az search service

  • 參考

管理 Azure 搜尋服務。

命令

名稱 Description 類型 狀態
az search service create

在指定的資源群組中建立搜尋服務。 如果搜尋服務已經存在，所有屬性都會以指定的值更新。

 核心 GA
az search service delete

刪除指定資源群組中的搜尋服務及其相關聯的資源。

 核心 GA
az search service list

取得指定資源群組中所有 搜尋服務 的清單。

 核心 GA
az search service show

取得具有指定資源群組中指定名稱的搜尋服務。

 核心 GA
az search service update

更新指定資源群組中的搜尋服務。 如果搜尋服務已經存在，所有屬性都會以指定的值更新。

 核心 GA
az search service wait

將 CLI 置於等候狀態，直到符合條件為止。

 核心 GA

az search service create

編輯

在指定的資源群組中建立搜尋服務。 如果搜尋服務已經存在，所有屬性都會以指定的值更新。

az search service create --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}]
                         [--disable-local-auth {0, 1, f, false, n, no, t, true, y, yes}]
                         [--hosting-mode {default, highDensity}]
                         [--identity-type {None, SystemAssigned}]
                         [--ip-rules]
                         [--location]
                         [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                         [--partition-count]
                         [--public-access {disabled, enabled}]
                         [--replica-count]
                         [--semantic-search {disabled, free, standard}]
                         [--tags]

必要參數

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

要建立或更新之 Azure 認知搜尋 服務的名稱。 搜尋服務 名稱只能包含小寫字母、數位或破折號，不能使用虛線做為前兩個或最後一個字元、不能包含連續連字元，而且長度必須介於 2 到 60 個字元之間。 搜尋服務 名稱必須是全域唯一的，因為它們是服務 URI 的一部分（https://.search.windows.net). 建立服務之後，您無法變更服務名稱。

--resource-group -g

資源組名。 您可以使用 來設定預設群組 az configure --defaults group=<name>。

--sku

搜尋服務的 SKU。 有效值包括：「免費」：共享服務。 'basic'：最多 3 個複本的專用服務。 'standard'： 專用服務，最多可有 12 個分割區和 12 個復本。 'standard2'：類似於標準，但每個搜尋單位的容量較多。 'standard3'：最大標準供應專案，最多可有 12 個分割區和 12 個復本（如果您也將 hostingMode 屬性設定為 'highDensity'，則最多 3 個具有更多索引的數據分割）。 'storage_optimized_l1'：支援每個分割區 1TB，最多 12 個分割區。 'storage_optimized_l2'：支援每個分割區 2TB，最多 12 個分割區。'。

接受的值: basic, free, standard, standard2, standard3, storage_optimized_l1, storage_optimized_l2

選擇性參數

--aad-auth-failure-mode

描述 搜尋服務 的數據平面 API 會針對驗證失敗的要求傳送哪些回應。

接受的值: http401WithBearerChallenge, http403
--auth-options

一些說明。

接受的值: aadOrApiKey, apiKeyOnly
--disable-local-auth

當設定為 true 時，不允許對搜尋服務的呼叫利用 API 金鑰進行驗證。 如果已定義 『dataPlaneAuthOptions』，則無法設定為 true。

接受的值: 0, 1, f, false, n, no, t, true, y, yes
--hosting-mode

僅適用於 standard3 SKU。 您可以設定此屬性來啟用最多 3 個高密度分割區，允許最多 1000 個索引，這遠高於任何其他 SKU 允許的最大索引。 針對 standard3 SKU，此值為 'default' 或 'highDensity'。 對於所有其他 SKU，此值必須是 'default'。

接受的值: default, highDensity
預設值: default
--identity-type

識別類型。

接受的值: None, SystemAssigned
--ip-rules

一些說明。

--location -l

未指定資源所在的地理位置，將會使用資源群組的位置。

--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 之間。

預設值: 1
--public-access --public-network-access

此值可以設定為 「已啟用」，以避免現有客戶資源和範本發生重大變更。 如果設定為 『disabled』，則不允許透過公用介面的流量，而私人端點聯機會是獨佔存取方法。

接受的值: disabled, enabled
預設值: enabled
--replica-count

搜尋服務中的複本數目。 如果指定，它必須是標準 SKU 的 1 到 12 之間的值，或基本 SKU 的 1 到 3 之間。

預設值: 1
--semantic-search

設定控制語意搜尋可用性的選項。 此設定僅適用於特定位置的特定 Azure 認知搜尋 SKU。

接受的值: disabled, free, standard
--tags

資源標籤。 支援速記語法、json-file 和 yaml-file。 請嘗試 “？？” 以顯示更多。

全域參數
--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
預設值: json
--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或標識碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az search service delete

編輯

刪除指定資源群組中的搜尋服務及其相關聯的資源。

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

選擇性參數

--ids

一或多個資源識別碼 (以空格分隔)。 它應該是包含 「資源標識碼」自變數所有資訊的完整資源識別碼。 您應該提供 --ids 或其他「資源識別碼」自變數。

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

與指定資源群組相關聯的 Azure 認知搜尋 服務名稱。

--resource-group -g

資源組名。 您可以使用 來設定預設群組 az configure --defaults group=<name>。

--subscription

訂用帳戶的名稱或標識碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。

--yes -y

不提示確認。

預設值: False
全域參數
--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
預設值: json
--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或標識碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az search service list

編輯

取得指定資源群組中所有 搜尋服務 的清單。

az search service list --resource-group

必要參數

--resource-group -g

資源組名。 您可以使用 來設定預設群組 az configure --defaults group=<name>。

全域參數
--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
預設值: json
--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或標識碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az search service show

編輯

取得具有指定資源群組中指定名稱的搜尋服務。

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

選擇性參數

--ids

一或多個資源識別碼 (以空格分隔)。 它應該是包含 「資源標識碼」自變數所有資訊的完整資源識別碼。 您應該提供 --ids 或其他「資源識別碼」自變數。

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

與指定資源群組相關聯的 Azure 認知搜尋 服務名稱。

--resource-group -g

資源組名。 您可以使用 來設定預設群組 az configure --defaults group=<name>。

--subscription

訂用帳戶的名稱或標識碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。

全域參數
--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
預設值: json
--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或標識碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az search service update

編輯

更新指定資源群組中的搜尋服務。 如果搜尋服務已經存在，所有屬性都會以指定的值更新。

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

選擇性參數

--aad-auth-failure-mode

描述 搜尋服務 的數據平面 API 會針對驗證失敗的要求傳送哪些回應。

接受的值: http401WithBearerChallenge, http403
--add

藉由指定路徑和索引鍵值組，將物件加入物件清單。 範例：--add property.listProperty <key=value、string 或 JSON 字串>。

--auth-options

一些說明。

接受的值: aadOrApiKey, apiKeyOnly
--disable-local-auth

當設定為 true 時，不允許對搜尋服務的呼叫利用 API 金鑰進行驗證。 如果已定義 『dataPlaneAuthOptions』，則無法設定為 true。

接受的值: 0, 1, f, false, n, no, t, true, y, yes
--force-string

使用 'set' 或 'add' 時，請保留字串常值，而不是嘗試轉換成 JSON。

接受的值: 0, 1, f, false, n, no, t, true, y, yes
--identity-type

識別類型。

接受的值: None, SystemAssigned
--ids

一或多個資源識別碼 (以空格分隔)。 它應該是包含 「資源標識碼」自變數所有資訊的完整資源識別碼。 您應該提供 --ids 或其他「資源識別碼」自變數。

--ip-rules

一些說明。

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

與指定資源群組相關聯的 Azure 認知搜尋 服務名稱。

--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 之間。

--public-access --public-network-access

此值可以設定為 「已啟用」，以避免現有客戶資源和範本發生重大變更。 如果設定為 『disabled』，則不允許透過公用介面的流量，而私人端點聯機會是獨佔存取方法。

接受的值: disabled, enabled
--remove

從清單中移除屬性或專案。 範例：--remove property.list OR --remove 屬性ToRemove。

--replica-count

搜尋服務中的複本數目。 如果指定，它必須是標準 SKU 的 1 到 12 之間的值，或基本 SKU 的 1 到 3 之間。

--resource-group -g

資源組名。 您可以使用 來設定預設群組 az configure --defaults group=<name>。

--semantic-search

設定控制語意搜尋可用性的選項。 此設定僅適用於特定位置的特定 Azure 認知搜尋 SKU。

接受的值: disabled, free, standard
--set

指定要設定的屬性路徑和值，以更新物件。 範例：--set property1.property2=。

--subscription

訂用帳戶的名稱或標識碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。

--tags

資源標籤。 支援速記語法、json-file 和 yaml-file。 請嘗試 “？？” 以顯示更多。

全域參數
--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
預設值: json
--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或標識碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az search service wait

編輯

將 CLI 置於等候狀態，直到符合條件為止。

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

選擇性參數

--created

請等候在 'Succeeded' 使用 'provisioningState' 建立。

預設值: False
--custom

等到條件符合自定義 JMESPath 查詢為止。 例如 provisioningState！='InProgress'， instanceView.statuses[？code=='PowerState/running']。

--deleted

等到刪除為止。

預設值: False
--exists

等候資源存在。

預設值: False
--ids

一或多個資源識別碼 (以空格分隔)。 它應該是包含 「資源標識碼」自變數所有資訊的完整資源識別碼。 您應該提供 --ids 或其他「資源識別碼」自變數。

--interval

輪詢間隔以秒為單位。

預設值: 30
--name --search-service-name -n

與指定資源群組相關聯的 Azure 認知搜尋 服務名稱。

--resource-group -g

資源組名。 您可以使用 來設定預設群組 az configure --defaults group=<name>。

--subscription

訂用帳戶的名稱或標識碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。

--timeout

以秒為單位的等候上限。

預設值: 3600
--updated

等到 provisioningState 更新為 'Succeeded'。

預設值: False
全域參數
--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
預設值: json
--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或標識碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。