Synonym Maps - Get

참조

서비스:: Search Service

API 버전:: 2024-07-01

동의어 맵 정의를 검색합니다.

GET {endpoint}/synonymmaps('{synonymMapName}')?api-version=2024-07-01

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
endpoint	path	True	string	검색 서비스의 엔드포인트 URL입니다.
synonymMapName	path	True	string	검색할 동의어 맵의 이름입니다.
api-version	query	True	string	클라이언트 API 버전입니다.

요청 헤더

Name	필수	형식	Description
x-ms-client-request-id		string uuid	디버깅에 도움이 되도록 요청과 함께 전송된 추적 ID입니다.

응답

Name	형식	Description
200 OK	SynonymMap
Other Status Codes	ErrorResponse	오류 응답입니다.

예제

SearchServiceGetSynonymMap

샘플 요청

HTTP

GET https://myservice.search.windows.net/synonymmaps('mysynonymmap')?api-version=2024-07-01

샘플 응답

상태 코드:: 200

{
  "name": "mysynonymmap",
  "format": "solr",
  "synonyms": "United States, United States of America, USA\nWashington, Wash. => WA",
  "encryptionKey": {
    "keyVaultKeyName": "myKeyName",
    "keyVaultKeyVersion": "myKeyVersion",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": null
    }
  }
}

정의

Name	Description
AzureActiveDirectoryApplicationCredentials	Azure Key Vault에 저장된 암호화 키에 대한 인증된 액세스에 사용되는 검색 서비스에 대해 생성된 등록된 애플리케이션의 자격 증명입니다.
ErrorAdditionalInfo	리소스 관리 오류 추가 정보입니다.
ErrorDetail	오류 세부 정보입니다.
ErrorResponse	오류 응답
SearchResourceEncryptionKey	Azure Key Vault의 고객 관리형 암호화 키입니다. 만들고 관리하는 키를 사용하여 인덱스 및 동의어 맵과 같은 미사용 데이터를 암호화하거나 암호 해독할 수 있습니다.
SynonymMap	동의어 맵 정의를 나타냅니다.
SynonymMapFormat	동의어 맵의 형식입니다. 현재 'solr' 형식만 지원됩니다.

AzureActiveDirectoryApplicationCredentials

Azure Key Vault에 저장된 암호화 키에 대한 인증된 액세스에 사용되는 검색 서비스에 대해 생성된 등록된 애플리케이션의 자격 증명입니다.

Name	형식	Description
applicationId	string	미사용 데이터를 암호화할 때 사용할 Azure Key Vault에 필요한 액세스 권한이 부여된 AAD 애플리케이션 ID입니다. 애플리케이션 ID는 AAD 애플리케이션의 개체 ID와 혼동해서는 안 됩니다.
applicationSecret	string	지정된 AAD 애플리케이션의 인증 키입니다.

ErrorAdditionalInfo

리소스 관리 오류 추가 정보입니다.

Name	형식	Description
info	object	추가 정보입니다.
type	string	추가 정보 유형입니다.

ErrorDetail

오류 세부 정보입니다.

Name	형식	Description
additionalInfo	ErrorAdditionalInfo[]	오류 추가 정보입니다.
code	string	오류 코드입니다.
details	ErrorDetail[]	오류 세부 정보입니다.
message	string	오류 메시지입니다.
target	string	오류 대상입니다.

ErrorResponse

오류 응답

Name	형식	Description
error	ErrorDetail	오류 개체입니다.

SearchResourceEncryptionKey

Azure Key Vault의 고객 관리형 암호화 키입니다. 만들고 관리하는 키를 사용하여 인덱스 및 동의어 맵과 같은 미사용 데이터를 암호화하거나 암호 해독할 수 있습니다.

Name	형식	Description
accessCredentials	AzureActiveDirectoryApplicationCredentials	Azure Key Vault에 액세스하는 데 사용되는 선택적 Azure Active Directory 자격 증명입니다. 대신 관리 ID를 사용하는 경우에는 필요하지 않습니다.
keyVaultKeyName	string	미사용 데이터를 암호화하는 데 사용할 Azure Key Vault 키의 이름입니다.
keyVaultKeyVersion	string	미사용 데이터를 암호화하는 데 사용할 Azure Key Vault 키의 버전입니다.
keyVaultUri	string	미사용 데이터를 암호화하는 데 사용할 키를 포함하는 DNS 이름이라고도 하는 Azure Key Vault의 URI입니다. 예제 URI는 `https://my-keyvault-name.vault.azure.net`수 있습니다.

SynonymMap

동의어 맵 정의를 나타냅니다.

Name	형식	Description
@odata.etag	string	동의어 맵의 ETag입니다.
encryptionKey	SearchResourceEncryptionKey	Azure Key Vault에서 만드는 암호화 키에 대한 설명입니다. 이 키는 Microsoft를 비롯한 누구도 데이터의 암호를 해독할 수 없다는 완전한 보증을 원할 때 데이터에 대한 추가 수준의 미사용 암호화를 제공하는 데 사용됩니다. 데이터를 암호화한 후에는 항상 암호화된 상태로 유지됩니다. 검색 서비스는 이 속성을 null로 설정하려는 시도를 무시합니다. 암호화 키를 회전하려는 경우 필요에 따라 이 속성을 변경할 수 있습니다. 데이터는 영향을 받지 않습니다. 고객 관리형 키를 사용한 암호화는 무료 검색 서비스에 사용할 수 없으며 2019년 1월 1일 이후 생성된 유료 서비스에만 사용할 수 있습니다.
format	SynonymMapFormat	동의어 맵의 형식입니다. 현재 'solr' 형식만 지원됩니다.
name	string	동의어 맵의 이름입니다.
synonyms	string	지정된 동의어 맵 형식의 일련의 동의어 규칙입니다. 규칙은 줄 바꿈으로 구분해야 합니다.

SynonymMapFormat

동의어 맵의 형식입니다. 현재 'solr' 형식만 지원됩니다.

Name	형식	Description
solr	string	동의어 맵에 대한 SOLR 형식을 선택합니다.

다음을 통해 공유