Edge Device Jobs - Get

Servicio:: Azure Stack HCI

Versión de la API:: 2024-09-01-preview

Obtener un EdgeDeviceJob

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
edgeDeviceName	path	True	string pattern: ^[a-zA-Z0-9-]{3,24}$	Nombre de EdgeDevice
jobsName	path	True	string pattern: ^[a-zA-Z0-9-]{3,24}$	Nombre del trabajo edgeDevice
resourceUri	path	True	string	Identificador completo de Azure Resource Manager del recurso.
api-version	query	True	string minLength: 1	Versión de la API que se va a usar para esta operación.

Respuestas

Nombre	Tipo	Description
200 OK	EdgeDeviceJob: HciEdgeDeviceJob	La operación de Azure se completó correctamente.
Other Status Codes	ErrorResponse	Una respuesta de error inesperada.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

EdgeDeviceJobs_Get_RemoteSupport

Solicitud de ejemplo

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

Respuesta de muestra

status code:: 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"
  }
}

Definiciones

Nombre	Description
createdByType	Tipo de identidad que creó el recurso.
DeploymentMode	Modo de implementación para desencadenar el trabajo.
DeploymentStep	El paso del clúster de AzureStackHCI.
DeviceLogCollectionStatus	Representa el estado de una operación de recopilación de registros.
EceActionStatus	El estado de implementación del plan de acción ECE para el clúster de AzureStackHCI.
EdgeDeviceKind	Tipo de dispositivo perimetral.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
HciCollectLogJobProperties	Representa las propiedades de un trabajo de registro de recopilación de HCI.
HciEdgeDeviceJob	Trabajo de dispositivo perimetral para la solución Azure Stack HCI.
HciEdgeDeviceJobType	Tipo de trabajo admitido.
HciRemoteSupportJobProperties	Representa las propiedades de un trabajo de soporte remoto para HCI.
JobStatus	Representa los distintos estados que un trabajo puede tener a lo largo de su ciclo de vida.
LogCollectionJobSession	Representa una sesión para recopilar registros de un dispositivo perimetral.
LogCollectionReportedProperties	Representa las propiedades notificadas de un trabajo de recopilación de registros.
ProvisioningState	Estado de aprovisionamiento de un recurso.
RemoteSupportAccessLevel	Define el nivel de acceso de soporte remoto concedido.
RemoteSupportJobNodeSettings	Representa la configuración de un nodo de soporte remoto.
RemoteSupportJobReportedProperties	Representa las propiedades notificadas de un trabajo de soporte remoto.
RemoteSupportSession	Representa una sesión de soporte técnico remoto.
RemoteSupportType	Define el tipo de acción de soporte remoto que se va a realizar en un dispositivo perimetral.
systemData	Metadatos relativos a la creación y última modificación del recurso.

createdByType

Enumeración

Tipo de identidad que creó el recurso.

Valor	Description
User
Application
ManagedIdentity
Key

DeploymentMode

Enumeración

Modo de implementación para desencadenar el trabajo.

Valor	Description
Validate	Valide la implementación de acciones ECE para un clúster.
Deploy	Implemente la implementación de acciones ECE para un clúster.

DeploymentStep

Object

El paso del clúster de AzureStackHCI.

Nombre	Tipo	Description
description	string	Descripción del paso.
endTimeUtc	string	Hora de finalización del paso.
exception	string[]	Lista de excepciones en implementación de clústeres de AzureStackHCI.
fullStepIndex	string	FullStepIndex del paso.
name	string	Nombre del paso.
startTimeUtc	string	Hora de inicio del paso.
status	string	Estado del paso. Los valores permitidos son 'Error', 'Success', 'InProgress'
steps	DeploymentStep[]	Lista de pasos anidados de implementación de clústeres de AzureStackHCI.

DeviceLogCollectionStatus

Enumeración

Representa el estado de una operación de recopilación de registros.

Valor	Description
NotStarted	No se ha iniciado la operación de recopilación de registros.
Running	Indica que la operación de recopilación de registros se está ejecutando actualmente.
Failed	Indica que se ha producido un error en la operación de recopilación de registros.
Succeeded	Indica que la operación de recopilación de registros se ha completado correctamente.
Canceled	Indica que la operación de recopilación de registros se ha completado correctamente.

EceActionStatus

Object

El estado de implementación del plan de acción ECE para el clúster de AzureStackHCI.

Nombre	Tipo	Description
status	string	Estado de la acción ECE AzureStackHCI Cluster Deployment( Implementación de clústeres de AzureStackHCI).
steps	DeploymentStep[]	Lista de pasos de implementación de clústeres de AzureStackHCI.

EdgeDeviceKind

Enumeración

Tipo de dispositivo perimetral.

Valor	Description
HCI	Dispositivo perimetral habilitado para Arc con sistema operativo HCI.

