Batch Deployments - Create Or Update

Riferimento

Service:: Machine Learning

API Version:: 2024-04-01

Crea/aggiorna una distribuzione di inferenza batch (asincrona).

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
deploymentName	path	True	string	Identificatore per la distribuzione dell'inferenza Batch. Regex pattern: `^[a-zA-Z0-9][a-zA-Z0-9\-_]{0,254}$`
endpointName	path	True	string	Nome dell'endpoint di inferenza Regex pattern: `^[a-zA-Z0-9][a-zA-Z0-9\-_]{0,254}$`
resourceGroupName	path	True	string	Nome del gruppo di risorse. Per il nome non viene fatta 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. Regex pattern: `^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$`
api-version	query	True	string	Versione dell'API da usare per questa operazione.

Corpo della richiesta

Nome	Necessario	Tipo	Descrizione
location	True	string	Posizione geografica in cui vive la risorsa
properties	True	BatchDeployment	[Obbligatorio] Attributi aggiuntivi dell'entità.
identity		ManagedServiceIdentity	Identità del servizio gestita (identità assegnata dal sistema e/o assegnata dall'utente)
kind		string	Metadati usati dal portale/strumenti/ecc per eseguire il rendering di esperienze utente diverse per le risorse dello stesso tipo.
sku		Sku	Dettagli sku necessari per il contratto ARM per la scalabilità automatica.
tags		object	Tag di risorse.

Risposte

Nome	Tipo	Descrizione
200 OK	BatchDeploymentTrackedResource	Create o la richiesta di aggiornamento ha esito positivo.
201 Created	BatchDeploymentTrackedResource	Data di creazione Headers x-ms-async-operation-timeout: string Azure-AsyncOperation: string
Other Status Codes	ErrorResponse	Errore

Nome

Tipo

Descrizione

200 OK

BatchDeploymentTrackedResource

Create o la richiesta di aggiornamento ha esito positivo.

201 Created

BatchDeploymentTrackedResource

Data di creazione

Headers

x-ms-async-operation-timeout: string
Azure-AsyncOperation: string

Other Status Codes

ErrorResponse

Errore

Esempio

CreateOrUpdate Workspace Batch Deployment.

Sample Request

HTTP

PUT https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.MachineLearningServices/workspaces/my-aml-workspace/batchEndpoints/testEndpointName/deployments/testDeploymentName?api-version=2024-04-01

{
  "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": {
          "cd3c37dc-2876-4ca4-8a54-21bd7619724a": null
        }
      }
    }
  },
  "tags": {},
  "location": "string",
  "kind": "string",
  "identity": {
    "type": "SystemAssigned",
    "userAssignedIdentities": {
      "string": {}
    }
  },
  "sku": {
    "name": "string",
    "tier": "Free",
    "size": "string",
    "family": "string",
    "capacity": 1
  }
}

Sample Response

Status code:: 200

{
  "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": {
          "4939850d-8eae-4343-8566-0826259a2ad1": 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
  }
}

Status code:: 201

{
  "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": {
          "b76755e4-16bf-45d4-b625-6634df7444cc": 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
  }
}

Definizioni

Nome	Descrizione
BatchDeployment	Impostazioni di inferenza batch per distribuzione.
BatchDeploymentConfigurationType	Tipi di proprietà enumerati per le distribuzioni batch.
BatchDeploymentTrackedResource
BatchLoggingLevel	Dettaglio 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 una distribuzione del componente della pipeline batch.
BatchRetrySettings	Impostazioni di ripetizione dei tentativi per un'operazione di inferenza batch.
CodeConfiguration	Configurazione per un asset del codice di assegnazione dei punteggi.
createdByType	Tipo di identità che ha creato la risorsa.
DataPathAssetReference	Riferimento a un asset tramite il percorso in un archivio dati.
DeploymentProvisioningState	Valori possibili per DeploymentProvisioningState.
DeploymentResourceConfiguration
ErrorAdditionalInfo	Informazioni aggiuntive sulla 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 i tipi SystemAssigned e UserAssigned).
OutputPathAssetReference	Riferimento a un asset tramite il percorso in un output del processo.
ReferenceType	Enumerazione per determinare quale metodo di riferimento usare per un asset.
Sku	Definizione del modello di risorsa 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 dei file. Per TabularDataset, questo valore è il conteggio degli errori dei 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: DataPathAssetReference IdAssetReference OutputPathAssetReference		Riferimento all'asset del modello per la distribuzione dell'endpoint.
outputAction	BatchOutputAction	AppendRow	Indica come verrà organizzato l'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 di 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	Azure Resource Manager metadati contenenti le informazioni createdBy e modifiedBy.
tags	object	Tag delle risorse.
type	string	Tipo di risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

BatchLoggingLevel

Dettaglio 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 una distribuzione del componente della pipeline batch.

Nome	Tipo	Descrizione
componentId	IdAssetReference	ID ARM del componente da eseguire.
deploymentConfigurationType	string: PipelineComponent	[Obbligatorio] Tipo della 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 del 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 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/directory nell'archivio dati.
referenceType	string: DataPath	[Obbligatorio] Specifica il tipo di riferimento dell'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 sulla 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 dell'asset.

ManagedServiceIdentity

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

Nome	Tipo	Descrizione
principalId	string	ID dell'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 i tipi SystemAssigned e 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 i tipi SystemAssigned e UserAssigned).

Nome	Tipo	Descrizione
None	string
SystemAssigned	string
SystemAssigned,UserAssigned	string
UserAssigned	string

OutputPathAssetReference

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

Nome	Tipo	Descrizione
jobId	string	ID risorsa ARM del processo.
path	string	Percorso del file/directory nell'output del processo.
referenceType	string: OutputPath	[Obbligatorio] Specifica il tipo di riferimento dell'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 risorsa che rappresenta lo SKU

Nome	Tipo	Descrizione
capacity	integer	Se lo SKU supporta la scalabilità orizzontale/in, è necessario includere l'intero della capacità. Se non è possibile aumentare o ridurre il numero di istanze per la risorsa, è possibile che venga omesso.
family	string	Se il servizio ha generazioni diverse di hardware, per lo stesso SKU, può essere acquisito qui.
name	string	Il nome della SKU. Ad esempio - P3. Si tratta in genere di un codice lettera+numero
size	string	Dimensioni dello SKU. Quando il campo name è 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 di risorse (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 principale dell'identità assegnata.

Batch Deployments - Create Or Update

Parametri dell'URI

Corpo della richiesta

Risposte

Esempio

CreateOrUpdate Workspace Batch Deployment.

Sample Request

Sample Response

Definizioni

BatchDeployment

BatchDeploymentConfigurationType

BatchDeploymentTrackedResource

BatchLoggingLevel

BatchOutputAction

BatchPipelineComponentDeploymentConfiguration

BatchRetrySettings

CodeConfiguration

createdByType

DataPathAssetReference

DeploymentProvisioningState

DeploymentResourceConfiguration

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

IdAssetReference

ManagedServiceIdentity

ManagedServiceIdentityType

OutputPathAssetReference

ReferenceType

Sku

SkuTier

systemData

UserAssignedIdentity

Risorse aggiuntive