Get-AzSqlVMGroup
Gets a SQL virtual machine group.
Syntax
List1 (Default)
Get-AzSqlVMGroup
[-SubscriptionId <String[]>]
[-DefaultProfile <PSObject>]
[<CommonParameters>]
Get
Get-AzSqlVMGroup
-Name <String>
-ResourceGroupName <String>
[-SubscriptionId <String[]>]
[-DefaultProfile <PSObject>]
[<CommonParameters>]
List
Get-AzSqlVMGroup
-ResourceGroupName <String>
[-SubscriptionId <String[]>]
[-DefaultProfile <PSObject>]
[<CommonParameters>]
GetViaIdentity
Get-AzSqlVMGroup
-InputObject <ISqlVirtualMachineIdentity>
[-DefaultProfile <PSObject>]
[<CommonParameters>]
Description
Gets a SQL virtual machine group.
Examples
Example 1: List all SQL Virtual Machine Groups
Get-AzSqlVMGroup
Location Name ResourceGroupName
-------- ---- -----------------
eastus sqlvmgroup01 ResourceGroup01
eastus sqlvmgroup02 ResourceGroup01
eastus sqlvmgroup03 ResourceGroup02
Example 2: List all SQL Virtual Machine Groups in a Resource Group
Get-AzSqlVMGroup -ResourceGroupName 'ResourceGroup01'
Location Name ResourceGroupName
-------- ---- -----------------
eastus sqlvmgroup01 ResourceGroup01
eastus sqlvmgroup02 ResourceGroup01
Example 3: Get a SQL Virtual Machine Group
Get-AzSqlVMGroup -ResourceGroupName 'ResourceGroup01' -Name 'sqlvmgroup01'
Location Name ResourceGroupName
-------- ---- -----------------
eastus sqlvmgroup01 ResourceGroup01
Parameters
-DefaultProfile
The DefaultProfile parameter is not functional.
Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.
Parameter properties
Type: PSObject
Default value: None
Supports wildcards: False
DontShow: False
Aliases: 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
Identity Parameter
To construct, see NOTES section for INPUTOBJECT properties and create a hash table.
GetViaIdentity
Position: Named
Mandatory: True
Value from pipeline: True
Value from pipeline by property name: False
Value from remaining arguments: False
-Name
Name of the SQL virtual machine group.
Parameter properties
Type: String
Default value: None
Supports wildcards: False
DontShow: False
Aliases: SqlVirtualMachineGroupName, SqlVMGroupName
Parameter sets
Get
Position: Named
Mandatory: True
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
-ResourceGroupName
Name of the resource group that contains the resource.
You can obtain this value from the Azure Resource Manager API or the portal.
Parameter properties
Type: String
Default value: None
Supports wildcards: False
DontShow: False
Parameter sets
Get
Position: Named
Mandatory: True
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
List
Position: Named
Mandatory: True
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
-SubscriptionId
Subscription ID that identifies an Azure subscription.
Parameter properties
Type: String [ ]
Default value: (Get-AzContext).Subscription.Id
Supports wildcards: False
DontShow: False
Parameter sets
List1
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
Get
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
List
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
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 .
Outputs