Batch Deployments - List

Tjänst:: Machine Learning

API-versionen:: 2025-12-01

Visar en lista över batch-inferensdistributioner på arbetsytan.

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

Med valfria parametrar:

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}

URI-parametrar

Namn	I	Krävs	Typ	Beskrivning
endpointName	path	True	string	Namn på Batch-slutpunkten.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
subscriptionId	path	True	string minLength: 1	ID för målprenumerationen.
workspaceName	path	True	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$	Namn på Azure Machine Learning-arbetsyta
api-version	query	True	string minLength: 1	Den API-version som ska användas för den här åtgärden.
$orderBy	query		string	Ordningen på listan.
$skip	query		string	Fortsättningstoken för sidnumrering.
$top	query		integer (int32)	Överst i listan.

Svaren

Namn	Typ	Beskrivning
200 OK	BatchDeploymentTrackedResourceArmPaginatedResult	Azure-åtgärden har slutförts.
Other Status Codes	ErrorResponse	Ett oväntat felsvar.

Säkerhet

azure_auth

Azure Active Directory OAuth2-flöde.

Typ: oauth2
Rinna: implicit
Auktorisations-URL: https://login.microsoftonline.com/common/oauth2/authorize

Scope

Namn	Beskrivning
user_impersonation	personifiera ditt användarkonto

Exempel

List Workspace Batch Deployment.

Exempelförfrågan

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

Exempelsvar

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

Definitioner

Namn	Beskrivning
BatchDeployment	Konkreta spårade resurstyper kan skapas genom att aliasisera den här typen med hjälp av en specifik egenskapstyp.
BatchDeploymentConfigurationType	De uppräknade egenskapstyperna för batchdistributioner.
BatchDeploymentProperties	Inställningar för batchinferens per distribution.
BatchDeploymentTrackedResourceArmPaginatedResult	En sidnumrerad lista över BatchDeployment-entiteter.
BatchLoggingLevel	Loggens utförlighet för batchinferens. Ökande utförlighetsordning för loggning är: Varning, Info och Felsök. Standardprefixet är "Info".
BatchOutputAction	Uppräkning för att avgöra hur batchinferens ska hantera utdata
BatchPipelineComponentDeploymentConfiguration	Egenskaper för en distribution av en batchpipelinekomponent.
BatchRetrySettings	Försök igen Inställningar för en batchinferensåtgärd.
CodeConfiguration	Konfiguration för en bedömningskodtillgång.
createdByType	Den typ av identitet som skapade resursen.
DataPathAssetReference	Referens till en tillgång via dess sökväg i ett datalager.
DeploymentProvisioningState	Möjliga värden för DeploymentProvisioningState.
DeploymentResourceConfiguration
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
ErrorDetail	Felinformationen.
ErrorResponse	Felsvar
IdAssetReference	Referens till en tillgång via dess ARM-resurs-ID.
ManagedServiceIdentity	Hanterad tjänstidentitet (systemtilldelade och/eller användartilldelade identiteter)
ManagedServiceIdentityType	Typ av hanterad tjänstidentitet (där både SystemAssigned- och UserAssigned-typer tillåts).
OutputPathAssetReference	Referens till en tillgång via dess sökväg i ett jobbutdata.
ReferenceType	Enum för att avgöra vilken referensmetod som ska användas för en tillgång.
Sku	Resursmodelldefinitionen som representerar SKU
SkuTier	Det här fältet måste implementeras av resursprovidern om tjänsten har mer än en nivå, men inte krävs på en PUT.
systemData	Metadata som rör skapande och senaste ändring av resursen.
UserAssignedIdentity	Användartilldelade identitetsegenskaper

BatchDeployment

Objekt

Konkreta spårade resurstyper kan skapas genom att aliasisera den här typen med hjälp av en specifik egenskapstyp.

Namn	Typ	Beskrivning
id	string	Fullständigt kvalificerat resurs-ID för resursen. Ex – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	ManagedServiceIdentity	Hanterad tjänstidentitet (systemtilldelade och/eller användartilldelade identiteter)
kind	string	Metadata som används av portal/verktyg/etc för att återge olika UX-funktioner för resurser av samma typ.
location	string	Den geo-plats där resursen finns
name	string	Namnet på resursen
properties	BatchDeploymentProperties	[Krävs] Ytterligare attribut för entiteten.
sku	Sku	Sku-information som krävs för ARM-kontrakt för automatisk skalning.
systemData	systemData	Azure Resource Manager-metadata som innehåller createdBy och modifiedBy information.
tags	object	Resursetiketter.
type	string	Resurstypen. T.ex. "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts"

BatchDeploymentConfigurationType

Uppräkning

De uppräknade egenskapstyperna för batchdistributioner.

Värde	Beskrivning
Model
PipelineComponent

BatchDeploymentProperties

Objekt

Inställningar för batchinferens per distribution.

