Batch Account - Create

Referensi

Service:: Batch Management

API Version:: 2022-06-01

Membuat akun Batch baru dengan parameter yang ditentukan. Akun yang ada tidak dapat diperbarui dengan API ini dan sebagai gantinya harus diperbarui dengan API Perbarui Akun Batch.

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

Parameter URI

Name	In	Required	Type	Description
accountName	path	True	string	Nama untuk akun Batch yang harus unik dalam wilayah tersebut. Panjang nama akun batch harus antara 3 dan 24 karakter dan hanya boleh menggunakan angka dan huruf kecil. Nama ini digunakan sebagai bagian dari nama DNS yang digunakan untuk mengakses layanan Batch di wilayah tempat akun dibuat. Misalnya: http://accountname.region.batch.azure.com/. Regex pattern: `^[a-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-000000000000)
api-version	query	True	string	Versi API yang akan digunakan dengan permintaan HTTP.

Isi Permintaan

Name	Required	Type	Description
location	True	string	Wilayah tempat membuat akun.
identity		BatchAccountIdentity	Identitas akun Batch.
properties.allowedAuthenticationModes		string[]	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		AutoStorageBaseProperties	Properti yang terkait dengan akun penyimpanan otomatis.
properties.encryption		EncryptionProperties	Konfigurasi enkripsi untuk akun Batch. Mengonfigurasi cara data pelanggan dienkripsi di dalam akun Batch. Secara default, akun dienkripsi menggunakan kunci terkelola 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.
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.poolAllocationMode		PoolAllocationMode	Mode alokasi yang digunakan untuk membuat kumpulan di akun Batch. Mode alokasi kumpulan juga memengaruhi bagaimana klien dapat mengautentikasi ke API Layanan Batch. Jika modenya adalah BatchService, klien dapat mengautentikasi menggunakan kunci akses atau Azure Active Directory. Jika modenya adalah UserSubscription, klien harus menggunakan Azure Active Directory. Defaultnya adalah BatchService.
properties.publicNetworkAccess		PublicNetworkAccessType	Jenis akses jaringan untuk mengakses akun Azure Batch. Jika tidak ditentukan, nilai defaultnya adalah 'diaktifkan'.
tags		object	Tag yang ditentukan pengguna yang terkait dengan akun.

Respons

Name	Type	Description
200 OK	BatchAccount	Operasi berhasil. Respons berisi entitas akun Batch.
202 Accepted		Operasi akan diselesaikan secara asinkron. Headers Location: string Retry-After: integer
Other Status Codes	CloudError	Respons kesalahan yang menjelaskan mengapa operasi gagal.

Name

Type

Description

200 OK

BatchAccount

Operasi berhasil. Respons berisi entitas akun Batch.

202 Accepted

Operasi akan diselesaikan secara asinkron.

Headers

Location: string
Retry-After: integer

Other Status Codes

CloudError

Respons kesalahan yang menjelaskan mengapa operasi gagal.

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory

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

Scopes

Name	Description
user_impersonation	meniru akun pengguna Anda

Contoh

BatchAccountCreate_BYOS

BatchAccountCreate_Default

BatchAccountCreate_SystemAssignedIdentity

BatchAccountCreate_UserAssignedIdentity

PrivateBatchAccountCreate

BatchAccountCreate_BYOS

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

{
  "location": "japaneast",
  "properties": {
    "autoStorage": {
      "storageAccountId": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage"
    },
    "poolAllocationMode": "UserSubscription",
    "keyVaultReference": {
      "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.KeyVault/vaults/sample",
      "url": "http://sample.vault.azure.net/"
    }
  }
}

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

/**
 * This sample demonstrates how to Creates a new Batch account with the specified parameters. Existing accounts cannot be updated with this API and should instead be updated with the Update Batch Account API.
 *
 * @summary Creates a new Batch account with the specified parameters. Existing accounts cannot be updated with this API and should instead be updated with the Update Batch Account API.
 * x-ms-original-file: specification/batch/resource-manager/Microsoft.Batch/stable/2022-06-01/examples/BatchAccountCreate_BYOS.json
 */
