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 매개 변수
Name | In(다음 안에) | 필수 | 형식 | Description |
---|---|---|---|---|
location
|
path | True |
string |
지역 |
subscription
|
path | True |
string uuid |
대상 구독의 ID입니다. 값은 UUID여야 합니다. |
api-version
|
query | True |
string |
이 작업에 사용할 API 버전입니다. |
요청 본문
Name | 필수 | 형식 | Description |
---|---|---|---|
name | True |
string |
유효성을 검사할 리소스 이름입니다. 예: my-resource-name" |
type | True |
string |
리소스 종류입니다. "Microsoft.SignalRService/SignalR", "Microsoft.SignalRService/WebPubSub", "Microsoft.SignalRService/SignalR/replicas" 또는 "Microsoft.SignalRService/WebPubSub/replicas"일 수 있습니다. |
응답
Name | 형식 | Description |
---|---|---|
200 OK |
성공. 응답은 이름 가용성을 설명합니다. |
|
Other Status Codes |
작업이 실패한 이유를 설명하는 오류 응답입니다. |
보안
azure_auth
Azure Active Directory OAuth2 Flow
형식:
oauth2
Flow:
implicit
권한 부여 URL:
https://login.microsoftonline.com/common/oauth2/authorize
범위
Name | Description |
---|---|
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."
}
정의
Name | Description |
---|---|
Error |
리소스 관리 오류 추가 정보입니다. |
Error |
오류 세부 정보입니다. |
Error |
오류 응답 |
Name |
이름 가용성을 검사 요청의 결과입니다. 플래그와 가능한 실패 이유가 포함됩니다. |
Name |
nameAvailability 작업에 대한 데이터 POST-ed |
ErrorAdditionalInfo
리소스 관리 오류 추가 정보입니다.
Name | 형식 | Description |
---|---|---|
info |
object |
추가 정보입니다. |
type |
string |
추가 정보 유형입니다. |
ErrorDetail
오류 세부 정보입니다.
Name | 형식 | Description |
---|---|---|
additionalInfo |
오류 추가 정보입니다. |
|
code |
string |
오류 코드입니다. |
details |
오류 세부 정보입니다. |
|
message |
string |
오류 메시지입니다. |
target |
string |
오류 대상입니다. |
ErrorResponse
오류 응답
Name | 형식 | Description |
---|---|---|
error |
Error 개체. |
NameAvailability
이름 가용성을 검사 요청의 결과입니다. 플래그와 가능한 실패 이유가 포함됩니다.
Name | 형식 | Description |
---|---|---|
message |
string |
작업의 메시지입니다. |
nameAvailable |
boolean |
이름을 사용할 수 있는지 여부를 나타냅니다. |
reason |
string |
가용성의 이유입니다. 이름을 사용할 수 없는 경우 필수입니다. |
NameAvailabilityParameters
nameAvailability 작업에 대한 데이터 POST-ed
Name | 형식 | Description |
---|---|---|
name |
string |
유효성을 검사할 리소스 이름입니다. 예: my-resource-name" |
type |
string |
리소스 종류입니다. "Microsoft.SignalRService/SignalR", "Microsoft.SignalRService/WebPubSub", "Microsoft.SignalRService/SignalR/replicas" 또는 "Microsoft.SignalRService/WebPubSub/replicas"일 수 있습니다. |