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

Имя	В	Обязательно	Тип	Описание
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, используемая для этой операции.

Ответы

Имя	Тип	Описание
200 OK	EdgeDeviceJob: HciEdgeDeviceJob	Операция Azure успешно завершена.
Other Status Codes	ErrorResponse	Непредвиденное сообщение об ошибке.

Безопасность

azure_auth

Поток OAuth2 Azure Active Directory.

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
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"
  }
}

Определения

Имя	Описание
createdByType	Тип удостоверения, создавшего ресурс.
DeploymentMode	Режим развертывания для активации задания.
DeploymentStep	Шаг кластера AzureStackHCI.
DeviceLogCollectionStatus	Представляет состояние операции сбора журналов.
EceActionStatus	Состояние развертывания плана действий ДЛЯ кластера AzureStackHCI.
EdgeDeviceKind	Тип пограничного устройства.
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Ответ на ошибку
HciCollectLogJobProperties	Представляет свойства задания журнала сбора HCI.
HciEdgeDeviceJob	Задание пограничного устройства для решения Azure Stack HCI.
HciEdgeDeviceJobType	Поддерживаемый тип задания.
HciRemoteSupportJobProperties	Представляет свойства удаленного задания поддержки для HCI.
JobStatus	Представляет различные состояния задания, которые могут иметь на протяжении всего жизненного цикла.
LogCollectionJobSession	Представляет сеанс для сбора журналов с пограничного устройства.
LogCollectionReportedProperties	Представляет сообщаемые свойства задания сбора журналов.
ProvisioningState	Состояние подготовки ресурса.
RemoteSupportAccessLevel	Определяет уровень предоставленного удаленного доступа к поддержке.
RemoteSupportJobNodeSettings	Представляет параметры удаленного узла поддержки.
RemoteSupportJobReportedProperties	Представляет сообщаемые свойства удаленного задания поддержки.
RemoteSupportSession	Представляет сеанс удаленной поддержки.
RemoteSupportType	Определяет тип действия удаленной поддержки, выполняемого на пограничном устройстве.
systemData	Метаданные, относящиеся к созданию и последнему изменении ресурса.

createdByType

Перечисление

Тип удостоверения, создавшего ресурс.

Значение	Описание
User
Application
ManagedIdentity
Key

DeploymentMode

Перечисление

Режим развертывания для активации задания.

Значение	Описание
Validate	Проверка развертывания действий ВЕО для кластера.
Deploy	Разверните развертывание действий ECE для кластера.

DeploymentStep

Object

Шаг кластера AzureStackHCI.

Имя	Тип	Описание
description	string	Описание шага.
endTimeUtc	string	Время окончания шага.
exception	string[]	Список исключений в развертывании кластера AzureStackHCI.
fullStepIndex	string	FullStepIndex шага.
name	string	Имя шага.
startTimeUtc	string	Время начала шага.
status	string	Состояние шага. Допустимые значения: Error, Success, InProgress
steps	DeploymentStep[]	Список вложенных шагов развертывания кластера AzureStackHCI.

DeviceLogCollectionStatus

Перечисление

Представляет состояние операции сбора журналов.

Значение	Описание
NotStarted	Операция сбора журналов не была инициирована.
Running	Указывает, что в настоящее время выполняется операция сбора журналов.
Failed	Указывает, что операция сбора журналов завершилась сбоем.
Succeeded	Указывает, что операция сбора журналов успешно завершена.
Canceled	Указывает, что операция сбора журналов успешно завершена.

EceActionStatus

Object

Состояние развертывания плана действий ДЛЯ кластера AzureStackHCI.

Имя	Тип	Описание
status	string	Состояние развертывания кластера AzureStackHCI.
steps	DeploymentStep[]	Список шагов развертывания кластера AzureStackHCI.

EdgeDeviceKind

Перечисление

Тип пограничного устройства.

Значение	Описание
HCI	Пограничное устройство с поддержкой Arc с ОС HCI.

ErrorAdditionalInfo

Object

Дополнительные сведения об ошибке управления ресурсами.

Имя	Тип	Описание
info	object	Дополнительные сведения.
type	string	Дополнительный тип сведений.

ErrorDetail

Object

