Servers - Check Name Availability

Dienst:

SQL Database

API-Version:

2021-11-01

Bestimmt, ob eine Ressource mit dem angegebenen Namen erstellt werden kann.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
subscriptionId	path	True	string	Abonnement-ID für ein Azure-Abonnement.
api-version	query	True	string	API-Version, die für die Anforderung verwendet werden soll.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
name	True	string
type	True	CheckNameAvailabilityResourceType

Antworten

Name	Typ	Beschreibung
200 OK	CheckNameAvailabilityResponse	Die Verfügbarkeitsprüfung wurde erfolgreich abgeschlossen.
Other Status Codes		Fehlerantworten: *** 400 InvalidNameAvailabilityRequest: Die Anforderung zur Verfügbarkeit des Prüfnamens ist ungültig. 400 UnknownNameType: Unbekannter Ressourcentyp, der für eine Überprüfung der Verfügbarkeit von Namen auf Abonnementebene angegeben ist.

Beispiele

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

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:

200

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

Check for a server name that is available

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:

200

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

Check for a server name that is invalid

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:

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

Definitionen

Name	Beschreibung
CheckNameAvailabilityReason	Der Grundcode, der erklärt, warum der Name nicht verfügbar ist. Wird nicht definiert, wenn der Name verfügbar ist.
CheckNameAvailabilityRequest	Eine Anforderung, um zu überprüfen, ob der angegebene Name für eine Ressource verfügbar ist.
CheckNameAvailabilityResourceType
CheckNameAvailabilityResponse	Das Ergebnis einer Namensverfügbarkeitsprüfung.

CheckNameAvailabilityReason

Der Grundcode, der erklärt, warum der Name nicht verfügbar ist. Wird nicht definiert, wenn der Name verfügbar ist.

Name	Typ	Beschreibung
AlreadyExists	string
Invalid	string

CheckNameAvailabilityRequest

Eine Anforderung, um zu überprüfen, ob der angegebene Name für eine Ressource verfügbar ist.

Name	Typ	Beschreibung
name	string
type	CheckNameAvailabilityResourceType

CheckNameAvailabilityResourceType

Name	Typ	Beschreibung
Microsoft.Sql/servers	string

CheckNameAvailabilityResponse

Das Ergebnis einer Namensverfügbarkeitsprüfung.

Name	Typ	Beschreibung
available	boolean	True, wenn der Name verfügbar ist, andernfalls false.
message	string	Eine Meldung, die erklärt, warum der Name nicht verfügbar ist. Wird nicht definiert, wenn der Name verfügbar ist.
name	string	Der Name, dessen Verfügbarkeit überprüft wurde.
reason	CheckNameAvailabilityReason	Der Grundcode, der erklärt, warum der Name nicht verfügbar ist. Wird nicht definiert, wenn der Name verfügbar ist.