Batch Account - Get

リファレンス

サービス:: Batch Management

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

指定した Batch アカウントに関する情報を取得します。

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

URI パラメーター

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

応答

名前	型	説明
200 OK	BatchAccount	操作が成功しました。応答には Batch アカウントエンティティが含まれています。
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	ユーザーアカウントを偽装する

例

BatchAccountGet

PrivateBatchAccountGet

BatchAccountGet

要求のサンプル

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


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

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

from azure.identity import DefaultAzureCredential

from azure.mgmt.batch import BatchManagementClient

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

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


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

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


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

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

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

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

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

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

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

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

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

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

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

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

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

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

応答のサンプル

状態コード:: 200

{
  "name": "sampleacct",
  "location": "japaneast",
  "properties": {
    "accountEndpoint": "sampleacct.japaneast.batch.azure.com",
    "provisioningState": "Succeeded",
    "poolAllocationMode": "BatchService",
    "dedicatedCoreQuota": 20,
    "lowPriorityCoreQuota": 20,
    "poolQuota": 20,
    "activeJobAndJobScheduleQuota": 20,
    "autoStorage": {
      "storageAccountId": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage",
      "lastKeySync": "2016-03-10T23:48:38.9878479Z"
    },
    "publicNetworkAccess": "Enabled"
  },
  "identity": {
    "type": "None"
  },
  "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct",
  "type": "Microsoft.Batch/batchAccounts"
}

PrivateBatchAccountGet

要求のサンプル

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


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

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

from azure.identity import DefaultAzureCredential

from azure.mgmt.batch import BatchManagementClient

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

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


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

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


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

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

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

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

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

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

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

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

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

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

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

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

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

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

応答のサンプル

状態コード:: 200

{
  "name": "sampleacct",
  "location": "japaneast",
  "properties": {
    "accountEndpoint": "sampleacct.japaneast.batch.azure.com",
    "provisioningState": "Succeeded",
    "poolAllocationMode": "BatchService",
    "dedicatedCoreQuota": 20,
    "lowPriorityCoreQuota": 20,
    "poolQuota": 20,
    "activeJobAndJobScheduleQuota": 20,
    "autoStorage": {
      "storageAccountId": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage",
      "lastKeySync": "2016-03-10T23:48:38.9878479Z"
    },
    "publicNetworkAccess": "Disabled",
    "privateEndpointConnections": [
      {
        "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/privateEndpointConnections/testprivateEndpointConnection.24d6b4b5-e65c-4330-bbe9-3a290d62f8e0",
        "name": "testprivateEndpointConnection.24d6b4b5-e65c-4330-bbe9-3a290d62f8e0",
        "type": "Microsoft.Batch/batchAccounts/privateEndpointConnections",
        "properties": {
          "privateEndpoint": {
            "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Network/privateEndpoints/testprivateEndpoint"
          },
          "privateLinkServiceConnectionState": {
            "status": "Approved",
            "description": "Approved by xyz.abc@company.com"
          }
        }
      }
    ]
  },
  "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct",
  "type": "Microsoft.Batch/batchAccounts"
}

定義

