Edge Device Jobs - Get

Služba:: Azure Stack HCI

Verze rozhraní API:: 2024-09-01-preview

Získání úlohy EdgeDeviceJob

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
edgeDeviceName	path	True	string pattern: ^[a-zA-Z0-9-]{3,24}$	Název EdgeDevice
jobsName	path	True	string pattern: ^[a-zA-Z0-9-]{3,24}$	Název úlohy EdgeDevice
resourceUri	path	True	string	Plně kvalifikovaný identifikátor Azure Resource Manageru prostředku.
api-version	query	True	string minLength: 1	Verze rozhraní API, která se má použít pro tuto operaci.

Odpovědi

Name	Typ	Description
200 OK	EdgeDeviceJob: HciEdgeDeviceJob	Operace Azure byla úspěšně dokončena.
Other Status Codes	ErrorResponse	Neočekávaná chybová odpověď

Zabezpečení

azure_auth

Tok OAuth2 v Azure Active Directory

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

EdgeDeviceJobs_Get_RemoteSupport

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:: 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"
  }
}

Definice

Name	Description
createdByType	Typ identity, která prostředek vytvořila.
DeploymentMode	Režim nasazení pro aktivaci úlohy
DeploymentStep	Krok clusteru AzureStackHCI
DeviceLogCollectionStatus	Představuje stav operace shromažďování protokolů.
EceActionStatus	Stav nasazení akčního plánu ECE pro cluster AzureStackHCI
EdgeDeviceKind	Druh hraničního zařízení.
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorDetail	Podrobnosti o chybě.
ErrorResponse	Chybová odpověď
HciCollectLogJobProperties	Představuje vlastnosti úlohy protokolu shromažďování HCI.
HciEdgeDeviceJob	Úloha hraničního zařízení pro řešení Azure Stack HCI
HciEdgeDeviceJobType	Podporovaný typ úlohy.
HciRemoteSupportJobProperties	Představuje vlastnosti úlohy vzdálené podpory pro HCI.
JobStatus	Představuje různé stavy, které může úloha mít v průběhu životního cyklu.
LogCollectionJobSession	Představuje relaci pro shromažďování protokolů z hraničního zařízení.
LogCollectionReportedProperties	Představuje ohlášené vlastnosti úlohy shromažďování protokolů.
ProvisioningState	Stav zřizování prostředku.
RemoteSupportAccessLevel	Definuje úroveň uděleného vzdáleného přístupu podpory.
RemoteSupportJobNodeSettings	Představuje nastavení uzlu vzdálené podpory.
RemoteSupportJobReportedProperties	Představuje ohlášené vlastnosti úlohy vzdálené podpory.
RemoteSupportSession	Představuje relaci vzdálené podpory.
RemoteSupportType	Definuje typ akce vzdálené podpory, která se má provést na hraničním zařízení.
systemData	Metadata týkající se vytvoření a poslední změny prostředku.

createdByType

Výčet

Typ identity, která prostředek vytvořila.

Hodnota	Description
User
Application
ManagedIdentity
Key

DeploymentMode

Výčet

Režim nasazení pro aktivaci úlohy

Hodnota	Description
Validate	Ověřte nasazení akce ECE pro cluster.
Deploy	Nasazení akce ECE pro cluster

DeploymentStep

Objekt

Krok clusteru AzureStackHCI

Name	Typ	Description
description	string	Popis kroku
endTimeUtc	string	Koncový čas kroku.
exception	string[]	Seznam výjimek v nasazení clusteru AzureStackHCI
fullStepIndex	string	FullStepIndex kroku.
name	string	Název kroku
startTimeUtc	string	Počáteční čas kroku
status	string	Stav kroku Povolené hodnoty jsou Error, Success, InProgress.
steps	DeploymentStep[]	Seznam vnořených kroků nasazení clusteru AzureStackHCI

DeviceLogCollectionStatus

Výčet

Představuje stav operace shromažďování protokolů.

Hodnota	Description
NotStarted	Operace shromažďování protokolů nebyla inicializována.
Running	Označuje, že je aktuálně spuštěná operace shromažďování protokolů.
Failed	Označuje, že operace shromažďování protokolů selhala.
Succeeded	Označuje, že operace shromažďování protokolů byla úspěšně dokončena.
Canceled	Označuje, že operace shromažďování protokolů byla úspěšně dokončena.

EceActionStatus

Objekt

Stav nasazení akčního plánu ECE pro cluster AzureStackHCI

Name	Typ	Description
status	string	Stav nasazení clusteru AzureStackHCI akce ECE
steps	DeploymentStep[]	Seznam kroků nasazení clusteru AzureStackHCI

EdgeDeviceKind

Výčet

Druh hraničního zařízení.

Hodnota	Description
HCI	Hraniční zařízení s podporou arc s operačním systémem HCI

ErrorAdditionalInfo

Objekt

Další informace o chybě správy prostředků

