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

Batch Account - Get

Service:

Batch Management

API Version:

2024-02-01

获取有关指定 Batch 帐户的信息。

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

URI 参数

名称	在	必需	类型	说明
accountName	path	True	string	Batch 帐户的名称。 Regex pattern: ^[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 版本。

响应

名称	类型	说明
200 OK	BatchAccount	操作成功。 响应包含 Batch 帐户实体。
Other Status Codes	CloudError	描述操作失败原因的错误响应。

安全性

azure_auth

Microsoft Entra OAuth 2.0 身份验证代码流

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

名称	说明
user_impersonation	模拟用户帐户

示例

BatchAccountGet

PrivateBatchAccountGet

BatchAccountGet

Sample Request

HTTP

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

Java

/**
 * Samples for BatchAccount GetByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/batch/resource-manager/Microsoft.Batch/stable/2024-02-01/examples/BatchAccountGet.json
     */
    /**
     * Sample code: BatchAccountGet.
     * 
     * @param manager Entry point to BatchManager.
     */
    public static void batchAccountGet(com.azure.resourcemanager.batch.BatchManager manager) {
        manager.batchAccounts().getByResourceGroupWithResponse("default-azurebatch-japaneast", "sampleacct",
            com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.batch import BatchManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-batch
# USAGE
    python batch_account_get.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = BatchManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.batch_account.get(
        resource_group_name="default-azurebatch-japaneast",
        account_name="sampleacct",
    )
    print(response)


# x-ms-original-file: specification/batch/resource-manager/Microsoft.Batch/stable/2024-02-01/examples/BatchAccountGet.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armbatch_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/batch/armbatch/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/cf5ad1932d00c7d15497705ad6b71171d3d68b1e/specification/batch/resource-manager/Microsoft.Batch/stable/2024-02-01/examples/BatchAccountGet.json
func ExampleAccountClient_Get_batchAccountGet() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armbatch.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewAccountClient().Get(ctx, "default-azurebatch-japaneast", "sampleacct", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.Account = armbatch.Account{
	// 	Name: to.Ptr("sampleacct"),
	// 	Type: to.Ptr("Microsoft.Batch/batchAccounts"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct"),
	// 	Location: to.Ptr("japaneast"),
	// 	Identity: &armbatch.AccountIdentity{
	// 		Type: to.Ptr(armbatch.ResourceIdentityTypeNone),
	// 	},
	// 	Properties: &armbatch.AccountProperties{
	// 		AccountEndpoint: to.Ptr("sampleacct.japaneast.batch.azure.com"),
	// 		ActiveJobAndJobScheduleQuota: to.Ptr[int32](20),
	// 		AutoStorage: &armbatch.AutoStorageProperties{
	// 			StorageAccountID: to.Ptr("/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage"),
	// 			LastKeySync: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2016-03-10T23:48:38.987Z"); return t}()),
	// 		},
	// 		DedicatedCoreQuota: to.Ptr[int32](20),
	// 		LowPriorityCoreQuota: to.Ptr[int32](20),
	// 		PoolAllocationMode: to.Ptr(armbatch.PoolAllocationModeBatchService),
	// 		PoolQuota: to.Ptr[int32](20),
	// 		ProvisioningState: to.Ptr(armbatch.ProvisioningStateSucceeded),
	// 		PublicNetworkAccess: to.Ptr(armbatch.PublicNetworkAccessTypeEnabled),
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { BatchManagementClient } = require("@azure/arm-batch");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Gets information about the specified Batch account.
 *
 * @summary Gets information about the specified Batch account.
 * x-ms-original-file: specification/batch/resource-manager/Microsoft.Batch/stable/2024-02-01/examples/BatchAccountGet.json
 */
async function batchAccountGet() {
  const subscriptionId = process.env["BATCH_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["BATCH_RESOURCE_GROUP"] || "default-azurebatch-japaneast";
  const accountName = "sampleacct";
  const credential = new DefaultAzureCredential();
  const client = new BatchManagementClient(credential, subscriptionId);
  const result = await client.batchAccountOperations.get(resourceGroupName, accountName);
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Batch;
using Azure.ResourceManager.Batch.Models;
using Azure.ResourceManager.Resources;

// Generated from example definition: specification/batch/resource-manager/Microsoft.Batch/stable/2024-02-01/examples/BatchAccountGet.json
// this example is just showing the usage of "BatchAccount_Get" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this BatchAccountResource created on azure
// for more information of creating BatchAccountResource, please refer to the document of BatchAccountResource
string subscriptionId = "subid";
string resourceGroupName = "default-azurebatch-japaneast";
string accountName = "sampleacct";
ResourceIdentifier batchAccountResourceId = BatchAccountResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, accountName);
BatchAccountResource batchAccount = client.GetBatchAccountResource(batchAccountResourceId);

// invoke the operation
BatchAccountResource result = await batchAccount.GetAsync();

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
BatchAccountData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:

200

{
  "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"
}

PrivateBatchAccountGet

Sample Request

HTTP

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

Java

/**
 * Samples for BatchAccount GetByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/batch/resource-manager/Microsoft.Batch/stable/2024-02-01/examples/PrivateBatchAccountGet.json
     */
    /**
     * Sample code: PrivateBatchAccountGet.
     * 
     * @param manager Entry point to BatchManager.
     */
    public static void privateBatchAccountGet(com.azure.resourcemanager.batch.BatchManager manager) {
        manager.batchAccounts().getByResourceGroupWithResponse("default-azurebatch-japaneast", "sampleacct",
            com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.batch import BatchManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-batch
# USAGE
    python private_batch_account_get.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = BatchManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.batch_account.get(
        resource_group_name="default-azurebatch-japaneast",
        account_name="sampleacct",
    )
    print(response)


# x-ms-original-file: specification/batch/resource-manager/Microsoft.Batch/stable/2024-02-01/examples/PrivateBatchAccountGet.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armbatch_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/batch/armbatch/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/cf5ad1932d00c7d15497705ad6b71171d3d68b1e/specification/batch/resource-manager/Microsoft.Batch/stable/2024-02-01/examples/PrivateBatchAccountGet.json
func ExampleAccountClient_Get_privateBatchAccountGet() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armbatch.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewAccountClient().Get(ctx, "default-azurebatch-japaneast", "sampleacct", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.Account = armbatch.Account{
	// 	Name: to.Ptr("sampleacct"),
	// 	Type: to.Ptr("Microsoft.Batch/batchAccounts"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct"),
	// 	Location: to.Ptr("japaneast"),
	// 	Properties: &armbatch.AccountProperties{
	// 		AccountEndpoint: to.Ptr("sampleacct.japaneast.batch.azure.com"),
	// 		ActiveJobAndJobScheduleQuota: to.Ptr[int32](20),
	// 		AutoStorage: &armbatch.AutoStorageProperties{
	// 			StorageAccountID: to.Ptr("/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage"),
	// 			LastKeySync: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2016-03-10T23:48:38.987Z"); return t}()),
	// 		},
	// 		DedicatedCoreQuota: to.Ptr[int32](20),
	// 		LowPriorityCoreQuota: to.Ptr[int32](20),
	// 		PoolAllocationMode: to.Ptr(armbatch.PoolAllocationModeBatchService),
	// 		PoolQuota: to.Ptr[int32](20),
	// 		PrivateEndpointConnections: []*armbatch.PrivateEndpointConnection{
	// 			{
	// 				Name: to.Ptr("testprivateEndpointConnection.24d6b4b5-e65c-4330-bbe9-3a290d62f8e0"),
	// 				Type: to.Ptr("Microsoft.Batch/batchAccounts/privateEndpointConnections"),
	// 				ID: to.Ptr("/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/privateEndpointConnections/testprivateEndpointConnection.24d6b4b5-e65c-4330-bbe9-3a290d62f8e0"),
	// 				Properties: &armbatch.PrivateEndpointConnectionProperties{
	// 					PrivateEndpoint: &armbatch.PrivateEndpoint{
	// 						ID: to.Ptr("/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Network/privateEndpoints/testprivateEndpoint"),
	// 					},
	// 					PrivateLinkServiceConnectionState: &armbatch.PrivateLinkServiceConnectionState{
	// 						Description: to.Ptr("Approved by xyz.abc@company.com"),
	// 						Status: to.Ptr(armbatch.PrivateLinkServiceConnectionStatusApproved),
	// 					},
	// 				},
	// 		}},
	// 		ProvisioningState: to.Ptr(armbatch.ProvisioningStateSucceeded),
	// 		PublicNetworkAccess: to.Ptr(armbatch.PublicNetworkAccessTypeDisabled),
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { BatchManagementClient } = require("@azure/arm-batch");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Gets information about the specified Batch account.
 *
 * @summary Gets information about the specified Batch account.
 * x-ms-original-file: specification/batch/resource-manager/Microsoft.Batch/stable/2024-02-01/examples/PrivateBatchAccountGet.json
 */
async function privateBatchAccountGet() {
  const subscriptionId = process.env["BATCH_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["BATCH_RESOURCE_GROUP"] || "default-azurebatch-japaneast";
  const accountName = "sampleacct";
  const credential = new DefaultAzureCredential();
  const client = new BatchManagementClient(credential, subscriptionId);
  const result = await client.batchAccountOperations.get(resourceGroupName, accountName);
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Batch;
using Azure.ResourceManager.Batch.Models;
using Azure.ResourceManager.Resources;

// Generated from example definition: specification/batch/resource-manager/Microsoft.Batch/stable/2024-02-01/examples/PrivateBatchAccountGet.json
// this example is just showing the usage of "BatchAccount_Get" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this BatchAccountResource created on azure
// for more information of creating BatchAccountResource, please refer to the document of BatchAccountResource
string subscriptionId = "subid";
string resourceGroupName = "default-azurebatch-japaneast";
string accountName = "sampleacct";
ResourceIdentifier batchAccountResourceId = BatchAccountResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, accountName);
BatchAccountResource batchAccount = client.GetBatchAccountResource(batchAccountResourceId);

// invoke the operation
BatchAccountResource result = await batchAccount.GetAsync();

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
BatchAccountData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:

200

{
  "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": "Disabled",
    "privateEndpointConnections": [
      {
        "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/privateEndpointConnections/testprivateEndpointConnection.24d6b4b5-e65c-4330-bbe9-3a290d62f8e0",
        "name": "testprivateEndpointConnection.24d6b4b5-e65c-4330-bbe9-3a290d62f8e0",
        "type": "Microsoft.Batch/batchAccounts/privateEndpointConnections",
        "properties": {
          "privateEndpoint": {
            "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Network/privateEndpoints/testprivateEndpoint"
          },
          "privateLinkServiceConnectionState": {
            "status": "Approved",
            "description": "Approved by xyz.abc@company.com"
          }
        }
      }
    ]
  },
  "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct",
  "type": "Microsoft.Batch/batchAccounts"
}

定义

名称	说明
AuthenticationMode	Batch 帐户的身份验证模式。
AutoStorageAuthenticationMode	Batch 服务将用于管理自动存储帐户的身份验证模式。
AutoStorageProperties	包含有关与 Batch 帐户关联的自动存储帐户的信息。
BatchAccount	包含有关Azure Batch帐户的信息。
BatchAccountIdentity	Batch 帐户的标识（如果已配置）。 当用户指定“Microsoft.KeyVault”作为其 Batch 帐户加密配置或选择作为自动存储身份验证模式时 ManagedIdentity ，会使用此方法。
CloudError	来自 Batch 服务的错误响应。
CloudErrorBody	来自 Batch 服务的错误响应。
ComputeNodeIdentityReference	对与计算节点将使用的 Batch 池关联的用户分配标识的引用。
EncryptionProperties	配置如何在 Batch 帐户中加密客户数据。 默认情况下，使用 Microsoft 托管密钥对帐户进行加密。 对于其他控制，可以改用客户管理的密钥。
EndpointAccessDefaultAction	没有匹配 IPRule 时的默认操作。
EndpointAccessProfile	Batch 终结点的网络访问配置文件。
IPRule	用于筛选客户端 IP 地址的规则。
IPRuleAction	匹配客户端 IP 地址时的操作。
KeySource	密钥源的类型。
KeyVaultProperties	使用 Microsoft.KeyVault 加密密钥源时的 KeyVault 配置。
KeyVaultReference	标识与 Batch 帐户关联的 Azure 密钥保管库。
NetworkProfile	Batch 帐户的网络配置文件，其中包含每个终结点的网络规则设置。
PoolAllocationMode	用于在 Batch 帐户中创建池的分配模式。
PrivateEndpoint	专用终结点连接的专用终结点。
PrivateEndpointConnection	包含有关专用链接资源的信息。
PrivateEndpointConnectionProvisioningState	专用终结点连接的预配状态。
PrivateLinkServiceConnectionState	专用终结点连接的专用链接服务连接状态
PrivateLinkServiceConnectionStatus	Batch 专用终结点连接的状态
ProvisioningState	资源的预配状态
PublicNetworkAccessType	用于对 Batch 帐户中的资源进行操作的网络访问类型。
ResourceIdentityType	用于 Batch 帐户的标识类型。
UserAssignedIdentities	关联用户标识的列表。
VirtualMachineFamilyCoreQuota	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	AutoStorageAuthenticationMode	StorageKeys	Batch 服务将用于管理自动存储帐户的身份验证模式。
lastKeySync	string		存储密钥上次与 Batch 帐户同步的 UTC 时间。
nodeIdentityReference	ComputeNodeIdentityReference		对计算节点将用于访问自动存储的用户分配标识的引用。 此处引用的标识必须分配给具有需要访问自动存储的计算节点的池。
storageAccountId	string		要用于自动存储帐户的存储帐户的资源 ID。

BatchAccount

包含有关Azure Batch帐户的信息。

名称	类型	默认值	说明
id	string		资源的 ID。
identity	BatchAccountIdentity		Batch 帐户的标识。
location	string		资源的位置。
name	string		资源的名称。
properties.accountEndpoint	string		用于与 Batch 服务交互的帐户终结点。
properties.activeJobAndJobScheduleQuota	integer		Batch 帐户的活动作业和作业计划配额。
properties.allowedAuthenticationModes	AuthenticationMode[]		可用于向数据平面进行身份验证的 Batch 帐户允许的身份验证模式列表。 这不会影响使用控制平面进行身份验证。
properties.autoStorage	AutoStorageProperties		与 Batch 帐户关联的任何自动存储帐户的属性和状态。 包含有关与 Batch 帐户关联的自动存储帐户的信息。
properties.dedicatedCoreQuota	integer		Batch 帐户的专用核心配额。 对于 PoolAllocationMode 设置为 UserSubscription 的帐户，对订阅管理配额，因此不会返回此值。
properties.dedicatedCoreQuotaPerVMFamily	VirtualMachineFamilyCoreQuota[]		Batch 帐户的每个虚拟机系列的专用核心配额列表。 对于 PoolAllocationMode 设置为 UserSubscription 的帐户，对订阅管理配额，因此不会返回此值。
properties.dedicatedCoreQuotaPerVMFamilyEnforced	boolean		一个值，该值指示是否为此帐户强制实施每个虚拟机系列的核心配额 如果此标志为 true，则通过帐户上的 dedicatedCoreQuotaPerVMFamily 和 dedicatedCoreQuota 属性强制实施专用核心配额。 如果此标志为 false，则仅通过帐户上的 dedicatedCoreQuota 属性强制实施专用核心配额，不考虑虚拟机系列。
properties.encryption	EncryptionProperties		Batch 帐户的加密配置。 配置如何在 Batch 帐户中加密客户数据。 默认情况下，使用 Microsoft 托管密钥对帐户进行加密。 对于其他控制，可以改用客户管理的密钥。
properties.keyVaultReference	KeyVaultReference		对与 Batch 帐户关联的 Azure 密钥保管库的引用。 标识与 Batch 帐户关联的 Azure 密钥保管库。
properties.lowPriorityCoreQuota	integer		Batch 帐户的现成/低优先级核心配额。 对于 PoolAllocationMode 设置为 UserSubscription 的帐户，对订阅管理配额，因此不会返回此值。
properties.networkProfile	NetworkProfile		Batch 帐户的网络配置文件，其中包含每个终结点的网络规则设置。 仅当启用 publicNetworkAccess 时，网络配置文件才会生效。
properties.nodeManagementEndpoint	string		计算节点用于连接到 Batch 节点管理服务的终结点。
properties.poolAllocationMode	PoolAllocationMode		用于在 Batch 帐户中创建池的分配模式。 用于在 Batch 帐户中创建池的分配模式。
properties.poolQuota	integer		Batch 帐户的池配额。
properties.privateEndpointConnections	PrivateEndpointConnection[]		与 Batch 帐户关联的专用终结点连接列表
properties.provisioningState	ProvisioningState		资源的预配状态
properties.publicNetworkAccess	PublicNetworkAccessType	Enabled	用于访问Azure Batch服务和 Batch 帐户操作的网络接口类型。 如果未指定，则默认值为“enabled”。
tags	object		资源的标记。
type	string		资源类型。

BatchAccountIdentity

Batch 帐户的标识（如果已配置）。 当用户指定“Microsoft.KeyVault”作为其 Batch 帐户加密配置或选择作为自动存储身份验证模式时 ManagedIdentity ，会使用此方法。

名称	类型	说明
principalId	string	Batch 帐户的主体 ID。 此属性仅针对系统分配的标识提供。
tenantId	string	与 Batch 帐户关联的租户 ID。 此属性仅针对系统分配的标识提供。
type	ResourceIdentityType	用于 Batch 帐户的标识类型。
userAssignedIdentities	object	与 Batch 帐户关联的用户标识列表。

CloudError

来自 Batch 服务的错误响应。

名称	类型	说明
error	CloudErrorBody	错误响应的正文。

CloudErrorBody

来自 Batch 服务的错误响应。

名称	类型	说明
code	string	错误的标识符。 代码是固定的，旨在以编程方式使用。
details	CloudErrorBody[]	有关错误的其他详细信息的列表。
message	string	描述错误的消息，该消息适用于在用户界面中显示。
target	string	特定错误的目标。 例如，属性的名称出错。

ComputeNodeIdentityReference

对与计算节点将使用的 Batch 池关联的用户分配标识的引用。

名称	类型	说明
resourceId	string	用户分配的标识的 ARM 资源 ID。

EncryptionProperties

配置如何在 Batch 帐户中加密客户数据。 默认情况下，使用 Microsoft 托管密钥对帐户进行加密。 对于其他控制，可以改用客户管理的密钥。

名称	类型	说明
keySource	KeySource	密钥源的类型。
keyVaultProperties	KeyVaultProperties	使用 Microsoft.KeyVault 时的其他详细信息

EndpointAccessDefaultAction

没有匹配 IPRule 时的默认操作。

名称	类型	说明
Allow	string	允许客户端访问。
Deny	string	拒绝客户端访问。

EndpointAccessProfile

Batch 终结点的网络访问配置文件。

名称	类型	说明
defaultAction	EndpointAccessDefaultAction	没有匹配 IPRule 时的默认操作。 终结点访问的默认操作。 它仅在启用 publicNetworkAccess 时适用。
ipRules	IPRule[]	用于筛选客户端 IP 地址的 IP 范围的数组。

IPRule

用于筛选客户端 IP 地址的规则。

名称	类型	说明
action	IPRuleAction	匹配客户端 IP 地址时的操作。
value	string	要筛选的 IP 地址或 IP 地址范围 IPv4 地址或 CIDR 格式的 IPv4 地址范围。

IPRuleAction

匹配客户端 IP 地址时的操作。

名称	类型	说明
Allow	string	允许对匹配的客户端 IP 地址进行访问。

KeySource

密钥源的类型。

名称	类型	说明
Microsoft.Batch	string	Batch 创建和管理用于保护帐户数据的加密密钥。
Microsoft.KeyVault	string	用于保护帐户数据的加密密钥存储在外部密钥保管库中。 如果已设置，则必须将 Batch 帐户标识设置为 SystemAssigned ，并且还必须在 keyVaultProperties 下提供有效的密钥标识符。

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	EndpointAccessProfile	batchAccount 终结点的网络访问配置文件 (Batch 帐户数据平面 API) 。
nodeManagementAccess	EndpointAccessProfile	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。 值具有一个且只有一个组 ID。
properties.privateEndpoint	PrivateEndpoint	专用终结点的 ARM 资源标识符。 专用终结点连接的专用终结点。
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	专用终结点连接的专用链接服务连接状态。 专用终结点连接的专用链接服务连接状态
properties.provisioningState	PrivateEndpointConnectionProvisioningState	专用终结点连接的预配状态。
type	string	资源类型。

PrivateEndpointConnectionProvisioningState

专用终结点连接的预配状态。

名称	类型	说明
Cancelled	string	用户已取消连接创建。
Creating	string	正在创建连接。
Deleting	string	正在删除连接。
Failed	string	用户请求更新连接，但失败。 可以重试更新操作。
Succeeded	string	连接状态为最终状态，如果状态为“已批准”，则可供使用。
Updating	string	用户已请求更新连接状态，但更新操作尚未完成。 连接 Batch 帐户时，不得引用连接。

PrivateLinkServiceConnectionState

专用终结点连接的专用链接服务连接状态

名称	类型	说明
actionsRequired	string	专用连接状态所需的操作
description	string	专用连接状态的说明
status	PrivateLinkServiceConnectionStatus	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 帐户没有与之关联的标识。 在更新帐户中设置 None 将删除现有标识。
SystemAssigned	string	Batch 帐户具有系统分配的标识。
UserAssigned	string	Batch 帐户具有用户分配的标识。

UserAssignedIdentities

关联用户标识的列表。

名称	类型	说明
clientId	string	用户分配标识的客户端 ID。
principalId	string	用户分配标识的主体 ID。

VirtualMachineFamilyCoreQuota

Batch 帐户的 VM 系列及其关联的核心配额。

名称	类型	说明
coreQuota	integer	Batch 帐户的 VM 系列的核心配额。
name	string	虚拟机系列名称。