Namespaces - CheckName Availability - Check Name Availability

Service:

Service Bus

API Version:

2024-01-01

Check the give namespace name availability.

POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.ServiceBus/CheckNameAvailability?api-version=2024-01-01

URI Parameters

Name	In	Required	Type	Description
subscriptionId	path	True	string	Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
api-version	query	True	string	The API version to use for this operation.

Request Body

Name	Required	Type	Description
name	True	string	The Name to check the namespace name availability and The namespace name can contain only letters, numbers, and hyphens. The namespace must start with a letter, and it must end with a letter or number.

Responses

Name	Type	Description
200 OK	CheckNameAvailabilityResult	check availability returned successfully.
Other Status Codes	ErrorResponse	ServiceBus error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

NameSpaceCheckNameAvailability

Sample request

HTTP

POST https://management.azure.com/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/providers/Microsoft.ServiceBus/CheckNameAvailability?api-version=2024-01-01

{
  "name": "sdk-Namespace-2924"
}

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.ServiceBus.Models;
using Azure.ResourceManager.ServiceBus;

// Generated from example definition: specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2024-01-01/examples/NameSpaces/SBNameSpaceCheckNameAvailability.json
// this example is just showing the usage of "Namespaces_CheckNameAvailability" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SubscriptionResource created on azure
// for more information of creating SubscriptionResource, please refer to the document of SubscriptionResource
string subscriptionId = "5f750a97-50d9-4e36-8081-c9ee4c0210d4";
ResourceIdentifier subscriptionResourceId = SubscriptionResource.CreateResourceIdentifier(subscriptionId);
SubscriptionResource subscriptionResource = client.GetSubscriptionResource(subscriptionResourceId);

// invoke the operation
ServiceBusNameAvailabilityContent content = new ServiceBusNameAvailabilityContent("sdk-Namespace-2924");
ServiceBusNameAvailabilityResult result = await subscriptionResource.CheckServiceBusNamespaceNameAvailabilityAsync(content);

Console.WriteLine($"Succeeded: {result}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:

200

{
  "nameAvailable": true,
  "reason": "None",
  "message": ""
}

Definitions

Name	Description
CheckNameAvailability	Description of a Check Name availability request properties.
CheckNameAvailabilityResult	Description of a Check Name availability request properties.
Error	The error object.
ErrorAdditionalInfo	The resource management error additional info.
ErrorResponse	The resource management error response.
UnavailableReason	Specifies the reason for the unavailability of the service.

CheckNameAvailability

Object

Description of a Check Name availability request properties.

Name	Type	Description
name	string	The Name to check the namespace name availability and The namespace name can contain only letters, numbers, and hyphens. The namespace must start with a letter, and it must end with a letter or number.

CheckNameAvailabilityResult

Object

Description of a Check Name availability request properties.

Name	Type	Description
message	string	The detailed info regarding the reason associated with the namespace.
nameAvailable	boolean	Value indicating namespace is availability, true if the namespace is available; otherwise, false.
reason	UnavailableReason	The reason for unavailability of a namespace.

Error

Object

The error object.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorResponse[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorAdditionalInfo

Object

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorResponse

Object

The resource management error response.

Name	Type	Description
error	Error	The error object.

UnavailableReason

Enumeration

Specifies the reason for the unavailability of the service.

Value	Description
InvalidName
NameInLockdown
NameInUse
None
SubscriptionIsDisabled
TooManyNamespaceInCurrentSubscription