Batch Endpoints - Create Or Update

Referencia

Szolgáltatás:: Machine Learning

API-verzió:: 2024-10-01

Létrehoz egy kötegelt következtetési végpontot (aszinkron).

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
endpointName	path	True	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-_]{0,254}$	A Batch következtetési végpontjának neve.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Az erőforráscsoport neve. A név nem megkülönbözteti a kis- és nagybetűket.
subscriptionId	path	True	string minLength: 1	A cél-előfizetés azonosítója.
workspaceName	path	True	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$	Az Azure Machine Learning-munkaterület neve.
api-version	query	True	string minLength: 1	A művelethez használni kívánt API-verzió.

Kérelem törzse

Name	Kötelező	Típus	Description
location	True	string	Az a földrajzi hely, ahol az erőforrás él
properties	True	BatchEndpoint	[Kötelező] Az entitás további attribútumai.
identity		ManagedServiceIdentity	Felügyeltszolgáltatás-identitás (rendszer által hozzárendelt és/vagy felhasználó által hozzárendelt identitások)
kind		string	A portál/eszközhasználat/stb. által használt metaadatok különböző UX-élményeket jelenítenek meg az azonos típusú erőforrásokhoz.
sku		Sku	Az automatikus skálázáshoz szükséges ARM-szerződéshez szükséges termékváltozat részletei.
tags		object	Erőforráscímkék.

Válaszok

Name	Típus	Description
200 OK	BatchEndpointTrackedResource	A létrehozási vagy frissítési kérés sikeres.
201 Created	BatchEndpointTrackedResource	Létrehozott Fejlécek x-ms-async-operation-timeout: string Azure-AsyncOperation: string
Other Status Codes	ErrorResponse	Hiba

Name

Típus

Description

200 OK

BatchEndpointTrackedResource

A létrehozási vagy frissítési kérés sikeres.

201 Created

BatchEndpointTrackedResource

Létrehozott

Fejlécek

x-ms-async-operation-timeout: string
Azure-AsyncOperation: string

Other Status Codes

ErrorResponse

Hiba

Példák

CreateOrUpdate Workspace Batch Endpoint.

Mintakérelem

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=2024-10-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
  }
}

Mintaválasz

Állapotkód:: 200

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

Állapotkód:: 201

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

Definíciók

Name	Description
BatchEndpoint	Batch-végpont konfigurációja.
BatchEndpointDefaults	Batch-végpont alapértelmezett értékei
BatchEndpointTrackedResource
createdByType	Az erőforrást létrehozó identitás típusa.
EndpointAuthKeys	Végponthitelesítés kulcsai.
EndpointAuthMode	Enum a végpont-hitelesítési mód meghatározásához.
EndpointProvisioningState	A végpontkiépítés állapota.
ErrorAdditionalInfo	Az erőforrás-kezelési hiba további információi.
ErrorDetail	A hiba részletei.
ErrorResponse	Hibaválasz
ManagedServiceIdentity	Felügyeltszolgáltatás-identitás (rendszer által hozzárendelt és/vagy felhasználó által hozzárendelt identitások)
ManagedServiceIdentityType	A felügyelt szolgáltatás identitásának típusa (ahol a SystemAssigned és a UserAssigned típus is engedélyezett).
Sku	A termékváltozatot képviselő erőforrásmodell-definíció
SkuTier	Ezt a mezőt az erőforrás-szolgáltatónak kell implementálnia, ha a szolgáltatás egynél több szinttel rendelkezik, de put esetén nem szükséges.
systemData	Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.
UserAssignedIdentity	Felhasználó által hozzárendelt identitástulajdonságok

BatchEndpoint

Objektum

Batch-végpont konfigurációja.

