Get-AzAvailabilityGroupListener

Module:

Az.SqlVirtualMachine

Gets an availability group listener.

Syntax

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

Get-AzAvailabilityGroupListener
   -Name <String>
   -ResourceGroupName <String>
   -SqlVMGroupName <String>
   [-SubscriptionId <String[]>]
   [-Expand <String>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Get-AzAvailabilityGroupListener
   -InputObject <ISqlVirtualMachineIdentity>
   [-Expand <String>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Description

Gets an availability group listener.

Examples

Example 1: Get all Availability Group Listeners of a SQL Virtual Machine Group

Get-AzAvailabilityGroupListener -ResourceGroupName 'ResourceGroup01' -SqlVMGroupName 'SqlVmGroup01'

Name            ResourceGroupName
----            -----------------
AgListener01    ResourceGroup01
AgListener02    ResourceGroup01

Example 2: Get one Availability Group Listener of a SQL Virtual Machine Group

Get-AzAvailabilityGroupListener -ResourceGroupName 'ResourceGroup01' -SqlVMGroupName 'SqlVmGroup01' -Name 'AgListener01'

Name            ResourceGroupName
----            -----------------
AgListener01    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

-Expand

The child resources to include in the response.

Type:	String
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 availability group listener.

Type:	String
Aliases:	AvailabilityGroupListenerName
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

-SqlVMGroupName

Name of the SQL virtual machine group.

Type:	String
Aliases:	GroupName
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

IAvailabilityGroupListener

Notes

ALIASES

COMPLEX PARAMETER PROPERTIES

To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables.

INPUTOBJECT <ISqlVirtualMachineIdentity>: Identity Parameter

• [AvailabilityGroupListenerName <String>]: Name of the availability group listener.
• [Id <String>]: Resource identity path
• [ResourceGroupName <String>]: Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
• [SqlVirtualMachineGroupName <String>]: Name of the SQL virtual machine group.
• [SqlVirtualMachineName <String>]: Name of the SQL virtual machine.
• [SubscriptionId <String>]: Subscription ID that identifies an Azure subscription.