Edge Device Jobs - Get

Service:: Azure Stack HCI

API Version:: 2024-09-01-preview

Get a EdgeDeviceJob

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

URI Parameters

Name	In	Required	Type	Description
edgeDeviceName	path	True	string pattern: ^[a-zA-Z0-9-]{3,24}$	The name of the EdgeDevice
jobsName	path	True	string pattern: ^[a-zA-Z0-9-]{3,24}$	Name of EdgeDevice Job
resourceUri	path	True	string	The fully qualified Azure Resource manager identifier of the resource.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	EdgeDeviceJob: HciEdgeDeviceJob	Azure operation completed successfully.
Other Status Codes	ErrorResponse	An unexpected error response.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

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

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

EdgeDeviceJobs_Get_RemoteSupport

Sample request

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

Sample response

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

Definitions

Name	Description
createdByType	The type of identity that created the resource.
DeploymentMode	Deployment mode to trigger job.
DeploymentStep	The Step of AzureStackHCI Cluster.
DeviceLogCollectionStatus	Represents the status of a log collection operation.
EceActionStatus	The ECE action plan deployment status for AzureStackHCI Cluster.
EdgeDeviceKind	Edge device kind.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
HciCollectLogJobProperties	Represents the properties of an HCI Collect Log job.
HciEdgeDeviceJob	Edge device job for Azure Stack HCI solution.
HciEdgeDeviceJobType	Job Type supported.
HciRemoteSupportJobProperties	Represents the properties of a remote support job for HCI.
JobStatus	Represents the various statuses a job can have throughout its lifecycle.
LogCollectionJobSession	Represents a session for collecting logs from an edge device.
LogCollectionReportedProperties	Represents the reported properties of a log collection job.
ProvisioningState	The provisioning state of a resource.
RemoteSupportAccessLevel	Defines the level of remote support access granted.
RemoteSupportJobNodeSettings	Represents the settings of a remote support node.
RemoteSupportJobReportedProperties	Represents the reported properties of a remote support job.
RemoteSupportSession	Represents a remote support session.
RemoteSupportType	Defines the type of remote support action to be performed on an edge device.
systemData	Metadata pertaining to creation and last modification of the resource.

createdByType

Enumeration

The type of identity that created the resource.

Value	Description
User
Application
ManagedIdentity
Key

DeploymentMode

Enumeration

Deployment mode to trigger job.

Value	Description
Validate	Validate ECE action deployment for a cluster.
Deploy	Deploy ECE action deployment for a cluster.

DeploymentStep

Object

The Step of AzureStackHCI Cluster.

Name	Type	Description
description	string	Description of step.
endTimeUtc	string	End time of step.
exception	string[]	List of exceptions in AzureStackHCI Cluster Deployment.
fullStepIndex	string	FullStepIndex of step.
name	string	Name of step.
startTimeUtc	string	Start time of step.
status	string	Status of step. Allowed values are 'Error', 'Success', 'InProgress'
steps	DeploymentStep[]	List of nested steps of AzureStackHCI Cluster Deployment.

DeviceLogCollectionStatus

Enumeration

Represents the status of a log collection operation.

Value	Description
NotStarted	Log collection operation has not been initiated.
Running	Indicates that the log collection operation is currently running.
Failed	Indicates that the log collection operation has failed.
Succeeded	Indicates that the log collection operation has completed successfully.
Canceled	Indicates that the log collection operation has completed successfully.

EceActionStatus

Object

The ECE action plan deployment status for AzureStackHCI Cluster.

Name	Type	Description
status	string	Status of ECE action AzureStackHCI Cluster Deployment.
steps	DeploymentStep[]	List of steps of AzureStackHCI Cluster Deployment.

EdgeDeviceKind

Enumeration

Edge device kind.

Value	Description
HCI	Arc-enabled edge device with HCI OS.

ErrorAdditionalInfo

Object

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

Object

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Object

Error response

Name	Type	Description
error	ErrorDetail	The error object.

HciCollectLogJobProperties

Object

Represents the properties of an HCI Collect Log job.

Name	Type	Description
deploymentMode	DeploymentMode	Deployment mode to trigger job.
endTimeUtc	string (date-time)	The UTC date and time at which the job completed.
fromDate	string (date-time)	From date for log collection.
jobId	string	Unique, immutable job id.
jobType	string: CollectLog	Job Type to support polymorphic resource.
lastLogGenerated	string (date-time)	To date for log collection.
provisioningState	ProvisioningState	Job provisioning state
reportedProperties	LogCollectionReportedProperties	log collection job reported properties.
startTimeUtc	string (date-time)	The UTC date and time at which the job started.
status	JobStatus	Status of Edge device job.
toDate	string (date-time)	To date for log collection.

HciEdgeDeviceJob

Object

Edge device job for Azure Stack HCI solution.

Name	Type	Default value	Description
id	string (arm-id)		Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
kind	string: HCI	HCI	Edge Solution type to support polymorphic resource.
name	string		The name of the resource
properties	HciEdgeDeviceJobProperties: HciCollectLogJobProperties HciRemoteSupportJobProperties		HCI Edge device job properties
systemData	systemData		Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string		The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

HciEdgeDeviceJobType

Enumeration

Job Type supported.

Value	Description
CollectLog	Job to collect logs from the device.
RemoteSupport	Job to provide remote support to the device.

