New-AzSqlVM
Creates or updates a SQL virtual machine.
Syntax
Default (Default)
New-AzSqlVM
-Name <String>
-ResourceGroupName <String>
[-SubscriptionId <String>]
-Location <String>
[-AdditionalFeatureServerConfigurationIsRServicesEnabled]
[-AssessmentSettingEnable]
[-AssessmentSettingRunImmediately]
[-AutoBackupSettingBackupScheduleType <BackupScheduleType>]
[-AutoBackupSettingBackupSystemDb]
[-AutoBackupSettingDaysOfWeek <AutoBackupDaysOfWeek[]>]
[-AutoBackupSettingEnable]
[-AutoBackupSettingEnableEncryption]
[-AutoBackupSettingFullBackupFrequency <FullBackupFrequencyType>]
[-AutoBackupSettingFullBackupStartTime <Int32>]
[-AutoBackupSettingFullBackupWindowHour <Int32>]
[-AutoBackupSettingLogBackupFrequency <Int32>]
[-AutoBackupSettingPassword <SecureString>]
[-AutoBackupSettingRetentionPeriod <Int32>]
[-AutoBackupSettingStorageAccessKey <String>]
[-AutoBackupSettingStorageAccountUrl <String>]
[-AutoBackupSettingStorageContainerName <String>]
[-AutoPatchingSettingDayOfWeek <DayOfWeek>]
[-AutoPatchingSettingEnable]
[-AutoPatchingSettingMaintenanceWindowDuration <Int32>]
[-AutoPatchingSettingMaintenanceWindowStartingHour <Int32>]
[-AzureAdAuthenticationSettingClientId <String>]
[-EnableAutomaticUpgrade]
[-IdentityType <IdentityType>]
[-KeyVaultCredentialSettingAzureKeyVaultUrl <String>]
[-KeyVaultCredentialSettingCredentialName <String>]
[-KeyVaultCredentialSettingEnable]
[-KeyVaultCredentialSettingServicePrincipalName <String>]
[-KeyVaultCredentialSettingServicePrincipalSecret <String>]
[-LeastPrivilegeMode <LeastPrivilegeMode>]
[-LicenseType <SqlServerLicenseType>]
[-Offer <String>]
[-ScheduleDayOfWeek <AssessmentDayOfWeek>]
[-ScheduleEnable]
[-ScheduleMonthlyOccurrence <Int32>]
[-ScheduleStartTime <String>]
[-ScheduleWeeklyInterval <Int32>]
[-Sku <SqlImageSku>]
[-SqlConnectivityUpdateSettingConnectivityType <ConnectivityType>]
[-SqlConnectivityUpdateSettingPort <Int32>]
[-SqlConnectivityUpdateSettingSqlAuthUpdatePassword <SecureString>]
[-SqlConnectivityUpdateSettingSqlAuthUpdateUserName <String>]
[-SqlDataSettingDefaultFilePath <String>]
[-SqlDataSettingLun <Int32[]>]
[-SqlInstanceSettingCollation <String>]
[-SqlInstanceSettingIsIfiEnabled]
[-SqlInstanceSettingIsLpimEnabled]
[-SqlInstanceSettingIsOptimizeForAdHocWorkloadsEnabled]
[-SqlInstanceSettingMaxDop <Int32>]
[-SqlInstanceSettingMaxServerMemoryMb <Int32>]
[-SqlInstanceSettingMinServerMemoryMb <Int32>]
[-SqlLogSettingDefaultFilePath <String>]
[-SqlLogSettingLun <Int32[]>]
[-SqlManagementType <SqlManagementMode>]
[-SqlStorageUpdateSettingDiskConfigurationType <DiskConfigurationType>]
[-SqlStorageUpdateSettingDiskCount <Int32>]
[-SqlStorageUpdateSettingStartingDeviceId <Int32>]
[-SqlTempDbSettingDataFileCount <Int32>]
[-SqlTempDbSettingDataFileSize <Int32>]
[-SqlTempDbSettingDataGrowth <Int32>]
[-SqlTempDbSettingDefaultFilePath <String>]
[-SqlTempDbSettingLogFileSize <Int32>]
[-SqlTempDbSettingLogGrowth <Int32>]
[-SqlTempDbSettingLun <Int32[]>]
[-SqlTempDbSettingPersistFolder]
[-SqlTempDbSettingPersistFolderPath <String>]
[-SqlVirtualMachineGroupResourceId <String>]
[-SqlWorkloadTypeUpdateSettingSqlWorkloadType <SqlWorkloadType>]
[-StorageConfigurationSettingDiskConfigurationType <DiskConfigurationType>]
[-StorageConfigurationSettingSqlSystemDbOnDataDisk]
[-StorageConfigurationSettingStorageWorkloadType <StorageWorkloadType>]
[-Tag <Hashtable>]
[-WsfcDomainCredentialsClusterBootstrapAccountPassword <SecureString>]
[-WsfcDomainCredentialsClusterOperatorAccountPassword <SecureString>]
[-WsfcDomainCredentialsSqlServiceAccountPassword <SecureString>]
[-WsfcStaticIP <String>]
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Creates or updates a SQL virtual machine.
If you are updating an existing SQL virtual machine and a parameter such as -Tag is omitted, then the previously defined values may be removed.
For this reason, it is recommended to use Update-AzSqlVM to prevent overwriting of unintended parameters.
Examples
Example 1
New-AzSqlVM -ResourceGroupName 'ResourceGroup01' -Name 'sqlvm1' -Location 'eastus'
Location Name ResourceGroupName
-------- ---- -----------------
eastus sqlvm1 ResourceGroup01
Create a SQL virtual machine with default settings.
Example 2
New-AzSqlVM -ResourceGroupName 'ResourceGroup01' -Name 'sqlvm1' -Location 'eastus' -Sku 'Developer' -LicenseType 'PAYG'
Location Name ResourceGroupName
-------- ---- -----------------
eastus sqlvm1 ResourceGroup01
Create a SQL virtual machine with specific sku and license type.
Example 3
New-AzSqlVM -ResourceGroupName 'ResourceGroup01' -Name 'sqlvm1' -Location 'eastus' -LicenseType 'AHUB'
Location Name ResourceGroupName
-------- ---- -----------------
eastus sqlvm1 ResourceGroup01
Create a SQL virtual machine with AHUB billing tag.
Example 4
New-AzSqlVM -ResourceGroupName 'ResourceGroup01' -Name 'sqlvm1' -Location 'eastus' -LicenseType 'DR'
Location Name ResourceGroupName
-------- ---- -----------------
eastus sqlvm1 ResourceGroup01
Create a SQL virtual machine with DR billing tag.
Example 5
New-AzSqlVM -ResourceGroupName 'ResourceGroup01' -Name 'sqlvm1' -Location 'eastus' -AutoBackupSettingEnable `
-AutoBackupSettingBackupScheduleType manual -AutoBackupSettingFullBackupFrequency Weekly -AutoBackupSettingFullBackupStartTime 5 `
-AutoBackupSettingFullBackupWindowHour 2 -AutoBackupSettingStorageAccessKey 'keyvalue' -AutoBackupSettingStorageAccountUrl `
'https://storagename.blob.core.windows.net/' -AutoBackupSettingRetentionPeriod 10 -AutoBackupSettingLogBackupFrequency 60 `
-AutoBackupSettingStorageContainerName 'storagecontainername'
Location Name ResourceGroupName
-------- ---- -----------------
eastus sqlvm1 ResourceGroup01
Create a SQL virtual machine and configure auto backup settings.
Example 6
New-AzSqlVM -ResourceGroupName 'ResourceGroup01' -Name 'sqlvm1' -Location 'eastus' -AutoPatchingSettingDayOfWeek Thursday `
-AutoPatchingSettingMaintenanceWindowDuration 120 -AutoPatchingSettingMaintenanceWindowStartingHour 3 -AutoPatchingSettingEnable
Location Name ResourceGroupName
-------- ---- -----------------
eastus sqlvm1 ResourceGroup01
Create a SQL virtual machine and configure auto patching settings.
Example 7
New-AzSqlVM -ResourceGroupName 'ResourceGroup01' -Name 'sqlvm1' -Location 'eastus' -AssessmentSettingEnable
Location Name ResourceGroupName
-------- ---- -----------------
eastus sqlvm1 ResourceGroup01
Create a SQL virtual machine and configure assessment settings.
Example 8
New-AzSqlVM -ResourceGroupName 'ResourceGroup01' -Name 'sqlvm1' -Location 'eastus' -AsJob
Location Name ResourceGroupName
-------- ---- -----------------
eastus sqlvm1 ResourceGroup01
Create a SQL virtual machine as a background job.
Parameters
-AdditionalFeatureServerConfigurationIsRServicesEnabled
Enable or disable R services (SQL 2016 onwards).
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-AsJob
Run the command as a job
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-AssessmentSettingEnable
Enable or disable SQL best practices Assessment feature on SQL virtual machine.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
Run SQL best practices Assessment immediately on SQL virtual machine.
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-AutoBackupSettingBackupScheduleType
Backup schedule type.
Parameter properties
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-AutoBackupSettingBackupSystemDb
Include or exclude system databases from auto backup.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-AutoBackupSettingDaysOfWeek
Days of the week for the backups when FullBackupFrequency is set to Weekly.
Parameter properties
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-AutoBackupSettingEnable
Enable or disable autobackup on SQL virtual machine.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-AutoBackupSettingEnableEncryption
Enable or disable encryption for backup on SQL virtual machine.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-AutoBackupSettingFullBackupFrequency
Frequency of full backups.
In both cases, full backups begin during the next scheduled time window.
Parameter properties
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-AutoBackupSettingFullBackupStartTime
Start time of a given day during which full backups can take place.
0-23 hours.
Parameter properties
Type: Int32
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-AutoBackupSettingFullBackupWindowHour
Duration of the time window of a given day during which full backups can take place.
1-23 hours.
Parameter properties
Type: Int32
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-AutoBackupSettingLogBackupFrequency
Frequency of log backups.
5-60 minutes.
Parameter properties
Type: Int32
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-AutoBackupSettingPassword
Password for encryption on backup.
Parameter properties
Type: SecureString
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-AutoBackupSettingRetentionPeriod
Retention period of backup: 1-90 days.
Parameter properties
Type: Int32
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-AutoBackupSettingStorageAccessKey
Storage account key where backup will be taken to.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-AutoBackupSettingStorageAccountUrl
Storage account url where backup will be taken to.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-AutoBackupSettingStorageContainerName
Storage container name where backup will be taken to.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-AutoPatchingSettingDayOfWeek
Day of week to apply the patch on.
Parameter properties
Type: DayOfWeek
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-AutoPatchingSettingEnable
Enable or disable autopatching on SQL virtual machine.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-AutoPatchingSettingMaintenanceWindowDuration
Duration of patching.
Parameter properties
Type: Int32
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-AutoPatchingSettingMaintenanceWindowStartingHour
Hour of the day when patching is initiated.
Local VM time.
Parameter properties
Type: Int32
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-AzureAdAuthenticationSettingClientId
The client Id of the Managed Identity to query Microsoft Graph API.
An empty string must be used for the system assigned Managed Identity
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False Aliases: cf
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with Azure.
Parameter properties
Type: PSObject
Default value: None Supports wildcards: False DontShow: False Aliases: AzureRMContext, AzureCredential
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-EnableAutomaticUpgrade
Enable automatic upgrade of Sql IaaS extension Agent.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-IdentityType
The identity type.
Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource.
Parameter properties
Type: IdentityType
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-KeyVaultCredentialSettingAzureKeyVaultUrl
Azure Key Vault url.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-KeyVaultCredentialSettingCredentialName
Credential name.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-KeyVaultCredentialSettingEnable
Enable or disable key vault credential setting.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-KeyVaultCredentialSettingServicePrincipalName
Service principal name to access key vault.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-KeyVaultCredentialSettingServicePrincipalSecret
Service principal name secret to access key vault.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-LeastPrivilegeMode
SQL IaaS Agent least privilege mode.
Parameter properties
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-LicenseType
SQL Server license type.
Parameter properties
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Location
Resource ___location.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Name
Name of the SQL virtual machine.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False Aliases: SqlVirtualMachineName, SqlVMName
Parameter sets
(All)
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-NoWait
Run the command asynchronously
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Offer
SQL image offer.
Examples include SQL2016-WS2016, SQL2017-WS2016.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ResourceGroupName
Name of the resource group that contains the resource.
You can obtain this value from the Azure Resource Manager API or the portal.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ScheduleDayOfWeek
Day of the week to run assessment.
Parameter properties
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ScheduleEnable
Enable or disable assessment schedule on SQL virtual machine.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ScheduleMonthlyOccurrence
Occurrence of the DayOfWeek day within a month to schedule assessment.
Takes values: 1,2,3,4 and -1.
Use -1 for last DayOfWeek day of the month
Parameter properties
Type: Int32
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ScheduleStartTime
Time of the day in HH:mm format.
Eg.
17:30
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ScheduleWeeklyInterval
Number of weeks to schedule between 2 assessment runs.
Takes value from 1-6
Parameter properties
Type: Int32
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Sku
SQL Server edition type.
Parameter properties
Type: SqlImageSku
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-SqlConnectivityUpdateSettingConnectivityType
SQL Server connectivity option.
Parameter properties
Type: ConnectivityType
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-SqlConnectivityUpdateSettingPort
SQL Server port.
Parameter properties
Type: Int32
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-SqlConnectivityUpdateSettingSqlAuthUpdatePassword
SQL Server sysadmin login password.
Parameter properties
Type: SecureString
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-SqlConnectivityUpdateSettingSqlAuthUpdateUserName
SQL Server sysadmin login to create.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-SqlDataSettingDefaultFilePath
SQL Server default file path
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-SqlDataSettingLun
Logical Unit Numbers for the disks.
Parameter properties
Type: Int32 [ ]
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-SqlInstanceSettingCollation
SQL Server Collation.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-SqlInstanceSettingIsIfiEnabled
SQL Server IFI.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-SqlInstanceSettingIsLpimEnabled
SQL Server LPIM.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-SqlInstanceSettingIsOptimizeForAdHocWorkloadsEnabled
SQL Server Optimize for Adhoc workloads.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-SqlInstanceSettingMaxDop
SQL Server MAXDOP.
Parameter properties
Type: Int32
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-SqlInstanceSettingMaxServerMemoryMb
SQL Server maximum memory.
Parameter properties
Type: Int32
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-SqlInstanceSettingMinServerMemoryMb
SQL Server minimum memory.
Parameter properties
Type: Int32
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-SqlLogSettingDefaultFilePath
SQL Server default file path
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-SqlLogSettingLun
Logical Unit Numbers for the disks.
Parameter properties
Type: Int32 [ ]
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-SqlManagementType
SQL Server Management type.
Parameter properties
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-SqlStorageUpdateSettingDiskConfigurationType
Disk configuration to apply to SQL Server.
Parameter properties
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-SqlStorageUpdateSettingDiskCount
Virtual machine disk count.
Parameter properties
Type: Int32
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-SqlStorageUpdateSettingStartingDeviceId
Device id of the first disk to be updated.
Parameter properties
Type: Int32
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-SqlTempDbSettingDataFileCount
SQL Server tempdb data file count
Parameter properties
Type: Int32
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-SqlTempDbSettingDataFileSize
SQL Server tempdb data file size
Parameter properties
Type: Int32
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-SqlTempDbSettingDataGrowth
SQL Server tempdb data file autoGrowth size
Parameter properties
Type: Int32
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-SqlTempDbSettingDefaultFilePath
SQL Server default file path
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-SqlTempDbSettingLogFileSize
SQL Server tempdb log file size
Parameter properties
Type: Int32
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-SqlTempDbSettingLogGrowth
SQL Server tempdb log file autoGrowth size
Parameter properties
Type: Int32
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-SqlTempDbSettingLun
Logical Unit Numbers for the disks.
Parameter properties
Type: Int32 [ ]
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-SqlTempDbSettingPersistFolder
SQL Server tempdb persist folder choice
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-SqlTempDbSettingPersistFolderPath
SQL Server tempdb persist folder ___location
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-SqlVirtualMachineGroupResourceId
ARM resource id of the SQL virtual machine group this SQL virtual machine is or will be part of.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-SqlWorkloadTypeUpdateSettingSqlWorkloadType
SQL Server workload type.
Parameter properties
Type: SqlWorkloadType
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-StorageConfigurationSettingDiskConfigurationType
Disk configuration to apply to SQL Server.
Parameter properties
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-StorageConfigurationSettingSqlSystemDbOnDataDisk
SQL Server SystemDb Storage on DataPool if true.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-StorageConfigurationSettingStorageWorkloadType
Storage workload type.
Parameter properties
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-SubscriptionId
Subscription ID that identifies an Azure subscription.
Parameter properties
Type: String
Default value: (Get-AzContext).Subscription.Id Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Tag
Resource tags.
Parameter properties
Type: Hashtable
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-WhatIf
Shows what would happen if the cmdlet runs.
The cmdlet is not run.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False Aliases: wi
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-WsfcDomainCredentialsClusterBootstrapAccountPassword
Cluster bootstrap account password.
Parameter properties
Type: SecureString
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-WsfcDomainCredentialsClusterOperatorAccountPassword
Cluster operator account password.
Parameter properties
Type: SecureString
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-WsfcDomainCredentialsSqlServiceAccountPassword
SQL service account password.
Parameter properties
Type: SecureString
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-WsfcStaticIP
Domain credentials for setting up Windows Server Failover Cluster for SQL availability group.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
-InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable,
-ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see
about_CommonParameters .
Outputs
