Get-AzRelayAuthorizationRule

Reference

Module:: Az.Relay

Authorization rule for a namespace by name.

Syntax

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

Get-AzRelayAuthorizationRule
   -Namespace <String>
   -ResourceGroupName <String>
   [-SubscriptionId <String[]>]
   -HybridConnection <String>
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Get-AzRelayAuthorizationRule
   -Namespace <String>
   -ResourceGroupName <String>
   [-SubscriptionId <String[]>]
   -WcfRelay <String>
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

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

Get-AzRelayAuthorizationRule
   -Namespace <String>
   -ResourceGroupName <String>
   [-SubscriptionId <String[]>]
   -Name <String>
   -HybridConnection <String>
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Get-AzRelayAuthorizationRule
   -Namespace <String>
   -ResourceGroupName <String>
   [-SubscriptionId <String[]>]
   -Name <String>
   -WcfRelay <String>
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Get-AzRelayAuthorizationRule
   -InputObject <IRelayIdentity>
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Description

Authorization rule for a namespace by name.

Examples

Example 1: List all Authorization Rules of the Relay namespace

Get-AzRelayAuthorizationRule -ResourceGroupName lucas-relay-rg -Namespace namespace-pwsh01

Location Name                      ResourceGroupName
-------- ----                      -----------------
eastus   RootManageSharedAccessKey lucas-relay-rg
eastus   authRule-03               lucas-relay-rg

This cmdlet lists all Authorization Rules of the Relay namespace.

Example 2: Get the specified authorization rule description for a given Relay namespace

Get-AzRelayAuthorizationRule -ResourceGroupName lucas-relay-rg -Namespace namespace-pwsh01 -Name authRule-03 | Format-List

Id                           : /subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourcegroups/lucas-relay-rg/providers/Microsoft.Relay/namespaces/namespa
                               ce-pwsh01/authorizationrules/authRule-03
Location                     : eastus
Name                         : authRule-03
ResourceGroupName            : lucas-relay-rg
Rights                       : {Listen, Send}
SystemDataCreatedAt          : 
SystemDataCreatedBy          : 
SystemDataCreatedByType      : 
SystemDataLastModifiedAt     : 
SystemDataLastModifiedBy     : 
SystemDataLastModifiedByType : 
Type                         : Microsoft.Relay/Namespaces/AuthorizationRules

This cmdlet gets the specified authorization rule description for a given Relay namespace.

Example 3: List all Authorization Rules of the Hybrid Connection

Get-AzRelayAuthorizationRule -ResourceGroupName lucas-relay-rg -Namespace namespace-pwsh01 -HybridConnection connection-01

Location Name        ResourceGroupName
-------- ----        -----------------
eastus   authRule-01 lucas-relay-rg

This cmdlet lists all Authorization Rules of the Hybrid Connection.

Example 4: Get the specified authorization rule description for a given Hybrid Connection

Get-AzRelayAuthorizationRule -ResourceGroupName lucas-relay-rg -Namespace namespace-pwsh01 -HybridConnection connection-01 -Name authRule-01 | Format-List

Id                           : /subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourcegroups/lucas-relay-rg/providers/Microsoft.Relay/namespaces/namespa
                               ce-pwsh01/hybridconnections/connection-01/authorizationrules/authRule-01
Location                     : eastus
Name                         : authRule-01
ResourceGroupName            : lucas-relay-rg
Rights                       : {Listen, Send}
SystemDataCreatedAt          : 
SystemDataCreatedBy          : 
SystemDataCreatedByType      : 
SystemDataLastModifiedAt     : 
SystemDataLastModifiedBy     : 
SystemDataLastModifiedByType : 
Type                         : Microsoft.Relay/namespaces/hybridconnections/authorizationrules

This cmdlet gets the specified authorization rule description for a given Hybrid Connection.

Example 5: List all Authorization Rules of the Wcf Relay

Get-AzRelayAuthorizationRule -ResourceGroupName lucas-relay-rg -Namespace namespace-pwsh01 -WcfRelay wcf-01

Location Name        ResourceGroupName
-------- ----        -----------------
eastus   authRule-01 lucas-relay-rg

This cmdlet lists all Authorization Rules of the Wcf Relay.

Example 6: Get the specified authorization rule description for a given Wcf Relay

Get-AzRelayAuthorizationRule -ResourceGroupName lucas-relay-rg -Namespace namespace-pwsh01 -WcfRelay connection-01 -Name authRule-01 | Format-List

Id                           : /subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourcegroups/lucas-relay-rg/providers/Microsoft.Relay/namespaces/namespa
                               ce-pwsh01/wcfrelays/connection-01/authorizationrules/authRule-01
Location                     : eastus
Name                         : authRule-01
ResourceGroupName            : lucas-relay-rg
Rights                       : {Listen, Send}
SystemDataCreatedAt          : 
SystemDataCreatedBy          : 
SystemDataCreatedByType      : 
SystemDataLastModifiedAt     : 
SystemDataLastModifiedBy     : 
SystemDataLastModifiedByType : 
Type                         : Microsoft.Relay/namespaces/wcfrelays/authorizationrules

This cmdlet gets the specified authorization rule description for a given Wcf Relay.

Example 7: Get the specified authorization rule description by pipeline

Get-AzRelayAuthorizationRule -ResourceGroupName lucas-relay-rg -Namespace namespace-pwsh01 | Get-AzRelayAuthorizationRule

Location Name                      ResourceGroupName
-------- ----                      -----------------
eastus   RootManageSharedAccessKey lucas-relay-rg
eastus   authRule-03               lucas-relay-rg

This cmdlet gets the specified authorization rule description by pipeline.

Parameters

-DefaultProfile

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

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

-HybridConnection

The hybrid connection name.

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

-Name

The authorization rule name.

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

-Namespace

The namespace name

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

-ResourceGroupName

Name of the Resource group within the Azure subscription.

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

-SubscriptionId

Subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

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

-WcfRelay

The relay name.

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

Inputs

IRelayIdentity

Outputs

IAuthorizationRule

Share via