Admin Keys - Get

Referência

Serviço:: Search Management

Versão da API:: 2024-03-01-preview

Obtém as chaves da API de administração primária e secundária para o serviço Pesquisa de IA do Azure especificado.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
resourceGroupName	path	True	string	O nome do grupo de recursos na assinatura atual. Você pode obter esse valor por meio da API do Gerenciador de Recursos do Azure ou por meio do portal.
searchServiceName	path	True	string	O nome da IA do Azure serviço Pesquisa associado ao grupo de recursos especificado. Padrão Regex: `^(?=.{2,60}$)[a-z0-9][a-z0-9]+(-[a-z0-9]+)*$`
subscriptionId	path	True	string	O identificador exclusivo para uma assinatura do Microsoft Azure. Você pode obter esse valor por meio da API do Gerenciador de Recursos do Azure ou por meio do portal.
api-version	query	True	string	A versão da API a ser usada para cada solicitação.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
x-ms-client-request-id		string uuid	Um valor de GUID gerado pelo cliente que identifica esta solicitação. Se especificado, isso será incluído nas informações de resposta como uma maneira de acompanhar a solicitação.

Respostas

Nome	Tipo	Description
200 OK	AdminKeyResult	As chaves de administrador foram recuperadas com êxito e estão na resposta. Você pode usar a chave primária ou secundária como o valor do parâmetro 'api-key' na IA do Azure serviço Pesquisa API REST ou SDK para executar quaisquer operações em seu serviço de pesquisa, incluindo operações privilegiadas. As operações privilegiadas incluem o gerenciamento de recursos, como índices e fontes de dados, bem como o upload, a modificação ou a exclusão de dados em seus índices.
Other Status Codes	CloudError	HTTP 404 (Não Encontrado): não foi possível encontrar a assinatura, o grupo de recursos ou o serviço de pesquisa. HTTP 409 (Conflito): a assinatura especificada está desabilitada.

Segurança

azure_auth

Especifica um fluxo de concessão implícito, conforme suportado na plataforma do Microsoft Identity.

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

SearchGetAdminKeys

Solicitação de exemplo

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

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

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-search
# USAGE
    python search_get_admin_keys.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.get(
        resource_group_name="rg1",
        search_service_name="mysearchservice",
    )
    print(response)


# x-ms-original-file: specification/search/resource-manager/Microsoft.Search/preview/2024-03-01-preview/examples/SearchGetAdminKeys.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

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/SearchGetAdminKeys.json
func ExampleAdminKeysClient_Get() {
	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().Get(ctx, "rg1", "mysearchservice", &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

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

/**
 * This sample demonstrates how to Gets the primary and secondary admin API keys for the specified Azure AI Search service.
 *
 * @summary Gets the primary and secondary admin API keys for the specified Azure AI Search service.
 * x-ms-original-file: specification/search/resource-manager/Microsoft.Search/preview/2024-03-01-preview/examples/SearchGetAdminKeys.json
 */
async function searchGetAdminKeys() {
  const subscriptionId = process.env["SEARCH_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["SEARCH_RESOURCE_GROUP"] || "rg1";
  const searchServiceName = "mysearchservice";
  const credential = new DefaultAzureCredential();
  const client = new SearchManagementClient(credential, subscriptionId);
  const result = await client.adminKeys.get(resourceGroupName, searchServiceName);
  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

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/SearchGetAdminKeys.json
// this example is just showing the usage of "AdminKeys_Get" 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
SearchServiceAdminKeyResult result = await searchService.GetAdminKeyAsync();

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

Resposta de exemplo

Código de status:: 200

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

Definições

Nome	Description
AdminKeyResult	Resposta que contém as chaves da API de administrador primário e secundário para um determinado serviço Pesquisa de IA do Azure.
CloudError	Contém informações sobre um erro de API.
CloudErrorBody	Descreve um erro de API específico com um código de erro e uma mensagem.

AdminKeyResult

Resposta que contém as chaves da API de administrador primário e secundário para um determinado serviço Pesquisa de IA do Azure.

Nome	Tipo	Description
primaryKey	string	A chave da API de administrador primário do serviço de pesquisa.
secondaryKey	string	A chave de API de administrador secundário do serviço de pesquisa.

CloudError

Contém informações sobre um erro de API.

Nome	Tipo	Description
error	CloudErrorBody	Descreve um erro de API específico com um código de erro e uma mensagem.
message	string	Uma breve descrição do erro que indica o que deu errado (para obter detalhes/informações de depuração, consulte a propriedade 'error.message').

CloudErrorBody

Descreve um erro de API específico com um código de erro e uma mensagem.

Nome	Tipo	Description
code	string	Um código de erro que descreve a condição de erro com mais precisão do que um código de status HTTP. Pode ser usado para lidar programaticamente com casos de erro específicos.
details	CloudErrorBody[]	Contém erros aninhados relacionados a esse erro.
message	string	Uma mensagem que descreve o erro em detalhes e fornece informações de depuração.
target	string	O destino do erro específico (por exemplo, o nome da propriedade em erro).

Compartilhar via

Admin Keys - Get

Parâmetros de URI

Cabeçalho da solicitação

Respostas

Segurança

azure_auth

Escopos

Exemplos

SearchGetAdminKeys

Solicitação de exemplo

Resposta de exemplo

Definições

AdminKeyResult

CloudError

CloudErrorBody

Recursos adicionais