Edge Device Jobs - Get

Serviço:

Azure Stack HCI

Versão da API:

2024-09-01-preview

Obter um EdgeDeviceJob

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
edgeDeviceName	path	True	string pattern: ^[a-zA-Z0-9-]{3,24}$	O nome do EdgeDevice
jobsName	path	True	string pattern: ^[a-zA-Z0-9-]{3,24}$	Nome do trabalho do EdgeDevice
resourceUri	path	True	string	O identificador totalmente qualificado do Azure Resource Manager do recurso.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.

Respostas

Nome	Tipo	Description
200 OK	EdgeDeviceJob: HciEdgeDeviceJob	A operação do Azure foi concluída com êxito.
Other Status Codes	ErrorResponse	Uma resposta de erro inesperada.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

EdgeDeviceJobs_Get_RemoteSupport

Solicitação de exemplo

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

Resposta de exemplo

Código de status:

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

Definições

Nome	Description
createdByType	O tipo de identidade que criou o recurso.
DeploymentMode	Modo de implantação para disparar o trabalho.
DeploymentStep	A etapa do cluster AzureStackHCI.
DeviceLogCollectionStatus	Representa o status de uma operação de coleta de logs.
EceActionStatus	O status de implantação do plano de ação do ECE para o cluster AzureStackHCI.
EdgeDeviceKind	Tipo de dispositivo de borda.
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
HciCollectLogJobProperties	Representa as propriedades de um trabalho de Log de Coleta de HCI.
HciEdgeDeviceJob	Trabalho de dispositivo de borda para a solução Azure Stack HCI.
HciEdgeDeviceJobType	Tipo de trabalho com suporte.
HciRemoteSupportJobProperties	Representa as propriedades de um trabalho de suporte remoto para HCI.
JobStatus	Representa os vários status que um trabalho pode ter ao longo de seu ciclo de vida.
LogCollectionJobSession	Representa uma sessão para coletar logs de um dispositivo de borda.
LogCollectionReportedProperties	Representa as propriedades relatadas de um trabalho de coleção de logs.
ProvisioningState	O estado de provisionamento de um recurso.
RemoteSupportAccessLevel	Define o nível de acesso de suporte remoto concedido.
RemoteSupportJobNodeSettings	Representa as configurações de um nó de suporte remoto.
RemoteSupportJobReportedProperties	Representa as propriedades relatadas de um trabalho de suporte remoto.
RemoteSupportSession	Representa uma sessão de suporte remoto.
RemoteSupportType	Define o tipo de ação de suporte remoto a ser executada em um dispositivo de borda.
systemData	Metadados relativos à criação e última modificação do recurso.

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Description
User
Application
ManagedIdentity
Key

DeploymentMode

Enumeração

Modo de implantação para disparar o trabalho.

Valor	Description
Validate	Validar a implantação de ação do ECE para um cluster.
Deploy	Implantar a implantação de ação do ECE para um cluster.

DeploymentStep

Objeto

A etapa do cluster AzureStackHCI.

Nome	Tipo	Description
description	string	Descrição da etapa.
endTimeUtc	string	Hora de término da etapa.
exception	string[]	Lista de exceções na Implantação de Cluster do AzureStackHCI.
fullStepIndex	string	FullStepIndex da etapa.
name	string	Nome da etapa.
startTimeUtc	string	Hora de início da etapa.
status	string	Status da etapa. Os valores permitidos são 'Error', 'Success', 'InProgress'
steps	DeploymentStep[]	Lista de etapas aninhadas da Implantação de Cluster do AzureStackHCI.

DeviceLogCollectionStatus

Enumeração

Representa o status de uma operação de coleta de logs.

Valor	Description
NotStarted	A operação de coleta de logs não foi iniciada.
Running	Indica que a operação de coleta de logs está em execução no momento.
Failed	Indica que a operação de coleta de logs falhou.
Succeeded	Indica que a operação de coleta de logs foi concluída com êxito.
Canceled	Indica que a operação de coleta de logs foi concluída com êxito.

EceActionStatus

Objeto

O status de implantação do plano de ação do ECE para o cluster AzureStackHCI.

Nome	Tipo	Description
status	string	Status da implantação de cluster do AzureStackHCI de ação do ECE.
steps	DeploymentStep[]	Lista de etapas da Implantação de Cluster do AzureStackHCI.

