Partager via


Batch Deployments - List

Répertorie les déploiements d’inférence Batch dans l’espace de travail.

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}

Paramètres URI

Nom Dans Obligatoire Type Description
endpointName
path True

string

Nom du point de terminaison

resourceGroupName
path True

string

Nom du groupe de ressources. Le nom ne respecte pas la casse.

subscriptionId
path True

string

ID de l’abonnement cible.

workspaceName
path True

string

Nom de l’espace de travail Azure Machine Learning.

Modèle d’expression régulière: ^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$

api-version
query True

string

Version de l’API à utiliser pour cette opération.

$orderBy
query

string

Classement de la liste.

$skip
query

string

Jeton de continuation pour la pagination.

$top
query

integer

int32

En haut de la liste.

Réponses

Nom Type Description
200 OK

BatchDeploymentTrackedResourceArmPaginatedResult

Succès

Other Status Codes

ErrorResponse

Erreur

Exemples

List Workspace Batch Deployment.

Exemple de requête

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

Exemple de réponse

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

Définitions

Nom Description
BatchDeployment

Paramètres d’inférence par lot par déploiement.

BatchDeploymentConfigurationType

Types de propriétés énumérés pour les déploiements par lots.

BatchDeploymentTrackedResource
BatchDeploymentTrackedResourceArmPaginatedResult

Liste paginé des entités BatchDeployment.

BatchLoggingLevel

Log verbosity for batch inferencing. L’ordre de détail croissant pour la journalisation est : Avertissement, Informations et Débogage. La valeur par défaut est Info.

BatchOutputAction

Énumération pour déterminer comment l’inférence par lots gère la sortie

BatchPipelineComponentDeploymentConfiguration

Propriétés d’un déploiement de composant de pipeline Batch.

BatchRetrySettings

Réessayez les paramètres d’une opération d’inférence par lots.

CodeConfiguration

Configuration d’une ressource de code de scoring.

createdByType

Type d’identité qui a créé la ressource.

DataPathAssetReference

Référence à une ressource via son chemin d’accès dans un magasin de données.

DeploymentProvisioningState

Valeurs possibles pour DeploymentProvisioningState.

DeploymentResourceConfiguration
ErrorAdditionalInfo

Informations supplémentaires sur l’erreur de gestion des ressources.

ErrorDetail

Détail de l’erreur.

ErrorResponse

Réponse d’erreur

IdAssetReference

Référence à une ressource via son ID de ressource ARM.

ManagedServiceIdentity

Identité de service managée (identités affectées par le système et/ou identités affectées par l’utilisateur)

ManagedServiceIdentityType

Type d’identité de service managé (où les types SystemAssigned et UserAssigned sont autorisés).

OutputPathAssetReference

Référence à une ressource via son chemin d’accès dans une sortie de travail.

ReferenceType

Énumération pour déterminer la méthode de référence à utiliser pour une ressource.

Sku

Définition du modèle de ressource représentant la référence SKU

SkuTier

Ce champ doit être implémenté par le fournisseur de ressources si le service a plusieurs niveaux, mais n’est pas obligatoire sur un PUT.

systemData

Métadonnées relatives à la création et à la dernière modification de la ressource.

UserAssignedIdentity

Propriétés d’identité attribuées par l’utilisateur

BatchDeployment

Paramètres d’inférence par lot par déploiement.

Nom Type Valeur par défaut Description
codeConfiguration

CodeConfiguration

Configuration du code pour le déploiement du point de terminaison.

compute

string

Cible de calcul pour l’opération d’inférence par lots.

deploymentConfiguration BatchDeploymentConfiguration:

BatchPipelineComponentDeploymentConfiguration

Propriétés pertinentes pour différents types de déploiement.

description

string

Description du déploiement du point de terminaison.

environmentId

string

ID de ressource ARM ou AssetId de la spécification d’environnement pour le déploiement du point de terminaison.

environmentVariables

object

Configuration des variables d’environnement pour le déploiement.

errorThreshold

integer

-1

Seuil d’erreur, si le nombre d’erreurs pour l’entrée entière dépasse cette valeur, l’inférence par lot est abandonnée. La plage est [-1, int. MaxValue]. Pour FileDataset, cette valeur correspond au nombre d’échecs de fichiers. Pour TabularDataset, cette valeur correspond au nombre d’échecs d’enregistrement. Si la valeur est -1 (la limite inférieure), toutes les défaillances pendant l’inférence par lots sont ignorées.

loggingLevel

BatchLoggingLevel

Info

Niveau de journalisation pour l’opération d’inférence par lots.

maxConcurrencyPerInstance

integer

1

