Edge Device Jobs - Get

Servizio:: Azure Stack HCI

Versione API:: 2024-09-01-preview

Ottenere un edgeDeviceJob

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
edgeDeviceName	path	True	string pattern: ^[a-zA-Z0-9-]{3,24}$	Nome del dispositivo Edge
jobsName	path	True	string pattern: ^[a-zA-Z0-9-]{3,24}$	Nome del processo EdgeDevice
resourceUri	path	True	string	Identificatore completo di Azure Resource Manager della risorsa.
api-version	query	True	string minLength: 1	Versione dell'API da usare per questa operazione.

Risposte

Nome	Tipo	Descrizione
200 OK	EdgeDeviceJob: HciEdgeDeviceJob	Operazione di Azure completata correttamente.
Other Status Codes	ErrorResponse	Risposta di errore imprevista.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

EdgeDeviceJobs_Get_RemoteSupport

Esempio di richiesta

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

Risposta di esempio

Codice di stato:: 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"
  }
}

Definizioni

Nome	Descrizione
createdByType	Tipo di identità che ha creato la risorsa.
DeploymentMode	Modalità di distribuzione per attivare il processo.
DeploymentStep	Passaggio del cluster AzureStackHCI.
DeviceLogCollectionStatus	Rappresenta lo stato di un'operazione di raccolta log.
EceActionStatus	Stato di distribuzione del piano di azione ECE per il cluster AzureStackHCI.
EdgeDeviceKind	Tipo di dispositivo perimetrale.
ErrorAdditionalInfo	Informazioni aggiuntive sull'errore di gestione delle risorse.
ErrorDetail	Dettagli dell'errore.
ErrorResponse	Risposta di errore
HciCollectLogJobProperties	Rappresenta le proprietà di un processo HCI Collect Log.
HciEdgeDeviceJob	Processo del dispositivo Edge per la soluzione Azure Stack HCI.
HciEdgeDeviceJobType	Tipo di processo supportato.
HciRemoteSupportJobProperties	Rappresenta le proprietà di un processo di supporto remoto per HCI.
JobStatus	Rappresenta i vari stati che un processo può avere per tutto il ciclo di vita.
LogCollectionJobSession	Rappresenta una sessione per la raccolta dei log da un dispositivo perimetrale.
LogCollectionReportedProperties	Rappresenta le proprietà segnalate di un processo di raccolta log.
ProvisioningState	Stato di provisioning di una risorsa.
RemoteSupportAccessLevel	Definisce il livello di accesso al supporto remoto concesso.
RemoteSupportJobNodeSettings	Rappresenta le impostazioni di un nodo di supporto remoto.
RemoteSupportJobReportedProperties	Rappresenta le proprietà segnalate di un processo di supporto remoto.
RemoteSupportSession	Rappresenta una sessione di supporto remoto.
RemoteSupportType	Definisce il tipo di azione di supporto remoto da eseguire in un dispositivo perimetrale.
systemData	Metadati relativi alla creazione e all'ultima modifica della risorsa.

createdByType

Enumerazione

Tipo di identità che ha creato la risorsa.

Valore	Descrizione
User
Application
ManagedIdentity
Key

DeploymentMode

Enumerazione

Modalità di distribuzione per attivare il processo.

Valore	Descrizione
Validate	Convalidare la distribuzione dell'azione ECE per un cluster.
Deploy	Distribuire la distribuzione di azioni ECE per un cluster.

DeploymentStep

Object

Passaggio del cluster AzureStackHCI.

Nome	Tipo	Descrizione
description	string	Descrizione del passaggio.
endTimeUtc	string	Ora di fine del passaggio.
exception	string[]	Elenco di eccezioni nella distribuzione del cluster AzureStackHCI.
fullStepIndex	string	FullStepIndex del passaggio.
name	string	Nome del passaggio.
startTimeUtc	string	Ora di inizio del passaggio.
status	string	Stato del passaggio. I valori consentiti sono 'Error', 'Success', 'InProgress'
steps	DeploymentStep[]	Elenco dei passaggi annidati della distribuzione del cluster AzureStackHCI.

DeviceLogCollectionStatus

Enumerazione

Rappresenta lo stato di un'operazione di raccolta log.

Valore	Descrizione
NotStarted	L'operazione di raccolta dei log non è stata avviata.
Running	Indica che l'operazione di raccolta log è attualmente in esecuzione.
Failed	Indica che l'operazione di raccolta log non è riuscita.
Succeeded	Indica che l'operazione di raccolta log è stata completata correttamente.
Canceled	Indica che l'operazione di raccolta log è stata completata correttamente.

EceActionStatus

Object

Stato di distribuzione del piano di azione ECE per il cluster AzureStackHCI.

Nome	Tipo	Descrizione
status	string	Stato dell'azione ECE AzureStackHCI Cluster Deployment( Distribuzione del cluster AzureStackHCI).
steps	DeploymentStep[]	Elenco dei passaggi della distribuzione del cluster AzureStackHCI.

EdgeDeviceKind

Enumerazione

Tipo di dispositivo perimetrale.

