Batch Deployments - List

Služba:: Machine Learning

Verze rozhraní API:: 2025-12-01

Zobrazí seznam nasazení dávkového odvozování v pracovním prostoru.

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

S volitelnými parametry:

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
endpointName	path	True	string	Název koncového bodu batch
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Název skupiny prostředků. Název nerozlišuje malá a velká písmena.
subscriptionId	path	True	string minLength: 1	ID cílového předplatného.
workspaceName	path	True	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$	Název pracovního prostoru služby Azure Machine Learning
api-version	query	True	string minLength: 1	Verze rozhraní API, která se má použít pro tuto operaci.
$orderBy	query		string	Řazení seznamu
$skip	query		string	Token pokračování pro stránkování
$top	query		integer (int32)	Začátek seznamu

Odpovědi

Name	Typ	Description
200 OK	BatchDeploymentTrackedResourceArmPaginatedResult	Operace Azure byla úspěšně dokončena.
Other Status Codes	ErrorResponse	Neočekávaná chybová odpověď

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2.

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

List Workspace Batch Deployment.

Ukázkový požadavek

HTTP

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=2025-12-01&$orderBy=string&$top=1

Ukázková odpověď

Stavový kód:: 200

{
  "nextLink": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/my-aml-workspace/batchEndpoints/testEndpointName/deployments?api-version=2025-07-01-preview&$skip=2",
  "value": [
    {
      "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",
        "codeConfiguration": {
          "codeId": "string",
          "scoringScript": "string"
        },
        "compute": "string",
        "environmentId": "string",
        "environmentVariables": {
          "string": "string"
        },
        "errorThreshold": 1,
        "loggingLevel": "Info",
        "maxConcurrencyPerInstance": 1,
        "miniBatchSize": 1,
        "model": {
          "assetId": "string",
          "referenceType": "Id"
        },
        "outputAction": "SummaryOnly",
        "outputFileName": "string",
        "properties": {
          "string": "string"
        },
        "provisioningState": "Creating",
        "resources": {
          "instanceCount": 1,
          "instanceType": "string",
          "properties": {
            "string": {
              "a3c13e2e-a213-4cac-9f5a-b49966906ad6": null
            }
          }
        },
        "retrySettings": {
          "maxRetries": 1,
          "timeout": "PT5M"
        }
      },
      "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": {}
    }
  ]
}

Definice

Name	Description
BatchDeployment	Konkrétní sledované typy prostředků lze vytvořit aliasem tohoto typu pomocí konkrétního typu vlastnosti.
BatchDeploymentConfigurationType	Výčtové typy vlastností pro dávková nasazení.
BatchDeploymentProperties	Nastavení dávkového odvozování pro každé nasazení.
BatchDeploymentTrackedResourceArmPaginatedResult	Stránkovaný seznam entit BatchDeployment.
BatchLoggingLevel	Protokolujte podrobnost pro dávkové odvozování. Zvyšuje se pořadí podrobností pro protokolování je: Varování, Informace a Ladění. Výchozí hodnota je Info.
BatchOutputAction	Výčet k určení, jak bude dávkové odvozování zpracovávat výstup
BatchPipelineComponentDeploymentConfiguration	Vlastnosti pro nasazení komponenty kanálu Batch.
BatchRetrySettings	Opakujte nastavení pro operaci dávkového odvozování.
CodeConfiguration	Konfigurace pro prostředek bodovacího kódu.
createdByType	Typ identity, která prostředek vytvořila.
DataPathAssetReference	Odkazovat na datový zdroj prostřednictvím jeho cesty v datovém úložišti.
DeploymentProvisioningState	Možné hodnoty pro DeploymentProvisioningState.
DeploymentResourceConfiguration
ErrorAdditionalInfo	Chyba správy zdrojů další informace.
ErrorDetail	Detail chyby.
ErrorResponse	Chybová odpověď
IdAssetReference	Odkaz na datový zdroj prostřednictvím ID prostředku ARM.
ManagedServiceIdentity	Identita spravované služby (identita přiřazená systémem nebo identita přiřazená uživatelem)
ManagedServiceIdentityType	Typ identity spravované služby (kde jsou povolené typy SystemAssigned i UserAssigned).
OutputPathAssetReference	Odkaz na datový zdroj prostřednictvím jeho cesty ve výstupu úlohy.
ReferenceType	Výčet k určení, která referenční metoda se má pro datový zdroj použít.
Sku	Definice modelu prostředků představující skladovou položku
SkuTier	Toto pole musí implementovat poskytovatel prostředků, pokud má služba více než jednu úroveň, ale nevyžaduje se u put.
systemData	Metadata týkající se vytvoření a poslední změny prostředku.
UserAssignedIdentity	Vlastnosti identity přiřazené uživatelem

