Get-AzSqlVMGroup

Reference

Module:: Az.SqlVirtualMachine

Gets a SQL virtual machine group.

Syntax

Get-AzSqlVMGroup
   [-SubscriptionId <String[]>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Get-AzSqlVMGroup
   -Name <String>
   -ResourceGroupName <String>
   [-SubscriptionId <String[]>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Get-AzSqlVMGroup
   -ResourceGroupName <String>
   [-SubscriptionId <String[]>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

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.

Type:	PSObject
Aliases:	AzureRMContext, AzureCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-InputObject

Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.

Type:	ISqlVirtualMachineIdentity
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-Name

Name of the SQL virtual machine group.

Type:	String
Aliases:	SqlVirtualMachineGroupName, SqlVMGroupName
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	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.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-SubscriptionId

Subscription ID that identifies an Azure subscription.

Type:	String[]
Position:	Named
Default value:	(Get-AzContext).Subscription.Id
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

ISqlVirtualMachineIdentity

Outputs

ISqlVirtualMachineGroup

Share via