Belirtilen arama hizmeti için yeni bir sorgu anahtarı oluşturur. Hizmet başına en fazla 50 sorgu anahtarı oluşturabilirsiniz.
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/createQueryKey/{name}?api-version=2024-03-01-preview
URI Parametreleri
Name |
İçinde |
Gerekli |
Tür |
Description |
name
|
path |
True
|
string
|
Yeni sorgu API anahtarının adı.
|
resourceGroupName
|
path |
True
|
string
|
Geçerli abonelik içindeki kaynak grubunun adı. Bu değeri Azure Resource Manager API'sinden veya portaldan alabilirsiniz.
|
searchServiceName
|
path |
True
|
string
|
Belirtilen kaynak grubuyla ilişkili Azure AI Arama hizmeti adı.
Normal ifade deseni: ^(?=.{2,60}$)[a-z0-9][a-z0-9]+(-[a-z0-9]+)*$
|
subscriptionId
|
path |
True
|
string
|
Microsoft Azure aboneliğinin benzersiz tanımlayıcısı. Bu değeri Azure Resource Manager API'sinden veya portaldan alabilirsiniz.
|
api-version
|
query |
True
|
string
|
Her istek için kullanılacak API sürümü.
|
Name |
Gerekli |
Tür |
Description |
x-ms-client-request-id
|
|
string
uuid
|
Bu isteği tanımlayan istemci tarafından oluşturulan GUID değeri. Belirtilirse, isteği izlemenin bir yolu olarak yanıt bilgilerine eklenir.
|
Yanıtlar
Name |
Tür |
Description |
200 OK
|
QueryKey
|
Sorgu anahtarı başarıyla oluşturuldu ve yanıtta. Azure AI Arama hizmeti REST API veya SDK'daki 'api-key' parametresinin değeri olarak sorgu anahtarını kullanarak arama dizinlerinizde kimliğe göre belgeleri sorgulama ve arama gibi salt okunur işlemler gerçekleştirebilirsiniz.
|
Other Status Codes
|
CloudError
|
HTTP 404 (Bulunamadı): Abonelik, kaynak grubu veya arama hizmeti bulunamadı. HTTP 409 (Çakışma): Belirtilen abonelik devre dışı bırakıldı.
|
Güvenlik
azure_auth
Microsoft Identity platformunda desteklendiği gibi örtük bir verme akışı belirtir.
Tür:
oauth2
Akış:
implicit
Yetkilendirme URL’si:
https://login.microsoftonline.com/common/oauth2/authorize
Kapsamlar
Name |
Description |
user_impersonation
|
kullanıcı hesabınızın kimliğine bürünme
|
Örnekler
SearchCreateQueryKey
Örnek isteği
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
Örnek yanıt
{
"name": "An API key granting read-only access to the documents collection of an index.",
"key": "<a query API key>"
}
Tanımlar
Name |
Description |
CloudError
|
API hatası hakkında bilgi içerir.
|
CloudErrorBody
|
Hata kodu ve ileti içeren belirli bir API hatası açıklanır.
|
QueryKey
|
Belirli bir Azure AI Arama hizmeti için bir dizinin docs koleksiyonu üzerinde salt okunur izinleri ileten bir API anahtarını açıklar.
|
CloudError
API hatası hakkında bilgi içerir.
Name |
Tür |
Description |
error
|
CloudErrorBody
|
Hata kodu ve ileti içeren belirli bir API hatası açıklanır.
|
message
|
string
|
Neyin yanlış gittiğini gösteren hatanın kısa bir açıklaması (ayrıntılar/hata ayıklama bilgileri için 'error.message' özelliğine bakın).
|
CloudErrorBody
Hata kodu ve ileti içeren belirli bir API hatası açıklanır.
Name |
Tür |
Description |
code
|
string
|
Http durum kodundan daha kesin bir şekilde hata koşulunu açıklayan bir hata kodu. Belirli hata durumlarını program aracılığıyla işlemek için kullanılabilir.
|
details
|
CloudErrorBody[]
|
Bu hatayla ilgili iç içe hatalar içerir.
|
message
|
string
|
Hatayı ayrıntılı olarak açıklayan ve hata ayıklama bilgileri sağlayan bir ileti.
|
target
|
string
|
Belirli bir hatanın hedefi (örneğin, hatadaki özelliğin adı).
|
QueryKey
Belirli bir Azure AI Arama hizmeti için bir dizinin docs koleksiyonu üzerinde salt okunur izinleri ileten bir API anahtarını açıklar.
Name |
Tür |
Description |
key
|
string
|
Sorgu API anahtarının değeri.
|
name
|
string
|
Sorgu API anahtarının adı. Sorgu adları isteğe bağlıdır, ancak ad atamak nasıl kullanıldığını hatırlamanıza yardımcı olabilir.
|