Ottiene le chiavi API di amministrazione primaria e secondaria per il servizio di ricerca di Intelligenza artificiale di Azure specificato.
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/listAdminKeys?api-version=2024-03-01-preview
Parametri dell'URI
| Nome |
In |
Necessario |
Tipo |
Descrizione |
|
resourceGroupName
|
path |
True
|
string
|
Nome del gruppo di risorse all'interno della sottoscrizione corrente. È possibile ottenere questo valore dall'API di Gestione risorse di Azure o dal portale.
|
|
searchServiceName
|
path |
True
|
string
|
Nome del servizio di ricerca di intelligenza artificiale di Azure associato al gruppo di risorse specificato.
Criterio di espressione regolare: ^(?=.{2,60}$)[a-z0-9][a-z0-9]+(-[a-z0-9]+)*$
|
|
subscriptionId
|
path |
True
|
string
|
Identificatore univoco per una sottoscrizione di Microsoft Azure. È possibile ottenere questo valore dall'API di Gestione risorse di Azure o dal portale.
|
|
api-version
|
query |
True
|
string
|
Versione dell'API da usare per ogni richiesta.
|
| Nome |
Necessario |
Tipo |
Descrizione |
|
x-ms-client-request-id
|
|
string
uuid
|
Valore GUID generato dal client che identifica la richiesta. Se specificato, verrà incluso nelle informazioni di risposta come modo per tenere traccia della richiesta.
|
Risposte
| Nome |
Tipo |
Descrizione |
|
200 OK
|
AdminKeyResult
|
Le chiavi di amministrazione sono state recuperate correttamente e sono nella risposta. È possibile usare la chiave primaria o secondaria come valore del parametro 'api-key' nell'API REST di Azure per intelligenza artificiale servizio di ricerca o SDK per eseguire qualsiasi operazione nel servizio di ricerca, incluse le operazioni con privilegi. Le operazioni con privilegi includono la gestione di risorse come indici e origini dati, nonché il caricamento, la modifica o l'eliminazione di dati negli indici.
|
|
Other Status Codes
|
CloudError
|
HTTP 404 (Non trovato): impossibile trovare la sottoscrizione, il gruppo di risorse o il servizio di ricerca. HTTP 409 (Conflitto): la sottoscrizione specificata è disabilitata.
|
Sicurezza
azure_auth
Specifica un flusso di concessione implicita, come supportato in Microsoft Identity Platform.
Tipo:
oauth2
Flow:
implicit
URL di autorizzazione:
https://login.microsoftonline.com/common/oauth2/authorize
Ambiti
| Nome |
Descrizione |
|
user_impersonation
|
rappresentare l'account utente
|
Esempio
SearchGetAdminKeys
Esempio di richiesta
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
Risposta di esempio
{
"primaryKey": "<your primary admin API key>",
"secondaryKey": "<your secondary admin API key>"
}
Definizioni
| Nome |
Descrizione |
|
AdminKeyResult
|
Risposta contenente le chiavi API di amministrazione primaria e secondaria per un determinato servizio di ricerca di intelligenza artificiale di Azure.
|
|
CloudError
|
Contiene informazioni su un errore dell'API.
|
|
CloudErrorBody
|
Descrive un particolare errore dell'API con un codice di errore e un messaggio.
|
AdminKeyResult
Risposta contenente le chiavi API di amministrazione primaria e secondaria per un determinato servizio di ricerca di intelligenza artificiale di Azure.
| Nome |
Tipo |
Descrizione |
|
primaryKey
|
string
|
Chiave API amministratore primaria del servizio di ricerca.
|
|
secondaryKey
|
string
|
Chiave API amministratore secondaria del servizio di ricerca.
|
CloudError
Contiene informazioni su un errore dell'API.
| Nome |
Tipo |
Descrizione |
|
error
|
CloudErrorBody
|
Descrive un particolare errore dell'API con un codice di errore e un messaggio.
|
|
message
|
string
|
Breve descrizione dell'errore che indica cosa è andato storto (per informazioni dettagliate/di debug fare riferimento alla proprietà "error.message").
|
CloudErrorBody
Descrive un particolare errore dell'API con un codice di errore e un messaggio.
| Nome |
Tipo |
Descrizione |
|
code
|
string
|
Codice di errore che descrive più precisamente la condizione di errore rispetto a un codice di stato HTTP. Può essere usato per gestire casi di errore specifici a livello di codice.
|
|
details
|
CloudErrorBody[]
|
Contiene errori annidati correlati a questo errore.
|
|
message
|
string
|
Messaggio che descrive l'errore in dettaglio e fornisce informazioni di debug.
|
|
target
|
string
|
Destinazione dell'errore specifico, ad esempio il nome della proprietà in errore.
|