Batch Endpoints - Create Or Update

Služba:: Machine Learning

Verze rozhraní API:: 2025-12-01

Vytvořte dávkový inferenční endpoint (asynchronní).
Vytvoří koncový bod dávkového odvození (asynchronní).

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
endpointName	path	True	string	Název koncového bodu batch
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Název skupiny prostředků. Název nerozlišuje malá a velká písmena.
subscriptionId	path	True	string minLength: 1	ID cílového předplatného.
workspaceName	path	True	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$	Název pracovního prostoru služby Azure Machine Learning
api-version	query	True	string minLength: 1	Verze rozhraní API, která se má použít pro tuto operaci.

Text požadavku

Name	Vyžadováno	Typ	Description
location	True	string	Geografické umístění, ve kterém se nachází zdroj
properties	True	BatchEndpointProperties	[Povinné] Další atributy entity.
identity		ManagedServiceIdentity	Identita spravované služby (identita přiřazená systémem nebo identita přiřazená uživatelem)
kind		string	Metadata používaná portálem, nástroji atd. k vykreslení různých prostředí uživatelského rozhraní pro prostředky stejného typu.
sku		Sku	Podrobnosti skladové položky vyžadované pro kontrakt ARM pro automatické škálování
tags		object	Značky prostředků

Odpovědi

Name	Typ	Description
200 OK	BatchEndpoint	Aktualizace zdroje 'BatchEndpoint' byla úspěšná
201 Created	BatchEndpoint	Požadavek byl úspěšný a v důsledku toho byl vytvořen nový prostředek. Hlavičky Azure-AsyncOperation: string Retry-After: integer x-ms-async-operation-timeout: string
Other Status Codes	ErrorResponse	Neočekávaná chybová odpověď

Name

Typ

Description

200 OK

BatchEndpoint

Aktualizace zdroje 'BatchEndpoint' byla úspěšná

201 Created

BatchEndpoint

Požadavek byl úspěšný a v důsledku toho byl vytvořen nový prostředek.

Hlavičky

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

Other Status Codes

ErrorResponse

Neočekávaná chybová odpověď

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2.

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

CreateOrUpdate Workspace Batch Endpoint.

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:: 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": {}
}

Stavový kód:: 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": {}
}

Definice

Name	Description
BatchEndpoint	Konkrétní sledované typy prostředků lze vytvořit aliasem tohoto typu pomocí konkrétního typu vlastnosti.
BatchEndpointDefaults	Výchozí hodnoty koncového bodu služby Batch
BatchEndpointProperties	Konfigurace koncového bodu služby Batch.
createdByType	Typ identity, která prostředek vytvořila.
EndpointAuthKeys	Klíče pro autentizaci koncového bodu.
EndpointAuthMode	Výčet k určení režimu ověřování koncového bodu
EndpointProvisioningState	Stav zřizování koncových bodů.
ErrorAdditionalInfo	Chyba správy zdrojů další informace.
ErrorDetail	Detail chyby.
ErrorResponse	Chybová odpověď
ManagedServiceIdentity	Identita spravované služby (identita přiřazená systémem nebo identita přiřazená uživatelem)
ManagedServiceIdentityType	Typ identity spravované služby (kde jsou povolené typy SystemAssigned i UserAssigned).
Sku	Definice modelu prostředků představující skladovou položku
SkuTier	Toto pole musí implementovat poskytovatel prostředků, pokud má služba více než jednu úroveň, ale nevyžaduje se u put.
systemData	Metadata týkající se vytvoření a poslední změny prostředku.
UserAssignedIdentity	Vlastnosti identity přiřazené uživatelem

BatchEndpoint

Objekt

Konkrétní sledované typy prostředků lze vytvořit aliasem tohoto typu pomocí konkrétního typu vlastnosti.

Name	Typ	Description
id	string	Plně kvalifikované ID prostředku pro prostředek. Příklad : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	ManagedServiceIdentity	Identita spravované služby (identita přiřazená systémem nebo identita přiřazená uživatelem)
kind	string	Metadata používaná portálem, nástroji atd. k vykreslení různých prostředí uživatelského rozhraní pro prostředky stejného typu.
location	string	Geografické umístění, ve kterém se nachází zdroj
name	string	Název prostředku
properties	BatchEndpointProperties	[Povinné] Další atributy entity.
sku	Sku	Podrobnosti skladové položky vyžadované pro kontrakt ARM pro automatické škálování
systemData	systemData	Metadata služby Azure Resource Manager obsahující informace o tom, kdo jej vytvořil a upravil.
tags	object	Značky prostředků
type	string	Typ prostředku. Např. "Microsoft.Compute/virtualMachines" nebo "Microsoft.Storage/storageAccounts"

BatchEndpointDefaults

Objekt

Výchozí hodnoty koncového bodu služby Batch

Name	Typ	Description
deploymentName	string	Název nasazení, které bude pro koncový bod výchozí. Toto nasazení bude mít při vyvolání adresy URL bodování koncového bodu 100% provozu.

BatchEndpointProperties

Objekt

Konfigurace koncového bodu služby Batch.

