Edit

Remove-AzServiceBusQueue

  • Reference
Module:
Az.ServiceBus

Removes the queue 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-AzServiceBusQueue
      [-ResourceGroupName] <String>
      [-Namespace] <String>
      [-Name] <String>
      [-PassThru]
      [-AsJob]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Remove-AzServiceBusQueue
      [-InputObject] <PSQueueAttributes>
      [-PassThru]
      [-AsJob]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Remove-AzServiceBusQueue
      [-ResourceId] <String>
      [-PassThru]
      [-AsJob]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

The Remove-AzServiceBusQueue cmdlet removes the queue from the specified Service Bus namespace.

Examples

Example 1

Remove-AzServiceBusQueue -ResourceGroup Default-ServiceBus-WestUS -NamespaceName SB-Example1 -QueueName SB-Queue_exampl1

Removes the Service Bus queue SB-Queue_exampl1 from the namespace SB-Example1.

Example 2: InputObject - Using variable:

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

Removes the Service Bus queue provided in the $inputobject for -InputObject parameter

Example 3: InputObject - Using Piping:

Get-AzServiceBusQueue <params> | Remove-AzServiceBusQueue

Example 4: ResourceId - Using variable:

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

Removes the Service Bus queue provided in the ARM id in $resourceid/string for -ResourceId parameter

Example 5: ResourceId - passing as string:

Remove-AzServiceBusQueue -ResourceId "/subscriptions/xxxx-xxxxx-xxxxx-xxxxxx-xxxxxxx/resourceGroups/ResourceGroupName/providers/Microsoft.ServiceBus/namespaces/NamespaceName/queues/QueueName"

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

Type:PSQueueAttributes
Position:0
Default value:None
Accept pipeline input:True
Accept wildcard characters:False
-Name

Queue Name

Type:String
Aliases:QueueName
Position:2
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 Queue 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

PSQueueAttributes

Outputs

Boolean