EdgeDeviceKind

Enumeração

Tipo de dispositivo de borda.

Valor	Description
HCI	Dispositivo de borda habilitado para Arc com sistema operacional HCI.

ErrorAdditionalInfo

Objeto

As informações adicionais do erro de gerenciamento de recursos.

Nome	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

Objeto

O detalhe do erro.

Nome	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Objeto

Resposta de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

HciCollectLogJobProperties

Objeto

Representa as propriedades de um trabalho de Log de Coleta de HCI.

Nome	Tipo	Description
deploymentMode	DeploymentMode	Modo de implantação para disparar o trabalho.
endTimeUtc	string (date-time)	A data e a hora UTC em que o trabalho foi concluído.
fromDate	string (date-time)	A partir da data da coleção de logs.
jobId	string	ID de trabalho exclusiva e imutável.
jobType	string: CollectLog	Tipo de trabalho para dar suporte ao recurso polimórfico.
lastLogGenerated	string (date-time)	Até a data da coleção de logs.
provisioningState	ProvisioningState	Estado de provisionamento de trabalho
reportedProperties	LogCollectionReportedProperties	propriedades relatadas do trabalho de coleta de logs.
startTimeUtc	string (date-time)	A data e a hora UTC em que o trabalho foi iniciado.
status	JobStatus	Status do trabalho do dispositivo edge.
toDate	string (date-time)	Até a data da coleção de logs.

HciEdgeDeviceJob

Objeto

Trabalho de dispositivo de borda para a solução Azure Stack HCI.

Nome	Tipo	Valor padrão	Description
id	string (arm-id)		ID de recurso totalmente qualificada para o recurso. Por exemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
kind	string: HCI	HCI	Tipo de solução de borda para dar suporte ao recurso polimórfico.
name	string		O nome do recurso
properties	HciEdgeDeviceJobProperties: HciCollectLogJobProperties HciRemoteSupportJobProperties		Propriedades do trabalho do dispositivo HCI Edge
systemData	systemData		Metadados do Azure Resource Manager que contêm informações createdBy e modifiedBy.
type	string		O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

HciEdgeDeviceJobType

Enumeração

Tipo de trabalho com suporte.

Valor	Description
CollectLog	Trabalho para coletar logs do dispositivo.
RemoteSupport	Trabalho para fornecer suporte remoto ao dispositivo.

HciRemoteSupportJobProperties

Objeto

Representa as propriedades de um trabalho de suporte remoto para HCI.

Nome	Tipo	Description
accessLevel	RemoteSupportAccessLevel	Nível de acesso de suporte remoto.
deploymentMode	DeploymentMode	Modo de implantação para disparar o trabalho.
endTimeUtc	string (date-time)	A data e a hora UTC em que o trabalho foi concluído.
expirationTimestamp	string (date-time)	Carimbo de data/hora de expiração de suporte remoto.
jobId	string	ID de trabalho exclusiva e imutável.
jobType	string: RemoteSupport	Tipo de trabalho para dar suporte ao recurso polimórfico.
provisioningState	ProvisioningState	Estado de provisionamento de trabalho
reportedProperties	RemoteSupportJobReportedProperties	propriedades relatadas do trabalho de coleta de logs.
startTimeUtc	string (date-time)	A data e a hora UTC em que o trabalho foi iniciado.
status	JobStatus	Status do trabalho do dispositivo edge.
type	RemoteSupportType	Tipo de suporte remoto.

JobStatus

Enumeração

Representa os vários status que um trabalho pode ter ao longo de seu ciclo de vida.

Valor	Description
NotSpecified	O status do trabalho não foi especificado.
ValidationInProgress	No momento, o trabalho está em validação.
ValidationSuccess	O trabalho passou com êxito na validação.
ValidationFailed	O trabalho falhou na validação.
DeploymentInProgress	A implantação do trabalho está em andamento no momento.
DeploymentFailed	A implantação do trabalho falhou.
DeploymentSuccess	O trabalho foi implantado com êxito.
Succeeded	O trabalho foi bem-sucedido.
Failed	O trabalho falhou.
Canceled	O trabalho foi cancelado.
Paused	O trabalho está em pausa.
Scheduled	O trabalho está agendado para ser executado.

