你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
Shared Private Link Resources - Create Or Update
启动创建或更新由给定资源组中的搜索服务管理的共享专用链接资源。
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/sharedPrivateLinkResources/{sharedPrivateLinkResourceName}?api-version=2023-11-01
URI 参数
名称 | 在 | 必需 | 类型 | 说明 |
---|---|---|---|---|
resource
|
path | True |
string |
当前订阅中资源组的名称。 可以从 Azure 资源管理器 API 或门户获取此值。 |
search
|
path | True |
string |
与指定资源组关联的搜索服务的名称。 |
shared
|
path | True |
string |
指定资源组中由搜索服务管理的共享专用链接资源的名称。 |
subscription
|
path | True |
string |
Microsoft Azure 订阅的唯一标识符。 可以从 Azure 资源管理器 API、命令行工具或门户获取此值。 |
api-version
|
query | True |
string |
要用于每个请求的 API 版本。 |
请求头
名称 | 必需 | 类型 | 说明 |
---|---|---|---|
x-ms-client-request-id |
string uuid |
客户端生成的用于标识此请求的 GUID 值。 如果指定,则会将其包含在响应信息中,作为跟踪请求的一种方式。 |
请求正文
名称 | 类型 | 说明 |
---|---|---|
properties |
描述搜索服务管理的共享专用链接资源的属性。 |
响应
名称 | 类型 | 说明 |
---|---|---|
200 OK |
已创建或更新的共享专用链接资源的详细信息。 |
|
202 Accepted |
共享专用链接资源创建或更新操作已被接受,并将异步完成。 |
|
Other Status Codes |
HTTP 400 (错误的请求) :给定的共享专用链接资源名称或共享专用链接资源定义无效;有关详细信息,请参阅响应中的错误代码和消息。 HTTP 404 (找不到) :找不到订阅、资源组、搜索服务或共享专用链接资源。 HTTP 409 (冲突) :禁用指定的订阅。 |
安全性
azure_auth
Microsoft Entra ID OAuth2 授权流。
类型:
oauth2
流向:
implicit
授权 URL:
https://login.microsoftonline.com/common/oauth2/authorize
作用域
名称 | 说明 |
---|---|
user_impersonation | 模拟用户帐户 |
示例
SharedPrivateLinkResourceCreateOrUpdate
示例请求
PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/sharedPrivateLinkResources/testResource?api-version=2023-11-01
{
"properties": {
"requestMessage": "please approve",
"groupId": "blob",
"privateLinkResourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Storage/storageAccounts/storageAccountName",
"resourceRegion": null
}
}
示例响应
Location: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchService/sharedPrivateLinkResources/testResource/operationStatuses/08586060559526078782?api-version=2023-11-01
Azure-AsyncOperation: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchService/sharedPrivateLinkResources/testResource/operationStatuses/08586060559526078782?api-version=2023-11-01
{
"name": "testResource",
"type": "Microsoft.Search/searchServices/sharedPrivateLinkResources",
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/sharedPrivateLinkResources/testResource",
"properties": {
"requestMessage": "please approve",
"groupId": "blob",
"privateLinkResourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Storage/storageAccounts/storageAccountName",
"status": "Pending",
"resourceRegion": null
}
}
定义
名称 | 说明 |
---|---|
Cloud |
包含有关 API 错误的信息。 |
Cloud |
使用错误代码和消息描述特定的 API 错误。 |
Shared |
描述搜索服务管理的共享专用链接资源。 |
Shared |
描述搜索服务管理的现有共享专用链接资源的属性。 |
Shared |
共享专用链接资源的预配状态。 有效值为 Updateing、Deleting、Failed、Succeeded 或 Incomplete。 |
Shared |
共享专用链接资源的状态。 有效值为 Pending、Approved、Rejected 或 Disconnected。 |
CloudError
包含有关 API 错误的信息。
名称 | 类型 | 说明 |
---|---|---|
error |
使用错误代码和消息描述特定的 API 错误。 |
CloudErrorBody
使用错误代码和消息描述特定的 API 错误。
名称 | 类型 | 说明 |
---|---|---|
code |
string |
描述错误条件的错误代码比 HTTP 状态代码更精确。 可用于以编程方式处理特定错误情况。 |
details |
包含与此错误相关的嵌套错误。 |
|
message |
string |
详细描述错误并提供调试信息的消息。 |
target |
string |
特定错误的目标 (例如,错误) 中属性的名称。 |
SharedPrivateLinkResource
描述搜索服务管理的共享专用链接资源。
名称 | 类型 | 说明 |
---|---|---|
id |
string |
资源的完全限定的资源 ID。 例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name |
string |
资源的名称 |
properties |
描述搜索服务管理的共享专用链接资源的属性。 |
|
type |
string |
资源类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts” |
SharedPrivateLinkResourceProperties
描述搜索服务管理的现有共享专用链接资源的属性。
名称 | 类型 | 说明 |
---|---|---|
groupId |
string |
共享专用链接资源所针对的资源提供程序的组 ID。 |
privateLinkResourceId |
string |
共享专用链接资源所针对的资源的资源 ID。 |
provisioningState |
共享专用链接资源的预配状态。 有效值为 Updateing、Deleting、Failed、Succeeded 或 Incomplete。 |
|
requestMessage |
string |
请求批准共享专用链接资源的请求消息。 |
resourceRegion |
string |
可选。 可用于指定要创建共享专用链接的资源的 Azure 资源管理器位置。 只有 DNS 配置为区域性 (的资源(如 Azure Kubernetes 服务) )才需要这样做。 |
status |
共享专用链接资源的状态。 有效值为 Pending、Approved、Rejected 或 Disconnected。 |
SharedPrivateLinkResourceProvisioningState
共享专用链接资源的预配状态。 有效值为 Updateing、Deleting、Failed、Succeeded 或 Incomplete。
名称 | 类型 | 说明 |
---|---|---|
Deleting |
string |
|
Failed |
string |
|
Incomplete |
string |
|
Succeeded |
string |
|
Updating |
string |
SharedPrivateLinkResourceStatus
共享专用链接资源的状态。 有效值为 Pending、Approved、Rejected 或 Disconnected。
名称 | 类型 | 说明 |
---|---|---|
Approved |
string |
|
Disconnected |
string |
|
Pending |
string |
|
Rejected |
string |