Disaster Recovery Configs - Check Name Availability

Check the give namespace name availability.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/disasterRecoveryConfigs/CheckNameAvailability?api-version=2017-04-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.

resourceGroupName
path True
  • string

Name of the Resource group within the Azure subscription.

namespaceName
path True
  • string

The namespace name

api-version
query True
  • string

Client API version.

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

check availability returned successfully.

Other Status Codes

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

AliasNameAvailability

Sample Request

POST https://management.azure.com/subscriptions/exampleSubscriptionId/resourceGroups/exampleResourceGroup/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-9080/disasterRecoveryConfigs/CheckNameAvailability?api-version=2017-04-01
{
  "name": "sdk-DisasterRecovery-9474"
}

Sample Response

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

Definitions

CheckNameAvailability

Description of a Check Name availability request properties.

CheckNameAvailabilityResult

Description of a Check Name availability request properties.

ErrorResponse

Error response indicates ServiceBus service is not able to process the incoming request. The reason is provided in the error message.

UnavailableReason

Specifies the reason for the unavailability of the service.

CheckNameAvailability

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

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

The reason for unavailability of a namespace.

ErrorResponse

Error response indicates ServiceBus service is not able to process the incoming request. The reason is provided in the error message.

Name Type Description
code
  • string

Error code.

message
  • string

Error message indicating why the operation failed.

UnavailableReason

Specifies the reason for the unavailability of the service.

Name Type Description
InvalidName
  • string
NameInLockdown
  • string
NameInUse
  • string
None
  • string
SubscriptionIsDisabled
  • string
TooManyNamespaceInCurrentSubscription
  • string