Batch Endpoints - Create Or Update

Layanan:: Machine Learning

Versi API:: 2025-12-01

Buat titik akhir inferensi batch (asinkron).
Membuat titik akhir inferensi batch (asinkron).

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/batchEndpoints/{endpointName}?api-version=2025-12-01

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
endpointName	path	True	string	Nama untuk Titik Akhir Batch.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nama grup sumber daya. Nama tidak sensitif terhadap penggunaan huruf besar atau kecil.
subscriptionId	path	True	string minLength: 1	ID langganan target.
workspaceName	path	True	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$	Nama Ruang Kerja Azure Machine Learning
api-version	query	True	string minLength: 1	Versi API yang digunakan untuk operasi ini.

Isi Permintaan

Nama	Diperlukan	Jenis	Deskripsi
location	True	string	Lokasi geografis tempat sumber daya berada
properties	True	BatchEndpointProperties	[Diperlukan] Atribut tambahan entitas.
identity		ManagedServiceIdentity	Identitas layanan terkelola (identitas yang ditetapkan sistem dan/atau pengguna)
kind		string	Metadata yang digunakan oleh portal/peralatan/dll untuk merender pengalaman UX yang berbeda untuk sumber daya dengan jenis yang sama.
sku		Sku	Detail Sku diperlukan untuk kontrak ARM untuk Autoscaling.
tags		object	Tag sumber daya.

Respons

Nama	Jenis	Deskripsi
200 OK	BatchEndpoint	Operasi pembaruan 'BatchEndpoint' sumber daya berhasil
201 Created	BatchEndpoint	Permintaan telah berhasil dan sumber daya baru telah dibuat sebagai hasilnya. Header Azure-AsyncOperation: string Retry-After: integer x-ms-async-operation-timeout: string
Other Status Codes	ErrorResponse	Respons kesalahan tak terduga.

Nama

Jenis

Deskripsi

200 OK

BatchEndpoint

Operasi pembaruan 'BatchEndpoint' sumber daya berhasil

201 Created

BatchEndpoint

Permintaan telah berhasil dan sumber daya baru telah dibuat sebagai hasilnya.

Header

Azure-AsyncOperation: string
Retry-After: integer
x-ms-async-operation-timeout: string

Other Status Codes

ErrorResponse

Respons kesalahan tak terduga.

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

CreateOrUpdate Workspace Batch Endpoint.

Permintaan sampel

HTTP

PUT https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.MachineLearningServices/workspaces/my-aml-workspace/batchEndpoints/testEndpointName?api-version=2025-12-01

{
  "identity": {
    "type": "SystemAssigned",
    "userAssignedIdentities": {
      "string": {}
    }
  },
  "kind": "string",
  "location": "string",
  "properties": {
    "description": "string",
    "authMode": "AMLToken",
    "defaults": {
      "deploymentName": "string"
    },
    "properties": {
      "string": "string"
    }
  },
  "sku": {
    "name": "string",
    "capacity": 1,
    "family": "string",
    "size": "string",
    "tier": "Free"
  },
  "tags": {}
}

Respon sampel

Kode status:: 200

{
  "name": "string",
  "type": "string",
  "id": "string",
  "identity": {
    "type": "SystemAssigned",
    "principalId": "00000000-1111-2222-3333-444444444444",
    "tenantId": "00000000-1111-2222-3333-444444444444",
    "userAssignedIdentities": {
      "string": {
        "clientId": "00000000-1111-2222-3333-444444444444",
        "principalId": "00000000-1111-2222-3333-444444444444"
      }
    }
  },
  "kind": "string",
  "location": "string",
  "properties": {
    "description": "string",
    "authMode": "AMLToken",
    "defaults": {
      "deploymentName": "string"
    },
    "properties": {
      "string": "string"
    },
    "provisioningState": "Succeeded",
    "scoringUri": "https://www.contoso.com/example",
    "swaggerUri": "https://www.contoso.com/example"
  },
  "sku": {
    "name": "string",
    "capacity": 1,
    "family": "string",
    "size": "string",
    "tier": "Free"
  },
  "systemData": {
    "createdAt": "2020-01-01T12:34:56.999Z",
    "createdBy": "string",
    "createdByType": "User",
    "lastModifiedAt": "2020-01-01T12:34:56.999Z",
    "lastModifiedBy": "string",
    "lastModifiedByType": "User"
  },
  "tags": {}
}

Kode status:: 201

