Batch Endpoints - Update

Dienst:: Machine Learning

API-Version:: 2025-04-01

Aktualisieren eines Batch-Ableitungsendpunkts (asynchron).

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpointName	path	True	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-_]{0,254}$	Name für den Batch-Ableitungsendpunkt.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
subscriptionId	path	True	string minLength: 1	Die ID des Zielabonnements.
workspaceName	path	True	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$	Name des Azure Machine Learning-Arbeitsbereichs.
api-version	query	True	string minLength: 1	Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.

Anforderungstext

Name	Typ	Beschreibung
identity	PartialManagedServiceIdentity	Verwaltete Dienstidentität (vom System zugewiesene und/oder vom Benutzer zugewiesene Identitäten)
tags	object	Ressourcentags.

Antworten

Name	Typ	Beschreibung
200 OK	BatchEndpointTrackedResource	Erfolg
202 Accepted		Angenommen Header x-ms-async-operation-timeout: string Location: string Retry-After: integer
Other Status Codes	ErrorResponse	Fehler

Name

Typ

Beschreibung

200 OK

BatchEndpointTrackedResource

Erfolg

202 Accepted

Angenommen

Header

x-ms-async-operation-timeout: string
Location: string
Retry-After: integer

Other Status Codes

ErrorResponse

Fehler

Beispiele

Update Workspace Batch Endpoint.

Beispielanforderung

HTTP

PATCH 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-04-01

{
  "tags": {},
  "identity": {
    "type": "SystemAssigned",
    "userAssignedIdentities": {
      "string": {}
    }
  }
}

Beispiel für eine Antwort

Statuscode:: 200

Location: example_location

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

Statuscode:: 202

Location: example_location

Definitionen

Name	Beschreibung
BatchEndpoint	Batchendpunktkonfiguration.
BatchEndpointDefaults	Standardwerte für Batchendpunkt
BatchEndpointTrackedResource
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
EndpointAuthKeys	Schlüssel für die Endpunktauthentifizierung.
EndpointAuthMode	Enumeration zum Ermitteln des Endpunktauthentifizierungsmodus.
EndpointProvisioningState	Status der Endpunktbereitstellung.
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
ManagedServiceIdentity	Verwaltete Dienstidentität (vom System zugewiesene und/oder vom Benutzer zugewiesene Identitäten)
ManagedServiceIdentityType	Typ der verwalteten Dienstidentität (wobei systemAssigned- und UserAssigned-Typen zulässig sind).
PartialManagedServiceIdentity	Verwaltete Dienstidentität (vom System zugewiesene und/oder vom Benutzer zugewiesene Identitäten)
PartialMinimalTrackedResourceWithIdentity	Wird streng in Updateanforderungen verwendet.
Sku	Die Definition des Ressourcenmodells, die SKU darstellt
SkuTier	Dieses Feld muss vom Ressourcenanbieter implementiert werden, wenn der Dienst mehr als eine Ebene aufweist, für einen PUT jedoch nicht erforderlich ist.
systemData	Metadaten zur Erstellung und letzten Änderung der Ressource.
UserAssignedIdentity	Benutzer zugewiesene Identitätseigenschaften

BatchEndpoint

Objekt

Batchendpunktkonfiguration.

Name	Typ	Beschreibung
authMode	EndpointAuthMode	[Erforderlich] Die Authentifizierungsmethode zum Aufrufen des Endpunkts (Datenebenenvorgang). Verwenden Sie "Schlüssel" für die schlüsselbasierte Authentifizierung. Verwenden Sie "AMLToken" für die tokenbasierte Azure Machine Learning-Authentifizierung. Verwenden Sie "AADToken" für die tokenbasierte Authentifizierung von Microsoft Entra.
defaults	BatchEndpointDefaults	Standardwerte für Batchendpunkt
description	string	Beschreibung des Ableitungsendpunkts.
keys	EndpointAuthKeys	EndpointAuthKeys, die anfänglich für einen Endpunkt festgelegt werden sollen. Diese Eigenschaft wird immer als NULL zurückgegeben. AuthKey-Werte müssen mithilfe der ListKeys-API abgerufen werden.
properties	object	Eigenschaftenwörterbuch. Eigenschaften können hinzugefügt, aber nicht entfernt oder geändert werden.
provisioningState	EndpointProvisioningState	Bereitstellungsstatus für den Endpunkt.
scoringUri	string (uri)	Endpunkt-URI.
swaggerUri	string (uri)	Endpunkt-Swagger-URI.

