Batch Endpoints - Create Or Update

Usługa:: Machine Learning

Wersja API:: 2025-12-01

Stwórz punkt końcowy wnioskowania wsadowego (asynchroniczny).
Tworzy punkt końcowy wnioskowania wsadowego (asynchroniczny).

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

Parametry URI

Nazwa	W	Wymagane	Typ	Opis
endpointName	path	True	string	Nazwa punktu końcowego usługi Batch.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
subscriptionId	path	True	string minLength: 1	Identyfikator subskrypcji docelowej.
workspaceName	path	True	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$	Nazwa obszaru roboczego usługi Azure Machine Learning
api-version	query	True	string minLength: 1	Wersja interfejsu API do użycia dla tej operacji.

Ciało żądania

Nazwa	Wymagane	Typ	Opis
location	True	string	Lokalizacja geograficzna, w której znajduje się zasób
properties	True	BatchEndpointProperties	[Wymagane] Dodatkowe atrybuty jednostki.
identity		ManagedServiceIdentity	Tożsamość usługi zarządzanej (tożsamości przypisane przez system i/lub tożsamości przypisane przez użytkownika)
kind		string	Metadane używane przez portal/narzędzia/itp. do renderowania różnych środowisk środowiska użytkownika dla zasobów tego samego typu.
sku		Sku	Szczegóły jednostki SKU wymagane dla kontraktu usługi ARM na potrzeby skalowania automatycznego.
tags		object	Tagi zasobów.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	BatchEndpoint	Aktualizacja zasobu 'BatchEndpoint' zakończyła się sukcesem
201 Created	BatchEndpoint	Żądanie zakończyło się pomyślnie i w rezultacie został utworzony nowy zasób. Nagłówki Azure-AsyncOperation: string Retry-After: integer x-ms-async-operation-timeout: string
Other Status Codes	ErrorResponse	Nieoczekiwana odpowiedź na błąd.

Nazwa

Typ

Opis

200 OK

BatchEndpoint

Aktualizacja zasobu 'BatchEndpoint' zakończyła się sukcesem

201 Created

BatchEndpoint

Żądanie zakończyło się pomyślnie i w rezultacie został utworzony nowy zasób.

Nagłówki

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

Other Status Codes

ErrorResponse

Nieoczekiwana odpowiedź na błąd.

Zabezpieczenia

azure_auth

Przepływ OAuth2 w usłudze Azure Active Directory.

Typ: oauth2
Flow: implicit
URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresów

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

CreateOrUpdate Workspace Batch Endpoint.

Przykładowa prośba

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

Przykładowa odpowiedź

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

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

Definicje

Nazwa	Opis
BatchEndpoint	Konkretne śledzone typy zasobów można utworzyć, aliasując ten typ przy użyciu określonego typu właściwości.
BatchEndpointDefaults	Wartości domyślne punktu końcowego usługi Batch
BatchEndpointProperties	Konfiguracja punktu końcowego usługi Batch.
createdByType	Typ tożsamości, która utworzyła zasób.
EndpointAuthKeys	Klucze do uwierzytelniania punktu końcowego.
EndpointAuthMode	Wyliczenie w celu określenia trybu uwierzytelniania punktu końcowego.
EndpointProvisioningState	Stan aprowizacji punktu końcowego.
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail	Szczegóły błędu.
ErrorResponse	Odpowiedź na błąd
ManagedServiceIdentity	Tożsamość usługi zarządzanej (tożsamości przypisane przez system i/lub tożsamości przypisane przez użytkownika)
ManagedServiceIdentityType	Typ tożsamości usługi zarządzanej (gdzie dozwolone są typy SystemAssigned i UserAssigned).
Sku	Definicja modelu zasobów reprezentująca jednostkę SKU
SkuTier	To pole jest wymagane do zaimplementowania przez dostawcę zasobów, jeśli usługa ma więcej niż jedną warstwę, ale nie jest wymagana w put.
systemData	Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.
UserAssignedIdentity	Właściwości tożsamości przypisanej przez użytkownika

BatchEndpoint

Sprzeciwiać się

Konkretne śledzone typy zasobów można utworzyć, aliasując ten typ przy użyciu określonego typu właściwości.

