Udostępnij za pośrednictwem


Batch Deployments - List

Listy wdrożenia wnioskowania usługi Batch w obszarze roboczym.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/batchEndpoints/{endpointName}/deployments?api-version=2024-04-01
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/batchEndpoints/{endpointName}/deployments?api-version=2024-04-01&$orderBy={$orderBy}&$top={$top}&$skip={$skip}

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
endpointName
path True

string

Nazwa punktu końcowego

resourceGroupName
path True

string

Nazwa grupy zasobów. W nazwie jest uwzględniana wielkość liter.

subscriptionId
path True

string

Identyfikator subskrypcji docelowej.

workspaceName
path True

string

Nazwa obszaru roboczego usługi Azure Machine Learning.

Wzorzec wyrażenia regularnego: ^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$

api-version
query True

string

Wersja interfejsu API do użycia dla tej operacji.

$orderBy
query

string

Kolejność listy.

$skip
query

string

Token kontynuacji dla stronicowania.

$top
query

integer

int32

Górna część listy.

Odpowiedzi

Nazwa Typ Opis
200 OK

BatchDeploymentTrackedResourceArmPaginatedResult

Powodzenie

Other Status Codes

ErrorResponse

Błąd

Przykłady

List Workspace Batch Deployment.

Przykładowe żądanie

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.MachineLearningServices/workspaces/my-aml-workspace/batchEndpoints/testEndpointName/deployments?api-version=2024-04-01&$orderBy=string&$top=1

Przykładowa odpowiedź

{
  "value": [
    {
      "id": "string",
      "name": "string",
      "type": "string",
      "properties": {
        "description": "string",
        "properties": {
          "string": "string"
        },
        "codeConfiguration": {
          "codeId": "string",
          "scoringScript": "string"
        },
        "environmentId": "string",
        "environmentVariables": {
          "string": "string"
        },
        "compute": "string",
        "errorThreshold": 1,
        "retrySettings": {
          "maxRetries": 1,
          "timeout": "PT5M"
        },
        "miniBatchSize": 1,
        "loggingLevel": "Info",
        "model": {
          "referenceType": "Id",
          "assetId": "string"
        },
        "maxConcurrencyPerInstance": 1,
        "outputAction": "SummaryOnly",
        "outputFileName": "string",
        "resources": {
          "instanceCount": 1,
          "instanceType": "string",
          "properties": {
            "string": {
              "a3c13e2e-a213-4cac-9f5a-b49966906ad6": null
            }
          }
        },
        "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
      }
    }
  ],
  "nextLink": "string"
}

Definicje

Nazwa Opis
BatchDeployment

Ustawienia wnioskowania wsadowego na wdrożenie.

BatchDeploymentConfigurationType

Wyliczone typy właściwości dla wdrożeń wsadowych.

BatchDeploymentTrackedResource
BatchDeploymentTrackedResourceArmPaginatedResult

Lista jednostek BatchDeployment z podziałem na strony.

BatchLoggingLevel

Pełne informacje dziennika dotyczące wnioskowania wsadowego. Zwiększenie kolejności szczegółowości rejestrowania to: Ostrzeżenie, Informacje i Debugowanie. Wartość domyślna to Informacje.

BatchOutputAction

Wyliczenie w celu określenia, jak wnioskowanie wsadowe będzie obsługiwać dane wyjściowe

BatchPipelineComponentDeploymentConfiguration

Właściwości wdrożenia składnika potoku usługi Batch.

BatchRetrySettings

Ponów próbę ustawień operacji wnioskowania wsadowego.

CodeConfiguration

Konfiguracja zasobu kodu oceniania.

createdByType

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

DataPathAssetReference

Odwołanie do zasobu za pośrednictwem jego ścieżki w magazynie danych.

DeploymentProvisioningState

Możliwe wartości parametru DeploymentProvisioningState.

DeploymentResourceConfiguration
ErrorAdditionalInfo

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

ErrorDetail

Szczegóły błędu.

ErrorResponse

Odpowiedź na błąd

IdAssetReference

Odwołanie do zasobu za pośrednictwem identyfikatora zasobu usługi ARM.

ManagedServiceIdentity

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

ManagedServiceIdentityType

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

OutputPathAssetReference

Odwołanie do elementu zawartości za pośrednictwem jego ścieżki w danych wyjściowych zadania.

ReferenceType

Wyliczenie określające, która metoda referencyjna ma być używana dla elementu zawartości.

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 funkcji PUT.