{
  "name": "string",
  "type": "string",
  "id": "string",
  "identity": {
    "type": "SystemAssigned",
    "principalId": "00000000-1111-2222-3333-444444444444",
    "tenantId": "00000000-1111-2222-3333-444444444444",
    "userAssignedIdentities": {
      "string": {
        "clientId": "00000000-1111-2222-3333-444444444444",
        "principalId": "00000000-1111-2222-3333-444444444444"
      }
    }
  },
  "kind": "string",
  "location": "string",
  "properties": {
    "description": "string",
    "authMode": "AMLToken",
    "defaults": {
      "deploymentName": "string"
    },
    "properties": {
      "string": "string"
    },
    "provisioningState": "Updating",
    "scoringUri": "https://www.contoso.com/example",
    "swaggerUri": "https://www.contoso.com/example"
  },
  "sku": {
    "name": "string",
    "capacity": 1,
    "family": "string",
    "size": "string",
    "tier": "Free"
  },
  "systemData": {
    "createdAt": "2020-01-01T12:34:56.999Z",
    "createdBy": "string",
    "createdByType": "User",
    "lastModifiedAt": "2020-01-01T12:34:56.999Z",
    "lastModifiedBy": "string",
    "lastModifiedByType": "User"
  },
  "tags": {}
}

Definisi

Nama	Deskripsi
BatchEndpoint	Jenis sumber daya terlacak konkret dapat dibuat dengan alias jenis ini menggunakan jenis properti tertentu.
BatchEndpointDefaults	Nilai default titik akhir batch
BatchEndpointProperties	Konfigurasi titik akhir batch.
createdByType	Jenis identitas yang membuat sumber daya.
EndpointAuthKeys	Kunci untuk autentikasi titik akhir.
EndpointAuthMode	Enum untuk menentukan mode autentikasi titik akhir.
EndpointProvisioningState	Status provisi titik akhir.
ErrorAdditionalInfo	Info tambahan kesalahan manajemen sumber daya.
ErrorDetail	Detail kesalahan.
ErrorResponse	Tanggapan kesalahan
ManagedServiceIdentity	Identitas layanan terkelola (identitas yang ditetapkan sistem dan/atau pengguna)
ManagedServiceIdentityType	Jenis identitas layanan terkelola (di mana jenis SystemAssigned dan UserAssigned diizinkan).
Sku	Definisi model sumber daya yang mewakili SKU
SkuTier	Bidang ini diperlukan untuk diimplementasikan oleh Penyedia Sumber Jika layanan memiliki lebih dari satu tingkat, tetapi tidak diperlukan pada PUT.
systemData	Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.
UserAssignedIdentity	Properti identitas yang ditetapkan pengguna

BatchEndpoint

Objek

Jenis sumber daya terlacak konkret dapat dibuat dengan alias jenis ini menggunakan jenis properti tertentu.

Nama	Jenis	Deskripsi
id	string	ID sumber daya yang sepenuhnya memenuhi syarat untuk sumber daya. Misalnya - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	ManagedServiceIdentity	Identitas layanan terkelola (identitas yang ditetapkan sistem dan/atau pengguna)
kind	string	Metadata yang digunakan oleh portal/peralatan/dll untuk merender pengalaman UX yang berbeda untuk sumber daya dengan jenis yang sama.
location	string	Lokasi geografis tempat sumber daya berada
name	string	Nama sumber daya.
properties	BatchEndpointProperties	[Diperlukan] Atribut tambahan entitas.
sku	Sku	Detail Sku diperlukan untuk kontrak ARM untuk Autoscaling.
systemData	systemData	Metadata Azure Resource Manager yang berisi informasi createBy dan modifiedBy.
tags	object	Tag sumber daya.
type	string	Jenis sumber daya. Misalnya "Microsoft.Compute/virtualMachines" atau "Microsoft.Storage/storageAccounts"

BatchEndpointDefaults

Objek

Nilai default titik akhir batch

Nama	Jenis	Deskripsi
deploymentName	string	Nama penyebaran yang akan menjadi default untuk titik akhir. Penyebaran ini akan akhirnya mendapatkan lalu lintas 100% saat URL penilaian titik akhir dipanggil.

BatchEndpointProperties

Objek

Konfigurasi titik akhir batch.

Nama	Jenis	Deskripsi
authMode	EndpointAuthMode	[Diperlukan] Metode autentikasi untuk memanggil titik akhir (operasi sarana data). Gunakan 'Kunci' untuk autentikasi berbasis kunci. Gunakan 'AMLToken' untuk autentikasi berbasis token Azure Machine Learning. Gunakan 'AADToken' untuk autentikasi berbasis token Microsoft Entra.
defaults	BatchEndpointDefaults	Nilai default untuk Titik Akhir Batch
description	string	Deskripsi titik akhir inferensi.
keys	EndpointAuthKeys (password)	EndpointAuthKeys untuk diatur awalnya pada Titik Akhir. Properti ini akan selalu dikembalikan sebagai null. Nilai AuthKey harus diambil menggunakan API ListKeys.
properties	object	Kamus properti. Properti dapat ditambahkan, tetapi tidak dihapus atau diubah.
provisioningState	EndpointProvisioningState	Status provisi untuk titik akhir.
scoringUri	string (uri)	URI titik akhir.
swaggerUri	string (uri)	URI Swagger Titik Akhir.

createdByType

Enumerasi

Jenis identitas yang membuat sumber daya.

Nilai	Deskripsi
User
Application
ManagedIdentity
Key

EndpointAuthKeys

Objek

Kunci untuk autentikasi titik akhir.

Nama	Jenis	Deskripsi
primaryKey	string (password)	Kunci utama.
secondaryKey	string (password)	Kunci sekunder.

