你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

az search service

参考

管理 Azure 搜索服务。

命令

名称	说明	类型	状态
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。有效值包括：“free”：共享服务。 “basic”：最多包含 3 个副本 (replica)的专用服务。 “standard”：专用服务，最多包含 12 个分区和 12 个副本 (replica)。 “standard2”：类似于标准，但每个搜索单位的容量更多。 “standard3”：最大标准产品/服务最多包含 12 个分区和 12 个副本 (replica)（如果还将 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

搜索服务中的副本 (replica)数。如果指定，它必须是标准 SKU 的 1 到 12（含 1 到 3）之间的值，对于基本 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

订阅的名称或 ID。可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。使用 --debug 获取完整的调试日志。

az search service delete

编辑

删除给定资源组中的搜索服务及其关联的资源。

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

可选参数

--ids

一个或多个资源 ID（以空格分隔）。它应该是包含“资源 ID”参数的所有信息的完整资源 ID。应提供 --id 或其他“资源 ID”参数。

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

与指定资源组关联的Azure 认知搜索服务的名称。

--resource-group -g

资源组的名称。可以使用 az configure --defaults group=<name> 配置默认组。

--subscription

订阅的名称或 ID。可以使用 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

订阅的名称或 ID。可以使用 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

订阅的名称或 ID。可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。使用 --debug 获取完整的调试日志。

az search service show

编辑

获取具有给定资源组中给定名称的搜索服务。

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

可选参数

--ids

一个或多个资源 ID（以空格分隔）。它应该是包含“资源 ID”参数的所有信息的完整资源 ID。应提供 --id 或其他“资源 ID”参数。

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

与指定资源组关联的Azure 认知搜索服务的名称。

--resource-group -g

资源组的名称。可以使用 az configure --defaults group=<name> 配置默认组。

--subscription

订阅的名称或 ID。可以使用 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

订阅的名称或 ID。可以使用 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

一个或多个资源 ID（以空格分隔）。它应该是包含“资源 ID”参数的所有信息的完整资源 ID。应提供 --id 或其他“资源 ID”参数。

--ip-rules

一些帮助。

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

与指定资源组关联的Azure 认知搜索服务的名称。

--no-wait

不等待长时间运行的操作完成。

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

--partition-count

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

接受的值: disabled, enabled

--remove

从列表中删除属性或元素。示例：--remove property.list OR --remove propertyToRemove。

--replica-count

搜索服务中的副本 (replica)数。如果指定，它必须是标准 SKU 的 1 到 12（含 1 到 3）之间的值，对于基本 SKU，该值必须介于 1 和 3 之间。

--resource-group -g

资源组的名称。可以使用 az configure --defaults group=<name> 配置默认组。

--semantic-search

设置控制语义搜索可用性的选项。此配置仅适用于特定位置的某些Azure 认知搜索 SKU。

接受的值: disabled, free, standard

--set

通过指定要设置的属性路径和值来更新对象。示例：--set property1.property2=。

--subscription

订阅的名称或 ID。可以使用 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

订阅的名称或 ID。可以使用 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

一个或多个资源 ID（以空格分隔）。它应该是包含“资源 ID”参数的所有信息的完整资源 ID。应提供 --id 或其他“资源 ID”参数。

--interval

轮询间隔（以秒为单位）。

默认值: 30

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

与指定资源组关联的Azure 认知搜索服务的名称。

--resource-group -g

资源组的名称。可以使用 az configure --defaults group=<name> 配置默认组。

--subscription

订阅的名称或 ID。可以使用 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

订阅的名称或 ID。可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。使用 --debug 获取完整的调试日志。

通过

az search service

命令

az search service create

必需参数

可选参数

az search service delete

可选参数

az search service list

必需参数

az search service show

可选参数

az search service update

可选参数

az search service wait

可选参数

其他资源