Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  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.
Azure Native v3.0.1 published on Monday, Apr 7, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.search.listQueryKeyBySearchService

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.0.1 published on Monday, Apr 7, 2025 by Pulumi
pulumi/pulumi-azure-native

Returns the list of query API keys for the given search service.

Uses Azure REST API version 2023-11-01.

Other available API versions: 2022-09-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>
Copy
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]
Copy
func ListQueryKeyBySearchService(ctx *Context, args *ListQueryKeyBySearchServiceArgs, opts ...InvokeOption) (*ListQueryKeyBySearchServiceResult, error)
func ListQueryKeyBySearchServiceOutput(ctx *Context, args *ListQueryKeyBySearchServiceOutputArgs, opts ...InvokeOption) ListQueryKeyBySearchServiceResultOutput
Copy

> 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)
}
Copy
public static CompletableFuture<ListQueryKeyBySearchServiceResult> listQueryKeyBySearchService(ListQueryKeyBySearchServiceArgs args, InvokeOptions options)
public static Output<ListQueryKeyBySearchServiceResult> listQueryKeyBySearchService(ListQueryKeyBySearchServiceArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:search:listQueryKeyBySearchService
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
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
This property is required.
Changes to this property will trigger replacement.
string
The name of the search service associated with the specified resource group.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
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
This property is required.
Changes to this property will trigger replacement.
string
The name of the search service associated with the specified resource group.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
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
This property is required.
Changes to this property will trigger replacement.
String
The name of the search service associated with the specified resource group.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
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
This property is required.
Changes to this property will trigger replacement.
string
The name of the search service associated with the specified resource group.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal.
search_service_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the search service associated with the specified resource group.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
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
This property is required.
Changes to this property will trigger replacement.
String
The name of the 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 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 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 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 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 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 search service.

Supporting Types

QueryKeyResponse

Key This property is required. string
The value of the query API key.
Name This property is required. string
The name of the query API key; may be empty.
Key This property is required. string
The value of the query API key.
Name This property is required. string
The name of the query API key; may be empty.
key This property is required. String
The value of the query API key.
name This property is required. String
The name of the query API key; may be empty.
key This property is required. string
The value of the query API key.
name This property is required. string
The name of the query API key; may be empty.
key This property is required. str
The value of the query API key.
name This property is required. str
The name of the query API key; may be empty.
key This property is required. String
The value of the query API key.
name This property is required. String
The name of the query API key; may be empty.

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.0.1 published on Monday, Apr 7, 2025 by Pulumi
pulumi/pulumi-azure-native