Get-AzureRmRelayKey

NAME Get-AzureRmRelayKey



SYNOPSIS

Gets the primary and secondary connection strings for the given Relay entities (Namespace/WcfRelay/HybridConnection).





SYNTAX

Get-AzureRmRelayKey [-ResourceGroupName] <String> [[-Namespace] <String>] [-HybridConnection] <String> [-Name] <String> [-DefaultProfile

<IAzureContextContainer>] [<CommonParameters>]



Get-AzureRmRelayKey [-ResourceGroupName] <String> [-Namespace] <String> [-Name] <String> [-DefaultProfile <IAzureContextContainer>]

[<CommonParameters>]



Get-AzureRmRelayKey [-ResourceGroupName] <String> [[-Namespace] <String>] [-WcfRelay] <String> [-Name] <String> [-DefaultProfile

<IAzureContextContainer>] [<CommonParameters>]





DESCRIPTION

The Get-AzureRmRelayKey cmdlet returns the primary and secondary connection strings for the given Relay entities

(Namespace/WcfRelay/HybridConnection).





PARAMETERS

-DefaultProfile <IAzureContextContainer>

The credentials, account, tenant, and subscription used for communication with azure.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-HybridConnection <String>

HybridConnection Name.



Required? true

Position? 2

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Name <String>

AuthorizationRule Name.



Required? true

Position? 3

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Namespace <String>

Namespace Name.



Required? true

Position? 1

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-ResourceGroupName <String>

Resource Group Name.



Required? true

Position? 0

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-WcfRelay <String>

WcfRelay Name.



Required? true

Position? 2

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).



INPUTS

-ResourceGroupName

System.String



-NamespaceName

System.String



-HybridConnectionsName

System.String



-WcfRelayName

System.String



-Name

System.String





OUTPUTS

Microsoft.Azure.Commands.Relay.Models.AuthorizationRuleKeysAttributes





Example 1 - Namespace

PrimaryConnectionString : Endpoint=sb://testnamespace-relay1.servicebus.windows.net/;SharedAccessKeyName=AuthoRule1;SharedAccessKey=#########

################################### SecondaryConnectionString : Endpoint=sb://testnamespace-relay1.servicebus.windows.net/;SharedAccessKeyName=

AuthoRule1;SharedAccessKey=############################################ PrimaryKey :

############################################ SecondaryKey : ############################################ KeyName

: AuthoRule1



Example 2 - WcfRelay

PrimaryConnectionString : Endpoint=sb://testnamespace-relay1.servicebus.windows.net/;SharedAccessKeyName=AuthoRule1;SharedAccessKey=#########

###################################;EntityPath=TestWCFRelay1 SecondaryConnectionString : Endpoint=sb://testnamespace-relay1.servicebus.windows.

net/;SharedAccessKeyName=AuthoRule1;SharedAccessKey=############################################;EntityPath=TestWCFRelay1 PrimaryKey

: ############################################ SecondaryKey : ############################################ KeyName

: AuthoRule1



Example 3 - HybridConnection

PrimaryConnectionString : Endpoint=sb://testnamespace-relay1.servicebus.windows.net/;SharedAccessKeyName=AuthoRule1;SharedAccessKey=#########

###################################;EntityPath=TestHybridConnection SecondaryConnectionString : Endpoint=sb://testnamespace-relay1.servicebus.w

indows.net/;SharedAccessKeyName=AuthoRule1;SharedAccessKey=############################################;EntityPath=TestHybridConnection

PrimaryKey : ############################################ SecondaryKey :

############################################ KeyName : AuthoRule1





NOTES









Example 1 - Namespace



PS C:\\> Get-AzureRmRelayKey -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameSpace-Relay1 -Name AuthoRule1









Example 2 - WcfRelay



PS C:\\> Get-AzureRmRelayKey -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameSpace-Relay1 -WcfRelay TestWCFRelay1 -Name AuthoRule1









Example 3 - HybridConnection



PS C:\\> Get-AzureRmRelayKey -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameSpace-Relay1 -HybridConnection TestHybridConnection

-Name AuthoRule1



Primary and secondary connection string to the specified Relay entities (Namespace/WcfRelay/HybridConnection).







RELATED LINKS

Online Version: https://docs.microsoft.com/en-us/powers ... rmrelaykey