Valore	Descrizione
HCI	Dispositivo perimetrale abilitato per Arc con sistema operativo HCI.

ErrorAdditionalInfo

Object

Informazioni aggiuntive sull'errore di gestione delle risorse.

Nome	Tipo	Descrizione
info	object	Informazioni aggiuntive.
type	string	Tipo di informazioni aggiuntive.

ErrorDetail

Object

Dettagli dell'errore.

Nome	Tipo	Descrizione
additionalInfo	ErrorAdditionalInfo[]	Informazioni aggiuntive sull'errore.
code	string	Codice di errore.
details	ErrorDetail[]	Dettagli dell'errore.
message	string	Messaggio di errore.
target	string	Destinazione dell'errore.

ErrorResponse

Object

Risposta di errore

Nome	Tipo	Descrizione
error	ErrorDetail	Oggetto error.

HciCollectLogJobProperties

Object

Rappresenta le proprietà di un processo HCI Collect Log.

Nome	Tipo	Descrizione
deploymentMode	DeploymentMode	Modalità di distribuzione per attivare il processo.
endTimeUtc	string (date-time)	Data e ora UTC in cui è stato completato il processo.
fromDate	string (date-time)	Data di inizio per la raccolta dei log.
jobId	string	ID processo univoco non modificabile.
jobType	string: CollectLog	Tipo di processo per supportare la risorsa polimorfica.
lastLogGenerated	string (date-time)	Data per la raccolta di log.
provisioningState	ProvisioningState	Stato di provisioning del processo
reportedProperties	LogCollectionReportedProperties	proprietà segnalate del processo di raccolta log.
startTimeUtc	string (date-time)	Data e ora UTC in cui è stato avviato il processo.
status	JobStatus	Stato del processo del dispositivo Edge.
toDate	string (date-time)	Data per la raccolta di log.

HciEdgeDeviceJob

Object

Processo del dispositivo Edge per la soluzione Azure Stack HCI.

Nome	Tipo	Valore predefinito	Descrizione
id	string (arm-id)		ID risorsa completo per la risorsa. Ad esempio, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
kind	string: HCI	HCI	Tipo di soluzione Edge per supportare la risorsa polimorfica.
name	string		Nome della risorsa
properties	HciEdgeDeviceJobProperties: HciCollectLogJobProperties HciRemoteSupportJobProperties		Proprietà del processo del dispositivo HCI Edge
systemData	systemData		Metadati di Azure Resource Manager contenenti le informazioni createdBy e modifiedBy.
type	string		Tipo della risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

HciEdgeDeviceJobType

Enumerazione

Tipo di processo supportato.

Valore	Descrizione
CollectLog	Processo per raccogliere i log dal dispositivo.
RemoteSupport	Processo per fornire supporto remoto al dispositivo.

HciRemoteSupportJobProperties

Object

Rappresenta le proprietà di un processo di supporto remoto per HCI.

Nome	Tipo	Descrizione
accessLevel	RemoteSupportAccessLevel	Livello di accesso di supporto remoto.
deploymentMode	DeploymentMode	Modalità di distribuzione per attivare il processo.
endTimeUtc	string (date-time)	Data e ora UTC in cui è stato completato il processo.
expirationTimestamp	string (date-time)	Timestamp di scadenza del supporto remoto.
jobId	string	ID processo univoco non modificabile.
jobType	string: RemoteSupport	Tipo di processo per supportare la risorsa polimorfica.
provisioningState	ProvisioningState	Stato di provisioning del processo
reportedProperties	RemoteSupportJobReportedProperties	proprietà segnalate del processo di raccolta log.
startTimeUtc	string (date-time)	Data e ora UTC in cui è stato avviato il processo.
status	JobStatus	Stato del processo del dispositivo Edge.
type	RemoteSupportType	Tipo di supporto remoto.

JobStatus

Enumerazione

Rappresenta i vari stati che un processo può avere per tutto il ciclo di vita.

Valore	Descrizione
NotSpecified	Lo stato del processo non è stato specificato.
ValidationInProgress	Il processo è attualmente in fase di convalida.
ValidationSuccess	Il processo ha superato correttamente la convalida.
ValidationFailed	La convalida del processo non è riuscita.
DeploymentInProgress	La distribuzione del processo è attualmente in corso.
DeploymentFailed	La distribuzione del processo non è riuscita.
DeploymentSuccess	Il processo è stato distribuito correttamente.
Succeeded	Il processo è riuscito.
Failed	Il processo non è riuscito.
Canceled	Il processo è stato annullato.
Paused	Il processo viene sospeso.
Scheduled	Il processo è pianificato per l'esecuzione.

LogCollectionJobSession

Object

Rappresenta una sessione per la raccolta dei log da un dispositivo perimetrale.

Nome	Tipo	Descrizione
correlationId	string	Identificatore univoco per correlare questa sessione di raccolta di log con altre operazioni o sessioni.
endTime	string	Timestamp al termine della raccolta di log, in formato ISO 8601.
logSize	integer (int32)	Dimensioni dei log raccolti in byte.
startTime	string	Timestamp all'avvio della raccolta di log, in formato ISO 8601.
status	DeviceLogCollectionStatus	Stato della sessione di raccolta log.
timeCollected	string	I log di tempo totale sono stati raccolti per, nel formato di durata ISO 8601.

