Remove-AzServiceBusSubscription

Reference

Module:: Az.ServiceBus

Removes the subscription to a topic from the specified Service Bus namespace.

Note

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

Syntax

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

Remove-AzServiceBusSubscription
      [-InputObject] <PSSubscriptionAttributes>
      [-PassThru]
      [-AsJob]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Remove-AzServiceBusSubscription
      [-ResourceId] <String>
      [-PassThru]
      [-AsJob]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

The Remove-AzServiceBusSubscription cmdlet removes the subscription to a topic from the specified Service Bus namespace.

Examples

Example 1

Remove-AzServiceBusSubscription -ResourceGroup Default-ServiceBus-WestUS -NamespaceName SB-Example1 -TopicName SB-Topic_exampl1 -SubscriptionName SB-TopicSubscription-Example1

Removes the subscription SB-TopicSubscription-Example1 to the topic SB-Topic_exampl1 in the specified Service Bus namespace SB-Example1.

Example 2: InputObject - Using Variable:

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

Example 3: InputObject - Using Piping:

Get-AzServiceBusSubscription <params> |Remove-AzServiceBusSubscription

Example 4: ResourceId - Using Variable:

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

Example 5: ResourceId - Using string value:

Remove-AzServiceBusSubscription -ResourceId "/subscriptions/Subscriptionid/resourceGroups/ResourceGroup/providers/Microsoft.ServiceBus/namespaces/NamespaceName/topics/TopicName/subscriptions/SubscriptionName"

Removes the subscription 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

-InputObject

Service Bus Subscription Object

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

-Name

Subscription Name

Type:	String
Aliases:	SubscriptionName
Position:	3
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 Subscription Resource Id

Type:	String
Position:	0
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

PSSubscriptionAttributes

Outputs

Boolean