Edge Device Jobs - Get

서비스:: Azure Stack HCI

API 버전:: 2024-09-01-preview

EdgeDeviceJob 가져오기

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

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
edgeDeviceName	path	True	string pattern: ^[a-zA-Z0-9-]{3,24}$	EdgeDevice의 이름
jobsName	path	True	string pattern: ^[a-zA-Z0-9-]{3,24}$	EdgeDevice 작업의 이름
resourceUri	path	True	string	리소스의 정규화된 Azure Resource Manager 식별자입니다.
api-version	query	True	string minLength: 1	이 작업에 사용할 API 버전입니다.

응답

Name	형식	Description
200 OK	EdgeDeviceJob: HciEdgeDeviceJob	Azure 작업이 성공적으로 완료되었습니다.
Other Status Codes	ErrorResponse	예기치 않은 오류 응답입니다.

보안

azure_auth

Azure Active Directory OAuth2 흐름.

형식: oauth2
Flow: implicit
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/authorize

범위

Name	Description
user_impersonation	사용자 계정 가장

예제

EdgeDeviceJobs_Get_RemoteSupport

샘플 요청

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

샘플 응답

상태 코드:: 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"
  }
}

정의

Name	Description
createdByType	리소스를 만든 ID의 형식입니다.
DeploymentMode	작업을 트리거하는 배포 모드입니다.
DeploymentStep	AzureStackHCI 클러스터의 단계입니다.
DeviceLogCollectionStatus	로그 수집 작업의 상태를 나타냅니다.
EceActionStatus	AzureStackHCI 클러스터에 대한 ECE 작업 계획 배포 상태입니다.
EdgeDeviceKind	Edge 디바이스 종류입니다.
ErrorAdditionalInfo	리소스 관리 오류 추가 정보입니다.
ErrorDetail	오류 세부 정보입니다.
ErrorResponse	오류 응답
HciCollectLogJobProperties	HCI 로그 수집 작업의 속성을 나타냅니다.
HciEdgeDeviceJob	Azure Stack HCI 솔루션에 대한 에지 디바이스 작업입니다.
HciEdgeDeviceJobType	지원되는 작업 유형입니다.
HciRemoteSupportJobProperties	HCI에 대한 원격 지원 작업의 속성을 나타냅니다.
JobStatus	작업이 수명 주기 동안 가질 수 있는 다양한 상태를 나타냅니다.
LogCollectionJobSession	에지 디바이스에서 로그를 수집하기 위한 세션을 나타냅니다.
LogCollectionReportedProperties	로그 컬렉션 작업의 reported 속성을 나타냅니다.
ProvisioningState	리소스의 프로비전 상태입니다.
RemoteSupportAccessLevel	부여된 원격 지원 액세스 수준을 정의합니다.
RemoteSupportJobNodeSettings	원격 지원 노드의 설정을 나타냅니다.
RemoteSupportJobReportedProperties	원격 지원 작업의 reported 속성을 나타냅니다.
RemoteSupportSession	원격 지원 세션을 나타냅니다.
RemoteSupportType	에지 디바이스에서 수행할 원격 지원 작업의 유형을 정의합니다.
systemData	리소스의 생성 및 마지막 수정과 관련된 메타데이터입니다.

createdByType

열거형

리소스를 만든 ID의 형식입니다.

값	Description
User
Application
ManagedIdentity
Key

DeploymentMode

열거형

작업을 트리거하는 배포 모드입니다.

값	Description
Validate	클러스터에 대한 ECE 작업 배포의 유효성을 검사합니다.
Deploy	클러스터에 대한 ECE 작업 배포를 배포합니다.

DeploymentStep

Object

AzureStackHCI 클러스터의 단계입니다.

