az search admin-key

Manage Azure Search admin keys.

Commands

az search admin-key renew

Regenerates either the primary or secondary admin API key.

az search admin-key show

Gets the primary and secondary admin API keys for the specified Azure Search service.

az search admin-key renew

Regenerates either the primary or secondary admin API key.

You can only regenerate one key at a time.

az search admin-key renew --key-kind
                          --resource-group
                          --service-name
                          [--subscription]

Required Parameters

--key-kind

The type (primary or secondary) of the admin key.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--service-name

The name of the search service.

Optional Parameters

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

az search admin-key show

Gets the primary and secondary admin API keys for the specified Azure Search service.

az search admin-key show --resource-group
                         --service-name
                         [--query-examples]
                         [--subscription]

Required Parameters

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--service-name

The name of the search service.

Optional Parameters

--query-examples

Recommend JMESPath string for you. You can copy one of the query and paste it after --query parameter within double quotation marks to see the results. You can add one or more positional keywords so that we can give suggestions based on these key words.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.