Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

Remove-AzureRmServiceBusAuthorizationRule

Removes the authorization rule of a Service Bus namespace or queue or topic from the specified resource group.

Warning

The AzureRM PowerShell module has been officially deprecated as of February 29, 2024. Users are advised to migrate from AzureRM to the Az PowerShell module to ensure continued support and updates.

Although the AzureRM module may still function, it's no longer maintained or supported, placing any continued use at the user's discretion and risk. Please refer to our migration resources for guidance on transitioning to the Az module.

Syntax

NamespaceAuthorizationRuleSet (Default)

Remove-AzureRmServiceBusAuthorizationRule
 [-ResourceGroupName] <String>
 [-Namespace] <String>
 [-Name] <String>
 [[-InputObject] <PSSharedAccessAuthorizationRuleAttributes>]
 [-Force]
 [-PassThru]
 [-DefaultProfile <IAzureContextContainer>]
 [-WhatIf]
 [-Confirm]
 [<CommonParameters>]

QueueAuthorizationRuleSet

Remove-AzureRmServiceBusAuthorizationRule
 [-ResourceGroupName] <String>
 [-Namespace] <String>
 [-Queue] <String>
 [-Name] <String>
 [[-InputObject] <PSSharedAccessAuthorizationRuleAttributes>]
 [-Force]
 [-PassThru]
 [-DefaultProfile <IAzureContextContainer>]
 [-WhatIf]
 [-Confirm]
 [<CommonParameters>]

TopicAuthorizationRuleSet

Remove-AzureRmServiceBusAuthorizationRule
 [-ResourceGroupName] <String>
 [-Namespace] <String>
 [-Topic] <String>
 [-Name] <String>
 [[-InputObject] <PSSharedAccessAuthorizationRuleAttributes>]
 [-Force]
 [-PassThru]
 [-DefaultProfile <IAzureContextContainer>]
 [-WhatIf]
 [-Confirm]
 [<CommonParameters>]

Description

The Remove-AzureRmServiceBusAuthorizationRule cmdlet removes the authorization rule of a Service Bus namespace or queue or topic for the specified resource group.

Examples

Example 1

PS C:\> Remove-AzureRmServiceBusAuthorizationRule -ResourceGroup Default-ServiceBus-WestUS -Namespace SB-Example1 -Name AuthoRule1

Removes the authorization rule SBAuthoRule1 of namespace SB-Example1 from the specified resource group.

Example 2

PS C:\> Remove-AzureRmServiceBusAuthorizationRule -ResourceGroup Default-ServiceBus-WestUS -Namespace SB-Example1 -Queue SBQueue -Name AuthoRule1

Removes the authorization rule SBAuthoRule1 of queue SBQueue from the specified resource group.

Example 3

PS C:\> Remove-AzureRmServiceBusAuthorizationRule -ResourceGroup Default-ServiceBus-WestUS -Namespace SB-Example1 -Topic SBTopic -Name AuthoRule1

Removes the authorization rule SBAuthoRule1 of topic SBTopic from the specified resource group.

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

-DefaultProfile

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

Parameter properties

Type:IAzureContextContainer
Default value:None
Supports wildcards:False
DontShow:False
Aliases:AzureRmContext, AzureCredential

Parameter sets

-Force

Do not ask for confirmation.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

-InputObject

ServiceBus AuthorizationRule Object

Parameter properties

Type:PSSharedAccessAuthorizationRuleAttributes
Default value:None
Supports wildcards:False
DontShow:False
Aliases:AuthRuleObj

Parameter sets

-Name

AuthorizationRule Name

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:AuthorizationRuleName

Parameter sets

-Namespace

Namespace Name

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:NamespaceName

Parameter sets

-PassThru

Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

-Queue

Queue Name

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:QueueName

Parameter sets

-ResourceGroupName

Resource Group Name

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

-Topic

Topic Name

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:TopicName

Parameter sets

-WhatIf

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

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

String

PSSharedAccessAuthorizationRuleAttributes

Parameters: InputObject (ByValue)

Outputs

Boolean