Indique le nombre maximal de parallélisme par instance.

miniBatchSize

integer

10

Taille du mini-lot passé à chaque appel de lot. Pour FileDataset, il s’agit du nombre de fichiers par mini-lot. Pour TabularDataset, il s’agit de la taille des enregistrements en octets, par mini-lot.

model AssetReferenceBase:

Référence à la ressource de modèle pour le déploiement du point de terminaison.

outputAction

BatchOutputAction

AppendRow

Indique comment la sortie sera organisée.

outputFileName

string

predictions.csv

Nom de fichier de sortie personnalisé pour append_row action de sortie.

properties

object

Dictionnaire de propriétés. Les propriétés peuvent être ajoutées, mais pas supprimées ou modifiées.

provisioningState

DeploymentProvisioningState

État d’approvisionnement pour le déploiement du point de terminaison.

resources

DeploymentResourceConfiguration

Indique la configuration de calcul du travail. S’il n’est pas fourni, la valeur par défaut est définie par défaut dans ResourceConfiguration.

retrySettings

BatchRetrySettings

Réessayez les paramètres de l’opération d’inférence par lots. S’il n’est pas fourni, la valeur par défaut est définie par défaut dans BatchRetrySettings.

BatchDeploymentConfigurationType

Types de propriétés énumérés pour les déploiements par lots.

Nom Type Description
Model

string

PipelineComponent

string

BatchDeploymentTrackedResource

Nom Type Description
id

string

ID de ressource complet pour la ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

identity

ManagedServiceIdentity

Identité de service managée (identités affectées par le système et/ou identités affectées par l’utilisateur)

kind

string

Métadonnées utilisées par le portail/l’outil/etc pour afficher différentes expériences d’expérience utilisateur pour les ressources du même type.

location

string

Emplacement géographique où réside la ressource

name

string

Nom de la ressource

properties

BatchDeployment

[Obligatoire] Attributs supplémentaires de l’entité.

sku

Sku

Détails de la référence SKU requis pour le contrat ARM pour la mise à l’échelle automatique.

systemData

systemData

Métadonnées Azure Resource Manager contenant les informations createdBy et modifiedBy.

tags

object

Balises de ressource.

type

string

Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

BatchDeploymentTrackedResourceArmPaginatedResult

Liste paginé des entités BatchDeployment.

Nom Type Description
nextLink

string

Lien vers la page suivante des objets BatchDeployment. Si la valeur est null, il n’existe aucune page supplémentaire.

value

BatchDeploymentTrackedResource[]

Tableau d’objets de type BatchDeployment.

BatchLoggingLevel

Log verbosity for batch inferencing. L’ordre de détail croissant pour la journalisation est : Avertissement, Informations et Débogage. La valeur par défaut est Info.

Nom Type Description
Debug

string

Info

string

Warning

string

BatchOutputAction

Énumération pour déterminer comment l’inférence par lots gère la sortie

Nom Type Description
AppendRow

string

SummaryOnly

string

BatchPipelineComponentDeploymentConfiguration

Propriétés d’un déploiement de composant de pipeline Batch.

Nom Type Description
componentId

IdAssetReference

ID ARM du composant à exécuter.

deploymentConfigurationType string:

PipelineComponent

[Obligatoire] Type du déploiement

description

string

Description qui sera appliquée au travail.

settings

object

Paramètres d’exécution du travail de pipeline.

tags

object

Balises qui seront appliquées au travail.

BatchRetrySettings

Réessayez les paramètres d’une opération d’inférence par lots.

Nom Type Valeur par défaut Description
maxRetries

integer

3

Nombre maximal de nouvelles tentatives pour un mini-lot

timeout

string

PT30S

Délai d’appel pour un mini-lot, au format ISO 8601.

CodeConfiguration

Configuration d’une ressource de code de scoring.

Nom Type Description
codeId

string

ID de ressource ARM de la ressource de code.

scoringScript

string

[Obligatoire] Script à exécuter au démarrage. Eg. « score.py »

createdByType

Type d’identité qui a créé la ressource.

Nom Type Description
Application

string

Key

string

ManagedIdentity

string

User

string

DataPathAssetReference

Référence à une ressource via son chemin d’accès dans un magasin de données.

Nom Type Description
datastoreId

string

ID de ressource ARM du magasin de données où se trouve la ressource.

path

string

Chemin d’accès du fichier/répertoire dans le magasin de données.

referenceType string:

DataPath

[Obligatoire] Spécifie le type de référence de ressource.

DeploymentProvisioningState

Valeurs possibles pour DeploymentProvisioningState.

Nom Type Description
Canceled

string

Creating

string

Deleting

string

Failed

string