ErrorAdditionalInfo

Object

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorDetail

Object

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Detalles del error.
message	string	Mensaje de error.
target	string	Destino del error.

ErrorResponse

Object

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

HciCollectLogJobProperties

Object

Representa las propiedades de un trabajo de registro de recopilación de HCI.

Nombre	Tipo	Description
deploymentMode	DeploymentMode	Modo de implementación para desencadenar el trabajo.
endTimeUtc	string (date-time)	Fecha y hora UTC a la que se completó el trabajo.
fromDate	string (date-time)	A partir de la fecha de recopilación de registros.
jobId	string	Identificador de trabajo único e inmutable.
jobType	string: CollectLog	Tipo de trabajo para admitir recursos polimórficos.
lastLogGenerated	string (date-time)	Hasta la fecha para la recopilación de registros.
provisioningState	ProvisioningState	Estado de aprovisionamiento de trabajos
reportedProperties	LogCollectionReportedProperties	propiedades notificadas del trabajo de recopilación de registros.
startTimeUtc	string (date-time)	Fecha y hora UTC en la que se inició el trabajo.
status	JobStatus	Estado del trabajo del dispositivo Perimetral.
toDate	string (date-time)	Hasta la fecha para la recopilación de registros.

HciEdgeDeviceJob

Object

Trabajo de dispositivo perimetral para la solución Azure Stack HCI.

Nombre	Tipo	Valor predeterminado	Description
id	string (arm-id)		Identificador de recurso completo para el recurso. Por ejemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
kind	string: HCI	HCI	Tipo de solución perimetral para admitir recursos polimórficos.
name	string		Nombre del recurso
properties	HciEdgeDeviceJobProperties: HciCollectLogJobProperties HciRemoteSupportJobProperties		Propiedades del trabajo del dispositivo HCI Edge
systemData	systemData		Metadatos de Azure Resource Manager que contienen información createdBy y modifiedBy.
type	string		Tipo del recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

HciEdgeDeviceJobType

Enumeración

Tipo de trabajo admitido.

Valor	Description
CollectLog	Trabajo para recopilar registros del dispositivo.
RemoteSupport	Trabajo para proporcionar soporte remoto al dispositivo.

HciRemoteSupportJobProperties

Object

Representa las propiedades de un trabajo de soporte remoto para HCI.

Nombre	Tipo	Description
accessLevel	RemoteSupportAccessLevel	Nivel de acceso de soporte remoto.
deploymentMode	DeploymentMode	Modo de implementación para desencadenar el trabajo.
endTimeUtc	string (date-time)	Fecha y hora UTC a la que se completó el trabajo.
expirationTimestamp	string (date-time)	Marca de tiempo de expiración de compatibilidad remota.
jobId	string	Identificador de trabajo único e inmutable.
jobType	string: RemoteSupport	Tipo de trabajo para admitir recursos polimórficos.
provisioningState	ProvisioningState	Estado de aprovisionamiento de trabajos
reportedProperties	RemoteSupportJobReportedProperties	propiedades notificadas del trabajo de recopilación de registros.
startTimeUtc	string (date-time)	Fecha y hora UTC en la que se inició el trabajo.
status	JobStatus	Estado del trabajo del dispositivo Perimetral.
type	RemoteSupportType	Tipo de soporte técnico remoto.

JobStatus

Enumeración

Representa los distintos estados que un trabajo puede tener a lo largo de su ciclo de vida.

Valor	Description
NotSpecified	No se ha especificado el estado del trabajo.
ValidationInProgress	El trabajo está actualmente en proceso de validación.
ValidationSuccess	El trabajo ha superado correctamente la validación.
ValidationFailed	El trabajo ha producido un error en la validación.
DeploymentInProgress	La implementación del trabajo está actualmente en curso.
DeploymentFailed	Error en la implementación del trabajo.
DeploymentSuccess	El trabajo se ha implementado correctamente.
Succeeded	El trabajo se ha realizado correctamente.
Failed	Error en el trabajo.
Canceled	Se ha cancelado el trabajo.
Paused	El trabajo está en pausa.
Scheduled	El trabajo está programado para ejecutarse.

LogCollectionJobSession

Object

Representa una sesión para recopilar registros de un dispositivo perimetral.

Nombre	Tipo	Description
correlationId	string	Identificador único para correlacionar esta sesión de recopilación de registros con otras operaciones o sesiones.
endTime	string	Marca de tiempo cuando finalizó la recopilación de registros, en formato ISO 8601.
logSize	integer (int32)	Tamaño de los registros recopilados en bytes.
startTime	string	Marca de tiempo cuando se inició la recopilación de registros, en formato ISO 8601.
status	DeviceLogCollectionStatus	Estado de la sesión de recopilación de registros.
timeCollected	string	Los registros de tiempo total se recopilaron en formato de duración ISO 8601.