BatchEndpointDefaults

Objekt

Standardwerte für Batchendpunkt

Name	Typ	Beschreibung
deploymentName	string	Der Name der Bereitstellung, die standardmäßig für den Endpunkt verwendet wird. Diese Bereitstellung erhält letztendlich 100% Datenverkehr, wenn die Endpunktbewertungs-URL aufgerufen wird.

BatchEndpointTrackedResource

Objekt

Name	Typ	Beschreibung
id	string	Vollqualifizierte Ressourcen-ID für die Ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	ManagedServiceIdentity	Verwaltete Dienstidentität (vom System zugewiesene und/oder vom Benutzer zugewiesene Identitäten)
kind	string	Metadaten, die von Portal/Tooling/etc. verwendet werden, um unterschiedliche UX-Oberflächen für Ressourcen desselben Typs zu rendern.
location	string	Der geografische Standort, an dem sich die Ressource befindet
name	string	Der Name der Ressource
properties	BatchEndpoint	[Erforderlich] Zusätzliche Attribute der Entität.
sku	Sku	Sku-Details, die für den ARM-Vertrag für die automatische Skalierung erforderlich sind.
systemData	systemData	Azure Resource Manager-Metadaten, die createdBy- und modifiedBy-Informationen enthalten.
tags	object	Ressourcentags.
type	string	Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

createdByType

Enumeration

Der Identitätstyp, der die Ressource erstellt hat.

Wert	Beschreibung
Application
Key
ManagedIdentity
User

EndpointAuthKeys

Objekt

Schlüssel für die Endpunktauthentifizierung.

Name	Typ	Beschreibung
primaryKey	string	Der Primärschlüssel.
secondaryKey	string	Der sekundäre Schlüssel.

EndpointAuthMode

Enumeration

Enumeration zum Ermitteln des Endpunktauthentifizierungsmodus.

Wert	Beschreibung
AADToken
AMLToken
Key

EndpointProvisioningState

Enumeration

Status der Endpunktbereitstellung.

Wert	Beschreibung
Canceled
Creating
Deleting
Failed
Succeeded
Updating

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Objekt

Das Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Objekt

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

ManagedServiceIdentity

Objekt

Verwaltete Dienstidentität (vom System zugewiesene und/oder vom Benutzer zugewiesene Identitäten)

Name	Typ	Beschreibung
principalId	string (uuid)	Die Dienstprinzipal-ID der vom System zugewiesenen Identität. Diese Eigenschaft wird nur für eine vom System zugewiesene Identität bereitgestellt.
tenantId	string (uuid)	Die Mandanten-ID der vom System zugewiesenen Identität. Diese Eigenschaft wird nur für eine vom System zugewiesene Identität bereitgestellt.
type	ManagedServiceIdentityType	Typ der verwalteten Dienstidentität (wobei systemAssigned- und UserAssigned-Typen zulässig sind).
userAssignedIdentities	<string, UserAssignedIdentity>	User-Assigned Identitäten Die Gruppe der benutzerzuweisungen Identitäten, die der Ressource zugeordnet sind. Die Wörterbuchschlüssel "userAssignedIdentities" sind ARM-Ressourcen-IDs im Formular: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Die Wörterbuchwerte können leere Objekte ({}) in Anforderungen sein.

ManagedServiceIdentityType

