1. Packages
  2. Azure Native
  3. API Docs
  4. search
  5. listQueryKeyBySearchService
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Viewing docs for Azure Native v3.16.0
published on Friday, Mar 20, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-azure-native

azure-native.search.listQueryKeyBySearchService

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Viewing docs for Azure Native v3.16.0
published on Friday, Mar 20, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-azure-native

    Returns the list of query API keys for the given Azure AI Search service.

    Uses Azure REST API version 2025-05-01.

    Other available API versions: 2022-09-01, 2023-11-01, 2024-03-01-preview, 2024-06-01-preview, 2025-02-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native search [ApiVersion]. See the version guide for details.

    Using listQueryKeyBySearchService

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function listQueryKeyBySearchService(args: ListQueryKeyBySearchServiceArgs, opts?: InvokeOptions): Promise<ListQueryKeyBySearchServiceResult>
function listQueryKeyBySearchServiceOutput(args: ListQueryKeyBySearchServiceOutputArgs, opts?: InvokeOptions): Output<ListQueryKeyBySearchServiceResult>
    def list_query_key_by_search_service(resource_group_name: Optional[str] = None,
                                     search_service_name: Optional[str] = None,
                                     opts: Optional[InvokeOptions] = None) -> ListQueryKeyBySearchServiceResult
def list_query_key_by_search_service_output(resource_group_name: Optional[pulumi.Input[str]] = None,
                                     search_service_name: Optional[pulumi.Input[str]] = None,
                                     opts: Optional[InvokeOptions] = None) -> Output[ListQueryKeyBySearchServiceResult]
    func ListQueryKeyBySearchService(ctx *Context, args *ListQueryKeyBySearchServiceArgs, opts ...InvokeOption) (*ListQueryKeyBySearchServiceResult, error)
func ListQueryKeyBySearchServiceOutput(ctx *Context, args *ListQueryKeyBySearchServiceOutputArgs, opts ...InvokeOption) ListQueryKeyBySearchServiceResultOutput

    > Note: This function is named ListQueryKeyBySearchService in the Go SDK.

    public static class ListQueryKeyBySearchService 
{
    public static Task<ListQueryKeyBySearchServiceResult> InvokeAsync(ListQueryKeyBySearchServiceArgs args, InvokeOptions? opts = null)
    public static Output<ListQueryKeyBySearchServiceResult> Invoke(ListQueryKeyBySearchServiceInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<ListQueryKeyBySearchServiceResult> listQueryKeyBySearchService(ListQueryKeyBySearchServiceArgs args, InvokeOptions options)
public static Output<ListQueryKeyBySearchServiceResult> listQueryKeyBySearchService(ListQueryKeyBySearchServiceArgs args, InvokeOptions options)

    fn::invoke:
  function: azure-native:search:listQueryKeyBySearchService
  arguments:
    # arguments dictionary

    The following arguments are supported:

    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    SearchServiceName string
    The name of the Azure AI Search service associated with the specified resource group.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    SearchServiceName string
    The name of the Azure AI Search service associated with the specified resource group.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    searchServiceName String
    The name of the Azure AI Search service associated with the specified resource group.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    searchServiceName string
    The name of the Azure AI Search service associated with the specified resource group.
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    search_service_name str
    The name of the Azure AI Search service associated with the specified resource group.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    searchServiceName String
    The name of the Azure AI Search service associated with the specified resource group.

    listQueryKeyBySearchService Result

    The following output properties are available:

    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 List<Pulumi.AzureNative.Search.Outputs.QueryKeyResponse>
    The query keys for the Azure AI Search service.
    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 []QueryKeyResponse
    The query keys for the Azure AI Search service.
    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 List<QueryKeyResponse>
    The query keys for the Azure AI Search service.
    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 QueryKeyResponse[]
    The query keys for the Azure AI Search service.
    next_link str
    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 Sequence[QueryKeyResponse]
    The query keys for the Azure AI Search service.
    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 List<Property Map>
    The query keys for the Azure AI Search service.

    Supporting Types

    QueryKeyResponse

    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.
    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.
    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.
    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.
    key str
    The value of the query API key.
    name str
    The name of the query API key. Query names are optional, but assigning a name can help you remember how it's used.
    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.

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
    Viewing docs for Azure Native v3.16.0
    published on Friday, Mar 20, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-azure-native
      Try Pulumi Cloud free. Your team will thank you.