async function batchAccountCreateByos() {
  const subscriptionId = "subid";
  const resourceGroupName = "default-azurebatch-japaneast";
  const accountName = "sampleacct";
  const parameters = {
    autoStorage: {
      storageAccountId:
        "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage",
    },
    keyVaultReference: {
      id: "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.KeyVault/vaults/sample",
      url: "http://sample.vault.azure.net/",
    },
    location: "japaneast",
    poolAllocationMode: "UserSubscription",
  };
  const credential = new DefaultAzureCredential();
  const client = new BatchManagementClient(credential, subscriptionId);
  const result = await client.batchAccountOperations.beginCreateAndWait(
    resourceGroupName,
    accountName,
    parameters
  );
  console.log(result);
}

batchAccountCreateByos().catch(console.error);

Read this SDK documentation on how to add the SDK to your project and authenticate.

Sample Response

Status code:: 202

Status code:: 200

{
  "name": "sampleacct",
  "location": "japaneast",
  "properties": {
    "accountEndpoint": "sampleacct.japaneast.batch.azure.com",
    "provisioningState": "Succeeded",
    "poolAllocationMode": "UserSubscription",
    "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"
    },
    "keyVaultReference": {
      "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.KeyVault/vaults/sample",
      "url": "http://sample.vault.azure.net/"
    },
    "publicNetworkAccess": "Enabled"
  },
  "identity": {
    "type": "None"
  },
  "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct",
  "type": "Microsoft.Batch/batchAccounts"
}

BatchAccountCreate_Default

Sample Request

HTTP
JavaScript

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

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

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

/**
 * This sample demonstrates how to Creates a new Batch account with the specified parameters. Existing accounts cannot be updated with this API and should instead be updated with the Update Batch Account API.
 *
 * @summary Creates a new Batch account with the specified parameters. Existing accounts cannot be updated with this API and should instead be updated with the Update Batch Account API.
 * x-ms-original-file: specification/batch/resource-manager/Microsoft.Batch/stable/2022-06-01/examples/BatchAccountCreate_Default.json
 */
async function batchAccountCreateDefault() {
  const subscriptionId = "subid";
  const resourceGroupName = "default-azurebatch-japaneast";
  const accountName = "sampleacct";
  const parameters = {
    autoStorage: {
      storageAccountId:
        "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage",
    },
    location: "japaneast",
  };
  const credential = new DefaultAzureCredential();
  const client = new BatchManagementClient(credential, subscriptionId);
  const result = await client.batchAccountOperations.beginCreateAndWait(
    resourceGroupName,
    accountName,
    parameters
  );
  console.log(result);
}

batchAccountCreateDefault().catch(console.error);

Read this SDK documentation on how to add the SDK to your project and authenticate.

Sample Response

Status code:: 202

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

BatchAccountCreate_SystemAssignedIdentity

Sample Request

HTTP
JavaScript

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

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

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

/**
 * This sample demonstrates how to Creates a new Batch account with the specified parameters. Existing accounts cannot be updated with this API and should instead be updated with the Update Batch Account API.
 *
 * @summary Creates a new Batch account with the specified parameters. Existing accounts cannot be updated with this API and should instead be updated with the Update Batch Account API.
 * x-ms-original-file: specification/batch/resource-manager/Microsoft.Batch/stable/2022-06-01/examples/BatchAccountCreate_SystemAssignedIdentity.json
 */
async function batchAccountCreateSystemAssignedIdentity() {
  const subscriptionId = "subid";
  const resourceGroupName = "default-azurebatch-japaneast";
  const accountName = "sampleacct";
  const parameters = {
    autoStorage: {
      storageAccountId:
        "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage",
    },
    identity: { type: "SystemAssigned" },
    location: "japaneast",
  };
  const credential = new DefaultAzureCredential();
  const client = new BatchManagementClient(credential, subscriptionId);
  const result = await client.batchAccountOperations.beginCreateAndWait(
    resourceGroupName,
    accountName,
    parameters
  );
  console.log(result);
}

batchAccountCreateSystemAssignedIdentity().catch(console.error);

Read this SDK documentation on how to add the SDK to your project and authenticate.

Sample Response

Status code:: 202

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": {
    "principalId": "1a2e532b-9900-414c-8600-cfc6126628d7",
    "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd",
    "type": "SystemAssigned"
  },
  "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct",
  "type": "Microsoft.Batch/batchAccounts"
}

BatchAccountCreate_UserAssignedIdentity

Sample Request