Enumeration

Typ der verwalteten Dienstidentität (wobei systemAssigned- und UserAssigned-Typen zulässig sind).

Wert	Beschreibung
None
SystemAssigned
SystemAssigned,UserAssigned
UserAssigned

PartialManagedServiceIdentity

Objekt

Verwaltete Dienstidentität (vom System zugewiesene und/oder vom Benutzer zugewiesene Identitäten)

Name	Typ	Beschreibung
type	ManagedServiceIdentityType	Verwaltete Dienstidentität (vom System zugewiesene und/oder vom Benutzer zugewiesene Identitäten)
userAssignedIdentities		Die Gruppe der benutzerzuweisungen Identitäten, die der Ressource zugeordnet sind. Die Wörterbuchschlüssel "userAssignedIdentities" sind ARM-Ressourcen-IDs im Formular: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Die Wörterbuchwerte können leere Objekte ({}) in Anforderungen sein.

PartialMinimalTrackedResourceWithIdentity

Objekt

Wird streng in Updateanforderungen verwendet.

Name	Typ	Beschreibung
identity	PartialManagedServiceIdentity	Verwaltete Dienstidentität (vom System zugewiesene und/oder vom Benutzer zugewiesene Identitäten)
tags	object	Ressourcentags.

Sku

Objekt

Die Definition des Ressourcenmodells, die SKU darstellt

Name	Typ	Beschreibung
capacity	integer (int32)	Wenn die SKU skalierungs-/in unterstützt, sollte die Ganze Kapazität eingeschlossen werden. Wenn eine Skalierung für die Ressource nicht möglich ist, wird dies möglicherweise weggelassen.
family	string	Wenn der Dienst über unterschiedliche Hardwaregenerationen verfügt, kann dies für dieselbe SKU hier erfasst werden.
name	string	Der Name der SKU. Ex - P3. Es handelt sich in der Regel um einen Buchstaben+Zahlencode.
size	string	Die SKU-Größe. Wenn das Namensfeld die Kombination aus Ebene und einem anderen Wert ist, wäre dies der eigenständige Code.
tier	SkuTier	Dieses Feld muss vom Ressourcenanbieter implementiert werden, wenn der Dienst mehr als eine Ebene aufweist, für einen PUT jedoch nicht erforderlich ist.

SkuTier

Enumeration

Dieses Feld muss vom Ressourcenanbieter implementiert werden, wenn der Dienst mehr als eine Ebene aufweist, für einen PUT jedoch nicht erforderlich ist.

Wert	Beschreibung
Basic
Free
Premium
Standard

systemData

Objekt

Metadaten zur Erstellung und letzten Änderung der Ressource.

Name	Typ	Beschreibung
createdAt	string (date-time)	Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy	string	Die Identität, die die Ressource erstellt hat.
createdByType	createdByType	Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt	string (date-time)	Der Zeitstempel der letzten Änderung der Ressource (UTC)
lastModifiedBy	string	Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType	createdByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.

UserAssignedIdentity

Objekt

Benutzer zugewiesene Identitätseigenschaften

Name	Typ	Beschreibung
clientId	string (uuid)	Die Client-ID der zugewiesenen Identität.
principalId	string (uuid)	Die Prinzipal-ID der zugewiesenen Identität.

Freigeben über

Batch Endpoints - Update

URI-Parameter

Anforderungstext

Antworten

Beispiele

Update Workspace Batch Endpoint.

Beispielanforderung

Beispiel für eine Antwort

Definitionen

BatchEndpoint

BatchEndpointDefaults

BatchEndpointTrackedResource

createdByType

EndpointAuthKeys

EndpointAuthMode

EndpointProvisioningState

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ManagedServiceIdentity

ManagedServiceIdentityType

PartialManagedServiceIdentity

PartialMinimalTrackedResourceWithIdentity

Sku

SkuTier

systemData

UserAssignedIdentity