Name	형식	Description
description	string	단계에 대한 설명입니다.
endTimeUtc	string	단계 종료 시간입니다.
exception	string[]	AzureStackHCI 클러스터 배포의 예외 목록입니다.
fullStepIndex	string	단계의 FullStepIndex입니다.
name	string	단계의 이름입니다.
startTimeUtc	string	단계의 시작 시간입니다.
status	string	단계의 상태입니다. 허용되는 값은 'Error', 'Success', 'InProgress'입니다.
steps	DeploymentStep[]	AzureStackHCI 클러스터 배포의 중첩된 단계 목록입니다.

DeviceLogCollectionStatus

열거형

로그 수집 작업의 상태를 나타냅니다.

값	Description
NotStarted	로그 수집 작업이 시작되지 않았습니다.
Running	로그 수집 작업이 현재 실행 중임을 나타냅니다.
Failed	로그 수집 작업이 실패했음을 나타냅니다.
Succeeded	로그 수집 작업이 성공적으로 완료되었음을 나타냅니다.
Canceled	로그 수집 작업이 성공적으로 완료되었음을 나타냅니다.

EceActionStatus

Object

AzureStackHCI 클러스터에 대한 ECE 작업 계획 배포 상태입니다.

Name	형식	Description
status	string	ECE 작업 AzureStackHCI 클러스터 배포의 상태입니다.
steps	DeploymentStep[]	AzureStackHCI 클러스터 배포의 단계 목록입니다.

EdgeDeviceKind

열거형

Edge 디바이스 종류입니다.

값	Description
HCI	HCI OS를 사용하는 Arc 지원 에지 디바이스.

ErrorAdditionalInfo

Object

리소스 관리 오류 추가 정보입니다.

Name	형식	Description
info	object	추가 정보입니다.
type	string	추가 정보 유형입니다.

ErrorDetail

Object

오류 세부 정보입니다.

Name	형식	Description
additionalInfo	ErrorAdditionalInfo[]	오류 추가 정보입니다.
code	string	오류 코드입니다.
details	ErrorDetail[]	오류 세부 정보입니다.
message	string	오류 메시지입니다.
target	string	오류 대상입니다.

ErrorResponse

Object

오류 응답

Name	형식	Description
error	ErrorDetail	오류 개체입니다.

HciCollectLogJobProperties

Object

HCI 로그 수집 작업의 속성을 나타냅니다.

Name	형식	Description
deploymentMode	DeploymentMode	작업을 트리거하는 배포 모드입니다.
endTimeUtc	string (date-time)	작업이 완료된 UTC 날짜 및 시간입니다.
fromDate	string (date-time)	로그 수집 날짜부터
jobId	string	고유하고 변경할 수 없는 작업 ID입니다.
jobType	string: CollectLog	다형 리소스를 지원하는 작업 유형입니다.
lastLogGenerated	string (date-time)	로그 수집에 대한 날짜입니다.
provisioningState	ProvisioningState	작업 프로비저닝 상태
reportedProperties	LogCollectionReportedProperties	로그 컬렉션 작업 reported 속성입니다.
startTimeUtc	string (date-time)	작업이 시작된 UTC 날짜 및 시간입니다.
status	JobStatus	Edge 디바이스 작업의 상태입니다.
toDate	string (date-time)	로그 수집에 대한 날짜입니다.

HciEdgeDeviceJob

Object

Azure Stack HCI 솔루션에 대한 에지 디바이스 작업입니다.

Name	형식	Default value	Description
id	string (arm-id)		리소스에 대한 정규화된 리소스 ID입니다. 예: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
kind	string: HCI	HCI	다형 리소스를 지원하는 에지 솔루션 유형입니다.
name	string		리소스의 이름
properties	HciEdgeDeviceJobProperties: HciCollectLogJobProperties HciRemoteSupportJobProperties		HCI Edge 디바이스 작업 속성
systemData	systemData		createdBy 및 modifiedBy 정보가 포함된 Azure Resource Manager 메타데이터입니다.
type	string		리소스의 형식입니다. 예: "Microsoft.Compute/virtualMachines" 또는 "Microsoft.Storage/storageAccounts"

HciEdgeDeviceJobType

