다음을 통해 공유


Admin Keys - Get

지정된 검색 서비스에 대한 기본 및 보조 관리자 API 키를 가져옵니다.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/listAdminKeys?api-version=2023-11-01

URI 매개 변수

Name In(다음 안에) 필수 형식 Description
resourceGroupName
path True

string

현재 구독 내의 리소스 그룹 이름입니다. Azure 리소스 관리자 API 또는 포털에서 이 값을 가져올 수 있습니다.

searchServiceName
path True

string

지정된 리소스 그룹과 연결된 검색 서비스의 이름입니다.

subscriptionId
path True

string

Microsoft Azure 구독의 고유 식별자입니다. Azure Resource Manager API, 명령줄 도구 또는 포털에서 이 값을 가져올 수 있습니다.

api-version
query True

string

각 요청에 사용할 API 버전입니다.

요청 헤더

Name 필수 형식 Description
x-ms-client-request-id

string

uuid

이 요청을 식별하는 클라이언트에서 생성한 GUID 값입니다. 지정된 경우 요청을 추적하는 방법으로 응답 정보에 포함됩니다.

응답

Name 형식 Description
200 OK

AdminKeyResult

관리자 키가 성공적으로 검색되었으며 응답에 있습니다. 기본 또는 보조 키를 데이터 평면 REST API의 'api-key' 매개 변수 값으로 사용하거나 Azure SDK를 사용하여 권한 있는 작업을 포함하여 검색 서비스에서 모든 작업을 수행할 수 있습니다. 권한 있는 작업에는 인덱스 및 데이터 원본과 같은 리소스 관리와 인덱스의 데이터 업로드, 수정 또는 삭제가 포함됩니다.

Other Status Codes

CloudError

HTTP 404(찾을 수 없음): 구독, 리소스 그룹 또는 검색 서비스를 찾을 수 없습니다. HTTP 409(충돌): 지정된 구독을 사용할 수 없습니다.

보안

azure_auth

OAuth2 권한 부여 흐름을 Microsoft Entra ID.

형식: oauth2
Flow: implicit
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/authorize

범위

Name Description
user_impersonation 사용자 계정 가장

예제

SearchGetAdminKeys

샘플 요청

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/listAdminKeys?api-version=2023-11-01

샘플 응답

{
  "primaryKey": "<your primary admin API key>",
  "secondaryKey": "<your secondary admin API key>"
}

정의

Name Description
AdminKeyResult

지정된 검색 서비스에 대한 기본 및 보조 관리자 API 키를 포함하는 응답입니다.

CloudError

API 오류에 대한 정보를 포함합니다.

CloudErrorBody

오류 코드와 메시지가 있는 특정 API 오류에 대해 설명합니다.

AdminKeyResult

지정된 검색 서비스에 대한 기본 및 보조 관리자 API 키를 포함하는 응답입니다.

Name 형식 Description
primaryKey

string

검색 서비스의 기본 관리자 API 키입니다.

secondaryKey

string

검색 서비스의 보조 관리자 API 키입니다.

CloudError

API 오류에 대한 정보를 포함합니다.

Name 형식 Description
error

CloudErrorBody

오류 코드와 메시지가 있는 특정 API 오류에 대해 설명합니다.

CloudErrorBody

오류 코드와 메시지가 있는 특정 API 오류에 대해 설명합니다.

Name 형식 Description
code

string

HTTP 상태 코드보다 더 정확하게 오류 조건을 설명하는 오류 코드입니다. 프로그래밍 방식으로 특정 오류 사례를 처리하는 데 사용할 수 있습니다.

details

CloudErrorBody[]

이 오류와 관련된 중첩된 오류를 포함합니다.

message

string

오류를 자세히 설명하고 디버깅 정보를 제공하는 메시지입니다.

target

string

특정 오류의 대상(예: 오류에 있는 속성의 이름)입니다.