Servers - Check Name Availability

Service:

SQL Database

API Version:

2021-11-01

Determina se è possibile creare una risorsa con il nome specificato.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
subscriptionId	path	True	string	ID sottoscrizione che identifica una sottoscrizione di Azure.
api-version	query	True	string	Versione dell'API da usare per la richiesta.

Corpo della richiesta

Nome	Necessario	Tipo	Descrizione
name	True	string
type	True	CheckNameAvailabilityResourceType

Risposte

Nome	Tipo	Descrizione
200 OK	CheckNameAvailabilityResponse	Il controllo di disponibilità è stato completato correttamente.
Other Status Codes		Risposte di errore: 400 InvalidNameAvailabilityRequest: la richiesta di disponibilità del nome di controllo non è valida. 400 UnknownNameType : tipo di risorsa sconosciuto specificato per un controllo di disponibilità del nome a livello di sottoscrizione.

Esempio

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

Sample Request

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

Sample Response

Status code:

200

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

Check for a server name that is available

Sample Request

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

Sample Response

Status code:

200

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

Check for a server name that is invalid

Sample Request

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

Sample Response

Status code:

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

Definizioni

Nome	Descrizione
CheckNameAvailabilityReason	Codice motivo che spiega perché il nome non è disponibile. Non sarà definito se il nome è disponibile.
CheckNameAvailabilityRequest	Richiesta di verificare se il nome specificato per una risorsa è disponibile.
CheckNameAvailabilityResourceType
CheckNameAvailabilityResponse	Risultato di un controllo di disponibilità del nome.

CheckNameAvailabilityReason

Codice motivo che spiega perché il nome non è disponibile. Non sarà definito se il nome è disponibile.

Nome	Tipo	Descrizione
AlreadyExists	string
Invalid	string

CheckNameAvailabilityRequest

Richiesta di verificare se il nome specificato per una risorsa è disponibile.

Nome	Tipo	Descrizione
name	string
type	CheckNameAvailabilityResourceType

CheckNameAvailabilityResourceType

Nome	Tipo	Descrizione
Microsoft.Sql/servers	string

CheckNameAvailabilityResponse

Risultato di un controllo di disponibilità del nome.

Nome	Tipo	Descrizione
available	boolean	True se il nome è disponibile; in caso contrario, false.
message	string	Messaggio che spiega perché il nome non è disponibile. Non sarà definito se il nome è disponibile.
name	string	Nome di cui è stata verificata la disponibilità.
reason	CheckNameAvailabilityReason	Codice motivo che spiega perché il nome non è disponibile. Non sarà definito se il nome è disponibile.