Namn	Typ	Standardvärde	Beskrivning
codeConfiguration	CodeConfiguration		Kodkonfiguration för slutpunktsdistributionen.
compute	string		Beräkningsmål för batchinferensåtgärd.
deploymentConfiguration	BatchDeploymentConfiguration: BatchPipelineComponentDeploymentConfiguration		Egenskaper som är relevanta för olika distributionstyper.
description	string		Beskrivning av slutpunktsdistributionen.
environmentId	string		ARM-resurs-ID eller AssetId för miljöspecifikationen för slutpunktsdistributionen.
environmentVariables	object		Konfiguration av miljövariabler för distributionen.
errorThreshold	integer (int32)	-1	Feltröskel, om antalet fel för hela indata överstiger det här värdet avbryts batchinferensen. Intervallet är [-1, int. MaxValue]. För FileDataset är det här värdet antalet filfel. För TabularDataset är det här värdet antalet postfel. Om värdet är inställt på -1 (den nedre gränsen) ignoreras alla fel under batchinferensen.
loggingLevel	BatchLoggingLevel	Info	Loggens utförlighet för batchinferens. Ökande utförlighetsordning för loggning är: Varning, Info och Felsök. Standardprefixet är "Info".
maxConcurrencyPerInstance	integer (int32)	1	Anger maximalt antal parallelliteter per instans.
miniBatchSize	integer (int64)	10	Storleken på mini-batchen som skickas till varje batchanrop. För FileDataset är det här antalet filer per mini-batch. För TabularDataset är det här storleken på posterna i byte per mini-batch.
model	AssetReferenceBase: DataPathAssetReference IdAssetReference OutputPathAssetReference		Referens till modelltillgången för slutpunktsdistributionen.
outputAction	BatchOutputAction	AppendRow	Uppräkning för att avgöra hur batchinferens ska hantera utdata
outputFileName	string	predictions.csv	Anpassat filnamn för utdata för append_row utdataåtgärd.
properties	object		Egenskapsordlista. Egenskaper kan läggas till, men inte tas bort eller ändras.
provisioningState	DeploymentProvisioningState		Etableringstillstånd för slutpunktsdistributionen.
resources	DeploymentResourceConfiguration		Anger beräkningskonfiguration för jobbet. Om det inte anges kommer standardvärdena som definierats i ResourceConfiguration att vara standard.
retrySettings	BatchRetrySettings		Försök igen Inställningar för batchinferensåtgärden. Om det inte anges kommer standardvärdena som definierats i BatchRetrySettings att vara standard.

BatchDeploymentTrackedResourceArmPaginatedResult

Objekt

En sidnumrerad lista över BatchDeployment-entiteter.

Namn	Typ	Beskrivning
nextLink	string (uri)	Länken till nästa sida med objekt
value	BatchDeployment[]	BatchDeployment-objekten på denna sida

BatchLoggingLevel

Uppräkning

Loggens utförlighet för batchinferens. Ökande utförlighetsordning för loggning är: Varning, Info och Felsök. Standardprefixet är "Info".

Värde	Beskrivning
Info
Warning
Debug

BatchOutputAction

Uppräkning

Uppräkning för att avgöra hur batchinferens ska hantera utdata

Värde	Beskrivning
SummaryOnly
AppendRow

BatchPipelineComponentDeploymentConfiguration

Objekt

Egenskaper för en distribution av en batchpipelinekomponent.

Namn	Typ	Beskrivning
componentId	IdAssetReference	ARM-ID:t för komponenten som ska köras.
deploymentConfigurationType	string: PipelineComponent	[Krävs] Typ av distribution
description	string	Beskrivningen som ska tillämpas på jobbet.
settings	object	Körningsinställningar för pipelinejobbet.
tags	object	Taggarna som ska tillämpas på jobbet.

BatchRetrySettings

Objekt

Försök igen Inställningar för en batchinferensåtgärd.

Namn	Typ	Standardvärde	Beskrivning
maxRetries	integer (int32)	3	Maximalt antal återförsök för en mini-batch
timeout	string (duration)	PT30S	Tidsgräns för anrop för en mini-batch i ISO 8601-format.

CodeConfiguration

Objekt

Konfiguration för en bedömningskodtillgång.

Namn	Typ	Beskrivning
codeId	string	ARM-resurs-ID för kodtillgången.
scoringScript	string minLength: 1 pattern: [a-zA-Z0-9_]	[Krävs] Skriptet som ska köras vid start. eg. "score.py"

createdByType

Uppräkning

Den typ av identitet som skapade resursen.

Värde	Beskrivning
User
Application
ManagedIdentity
Key

DataPathAssetReference

Objekt

Referens till en tillgång via dess sökväg i ett datalager.

Namn	Typ	Beskrivning
datastoreId	string	ARM-resurs-ID för det datalager där tillgången finns.
path	string	Sökvägen till filen/katalogen i dataarkivet.
referenceType	string: DataPath	[Krävs] Anger typ av tillgångsreferens.

DeploymentProvisioningState

Uppräkning

Möjliga värden för DeploymentProvisioningState.

Värde	Beskrivning
Creating
Deleting
Scaling
Updating
Succeeded
Failed
Canceled

DeploymentResourceConfiguration

Objekt

