Namespaces - Check Availability

  • リファレンス
Service:
Notification Hubs
API Version:
2023-09-01

すべての Azure サブスクリプションで、指定されたサービス名前空間の可用性を確認します。 これは、サービス名前空間名に基づいてドメイン名が作成されるため便利です。

POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.NotificationHubs/checkNamespaceAvailability?api-version=2023-09-01

URI パラメーター

名前 / 必須 型 説明
subscriptionId
 path True

string

uuid

ターゲット サブスクリプションの ID。 値は UUID である必要があります。
api-version
 query True

string

この操作に使用する API バージョン。

要求本文

名前 必須 型 説明
name True

string

リソース名を取得または設定します
isAvailiable

boolean

API バージョン 2023-09-01 以降は使用されず、非推奨
location

string

リソースの場所を取得または設定します
sku

Sku

名前空間の Sku の説明
tags

object

リソース タグを取得または設定します

応答

名前 型 説明
200 OK

CheckAvailabilityResult

Success
Other Status Codes

ErrorResponse

理由を含むエラー コード。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

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

Scopes

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

例

Namespaces_CheckAvailability

Sample Request

POST https://management.azure.com/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/providers/Microsoft.NotificationHubs/checkNamespaceAvailability?api-version=2023-09-01

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

Sample Response

Status code:
200 
{
  "isAvailiable": true,
  "id": "/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/providers/Microsoft.NotificationHubs/namespaces/sdk-Namespace-2924",
  "name": "sdk-Namespace-2924",
  "type": "Microsoft.NotificationHubs/namespaces/checkNamespaceAvailability"
}

定義

名前 説明
CheckAvailabilityParameters

名前空間と NotificationHubs の [名前の可用性の確認] に指定されたパラメーター。
CheckAvailabilityResult

CheckAvailability リソースの説明。
createdByType

リソースを作成した ID の種類。
ErrorAdditionalInfo

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

エラーの詳細。
ErrorResponse

エラー応答
Sku

名前空間の Sku の説明
SkuName

名前空間 SKU 名。
systemData

リソースの作成と最後の変更に関連するメタデータ。

CheckAvailabilityParameters

名前空間と NotificationHubs の [名前の可用性の確認] に指定されたパラメーター。

名前 型 説明
id

string

リソース ID を取得します
isAvailiable

boolean

API バージョン 2023-09-01 以降は使用されず、非推奨
location

string

リソースの場所を取得または設定します
name

string

リソース名を取得または設定します
sku

Sku

名前空間の Sku の説明
tags

object

リソース タグを取得または設定します
type

string

リソースの種類を取得します

CheckAvailabilityResult

CheckAvailability リソースの説明。

名前 型 説明
id

string

リソースの完全修飾リソース ID。 例: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
isAvailiable

boolean

名前が使用可能で、新しい Namespace/NotificationHub の作成に使用できる場合は、true を取得または設定します。 それ以外の場合は false。
location

string

非推奨 - 互換性のみを目的としています。
name

string

リソースの名前
sku

Sku

名前空間の Sku の説明
systemData

systemData

createdBy および modifiedBy 情報を含む Azure Resource Manager メタデータ。
tags

object

非推奨 - 互換性のみを目的としています。
type

string

リソースの型。 例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

createdByType

リソースを作成した ID の種類。

名前 型 説明
Application

string

Key

string

ManagedIdentity

string

User

string

ErrorAdditionalInfo

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

名前 型 説明
info

object

追加情報。
type

string

追加情報の種類。

ErrorDetail

エラーの詳細。

名前 型 説明
additionalInfo

ErrorAdditionalInfo[]

エラーの追加情報。
code

string

エラー コード。
details

ErrorDetail[]

エラーの詳細です。
message

string

エラー メッセージ。
target

string

エラーのターゲット。

ErrorResponse

エラー応答

名前 型 説明
error

ErrorDetail

error オブジェクト。

Sku

名前空間の Sku の説明

名前 型 説明
capacity

integer

リソースの容量を取得または設定します
family

string

Sku ファミリを取得または設定します
name

SkuName

名前空間 SKU 名。
size

string

Sku サイズを取得または設定します
tier

string

特定の SKU のレベルを取得または設定します

SkuName

名前空間 SKU 名。

名前 型 説明
Basic

string

Free

string

Standard

string

systemData

リソースの作成と最後の変更に関連するメタデータ。

名前 型 説明
createdAt

string

リソース作成のタイムスタンプ (UTC)。
createdBy

string

リソースを作成した ID。
createdByType

createdByType

リソースを作成した ID の種類。
lastModifiedAt

string

リソースの最終変更のタイムスタンプ (UTC)
lastModifiedBy

string

リソースを最後に変更した ID。
lastModifiedByType

createdByType

リソースを最後に変更した ID の種類。