Batch Account - Update

參考

服務:: Batch Management

API 版本:: 2024-07-01

更新現有 Batch 帳戶的屬性。

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

URI 參數

名稱	位於	必要	類型	Description
accountName	path	True	string minLength: 3 maxLength: 24 pattern: ^[a-zA-Z0-9]+$	Batch 帳戶的名稱。
resourceGroupName	path	True	string	包含 Batch 帳戶的資源群組名稱。
subscriptionId	path	True	string	Azure 訂用帳戶標識碼。這是 GUID 格式的字串（例如 0000000000-0000-0000-0000-0000000000000000）
api-version	query	True	string	要與 HTTP 要求搭配使用的 API 版本。

要求本文

名稱	類型	Description
identity	BatchAccountIdentity	Batch 帳戶的身分識別。
properties.allowedAuthenticationModes	AuthenticationMode[]	Batch 帳戶允許的驗證模式清單，可用來向數據平面進行驗證。這不會影響控制平面的驗證。
properties.autoStorage	AutoStorageBaseProperties	與自動記憶體帳戶相關的屬性。
properties.encryption	EncryptionProperties	Batch 帳戶的加密組態。設定客戶數據在 Batch 帳戶內加密的方式。根據預設，帳戶會使用Microsoft受控密鑰來加密。如需其他控制，可以改用客戶管理的密鑰。
properties.networkProfile	NetworkProfile	Batch 帳戶的網路配置檔，其中包含每個端點的網路規則設定。只有在啟用 publicNetworkAccess 時，網路配置檔才會生效。
properties.publicNetworkAccess	PublicNetworkAccessType	用於存取 Azure Batch 帳戶的網路存取類型。如果未指定，預設值為 'enabled'。
tags	object	與帳戶相關聯的使用者指定標記。

回應

名稱	類型	Description
200 OK	BatchAccount	作業成功。回應包含 Batch 帳戶實體。
Other Status Codes	CloudError	描述作業失敗原因的錯誤回應。

安全性

azure_auth

Microsoft Entra OAuth 2.0 驗證碼流程

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
user_impersonation	模擬您的用戶帳戶

範例

BatchAccountUpdate

範例要求

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

{
  "properties": {
    "autoStorage": {
      "storageAccountId": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage"
    }
  }
}


import com.azure.resourcemanager.batch.models.AutoStorageBaseProperties;
import com.azure.resourcemanager.batch.models.BatchAccount;

/**
 * Samples for BatchAccount Update.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/batch/resource-manager/Microsoft.Batch/stable/2024-07-01/examples/BatchAccountUpdate.json
     */
    /**
     * Sample code: BatchAccountUpdate.
     * 
     * @param manager Entry point to BatchManager.
     */
    public static void batchAccountUpdate(com.azure.resourcemanager.batch.BatchManager manager) {
        BatchAccount resource = manager.batchAccounts().getByResourceGroupWithResponse("default-azurebatch-japaneast",
            "sampleacct", com.azure.core.util.Context.NONE).getValue();
        resource.update().withAutoStorage(new AutoStorageBaseProperties().withStorageAccountId(
            "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage"))
            .apply();
    }
}

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

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_update.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.update(
        resource_group_name="default-azurebatch-japaneast",
        account_name="sampleacct",
        parameters={
            "properties": {
                "autoStorage": {
                    "storageAccountId": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage"
                }
            }
        },
    )
    print(response)


# x-ms-original-file: specification/batch/resource-manager/Microsoft.Batch/stable/2024-07-01/examples/BatchAccountUpdate.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

package armbatch_test

