Web Pub Sub - Check Name Availability

リソース名が有効であり、まだ使用されていないことを確認します。

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

URI パラメーター

名前 / 必須 説明
location
path True

string

リージョン

subscriptionId
path True

string

uuid

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

api-version
query True

string

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

要求本文

名前 必須 説明
name True

string

検証するリソース名。 例:."my-resource-name"

type True

string

リソースの種類。 "Microsoft.SignalRService/SignalR"、"Microsoft.SignalRService/WebPubSub"、"Microsoft.SignalRService/SignalR/replicas"、または "Microsoft.SignalRService/WebPubSub/replicas" を指定できます。

応答

名前 説明
200 OK

NameAvailability

正常終了しました。 応答では、名前の可用性について説明します。

Other Status Codes

ErrorResponse

操作に失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

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

スコープ

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

WebPubSub_CheckNameAvailability

要求のサンプル

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.SignalRService/locations/eastus/checkNameAvailability?api-version=2024-03-01

{
  "type": "Microsoft.SignalRService/WebPubSub",
  "name": "myWebPubSubService"
}

応答のサンプル

{
  "nameAvailable": false,
  "reason": "AlreadyExists",
  "message": "The name is already taken. Please try a different name."
}

定義

名前 説明
ErrorAdditionalInfo

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

ErrorDetail

エラーの詳細。

ErrorResponse

エラー応答

NameAvailability

名前の可用性をチェック要求の結果。 これには、フラグとエラーの考えられる理由が含まれています。

NameAvailabilityParameters

nameAvailability アクションへのデータ POST

ErrorAdditionalInfo

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

名前 説明
info

object

追加情報。

type

string

追加情報の種類。

ErrorDetail

エラーの詳細。

名前 説明
additionalInfo

ErrorAdditionalInfo[]

エラーの追加情報。

code

string

エラー コード。

details

ErrorDetail[]

エラーの詳細です。

message

string

エラー メッセージ。

target

string

エラーのターゲット。

ErrorResponse

エラー応答

名前 説明
error

ErrorDetail

error オブジェクト。

NameAvailability

名前の可用性をチェック要求の結果。 これには、フラグとエラーの考えられる理由が含まれています。

名前 説明
message

string

操作のメッセージ。

nameAvailable

boolean

名前が使用できるかどうかを示します。

reason

string

可用性の理由。 name が使用できない場合は必須。

NameAvailabilityParameters

nameAvailability アクションへのデータ POST

名前 説明
name

string

検証するリソース名。 例:."my-resource-name"

type

string

リソースの種類。 "Microsoft.SignalRService/SignalR"、"Microsoft.SignalRService/WebPubSub"、"Microsoft.SignalRService/SignalR/replicas"、または "Microsoft.SignalRService/WebPubSub/replicas" を指定できます。