Admin Keys - Regenerate

サービス:

Search Management

API バージョン:

2024-03-01-preview

プライマリまたはセカンダリの管理者 API キーを再生成します。 再生成できるキーは一度に 1 つだけです。

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/regenerateAdminKey/{keyKind}?api-version=2024-03-01-preview

URI パラメーター

名前	/	必須	型	説明
keyKind	path	True	AdminKeyKind	再生成するキーを指定します。 有効な値には、"primary" と "secondary" が含まれます。
resourceGroupName	path	True	string	現在のサブスクリプション内のリソース グループの名前。 この値は、Azure Resource Manager API またはポータルから取得できます。
searchServiceName	path	True	string pattern: ^(?=.{2,60}$)[a-z0-9][a-z0-9]+(-[a-z0-9]+)*$	指定したリソース グループに関連付けられている Azure AI Search サービスの名前。
subscriptionId	path	True	string	Microsoft Azure サブスクリプションの一意識別子。 この値は、Azure Resource Manager API またはポータルから取得できます。
api-version	query	True	string	各要求に使用する API バージョン。

要求ヘッダー

名前	必須	型	説明
x-ms-client-request-id		string (uuid)	この要求を識別するクライアントによって生成される GUID 値。 指定した場合、これは要求を追跡する方法として応答情報に含まれます。

応答

名前	型	説明
200 OK	AdminKeyResult	指定された管理者キーが正常に再生成されました。 新しく再生成されたキーを含め、両方の管理者キーが応答に含まれます。
Other Status Codes	CloudError	HTTP 404 (見つかりません): サブスクリプション、リソース グループ、または検索サービスが見つかりませんでした。 HTTP 409 (競合): 指定されたサブスクリプションが無効になっています。

セキュリティ

azure_auth

Microsoft ID プラットフォームでサポートされている暗黙的な許可フローを指定します。

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザー アカウントを偽装する

例

SearchRegenerateAdminKey

要求のサンプル

HTTP

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/regenerateAdminKey/primary?api-version=2024-03-01-preview

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.search import SearchManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-search
# USAGE
    python search_regenerate_admin_key.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = SearchManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.admin_keys.regenerate(
        resource_group_name="rg1",
        search_service_name="mysearchservice",
        key_kind="primary",
    )
    print(response)


# x-ms-original-file: specification/search/resource-manager/Microsoft.Search/preview/2024-03-01-preview/examples/SearchRegenerateAdminKey.json
if __name__ == "__main__":
    main()

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

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"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/cf5ad1932d00c7d15497705ad6b71171d3d68b1e/specification/search/resource-manager/Microsoft.Search/preview/2024-03-01-preview/examples/SearchRegenerateAdminKey.json
func ExampleAdminKeysClient_Regenerate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsearch.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewAdminKeysClient().Regenerate(ctx, "rg1", "mysearchservice", armsearch.AdminKeyKindPrimary, &armsearch.SearchManagementRequestOptions{ClientRequestID: nil}, 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.AdminKeyResult = armsearch.AdminKeyResult{
	// 	PrimaryKey: to.Ptr("<your primary admin API key>"),
	// 	SecondaryKey: to.Ptr("<your secondary admin 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

JavaScript

const { SearchManagementClient } = require("@azure/arm-search");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Regenerates either the primary or secondary admin API key. You can only regenerate one key at a time.
 *
 * @summary Regenerates either the primary or secondary admin API key. You can only regenerate one key at a time.
 * x-ms-original-file: specification/search/resource-manager/Microsoft.Search/preview/2024-03-01-preview/examples/SearchRegenerateAdminKey.json
 */
async function searchRegenerateAdminKey() {
  const subscriptionId = process.env["SEARCH_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["SEARCH_RESOURCE_GROUP"] || "rg1";
  const searchServiceName = "mysearchservice";
  const keyKind = "primary";
  const credential = new DefaultAzureCredential();
  const client = new SearchManagementClient(credential, subscriptionId);
  const result = await client.adminKeys.regenerate(resourceGroupName, searchServiceName, keyKind);
  console.log(result);
}

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

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.Search.Models;
using Azure.ResourceManager.Search;

// Generated from example definition: specification/search/resource-manager/Microsoft.Search/preview/2024-03-01-preview/examples/SearchRegenerateAdminKey.json
// this example is just showing the usage of "AdminKeys_Regenerate" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SearchServiceResource created on azure
// for more information of creating SearchServiceResource, please refer to the document of SearchServiceResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string searchServiceName = "mysearchservice";
ResourceIdentifier searchServiceResourceId = SearchServiceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, searchServiceName);
SearchServiceResource searchService = client.GetSearchServiceResource(searchServiceResourceId);

// invoke the operation
SearchServiceAdminKeyKind keyKind = SearchServiceAdminKeyKind.Primary;
SearchServiceAdminKeyResult result = await searchService.RegenerateAdminKeyAsync(keyKind);

Console.WriteLine($"Succeeded: {result}");

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

応答のサンプル

状態コード:

200

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

定義

名前	説明
AdminKeyKind	再生成するキーを指定します。 有効な値には、"primary" と "secondary" が含まれます。
AdminKeyResult	特定の Azure AI Search サービスのプライマリおよびセカンダリ管理者 API キーを含む応答。
CloudError	API エラーに関する情報が含まれています。
CloudErrorBody	エラー コードとメッセージを含む特定の API エラーについて説明します。

AdminKeyKind

列挙

再生成するキーを指定します。 有効な値には、"primary" と "secondary" が含まれます。

値	説明
primary	検索サービスのプライマリ API キー。
secondary	検索サービスのセカンダリ API キー。

AdminKeyResult

Object

特定の Azure AI Search サービスのプライマリおよびセカンダリ管理者 API キーを含む応答。

名前	型	説明
primaryKey	string	検索サービスのプライマリ管理者 API キー。
secondaryKey	string	検索サービスのセカンダリ管理者 API キー。

CloudError

Object

API エラーに関する情報が含まれています。

名前	型	説明
error	CloudErrorBody	エラー コードとメッセージを含む特定の API エラーについて説明します。
message	string	問題の原因を示すエラーの簡単な説明 (詳細/デバッグ情報については、'error.message' プロパティを参照してください)。

CloudErrorBody

Object

エラー コードとメッセージを含む特定の API エラーについて説明します。

名前	型	説明
code	string	HTTP 状態コードよりも正確にエラー状態を記述するエラー コード。 特定のエラー ケースをプログラムで処理するために使用できます。
details	CloudErrorBody[]	このエラーに関連する入れ子になったエラーが含まれています。
message	string	エラーの詳細を説明し、デバッグ情報を提供するメッセージ。
target	string	特定のエラーのターゲット (たとえば、エラーのプロパティの名前)。