Set-AzVMSqlServerExtension

Reference

Module:: Az.Compute

Sets the Azure SQL Server extension on a virtual machine.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Syntax

Set-AzVMSqlServerExtension
   [[-Version] <String>]
   [-ResourceGroupName] <String>
   [-VMName] <String>
   [[-Name] <String>]
   [[-AutoPatchingSettings] <AutoPatchingSettings>]
   [[-AutoBackupSettings] <AutoBackupSettings>]
   [[-KeyVaultCredentialSettings] <KeyVaultCredentialSettings>]
   [[-Location] <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

The Set-AzVMSqlServerExtension cmdlet sets the AzureSQL Server extension on a virtual machine.

Examples

Example 1: Set automatic patching settings on a virtual machine

$AutoPatchingConfig = New-AzVMSqlServerAutoPatchingConfig -Enable -DayOfWeek "Thursday" -MaintenanceWindowStartingHour 11 -MaintenanceWindowDuration 120 -PatchCategory "Important"
Get-AzVM -ResourceGroupName "testrg" -Name "VirtualMachine11" | Set-AzVMSqlServerExtension -AutoPatchingSettings $AutoPatchingConfig | Update-AzVM

The first command creates a configuration object by using the New-AzVMSqlServerAutoPatchingConfig cmdlet. The command stores the configuration in the $AutoPatchingConfig variable. The second command gets the virtual machine named VirtualMachine11 in the Resource Group testrg by using the Get-AzVM cmdlet. The command passes that object to the current cmdlet by using the pipeline operator. The current cmdlet sets the automatic patching settings in $AutoPatchingConfig for the virtual machine. The command passes the virtual machine to the Update-AzVM cmdlet.

Example 2: Set automatic backup settings on a virtual machine

$AutoBackupConfig = New-AzVMSqlServerAutoBackupConfig -Enable -RetentionPeriodInDays 10 -StorageUri $StorageUrl -StorageKey $StorageAccountKeySecure
Get-AzVM -ResourceGroupName "testrg" -Name "VirtualMachine11" | Set-AzVMSqlServerExtension -AutoBackupSettings $AutoBackupConfig | Update-AzVM

The first command creates a configuration object by using the New-AzVMSqlServerAutoBackupConfig cmdlet. The command stores the configuration in the $AutoBackupConfig variable. The second command gets the virtual machine named VirtualMachine11 in the Resource Group testrg, and then passes it to the current cmdlet. The current cmdlet sets the automatic backup settings in $AutoBackupConfig for the virtual machine. The command passes the virtual machine to the Update-AzVM cmdlet.

Parameters

-AutoBackupSettings

Specifies the automatic SQL Server backup settings. To create an AutoBackupSettings object , use the New-AzVMSqlServerAutoBackupConfig cmdlet.

Type:	AutoBackupSettings
Position:	6
Default value:	None
Accept pipeline input:	True
Accept wildcard characters:	False

-AutoPatchingSettings

Specifies the automatic SQL Server patching settings. To create an AutoPatchingSettings object , use the New-AzVMSqlServerAutoPatchingConfig cmdlet.

Type:	AutoPatchingSettings
Position:	5
Default value:	None
Accept pipeline input:	True
Accept wildcard characters:	False

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with azure.

Type:	IAzureContextContainer
Aliases:	AzContext, AzureRmContext, AzureCredential
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-KeyVaultCredentialSettings

Type:	KeyVaultCredentialSettings
Position:	7
Default value:	None
Accept pipeline input:	True
Accept wildcard characters:	False

-Location

Specifies the location of the virtual machine.

Type:	String
Position:	8
Default value:	None
Accept pipeline input:	True
Accept wildcard characters:	False

-Name

Specifies the name of the SQL Server the extension.

Type:	String
Position:	4
Default value:	None
Accept pipeline input:	True
Accept wildcard characters:	False

-ResourceGroupName

Specifies the name of the resource group of the virtual machine.

Type:	String
Position:	2
Default value:	None
Accept pipeline input:	True
Accept wildcard characters:	False

-Version

Specifies the version of the SQL Server extension.

Type:	String
Aliases:	HandlerVersion
Position:	1
Default value:	None
Accept pipeline input:	True
Accept wildcard characters:	False

-VMName

Specifies the name of the virtual machine on which this cmdlet sets the SQL Server extension.

Type:	String
Position:	3
Default value:	None
Accept pipeline input:	True
Accept wildcard characters:	False

Inputs

String

AutoPatchingSettings

AutoBackupSettings

KeyVaultCredentialSettings

Outputs

PSAzureOperationResponse