BatchDeployment

Objekt

Konkrétní sledované typy prostředků lze vytvořit aliasem tohoto typu pomocí konkrétního typu vlastnosti.

Name	Typ	Description
id	string	Plně kvalifikované ID prostředku pro prostředek. Příklad : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	ManagedServiceIdentity	Identita spravované služby (identita přiřazená systémem nebo identita přiřazená uživatelem)
kind	string	Metadata používaná portálem, nástroji atd. k vykreslení různých prostředí uživatelského rozhraní pro prostředky stejného typu.
location	string	Geografické umístění, ve kterém se nachází zdroj
name	string	Název prostředku
properties	BatchDeploymentProperties	[Povinné] Další atributy entity.
sku	Sku	Podrobnosti skladové položky vyžadované pro kontrakt ARM pro automatické škálování
systemData	systemData	Metadata služby Azure Resource Manager obsahující informace o tom, kdo jej vytvořil a upravil.
tags	object	Značky prostředků
type	string	Typ prostředku. Např. "Microsoft.Compute/virtualMachines" nebo "Microsoft.Storage/storageAccounts"

BatchDeploymentConfigurationType

Výčet

Výčtové typy vlastností pro dávková nasazení.

Hodnota	Description
Model
PipelineComponent

BatchDeploymentProperties

Objekt

Nastavení dávkového odvozování pro každé nasazení.

Name	Typ	Default value	Description
codeConfiguration	CodeConfiguration		Konfigurace kódu pro nasazení koncového bodu
compute	string		Cílový výpočetní objekt pro operaci dávkového odvozování
deploymentConfiguration	BatchDeploymentConfiguration: BatchPipelineComponentDeploymentConfiguration		Vlastnosti relevantní pro různé typy nasazení
description	string		Popis nasazení koncového bodu
environmentId	string		ID prostředku ARM nebo AssetId specifikace prostředí pro nasazení koncového bodu
environmentVariables	object		Konfigurace proměnných prostředí pro nasazení
errorThreshold	integer (int32)	-1	Prahová hodnota chyby, pokud počet chyb pro celý vstup překročí tuto hodnotu, dávkové odvození se přeruší. Rozsah je [-1, int. MaxValue]. U FileDataset je tato hodnota počet selhání souborů. Pro TabularDataset je tato hodnota počet selhání záznamů. Pokud je nastavená hodnota -1 (dolní mez), budou všechna selhání během dávkového odvozu ignorována.
loggingLevel	BatchLoggingLevel	Info	Protokolujte podrobnost pro dávkové odvozování. Zvyšuje se pořadí podrobností pro protokolování je: Varování, Informace a Ladění. Výchozí hodnota je Info.
maxConcurrencyPerInstance	integer (int32)	1	Určuje maximální počet paralelismu na instanci.
miniBatchSize	integer (int64)	10	Velikost minidávkové dávky předané každému vyvolání dávky U FileDataset se jedná o počet souborů na minidávku. U TabularDataset se jedná o velikost záznamů v bajtech na minidávku.
model	AssetReferenceBase: DataPathAssetReference IdAssetReference OutputPathAssetReference		Odkaz na prostředek modelu pro nasazení koncového bodu
outputAction	BatchOutputAction	AppendRow	Výčet k určení, jak bude dávkové odvozování zpracovávat výstup
outputFileName	string	predictions.csv	Přizpůsobený název výstupního souboru pro append_row výstupní akci
properties	object		Slovník vlastností Vlastnosti lze přidat, ale ne odebrat nebo změnit.
provisioningState	DeploymentProvisioningState		Stav zřizování pro nasazení koncového bodu.
resources	DeploymentResourceConfiguration		Označuje konfiguraci výpočetních prostředků pro úlohu. Pokud není k dispozici, nastaví se výchozí hodnoty definované v ResourceConfiguration.
retrySettings	BatchRetrySettings		Zopakujte nastavení pro operaci odvozování dávky. Pokud není zadaný, použije se výchozí nastavení definované ve službě BatchRetrySettings.