Name	Típus	Description
authMode	EndpointAuthMode	[Kötelező] A végpont meghívásának hitelesítési módszere (adatsík-művelet). Kulcsalapú hitelesítéshez használja a "Key" (Kulcs) parancsot. Használja az "AMLToken" parancsot az Azure Machine Learning tokenalapú hitelesítéséhez. Használja az "AADToken" parancsot a Microsoft Entra tokenalapú hitelesítéshez.
defaults	BatchEndpointDefaults	A Batch-végpont alapértelmezett értékei
description	string	A következtetési végpont leírása.
keys	EndpointAuthKeys	EndpointAuthKeys, amely először egy végponton van beállítva. Ezt a tulajdonságot a rendszer mindig null értékként adja vissza. Az AuthKey-értékeket a ListKeys API használatával kell lekérni.
properties	object	Tulajdonságszótár. A tulajdonságok hozzáadhatók, de nem távolíthatók el és nem módosíthatók.
provisioningState	EndpointProvisioningState	A végpont kiépítési állapota.
scoringUri	string (uri)	Végpont URI-ja.
swaggerUri	string (uri)	Endpoint Swagger URI.

BatchEndpointDefaults

Objektum

Batch-végpont alapértelmezett értékei

Name	Típus	Description
deploymentName	string	Annak az üzembe helyezésnek a neve, amely alapértelmezés szerint a végponthoz lesz bekapcsolva. Ez az üzembe helyezés végül 100% forgalmat kap a végpont pontozási URL-címének meghívásakor.

BatchEndpointTrackedResource

Objektum

Name	Típus	Description
id	string	Az erőforrás teljes erőforrás-azonosítója. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	ManagedServiceIdentity	Felügyeltszolgáltatás-identitás (rendszer által hozzárendelt és/vagy felhasználó által hozzárendelt identitások)
kind	string	A portál/eszközhasználat/stb. által használt metaadatok különböző UX-élményeket jelenítenek meg az azonos típusú erőforrásokhoz.
location	string	Az a földrajzi hely, ahol az erőforrás él
name	string	Az erőforrás neve
properties	BatchEndpoint	[Kötelező] Az entitás további attribútumai.
sku	Sku	Az automatikus skálázáshoz szükséges ARM-szerződéshez szükséges termékváltozat részletei.
systemData	systemData	A createdBy és a modifiedBy adatokat tartalmazó Azure Resource Manager-metaadatok.
tags	object	Erőforráscímkék.
type	string	Az erőforrás típusa. Pl. "Microsoft.Compute/virtualMachines" vagy "Microsoft.Storage/storageAccounts"

createdByType

Enumerálás

Az erőforrást létrehozó identitás típusa.

Érték	Description
Application
Key
ManagedIdentity
User

EndpointAuthKeys

Objektum

Végponthitelesítés kulcsai.

Name	Típus	Description
primaryKey	string	Az elsődleges kulcs.
secondaryKey	string	A másodlagos kulcs.

EndpointAuthMode

Enumerálás

Enum a végpont-hitelesítési mód meghatározásához.

Érték	Description
AADToken
AMLToken
Key

EndpointProvisioningState

Enumerálás

A végpontkiépítés állapota.

Érték	Description
Canceled
Creating
Deleting
Failed
Succeeded
Updating

ErrorAdditionalInfo

Objektum

Az erőforrás-kezelési hiba további információi.

Name	Típus	Description
info	object	A további információk.
type	string	A további információtípus.

ErrorDetail

Objektum

A hiba részletei.

Name	Típus	Description
additionalInfo	ErrorAdditionalInfo[]	A hiba további információi.
code	string	A hibakód.
details	ErrorDetail[]	A hiba részletei.
message	string	A hibaüzenet.
target	string	A hibacél.

ErrorResponse

Objektum

Hibaválasz

Name	Típus	Description
error	ErrorDetail	A hibaobjektum.

ManagedServiceIdentity

Objektum

Felügyeltszolgáltatás-identitás (rendszer által hozzárendelt és/vagy felhasználó által hozzárendelt identitások)

