Get-AzAvailabilityGroupListener
Gets an availability group listener.
Syntax
List (Default)
Get-AzAvailabilityGroupListener
-ResourceGroupName <String>
-SqlVMGroupName <String>
[-SubscriptionId <String[]>]
[-DefaultProfile <PSObject>]
[<CommonParameters>]
Get
Get-AzAvailabilityGroupListener
-Name <String>
-ResourceGroupName <String>
-SqlVMGroupName <String>
[-SubscriptionId <String[]>]
[-Expand <String>]
[-DefaultProfile <PSObject>]
[<CommonParameters>]
GetViaIdentity
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.
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
-Expand
The child resources to include in the response.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
Get
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
GetViaIdentity
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 availability group listener.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False Aliases: AvailabilityGroupListenerName
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
List
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
Get
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-SqlVMGroupName
Name of the SQL virtual machine group.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False Aliases: GroupName
Parameter sets
List
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
Get
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
List
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
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