systemData

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

UserAssignedIdentity

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

BatchDeployment

Ustawienia wnioskowania wsadowego na wdrożenie.

Nazwa Typ Domyślna wartość Opis
codeConfiguration

CodeConfiguration

Konfiguracja kodu dla wdrożenia punktu końcowego.

compute

string

Obiekt docelowy obliczeniowy dla operacji wnioskowania wsadowego.

deploymentConfiguration BatchDeploymentConfiguration:

BatchPipelineComponentDeploymentConfiguration

Właściwości istotne dla różnych typów wdrożeń.

description

string

Opis wdrożenia punktu końcowego.

environmentId

string

Identyfikator zasobu usługi ARM lub identyfikator zasobu specyfikacji środowiska dla wdrożenia punktu końcowego.

environmentVariables

object

Konfiguracja zmiennych środowiskowych dla wdrożenia.

errorThreshold

integer

-1

Próg błędu, jeśli liczba błędów dla całego danych wejściowych przekroczy tę wartość, wnioskowanie wsadowe zostanie przerwane. Zakres to [-1, int. MaxValue]. W przypadku elementu FileDataset ta wartość jest liczbą błędów plików. W przypadku zestawu TabularDataset ta wartość jest liczbą błędów rekordów. Jeśli ustawiono wartość -1 (dolną granicę), wszystkie błędy podczas wnioskowania wsadowego zostaną zignorowane.

loggingLevel

BatchLoggingLevel

Info

Poziom rejestrowania dla operacji wnioskowania wsadowego.

maxConcurrencyPerInstance

integer

1

Wskazuje maksymalną liczbę równoległości na wystąpienie.

miniBatchSize

integer

10

Rozmiar minisadowej partii przekazanej do każdej wywołania partii. W przypadku elementu FileDataset jest to liczba plików na minisadę. W przypadku zestawu TabularDataset jest to rozmiar rekordów w bajtach na minisadę.

model AssetReferenceBase:

Odwołanie do zasobu modelu dla wdrożenia punktu końcowego.

outputAction

BatchOutputAction

AppendRow

Wskazuje sposób organizowania danych wyjściowych.

outputFileName

string

predictions.csv

Niestandardowa nazwa pliku wyjściowego append_row akcji wyjściowej.

properties

object

Słownik właściwości. Właściwości można dodać, ale nie usuwać ani zmieniać.

provisioningState

DeploymentProvisioningState

Stan aprowizacji dla wdrożenia punktu końcowego.

resources

DeploymentResourceConfiguration

Wskazuje konfigurację obliczeniową zadania. Jeśli nie zostanie podana, wartość domyślna zostanie ustawiona na wartości domyślne zdefiniowane w usłudze ResourceConfiguration.

retrySettings

BatchRetrySettings

Ponów próbę ustawienia operacji wnioskowania wsadowego. Jeśli nie zostanie podana wartość domyślna, zostanie ustawiona na wartości domyślne zdefiniowane w usłudze BatchRetrySettings.

BatchDeploymentConfigurationType

Wyliczone typy właściwości dla wdrożeń wsadowych.

Nazwa Typ Opis
Model

string

PipelineComponent

string

BatchDeploymentTrackedResource

Nazwa Typ Opis
id

string

W pełni kwalifikowany identyfikator zasobu dla zasobu. Ex — /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

identity

ManagedServiceIdentity

