Set-​Azure​Rm​Relay​Authorization​Rule

Updates the specified authorization rule description for the given Relay entities (Namespace/WcfRelay/HybridConnection).

Syntax

Set-AzureRmRelayAuthorizationRule
   [-ResourceGroupName] <String>
   [[-Namespace] <String>]
   [-HybridConnection] <String>
   [-Name] <String>
   [-Confirm]
   -Rights <String[]>
   [-WhatIf]
   [<CommonParameters>]
Set-AzureRmRelayAuthorizationRule
   [-ResourceGroupName] <String>
   [-Namespace] <String>
   [-Name] <String>
   [-Confirm]
   -Rights <String[]>
   [-WhatIf]
   [<CommonParameters>]
Set-AzureRmRelayAuthorizationRule
   [-ResourceGroupName] <String>
   [[-Namespace] <String>]
   [-WcfRelay] <String>
   [-Name] <String>
   [-Confirm]
   -Rights <String[]>
   [-WhatIf]
   [<CommonParameters>]

Description

The Set-AzureRmRelayAuthorizationRule cmdlet updates the description for the specified authorization rule of the given Relay entities (Namespace/WcfRelay/HybridConnection).

Examples

Example 1.1 - Namespace with InputObject

PS C:\>
PS C:\> $getAutoRule = Get-AzureRmRelayAuthorizationRule -ResourceGroupName Default-ServiceBus-WestUS -NamespaceName TestNameSpace-Relay1 -AuthorizationRuleName
 AuthoRule1
PS C:\> $getAutoRule.Rights.Add("Send")
PS C:\> Set-AzureRmRelayAuthorizationRule -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameSpace-Relay1 -AuthorizationRule AuthoRule1 -InputObject $getAutoRule

Adds Send from the access rights of the authorization rule AuthoRule1 in namespace TestNameSpace-Relay1.

Example 1.2 - Namespace with Rights parameter

PS C:\> Set-AzureRmRelayAuthorizationRule -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameSpace-Relay1 -AuthorizationRule AuthoRule1 -Rights "Send"

Adds Send from the access rights of the authorization rule AuthoRule1 in namespace TestNameSpace-Relay1.

Example 2.1 - WcfRelay with InputObject

PS C:\> $getWcfRelayAutho = Get-AzureRmRelayAuthorizationRule -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameSpace-Relay1 -WcfRelay TestWCFRelay1 -Name AuthoRule1
PS C:\> $getWcfRelayAutho.Rights.Add("Send")
PS C:\> Set-AzureRmRelayAuthorizationRule -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameSpace-Relay1 -WcfRelay TestWCFRelay1 -Name AuthoRule1 -InputObject $getWcfRelayAutho

Adds Send to the access rights of the authorization rule AuthoRule1 of the WcfRelay TestWCFRelay1.

Example 2.2 - WcfRelay with Rights parameter

PS C:\> Set-AzureRmRelayAuthorizationRule -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameSpace-Relay1 -WcfRelay TestWCFRelay1 -Name AuthoRule1 -Rights "Send"

Adds Send to the access rights of the authorization rule AuthoRule1 of the WcfRelay TestWCFRelay1.

Example 3.1 - HybridConnection with InputObject

PS C:\> $GetHybirdAutho = Get-AzureRmRelayAuthorizationRule -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameSpace-Relay1 -HybridConnection TestHybridConnection -Name AuthoRule1
PS C:\> $GetHybirdAutho.Rights.Add("Send")
PS C:\> Set-AzureRmRelayAuthorizationRule -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameSpace-Relay1 -HybridConnection TestHybridConnection -Name AuthoRule1 -InputObject $GetHybirdAutho

Adds Send to the access rights of the authorization rule AuthoRule1 of the HybridConnection TestHybridConnection.

Example 3.2 - HybridConnection with Rights parameter

PS C:\> Set-AzureRmRelayAuthorizationRule -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameSpace-Relay1 -HybridConnection TestHybridConnection -Name AuthoRule1 -Rights "Send"

Adds Send to the access rights of the authorization rule AuthoRule1 of the HybridConnection TestHybridConnection.

Required Parameters

-HybridConnection

HybridConnection Name.

Type:String
Position:2
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-Name

AuthorizationRule Name.

Type:String
Position:3
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-Namespace

Namespace Name.

Type:String
Position:1
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-ResourceGroupName

Resource Group Name.

Type:String
Position:0
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-Rights

Rights, e.g. @("Listen","Send","Manage")

Type:String[]
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-WcfRelay

WcfRelay Name.

Type:String
Position:2
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

Optional Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

Inputs

-ResourceGroupName

System.String

Inputs

-Namespace

System.String

Inputs

-WcfRelay

System.String

Inputs

-HybridConnection

System.String

Inputs

-Name

System.String

Inputs

-InputObject

Microsoft.Azure.Commands.Relay.Models.AuthorizationRuleAttributes

Inputs

-Rights

System.String []

Outputs

Microsoft.Azure.Commands.Relay.Models.AuthorizationRuleAttributes

Outputs

Example 1 - Namespace

Rights : {Listen, Send} Name : AuthoRule1 Type : Microsoft.Relay/AuthorizationRules Id : /subscriptions/854d368f-1828-428f-8f3c-f2affa9b2f7d/resourceGroups/Default-ServiceBus-WestUS/providers/Microsoft.Relay/namespaces/TestNameSpace-Relay1/AuthorizationRules/AuthoRule1

Outputs

Example 2 - WcfRelay

Rights : {Listen, Send} Name : AuthoRule1 Type : Microsoft.Relay/AuthorizationRules Id : /subscriptions/854d368f-1828-428f-8f3c-f2affa9b2f7d/resourceGroups/Default-ServiceBus-WestUS/providers/Microsoft.Relay/namespaces/TestNameSpace-Relay1/WcfRelays/TestWCFRelay1/authorizationRules/AuthoRule1

Outputs

Example 3 - HybridConnection

Rights : {Listen, Send} Name : AuthoRule1 Type : Microsoft.Relay/AuthorizationRules Id : /subscriptions/854d368f-1828-428f-8f3c-f2affa9b2f7d/resourceGroups/Default-ServiceBus-WestUS/providers/Microsoft.Relay/namespaces/TestNameSpace-Relay1/HybridConnections/TestHybridConnection/authorizationRules/AuthoRule1