Partilhar via

Servers - Check Name Availability

Serviço:
SQL Database
Versão da API:
2025-01-01

Determina se um recurso pode ser criado com o nome especificado.

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

Parâmetros do URI

Name Em Necessário Tipo Description
subscriptionId
 path True

string (uuid)

A ID da assinatura de destino. O valor deve ser um UUID.
api-version
 query True

string

minLength: 1

A versão da API a utilizar para esta operação.

Corpo do Pedido

Name Necessário Tipo Description
name True

string

type True

CheckNameAvailabilityResourceType

Respostas

Name Tipo Description
200 OK

CheckNameAvailabilityResponse

O pedido foi bem-sucedido.
Other Status Codes

ErrorResponse

Uma resposta de erro inesperada.

Segurança

azure_auth

Azure Active Directory OAuth2 Flow.

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

Âmbitos

Name Description
user_impersonation personificar a sua conta de utilizador

Exemplos

Check for a server name that already exists
Check for a server name that is available
Check for a server name that is invalid

Check for a server name that already exists

Pedido de amostra

POST https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Sql/checkNameAvailability?api-version=2025-01-01

{
  "name": "server1",
  "type": "Microsoft.Sql/servers"
}

Resposta da amostra

Código de estado:
200 
{
  "name": "server1",
  "available": false,
  "message": "Specified server name is already used",
  "reason": "AlreadyExists"
}

Check for a server name that is available

Pedido de amostra

POST https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Sql/checkNameAvailability?api-version=2025-01-01

{
  "name": "server1",
  "type": "Microsoft.Sql/servers"
}

Resposta da amostra

Código de estado:
200 
{
  "name": "server1",
  "available": true
}

Check for a server name that is invalid

Pedido de amostra

POST https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Sql/checkNameAvailability?api-version=2025-01-01

{
  "name": "SERVER1",
  "type": "Microsoft.Sql/servers"
}

Resposta da amostra

Código de estado:
200 
{
  "name": "SERVER1",
  "available": false,
  "message": "Specified server name contains unsupported characters or is too long. Server name must be no longer than 63 characters long, contain only lower-case characters or digits, cannot contain '.' or '_' characters and can't start or end with '-' character.",
  "reason": "Invalid"
}

Definições

Name Description
CheckNameAvailabilityReason

O código de motivo que explica por que o nome não está disponível. Será indefinido se o nome estiver disponível.
CheckNameAvailabilityRequest

Uma solicitação para verificar se o nome especificado para um recurso está disponível.
CheckNameAvailabilityResourceType
CheckNameAvailabilityResponse

O resultado de uma verificação de disponibilidade de nome.
ErrorAdditionalInfo

O erro de gerenciamento de recursos informações adicionais.
ErrorDetail

O detalhe do erro.
ErrorResponse

Resposta de erro

CheckNameAvailabilityReason

Enumeração

O código de motivo que explica por que o nome não está disponível. Será indefinido se o nome estiver disponível.

Valor Description
Invalid

Inválido
AlreadyExists

Já existe

CheckNameAvailabilityRequest

Object

Uma solicitação para verificar se o nome especificado para um recurso está disponível.

Name Tipo Description
name

string

type

CheckNameAvailabilityResourceType

CheckNameAvailabilityResourceType

Enumeração
Valor Description
Microsoft.Sql/servers

Microsoft. SQL/servidores

CheckNameAvailabilityResponse

Object

O resultado de uma verificação de disponibilidade de nome.

Name Tipo Description
available

boolean

True se o nome estiver disponível, caso contrário, false.
message

string

Uma mensagem explicando por que o nome não está disponível. Será indefinido se o nome estiver disponível.
name

string

O nome cuja disponibilidade foi verificada.
reason

CheckNameAvailabilityReason

O código de motivo que explica por que o nome não está disponível. Será indefinido se o nome estiver disponível.

ErrorAdditionalInfo

Object

O erro de gerenciamento de recursos informações adicionais.

Name Tipo Description
info

object

As informações adicionais.
type

string

O tipo de informação adicional.

ErrorDetail

Object

O detalhe do erro.

Name Tipo Description
additionalInfo

ErrorAdditionalInfo[]

O erro informações adicionais.
code

string

O código de erro.
details

ErrorDetail[]

Os detalhes do erro.
message

string

A mensagem de erro.
target

string

O alvo do erro.

ErrorResponse

Object

Resposta de erro

Name Tipo Description
error

ErrorDetail

O objeto de erro.