Operations Status - Get

Obtient les détails d’un travail spécifié sur un appareil Data Box Edge/Data Box Gateway.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/operationsStatus/{name}?api-version=2019-08-01

Paramètres URI

Name In Required Type Description
deviceName
path True
  • string

Le nom de l'appareil.

name
path True
  • string

Nom du travail.

resourceGroupName
path True
  • string

Nom du groupe de ressources.

subscriptionId
path True
  • string

L'ID de l'abonnement.

api-version
query True
  • string

Version de l'API.

Réponses

Name Type Description
200 OK

Détails du travail.

Other Status Codes

Réponse d’erreur décrivant la raison de l’échec de l’opération.

Sécurité

azure_auth

Azure Active Directory le Flow OAuth2.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation emprunter l’identité de votre compte d’utilisateur.

Exemples

OperationsStatusGet

Sample Request

GET https://management.azure.com/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/operationsStatus/159a00c7-8543-4343-9435-263ac87df3bb?api-version=2019-08-01

Sample Response

{
  "id": "/subscriptions/id/locations/westus/operationsStatus/159a00c7-8543-4343-9435-263ac87df3bb",
  "name": "159a00c7-8543-4343-9435-263ac87df3bb",
  "status": "Succeeded",
  "startTime": "2018-12-18T02:18:51.4270267Z",
  "endTime": "2018-12-18T03:18:51.4270267Z",
  "percentComplete": 100,
  "properties": {
    "jobType": "DownloadUpdates",
    "currentStage": "Success"
  }
}

Définitions

CloudError

Réponse d’erreur du service.

CloudErrorBody

Réponse d’erreur du service.

DownloadPhase

Phase de téléchargement.

Job

Un travail d’appareil.

JobErrorDetails

Informations sur l’erreur de tâche contenant la liste des erreurs de tâche.

JobErrorItem

Éléments d’erreur du travail.

JobStatus

L’état actuel du travail.

JobType

Type du travail.

UpdateDownloadProgress

Détails sur la progression du téléchargement de la mise à jour.

UpdateInstallProgress

Détails de la progression lors de l’installation des mises à jour.

UpdateOperationStage

Étape actuelle de l’opération de mise à jour.

CloudError

Réponse d’erreur du service.

Name Type Description
error

Détails de l’erreur.

CloudErrorBody

Réponse d’erreur du service.

Name Type Description
code
  • string

Identificateur de l'erreur. Les codes sont invariants et sont destinés à être consommés par programmation.

details

Liste de détails supplémentaires sur l’erreur.

message
  • string

Message décrivant l’erreur, destiné à être adapté à l’affichage dans une interface utilisateur.

DownloadPhase

Phase de téléchargement.

Name Type Description
Downloading
  • string
Initializing
  • string
Unknown
  • string
Verifying
  • string

Job

Un travail d’appareil.

Name Type Description
endTime
  • string

Date et heure UTC auxquelles le travail s’est terminé.

error

Détails de l’erreur.

id
  • string

ID de chemin d’accès qui identifie l’objet de façon unique.

name
  • string

Nom de l'objet.

percentComplete
  • integer

Pourcentage de la tâche qui est terminé.

properties.currentStage

Étape actuelle de l’opération de mise à jour.

properties.downloadProgress

Progression du téléchargement.

properties.errorManifestFile
  • string

Chemin relatif du partage local/du conteneur distant vers le fichier manifeste d’erreur de l’actualisation.

properties.folder
  • string

Si seuls les sous-dossiers doivent être actualisés, le chemin du sous-dossier se trouve dans le partage ou le conteneur. (Le chemin d’accès est vide s’il n’y a aucun sous-dossier.)

properties.installProgress

Progression de l’installation.

properties.jobType

Type du travail.

properties.refreshedEntityId
  • string

ID ARM de l’entité qui a été actualisée.

properties.totalRefreshErrors
  • integer

Nombre total d’erreurs rencontrées au cours du processus d’actualisation.

startTime
  • string

Date et heure UTC auxquelles le travail a démarré.

status

L’état actuel du travail.

type
  • string

Type hiérarchique de l’objet.

JobErrorDetails

Informations sur l’erreur de tâche contenant la liste des erreurs de tâche.

Name Type Description
code
  • string

Code destiné à l’accès par programme.

errorDetails

Détails de l’erreur.

message
  • string

Message qui décrit l’erreur en détail.

JobErrorItem

Éléments d’erreur du travail.

Name Type Description
code
  • string

Code destiné à l’accès par programme.

message
  • string

Message qui décrit l’erreur en détail.

recommendations
  • string[]

Actions recommandées.

JobStatus

L’état actuel du travail.

Name Type Description
Canceled
  • string
Failed
  • string
Invalid
  • string
Paused
  • string
Running
  • string
Scheduled
  • string
Succeeded
  • string

JobType

Type du travail.

Name Type Description
DownloadUpdates
  • string
InstallUpdates
  • string
Invalid
  • string
RefreshContainer
  • string
RefreshShare
  • string
ScanForUpdates
  • string

UpdateDownloadProgress

Détails sur la progression du téléchargement de la mise à jour.

Name Type Description
downloadPhase

Phase de téléchargement.

numberOfUpdatesDownloaded
  • integer

Nombre de mises à jour téléchargées.

numberOfUpdatesToDownload
  • integer

Nombre de mises à jour à télécharger.

percentComplete
  • integer

Pourcentage d’achèvement.

totalBytesDownloaded
  • number

Nombre total d’octets téléchargés.

totalBytesToDownload
  • number

Nombre total d’octets à télécharger.

UpdateInstallProgress

Détails de la progression lors de l’installation des mises à jour.

Name Type Description
numberOfUpdatesInstalled
  • integer

Nombre de mises à jour installées.

numberOfUpdatesToInstall
  • integer

Nombre de mises à jour à installer.

percentComplete
  • integer

Pourcentage effectué.

UpdateOperationStage

Étape actuelle de l’opération de mise à jour.

Name Type Description
DownloadComplete
  • string
DownloadFailed
  • string
DownloadStarted
  • string
Failure
  • string
Initial
  • string
InstallComplete
  • string
InstallFailed
  • string
InstallStarted
  • string
RebootInitiated
  • string
RescanComplete
  • string
RescanFailed
  • string
RescanStarted
  • string
ScanComplete
  • string
ScanFailed
  • string
ScanStarted
  • string
Success
  • string
Unknown
  • string