Servers - Check Name Availability

Service:

SQL Database

API Version:

2021-11-01

Określa, czy zasób można utworzyć przy użyciu określonej nazwy.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
subscriptionId	path	True	string	Identyfikator subskrypcji identyfikujący subskrypcję platformy Azure.
api-version	query	True	string	Wersja interfejsu API do użycia dla żądania.

Treść żądania

Nazwa	Wymagane	Typ	Opis
name	True	string
type	True	CheckNameAvailabilityResourceType

Odpowiedzi

Nazwa	Typ	Opis
200 OK	CheckNameAvailabilityResponse	Pomyślnie ukończono sprawdzanie dostępności.
Other Status Codes		Odpowiedzi na błędy: *** 400 InvalidNameAvailabilityRequest — żądanie dostępności nazwy sprawdzania jest nieprawidłowe. 400 UnknownNameType — nieznany typ zasobu określony dla sprawdzania dostępności nazwy subskrypcji.

Przykłady

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

Definicje

Nazwa	Opis
CheckNameAvailabilityReason	Kod przyczyny wyjaśniający, dlaczego nazwa jest niedostępna. Jeśli nazwa jest dostępna, nie zostanie zdefiniowana.
CheckNameAvailabilityRequest	Żądanie sprawdzenia, czy określona nazwa zasobu jest dostępna.
CheckNameAvailabilityResourceType
CheckNameAvailabilityResponse	Wynik sprawdzania dostępności nazwy.

CheckNameAvailabilityReason

Kod przyczyny wyjaśniający, dlaczego nazwa jest niedostępna. Jeśli nazwa jest dostępna, nie zostanie zdefiniowana.

Nazwa	Typ	Opis
AlreadyExists	string
Invalid	string

CheckNameAvailabilityRequest

Żądanie sprawdzenia, czy określona nazwa zasobu jest dostępna.

Nazwa	Typ	Opis
name	string
type	CheckNameAvailabilityResourceType

CheckNameAvailabilityResourceType

Nazwa	Typ	Opis
Microsoft.Sql/servers	string

CheckNameAvailabilityResponse

Wynik sprawdzania dostępności nazwy.

Nazwa	Typ	Opis
available	boolean	Prawda, jeśli nazwa jest dostępna, w przeciwnym razie wartość false.
message	string	Komunikat wyjaśniający, dlaczego nazwa jest niedostępna. Jeśli nazwa jest dostępna, nie zostanie zdefiniowana.
name	string	Nazwa, której dostępność została sprawdzona.
reason	CheckNameAvailabilityReason	Kod przyczyny wyjaśniający, dlaczego nazwa jest niedostępna. Jeśli nazwa jest dostępna, nie zostanie zdefiniowana.