Servers - Check Name Availability

Serviço:

SQL Database

Versão da API:

2021-11-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=2021-11-01

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
subscriptionId	path	True	string	A ID de assinatura que identifica uma assinatura do Azure.
api-version	query	True	string	A versão da API a ser usada para a solicitação.

Corpo da solicitação

Nome	Obrigatório	Tipo	Description
name	True	string
type	True	CheckNameAvailabilityResourceType

Respostas

Nome	Tipo	Description
200 OK	CheckNameAvailabilityResponse	A marcar de disponibilidade foi concluída com êxito.
Other Status Codes		Respostas de erro: *** 400 InvalidNameAvailabilityRequest - A solicitação de disponibilidade de nome marcar é inválida. 400 UnknownNameType - Tipo de recurso desconhecido especificado para uma marcar de disponibilidade de nome no nível da assinatura.

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

Solicitação de exemplo

HTTP

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

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

Java

import com.azure.core.util.Context;
import com.azure.resourcemanager.sql.models.CheckNameAvailabilityRequest;

/** Samples for Servers CheckNameAvailability. */
public final class Main {
    /*
     * x-ms-original-file: specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/
     * CheckNameAvailabilityServerAlreadyExists.json
     */
    /**
     * Sample code: Check for a server name that already exists.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void checkForAServerNameThatAlreadyExists(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getServers()
            .checkNameAvailabilityWithResponse(new CheckNameAvailabilityRequest().withName("server1"), Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Resposta de exemplo

Código de status:

200

{
  "name": "server1",
  "available": false,
  "reason": "AlreadyExists",
  "message": "Specified server name is already used"
}

Check for a server name that is available

Solicitação de exemplo

HTTP

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

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

Java

import com.azure.core.util.Context;
import com.azure.resourcemanager.sql.models.CheckNameAvailabilityRequest;

/** Samples for Servers CheckNameAvailability. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/CheckNameAvailabilityServerAvailable.
     * json
     */
    /**
     * Sample code: Check for a server name that is available.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void checkForAServerNameThatIsAvailable(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getServers()
            .checkNameAvailabilityWithResponse(new CheckNameAvailabilityRequest().withName("server1"), Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Resposta de exemplo

Código de status:

200

{
  "name": "server1",
  "available": true
}

Check for a server name that is invalid

Solicitação de exemplo

HTTP

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

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

Java

import com.azure.core.util.Context;
import com.azure.resourcemanager.sql.models.CheckNameAvailabilityRequest;

/** Samples for Servers CheckNameAvailability. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/CheckNameAvailabilityServerInvalid.
     * json
     */
    /**
     * Sample code: Check for a server name that is invalid.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void checkForAServerNameThatIsInvalid(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getServers()
            .checkNameAvailabilityWithResponse(new CheckNameAvailabilityRequest().withName("SERVER1"), Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Resposta de exemplo

Código de status:

200

{
  "name": "SERVER1",
  "available": false,
  "reason": "Invalid",
  "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."
}

Definições

Nome	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 marcar se o nome especificado para um recurso está disponível.
CheckNameAvailabilityResourceType
CheckNameAvailabilityResponse	O resultado de uma marcar de disponibilidade de nome.

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.

Nome	Tipo	Description
AlreadyExists	string
Invalid	string

CheckNameAvailabilityRequest

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

Nome	Tipo	Description
name	string
type	CheckNameAvailabilityResourceType

CheckNameAvailabilityResourceType

Nome	Tipo	Description
Microsoft.Sql/servers	string

CheckNameAvailabilityResponse

O resultado de uma marcar de disponibilidade de nome.

Nome	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.