名前	説明
AuthenticationMode	Batch アカウントの認証モード。
AutoStorageAuthenticationMode	Batch サービスが自動ストレージアカウントの管理に使用する認証モード。
AutoStorageProperties	Batch アカウントに関連付けられている自動ストレージアカウントに関する情報が含まれています。
BatchAccount	Azure Batch アカウントに関する情報が含まれています。
BatchAccountIdentity	Batch アカウントの ID (構成されている場合)。これは、ユーザーが Batch アカウント暗号化構成として "Microsoft.KeyVault" を指定した場合、または自動ストレージ認証モードとして `ManagedIdentity` が選択されている場合に使用されます。
CloudError	Batch サービスからのエラー応答。
CloudErrorBody	Batch サービスからのエラー応答。
ComputeNodeIdentityReference	コンピューティングノードが使用する Batch プールに関連付けられているユーザー割り当て ID への参照。
EncryptionProperties	Batch アカウント内で顧客データを暗号化する方法を構成します。既定では、アカウントは Microsoft マネージドキーを使用して暗号化されます。追加の制御のために、代わりにカスタマーマネージドキーを使用できます。
EndpointAccessDefaultAction	一致する IPRule がない場合の既定のアクション。
EndpointAccessProfile	Batch エンドポイントのネットワークアクセスプロファイル。
IPRule	クライアント IP アドレスをフィルター処理する規則。
IPRuleAction	クライアント IP アドレスが一致したときのアクション。
KeySource	キーソースの種類。
KeyVaultProperties	Microsoft.KeyVault の暗号化 KeySource を使用する場合の KeyVault 構成。
KeyVaultReference	Batch アカウントに関連付けられている Azure キーコンテナーを識別します。
NetworkProfile	Batch アカウントのネットワークプロファイル。各エンドポイントのネットワークルール設定が含まれています。
PoolAllocationMode	Batch アカウントでプールを作成するための割り当てモード。
PrivateEndpoint	プライベートエンドポイント接続のプライベートエンドポイント。
PrivateEndpointConnection	プライベートリンクリソースに関する情報が含まれています。
PrivateEndpointConnectionProvisioningState	プライベートエンドポイント接続のプロビジョニング状態。
PrivateLinkServiceConnectionState	プライベートエンドポイント接続のプライベートリンクサービス接続状態
PrivateLinkServiceConnectionStatus	Batch プライベートエンドポイント接続の状態
ProvisioningState	リソースのプロビジョニング済み状態
PublicNetworkAccessType	Batch アカウント内のリソースで動作するためのネットワークアクセスの種類。
ResourceIdentityType	Batch アカウントに使用される ID の種類。
UserAssignedIdentities	関連付けられているユーザー ID の一覧。
VirtualMachineFamilyCoreQuota	BATCH アカウントの VM ファミリとそれに関連付けられているコアクォータ。

AuthenticationMode

列挙

Batch アカウントの認証モード。

値	説明
AAD	Microsoft Entra ID を使用した認証モード。
SharedKey	共有キーを使用した認証モード。
TaskAuthenticationToken	タスク認証トークンを使用した認証モード。

AutoStorageAuthenticationMode

列挙

Batch サービスが自動ストレージアカウントの管理に使用する認証モード。

値	説明
BatchAccountManagedIdentity	Batch サービスは、Batch アカウントに割り当てられたマネージド ID を使用して、自動ストレージへの要求を認証します。
StorageKeys	Batch サービスは、ストレージアカウントキーを使用して自動ストレージへの要求を認証します。

AutoStorageProperties

Object

Batch アカウントに関連付けられている自動ストレージアカウントに関する情報が含まれています。

名前	型	規定値	説明
authenticationMode	AutoStorageAuthenticationMode	StorageKeys	Batch サービスが自動ストレージアカウントの管理に使用する認証モード。
lastKeySync	string (date-time)		ストレージキーが Batch アカウントと最後に同期された UTC 時刻。
nodeIdentityReference	ComputeNodeIdentityReference		自動ストレージへのアクセスにコンピューティングノードが使用するユーザー割り当て ID への参照。ここで参照される ID は、自動ストレージへのアクセスを必要とするコンピューティングノードを持つプールに割り当てる必要があります。
storageAccountId	string (arm-id)		自動ストレージアカウントに使用するストレージアカウントのリソース ID。

BatchAccount

Object

Azure Batch アカウントに関する情報が含まれています。

