< Back
Set-AzureRmVMSqlServerExtension
Post
NAME Set-AzureRmVMSqlServerExtension
SYNOPSIS
Sets the Azure SQL Server extension on a virtual machine.
SYNTAX
Set-AzureRmVMSqlServerExtension [[-Version] <String>] [-ResourceGroupName] <String> [-VMName] <String> [[-Name] <String>] [[-AutoPatchingSettings]
<AutoPatchingSettings>] [[-AutoBackupSettings] <AutoBackupSettings>] [[-KeyVaultCredentialSettings] <KeyVaultCredentialSettings>] [[-Location]
<String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
DESCRIPTION
The Set-AzureRmVMSqlServerExtension cmdlet sets the AzureSQL Server extension on a virtual machine.
PARAMETERS
-AutoBackupSettings <AutoBackupSettings>
Specifies the automatic SQL Server backup settings. To create an AutoBackupSettings object , use the New-AzureVMSqlServerAutoBackupConfig
cmdlet.
Required? false
Position? 6
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-AutoPatchingSettings <AutoPatchingSettings>
Specifies the automatic SQL Server patching settings. To create an AutoPatchingSettings object , use the
New-AzureVMSqlServerAutoPatchingConfig cmdlet.
Required? false
Position? 5
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-KeyVaultCredentialSettings <KeyVaultCredentialSettings>
Required? false
Position? 7
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Location <String>
Specifies the location of the virtual machine.
Required? false
Position? 8
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Name <String>
Specifies the name of the SQL Server the extension.
Required? false
Position? 4
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ResourceGroupName <String>
Specifies the name of the resource group of the virtual machine.
Required? true
Position? 2
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Version <String>
Specifies the version of the SQL Server extension.
Required? false
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-VMName <String>
Specifies the name of the virtual machine on which this cmdlet sets the SQL Server extension.
Required? true
Position? 3
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
None
This cmdlet does not accept any input.
OUTPUTS
Microsoft.Azure.Commands.Compute.Models.PSAzureOperationResponse
NOTES
Example 1: Set automatic patching settings on a virtual machine
PS C:\\> $AutoPatchingConfig = New-AzureVMSqlServerAutoPatchingConfig -Enable -DayOfWeek "Thursday" -MaintenanceWindowStartingHour 11
-MaintenanceWindowDuration 120 -PatchCategory "Important"
PS C:\\> Get-AzureRmVM -ServiceName "Service02" -Name "VirtualMachine11" | Set-AzureRmVMSqlServerExtension -AutoPatchingSettings
$AutoPatchingConfig | Update-AzureRmVM
The first command creates a configuration object by using the New-AzureVMSqlServerAutoPatchingConfig cmdlet. The command stores the configuration
in the $AutoPatchingConfig variable.
The second command gets the virtual machine named VirtualMachine11 on the service named Service02 by using the Get-AzureRmVM 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-AzureRmVM cmdlet.
Example 2: Set automatic backup settings on a virtual machine
PS C:\\> $AutoBackupConfig = New-AzureVMSqlServerAutoBackupConfig -Enable -RetentionPeriod 10 -StorageUri $StorageUrl -StorageKey
$StorageAccountKeySecure
PS C:\\> Get-AzureRmVM -ServiceName "Service02" -Name "VirtualMachine11" | Set-AzureRmVMSqlServerExtension -AutoBackupSettings $AutoBackupConfig |
Update-AzureRmVM
The first command creates a configuration object by using the New-AzureVMSqlServerAutoBackupConfig cmdlet. The command stores the configuration in
the $AutoBackupConfig variable.
The second command gets the virtual machine named VirtualMachine11 on the service named Service02, 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-AzureRmVM cmdlet.
Example 3: Disable a SQL Server extension on a virtual machine
PS C:\\> Get-AzureRmVM -ServiceName "Service03" -Name "VirtualMachine08" | Set-AzureRmVMSqlServerExtension -Disable
This command gets a virtual machine named VirtualMachine08 on Service03, and then passes it to the current cmdlet. The command disables SQL Server
virtual machine extension on that virtual machine.
Example 4: Uninstall a SQL Server extension on a specific virtual machine
PS C:\\> Get-AzureRmVM -ServiceName "Service03" -Name "VirtualMachine08" | Set-AzureRmVMSqlServerExtension -Uninstall
This command gets a virtual machine named VirtualMachine08 on Service03, and then passes it to the current cmdlet. The command uninstalls a SQL
Server virtual machine extension on that virtual machine.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... rextension
Get-AzureRmVmssDiskEncryption
Get-AzureRmVMSqlServerExtension
New-AzureVMSqlServerAutoPatchingConfig
New-AzureVMSqlServerAutoBackupConfig
Remove-AzureRmVMSqlServerExtension
Update-AzureRmVmss
SYNOPSIS
Sets the Azure SQL Server extension on a virtual machine.
SYNTAX
Set-AzureRmVMSqlServerExtension [[-Version] <String>] [-ResourceGroupName] <String> [-VMName] <String> [[-Name] <String>] [[-AutoPatchingSettings]
<AutoPatchingSettings>] [[-AutoBackupSettings] <AutoBackupSettings>] [[-KeyVaultCredentialSettings] <KeyVaultCredentialSettings>] [[-Location]
<String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
DESCRIPTION
The Set-AzureRmVMSqlServerExtension cmdlet sets the AzureSQL Server extension on a virtual machine.
PARAMETERS
-AutoBackupSettings <AutoBackupSettings>
Specifies the automatic SQL Server backup settings. To create an AutoBackupSettings object , use the New-AzureVMSqlServerAutoBackupConfig
cmdlet.
Required? false
Position? 6
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-AutoPatchingSettings <AutoPatchingSettings>
Specifies the automatic SQL Server patching settings. To create an AutoPatchingSettings object , use the
New-AzureVMSqlServerAutoPatchingConfig cmdlet.
Required? false
Position? 5
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-KeyVaultCredentialSettings <KeyVaultCredentialSettings>
Required? false
Position? 7
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Location <String>
Specifies the location of the virtual machine.
Required? false
Position? 8
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Name <String>
Specifies the name of the SQL Server the extension.
Required? false
Position? 4
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ResourceGroupName <String>
Specifies the name of the resource group of the virtual machine.
Required? true
Position? 2
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Version <String>
Specifies the version of the SQL Server extension.
Required? false
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-VMName <String>
Specifies the name of the virtual machine on which this cmdlet sets the SQL Server extension.
Required? true
Position? 3
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
None
This cmdlet does not accept any input.
OUTPUTS
Microsoft.Azure.Commands.Compute.Models.PSAzureOperationResponse
NOTES
Example 1: Set automatic patching settings on a virtual machine
PS C:\\> $AutoPatchingConfig = New-AzureVMSqlServerAutoPatchingConfig -Enable -DayOfWeek "Thursday" -MaintenanceWindowStartingHour 11
-MaintenanceWindowDuration 120 -PatchCategory "Important"
PS C:\\> Get-AzureRmVM -ServiceName "Service02" -Name "VirtualMachine11" | Set-AzureRmVMSqlServerExtension -AutoPatchingSettings
$AutoPatchingConfig | Update-AzureRmVM
The first command creates a configuration object by using the New-AzureVMSqlServerAutoPatchingConfig cmdlet. The command stores the configuration
in the $AutoPatchingConfig variable.
The second command gets the virtual machine named VirtualMachine11 on the service named Service02 by using the Get-AzureRmVM 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-AzureRmVM cmdlet.
Example 2: Set automatic backup settings on a virtual machine
PS C:\\> $AutoBackupConfig = New-AzureVMSqlServerAutoBackupConfig -Enable -RetentionPeriod 10 -StorageUri $StorageUrl -StorageKey
$StorageAccountKeySecure
PS C:\\> Get-AzureRmVM -ServiceName "Service02" -Name "VirtualMachine11" | Set-AzureRmVMSqlServerExtension -AutoBackupSettings $AutoBackupConfig |
Update-AzureRmVM
The first command creates a configuration object by using the New-AzureVMSqlServerAutoBackupConfig cmdlet. The command stores the configuration in
the $AutoBackupConfig variable.
The second command gets the virtual machine named VirtualMachine11 on the service named Service02, 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-AzureRmVM cmdlet.
Example 3: Disable a SQL Server extension on a virtual machine
PS C:\\> Get-AzureRmVM -ServiceName "Service03" -Name "VirtualMachine08" | Set-AzureRmVMSqlServerExtension -Disable
This command gets a virtual machine named VirtualMachine08 on Service03, and then passes it to the current cmdlet. The command disables SQL Server
virtual machine extension on that virtual machine.
Example 4: Uninstall a SQL Server extension on a specific virtual machine
PS C:\\> Get-AzureRmVM -ServiceName "Service03" -Name "VirtualMachine08" | Set-AzureRmVMSqlServerExtension -Uninstall
This command gets a virtual machine named VirtualMachine08 on Service03, and then passes it to the current cmdlet. The command uninstalls a SQL
Server virtual machine extension on that virtual machine.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... rextension
Get-AzureRmVmssDiskEncryption
Get-AzureRmVMSqlServerExtension
New-AzureVMSqlServerAutoPatchingConfig
New-AzureVMSqlServerAutoBackupConfig
Remove-AzureRmVMSqlServerExtension
Update-AzureRmVmss