Edge Device Jobs - Get

Service:: Azure Stack HCI

Version d'API:: 2024-09-01-preview

Obtenir un EdgeDeviceJob

GET https://management.azure.com/{resourceUri}/providers/Microsoft.AzureStackHCI/edgeDevices/{edgeDeviceName}/jobs/{jobsName}?api-version=2024-09-01-preview

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
edgeDeviceName	path	True	string pattern: ^[a-zA-Z0-9-]{3,24}$	Nom de EdgeDevice
jobsName	path	True	string pattern: ^[a-zA-Z0-9-]{3,24}$	Nom du travail EdgeDevice
resourceUri	path	True	string	Identificateur Azure Resource Manager complet de la ressource.
api-version	query	True	string minLength: 1	Version de l’API à utiliser pour cette opération.

Réponses

Nom	Type	Description
200 OK	EdgeDeviceJob: HciEdgeDeviceJob	L’opération Azure s’est terminée avec succès.
Other Status Codes	ErrorResponse	Réponse d’erreur inattendue.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

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

Exemples

EdgeDeviceJobs_Get_RemoteSupport

Exemple de requête

HTTP

GET https://management.azure.com/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1/providers/Microsoft.AzureStackHCI/edgeDevices/-5M1G7G10OZ-o5b-HS3-c72/jobs/-oUxs?api-version=2024-09-01-preview

Exemple de réponse

Code d’état:: 200

{
  "properties": {
    "jobType": "RemoteSupport",
    "accessLevel": "Diagnostics",
    "type": "Enable",
    "expirationTimestamp": "2024-01-29T10:43:27.9471574Z"
  },
  "kind": "HCI",
  "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1/providers/Microsoft.AzureStackHCI/edgeDevices/default/jobs/RemoteSupport",
  "name": "collectLog",
  "type": "Microsoft.AzureStackHCI/edgeDevices/jobs",
  "systemData": {
    "createdBy": "zsnvvvbj",
    "createdByType": "User",
    "createdAt": "2024-07-01T17:02:21.168Z",
    "lastModifiedBy": "qxlrx",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-07-01T17:02:21.168Z"
  }
}

Définitions

Nom	Description
createdByType	Type d’identité qui a créé la ressource.
DeploymentMode	Mode de déploiement pour déclencher un travail.
DeploymentStep	Étape du cluster AzureStackHCI.
DeviceLogCollectionStatus	Représente l’état d’une opération de collecte de journaux.
EceActionStatus	État du déploiement du plan d’action DE l’INSTANCE pour le cluster AzureStackHCI.
EdgeDeviceKind	Type d’appareil edge.
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail	Détail de l’erreur.
ErrorResponse	Réponse d’erreur
HciCollectLogJobProperties	Représente les propriétés d’un travail de journal de collecte HCI.
HciEdgeDeviceJob	Travail d’appareil Edge pour la solution Azure Stack HCI.
HciEdgeDeviceJobType	Type de travail pris en charge.
HciRemoteSupportJobProperties	Représente les propriétés d’un travail de support à distance pour HCI.
JobStatus	Représente les différents états qu’un travail peut avoir tout au long de son cycle de vie.
LogCollectionJobSession	Représente une session pour collecter les journaux d’activité à partir d’un appareil edge.
LogCollectionReportedProperties	Représente les propriétés signalées d’un travail de collecte de journaux.
ProvisioningState	État d’approvisionnement d’une ressource.
RemoteSupportAccessLevel	Définit le niveau d’accès à la prise en charge à distance accordé.
RemoteSupportJobNodeSettings	Représente les paramètres d’un nœud de support distant.
RemoteSupportJobReportedProperties	Représente les propriétés signalées d’un travail de support à distance.
RemoteSupportSession	Représente une session de support à distance.
RemoteSupportType	Définit le type d’action de prise en charge à distance à effectuer sur un appareil de périphérie.
systemData	Métadonnées relatives à la création et à la dernière modification de la ressource.

createdByType

Énumération

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

Valeur	Description
User
Application
ManagedIdentity
Key

DeploymentMode

Énumération

Mode de déploiement pour déclencher un travail.

Valeur	Description
Validate	Validez le déploiement d’actions DUT pour un cluster.
Deploy	Déployez le déploiement d’actions CLUSTER pour un cluster.

DeploymentStep

Object

Étape du cluster AzureStackHCI.

Nom	Type	Description
description	string	Description de l’étape.
endTimeUtc	string	Heure de fin de l’étape.
exception	string[]	Liste des exceptions dans le déploiement de cluster AzureStackHCI.
fullStepIndex	string	FullStepIndex de l’étape.
name	string	Nom de l’étape.
startTimeUtc	string	Heure de début de l’étape.
status	string	État de l’étape. Les valeurs autorisées sont « Error », « Success », « InProgress »
steps	DeploymentStep[]	Liste des étapes imbriquées du déploiement de cluster AzureStackHCI.