名前	型	規定値	説明
id	string		リソースの ID。
identity	BatchAccountIdentity		Batch アカウントの ID。
location	string		リソースの場所。
name	string		リソースの名前。
properties.accountEndpoint	string		Batch サービスとの対話に使用されるアカウントエンドポイント。
properties.activeJobAndJobScheduleQuota	integer (int32)		Batch アカウントのアクティブなジョブとジョブスケジュールのクォータ。
properties.allowedAuthenticationModes	AuthenticationMode[]		データプレーンでの認証に使用できる Batch アカウントで許可される認証モードの一覧。これは、コントロールプレーンでの認証には影響しません。
properties.autoStorage	AutoStorageProperties		Batch アカウントに関連付けられている自動ストレージアカウントのプロパティと状態。 Batch アカウントに関連付けられている自動ストレージアカウントに関する情報が含まれています。
properties.dedicatedCoreQuota	integer (int32)		Batch アカウントの専用コアクォータ。 PoolAllocationMode が UserSubscription に設定されているアカウントの場合、クォータはサブスクリプションで管理されるため、この値は返されません。
properties.dedicatedCoreQuotaPerVMFamily	VirtualMachineFamilyCoreQuota[]		Batch アカウントの仮想マシンファミリごとの専用コアクォータの一覧。 PoolAllocationMode が UserSubscription に設定されているアカウントの場合、クォータはサブスクリプションで管理されるため、この値は返されません。
properties.dedicatedCoreQuotaPerVMFamilyEnforced	boolean		このアカウントに対して仮想マシンファミリごとのコアクォータが適用されるかどうかを示す値このフラグが true の場合、専用コアクォータは、アカウントの dedicatedCoreQuotaPerVMFamily プロパティと dedicatedCoreQuota プロパティの両方を介して適用されます。このフラグが false の場合、専用コアクォータはアカウントの dedicatedCoreQuota プロパティを介してのみ適用され、仮想マシンファミリは考慮されません。
properties.encryption	EncryptionProperties		Batch アカウントの暗号化構成。 Batch アカウント内で顧客データを暗号化する方法を構成します。既定では、アカウントは Microsoft マネージドキーを使用して暗号化されます。追加の制御のために、代わりにカスタマーマネージドキーを使用できます。
properties.keyVaultReference	KeyVaultReference		Batch アカウントに関連付けられている Azure キーコンテナーへの参照。 Batch アカウントに関連付けられている Azure キーコンテナーを識別します。
properties.lowPriorityCoreQuota	integer (int32)		Batch アカウントのスポット/優先順位の低いコアクォータ。 PoolAllocationMode が UserSubscription に設定されているアカウントの場合、クォータはサブスクリプションで管理されるため、この値は返されません。
properties.networkProfile	NetworkProfile		Batch アカウントのネットワークプロファイル。各エンドポイントのネットワークルール設定が含まれています。ネットワークプロファイルは、publicNetworkAccess が有効になっている場合にのみ有効になります。
properties.nodeManagementEndpoint	string		Batch ノード管理サービスに接続するためにコンピューティングノードによって使用されるエンドポイント。
properties.poolAllocationMode	PoolAllocationMode		Batch アカウントでプールを作成するために使用する割り当てモード。 Batch アカウントでプールを作成するための割り当てモード。
properties.poolQuota	integer (int32)		Batch アカウントのプールクォータ。
properties.privateEndpointConnections	PrivateEndpointConnection[]		Batch アカウントに関連付けられているプライベートエンドポイント接続の一覧
properties.provisioningState	ProvisioningState		リソースのプロビジョニング済み状態
properties.publicNetworkAccess	PublicNetworkAccessType	Enabled	Azure Batch サービスと Batch アカウント操作にアクセスするためのネットワークインターフェイスの種類。指定しない場合、既定値は 'enabled' です。
tags	object		リソースのタグ。
type	string		リソースの種類。

BatchAccountIdentity

Object

Batch アカウントの ID (構成されている場合)。これは、ユーザーが Batch アカウント暗号化構成として "Microsoft.KeyVault" を指定した場合、または自動ストレージ認証モードとして ManagedIdentity が選択されている場合に使用されます。

名前	型	説明
principalId	string	Batch アカウントのプリンシパル ID。このプロパティは、システム割り当て ID にのみ提供されます。
tenantId	string	Batch アカウントに関連付けられているテナント ID。このプロパティは、システム割り当て ID にのみ提供されます。
type	ResourceIdentityType	Batch アカウントに使用される ID の種類。
userAssignedIdentities	<string, UserAssignedIdentities>	Batch アカウントに関連付けられているユーザー ID の一覧。

CloudError

Object

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

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

CloudErrorBody

Object

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

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

ComputeNodeIdentityReference

Object

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

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

EncryptionProperties

Object

Batch アカウント内で顧客データを暗号化する方法を構成します。既定では、アカウントは Microsoft マネージドキーを使用して暗号化されます。追加の制御のために、代わりにカスタマーマネージドキーを使用できます。

名前	型	説明
keySource	KeySource	キーソースの種類。
keyVaultProperties	KeyVaultProperties	Microsoft.KeyVault を使用する場合の追加の詳細

EndpointAccessDefaultAction

列挙

一致する IPRule がない場合の既定のアクション。

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

EndpointAccessProfile

Object

Batch エンドポイントのネットワークアクセスプロファイル。

名前	型	説明
defaultAction	EndpointAccessDefaultAction	一致する IPRule がない場合の既定のアクション。エンドポイントアクセスの既定のアクション。 publicNetworkAccess が有効になっている場合にのみ適用されます。
ipRules	IPRule[]	クライアント IP アドレスをフィルター処理する IP 範囲の配列。

IPRule

Object

クライアント IP アドレスをフィルター処理する規則。

名前	型	説明
action	IPRuleAction	クライアント IP アドレスが一致したときのアクション。
value	string	フィルター処理する IP アドレスまたは IP アドレス範囲 IPv4 アドレス、または CIDR 形式の IPv4 アドレス範囲。

IPRuleAction

列挙

クライアント IP アドレスが一致したときのアクション。

値	説明
Allow	一致したクライアント IP アドレスへのアクセスを許可します。

KeySource

列挙

キーソースの種類。

値	説明
Microsoft.Batch	Batch は、アカウントデータの保護に使用される暗号化キーを作成および管理します。
Microsoft.KeyVault	アカウントデータの保護に使用される暗号化キーは、外部キーコンテナーに格納されます。これが設定されている場合、Batch アカウント ID を `SystemAssigned` に設定し、keyVaultProperties の下に有効なキー識別子も指定する必要があります。

KeyVaultProperties

Object

Microsoft.KeyVault の暗号化 KeySource を使用する場合の KeyVault 構成。

名前	型	説明
keyIdentifier	string	バージョンの有無に関係なくシークレットへの完全パス。 https://mykeyvault.vault.azure.net/keys/testkey/6e34a81fef704045975661e297a4c053の例または https://mykeyvault.vault.azure.net/keys/testkey. 使用できるようにするには、次の前提条件を満たす必要があります。 Batch アカウントにシステム割り当て ID があります。アカウント ID には、キー/取得、キー/ラップ解除、キー/ラップのアクセス許可が付与されています。KeyVault には論理的な削除と消去の保護が有効になっています

名前

型

説明

keyIdentifier

string

バージョンの有無に関係なくシークレットへの完全パス。 https://mykeyvault.vault.azure.net/keys/testkey/6e34a81fef704045975661e297a4c053の例または https://mykeyvault.vault.azure.net/keys/testkey. 使用できるようにするには、次の前提条件を満たす必要があります。

Batch アカウントにシステム割り当て ID があります。アカウント ID には、キー/取得、キー/ラップ解除、キー/ラップのアクセス許可が付与されています。KeyVault には論理的な削除と消去の保護が有効になっています

KeyVaultReference

Object

Batch アカウントに関連付けられている Azure キーコンテナーを識別します。

名前	型	説明
id	string (arm-id)	Batch アカウントに関連付けられている Azure キーコンテナーのリソース ID。
url	string	Batch アカウントに関連付けられている Azure キーコンテナーの URL。

NetworkProfile

Object

Batch アカウントのネットワークプロファイル。各エンドポイントのネットワークルール設定が含まれています。

名前	型	説明
accountAccess	EndpointAccessProfile	batchAccount エンドポイントのネットワークアクセスプロファイル (Batch アカウントデータプレーン API)。
nodeManagementAccess	EndpointAccessProfile	nodeManagement エンドポイントのネットワークアクセスプロファイル (Batch プールのコンピューティングノードを管理する Batch サービス)。

PoolAllocationMode

列挙

Batch アカウントでプールを作成するための割り当てモード。

値	説明
BatchService	プールは、Batch サービスが所有するサブスクリプションに割り当てられます。
UserSubscription	プールは、ユーザーが所有するサブスクリプションに割り当てられます。

PrivateEndpoint

Object

プライベートエンドポイント接続のプライベートエンドポイント。

名前	型	説明
id	string	プライベートエンドポイントの ARM リソース識別子。これは、/subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/privateEndpoints/{privateEndpoint} という形式です。

PrivateEndpointConnection

Object

プライベートリンクリソースに関する情報が含まれています。

名前	型	説明
etag	string	コンカレンシーステートメントに使用されるリソースの ETag。
id	string	リソースの ID。
name	string	リソースの名前。
properties.groupIds	string[]	プライベートエンドポイント接続のグループ ID。値のグループ ID は 1 つだけです。
properties.privateEndpoint	PrivateEndpoint	プライベートエンドポイントの ARM リソース識別子。プライベートエンドポイント接続のプライベートエンドポイント。
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	プライベートエンドポイント接続のプライベートリンクサービス接続状態。プライベートエンドポイント接続のプライベートリンクサービス接続状態
properties.provisioningState	PrivateEndpointConnectionProvisioningState	プライベートエンドポイント接続のプロビジョニング状態。
tags	object	リソースのタグ。
type	string	リソースの種類。

