Edit

Share via


Update-AzSqlVM

Updates a SQL virtual machine.

Syntax

UpdateExpanded (Default)

Update-AzSqlVM
    -Name <String>
    -ResourceGroupName <String>
    [-SubscriptionId <String>]
    [-LicenseType <SqlServerLicenseType>]
    [-Offer <String>]
    [-Sku <SqlImageSku>]
    [-SqlManagementType <SqlManagementMode>]
    [-Tag <Hashtable>]
    [-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>]
    [-AssessmentSettingEnable]
    [-AssessmentSettingRunImmediately]
    [-ScheduleDayOfWeek <AssessmentDayOfWeek>]
    [-ScheduleEnable]
    [-ScheduleMonthlyOccurrence <Int32>]
    [-ScheduleStartTime <String>]
    [-ScheduleWeeklyInterval <Int32>]
    [-SqlVirtualMachineGroupResourceId <String>]
    [-VirtualMachineResourceId <String>]
    [-WsfcDomainCredentialsClusterBootstrapAccountPassword <SecureString>]
    [-WsfcDomainCredentialsClusterOperatorAccountPassword <SecureString>]
    [-WsfcDomainCredentialsSqlServiceAccountPassword <SecureString>]
    [-WsfcStaticIP <String>]
    [-EnableAutomaticUpgrade]
    [-ManagedIdentityClientId <String>]
    [-IdentityType <String>]
    [-DefaultProfile <PSObject>]
    [-AsJob]
    [-NoWait]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

UpdateViaIdentity

Update-AzSqlVM
    -InputObject <ISqlVirtualMachineIdentity>
    [-LicenseType <SqlServerLicenseType>]
    [-Offer <String>]
    [-Sku <SqlImageSku>]
    [-SqlManagementType <SqlManagementMode>]
    [-Tag <Hashtable>]
    [-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>]
    [-AssessmentSettingEnable]
    [-AssessmentSettingRunImmediately]
    [-ScheduleDayOfWeek <AssessmentDayOfWeek>]
    [-ScheduleEnable]
    [-ScheduleMonthlyOccurrence <Int32>]
    [-ScheduleStartTime <String>]
    [-ScheduleWeeklyInterval <Int32>]
    [-SqlVirtualMachineGroupResourceId <String>]
    [-VirtualMachineResourceId <String>]
    [-WsfcDomainCredentialsClusterBootstrapAccountPassword <SecureString>]
    [-WsfcDomainCredentialsClusterOperatorAccountPassword <SecureString>]
    [-WsfcDomainCredentialsSqlServiceAccountPassword <SecureString>]
    [-WsfcStaticIP <String>]
    [-EnableAutomaticUpgrade]
    [-ManagedIdentityClientId <String>]
    [-IdentityType <String>]
    [-DefaultProfile <PSObject>]
    [-AsJob]
    [-NoWait]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

Updates a SQL virtual machine.

Examples

Example 1

Update-AzSqlVM -ResourceGroupName 'ResourceGroup01' -Name 'sqlvm1' -LicenseType 'AHUB' -Tag @{'newkey'='newvalue'}
Location	Name		ResourceGroupName
--------	----		-----------------
eastus		sqlvm1		ResourceGroup01

Update a SQL virtual machine with AHUB billing and add a tag.

Example 2

$sqlVM = Get-AzSqlVM -ResourceGroupName 'ResourceGroup01' -Name 'sqlvm1'
$sqlVM | Update-AzSqlVM -Sku 'Standard' -LicenseType 'AHUB'
Location	Name		ResourceGroupName
--------	----		-----------------
eastus		sqlvm1		ResourceGroup01

Update a SQL virtual machine's sku and license type via identity.

Example 3

Update-AzSqlVM -ResourceGroupName 'ResourceGroup01' -Name 'sqlvm1' -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

Update a SQL virtual machine to enable auto backup.

Example 4

Update-AzSqlVM -ResourceGroupName 'ResourceGroup01' -Name 'sqlvm1' -AutoBackupSettingEnable:$false
Location	Name		ResourceGroupName
--------	----		-----------------
eastus		sqlvm1		ResourceGroup01

Update a SQL virtual machine to disable auto backup.

Example 5

