Genera una nueva clave de consulta para el servicio de búsqueda especificado. Puede crear hasta 50 claves de consulta por servicio.
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/createQueryKey/{name}?api-version=2024-03-01-preview
Parámetros de identificador URI
| Nombre |
En |
Requerido |
Tipo |
Description |
|
name
|
path |
True
|
string
|
Nombre de la nueva clave de API de consulta.
|
|
resourceGroupName
|
path |
True
|
string
|
Nombre del grupo de recursos dentro de la suscripción actual. Puede obtener este valor desde la API de Azure Resource Manager o el portal.
|
|
searchServiceName
|
path |
True
|
string
pattern: ^(?=.{2,60}$)[a-z0-9][a-z0-9]+(-[a-z0-9]+)*$
|
Nombre del servicio Azure AI Search asociado al grupo de recursos especificado.
|
|
subscriptionId
|
path |
True
|
string
|
Identificador único de una suscripción de Microsoft Azure. Puede obtener este valor desde la API de Azure Resource Manager o el portal.
|
|
api-version
|
query |
True
|
string
|
Versión de la API que se va a usar para cada solicitud.
|
| Nombre |
Requerido |
Tipo |
Description |
|
x-ms-client-request-id
|
|
string
(uuid)
|
Valor GUID generado por el cliente que identifica esta solicitud. Si se especifica, se incluirá en la información de respuesta como una manera de realizar un seguimiento de la solicitud.
|
Respuestas
| Nombre |
Tipo |
Description |
|
200 OK
|
QueryKey
|
La clave de consulta se creó correctamente y se encuentra en la respuesta. Puede usar la clave de consulta como valor del parámetro "api-key" en la API REST del servicio Azure AI Search o el SDK para realizar operaciones de solo lectura en los índices de búsqueda, como consultar y buscar documentos por identificador.
|
|
Other Status Codes
|
CloudError
|
HTTP 404 (no encontrado): no se encontró la suscripción, el grupo de recursos o el servicio de búsqueda. HTTP 409 (Conflicto): la suscripción especificada está deshabilitada.
|
Seguridad
azure_auth
Especifica un flujo de concesión implícito, como se admite en la plataforma de identidad de Microsoft.
Tipo:
oauth2
Flujo:
implicit
Dirección URL de autorización:
https://login.microsoftonline.com/common/oauth2/authorize
Ámbitos
| Nombre |
Description |
|
user_impersonation
|
suplantar la cuenta de usuario
|
Ejemplos
SearchCreateQueryKey
Solicitud de ejemplo
POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/createQueryKey/An API key granting read-only access to the documents collection of an index.?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_create_query_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.query_keys.create(
resource_group_name="rg1",
search_service_name="mysearchservice",
name="An API key granting read-only access to the documents collection of an index.",
)
print(response)
# x-ms-original-file: specification/search/resource-manager/Microsoft.Search/preview/2024-03-01-preview/examples/SearchCreateQueryKey.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/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("<subscription-id>", 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.", &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.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
const { SearchManagementClient } = require("@azure/arm-search");
const { DefaultAzureCredential } = require("@azure/identity");
/**
* This sample demonstrates how to Generates a new query key for the specified search service. You can create up to 50 query keys per service.
*
* @summary Generates a new query key for the specified search service. You can create up to 50 query keys per service.
* x-ms-original-file: specification/search/resource-manager/Microsoft.Search/preview/2024-03-01-preview/examples/SearchCreateQueryKey.json
*/
async function searchCreateQueryKey() {
const subscriptionId = process.env["SEARCH_SUBSCRIPTION_ID"] || "subid";
const resourceGroupName = process.env["SEARCH_RESOURCE_GROUP"] || "rg1";
const searchServiceName = "mysearchservice";
const name = "An API key granting read-only access to the documents collection of an index.";
const credential = new DefaultAzureCredential();
const client = new SearchManagementClient(credential, subscriptionId);
const result = await client.queryKeys.create(resourceGroupName, searchServiceName, name);
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/SearchCreateQueryKey.json
// this example is just showing the usage of "QueryKeys_Create" 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
string name = "An API key granting read-only access to the documents collection of an index.";
SearchServiceQueryKey result = await searchService.CreateQueryKeyAsync(name);
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
Respuesta de muestra
{
"name": "An API key granting read-only access to the documents collection of an index.",
"key": "<a query API key>"
}
Definiciones
| Nombre |
Description |
|
CloudError
|
Contiene información sobre un error de API.
|
|
CloudErrorBody
|
Describe un error de API determinado con un código de error y un mensaje.
|
|
QueryKey
|
Describe una clave de API para un servicio de Azure AI Search determinado que transmite permisos de solo lectura en la colección de documentos de un índice.
|
CloudError
Object
Contiene información sobre un error de API.
| Nombre |
Tipo |
Description |
|
error
|
CloudErrorBody
|
Describe un error de API determinado con un código de error y un mensaje.
|
|
message
|
string
|
Una breve descripción del error que indica lo que salió mal (para obtener detalles o información de depuración, consulte la propiedad "error.message").
|
CloudErrorBody
Object
Describe un error de API determinado con un código de error y un mensaje.
| Nombre |
Tipo |
Description |
|
code
|
string
|
Código de error que describe la condición de error más precisamente que un código de estado HTTP. Se puede usar para controlar mediante programación casos de error específicos.
|
|
details
|
CloudErrorBody[]
|
Contiene errores anidados relacionados con este error.
|
|
message
|
string
|
Mensaje que describe el error con detalle y proporciona información de depuración.
|
|
target
|
string
|
Destino del error concreto (por ejemplo, el nombre de la propiedad en error).
|
QueryKey
Object
Describe una clave de API para un servicio de Azure AI Search determinado que transmite permisos de solo lectura en la colección de documentos de un índice.
| Nombre |
Tipo |
Description |
|
key
|
string
|
Valor de la clave de API de consulta.
|
|
name
|
string
|
Nombre de la clave de API de consulta. Los nombres de consulta son opcionales, pero asignar un nombre puede ayudarle a recordar cómo se usa.
|