Batch Account - Create

Layanan:: Batch Management

Versi API:: 2020-03-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=2020-03-01

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
accountName	path	True	string minLength: 3 maxLength: 24 pattern: ^[a-z0-9]+$	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/`.
resourceGroupName	path	True	string	Nama grup sumber daya yang berisi akun Batch.
subscriptionId	path	True	string	ID langganan Azure. Ini adalah string berformat GUID (misalnya 00000000-0000-0000-0000-0000000000000)
api-version	query	True	string	Versi API yang akan digunakan dengan permintaan HTTP.

Isi Permintaan

Nama	Diperlukan	Jenis	Deskripsi
location	True	string	Wilayah tempat membuat akun.
properties.autoStorage		AutoStorageBaseProperties	Properti yang terkait dengan akun penyimpanan otomatis.
properties.encryption		EncryptionProperties	Konfigurasi enkripsi untuk akun Batch.
properties.keyVaultReference		KeyVaultReference	Referensi ke brankas kunci Azure yang terkait dengan akun Batch.
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

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

Nama

Jenis

Deskripsi

200 OK

BatchAccount

Operasi berhasil. Respons berisi entitas akun Batch.

202 Accepted

Operasi akan diselesaikan secara asinkron.

Header

Location: string
Retry-After: integer

Other Status Codes

CloudError

Respons kesalahan yang menjelaskan mengapa operasi gagal.

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory

Jenis: oauth2
Alur: implicit
URL Otorisasi: https://login.microsoftonline.com/common/oauth2/authorize

Cakupan

Nama	Deskripsi
user_impersonation	meniru akun pengguna Anda

Contoh

BatchAccountCreate_BYOS

BatchAccountCreate_Default

PrivateBatchAccountCreate

BatchAccountCreate_BYOS

Permintaan sampel

HTTP

PUT https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct?api-version=2020-03-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/"
    }
  }
}

Respon sampel

Kode status:: 202

Kode status:: 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"
  },
  "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct",
  "type": "Microsoft.Batch/batchAccounts"
}

BatchAccountCreate_Default

Permintaan sampel

HTTP

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

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

Respon sampel

Kode status:: 202

Kode status:: 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"
  },
  "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct",
  "type": "Microsoft.Batch/batchAccounts"
}

PrivateBatchAccountCreate

Permintaan sampel

HTTP

PUT https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct?api-version=2020-03-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"
  }
}

Respon sampel

Kode status:: 202

Kode status:: 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"
  },
  "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct",
  "type": "Microsoft.Batch/batchAccounts"
}

Definisi

Nama	Deskripsi
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.
CloudError	Respons kesalahan dari layanan Batch.
CloudErrorBody	Respons kesalahan dari layanan Batch.
EncryptionProperties
KeySource	Jenis sumber kunci.
KeyVaultProperties
KeyVaultReference	Mengidentifikasi brankas kunci Azure yang terkait dengan akun Batch.
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 provisi 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.
VirtualMachineFamilyCoreQuota	Keluarga VM dan kuota inti terkait untuk akun Batch.

AutoStorageBaseProperties

Objek

Properti yang terkait dengan akun penyimpanan otomatis.

Nama	Jenis	Deskripsi
storageAccountId	string	ID sumber daya akun penyimpanan yang akan digunakan untuk akun penyimpanan otomatis.

AutoStorageProperties

Objek

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

Nama	Jenis	Deskripsi
lastKeySync	string (date-time)	Waktu UTC di mana kunci penyimpanan terakhir disinkronkan dengan akun Batch.
storageAccountId	string	ID sumber daya akun penyimpanan yang akan digunakan untuk akun penyimpanan otomatis.

BatchAccount

Objek

Berisi informasi tentang akun Azure Batch.

Nama	Jenis	Nilai default	Deskripsi
id	string		ID sumber daya.
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 (int32)		Kuota jadwal pekerjaan dan pekerjaan aktif untuk akun Batch.
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 (int32)		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 untuk Akun Batch diberlakukan per keluarga Komputer Virtual atau tidak. Batch sedang mentransisikan sistem kuota intinya untuk inti khusus yang akan diberlakukan per keluarga Komputer Virtual. Selama fase transisi ini, kuota inti khusus per keluarga Komputer Virtual mungkin belum diberlakukan. Jika bendera ini salah, kuota inti khusus diberlakukan melalui properti dedicatedCoreQuota lama pada akun dan tidak mempertimbangkan keluarga Komputer Virtual. Jika bendera ini benar, kuota inti khusus diberlakukan melalui properti dedicatedCoreQuotaPerVMFamily pada akun, dan dedicatedCoreQuota lama tidak berlaku.
properties.encryption	EncryptionProperties		Konfigurasi enkripsi untuk akun Batch.
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 (int32)		Kuota inti berprioritas rendah untuk akun Batch. Untuk akun dengan PoolAllocationMode yang diatur ke UserSubscription, kuota dikelola pada langganan sehingga nilai ini tidak dikembalikan.
properties.poolAllocationMode	PoolAllocationMode		Mode alokasi yang digunakan untuk membuat kumpulan di akun Batch. Mode alokasi untuk membuat kumpulan di akun Batch.
properties.poolQuota	integer (int32)		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

Objek

Parameter yang disediakan untuk operasi Buat.

Nama	Jenis	Nilai default	Deskripsi
location	string		Wilayah tempat membuat akun.
properties.autoStorage	AutoStorageBaseProperties		Properti yang terkait dengan akun penyimpanan otomatis.
properties.encryption	EncryptionProperties		Konfigurasi enkripsi untuk akun Batch.
properties.keyVaultReference	KeyVaultReference		Referensi ke brankas kunci Azure yang terkait dengan akun Batch.
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.

CloudError

Objek

Respons kesalahan dari layanan Batch.

Nama	Jenis	Deskripsi
error	CloudErrorBody	Respons kesalahan dari layanan Batch.

CloudErrorBody

Objek

Respons kesalahan dari layanan Batch.

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

EncryptionProperties

Objek

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

KeySource

Enumeration

Jenis sumber kunci.

Nilai	Deskripsi
Microsoft.Batch	Batch membuat dan mengelola kunci enkripsi yang digunakan untuk melindungi data akun.
Microsoft.KeyVault	Kunci enkripsi yang digunakan untuk melindungi data akun disimpan dalam brankas kunci eksternal.

KeyVaultProperties

Objek

Nama	Jenis	Deskripsi
keyIdentifier	string	Jalur lengkap ke rahasia versi. Contoh `https://mykeyvault.vault.azure.net/keys/testkey/6e34a81fef704045975661e297a4c053`