DeviceLogCollectionStatus

Énumération

Représente l’état d’une opération de collecte de journaux.

Valeur	Description
NotStarted	L’opération de collecte de journaux n’a pas été lancée.
Running	Indique que l’opération de collecte de journaux est en cours d’exécution.
Failed	Indique que l’opération de collecte de journaux a échoué.
Succeeded	Indique que l’opération de collecte de journaux s’est terminée correctement.
Canceled	Indique que l’opération de collecte de journaux s’est terminée correctement.

EceActionStatus

Object

État du déploiement du plan d’action DE l’INSTANCE pour le cluster AzureStackHCI.

Nom	Type	Description
status	string	État du déploiement du cluster AzureStackHCI de l’action CLUSTER AZUREStackHCI.
steps	DeploymentStep[]	Liste des étapes du déploiement de cluster AzureStackHCI.

EdgeDeviceKind

Énumération

Type d’appareil edge.

Valeur	Description
HCI	Appareil edge avec Arc avec système d’exploitation HCI.

ErrorAdditionalInfo

Object

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

Object

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

Object

Réponse d’erreur

Nom	Type	Description
error	ErrorDetail	Objet d’erreur.

HciCollectLogJobProperties

Object

Représente les propriétés d’un travail de journal de collecte HCI.

Nom	Type	Description
deploymentMode	DeploymentMode	Mode de déploiement pour déclencher un travail.
endTimeUtc	string (date-time)	Date et heure UTC à laquelle le travail s’est terminé.
fromDate	string (date-time)	À partir de la date de la collecte de journaux.
jobId	string	ID de travail unique et immuable.
jobType	string: CollectLog	Type de travail pour prendre en charge la ressource polymorphe.
lastLogGenerated	string (date-time)	À ce jour, pour la collecte de journaux.
provisioningState	ProvisioningState	État d’approvisionnement des travaux
reportedProperties	LogCollectionReportedProperties	propriétés signalées du travail de collecte de journaux.
startTimeUtc	string (date-time)	Date et heure UTC à laquelle le travail a démarré.
status	JobStatus	État du travail d’appareil Edge.
toDate	string (date-time)	À ce jour, pour la collecte de journaux.

HciEdgeDeviceJob

Object

Travail d’appareil Edge pour la solution Azure Stack HCI.

Nom	Type	Valeur par défaut	Description
id	string (arm-id)		ID de ressource complet pour la ressource. Par exemple, « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} »
kind	string: HCI	HCI	Type de solution Edge pour prendre en charge la ressource polymorphe.
name	string		Nom de la ressource
properties	HciEdgeDeviceJobProperties: HciCollectLogJobProperties HciRemoteSupportJobProperties		Propriétés du travail de l’appareil HCI Edge
systemData	systemData		Métadonnées Azure Resource Manager contenant les informations createdBy et modifiedBy.
type	string		Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

HciEdgeDeviceJobType

Énumération

Type de travail pris en charge.

Valeur	Description
CollectLog	Tâche de collecte des journaux à partir de l’appareil.
RemoteSupport	Tâche de fournir une prise en charge à distance à l’appareil.

HciRemoteSupportJobProperties

Object

Représente les propriétés d’un travail de support à distance pour HCI.

Nom	Type	Description
accessLevel	RemoteSupportAccessLevel	Niveau d’accès au support à distance.
deploymentMode	DeploymentMode	Mode de déploiement pour déclencher un travail.
endTimeUtc	string (date-time)	Date et heure UTC à laquelle le travail s’est terminé.
expirationTimestamp	string (date-time)	Horodatage d’expiration du support à distance.
jobId	string	ID de travail unique et immuable.
jobType	string: RemoteSupport	Type de travail pour prendre en charge la ressource polymorphe.
provisioningState	ProvisioningState	État d’approvisionnement des travaux
reportedProperties	RemoteSupportJobReportedProperties	propriétés signalées du travail de collecte de journaux.
startTimeUtc	string (date-time)	Date et heure UTC à laquelle le travail a démarré.
status	JobStatus	État du travail d’appareil Edge.
type	RemoteSupportType	Type de support à distance.

JobStatus

Énumération

Représente les différents états qu’un travail peut avoir tout au long de son cycle de vie.

Valeur	Description
NotSpecified	L’état du travail n’a pas été spécifié.
ValidationInProgress	Le travail est actuellement en cours de validation.
ValidationSuccess	Le travail a réussi à valider.
ValidationFailed	La validation du travail a échoué.
DeploymentInProgress	Le déploiement du travail est en cours.
DeploymentFailed	Le déploiement du travail a échoué.
DeploymentSuccess	Le travail a été correctement déployé.
Succeeded	Le travail a réussi.
Failed	Le travail a échoué.
Canceled	Le travail a été annulé.
Paused	Le travail est suspendu.
Scheduled	Le travail est planifié pour s’exécuter.

