Share via

Check Name Availability - Namespaces - Check Name Availability

Service:
Event Hubs
API Version:
2024-01-01

Check the give Namespace name availability.

POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.EventHub/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

Client API Version.

Request Body

Name Required Type Description
name True

string

Name to check the namespace name availability

Responses

Name Type Description
200 OK

CheckNameAvailabilityResult

check availability returned successfully.
Other Status Codes

ErrorResponse

Eventhub 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

NamespacesCheckNameAvailability

Sample request

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

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

Sample response

Status code:
200 
{
  "nameAvailable": true,
  "reason": "None",
  "message": ""
}

Definitions

Name Description
CheckNameAvailabilityParameter

Parameter supplied to check Namespace name availability operation
CheckNameAvailabilityResult

The Result of the CheckNameAvailability operation
ErrorAdditionalInfo

The resource management error additional info.
ErrorDetail

The error detail.
ErrorResponse

Error response indicates Event Hub 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.

CheckNameAvailabilityParameter

Object

Parameter supplied to check Namespace name availability operation

Name Type Description
name

string

Name to check the namespace name availability

CheckNameAvailabilityResult

Object

The Result of the CheckNameAvailability operation

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.

ErrorAdditionalInfo

Object

The resource management error additional info.

Name Type Description
info

object

The additional info.
type

string

The additional info type.

ErrorDetail

Object

The error detail.

Name Type Description
additionalInfo

ErrorAdditionalInfo[]

The error additional info.
code

string

The error code.
details

ErrorDetail[]

The error details.
message

string

The error message.
target

string

The error target.

ErrorResponse

Object

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

Name Type Description
error

ErrorDetail

The error object.

UnavailableReason

Enumeration

Specifies the reason for the unavailability of the service.

Value Description
None
InvalidName
SubscriptionIsDisabled
NameInUse
NameInLockdown
TooManyNamespaceInCurrentSubscription