Check Name Availability - Namespaces - Check Name Availability

Referencia

Service:: Event Hubs

API Version:: 2024-01-01

Compruebe la disponibilidad del nombre del espacio de nombres.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
subscriptionId	path	True	string	Credenciales de suscripción que identifican de forma única una suscripción de Microsoft Azure. El identificador de suscripción forma parte del URI para cada llamada al servicio.
api-version	query	True	string	Versión de la API de cliente.

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
name	True	string	Nombre para comprobar la disponibilidad del nombre del espacio de nombres

Respuestas

Nombre	Tipo	Description
200 OK	CheckNameAvailabilityResult	compruebe la disponibilidad devuelta correctamente.
Other Status Codes	ErrorResponse	Respuesta de error del centro de eventos que describe por qué se produjo un error en la operación.

Seguridad

azure_auth

Flujo OAuth2 de Azure Active Directory

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

Scopes

Nombre	Description
user_impersonation	suplantación de su cuenta de usuario

Ejemplos

NamespacesCheckNameAvailability

Sample Request

HTTP

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": ""
}

Definiciones

Nombre	Description
CheckNameAvailabilityParameter	Parámetro proporcionado para comprobar la operación de disponibilidad de nombres del espacio de nombres
CheckNameAvailabilityResult	Resultado de la operación CheckNameAvailability
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	La respuesta de error indica que el servicio event hubs no puede procesar la solicitud entrante. El motivo se proporciona en el mensaje de error.
UnavailableReason	Especifica el motivo de la falta de disponibilidad del servicio.

CheckNameAvailabilityParameter

Parámetro proporcionado para comprobar la operación de disponibilidad de nombres del espacio de nombres

Nombre	Tipo	Description
name	string	Nombre para comprobar la disponibilidad del nombre del espacio de nombres

CheckNameAvailabilityResult

Resultado de la operación CheckNameAvailability

Nombre	Tipo	Description
message	string	La información detallada con respecto al motivo asociado al espacio de nombres.
nameAvailable	boolean	Valor que indica la disponibilidad del espacio de nombres, true si el espacio de nombres está disponible; de lo contrario, false.
reason	UnavailableReason	Motivo de falta de disponibilidad de un espacio de nombres.

ErrorAdditionalInfo

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorDetail

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Los detalles del error.
message	string	El mensaje de error.
target	string	Destino del error.

ErrorResponse

La respuesta de error indica que el servicio event hubs no puede procesar la solicitud entrante. El motivo se proporciona en el mensaje de error.

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

UnavailableReason

Especifica el motivo de la falta de disponibilidad del servicio.

Nombre	Tipo	Description
InvalidName	string
NameInLockdown	string
NameInUse	string
None	string
SubscriptionIsDisabled	string
TooManyNamespaceInCurrentSubscription	string