Сведения об ошибке.

Имя	Тип	Описание
additionalInfo	ErrorAdditionalInfo[]	Дополнительные сведения об ошибке.
code	string	Код ошибки.
details	ErrorDetail[]	Сведения об ошибке.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

ErrorResponse

Object

Ответ на ошибку

Имя	Тип	Описание
error	ErrorDetail	Объект ошибки.

HciCollectLogJobProperties

Object

Представляет свойства задания журнала сбора HCI.

Имя	Тип	Описание
deploymentMode	DeploymentMode	Режим развертывания для активации задания.
endTimeUtc	string (date-time)	Дата и время выполнения задания в формате UTC.
fromDate	string (date-time)	Дата сбора журналов.
jobId	string	Уникальный идентификатор неизменяемого задания.
jobType	string: CollectLog	Тип задания для поддержки полиморфного ресурса.
lastLogGenerated	string (date-time)	Дата сбора журналов.
provisioningState	ProvisioningState	Состояние подготовки заданий
reportedProperties	LogCollectionReportedProperties	Сообщаемые свойства задания сбора журналов.
startTimeUtc	string (date-time)	Дата и время начала задания в формате UTC.
status	JobStatus	Состояние задания устройства Edge.
toDate	string (date-time)	Дата сбора журналов.

HciEdgeDeviceJob

Object

Задание пограничного устройства для решения Azure Stack HCI.

Имя	Тип	Default value	Описание
id	string (arm-id)		Полный идентификатор ресурса для ресурса. Например, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
kind	string: HCI	HCI	Тип решения Edge для поддержки полиморфного ресурса.
name	string		Имя ресурса
properties	HciEdgeDeviceJobProperties: HciCollectLogJobProperties HciRemoteSupportJobProperties		Свойства задания устройства HCI Edge
systemData	systemData		Метаданные Azure Resource Manager, содержащие данные createdBy и modifiedBy.
type	string		Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts"

HciEdgeDeviceJobType

Перечисление

Поддерживаемый тип задания.

Значение	Описание
CollectLog	Задание для сбора журналов с устройства.
RemoteSupport	Задание для предоставления удаленной поддержки устройству.

HciRemoteSupportJobProperties

Object

Представляет свойства удаленного задания поддержки для HCI.

Имя	Тип	Описание
accessLevel	RemoteSupportAccessLevel	Уровень доступа к удаленной поддержке.
deploymentMode	DeploymentMode	Режим развертывания для активации задания.
endTimeUtc	string (date-time)	Дата и время выполнения задания в формате UTC.
expirationTimestamp	string (date-time)	Метка времени окончания срока действия удаленной поддержки.
jobId	string	Уникальный идентификатор неизменяемого задания.
jobType	string: RemoteSupport	Тип задания для поддержки полиморфного ресурса.
provisioningState	ProvisioningState	Состояние подготовки заданий
reportedProperties	RemoteSupportJobReportedProperties	Сообщаемые свойства задания сбора журналов.
startTimeUtc	string (date-time)	Дата и время начала задания в формате UTC.
status	JobStatus	Состояние задания устройства Edge.
type	RemoteSupportType	Тип удаленной поддержки.

JobStatus

Перечисление

Представляет различные состояния задания, которые могут иметь на протяжении всего жизненного цикла.

Значение	Описание
NotSpecified	Состояние задания не указано.
ValidationInProgress	Задание в настоящее время проходит проверку.
ValidationSuccess	Задание успешно прошло проверку.
ValidationFailed	Задание завершилось ошибкой проверки.
DeploymentInProgress	Развертывание задания в настоящее время выполняется.
DeploymentFailed	Развертывание задания завершилось сбоем.
DeploymentSuccess	Задание успешно развернуто.
Succeeded	Задание выполнено успешно.
Failed	Задание завершилось сбоем.
Canceled	Задание отменено.
Paused	Задание приостановлено.
Scheduled	Задание планируется запустить.

LogCollectionJobSession

Object

Представляет сеанс для сбора журналов с пограничного устройства.

