Servers - Check Name Availability

서비스:

SQL Database

API 버전:

2021-11-01

지정된 이름의 리소스를 만들 수 있는지 여부를 결정합니다.

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

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
subscriptionId	path	True	string	Azure 구독을 식별하는 구독 ID입니다.
api-version	query	True	string	요청에 사용할 API 버전입니다.

요청 본문

Name	필수	형식	Description
name	True	string
type	True	CheckNameAvailabilityResourceType

응답

Name	형식	Description
200 OK	CheckNameAvailabilityResponse	가용성 검사 완료했습니다.
Other Status Codes		오류 응답: *** 400 InvalidNameAvailabilityRequest - 검사 이름 가용성 요청이 잘못되었습니다. 400 UnknownNameType - 구독 수준 이름 가용성 검사 대해 지정된 알 수 없는 리소스 종류입니다.

예제

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

샘플 요청

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

샘플 응답

상태 코드:

200

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

Check for a server name that is available

샘플 요청

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

샘플 응답

상태 코드:

200

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

Check for a server name that is invalid

샘플 요청

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

샘플 응답

상태 코드:

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

정의

Name	Description
CheckNameAvailabilityReason	이름을 사용할 수 없는 이유를 설명하는 이유 코드입니다. 이름을 사용할 수 있는 경우 정의되지 않습니다.
CheckNameAvailabilityRequest	리소스에 대해 지정된 이름을 사용할 수 있는지 여부를 검사 요청입니다.
CheckNameAvailabilityResourceType
CheckNameAvailabilityResponse	이름 가용성 검사 결과입니다.

CheckNameAvailabilityReason

이름을 사용할 수 없는 이유를 설명하는 이유 코드입니다. 이름을 사용할 수 있는 경우 정의되지 않습니다.

Name	형식	Description
AlreadyExists	string
Invalid	string

CheckNameAvailabilityRequest

리소스에 대해 지정된 이름을 사용할 수 있는지 여부를 검사 요청입니다.

Name	형식	Description
name	string
type	CheckNameAvailabilityResourceType

CheckNameAvailabilityResourceType

Name	형식	Description
Microsoft.Sql/servers	string

CheckNameAvailabilityResponse

이름 가용성 검사 결과입니다.

Name	형식	Description
available	boolean	이름을 사용할 수 있으면 True이고, 그렇지 않으면 false입니다.
message	string	이름을 사용할 수 없는 이유를 설명하는 메시지입니다. 이름을 사용할 수 있는 경우 정의되지 않습니다.
name	string	가용성을 확인한 이름입니다.
reason	CheckNameAvailabilityReason	이름을 사용할 수 없는 이유를 설명하는 이유 코드입니다. 이름을 사용할 수 있는 경우 정의되지 않습니다.