Name	Typ	Description
info	object	Další informace.
type	string	Další typ informací.

ErrorDetail

Objekt

Podrobnosti o chybě.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Další informace o chybě.
code	string	Kód chyby.
details	ErrorDetail[]	Podrobnosti o chybě.
message	string	Chybová zpráva.
target	string	Cíl chyby.

ErrorResponse

Objekt

Chybová odpověď

Name	Typ	Description
error	ErrorDetail	Objekt chyby.

HciCollectLogJobProperties

Objekt

Představuje vlastnosti úlohy protokolu shromažďování HCI.

Name	Typ	Description
deploymentMode	DeploymentMode	Režim nasazení pro aktivaci úlohy
endTimeUtc	string (date-time)	Datum a čas UTC, kdy se úloha dokončila.
fromDate	string (date-time)	Od data pro shromažďování protokolů.
jobId	string	Jedinečné, neměnné ID úlohy
jobType	string: CollectLog	Typ úlohy pro podporu polymorfního prostředku
lastLogGenerated	string (date-time)	Datum pro shromažďování protokolů.
provisioningState	ProvisioningState	Stav zřizování úloh
reportedProperties	LogCollectionReportedProperties	Hlášené vlastnosti úlohy shromažďování protokolů
startTimeUtc	string (date-time)	Datum a čas UTC, kdy byla úloha spuštěna.
status	JobStatus	Stav úlohy zařízení Edge
toDate	string (date-time)	Datum pro shromažďování protokolů.

HciEdgeDeviceJob

Objekt

Úloha hraničního zařízení pro řešení Azure Stack HCI

Name	Typ	Default value	Description
id	string (arm-id)		Plně kvalifikované ID prostředku pro prostředek. Například /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
kind	string: HCI	HCI	Typ řešení Edge pro podporu polymorfního prostředku
name	string		Název prostředku
properties	HciEdgeDeviceJobProperties: HciCollectLogJobProperties HciRemoteSupportJobProperties		Vlastnosti úlohy zařízení HCI Edge
systemData	systemData		Metadata Azure Resource Manageru obsahující informace createdBy a modifiedBy
type	string		Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts

HciEdgeDeviceJobType

Výčet

Podporovaný typ úlohy.

Hodnota	Description
CollectLog	Úloha shromažďování protokolů ze zařízení
RemoteSupport	Úloha poskytující vzdálenou podporu zařízení

HciRemoteSupportJobProperties

Objekt

Představuje vlastnosti úlohy vzdálené podpory pro HCI.

Name	Typ	Description
accessLevel	RemoteSupportAccessLevel	Úroveň vzdálené podpory přístupu.
deploymentMode	DeploymentMode	Režim nasazení pro aktivaci úlohy
endTimeUtc	string (date-time)	Datum a čas UTC, kdy se úloha dokončila.
expirationTimestamp	string (date-time)	Vzdálená podpora časového razítka vypršení platnosti
jobId	string	Jedinečné, neměnné ID úlohy
jobType	string: RemoteSupport	Typ úlohy pro podporu polymorfního prostředku
provisioningState	ProvisioningState	Stav zřizování úloh
reportedProperties	RemoteSupportJobReportedProperties	Hlášené vlastnosti úlohy shromažďování protokolů
startTimeUtc	string (date-time)	Datum a čas UTC, kdy byla úloha spuštěna.
status	JobStatus	Stav úlohy zařízení Edge
type	RemoteSupportType	Typ vzdálené podpory.

JobStatus

Výčet

Představuje různé stavy, které může úloha mít v průběhu životního cyklu.

Hodnota	Description
NotSpecified	Stav úlohy nebyl zadán.
ValidationInProgress	Úloha právě prochází ověřením.
ValidationSuccess	Úloha úspěšně prošla ověřením.
ValidationFailed	Ověření úlohy se nezdařilo.
DeploymentInProgress	Aktuálně probíhá nasazení úlohy.
DeploymentFailed	Nasazení úlohy se nezdařilo.
DeploymentSuccess	Úloha byla úspěšně nasazena.
Succeeded	Úloha byla úspěšná.
Failed	Úloha se nezdařila.
Canceled	Úloha byla zrušena.
Paused	Úloha je pozastavená.
Scheduled	Úloha je naplánovaná ke spuštění.

LogCollectionJobSession

Objekt

Představuje relaci pro shromažďování protokolů z hraničního zařízení.

Name	Typ	Description
correlationId	string	Jedinečný identifikátor pro korelaci této relace shromažďování protokolů s jinými operacemi nebo relacemi.
endTime	string	Časové razítko po ukončení shromažďování protokolů ve formátu ISO 8601.
logSize	integer (int32)	Velikost shromážděných protokolů v bajtech.
startTime	string	Časové razítko při spuštění shromažďování protokolů ve formátu ISO 8601.
status	DeviceLogCollectionStatus	Stav relace shromažďování protokolů.
timeCollected	string	Celkové časové protokoly byly shromážděny pro formát doby trvání ISO 8601.

