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

Private Link Resource - List By Batch Account

Lists指定帐户中的所有专用链接资源。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/privateLinkResources?api-version=2024-02-01
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/privateLinkResources?api-version=2024-02-01&maxresults={maxresults}

URI 参数

名称 必需 类型 说明
accountName
path True

string

Batch 帐户的名称。

正则表达式模式: ^[a-zA-Z0-9]+$

resourceGroupName
path True

string

包含 Batch 帐户的资源组的名称。

subscriptionId
path True

string

Azure 订阅 ID。 这是 GUID 格式的字符串, (例如 00000000-0000-0000-0000-00000000000000)

api-version
query True

string

要与 HTTP 请求一起使用的 API 版本。

maxresults
query

integer

int32

响应中要返回的最大项数。

响应

名称 类型 说明
200 OK

ListPrivateLinkResourcesResult

操作成功。 响应包含与帐户关联的专用链接资源的列表。

Other Status Codes

CloudError

描述操作失败原因的错误响应。

安全性

azure_auth

Microsoft Entra OAuth 2.0 身份验证代码流

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称 说明
user_impersonation 模拟用户帐户

示例

ListPrivateLinkResource

示例请求

GET https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/privateLinkResources?api-version=2024-02-01

示例响应

{
  "value": [
    {
      "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/privateLinkResources/batchAccount",
      "name": "batchAccount",
      "type": "Microsoft.Batch/batchAccounts/privateLinkResources",
      "properties": {
        "groupId": "batchAccount",
        "requiredMembers": [
          "batchAccount"
        ],
        "requiredZoneNames": [
          "privatelink.japaneast.batch.azure.com"
        ]
      }
    }
  ]
}

定义

名称 说明
CloudError

来自 Batch 服务的错误响应。

CloudErrorBody

来自 Batch 服务的错误响应。

ListPrivateLinkResourcesResult

List 操作返回的值。

PrivateLinkResource

包含有关专用链接资源的信息。

CloudError

来自 Batch 服务的错误响应。

名称 类型 说明
error

CloudErrorBody

错误响应的正文。

CloudErrorBody

来自 Batch 服务的错误响应。

名称 类型 说明
code

string

错误的标识符。 代码是固定的,旨在以编程方式使用。

details

CloudErrorBody[]

有关错误的其他详细信息的列表。

message

string

描述错误的消息,该消息适用于在用户界面中显示。

target

string

特定错误的目标。 例如,属性的名称出错。

ListPrivateLinkResourcesResult

List 操作返回的值。

名称 类型 说明
nextLink

string

继续标记。

value

PrivateLinkResource[]

返回的专用链接资源的集合。

PrivateLinkResource

包含有关专用链接资源的信息。

名称 类型 说明
etag

string

资源的 ETag,用于并发语句。

id

string

资源的 ID。

name

string

资源的名称。

properties.groupId

string

专用链接资源的组 ID。
组 ID 用于建立专用链接连接。

properties.requiredMembers

string[]

用于建立专用链接连接的必需成员的列表。

properties.requiredZoneNames

string[]

专用 DNS 资源名称所需的区域名称列表

type

string

资源类型。