Set-AzureVMSqlServerExtension
Sets the Azure SQL Server extension on a virtual machine.
Note
The cmdlets referenced in this documentation are for managing legacy Azure resources that use Azure Service Manager (ASM) APIs. This legacy PowerShell module isn't recommended when creating new resources since ASM is scheduled for retirement. For more information, see Azure Service Manager retirement.
The Az PowerShell module is the recommended PowerShell module for managing Azure Resource Manager (ARM) resources with PowerShell.
Syntax
EnableSqlServerExtension (Default)
Set-AzureVMSqlServerExtension
[[-ReferenceName] <String>]
[[-Version] <String>]
[[-AutoPatchingSettings] <AutoPatchingSettings>]
[[-AutoBackupSettings] <AutoBackupSettings>]
[[-KeyVaultCredentialSettings] <KeyVaultCredentialSettings>]
-VM <IPersistentVM>
[-Profile <AzureSMProfile>]
[-InformationAction <ActionPreference>]
[-InformationVariable <String>]
[<CommonParameters>]
DisableSqlServerExtension
Set-AzureVMSqlServerExtension
[[-ReferenceName] <String>]
[[-Version] <String>]
-VM <IPersistentVM>
[-Disable]
[-Profile <AzureSMProfile>]
[-InformationAction <ActionPreference>]
[-InformationVariable <String>]
[<CommonParameters>]
UninstallSqlServerExtension
Set-AzureVMSqlServerExtension
[[-ReferenceName] <String>]
[[-Version] <String>]
-VM <IPersistentVM>
[-Uninstall]
[-Profile <AzureSMProfile>]
[-InformationAction <ActionPreference>]
[-InformationVariable <String>]
[<CommonParameters>]
Description
The Set-AzureVMSqlServerExtension cmdlet sets the Azure SQL Server extension on a virtual machine.
Examples
Example 1: Set auto-patching settings on a virtual machine
PS C:\> Get-AzureVM -ServiceName "ServiceName" -Name "VMName" | Set-AzureVMSqlServerExtension -AutoPatchingSettings $APS | Update-AzureVM
This command sets auto-patching settings on an Azure virtual machine.
Example 2: Set auto-backup settings on a virtual machine
PS C:\> Get-AzureVM -ServiceName "ServiceName" -Name "VMName" | Set-AzureVMSqlServerExtension -AutoBackupSettings $ABS | Update-AzureVM
This command sets auto-backup settings on Azure virtual machine.
Example 3: Disable an SQL Server extension on a virtual machine
PS C:\> Get-AzureVM -ServiceName "Service" -Name "VMName" | Set-AzureVMSqlServerExtension -Disable
This command disables SQL Server virtual machine extension on a given virtual machine.
Example 4: Uninstall an SQL Server extension on a specific virtual machine
PS C:\> Get-AzureVM -ServiceName "Service" -Name "VMName" | Set-AzureVMSqlServerExtension -Uninstall
This command uninstalls a SQL Server virtual machine extension on the virtual machine named VMName.
Parameters
-AutoBackupSettings
Specifies the automatic SQL Server backup settings.
Parameter properties
| Type: | AutoBackupSettings |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
EnableSqlServerExtension
| Position: | 4 |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-AutoPatchingSettings
Specifies the automatic SQL Server patching settings.
Parameter properties
| Type: | AutoPatchingSettings |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
EnableSqlServerExtension
| Position: | 3 |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-Disable
Indicates that this cmdlet disables the extension state.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
DisableSqlServerExtension
| Position: | 2 |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-InformationAction
Specifies how this cmdlet responds to an information event.
The acceptable values for this parameter are:
- Continue
- Ignore
- Inquire
- SilentlyContinue
- Stop
- Suspend
Parameter properties
| Type: | ActionPreference |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | infa |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-InformationVariable
Specifies an information variable.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | iv |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-KeyVaultCredentialSettings
Specifies key vault credential settings.
Parameter properties
| Type: | KeyVaultCredentialSettings |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
EnableSqlServerExtension
| Position: | 5 |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-Profile
Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.
Parameter properties
| Type: | AzureSMProfile |
| 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 |
-ReferenceName
Specifies the reference name of the SQL Server extension.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 0 |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-Uninstall
Indicates that this cmdlet uninstalls the SQL Server extension from the virtual machine.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
UninstallSqlServerExtension
| Position: | 2 |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-Version
Specifies the version of the SQL Server extension that Get-AzureVMSqlServerExtension retrieves settings from.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 1 |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-VM
Specifies the persistent virtual machine object.
Parameter properties
| Type: | IPersistentVM |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | InputObject |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | True |
| 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.