HTTP
JavaScript

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

{
  "location": "japaneast",
  "properties": {
    "autoStorage": {
      "storageAccountId": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage"
    }
  },
  "identity": {
    "type": "UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {}
    }
  }
}

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

/**
 * This sample demonstrates how to Creates a new Batch account with the specified parameters. Existing accounts cannot be updated with this API and should instead be updated with the Update Batch Account API.
 *
 * @summary Creates a new Batch account with the specified parameters. Existing accounts cannot be updated with this API and should instead be updated with the Update Batch Account API.
 * x-ms-original-file: specification/batch/resource-manager/Microsoft.Batch/stable/2022-06-01/examples/BatchAccountCreate_UserAssignedIdentity.json
 */
async function batchAccountCreateUserAssignedIdentity() {
  const subscriptionId = "subid";
  const resourceGroupName = "default-azurebatch-japaneast";
  const accountName = "sampleacct";
  const parameters = {
    autoStorage: {
      storageAccountId:
        "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage",
    },
    identity: {
      type: "UserAssigned",
      userAssignedIdentities: {
        "/subscriptions/subid/resourceGroups/defaultAzurebatchJapaneast/providers/MicrosoftManagedIdentity/userAssignedIdentities/id1":
          {},
      },
    },
    location: "japaneast",
  };
  const credential = new DefaultAzureCredential();
  const client = new BatchManagementClient(credential, subscriptionId);
  const result = await client.batchAccountOperations.beginCreateAndWait(
    resourceGroupName,
    accountName,
    parameters
  );
  console.log(result);
}

batchAccountCreateUserAssignedIdentity().catch(console.error);

Read this SDK documentation on how to add the SDK to your project and authenticate.

Sample Response

Status code:: 202

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": "UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {
        "principalId": "principalId1",
        "clientId": "clientId1"
      }
    }
  },
  "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct",
  "type": "Microsoft.Batch/batchAccounts"
}

PrivateBatchAccountCreate

Sample Request

HTTP
JavaScript

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

{
  "location": "japaneast",
  "properties": {
    "autoStorage": {
      "storageAccountId": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage"
    },
    "keyVaultReference": {
      "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.KeyVault/vaults/sample",
      "url": "http://sample.vault.azure.net/"
    },
    "publicNetworkAccess": "Disabled"
  }
}

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

/**
 * This sample demonstrates how to Creates a new Batch account with the specified parameters. Existing accounts cannot be updated with this API and should instead be updated with the Update Batch Account API.
 *
 * @summary Creates a new Batch account with the specified parameters. Existing accounts cannot be updated with this API and should instead be updated with the Update Batch Account API.
 * x-ms-original-file: specification/batch/resource-manager/Microsoft.Batch/stable/2022-06-01/examples/PrivateBatchAccountCreate.json
 */
async function privateBatchAccountCreate() {
  const subscriptionId = "subid";
  const resourceGroupName = "default-azurebatch-japaneast";
  const accountName = "sampleacct";
  const parameters = {
    autoStorage: {
      storageAccountId:
        "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage",
    },
    keyVaultReference: {
      id: "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.KeyVault/vaults/sample",
      url: "http://sample.vault.azure.net/",
    },
    location: "japaneast",
    publicNetworkAccess: "Disabled",
  };
  const credential = new DefaultAzureCredential();
  const client = new BatchManagementClient(credential, subscriptionId);
  const result = await client.batchAccountOperations.beginCreateAndWait(
    resourceGroupName,
    accountName,
    parameters
  );
  console.log(result);
}

privateBatchAccountCreate().catch(console.error);

Read this SDK documentation on how to add the SDK to your project and authenticate.

Sample Response

Status code:: 202

Status code:: 200

{
  "name": "sampleacct",
  "location": "japaneast",
  "properties": {
    "accountEndpoint": "sampleacct.japaneast.batch.azure.com",
    "provisioningState": "Succeeded",
    "poolAllocationMode": "UserSubscription",
    "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"
    },
    "keyVaultReference": {
      "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.KeyVault/vaults/sample",
      "url": "http://sample.vault.azure.net/"
    },
    "publicNetworkAccess": "Disabled"
  },
  "identity": {
    "type": "None"
  },
  "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct",
  "type": "Microsoft.Batch/batchAccounts"
}

Definisi