PrivateEndpointConnectionProvisioningState

列挙

プライベートエンドポイント接続のプロビジョニング状態。

値	説明
Cancelled	ユーザーが接続の作成を取り消しました。
Creating	接続が作成されています。
Deleting	接続が削除されています。
Failed	ユーザーが接続の更新を要求し、失敗しました。更新操作を再試行できます。
Succeeded	接続の状態は最終的であり、状態が承認されている場合は使用できる状態です。
Updating	ユーザーは接続の状態を更新することを要求しましたが、更新操作はまだ完了していません。 Batch アカウントを接続するときに接続を参照することはできません。

PrivateLinkServiceConnectionState

Object

プライベートエンドポイント接続のプライベートリンクサービス接続状態

名前	型	説明
actionsRequired	string	プライベート接続状態で必要なアクション
description	string	プライベート接続状態の説明
status	PrivateLinkServiceConnectionStatus	Batch アカウントのプライベートエンドポイント接続の状態

PrivateLinkServiceConnectionStatus

列挙

Batch プライベートエンドポイント接続の状態

値	説明
Approved	プライベートエンドポイント接続が承認され、Batch アカウントへのアクセスに使用できます
Disconnected	プライベートエンドポイント接続が切断され、Batch アカウントにアクセスするために使用できない
Pending	プライベートエンドポイント接続が保留中であり、Batch アカウントへのアクセスに使用できない
Rejected	プライベートエンドポイント接続が拒否され、Batch アカウントへのアクセスに使用できない

ProvisioningState

列挙

リソースのプロビジョニング済み状態

値	説明
Cancelled	アカウントの最後の操作は取り消されます。
Creating	アカウントが作成されています。
Deleting	アカウントが削除されています。
Failed	アカウントの最後の操作が失敗しました。
Invalid	アカウントが無効な状態です。
Succeeded	アカウントが作成され、使用する準備ができました。

PublicNetworkAccessType

列挙

Batch アカウント内のリソースで動作するためのネットワークアクセスの種類。

値	説明
Disabled	パブリック接続を無効にし、プライベートエンドポイントリソースを介した Azure Batch Service へのプライベート接続を有効にします。
Enabled	パブリック DNS を介した Azure Batch への接続を有効にします。
SecuredByPerimeter	NSP 構成を使用して Azure Batch への接続をセキュリティで保護します。

ResourceIdentityType

列挙

Batch アカウントに使用される ID の種類。

値	説明
None	Batch アカウントには ID が関連付けされません。更新アカウントで `None` を設定すると、既存の ID が削除されます。
SystemAssigned	Batch アカウントには、システム割り当て ID があります。
UserAssigned	Batch アカウントには、ユーザー割り当て ID があります。

UserAssignedIdentities

Object

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

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

VirtualMachineFamilyCoreQuota

Object

BATCH アカウントの VM ファミリとそれに関連付けられているコアクォータ。

名前	型	説明
coreQuota	integer (int32)	Batch アカウントの VM ファミリのコアクォータ。
name	string	仮想マシンファミリ名。

次の方法で共有

Batch Account - Get

URI パラメーター

応答

セキュリティ

azure_auth

スコープ

例

BatchAccountGet

要求のサンプル

応答のサンプル

PrivateBatchAccountGet

要求のサンプル

応答のサンプル

定義

AuthenticationMode

AutoStorageAuthenticationMode

AutoStorageProperties

BatchAccount

BatchAccountIdentity

CloudError

CloudErrorBody

ComputeNodeIdentityReference

EncryptionProperties

EndpointAccessDefaultAction

EndpointAccessProfile

IPRule

IPRuleAction

KeySource

KeyVaultProperties

KeyVaultReference

NetworkProfile

PoolAllocationMode

PrivateEndpoint

PrivateEndpointConnection

PrivateEndpointConnectionProvisioningState

PrivateLinkServiceConnectionState

PrivateLinkServiceConnectionStatus

ProvisioningState

PublicNetworkAccessType

ResourceIdentityType

UserAssignedIdentities

VirtualMachineFamilyCoreQuota

その他のリソース