Get-AzSignalR
Get a specific SignalR service or all the SignalR services in a resource group or a subscription.
Syntax
ListSignalRServiceParameterSet (Default)
Get-AzSignalR
[-ResourceGroupName <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
ResourceGroupParameterSet
Get-AzSignalR
[-Name] <String>
[-ResourceGroupName <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
ResourceIdParameterSet
Get-AzSignalR
-ResourceId <String>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Description
Get a specific SignalR service or all the SignalR services in a resource group or a subscription.
Examples
Example 1: Get all SignalR services in the subscription
Get-AzSignalR
HostName Location ServerPort PublicPort ProvisioningState Version
-------- -------- ---------- ---------- ----------------- -------
mysignalr1.service.signalr.net eastus 5002 5001 Succeeded 1.0
mysignalr2.service.signalr.net eastus 5002 5001 Succeeded 1.0
mysignalr3.service.signalr.net eastus 5002 5001 Creating 1.0
Example 2: Get all SignalR services in a resource group
Get-AzSignalR -ResourceGroupName myResourceGroup
HostName Location ServerPort PublicPort ProvisioningState Version
-------- -------- ---------- ---------- ----------------- -------
mysignalr1.service.signalr.net eastus 5002 5001 Succeeded 1.0
mysignalr2.service.signalr.net eastus 5002 5001 Succeeded 1.0
Example 3: Get a specific SignalR service
Get-AzSignalR -ResourceGroupName myResourceGroup -Name mysignalr1
HostName Location ServerPort PublicPort ProvisioningState Version
-------- -------- ---------- ---------- ----------------- -------
mysignalr1.service.signalr.net eastus 5002 5001 Succeeded 1.0
Example 4: Get a specific SignalR service from the default resource group
Get-AzSignalR -Name mysignalr2
HostName Location ServerPort PublicPort ProvisioningState Version
-------- -------- ---------- ---------- ----------------- -------
mysignalr2.service.signalr.net eastus 5002 5001 Succeeded 1.0
The default resource group can be set by `Set-AzDefault -ResourceGroupName myResourceGroup`.
Parameters
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with Azure.
Parameter properties
Type: IAzureContextContainer
Default value: None Supports wildcards: False DontShow: False Aliases: AzContext, 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
-Name
SignalR service name.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
ResourceGroupParameterSet
Position: 0 Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ResourceGroupName
Resource group name.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
ListSignalRServiceParameterSet
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
ResourceGroupParameterSet
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ResourceId
The SignalR service resource ID.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
ResourceIdParameterSet
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: True 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