LogCollectionReportedProperties

Objekt

Představuje ohlášené vlastnosti úlohy shromažďování protokolů.

Name	Typ	Description
deploymentStatus	EceActionStatus	Stav nasazení úlohy
logCollectionSessionDetails	LogCollectionJobSession[]	Podrobnosti o relaci shromažďování protokolů
percentComplete	integer (int32)	Procento dokončené úlohy.
validationStatus	EceActionStatus	Stav ověření úlohy

ProvisioningState

Výčet

Stav zřizování prostředku.

Hodnota	Description
Succeeded	Prostředek byl vytvořen.
Failed	Vytvoření prostředku se nezdařilo.
Canceled	Vytvoření prostředku bylo zrušeno.
NotSpecified	Stav zřizování prostředků není zadaný.
Provisioning	Prostředek se zřizuje.
Updating	Prostředek se aktualizuje.
Deleting	Prostředek se odstraňuje.
Accepted	Žádost o vytvoření prostředku byla přijata.

RemoteSupportAccessLevel

Výčet

Definuje úroveň uděleného vzdáleného přístupu podpory.

Hodnota	Description
None	Není udělen přístup ke vzdálené podpoře.
Diagnostics	Přístup je omezen pouze na diagnostické informace.
DiagnosticsAndRepair	Access obsahuje diagnostické informace a schopnost provádět opravy.

RemoteSupportJobNodeSettings

Objekt

Představuje nastavení uzlu vzdálené podpory.

Name	Typ	Description
connectionErrorMessage	string	Chybová zpráva, pokud existuje, od posledního pokusu o připojení.
connectionStatus	string	Aktuální stav připojení relace vzdálené podpory.
createdAt	string (date-time)	Časové razítko vytvoření nastavení uzlu v UTC.
state	string	Stav vzdáleného uzlu podpory
updatedAt	string (date-time)	Časové razítko poslední aktualizace nastavení uzlu v UTC.

RemoteSupportJobReportedProperties

Objekt

Představuje ohlášené vlastnosti úlohy vzdálené podpory.

Name	Typ	Description
deploymentStatus	EceActionStatus	Stav nasazení úlohy
nodeSettings	RemoteSupportJobNodeSettings	Volitelná nastavení pro konfiguraci uzlu pro vzdálenou podporu.
percentComplete	integer (int32)	Procento dokončené úlohy.
sessionDetails	RemoteSupportSession[]	Podrobnosti o relaci vzdálené podpory
validationStatus	EceActionStatus	Stav ověření úlohy

RemoteSupportSession

Objekt

Představuje relaci vzdálené podpory.

Name	Typ	Description
accessLevel	RemoteSupportAccessLevel	Úroveň přístupu udělená během relace vzdálené podpory.
sessionEndTime	string (date-time)	Koncový čas relace vzdálené podpory v UTC.
sessionId	string	Jedinečné ID relace.
sessionStartTime	string (date-time)	Čas zahájení relace vzdálené podpory v UTC.
transcriptLocation	string	Umístění, kde je uložený přepis relace.

RemoteSupportType

Výčet

Definuje typ akce vzdálené podpory, která se má provést na hraničním zařízení.

Hodnota	Description
Enable	Povolí vzdálenou podporu hraničního zařízení.
Revoke	Odvolá dříve udělený vzdálený přístup k podpoře hraničního zařízení.

systemData

Objekt

Metadata týkající se vytvoření a poslední změny prostředku.

Name	Typ	Description
createdAt	string (date-time)	Časové razítko vytvoření prostředku (UTC).
createdBy	string	Identita, která prostředek vytvořila.
createdByType	createdByType	Typ identity, která prostředek vytvořila.
lastModifiedAt	string (date-time)	Časové razítko poslední změny zdroje (UTC)
lastModifiedBy	string	Identita, která naposledy změnila prostředek.
lastModifiedByType	createdByType	Typ identity, která naposledy změnila prostředek.

Sdílet prostřednictvím

Edge Device Jobs - Get

Parametry identifikátoru URI

Odpovědi

Zabezpečení

azure_auth

Rozsahy

Příklady

EdgeDeviceJobs_Get_RemoteSupport

Ukázkový požadavek

Ukázková odpověď

Definice

createdByType

DeploymentMode

DeploymentStep

DeviceLogCollectionStatus

EceActionStatus

EdgeDeviceKind

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

HciCollectLogJobProperties

HciEdgeDeviceJob

HciEdgeDeviceJobType

HciRemoteSupportJobProperties

JobStatus

LogCollectionJobSession

LogCollectionReportedProperties

ProvisioningState

RemoteSupportAccessLevel

RemoteSupportJobNodeSettings

RemoteSupportJobReportedProperties

RemoteSupportSession

RemoteSupportType

systemData