Condividi tramite


Batch Deployments - List

Elenca le distribuzioni di inferenza batch nell'area di lavoro.

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}

Parametri dell'URI

Nome In Necessario Tipo Descrizione
endpointName
path True

string

Nome endpoint

resourceGroupName
path True

string

Nome del gruppo di risorse. Il nome non fa distinzione tra maiuscole e minuscole.

subscriptionId
path True

string

ID della sottoscrizione di destinazione.

workspaceName
path True

string

Nome dell'area di lavoro di Azure Machine Learning.

Criterio di espressione regolare: ^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$

api-version
query True

string

Versione dell'API da usare per questa operazione.

$orderBy
query

string

Ordinamento dell'elenco.

$skip
query

string

Token di continuazione per la paginazione.

$top
query

integer

int32

Inizio dell'elenco.

Risposte

Nome Tipo Descrizione
200 OK

BatchDeploymentTrackedResourceArmPaginatedResult

Successo

Other Status Codes

ErrorResponse

Errore

Esempio

List Workspace Batch Deployment.

Esempio di richiesta

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

Risposta di esempio

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

Definizioni

Nome Descrizione
BatchDeployment

Impostazioni di inferenza batch per distribuzione.

BatchDeploymentConfigurationType

Tipi di proprietà enumerati per le distribuzioni batch.

BatchDeploymentTrackedResource
BatchDeploymentTrackedResourceArmPaginatedResult

Elenco impaginato di entità BatchDeployment.

BatchLoggingLevel

Dettagli del log per l'inferenza batch. L'aumento dell'ordine di dettaglio per la registrazione è: avviso, informazioni e debug. Il valore predefinito è Info.

BatchOutputAction

Enumerazione per determinare come l'inferenza batch gestirà l'output

BatchPipelineComponentDeploymentConfiguration

Proprietà per la distribuzione di un componente della pipeline batch.

BatchRetrySettings

Impostazioni di ripetizione dei tentativi per un'operazione di inferenza batch.

CodeConfiguration

Configurazione per un asset di codice di assegnazione dei punteggi.

createdByType

Tipo di identità che ha creato la risorsa.

DataPathAssetReference

Riferimento a un asset tramite il relativo percorso in un archivio dati.

DeploymentProvisioningState

Valori possibili per DeploymentProvisioningState.

DeploymentResourceConfiguration
ErrorAdditionalInfo

Informazioni aggiuntive sull'errore di gestione delle risorse.

ErrorDetail

Dettagli dell'errore.

ErrorResponse

Risposta di errore

IdAssetReference

Riferimento a un asset tramite l'ID risorsa arm.

ManagedServiceIdentity

