指定した名前でリソースを作成できるかどうかを判断します。
POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Sql/checkNameAvailability?api-version=2021-11-01
URI パラメーター
| 名前 |
/ |
必須 |
型 |
説明 |
|
subscriptionId
|
path |
True
|
string
|
Azure サブスクリプションを識別するサブスクリプション ID。
|
|
api-version
|
query |
True
|
string
|
要求で使用する API のバージョン。
|
要求本文
応答
例
Check for a server name that already exists
要求のサンプル
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"
}
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
応答のサンプル
{
"name": "server1",
"available": false,
"reason": "AlreadyExists",
"message": "Specified server name is already used"
}
Check for a server name that is available
要求のサンプル
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"
}
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
応答のサンプル
{
"name": "server1",
"available": true
}
Check for a server name that is invalid
要求のサンプル
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"
}
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
応答のサンプル
{
"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."
}
定義
CheckNameAvailabilityReason
名前が使用できない理由を説明する理由コード。 名前が使用可能な場合は未定義になります。
| 名前 |
型 |
説明 |
|
AlreadyExists
|
string
|
|
|
Invalid
|
string
|
|
CheckNameAvailabilityRequest
リソースの指定した名前を使用できるかどうかをチェックする要求。
CheckNameAvailabilityResourceType
| 名前 |
型 |
説明 |
|
Microsoft.Sql/servers
|
string
|
|
CheckNameAvailabilityResponse
名前の可用性チェックの結果。
| 名前 |
型 |
説明 |
|
available
|
boolean
|
名前が使用可能な場合は True、それ以外の場合は false。
|
|
message
|
string
|
名前が使用できない理由を説明するメッセージ。 名前が使用可能な場合は未定義になります。
|
|
name
|
string
|
可用性がチェックされた名前。
|
|
reason
|
CheckNameAvailabilityReason
|
名前が使用できない理由を説明する理由コード。 名前が使用可能な場合は未定義になります。
|