Bagikan melalui


Batch Endpoints - Create Or Update

Membuat titik akhir inferensi batch (asinkron).

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

Parameter URI

Nama Dalam Diperlukan Jenis Deskripsi
endpointName
path True

string

Nama untuk titik akhir inferensi Batch.

Pola regex: ^[a-zA-Z0-9][a-zA-Z0-9\-_]{0,254}$

resourceGroupName
path True

string

Nama grup sumber daya. Nama ini tidak peka huruf besar/kecil.

subscriptionId
path True

string

ID langganan target.

workspaceName
path True

string

Nama ruang kerja Azure Machine Learning.

Pola regex: ^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$

api-version
query True

string

Versi API yang akan digunakan untuk operasi ini.

Isi Permintaan

Nama Diperlukan Jenis Deskripsi
location True

string

Lokasi geografis tempat sumber daya berada

properties True

BatchEndpoint

[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

BatchEndpointTrackedResource

Permintaan buat atau perbarui berhasil.

201 Created

BatchEndpointTrackedResource

Dibuat

Header

  • x-ms-async-operation-timeout: string
  • Azure-AsyncOperation: string
Other Status Codes

ErrorResponse

Kesalahan

Contoh

CreateOrUpdate Workspace Batch Endpoint.

Permintaan sampel

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=2024-04-01

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

Respon sampel

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

Definisi

Nama Deskripsi
BatchEndpoint

Konfigurasi titik akhir batch.

BatchEndpointDefaults

Nilai default titik akhir batch

BatchEndpointTrackedResource
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

Respons 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

Konfigurasi titik akhir batch.

Nama Jenis Deskripsi
authMode

EndpointAuthMode

[Diperlukan] Gunakan 'Kunci' untuk autentikasi berbasis kunci dan 'AMLToken' untuk autentikasi berbasis token Azure Machine Learning. 'Kunci' tidak kedaluwarsa tetapi 'AMLToken' tidak.

defaults

BatchEndpointDefaults

Nilai default untuk Titik Akhir Batch

description

string

Deskripsi titik akhir inferensi.

keys

EndpointAuthKeys

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 titik akhir.

swaggerUri

string

URI Swagger Titik Akhir.

BatchEndpointDefaults

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.

BatchEndpointTrackedResource

Nama Jenis Deskripsi
id

string

ID sumber daya yang sepenuhnya memenuhi syarat untuk sumber daya. Ex - /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

BatchEndpoint

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

createdByType

Jenis identitas yang membuat sumber daya.

Nama Jenis Deskripsi
Application

string

Key

string

ManagedIdentity

string

User

string

EndpointAuthKeys

Kunci untuk autentikasi titik akhir.

Nama Jenis Deskripsi
primaryKey

string

Kunci utama.

secondaryKey

string

Kunci sekunder.

EndpointAuthMode

Enum untuk menentukan mode autentikasi titik akhir.

Nama Jenis Deskripsi
AADToken

string

AMLToken

string

Key

string

EndpointProvisioningState

Status provisi titik akhir.

Nama Jenis Deskripsi
Canceled

string

Creating

string

Deleting

string

Failed

string

Succeeded

string

Updating

string

ErrorAdditionalInfo

Info tambahan kesalahan manajemen sumber daya.

Nama Jenis Deskripsi
info

object

Info tambahan.

type

string

Jenis info tambahan.

ErrorDetail

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

Respons kesalahan

Nama Jenis Deskripsi
error

ErrorDetail

Objek kesalahan.

ManagedServiceIdentity

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

Nama Jenis Deskripsi
principalId

string

ID perwakilan layanan dari identitas yang ditetapkan sistem. Properti ini hanya akan disediakan untuk identitas yang ditetapkan sistem.

tenantId

string

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

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

Nama Jenis Deskripsi
None

string

SystemAssigned

string

SystemAssigned,UserAssigned

string

UserAssigned

string

Sku

Definisi model sumber daya yang mewakili SKU

Nama Jenis Deskripsi
capacity

integer

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

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

Nama Jenis Deskripsi
Basic

string

Free

string

Premium

string

Standard

string

systemData

Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.

Nama Jenis Deskripsi
createdAt

string

Tanda waktu pembuatan sumber daya (UTC).

createdBy

string

Identitas yang membuat sumber daya.

createdByType

createdByType

Jenis identitas yang membuat sumber daya.

lastModifiedAt

string

Tanda waktu modifikasi terakhir sumber daya (UTC)

lastModifiedBy

string

Identitas yang terakhir mengubah sumber daya.

lastModifiedByType

createdByType

Jenis identitas yang terakhir memodifikasi sumber daya.

UserAssignedIdentity

Properti identitas yang ditetapkan pengguna

Nama Jenis Deskripsi
clientId

string

ID klien dari identitas yang ditetapkan.

principalId

string

ID utama identitas yang ditetapkan.