BatchDeploymentTrackedResourceArmPaginatedResult

Objekt

Stránkovaný seznam entit BatchDeployment.

Name	Typ	Description
nextLink	string (uri)	Odkaz na další stránku položek
value	BatchDeployment[]	Položky BatchDeployment na této stránce

BatchLoggingLevel

Výčet

Protokolujte podrobnost pro dávkové odvozování. Zvyšuje se pořadí podrobností pro protokolování je: Varování, Informace a Ladění. Výchozí hodnota je Info.

Hodnota	Description
Info
Warning
Debug

BatchOutputAction

Výčet

Výčet k určení, jak bude dávkové odvozování zpracovávat výstup

Hodnota	Description
SummaryOnly
AppendRow

BatchPipelineComponentDeploymentConfiguration

Objekt

Vlastnosti pro nasazení komponenty kanálu Batch.

Name	Typ	Description
componentId	IdAssetReference	ID ARM komponenty, která se má spustit.
deploymentConfigurationType	string: PipelineComponent	[Povinné] Typ nasazení
description	string	Popis, který se použije pro úlohu.
settings	object	Nastavení doby běhu pro úlohu kanálu
tags	object	Značky, které se použijí pro úlohu.

BatchRetrySettings

Objekt

Opakujte nastavení pro operaci dávkového odvozování.

Name	Typ	Default value	Description
maxRetries	integer (int32)	3	Maximální počet opakování pro minidávku
timeout	string (duration)	PT30S	Časový limit vyvolání pro minidávku ve formátu ISO 8601.

CodeConfiguration

Objekt

Konfigurace pro prostředek bodovacího kódu.

Name	Typ	Description
codeId	string	ID prostředku ARM prostředku kódu
scoringScript	string minLength: 1 pattern: [a-zA-Z0-9_]	[Povinné] Skript, který se má spustit při spuštění. eg. "score.py"

createdByType

Výčet

Typ identity, která prostředek vytvořila.

Hodnota	Description
User
Application
ManagedIdentity
Key

DataPathAssetReference

Objekt

Odkazovat na datový zdroj prostřednictvím jeho cesty v datovém úložišti.

Name	Typ	Description
datastoreId	string	ID prostředku ARM úložiště dat, ve kterém se prostředek nachází.
path	string	Cesta k souboru nebo adresáři v úložišti dat.
referenceType	string: DataPath	[Povinné] Určuje typ odkazu na prostředek.

DeploymentProvisioningState

Výčet

Možné hodnoty pro DeploymentProvisioningState.

Hodnota	Description
Creating
Deleting
Scaling
Updating
Succeeded
Failed
Canceled

DeploymentResourceConfiguration

Objekt

Name	Typ	Default value	Description
instanceCount	integer (int32)	1	Volitelný počet instancí nebo uzlů používaných cílovým výpočetním objektem.
instanceType	string		Volitelný typ virtuálního počítače, který je podporovaný cílovým výpočetním objektem.
properties			Taška s dalšími vlastnostmi.

ErrorAdditionalInfo

Objekt

Chyba správy zdrojů další informace.

Name	Typ	Description
info	object	Další informace.
type	string	Typ doplňkových informací.

ErrorDetail

Objekt

Detail chyby.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Chyba další informace.
code	string	Kód chyby.
details	ErrorDetail[]	Podrobnosti o chybě.
message	string	Chybová zpráva.
target	string	Cíl chyby.

ErrorResponse

Objekt

Chybová odpověď

Name	Typ	Description
error	ErrorDetail	Objekt chyby.

IdAssetReference

Objekt

Odkaz na datový zdroj prostřednictvím ID prostředku ARM.

Name	Typ	Description
assetId	string minLength: 1 pattern: [a-zA-Z0-9_]	[Povinné] ID prostředku ARM prostředku
referenceType	string: Id	[Povinné] Určuje typ odkazu na prostředek.

ManagedServiceIdentity

Objekt

Identita spravované služby (identita přiřazená systémem nebo identita přiřazená uživatelem)

