次の方法で共有

az search service

サービスを管理します。

コマンド

名前 説明 型 状態
az search service admin-key

管理キーを管理します。

 Core GA
az search service admin-key list

指定した Azure AI Search サービスのプライマリ管理者 API キーとセカンダリ管理者 API キーを取得します。

 Core GA
az search service admin-key regenerate

プライマリまたはセカンダリの管理者 API キーを再生成します。 一度に再生成できるキーは 1 つだけです。

 Core GA
az search service check-name-availability

指定された検索サービス名が使用できるかどうかをチェックします。 検索サービス名はサービス URI (https://<name>.search.windows.net) の一部であるため、グローバルに一意である必要があります。

 Core GA
az search service create

指定されたリソース グループ内の検索サービスを作成または更新します。 検索サービスが既に存在する場合は、すべてのプロパティが指定された値で更新されます。

 Core GA
az search service delete

特定のリソース グループ内の検索サービスとそれに関連付けられているリソースを削除します。

 Core GA
az search service list

指定されたリソース グループ内のすべての Search サービスの一覧を取得します。

 Core GA
az search service network-security-perimeter-configuration

ネットワーク セキュリティ境界の構成を管理します。

 Core GA
az search service network-security-perimeter-configuration list

検索サービスのネットワーク セキュリティ境界構成の一覧を一覧表示します。

 Core GA
az search service network-security-perimeter-configuration reconcile

Azure AI Search リソース プロバイダーのネットワーク セキュリティ境界構成を調整します。 これにより、検索サービスが最新の構成を確実に保持することで、ネットワーク セキュリティ境界構成との手動再同期がトリガーされます。

 Core GA
az search service network-security-perimeter-configuration show

ネットワーク セキュリティ境界構成を取得します。

 Core GA
az search service private-endpoint-connection

プライベート エンドポイント接続を管理します。

 Core GA
az search service private-endpoint-connection delete

プライベート エンドポイント接続を削除し、検索サービスから削除します。

 Core GA
az search service private-endpoint-connection list

特定のサービス内のすべてのプライベート エンドポイント接続の一覧を一覧表示します。

 Core GA
az search service private-endpoint-connection show

特定のリソース グループ内の検索サービスへのプライベート エンドポイント接続の詳細を取得します。

 Core GA
az search service private-endpoint-connection update

特定のリソース グループ内の検索サービスへのプライベート エンドポイント接続を更新します。

 Core GA
az search service private-link-resource

Private Link リソースを管理します。

 Core GA
az search service private-link-resource list

特定のサービスでサポートされているすべてのプライベート リンク リソースの種類の一覧を一覧表示します。

 Core GA
az search service query-key

クエリ キーの作成を管理します。

 Core GA
az search service query-key create

指定した検索サービスの新しいクエリ キーを作成します。 サービスごとに最大 50 個のクエリキーを作成できます。

 Core GA
az search service query-key delete

指定したクエリ キーを削除します。 管理キーとは異なり、クエリ キーは再生成されません。 クエリ キーを再生成するプロセスは、削除してから再作成することです。

 Core GA
az search service query-key list

特定の Azure AI Search サービスのクエリ API キーの一覧を返します。

 Core GA
az search service shared-private-link-resource

共有プライベート リンク リソースを管理します。

 Core GA
az search service shared-private-link-resource create

特定のリソース グループ内の検索サービスによって管理される共有プライベート リンク リソースの作成または更新を作成します。

 Core GA
az search service shared-private-link-resource delete

共有プライベート リンク リソースの削除を検索サービスから削除します。

 Core GA
az search service shared-private-link-resource list

特定のサービスによって管理されているすべての共有プライベート リンク リソースの一覧を一覧表示します。

 Core GA
az search service shared-private-link-resource show

特定のリソース グループ内の検索サービスによって管理されている共有プライベート リンク リソースの詳細を取得します。

 Core GA
az search service shared-private-link-resource update

特定のリソース グループ内の検索サービスによって管理される共有プライベート リンク リソースの作成または更新を更新します。

 Core GA
az search service shared-private-link-resource wait

条件が満たされるまで CLI を待機状態にします。

 Core GA
az search service show

指定されたリソース グループ内の指定された名前を持つ検索サービスを取得します。

 Core GA
az search service update

特定のリソース グループ内の既存の検索サービスを更新します。

 Core GA
az search service upgrade

Azure AI Search サービスを利用可能な最新バージョンにアップグレードします。

 Core GA
az search service wait

条件が満たされるまで CLI を待機状態にします。

 Core GA

az search service check-name-availability

編集

指定された検索サービス名が使用できるかどうかをチェックします。 検索サービス名はサービス URI (https://<name>.search.windows.net) の一部であるため、グローバルに一意である必要があります。

az search service check-name-availability --name
                                          --type {searchServices}

必須のパラメーター

--name

検証する検索サービス名。 検索サービス名には、小文字、数字、またはダッシュのみを含める必要があり、最初の 2 文字または最後の 1 文字としてダッシュを使用することはできません。連続するダッシュを含めることはできません。また、長さは 2 ~ 60 文字にする必要があります。

プロパティ 値
パラメーター グループ: CheckNameAvailabilityInput Arguments
--type

名前が検証されるリソースの種類。 この値は常に 'searchServices' である必要があります。

プロパティ 値
パラメーター グループ: CheckNameAvailabilityInput Arguments
指定可能な値: searchServices
グローバル パラメーター
--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ 値
規定値: False
--help -h

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

--only-show-errors

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

プロパティ 値
規定値: False
--output -o

出力フォーマット。

プロパティ 値
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ 値
規定値: False

az search service create

編集

指定されたリソース グループ内の検索サービスを作成または更新します。 検索サービスが既に存在する場合は、すべてのプロパティが指定された値で更新されます。

az search service create --name --search-service-name
                         --resource-group
                         --sku {basic, free, standard, standard2, standard3, storage_optimized_l1, storage_optimized_l2}
                         [--aad-auth-failure-mode {http401WithBearerChallenge, http403}]
                         [--auth-options {aadOrApiKey, apiKeyOnly}]
                         [--bypass {AzureServices, None}]
                         [--compute-type {confidential, default}]
                         [--data--protections --data-exfiltration-protections]
                         [--disable-local-auth {0, 1, f, false, n, no, t, true, y, yes}]
                         [--encryption-with-cmk]
                         [--hosting-mode {default, highDensity}]
                         [--identity-type {None, SystemAssigned, SystemAssigned, UserAssigned, UserAssigned}]
                         [--ip-rules]
                         [--location]
                         [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                         [--partition-count]
                         [--public-access --public-network-access {disabled, enabled, securedByPerimeter}]
                         [--replica-count]
                         [--semantic-search {disabled, free, standard}]
                         [--tags]

必須のパラメーター

--name --search-service-name -n

作成または更新する Azure AI Search サービスの名前。 検索サービス名には、小文字、数字、またはダッシュのみを含める必要があり、最初の 2 文字または最後の 1 文字としてダッシュを使用することはできません。連続するダッシュを含めることはできません。また、長さは 2 ~ 60 文字にする必要があります。 検索サービス名はサービス URI (https://<name>.search.windows.net) の一部であるため、一意である必要があります。 サービスの作成後にサービス名を変更することはできません。

--resource-group -g

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

--sku

検索サービスの SKU。 有効な値には、'free': 共有サービスが含まれます。 "basic": 最大 3 つのレプリカを含む専用サービス。 'standard': 最大 12 個のパーティションと 12 個のレプリカを持つ専用サービス。 'standard2': 標準に似ていますが、検索ユニットあたりの容量が多くなります。 'standard3': 最大 12 個のパーティションと 12 個のレプリカを備えた最大の Standard オファリング (hostingMode プロパティも 'highDensity' に設定した場合は、インデックスが多い最大 3 つのパーティション)。 'storage_optimized_l1': パーティションあたり 1 TB、最大 12 個のパーティションをサポートします。 'storage_optimized_l2': パーティションあたり 2 TB、最大 12 個のパーティションをサポートしています。'

プロパティ 値
パラメーター グループ: Service Arguments
指定可能な値: basic, free, standard, standard2, standard3, storage_optimized_l1, storage_optimized_l2

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--aad-auth-failure-mode

認証に失敗した要求に対して Search サービスのデータ プレーン API が送信する応答について説明します。

プロパティ 値
パラメーター グループ: AuthOptions Arguments
指定可能な値: http401WithBearerChallenge, http403
--auth-options

いくつかのヘルプ。

プロパティ 値
パラメーター グループ: Properties Arguments
指定可能な値: aadOrApiKey, apiKeyOnly
--bypass

"ipRules" セクションで定義されている規則をバイパスできる受信トラフィックの発生元として考えられます。

プロパティ 値
パラメーター グループ: NetworkRuleSet Arguments
指定可能な値: AzureServices, None
--compute-type

既定のコンピューティングまたは Azure Confidential Compute を使用して検索サービスをサポートするように、このプロパティを構成します。

プロパティ 値
パラメーター グループ: Properties Arguments
指定可能な値: confidential, default
--data--protections --data-exfiltration-protections

検索サービスに対して明示的に許可されていないデータ流出シナリオの一覧。 現在、サポートされる唯一の値は、将来計画されるより細かい制御を使用して、すべての可能なデータ エクスポート シナリオを無効にする 'All' です。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

プロパティ 値
パラメーター グループ: Properties Arguments
--disable-local-auth

true に設定すると、検索サービスの呼び出しで認証に API キーを使用することはできません。 'dataPlaneAuthOptions' が定義されている場合、これを true に設定することはできません。

プロパティ 値
パラメーター グループ: Properties Arguments
指定可能な値: 0, 1, f, false, n, no, t, true, y, yes
--encryption-with-cmk

検索サービス内でカスタマー マネージャー キーを使用するリソース (インデックスなど) の暗号化に関するポリシーを指定します。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

プロパティ 値
パラメーター グループ: Properties Arguments
--hosting-mode

Standard3 SKU にのみ適用されます。 このプロパティを設定すると、最大 3 つの高密度パーティションを有効にして、最大 1,000 個のインデックスを使用できます。これは、他の SKU で許可されている最大インデックスよりもはるかに大きくなります。 standard3 SKU の場合、値は 'default' または 'highDensity' です。 他のすべての SKU の場合、この値は 'default' である必要があります。

プロパティ 値
パラメーター グループ: Properties Arguments
規定値: default
指定可能な値: default, highDensity
--identity-type

ID の種類。

プロパティ 値
パラメーター グループ: Identity Arguments
指定可能な値: None, SystemAssigned, SystemAssigned, UserAssigned, UserAssigned
--ip-rules

検索サービス エンドポイントへのアクセスを許可する受信ネットワークを定義する IP の一覧。

プロパティ 値
パラメーター グループ: NetworkRuleSet Arguments
--location -l

リソースが存在する地理的な場所 を指定しない場合は、リソース グループの場所が使用されます。

プロパティ 値
パラメーター グループ: Service Arguments
--no-wait

実行時間の長い操作が完了するまで待つ必要はありません。

プロパティ 値
指定可能な値: 0, 1, f, false, n, no, t, true, y, yes
--partition-count

検索サービス内のパーティションの数。指定する場合は、1、2、3、4、6、または 12 にすることができます。 1 より大きい値は、標準 SKU でのみ有効です。 hostingMode が 'highDensity' に設定されている 'standard3' サービスの場合、許可される値は 1 から 3 の間です。

プロパティ 値
パラメーター グループ: Properties Arguments
規定値: 1
--public-access --public-network-access

この値を "有効" に設定すると、既存の顧客リソースとテンプレートの重大な変更を回避できます。 "無効" に設定すると、パブリック インターフェイス経由のトラフィックは許可されず、プライベート エンドポイント接続は排他アクセス方式になります。

プロパティ 値
パラメーター グループ: Properties Arguments
規定値: enabled
指定可能な値: disabled, enabled, securedByPerimeter
--replica-count

検索サービス内のレプリカの数。 指定する場合は、標準 SKU の場合は 1 から 12 までの値、Basic SKU の場合は 1 ~ 3 の値にする必要があります。

プロパティ 値
パラメーター グループ: Properties Arguments
規定値: 1
--semantic-search

セマンティック検索の可用性を制御するオプションを設定します。 この構成は、特定の場所にある特定の Azure AI Search SKU に対してのみ可能です。

プロパティ 値
パラメーター グループ: Properties Arguments
指定可能な値: disabled, free, standard
--tags

リソース タグ。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

プロパティ 値
パラメーター グループ: Service Arguments
グローバル パラメーター
--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ 値
規定値: False
--help -h

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

--only-show-errors

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

プロパティ 値
規定値: False
--output -o

出力フォーマット。

プロパティ 値
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ 値
規定値: False

az search service delete

編集

特定のリソース グループ内の検索サービスとそれに関連付けられているリソースを削除します。

az search service delete [--ids]
                         [--name --search-service-name]
                         [--resource-group]
                         [--subscription]
                         [--yes]

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--ids

1 つ以上のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

プロパティ 値
パラメーター グループ: Resource Id Arguments
--name --search-service-name -n

指定したリソース グループに関連付けられている Azure AI Search サービスの名前。

プロパティ 値
パラメーター グループ: Resource Id Arguments
--resource-group -g

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

プロパティ 値
パラメーター グループ: Resource Id Arguments
--subscription

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

プロパティ 値
パラメーター グループ: Resource Id Arguments
--yes -y

確認を求めないでください。

プロパティ 値
規定値: False
グローバル パラメーター
--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ 値
規定値: False
--help -h

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

--only-show-errors

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

プロパティ 値
規定値: False
--output -o

出力フォーマット。

プロパティ 値
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ 値
規定値: False

az search service list

編集

指定されたリソース グループ内のすべての Search サービスの一覧を取得します。

az search service list --resource-group

必須のパラメーター

--resource-group -g

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

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

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ 値
規定値: False
--help -h

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

--only-show-errors

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

プロパティ 値
規定値: False
--output -o

出力フォーマット。

プロパティ 値
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ 値
規定値: False

az search service show

編集

指定されたリソース グループ内の指定された名前を持つ検索サービスを取得します。

az search service show [--ids]
                       [--name --search-service-name]
                       [--resource-group]
                       [--subscription]

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--ids

1 つ以上のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

プロパティ 値
パラメーター グループ: Resource Id Arguments
--name --search-service-name -n

指定したリソース グループに関連付けられている Azure AI Search サービスの名前。

プロパティ 値
パラメーター グループ: Resource Id Arguments
--resource-group -g

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

プロパティ 値
パラメーター グループ: Resource Id Arguments
--subscription

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

プロパティ 値
パラメーター グループ: Resource Id Arguments
グローバル パラメーター
--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ 値
規定値: False
--help -h

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

--only-show-errors

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

プロパティ 値
規定値: False
--output -o

出力フォーマット。

プロパティ 値
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ 値
規定値: False

az search service update

編集

特定のリソース グループ内の既存の検索サービスを更新します。

az search service update [--aad-auth-failure-mode {http401WithBearerChallenge, http403}]
                         [--add]
                         [--auth-options {aadOrApiKey, apiKeyOnly}]
                         [--data--protections --data-exfiltration-protections]
                         [--disable-local-auth {0, 1, f, false, n, no, t, true, y, yes}]
                         [--encryption-with-cmk]
                         [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                         [--identity-type {None, SystemAssigned}]
                         [--ids]
                         [--ip-rules]
                         [--name --search-service-name]
                         [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                         [--partition-count]
                         [--public-access --public-network-access {disabled, enabled}]
                         [--remove]
                         [--replica-count]
                         [--resource-group]
                         [--semantic-search {disabled, free, standard}]
                         [--set]
                         [--sku {basic, free, standard, standard2, standard3, storage_optimized_l1, storage_optimized_l2}]
                         [--subscription]
                         [--tags]

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--aad-auth-failure-mode

認証に失敗した要求に対して Search サービスのデータ プレーン API が送信する応答について説明します。

プロパティ 値
パラメーター グループ: AuthOptions Arguments
指定可能な値: http401WithBearerChallenge, http403
--add

パスとキー値のペアを指定して、オブジェクトの一覧にオブジェクトを追加します。 例: --add property.listProperty <key=value, string or JSON string>。

プロパティ 値
パラメーター グループ: Generic Update Arguments
--auth-options

いくつかのヘルプ。

プロパティ 値
パラメーター グループ: Properties Arguments
指定可能な値: aadOrApiKey, apiKeyOnly
--data--protections --data-exfiltration-protections

検索サービスに対して明示的に許可されていないデータ流出シナリオの一覧。 現在、サポートされる唯一の値は、将来計画されるより細かい制御を使用して、すべての可能なデータ エクスポート シナリオを無効にする 'All' です。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

プロパティ 値
パラメーター グループ: Properties Arguments
--disable-local-auth

true に設定すると、検索サービスの呼び出しで認証に API キーを使用することはできません。 'dataPlaneAuthOptions' が定義されている場合、これを true に設定することはできません。

プロパティ 値
パラメーター グループ: Properties Arguments
指定可能な値: 0, 1, f, false, n, no, t, true, y, yes
--encryption-with-cmk

検索サービス内でカスタマー マネージャー キーを使用するリソース (インデックスなど) の暗号化に関するポリシーを指定します。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

プロパティ 値
パラメーター グループ: Properties Arguments
--force-string

'set' または 'add' を使用する場合は、JSON に変換するのではなく、文字列リテラルを保持します。

プロパティ 値
パラメーター グループ: Generic Update Arguments
指定可能な値: 0, 1, f, false, n, no, t, true, y, yes
--identity-type

ID の種類。

プロパティ 値
パラメーター グループ: Identity Arguments
指定可能な値: None, SystemAssigned
--ids

1 つ以上のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

プロパティ 値
パラメーター グループ: Resource Id Arguments
--ip-rules

検索サービス エンドポイントへのアクセスを許可する受信ネットワークを定義する IP の一覧。

プロパティ 値
パラメーター グループ: NetworkRuleSet Arguments
--name --search-service-name -n

更新する Azure AI Search サービスの名前。

プロパティ 値
パラメーター グループ: Resource Id Arguments
--no-wait

実行時間の長い操作が完了するまで待つ必要はありません。

プロパティ 値
指定可能な値: 0, 1, f, false, n, no, t, true, y, yes
--partition-count

検索サービス内のパーティションの数。指定する場合は、1、2、3、4、6、または 12 にすることができます。 1 より大きい値は、標準 SKU でのみ有効です。 hostingMode が 'highDensity' に設定されている 'standard3' サービスの場合、許可される値は 1 から 3 の間です。

プロパティ 値
パラメーター グループ: Properties Arguments
--public-access --public-network-access

この値を "有効" に設定すると、既存の顧客リソースとテンプレートの重大な変更を回避できます。 "無効" に設定すると、パブリック インターフェイス経由のトラフィックは許可されず、プライベート エンドポイント接続は排他アクセス方式になります。

プロパティ 値
パラメーター グループ: Properties Arguments
指定可能な値: disabled, enabled
--remove

リストからプロパティまたは要素を削除します。 例: --remove property.list <indexToRemove> OR --remove propertyToRemove。

プロパティ 値
パラメーター グループ: Generic Update Arguments
--replica-count

検索サービス内のレプリカの数。 指定する場合は、標準 SKU の場合は 1 から 12 までの値、Basic SKU の場合は 1 ~ 3 の値にする必要があります。

プロパティ 値
パラメーター グループ: Properties Arguments
--resource-group -g

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

プロパティ 値
パラメーター グループ: Resource Id Arguments
--semantic-search

セマンティック検索の可用性を制御するオプションを設定します。 この構成は、特定の場所にある特定の Azure Cognitive Search SKU に対してのみ可能です。

プロパティ 値
パラメーター グループ: Properties Arguments
指定可能な値: disabled, free, standard
--set

設定するプロパティ パスと値を指定して、オブジェクトを更新します。 例: --set property1.property2=<value>。

プロパティ 値
パラメーター グループ: Generic Update Arguments
--sku

検索サービスの SKU。 有効な値には、'free': 共有サービスが含まれます。 "basic": 最大 3 つのレプリカを含む専用サービス。 'standard': 最大 12 個のパーティションと 12 個のレプリカを持つ専用サービス。 'standard2': 標準に似ていますが、検索ユニットあたりの容量が多くなります。 'standard3': 最大 12 個のパーティションと 12 個のレプリカを備えた最大の Standard オファリング (hostingMode プロパティも 'highDensity' に設定した場合は、インデックスが多い最大 3 つのパーティション)。 'storage_optimized_l1': パーティションあたり 1 TB、最大 12 個のパーティションをサポートします。 'storage_optimized_l2': パーティションあたり 2 TB、最大 12 個のパーティションをサポートしています。'

プロパティ 値
パラメーター グループ: Service Arguments
指定可能な値: basic, free, standard, standard2, standard3, storage_optimized_l1, storage_optimized_l2
--subscription

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

プロパティ 値
パラメーター グループ: Resource Id Arguments
--tags

リソース タグ。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

プロパティ 値
パラメーター グループ: Service Arguments
グローバル パラメーター
--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ 値
規定値: False
--help -h

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

--only-show-errors

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

プロパティ 値
規定値: False
--output -o

出力フォーマット。

プロパティ 値
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ 値
規定値: False

az search service upgrade

編集

Azure AI Search サービスを利用可能な最新バージョンにアップグレードします。

az search service upgrade [--ids]
                          [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                          [--resource-group]
                          [--search-service-name]
                          [--subscription]

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--ids

1 つ以上のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

プロパティ 値
パラメーター グループ: Resource Id Arguments
--no-wait

実行時間の長い操作が完了するまで待つ必要はありません。

プロパティ 値
指定可能な値: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

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

プロパティ 値
パラメーター グループ: Resource Id Arguments
--search-service-name

指定したリソース グループに関連付けられている Azure AI Search サービスの名前。

プロパティ 値
パラメーター グループ: Resource Id Arguments
--subscription

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

プロパティ 値
パラメーター グループ: Resource Id Arguments
グローバル パラメーター
--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ 値
規定値: False
--help -h

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

--only-show-errors

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

プロパティ 値
規定値: False
--output -o

出力フォーマット。

プロパティ 値
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ 値
規定値: False

az search service wait

編集

条件が満たされるまで CLI を待機状態にします。

az search service wait [--created]
                       [--custom]
                       [--deleted]
                       [--exists]
                       [--ids]
                       [--interval]
                       [--name --search-service-name]
                       [--resource-group]
                       [--subscription]
                       [--timeout]
                       [--updated]

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--created

'provisioningState' が 'Succeeded' で作成されるまで待ちます。

プロパティ 値
パラメーター グループ: Wait Condition Arguments
規定値: False
--custom

条件がカスタム JMESPath クエリを満たすまで待ちます。 例: provisioningState!='InProgress'、instanceView.statuses[?code=='PowerState/running']。

プロパティ 値
パラメーター グループ: Wait Condition Arguments
--deleted

削除されるまで待ちます。

プロパティ 値
パラメーター グループ: Wait Condition Arguments
規定値: False
--exists

リソースが存在するまで待ちます。

プロパティ 値
パラメーター グループ: Wait Condition Arguments
規定値: False
--ids

1 つ以上のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

プロパティ 値
パラメーター グループ: Resource Id Arguments
--interval

ポーリング間隔 (秒単位)。

プロパティ 値
パラメーター グループ: Wait Condition Arguments
規定値: 30
--name --search-service-name -n

指定したリソース グループに関連付けられている Azure AI Search サービスの名前。

プロパティ 値
パラメーター グループ: Resource Id Arguments
--resource-group -g

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

プロパティ 値
パラメーター グループ: Resource Id Arguments
--subscription

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

プロパティ 値
パラメーター グループ: Resource Id Arguments
--timeout

最大待機時間 (秒単位)。

プロパティ 値
パラメーター グループ: Wait Condition Arguments
規定値: 3600
--updated

provisioningState が 'Succeeded' で更新されるまで待ちます。

プロパティ 値
パラメーター グループ: Wait Condition Arguments
規定値: False
グローバル パラメーター
--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ 値
規定値: False
--help -h

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

--only-show-errors

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

プロパティ 値
規定値: False
--output -o

出力フォーマット。

プロパティ 値
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ 値
規定値: False