Namn	Typ	Standardvärde	Beskrivning
instanceCount	integer (int32)	1	Valfritt antal instanser eller noder som används av beräkningsmålet.
instanceType	string		Valfri typ av virtuell dator som stöds av beräkningsmålet.
properties			Ytterligare egenskapsväska.

ErrorAdditionalInfo

Objekt

Ytterligare information om resurshanteringsfelet.

Namn	Typ	Beskrivning
info	object	Ytterligare information.
type	string	Ytterligare informationstyp.

ErrorDetail

Objekt

Felinformationen.

Namn	Typ	Beskrivning
additionalInfo	ErrorAdditionalInfo[]	Ytterligare information om felet.
code	string	Felkoden.
details	ErrorDetail[]	Felinformationen.
message	string	Felmeddelandet.
target	string	Felmålet.

ErrorResponse

Objekt

Felsvar

Namn	Typ	Beskrivning
error	ErrorDetail	Felobjektet.

IdAssetReference

Objekt

Referens till en tillgång via dess ARM-resurs-ID.

Namn	Typ	Beskrivning
assetId	string minLength: 1 pattern: [a-zA-Z0-9_]	[Krävs] ARM-resurs-ID för tillgången.
referenceType	string: Id	[Krävs] Anger typ av tillgångsreferens.

ManagedServiceIdentity

Objekt

Hanterad tjänstidentitet (systemtilldelade och/eller användartilldelade identiteter)

Namn	Typ	Beskrivning
principalId	string (uuid)	Tjänstens huvudnamns-ID för den systemtilldelade identiteten. Den här egenskapen tillhandahålls endast för en systemtilldelad identitet.
tenantId	string (uuid)	Klientorganisations-ID för den systemtilldelade identiteten. Den här egenskapen tillhandahålls endast för en systemtilldelad identitet.
type	ManagedServiceIdentityType	Typ av hanterad tjänstidentitet (där både SystemAssigned- och UserAssigned-typer tillåts).
userAssignedIdentities	<string, UserAssignedIdentity>	User-Assigned identiteter Uppsättningen användartilldelade identiteter som är associerade med resursen. Ordlistenycklarna userAssignedIdentities är ARM-resurs-ID:er i formuläret: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Ordlistevärdena kan vara tomma objekt ({}) i begäranden.

ManagedServiceIdentityType

Uppräkning

Typ av hanterad tjänstidentitet (där både SystemAssigned- och UserAssigned-typer tillåts).

Värde	Beskrivning
None
SystemAssigned
UserAssigned
SystemAssigned,UserAssigned

OutputPathAssetReference

Objekt

Referens till en tillgång via dess sökväg i ett jobbutdata.

Namn	Typ	Beskrivning
jobId	string	ARM-resurs-ID för jobbet.
path	string	Sökvägen till filen/katalogen i jobbutdata.
referenceType	string: OutputPath	[Krävs] Anger typ av tillgångsreferens.

ReferenceType

Uppräkning

Enum för att avgöra vilken referensmetod som ska användas för en tillgång.

Värde	Beskrivning
Id
DataPath
OutputPath

Sku

Objekt

Resursmodelldefinitionen som representerar SKU

Namn	Typ	Beskrivning
capacity	integer (int32)	Om SKU:n stöder utskalning/in bör kapacitets heltal inkluderas. Om det inte går att skala ut/in för resursen kan detta utelämnas.
family	string	Om tjänsten har olika generationer av maskinvara, för samma SKU, kan den samlas in här.
name	string	Namnet på SKU:n. Ex - P3. Det är vanligtvis en bokstav+nummerkod
size	string	SKU-storleken. När namnfältet är kombinationen av nivå och något annat värde är detta den fristående koden.
tier	SkuTier	Det här fältet måste implementeras av resursprovidern om tjänsten har mer än en nivå, men inte krävs på en PUT.

SkuTier

Uppräkning

Det här fältet måste implementeras av resursprovidern om tjänsten har mer än en nivå, men inte krävs på en PUT.

Värde	Beskrivning
Free
Basic
Standard
Premium

systemData

Objekt

Metadata som rör skapande och senaste ändring av resursen.

Namn	Typ	Beskrivning
createdAt	string (date-time)	Tidsstämpeln för resursskapande (UTC).
createdBy	string	Identiteten som skapade resursen.
createdByType	createdByType	Den typ av identitet som skapade resursen.
lastModifiedAt	string (date-time)	Tidsstämpeln för senaste ändring av resurs (UTC)
lastModifiedBy	string	Identiteten som senast ändrade resursen.
lastModifiedByType	createdByType	Den typ av identitet som senast ändrade resursen.

UserAssignedIdentity

Objekt

Användartilldelade identitetsegenskaper

Namn	Typ	Beskrivning
clientId	string (uuid)	Klient-ID för den tilldelade identiteten.
principalId	string (uuid)	Huvud-ID för den tilldelade identiteten.

Dela via

Batch Deployments - List

URI-parametrar

Svaren

Säkerhet

azure_auth

Scope

Exempel

List Workspace Batch Deployment.

Exempelförfrågan

Exempelsvar

Definitioner

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