Name	Typ	Description
principalId	string (uuid)	ID instančního objektu identity přiřazené systémem. Tato vlastnost bude poskytována pouze pro identitu přiřazenou systémem.
tenantId	string (uuid)	ID tenanta přiřazené identity systému. Tato vlastnost bude poskytována pouze pro identitu přiřazenou systémem.
type	ManagedServiceIdentityType	Typ identity spravované služby (kde jsou povolené typy SystemAssigned i UserAssigned).
userAssignedIdentities	<string, UserAssignedIdentity>	identity User-Assigned Sada identit přiřazených uživatelem přidružená k prostředku. Klíče slovníku userAssignedIdentities budou ID prostředků ARM ve formuláři: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Hodnoty slovníku můžou být prázdné objekty ({}) v požadavcích.

ManagedServiceIdentityType

Výčet

Typ identity spravované služby (kde jsou povolené typy SystemAssigned i UserAssigned).

Hodnota	Description
None
SystemAssigned
UserAssigned
SystemAssigned,UserAssigned

OutputPathAssetReference

Objekt

Odkaz na datový zdroj prostřednictvím jeho cesty ve výstupu úlohy.

Name	Typ	Description
jobId	string	ID prostředku ARM úlohy
path	string	Cesta k souboru nebo adresáři ve výstupu úlohy.
referenceType	string: OutputPath	[Povinné] Určuje typ odkazu na prostředek.

ReferenceType

Výčet

Výčet k určení, která referenční metoda se má pro datový zdroj použít.

Hodnota	Description
Id
DataPath
OutputPath

Sku

Objekt

Definice modelu prostředků představující skladovou položku

Name	Typ	Description
capacity	integer (int32)	Pokud skladová položka podporuje horizontální navýšení/snížení kapacity, měla by být zahrnuta celá čísla kapacity. Pokud není pro prostředek možné horizontální navýšení kapacity nebo jeho snížení kapacity, může se tento parametr vynechat.
family	string	Pokud má služba různé generace hardwaru, pro stejnou skladovou položku, můžete ji zde zachytit.
name	string	Název skladové položky. Ex - P3. Obvykle se jedná o písmeno+číslo.
size	string	Velikost skladové položky. Pokud je pole název kombinací vrstvy a jiné hodnoty, jedná se o samostatný kód.
tier	SkuTier	Toto pole musí implementovat poskytovatel prostředků, pokud má služba více než jednu úroveň, ale nevyžaduje se u put.

SkuTier

Výčet

Toto pole musí implementovat poskytovatel prostředků, pokud má služba více než jednu úroveň, ale nevyžaduje se u put.

Hodnota	Description
Free
Basic
Standard
Premium

systemData

Objekt

Metadata týkající se vytvoření a poslední změny prostředku.

Name	Typ	Description
createdAt	string (date-time)	Časové razítko vytvoření prostředku (UTC).
createdBy	string	Identita, která prostředek vytvořila.
createdByType	createdByType	Typ identity, která prostředek vytvořila.
lastModifiedAt	string (date-time)	Časové razítko poslední změny zdroje (UTC)
lastModifiedBy	string	Identita, která naposledy změnila prostředek.
lastModifiedByType	createdByType	Typ identity, která naposledy změnila prostředek.

UserAssignedIdentity

Objekt

Vlastnosti identity přiřazené uživatelem

Name	Typ	Description
clientId	string (uuid)	ID klienta přiřazené identity.
principalId	string (uuid)	ID objektu zabezpečení přiřazené identity.

Sdílet prostřednictvím

Batch Deployments - List

Parametry identifikátoru URI

Odpovědi

Zabezpečení

azure_auth

Rozsahy

Příklady

List Workspace Batch Deployment.

Ukázkový požadavek

Ukázková odpověď

Definice

BatchDeployment

BatchDeploymentConfigurationType

BatchDeploymentProperties

BatchDeploymentTrackedResourceArmPaginatedResult

BatchLoggingLevel

BatchOutputAction

BatchPipelineComponentDeploymentConfiguration

BatchRetrySettings

CodeConfiguration

createdByType

DataPathAssetReference

DeploymentProvisioningState

DeploymentResourceConfiguration

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

IdAssetReference

ManagedServiceIdentity

ManagedServiceIdentityType

OutputPathAssetReference

ReferenceType

Sku

SkuTier

systemData

UserAssignedIdentity