Name	Typ	Description
authMode	EndpointAuthMode	[Povinné] Metoda ověřování pro vyvolání koncového bodu (operace roviny dat). Pro ověřování na základě klíčů použijte klíč. K ověřování pomocí tokenu Azure Machine Learning použijte AMLToken. Pro ověřování pomocí tokenu Microsoft Entra použijte AADToken.
defaults	BatchEndpointDefaults	Výchozí hodnoty pro koncový bod služby Batch
description	string	Popis koncového bodu odvozování
keys	EndpointAuthKeys (password)	EndpointAuthKeys pro počáteční nastavení na koncovém bodu. Tato vlastnost bude vždy vrácena jako null. Hodnoty AuthKey musí být načteny pomocí rozhraní ListKeys API.
properties	object	Slovník vlastností Vlastnosti lze přidat, ale ne odebrat nebo změnit.
provisioningState	EndpointProvisioningState	Stav zřizování pro koncový bod.
scoringUri	string (uri)	Identifikátor URI koncového bodu.
swaggerUri	string (uri)	Identifikátor URI Swagger koncového bodu.

createdByType

Výčet

Typ identity, která prostředek vytvořila.

Hodnota	Description
User
Application
ManagedIdentity
Key

EndpointAuthKeys

Objekt

Klíče pro autentizaci koncového bodu.

Name	Typ	Description
primaryKey	string (password)	Primární klíč.
secondaryKey	string (password)	Sekundární klíč.

EndpointAuthMode

Výčet

Výčet k určení režimu ověřování koncového bodu

Hodnota	Description
AMLToken
Key
AADToken

EndpointProvisioningState

Výčet

Stav zřizování koncových bodů.

Hodnota	Description
Creating
Deleting
Succeeded
Failed
Updating
Canceled

ErrorAdditionalInfo

Objekt

Chyba správy zdrojů další informace.

Name	Typ	Description
info	object	Další informace.
type	string	Typ doplňkových informací.

ErrorDetail

Objekt

Detail chyby.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Chyba další informace.
code	string	Kód chyby.
details	ErrorDetail[]	Podrobnosti o chybě.
message	string	Chybová zpráva.
target	string	Cíl chyby.

ErrorResponse

Objekt

Chybová odpověď

Name	Typ	Description
error	ErrorDetail	Objekt chyby.

ManagedServiceIdentity

Objekt

Identita spravované služby (identita přiřazená systémem nebo identita přiřazená uživatelem)

Name	Typ	Description
principalId	string (uuid)	ID instančního objektu identity přiřazené systémem. Tato vlastnost bude poskytována pouze pro identitu přiřazenou systémem.
tenantId	string (uuid)	ID tenanta přiřazené identity systému. Tato vlastnost bude poskytována pouze pro identitu přiřazenou systémem.
type	ManagedServiceIdentityType	Typ identity spravované služby (kde jsou povolené typy SystemAssigned i UserAssigned).
userAssignedIdentities	<string, UserAssignedIdentity>	identity User-Assigned Sada identit přiřazených uživatelem přidružená k prostředku. Klíče slovníku userAssignedIdentities budou ID prostředků ARM ve formuláři: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Hodnoty slovníku můžou být prázdné objekty ({}) v požadavcích.

ManagedServiceIdentityType

Výčet

Typ identity spravované služby (kde jsou povolené typy SystemAssigned i UserAssigned).

Hodnota	Description
None
SystemAssigned
UserAssigned
SystemAssigned,UserAssigned

Sku

Objekt

Definice modelu prostředků představující skladovou položku

Name	Typ	Description
capacity	integer (int32)	Pokud skladová položka podporuje horizontální navýšení/snížení kapacity, měla by být zahrnuta celá čísla kapacity. Pokud není pro prostředek možné horizontální navýšení kapacity nebo jeho snížení kapacity, může se tento parametr vynechat.
family	string	Pokud má služba různé generace hardwaru, pro stejnou skladovou položku, můžete ji zde zachytit.
name	string	Název skladové položky. Ex - P3. Obvykle se jedná o písmeno+číslo.
size	string	Velikost skladové položky. Pokud je pole název kombinací vrstvy a jiné hodnoty, jedná se o samostatný kód.
tier	SkuTier	Toto pole musí implementovat poskytovatel prostředků, pokud má služba více než jednu úroveň, ale nevyžaduje se u put.

SkuTier

Výčet

Toto pole musí implementovat poskytovatel prostředků, pokud má služba více než jednu úroveň, ale nevyžaduje se u put.

Hodnota	Description
Free
Basic
Standard
Premium

systemData

Objekt

Metadata týkající se vytvoření a poslední změny prostředku.

Name	Typ	Description
createdAt	string (date-time)	Časové razítko vytvoření prostředku (UTC).
createdBy	string	Identita, která prostředek vytvořila.
createdByType	createdByType	Typ identity, která prostředek vytvořila.
lastModifiedAt	string (date-time)	Časové razítko poslední změny zdroje (UTC)
lastModifiedBy	string	Identita, která naposledy změnila prostředek.
lastModifiedByType	createdByType	Typ identity, která naposledy změnila prostředek.

UserAssignedIdentity

Objekt

Vlastnosti identity přiřazené uživatelem

Name	Typ	Description
clientId	string (uuid)	ID klienta přiřazené identity.
principalId	string (uuid)	ID objektu zabezpečení přiřazené identity.

Sdílet prostřednictvím

Batch Endpoints - Create Or Update

Parametry identifikátoru URI

Text požadavku

Odpovědi

Zabezpečení

azure_auth

Rozsahy

Příklady

CreateOrUpdate Workspace Batch Endpoint.

Ukázkový požadavek

Ukázková odpověď

Definice

BatchEndpoint

BatchEndpointDefaults

BatchEndpointProperties

createdByType

EndpointAuthKeys

EndpointAuthMode

EndpointProvisioningState

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ManagedServiceIdentity

ManagedServiceIdentityType

Sku

SkuTier

systemData

UserAssignedIdentity