az search query-key

Azure Search クエリ キーを管理します。

コマンド

名前 説明 Status
az search query-key create

指定した検索サービスの新しいクエリ キーを生成します。

コア GA
az search query-key delete

指定したクエリ キーを削除します。

コア GA
az search query-key list

指定された Azure Cognitive Search サービスのクエリ API キーの一覧を返します。

コア GA

az search query-key create

指定した検索サービスの新しいクエリ キーを生成します。

サービスごとに最大で 50 個のクエリ キーを作成できます。

az search query-key create --name
                           --resource-group
                           --service-name

必須のパラメーター

--name -n

クエリ キーの名前。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

--service-name

検索サービスの名前。

グローバル パラメーター
--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc
既定値: json
--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az search query-key delete

指定したクエリ キーを削除します。

管理者キーとは異なり、クエリ キーは再生成されません。 クエリ キーを再生成するには、キーを削除して再作成します。

az search query-key delete --key-value
                           --resource-group
                           --service-name

必須のパラメーター

--key-value

クエリ キーの値。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

--service-name

検索サービスの名前。

グローバル パラメーター
--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc
既定値: json
--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az search query-key list

指定された Azure Cognitive Search サービスのクエリ API キーの一覧を返します。

az search query-key list --resource-group
                         --service-name

必須のパラメーター

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

--service-name

検索サービスの名前。

グローバル パラメーター
--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc
既定値: json
--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。