AutoStorageAuthenticationMode	Mode autentikasi yang akan digunakan layanan Batch untuk mengelola akun penyimpanan otomatis.
AutoStorageBaseProperties	Properti yang terkait dengan akun penyimpanan otomatis.
AutoStorageProperties	Berisi informasi tentang akun penyimpanan otomatis yang terkait dengan akun Batch.
BatchAccount	Berisi informasi tentang akun Azure Batch.
BatchAccountCreateParameters	Parameter yang disediakan untuk operasi Buat.
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.

AutoStorageAuthenticationMode

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

Name	Type	Description
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.

AutoStorageBaseProperties

Properti yang terkait dengan akun penyimpanan otomatis.

Name	Type	Default Value	Description
authenticationMode	AutoStorageAuthenticationMode	StorageKeys	Mode autentikasi yang akan digunakan layanan Batch untuk mengelola akun penyimpanan otomatis.
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.

AutoStorageProperties

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

Name	Type	Default Value	Description
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.

Name	Type	Default Value	Description
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	string[]		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.

BatchAccountCreateParameters

Parameter yang disediakan untuk operasi Buat.

Name	Type	Default Value	Description
identity	BatchAccountIdentity		Identitas akun Batch.
location	string		Wilayah tempat membuat akun.
properties.allowedAuthenticationModes	string[]		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	AutoStorageBaseProperties		Properti yang terkait dengan akun penyimpanan otomatis.
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.
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.poolAllocationMode	PoolAllocationMode		Mode alokasi yang digunakan untuk membuat kumpulan di akun Batch. Mode alokasi kumpulan juga memengaruhi bagaimana klien dapat mengautentikasi ke API Layanan Batch. Jika modenya adalah BatchService, klien dapat mengautentikasi menggunakan kunci akses atau Azure Active Directory. Jika modenya adalah UserSubscription, klien harus menggunakan Azure Active Directory. Defaultnya adalah BatchService.
properties.publicNetworkAccess	PublicNetworkAccessType	Enabled	Jenis akses jaringan untuk mengakses akun Azure Batch. Jika tidak ditentukan, nilai defaultnya adalah 'diaktifkan'.
tags	object		Tag yang ditentukan pengguna yang terkait dengan akun.

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.

Name	Type	Description
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	<string, UserAssignedIdentities>	Daftar identitas pengguna yang terkait dengan akun Batch.

CloudError

Respons kesalahan dari layanan Batch.

Name	Type	Description
error	CloudErrorBody	Isi respons kesalahan.

CloudErrorBody

Respons kesalahan dari layanan Batch.

Name	Type	Description
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.

Name	Type	Description
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.

Name	Type	Description
keySource	KeySource	Jenis sumber kunci.
keyVaultProperties	KeyVaultProperties	Detail tambahan saat menggunakan Microsoft.KeyVault

EndpointAccessDefaultAction

Tindakan default ketika tidak ada IPRule yang cocok.

Name	Type	Description
Allow	string	Izinkan akses klien.
Deny	string	Tolak akses klien.

EndpointAccessProfile

Profil akses jaringan untuk titik akhir Batch.

Name	Type	Description
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.

Name	Type	Description
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.

Name	Type	Description
Allow	string	Izinkan akses untuk alamat IP klien yang cocok.

KeySource

Jenis sumber kunci.

Name	Type	Description
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.

Name	Type	Description
keyIdentifier	string	Jalur lengkap ke rahasia versi. Contoh https://mykeyvault.vault.azure.net/keys/testkey/6e34a81fef704045975661e297a4c053. 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

Name

Type

Description

keyIdentifier

string

Jalur lengkap ke rahasia versi. Contoh https://mykeyvault.vault.azure.net/keys/testkey/6e34a81fef704045975661e297a4c053. 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.

Name	Type	Description
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.

Name	Type	Description
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.

Name	Type	Description
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.

Name	Type	Description
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.

Name	Type	Description
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.

Name	Type	Description
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

Name	Type	Description
actionRequired	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

Name	Type	Description
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

Name	Type	Description
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.

Name	Type	Description
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.

Name	Type	Description
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.

Name	Type	Description
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.

Name	Type	Description
coreQuota	integer	Kuota inti untuk keluarga VM untuk akun Batch.
name	string	Nama keluarga Komputer Virtual.