Query Keys - Create

서비스:

Search Management

API 버전:

2025-05-01

지정된 검색 서비스에 대한 새 쿼리 키를 생성합니다. 서비스당 최대 50개 쿼리 키를 만들 수 있습니다.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/createQueryKey/{name}?api-version=2025-05-01

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
name	path	True	string	새 쿼리 API 키의 이름입니다.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	리소스 그룹의 이름입니다. 이름은 대소문자를 구분하지 않습니다.
searchServiceName	path	True	string pattern: ^(?=.{2,60}$)[a-z0-9][a-z0-9]+(-[a-z0-9]+)*$	지정된 리소스 그룹과 연결된 Azure AI Search 서비스의 이름입니다.
subscriptionId	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
200 OK	QueryKey	Azure 작업이 성공적으로 완료되었습니다.
Other Status Codes	CloudError	예기치 않은 오류 응답입니다.

보안

azure_auth

Azure Active Directory OAuth2 흐름.

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

범위

Name	Description
user_impersonation	사용자 계정 가장

예제

SearchCreateQueryKey

샘플 요청

HTTP

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/createQueryKey/An API key granting read-only access to the documents collection of an index.?api-version=2025-05-01

Go

package armsearch_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/search/armsearch/v2"
)

// Generated from example definition: 2025-05-01/SearchCreateQueryKey.json
func ExampleQueryKeysClient_Create() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsearch.NewClientFactory("00000000-0000-0000-0000-000000000000", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewQueryKeysClient().Create(ctx, "rg1", "mysearchservice", "An API key granting read-only access to the documents collection of an index.", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res = armsearch.QueryKeysClientCreateResponse{
	// 	QueryKey: &armsearch.QueryKey{
	// 		Name: to.Ptr("An API key granting read-only access to the documents collection of an index."),
	// 		Key: to.Ptr("<a query API key>"),
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

샘플 응답

상태 코드:

200

{
  "name": "An API key granting read-only access to the documents collection of an index.",
  "key": "<a query API key>"
}

정의

Name	Description
CloudError	API 오류에 대한 정보를 포함합니다.
CloudErrorBody	오류 코드 및 메시지를 사용하여 특정 API 오류를 설명합니다.
QueryKey	인덱스의 문서 컬렉션에 대한 읽기 전용 권한을 전달하는 지정된 Azure AI Search 서비스에 대한 API 키를 설명합니다.

CloudError

Object

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

Name	형식	Description
error	CloudErrorBody	오류 코드 및 메시지를 사용하여 특정 API 오류를 설명합니다.
message	string	오류에 대한 간략한 설명은 무엇이 잘못되었는지를 암시합니다(세부 정보/디버깅 정보는 'error.message' 속성을 참조).

CloudErrorBody

Object

오류 코드 및 메시지를 사용하여 특정 API 오류를 설명합니다.

Name	형식	Description
code	string	HTTP 상태 코드보다 오류 조건을 보다 정확하게 설명하는 오류 코드입니다. 프로그래밍 방식으로 특정 오류 사례를 처리하는 데 사용할 수 있습니다.
details	CloudErrorBody[]	이 오류와 관련된 중첩된 오류를 포함합니다.
message	string	오류를 자세히 설명하고 디버깅 정보를 제공하는 메시지입니다.
target	string	특정 오류의 대상입니다(예: 오류에 있는 속성의 이름).

QueryKey

Object

인덱스의 문서 컬렉션에 대한 읽기 전용 권한을 전달하는 지정된 Azure AI Search 서비스에 대한 API 키를 설명합니다.

Name	형식	Description
key	string	쿼리 API 키의 값입니다.
name	string	쿼리 API 키의 이름입니다. 쿼리 이름은 선택 사항이지만 이름을 할당하면 사용 방법을 기억하는 데 도움이 될 수 있습니다.