LogCollectionReportedProperties

Object

Representa las propiedades notificadas de un trabajo de recopilación de registros.

Nombre	Tipo	Description
deploymentStatus	EceActionStatus	Estado de implementación del trabajo.
logCollectionSessionDetails	LogCollectionJobSession[]	Detalles de la sesión de recopilación de registros.
percentComplete	integer (int32)	Porcentaje del trabajo completado.
validationStatus	EceActionStatus	Estado de validación del trabajo.

ProvisioningState

Enumeración

Estado de aprovisionamiento de un recurso.

Valor	Description
Succeeded	Se ha creado el recurso.
Failed	Error en la creación de recursos.
Canceled	Se canceló la creación de recursos.
NotSpecified	No se especifica el estado de aprovisionamiento de recursos.
Provisioning	El recurso se está aprovisionando.
Updating	El recurso se está actualizando
Deleting	El recurso se está eliminando.
Accepted	Se ha aceptado la solicitud de creación de recursos.

RemoteSupportAccessLevel

Enumeración

Define el nivel de acceso de soporte remoto concedido.

Valor	Description
None	No se concede acceso de soporte remoto.
Diagnostics	El acceso solo se limita a la información de diagnóstico.
DiagnosticsAndRepair	Access incluye información de diagnóstico y la capacidad de realizar reparaciones.

RemoteSupportJobNodeSettings

Object

Representa la configuración de un nodo de soporte remoto.

Nombre	Tipo	Description
connectionErrorMessage	string	Mensaje de error, si existe, desde el último intento de conexión.
connectionStatus	string	Estado de conexión actual de la sesión de soporte remoto.
createdAt	string (date-time)	Marca de tiempo en la que se creó la configuración del nodo, en UTC.
state	string	Estado del nodo de soporte remoto.
updatedAt	string (date-time)	Marca de tiempo en la que se actualizó por última vez la configuración del nodo, en UTC.

RemoteSupportJobReportedProperties

Object

Representa las propiedades notificadas de un trabajo de soporte remoto.

Nombre	Tipo	Description
deploymentStatus	EceActionStatus	Estado de implementación del trabajo.
nodeSettings	RemoteSupportJobNodeSettings	Opciones opcionales para configurar el nodo para la compatibilidad remota.
percentComplete	integer (int32)	Porcentaje del trabajo completado.
sessionDetails	RemoteSupportSession[]	Detalles de la sesión de soporte remoto.
validationStatus	EceActionStatus	Estado de validación del trabajo.

RemoteSupportSession

Object

Representa una sesión de soporte técnico remoto.

Nombre	Tipo	Description
accessLevel	RemoteSupportAccessLevel	Nivel de acceso concedido durante la sesión de soporte remoto.
sessionEndTime	string (date-time)	Hora de finalización de la sesión de soporte remoto, en UTC.
sessionId	string	Identificador de sesión único.
sessionStartTime	string (date-time)	Hora de inicio de la sesión de soporte remoto, en UTC.
transcriptLocation	string	Ubicación donde se almacena la transcripción de sesión.

RemoteSupportType

Enumeración

Define el tipo de acción de soporte remoto que se va a realizar en un dispositivo perimetral.

Valor	Description
Enable	Habilita la compatibilidad remota con el dispositivo perimetral.
Revoke	Revoca el acceso de soporte remoto concedido previamente para el dispositivo perimetral.

systemData

Object

Metadatos relativos a la creación y última modificación del recurso.

Nombre	Tipo	Description
createdAt	string (date-time)	Marca de tiempo de creación de recursos (UTC).
createdBy	string	Identidad que creó el recurso.
createdByType	createdByType	Tipo de identidad que creó el recurso.
lastModifiedAt	string (date-time)	Marca de tiempo de la última modificación del recurso (UTC)
lastModifiedBy	string	Identidad que modificó por última vez el recurso.
lastModifiedByType	createdByType	Tipo de identidad que modificó por última vez el recurso.

Compartir a través de

Edge Device Jobs - Get

Parámetros de identificador URI

Respuestas

Seguridad

azure_auth

Ámbitos

Ejemplos

EdgeDeviceJobs_Get_RemoteSupport

Solicitud de ejemplo

Respuesta de muestra

Definiciones

createdByType

DeploymentMode

DeploymentStep

DeviceLogCollectionStatus

EceActionStatus

EdgeDeviceKind

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

HciCollectLogJobProperties

HciEdgeDeviceJob

HciEdgeDeviceJobType

HciRemoteSupportJobProperties

JobStatus

LogCollectionJobSession

LogCollectionReportedProperties

ProvisioningState

RemoteSupportAccessLevel

RemoteSupportJobNodeSettings

RemoteSupportJobReportedProperties

RemoteSupportSession

RemoteSupportType

systemData