Edge Device Jobs - Get

Usługa:: Azure Stack HCI

Wersja interfejsu API:: 2024-09-01-preview

Pobieranie zadania EdgeDeviceJob

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
edgeDeviceName	path	True	string pattern: ^[a-zA-Z0-9-]{3,24}$	Nazwa urządzenia EdgeDevice
jobsName	path	True	string pattern: ^[a-zA-Z0-9-]{3,24}$	Nazwa zadania EdgeDevice
resourceUri	path	True	string	W pełni kwalifikowany identyfikator zasobu usługi Azure Resource Manager.
api-version	query	True	string minLength: 1	Wersja interfejsu API do użycia dla tej operacji.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	EdgeDeviceJob: HciEdgeDeviceJob	Operacja platformy Azure została ukończona pomyślnie.
Other Status Codes	ErrorResponse	Nieoczekiwana odpowiedź na błąd.

Zabezpieczenia

azure_auth

Przepływ protokołu OAuth2 usługi Azure Active Directory.

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

EdgeDeviceJobs_Get_RemoteSupport

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:: 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"
  }
}

Definicje

Nazwa	Opis
createdByType	Typ tożsamości, która utworzyła zasób.
DeploymentMode	Tryb wdrażania wyzwalający zadanie.
DeploymentStep	Krok klastra AzureStackHCI.
DeviceLogCollectionStatus	Reprezentuje stan operacji zbierania dzienników.
EceActionStatus	Stan wdrożenia planu działania ECE dla klastra AzureStackHCI.
EdgeDeviceKind	Rodzaj urządzenia brzegowego.
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail	Szczegóły błędu.
ErrorResponse	Odpowiedź na błąd
HciCollectLogJobProperties	Reprezentuje właściwości zadania zbierania danych HCI.
HciEdgeDeviceJob	Zadanie urządzenia brzegowego dla rozwiązania Azure Stack HCI.
HciEdgeDeviceJobType	Obsługiwany typ zadania.
HciRemoteSupportJobProperties	Reprezentuje właściwości zadania pomocy technicznej zdalnej dla rozwiązania HCI.
JobStatus	Reprezentuje różne stany, które zadanie może mieć w całym cyklu życia.
LogCollectionJobSession	Reprezentuje sesję zbierania dzienników z urządzenia brzegowego.
LogCollectionReportedProperties	Reprezentuje zgłoszone właściwości zadania zbierania dzienników.
ProvisioningState	Stan aprowizacji zasobu.
RemoteSupportAccessLevel	Definiuje poziom przyznanego dostępu do pomocy zdalnej.
RemoteSupportJobNodeSettings	Reprezentuje ustawienia węzła obsługi zdalnej.
RemoteSupportJobReportedProperties	Reprezentuje zgłoszone właściwości zadania pomocy technicznej zdalnej.
RemoteSupportSession	Reprezentuje sesję pomocy technicznej zdalnej.
RemoteSupportType	Definiuje typ akcji zdalnej pomocy technicznej, która ma być wykonywana na urządzeniu brzegowym.
systemData	Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

createdByType

Wyliczanie

Typ tożsamości, która utworzyła zasób.

Wartość	Opis
User
Application
ManagedIdentity
Key

DeploymentMode

Wyliczanie

Tryb wdrażania wyzwalający zadanie.

Wartość	Opis
Validate	Zweryfikuj wdrożenie akcji ECE dla klastra.
Deploy	Wdrażanie wdrożenia akcji ECE dla klastra.

DeploymentStep

Objekt

Krok klastra AzureStackHCI.

Nazwa	Typ	Opis
description	string	Opis kroku.
endTimeUtc	string	Godzina zakończenia kroku.
exception	string[]	Lista wyjątków we wdrożeniu klastra AzureStackHCI.
fullStepIndex	string	FullStepIndex kroku.
name	string	Nazwa kroku.
startTimeUtc	string	Godzina rozpoczęcia kroku.
status	string	Stan kroku. Dozwolone wartości to "Error", "Success", "InProgress"
steps	DeploymentStep[]	Lista zagnieżdżonych kroków wdrażania klastra AzureStackHCI.

