Check Name Availability - Namespaces - Check Name Availability

Service:

Event Hubs

API Version:

2024-01-01

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

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

URI パラメーター

名前	/	必須	型	説明
subscriptionId	path	True	string	Microsoft Azure サブスクリプションを一意に識別するサブスクリプション資格情報。 サブスクリプション ID は、全ての修理依頼についてURI の一部を生じさせます。
api-version	query	True	string	クライアント API のバージョン。

要求本文

名前	必須	型	説明
name	True	string	名前空間名の可用性をチェックする名前

応答

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

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

名前	説明
user_impersonation	ユーザー アカウントの借用

例

NamespacesCheckNameAvailability

Sample Request

HTTP

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

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

Sample Response

Status code:

200

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

定義

名前	説明
CheckNameAvailabilityParameter	チェック名前空間名の可用性操作に指定されたパラメーター
CheckNameAvailabilityResult	CheckNameAvailability 操作の結果
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答は、Event Hub サービスが受信要求を処理できないことを示します。 理由は、エラー メッセージに示されています。
UnavailableReason	サービスが使用できない理由を指定します。

CheckNameAvailabilityParameter

チェック名前空間名の可用性操作に指定されたパラメーター

名前	型	説明
name	string	名前空間名の可用性をチェックする名前

CheckNameAvailabilityResult

CheckNameAvailability 操作の結果

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

ErrorAdditionalInfo

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

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

ErrorDetail

エラーの詳細。

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

ErrorResponse

エラー応答は、Event Hub サービスが受信要求を処理できないことを示します。 理由は、エラー メッセージに示されています。

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

UnavailableReason

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

名前	型	説明
InvalidName	string
NameInLockdown	string
NameInUse	string
None	string
SubscriptionIsDisabled	string
TooManyNamespaceInCurrentSubscription	string