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

az search service shared-private-link-resource

管理共享专用链接资源。

命令

名称	说明	类型	Status
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 shared-private-link-resource create

编辑

创建或更新由给定资源组中的搜索服务管理的共享专用链接资源。

az search service shared-private-link-resource create --name --shared-private-link-resource-name
                                                      --resource-group
                                                      --search-service-name
                                                      [--group-id]
                                                      [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                      [--private-link-resource-id --resource-id]
                                                      [--provisioning-state {Deleting, Failed, Incomplete, Succeeded, Updating}]
                                                      [--request-message]
                                                      [--resource-region]
                                                      [--status {Approved, Disconnected, Pending, Rejected}]

必需参数

--name --shared-private-link-resource-name -n

指定资源组中由 Azure AI 搜索服务管理的共享专用链接资源的名称。

--resource-group -g

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

--search-service-name

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

可选参数

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--group-id

共享专用链接资源的提供程序中的组 ID。

属性	值
Parameter group:	Properties Arguments

--no-wait

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

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

--private-link-resource-id --resource-id

共享专用链接资源的资源的资源 ID。

属性	值
Parameter group:	Properties Arguments

--provisioning-state

共享专用链接资源的预配状态。有效值为更新、删除、失败、成功或不完整。

属性	值
Parameter group:	Properties Arguments
接受的值:	Deleting, Failed, Incomplete, Succeeded, Updating

--request-message

请求批准共享专用链接资源的消息。

属性	值
Parameter group:	Properties Arguments

--resource-region

可选。可用于指定要为其创建共享专用链接的资源的 Azure 资源管理器位置。只有 DNS 配置是区域（例如 Azure Kubernetes 服务）的资源才需要这样做。

属性	值
Parameter group:	Properties Arguments

--status

共享专用链接资源的状态。有效值为 Pending、Approved、Rejected 或 Disconnected。

属性	值
Parameter group:	Properties Arguments
接受的值:	Approved, Disconnected, Pending, Rejected

全局参数

--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 shared-private-link-resource delete

编辑

从搜索服务中删除共享专用链接资源。

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

可选参数

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--ids

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

属性	值
Parameter group:	Resource Id Arguments

--name --shared-private-link-resource-name -n

指定资源组中由 Azure AI 搜索服务管理的共享专用链接资源的名称。

属性	值
Parameter group:	Resource Id Arguments

--no-wait

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

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

--resource-group -g

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

属性	值
Parameter group:	Resource Id Arguments

--search-service-name

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

属性	值
Parameter group:	Resource Id Arguments

--subscription

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

属性	值
Parameter group:	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 shared-private-link-resource list

编辑

列出由给定服务管理的所有共享专用链接资源的列表。

az search service shared-private-link-resource list --resource-group
                                                    --search-service-name
                                                    [--max-items]
                                                    [--next-token]

必需参数

--resource-group -g

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

--search-service-name

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

可选参数

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--max-items

命令输出中要返回的项总数。如果可用的项总数大于指定的值，则会在命令的输出中提供令牌。若要恢复分页，请在后续命令的 --next-token 参数中提供令牌值。

属性	值
Parameter group:	Pagination Arguments

--next-token

用于指定开始分页的位置的令牌。这是先前截断的响应中的令牌值。

属性	值
Parameter group:	Pagination 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 shared-private-link-resource show

编辑

获取由给定资源组中的搜索服务管理的共享专用链接资源的详细信息。

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

可选参数

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--ids

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

属性	值
Parameter group:	Resource Id Arguments

--name --shared-private-link-resource-name -n

指定资源组中由 Azure AI 搜索服务管理的共享专用链接资源的名称。

属性	值
Parameter group:	Resource Id Arguments

--resource-group -g

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

属性	值
Parameter group:	Resource Id Arguments

--search-service-name

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

属性	值
Parameter group:	Resource Id Arguments

--subscription

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

属性	值
Parameter group:	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 shared-private-link-resource update

编辑

更新由给定资源组中的搜索服务管理的共享专用链接资源的创建或更新。

az search service shared-private-link-resource update [--add]
                                                      [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                                      [--group-id]
                                                      [--ids]
                                                      [--name --shared-private-link-resource-name]
                                                      [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                      [--private-link-resource-id --resource-id]
                                                      [--provisioning-state {Deleting, Failed, Incomplete, Succeeded, Updating}]
                                                      [--remove]
                                                      [--request-message]
                                                      [--resource-group]
                                                      [--resource-region]
                                                      [--search-service-name]
                                                      [--set]
                                                      [--status {Approved, Disconnected, Pending, Rejected}]
                                                      [--subscription]

可选参数

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--add

通过指定路径和键值对将对象添加到对象列表。示例：--add property.listProperty <key=value, string or JSON string>。

属性	值
Parameter group:	Generic Update Arguments

--force-string

使用“set”或“add”时，保留字符串文本，而不是尝试转换为 JSON。

属性	值
Parameter group:	Generic Update Arguments
接受的值:	0, 1, f, false, n, no, t, true, y, yes

--group-id

共享专用链接资源的提供程序中的组 ID。

属性	值
Parameter group:	Properties Arguments

--ids

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

属性	值
Parameter group:	Resource Id Arguments

--name --shared-private-link-resource-name -n

指定资源组中由 Azure AI 搜索服务管理的共享专用链接资源的名称。

属性	值
Parameter group:	Resource Id Arguments

--no-wait

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

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

--private-link-resource-id --resource-id

共享专用链接资源的资源的资源 ID。

属性	值
Parameter group:	Properties Arguments

--provisioning-state

共享专用链接资源的预配状态。有效值为更新、删除、失败、成功或不完整。

属性	值
Parameter group:	Properties Arguments
接受的值:	Deleting, Failed, Incomplete, Succeeded, Updating

--remove

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

属性	值
Parameter group:	Generic Update Arguments

--request-message

请求批准共享专用链接资源的消息。

属性	值
Parameter group:	Properties Arguments

--resource-group -g

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

属性	值
Parameter group:	Resource Id Arguments

--resource-region

可选。可用于指定要为其创建共享专用链接的资源的 Azure 资源管理器位置。只有 DNS 配置是区域（例如 Azure Kubernetes 服务）的资源才需要这样做。

属性	值
Parameter group:	Properties Arguments

--search-service-name

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

属性	值
Parameter group:	Resource Id Arguments

--set

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

属性	值
Parameter group:	Generic Update Arguments

--status

共享专用链接资源的状态。有效值为 Pending、Approved、Rejected 或 Disconnected。

属性	值
Parameter group:	Properties Arguments
接受的值:	Approved, Disconnected, Pending, Rejected

--subscription

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

属性	值
Parameter group:	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 shared-private-link-resource wait

编辑

将 CLI 置于等待状态，直到满足条件。

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

可选参数

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--created

等待在“Succeeded”中使用“provisioningState”创建。

属性	值
Parameter group:	Wait Condition Arguments
默认值:	False

--custom

等待条件满足自定义 JMESPath 查询。例如 provisioningState！='InProgress'， instanceView.statuses[？code=='PowerState/running']。

属性	值
Parameter group:	Wait Condition Arguments

--deleted

等到删除为止。

属性	值
Parameter group:	Wait Condition Arguments
默认值:	False

--exists

等待资源存在。

属性	值
Parameter group:	Wait Condition Arguments
默认值:	False

--ids

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

属性	值
Parameter group:	Resource Id Arguments

--interval

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

属性	值
Parameter group:	Wait Condition Arguments
默认值:	30

--name --shared-private-link-resource-name -n

指定资源组中由 Azure AI 搜索服务管理的共享专用链接资源的名称。

属性	值
Parameter group:	Resource Id Arguments

--resource-group -g

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

属性	值
Parameter group:	Resource Id Arguments

--search-service-name

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

属性	值
Parameter group:	Resource Id Arguments

--subscription

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

属性	值
Parameter group:	Resource Id Arguments

--timeout

最大等待（以秒为单位）。

属性	值
Parameter group:	Wait Condition Arguments
默认值:	3600

--updated

等到 provisioningState 更新为“Succeeded”。

属性	值
Parameter group:	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

反馈

此页面是否有帮助？