Api Management Service - Check Name Availability

Serviço:

API Management

Versão da API:

2024-05-01

Verifica a disponibilidade e a correção de um nome para um serviço de Gerenciamento de API.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
subscriptionId	path	True	string (uuid)	A ID da assinatura de destino. O valor deve ser uma UUID.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.

Corpo da solicitação

Nome	Obrigatório	Tipo	Description
name	True	string	O nome para verificar a disponibilidade.

Respostas

Nome	Tipo	Description
200 OK	ApiManagementServiceNameAvailabilityResult	O resultado da disponibilidade do nome de verificação.
Other Status Codes	ErrorResponse	Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

ApiManagementServiceCheckNameAvailability

Solicitação de exemplo

HTTP

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ApiManagement/checkNameAvailability?api-version=2024-05-01

{
  "name": "apimService1"
}

Resposta de exemplo

Código de status:

200

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

Definições

Nome	Description
ApiManagementServiceCheckNameAvailabilityParameters	Parâmetros fornecidos para a operação CheckNameAvailability.
ApiManagementServiceNameAvailabilityResult	Resposta da operação CheckNameAvailability.
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
NameAvailabilityReason	Inválido indica que o nome fornecido não corresponde aos requisitos de nomenclatura do provedor de recursos (comprimento incorreto, caracteres sem suporte etc.) AlreadyExists indica que o nome já está em uso e, portanto, não está disponível.

ApiManagementServiceCheckNameAvailabilityParameters

Objeto

Parâmetros fornecidos para a operação CheckNameAvailability.

Nome	Tipo	Description
name	string	O nome para verificar a disponibilidade.

ApiManagementServiceNameAvailabilityResult

Objeto

Resposta da operação CheckNameAvailability.

Nome	Tipo	Description
message	string	Se motivo == inválido, forneça ao usuário o motivo pelo qual o nome fornecido é inválido e forneça os requisitos de nomenclatura de recursos para que o usuário possa selecionar um nome válido. Se motivo == AlreadyExists, explique que já está em uso e direcione-os para selecionar um nome diferente.
nameAvailable	boolean	True se o nome estiver disponível e puder ser usado para criar um novo serviço de Gerenciamento de API; caso contrário, false.
reason	NameAvailabilityReason	Inválido indica que o nome fornecido não corresponde aos requisitos de nomenclatura do provedor de recursos (comprimento incorreto, caracteres sem suporte etc.) AlreadyExists indica que o nome já está em uso e, portanto, não está disponível.

ErrorAdditionalInfo

Objeto

As informações adicionais do erro de gerenciamento de recursos.

Nome	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

Objeto

O detalhe do erro.

Nome	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Objeto

Resposta de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

NameAvailabilityReason

Enumeração

Inválido indica que o nome fornecido não corresponde aos requisitos de nomenclatura do provedor de recursos (comprimento incorreto, caracteres sem suporte etc.) AlreadyExists indica que o nome já está em uso e, portanto, não está disponível.

Valor	Description
AlreadyExists
Invalid
Valid