Identità del servizio gestita (identità assegnate dal sistema e/o assegnate dall'utente)

ManagedServiceIdentityType

Tipo di identità del servizio gestito (in cui sono consentiti sia i tipi SystemAssigned che UserAssigned).

OutputPathAssetReference

Riferimento a un asset tramite il relativo percorso in un output del processo.

ReferenceType

Enumerazione per determinare quale metodo di riferimento usare per un asset.

Sku

Definizione del modello di risorse che rappresenta lo SKU

SkuTier

Questo campo deve essere implementato dal provider di risorse se il servizio ha più di un livello, ma non è necessario in un PUT.

systemData

Metadati relativi alla creazione e all'ultima modifica della risorsa.

UserAssignedIdentity

Proprietà di identità assegnate dall'utente

BatchDeployment

Impostazioni di inferenza batch per distribuzione.

Nome Tipo Valore predefinito Descrizione
codeConfiguration

CodeConfiguration

Configurazione del codice per la distribuzione dell'endpoint.

compute

string

Destinazione di calcolo per l'operazione di inferenza batch.

deploymentConfiguration BatchDeploymentConfiguration:

BatchPipelineComponentDeploymentConfiguration

Proprietà rilevanti per diversi tipi di distribuzione.

description

string

Descrizione della distribuzione dell'endpoint.

environmentId

string

ID risorsa ARM o AssetId della specifica dell'ambiente per la distribuzione dell'endpoint.

environmentVariables

object

Configurazione delle variabili di ambiente per la distribuzione.

errorThreshold

integer

-1

Soglia di errore, se il conteggio degli errori per l'intero input supera questo valore, l'inferenza batch verrà interrotta. L'intervallo è [-1, int. MaxValue]. Per FileDataset, questo valore è il numero di errori di file. Per TabularDataset, questo valore è il numero di errori di record. Se impostato su -1 (limite inferiore), tutti gli errori durante l'inferenza batch verranno ignorati.

loggingLevel

BatchLoggingLevel

Info

Livello di registrazione per l'operazione di inferenza batch.

maxConcurrencyPerInstance

integer

1

Indica il numero massimo di parallelismo per istanza.

miniBatchSize

integer

10

Dimensioni del mini batch passato a ogni chiamata batch. Per FileDataset, si tratta del numero di file per mini batch. Per TabularDataset, si tratta delle dimensioni dei record in byte, per mini batch.

model AssetReferenceBase:

Riferimento all'asset del modello per la distribuzione dell'endpoint.

outputAction

BatchOutputAction

AppendRow

Indica la modalità di organizzazione dell'output.

outputFileName

string

predictions.csv

Nome file di output personalizzato per append_row'azione di output.

properties

object

Dizionario delle proprietà. Le proprietà possono essere aggiunte, ma non rimosse o modificate.

provisioningState

DeploymentProvisioningState

Stato di provisioning per la distribuzione dell'endpoint.

resources

DeploymentResourceConfiguration

Indica la configurazione di calcolo per il processo. Se non specificato, per impostazione predefinita verranno specificate le impostazioni predefinite definite in ResourceConfiguration.

retrySettings

BatchRetrySettings

Impostazioni di ripetizione dei tentativi per l'operazione di inferenza batch. Se non specificato, per impostazione predefinita verranno specificate le impostazioni predefinite definite in BatchRetrySettings.

BatchDeploymentConfigurationType

Tipi di proprietà enumerati per le distribuzioni batch.

Nome Tipo Descrizione
Model

string

PipelineComponent

string

BatchDeploymentTrackedResource

Nome Tipo Descrizione
id

string

ID risorsa completo per la risorsa. Ad esempio - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

identity

ManagedServiceIdentity

Identità del servizio gestita (identità assegnate dal sistema e/o assegnate dall'utente)

kind

string

Metadati usati dal portale, dagli strumenti e così via per eseguire il rendering di esperienze utente diverse per le risorse dello stesso tipo.

location

string

Posizione geografica in cui risiede la risorsa

name

string

Nome della risorsa

properties

BatchDeployment

[Obbligatorio] Attributi aggiuntivi dell'entità.

sku

Sku

Dettagli sku necessari per il contratto ARM per la scalabilità automatica.

systemData

systemData

Metadati di Azure Resource Manager contenenti le informazioni createdBy e modifiedBy.

tags

object

Tag di risorsa.

type

string

Tipo della risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

BatchDeploymentTrackedResourceArmPaginatedResult

Elenco impaginato di entità BatchDeployment.

Nome Tipo Descrizione
nextLink

string

Collegamento alla pagina successiva degli oggetti BatchDeployment. Se null, non sono presenti pagine aggiuntive.

value

BatchDeploymentTrackedResource[]

Matrice di oggetti di tipo BatchDeployment.

BatchLoggingLevel

Dettagli del log per l'inferenza batch. L'aumento dell'ordine di dettaglio per la registrazione è: avviso, informazioni e debug. Il valore predefinito è Info.

Nome Tipo Descrizione
Debug

string

Info

string

Warning

string

BatchOutputAction

Enumerazione per determinare come l'inferenza batch gestirà l'output

Nome Tipo Descrizione
AppendRow

string

SummaryOnly

string

BatchPipelineComponentDeploymentConfiguration

Proprietà per la distribuzione di un componente della pipeline batch.

Nome Tipo Descrizione
componentId

IdAssetReference

ID ARM del componente da eseguire.

deploymentConfigurationType string:

PipelineComponent

[Obbligatorio] Tipo di distribuzione

description

string

Descrizione che verrà applicata al processo.

settings

object

Impostazioni di runtime per il processo della pipeline.

tags

object

Tag che verranno applicati al processo.

BatchRetrySettings

Impostazioni di ripetizione dei tentativi per un'operazione di inferenza batch.

Nome Tipo Valore predefinito Descrizione
maxRetries

integer

3

Numero massimo di tentativi per un mini batch

timeout

string

PT30S

Timeout di chiamata per un mini batch, in formato ISO 8601.

CodeConfiguration

Configurazione per un asset di codice di assegnazione dei punteggi.

Nome Tipo Descrizione
codeId

string

ID risorsa ARM dell'asset di codice.

scoringScript

string

[Obbligatorio] Script da eseguire all'avvio. ad esempio. "score.py"

createdByType

Tipo di identità che ha creato la risorsa.

Nome Tipo Descrizione
Application

string

Key

string

ManagedIdentity

string

User

string

DataPathAssetReference

Riferimento a un asset tramite il relativo percorso in un archivio dati.

Nome Tipo Descrizione
datastoreId

string

ID risorsa ARM dell'archivio dati in cui si trova l'asset.

path

string

Percorso del file o della directory nell'archivio dati.

referenceType string:

DataPath

[Obbligatorio] Specifica il tipo di riferimento all'asset.

DeploymentProvisioningState

Valori possibili per DeploymentProvisioningState.

Nome Tipo Descrizione
Canceled

string

Creating

string

Deleting

string

Failed

string

Scaling

string

Succeeded

string

Updating

string

DeploymentResourceConfiguration

Nome Tipo Valore predefinito Descrizione
instanceCount

integer

1

Numero facoltativo di istanze o nodi usati dalla destinazione di calcolo.

instanceType

string

Tipo facoltativo di macchina virtuale usato come supportato dalla destinazione di calcolo.

properties

object

Contenitore di proprietà aggiuntive.

ErrorAdditionalInfo

Informazioni aggiuntive sull'errore di gestione delle risorse.

Nome Tipo Descrizione
info

object

Informazioni aggiuntive.

type

string

Tipo di informazioni aggiuntive.

ErrorDetail

Dettagli dell'errore.

Nome Tipo Descrizione
additionalInfo

ErrorAdditionalInfo[]

Informazioni aggiuntive sull'errore.

code

string

Codice di errore.

details

ErrorDetail[]

Dettagli dell'errore.

message

string

Messaggio di errore.

target

string

Destinazione dell'errore.

ErrorResponse

Risposta di errore

Nome Tipo Descrizione
error

ErrorDetail

Oggetto error.

IdAssetReference

Riferimento a un asset tramite l'ID risorsa arm.

Nome Tipo Descrizione
assetId

string

[Obbligatorio] ID risorsa ARM dell'asset.

referenceType string:

Id

[Obbligatorio] Specifica il tipo di riferimento all'asset.

ManagedServiceIdentity

Identità del servizio gestita (identità assegnate dal sistema e/o assegnate dall'utente)

Nome Tipo Descrizione
principalId

string

ID entità servizio dell'identità assegnata dal sistema. Questa proprietà verrà fornita solo per un'identità assegnata dal sistema.

tenantId

string

ID tenant dell'identità assegnata dal sistema. Questa proprietà verrà fornita solo per un'identità assegnata dal sistema.

type

ManagedServiceIdentityType

Tipo di identità del servizio gestito (in cui sono consentiti sia i tipi SystemAssigned che UserAssigned).

userAssignedIdentities

<string,  UserAssignedIdentity>

identità User-Assigned
Set di identità assegnate dall'utente associate alla risorsa. Le chiavi del dizionario userAssignedIdentities saranno ID risorsa ARM nel formato : '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. I valori del dizionario possono essere oggetti vuoti ({}) nelle richieste.

ManagedServiceIdentityType

Tipo di identità del servizio gestito (in cui sono consentiti sia i tipi SystemAssigned che UserAssigned).

Nome Tipo Descrizione
None

string

SystemAssigned

string

SystemAssigned,UserAssigned

string

UserAssigned

string

OutputPathAssetReference

Riferimento a un asset tramite il relativo percorso in un output del processo.

Nome Tipo Descrizione
jobId

string

ID risorsa ARM del processo.

path

string

Percorso del file o della directory nell'output del processo.

referenceType string:

OutputPath

[Obbligatorio] Specifica il tipo di riferimento all'asset.

ReferenceType

Enumerazione per determinare quale metodo di riferimento usare per un asset.

Nome Tipo Descrizione
DataPath

string

Id

string

OutputPath

string

Sku

Definizione del modello di risorse che rappresenta lo SKU

Nome Tipo Descrizione
capacity

integer

Se lo SKU supporta l'aumento o l'aumento del numero di istanze, è necessario includere l'intero della capacità. Se non è possibile aumentare o ridurre il numero di istanze per la risorsa, potrebbe essere omesso.

family

string

Se il servizio ha generazioni diverse di hardware, per lo stesso SKU, è possibile acquisire qui.

name

string

Nome dello SKU. Ad esempio - P3. Si tratta in genere di un codice lettera+numero

size

string

Dimensioni dello SKU. Quando il campo nome è la combinazione di livello e un altro valore, si tratta del codice autonomo.

tier

SkuTier

Questo campo deve essere implementato dal provider di risorse se il servizio ha più di un livello, ma non è necessario in un PUT.

SkuTier

Questo campo deve essere implementato dal provider di risorse se il servizio ha più di un livello, ma non è necessario in un PUT.

Nome Tipo Descrizione
Basic

string

Free

string

Premium

string

Standard

string

systemData

Metadati relativi alla creazione e all'ultima modifica della risorsa.

Nome Tipo Descrizione
createdAt

string

Timestamp della creazione della risorsa (UTC).

createdBy

string

Identità che ha creato la risorsa.

createdByType

createdByType

Tipo di identità che ha creato la risorsa.

lastModifiedAt

string

Timestamp dell'ultima modifica della risorsa (UTC)

lastModifiedBy

string

Identità che ha modificato l'ultima volta la risorsa.

lastModifiedByType

createdByType

Tipo di identità che ha modificato l'ultima volta la risorsa.

UserAssignedIdentity

Proprietà di identità assegnate dall'utente

Nome Tipo Descrizione
clientId

string

ID client dell'identità assegnata.

principalId

string

ID entità dell'identità assegnata.