Returns the list of query API keys for the given Azure AI Search service.
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/listQueryKeys?api-version=2024-03-01-preview
URI Parameters
Name |
In |
Required |
Type |
Description |
resourceGroupName
|
path |
True
|
string
|
The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal.
|
searchServiceName
|
path |
True
|
string
|
The name of the Azure AI Search service associated with the specified resource group.
Regex pattern: ^(?=.{2,60}$)[a-z0-9][a-z0-9]+(-[a-z0-9]+)*$
|
subscriptionId
|
path |
True
|
string
|
The unique identifier for a Microsoft Azure subscription. You can obtain this value from the Azure Resource Manager API or the portal.
|
api-version
|
query |
True
|
string
|
The API version to use for each request.
|
Name |
Required |
Type |
Description |
x-ms-client-request-id
|
|
string
uuid
|
A client-generated GUID value that identifies this request. If specified, this will be included in response information as a way to track the request.
|
Responses
Name |
Type |
Description |
200 OK
|
ListQueryKeysResult
|
All query keys for the given search service were successfully retrieved and are in the response. You can use any of the query keys as the value of the 'api-key' parameter in the Azure AI Search Service REST API or SDK to perform read-only operations on your Search indexes such as querying and looking up documents by ID.
|
Other Status Codes
|
CloudError
|
HTTP 404 (Not Found): The subscription, resource group, or search service could not be found. HTTP 409 (Conflict): The specified subscription is disabled.
|
Security
azure_auth
Specifies an implicit grant flow, as supported on the Microsoft Identity platform.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name |
Description |
user_impersonation
|
impersonate your user account
|
Examples
SearchListQueryKeysBySearchService
Sample request
POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/listQueryKeys?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_list_query_keys_by_search_service.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.list_by_search_service(
resource_group_name="rg1",
search_service_name="mysearchservice",
)
for item in response:
print(item)
# x-ms-original-file: specification/search/resource-manager/Microsoft.Search/preview/2024-03-01-preview/examples/SearchListQueryKeysBySearchService.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/SearchListQueryKeysBySearchService.json
func ExampleQueryKeysClient_NewListBySearchServicePager() {
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)
}
pager := clientFactory.NewQueryKeysClient().NewListBySearchServicePager("rg1", "mysearchservice", &armsearch.SearchManagementRequestOptions{ClientRequestID: nil}, nil)
for pager.More() {
page, err := pager.NextPage(ctx)
if err != nil {
log.Fatalf("failed to advance page: %v", err)
}
for _, v := range page.Value {
// You could use page here. We use blank identifier for just demo purposes.
_ = v
}
// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// page.ListQueryKeysResult = armsearch.ListQueryKeysResult{
// Value: []*armsearch.QueryKey{
// {
// Name: to.Ptr("Query key for browser-based clients"),
// Key: to.Ptr("<a query API key>"),
// },
// {
// Name: to.Ptr("Query key for mobile clients"),
// Key: to.Ptr("<another 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 Returns the list of query API keys for the given Azure AI Search service.
*
* @summary Returns the list of query API keys for the given Azure AI Search service.
* x-ms-original-file: specification/search/resource-manager/Microsoft.Search/preview/2024-03-01-preview/examples/SearchListQueryKeysBySearchService.json
*/
async function searchListQueryKeysBySearchService() {
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 resArray = new Array();
for await (let item of client.queryKeys.listBySearchService(
resourceGroupName,
searchServiceName,
)) {
resArray.push(item);
}
console.log(resArray);
}
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/SearchListQueryKeysBySearchService.json
// this example is just showing the usage of "QueryKeys_ListBySearchService" 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 and iterate over the result
await foreach (SearchServiceQueryKey item in searchService.GetQueryKeysBySearchServiceAsync())
{
Console.WriteLine($"Succeeded: {item}");
}
Console.WriteLine($"Succeeded");
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
Sample response
{
"value": [
{
"name": "Query key for browser-based clients",
"key": "<a query API key>"
},
{
"name": "Query key for mobile clients",
"key": "<another query API key>"
}
]
}
Definitions
Name |
Description |
CloudError
|
Contains information about an API error.
|
CloudErrorBody
|
Describes a particular API error with an error code and a message.
|
ListQueryKeysResult
|
Response containing the query API keys for a given Azure AI Search service.
|
QueryKey
|
Describes an API key for a given Azure AI Search service that conveys read-only permissions on the docs collection of an index.
|
CloudError
Contains information about an API error.
Name |
Type |
Description |
error
|
CloudErrorBody
|
Describes a particular API error with an error code and a message.
|
message
|
string
|
A brief description of the error that hints at what went wrong (for details/debugging information refer to the 'error.message' property).
|
CloudErrorBody
Describes a particular API error with an error code and a message.
Name |
Type |
Description |
code
|
string
|
An error code that describes the error condition more precisely than an HTTP status code. Can be used to programmatically handle specific error cases.
|
details
|
CloudErrorBody[]
|
Contains nested errors that are related to this error.
|
message
|
string
|
A message that describes the error in detail and provides debugging information.
|
target
|
string
|
The target of the particular error (for example, the name of the property in error).
|
ListQueryKeysResult
Response containing the query API keys for a given Azure AI Search service.
Name |
Type |
Description |
nextLink
|
string
|
Request URL that can be used to query next page of query keys. Returned when the total number of requested query keys exceed maximum page size.
|
value
|
QueryKey[]
|
The query keys for the Azure AI Search service.
|
QueryKey
Describes an API key for a given Azure AI Search service that conveys read-only permissions on the docs collection of an index.
Name |
Type |
Description |
key
|
string
|
The value of the query API key.
|
name
|
string
|
The name of the query API key. Query names are optional, but assigning a name can help you remember how it's used.
|