Batch Deployments - List

Referentie

Service:: Machine Learning

API-versie:: 2024-10-01

Een lijst met Batch-deductie-implementaties in de werkruimte.

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

Met optionele parameters:

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

URI-parameters

Name	In	Vereist	Type	Description
endpointName	path	True	string	Eindpuntnaam
resourceGroupName	path	True	string minLength: 1 maxLength: 90	De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
subscriptionId	path	True	string minLength: 1	De id van het doelabonnement.
workspaceName	path	True	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$	Naam van Azure Machine Learning-werkruimte.
api-version	query	True	string minLength: 1	De API-versie die voor deze bewerking moet worden gebruikt.
$orderBy	query		string	Volgorde van lijst.
$skip	query		string	Vervolgtoken voor paginering.
$top	query		integer (int32)	Bovenaan de lijst.

Antwoorden

Name	Type	Description
200 OK	BatchDeploymentTrackedResourceArmPaginatedResult	Succes
Other Status Codes	ErrorResponse	Fout

Voorbeelden

List Workspace Batch Deployment.

Voorbeeldaanvraag

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

Voorbeeldrespons

Statuscode:: 200

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

Definities

Name	Description
BatchDeployment	Batchdeductie-instellingen per implementatie.
BatchDeploymentConfigurationType	De opgesomde eigenschapstypen voor batchimplementaties.
BatchDeploymentTrackedResource
BatchDeploymentTrackedResourceArmPaginatedResult	Een gepagineerde lijst met BatchDeployment-entiteiten.
BatchLoggingLevel	Uitgebreidheid van logboeken voor batchdeductie. Toenemende uitgebreidheidsvolgorde voor logboekregistratie is: waarschuwing, informatie en foutopsporing. De standaardwaarde is Info.
BatchOutputAction	Enum om te bepalen hoe batchdeductie uitvoer verwerkt
BatchPipelineComponentDeploymentConfiguration	Eigenschappen voor een batchpijplijnonderdeelimplementatie.
BatchRetrySettings	Instellingen voor een batchdeductiebewerking opnieuw proberen.
CodeConfiguration	Configuratie voor een scorecodeasset.
createdByType	Het type identiteit waarmee de resource is gemaakt.
DataPathAssetReference	Verwijzing naar een asset via het pad in een gegevensarchief.
DeploymentProvisioningState	Mogelijke waarden voor DeploymentProvisioningState.
DeploymentResourceConfiguration
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorDetail	De foutdetails.
ErrorResponse	Foutreactie
IdAssetReference	Verwijzing naar een asset via de ARM-resource-id.
ManagedServiceIdentity	Beheerde service-identiteit (door het systeem toegewezen en/of door de gebruiker toegewezen identiteiten)
ManagedServiceIdentityType	Type beheerde service-identiteit (waarbij zowel SystemAssigned- als UserAssigned-typen zijn toegestaan).
OutputPathAssetReference	Verwijzing naar een asset via het pad in een taakuitvoer.
ReferenceType	Enum om te bepalen welke referentiemethode moet worden gebruikt voor een asset.
Sku	De definitie van het resourcemodel die de SKU vertegenwoordigt
SkuTier	Dit veld moet worden geïmplementeerd door de resourceprovider als de service meer dan één laag heeft, maar niet vereist is voor een PUT.
systemData	Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.
UserAssignedIdentity	Door de gebruiker toegewezen identiteitseigenschappen

BatchDeployment

Object

Batchdeductie-instellingen per implementatie.