import (
	"context"
	"log"

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

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/e79d9ef3e065f2dcb6bd1db51e29c62a99dff5cb/specification/batch/resource-manager/Microsoft.Batch/stable/2024-07-01/examples/BatchAccountUpdate.json
func ExampleAccountClient_Update() {
	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().Update(ctx, "default-azurebatch-japaneast", "sampleacct", armbatch.AccountUpdateParameters{
		Properties: &armbatch.AccountUpdateProperties{
			AutoStorage: &armbatch.AutoStorageBaseProperties{
				StorageAccountID: to.Ptr("/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage"),
			},
		},
	}, 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

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

/**
 * This sample demonstrates how to Updates the properties of an existing Batch account.
 *
 * @summary Updates the properties of an existing Batch account.
 * x-ms-original-file: specification/batch/resource-manager/Microsoft.Batch/stable/2024-07-01/examples/BatchAccountUpdate.json
 */
async function batchAccountUpdate() {
  const subscriptionId = process.env["BATCH_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["BATCH_RESOURCE_GROUP"] || "default-azurebatch-japaneast";
  const accountName = "sampleacct";
  const parameters = {
    autoStorage: {
      storageAccountId:
        "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage",
    },
  };
  const credential = new DefaultAzureCredential();
  const client = new BatchManagementClient(credential, subscriptionId);
  const result = await client.batchAccountOperations.update(
    resourceGroupName,
    accountName,
    parameters,
  );
  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

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

// Generated from example definition: specification/batch/resource-manager/Microsoft.Batch/stable/2024-07-01/examples/BatchAccountUpdate.json
// this example is just showing the usage of "BatchAccount_Update" 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
BatchAccountPatch patch = new BatchAccountPatch()
{
    AutoStorage = new BatchAccountAutoStorageBaseConfiguration(new ResourceIdentifier("/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage")),
};
BatchAccountResource result = await batchAccount.UpdateAsync(patch);

// 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

範例回覆

狀態碼:: 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"
}

定義

名稱	Description
AuthenticationMode	Batch 帳戶的驗證模式。
AutoStorageAuthenticationMode	Batch 服務將用來管理自動記憶體帳戶的驗證模式。
AutoStorageBaseProperties	與自動記憶體帳戶相關的屬性。
AutoStorageProperties	包含與 Batch 帳戶相關聯的自動記憶體帳戶相關信息。
BatchAccount	包含 Azure Batch 帳戶的相關信息。
BatchAccountIdentity	如果已設定，則為 Batch 帳戶的身分識別。當使用者指定『Microsoft.KeyVault』作為其 Batch 帳戶加密組態，或選取 `ManagedIdentity` 作為自動儲存驗證模式時，就會使用此選項。
BatchAccountUpdateParameters	更新 Azure Batch 帳戶的參數。
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	VM 系列及其 Batch 帳戶的相關核心配額。

AuthenticationMode

列舉型別

Batch 帳戶的驗證模式。

值	Description
AAD	使用 Microsoft Entra 識別碼的驗證模式。
SharedKey	使用共用金鑰的驗證模式。
TaskAuthenticationToken	使用工作驗證令牌的驗證模式。

AutoStorageAuthenticationMode

列舉型別

Batch 服務將用來管理自動記憶體帳戶的驗證模式。

值	Description
BatchAccountManagedIdentity	Batch 服務會使用指派給 Batch 帳戶的受控識別來驗證對自動記憶體的要求。
StorageKeys	Batch 服務會使用記憶體帳戶密鑰來驗證對自動記憶體的要求。

AutoStorageBaseProperties

Object

與自動記憶體帳戶相關的屬性。

名稱	類型	預設值	Description
authenticationMode	AutoStorageAuthenticationMode	StorageKeys	Batch 服務將用來管理自動記憶體帳戶的驗證模式。
nodeIdentityReference	ComputeNodeIdentityReference		使用者指派身分識別的參考，計算節點將用來存取自動記憶體。此處參考的身分識別必須指派給具有需要存取自動記憶體之計算節點的集區。
storageAccountId	string (arm-id)		要用於自動記憶體帳戶之記憶體帳戶的記憶體帳戶的資源識別碼。

AutoStorageProperties

Object

包含與 Batch 帳戶相關聯的自動記憶體帳戶相關信息。

名稱	類型	預設值	Description
authenticationMode	AutoStorageAuthenticationMode	StorageKeys	Batch 服務將用來管理自動記憶體帳戶的驗證模式。
lastKeySync	string (date-time)		上次同步處理記憶體金鑰與 Batch 帳戶的 UTC 時間。
nodeIdentityReference	ComputeNodeIdentityReference		使用者指派身分識別的參考，計算節點將用來存取自動記憶體。此處參考的身分識別必須指派給具有需要存取自動記憶體之計算節點的集區。
storageAccountId	string (arm-id)		要用於自動記憶體帳戶之記憶體帳戶的記憶體帳戶的資源識別碼。

BatchAccount

Object

包含 Azure Batch 帳戶的相關信息。

名稱	類型	預設值	Description
id	string		資源的標識碼。
identity	BatchAccountIdentity		Batch 帳戶的身分識別。
location	string		資源的位置。
name	string		資源的名稱。
properties.accountEndpoint	string		用來與 Batch 服務互動的帳戶端點。
properties.activeJobAndJobScheduleQuota	integer (int32)		Batch 帳戶的作用中作業和作業排程配額。
properties.allowedAuthenticationModes	AuthenticationMode[]		Batch 帳戶允許的驗證模式清單，可用來向數據平面進行驗證。這不會影響控制平面的驗證。
properties.autoStorage	AutoStorageProperties		與 Batch 帳戶相關聯的任何自動記憶體帳戶的屬性和狀態。包含與 Batch 帳戶相關聯的自動記憶體帳戶相關信息。
properties.dedicatedCoreQuota	integer (int32)		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 (int32)		Batch 帳戶的 Spot/low-priority 核心配額。針對將 PoolAllocationMode 設定為 UserSubscription 的帳戶，訂用帳戶上會管理配額，因此不會傳回此值。
properties.networkProfile	NetworkProfile		Batch 帳戶的網路配置檔，其中包含每個端點的網路規則設定。只有在啟用 publicNetworkAccess 時，網路配置檔才會生效。
properties.nodeManagementEndpoint	string		計算節點用來連線到 Batch 節點管理服務的端點。
properties.poolAllocationMode	PoolAllocationMode		用於在 Batch 帳戶中建立集區的配置模式。在 Batch 帳戶中建立集區的配置模式。
properties.poolQuota	integer (int32)		Batch 帳戶的集區配額。
properties.privateEndpointConnections	PrivateEndpointConnection[]		與 Batch 帳戶相關聯的私人端點連線清單
properties.provisioningState	ProvisioningState		資源的布建狀態
properties.publicNetworkAccess	PublicNetworkAccessType	Enabled	用於存取 Azure Batch 服務和 Batch 帳戶作業的網路介面類型。如果未指定，預設值為 'enabled'。
tags	object		資源的標記。
type	string		資源的型別。

BatchAccountIdentity

Object

如果已設定，則為 Batch 帳戶的身分識別。當使用者指定『Microsoft.KeyVault』作為其 Batch 帳戶加密組態，或選取 ManagedIdentity 作為自動儲存驗證模式時，就會使用此選項。

名稱	類型	Description
principalId	string	Batch 帳戶的主體標識碼。此屬性只會針對系統指派的身分識別提供。
tenantId	string	與 Batch 帳戶相關聯的租用戶標識碼。此屬性只會針對系統指派的身分識別提供。
type	ResourceIdentityType	用於 Batch 帳戶的身分識別類型。
userAssignedIdentities	<string, UserAssignedIdentities>	與 Batch 帳戶相關聯的使用者身分識別清單。

BatchAccountUpdateParameters

Object

更新 Azure Batch 帳戶的參數。

名稱	類型	預設值	Description
identity	BatchAccountIdentity		Batch 帳戶的身分識別。
properties.allowedAuthenticationModes	AuthenticationMode[]		Batch 帳戶允許的驗證模式清單，可用來向數據平面進行驗證。這不會影響控制平面的驗證。
properties.autoStorage	AutoStorageBaseProperties		與自動記憶體帳戶相關的屬性。
properties.encryption	EncryptionProperties		Batch 帳戶的加密組態。設定客戶數據在 Batch 帳戶內加密的方式。根據預設，帳戶會使用Microsoft受控密鑰來加密。如需其他控制，可以改用客戶管理的密鑰。
properties.networkProfile	NetworkProfile		Batch 帳戶的網路配置檔，其中包含每個端點的網路規則設定。只有在啟用 publicNetworkAccess 時，網路配置檔才會生效。
properties.publicNetworkAccess	PublicNetworkAccessType	Enabled	用於存取 Azure Batch 帳戶的網路存取類型。如果未指定，預設值為 'enabled'。
tags	object		與帳戶相關聯的使用者指定標記。

CloudError

Object

Batch 服務的錯誤回應。

名稱	類型	Description
error	CloudErrorBody	錯誤回應的主體。

CloudErrorBody

Object

Batch 服務的錯誤回應。

名稱	類型	Description
code	string	錯誤的識別碼。程序代碼是不變的，而且是要以程序設計方式取用。
details	CloudErrorBody[]	錯誤的其他詳細數據清單。
message	string	描述錯誤的訊息，適用於在使用者介面中顯示。
target	string	特定錯誤的目標。例如，錯誤中的屬性名稱。

ComputeNodeIdentityReference

Object

與計算節點將使用的 Batch 集區相關聯的使用者指派身分識別參考。

名稱	類型	Description
resourceId	string	使用者指派身分識別的 ARM 資源識別碼。

EncryptionProperties

Object

設定客戶數據在 Batch 帳戶內加密的方式。根據預設，帳戶會使用Microsoft受控密鑰來加密。如需其他控制，可以改用客戶管理的密鑰。

名稱	類型	Description
keySource	KeySource	金鑰來源的類型。
keyVaultProperties	KeyVaultProperties	使用 Microsoft.KeyVault 時的其他詳細數據

EndpointAccessDefaultAction

列舉型別

沒有符合IPRule時的預設動作。

值	Description
Allow	允許用戶端存取。
Deny	拒絕用戶端存取。

EndpointAccessProfile

Object

Batch 端點的網路存取配置檔。

名稱	類型	Description
defaultAction	EndpointAccessDefaultAction	沒有符合IPRule時的預設動作。端點存取的預設動作。只有在啟用 publicNetworkAccess 時才適用。
ipRules	IPRule[]	篩選用戶端 IP 位址的 IP 範圍數位。

IPRule

Object

篩選用戶端 IP 位址的規則。

名稱	類型	Description
action	IPRuleAction	比對用戶端IP位址時的動作。
value	string	要篩選的IP位址或IP位址範圍 IPv4 位址或 CIDR 格式的 IPv4 位址範圍。

IPRuleAction

列舉型別

比對用戶端IP位址時的動作。

值	Description
Allow	允許存取相符的用戶端IP位址。

KeySource

列舉型別

金鑰來源的類型。

值	Description
Microsoft.Batch	Batch 會建立和管理用來保護帳戶數據的加密密鑰。
Microsoft.KeyVault	用來保護帳戶數據的加密金鑰會儲存在外部金鑰保存庫中。如果設定此選項，則必須將 Batch 帳戶身分識別設定為 `SystemAssigned`，而且必須在 keyVaultProperties 底下提供有效的密鑰標識碼。

KeyVaultProperties

Object

使用 Microsoft.KeyVault 的加密金鑰來源時，KeyVault 組態。

名稱

類型

Description

keyIdentifier

string

具有或不含版本之秘密的完整路徑。範例 https://mykeyvault.vault.azure.net/keys/testkey/6e34a81fef704045975661e297a4c053。或 https://mykeyvault.vault.azure.net/keys/testkey。若要可供使用，必須符合下列必要條件：

Batch 帳戶具有系統指派的身分識別帳戶身分識別已獲授與密鑰/取得、金鑰/解除包裝和密鑰/包裝許可權 KeyVault 已啟用虛刪除和清除保護

KeyVaultReference

Object

識別與 Batch 帳戶相關聯的 Azure 金鑰保存庫。

名稱	類型	Description
id	string (arm-id)	與 Batch 帳戶相關聯的 Azure 金鑰保存庫資源識別碼。
url	string	與 Batch 帳戶相關聯的 Azure 金鑰保存庫 URL。

NetworkProfile

Object

Batch 帳戶的網路配置檔，其中包含每個端點的網路規則設定。

名稱	類型	Description
accountAccess	EndpointAccessProfile	batchAccount 端點的網路存取配置檔（Batch 帳戶數據平面 API）。
nodeManagementAccess	EndpointAccessProfile	nodeManagement 端點的網路存取配置檔（Batch 服務管理 Batch 集區的計算節點）。

PoolAllocationMode

列舉型別

在 Batch 帳戶中建立集區的配置模式。

值	Description
BatchService	集區將會配置在 Batch 服務所擁有的訂用帳戶中。
UserSubscription	集區將會配置在使用者所擁有的訂用帳戶中。

PrivateEndpoint

Object

私人端點連線的私人端點。

名稱	類型	Description
id	string	私人端點的 ARM 資源識別碼。這是 /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/privateEndpoints/{privateEndpoint}的格式。

PrivateEndpointConnection

Object

包含私人鏈接資源的相關信息。

名稱	類型	Description
etag	string	資源的 ETag，用於並行語句。
id	string	資源的標識碼。
name	string	資源的名稱。
properties.groupIds	string[]	私人端點聯機的群組標識碼。值只有一個且只有一個群組標識符。
properties.privateEndpoint	PrivateEndpoint	私人端點的 ARM 資源識別碼。私人端點連線的私人端點。
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	私人端點連線的私人連結服務連線狀態。私人端點連線的私人連結服務連線狀態
properties.provisioningState	PrivateEndpointConnectionProvisioningState	私人端點聯機的布建狀態。
tags	object	資源的標記。
type	string	資源的型別。

PrivateEndpointConnectionProvisioningState

列舉型別

私人端點聯機的布建狀態。

值	Description
Cancelled	使用者已取消連線建立。
Creating	正在建立連線。
Deleting	線上正在刪除。
Failed	使用者要求更新連線且失敗。您可以重試更新作業。
Succeeded	連線狀態為最終狀態，且已準備好在 [狀態] 為 [已核准] 時使用。
Updating	使用者已要求更新連線狀態，但更新作業尚未完成。連接 Batch 帳戶時，您可能不會參考連線。

PrivateLinkServiceConnectionState

Object

私人端點連線的私人連結服務連線狀態

名稱	類型	Description
actionsRequired	string	私人連線狀態所需的動作
description	string	私人連線狀態的描述
status	PrivateLinkServiceConnectionStatus	Batch 帳戶的私人端點連線狀態

PrivateLinkServiceConnectionStatus

列舉型別

Batch 私人端點連線的狀態

值	Description
Approved	私人端點連線已核准，可用來存取 Batch 帳戶
Disconnected	私人端點連線已中斷連線，無法用來存取 Batch 帳戶
Pending	私人端點連線擱置中，無法用來存取 Batch 帳戶
Rejected	私人端點連線遭到拒絕，無法用來存取 Batch 帳戶

ProvisioningState

列舉型別

資源的布建狀態

值	Description
Cancelled	取消帳戶的最後一個作業。
Creating	正在建立帳戶。
Deleting	正在刪除帳戶。
Failed	帳戶的最後一個作業失敗。
Invalid	帳戶處於無效狀態。
Succeeded	帳戶已建立並可供使用。

PublicNetworkAccessType

列舉型別

在 Batch 帳戶中的資源上操作的網路存取類型。

值	Description
Disabled	停用公用連線，並透過私人端點資源啟用對 Azure Batch Service 的私人連線。
Enabled	允許透過公用 DNS 連線到 Azure Batch。
SecuredByPerimeter	透過 NSP 設定保護與 Azure Batch 的連線。

ResourceIdentityType

列舉型別

用於 Batch 帳戶的身分識別類型。

值	Description
None	Batch 帳戶沒有與其相關聯的身分識別。在更新帳戶中設定 `None` 將會移除現有的身分識別。
SystemAssigned	Batch 帳戶具有系統指派的身分識別。
UserAssigned	Batch 帳戶具有使用者指派的身分識別。

UserAssignedIdentities

Object

相關聯的使用者身分識別清單。

名稱	類型	Description
clientId	string	使用者指派身分識別的用戶端標識碼。
principalId	string	使用者指派身分識別的主體標識碼。

VirtualMachineFamilyCoreQuota

Object

VM 系列及其 Batch 帳戶的相關核心配額。

名稱	類型	Description
coreQuota	integer (int32)	Batch 帳戶 VM 系列的核心配額。
name	string	虛擬機系列名稱。