Servers - Check Name Availability

サービス:: SQL Database

API バージョン:: 2025-01-01

指定した名前でリソースを作成できるかどうかを判断します。

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

URI パラメーター

名前	/	必須	型	説明
subscriptionId	path	True	string (uuid)	ターゲットサブスクリプションの ID。値は UUID である必要があります。
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。

要求本文

名前	必須	型	説明
name	True	string
type	True	CheckNameAvailabilityResourceType

応答

名前	型	説明
200 OK	CheckNameAvailabilityResponse	要求は成功しました。
Other Status Codes	ErrorResponse	予期しないエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 Flow.

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザーアカウントを偽装する

例

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=2025-01-01

{
  "name": "server1",
  "type": "Microsoft.Sql/servers"
}

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.Resources.Models;
using Azure.ResourceManager.Sql.Models;
using Azure.ResourceManager.Sql;

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/SQL/stable/2025-01-01/examples/CheckNameAvailabilityServerAlreadyExists.json
// this example is just showing the usage of "Servers_CheckNameAvailability" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SubscriptionResource created on azure
// for more information of creating SubscriptionResource, please refer to the document of SubscriptionResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
ResourceIdentifier subscriptionResourceId = SubscriptionResource.CreateResourceIdentifier(subscriptionId);
SubscriptionResource subscriptionResource = client.GetSubscriptionResource(subscriptionResourceId);

// invoke the operation
SqlNameAvailabilityContent content = new SqlNameAvailabilityContent("server1");
SqlNameAvailabilityResponse result = await subscriptionResource.CheckSqlServerNameAvailabilityAsync(content);

Console.WriteLine($"Succeeded: {result}");

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,
  "message": "Specified server name is already used",
  "reason": "AlreadyExists"
}

Check for a server name that is available

要求のサンプル

HTTP
dotnet

POST https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Sql/checkNameAvailability?api-version=2025-01-01

{
  "name": "server1",
  "type": "Microsoft.Sql/servers"
}

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.Resources.Models;
using Azure.ResourceManager.Sql.Models;
using Azure.ResourceManager.Sql;

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/SQL/stable/2025-01-01/examples/CheckNameAvailabilityServerAvailable.json
// this example is just showing the usage of "Servers_CheckNameAvailability" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SubscriptionResource created on azure
// for more information of creating SubscriptionResource, please refer to the document of SubscriptionResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
ResourceIdentifier subscriptionResourceId = SubscriptionResource.CreateResourceIdentifier(subscriptionId);
SubscriptionResource subscriptionResource = client.GetSubscriptionResource(subscriptionResourceId);

// invoke the operation
SqlNameAvailabilityContent content = new SqlNameAvailabilityContent("server1");
SqlNameAvailabilityResponse result = await subscriptionResource.CheckSqlServerNameAvailabilityAsync(content);

Console.WriteLine($"Succeeded: {result}");

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
dotnet

POST https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Sql/checkNameAvailability?api-version=2025-01-01

{
  "name": "SERVER1",
  "type": "Microsoft.Sql/servers"
}

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.Resources.Models;
using Azure.ResourceManager.Sql.Models;
using Azure.ResourceManager.Sql;

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/SQL/stable/2025-01-01/examples/CheckNameAvailabilityServerInvalid.json
// this example is just showing the usage of "Servers_CheckNameAvailability" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SubscriptionResource created on azure
// for more information of creating SubscriptionResource, please refer to the document of SubscriptionResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
ResourceIdentifier subscriptionResourceId = SubscriptionResource.CreateResourceIdentifier(subscriptionId);
SubscriptionResource subscriptionResource = client.GetSubscriptionResource(subscriptionResourceId);

// invoke the operation
SqlNameAvailabilityContent content = new SqlNameAvailabilityContent("SERVER1");
SqlNameAvailabilityResponse result = await subscriptionResource.CheckSqlServerNameAvailabilityAsync(content);

Console.WriteLine($"Succeeded: {result}");

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,
  "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.",
  "reason": "Invalid"
}

定義

名前	説明
CheckNameAvailabilityReason	名前が使用できない理由を説明する理由コード。名前が使用可能な場合は未定義になります。
CheckNameAvailabilityRequest	指定したリソース名を使用できるかどうかを確認する要求。
CheckNameAvailabilityResourceType
CheckNameAvailabilityResponse	名前の可用性チェックの結果。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答

CheckNameAvailabilityReason

列挙

名前が使用できない理由を説明する理由コード。名前が使用可能な場合は未定義になります。

値	説明
Invalid	無効です
AlreadyExists	すでに存在します

CheckNameAvailabilityRequest

Object

指定したリソース名を使用できるかどうかを確認する要求。

名前	型	説明
name	string
type	CheckNameAvailabilityResourceType

CheckNameAvailabilityResourceType

列挙

値	説明
Microsoft.Sql/servers	Microsoft。SQL/サーバー

CheckNameAvailabilityResponse

Object

名前の可用性チェックの結果。

名前	型	説明
available	boolean	名前が使用可能な場合は True、それ以外の場合は false。
message	string	名前が使用できない理由を説明するメッセージ。名前が使用可能な場合は未定義になります。
name	string	可用性がチェックされた名前。
reason	CheckNameAvailabilityReason	名前が使用できない理由を説明する理由コード。名前が使用可能な場合は未定義になります。

ErrorAdditionalInfo

Object

リソース管理エラーの追加情報。

名前	型	説明
info	object	追加情報。
type	string	追加情報の種類。

ErrorDetail

Object

エラーの詳細。

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラーコード。
details	ErrorDetail[]	エラーの詳細。
message	string	エラーメッセージ。
target	string	エラーターゲット。

ErrorResponse

Object

エラー応答

名前	型	説明
error	ErrorDetail	エラーオブジェクト。