Name	Type	Default value	Description
codeConfiguration	CodeConfiguration		Codeconfiguratie voor de eindpuntimplementatie.
compute	string		Rekendoel voor batchdeductiebewerking.
deploymentConfiguration	BatchDeploymentConfiguration: BatchPipelineComponentDeploymentConfiguration		Eigenschappen die relevant zijn voor verschillende implementatietypen.
description	string		Beschrijving van de eindpuntimplementatie.
environmentId	string		ARM-resource-id of AssetId van de omgevingsspecificatie voor de eindpuntimplementatie.
environmentVariables	object		Configuratie van omgevingsvariabelen voor de implementatie.
errorThreshold	integer (int32)	-1	Foutdrempel, als het aantal fouten voor de volledige invoer boven deze waarde gaat, wordt de batchdeductie afgebroken. Bereik is [-1, int. MaxValue]. Voor FileDataset is deze waarde het aantal bestandsfouten. Voor TabularDataset is deze waarde het aantal recordfouten. Als deze optie is ingesteld op -1 (de ondergrens), worden alle fouten tijdens batchdeductie genegeerd.
loggingLevel	BatchLoggingLevel	Info	Logboekregistratieniveau voor batchdeductiebewerking.
maxConcurrencyPerInstance	integer (int32)	1	Geeft het maximum aantal parallelle uitvoeringen per exemplaar aan.
miniBatchSize	integer (int64)	10	Grootte van de minibatch die wordt doorgegeven aan elke batch-aanroep. Voor FileDataset is dit het aantal bestanden per minibatch. Voor TabularDataset is dit de grootte van de records in bytes, per minibatch.
model	AssetReferenceBase: DataPathAssetReference IdAssetReference OutputPathAssetReference		Verwijzing naar de modelasset voor de eindpuntimplementatie.
outputAction	BatchOutputAction	AppendRow	Geeft aan hoe de uitvoer wordt geordend.
outputFileName	string	predictions.csv	Aangepaste naam van uitvoerbestand voor append_row uitvoeractie.
properties	object		Eigenschappenwoordenlijst. Eigenschappen kunnen worden toegevoegd, maar niet worden verwijderd of gewijzigd.
provisioningState	DeploymentProvisioningState		Inrichtingsstatus voor de eindpuntimplementatie.
resources	DeploymentResourceConfiguration		Geeft de rekenconfiguratie voor de taak aan. Als dit niet is opgegeven, wordt standaard de standaardinstellingen gebruikt die zijn gedefinieerd in ResourceConfiguration.
retrySettings	BatchRetrySettings		Instellingen voor opnieuw proberen voor de batchdeductiebewerking. Als dit niet is opgegeven, wordt standaard de standaardwaarden gedefinieerd in BatchRetrySettings.

BatchDeploymentConfigurationType

Inventarisatie

De opgesomde eigenschapstypen voor batchimplementaties.

Waarde	Description
Model
PipelineComponent

BatchDeploymentTrackedResource

Object

Name	Type	Description
id	string	Volledig gekwalificeerde resource-id voor de resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	ManagedServiceIdentity	Beheerde service-identiteit (door het systeem toegewezen en/of door de gebruiker toegewezen identiteiten)
kind	string	Metagegevens die worden gebruikt door portal/tooling/etc om verschillende UX-ervaringen weer te geven voor resources van hetzelfde type.
location	string	De geografische locatie waar de resource zich bevindt
name	string	De naam van de resource
properties	BatchDeployment	[Vereist] Aanvullende kenmerken van de entiteit.
sku	Sku	SKU-gegevens die vereist zijn voor een ARM-contract voor automatisch schalen.
systemData	systemData	Azure Resource Manager-metagegevens met createdBy- en modifiedBy-gegevens.
tags	object	Resourcetags.
type	string	Het type resource. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts'

BatchDeploymentTrackedResourceArmPaginatedResult

Object

Een gepagineerde lijst met BatchDeployment-entiteiten.

Name	Type	Description
nextLink	string	De koppeling naar de volgende pagina van BatchDeployment-objecten. Als null is, zijn er geen extra pagina's.
value	BatchDeploymentTrackedResource[]	Een matrix van objecten van het type BatchDeployment.

BatchLoggingLevel

Inventarisatie

Uitgebreidheid van logboeken voor batchdeductie. Toenemende uitgebreidheidsvolgorde voor logboekregistratie is: waarschuwing, informatie en foutopsporing. De standaardwaarde is Info.

Waarde	Description
Debug
Info
Warning

