Get-AzVMSqlServerExtension
Gets the settings for a SQL Server extension on a virtual machine.
Syntax
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
PS C:\> 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
PS C:\> Get-AzVM -ServiceName "Service08" -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 on the service Service08 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.
Example 3: Get the settings of specific SQL Server version
PS C:\> Get-AzVMSqlServerExtension -ResourceGroupName "ResourceGroup11" -VMName "ContosoVM07" -Version "1.0"
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 version 1.0 of the SQL Server extension on a virtual machine named ContosoVM07.
Parameters
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with azure.
Type: | IAzureContextContainer |
Aliases: | AzureRmContext, AzureCredential |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Name
Specifies the name of the SQL Server the extension.
Type: | String |
Position: | 2 |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-ResourceGroupName
Specifies the name of the resource group of the virtual machine.
Type: | String |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-VMName
Specifies the name of the virtual machine.
Type: | String |
Position: | 1 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
Inputs
None
This cmdlet does not accept any input.
Outputs
VirtualMachineSqlServerExtensionContext