Tożsamość usługi zarządzanej (tożsamości przypisane przez system i/lub 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

BatchDeployment

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

BatchDeploymentTrackedResourceArmPaginatedResult

Lista jednostek BatchDeployment z podziałem na strony.

Nazwa Typ Opis
nextLink

string

Link do następnej strony obiektów BatchDeployment. Jeśli wartość null, nie ma żadnych dodatkowych stron.

value

BatchDeploymentTrackedResource[]

Tablica obiektów typu BatchDeployment.

BatchLoggingLevel

Pełne informacje dziennika dotyczące wnioskowania wsadowego. Zwiększenie kolejności szczegółowości rejestrowania to: Ostrzeżenie, Informacje i Debugowanie. Wartość domyślna to Informacje.

Nazwa Typ Opis
Debug

string

Info

string

Warning

string

BatchOutputAction

Wyliczenie w celu określenia, jak wnioskowanie wsadowe będzie obsługiwać dane wyjściowe

Nazwa Typ Opis
AppendRow

string

SummaryOnly

string

BatchPipelineComponentDeploymentConfiguration

Właściwości wdrożenia składnika potoku usługi Batch.

Nazwa Typ Opis
componentId

IdAssetReference

Identyfikator arm składnika, który ma zostać uruchomiony.

deploymentConfigurationType string:

PipelineComponent

[Wymagane] Typ wdrożenia

description

string

Opis, który zostanie zastosowany do zadania.

settings

object

Ustawienia czasu wykonywania dla zadania potoku.

tags

object

Tagi, które zostaną zastosowane do zadania.

BatchRetrySettings

Ponów próbę ustawień operacji wnioskowania wsadowego.

Nazwa Typ Domyślna wartość Opis
maxRetries

integer

3

Maksymalna liczba ponownych prób dla mini-partii

timeout

string

PT30S

Limit czasu wywołania dla mini-partii w formacie ISO 8601.

CodeConfiguration

Konfiguracja zasobu kodu oceniania.

Nazwa Typ Opis
codeId

string

Identyfikator zasobu usługi ARM zasobu kodu.

scoringScript

string

[Wymagane] Skrypt do wykonania podczas uruchamiania. np. "score.py"

createdByType

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

Nazwa Typ Opis
Application

string

Key

string

ManagedIdentity

string

User

string

DataPathAssetReference

Odwołanie do zasobu za pośrednictwem jego ścieżki w magazynie danych.

Nazwa Typ Opis
datastoreId

string

Identyfikator zasobu usługi ARM magazynu danych, w którym znajduje się zasób.

path

string

Ścieżka pliku/katalogu w magazynie danych.

referenceType string:

DataPath

[Wymagane] Określa typ odwołania do zasobu.

DeploymentProvisioningState

Możliwe wartości parametru DeploymentProvisioningState.

Nazwa Typ Opis
Canceled

string

Creating

string

Deleting

string

Failed

string

Scaling

string

Succeeded

string

Updating

string

DeploymentResourceConfiguration

Nazwa Typ Domyślna wartość Opis
instanceCount

integer

1

Opcjonalna liczba wystąpień lub węzłów używanych przez docelowy obiekt obliczeniowy.

instanceType

string

Opcjonalny typ maszyny wirtualnej używany jako obsługiwany przez docelowy obiekt obliczeniowy.

properties

object

Dodatkowa torba właściwości.

ErrorAdditionalInfo

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

Nazwa Typ Opis
info

object

Dodatkowe informacje.

type

string

Dodatkowy typ informacji.

ErrorDetail

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

Odpowiedź na błąd

Nazwa Typ Opis
error

ErrorDetail

Obiekt błędu.

IdAssetReference

Odwołanie do zasobu za pośrednictwem identyfikatora zasobu usługi ARM.

Nazwa Typ Opis
assetId

string

[Wymagane] Identyfikator zasobu usługi ARM.

referenceType string:

Id

[Wymagane] Określa typ odwołania do zasobu.

ManagedServiceIdentity

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

Nazwa Typ Opis
principalId

string

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

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

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

Nazwa Typ Opis
None

string

SystemAssigned

string

SystemAssigned,UserAssigned

string

UserAssigned

string

OutputPathAssetReference

Odwołanie do elementu zawartości za pośrednictwem jego ścieżki w danych wyjściowych zadania.

Nazwa Typ Opis
jobId

string

Identyfikator zasobu usługi ARM zadania.

path

string

Ścieżka pliku/katalogu w danych wyjściowych zadania.

referenceType string:

OutputPath

[Wymagane] Określa typ odwołania do zasobu.

ReferenceType

Wyliczenie określające, która metoda referencyjna ma być używana dla elementu zawartości.

Nazwa Typ Opis
DataPath

string

Id

string

OutputPath

string

Sku

Definicja modelu zasobów reprezentująca jednostkę SKU

Nazwa Typ Opis
capacity

integer

Jeśli jednostka SKU obsługuje skalowanie w poziomie/w poziomie, 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 litery i cyfry

size

string

Rozmiar jednostki SKU. Gdy pole nazwy jest kombinacją warstwy i inną 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

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 funkcji PUT.

Nazwa Typ Opis
Basic

string

Free

string

Premium

string

Standard

string

systemData

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

Nazwa Typ Opis
createdAt

string

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

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

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

Nazwa Typ Opis
clientId

string

Identyfikator klienta przypisanej tożsamości.

principalId

string

Identyfikator podmiotu zabezpieczeń przypisanej tożsamości.