Batch Account - Get

Referensi

Service:: Batch Management

API Version:: 2024-02-01

Mendapatkan informasi tentang akun Batch yang ditentukan.

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
accountName	path	True	string	Nama akun Batch. Regex pattern: `^[a-zA-Z0-9]+$`
resourceGroupName	path	True	string	Nama grup sumber daya yang berisi akun Batch.
subscriptionId	path	True	string	Atur ID Langganan Azure. Ini adalah string berformat GUID (misalnya 000000000-0000-0000-0000-00000000000)
api-version	query	True	string	Versi API yang akan digunakan dengan permintaan HTTP.

Respons

Nama	Jenis	Deskripsi
200 OK	BatchAccount	Operasi berhasil. Respons berisi entitas akun Batch.
Other Status Codes	CloudError	Respons kesalahan yang menjelaskan mengapa operasi gagal.

Keamanan

azure_auth

Microsoft Entra alur kode autentikasi OAuth 2.0

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

Scopes

Nama	Deskripsi
user_impersonation	meniru akun pengguna Anda

Contoh

BatchAccountGet

PrivateBatchAccountGet

BatchAccountGet

Sample Request

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


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

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

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

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

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


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

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


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

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

package armbatch_test

import (
	"context"
	"log"

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

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

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

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

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

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

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

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

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

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

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

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

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

Sample Response

Status code:: 200

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

PrivateBatchAccountGet

Sample Request

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


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

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

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

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

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


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

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


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

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

package armbatch_test

import (
	"context"
	"log"

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

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

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

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

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

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

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

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

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

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

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

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

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

Sample Response

Status code:: 200

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

Definisi

Nama	Deskripsi
AuthenticationMode	Mode autentikasi untuk akun Batch.
AutoStorageAuthenticationMode	Mode autentikasi yang akan digunakan layanan Batch untuk mengelola akun penyimpanan otomatis.
AutoStorageProperties	Berisi informasi tentang akun penyimpanan otomatis yang terkait dengan akun Batch.
BatchAccount	Berisi informasi tentang akun Azure Batch.
BatchAccountIdentity	Identitas akun Batch, jika dikonfigurasi. Ini digunakan ketika pengguna menentukan 'Microsoft.KeyVault' sebagai konfigurasi enkripsi akun Batch mereka atau ketika `ManagedIdentity` dipilih sebagai mode autentikasi penyimpanan otomatis.
CloudError	Respons kesalahan dari layanan Batch.
CloudErrorBody	Respons kesalahan dari layanan Batch.
ComputeNodeIdentityReference	Referensi ke identitas yang ditetapkan pengguna yang terkait dengan kumpulan Batch yang akan digunakan simpul komputasi.
EncryptionProperties	Mengonfigurasi cara data pelanggan dienkripsi di dalam akun Batch. Secara default, akun dienkripsi menggunakan kunci yang dikelola Microsoft. Untuk kontrol tambahan, kunci yang dikelola pelanggan dapat digunakan sebagai gantinya.
EndpointAccessDefaultAction	Tindakan default ketika tidak ada IPRule yang cocok.
EndpointAccessProfile	Profil akses jaringan untuk titik akhir Batch.
IPRule	Aturan untuk memfilter alamat IP klien.
IPRuleAction	Tindakan saat alamat IP klien dicocokkan.
KeySource	Jenis sumber kunci.
KeyVaultProperties	Konfigurasi KeyVault saat menggunakan KeySource enkripsi Microsoft.KeyVault.
KeyVaultReference	Mengidentifikasi brankas kunci Azure yang terkait dengan akun Batch.
NetworkProfile	Profil jaringan untuk akun Batch, yang berisi pengaturan aturan jaringan untuk setiap titik akhir.
PoolAllocationMode	Mode alokasi untuk membuat kumpulan di akun Batch.
PrivateEndpoint	Titik akhir privat koneksi titik akhir privat.
PrivateEndpointConnection	Berisi informasi tentang sumber daya tautan privat.
PrivateEndpointConnectionProvisioningState	Status penyediaan koneksi titik akhir privat.
PrivateLinkServiceConnectionState	Status koneksi layanan tautan privat dari koneksi titik akhir privat
PrivateLinkServiceConnectionStatus	Status koneksi titik akhir privat Batch
ProvisioningState	Status sumber daya yang disediakan
PublicNetworkAccessType	Jenis akses jaringan untuk beroperasi pada sumber daya di akun Batch.
ResourceIdentityType	Jenis identitas yang digunakan untuk akun Batch.
UserAssignedIdentities	Daftar identitas pengguna terkait.
VirtualMachineFamilyCoreQuota	Keluarga VM dan kuota inti terkait untuk akun Batch.

AuthenticationMode

Mode autentikasi untuk akun Batch.

Nama	Jenis	Deskripsi
AAD	string	Mode autentikasi menggunakan Microsoft Entra ID.
SharedKey	string	Mode autentikasi menggunakan kunci bersama.
TaskAuthenticationToken	string	Mode autentikasi menggunakan token autentikasi tugas.

AutoStorageAuthenticationMode

Mode autentikasi yang akan digunakan layanan Batch untuk mengelola akun penyimpanan otomatis.

Nama	Jenis	Deskripsi
BatchAccountManagedIdentity	string	Layanan Batch akan mengautentikasi permintaan ke penyimpanan otomatis menggunakan identitas terkelola yang ditetapkan ke akun Batch.
StorageKeys	string	Layanan Batch akan mengautentikasi permintaan ke penyimpanan otomatis menggunakan kunci akun penyimpanan.

AutoStorageProperties

Berisi informasi tentang akun penyimpanan otomatis yang terkait dengan akun Batch.

Nama	Jenis	Nilai Default	Deskripsi
authenticationMode	AutoStorageAuthenticationMode	StorageKeys	Mode autentikasi yang akan digunakan layanan Batch untuk mengelola akun penyimpanan otomatis.
lastKeySync	string		Waktu UTC di mana kunci penyimpanan terakhir disinkronkan dengan akun Batch.
nodeIdentityReference	ComputeNodeIdentityReference		Referensi ke identitas yang ditetapkan pengguna yang akan digunakan simpul komputasi untuk mengakses penyimpanan otomatis. Identitas yang direferensikan di sini harus ditetapkan ke kumpulan yang memiliki simpul komputasi yang memerlukan akses ke penyimpanan otomatis.
storageAccountId	string		ID sumber daya akun penyimpanan yang akan digunakan untuk akun penyimpanan otomatis.

BatchAccount

Berisi informasi tentang akun Azure Batch.

Nama	Jenis	Nilai Default	Deskripsi
id	string		ID sumber daya.
identity	BatchAccountIdentity		Identitas akun Batch.
location	string		Lokasi sumber daya.
name	string		Nama sumber daya.
properties.accountEndpoint	string		Titik akhir akun yang digunakan untuk berinteraksi dengan layanan Batch.
properties.activeJobAndJobScheduleQuota	integer		Kuota jadwal pekerjaan dan pekerjaan aktif untuk akun Batch.
properties.allowedAuthenticationModes	AuthenticationMode[]		Daftar mode autentikasi yang diizinkan untuk akun Batch yang dapat digunakan untuk mengautentikasi dengan bidang data. Ini tidak memengaruhi autentikasi dengan sarana kontrol.
properties.autoStorage	AutoStorageProperties		Properti dan status akun penyimpanan otomatis apa pun yang terkait dengan akun Batch. Berisi informasi tentang akun penyimpanan otomatis yang terkait dengan akun Batch.
properties.dedicatedCoreQuota	integer		Kuota inti khusus untuk akun Batch. Untuk akun dengan PoolAllocationMode yang diatur ke UserSubscription, kuota dikelola pada langganan sehingga nilai ini tidak dikembalikan.
properties.dedicatedCoreQuotaPerVMFamily	VirtualMachineFamilyCoreQuota[]		Daftar kuota inti khusus per keluarga Komputer Virtual untuk akun Batch. Untuk akun dengan PoolAllocationMode yang diatur ke UserSubscription, kuota dikelola pada langganan sehingga nilai ini tidak dikembalikan.
properties.dedicatedCoreQuotaPerVMFamilyEnforced	boolean		Nilai yang menunjukkan apakah kuota inti per keluarga Komputer Virtual diberlakukan untuk akun ini Jika bendera ini benar, kuota inti khusus diberlakukan melalui properti dedicatedCoreQuotaPerVMFamily dan dedicatedCoreQuota pada akun. Jika bendera ini salah, kuota inti khusus hanya diberlakukan melalui properti dedicatedCoreQuota pada akun dan tidak mempertimbangkan keluarga Komputer Virtual.
properties.encryption	EncryptionProperties		Konfigurasi enkripsi untuk akun Batch. Mengonfigurasi cara data pelanggan dienkripsi di dalam akun Batch. Secara default, akun dienkripsi menggunakan kunci yang dikelola Microsoft. Untuk kontrol tambahan, kunci yang dikelola pelanggan dapat digunakan sebagai gantinya.
properties.keyVaultReference	KeyVaultReference		Referensi ke brankas kunci Azure yang terkait dengan akun Batch. Mengidentifikasi brankas kunci Azure yang terkait dengan akun Batch.
properties.lowPriorityCoreQuota	integer		Kuota inti Spot/berprioritas rendah untuk akun Batch. Untuk akun dengan PoolAllocationMode yang diatur ke UserSubscription, kuota dikelola pada langganan sehingga nilai ini tidak dikembalikan.
properties.networkProfile	NetworkProfile		Profil jaringan untuk akun Batch, yang berisi pengaturan aturan jaringan untuk setiap titik akhir. Profil jaringan hanya berlaku ketika publicNetworkAccess diaktifkan.
properties.nodeManagementEndpoint	string		Titik akhir yang digunakan oleh simpul komputasi untuk menyambungkan ke layanan manajemen simpul Batch.
properties.poolAllocationMode	PoolAllocationMode		Mode alokasi yang digunakan untuk membuat kumpulan di akun Batch. Mode alokasi untuk membuat kumpulan di akun Batch.
properties.poolQuota	integer		Kuota kumpulan untuk akun Batch.
properties.privateEndpointConnections	PrivateEndpointConnection[]		Daftar koneksi titik akhir privat yang terkait dengan akun Batch
properties.provisioningState	ProvisioningState		Status sumber daya yang disediakan
properties.publicNetworkAccess	PublicNetworkAccessType	Enabled	Jenis antarmuka jaringan untuk mengakses layanan Azure Batch dan operasi akun Batch. Jika tidak ditentukan, nilai defaultnya adalah 'diaktifkan'.
tags	object		Tag sumber daya.
type	string		Jenis sumber daya.

BatchAccountIdentity

Identitas akun Batch, jika dikonfigurasi. Ini digunakan ketika pengguna menentukan 'Microsoft.KeyVault' sebagai konfigurasi enkripsi akun Batch mereka atau ketika ManagedIdentity dipilih sebagai mode autentikasi penyimpanan otomatis.

Nama	Jenis	Deskripsi
principalId	string	Id utama akun Batch. Properti ini hanya akan disediakan untuk identitas yang ditetapkan sistem.
tenantId	string	Id penyewa yang terkait dengan akun Batch. Properti ini hanya akan disediakan untuk identitas yang ditetapkan sistem.
type	ResourceIdentityType	Jenis identitas yang digunakan untuk akun Batch.
userAssignedIdentities	object	Daftar identitas pengguna yang terkait dengan akun Batch.

CloudError

Respons kesalahan dari layanan Batch.

Nama	Jenis	Deskripsi
error	CloudErrorBody	Isi respons kesalahan.

CloudErrorBody

Respons kesalahan dari layanan Batch.

Nama	Jenis	Deskripsi
code	string	Pengidentifikasi untuk kesalahan. Kode tidak berubah dan dimaksudkan untuk dikonsumsi secara terprogram.
details	CloudErrorBody[]	Daftar detail tambahan tentang kesalahan tersebut.
message	string	Pesan yang menjelaskan kesalahan, dimaksudkan agar cocok untuk ditampilkan di antarmuka pengguna.
target	string	Target kesalahan tertentu. Misalnya, nama properti dalam kesalahan.

ComputeNodeIdentityReference

Referensi ke identitas yang ditetapkan pengguna yang terkait dengan kumpulan Batch yang akan digunakan simpul komputasi.

Nama	Jenis	Deskripsi
resourceId	string	Id sumber daya ARM dari identitas yang ditetapkan pengguna.

EncryptionProperties

Mengonfigurasi cara data pelanggan dienkripsi di dalam akun Batch. Secara default, akun dienkripsi menggunakan kunci yang dikelola Microsoft. Untuk kontrol tambahan, kunci yang dikelola pelanggan dapat digunakan sebagai gantinya.

Nama	Jenis	Deskripsi
keySource	KeySource	Jenis sumber kunci.
keyVaultProperties	KeyVaultProperties	Detail tambahan saat menggunakan Microsoft.KeyVault

EndpointAccessDefaultAction

Tindakan default ketika tidak ada IPRule yang cocok.

Nama	Jenis	Deskripsi
Allow	string	Izinkan akses klien.
Deny	string	Tolak akses klien.

EndpointAccessProfile

Profil akses jaringan untuk titik akhir Batch.

Nama	Jenis	Deskripsi
defaultAction	EndpointAccessDefaultAction	Tindakan default ketika tidak ada IPRule yang cocok. Tindakan default untuk akses titik akhir. Ini hanya berlaku ketika publicNetworkAccess diaktifkan.
ipRules	IPRule[]	Array rentang IP untuk memfilter alamat IP klien.

IPRule

Aturan untuk memfilter alamat IP klien.

Nama	Jenis	Deskripsi
action	IPRuleAction	Tindakan saat alamat IP klien dicocokkan.
value	string	Alamat IP atau rentang alamat IP untuk difilter Alamat IPv4, atau rentang alamat IPv4 dalam format CIDR.

IPRuleAction

Tindakan saat alamat IP klien dicocokkan.

Nama	Jenis	Deskripsi
Allow	string	Izinkan akses untuk alamat IP klien yang cocok.

KeySource

Jenis sumber kunci.

Nama	Jenis	Deskripsi
Microsoft.Batch	string	Batch membuat dan mengelola kunci enkripsi yang digunakan untuk melindungi data akun.
Microsoft.KeyVault	string	Kunci enkripsi yang digunakan untuk melindungi data akun disimpan dalam brankas kunci eksternal. Jika ini diatur maka identitas Akun Batch harus diatur ke `SystemAssigned` dan Pengidentifikasi Kunci yang valid juga harus disediakan di bawah keyVaultProperties.

KeyVaultProperties

Konfigurasi KeyVault saat menggunakan KeySource enkripsi Microsoft.KeyVault.

Nama	Jenis	Deskripsi
keyIdentifier	string	Jalur lengkap ke rahasia dengan atau tanpa versi. Contoh https://mykeyvault.vault.azure.net/keys/testkey/6e34a81fef704045975661e297a4c053. atau https://mykeyvault.vault.azure.net/keys/testkey. Agar dapat digunakan, prasyarat berikut harus dipenuhi: Akun Batch memiliki identitas yang Ditetapkan Sistem Identitas akun telah diberikan izin Kunci/Dapatkan, Kunci/Buka Bungkus dan Kunci/Bungkus KeyVault mengaktifkan penghapusan sementara dan perlindungan penghapusan menyeluruh

Nama

Jenis

Deskripsi

keyIdentifier

string

Jalur lengkap ke rahasia dengan atau tanpa versi. Contoh https://mykeyvault.vault.azure.net/keys/testkey/6e34a81fef704045975661e297a4c053. atau https://mykeyvault.vault.azure.net/keys/testkey. Agar dapat digunakan, prasyarat berikut harus dipenuhi:

Akun Batch memiliki identitas yang Ditetapkan Sistem Identitas akun telah diberikan izin Kunci/Dapatkan, Kunci/Buka Bungkus dan Kunci/Bungkus KeyVault mengaktifkan penghapusan sementara dan perlindungan penghapusan menyeluruh

KeyVaultReference

Mengidentifikasi brankas kunci Azure yang terkait dengan akun Batch.

Nama	Jenis	Deskripsi
id	string	ID sumber daya brankas kunci Azure yang terkait dengan akun Batch.
url	string	URL brankas kunci Azure yang terkait dengan akun Batch.

NetworkProfile

Profil jaringan untuk akun Batch, yang berisi pengaturan aturan jaringan untuk setiap titik akhir.

Nama	Jenis	Deskripsi
accountAccess	EndpointAccessProfile	Profil akses jaringan untuk titik akhir batchAccount (API sarana data akun Batch).
nodeManagementAccess	EndpointAccessProfile	Profil akses jaringan untuk titik akhir nodeManagement (layanan Batch mengelola simpul komputasi untuk kumpulan Batch).

PoolAllocationMode

Mode alokasi untuk membuat kumpulan di akun Batch.

Nama	Jenis	Deskripsi
BatchService	string	Kumpulan akan dialokasikan dalam langganan yang dimiliki oleh layanan Batch.
UserSubscription	string	Kumpulan akan dialokasikan dalam langganan yang dimiliki oleh pengguna.

PrivateEndpoint

Titik akhir privat koneksi titik akhir privat.

Nama	Jenis	Deskripsi
id	string	Pengidentifikasi sumber daya ARM dari titik akhir privat. Ini adalah formulir /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/privateEndpoints/{privateEndpoint}.

PrivateEndpointConnection

Berisi informasi tentang sumber daya tautan privat.

Nama	Jenis	Deskripsi
etag	string	ETag sumber daya, digunakan untuk pernyataan konkurensi.
id	string	ID sumber daya.
name	string	Nama sumber daya.
properties.groupIds	string[]	Id grup koneksi titik akhir privat. Nilai memiliki satu dan hanya satu id grup.
properties.privateEndpoint	PrivateEndpoint	Pengidentifikasi sumber daya ARM dari titik akhir privat. Titik akhir privat koneksi titik akhir privat.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Status koneksi layanan tautan privat dari koneksi titik akhir privat. Status koneksi layanan tautan privat dari koneksi titik akhir privat
properties.provisioningState	PrivateEndpointConnectionProvisioningState	Status penyediaan koneksi titik akhir privat.
type	string	Jenis sumber daya.

PrivateEndpointConnectionProvisioningState

Status penyediaan koneksi titik akhir privat.

Nama	Jenis	Deskripsi
Cancelled	string	Pengguna telah membatalkan pembuatan koneksi.
Creating	string	Koneksi sedang dibuat.
Deleting	string	Koneksi sedang dihapus.
Failed	string	Pengguna meminta agar koneksi diperbarui dan gagal. Anda dapat mencoba kembali operasi pembaruan.
Succeeded	string	Status koneksi sudah final dan siap digunakan jika Status Disetujui.
Updating	string	Pengguna telah meminta agar status koneksi diperbarui, tetapi operasi pembaruan belum selesai. Anda mungkin tidak mereferensikan koneksi saat menyambungkan akun Batch.

PrivateLinkServiceConnectionState

Status koneksi layanan tautan privat dari koneksi titik akhir privat

Nama	Jenis	Deskripsi
actionsRequired	string	Tindakan yang diperlukan pada status koneksi privat
description	string	Deskripsi status Koneksi privat
status	PrivateLinkServiceConnectionStatus	Status untuk koneksi titik akhir privat akun Batch

PrivateLinkServiceConnectionStatus

Status koneksi titik akhir privat Batch

Nama	Jenis	Deskripsi
Approved	string	Koneksi titik akhir privat disetujui dan dapat digunakan untuk mengakses akun Batch
Disconnected	string	Koneksi titik akhir privat terputus dan tidak dapat digunakan untuk mengakses akun Batch
Pending	string	Koneksi titik akhir privat tertunda dan tidak dapat digunakan untuk mengakses akun Batch
Rejected	string	Koneksi titik akhir privat ditolak dan tidak dapat digunakan untuk mengakses akun Batch

ProvisioningState

Status sumber daya yang disediakan

Nama	Jenis	Deskripsi
Cancelled	string	Operasi terakhir untuk akun dibatalkan.
Creating	string	Akun sedang dibuat.
Deleting	string	Akun sedang dihapus.
Failed	string	Operasi terakhir untuk akun gagal.
Invalid	string	Akun dalam status tidak valid.
Succeeded	string	Akun telah dibuat dan siap digunakan.

PublicNetworkAccessType

Jenis akses jaringan untuk beroperasi pada sumber daya di akun Batch.

Nama	Jenis	Deskripsi
Disabled	string	Menonaktifkan konektivitas publik dan memungkinkan konektivitas privat untuk Azure Batch Layanan melalui sumber daya titik akhir privat.
Enabled	string	Memungkinkan konektivitas Azure Batch melalui DNS publik.

ResourceIdentityType

Jenis identitas yang digunakan untuk akun Batch.

Nama	Jenis	Deskripsi
None	string	Akun Batch tidak memiliki identitas yang terkait dengannya. Pengaturan `None` di akun pembaruan akan menghapus identitas yang ada.
SystemAssigned	string	Akun Batch memiliki identitas yang ditetapkan sistem dengannya.
UserAssigned	string	Akun Batch memiliki identitas yang ditetapkan pengguna dengannya.

UserAssignedIdentities

Daftar identitas pengguna terkait.

Nama	Jenis	Deskripsi
clientId	string	Id klien identitas yang ditetapkan pengguna.
principalId	string	Id utama identitas yang ditetapkan pengguna.

VirtualMachineFamilyCoreQuota

Keluarga VM dan kuota inti terkait untuk akun Batch.

Nama	Jenis	Deskripsi
coreQuota	integer	Kuota inti untuk keluarga VM untuk akun Batch.
name	string	Nama keluarga Komputer Virtual.

Bagikan melalui

Batch Account - Get

Parameter URI

Respons

Keamanan

azure_auth

Scopes

Contoh

BatchAccountGet

Sample Request

Sample Response

PrivateBatchAccountGet

Sample Request

Sample Response

Definisi

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

Sumber Daya Tambahan: