Services - Check Name Availability

Servicio:: Search Management

Versión de la API:: 2024-03-01-preview

Comprueba si el nombre del servicio de búsqueda determinado está disponible para su uso. Los nombres de servicio de búsqueda deben ser únicos globalmente, ya que forman parte del URI del servicio (https://< name.search.windows.net>).

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
subscriptionId	path	True	string	Identificador único de una suscripción de Microsoft Azure. Puede obtener este valor desde la API de Azure Resource Manager o el portal.
api-version	query	True	string	Versión de la API que se va a usar para cada solicitud.

Encabezado de la solicitud

Nombre	Requerido	Tipo	Description
x-ms-client-request-id		string (uuid)	Valor GUID generado por el cliente que identifica esta solicitud. Si se especifica, se incluirá en la información de respuesta como una manera de realizar un seguimiento de la solicitud.

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
name	True	string	Nombre del servicio de búsqueda que se va a validar. Los nombres del servicio de búsqueda solo deben contener letras minúsculas, dígitos o guiones, no pueden usar guiones como los dos primeros o últimos caracteres, no pueden contener guiones consecutivos y deben tener entre 2 y 60 caracteres de longitud.
type	True	ResourceType	Tipo del recurso cuyo nombre se va a validar. Este valor siempre debe ser "searchServices".

Respuestas

Nombre	Tipo	Description
200 OK	CheckNameAvailabilityOutput	Comprobación de nombres completada. La respuesta contiene detalles de si el nombre es válido y está disponible. Si el nombre no es válido, la respuesta también contiene un mensaje que explica por qué no.
Other Status Codes	CloudError	HTTP 400 (solicitud incorrecta): el tipo de recurso especificado no es "searchServices".

Seguridad

azure_auth

Especifica un flujo de concesión implícito, como se admite en la plataforma de identidad de Microsoft.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

SearchCheckNameAvailability

Solicitud de ejemplo

HTTP

POST https://management.azure.com/subscriptions/subid/providers/Microsoft.Search/checkNameAvailability?api-version=2024-03-01-preview

{
  "name": "mysearchservice",
  "type": "searchServices"
}

Respuesta de muestra

status code:: 200

{
  "nameAvailable": false,
  "reason": "AlreadyExists",
  "message": ""
}

Definiciones

Nombre	Description
CheckNameAvailabilityInput	Entrada de check name availability API.
CheckNameAvailabilityOutput	Salida de check name availability API.
CloudError	Contiene información sobre un error de API.
CloudErrorBody	Describe un error de API determinado con un código de error y un mensaje.
ResourceType	Tipo del recurso cuyo nombre se va a validar. Este valor siempre debe ser "searchServices".
UnavailableNameReason	Motivo por el que el nombre no está disponible. 'No válido' indica que el nombre proporcionado no coincide con los requisitos de nomenclatura (longitud incorrecta, caracteres no admitidos, etc.). "AlreadyExists" indica que el nombre ya está en uso y, por tanto, no está disponible.

CheckNameAvailabilityInput

Objeto

Entrada de check name availability API.

Nombre	Tipo	Description
name	string	Nombre del servicio de búsqueda que se va a validar. Los nombres del servicio de búsqueda solo deben contener letras minúsculas, dígitos o guiones, no pueden usar guiones como los dos primeros o últimos caracteres, no pueden contener guiones consecutivos y deben tener entre 2 y 60 caracteres de longitud.
type	ResourceType	Tipo del recurso cuyo nombre se va a validar. Este valor siempre debe ser "searchServices".

CheckNameAvailabilityOutput

Objeto

Salida de check name availability API.

Nombre	Tipo	Description
message	string	Mensaje que explica por qué el nombre no es válido y proporciona requisitos de nomenclatura de recursos. Solo está disponible si se devuelve 'Invalid' en la propiedad 'reason'.
nameAvailable	boolean	Valor que indica si el nombre está disponible.
reason	UnavailableNameReason	Motivo por el que el nombre no está disponible. 'No válido' indica que el nombre proporcionado no coincide con los requisitos de nomenclatura (longitud incorrecta, caracteres no admitidos, etc.). "AlreadyExists" indica que el nombre ya está en uso y, por tanto, no está disponible.

CloudError

Objeto

Contiene información sobre un error de API.

Nombre	Tipo	Description
error	CloudErrorBody	Describe un error de API determinado con un código de error y un mensaje.
message	string	Una breve descripción del error que indica lo que salió mal (para obtener detalles o información de depuración, consulte la propiedad "error.message").

CloudErrorBody

Objeto

Describe un error de API determinado con un código de error y un mensaje.

Nombre	Tipo	Description
code	string	Código de error que describe la condición de error más precisamente que un código de estado HTTP. Se puede usar para controlar mediante programación casos de error específicos.
details	CloudErrorBody[]	Contiene errores anidados relacionados con este error.
message	string	Mensaje que describe el error con detalle y proporciona información de depuración.
target	string	Destino del error concreto (por ejemplo, el nombre de la propiedad en error).

ResourceType

Enumeración

Tipo del recurso cuyo nombre se va a validar. Este valor siempre debe ser "searchServices".

Valor	Description
searchServices	'searchServices' es el único tipo de recurso cuyo nombre se puede validar.

UnavailableNameReason

Enumeración

Motivo por el que el nombre no está disponible. 'No válido' indica que el nombre proporcionado no coincide con los requisitos de nomenclatura (longitud incorrecta, caracteres no admitidos, etc.). "AlreadyExists" indica que el nombre ya está en uso y, por tanto, no está disponible.

Valor	Description
Invalid	El nombre del servicio de búsqueda no coincide con los requisitos de nomenclatura.
AlreadyExists	El nombre del servicio de búsqueda ya está asignado a otro servicio de búsqueda.