Aliases - Create Or Update

서비스:: Search Service

API 버전:: 2023-10-01-Preview

새 검색 별칭을 만들거나 이미 있는 경우 별칭을 업데이트합니다.

PUT {endpoint}/aliases('{aliasName}')?api-version=2023-10-01-Preview

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
aliasName	path	True	string	만들거나 업데이트할 별칭의 정의입니다.
endpoint	path	True	string	검색 서비스의 엔드포인트 URL입니다.
api-version	query	True	string	클라이언트 API 버전입니다.

요청 헤더

Name	필수	형식	Description
x-ms-client-request-id		string (uuid)	디버깅에 도움이 되도록 요청과 함께 전송된 추적 ID입니다.
If-Match		string	If-Match 조건을 정의합니다. 서버의 ETag가 이 값과 일치하는 경우에만 작업이 수행됩니다.
If-None-Match		string	If-None-Match 조건을 정의합니다. 서버의 ETag가 이 값과 일치하지 않는 경우에만 작업이 수행됩니다.
Prefer	True	string	HTTP PUT 요청의 경우 성공 시 생성/업데이트된 리소스를 반환하도록 서비스에 지시합니다.

요청 본문

Name	필수	형식	Description
indexes	True	string[]	이 별칭이 매핑되는 인덱스의 이름입니다. 인덱스 이름은 하나만 지정할 수 있습니다.
name	True	string	별칭의 이름입니다.
@odata.etag		string	별칭의 ETag입니다.

응답

Name	형식	Description
200 OK	SearchAlias
201 Created	SearchAlias
Other Status Codes	SearchError	오류 응답입니다.

예제

SearchServiceCreateOrUpdateAlias

샘플 요청

HTTP

PUT https://myservice.search.windows.net/aliases('production')?api-version=2023-10-01-Preview


{
  "name": "production",
  "indexes": [
    "hotels"
  ]
}

샘플 응답

상태 코드:: 200

{
  "name": "production",
  "indexes": [
    "hotels"
  ]
}

상태 코드:: 201

{
  "name": "production",
  "indexes": [
    "hotels"
  ]
}

정의

Name	Description
SearchAlias	별칭 이름에서 인덱스로의 매핑을 설명하는 인덱스 별칭을 나타냅니다. 지원되는 작업에 대한 인덱스 이름 대신 별칭 이름을 사용할 수 있습니다.
SearchError	API에 대한 오류 조건을 설명합니다.

SearchAlias

Object

별칭 이름에서 인덱스로의 매핑을 설명하는 인덱스 별칭을 나타냅니다. 지원되는 작업에 대한 인덱스 이름 대신 별칭 이름을 사용할 수 있습니다.

Name	형식	Description
@odata.etag	string	별칭의 ETag입니다.
indexes	string[]	이 별칭이 매핑되는 인덱스의 이름입니다. 인덱스 이름은 하나만 지정할 수 있습니다.
name	string	별칭의 이름입니다.

SearchError

Object

API에 대한 오류 조건을 설명합니다.

Name	형식	Description
code	string	서버에서 정의한 오류 코드 집합 중 하나입니다.
details	SearchError[]	이 보고된 오류로 이어진 특정 오류에 대한 세부 정보 배열입니다.
message	string	사람이 읽을 수 있는 오류 표현입니다.