HciRemoteSupportJobProperties

Object

Represents the properties of a remote support job for HCI.

Name	Type	Description
accessLevel	RemoteSupportAccessLevel	Remote support access level.
deploymentMode	DeploymentMode	Deployment mode to trigger job.
endTimeUtc	string (date-time)	The UTC date and time at which the job completed.
expirationTimestamp	string (date-time)	Remote support expiration timestamp.
jobId	string	Unique, immutable job id.
jobType	string: RemoteSupport	Job Type to support polymorphic resource.
provisioningState	ProvisioningState	Job provisioning state
reportedProperties	RemoteSupportJobReportedProperties	log collection job reported properties.
startTimeUtc	string (date-time)	The UTC date and time at which the job started.
status	JobStatus	Status of Edge device job.
type	RemoteSupportType	Remote support type.

JobStatus

Enumeration

Represents the various statuses a job can have throughout its lifecycle.

Value	Description
NotSpecified	The job status has not been specified.
ValidationInProgress	The job is currently undergoing validation.
ValidationSuccess	The job has successfully passed validation.
ValidationFailed	The job has failed validation.
DeploymentInProgress	The job's deployment is currently in progress.
DeploymentFailed	The job's deployment has failed.
DeploymentSuccess	The job has been successfully deployed.
Succeeded	The job has succeeded.
Failed	The job has failed.
Canceled	The job has been canceled.
Paused	The job is paused.
Scheduled	The job is scheduled to run.

LogCollectionJobSession

Object

Represents a session for collecting logs from an edge device.

Name	Type	Description
correlationId	string	A unique identifier for correlating this log collection session with other operations or sessions.
endTime	string	The timestamp when log collection ended, in ISO 8601 format.
logSize	integer (int32)	The size of the collected logs in bytes.
startTime	string	The timestamp when log collection started, in ISO 8601 format.
status	DeviceLogCollectionStatus	The status of the log collection session.
timeCollected	string	The total time logs were collected for, in ISO 8601 duration format.

LogCollectionReportedProperties

Object

Represents the reported properties of a log collection job.

Name	Type	Description
deploymentStatus	EceActionStatus	Deployment status of job.
logCollectionSessionDetails	LogCollectionJobSession[]	Details of the log collection session.
percentComplete	integer (int32)	The percentage of the job that is complete.
validationStatus	EceActionStatus	Validation status of job.

ProvisioningState

Enumeration

The provisioning state of a resource.

Value	Description
Succeeded	Resource has been created.
Failed	Resource creation failed.
Canceled	Resource creation was canceled.
NotSpecified	The resource provision state is not specified
Provisioning	The resource is being provisioned
Updating	The resource is updating
Deleting	The resource is being deleted
Accepted	The resource create request has been accepted

RemoteSupportAccessLevel

Enumeration

Defines the level of remote support access granted.

Value	Description
None	No remote support access is granted.
Diagnostics	Access is limited to diagnostics information only.
DiagnosticsAndRepair	Access includes diagnostics information and the ability to perform repairs.

RemoteSupportJobNodeSettings

Object

Represents the settings of a remote support node.

Name	Type	Description
connectionErrorMessage	string	The error message, if any, from the last connection attempt.
connectionStatus	string	The current connection status of the remote support session.
createdAt	string (date-time)	The timestamp when the node settings were created, in UTC.
state	string	The state of the remote support node.
updatedAt	string (date-time)	The timestamp when the node settings were last updated, in UTC.

RemoteSupportJobReportedProperties

Object

Represents the reported properties of a remote support job.

Name	Type	Description
deploymentStatus	EceActionStatus	Deployment status of job.
nodeSettings	RemoteSupportJobNodeSettings	Optional settings for configuring the node for remote support.
percentComplete	integer (int32)	The percentage of the job that is complete.
sessionDetails	RemoteSupportSession[]	Details of the remote support session.
validationStatus	EceActionStatus	Validation status of job.

RemoteSupportSession

Object

Represents a remote support session.

Name	Type	Description
accessLevel	RemoteSupportAccessLevel	The level of access granted during the remote support session.
sessionEndTime	string (date-time)	The end time of the remote support session, in UTC.
sessionId	string	Unique session Id.
sessionStartTime	string (date-time)	The start time of the remote support session, in UTC.
transcriptLocation	string	The location where the session transcript is stored.

RemoteSupportType

Enumeration

Defines the type of remote support action to be performed on an edge device.

Value	Description
Enable	Enables remote support for the edge device.
Revoke	Revokes previously granted remote support access for the edge device.

systemData

Object

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string (date-time)	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string (date-time)	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.

Share via

Edge Device Jobs - Get

URI Parameters

Responses

Security

azure_auth

Scopes

Examples

EdgeDeviceJobs_Get_RemoteSupport

Sample request

Sample response

Definitions

createdByType

DeploymentMode

DeploymentStep

DeviceLogCollectionStatus

EceActionStatus

EdgeDeviceKind

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

HciCollectLogJobProperties

HciEdgeDeviceJob

HciEdgeDeviceJobType

HciRemoteSupportJobProperties

JobStatus

LogCollectionJobSession

LogCollectionReportedProperties

ProvisioningState

RemoteSupportAccessLevel

RemoteSupportJobNodeSettings

RemoteSupportJobReportedProperties

RemoteSupportSession

RemoteSupportType

systemData