BatchOutputAction

Inventarisatie

Enum om te bepalen hoe batchdeductie uitvoer verwerkt

Waarde	Description
AppendRow
SummaryOnly

BatchPipelineComponentDeploymentConfiguration

Object

Eigenschappen voor een batchpijplijnonderdeelimplementatie.

Name	Type	Description
componentId	IdAssetReference	De ARM-id van het onderdeel dat moet worden uitgevoerd.
deploymentConfigurationType	string: PipelineComponent	[Vereist] Het type implementatie
description	string	De beschrijving die wordt toegepast op de taak.
settings	object	Runtime-instellingen voor de pijplijntaak.
tags	object	De tags die worden toegepast op de taak.

BatchRetrySettings

Object

Instellingen voor een batchdeductiebewerking opnieuw proberen.

Name	Type	Default value	Description
maxRetries	integer (int32)	3	Maximumaantal nieuwe pogingen voor een minibatch
timeout	string (duration)	PT30S	Time-out voor aanroepen voor een minibatch, in ISO 8601-indeling.

CodeConfiguration

Object

Configuratie voor een scorecodeasset.

Name	Type	Description
codeId	string	ARM-resource-id van de codeasset.
scoringScript	string minLength: 1 pattern: [a-zA-Z0-9_]	[Vereist] Het script dat moet worden uitgevoerd bij het opstarten. bijvoorbeeld "score.py"

createdByType

Inventarisatie

Het type identiteit waarmee de resource is gemaakt.

Waarde	Description
Application
Key
ManagedIdentity
User

DataPathAssetReference

Object

Verwijzing naar een asset via het pad in een gegevensarchief.

Name	Type	Description
datastoreId	string	ARM-resource-id van het gegevensarchief waar de asset zich bevindt.
path	string	Het pad van het bestand/de map in het gegevensarchief.
referenceType	string: DataPath	[Vereist] Hiermee geeft u het type assetreferentie op.

DeploymentProvisioningState

Inventarisatie

Mogelijke waarden voor DeploymentProvisioningState.

Waarde	Description
Canceled
Creating
Deleting
Failed
Scaling
Succeeded
Updating

DeploymentResourceConfiguration

Object

Name	Type	Default value	Description
instanceCount	integer (int32)	1	Optioneel aantal exemplaren of knooppunten dat door het rekendoel wordt gebruikt.
instanceType	string		Optioneel type VM dat wordt gebruikt als ondersteund door het rekendoel.
properties	object		Extra eigenschappen zak.

ErrorAdditionalInfo

Object

Aanvullende informatie over de resourcebeheerfout.

Name	Type	Description
info	object	De aanvullende informatie.
type	string	Het extra informatietype.

ErrorDetail

Object

De foutdetails.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	De fout bevat aanvullende informatie.
code	string	De foutcode.
details	ErrorDetail[]	De foutdetails.
message	string	Het foutbericht.
target	string	Het foutdoel.

ErrorResponse

Object

Foutreactie

Name	Type	Description
error	ErrorDetail	Het foutobject.

IdAssetReference

Object

Verwijzing naar een asset via de ARM-resource-id.

Name	Type	Description
assetId	string minLength: 1 pattern: [a-zA-Z0-9_]	[Vereist] ARM-resource-id van de asset.
referenceType	string: Id	[Vereist] Hiermee geeft u het type assetreferentie op.

ManagedServiceIdentity

Object

Beheerde service-identiteit (door het systeem toegewezen en/of door de gebruiker toegewezen identiteiten)

Name	Type	Description
principalId	string (uuid)	De service-principal-id van de door het systeem toegewezen identiteit. Deze eigenschap wordt alleen verstrekt voor een door het systeem toegewezen identiteit.
tenantId	string (uuid)	De tenant-id van de door het systeem toegewezen identiteit. Deze eigenschap wordt alleen verstrekt voor een door het systeem toegewezen identiteit.
type	ManagedServiceIdentityType	Type beheerde service-identiteit (waarbij zowel SystemAssigned- als UserAssigned-typen zijn toegestaan).
userAssignedIdentities	<string, UserAssignedIdentity>	User-Assigned identiteiten De set door de gebruiker toegewezen identiteiten die aan de resource zijn gekoppeld. De woordenlijstsleutels userAssignedIdentities zijn ARM-resource-id's in de vorm: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. De waarden van de woordenlijst kunnen lege objecten ({}) zijn in aanvragen.