Scaling

string

Succeeded

string

Updating

string

DeploymentResourceConfiguration

Nom Type Valeur par défaut Description
instanceCount

integer

1

Nombre facultatif d’instances ou de nœuds utilisés par la cible de calcul.

instanceType

string

Type facultatif de machine virtuelle utilisée comme prise en charge par la cible de calcul.

properties

object

Conteneur de propriétés supplémentaires.

ErrorAdditionalInfo

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom Type Description
info

object

Informations supplémentaires.

type

string

Type d’informations supplémentaire.

ErrorDetail

Détail de l’erreur.

Nom Type Description
additionalInfo

ErrorAdditionalInfo[]

Informations supplémentaires sur l’erreur.

code

string

Code d’erreur.

details

ErrorDetail[]

Détails de l’erreur.

message

string

Message d’erreur.

target

string

Cible d’erreur.

ErrorResponse

Réponse d’erreur

Nom Type Description
error

ErrorDetail

Objet d’erreur.

IdAssetReference

Référence à une ressource via son ID de ressource ARM.

Nom Type Description
assetId

string

[Obligatoire] ID de ressource ARM de la ressource.

referenceType string:

Id

[Obligatoire] Spécifie le type de référence de ressource.

ManagedServiceIdentity

Identité de service managée (identités affectées par le système et/ou identités affectées par l’utilisateur)

Nom Type Description
principalId

string

ID du principal de service de l’identité affectée par le système. Cette propriété est fournie uniquement pour une identité affectée par le système.

tenantId

string

ID de locataire de l’identité affectée par le système. Cette propriété est fournie uniquement pour une identité affectée par le système.

type

ManagedServiceIdentityType

Type d’identité de service managé (où les types SystemAssigned et UserAssigned sont autorisés).

userAssignedIdentities

<string,  UserAssignedIdentity>

identités User-Assigned
Ensemble d’identités affectées par l’utilisateur associées à la ressource. Les clés de dictionnaire userAssignedIdentities seront des ID de ressource ARM sous la forme : « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Les valeurs de dictionnaire peuvent être des objets vides ({}) dans les requêtes.

ManagedServiceIdentityType

Type d’identité de service managé (où les types SystemAssigned et UserAssigned sont autorisés).

Nom Type Description
None

string

SystemAssigned

string

SystemAssigned,UserAssigned

string

UserAssigned

string

OutputPathAssetReference

Référence à une ressource via son chemin d’accès dans une sortie de travail.

Nom Type Description
jobId

string

ID de ressource ARM du travail.

path

string

Chemin d’accès du fichier/répertoire dans la sortie du travail.

referenceType string:

OutputPath

[Obligatoire] Spécifie le type de référence de ressource.

ReferenceType

Énumération pour déterminer la méthode de référence à utiliser pour une ressource.

Nom Type Description
DataPath

string

Id

string

OutputPath

string

Sku

Définition du modèle de ressource représentant la référence SKU

Nom Type Description
capacity

integer

Si la référence SKU prend en charge le scale-out/in, l’entier de capacité doit être inclus. Si le scale-out/in n’est pas possible pour la ressource, cela peut être omis.

family

string

Si le service a différentes générations de matériel, pour la même référence SKU, vous pouvez le capturer ici.

name

string

Nom de la référence SKU. Ex - P3. Il s’agit généralement d’une lettre+code numérique

size

string

Taille de la référence SKU. Lorsque le champ de nom est la combinaison de niveau et d’une autre valeur, il s’agit du code autonome.

tier

SkuTier

Ce champ doit être implémenté par le fournisseur de ressources si le service a plusieurs niveaux, mais n’est pas obligatoire sur un PUT.

SkuTier

Ce champ doit être implémenté par le fournisseur de ressources si le service a plusieurs niveaux, mais n’est pas obligatoire sur un PUT.

Nom Type Description
Basic

string

Free

string

Premium

string

Standard

string

systemData

Métadonnées relatives à la création et à la dernière modification de la ressource.

Nom Type Description
createdAt

string

Horodatage de la création de ressources (UTC).

createdBy

string

Identité qui a créé la ressource.

createdByType

createdByType

Type d’identité qui a créé la ressource.

lastModifiedAt

string

Horodatage de la dernière modification de ressource (UTC)

lastModifiedBy

string

Identité qui a modifié la ressource pour la dernière fois.

lastModifiedByType

createdByType

Type d’identité qui a modifié la ressource pour la dernière fois.

UserAssignedIdentity

Propriétés d’identité attribuées par l’utilisateur

Nom Type Description
clientId

string

ID client de l’identité affectée.

principalId

string

ID principal de l’identité affectée.