Nazwa	Typ	Opis
id	string	W pełni kwalifikowany identyfikator zasobu dla zasobu. Przykład - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	ManagedServiceIdentity	Tożsamość usługi zarządzanej (tożsamości przypisane przez system i/lub tożsamości przypisane przez użytkownika)
kind	string	Metadane używane przez portal/narzędzia/itp. do renderowania różnych środowisk środowiska użytkownika dla zasobów tego samego typu.
location	string	Lokalizacja geograficzna, w której znajduje się zasób
name	string	Nazwa zasobu
properties	BatchEndpointProperties	[Wymagane] Dodatkowe atrybuty jednostki.
sku	Sku	Szczegóły jednostki SKU wymagane dla kontraktu usługi ARM na potrzeby skalowania automatycznego.
systemData	systemData	Metadane usługi Azure Resource Manager zawierające informacje „createdBy” i „modifiedBy”.
tags	object	Tagi zasobów.
type	string	Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts"

BatchEndpointDefaults

Sprzeciwiać się

Wartości domyślne punktu końcowego usługi Batch

Nazwa	Typ	Opis
deploymentName	string	Nazwa wdrożenia, które będzie domyślne dla punktu końcowego. To wdrożenie spowoduje uzyskanie 100% ruchu po wywołaniu adresu URL oceniania punktu końcowego.

BatchEndpointProperties

Sprzeciwiać się

Konfiguracja punktu końcowego usługi Batch.

Nazwa	Typ	Opis
authMode	EndpointAuthMode	[Wymagane] Metoda uwierzytelniania wywoływania punktu końcowego (operacja płaszczyzny danych). Użyj klucza do uwierzytelniania opartego na kluczach. Użyj elementu "AMLToken" na potrzeby uwierzytelniania opartego na tokenach usługi Azure Machine Learning. Użyj wartości "AADToken" dla uwierzytelniania opartego na tokenach firmy Microsoft.
defaults	BatchEndpointDefaults	Wartości domyślne dla punktu końcowego usługi Batch
description	string	Opis punktu końcowego wnioskowania.
keys	EndpointAuthKeys (password)	EndpointAuthKeys do początkowego ustawienia w punkcie końcowym. Ta właściwość będzie zawsze zwracana jako null. Wartości AuthKey należy pobrać przy użyciu interfejsu API ListKeys.
properties	object	Słownik właściwości. Właściwości można dodawać, ale nie usuwać ani zmieniać.
provisioningState	EndpointProvisioningState	Stan aprowizacji punktu końcowego.
scoringUri	string (uri)	Identyfikator URI punktu końcowego.
swaggerUri	string (uri)	Identyfikator URI struktury Swagger punktu końcowego.

createdByType

Wyliczenie

Typ tożsamości, która utworzyła zasób.

Wartość	Opis
User
Application
ManagedIdentity
Key

EndpointAuthKeys

Sprzeciwiać się

Klucze do uwierzytelniania punktu końcowego.

Nazwa	Typ	Opis
primaryKey	string (password)	Klucz podstawowy.
secondaryKey	string (password)	Klucz pomocniczy.

EndpointAuthMode

Wyliczenie

Wyliczenie w celu określenia trybu uwierzytelniania punktu końcowego.

Wartość	Opis
AMLToken
Key
AADToken

EndpointProvisioningState

Wyliczenie

Stan aprowizacji punktu końcowego.

Wartość	Opis
Creating
Deleting
Succeeded
Failed
Updating
Canceled

ErrorAdditionalInfo

Sprzeciwiać się

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa	Typ	Opis
info	object	Dodatkowe informacje.
type	string	Dodatkowy typ informacji.

ErrorDetail

Sprzeciwiać się

Szczegóły błędu.

Nazwa	Typ	Opis
additionalInfo	ErrorAdditionalInfo[]	Dodatkowe informacje o błędzie.
code	string	Kod błędu.
details	ErrorDetail[]	Szczegóły błędu.
message	string	Komunikat o błędzie.
target	string	Element docelowy błędu.

ErrorResponse

Sprzeciwiać się

Odpowiedź na błąd

Nazwa	Typ	Opis
error	ErrorDetail	Obiekt błędu.

ManagedServiceIdentity

