Namespaces - CheckName Availability - Check Name Availability

サービス:

Service Bus

API バージョン:

2024-01-01

名前空間名の指定の可用性を確認します。

POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.ServiceBus/CheckNameAvailability?api-version=2024-01-01

URI パラメーター

名前	/	必須	型	説明
subscriptionId	path	True	string	Microsoft Azure サブスクリプションを一意に識別するサブスクリプション資格情報。 サブスクリプション ID は、すべてのサービス呼び出しの URI の一部を形成します。
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。

要求本文

名前	必須	型	説明
name	True	string	名前空間名の可用性を確認する名前と名前空間名には、文字、数字、ハイフンのみを含めることができます。 名前空間は文字で始まる必要があり、末尾は文字または数字である必要があります。

応答

名前	型	説明
200 OK	CheckNameAvailabilityResult	可用性の確認が正常に返されました。
Other Status Codes	ErrorResponse	操作が失敗した理由を説明する ServiceBus エラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

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

スコープ

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

例

NameSpaceCheckNameAvailability

要求のサンプル

HTTP

POST https://management.azure.com/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/providers/Microsoft.ServiceBus/CheckNameAvailability?api-version=2024-01-01

{
  "name": "sdk-Namespace-2924"
}

dotnet

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

// Generated from example definition: specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2024-01-01/examples/NameSpaces/SBNameSpaceCheckNameAvailability.json
// this example is just showing the usage of "Namespaces_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 = "5f750a97-50d9-4e36-8081-c9ee4c0210d4";
ResourceIdentifier subscriptionResourceId = SubscriptionResource.CreateResourceIdentifier(subscriptionId);
SubscriptionResource subscriptionResource = client.GetSubscriptionResource(subscriptionResourceId);

// invoke the operation
ServiceBusNameAvailabilityContent content = new ServiceBusNameAvailabilityContent("sdk-Namespace-2924");
ServiceBusNameAvailabilityResult result = await subscriptionResource.CheckServiceBusNamespaceNameAvailabilityAsync(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

{
  "nameAvailable": true,
  "reason": "None",
  "message": ""
}

定義

名前	説明
CheckNameAvailability	Check Name 可用性要求プロパティの説明。
CheckNameAvailabilityResult	Check Name 可用性要求プロパティの説明。
Error	エラー オブジェクト。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorResponse	リソース管理エラー応答。
UnavailableReason	サービスが使用できない理由を指定します。

CheckNameAvailability

Object

Check Name 可用性要求プロパティの説明。

名前	型	説明
name	string	名前空間名の可用性を確認する名前と名前空間名には、文字、数字、ハイフンのみを含めることができます。 名前空間は文字で始まる必要があり、末尾は文字または数字である必要があります。

CheckNameAvailabilityResult

Object

Check Name 可用性要求プロパティの説明。

名前	型	説明
message	string	名前空間に関連付けられている理由に関する詳細情報。
nameAvailable	boolean	名前空間が可用性であることを示す値。名前空間が使用可能な場合は true。それ以外の場合は false。
reason	UnavailableReason	名前空間が使用できない理由。

Error

Object

エラー オブジェクト。

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

ErrorAdditionalInfo

Object

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

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

ErrorResponse

Object

リソース管理エラー応答。

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

UnavailableReason

列挙

サービスが使用できない理由を指定します。

値	説明
InvalidName
NameInLockdown
NameInUse
None
SubscriptionIsDisabled
TooManyNamespaceInCurrentSubscription