Servers - Check Name Availability
指定した名前でリソースを作成できるかどうかを判断します。
POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Sql/checkNameAvailability?api-version=2014-04-01
URI パラメーター
| 名前 | / | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
subscription
|
path | True |
string |
Azure サブスクリプションを識別するサブスクリプション ID。 |
|
api-version
|
query | True |
string |
要求に使用する API バージョン。 |
要求本文
| 名前 | 型 | 説明 |
|---|---|---|
| parameters |
名前の利用可能性を要求するためのパラメータ。 |
応答
| 名前 | 型 | 説明 |
|---|---|---|
| 200 OK |
[OK] |
例
| 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
要求のサンプル
POST https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Sql/checkNameAvailability?api-version=2014-04-01
{
"name": "server1",
"type": "Microsoft.Sql/servers"
}
応答のサンプル
{
"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=2014-04-01
{
"name": "server1",
"type": "Microsoft.Sql/servers"
}
応答のサンプル
{
"name": "server1",
"available": true,
"reason": null,
"message": null
}
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=2014-04-01
{
"name": "SERVER1",
"type": "Microsoft.Sql/servers"
}
応答のサンプル
{
"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."
}
定義
| 名前 | 説明 |
|---|---|
|
Check |
名前が使用できない理由を説明する理由コード。 名前が使用可能な場合は null になります。 |
|
Check |
名前の利用可能性を要求するためのパラメータ。 |
|
Check |
可用性チェックの有効範囲として使用されるリソースのタイプ。 |
|
Check |
指定されたリソース名が利用可能かどうかを示すレスポンスです。 |
CheckNameAvailabilityReason
名前が使用できない理由を説明する理由コード。 名前が使用可能な場合は null になります。
| 値 | 説明 |
|---|---|
| Invalid | |
| AlreadyExists |
CheckNameAvailabilityRequest
名前の利用可能性を要求するためのパラメータ。
| 名前 | 型 | 説明 |
|---|---|---|
| name |
string |
その名前の利用可能性は確認すべきです。 |
| type |
可用性チェックの有効範囲として使用されるリソースのタイプ。 |
CheckNameAvailabilityResourceType
可用性チェックの有効範囲として使用されるリソースのタイプ。
| 値 | 説明 |
|---|---|
| Microsoft.Sql/servers |
CheckNameAvailabilityResponse
指定されたリソース名が利用可能かどうかを示すレスポンスです。
| 名前 | 型 | 説明 |
|---|---|---|
| available |
boolean |
名前が使用可能な場合は True、それ以外の場合は false。 |
| message |
string |
名前が使用できない理由を説明するメッセージ。 名前が使用可能な場合は null になります。 |
| name |
string |
可用性がチェックされた名前。 |
| reason |
名前が使用できない理由を説明する理由コード。 名前が使用可能な場合は null になります。 |