Sprzeciwiać się

Tożsamość usługi zarządzanej (tożsamości przypisane przez system i/lub tożsamości przypisane przez użytkownika)

Nazwa	Typ	Opis
principalId	string (uuid)	Identyfikator jednostki usługi tożsamości przypisanej przez system. Ta właściwość zostanie udostępniona tylko dla tożsamości przypisanej przez system.
tenantId	string (uuid)	Identyfikator dzierżawy tożsamości przypisanej przez system. Ta właściwość zostanie udostępniona tylko dla tożsamości przypisanej przez system.
type	ManagedServiceIdentityType	Typ tożsamości usługi zarządzanej (gdzie dozwolone są typy SystemAssigned i UserAssigned).
userAssignedIdentities	<string, UserAssignedIdentity>	tożsamości User-Assigned Zestaw tożsamości przypisanych przez użytkownika skojarzonych z zasobem. Klucze słownika userAssignedIdentities będą identyfikatorami zasobów usługi ARM w postaci: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Wartości słownika mogą być pustymi obiektami ({}) w żądaniach.

ManagedServiceIdentityType

Wyliczenie

Typ tożsamości usługi zarządzanej (gdzie dozwolone są typy SystemAssigned i UserAssigned).

Wartość	Opis
None
SystemAssigned
UserAssigned
SystemAssigned,UserAssigned

Sku

Sprzeciwiać się

Definicja modelu zasobów reprezentująca jednostkę SKU

Nazwa	Typ	Opis
capacity	integer (int32)	Jeśli jednostka SKU obsługuje skalowanie w poziomie/w, należy uwzględnić liczbę całkowitą pojemności. Jeśli skalowanie w poziomie/w nie jest możliwe dla zasobu, może to zostać pominięte.
family	string	Jeśli usługa ma różne generacje sprzętu, dla tej samej jednostki SKU, można je przechwycić tutaj.
name	string	Nazwa jednostki SKU. Ex - P3. Zazwyczaj jest to kod z literą i cyfrą
size	string	Rozmiar jednostki SKU. Gdy pole nazwy jest kombinacją warstwy i innej wartości, będzie to autonomiczny kod.
tier	SkuTier	To pole jest wymagane do zaimplementowania przez dostawcę zasobów, jeśli usługa ma więcej niż jedną warstwę, ale nie jest wymagana w put.

SkuTier

Wyliczenie

To pole jest wymagane do zaimplementowania przez dostawcę zasobów, jeśli usługa ma więcej niż jedną warstwę, ale nie jest wymagana w put.

Wartość	Opis
Free
Basic
Standard
Premium

systemData

Sprzeciwiać się

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

Nazwa	Typ	Opis
createdAt	string (date-time)	Sygnatura czasowa tworzenia zasobu (UTC).
createdBy	string	Tożsamość, która utworzyła zasób.
createdByType	createdByType	Typ tożsamości, która utworzyła zasób.
lastModifiedAt	string (date-time)	Sygnatura czasowa ostatniej modyfikacji zasobu (UTC)
lastModifiedBy	string	Tożsamość, która ostatnio zmodyfikowała zasób.
lastModifiedByType	createdByType	Typ tożsamości, która ostatnio zmodyfikowała zasób.

UserAssignedIdentity

Sprzeciwiać się

Właściwości tożsamości przypisanej przez użytkownika

Nazwa	Typ	Opis
clientId	string (uuid)	Identyfikator klienta przypisanej tożsamości.
principalId	string (uuid)	Identyfikator podmiotu zabezpieczeń przypisanej tożsamości.

Udostępnij za pośrednictwem

Batch Endpoints - Create Or Update

Parametry URI

Ciało żądania

Odpowiedzi

Zabezpieczenia

azure_auth

Zakresów

Przykłady

CreateOrUpdate Workspace Batch Endpoint.

Przykładowa prośba

Przykładowa odpowiedź

Definicje

BatchEndpoint

BatchEndpointDefaults

BatchEndpointProperties

createdByType

EndpointAuthKeys

EndpointAuthMode

EndpointProvisioningState

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ManagedServiceIdentity

ManagedServiceIdentityType

Sku

SkuTier

systemData

UserAssignedIdentity