EndpointAuthMode

Enumerasi

Enum untuk menentukan mode autentikasi titik akhir.

Nilai	Deskripsi
AMLToken
Key
AADToken

EndpointProvisioningState

Enumerasi

Status provisi titik akhir.

Nilai	Deskripsi
Creating
Deleting
Succeeded
Failed
Updating
Canceled

ErrorAdditionalInfo

Objek

Info tambahan kesalahan manajemen sumber daya.

Nama	Jenis	Deskripsi
info	object	Info tambahan.
type	string	Jenis info tambahan.

ErrorDetail

Objek

Detail kesalahan.

Nama	Jenis	Deskripsi
additionalInfo	ErrorAdditionalInfo[]	Info tambahan kesalahan.
code	string	Kode kesalahan.
details	ErrorDetail[]	Detail kesalahan.
message	string	Pesan kesalahan.
target	string	Target kesalahan.

ErrorResponse

Objek

Tanggapan kesalahan

Nama	Jenis	Deskripsi
error	ErrorDetail	Objek kesalahan.

ManagedServiceIdentity

Objek

Identitas layanan terkelola (identitas yang ditetapkan sistem dan/atau pengguna)

Nama	Jenis	Deskripsi
principalId	string (uuid)	ID perwakilan layanan dari identitas yang ditetapkan sistem. Properti ini hanya akan disediakan untuk identitas yang ditetapkan sistem.
tenantId	string (uuid)	ID penyewa dari identitas yang ditetapkan sistem. Properti ini hanya akan disediakan untuk identitas yang ditetapkan sistem.
type	ManagedServiceIdentityType	Jenis identitas layanan terkelola (di mana jenis SystemAssigned dan UserAssigned diizinkan).
userAssignedIdentities	<string, UserAssignedIdentity>	Identitas User-Assigned Kumpulan identitas yang ditetapkan pengguna yang terkait dengan sumber daya. Kunci kamus userAssignedIdentities akan menjadi id sumber daya ARM dalam formulir: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Nilai kamus dapat berupa objek kosong ({}) dalam permintaan.

ManagedServiceIdentityType

Enumerasi

Jenis identitas layanan terkelola (di mana jenis SystemAssigned dan UserAssigned diizinkan).

Nilai	Deskripsi
None
SystemAssigned
UserAssigned
SystemAssigned,UserAssigned

Sku

Objek

Definisi model sumber daya yang mewakili SKU

Nama	Jenis	Deskripsi
capacity	integer (int32)	Jika SKU mendukung peluasan skala/masuk, bilangan bulat kapasitas harus disertakan. Jika peluasan/masuk skala tidak dimungkinkan untuk sumber daya, ini dapat dihilangkan.
family	string	Jika layanan memiliki generasi perangkat keras yang berbeda, untuk SKU yang sama, maka itu dapat ditangkap di sini.
name	string	Nama SKU. Ex - P3. Biasanya kode huruf+angka
size	string	Ukuran SKU. Ketika bidang nama adalah kombinasi tingkatan dan beberapa nilai lainnya, ini akan menjadi kode mandiri.
tier	SkuTier	Bidang ini diperlukan untuk diimplementasikan oleh Penyedia Sumber Jika layanan memiliki lebih dari satu tingkat, tetapi tidak diperlukan pada PUT.

SkuTier

Enumerasi

Bidang ini diperlukan untuk diimplementasikan oleh Penyedia Sumber Jika layanan memiliki lebih dari satu tingkat, tetapi tidak diperlukan pada PUT.

Nilai	Deskripsi
Free
Basic
Standard
Premium

systemData

Objek

Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.

Nama	Jenis	Deskripsi
createdAt	string (date-time)	Tanda waktu pembuatan sumber daya (UTC).
createdBy	string	Identitas yang membuat sumber daya.
createdByType	createdByType	Jenis identitas yang membuat sumber daya.
lastModifiedAt	string (date-time)	Stempel waktu modifikasi terakhir sumber daya (UTC)
lastModifiedBy	string	Identitas yang terakhir mengubah sumber daya.
lastModifiedByType	createdByType	Jenis identitas yang terakhir memodifikasi sumber daya.

UserAssignedIdentity

Objek

Properti identitas yang ditetapkan pengguna

Nama	Jenis	Deskripsi
clientId	string (uuid)	ID klien dari identitas yang ditetapkan.
principalId	string (uuid)	ID utama identitas yang ditetapkan.

Bagikan melalui

Batch Endpoints - Create Or Update

Parameter URI

Isi Permintaan

Respons

Keamanan

azure_auth

Cakupan

Contoh

CreateOrUpdate Workspace Batch Endpoint.

Permintaan sampel

Respon sampel

Definisi

BatchEndpoint

BatchEndpointDefaults

BatchEndpointProperties

createdByType

EndpointAuthKeys

EndpointAuthMode

EndpointProvisioningState

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ManagedServiceIdentity

ManagedServiceIdentityType

Sku

SkuTier

systemData

UserAssignedIdentity