Get-AzVMSqlServerExtension
Gets the settings for a SQL Server extension on a virtual machine.
Syntax
Default (Default)
Get-AzVMSqlServerExtension
[-ResourceGroupName] <String>
[-VMName] <String>
[[-Name] <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Description
The Get-AzVMSqlServerExtension cmdlet gets the settings of the SQL Server infrastructure as a service (IaaS) Agent on a virtual machine.
Examples
Example 1: Get the settings of a SQL Server extension on a virtual machine
Get-AzVMSqlServerExtension -ResourceGroupName "ResourceGroup11" -VMName "ContosoVM07"
ExtensionName : SqlIaaSAgent
Publisher : Microsoft.SqlServer.Management
Version : 1.0
State : Enable
RoleName : VMName
AutoPatchingSettings : Microsoft.WindowsAzure.Commands.ServiceManagement.IaaS.Extensions.AutoPatchingSettings
AutoBackupSettings : Microsoft.WindowsAzure.Commands.ServiceManagement.IaaS.Extensions.AutoBackupSettings
This command gets the settings of the SQL Server extension on a virtual machine named ContosoVM07.
Example 2: Get the settings by using the pipeline
Get-AzVM -ResourceGroupName "testrg" -Name "ContosoVM22" | Get-AzVMSqlServerExtension
ExtensionName : SqlIaaSAgent
Publisher : Microsoft.SqlServer.Management
Version : 1.0
State : Enable
RoleName : VMName
AutoPatchingSettings : Microsoft.WindowsAzure.Commands.ServiceManagement.IaaS.Extensions.AutoPatchingSettings
AutoBackupSettings : Microsoft.WindowsAzure.Commands.ServiceManagement.IaaS.Extensions.AutoBackupSettings
This command gets the virtual machine named ContosoVM22 in the Resource Group testrg by using the Get-AzVM cmdlet. The command passes the results to the current cmdlet by using the pipeline operator. The current command gets the settings of the SQL Server IaaS Agent on that virtual machine.
Parameters
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with azure.
Parameter properties
| Type: | IAzureContextContainer |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | AzContext, 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 |
-Name
Specifies the name of the SQL Server the extension.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 2 |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-ResourceGroupName
Specifies the name of the resource group of the virtual machine.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 0 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-VMName
Specifies the name of the virtual machine.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 1 |
| Mandatory: | True |
| Value from pipeline: | False |
| 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.
