Servers - Check Name Availability

Služba:

SQL Database

Verze rozhraní API:

2021-11-01

Určuje, zda lze prostředek vytvořit se zadaným názvem.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
subscriptionId	path	True	string	ID předplatného, které identifikuje předplatné Azure.
api-version	query	True	string	Verze rozhraní API, která se má použít pro požadavek.

Text požadavku

Name	Vyžadováno	Typ	Description
name	True	string
type	True	CheckNameAvailabilityResourceType

Odpovědi

Name	Typ	Description
200 OK	CheckNameAvailabilityResponse	Kontrola dostupnosti se úspěšně dokončila.
Other Status Codes		Chybové odpovědi: *** 400 InvalidNameAvailabilityRequest – žádost o kontrolu dostupnosti názvu je neplatná. 400 UnknownNameType – neznámý typ prostředku zadaný pro kontrolu dostupnosti názvů na úrovni předplatného.

Příklady

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

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:

200

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

Check for a server name that is available

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:

200

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

Check for a server name that is invalid

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:

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

Definice

Name	Description
CheckNameAvailabilityReason	Kód důvodu vysvětlující, proč je název nedostupný. Pokud je název k dispozici, nebude definován.
CheckNameAvailabilityRequest	Požadavek na kontrolu, jestli je zadaný název prostředku dostupný.
CheckNameAvailabilityResourceType
CheckNameAvailabilityResponse	Výsledek kontroly dostupnosti názvu.

CheckNameAvailabilityReason

Kód důvodu vysvětlující, proč je název nedostupný. Pokud je název k dispozici, nebude definován.

Name	Typ	Description
AlreadyExists	string
Invalid	string

CheckNameAvailabilityRequest

Požadavek na kontrolu, jestli je zadaný název prostředku dostupný.

Name	Typ	Description
name	string
type	CheckNameAvailabilityResourceType

CheckNameAvailabilityResourceType

Name	Typ	Description
Microsoft.Sql/servers	string

CheckNameAvailabilityResponse

Výsledek kontroly dostupnosti názvu.

Name	Typ	Description
available	boolean	True, pokud je název k dispozici, jinak false.
message	string	Zpráva s vysvětlením, proč název není k dispozici. Pokud je název k dispozici, nebude definován.
name	string	Název, jehož dostupnost byla zkontrolována.
reason	CheckNameAvailabilityReason	Kód důvodu vysvětlující, proč je název nedostupný. Pokud je název k dispozici, nebude definován.