열거형

지원되는 작업 유형입니다.

값	Description
CollectLog	디바이스에서 로그를 수집하는 작업입니다.
RemoteSupport	디바이스에 원격 지원을 제공하는 작업입니다.

HciRemoteSupportJobProperties

Object

HCI에 대한 원격 지원 작업의 속성을 나타냅니다.

Name	형식	Description
accessLevel	RemoteSupportAccessLevel	원격 지원 액세스 수준입니다.
deploymentMode	DeploymentMode	작업을 트리거하는 배포 모드입니다.
endTimeUtc	string (date-time)	작업이 완료된 UTC 날짜 및 시간입니다.
expirationTimestamp	string (date-time)	원격 지원 만료 타임스탬프입니다.
jobId	string	고유하고 변경할 수 없는 작업 ID입니다.
jobType	string: RemoteSupport	다형 리소스를 지원하는 작업 유형입니다.
provisioningState	ProvisioningState	작업 프로비저닝 상태
reportedProperties	RemoteSupportJobReportedProperties	로그 컬렉션 작업 reported 속성입니다.
startTimeUtc	string (date-time)	작업이 시작된 UTC 날짜 및 시간입니다.
status	JobStatus	Edge 디바이스 작업의 상태입니다.
type	RemoteSupportType	원격 지원 유형입니다.

JobStatus

열거형

작업이 수명 주기 동안 가질 수 있는 다양한 상태를 나타냅니다.

값	Description
NotSpecified	작업 상태가 지정되지 않았습니다.
ValidationInProgress	작업이 현재 유효성 검사를 진행 중입니다.
ValidationSuccess	작업이 유효성 검사를 성공적으로 통과했습니다.
ValidationFailed	작업이 유효성 검사에 실패했습니다.
DeploymentInProgress	작업의 배포는 현재 진행 중입니다.
DeploymentFailed	작업의 배포가 실패했습니다.
DeploymentSuccess	작업이 성공적으로 배포되었습니다.
Succeeded	작업이 성공했습니다.
Failed	작업이 실패했습니다.
Canceled	작업이 취소되었습니다.
Paused	작업이 일시 중지되었습니다.
Scheduled	작업이 실행되도록 예약되어 있습니다.

LogCollectionJobSession

Object

에지 디바이스에서 로그를 수집하기 위한 세션을 나타냅니다.

Name	형식	Description
correlationId	string	이 로그 수집 세션과 다른 작업 또는 세션의 상관 관계를 지정하기 위한 고유 식별자입니다.
endTime	string	로그 수집이 종료된 타임스탬프(ISO 8601 형식)입니다.
logSize	integer (int32)	수집된 로그의 크기(바이트)입니다.
startTime	string	로그 수집이 시작된 타임스탬프(ISO 8601 형식)입니다.
status	DeviceLogCollectionStatus	로그 수집 세션의 상태입니다.
timeCollected	string	총 시간 로그는 ISO 8601 기간 형식으로 수집되었습니다.

LogCollectionReportedProperties

Object

로그 컬렉션 작업의 reported 속성을 나타냅니다.

Name	형식	Description
deploymentStatus	EceActionStatus	작업의 배포 상태입니다.
logCollectionSessionDetails	LogCollectionJobSession[]	로그 수집 세션의 세부 정보입니다.
percentComplete	integer (int32)	완료된 작업의 백분율입니다.
validationStatus	EceActionStatus	작업의 유효성 검사 상태입니다.

ProvisioningState

열거형

리소스의 프로비전 상태입니다.

값	Description
Succeeded	리소스가 만들어졌습니다.
Failed	리소스를 만들지 못했습니다.
Canceled	리소스 만들기가 취소되었습니다.
NotSpecified	리소스 프로비전 상태가 지정되지 않았습니다.
Provisioning	리소스가 프로비전되고 있습니다.
Updating	리소스가 업데이트되고 있습니다.
Deleting	리소스가 삭제되고 있습니다.
Accepted	리소스 만들기 요청이 수락되었습니다.

