Services - Check Name Availability
지정된 검색 서비스 이름을 사용할 수 있는지 여부를 확인합니다. 검색 서비스 이름은 서비스 URI(https://< name.search.windows.net>)의 일부이므로 전역적으로 고유해야 합니다.
POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Search/checkNameAvailability?api-version=2025-05-01
URI 매개 변수
| Name | In(다음 안에) | 필수 | 형식 | Description |
|---|---|---|---|---|
|
subscription
|
path | True |
string (uuid) |
대상 구독의 ID입니다. 값은 UUID여야 합니다. |
|
api-version
|
query | True |
string minLength: 1 |
이 작업에 사용할 API 버전입니다. |
요청 헤더
| Name | 필수 | 형식 | Description |
|---|---|---|---|
| x-ms-client-request-id |
string (uuid) |
이 요청을 식별하는 클라이언트에서 생성된 GUID 값입니다. 지정된 경우 요청을 추적하는 방법으로 응답 정보에 포함됩니다. |
요청 본문
| Name | 필수 | 형식 | Description |
|---|---|---|---|
| name | True |
string |
유효성을 검사할 검색 서비스 이름입니다. 검색 서비스 이름은 소문자, 숫자 또는 대시만 포함해야 하며, 처음 두 문자 또는 마지막 한 문자로 대시를 사용할 수 없고, 연속 대시를 포함할 수 없으며, 길이가 2~60자 사이여야 합니다. |
| type | True |
enum:
search |
이름의 유효성을 검사할 리소스의 형식입니다. 이 값은 항상 'searchServices'여야 합니다. |
응답
| Name | 형식 | Description |
|---|---|---|
| 200 OK |
요청이 성공했습니다. |
|
| Other Status Codes |
예기치 않은 오류 응답입니다. |
보안
azure_auth
Azure Active Directory OAuth2 흐름.
형식:
oauth2
Flow:
implicit
권한 부여 URL:
https://login.microsoftonline.com/common/oauth2/authorize
범위
| Name | Description |
|---|---|
| user_impersonation | 사용자 계정 가장 |
예제
SearchCheckNameAvailability
샘플 요청
샘플 응답
{
"message": "",
"nameAvailable": false,
"reason": "AlreadyExists"
}
정의
| Name | Description |
|---|---|
|
Check |
이름 확인 가용성 API의 입력입니다. |
|
Check |
확인 이름 가용성 API의 출력입니다. |
|
Cloud |
API 오류에 대한 정보를 포함합니다. |
|
Cloud |
오류 코드 및 메시지를 사용하여 특정 API 오류를 설명합니다. |
|
Unavailable |
이름을 사용할 수 없는 이유입니다. 'Invalid'는 제공된 이름이 명명 요구 사항(잘못된 길이, 지원되지 않는 문자 등)과 일치하지 않음을 나타냅니다. 'AlreadyExists'는 이름이 이미 사용 중이므로 사용할 수 없음을 나타냅니다. |
CheckNameAvailabilityInput
이름 확인 가용성 API의 입력입니다.
| Name | 형식 | Description |
|---|---|---|
| name |
string |
유효성을 검사할 검색 서비스 이름입니다. 검색 서비스 이름은 소문자, 숫자 또는 대시만 포함해야 하며, 처음 두 문자 또는 마지막 한 문자로 대시를 사용할 수 없고, 연속 대시를 포함할 수 없으며, 길이가 2~60자 사이여야 합니다. |
| type |
enum:
search |
이름의 유효성을 검사할 리소스의 형식입니다. 이 값은 항상 'searchServices'여야 합니다. |
CheckNameAvailabilityOutput
확인 이름 가용성 API의 출력입니다.
| Name | 형식 | Description |
|---|---|---|
| message |
string |
이름이 잘못된 이유를 설명하고 리소스 명명 요구 사항을 제공하는 메시지입니다. 'reason' 속성에 'Invalid'가 반환된 경우에만 사용할 수 있습니다. |
| nameAvailable |
boolean |
이름을 사용할 수 있는지 여부를 나타내는 값입니다. |
| reason |
이름을 사용할 수 없는 이유입니다. 'Invalid'는 제공된 이름이 명명 요구 사항(잘못된 길이, 지원되지 않는 문자 등)과 일치하지 않음을 나타냅니다. 'AlreadyExists'는 이름이 이미 사용 중이므로 사용할 수 없음을 나타냅니다. |
CloudError
API 오류에 대한 정보를 포함합니다.
| Name | 형식 | Description |
|---|---|---|
| error |
오류 코드 및 메시지를 사용하여 특정 API 오류를 설명합니다. |
|
| message |
string |
오류에 대한 간략한 설명은 무엇이 잘못되었는지를 암시합니다(세부 정보/디버깅 정보는 'error.message' 속성을 참조). |
CloudErrorBody
오류 코드 및 메시지를 사용하여 특정 API 오류를 설명합니다.
| Name | 형식 | Description |
|---|---|---|
| code |
string |
HTTP 상태 코드보다 오류 조건을 보다 정확하게 설명하는 오류 코드입니다. 프로그래밍 방식으로 특정 오류 사례를 처리하는 데 사용할 수 있습니다. |
| details |
이 오류와 관련된 중첩된 오류를 포함합니다. |
|
| message |
string |
오류를 자세히 설명하고 디버깅 정보를 제공하는 메시지입니다. |
| target |
string |
특정 오류의 대상입니다(예: 오류에 있는 속성의 이름). |
UnavailableNameReason
이름을 사용할 수 없는 이유입니다. 'Invalid'는 제공된 이름이 명명 요구 사항(잘못된 길이, 지원되지 않는 문자 등)과 일치하지 않음을 나타냅니다. 'AlreadyExists'는 이름이 이미 사용 중이므로 사용할 수 없음을 나타냅니다.
| 값 | Description |
|---|---|
| Invalid |
검색 서비스 이름이 명명 요구 사항과 일치하지 않습니다. |
| AlreadyExists |
검색 서비스 이름이 이미 다른 검색 서비스에 할당되어 있습니다. |