Remove-AzServiceBusNamespace

Reference

Module:: Az.ServiceBus

Removes the namespace from the specified resource group.

Syntax

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

Remove-AzServiceBusNamespace
      [-InputObject] <PSNamespaceAttributes>
      [-PassThru]
      [-AsJob]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

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

Description

The Remove-AzServiceBusNamespace cmdlet removes the namespace from the specified resource group.

Examples

Example 1

Remove-AzServiceBusNamespace -ResourceGroup Default-ServiceBus-WestUS -NamespaceName SB-Example1

Removes the Service Bus namespace SB-Example1 from the specified resource group Default-ServiceBus-WestUS.

Example 2.1 - InputObject - Using variable:

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

Removes the Service Bus namespace provided through the $inputobject.

Example 2.2 - InputObject - Using Piping:

Get-AzServiceBusNamespace <params> | Remove-AzServiceBusNamespace

Removes the Service Bus namespace using Piping.

Example 3 - ResourceId

$ResourceId = (Get-AzResource -ResourceType Microsoft.ServiceBus/namespaces).ResourceId
Remove-AzServiceBusNamespace -ResourceId $resourceid

Removes the Service Bus namespace provided through ARM id in $resourceid for -ResourceId parameter or through piping.

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 Namespace Object

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

-Name

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 Namespace Resource Id

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

PSNamespaceAttributes

Outputs

Boolean