< Back

New-AzureRmRelayAuthorizationRule

Tue Jan 29, 2019 10:04 pm

NAME New-AzureRmRelayAuthorizationRule



SYNOPSIS

Creates a new authorization rule for the specified Relay entities (Namespace/WcfRelay/HybridConnection).





SYNTAX

New-AzureRmRelayAuthorizationRule [-ResourceGroupName] <String> [[-Namespace] <String>] [-HybridConnection] <String> [-Name] <String>

[-DefaultProfile <IAzureContextContainer>] -Rights {Listen | Send | Manage} [-Confirm] [-WhatIf] [<CommonParameters>]



New-AzureRmRelayAuthorizationRule [-ResourceGroupName] <String> [-Namespace] <String> [-Name] <String> [-DefaultProfile <IAzureContextContainer>]

-Rights {Listen | Send | Manage} [-Confirm] [-WhatIf] [<CommonParameters>]



New-AzureRmRelayAuthorizationRule [-ResourceGroupName] <String> [[-Namespace] <String>] [-WcfRelay] <String> [-Name] <String> [-DefaultProfile

<IAzureContextContainer>] -Rights {Listen | Send | Manage} [-Confirm] [-WhatIf] [<CommonParameters>]





DESCRIPTION

The New-AzureRmRelayAuthorizationRule cmdlet creates a new authorization rule for the specified 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



-Rights <String[]>

Rights, e.g. "Listen","Send","Manage"



Required? true

Position? named

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



-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



-Rights

System.String []





OUTPUTS

Microsoft.Azure.Commands.Relay.Models.AuthorizationRuleAttributes





Example 1 - Namespace

Rights : {Listen} 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



Example 2 - WcfRelay

Rights : {Listen} 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/A

uthoRule1



Example 3 - HybridConnection

Rights : {Listen} 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/autho

rizationRules/AuthoRule1





NOTES









Example 1 - Namespace



PS C:\\>New-AzureRmRelayAuthorizationRule -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameSpace-Relay1 -Name AuthoRule1 -Rights

"Listen"



Creates `AuthoRule1` with Listen rights for the namespace `TestNameSpace-Relay1`.





Example 2 - WcfRelay



PS C:\\>New-AzureRmRelayAuthorizationRule -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameSpace-Relay1 -WcfRelay TestWCFRelay1

-Name AuthoRule1 -Rights "Listen"



Creates authorization rule `AuthoRule1` with Listen rights for the WcfRelay `TestWCFRelay1`.





Example 3 - HybridConnection



PS C:\\>New-AzureRmRelayAuthorizationRule -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameSpace-Relay1 -HybridConnection

TestHybridConnection -Name AuthoRule1 -Rights "Listen"



Creates `AuthoRule1` with Listen rights for the namespace `TestNameSpace-Relay1`.







RELATED LINKS

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