Remove-AzServiceBusRule

Reference

Module:: Az.ServiceBus

Removes the specified rule of a given subscription .

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Syntax

Remove-AzServiceBusRule
      [-ResourceGroupName] <String>
      [-Namespace] <String>
      [-Topic] <String>
      [-Subscription] <String>
      [-Name] <String>
      [-PassThru]
      [-AsJob]
      [-Force]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Remove-AzServiceBusRule
      [-InputObject] <PSTopicAttributes>
      [-ResourceId] <String>
      [-PassThru]
      [-AsJob]
      [-Force]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

The Remove-AzServiceBusRule cmdlet removes the rule of a subscription of given topic.

Examples

Example 1

Remove-AzServiceBusRule -ResourceGroup Default-ServiceBus-WestUS -Namespace SBExample1 -Topic SBTopic -Subscription SBSubscription -Name SBRule

Removes the rule SBRule of subscription SBSubscription of specified topic SBTopic.

Example 2: InputObject - Using Variable:

$inputobject = Get-AzServiceBusRule <params>
Remove-AzServiceBusRule -InputObject $inputobject

Removes the rule provided through $inputobject for -InputObject parameter

Example 3: InputObject - Using Piping:

Get-AzServiceBusRule <params> | Remove-AzServiceBusRule

Example 4: ResourceId - Using Variable

$resourceid = Get-AzServiceBusRule <params>
Remove-AzServiceBusRule -ResourceId $resourceid.Id

Example 5: ResourceId - Using string value

Remove-AzServiceBusRule -ResourceId "/subscriptions/xxx-xxxxx-xxxxxx-xxxxxx/resourceGroups/ResourceGroupName/providers/Microsoft.ServiceBus/namespaces/NamespaceName/topics/TopicName/subscriptions/SubscriptionName/rules/RuleName"

Removes the rule provided through ARM Id in $resourceid/string for -ResourceId parameter

Parameters

-AsJob

Run cmdlet in the background

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

-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

-DefaultProfile

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

Type:	IAzureContextContainer
Aliases:	AzContext, AzureRmContext, AzureCredential
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-Force

Do not ask for confirmation.

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

-InputObject

Service Bus Rule Object

Type:	PSTopicAttributes
Position:	0
Default value:	None
Accept pipeline input:	True
Accept wildcard characters:	False

-Name

Rule Name

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

-Namespace

Namespace Name

Type:	String
Aliases:	NamespaceName
Position:	1
Default value:	None
Accept pipeline input:	True
Accept wildcard characters:	False

-PassThru

Specifying this will return true if the command was successful.

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

-ResourceGroupName

The name of the resource group

Type:	String
Aliases:	ResourceGroup
Position:	0
Default value:	None
Accept pipeline input:	True
Accept wildcard characters:	False

-ResourceId

Service Bus Rule Resource Id

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

-Subscription

Subscription Name

Type:	String
Aliases:	SubscriptionName
Position:	3
Default value:	None
Accept pipeline input:	True
Accept wildcard characters:	False

-Topic

Topic Name

Type:	String
Aliases:	TopicName
Position:	2
Default value:	None
Accept pipeline input:	True
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

String

PSTopicAttributes

Outputs

Boolean