ManagedServiceIdentityType

Inventarisatie

Type beheerde service-identiteit (waarbij zowel SystemAssigned- als UserAssigned-typen zijn toegestaan).

Waarde	Description
None
SystemAssigned
SystemAssigned,UserAssigned
UserAssigned

OutputPathAssetReference

Object

Verwijzing naar een asset via het pad in een taakuitvoer.

Name	Type	Description
jobId	string	ARM-resource-id van de taak.
path	string	Het pad van het bestand/de map in de taakuitvoer.
referenceType	string: OutputPath	[Vereist] Hiermee geeft u het type assetreferentie op.

ReferenceType

Inventarisatie

Enum om te bepalen welke referentiemethode moet worden gebruikt voor een asset.

Waarde	Description
DataPath
Id
OutputPath

Sku

Object

De definitie van het resourcemodel die de SKU vertegenwoordigt

Name	Type	Description
capacity	integer (int32)	Als de SKU uitschalen/inschalen ondersteunt, moet het gehele getal van de capaciteit worden opgenomen. Als uitschalen/inschalen niet mogelijk is voor de resource, kan dit worden weggelaten.
family	string	Als de service verschillende generaties hardware heeft, voor dezelfde SKU, kan die hier worden vastgelegd.
name	string	De naam van de SKU. Ex - P3. Dit is meestal een letter+cijfercode
size	string	De SKU-grootte. Wanneer het naamveld de combinatie van de laag en een andere waarde is, is dit de zelfstandige code.
tier	SkuTier	Dit veld moet worden geïmplementeerd door de resourceprovider als de service meer dan één laag heeft, maar niet vereist is voor een PUT.

SkuTier

Inventarisatie

Dit veld moet worden geïmplementeerd door de resourceprovider als de service meer dan één laag heeft, maar niet vereist is voor een PUT.

Waarde	Description
Basic
Free
Premium
Standard

systemData

Object

Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.

Name	Type	Description
createdAt	string (date-time)	De tijdstempel van het maken van resources (UTC).
createdBy	string	De identiteit waarmee de resource is gemaakt.
createdByType	createdByType	Het type identiteit waarmee de resource is gemaakt.
lastModifiedAt	string (date-time)	De tijdstempel van de laatste wijziging van de resource (UTC)
lastModifiedBy	string	De identiteit die de resource voor het laatst heeft gewijzigd.
lastModifiedByType	createdByType	Het type identiteit dat de resource voor het laatst heeft gewijzigd.

UserAssignedIdentity

Object

Door de gebruiker toegewezen identiteitseigenschappen

Name	Type	Description
clientId	string (uuid)	De client-id van de toegewezen identiteit.
principalId	string (uuid)	De principal-id van de toegewezen identiteit.

Delen via

Batch Deployments - List

URI-parameters

Antwoorden

Voorbeelden

List Workspace Batch Deployment.

Voorbeeldaanvraag

Voorbeeldrespons

Definities

BatchDeployment

BatchDeploymentConfigurationType

BatchDeploymentTrackedResource

BatchDeploymentTrackedResourceArmPaginatedResult

BatchLoggingLevel

BatchOutputAction

BatchPipelineComponentDeploymentConfiguration

BatchRetrySettings

CodeConfiguration

createdByType

DataPathAssetReference

DeploymentProvisioningState

DeploymentResourceConfiguration

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

IdAssetReference

ManagedServiceIdentity

ManagedServiceIdentityType

OutputPathAssetReference

ReferenceType

Sku

SkuTier

systemData

UserAssignedIdentity

Aanvullende resources