Test-AzServiceBusNameAvailability

Reference

Module:: Az.ServiceBus

Checks the Availability of the given Queue or Topic name

Note

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

Syntax

Test-AzServiceBusNameAvailability
    [-ResourceGroupName] <String>
    [-Namespace] <String>
    [-Name] <String>
    [-Queue]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

Test-AzServiceBusNameAvailability
    [-ResourceGroupName] <String>
    [-Namespace] <String>
    [-Name] <String>
    [-Topic]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

Description

The Test-AzServiceBusNameAvailability Cmdlet Check Availability of the provided Name of Queue or Topic

Examples

Example 1

Test-AzServiceBusNameAvailability -ResourceGroupName $resourceGroupName -Namespace $namespaceName -Name $nameQueue -Queue

True

Returns True if the Provided $nameQueue name is Availabile or returns False if Provided $nameQueue name in not available

Example 2

Test-AzServiceBusNameAvailability -ResourceGroupName $resourceGroupName -Namespace $namespaceName -Name $nameTopic -Topic

True

Returns True if the Provided $nameTopic name is Availabile or returns False if Provided $nameTopic name in not available

Parameters

-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

-Name

Queue Name to check the Name Availability

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

-Namespace

Servicebus Namespace Name

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

-Queue

To Check Name Availability for Queue Name

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

-ResourceGroupName

Resource Group Name

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

-Topic

To Check Name Availability for Topic Name

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

Inputs

String

Outputs

Boolean