Name	Típus	Description
principalId	string (uuid)	A rendszer által hozzárendelt identitás szolgáltatásnév-azonosítója. Ez a tulajdonság csak a rendszer által hozzárendelt identitáshoz lesz megadva.
tenantId	string (uuid)	A rendszer által hozzárendelt identitás bérlőazonosítója. Ez a tulajdonság csak a rendszer által hozzárendelt identitáshoz lesz megadva.
type	ManagedServiceIdentityType	A felügyelt szolgáltatás identitásának típusa (ahol a SystemAssigned és a UserAssigned típus is engedélyezett).
userAssignedIdentities	<string, UserAssignedIdentity>	User-Assigned identitások Az erőforráshoz társított felhasználó által hozzárendelt identitások készlete. A userAssignedIdentities szótárkulcsok arm-erőforrásazonosítók lesznek a következő formában: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. A szótár értékei lehetnek üres objektumok ({}) a kérelmekben.

ManagedServiceIdentityType

Enumerálás

A felügyelt szolgáltatás identitásának típusa (ahol a SystemAssigned és a UserAssigned típus is engedélyezett).

Érték	Description
None
SystemAssigned
SystemAssigned,UserAssigned
UserAssigned

Sku

Objektum

A termékváltozatot képviselő erőforrásmodell-definíció

Name	Típus	Description
capacity	integer (int32)	Ha az SKU támogatja a vertikális felskálázást/azt, akkor a kapacitás egészét is tartalmaznia kell. Ha az erőforrás esetében nem lehetséges a vertikális felskálázás/beskálázás, akkor ez kihagyható.
family	string	Ha a szolgáltatás különböző hardvergenerációval rendelkezik ugyanahhoz az SKU-hoz, akkor ezt itt rögzítheti.
name	string	Az termékváltozat neve. Ex - P3. Ez általában egy betű+szám kód
size	string	A termékváltozat mérete. Ha a névmező a réteg és más értékek kombinációja, akkor ez a különálló kód.
tier	SkuTier	Ezt a mezőt az erőforrás-szolgáltatónak kell implementálnia, ha a szolgáltatás egynél több szinttel rendelkezik, de put esetén nem szükséges.

SkuTier

Enumerálás

Ezt a mezőt az erőforrás-szolgáltatónak kell implementálnia, ha a szolgáltatás egynél több szinttel rendelkezik, de put esetén nem szükséges.

Érték	Description
Basic
Free
Premium
Standard

systemData

Objektum

Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

Name	Típus	Description
createdAt	string (date-time)	Az erőforrás-létrehozás időbélyege (UTC).
createdBy	string	Az erőforrást létrehozó identitás.
createdByType	createdByType	Az erőforrást létrehozó identitás típusa.
lastModifiedAt	string (date-time)	Az erőforrás utolsó módosításának időbélyege (UTC)
lastModifiedBy	string	Az erőforrást legutóbb módosító identitás.
lastModifiedByType	createdByType	Az erőforrást legutóbb módosító identitás típusa.

UserAssignedIdentity

Objektum

Felhasználó által hozzárendelt identitástulajdonságok

Name	Típus	Description
clientId	string (uuid)	A hozzárendelt identitás ügyfélazonosítója.
principalId	string (uuid)	A hozzárendelt identitás egyszerű azonosítója.

Megosztás a következőn keresztül:

Batch Endpoints - Create Or Update

URI-paraméterek

Kérelem törzse

Válaszok

Példák

CreateOrUpdate Workspace Batch Endpoint.

Mintakérelem

Mintaválasz

Definíciók

BatchEndpoint

BatchEndpointDefaults

BatchEndpointTrackedResource

createdByType

EndpointAuthKeys

EndpointAuthMode

EndpointProvisioningState

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ManagedServiceIdentity

ManagedServiceIdentityType

Sku

SkuTier

systemData

UserAssignedIdentity

További források