你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
Batch Account - List
获取有关与订阅关联的 Batch 帐户的信息。
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Batch/batchAccounts?api-version=2024-02-01
URI 参数
名称 | 在 | 必需 | 类型 | 说明 |
---|---|---|---|---|
subscription
|
path | True |
string |
Azure 订阅 ID。 这是 GUID 格式的字符串 (例如 00000000-0000-0000-0000-0000-0000000000000) |
api-version
|
query | True |
string |
要与 HTTP 请求一起使用的 API 版本。 |
响应
名称 | 类型 | 说明 |
---|---|---|
200 OK |
操作成功。 响应包含与订阅关联的 Batch 帐户实体的列表。 |
|
Other Status Codes |
描述操作失败原因的错误响应。 |
安全性
azure_auth
Microsoft Entra OAuth 2.0 身份验证代码流
类型:
oauth2
流向:
implicit
授权 URL:
https://login.microsoftonline.com/common/oauth2/authorize
作用域
名称 | 说明 |
---|---|
user_impersonation | 模拟用户帐户 |
示例
BatchAccountList
示例请求
示例响应
{
"value": [
{
"name": "sampleacct",
"location": "japaneast",
"properties": {
"accountEndpoint": "sampleacct.japaneast.batch.azure.com",
"provisioningState": "Succeeded",
"poolAllocationMode": "BatchService",
"dedicatedCoreQuota": 20,
"lowPriorityCoreQuota": 20,
"poolQuota": 20,
"activeJobAndJobScheduleQuota": 20,
"autoStorage": {
"storageAccountId": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage",
"lastKeySync": "2016-03-10T23:48:38.9878479Z"
},
"publicNetworkAccess": "Enabled"
},
"identity": {
"type": "None"
},
"id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct",
"type": "Microsoft.Batch/batchAccounts"
}
]
}
定义
名称 | 说明 |
---|---|
Authentication |
Batch 帐户的身份验证模式。 |
Auto |
Batch 服务将用于管理自动存储帐户的身份验证模式。 |
Auto |
包含有关与 Batch 帐户关联的自动存储帐户的信息。 |
Batch |
包含有关Azure Batch帐户的信息。 |
Batch |
Batch 帐户的标识(如果已配置)。 当用户指定“Microsoft.KeyVault”作为其 Batch 帐户加密配置或选择作为自动存储身份验证模式时 |
Batch |
List 操作返回的值。 |
Cloud |
Batch 服务的错误响应。 |
Cloud |
Batch 服务的错误响应。 |
Compute |
对与计算节点将使用的 Batch 池关联的用户分配标识的引用。 |
Encryption |
配置如何在 Batch 帐户中加密客户数据。 默认情况下,使用 Microsoft 托管密钥对帐户进行加密。 为了进行额外的控制,可以改用客户管理的密钥。 |
Endpoint |
未匹配 IPRule 时的默认操作。 |
Endpoint |
Batch 终结点的网络访问配置文件。 |
IPRule |
用于筛选客户端 IP 地址的规则。 |
IPRule |
匹配客户端 IP 地址时的操作。 |
Key |
密钥源的类型。 |
Key |
使用 Microsoft.KeyVault 加密密钥源时的 KeyVault 配置。 |
Key |
标识与 Batch 帐户关联的 Azure 密钥保管库。 |
Network |
Batch 帐户的网络配置文件,其中包含每个终结点的网络规则设置。 |
Pool |
用于在 Batch 帐户中创建池的分配模式。 |
Private |
专用终结点连接的专用终结点。 |
Private |
包含有关专用链接资源的信息。 |
Private |
专用终结点连接的预配状态。 |
Private |
专用终结点连接的专用链接服务连接状态 |
Private |
Batch 专用终结点连接的状态 |
Provisioning |
资源的预配状态 |
Public |
用于在 Batch 帐户中的资源上运行的网络访问类型。 |
Resource |
用于 Batch 帐户的标识类型。 |
User |
关联用户标识的列表。 |
Virtual |
BATCH 帐户的 VM 系列及其关联的核心配额。 |
AuthenticationMode
Batch 帐户的身份验证模式。
名称 | 类型 | 说明 |
---|---|---|
AAD |
string |
使用 Microsoft Entra ID 的身份验证模式。 |
SharedKey |
string |
使用共享密钥的身份验证模式。 |
TaskAuthenticationToken |
string |
使用任务身份验证令牌的身份验证模式。 |
AutoStorageAuthenticationMode
Batch 服务将用于管理自动存储帐户的身份验证模式。
名称 | 类型 | 说明 |
---|---|---|
BatchAccountManagedIdentity |
string |
Batch 服务将使用分配给 Batch 帐户的托管标识对自动存储的请求进行身份验证。 |
StorageKeys |
string |
Batch 服务将使用存储帐户密钥对自动存储的请求进行身份验证。 |
AutoStorageProperties
包含有关与 Batch 帐户关联的自动存储帐户的信息。
名称 | 类型 | 默认值 | 说明 |
---|---|---|---|
authenticationMode | StorageKeys |
Batch 服务将用于管理自动存储帐户的身份验证模式。 |
|
lastKeySync |
string |
存储密钥上次与 Batch 帐户同步的 UTC 时间。 |
|
nodeIdentityReference |
对计算节点将用于访问自动存储的用户分配标识的引用。 |
||
storageAccountId |
string |
要用于自动存储帐户的存储帐户的资源 ID。 |
BatchAccount
包含有关Azure Batch帐户的信息。
名称 | 类型 | 默认值 | 说明 |
---|---|---|---|
id |
string |
资源的 ID。 |
|
identity |
Batch 帐户的标识。 |
||
location |
string |
资源的位置。 |
|
name |
string |
资源的名称。 |
|
properties.accountEndpoint |
string |
用于与 Batch 服务交互的帐户终结点。 |
|
properties.activeJobAndJobScheduleQuota |
integer |
Batch 帐户的活动作业和作业计划配额。 |
|
properties.allowedAuthenticationModes |
Batch 帐户允许的身份验证模式列表,这些模式可用于对数据平面进行身份验证。 这不会影响控制平面的身份验证。 |
||
properties.autoStorage |
与 Batch 帐户关联的任何自动存储帐户的属性和状态。 |
||
properties.dedicatedCoreQuota |
integer |
Batch 帐户的专用核心配额。 |
|
properties.dedicatedCoreQuotaPerVMFamily |
Batch 帐户的每个虚拟机系列的专用核心配额列表。 对于 PoolAllocationMode 设置为 UserSubscription 的帐户,在订阅上管理配额,因此不会返回此值。 |
||
properties.dedicatedCoreQuotaPerVMFamilyEnforced |
boolean |
一个值,该值指示是否为此帐户强制实施每个虚拟机系列的核心配额 |
|
properties.encryption |
Batch 帐户的加密配置。 |
||
properties.keyVaultReference |
对与 Batch 帐户关联的 Azure 密钥保管库的引用。 |
||
properties.lowPriorityCoreQuota |
integer |
Batch 帐户的现成/低优先级核心配额。 |
|
properties.networkProfile |
Batch 帐户的网络配置文件,其中包含每个终结点的网络规则设置。 |
||
properties.nodeManagementEndpoint |
string |
计算节点用于连接到 Batch 节点管理服务的终结点。 |
|
properties.poolAllocationMode |
用于在 Batch 帐户中创建池的分配模式。 |
||
properties.poolQuota |
integer |
Batch 帐户的池配额。 |
|
properties.privateEndpointConnections |
与 Batch 帐户关联的专用终结点连接列表 |
||
properties.provisioningState |
资源的预配状态 |
||
properties.publicNetworkAccess | Enabled |
用于访问Azure Batch服务和 Batch 帐户操作的网络接口类型。 |
|
tags |
object |
资源的标记。 |
|
type |
string |
资源类型。 |
BatchAccountIdentity
Batch 帐户的标识(如果已配置)。 当用户指定“Microsoft.KeyVault”作为其 Batch 帐户加密配置或选择作为自动存储身份验证模式时 ManagedIdentity
,会使用此选项。
名称 | 类型 | 说明 |
---|---|---|
principalId |
string |
Batch 帐户的主体 ID。 仅为系统分配的标识提供此属性。 |
tenantId |
string |
与 Batch 帐户关联的租户 ID。 仅为系统分配的标识提供此属性。 |
type |
用于 Batch 帐户的标识类型。 |
|
userAssignedIdentities |
<string,
User |
与 Batch 帐户关联的用户标识列表。 |
BatchAccountListResult
List 操作返回的值。
名称 | 类型 | 说明 |
---|---|---|
nextLink |
string |
继续标记。 |
value |
列表操作返回的 Batch 帐户集合。 |
CloudError
Batch 服务的错误响应。
名称 | 类型 | 说明 |
---|---|---|
error |
错误响应的正文。 |
CloudErrorBody
Batch 服务的错误响应。
名称 | 类型 | 说明 |
---|---|---|
code |
string |
错误的标识符。 代码是固定的,旨在以编程方式使用。 |
details |
有关错误的其他详细信息的列表。 |
|
message |
string |
描述错误的消息,该消息适用于在用户界面中显示。 |
target |
string |
特定错误的目标。 例如,属性的名称出错。 |
ComputeNodeIdentityReference
对与计算节点将使用的 Batch 池关联的用户分配标识的引用。
名称 | 类型 | 说明 |
---|---|---|
resourceId |
string |
用户分配的标识的 ARM 资源 ID。 |
EncryptionProperties
配置如何在 Batch 帐户中加密客户数据。 默认情况下,使用 Microsoft 托管密钥对帐户进行加密。 为了进行额外的控制,可以改用客户管理的密钥。
名称 | 类型 | 说明 |
---|---|---|
keySource |
密钥源的类型。 |
|
keyVaultProperties |
使用 Microsoft.KeyVault 时的其他详细信息 |
EndpointAccessDefaultAction
未匹配 IPRule 时的默认操作。
名称 | 类型 | 说明 |
---|---|---|
Allow |
string |
允许客户端访问。 |
Deny |
string |
拒绝客户端访问。 |
EndpointAccessProfile
Batch 终结点的网络访问配置文件。
名称 | 类型 | 说明 |
---|---|---|
defaultAction |
未匹配 IPRule 时的默认操作。 |
|
ipRules |
IPRule[] |
用于筛选客户端 IP 地址的 IP 范围的数组。 |
IPRule
用于筛选客户端 IP 地址的规则。
名称 | 类型 | 说明 |
---|---|---|
action |
匹配客户端 IP 地址时的操作。 |
|
value |
string |
要筛选的 IP 地址或 IP 地址范围 |
IPRuleAction
匹配客户端 IP 地址时的操作。
名称 | 类型 | 说明 |
---|---|---|
Allow |
string |
允许访问匹配的客户端 IP 地址。 |
KeySource
密钥源的类型。
名称 | 类型 | 说明 |
---|---|---|
Microsoft.Batch |
string |
Batch 创建和管理用于保护帐户数据的加密密钥。 |
Microsoft.KeyVault |
string |
用于保护帐户数据的加密密钥存储在外部密钥保管库中。 如果已设置,则必须将 Batch 帐户标识设置为 |
KeyVaultProperties
使用 Microsoft.KeyVault 加密密钥源时的 KeyVault 配置。
名称 | 类型 | 说明 |
---|---|---|
keyIdentifier |
string |
包含或不带版本的机密的完整路径。 示例 https://mykeyvault.vault.azure.net/keys/testkey/6e34a81fef704045975661e297a4c053。 或 https://mykeyvault.vault.azure.net/keys/testkey。 若要使用,必须满足以下先决条件: Batch 帐户具有系统分配的标识 帐户标识已被授予密钥/获取、密钥/取消包装和密钥/包装权限 KeyVault 已启用软删除和清除保护 |
KeyVaultReference
标识与 Batch 帐户关联的 Azure 密钥保管库。
名称 | 类型 | 说明 |
---|---|---|
id |
string |
与 Batch 帐户关联的 Azure Key Vault 的资源 ID。 |
url |
string |
与 Batch 帐户关联的 Azure Key Vault 的 URL。 |
NetworkProfile
Batch 帐户的网络配置文件,其中包含每个终结点的网络规则设置。
名称 | 类型 | 说明 |
---|---|---|
accountAccess |
batchAccount 终结点的网络访问配置文件 (Batch 帐户数据平面 API) 。 |
|
nodeManagementAccess |
nodeManagement 终结点的网络访问配置文件 (Batch 服务管理 Batch 池的计算节点) 。 |
PoolAllocationMode
用于在 Batch 帐户中创建池的分配模式。
名称 | 类型 | 说明 |
---|---|---|
BatchService |
string |
池将在 Batch 服务拥有的订阅中分配。 |
UserSubscription |
string |
池将在用户拥有的订阅中分配。 |
PrivateEndpoint
专用终结点连接的专用终结点。
名称 | 类型 | 说明 |
---|---|---|
id |
string |
专用终结点的 ARM 资源标识符。 其格式为 /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/privateEndpoints/{privateEndpoint}。 |
PrivateEndpointConnection
包含有关专用链接资源的信息。
名称 | 类型 | 说明 |
---|---|---|
etag |
string |
资源的 ETag,用于并发语句。 |
id |
string |
资源的 ID。 |
name |
string |
资源的名称。 |
properties.groupIds |
string[] |
专用终结点连接的组 ID。 |
properties.privateEndpoint |
专用终结点的 ARM 资源标识符。 |
|
properties.privateLinkServiceConnectionState |
专用终结点连接的专用链接服务连接状态。 |
|
properties.provisioningState |
专用终结点连接的预配状态。 |
|
type |
string |
资源类型。 |
PrivateEndpointConnectionProvisioningState
专用终结点连接的预配状态。
名称 | 类型 | 说明 |
---|---|---|
Cancelled |
string |
用户已取消连接创建。 |
Creating |
string |
正在创建连接。 |
Deleting |
string |
正在删除连接。 |
Failed |
string |
用户请求更新连接,但失败。 可以重试更新操作。 |
Succeeded |
string |
连接状态为最终状态,如果状态为“已批准”,则可供使用。 |
Updating |
string |
用户已请求更新连接状态,但更新操作尚未完成。 连接 Batch 帐户时,不得引用连接。 |
PrivateLinkServiceConnectionState
专用终结点连接的专用链接服务连接状态
名称 | 类型 | 说明 |
---|---|---|
actionsRequired |
string |
专用连接状态所需的操作 |
description |
string |
专用连接状态的说明 |
status |
Batch 帐户的专用终结点连接状态 |
PrivateLinkServiceConnectionStatus
Batch 专用终结点连接的状态
名称 | 类型 | 说明 |
---|---|---|
Approved |
string |
专用终结点连接已获批准,可用于访问 Batch 帐户 |
Disconnected |
string |
专用终结点连接已断开连接,不能用于访问 Batch 帐户 |
Pending |
string |
专用终结点连接处于挂起状态,不能用于访问 Batch 帐户 |
Rejected |
string |
专用终结点连接被拒绝,不能用于访问 Batch 帐户 |
ProvisioningState
资源的预配状态
名称 | 类型 | 说明 |
---|---|---|
Cancelled |
string |
帐户的最后一个操作将被取消。 |
Creating |
string |
正在创建帐户。 |
Deleting |
string |
正在删除该帐户。 |
Failed |
string |
帐户的最后一个操作失败。 |
Invalid |
string |
帐户处于无效状态。 |
Succeeded |
string |
帐户已创建并可供使用。 |
PublicNetworkAccessType
用于在 Batch 帐户中的资源上运行的网络访问类型。
名称 | 类型 | 说明 |
---|---|---|
Disabled |
string |
禁用公共连接,并启用通过专用终结点资源Azure Batch服务的专用连接。 |
Enabled |
string |
启用通过公共 DNS 与Azure Batch的连接。 |
ResourceIdentityType
用于 Batch 帐户的标识类型。
名称 | 类型 | 说明 |
---|---|---|
None |
string |
Batch 帐户没有与之关联的标识。 在更新帐户中设置 |
SystemAssigned |
string |
Batch 帐户具有系统分配的标识。 |
UserAssigned |
string |
Batch 帐户具有用户分配的标识。 |
UserAssignedIdentities
关联用户标识的列表。
名称 | 类型 | 说明 |
---|---|---|
clientId |
string |
用户分配标识的客户端 ID。 |
principalId |
string |
用户分配的标识的主体 ID。 |
VirtualMachineFamilyCoreQuota
BATCH 帐户的 VM 系列及其关联的核心配额。
名称 | 类型 | 说明 |
---|---|---|
coreQuota |
integer |
Batch 帐户的 VM 系列的核心配额。 |
name |
string |
虚拟机系列名称。 |