KeyVaultReference

Objek

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.

PoolAllocationMode

Enumeration

Mode alokasi untuk membuat kumpulan di akun Batch.

Nilai	Deskripsi
BatchService	Kumpulan akan dialokasikan dalam langganan yang dimiliki oleh layanan Batch.
UserSubscription	Kumpulan akan dialokasikan dalam langganan yang dimiliki oleh pengguna.

PrivateEndpoint

Objek

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

Objek

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.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 provisi koneksi titik akhir privat.
type	string	Jenis sumber daya.

PrivateEndpointConnectionProvisioningState

Enumeration

Status provisi koneksi titik akhir privat.

Nilai	Deskripsi
Failed	Pengguna meminta agar koneksi diperbarui dan gagal. Anda dapat mencoba kembali operasi pembaruan.
Succeeded	Status koneksi bersifat final dan siap digunakan jika Status Disetujui.
Updating	Pengguna telah meminta agar status koneksi diperbarui, tetapi operasi pembaruan belum selesai. Anda mungkin tidak mereferensikan koneksi saat menyambungkan akun Batch.

PrivateLinkServiceConnectionState

Objek

Status koneksi layanan tautan privat dari koneksi titik akhir privat

Nama	Jenis	Deskripsi
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

Enumeration

Status koneksi titik akhir privat Batch

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

ProvisioningState

Enumeration

Status sumber daya yang disediakan

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

PublicNetworkAccessType

Enumeration

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

Nilai	Deskripsi
Disabled	Menonaktifkan konektivitas publik dan memungkinkan konektivitas privat ke Azure Batch Service melalui sumber daya titik akhir privat.
Enabled	Memungkinkan konektivitas ke Azure Batch melalui DNS publik.

VirtualMachineFamilyCoreQuota

Objek

Keluarga VM dan kuota inti terkait untuk akun Batch.

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

Bagikan melalui

Batch Account - Create

Parameter URI

Isi Permintaan

Respons

Keamanan

azure_auth

Cakupan

Contoh

BatchAccountCreate_BYOS

Permintaan sampel

Respon sampel

BatchAccountCreate_Default

Permintaan sampel

Respon sampel

PrivateBatchAccountCreate

Permintaan sampel

Respon sampel

Definisi

AutoStorageBaseProperties

AutoStorageProperties

BatchAccount

BatchAccountCreateParameters

CloudError

CloudErrorBody

EncryptionProperties

KeySource

KeyVaultProperties

KeyVaultReference

PoolAllocationMode

PrivateEndpoint

PrivateEndpointConnection

PrivateEndpointConnectionProvisioningState

PrivateLinkServiceConnectionState

PrivateLinkServiceConnectionStatus

ProvisioningState

PublicNetworkAccessType

VirtualMachineFamilyCoreQuota