RemoteSupportAccessLevel

열거형

부여된 원격 지원 액세스 수준을 정의합니다.

값	Description
None	원격 지원 액세스 권한이 부여되지 않습니다.
Diagnostics	액세스는 진단 정보로만 제한됩니다.
DiagnosticsAndRepair	액세스에는 진단 정보 및 복구를 수행하는 기능이 포함됩니다.

RemoteSupportJobNodeSettings

Object

원격 지원 노드의 설정을 나타냅니다.

Name	형식	Description
connectionErrorMessage	string	마지막 연결 시도에서 발생한 오류 메시지(있는 경우)입니다.
connectionStatus	string	원격 지원 세션의 현재 연결 상태입니다.
createdAt	string (date-time)	노드 설정이 만들어진 타임스탬프(UTC)입니다.
state	string	원격 지원 노드의 상태입니다.
updatedAt	string (date-time)	노드 설정이 마지막으로 업데이트된 타임스탬프(UTC)입니다.

RemoteSupportJobReportedProperties

Object

원격 지원 작업의 reported 속성을 나타냅니다.

Name	형식	Description
deploymentStatus	EceActionStatus	작업의 배포 상태입니다.
nodeSettings	RemoteSupportJobNodeSettings	원격 지원을 위해 노드를 구성하기 위한 선택적 설정입니다.
percentComplete	integer (int32)	완료된 작업의 백분율입니다.
sessionDetails	RemoteSupportSession[]	원격 지원 세션의 세부 정보입니다.
validationStatus	EceActionStatus	작업의 유효성 검사 상태입니다.

RemoteSupportSession

Object

원격 지원 세션을 나타냅니다.

Name	형식	Description
accessLevel	RemoteSupportAccessLevel	원격 지원 세션 중에 부여된 액세스 수준입니다.
sessionEndTime	string (date-time)	원격 지원 세션의 종료 시간(UTC)입니다.
sessionId	string	고유 세션 ID입니다.
sessionStartTime	string (date-time)	원격 지원 세션의 시작 시간(UTC)입니다.
transcriptLocation	string	세션 대본이 저장되는 위치입니다.

RemoteSupportType

열거형

에지 디바이스에서 수행할 원격 지원 작업의 유형을 정의합니다.

값	Description
Enable	에지 디바이스에 대한 원격 지원을 사용하도록 설정합니다.
Revoke	에지 디바이스에 대해 이전에 부여한 원격 지원 액세스 권한을 취소합니다.

systemData

Object

리소스의 생성 및 마지막 수정과 관련된 메타데이터입니다.

Name	형식	Description
createdAt	string (date-time)	리소스 만들기의 타임스탬프(UTC)입니다.
createdBy	string	리소스를 만든 ID입니다.
createdByType	createdByType	리소스를 만든 ID의 형식입니다.
lastModifiedAt	string (date-time)	리소스 마지막 수정의 타임스탬프(UTC)
lastModifiedBy	string	리소스를 마지막으로 수정한 ID입니다.
lastModifiedByType	createdByType	리소스를 마지막으로 수정한 ID의 형식입니다.

다음을 통해 공유

Edge Device Jobs - Get

URI 매개 변수

응답

보안

azure_auth

범위

예제

EdgeDeviceJobs_Get_RemoteSupport

샘플 요청

샘플 응답

정의

createdByType

DeploymentMode

DeploymentStep

DeviceLogCollectionStatus

EceActionStatus

EdgeDeviceKind

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

HciCollectLogJobProperties

HciEdgeDeviceJob

HciEdgeDeviceJobType

HciRemoteSupportJobProperties

JobStatus

LogCollectionJobSession

LogCollectionReportedProperties

ProvisioningState

RemoteSupportAccessLevel

RemoteSupportJobNodeSettings

RemoteSupportJobReportedProperties

RemoteSupportSession

RemoteSupportType

systemData