Имя	Тип	Описание
correlationId	string	Уникальный идентификатор для сопоставления сеанса сбора журналов с другими операциями или сеансами.
endTime	string	Метка времени окончания сбора журналов в формате ISO 8601.
logSize	integer (int32)	Размер собранных журналов в байтах.
startTime	string	Метка времени при запуске сбора журналов в формате ISO 8601.
status	DeviceLogCollectionStatus	Состояние сеанса сбора журналов.
timeCollected	string	Общие журналы времени были собраны в формате длительности ISO 8601.

LogCollectionReportedProperties

Object

Представляет сообщаемые свойства задания сбора журналов.

Имя	Тип	Описание
deploymentStatus	EceActionStatus	Состояние развертывания задания.
logCollectionSessionDetails	LogCollectionJobSession[]	Сведения о сеансе сбора журналов.
percentComplete	integer (int32)	Процент завершенного задания.
validationStatus	EceActionStatus	Состояние проверки задания.

ProvisioningState

Перечисление

Состояние подготовки ресурса.

Значение	Описание
Succeeded	Ресурс создан.
Failed	Не удалось создать ресурс.
Canceled	Создание ресурсов было отменено.
NotSpecified	Состояние подготовки ресурсов не указано
Provisioning	Ресурс подготавливается
Updating	Ресурс обновляется
Deleting	Ресурс удаляется
Accepted	Запрос на создание ресурса был принят

RemoteSupportAccessLevel

Перечисление

Определяет уровень предоставленного удаленного доступа к поддержке.

Значение	Описание
None	Доступ к удаленной поддержке не предоставляется.
Diagnostics	Доступ ограничен только сведениями диагностики.
DiagnosticsAndRepair	Доступ включает сведения о диагностике и возможность выполнения ремонта.

RemoteSupportJobNodeSettings

Object

Представляет параметры удаленного узла поддержки.

Имя	Тип	Описание
connectionErrorMessage	string	Сообщение об ошибке( при наличии) из последней попытки подключения.
connectionStatus	string	Текущее состояние подключения сеанса удаленной поддержки.
createdAt	string (date-time)	Метка времени создания параметров узла в формате UTC.
state	string	Состояние узла удаленной поддержки.
updatedAt	string (date-time)	Метка времени последнего обновления параметров узла в формате UTC.

RemoteSupportJobReportedProperties

Object

Представляет сообщаемые свойства удаленного задания поддержки.

Имя	Тип	Описание
deploymentStatus	EceActionStatus	Состояние развертывания задания.
nodeSettings	RemoteSupportJobNodeSettings	Необязательные параметры настройки узла для удаленной поддержки.
percentComplete	integer (int32)	Процент завершенного задания.
sessionDetails	RemoteSupportSession[]	Сведения о сеансе удаленной поддержки.
validationStatus	EceActionStatus	Состояние проверки задания.

RemoteSupportSession

Object

Представляет сеанс удаленной поддержки.

Имя	Тип	Описание
accessLevel	RemoteSupportAccessLevel	Уровень доступа, предоставленный во время сеанса удаленной поддержки.
sessionEndTime	string (date-time)	Время окончания сеанса удаленной поддержки в формате UTC.
sessionId	string	Уникальный идентификатор сеанса.
sessionStartTime	string (date-time)	Время начала сеанса удаленной поддержки в формате UTC.
transcriptLocation	string	Расположение, в котором хранится расшифровка сеанса.

RemoteSupportType

Перечисление

Определяет тип действия удаленной поддержки, выполняемого на пограничном устройстве.

Значение	Описание
Enable	Обеспечивает удаленную поддержку пограничного устройства.
Revoke	Отменяет ранее предоставленный удаленный доступ к удаленной поддержке для пограничного устройства.

systemData

Object

Метаданные, относящиеся к созданию и последнему изменении ресурса.

Имя	Тип	Описание
createdAt	string (date-time)	Метка времени создания ресурса (UTC).
createdBy	string	Удостоверение, создающее ресурс.
createdByType	createdByType	Тип удостоверения, создавшего ресурс.
lastModifiedAt	string (date-time)	Метка времени последнего изменения ресурса (UTC)
lastModifiedBy	string	Идентификатор, который последний раз изменил ресурс.
lastModifiedByType	createdByType	Тип удостоверения, который последний раз изменил ресурс.

Поделиться через

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