LogCollectionJobSession

Objeto

Representa uma sessão para coletar logs de um dispositivo de borda.

Nome	Tipo	Description
correlationId	string	Um identificador exclusivo para correlacionar essa sessão de coleta de logs com outras operações ou sessões.
endTime	string	O carimbo de data/hora quando a coleção de logs terminou, no formato ISO 8601.
logSize	integer (int32)	O tamanho dos logs coletados em bytes.
startTime	string	O carimbo de data/hora quando a coleção de logs foi iniciada, no formato ISO 8601.
status	DeviceLogCollectionStatus	O status da sessão de coleta de logs.
timeCollected	string	Os logs de tempo total foram coletados para, no formato de duração ISO 8601.

LogCollectionReportedProperties

Objeto

Representa as propriedades relatadas de um trabalho de coleção de logs.

Nome	Tipo	Description
deploymentStatus	EceActionStatus	Status de implantação do trabalho.
logCollectionSessionDetails	LogCollectionJobSession[]	Detalhes da sessão de coleta de logs.
percentComplete	integer (int32)	A porcentagem do trabalho que está concluído.
validationStatus	EceActionStatus	Status de validação do trabalho.

ProvisioningState

Enumeração

O estado de provisionamento de um recurso.

Valor	Description
Succeeded	O recurso foi criado.
Failed	Falha na criação de recursos.
Canceled	A criação de recursos foi cancelada.
NotSpecified	O estado de provisionamento de recursos não é especificado
Provisioning	O recurso está sendo provisionado
Updating	O recurso está sendo atualizado
Deleting	O recurso está sendo excluído
Accepted	A solicitação de criação de recurso foi aceita

RemoteSupportAccessLevel

Enumeração

Define o nível de acesso de suporte remoto concedido.

Valor	Description
None	Nenhum acesso de suporte remoto é concedido.
Diagnostics	O acesso é limitado apenas às informações de diagnóstico.
DiagnosticsAndRepair	O acesso inclui informações de diagnóstico e a capacidade de executar reparos.

RemoteSupportJobNodeSettings

Objeto

Representa as configurações de um nó de suporte remoto.

Nome	Tipo	Description
connectionErrorMessage	string	A mensagem de erro, se houver, da última tentativa de conexão.
connectionStatus	string	O status da conexão atual da sessão de suporte remoto.
createdAt	string (date-time)	O carimbo de data/hora quando as configurações do nó foram criadas, em UTC.
state	string	O estado do nó de suporte remoto.
updatedAt	string (date-time)	O carimbo de data/hora em que as configurações do nó foram atualizadas pela última vez, em UTC.

RemoteSupportJobReportedProperties

Objeto

Representa as propriedades relatadas de um trabalho de suporte remoto.

Nome	Tipo	Description
deploymentStatus	EceActionStatus	Status de implantação do trabalho.
nodeSettings	RemoteSupportJobNodeSettings	Configurações opcionais para configurar o nó para suporte remoto.
percentComplete	integer (int32)	A porcentagem do trabalho que está concluído.
sessionDetails	RemoteSupportSession[]	Detalhes da sessão de suporte remoto.
validationStatus	EceActionStatus	Status de validação do trabalho.

RemoteSupportSession

Objeto

Representa uma sessão de suporte remoto.

Nome	Tipo	Description
accessLevel	RemoteSupportAccessLevel	O nível de acesso concedido durante a sessão de suporte remoto.
sessionEndTime	string (date-time)	A hora de término da sessão de suporte remoto, em UTC.
sessionId	string	ID de sessão exclusiva.
sessionStartTime	string (date-time)	A hora de início da sessão de suporte remoto, em UTC.
transcriptLocation	string	O local onde a transcrição da sessão é armazenada.

RemoteSupportType

Enumeração

Define o tipo de ação de suporte remoto a ser executada em um dispositivo de borda.

Valor	Description
Enable	Habilita o suporte remoto para o dispositivo de borda.
Revoke	Revoga o acesso de suporte remoto concedido anteriormente para o dispositivo de borda.

systemData

Objeto

Metadados relativos à criação e última modificação do recurso.

Nome	Tipo	Description
createdAt	string (date-time)	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string (date-time)	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.