DeviceLogCollectionStatus

Wyliczanie

Reprezentuje stan operacji zbierania dzienników.

Wartość	Opis
NotStarted	Operacja zbierania dzienników nie została zainicjowana.
Running	Wskazuje, że operacja zbierania dzienników jest obecnie uruchomiona.
Failed	Wskazuje, że operacja zbierania dzienników nie powiodła się.
Succeeded	Wskazuje, że operacja zbierania dzienników została ukończona pomyślnie.
Canceled	Wskazuje, że operacja zbierania dzienników została ukończona pomyślnie.

EceActionStatus

Objekt

Stan wdrożenia planu działania ECE dla klastra AzureStackHCI.

Nazwa	Typ	Opis
status	string	Stan akcji ECE Wdrożenie klastra AzureStackHCI.
steps	DeploymentStep[]	Lista kroków wdrażania klastra AzureStackHCI.

EdgeDeviceKind

Wyliczanie

Rodzaj urządzenia brzegowego.

Wartość	Opis
HCI	Urządzenie brzegowe z obsługą usługi Arc z systemem operacyjnym HCI.

ErrorAdditionalInfo

Objekt

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa	Typ	Opis
info	object	Dodatkowe informacje.
type	string	Dodatkowy typ informacji.

ErrorDetail

Objekt

Szczegóły błędu.

Nazwa	Typ	Opis
additionalInfo	ErrorAdditionalInfo[]	Dodatkowe informacje o błędzie.
code	string	Kod błędu.
details	ErrorDetail[]	Szczegóły błędu.
message	string	Komunikat o błędzie.
target	string	Element docelowy błędu.

ErrorResponse

Objekt

Odpowiedź na błąd

Nazwa	Typ	Opis
error	ErrorDetail	Obiekt błędu.

HciCollectLogJobProperties

Objekt

Reprezentuje właściwości zadania zbierania danych HCI.

Nazwa	Typ	Opis
deploymentMode	DeploymentMode	Tryb wdrażania wyzwalający zadanie.
endTimeUtc	string (date-time)	Data i godzina UTC, o której zadanie zostało ukończone.
fromDate	string (date-time)	Od daty zbierania dzienników.
jobId	string	Unikatowy, niezmienny identyfikator zadania.
jobType	string: CollectLog	Typ zadania do obsługi zasobu polimorficznego.
lastLogGenerated	string (date-time)	Do daty zbierania dzienników.
provisioningState	ProvisioningState	Stan aprowizacji zadania
reportedProperties	LogCollectionReportedProperties	zgłoszone właściwości zadania zbierania dzienników.
startTimeUtc	string (date-time)	Data i godzina UTC, o której uruchomiono zadanie.
status	JobStatus	Stan zadania urządzenia edge.
toDate	string (date-time)	Do daty zbierania dzienników.

HciEdgeDeviceJob

Objekt

Zadanie urządzenia brzegowego dla rozwiązania Azure Stack HCI.

Nazwa	Typ	Domyślna wartość	Opis
id	string (arm-id)		W pełni kwalifikowany identyfikator zasobu dla zasobu. Np. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
kind	string: HCI	HCI	Typ rozwiązania edge do obsługi zasobu polimorficznego.
name	string		Nazwa zasobu
properties	HciEdgeDeviceJobProperties: HciCollectLogJobProperties HciRemoteSupportJobProperties		Właściwości zadania urządzenia HCI Edge
systemData	systemData		Metadane usługi Azure Resource Manager zawierające informacje createdBy i modifiedBy.
type	string		Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts"

HciEdgeDeviceJobType

Wyliczanie

Obsługiwany typ zadania.

Wartość	Opis
CollectLog	Zadanie zbierania dzienników z urządzenia.
RemoteSupport	Zadanie zapewnienia zdalnej pomocy technicznej dla urządzenia.

HciRemoteSupportJobProperties

Objekt

