Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. search
  5. listAdminKey
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native-v2.search.listAdminKey

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

Gets the primary and secondary admin API keys for the specified Azure Cognitive Search service. Azure REST API version: 2022-09-01.

Other available API versions: 2021-04-01-preview, 2023-11-01, 2024-03-01-preview, 2024-06-01-preview.

Using listAdminKey

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 listAdminKey(args: ListAdminKeyArgs, opts?: InvokeOptions): Promise<ListAdminKeyResult>
function listAdminKeyOutput(args: ListAdminKeyOutputArgs, opts?: InvokeOptions): Output<ListAdminKeyResult>
Copy
def list_admin_key(resource_group_name: Optional[str] = None,
                   search_service_name: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> ListAdminKeyResult
def list_admin_key_output(resource_group_name: Optional[pulumi.Input[str]] = None,
                   search_service_name: Optional[pulumi.Input[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[ListAdminKeyResult]
Copy
func ListAdminKey(ctx *Context, args *ListAdminKeyArgs, opts ...InvokeOption) (*ListAdminKeyResult, error)
func ListAdminKeyOutput(ctx *Context, args *ListAdminKeyOutputArgs, opts ...InvokeOption) ListAdminKeyResultOutput
Copy

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

public static class ListAdminKey 
{
    public static Task<ListAdminKeyResult> InvokeAsync(ListAdminKeyArgs args, InvokeOptions? opts = null)
    public static Output<ListAdminKeyResult> Invoke(ListAdminKeyInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<ListAdminKeyResult> listAdminKey(ListAdminKeyArgs args, InvokeOptions options)
public static Output<ListAdminKeyResult> listAdminKey(ListAdminKeyArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:search:listAdminKey
  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 Azure Cognitive 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 Azure Cognitive 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 Azure Cognitive 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 Azure Cognitive 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 Azure Cognitive 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 Azure Cognitive Search service associated with the specified resource group.

listAdminKey Result

The following output properties are available:

PrimaryKey string
The primary admin API key of the search service.
SecondaryKey string
The secondary admin API key of the search service.
PrimaryKey string
The primary admin API key of the search service.
SecondaryKey string
The secondary admin API key of the search service.
primaryKey String
The primary admin API key of the search service.
secondaryKey String
The secondary admin API key of the search service.
primaryKey string
The primary admin API key of the search service.
secondaryKey string
The secondary admin API key of the search service.
primary_key str
The primary admin API key of the search service.
secondary_key str
The secondary admin API key of the search service.
primaryKey String
The primary admin API key of the search service.
secondaryKey String
The secondary admin API key of the search service.

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native