LogCollectionReportedProperties

Object

Rappresenta le proprietà segnalate di un processo di raccolta log.

Nome	Tipo	Descrizione
deploymentStatus	EceActionStatus	Stato della distribuzione del processo.
logCollectionSessionDetails	LogCollectionJobSession[]	Dettagli della sessione di raccolta dei log.
percentComplete	integer (int32)	Percentuale del processo completato.
validationStatus	EceActionStatus	Stato di convalida del processo.

ProvisioningState

Enumerazione

Stato di provisioning di una risorsa.

Valore	Descrizione
Succeeded	La risorsa è stata creata.
Failed	Creazione della risorsa non riuscita.
Canceled	La creazione della risorsa è stata annullata.
NotSpecified	Lo stato di provisioning della risorsa non è specificato
Provisioning	Provisioning della risorsa
Updating	La risorsa sta aggiornando
Deleting	La risorsa viene eliminata
Accepted	La richiesta di creazione della risorsa è stata accettata

RemoteSupportAccessLevel

Enumerazione

Definisce il livello di accesso al supporto remoto concesso.

Valore	Descrizione
None	Non viene concesso alcun accesso al supporto remoto.
Diagnostics	L'accesso è limitato solo alle informazioni di diagnostica.
DiagnosticsAndRepair	L'accesso include informazioni di diagnostica e la possibilità di eseguire riparazioni.

RemoteSupportJobNodeSettings

Object

Rappresenta le impostazioni di un nodo di supporto remoto.

Nome	Tipo	Descrizione
connectionErrorMessage	string	Messaggio di errore, se presente, dall'ultimo tentativo di connessione.
connectionStatus	string	Stato della connessione corrente della sessione di supporto remoto.
createdAt	string (date-time)	Timestamp in cui sono state create le impostazioni del nodo, in formato UTC.
state	string	Stato del nodo di supporto remoto.
updatedAt	string (date-time)	Timestamp dell'ultimo aggiornamento delle impostazioni del nodo, in formato UTC.

RemoteSupportJobReportedProperties

Object

Rappresenta le proprietà segnalate di un processo di supporto remoto.

Nome	Tipo	Descrizione
deploymentStatus	EceActionStatus	Stato della distribuzione del processo.
nodeSettings	RemoteSupportJobNodeSettings	Impostazioni facoltative per la configurazione del nodo per il supporto remoto.
percentComplete	integer (int32)	Percentuale del processo completato.
sessionDetails	RemoteSupportSession[]	Dettagli della sessione di supporto remoto.
validationStatus	EceActionStatus	Stato di convalida del processo.

RemoteSupportSession

Object

Rappresenta una sessione di supporto remoto.

Nome	Tipo	Descrizione
accessLevel	RemoteSupportAccessLevel	Livello di accesso concesso durante la sessione di supporto remoto.
sessionEndTime	string (date-time)	Ora di fine della sessione di supporto remoto, in formato UTC.
sessionId	string	ID sessione univoco.
sessionStartTime	string (date-time)	Ora di inizio della sessione di supporto remoto, in formato UTC.
transcriptLocation	string	Percorso in cui è archiviata la trascrizione della sessione.

RemoteSupportType

Enumerazione

Definisce il tipo di azione di supporto remoto da eseguire in un dispositivo perimetrale.

Valore	Descrizione
Enable	Abilita il supporto remoto per il dispositivo perimetrale.
Revoke	Revoca l'accesso al supporto remoto precedentemente concesso per il dispositivo perimetrale.

systemData

Object

Metadati relativi alla creazione e all'ultima modifica della risorsa.

Nome	Tipo	Descrizione
createdAt	string (date-time)	Timestamp della creazione della risorsa (UTC).
createdBy	string	Identità che ha creato la risorsa.
createdByType	createdByType	Tipo di identità che ha creato la risorsa.
lastModifiedAt	string (date-time)	Timestamp dell'ultima modifica della risorsa (UTC)
lastModifiedBy	string	Identità che ha modificato l'ultima volta la risorsa.
lastModifiedByType	createdByType	Tipo di identità che ha modificato l'ultima volta la risorsa.

Condividi tramite

Edge Device Jobs - Get

Parametri dell'URI

Risposte

Sicurezza

azure_auth

Ambiti

Esempio

EdgeDeviceJobs_Get_RemoteSupport

Esempio di richiesta

Risposta di esempio

Definizioni

createdByType

DeploymentMode

DeploymentStep

DeviceLogCollectionStatus

EceActionStatus

EdgeDeviceKind

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

HciCollectLogJobProperties

HciEdgeDeviceJob

HciEdgeDeviceJobType

HciRemoteSupportJobProperties

JobStatus

LogCollectionJobSession

LogCollectionReportedProperties

ProvisioningState

RemoteSupportAccessLevel

RemoteSupportJobNodeSettings

RemoteSupportJobReportedProperties

RemoteSupportSession

RemoteSupportType

systemData