Reprezentuje właściwości zadania pomocy technicznej zdalnej dla rozwiązania HCI.

Nazwa	Typ	Opis
accessLevel	RemoteSupportAccessLevel	Poziom dostępu do pomocy technicznej zdalnej.
deploymentMode	DeploymentMode	Tryb wdrażania wyzwalający zadanie.
endTimeUtc	string (date-time)	Data i godzina UTC, o której zadanie zostało ukończone.
expirationTimestamp	string (date-time)	Sygnatura czasowa wygaśnięcia pomocy technicznej zdalnej.
jobId	string	Unikatowy, niezmienny identyfikator zadania.
jobType	string: RemoteSupport	Typ zadania do obsługi zasobu polimorficznego.
provisioningState	ProvisioningState	Stan aprowizacji zadania
reportedProperties	RemoteSupportJobReportedProperties	zgłoszone właściwości zadania zbierania dzienników.
startTimeUtc	string (date-time)	Data i godzina UTC, o której uruchomiono zadanie.
status	JobStatus	Stan zadania urządzenia edge.
type	RemoteSupportType	Typ obsługi zdalnej.

JobStatus

Wyliczanie

Reprezentuje różne stany, które zadanie może mieć w całym cyklu życia.

Wartość	Opis
NotSpecified	Nie określono stanu zadania.
ValidationInProgress	Zadanie jest obecnie w trakcie walidacji.
ValidationSuccess	Zadanie pomyślnie zakończyło się pomyślnie walidacją.
ValidationFailed	Sprawdzanie poprawności zadania nie powiodło się.
DeploymentInProgress	Wdrożenie zadania jest obecnie w toku.
DeploymentFailed	Wdrożenie zadania nie powiodło się.
DeploymentSuccess	Zadanie zostało pomyślnie wdrożone.
Succeeded	Zadanie zakończyło się pomyślnie.
Failed	Zadanie nie powiodło się.
Canceled	Zadanie zostało anulowane.
Paused	Zadanie jest wstrzymane.
Scheduled	Zadanie jest zaplanowane do uruchomienia.

LogCollectionJobSession

Objekt

Reprezentuje sesję zbierania dzienników z urządzenia brzegowego.

Nazwa	Typ	Opis
correlationId	string	Unikatowy identyfikator korelujący tę sesję zbierania dzienników z innymi operacjami lub sesjami.
endTime	string	Sygnatura czasowa zakończenia zbierania dzienników w formacie ISO 8601.
logSize	integer (int32)	Rozmiar zebranych dzienników w bajtach.
startTime	string	Sygnatura czasowa rozpoczęcia zbierania dzienników w formacie ISO 8601.
status	DeviceLogCollectionStatus	Stan sesji zbierania dzienników.
timeCollected	string	Zebrano łączny czas zbierania dzienników w formacie czasu trwania ISO 8601.

LogCollectionReportedProperties

Objekt

Reprezentuje zgłoszone właściwości zadania zbierania dzienników.

Nazwa	Typ	Opis
deploymentStatus	EceActionStatus	Stan wdrożenia zadania.
logCollectionSessionDetails	LogCollectionJobSession[]	Szczegóły sesji zbierania dzienników.
percentComplete	integer (int32)	Procent ukończonego zadania.
validationStatus	EceActionStatus	Stan weryfikacji zadania.

ProvisioningState

Wyliczanie

Stan aprowizacji zasobu.

Wartość	Opis
Succeeded	Zasób został utworzony.
Failed	Tworzenie zasobu nie powiodło się.
Canceled	Tworzenie zasobów zostało anulowane.
NotSpecified	Stan aprowizacji zasobu nie jest określony
Provisioning	Zasób jest aprowizowany
Updating	Zasób jest aktualizowany
Deleting	Zasób jest usuwany
Accepted	Żądanie utworzenia zasobu zostało zaakceptowane

RemoteSupportAccessLevel

Wyliczanie

Definiuje poziom przyznanego dostępu do pomocy zdalnej.

