Pool - Update

リファレンス

サービス:: Batch Management

API バージョン:: 2024-07-01

既存のプールのプロパティを更新します。

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

URI パラメーター

名前	/	必須	型	説明
accountName	path	True	string minLength: 3 maxLength: 24 pattern: ^[a-zA-Z0-9]+$	Batch アカウントの名前。
poolName	path	True	string minLength: 1 maxLength: 64 pattern: ^[a-zA-Z0-9_-]+$	プール名。これはアカウント内で一意である必要があります。
resourceGroupName	path	True	string	Batch アカウントを含むリソースグループの名前。
subscriptionId	path	True	string	Azure サブスクリプション ID。これは GUID 形式の文字列です (例: 000000000-0000-0000-0000-000000000000)
api-version	query	True	string	HTTP 要求で使用される API バージョン。

要求ヘッダー

名前	必須	型	説明
If-Match		string	更新するプールのエンティティ状態 (ETag) バージョン。操作を無条件に適用するには、この値を省略するか、"*" に設定できます。

要求本文

名前	型	説明
identity	BatchPoolIdentity	バッチプールに使用される ID の種類。バッチプールに使用される ID の種類。
properties.applicationLicenses	string[]	Batch サービスがプール内の各コンピューティングノードで使用できるアプリケーションライセンスの一覧。アプリケーションライセンスの一覧は、使用可能な Batch サービスアプリケーションライセンスのサブセットである必要があります。サポートされていないライセンスが要求された場合、プールの作成は失敗します。
properties.applicationPackages	ApplicationPackageReference[]	プール内の各コンピューティングノードにインストールするアプリケーションパッケージの一覧。アプリケーションパッケージ参照に対する変更は、プールに参加しているすべての新しいコンピューティングノードに影響しますが、再起動または再イメージ化されるまで、プール内に既に存在するコンピューティングノードには影響しません。特定のプールには、最大 10 個のアプリケーションパッケージ参照があります。
properties.certificates	CertificateReference[]	プール内の各コンピューティングノードにインストールする証明書の一覧。 Windows コンピューティングノードの場合、Batch サービスは、指定された証明書ストアと場所に証明書をインストールします。 Linux コンピューティングノードの場合、証明書はタスク作業ディレクトリ内のディレクトリに格納され、この場所を照会するためにタスクにAZ_BATCH_CERTIFICATES_DIR環境変数が提供されます。 'remoteUser' の可視性を持つ証明書の場合、ユーザーのホームディレクトリ (/home/{user-name}/certs など) に 'certs' ディレクトリが作成され、そのディレクトリに証明書が配置されます。警告: このプロパティは非推奨であり、2024 年 2 月以降に削除されます。代わりに、Azure KeyVault 拡張機能を使用してください。
properties.deploymentConfiguration	DeploymentConfiguration	このプロパティは、プールノードがデプロイされる仮想マシンについて説明します。
properties.displayName	string	プールの表示名。表示名は一意である必要はありません。最大長 1024 までの Unicode 文字を含めることができます。
properties.interNodeCommunication	InterNodeCommunicationState	プールがノード間の直接通信を許可するかどうか。これにより、プールに割り当てることができるノードに制限が適用されます。この値を有効にすると、要求されたノード数がプールに割り当てられる可能性が低くなります。指定しない場合、この値の既定値は "Disabled" になります。
properties.metadata	MetadataItem[]	メタデータとしてプールに関連付けられている名前と値のペアの一覧。 Batch サービスは、メタデータに意味を割り当てません。これは、ユーザーコードの使用のみを目的とします。
properties.mountConfiguration	MountConfiguration[]	プール内の各ノードにマウントするファイルシステムの一覧。これにより、Azure Files、NFS、CIFS/SMB、Blobfuse がサポートされます。
properties.networkConfiguration	NetworkConfiguration	プールのネットワーク構成。プールのネットワーク構成。
properties.resourceTags	object	プールに関連付けられているユーザー指定のタグ。 Azure Batch プールに関連付けるユーザー定義タグ。これらのタグを指定すると、プールに関連付けられているバッキング Azure リソースにこれらのタグが伝達されます。このプロパティは、poolAllocationMode プロパティが 'UserSubscription' に設定された Batch アカウントが作成された場合にのみ指定できます。
properties.scaleSettings	ScaleSettings	プール内のノード数を構成する設定。プールの目的のサイズを定義します。これは、要求された targetDedicatedNodes が指定されている "fixedScale" か、定期的に再評価される数式を定義する 'autoScale' のいずれかです。このプロパティを指定しない場合、プールは 0 targetDedicatedNodes を使用して固定スケールになります。
properties.startTask	StartTask	プールに参加する各コンピューティングノードで実行するように指定されたタスク。 PATCH (更新) 操作では、このプロパティを空のオブジェクトに設定して、プールから開始タスクを削除できます。
properties.targetNodeCommunicationMode	NodeCommunicationMode	プールの目的のノード通信モード。省略した場合、既定値は Default です。
properties.taskSchedulingPolicy	TaskSchedulingPolicy	タスクをプール内のコンピューティングノード間で分散する方法。指定しない場合、既定値はスプレッドです。
properties.taskSlotsPerNode	integer (int32)	プール内の 1 つのコンピューティングノードで同時実行タスクを実行するために使用できるタスクスロットの数。既定値は 1 です。最大値は、プールの vmSize または 256 のコア数の 4 倍の小さい値です。
properties.upgradePolicy	UpgradePolicy	プールのアップグレードポリシー。アップグレードポリシー (自動、手動、またはローリング) について説明します。
properties.userAccounts	UserAccount[]	プール内の各ノードに作成するユーザーアカウントの一覧。
properties.vmSize	string	プール内の仮想マシンのサイズ。プール内のすべての VM のサイズは同じです。使用可能な VM サイズの詳細については、「Azure の仮想マシンのサイズ (https://learn.microsoft.com/azure/virtual-machines/sizes/overview)」を参照してください。 Batch では、STANDARD_A0と Premium Storage (STANDARD_GS、STANDARD_DS、STANDARD_DSV2 シリーズ) を除くすべての Azure VM サイズがサポートされます。
tags	object	リソースのタグ。

応答

名前	型	説明
200 OK	Pool	操作が成功しました。応答にはプールエンティティが含まれています。ヘッダー ETag: string
Other Status Codes	CloudError	操作が失敗した理由を説明するエラー応答。

名前

型

説明

200 OK

Pool

操作が成功しました。応答にはプールエンティティが含まれています。

ヘッダー

ETag: string

Other Status Codes

CloudError

操作が失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Microsoft Entra OAuth 2.0 認証コードフロー

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザーアカウントを偽装する

例

UpdatePool - Enable Autoscale

UpdatePool - Other Properties

UpdatePool - Remove Start Task

UpdatePool - Resize Pool

UpdatePool - Enable Autoscale

要求のサンプル

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

{
  "properties": {
    "scaleSettings": {
      "autoScale": {
        "formula": "$TargetDedicatedNodes=34"
      }
    }
  }
}


import com.azure.resourcemanager.batch.models.AutoScaleSettings;
import com.azure.resourcemanager.batch.models.Pool;
import com.azure.resourcemanager.batch.models.ScaleSettings;

/**
 * Samples for Pool Update.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/batch/resource-manager/Microsoft.Batch/stable/2024-07-01/examples/PoolUpdate_EnableAutoScale.json
     */
    /**
     * Sample code: UpdatePool - Enable Autoscale.
     * 
     * @param manager Entry point to BatchManager.
     */
    public static void updatePoolEnableAutoscale(com.azure.resourcemanager.batch.BatchManager manager) {
        Pool resource = manager.pools()
            .getWithResponse("default-azurebatch-japaneast", "sampleacct", "testpool", com.azure.core.util.Context.NONE)
            .getValue();
        resource.update()
            .withScaleSettings(
                new ScaleSettings().withAutoScale(new AutoScaleSettings().withFormula("$TargetDedicatedNodes=34")))
            .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 pool_update_enable_auto_scale.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.pool.update(
        resource_group_name="default-azurebatch-japaneast",
        account_name="sampleacct",
        pool_name="testpool",
        parameters={"properties": {"scaleSettings": {"autoScale": {"formula": "$TargetDedicatedNodes=34"}}}},
    )
    print(response)


# x-ms-original-file: specification/batch/resource-manager/Microsoft.Batch/stable/2024-07-01/examples/PoolUpdate_EnableAutoScale.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/PoolUpdate_EnableAutoScale.json
func ExamplePoolClient_Update_updatePoolEnableAutoscale() {
	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.NewPoolClient().Update(ctx, "default-azurebatch-japaneast", "sampleacct", "testpool", armbatch.Pool{
		Properties: &armbatch.PoolProperties{
			ScaleSettings: &armbatch.ScaleSettings{
				AutoScale: &armbatch.AutoScaleSettings{
					Formula: to.Ptr("$TargetDedicatedNodes=34"),
				},
			},
		},
	}, &armbatch.PoolClientUpdateOptions{IfMatch: 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.Pool = armbatch.Pool{
	// 	Name: to.Ptr("testpool"),
	// 	Type: to.Ptr("Microsoft.Batch/batchAccounts/pools"),
	// 	Etag: to.Ptr("W/\"0x8D4EDFEBFADF4AB\""),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool"),
	// 	Properties: &armbatch.PoolProperties{
	// 		AllocationState: to.Ptr(armbatch.AllocationStateResizing),
	// 		AllocationStateTransitionTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-08-29T10:22:55.940Z"); return t}()),
	// 		AutoScaleRun: &armbatch.AutoScaleRun{
	// 			EvaluationTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-08-29T10:22:55.940Z"); return t}()),
	// 			Results: to.Ptr("$TargetDedicatedNodes=34;NodeDeallocationOption=requeue"),
	// 		},
	// 		CreationTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-08-28T10:22:55.940Z"); return t}()),
	// 		CurrentDedicatedNodes: to.Ptr[int32](12),
	// 		CurrentLowPriorityNodes: to.Ptr[int32](0),
	// 		DeploymentConfiguration: &armbatch.DeploymentConfiguration{
	// 			VirtualMachineConfiguration: &armbatch.VirtualMachineConfiguration{
	// 				ImageReference: &armbatch.ImageReference{
	// 					Offer: to.Ptr("WindowsServer"),
	// 					Publisher: to.Ptr("MicrosoftWindowsServer"),
	// 					SKU: to.Ptr("2016-Datacenter-SmallDisk"),
	// 					Version: to.Ptr("latest"),
	// 				},
	// 				NodeAgentSKUID: to.Ptr("batch.node.windows amd64"),
	// 			},
	// 		},
	// 		InterNodeCommunication: to.Ptr(armbatch.InterNodeCommunicationStateDisabled),
	// 		LastModified: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-08-29T10:22:55.940Z"); return t}()),
	// 		ProvisioningState: to.Ptr(armbatch.PoolProvisioningStateSucceeded),
	// 		ProvisioningStateTransitionTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-08-28T10:22:55.940Z"); return t}()),
	// 		ResizeOperationStatus: &armbatch.ResizeOperationStatus{
	// 			NodeDeallocationOption: to.Ptr(armbatch.ComputeNodeDeallocationOptionRequeue),
	// 			ResizeTimeout: to.Ptr("PT15M"),
	// 			StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-08-29T10:22:55.940Z"); return t}()),
	// 			TargetDedicatedNodes: to.Ptr[int32](34),
	// 		},
	// 		ScaleSettings: &armbatch.ScaleSettings{
	// 			AutoScale: &armbatch.AutoScaleSettings{
	// 				EvaluationInterval: to.Ptr("PT15M"),
	// 				Formula: to.Ptr("$TargetDedicated=34"),
	// 			},
	// 		},
	// 		TaskSchedulingPolicy: &armbatch.TaskSchedulingPolicy{
	// 			NodeFillType: to.Ptr(armbatch.ComputeNodeFillTypeSpread),
	// 		},
	// 		TaskSlotsPerNode: to.Ptr[int32](1),
	// 		VMSize: to.Ptr("STANDARD_D4"),
	// 	},
	// }
}

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 pool.
 *
 * @summary Updates the properties of an existing pool.
 * x-ms-original-file: specification/batch/resource-manager/Microsoft.Batch/stable/2024-07-01/examples/PoolUpdate_EnableAutoScale.json
 */
async function updatePoolEnableAutoscale() {
  const subscriptionId = process.env["BATCH_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["BATCH_RESOURCE_GROUP"] || "default-azurebatch-japaneast";
  const accountName = "sampleacct";
  const poolName = "testpool";
  const parameters = {
    scaleSettings: { autoScale: { formula: "$TargetDedicatedNodes=34" } },
  };
  const credential = new DefaultAzureCredential();
  const client = new BatchManagementClient(credential, subscriptionId);
  const result = await client.poolOperations.update(
    resourceGroupName,
    accountName,
    poolName,
    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 System.Xml;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Batch.Models;
using Azure.ResourceManager.Batch;

// Generated from example definition: specification/batch/resource-manager/Microsoft.Batch/stable/2024-07-01/examples/PoolUpdate_EnableAutoScale.json
// this example is just showing the usage of "Pool_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 BatchAccountPoolResource created on azure
// for more information of creating BatchAccountPoolResource, please refer to the document of BatchAccountPoolResource
string subscriptionId = "subid";
string resourceGroupName = "default-azurebatch-japaneast";
string accountName = "sampleacct";
string poolName = "testpool";
ResourceIdentifier batchAccountPoolResourceId = BatchAccountPoolResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, accountName, poolName);
BatchAccountPoolResource batchAccountPool = client.GetBatchAccountPoolResource(batchAccountPoolResourceId);

// invoke the operation
BatchAccountPoolData data = new BatchAccountPoolData()
{
    ScaleSettings = new BatchAccountPoolScaleSettings()
    {
        AutoScale = new BatchAccountAutoScaleSettings("$TargetDedicatedNodes=34"),
    },
};
BatchAccountPoolResource result = await batchAccountPool.UpdateAsync(data);

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

ETag: W/"0x8D4EDFEBFADF4AB"

{
  "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool",
  "name": "testpool",
  "type": "Microsoft.Batch/batchAccounts/pools",
  "etag": "W/\"0x8D4EDFEBFADF4AB\"",
  "properties": {
    "lastModified": "2017-08-29T10:22:55.9407275Z",
    "creationTime": "2017-08-28T10:22:55.9407275Z",
    "provisioningState": "Succeeded",
    "provisioningStateTransitionTime": "2017-08-28T10:22:55.9407275Z",
    "allocationState": "Resizing",
    "allocationStateTransitionTime": "2017-08-29T10:22:55.9407275Z",
    "vmSize": "STANDARD_D4",
    "interNodeCommunication": "Disabled",
    "taskSlotsPerNode": 1,
    "taskSchedulingPolicy": {
      "nodeFillType": "Spread"
    },
    "deploymentConfiguration": {
      "virtualMachineConfiguration": {
        "imageReference": {
          "publisher": "MicrosoftWindowsServer",
          "offer": "WindowsServer",
          "sku": "2016-Datacenter-SmallDisk",
          "version": "latest"
        },
        "nodeAgentSkuId": "batch.node.windows amd64"
      }
    },
    "scaleSettings": {
      "autoScale": {
        "formula": "$TargetDedicated=34",
        "evaluationInterval": "PT15M"
      }
    },
    "autoScaleRun": {
      "evaluationTime": "2017-08-29T10:22:55.9407275Z",
      "results": "$TargetDedicatedNodes=34;NodeDeallocationOption=requeue"
    },
    "currentDedicatedNodes": 12,
    "currentLowPriorityNodes": 0,
    "resizeOperationStatus": {
      "startTime": "2017-08-29T10:22:55.9407275Z",
      "targetDedicatedNodes": 34,
      "nodeDeallocationOption": "Requeue",
      "resizeTimeout": "PT15M"
    }
  }
}

UpdatePool - Other Properties

要求のサンプル

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

{
  "properties": {
    "metadata": [
      {
        "name": "key1",
        "value": "value1"
      }
    ],
    "applicationPackages": [
      {
        "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool/applications/app_1234"
      },
      {
        "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool/applications/app_5678",
        "version": "1.0"
      }
    ],
    "certificates": [
      {
        "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool/certificates/sha1-1234567",
        "storeLocation": "LocalMachine",
        "storeName": "MY"
      }
    ],
    "targetNodeCommunicationMode": "Simplified"
  }
}


import com.azure.resourcemanager.batch.models.ApplicationPackageReference;
import com.azure.resourcemanager.batch.models.CertificateReference;
import com.azure.resourcemanager.batch.models.CertificateStoreLocation;
import com.azure.resourcemanager.batch.models.MetadataItem;
import com.azure.resourcemanager.batch.models.NodeCommunicationMode;
import com.azure.resourcemanager.batch.models.Pool;
import java.util.Arrays;

/**
 * Samples for Pool Update.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/batch/resource-manager/Microsoft.Batch/stable/2024-07-01/examples/PoolUpdate_OtherProperties.json
     */
    /**
     * Sample code: UpdatePool - Other Properties.
     * 
     * @param manager Entry point to BatchManager.
     */
    public static void updatePoolOtherProperties(com.azure.resourcemanager.batch.BatchManager manager) {
        Pool resource = manager.pools()
            .getWithResponse("default-azurebatch-japaneast", "sampleacct", "testpool", com.azure.core.util.Context.NONE)
            .getValue();
        resource.update().withMetadata(Arrays.asList(new MetadataItem().withName("key1").withValue("value1")))
            .withCertificates(Arrays.asList(new CertificateReference().withId(
                "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool/certificates/sha1-1234567")
                .withStoreLocation(CertificateStoreLocation.LOCAL_MACHINE).withStoreName("MY")))
            .withApplicationPackages(Arrays.asList(new ApplicationPackageReference().withId(
                "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool/applications/app_1234"),
                new ApplicationPackageReference().withId(
                    "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool/applications/app_5678")
                    .withVersion("1.0")))
            .withTargetNodeCommunicationMode(NodeCommunicationMode.SIMPLIFIED).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 pool_update_other_properties.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.pool.update(
        resource_group_name="default-azurebatch-japaneast",
        account_name="sampleacct",
        pool_name="testpool",
        parameters={
            "properties": {
                "applicationPackages": [
                    {
                        "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool/applications/app_1234"
                    },
                    {
                        "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool/applications/app_5678",
                        "version": "1.0",
                    },
                ],
                "certificates": [
                    {
                        "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool/certificates/sha1-1234567",
                        "storeLocation": "LocalMachine",
                        "storeName": "MY",
                    }
                ],
                "metadata": [{"name": "key1", "value": "value1"}],
                "targetNodeCommunicationMode": "Simplified",
            }
        },
    )
    print(response)


# x-ms-original-file: specification/batch/resource-manager/Microsoft.Batch/stable/2024-07-01/examples/PoolUpdate_OtherProperties.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/PoolUpdate_OtherProperties.json
func ExamplePoolClient_Update_updatePoolOtherProperties() {
	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.NewPoolClient().Update(ctx, "default-azurebatch-japaneast", "sampleacct", "testpool", armbatch.Pool{
		Properties: &armbatch.PoolProperties{
			ApplicationPackages: []*armbatch.ApplicationPackageReference{
				{
					ID: to.Ptr("/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool/applications/app_1234"),
				},
				{
					ID:      to.Ptr("/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool/applications/app_5678"),
					Version: to.Ptr("1.0"),
				}},
			Certificates: []*armbatch.CertificateReference{
				{
					ID:            to.Ptr("/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool/certificates/sha1-1234567"),
					StoreLocation: to.Ptr(armbatch.CertificateStoreLocationLocalMachine),
					StoreName:     to.Ptr("MY"),
				}},
			Metadata: []*armbatch.MetadataItem{
				{
					Name:  to.Ptr("key1"),
					Value: to.Ptr("value1"),
				}},
			TargetNodeCommunicationMode: to.Ptr(armbatch.NodeCommunicationModeSimplified),
		},
	}, &armbatch.PoolClientUpdateOptions{IfMatch: 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.Pool = armbatch.Pool{
	// 	Name: to.Ptr("testpool"),
	// 	Type: to.Ptr("Microsoft.Batch/batchAccounts/pools"),
	// 	Etag: to.Ptr("W/\"0x8D4EDFEBFADF4AB\""),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool"),
	// 	Properties: &armbatch.PoolProperties{
	// 		AllocationState: to.Ptr(armbatch.AllocationStateResizing),
	// 		AllocationStateTransitionTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-08-29T10:22:55.940Z"); return t}()),
	// 		ApplicationPackages: []*armbatch.ApplicationPackageReference{
	// 			{
	// 				ID: to.Ptr("/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool/applications/app_1234"),
	// 			},
	// 			{
	// 				ID: to.Ptr("/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool/applications/app_5678"),
	// 				Version: to.Ptr("1.0"),
	// 		}},
	// 		AutoScaleRun: &armbatch.AutoScaleRun{
	// 			EvaluationTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-08-29T10:22:55.940Z"); return t}()),
	// 			Results: to.Ptr("$TargetDedicatedNodes=34;NodeDeallocationOption=requeue"),
	// 		},
	// 		Certificates: []*armbatch.CertificateReference{
	// 			{
	// 				ID: to.Ptr("/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool/certificates/sha1-1234567"),
	// 				StoreLocation: to.Ptr(armbatch.CertificateStoreLocationLocalMachine),
	// 				StoreName: to.Ptr("MY"),
	// 				Visibility: []*armbatch.CertificateVisibility{
	// 					to.Ptr(armbatch.CertificateVisibilityStartTask),
	// 					to.Ptr(armbatch.CertificateVisibilityTask),
	// 					to.Ptr(armbatch.CertificateVisibilityRemoteUser)},
	// 			}},
	// 			CreationTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-08-28T10:22:55.940Z"); return t}()),
	// 			CurrentDedicatedNodes: to.Ptr[int32](12),
	// 			CurrentLowPriorityNodes: to.Ptr[int32](0),
	// 			DeploymentConfiguration: &armbatch.DeploymentConfiguration{
	// 				VirtualMachineConfiguration: &armbatch.VirtualMachineConfiguration{
	// 					ImageReference: &armbatch.ImageReference{
	// 						Offer: to.Ptr("WindowsServer"),
	// 						Publisher: to.Ptr("MicrosoftWindowsServer"),
	// 						SKU: to.Ptr("2016-Datacenter-SmallDisk"),
	// 						Version: to.Ptr("latest"),
	// 					},
	// 					NodeAgentSKUID: to.Ptr("batch.node.windows amd64"),
	// 				},
	// 			},
	// 			InterNodeCommunication: to.Ptr(armbatch.InterNodeCommunicationStateDisabled),
	// 			LastModified: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-08-29T10:22:55.940Z"); return t}()),
	// 			Metadata: []*armbatch.MetadataItem{
	// 				{
	// 					Name: to.Ptr("key1"),
	// 					Value: to.Ptr("value1"),
	// 			}},
	// 			ProvisioningState: to.Ptr(armbatch.PoolProvisioningStateSucceeded),
	// 			ProvisioningStateTransitionTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-08-28T10:22:55.940Z"); return t}()),
	// 			ResizeOperationStatus: &armbatch.ResizeOperationStatus{
	// 				NodeDeallocationOption: to.Ptr(armbatch.ComputeNodeDeallocationOptionTaskCompletion),
	// 				ResizeTimeout: to.Ptr("PT8M"),
	// 				StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-08-29T10:22:55.940Z"); return t}()),
	// 				TargetDedicatedNodes: to.Ptr[int32](8),
	// 			},
	// 			ScaleSettings: &armbatch.ScaleSettings{
	// 				FixedScale: &armbatch.FixedScaleSettings{
	// 					NodeDeallocationOption: to.Ptr(armbatch.ComputeNodeDeallocationOptionTaskCompletion),
	// 					ResizeTimeout: to.Ptr("PT8M"),
	// 					TargetDedicatedNodes: to.Ptr[int32](1),
	// 					TargetLowPriorityNodes: to.Ptr[int32](0),
	// 				},
	// 			},
	// 			TargetNodeCommunicationMode: to.Ptr(armbatch.NodeCommunicationModeSimplified),
	// 			TaskSchedulingPolicy: &armbatch.TaskSchedulingPolicy{
	// 				NodeFillType: to.Ptr(armbatch.ComputeNodeFillTypeSpread),
	// 			},
	// 			TaskSlotsPerNode: to.Ptr[int32](1),
	// 			VMSize: to.Ptr("STANDARD_D4"),
	// 		},
	// 	}
}

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 pool.
 *
 * @summary Updates the properties of an existing pool.
 * x-ms-original-file: specification/batch/resource-manager/Microsoft.Batch/stable/2024-07-01/examples/PoolUpdate_OtherProperties.json
 */
async function updatePoolOtherProperties() {
  const subscriptionId = process.env["BATCH_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["BATCH_RESOURCE_GROUP"] || "default-azurebatch-japaneast";
  const accountName = "sampleacct";
  const poolName = "testpool";
  const parameters = {
    applicationPackages: [
      {
        id: "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool/applications/app_1234",
      },
      {
        id: "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool/applications/app_5678",
        version: "1.0",
      },
    ],
    certificates: [
      {
        id: "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool/certificates/sha1-1234567",
        storeLocation: "LocalMachine",
        storeName: "MY",
      },
    ],
    metadata: [{ name: "key1", value: "value1" }],
    targetNodeCommunicationMode: "Simplified",
  };
  const credential = new DefaultAzureCredential();
  const client = new BatchManagementClient(credential, subscriptionId);
  const result = await client.poolOperations.update(
    resourceGroupName,
    accountName,
    poolName,
    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 System.Xml;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Batch.Models;
using Azure.ResourceManager.Batch;

// Generated from example definition: specification/batch/resource-manager/Microsoft.Batch/stable/2024-07-01/examples/PoolUpdate_OtherProperties.json
// this example is just showing the usage of "Pool_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 BatchAccountPoolResource created on azure
// for more information of creating BatchAccountPoolResource, please refer to the document of BatchAccountPoolResource
string subscriptionId = "subid";
string resourceGroupName = "default-azurebatch-japaneast";
string accountName = "sampleacct";
string poolName = "testpool";
ResourceIdentifier batchAccountPoolResourceId = BatchAccountPoolResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, accountName, poolName);
BatchAccountPoolResource batchAccountPool = client.GetBatchAccountPoolResource(batchAccountPoolResourceId);

// invoke the operation
BatchAccountPoolData data = new BatchAccountPoolData()
{
    Metadata =
    {
    new BatchAccountPoolMetadataItem("key1","value1")
    },
    Certificates =
    {
    new BatchCertificateReference(new ResourceIdentifier("/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool/certificates/sha1-1234567"))
    {
    StoreLocation = BatchCertificateStoreLocation.LocalMachine,
    StoreName = "MY",
    }
    },
    ApplicationPackages =
    {
    new BatchApplicationPackageReference(new ResourceIdentifier("/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool/applications/app_1234")),new BatchApplicationPackageReference(new ResourceIdentifier("/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool/applications/app_5678"))
    {
    Version = "1.0",
    }
    },
    TargetNodeCommunicationMode = NodeCommunicationMode.Simplified,
};
BatchAccountPoolResource result = await batchAccountPool.UpdateAsync(data);

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

ETag: W/"0x8D4EDFEBFADF4AB"

{
  "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool",
  "name": "testpool",
  "type": "Microsoft.Batch/batchAccounts/pools",
  "etag": "W/\"0x8D4EDFEBFADF4AB\"",
  "properties": {
    "lastModified": "2017-08-29T10:22:55.9407275Z",
    "creationTime": "2017-08-28T10:22:55.9407275Z",
    "provisioningState": "Succeeded",
    "provisioningStateTransitionTime": "2017-08-28T10:22:55.9407275Z",
    "allocationState": "Resizing",
    "allocationStateTransitionTime": "2017-08-29T10:22:55.9407275Z",
    "vmSize": "STANDARD_D4",
    "interNodeCommunication": "Disabled",
    "taskSlotsPerNode": 1,
    "taskSchedulingPolicy": {
      "nodeFillType": "Spread"
    },
    "deploymentConfiguration": {
      "virtualMachineConfiguration": {
        "imageReference": {
          "publisher": "MicrosoftWindowsServer",
          "offer": "WindowsServer",
          "sku": "2016-Datacenter-SmallDisk",
          "version": "latest"
        },
        "nodeAgentSkuId": "batch.node.windows amd64"
      }
    },
    "scaleSettings": {
      "fixedScale": {
        "targetDedicatedNodes": 1,
        "targetLowPriorityNodes": 0,
        "resizeTimeout": "PT8M",
        "nodeDeallocationOption": "TaskCompletion"
      }
    },
    "autoScaleRun": {
      "evaluationTime": "2017-08-29T10:22:55.9407275Z",
      "results": "$TargetDedicatedNodes=34;NodeDeallocationOption=requeue"
    },
    "currentDedicatedNodes": 12,
    "currentLowPriorityNodes": 0,
    "resizeOperationStatus": {
      "startTime": "2017-08-29T10:22:55.9407275Z",
      "targetDedicatedNodes": 8,
      "nodeDeallocationOption": "TaskCompletion",
      "resizeTimeout": "PT8M"
    },
    "metadata": [
      {
        "name": "key1",
        "value": "value1"
      }
    ],
    "applicationPackages": [
      {
        "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool/applications/app_1234"
      },
      {
        "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool/applications/app_5678",
        "version": "1.0"
      }
    ],
    "certificates": [
      {
        "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool/certificates/sha1-1234567",
        "storeLocation": "LocalMachine",
        "storeName": "MY",
        "visibility": [
          "StartTask",
          "Task",
          "RemoteUser"
        ]
      }
    ],
    "targetNodeCommunicationMode": "Simplified"
  }
}

UpdatePool - Remove Start Task

要求のサンプル

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

{
  "properties": {
    "startTask": {}
  }
}


import com.azure.resourcemanager.batch.models.Pool;
import com.azure.resourcemanager.batch.models.StartTask;

/**
 * Samples for Pool Update.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/batch/resource-manager/Microsoft.Batch/stable/2024-07-01/examples/PoolUpdate_RemoveStartTask.json
     */
    /**
     * Sample code: UpdatePool - Remove Start Task.
     * 
     * @param manager Entry point to BatchManager.
     */
    public static void updatePoolRemoveStartTask(com.azure.resourcemanager.batch.BatchManager manager) {
        Pool resource = manager.pools()
            .getWithResponse("default-azurebatch-japaneast", "sampleacct", "testpool", com.azure.core.util.Context.NONE)
            .getValue();
        resource.update().withStartTask(new StartTask()).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 pool_update_remove_start_task.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.pool.update(
        resource_group_name="default-azurebatch-japaneast",
        account_name="sampleacct",
        pool_name="testpool",
        parameters={"properties": {"startTask": {}}},
    )
    print(response)


# x-ms-original-file: specification/batch/resource-manager/Microsoft.Batch/stable/2024-07-01/examples/PoolUpdate_RemoveStartTask.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/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/PoolUpdate_RemoveStartTask.json
func ExamplePoolClient_Update_updatePoolRemoveStartTask() {
	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.NewPoolClient().Update(ctx, "default-azurebatch-japaneast", "sampleacct", "testpool", armbatch.Pool{
		Properties: &armbatch.PoolProperties{
			StartTask: &armbatch.StartTask{},
		},
	}, &armbatch.PoolClientUpdateOptions{IfMatch: 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.Pool = armbatch.Pool{
	// 	Name: to.Ptr("testpool"),
	// 	Type: to.Ptr("Microsoft.Batch/batchAccounts/pools"),
	// 	Etag: to.Ptr("W/\"0x8D4EDFEBFADF4AB\""),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool"),
	// 	Properties: &armbatch.PoolProperties{
	// 		AllocationState: to.Ptr(armbatch.AllocationStateResizing),
	// 		AllocationStateTransitionTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-08-29T10:22:55.940Z"); return t}()),
	// 		AutoScaleRun: &armbatch.AutoScaleRun{
	// 			EvaluationTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-08-29T10:22:55.940Z"); return t}()),
	// 			Results: to.Ptr("$TargetDedicatedNodes=34;NodeDeallocationOption=requeue"),
	// 		},
	// 		CreationTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-08-28T10:22:55.940Z"); return t}()),
	// 		CurrentDedicatedNodes: to.Ptr[int32](12),
	// 		CurrentLowPriorityNodes: to.Ptr[int32](0),
	// 		DeploymentConfiguration: &armbatch.DeploymentConfiguration{
	// 			VirtualMachineConfiguration: &armbatch.VirtualMachineConfiguration{
	// 				ImageReference: &armbatch.ImageReference{
	// 					Offer: to.Ptr("WindowsServer"),
	// 					Publisher: to.Ptr("MicrosoftWindowsServer"),
	// 					SKU: to.Ptr("2016-Datacenter-SmallDisk"),
	// 					Version: to.Ptr("latest"),
	// 				},
	// 				NodeAgentSKUID: to.Ptr("batch.node.windows amd64"),
	// 			},
	// 		},
	// 		InterNodeCommunication: to.Ptr(armbatch.InterNodeCommunicationStateDisabled),
	// 		LastModified: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-08-29T10:22:55.940Z"); return t}()),
	// 		ProvisioningState: to.Ptr(armbatch.PoolProvisioningStateSucceeded),
	// 		ProvisioningStateTransitionTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-08-28T10:22:55.940Z"); return t}()),
	// 		ResizeOperationStatus: &armbatch.ResizeOperationStatus{
	// 			NodeDeallocationOption: to.Ptr(armbatch.ComputeNodeDeallocationOptionRequeue),
	// 			ResizeTimeout: to.Ptr("PT15M"),
	// 			StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-08-29T10:22:55.940Z"); return t}()),
	// 			TargetDedicatedNodes: to.Ptr[int32](34),
	// 		},
	// 		ScaleSettings: &armbatch.ScaleSettings{
	// 			AutoScale: &armbatch.AutoScaleSettings{
	// 				EvaluationInterval: to.Ptr("PT15M"),
	// 				Formula: to.Ptr("$TargetDedicated=34"),
	// 			},
	// 		},
	// 		TaskSchedulingPolicy: &armbatch.TaskSchedulingPolicy{
	// 			NodeFillType: to.Ptr(armbatch.ComputeNodeFillTypeSpread),
	// 		},
	// 		TaskSlotsPerNode: to.Ptr[int32](1),
	// 		VMSize: to.Ptr("STANDARD_D4"),
	// 	},
	// }
}

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 pool.
 *
 * @summary Updates the properties of an existing pool.
 * x-ms-original-file: specification/batch/resource-manager/Microsoft.Batch/stable/2024-07-01/examples/PoolUpdate_RemoveStartTask.json
 */
async function updatePoolRemoveStartTask() {
  const subscriptionId = process.env["BATCH_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["BATCH_RESOURCE_GROUP"] || "default-azurebatch-japaneast";
  const accountName = "sampleacct";
  const poolName = "testpool";
  const parameters = { startTask: {} };
  const credential = new DefaultAzureCredential();
  const client = new BatchManagementClient(credential, subscriptionId);
  const result = await client.poolOperations.update(
    resourceGroupName,
    accountName,
    poolName,
    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 System.Xml;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Batch.Models;
using Azure.ResourceManager.Batch;

// Generated from example definition: specification/batch/resource-manager/Microsoft.Batch/stable/2024-07-01/examples/PoolUpdate_RemoveStartTask.json
// this example is just showing the usage of "Pool_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 BatchAccountPoolResource created on azure
// for more information of creating BatchAccountPoolResource, please refer to the document of BatchAccountPoolResource
string subscriptionId = "subid";
string resourceGroupName = "default-azurebatch-japaneast";
string accountName = "sampleacct";
string poolName = "testpool";
ResourceIdentifier batchAccountPoolResourceId = BatchAccountPoolResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, accountName, poolName);
BatchAccountPoolResource batchAccountPool = client.GetBatchAccountPoolResource(batchAccountPoolResourceId);

// invoke the operation
BatchAccountPoolData data = new BatchAccountPoolData()
{
    StartTask = new BatchAccountPoolStartTask(),
};
BatchAccountPoolResource result = await batchAccountPool.UpdateAsync(data);

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

ETag: W/"0x8D4EDFEBFADF4AB"

{
  "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool",
  "name": "testpool",
  "type": "Microsoft.Batch/batchAccounts/pools",
  "etag": "W/\"0x8D4EDFEBFADF4AB\"",
  "properties": {
    "lastModified": "2017-08-29T10:22:55.9407275Z",
    "creationTime": "2017-08-28T10:22:55.9407275Z",
    "provisioningState": "Succeeded",
    "provisioningStateTransitionTime": "2017-08-28T10:22:55.9407275Z",
    "allocationState": "Resizing",
    "allocationStateTransitionTime": "2017-08-29T10:22:55.9407275Z",
    "vmSize": "STANDARD_D4",
    "interNodeCommunication": "Disabled",
    "taskSlotsPerNode": 1,
    "taskSchedulingPolicy": {
      "nodeFillType": "Spread"
    },
    "deploymentConfiguration": {
      "virtualMachineConfiguration": {
        "imageReference": {
          "publisher": "MicrosoftWindowsServer",
          "offer": "WindowsServer",
          "sku": "2016-Datacenter-SmallDisk",
          "version": "latest"
        },
        "nodeAgentSkuId": "batch.node.windows amd64"
      }
    },
    "scaleSettings": {
      "autoScale": {
        "formula": "$TargetDedicated=34",
        "evaluationInterval": "PT15M"
      }
    },
    "autoScaleRun": {
      "evaluationTime": "2017-08-29T10:22:55.9407275Z",
      "results": "$TargetDedicatedNodes=34;NodeDeallocationOption=requeue"
    },
    "currentDedicatedNodes": 12,
    "currentLowPriorityNodes": 0,
    "resizeOperationStatus": {
      "startTime": "2017-08-29T10:22:55.9407275Z",
      "targetDedicatedNodes": 34,
      "nodeDeallocationOption": "Requeue",
      "resizeTimeout": "PT15M"
    }
  }
}

UpdatePool - Resize Pool

要求のサンプル

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

{
  "properties": {
    "scaleSettings": {
      "fixedScale": {
        "targetDedicatedNodes": 5,
        "targetLowPriorityNodes": 0,
        "resizeTimeout": "PT8M",
        "nodeDeallocationOption": "TaskCompletion"
      }
    }
  }
}


import com.azure.resourcemanager.batch.models.ComputeNodeDeallocationOption;
import com.azure.resourcemanager.batch.models.FixedScaleSettings;
import com.azure.resourcemanager.batch.models.Pool;
import com.azure.resourcemanager.batch.models.ScaleSettings;
import java.time.Duration;

/**
 * Samples for Pool Update.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/batch/resource-manager/Microsoft.Batch/stable/2024-07-01/examples/PoolUpdate_ResizePool.json
     */
    /**
     * Sample code: UpdatePool - Resize Pool.
     * 
     * @param manager Entry point to BatchManager.
     */
    public static void updatePoolResizePool(com.azure.resourcemanager.batch.BatchManager manager) {
        Pool resource = manager.pools()
            .getWithResponse("default-azurebatch-japaneast", "sampleacct", "testpool", com.azure.core.util.Context.NONE)
            .getValue();
        resource.update()
            .withScaleSettings(new ScaleSettings().withFixedScale(new FixedScaleSettings()
                .withResizeTimeout(Duration.parse("PT8M")).withTargetDedicatedNodes(5).withTargetLowPriorityNodes(0)
                .withNodeDeallocationOption(ComputeNodeDeallocationOption.TASK_COMPLETION)))
            .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 pool_update_resize_pool.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.pool.update(
        resource_group_name="default-azurebatch-japaneast",
        account_name="sampleacct",
        pool_name="testpool",
        parameters={
            "properties": {
                "scaleSettings": {
                    "fixedScale": {
                        "nodeDeallocationOption": "TaskCompletion",
                        "resizeTimeout": "PT8M",
                        "targetDedicatedNodes": 5,
                        "targetLowPriorityNodes": 0,
                    }
                }
            }
        },
    )
    print(response)


# x-ms-original-file: specification/batch/resource-manager/Microsoft.Batch/stable/2024-07-01/examples/PoolUpdate_ResizePool.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/PoolUpdate_ResizePool.json
func ExamplePoolClient_Update_updatePoolResizePool() {
	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.NewPoolClient().Update(ctx, "default-azurebatch-japaneast", "sampleacct", "testpool", armbatch.Pool{
		Properties: &armbatch.PoolProperties{
			ScaleSettings: &armbatch.ScaleSettings{
				FixedScale: &armbatch.FixedScaleSettings{
					NodeDeallocationOption: to.Ptr(armbatch.ComputeNodeDeallocationOptionTaskCompletion),
					ResizeTimeout:          to.Ptr("PT8M"),
					TargetDedicatedNodes:   to.Ptr[int32](5),
					TargetLowPriorityNodes: to.Ptr[int32](0),
				},
			},
		},
	}, &armbatch.PoolClientUpdateOptions{IfMatch: 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.Pool = armbatch.Pool{
	// 	Name: to.Ptr("testpool"),
	// 	Type: to.Ptr("Microsoft.Batch/batchAccounts/pools"),
	// 	Etag: to.Ptr("W/\"0x8D4EDFEBFADF4AB\""),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool"),
	// 	Properties: &armbatch.PoolProperties{
	// 		AllocationState: to.Ptr(armbatch.AllocationStateResizing),
	// 		AllocationStateTransitionTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-08-29T10:22:55.940Z"); return t}()),
	// 		AutoScaleRun: &armbatch.AutoScaleRun{
	// 			EvaluationTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-08-29T10:22:55.940Z"); return t}()),
	// 			Results: to.Ptr("$TargetDedicatedNodes=34;NodeDeallocationOption=requeue"),
	// 		},
	// 		CreationTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-08-28T10:22:55.940Z"); return t}()),
	// 		CurrentDedicatedNodes: to.Ptr[int32](12),
	// 		CurrentLowPriorityNodes: to.Ptr[int32](0),
	// 		DeploymentConfiguration: &armbatch.DeploymentConfiguration{
	// 			VirtualMachineConfiguration: &armbatch.VirtualMachineConfiguration{
	// 				ImageReference: &armbatch.ImageReference{
	// 					Offer: to.Ptr("WindowsServer"),
	// 					Publisher: to.Ptr("MicrosoftWindowsServer"),
	// 					SKU: to.Ptr("2016-Datacenter-SmallDisk"),
	// 					Version: to.Ptr("latest"),
	// 				},
	// 				NodeAgentSKUID: to.Ptr("batch.node.windows amd64"),
	// 			},
	// 		},
	// 		InterNodeCommunication: to.Ptr(armbatch.InterNodeCommunicationStateDisabled),
	// 		LastModified: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-08-29T10:22:55.940Z"); return t}()),
	// 		ProvisioningState: to.Ptr(armbatch.PoolProvisioningStateSucceeded),
	// 		ProvisioningStateTransitionTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-08-28T10:22:55.940Z"); return t}()),
	// 		ResizeOperationStatus: &armbatch.ResizeOperationStatus{
	// 			NodeDeallocationOption: to.Ptr(armbatch.ComputeNodeDeallocationOptionTaskCompletion),
	// 			ResizeTimeout: to.Ptr("PT8M"),
	// 			StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-08-29T10:22:55.940Z"); return t}()),
	// 			TargetDedicatedNodes: to.Ptr[int32](8),
	// 		},
	// 		ScaleSettings: &armbatch.ScaleSettings{
	// 			FixedScale: &armbatch.FixedScaleSettings{
	// 				NodeDeallocationOption: to.Ptr(armbatch.ComputeNodeDeallocationOptionTaskCompletion),
	// 				ResizeTimeout: to.Ptr("PT8M"),
	// 				TargetDedicatedNodes: to.Ptr[int32](1),
	// 				TargetLowPriorityNodes: to.Ptr[int32](0),
	// 			},
	// 		},
	// 		TaskSchedulingPolicy: &armbatch.TaskSchedulingPolicy{
	// 			NodeFillType: to.Ptr(armbatch.ComputeNodeFillTypeSpread),
	// 		},
	// 		TaskSlotsPerNode: to.Ptr[int32](1),
	// 		VMSize: to.Ptr("STANDARD_D4"),
	// 	},
	// }
}

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 pool.
 *
 * @summary Updates the properties of an existing pool.
 * x-ms-original-file: specification/batch/resource-manager/Microsoft.Batch/stable/2024-07-01/examples/PoolUpdate_ResizePool.json
 */
async function updatePoolResizePool() {
  const subscriptionId = process.env["BATCH_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["BATCH_RESOURCE_GROUP"] || "default-azurebatch-japaneast";
  const accountName = "sampleacct";
  const poolName = "testpool";
  const parameters = {
    scaleSettings: {
      fixedScale: {
        nodeDeallocationOption: "TaskCompletion",
        resizeTimeout: "PT8M",
        targetDedicatedNodes: 5,
        targetLowPriorityNodes: 0,
      },
    },
  };
  const credential = new DefaultAzureCredential();
  const client = new BatchManagementClient(credential, subscriptionId);
  const result = await client.poolOperations.update(
    resourceGroupName,
    accountName,
    poolName,
    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 System.Xml;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Batch.Models;
using Azure.ResourceManager.Batch;

// Generated from example definition: specification/batch/resource-manager/Microsoft.Batch/stable/2024-07-01/examples/PoolUpdate_ResizePool.json
// this example is just showing the usage of "Pool_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 BatchAccountPoolResource created on azure
// for more information of creating BatchAccountPoolResource, please refer to the document of BatchAccountPoolResource
string subscriptionId = "subid";
string resourceGroupName = "default-azurebatch-japaneast";
string accountName = "sampleacct";
string poolName = "testpool";
ResourceIdentifier batchAccountPoolResourceId = BatchAccountPoolResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, accountName, poolName);
BatchAccountPoolResource batchAccountPool = client.GetBatchAccountPoolResource(batchAccountPoolResourceId);

// invoke the operation
BatchAccountPoolData data = new BatchAccountPoolData()
{
    ScaleSettings = new BatchAccountPoolScaleSettings()
    {
        FixedScale = new BatchAccountFixedScaleSettings()
        {
            ResizeTimeout = XmlConvert.ToTimeSpan("PT8M"),
            TargetDedicatedNodes = 5,
            TargetLowPriorityNodes = 0,
            NodeDeallocationOption = BatchNodeDeallocationOption.TaskCompletion,
        },
    },
};
BatchAccountPoolResource result = await batchAccountPool.UpdateAsync(data);

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

ETag: W/"0x8D4EDFEBFADF4AB"

{
  "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool",
  "name": "testpool",
  "type": "Microsoft.Batch/batchAccounts/pools",
  "etag": "W/\"0x8D4EDFEBFADF4AB\"",
  "properties": {
    "lastModified": "2017-08-29T10:22:55.9407275Z",
    "creationTime": "2017-08-28T10:22:55.9407275Z",
    "provisioningState": "Succeeded",
    "provisioningStateTransitionTime": "2017-08-28T10:22:55.9407275Z",
    "allocationState": "Resizing",
    "allocationStateTransitionTime": "2017-08-29T10:22:55.9407275Z",
    "vmSize": "STANDARD_D4",
    "interNodeCommunication": "Disabled",
    "taskSlotsPerNode": 1,
    "taskSchedulingPolicy": {
      "nodeFillType": "Spread"
    },
    "deploymentConfiguration": {
      "virtualMachineConfiguration": {
        "imageReference": {
          "publisher": "MicrosoftWindowsServer",
          "offer": "WindowsServer",
          "sku": "2016-Datacenter-SmallDisk",
          "version": "latest"
        },
        "nodeAgentSkuId": "batch.node.windows amd64"
      }
    },
    "scaleSettings": {
      "fixedScale": {
        "targetDedicatedNodes": 1,
        "targetLowPriorityNodes": 0,
        "resizeTimeout": "PT8M",
        "nodeDeallocationOption": "TaskCompletion"
      }
    },
    "autoScaleRun": {
      "evaluationTime": "2017-08-29T10:22:55.9407275Z",
      "results": "$TargetDedicatedNodes=34;NodeDeallocationOption=requeue"
    },
    "currentDedicatedNodes": 12,
    "currentLowPriorityNodes": 0,
    "resizeOperationStatus": {
      "startTime": "2017-08-29T10:22:55.9407275Z",
      "targetDedicatedNodes": 8,
      "nodeDeallocationOption": "TaskCompletion",
      "resizeTimeout": "PT8M"
    }
  }
}

定義

名前	説明
AllocationState	プールのサイズが変更されているかどうか。
ApplicationPackageReference	バッチアカウント内のアプリケーションパッケージへのリンク
AutomaticOSUpgradePolicy	OS の自動アップグレードを実行するために使用される構成パラメーター。
AutoScaleRun	プールの自動スケール式の実行の結果とエラー。
AutoScaleRunError	プールを自動スケールするときに発生したエラー。
AutoScaleSettings	プールの自動スケール設定。
AutoUserScope	自動ユーザーのスコープ
AutoUserSpecification	Batch サービスでタスクを実行する自動ユーザーのパラメーターを指定します。
AzureBlobFileSystemConfiguration	Blobfuse を使用して Azure Storage コンテナーに接続するために使用される情報。
AzureFileShareConfiguration	Azure ファイル共有への接続に使用される情報。
BatchPoolIdentity	Batch プールの ID (構成されている場合)。既存のプールの更新中にプール ID が更新された場合、プールが 0 に縮小された後に作成された新しい VM のみが更新された ID を持ちます
CachingType	ディスクに対して有効にするキャッシュの種類。
CertificateReference	プール内のコンピューティングノードにインストールされる証明書への参照。これは、プールと同じアカウント内に存在する必要があります。
CertificateStoreLocation	証明書をインストールするコンピューティングノード上の証明書ストアの場所。
CertificateVisibility	証明書のプライベートデータにアクセスできるコンピューティングノード上のユーザーアカウント。
CIFSMountConfiguration	CIFS ファイルシステムへの接続に使用される情報。
CloudError	Batch サービスからのエラー応答。
CloudErrorBody	Batch サービスからのエラー応答。
ComputeNodeDeallocationOption	割り当て解除を選択した後のノードとその実行中のタスクの操作を決定します。
ComputeNodeFillType	タスクをコンピューティングノード間で分散する方法。
ComputeNodeIdentityReference	コンピューティングノードが使用する Batch プールに関連付けられているユーザー割り当て ID への参照。
ContainerConfiguration	コンテナーが有効なプールの構成。
ContainerHostBatchBindMountEntry	タスクコンテナーにマウントするパスとマウントモードのエントリ。
ContainerHostDataPath	コンテナータスクのコンテナーにマウントされるパス。
ContainerRegistry	プライベートコンテナーレジストリ。
ContainerType	使用するコンテナーテクノロジ。
ContainerWorkingDirectory	コンテナータスクの作業ディレクトリの場所を示すフラグ。既定値は 'taskWorkingDirectory' です。
DataDisk	プール内のコンピューティングノードに関連付けられているデータディスクによって使用される設定。接続されたデータディスクを使用する場合は、VM 内からディスクをマウントしてフォーマットして使用する必要があります。
DeploymentConfiguration	展開構成プロパティ。
DiffDiskPlacement	プール内のすべての VM のオペレーティングシステムディスクのエフェメラルディスクの配置を指定します。
DiffDiskSettings	仮想マシンで使用されるオペレーティングシステムディスクのエフェメラルディスク設定を指定します。
DiskEncryptionConfiguration	プール内のコンピューティングノードに適用されるディスク暗号化構成。仮想マシンイメージまたは Azure コンピューティングギャラリーイメージを使用して作成された Linux プールでは、ディスク暗号化の構成はサポートされていません。
DiskEncryptionTarget	Batch Service がコンピューティングノードで暗号化するディスクターゲットの一覧
DynamicVNetAssignmentScope	動的 vnet 割り当てのスコープ。
ElevationLevel	ユーザーの昇格レベル。
EnvironmentSetting	タスクプロセスに設定する環境変数。
FixedScaleSettings	プールのスケール設定を修正しました。
ImageReference	カスタム仮想マシンの Azure Virtual Machines Marketplace イメージまたは Azure Image リソースへの参照。 Azure Batch によって検証されたすべての imageReferences の一覧を取得するには、「サポートされているノードエージェント SKU の一覧表示」操作を参照してください。
InboundEndpointProtocol	エンドポイントのプロトコル。
InboundNatPool	Batch プール内のコンピューティングノード上の特定のポートを外部でアドレス指定するために使用できる受信 NAT プール。
InterNodeCommunicationState	プールがノード間の直接通信を許可するかどうか。
IPAddressProvisioningType	Batch プールのパブリック IP アドレスのプロビジョニングの種類。
LinuxUserConfiguration	Linux ノードでユーザーアカウントを作成するために使用されるプロパティ。
LoginMode	ユーザーのログインモード
ManagedDisk
MetadataItem	Batch サービスリソースに関連付けられている名前と値のペア。
MountConfiguration	各ノードにマウントするファイルシステム。
NetworkConfiguration	プールのネットワーク構成。
NetworkSecurityGroupRule	受信エンドポイントに適用するネットワークセキュリティグループルール。
NetworkSecurityGroupRuleAccess	指定した IP アドレス、サブネット範囲、またはタグに対して実行する必要があるアクション。
NFSMountConfiguration	NFS ファイルシステムへの接続に使用される情報。
NodeCommunicationMode	プールが Batch サービスと通信する方法を決定します。
NodePlacementConfiguration	バッチプールのノード配置構成。
NodePlacementPolicyType	プール内のノードを割り当てる配置ポリシー。
OSDisk	仮想マシンのオペレーティングシステムディスクの設定。
Pool	プールに関する情報を格納します。
PoolEndpointConfiguration	プールのエンドポイント構成。
PoolIdentityType	バッチプールに使用される ID の種類。
PoolProvisioningState	プールの現在の状態。
PublicIPAddressConfiguration	プールのネットワーク構成のパブリック IP アドレス構成。
ResizeError	プールのサイズを変更するときに発生したエラー。
ResizeOperationStatus	現在または最後に完了したサイズ変更操作の詳細。
ResourceFile	コンピューティングノードにダウンロードする 1 つのファイルまたは複数のファイル。
RollingUpgradePolicy	ローリングアップグレードの実行中に使用される構成パラメーター。
ScaleSettings	プールのスケール設定
SecurityEncryptionTypes	マネージドディスクの EncryptionType を指定します。 VMGuestState BLOB のみを暗号化する場合は VMGuestStateOnly に、VMGuestState BLOB にファームウェアの状態を保持しない場合は NonPersistedTPM に設定されます。注: 機密 VM にのみ設定でき、機密 VM を使用する場合は必須です。
SecurityProfile	仮想マシンまたは仮想マシンスケールセットのセキュリティプロファイル設定を指定します。
SecurityTypes	仮想マシンの SecurityType を指定します。 UefiSettings を有効にするには、指定した値に設定する必要があります。
ServiceArtifactReference	"最新" イメージバージョンを使用する場合に、スケールセット内のすべての仮想マシンに同じイメージバージョンを設定するために使用されるサービス成果物参照 ID を指定します。
StartTask	コンピューティングノードが Azure Batch サービス内のプールに参加したとき、またはコンピューティングノードが再起動または再イメージ化されたときに実行されるタスク。
StorageAccountType	データディスクまたは OS ディスクの作成に使用するストレージアカウントの種類。
TaskContainerSettings	タスクのコンテナー設定。
TaskSchedulingPolicy	タスクをコンピューティングノード間で分散する方法を指定します。
UefiSettings	仮想マシンの作成時に使用されるセキュアブートや vTPM などのセキュリティ設定を指定します。
UpgradeMode	スケールセット内の仮想マシンへのアップグレードモードを指定します。使用可能な値は次のとおりです。手動 - スケールセット内の仮想マシンへの更新プログラムの適用を制御します。これを行うには、manualUpgrade アクションを使用します。自動 - スケールセット内のすべての仮想マシンが同時に自動的に更新されます。ローリング - スケールセットは、必要に応じて一時停止時間の間にバッチで更新を実行します。
UpgradePolicy	アップグレードポリシー (自動、手動、またはローリング) について説明します。
UserAccount	Azure Batch ノードでユーザーを作成するために使用されるプロパティ。
UserAssignedIdentities	関連付けられているユーザー ID の一覧。
UserIdentity	タスクを実行するユーザー ID の定義。
VirtualMachineConfiguration	Azure Virtual Machines インフラストラクチャに基づくプール内のコンピューティングノードの構成。
VMDiskSecurityProfile	マネージドディスクのセキュリティプロファイル設定を指定します。注: 機密 VM にのみ設定でき、機密 VM を使用する場合に必要です。
VMExtension	仮想マシン拡張機能の構成。
WindowsConfiguration	仮想マシンに適用する Windows オペレーティングシステムの設定。
WindowsUserConfiguration	Windows ノードでユーザーアカウントを作成するために使用されるプロパティ。

AllocationState

列挙

プールのサイズが変更されているかどうか。

値	説明
Resizing	プールのサイズが変更されています。つまり、コンピューティングノードがプールに追加またはプールから削除されます。
Steady	プールのサイズが変更されていません。進行中のプール内のノードの数に変更はありません。プールが作成されたとき、およびノードの数を変更する操作がプールに対して実行されていない場合、プールはこの状態になります。
Stopping	プールのサイズは変更されていましたが、ユーザーはサイズ変更を停止することを要求しましたが、停止要求はまだ完了していません。

ApplicationPackageReference

Object

バッチアカウント内のアプリケーションパッケージへのリンク

名前	型	説明
id	string	インストールするアプリケーションパッケージの ID。これは、プールと同じバッチアカウント内にある必要があります。これは、特定のバージョンへの参照でも、存在する場合は既定のバージョンでもかまいません。
version	string	デプロイするアプリケーションのバージョン。省略すると、既定のバージョンがデプロイされます。これを省略し、このアプリケーションに既定のバージョンが指定されていない場合、要求はエラーコード InvalidApplicationPackageReferences で失敗します。 REST API を直接呼び出す場合、HTTP 状態コードは 409 です。

AutomaticOSUpgradePolicy

Object

OS の自動アップグレードを実行するために使用される構成パラメーター。

名前	型	説明
disableAutomaticRollback	boolean	OS イメージのロールバック機能を無効にする必要があるかどうか。
enableAutomaticOSUpgrade	boolean	新しいバージョンの OS イメージが使用可能になったときに、OS アップグレードをスケールセットインスタンスに自動的に適用するかどうかを示します。 Windows ベースのプールに対してこれが true に設定されている場合、WindowsConfiguration.enableAutomaticUpdates を true に設定することはできません。
osRollingUpgradeDeferral	boolean	タスクを実行している場合は、TVM の OS アップグレードを延期します。
useRollingUpgradePolicy	boolean	自動 OS アップグレード中にローリングアップグレードポリシーを使用するかどうかを示します。 VMSS でポリシーが定義されていない場合、OS の自動アップグレードは既定のポリシーにフォールバックします。

AutoScaleRun

Object

プールの自動スケール式の実行の結果とエラー。

名前	型	説明
error	AutoScaleRunError	評価が失敗した場合に、プールで自動スケール式の評価中に発生したエラーの詳細。
evaluationTime	string (date-time)	自動スケール式が最後に評価された時刻。
results	string	自動スケール式の評価で使用されるすべての変数の最終的な値。各変数値は $variable=value の形式で返され、変数はセミコロンで区切られます。

AutoScaleRunError

Object

プールを自動スケールするときに発生したエラー。

名前	型	説明
code	string	エラーの識別子。コードは不変であり、プログラムで使用することを目的としています。
details	AutoScaleRunError[]	エラーに関する追加の詳細。
message	string	ユーザーインターフェイスでの表示に適したエラーを説明するメッセージ。

AutoScaleSettings

Object

プールの自動スケール設定。

名前	型	説明
evaluationInterval	string (duration)	自動スケールの数式に従ってプールサイズを自動的に調整する時間間隔。省略した場合、既定値は 15 分 (PT15M) です。
formula	string	プール内のコンピューティングノードの必要な数の数式。

AutoUserScope

列挙

自動ユーザーのスコープ

値	説明
Pool	タスクが、プール内のすべてのノードで作成される共通の自動ユーザーアカウントとして実行されるように指定します。
Task	サービスがタスクの新しいユーザーを作成することを指定します。

AutoUserSpecification

Object

Batch サービスでタスクを実行する自動ユーザーのパラメーターを指定します。

名前	型	説明
elevationLevel	ElevationLevel	自動ユーザーの昇格レベル。既定値は nonAdmin です。
scope	AutoUserScope	自動ユーザーのスコープ既定値は Pool です。プールが Windows を実行している場合は、タスク間のより厳密な分離が必要な場合は、Task の値を指定する必要があります。たとえば、タスクが他のタスクに影響を与える可能性のある方法でレジストリを変更する場合や、通常のタスクではアクセスできないが、開始タスクからアクセスできる必要がある証明書がプールで指定されている場合などです。

AzureBlobFileSystemConfiguration

Object

Blobfuse を使用して Azure Storage コンテナーに接続するために使用される情報。

名前	型	説明
accountKey	string	Azure ストレージアカウントキー。このプロパティは、sasKey と ID の両方と相互に排他的です。正確に 1 つを指定する必要があります。
accountName	string	Azure ストレージアカウント名。
blobfuseOptions	string	mount コマンドに渡す追加のコマンドラインオプション。これらは、Windows の "net use" オプションと Linux の "マウント" オプションです。
containerName	string	Azure Blob Storage コンテナー名。
identityReference	ComputeNodeIdentityReference	containerName へのアクセスに使用するユーザー割り当て ID への参照このプロパティは、accountKey と sasKey の両方と相互に排他的です。正確に 1 つを指定する必要があります。
relativeMountPath	string	ファイルシステムがマウントされるコンピューティングノード上の相対パスすべてのファイルシステムは、AZ_BATCH_NODE_MOUNTS_DIR環境変数を介してアクセスできる Batch マウントディレクトリに対して相対的にマウントされます。
sasKey	string	Azure Storage SAS トークン。このプロパティは accountKey と ID の両方と相互に排他的です。正確に 1 つを指定する必要があります。

AzureFileShareConfiguration

Object

Azure ファイル共有への接続に使用される情報。

名前	型	説明
accountKey	string	Azure Storage アカウントキー。
accountName	string	Azure Storage アカウント名。
azureFileUrl	string	Azure Files の URL。これは 'https://{account}.file.core.windows.net/' の形式です。
mountOptions	string	mount コマンドに渡す追加のコマンドラインオプション。これらは、Windows の "net use" オプションと Linux の "マウント" オプションです。
relativeMountPath	string	ファイルシステムがマウントされるコンピューティングノード上の相対パスすべてのファイルシステムは、AZ_BATCH_NODE_MOUNTS_DIR環境変数を介してアクセスできる Batch マウントディレクトリに対して相対的にマウントされます。

BatchPoolIdentity

Object

Batch プールの ID (構成されている場合)。既存のプールの更新中にプール ID が更新された場合、プールが 0 に縮小された後に作成された新しい VM のみが更新された ID を持ちます

名前	型	説明
type	PoolIdentityType	バッチプールに使用される ID の種類。
userAssignedIdentities	<string, UserAssignedIdentities>	Batch プールに関連付けられているユーザー ID の一覧。

CachingType

列挙

ディスクに対して有効にするキャッシュの種類。

値	説明
None	ディスクのキャッシュモードが有効になっていません。
ReadOnly	ディスクのキャッシュモードは読み取り専用です。
ReadWrite	ディスクのキャッシュモードは読み取りと書き込みです。

CertificateReference

Object

プール内のコンピューティングノードにインストールされる証明書への参照。これは、プールと同じアカウント内に存在する必要があります。

名前	型	説明
id	string	プールにインストールする証明書の完全修飾 ID。これは、プールと同じバッチアカウント内にある必要があります。
storeLocation	CertificateStoreLocation	証明書をインストールするコンピューティングノード上の証明書ストアの場所。既定値は currentUser です。このプロパティは、Windows コンピューティングノードで構成されたプールにのみ適用されます。 Linux コンピューティングノードの場合、証明書はタスク作業ディレクトリ内のディレクトリに格納され、この場所を照会するためにタスクにAZ_BATCH_CERTIFICATES_DIR環境変数が提供されます。 'remoteUser' の可視性を持つ証明書の場合、ユーザーのホームディレクトリ (/home/{user-name}/certs など) に 'certs' ディレクトリが作成され、そのディレクトリに証明書が配置されます。
storeName	string	証明書をインストールするコンピューティングノード上の証明書ストアの名前。このプロパティは、Windows コンピューティングノードで構成されたプールにのみ適用されます。一般的なストア名には、My、Root、CA、Trust、Disallowed、TrustedPeople、TrustedPublisher、AuthRoot、AddressBook などがありますが、カスタムストア名も使用できます。既定値は My です。
visibility	CertificateVisibility[]	証明書のプライベートデータにアクセスできるコンピューティングノード上のユーザーアカウント。

CertificateStoreLocation

列挙

証明書をインストールするコンピューティングノード上の証明書ストアの場所。

値	説明
CurrentUser	CurrentUser 証明書ストアに証明書をインストールする必要があります。
LocalMachine	証明書は LocalMachine 証明書ストアにインストールする必要があります。

CertificateVisibility

列挙

証明書のプライベートデータにアクセスできるコンピューティングノード上のユーザーアカウント。

値	説明
RemoteUser	証明書は、ユーザーがノードにリモートでアクセスするユーザーアカウントに表示されます。
StartTask	証明書は、開始タスクが実行されているユーザーアカウントに表示されます。 AutoUser スコープが StartTask と Task の両方のプールである場合、この証明書はタスクにも表示されることに注意してください。
Task	証明書は、ジョブタスクが実行されているユーザーアカウントに表示されます。

CIFSMountConfiguration

Object

CIFS ファイルシステムへの接続に使用される情報。

名前	型	説明
mountOptions	string	mount コマンドに渡す追加のコマンドラインオプション。これらは、Windows の "net use" オプションと Linux の "マウント" オプションです。
password	string	CIFS ファイルシステムに対する認証に使用するパスワード。
relativeMountPath	string	ファイルシステムがマウントされるコンピューティングノード上の相対パスすべてのファイルシステムは、AZ_BATCH_NODE_MOUNTS_DIR環境変数を介してアクセスできる Batch マウントディレクトリに対して相対的にマウントされます。
source	string	マウントするファイルシステムの URI。
userName	string	CIFS ファイルシステムに対する認証に使用するユーザー。

CloudError

Object

Batch サービスからのエラー応答。

名前	型	説明
error	CloudErrorBody	エラー応答の本文。

CloudErrorBody

Object

Batch サービスからのエラー応答。

名前	型	説明
code	string	エラーの識別子。コードは不変であり、プログラムで使用することを目的としています。
details	CloudErrorBody[]	エラーに関する追加の詳細の一覧。
message	string	ユーザーインターフェイスでの表示に適したエラーを説明するメッセージ。
target	string	特定のエラーのターゲット。たとえば、エラーが発生したプロパティの名前です。

ComputeNodeDeallocationOption

列挙

割り当て解除を選択した後のノードとその実行中のタスクの操作を決定します。

値	説明
Requeue	実行中のタスクプロセスを終了し、タスクを再キューします。ノードが使用可能になると、タスクが再度実行されます。タスクが終了したらすぐにノードを削除します。
RetainedData	現在実行中のタスクの完了を許可し、すべてのタスクデータ保持期間の有効期限が切れるのを待ちます。待機中に新しいタスクをスケジュールしない。すべてのタスク保有期間の有効期限が切れたときにノードを削除します。
TaskCompletion	現在実行中のタスクの完了を許可します。待機中に新しいタスクをスケジュールしない。すべてのタスクが完了したら、ノードを削除します。
Terminate	実行中のタスクを終了します。タスクは、終了されたことを示す failureInfo で完了し、もう一度実行されません。タスクが終了したらすぐにノードを削除します。

ComputeNodeFillType

列挙

タスクをコンピューティングノード間で分散する方法。

値	説明
Pack	プール内の次のノードにタスクを割り当てる前に、できるだけ多くのタスク (taskSlotsPerNode) をプール内の各ノードに割り当てる必要があります。
Spread	タスクは、プール内のすべてのノードに均等に割り当てる必要があります。

ComputeNodeIdentityReference

Object

コンピューティングノードが使用する Batch プールに関連付けられているユーザー割り当て ID への参照。

名前	型	説明
resourceId	string	ユーザー割り当て ID の ARM リソース ID。

ContainerConfiguration

Object

コンテナーが有効なプールの構成。

名前	型	説明
containerImageNames	string[]	コンテナーイメージ名のコレクション。これは、"docker pull" に指定される完全なイメージ参照です。イメージが代替レジストリで完全修飾されていない限り、イメージは既定の Docker レジストリから取得されます。
containerRegistries	ContainerRegistry[]	コンテナーをプルできる追加のプライベートレジストリ。資格情報を必要とするプライベートレジストリからイメージをダウンロードする必要がある場合は、これらの資格情報をここで指定する必要があります。
type	ContainerType	使用するコンテナーテクノロジ。

ContainerHostBatchBindMountEntry

Object

タスクコンテナーにマウントするパスとマウントモードのエントリ。

名前	型	説明
isReadOnly	boolean	このソースパスを読み取り専用モードとしてマウントするかどうか。既定値は false (読み取り/書き込みモード) です。 Linux の場合、このパスを読み取り/書き込みモードとしてマウントした場合、コンテナー内のすべてのユーザーがパスの読み取り/書き込みアクセス権を持っているわけではありません。これは、ホスト VM のアクセスに依存します。このパスが読み取り専用でマウントされている場合、コンテナー内のすべてのユーザーはパスを変更できません。
source	ContainerHostDataPath	コンテナー顧客にマウントするパスを選択できます。

ContainerHostDataPath

列挙

コンテナータスクのコンテナーにマウントされるパス。

値	説明
Applications	アプリケーションパス。
JobPrep	ジョブ準備タスクのパス。
Shared	複数インスタンスのタスクがファイルを共有するためのパス。
Startup	開始タスクのパス。
Task	タスクパス。
VfsMounts	パスには、このノードにマウントされているすべての仮想ファイルシステムが含まれています。

ContainerRegistry

Object

プライベートコンテナーレジストリ。

名前	型	説明
identityReference	ComputeNodeIdentityReference	ユーザー名とパスワードではなく、Azure Container Registry へのアクセスに使用するユーザー割り当て ID への参照。コンピューティングノードが使用する Batch プールに関連付けられているユーザー割り当て ID への参照。
password	string	レジストリサーバーにログインするためのパスワード。
registryServer	string	レジストリ URL。省略した場合、既定値は "docker.io" です。
username	string	レジストリサーバーにログインするユーザー名。

ContainerType

列挙

使用するコンテナーテクノロジ。

値	説明
CriCompatible	CRI ベースのテクノロジを使用して、コンテナーを起動します。
DockerCompatible	Docker と互換性のあるコンテナーテクノロジを使用して、コンテナーを起動します。

ContainerWorkingDirectory

列挙

コンテナータスクの作業ディレクトリの場所を示すフラグ。既定値は 'taskWorkingDirectory' です。

値	説明
ContainerImageDefault	コンテナーイメージを使用して作業ディレクトリを定義します。このディレクトリには、Batch によってダウンロードされたリソースファイルが含まれていないことに注意してください。
TaskWorkingDirectory	標準の Batch サービスタスク作業ディレクトリを使用します。このディレクトリには、Batch によって設定されたタスクリソースファイルが含まれます。

DataDisk

Object

プール内のコンピューティングノードに関連付けられているデータディスクによって使用される設定。接続されたデータディスクを使用する場合は、VM 内からディスクをマウントしてフォーマットして使用する必要があります。

名前	型	説明
caching	CachingType	データディスクに対して有効にするキャッシュの種類。値は次のとおりです。 none - ディスクのキャッシュモードが有効になっていません。 readOnly - ディスクのキャッシュモードは読み取り専用です。 readWrite - ディスクのキャッシュモードは読み取りと書き込みです。キャッシュの既定値は none です。キャッシュオプションの詳細については、「https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/」を参照してください。
diskSizeGB	integer (int32)	新しいデータディスクを作成するときの初期ディスクサイズ (GB)。
lun	integer (int32)	論理ユニット番号。 lun は、各データディスクを一意に識別するために使用されます。複数のディスクを接続する場合は、それぞれ個別の LUN が必要です。値は、0 ~ 63 の範囲である必要があります。
storageAccountType	StorageAccountType	データディスクに使用するストレージアカウントの種類。省略した場合、既定値は "Standard_LRS" です。値は次のとおりです。 Standard_LRS - データディスクは、標準のローカル冗長ストレージを使用する必要があります。 Premium_LRS - データディスクでは、Premium ローカル冗長ストレージを使用する必要があります。

DeploymentConfiguration

Object

展開構成プロパティ。

名前	型	説明
virtualMachineConfiguration	VirtualMachineConfiguration	プールの仮想マシン構成。

DiffDiskPlacement

列挙

プール内のすべての VM のオペレーティングシステムディスクのエフェメラルディスクの配置を指定します。

値	説明
CacheDisk	エフェメラル OS ディスクは VM キャッシュに格納されます。

DiffDiskSettings

Object

仮想マシンで使用されるオペレーティングシステムディスクのエフェメラルディスク設定を指定します。

名前	型	説明
placement	DiffDiskPlacement	プール内のすべての VM のオペレーティングシステムディスクのエフェメラルディスクの配置を指定します。このプロパティは、オペレーティングシステムを配置する場所を選択する要求でユーザーが使用できます。たとえば、エフェメラル OS ディスクプロビジョニング用のキャッシュディスク領域などです。エフェメラル OS ディスクサイズの要件の詳細については、https://learn.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements の Windows VM と https://learn.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirementsの Linux VM のエフェメラル OS ディスクサイズ要件に関するページを参照してください。

DiskEncryptionConfiguration

Object

プール内のコンピューティングノードに適用されるディスク暗号化構成。仮想マシンイメージまたは Azure コンピューティングギャラリーイメージを使用して作成された Linux プールでは、ディスク暗号化の構成はサポートされていません。

名前	型	説明
targets	DiskEncryptionTarget[]	Batch Service がコンピューティングノードで暗号化するディスクターゲットの一覧 Linux プールでは、"TemporaryDisk" のみがサポートされています。Windows プールでは、"OsDisk" と "TemporaryDisk" を指定する必要があります。

DiskEncryptionTarget

列挙

Batch Service がコンピューティングノードで暗号化するディスクターゲットの一覧

値	説明
OsDisk	コンピューティングノード上の OS ディスクは暗号化されます。
TemporaryDisk	コンピューティングノード上の一時ディスクは暗号化されます。 Linux では、起動時に暗号化が行われると、この暗号化は他のパーティション (マウントされたデータディスク上のパーティションなど) に適用されます。

DynamicVNetAssignmentScope

列挙

動的 vnet 割り当てのスコープ。

値	説明
job	動的 VNet の割り当てはジョブごとに実行されます。この値を設定する場合は、ネットワーク構成サブネット ID も設定する必要があります。この機能は、使用前に承認が必要です。サポートにお問い合わせください
none	動的 VNet 割り当てが有効になっていません。

ElevationLevel

列挙

ユーザーの昇格レベル。

値	説明
Admin	ユーザーは昇格されたアクセス権を持つユーザーであり、完全な管理者権限で動作します。
NonAdmin	ユーザーは、昇格されたアクセス権を持たない標準ユーザーです。

EnvironmentSetting

Object

タスクプロセスに設定する環境変数。

名前	型	説明
name	string	環境変数の名前。
value	string	環境変数の値。

FixedScaleSettings

Object

プールのスケール設定を修正しました。

名前	型	規定値	説明
nodeDeallocationOption	ComputeNodeDeallocationOption		プールサイズが減少している場合にノードとその実行中のタスクを処理する方法を決定します。省略した場合、既定値は Requeue です。
resizeTimeout	string (duration)	PT15M	プールへのコンピューティングノードの割り当てのタイムアウト。既定値は 15 分です。タイムアウト値は ISO 8601 形式を使用します。たとえば、PT10M を 10 分間使用します。最小値は 5 分です。 5 分未満の値を指定した場合、Batch サービスはエラーで要求を拒否します。REST API を直接呼び出す場合、HTTP 状態コードは 400 (無効な要求) です。
targetDedicatedNodes	integer (int32)		プール内の専用コンピューティングノードの目的の数。 targetDedicatedNodes のうち少なくとも 1 つ、targetLowPriorityNodes を設定する必要があります。
targetLowPriorityNodes	integer (int32)		プール内のスポット/優先順位の低いコンピューティングノードの目的の数。 targetDedicatedNodes のうち少なくとも 1 つ、targetLowPriorityNodes を設定する必要があります。

ImageReference

Object

カスタム仮想マシンの Azure Virtual Machines Marketplace イメージまたは Azure Image リソースへの参照。 Azure Batch によって検証されたすべての imageReferences の一覧を取得するには、「サポートされているノードエージェント SKU の一覧表示」操作を参照してください。

名前	型	説明
communityGalleryImageId	string	コミュニティギャラリーイメージの一意識別子このプロパティは他のプロパティと相互に排他的であり、コミュニティギャラリーイメージの GET 呼び出しからフェッチできます。
id	string	Azure コンピューティングギャラリーイメージの ARM リソース識別子。プール内のコンピューティングノードは、このイメージ ID を使用して作成されます。これは、/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName}/versions/{versionId} の形式です。このプロパティは、他のプロパティと相互に排他的です。 Azure コンピューティングギャラリーイメージには、Azure Batch アカウントと同じリージョンにレプリカが必要です。 Batch ノードエージェントが Batch サービスと通信するためのファイアウォール設定については、https://learn.microsoft.com/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configurationを参照してください。
offer	string	Azure Virtual Machines Marketplace イメージのオファーの種類。たとえば、UbuntuServer や WindowsServer などです。
publisher	string	Azure Virtual Machines Marketplace イメージの発行元。たとえば、Canonical または MicrosoftWindowsServer です。
sharedGalleryImageId	string	共有ギャラリーイメージの一意識別子このプロパティは他のプロパティと相互に排他的であり、共有ギャラリーイメージの GET 呼び出しからフェッチできます。
sku	string	Azure Virtual Machines Marketplace イメージの SKU。たとえば、18.04-LTS や 2022-datacenter などです。
version	string	Azure Virtual Machines Marketplace イメージのバージョン。 "latest" の値を指定して、イメージの最新バージョンを選択できます。省略した場合、既定値は 'latest' です。

InboundEndpointProtocol

列挙

エンドポイントのプロトコル。

値	説明
TCP	エンドポイントには TCP を使用します。
UDP	エンドポイントには UDP を使用します。

InboundNatPool

Object

Batch プール内のコンピューティングノード上の特定のポートを外部でアドレス指定するために使用できる受信 NAT プール。

名前	型	説明
backendPort	integer (int32)	コンピューティングノードのポート番号。これは Batch プール内で一意である必要があります。 29876 から 29877 を除き、使用可能な値は 1 から 65535 の間です。これらは予約されています。予約された値が指定された場合、要求は HTTP 状態コード 400 で失敗します。
frontendPortRangeEnd	integer (int32)	個々のコンピューティングノードで backendPort への受信アクセスを提供するために使用される外部ポートの範囲内の最後のポート番号。指定できる値の範囲は 1 ~ 65534 です。ただし、Batch サービスによって予約されているポートは 50000 ~ 55000 です。プール内のすべての範囲は個別である必要があり、重複することはできません。予約された値または重複する値が指定されている場合、要求は HTTP 状態コード 400 で失敗します。
frontendPortRangeStart	integer (int32)	個々のコンピューティングノードで backendPort への受信アクセスを提供するために使用される外部ポートの範囲内の最初のポート番号。使用可能な値の範囲は 1 ~ 65534 です。ただし、予約されているポートは 50000 ~ 55000 です。プール内のすべての範囲は個別である必要があり、重複することはできません。予約された値または重複する値が指定されている場合、要求は HTTP 状態コード 400 で失敗します。
name	string	エンドポイントの名前。名前は Batch プール内で一意である必要があり、文字、数字、アンダースコア、ピリオド、ハイフンを含めることができます。名前は文字または数字で始まる必要があり、末尾は文字、数字、またはアンダースコアで終わる必要があり、77 文字を超えることはできません。無効な値が指定された場合、要求は HTTP 状態コード 400 で失敗します。
networkSecurityGroupRules	NetworkSecurityGroupRule[]	エンドポイントに適用されるネットワークセキュリティグループ規則の一覧。 Batch プール上のすべてのエンドポイントで指定できるルールの最大数は 25 です。ネットワークセキュリティグループの規則が指定されていない場合は、指定された backendPort への受信アクセスを許可する既定の規則が作成されます。ネットワークセキュリティグループ規則の最大数を超えた場合、要求は HTTP 状態コード 400 で失敗します。
protocol	InboundEndpointProtocol	エンドポイントのプロトコル。

InterNodeCommunicationState

列挙

プールがノード間の直接通信を許可するかどうか。

値	説明
Disabled	仮想マシン間のネットワーク通信を無効にします。
Enabled	仮想マシン間のネットワーク通信を有効にします。

IPAddressProvisioningType

列挙

Batch プールのパブリック IP アドレスのプロビジョニングの種類。

値	説明
BatchManaged	パブリック IP は Batch によって作成および管理されます。プールのサイズによっては、複数のパブリック IP が存在する場合があります。
NoPublicIPAddresses	プール内のコンピューティングノードのパブリック IP アドレスは作成されません。
UserManaged	パブリック IP はユーザーによって提供され、コンピューティングノードのプロビジョニングに使用されます。

LinuxUserConfiguration

Object

Linux ノードでユーザーアカウントを作成するために使用されるプロパティ。

名前	型	説明
gid	integer (int32)	ユーザーアカウントのグループ ID。 uid プロパティと gid プロパティは、一緒に指定するか、まったく指定しない必要があります。指定しない場合、基になるオペレーティングシステムは gid を選択します。
sshPrivateKey	string	ユーザーアカウントの SSH 秘密キー。秘密キーはパスワードで保護しないでください。この秘密キーは、プールの enableInterNodeCommunication プロパティが true の場合 (enableInterNodeCommunication が false の場合は無視されます)、Linux プール内のノード間で SSH の非対称キーベースの認証を自動的に構成するために使用されます。これを行うには、キーペアをユーザーの .ssh ディレクトリに配置します。指定しない場合、ノード間でパスワードレス SSH は構成されません (ユーザーの .ssh ディレクトリの変更は行われません)。
uid	integer (int32)	ユーザーアカウントのユーザー ID。 uid プロパティと gid プロパティは、一緒に指定するか、まったく指定しない必要があります。指定しない場合、基になるオペレーティングシステムは uid を選択します。

LoginMode

列挙

ユーザーのログインモード

値	説明
Batch	LOGON32_LOGON_BATCH Win32 ログインモード。バッチログインモードは、実行時間の長い並列プロセスに推奨されます。
Interactive	LOGON32_LOGON_INTERACTIVE Win32 ログインモード。一部のアプリケーションでは、対話型ログインモードに関連付けられたアクセス許可が必要です。タスクで使用するアプリケーションの場合は、このオプションをお勧めします。

ManagedDisk

Object

名前	型	説明
securityProfile	VMDiskSecurityProfile	マネージドディスクのセキュリティプロファイルを指定します。マネージドディスクのセキュリティプロファイル設定を指定します。注: 機密 VM にのみ設定でき、機密 VM を使用する場合に必要です。
storageAccountType	StorageAccountType	マネージドディスクのストレージアカウントの種類。

MetadataItem

Object

Batch サービスリソースに関連付けられている名前と値のペア。

名前	型	説明
name	string	メタデータ項目の名前。
value	string	メタデータ項目の値。

MountConfiguration

Object

各ノードにマウントするファイルシステム。

名前	型	説明
azureBlobFileSystemConfiguration	AzureBlobFileSystemConfiguration	各ノードで BLOB FUSE を使用してマウントする Azure Storage コンテナー。このプロパティは、他のすべてのプロパティと相互に排他的です。
azureFileShareConfiguration	AzureFileShareConfiguration	各ノードにマウントする Azure ファイル共有。このプロパティは、他のすべてのプロパティと相互に排他的です。
cifsMountConfiguration	CIFSMountConfiguration	各ノードにマウントする CIFS/SMB ファイルシステム。このプロパティは、他のすべてのプロパティと相互に排他的です。
nfsMountConfiguration	NFSMountConfiguration	各ノードにマウントする NFS ファイルシステム。このプロパティは、他のすべてのプロパティと相互に排他的です。

NetworkConfiguration

Object

プールのネットワーク構成。

名前	型	規定値	説明
dynamicVnetAssignmentScope	DynamicVNetAssignmentScope	none	動的 vnet 割り当てのスコープ。
enableAcceleratedNetworking	boolean		このプールで高速ネットワークを有効にする必要があるかどうか。高速ネットワークにより、VM への単一ルート I/O 仮想化 (SR-IOV) が可能になり、ネットワークパフォーマンスが向上する可能性があります。詳細については、https://learn.microsoft.com/azure/virtual-network/accelerated-networking-overviewを参照してください。
endpointConfiguration	PoolEndpointConfiguration		Batch プール内のコンピューティングノード上のエンドポイントの構成。
publicIPAddressConfiguration	PublicIPAddressConfiguration		Batch プール内のコンピューティングノードのパブリック IP アドレス構成。プールのネットワーク構成のパブリック IP アドレス構成。
subnetId	string		プールのコンピューティングノードが参加する仮想ネットワークサブネットの ARM リソース識別子。これは、/subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet} の形式です。仮想ネットワークは、Azure Batch アカウントと同じリージョンとサブスクリプションに存在する必要があります。指定されたサブネットには、プール内のノード数に対応できる十分な空き IP アドレスが必要です。サブネットに十分な空き IP アドレスがない場合、プールはコンピューティングノードを部分的に割り当て、サイズ変更エラーが発生します。 "MicrosoftAzureBatch" サービスプリンシパルには、指定された VNet の "クラシック仮想マシン共同作成者" Role-Based アクセス制御 (RBAC) ロールが必要です。指定したサブネットでは、コンピューティングノードでタスクをスケジュールできるように、Azure Batch サービスからの通信を許可する必要があります。これは、指定された VNet にネットワークセキュリティグループ (NSG) が関連付けられているかどうかを確認することで確認できます。指定したサブネット内のコンピューティングノードへの通信が NSG によって拒否された場合、Batch サービスはコンピューティングノードの状態を使用不可に設定します。指定した VNet にネットワークセキュリティグループ (NSG) が関連付けられている場合は、ポート 29876 と 29877 を含む、受信通信用にいくつかの予約済みシステムポートを有効にする必要があります。また、ポート 443 で Azure Storage への送信接続を有効にします。詳細については、次を参照してください: https://learn.microsoft.com/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration

NetworkSecurityGroupRule

Object

受信エンドポイントに適用するネットワークセキュリティグループルール。

名前	型	説明
access	NetworkSecurityGroupRuleAccess	指定した IP アドレス、サブネット範囲、またはタグに対して実行する必要があるアクション。
priority	integer (int32)	このルールの優先順位。プール内の優先順位は一意である必要があり、優先順位の順に評価されます。数値が小さい方が優先度が高くなります。たとえば、順序番号が 150、250、350 のルールを指定できます。順序番号が 150 のルールは、順序が 250 のルールよりも優先されます。許可される優先順位は 150 から 4096 です。予約された値または重複する値が指定されている場合、要求は HTTP 状態コード 400 で失敗します。
sourceAddressPrefix	string	ルールに一致する送信元アドレスプレフィックスまたはタグ。有効な値は、1 つの IP アドレス (10.10.10.10.10)、IP サブネット (つまり 192.168.1.0/24)、既定のタグ、または * (すべてのアドレスの場合) です。その他の値が指定されている場合、要求は HTTP 状態コード 400 で失敗します。
sourcePortRanges	string[]	規則に一致するソースポートの範囲。有効な値は、'' (すべてのポート 0 から 65535) またはポートまたはポート範囲の配列 (つまり、100 から 200) です。ポートは 0 ~ 65535 の範囲にする必要があり、ポート範囲またはポートは重複できません。その他の値が指定されている場合、要求は HTTP 状態コード 400 で失敗します。既定値はです。

NetworkSecurityGroupRuleAccess

列挙

指定した IP アドレス、サブネット範囲、またはタグに対して実行する必要があるアクション。

値	説明
Allow	アクセスを許可します。
Deny	アクセスを拒否します。

NFSMountConfiguration

Object

NFS ファイルシステムへの接続に使用される情報。

名前	型	説明
mountOptions	string	mount コマンドに渡す追加のコマンドラインオプション。これらは、Windows の "net use" オプションと Linux の "マウント" オプションです。
relativeMountPath	string	ファイルシステムがマウントされるコンピューティングノード上の相対パスすべてのファイルシステムは、AZ_BATCH_NODE_MOUNTS_DIR環境変数を介してアクセスできる Batch マウントディレクトリに対して相対的にマウントされます。
source	string	マウントするファイルシステムの URI。

NodeCommunicationMode

列挙

プールが Batch サービスと通信する方法を決定します。

値	説明
Classic	クラシック通信モードを使用するノードでは、"BatchNodeManagement" からのポート 29876 と 29877 の受信 TCP 通信が必要です。{region}" サービスタグとポート 443 の "Storage.region" および "BatchNodeManagement" への送信 TCP 通信。{region}" サービスタグ。
Default	ノード通信モードは、Batch サービスによって自動的に設定されます。
Simplified	簡易通信モードを使用するノードでは、ポート 443 で "BatchNodeManagement" への送信 TCP 通信が必要です。{region}" サービスタグ。開いている受信ポートは必要ありません。

NodePlacementConfiguration

Object

バッチプールのノード配置構成。

名前	型	説明
policy	NodePlacementPolicyType	Batch プールでのノード配置ポリシーの種類。ノードをプロビジョニングするために Batch Service によって使用される割り当てポリシー。指定しない場合、Batch はリージョンポリシーを使用します。

NodePlacementPolicyType

列挙

プール内のノードを割り当てる配置ポリシー。

値	説明
Regional	プール内のすべてのノードは、同じリージョンに割り当てられます。
Zonal	プール内のノードは、ベストエフォート分散によって異なるゾーンに分散されます。

OSDisk

Object

仮想マシンのオペレーティングシステムディスクの設定。

名前	型	説明
caching	CachingType	キャッシュ要件を指定します。使用できる値は None、ReadOnly、ReadWrite です。既定値は、Standard Storage の場合は [なし] です。 Premium Storage の ReadOnly。
diskSizeGB	integer (int32)	新しい OS ディスクを作成するときの初期ディスクサイズ (GB)。
ephemeralOSDiskSettings	DiffDiskSettings	仮想マシンで使用されるオペレーティングシステムディスクのエフェメラルディスク設定を指定します。
managedDisk	ManagedDisk	マネージドディスクのパラメーター。
writeAcceleratorEnabled	boolean	ディスクで writeAccelerator を有効または無効にするかどうかを指定します。

Pool

Object

プールに関する情報を格納します。

名前	型	規定値	説明
etag	string		コンカレンシーステートメントに使用されるリソースの ETag。
id	string		リソースの ID。
identity	BatchPoolIdentity		バッチプールに使用される ID の種類。バッチプールに使用される ID の種類。
name	string		リソースの名前。
properties.allocationState	AllocationState		プールのサイズが変更されているかどうか。
properties.allocationStateTransitionTime	string (date-time)		プールが現在の割り当て状態になった時刻。
properties.applicationLicenses	string[]		Batch サービスがプール内の各コンピューティングノードで使用できるアプリケーションライセンスの一覧。アプリケーションライセンスの一覧は、使用可能な Batch サービスアプリケーションライセンスのサブセットである必要があります。サポートされていないライセンスが要求された場合、プールの作成は失敗します。
properties.applicationPackages	ApplicationPackageReference[]		プール内の各コンピューティングノードにインストールするアプリケーションパッケージの一覧。アプリケーションパッケージ参照に対する変更は、プールに参加しているすべての新しいコンピューティングノードに影響しますが、再起動または再イメージ化されるまで、プール内に既に存在するコンピューティングノードには影響しません。特定のプールには、最大 10 個のアプリケーションパッケージ参照があります。
properties.autoScaleRun	AutoScaleRun		自動スケール式の最後の実行の結果とエラー。このプロパティは、プールが自動的にスケーリングされる場合、つまり autoScaleSettings が使用される場合にのみ設定されます。
properties.certificates	CertificateReference[]		プール内の各コンピューティングノードにインストールする証明書の一覧。 Windows コンピューティングノードの場合、Batch サービスは、指定された証明書ストアと場所に証明書をインストールします。 Linux コンピューティングノードの場合、証明書はタスク作業ディレクトリ内のディレクトリに格納され、この場所を照会するためにタスクにAZ_BATCH_CERTIFICATES_DIR環境変数が提供されます。 'remoteUser' の可視性を持つ証明書の場合、ユーザーのホームディレクトリ (/home/{user-name}/certs など) に 'certs' ディレクトリが作成され、そのディレクトリに証明書が配置されます。警告: このプロパティは非推奨であり、2024 年 2 月以降に削除されます。代わりに、Azure KeyVault 拡張機能を使用してください。
properties.creationTime	string (date-time)		プールの作成時刻。
properties.currentDedicatedNodes	integer (int32)		プール内の現在の専用コンピューティングノードの数。
properties.currentLowPriorityNodes	integer (int32)		プール内の現在のスポット/優先順位の低いコンピューティングノードの数。
properties.currentNodeCommunicationMode	NodeCommunicationMode		プール通信モードの現在の状態。
properties.deploymentConfiguration	DeploymentConfiguration		このプロパティは、プールノードがデプロイされる仮想マシンについて説明します。
properties.displayName	string		プールの表示名。表示名は一意である必要はありません。最大長 1024 までの Unicode 文字を含めることができます。
properties.interNodeCommunication	InterNodeCommunicationState		プールがノード間の直接通信を許可するかどうか。これにより、プールに割り当てることができるノードに制限が適用されます。この値を有効にすると、要求されたノード数がプールに割り当てられる可能性が低くなります。指定しない場合、この値の既定値は "Disabled" になります。
properties.lastModified	string (date-time)		プールの最終変更時刻。これは、targetDedicatedNodes や autoScaleSettings などのプールレベルのデータが最後に変更された時刻です。コンピューティングノードの状態の変化など、ノードレベルの変更は考慮されません。
properties.metadata	MetadataItem[]		メタデータとしてプールに関連付けられている名前と値のペアの一覧。 Batch サービスは、メタデータに意味を割り当てません。これは、ユーザーコードの使用のみを目的とします。
properties.mountConfiguration	MountConfiguration[]		プール内の各ノードにマウントするファイルシステムの一覧。これにより、Azure Files、NFS、CIFS/SMB、Blobfuse がサポートされます。
properties.networkConfiguration	NetworkConfiguration		プールのネットワーク構成。プールのネットワーク構成。
properties.provisioningState	PoolProvisioningState		プールの現在の状態。
properties.provisioningStateTransitionTime	string (date-time)		プールが現在の状態になった時刻。
properties.resizeOperationStatus	ResizeOperationStatus		現在または最後に完了したサイズ変更操作に関する詳細が含まれます。現在の操作 (プール AllocationState がサイズ変更中の場合) または以前に完了した操作 (AllocationState が安定している場合) について説明します。
properties.resourceTags	object		プールに関連付けられているユーザー指定のタグ。 Azure Batch プールに関連付けるユーザー定義タグ。これらのタグを指定すると、プールに関連付けられているバッキング Azure リソースにこれらのタグが伝達されます。このプロパティは、poolAllocationMode プロパティが 'UserSubscription' に設定された Batch アカウントが作成された場合にのみ指定できます。
properties.scaleSettings	ScaleSettings		プール内のノード数を構成する設定。プールの目的のサイズを定義します。これは、要求された targetDedicatedNodes が指定されている "fixedScale" か、定期的に再評価される数式を定義する 'autoScale' のいずれかです。このプロパティを指定しない場合、プールは 0 targetDedicatedNodes を使用して固定スケールになります。
properties.startTask	StartTask		プールに参加する各コンピューティングノードで実行するように指定されたタスク。 PATCH (更新) 操作では、このプロパティを空のオブジェクトに設定して、プールから開始タスクを削除できます。
properties.targetNodeCommunicationMode	NodeCommunicationMode		プールの目的のノード通信モード。省略した場合、既定値は Default です。
properties.taskSchedulingPolicy	TaskSchedulingPolicy		タスクをプール内のコンピューティングノード間で分散する方法。指定しない場合、既定値はスプレッドです。
properties.taskSlotsPerNode	integer (int32)	1	プール内の 1 つのコンピューティングノードで同時実行タスクを実行するために使用できるタスクスロットの数。既定値は 1 です。最大値は、プールの vmSize または 256 のコア数の 4 倍の小さい値です。
properties.upgradePolicy	UpgradePolicy		プールのアップグレードポリシー。アップグレードポリシー (自動、手動、またはローリング) について説明します。
properties.userAccounts	UserAccount[]		プール内の各ノードに作成するユーザーアカウントの一覧。
properties.vmSize	string		プール内の仮想マシンのサイズ。プール内のすべての VM のサイズは同じです。使用可能な VM サイズの詳細については、「Azure の仮想マシンのサイズ (https://learn.microsoft.com/azure/virtual-machines/sizes/overview)」を参照してください。 Batch では、STANDARD_A0と Premium Storage (STANDARD_GS、STANDARD_DS、STANDARD_DSV2 シリーズ) を除くすべての Azure VM サイズがサポートされます。
tags	object		リソースのタグ。
type	string		リソースの種類。

PoolEndpointConfiguration

Object

プールのエンドポイント構成。

名前	型	説明
inboundNatPools	InboundNatPool[]	個々のコンピューティングノード上の特定のポートを外部でアドレス指定するために使用できる受信 NAT プールの一覧。 Batch プールあたりの受信 NAT プールの最大数は 5 です。受信 NAT プールの最大数を超えた場合、要求は HTTP 状態コード 400 で失敗します。 IPAddressProvisioningType が NoPublicIPAddresses の場合、これは指定できません。

PoolIdentityType

列挙

バッチプールに使用される ID の種類。

値	説明
None	バッチプールには ID が関連付けされません。更新プールで `None` を設定すると、既存の ID が削除されます。
UserAssigned	Batch プールには、ユーザー割り当て ID があります。

PoolProvisioningState

列挙

プールの現在の状態。

値	説明
Deleting	ユーザーはプールの削除を要求しましたが、削除操作はまだ完了していません。
Succeeded	プールは、コンピューティングノードの可用性に応じてタスクを実行するために使用できます。

PublicIPAddressConfiguration

Object

プールのネットワーク構成のパブリック IP アドレス構成。

名前	型	説明
ipAddressIds	string[]	Batch サービスがコンピューティングノードのプロビジョニング時に使用するパブリック IP の一覧。ここで指定する IP の数によって、プールの最大サイズが制限されます。パブリック IP ごとに 100 個の専用ノードまたは 100 個のスポット/低優先度ノードを割り当て可能です。たとえば、250 個の専用 VM を必要とするプールには、少なくとも 3 つのパブリック IP が指定されている必要があります。このコレクションの各要素は、/subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/publicIPAddresses/{ip} の形式です。
provision	IPAddressProvisioningType	プールのパブリック IP アドレスのプロビジョニングの種類既定値は BatchManaged です

ResizeError

Object

プールのサイズを変更するときに発生したエラー。

名前	型	説明
code	string	エラーの識別子。コードは不変であり、プログラムで使用することを目的としています。
details	ResizeError[]	エラーに関する追加の詳細。
message	string	ユーザーインターフェイスでの表示に適したエラーを説明するメッセージ。

ResizeOperationStatus

Object

現在または最後に完了したサイズ変更操作の詳細。

名前	型	説明
errors	ResizeError[]	プールで最後のサイズ変更の実行中に発生したエラーの詳細。このプロパティは、プールの最後のサイズ変更中にエラーが発生した場合にのみ設定され、プールの allocationState が Steady の場合にのみ設定されます。
nodeDeallocationOption	ComputeNodeDeallocationOption	プールサイズが減少している場合にノードとその実行中のタスクを処理する方法を決定します。既定値は requeue です。
resizeTimeout	string (duration)	プールへのコンピューティングノードの割り当てまたはプールからのコンピューティングノードの削除のタイムアウト。既定値は 15 分です。最小値は 5 分です。 5 分未満の値を指定すると、Batch サービスはエラーを返します。REST API を直接呼び出す場合、HTTP 状態コードは 400 (無効な要求) です。
startTime	string (date-time)	このサイズ変更操作が開始された時刻。
targetDedicatedNodes	integer (int32)	プール内の専用コンピューティングノードの目的の数。
targetLowPriorityNodes	integer (int32)	プール内のスポット/優先順位の低いコンピューティングノードの目的の数。

ResourceFile

Object

コンピューティングノードにダウンロードする 1 つのファイルまたは複数のファイル。

名前	型	説明
autoStorageContainerName	string	自動ストレージアカウントのストレージコンテナー名。 autoStorageContainerName、storageContainerUrl、および httpUrl プロパティは相互に排他的であり、そのうちの 1 つを指定する必要があります。
blobPrefix	string	Azure Storage コンテナーから BLOB をダウンロードするときに使用する BLOB プレフィックス。指定したプレフィックスで始まる名前の BLOB のみがダウンロードされます。このプロパティは、autoStorageContainerName または storageContainerUrl が使用されている場合にのみ有効です。このプレフィックスには、部分的なファイル名またはサブディレクトリを指定できます。プレフィックスが指定されていない場合は、コンテナー内のすべてのファイルがダウンロードされます。
fileMode	string	ファイルアクセス許可モード属性 (8 進数形式)。このプロパティは、Linux コンピューティングノードにダウンロードされるファイルにのみ適用されます。これは、Windows ノードにダウンロードされる resourceFile に対して指定されている場合は無視されます。 Linux ノードにこのプロパティが指定されていない場合は、既定値の 0770 がファイルに適用されます。
filePath	string	タスクの作業ディレクトリを基準とした、ファイルのダウンロード先となるコンピューティングノード上の場所。 httpUrl プロパティが指定されている場合、filePath は必須であり、ファイルのダウンロード先となるパス (ファイル名を含む) を記述します。それ以外の場合、autoStorageContainerName または storageContainerUrl プロパティが指定されている場合、filePath は省略可能であり、ファイルをダウンロードするディレクトリです。 filePath がディレクトリとして使用されている場合、入力データに既に関連付けられているディレクトリ構造は完全に保持され、指定された filePath ディレクトリに追加されます。指定した相対パスは、タスクの作業ディレクトリから抜け出すことはできません (たとえば、'..' を使用)。
httpUrl	string	ダウンロードするファイルの URL。 autoStorageContainerName、storageContainerUrl、および httpUrl プロパティは相互に排他的であり、そのうちの 1 つを指定する必要があります。 URL が Azure Blob Storage を指している場合は、コンピューティングノードから読み取ることができる必要があります。 Azure Storage 内の BLOB のこのような URL を取得するには、3 つの方法があります。BLOB に対する読み取りアクセス許可を付与する Shared Access Signature (SAS) を含めるか、読み取りアクセス許可を持つマネージド ID を使用するか、BLOB またはそのコンテナーの ACL を設定してパブリックアクセスを許可します。
identityReference	ComputeNodeIdentityReference	storageContainerUrl または httpUrl で指定された Azure Blob Storage へのアクセスに使用するユーザー割り当て ID への参照コンピューティングノードが使用する Batch プールに関連付けられているユーザー割り当て ID への参照。
storageContainerUrl	string	Azure Blob Storage 内の BLOB コンテナーの URL。 autoStorageContainerName、storageContainerUrl、および httpUrl プロパティは相互に排他的であり、そのうちの 1 つを指定する必要があります。この URL は、コンピューティングノードから読み取り可能でリスト可能である必要があります。 Azure Storage 内のコンテナーのこのような URL を取得するには、3 つの方法があります。コンテナーに対する読み取りと一覧表示のアクセス許可を付与する Shared Access Signature (SAS) を含めるか、読み取りとリストのアクセス許可を持つマネージド ID を使用するか、コンテナーの ACL を設定してパブリックアクセスを許可します。

RollingUpgradePolicy

Object

ローリングアップグレードの実行中に使用される構成パラメーター。

名前	型	説明
enableCrossZoneUpgrade	boolean	アップグレードバッチを構築するときに、VMSS が AZ 境界を無視できるようにします。バッチサイズを決定するには、更新ドメインと maxBatchInstancePercent を考慮してください。このフィールドが設定されていない場合、Azure Azure Batch では既定値は設定されません。作成された VirtualMachineScaleSet の enableCrossZoneUpgrade の値は、VirtualMachineScaleSet の既定の構成によって決定されます。このフィールドは、NodePlacementConfiguration をゾーンとして使用する場合にのみ true または false に設定できます。
maxBatchInstancePercent	integer (int32) minimum: 5 maximum: 100	1 回のバッチでのローリングアップグレードによって同時にアップグレードされる仮想マシンインスタンスの合計数に対する最大割合。これは最大であるため、以前または将来のバッチの異常なインスタンスでは、信頼性を高めるためにバッチ内のインスタンスの割合が減少する可能性があります。このフィールドの値は、5 ~ 100 の範囲にする必要があります。 maxBatchInstancePercent と maxUnhealthyInstancePercent の両方に値が割り当てられている場合、maxBatchInstancePercent の値は maxUnhealthyInstancePercent を超えてはなりません。
maxUnhealthyInstancePercent	integer (int32) minimum: 5 maximum: 100	アップグレードの結果として、またはローリングアップグレードが中止される前に仮想マシンの正常性チェックによって異常な状態で検出された場合に、同時に異常になる可能性があるスケールセット内の仮想マシンインスタンスの合計数に対する最大割合。この制約は、バッチを開始する前にチェックされます。このフィールドの値は、5 ~ 100 の範囲にする必要があります。 maxBatchInstancePercent と maxUnhealthyInstancePercent の両方に値が割り当てられている場合、maxBatchInstancePercent の値は maxUnhealthyInstancePercent を超えてはなりません。
maxUnhealthyUpgradedInstancePercent	integer (int32) minimum: 0 maximum: 100	異常な状態にあると検出できるアップグレードされた仮想マシンインスタンスの最大割合。このチェックは、各バッチがアップグレードされた後に行われます。この割合を超えた場合、ローリングアップデートは中止されます。このフィールドの値は、0 ~ 100 の範囲にする必要があります。
pauseTimeBetweenBatches	string	すべての仮想マシンの更新を 1 つのバッチで完了してから次のバッチを開始するまでの待機時間。期間は ISO 8601 形式で指定する必要があります。
prioritizeUnhealthyInstances	boolean	正常なインスタンスの前に、スケールセット内のすべての異常なインスタンスをアップグレードします。
rollbackFailedInstancesOnPolicyBreach	boolean	ローリングアップグレードポリシーに違反した場合、失敗したインスタンスを以前のモデルにロールバックします。

ScaleSettings

Object

プールのスケール設定

名前	型	説明
autoScale	AutoScaleSettings	プールの自動スケール設定。このプロパティと fixedScale は相互に排他的であり、プロパティの 1 つを指定する必要があります。
fixedScale	FixedScaleSettings	プールのスケール設定を修正しました。このプロパティと自動スケールは相互に排他的であり、プロパティの 1 つを指定する必要があります。

SecurityEncryptionTypes

列挙

マネージドディスクの EncryptionType を指定します。 VMGuestState BLOB のみを暗号化する場合は VMGuestStateOnly に、VMGuestState BLOB にファームウェアの状態を保持しない場合は NonPersistedTPM に設定されます。注: 機密 VM にのみ設定でき、機密 VM を使用する場合は必須です。

値	説明
NonPersistedTPM
VMGuestStateOnly

SecurityProfile

Object

仮想マシンまたは仮想マシンスケールセットのセキュリティプロファイル設定を指定します。

名前	型	説明
encryptionAtHost	boolean	このプロパティは、要求のユーザーが仮想マシンまたは仮想マシンスケールセットの Host Encryption を有効または無効にするために使用できます。これにより、ホスト自体のリソース/一時ディスクを含むすべてのディスクの暗号化が有効になります。
securityType	SecurityTypes	仮想マシンの SecurityType を指定します。 UefiSettings を有効にするには、指定した値に設定する必要があります。
uefiSettings	UefiSettings	仮想マシンの作成時に使用されるセキュアブートや vTPM などのセキュリティ設定を指定します。仮想マシンの作成時に使用されるセキュアブートや vTPM などのセキュリティ設定を指定します。

SecurityTypes

列挙

仮想マシンの SecurityType を指定します。 UefiSettings を有効にするには、指定した値に設定する必要があります。

値

説明

confidentialVM

Azure コンフィデンシャルコンピューティングは、セキュリティと機密性の高い要件を持つテナント向けの機密 VM を提供します。これらの VM は、セキュリティニーズを満たすのに役立つ強力なハードウェア強制境界を提供します。コードを変更することなく、機密 VM を移行に使用できます。プラットフォームを使用すると、VM の状態が読み取られたり変更されたりするのを防いでいます。

trustedLaunch

信頼できる起動は、高度で永続的な攻撃手法から保護します。

ServiceArtifactReference

Object

"最新" イメージバージョンを使用する場合に、スケールセット内のすべての仮想マシンに同じイメージバージョンを設定するために使用されるサービス成果物参照 ID を指定します。

名前	型	説明
id	string	ServiceArtifactReference のサービス成果物参照 ID /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName} の形式のサービス成果物参照 ID

StartTask

Object

コンピューティングノードが Azure Batch サービス内のプールに参加したとき、またはコンピューティングノードが再起動または再イメージ化されたときに実行されるタスク。

名前	型	規定値	説明
commandLine	string		開始タスクのコマンドライン。コマンドラインはシェルでは実行されないため、環境変数の拡張などのシェル機能を利用することはできません。このような機能を利用する場合は、コマンドラインでシェルを呼び出す必要があります。たとえば、Windows では "cmd /c MyCommand" を使用し、Linux では "/bin/sh -c MyCommand" を使用します。 startTask の他のプロパティが指定されている場合は必須です。
containerSettings	TaskContainerSettings		開始タスクを実行するコンテナーの設定。これを指定すると、AZ_BATCH_NODE_ROOT_DIRの下にあるすべてのディレクトリ (ノード上の Azure Batch ディレクトリのルート) がコンテナーに再帰的にマップされ、すべてのタスク環境変数がコンテナーにマップされ、タスクコマンドラインがコンテナーで実行されます。
environmentSettings	EnvironmentSetting[]		開始タスクの環境変数設定の一覧。
maxTaskRetryCount	integer (int32)	0	タスクを再試行できる最大回数。終了コードが 0 以外の場合、Batch サービスはタスクを再試行します。この値は、再試行回数を特に制御します。 Batch サービスはタスクを 1 回試し、この制限まで再試行できます。たとえば、最大再試行回数が 3 の場合、Batch はタスクを最大 4 回試行します (1 回の最初の再試行と 3 回の再試行)。最大再試行回数が 0 の場合、Batch サービスはタスクを再試行しません。最大再試行回数が -1 の場合、Batch サービスは制限なくタスクを再試行します。既定値は 0 です
resourceFiles	ResourceFile[]		コマンドラインを実行する前に Batch サービスがコンピューティングノードにダウンロードするファイルの一覧。
userIdentity	UserIdentity		開始タスクを実行するユーザー ID。省略すると、タスクはタスクに固有の非管理ユーザーとして実行されます。
waitForSuccess	boolean		コンピューティングノード上のタスクをスケジュールする前に、Batch サービスが開始タスクが正常に完了するまで (つまり、終了コード 0 で終了する) のを待つ必要があるかどうか。 true で、コンピューティングノードで開始タスクが失敗した場合、Batch サービスは開始タスクを最大再試行回数 (maxTaskRetryCount) まで再試行します。すべての再試行の後もタスクが正常に完了していない場合、Batch サービスはコンピューティングノードを使用不可としてマークし、タスクをスケジュールしません。この条件は、ノードの状態とスケジュールエラーの詳細を使用して検出できます。 false の場合、Batch サービスは開始タスクの完了を待機しません。この場合、開始タスクの実行中に、他のタスクがコンピューティングノードで実行を開始できます。開始タスクが失敗した場合でも、新しいタスクはノードで引き続きスケジュールされます。既定値は true です。

StorageAccountType

列挙

データディスクまたは OS ディスクの作成に使用するストレージアカウントの種類。

値	説明
Premium_LRS	データディスク/OS ディスクでは、Premium ローカル冗長ストレージを使用する必要があります。
StandardSSD_LRS	データディスク/OS ディスクでは、Standard SSD のローカル冗長ストレージを使用する必要があります。
Standard_LRS	データディスク/OS ディスクでは、標準のローカル冗長ストレージを使用する必要があります。

TaskContainerSettings

Object

タスクのコンテナー設定。

名前	型	説明
containerHostBatchBindMounts	ContainerHostBatchBindMountEntry[]	コンテナータスクにマウントするパス。この配列が null または存在しない場合、コンテナータスクは一時ディスクドライブ全体を Windows (または Linux では AZ_BATCH_NODE_ROOT_DIR) にマウントします。この配列が空として設定されている場合、データパスはコンテナーにマウントされません。
containerRunOptions	string	コンテナー作成コマンドの追加オプション。これらの追加オプションは、Batch サービスによって制御されるオプションに加えて、"docker create" コマンドの引数として提供されます。
imageName	string	タスクを実行するコンテナーの作成に使用するイメージ。これは、"docker pull" に指定される完全なイメージ参照です。イメージ名の一部としてタグが指定されていない場合、タグ ":latest" が既定として使用されます。
registry	ContainerRegistry	コンテナーイメージを含むプライベートレジストリ。プールの作成時に既に指定されている場合は、この設定を省略できます。
workingDirectory	ContainerWorkingDirectory	コンテナータスクの作業ディレクトリの場所を示すフラグ。既定値は 'taskWorkingDirectory' です。

TaskSchedulingPolicy

Object

タスクをコンピューティングノード間で分散する方法を指定します。

名前	型	規定値	説明
nodeFillType	ComputeNodeFillType	Spread	タスクをコンピューティングノード間で分散する方法。

UefiSettings

Object

仮想マシンの作成時に使用されるセキュアブートや vTPM などのセキュリティ設定を指定します。

名前	型	説明
secureBootEnabled	boolean	仮想マシンでセキュアブートを有効にするかどうかを指定します。
vTpmEnabled	boolean	仮想マシンで vTPM を有効にするかどうかを指定します。

UpgradeMode

列挙

スケールセット内の仮想マシンへのアップグレードモードを指定します。

使用可能な値は次のとおりです。

手動 - スケールセット内の仮想マシンへの更新プログラムの適用を制御します。これを行うには、manualUpgrade アクションを使用します。

自動 - スケールセット内のすべての仮想マシンが同時に自動的に更新されます。

ローリング - スケールセットは、必要に応じて一時停止時間の間にバッチで更新を実行します。

値	説明
automatic	スケールセット内のすべての仮想マシンが同時に自動的に更新されます。
manual	スケールセット内の仮想マシンへの更新プログラムの適用を制御します。これを行うには、manualUpgrade アクションを使用します。
rolling	スケールセット内の既存のインスタンスは、アップグレードするバッチでダウンします。アップグレードされたバッチが完了すると、インスタンスはトラフィックの取得を再開し、次のバッチが開始されます。これは、すべてのインスタンスが -date を up-toするまで続けられます。

UpgradePolicy

Object

アップグレードポリシー (自動、手動、またはローリング) について説明します。

名前	型	説明
automaticOSUpgradePolicy	AutomaticOSUpgradePolicy	OS の自動アップグレードを実行するために使用される構成パラメーター。 OS の自動アップグレードを実行するために使用される構成パラメーター。
mode	UpgradeMode	スケールセット内の仮想マシンへのアップグレードモードを指定します。使用可能な値は次のとおりです。手動 - スケールセット内の仮想マシンへの更新プログラムの適用を制御します。これを行うには、manualUpgrade アクションを使用します。自動 - スケールセット内のすべての仮想マシンが同時に自動的に更新されます。ローリング - スケールセットは、必要に応じて一時停止時間の間にバッチで更新を実行します。
rollingUpgradePolicy	RollingUpgradePolicy	ローリングアップグレードの実行中に使用される構成パラメーター。ローリングアップグレードの実行中に使用される構成パラメーター。

UserAccount

Object

Azure Batch ノードでユーザーを作成するために使用されるプロパティ。

名前	型	説明
elevationLevel	ElevationLevel	ユーザーアカウントの昇格レベル。 nonAdmin - 自動ユーザーは、昇格されたアクセス権を持たない標準ユーザーです。 admin - 自動ユーザーは昇格されたアクセス権を持つユーザーであり、完全な管理者アクセス許可で動作します。既定値は nonAdmin です。
linuxUserConfiguration	LinuxUserConfiguration	ユーザーアカウントの Linux 固有のユーザー構成。このプロパティは、Windows プールで指定されている場合は無視されます。指定しない場合、ユーザーは既定のオプションで作成されます。
name	string	ユーザーアカウントの名前。名前には、最大 20 文字までの Unicode 文字を含めることができます。
password	string	ユーザーアカウントのパスワード。
windowsUserConfiguration	WindowsUserConfiguration	ユーザーアカウントの Windows 固有のユーザー構成。このプロパティは、ユーザーが Windows プール上にある場合にのみ指定できます。指定されていない場合、Windows プールでは、既定のオプションを使用してユーザーが作成されます。

UserAssignedIdentities

Object

関連付けられているユーザー ID の一覧。

名前	型	説明
clientId	string	ユーザー割り当て ID のクライアント ID。
principalId	string	ユーザー割り当て ID のプリンシパル ID。

UserIdentity

Object

タスクを実行するユーザー ID の定義。

名前	型	説明
autoUser	AutoUserSpecification	タスクを実行する自動ユーザー。 userName プロパティと autoUser プロパティは相互に排他的です。1 つを指定する必要がありますが、両方を指定する必要はありません。
userName	string	タスクを実行するユーザー ID の名前。 userName プロパティと autoUser プロパティは相互に排他的です。1 つを指定する必要がありますが、両方を指定する必要はありません。

VirtualMachineConfiguration

Object

Azure Virtual Machines インフラストラクチャに基づくプール内のコンピューティングノードの構成。

名前	型	説明
containerConfiguration	ContainerConfiguration	プールのコンテナー構成。指定した場合、タスクをコンテナーで実行できるように、プール内の各ノードでセットアップが実行されます。このプールで実行されるすべての通常のタスクとジョブマネージャータスクは containerSettings プロパティを指定する必要があり、他のすべてのタスクで指定できます。
dataDisks	DataDisk[]	プール内のコンピューティングノードに接続されているデータディスクの構成。プール内のコンピューティングノードに空のデータディスクが接続されている必要がある場合は、このプロパティを指定する必要があります。
diskEncryptionConfiguration	DiskEncryptionConfiguration	プールのディスク暗号化構成。指定した場合、暗号化は、ノードのプロビジョニング中にプール内の各ノードで実行されます。
extensions	VMExtension[]	プールの仮想マシン拡張機能。指定した場合、この構成に記載されている拡張機能が各ノードにインストールされます。
imageReference	ImageReference	使用する Azure Virtual Machines Marketplace イメージまたはカスタム仮想マシンイメージへの参照。
licenseType	string	オペレーティングシステムの展開時に使用するオンプレミスライセンスの種類。これは、Windows オペレーティングシステムを含むイメージにのみ適用され、展開されるノードの有効なオンプレミスライセンスを保持している場合にのみ使用する必要があります。省略した場合、オンプレミスのライセンス割引は適用されません。値は次のとおりです。 Windows_Server - オンプレミスライセンスは Windows Server 用です。 Windows_Client - オンプレミスライセンスは Windows クライアント用です。
nodeAgentSkuId	string	プール内のコンピューティングノードにプロビジョニングされる Batch ノードエージェントの SKU。 Batch ノードエージェントは、プール内の各ノードで実行されるプログラムであり、ノードと Batch サービスの間のコマンドおよび制御インターフェイスを提供します。オペレーティングシステムごとに、SKU と呼ばれるノードエージェントのさまざまな実装があります。選択したイメージ参照に一致するノードエージェント SKU を指定する必要があります。サポートされているノードエージェント SKU の一覧と検証済みイメージ参照の一覧を取得するには、「サポートされているノードエージェント SKU の一覧表示」操作を参照してください。
nodePlacementConfiguration	NodePlacementConfiguration	プールのノード配置構成。この構成では、プール内のノードを物理的に割り当てる方法に関する規則を指定します。
osDisk	OSDisk	仮想マシンのオペレーティングシステムディスクの設定。エフェメラル OSDisk 設定の構成が含まれています。
securityProfile	SecurityProfile	仮想マシンまたは仮想マシンスケールセットのセキュリティプロファイル設定を指定します。仮想マシンまたは仮想マシンスケールセットのセキュリティプロファイル設定を指定します。
serviceArtifactReference	ServiceArtifactReference	"最新" イメージバージョンを使用する場合に、スケールセット内のすべての仮想マシンに同じイメージバージョンを設定するために使用されるサービス成果物参照 ID を指定します。 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName} の形式のサービス成果物参照 ID
windowsConfiguration	WindowsConfiguration	仮想マシン上の Windows オペレーティングシステムの設定。 imageReference で Linux OS イメージが指定されている場合は、このプロパティを指定しないでください。

VMDiskSecurityProfile

Object

マネージドディスクのセキュリティプロファイル設定を指定します。注: 機密 VM にのみ設定でき、機密 VM を使用する場合に必要です。

名前	型	説明
securityEncryptionType	SecurityEncryptionTypes	マネージドディスクの EncryptionType を指定します。 VMGuestState BLOB のみを暗号化する場合は VMGuestStateOnly に、VMGuestState BLOB にファームウェアの状態を保持しない場合は NonPersistedTPM に設定されます。注: 機密 VM にのみ設定でき、機密 VM を使用する場合は必須です。

VMExtension

Object

仮想マシン拡張機能の構成。

名前	型	説明
autoUpgradeMinorVersion	boolean	展開時に使用可能な場合に、拡張機能で新しいマイナーバージョンを使用する必要があるかどうかを示します。ただし、デプロイされると、このプロパティが true に設定されていても、再デプロイされない限り、拡張機能はマイナーバージョンをアップグレードしません。
enableAutomaticUpgrade	boolean	使用可能な拡張機能の新しいバージョンがある場合に、拡張機能をプラットフォームによって自動的にアップグレードするかどうかを示します。
name	string	仮想マシン拡張機能の名前。
protectedSettings	object	拡張機能には、protectedSettings または protectedSettingsFromKeyVault、または保護された設定をまったく含めなくなります。
provisionAfterExtensions	string[]	拡張機能名のコレクション。この拡張機能をプロビジョニングする必要がある拡張機能名のコレクション。
publisher	string	拡張ハンドラーの発行元の名前。
settings	object	拡張機能の JSON 形式のパブリック設定。
type	string	拡張機能の種類。
typeHandlerVersion	string	スクリプトハンドラーのバージョン。

WindowsConfiguration

Object

仮想マシンに適用する Windows オペレーティングシステムの設定。

名前	型	説明
enableAutomaticUpdates	boolean	仮想マシンで自動更新が有効になっているかどうか。省略した場合、既定値は true です。

WindowsUserConfiguration

Object

Windows ノードでユーザーアカウントを作成するために使用されるプロパティ。

名前	型	説明
loginMode	LoginMode	ユーザーのログインモードユーザーのログインモードを指定します。既定値は Interactive です。

次の方法で共有

Pool - Update

URI パラメーター

要求ヘッダー

要求本文

応答

セキュリティ

azure_auth

スコープ

例

UpdatePool - Enable Autoscale

要求のサンプル

応答のサンプル

UpdatePool - Other Properties

要求のサンプル

応答のサンプル

UpdatePool - Remove Start Task

要求のサンプル

応答のサンプル

UpdatePool - Resize Pool

要求のサンプル

応答のサンプル

定義

AllocationState

ApplicationPackageReference

AutomaticOSUpgradePolicy

AutoScaleRun

AutoScaleRunError

AutoScaleSettings

AutoUserScope

AutoUserSpecification

AzureBlobFileSystemConfiguration

AzureFileShareConfiguration

BatchPoolIdentity

CachingType

CertificateReference

CertificateStoreLocation

CertificateVisibility

CIFSMountConfiguration

CloudError

CloudErrorBody

ComputeNodeDeallocationOption

ComputeNodeFillType

ComputeNodeIdentityReference

ContainerConfiguration

ContainerHostBatchBindMountEntry

ContainerHostDataPath

ContainerRegistry

ContainerType

ContainerWorkingDirectory

DataDisk

DeploymentConfiguration

DiffDiskPlacement

DiffDiskSettings

DiskEncryptionConfiguration

DiskEncryptionTarget

DynamicVNetAssignmentScope

ElevationLevel

EnvironmentSetting

FixedScaleSettings

ImageReference

InboundEndpointProtocol

InboundNatPool

InterNodeCommunicationState

IPAddressProvisioningType

LinuxUserConfiguration

LoginMode

ManagedDisk

MetadataItem

MountConfiguration

NetworkConfiguration

NetworkSecurityGroupRule

NetworkSecurityGroupRuleAccess

NFSMountConfiguration

NodeCommunicationMode

NodePlacementConfiguration

NodePlacementPolicyType

OSDisk

Pool

PoolEndpointConfiguration