Update-AzSqlVM -ResourceGroupName 'ResourceGroup01' -Name 'sqlvm1' `
-AutoPatchingSettingDayOfWeek Thursday `
-AutoPatchingSettingMaintenanceWindowDuration 120 -AutoPatchingSettingMaintenanceWindowStartingHour 3 -AutoPatchingSettingEnable
Location	Name		ResourceGroupName
--------	----		-----------------
eastus		sqlvm1		ResourceGroup01

Update a SQL virtual machine to enable auto patching.

Example 6

Update-AzSqlVM -ResourceGroupName 'ResourceGroup01' -Name 'sqlvm1' -AutoPatchingSettingEnable:$false
Location	Name		ResourceGroupName
--------	----		-----------------
eastus		sqlvm1		ResourceGroup01

Update a SQL virtual machine to disable auto patching.

Example 7

Update-AzSqlVM -ResourceGroupName 'ResourceGroup01' -Name 'sqlvm1' -AssessmentSettingEnable
Location	Name		ResourceGroupName
--------	----		-----------------
eastus		sqlvm1		ResourceGroup01

Update a SQL virtual machine to enable assessment.

Example 8

$securepwd = ConvertTo-SecureString -String "****" -AsPlainText -Force
Update-AzSqlVM -ResourceGroupName 'ResourceGroup01' -Name 'sqlvm1' `
-SqlVirtualMachineGroupResourceId '<group resource id>' `
-WsfcDomainCredentialsClusterBootstrapAccountPassword $securepwd `
-WsfcDomainCredentialsClusterOperatorAccountPassword $securepwd `
-WsfcDomainCredentialsSqlServiceAccountPassword $securepwd
Location	Name		ResourceGroupName
--------	----		-----------------
eastus		sqlvm1		ResourceGroup01

Update a SQL virtual machine to add it to a SQL VM group.

Example 9

Update-AzSqlVM -ResourceGroupName 'ResourceGroup01' -Name 'sqlvm1' -SqlVirtualMachineGroupResourceId ''
Location	Name		ResourceGroupName
--------	----		-----------------
eastus		sqlvm1		ResourceGroup01

Update a SQL virtual machine to remove it from a SQL VM group.

Example 10

Update-AzSqlVM -ResourceGroupName 'ResourceGroup01' -Name 'sqlvm1'  -Tag @{'newkey'='newvalue'} -AsJob
Location	Name		ResourceGroupName
--------	----		-----------------
eastus		sqlvm1		ResourceGroup01

Update a SQL virtual machine's tag as a background job.

Example 11

Update-AzSqlVM -ResourceGroupName 'ResourceGroup01' -Name 'sqlvm1' -IdentityType 'SystemAssigned'
Location	Name		ResourceGroupName
--------	----		-----------------
eastus		sqlvm1		ResourceGroup01

Update a SQL virtual machine to enable Microsoft Entra authentication using "System-assigned managed identity"

Example 12

Update-AzSqlVM -ResourceGroupName 'ResourceGroup01' -Name 'sqlvm1' -IdentityType 'UserAssigned' -ManagedIdentityClientId '00001111-aaaa-2222-bbbb-3333cccc4444'
Location	Name		ResourceGroupName
--------	----		-----------------
eastus		sqlvm1		ResourceGroup01

Update a SQL virtual machine to enable Microsoft Entra authentication using "User-assigned managed identity"

Parameters

-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

-AssessmentSettingRunImmediately

Run SQL best practices Assessment immediately 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

-AutoBackupSettingBackupScheduleType

Backup schedule type.

Parameter properties

Type:BackupScheduleType
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

-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

Type:

AutoBackupDaysOfWeek[]

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

-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

Type:FullBackupFrequencyType
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

-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

-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

Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).

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

-InputObject

Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.

Parameter properties

Type:ISqlVirtualMachineIdentity
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

UpdateViaIdentity
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-LicenseType

SQL Server license type.

Parameter properties

Type:SqlServerLicenseType
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

-ManagedIdentityClientId

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

-Name

Name of the SQL virtual machine.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:SqlVirtualMachineName, SqlVMName

Parameter sets

UpdateExpanded
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

UpdateExpanded
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

Type:AssessmentDayOfWeek
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

-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

-SqlManagementType

SQL Server Management type.

Parameter properties

Type:SqlManagementMode
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

-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

UpdateExpanded
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

-VirtualMachineResourceId

ARM Resource id of underlying virtual machine created from SQL marketplace image.

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

-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.

Inputs

ISqlVirtualMachineIdentity

Outputs

ISqlVirtualMachine