Wartość	Opis
None	Nie udzielono dostępu do pomocy zdalnej.
Diagnostics	Dostęp jest ograniczony tylko do informacji diagnostycznych.
DiagnosticsAndRepair	Dostęp obejmuje informacje diagnostyczne i możliwość przeprowadzania napraw.

RemoteSupportJobNodeSettings

Objekt

Reprezentuje ustawienia węzła obsługi zdalnej.

Nazwa	Typ	Opis
connectionErrorMessage	string	Komunikat o błędzie, jeśli istnieje, z ostatniej próby połączenia.
connectionStatus	string	Bieżący stan połączenia sesji zdalnej pomocy technicznej.
createdAt	string (date-time)	Sygnatura czasowa utworzenia ustawień węzła w formacie UTC.
state	string	Stan węzła obsługi zdalnej.
updatedAt	string (date-time)	Sygnatura czasowa ostatniej aktualizacji ustawień węzła w formacie UTC.

RemoteSupportJobReportedProperties

Objekt

Reprezentuje zgłoszone właściwości zadania pomocy technicznej zdalnej.

Nazwa	Typ	Opis
deploymentStatus	EceActionStatus	Stan wdrożenia zadania.
nodeSettings	RemoteSupportJobNodeSettings	Opcjonalne ustawienia konfigurowania węzła na potrzeby obsługi zdalnej.
percentComplete	integer (int32)	Procent ukończonego zadania.
sessionDetails	RemoteSupportSession[]	Szczegóły sesji pomocy technicznej zdalnej.
validationStatus	EceActionStatus	Stan weryfikacji zadania.

RemoteSupportSession

Objekt

Reprezentuje sesję pomocy technicznej zdalnej.

Nazwa	Typ	Opis
accessLevel	RemoteSupportAccessLevel	Poziom dostępu udzielony podczas sesji pomocy technicznej zdalnej.
sessionEndTime	string (date-time)	Godzina zakończenia sesji zdalnej pomocy technicznej w formacie UTC.
sessionId	string	Unikatowy identyfikator sesji.
sessionStartTime	string (date-time)	Godzina rozpoczęcia sesji zdalnej pomocy technicznej w formacie UTC.
transcriptLocation	string	Lokalizacja, w której jest przechowywana transkrypcja sesji.

RemoteSupportType

Wyliczanie

Definiuje typ akcji zdalnej pomocy technicznej, która ma być wykonywana na urządzeniu brzegowym.

Wartość	Opis
Enable	Umożliwia zdalną obsługę urządzenia brzegowego.
Revoke	Odwołuje wcześniej udzielony zdalny dostęp do pomocy technicznej dla urządzenia brzegowego.

systemData

Objekt

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

Nazwa	Typ	Opis
createdAt	string (date-time)	Sygnatura czasowa tworzenia zasobu (UTC).
createdBy	string	Tożsamość, która utworzyła zasób.
createdByType	createdByType	Typ tożsamości, która utworzyła zasób.
lastModifiedAt	string (date-time)	Znacznik czasu ostatniej modyfikacji zasobu (UTC)
lastModifiedBy	string	Tożsamość, która ostatnio zmodyfikowała zasób.
lastModifiedByType	createdByType	Typ tożsamości, która ostatnio zmodyfikowała zasób.

Udostępnij za pośrednictwem

Edge Device Jobs - Get

Parametry identyfikatora URI

Odpowiedzi

Zabezpieczenia

azure_auth

Zakresy

Przykłady

EdgeDeviceJobs_Get_RemoteSupport

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

createdByType

DeploymentMode

DeploymentStep

DeviceLogCollectionStatus

EceActionStatus

EdgeDeviceKind

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

HciCollectLogJobProperties

HciEdgeDeviceJob

HciEdgeDeviceJobType

HciRemoteSupportJobProperties

JobStatus

LogCollectionJobSession

LogCollectionReportedProperties

ProvisioningState

RemoteSupportAccessLevel

RemoteSupportJobNodeSettings

RemoteSupportJobReportedProperties

RemoteSupportSession

RemoteSupportType

systemData