LogCollectionJobSession

Object

Représente une session pour collecter les journaux d’activité à partir d’un appareil edge.

Nom	Type	Description
correlationId	string	Identificateur unique pour la corrélation de cette session de collecte de journaux avec d’autres opérations ou sessions.
endTime	string	Horodatage lorsque la collection de journaux s’est terminée, au format ISO 8601.
logSize	integer (int32)	Taille des journaux collectés en octets.
startTime	string	Horodatage au démarrage de la collecte de journaux, au format ISO 8601.
status	DeviceLogCollectionStatus	État de la session de collecte de journaux.
timeCollected	string	Les journaux d’activité de temps total ont été collectés pour, au format de durée ISO 8601.

LogCollectionReportedProperties

Object

Représente les propriétés signalées d’un travail de collecte de journaux.

Nom	Type	Description
deploymentStatus	EceActionStatus	État du déploiement du travail.
logCollectionSessionDetails	LogCollectionJobSession[]	Détails de la session de collecte de journaux.
percentComplete	integer (int32)	Pourcentage du travail terminé.
validationStatus	EceActionStatus	État de validation du travail.

ProvisioningState

Énumération

État d’approvisionnement d’une ressource.

Valeur	Description
Succeeded	La ressource a été créée.
Failed	Échec de la création de ressources.
Canceled	La création de ressources a été annulée.
NotSpecified	L’état de provisionnement des ressources n’est pas spécifié
Provisioning	La ressource est en cours d’approvisionnement
Updating	La ressource est mise à jour
Deleting	La ressource est en cours de suppression
Accepted	La demande de création de ressource a été acceptée

RemoteSupportAccessLevel

Énumération

Définit le niveau d’accès à la prise en charge à distance accordé.

Valeur	Description
None	Aucun accès au support à distance n’est accordé.
Diagnostics	L’accès est limité aux informations de diagnostic uniquement.
DiagnosticsAndRepair	Access inclut des informations de diagnostic et la possibilité d’effectuer des réparations.

RemoteSupportJobNodeSettings

Object

Représente les paramètres d’un nœud de support distant.

Nom	Type	Description
connectionErrorMessage	string	Message d’erreur, le cas échéant, à partir de la dernière tentative de connexion.
connectionStatus	string	État de connexion actuel de la session de support à distance.
createdAt	string (date-time)	Horodatage lorsque les paramètres du nœud ont été créés, en UTC.
state	string	État du nœud de prise en charge à distance.
updatedAt	string (date-time)	Horodatage lorsque les paramètres du nœud ont été mis à jour pour la dernière fois, en UTC.

RemoteSupportJobReportedProperties

Object

Représente les propriétés signalées d’un travail de support à distance.

Nom	Type	Description
deploymentStatus	EceActionStatus	État du déploiement du travail.
nodeSettings	RemoteSupportJobNodeSettings	Paramètres facultatifs pour la configuration du nœud pour la prise en charge à distance.
percentComplete	integer (int32)	Pourcentage du travail terminé.
sessionDetails	RemoteSupportSession[]	Détails de la session de support à distance.
validationStatus	EceActionStatus	État de validation du travail.

RemoteSupportSession

Object

Représente une session de support à distance.

Nom	Type	Description
accessLevel	RemoteSupportAccessLevel	Niveau d’accès accordé pendant la session de support à distance.
sessionEndTime	string (date-time)	Heure de fin de la session de support à distance, en UTC.
sessionId	string	ID de session unique.
sessionStartTime	string (date-time)	Heure de début de la session de support à distance, en UTC.
transcriptLocation	string	Emplacement où la transcription de session est stockée.

RemoteSupportType

Énumération

Définit le type d’action de prise en charge à distance à effectuer sur un appareil de périphérie.

Valeur	Description
Enable	Active la prise en charge à distance de l’appareil edge.
Revoke	Révoque l’accès à la prise en charge à distance précédemment accordé pour l’appareil edge.

systemData

Object

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

Nom	Type	Description
createdAt	string (date-time)	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 (date-time)	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.

Partager via

Edge Device Jobs - Get

Paramètres URI

Réponses

Sécurité

azure_auth

Étendues

Exemples

EdgeDeviceJobs_Get_RemoteSupport

Exemple de requête

Exemple de réponse

Définitions

createdByType

DeploymentMode

DeploymentStep

DeviceLogCollectionStatus

EceActionStatus

EdgeDeviceKind

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

HciCollectLogJobProperties

HciEdgeDeviceJob

HciEdgeDeviceJobType

HciRemoteSupportJobProperties

JobStatus

LogCollectionJobSession

LogCollectionReportedProperties

ProvisioningState

RemoteSupportAccessLevel

RemoteSupportJobNodeSettings

RemoteSupportJobReportedProperties

RemoteSupportSession

RemoteSupportType

systemData