Servers - Check Name Availability

Service:

SQL Database

API Version:

2021-11-01

Menentukan apakah sumber daya dapat dibuat dengan nama yang ditentukan.

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
subscriptionId	path	True	string	ID langganan yang mengidentifikasi langganan Azure.
api-version	query	True	string	Versi API yang digunakan untuk permintaan.

Isi Permintaan

Nama	Diperlukan	Jenis	Deskripsi
name	True	string
type	True	CheckNameAvailabilityResourceType

Respons

Nama	Jenis	Deskripsi
200 OK	CheckNameAvailabilityResponse	Berhasil menyelesaikan pemeriksaan ketersediaan.
Other Status Codes		Respons Kesalahan: *** 400 InvalidNameAvailabilityRequest - Permintaan ketersediaan nama pemeriksaan tidak valid. 400 UnknownNameType - Jenis sumber daya tidak diketahui yang ditentukan untuk pemeriksaan ketersediaan nama tingkat langganan.

Contoh

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

Definisi

Nama	Deskripsi
CheckNameAvailabilityReason	Kode alasan yang menjelaskan mengapa nama tidak tersedia. Tidak akan ditentukan jika nama tersedia.
CheckNameAvailabilityRequest	Permintaan untuk memeriksa apakah nama yang ditentukan untuk sumber daya tersedia.
CheckNameAvailabilityResourceType
CheckNameAvailabilityResponse	Hasil pemeriksaan ketersediaan nama.

CheckNameAvailabilityReason

Kode alasan yang menjelaskan mengapa nama tidak tersedia. Tidak akan ditentukan jika nama tersedia.

Nama	Jenis	Deskripsi
AlreadyExists	string
Invalid	string

CheckNameAvailabilityRequest

Permintaan untuk memeriksa apakah nama yang ditentukan untuk sumber daya tersedia.

Nama	Jenis	Deskripsi
name	string
type	CheckNameAvailabilityResourceType

CheckNameAvailabilityResourceType

Nama	Jenis	Deskripsi
Microsoft.Sql/servers	string

CheckNameAvailabilityResponse

Hasil pemeriksaan ketersediaan nama.

Nama	Jenis	Deskripsi
available	boolean	Benar jika nama tersedia, jika tidak salah.
message	string	Pesan yang menjelaskan mengapa nama tersebut tidak tersedia. Tidak akan ditentukan jika nama tersedia.
name	string	Nama yang ketersediaannya diperiksa.
reason	CheckNameAvailabilityReason	Kode alasan yang menjelaskan mengapa nama tidak tersedia. Tidak akan ditentukan jika nama tersedia.