< Back
Set-AzureRmRelayAuthorizationRule
Post
NAME Set-AzureRmRelayAuthorizationRule
SYNOPSIS
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>
[[-InputObject] <AuthorizationRuleAttributes>] [[-Rights] <String[]>] [-DefaultProfile <IAzureContextContainer>] [-Confirm] [-WhatIf]
[<CommonParameters>]
Set-AzureRmRelayAuthorizationRule [-ResourceGroupName] <String> [-Namespace] <String> [-Name] <String> [[-InputObject]
<AuthorizationRuleAttributes>] [[-Rights] <String[]>] [-DefaultProfile <IAzureContextContainer>] [-Confirm] [-WhatIf] [<CommonParameters>]
Set-AzureRmRelayAuthorizationRule [-ResourceGroupName] <String> [[-Namespace] <String>] [-WcfRelay] <String> [-Name] <String> [[-InputObject]
<AuthorizationRuleAttributes>] [[-Rights] <String[]>] [-DefaultProfile <IAzureContextContainer>] [-Confirm] [-WhatIf] [<CommonParameters>]
Set-AzureRmRelayAuthorizationRule [-ResourceGroupName] <String> [-Name] <String> [-InputObject] <AuthorizationRuleAttributes> [-DefaultProfile
<IAzureContextContainer>] [-Confirm] [-WhatIf] [<CommonParameters>]
Set-AzureRmRelayAuthorizationRule [-ResourceGroupName] <String> [-Name] <String> [-Rights] <String[]> [-DefaultProfile <IAzureContextContainer>]
[-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The Set-AzureRmRelayAuthorizationRule cmdlet updates the description for the specified authorization rule of 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
-InputObject <AuthorizationRuleAttributes>
Relay AuthorizationRule Object
Required? false
Position? 4
Default value None
Accept pipeline input? False
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
-Rights <String[]>
Rights, e.g. @("Listen","Send","Manage")
Required? false
Position? 4
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-WcfRelay <String>
WcfRelay Name.
Required? true
Position? 2
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? false
Position? named
Default value False
Accept pipeline input? False
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
-Namespace
System.String
-WcfRelay
System.String
-HybridConnection
System.String
-Name
System.String
-InputObject
Microsoft.Azure.Commands.Relay.Models.AuthorizationRuleAttributes
-Rights
System.String []
OUTPUTS
Microsoft.Azure.Commands.Relay.Models.AuthorizationRuleAttributes
Example 1 - Namespace
Rights : {Listen, Send} Name : AuthoRule1 Type : Microsoft.Relay/AuthorizationRules Id : /subscriptions/854d368f-1828-428f-8f3c-f2affa9
b2f7d/resourceGroups/Default-ServiceBus-WestUS/providers/Microsoft.Relay/namespaces/TestNameSpace-Relay1/AuthorizationRules/AuthoRule1
Example 2 - WcfRelay
Rights : {Listen, Send} Name : AuthoRule1 Type : Microsoft.Relay/AuthorizationRules Id : /subscriptions/854d368f-1828-428f-8f3c-f2affa9
b2f7d/resourceGroups/Default-ServiceBus-WestUS/providers/Microsoft.Relay/namespaces/TestNameSpace-Relay1/WcfRelays/TestWCFRelay1/authorizationR
ules/AuthoRule1
Example 3 - HybridConnection
Rights : {Listen, Send} Name : AuthoRule1 Type : Microsoft.Relay/AuthorizationRules Id : /subscriptions/854d368f-1828-428f-8f3c-f2affa9
b2f7d/resourceGroups/Default-ServiceBus-WestUS/providers/Microsoft.Relay/namespaces/TestNameSpace-Relay1/HybridConnections/TestHybridConnection
/authorizationRules/AuthoRule1
NOTES
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`.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... zationrule
SYNOPSIS
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>
[[-InputObject] <AuthorizationRuleAttributes>] [[-Rights] <String[]>] [-DefaultProfile <IAzureContextContainer>] [-Confirm] [-WhatIf]
[<CommonParameters>]
Set-AzureRmRelayAuthorizationRule [-ResourceGroupName] <String> [-Namespace] <String> [-Name] <String> [[-InputObject]
<AuthorizationRuleAttributes>] [[-Rights] <String[]>] [-DefaultProfile <IAzureContextContainer>] [-Confirm] [-WhatIf] [<CommonParameters>]
Set-AzureRmRelayAuthorizationRule [-ResourceGroupName] <String> [[-Namespace] <String>] [-WcfRelay] <String> [-Name] <String> [[-InputObject]
<AuthorizationRuleAttributes>] [[-Rights] <String[]>] [-DefaultProfile <IAzureContextContainer>] [-Confirm] [-WhatIf] [<CommonParameters>]
Set-AzureRmRelayAuthorizationRule [-ResourceGroupName] <String> [-Name] <String> [-InputObject] <AuthorizationRuleAttributes> [-DefaultProfile
<IAzureContextContainer>] [-Confirm] [-WhatIf] [<CommonParameters>]
Set-AzureRmRelayAuthorizationRule [-ResourceGroupName] <String> [-Name] <String> [-Rights] <String[]> [-DefaultProfile <IAzureContextContainer>]
[-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The Set-AzureRmRelayAuthorizationRule cmdlet updates the description for the specified authorization rule of 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
-InputObject <AuthorizationRuleAttributes>
Relay AuthorizationRule Object
Required? false
Position? 4
Default value None
Accept pipeline input? False
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
-Rights <String[]>
Rights, e.g. @("Listen","Send","Manage")
Required? false
Position? 4
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-WcfRelay <String>
WcfRelay Name.
Required? true
Position? 2
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? false
Position? named
Default value False
Accept pipeline input? False
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
-Namespace
System.String
-WcfRelay
System.String
-HybridConnection
System.String
-Name
System.String
-InputObject
Microsoft.Azure.Commands.Relay.Models.AuthorizationRuleAttributes
-Rights
System.String []
OUTPUTS
Microsoft.Azure.Commands.Relay.Models.AuthorizationRuleAttributes
Example 1 - Namespace
Rights : {Listen, Send} Name : AuthoRule1 Type : Microsoft.Relay/AuthorizationRules Id : /subscriptions/854d368f-1828-428f-8f3c-f2affa9
b2f7d/resourceGroups/Default-ServiceBus-WestUS/providers/Microsoft.Relay/namespaces/TestNameSpace-Relay1/AuthorizationRules/AuthoRule1
Example 2 - WcfRelay
Rights : {Listen, Send} Name : AuthoRule1 Type : Microsoft.Relay/AuthorizationRules Id : /subscriptions/854d368f-1828-428f-8f3c-f2affa9
b2f7d/resourceGroups/Default-ServiceBus-WestUS/providers/Microsoft.Relay/namespaces/TestNameSpace-Relay1/WcfRelays/TestWCFRelay1/authorizationR
ules/AuthoRule1
Example 3 - HybridConnection
Rights : {Listen, Send} Name : AuthoRule1 Type : Microsoft.Relay/AuthorizationRules Id : /subscriptions/854d368f-1828-428f-8f3c-f2affa9
b2f7d/resourceGroups/Default-ServiceBus-WestUS/providers/Microsoft.Relay/namespaces/TestNameSpace-Relay1/HybridConnections/TestHybridConnection
/authorizationRules/AuthoRule1
NOTES
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`.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... zationrule