Edge Device Jobs - Get

Tjänst:

Azure Stack HCI

API-version:

2024-09-01-preview

Hämta ett EdgeDeviceJob

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
edgeDeviceName	path	True	string pattern: ^[a-zA-Z0-9-]{3,24}$	Namnet på EdgeDevice
jobsName	path	True	string pattern: ^[a-zA-Z0-9-]{3,24}$	Namn på EdgeDevice-jobb
resourceUri	path	True	string	Resursens fullständigt kvalificerade Azure Resource Manager-identifierare.
api-version	query	True	string minLength: 1	DEN API-version som ska användas för den här åtgärden.

Svar

Name	Typ	Description
200 OK	EdgeDeviceJob: HciEdgeDeviceJob	Azure-åtgärden har slutförts.
Other Status Codes	ErrorResponse	Ett oväntat felsvar.

Säkerhet

azure_auth

Azure Active Directory OAuth2-flöde.

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

EdgeDeviceJobs_Get_RemoteSupport

Exempelbegäran

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

Exempelsvar

Statuskod:

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

Definitioner

Name	Description
createdByType	Den typ av identitet som skapade resursen.
DeploymentMode	Distributionsläge för att utlösa jobb.
DeploymentStep	Steget i AzureStackHCI-kluster.
DeviceLogCollectionStatus	Representerar status för en loggsamlingsåtgärd.
EceActionStatus	Ece-åtgärdsplanens distributionsstatus för AzureStackHCI-kluster.
EdgeDeviceKind	Typ av edge-enhet.
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
ErrorDetail	Felinformationen.
ErrorResponse	Felsvar
HciCollectLogJobProperties	Representerar egenskaperna för ett HCI Collect Log-jobb.
HciEdgeDeviceJob	Edge-enhetsjobb för Azure Stack HCI-lösning.
HciEdgeDeviceJobType	Jobbtyp stöds.
HciRemoteSupportJobProperties	Representerar egenskaperna för ett fjärrstödsjobb för HCI.
JobStatus	Representerar de olika statusar som ett jobb kan ha under hela livscykeln.
LogCollectionJobSession	Representerar en session för insamling av loggar från en gränsenhet.
LogCollectionReportedProperties	Representerar de rapporterade egenskaperna för ett logginsamlingsjobb.
ProvisioningState	Etableringstillståndet för en resurs.
RemoteSupportAccessLevel	Definierar nivån för beviljad fjärrsupportåtkomst.
RemoteSupportJobNodeSettings	Representerar inställningarna för en fjärrsupportnod.
RemoteSupportJobReportedProperties	Representerar de rapporterade egenskaperna för ett fjärrsupportjobb.
RemoteSupportSession	Representerar en fjärrsupportsession.
RemoteSupportType	Definierar vilken typ av fjärrsupportåtgärd som ska utföras på en gränsenhet.
systemData	Metadata som rör skapande och senaste ändring av resursen.

createdByType

Uppräkning

Den typ av identitet som skapade resursen.

Värde	Description
User
Application
ManagedIdentity
Key

DeploymentMode

Uppräkning

Distributionsläge för att utlösa jobb.

Värde	Description
Validate	Verifiera ECE-åtgärdsdistribution för ett kluster.
Deploy	Distribuera ECE-åtgärdsdistribution för ett kluster.

DeploymentStep

Objekt

Steget i AzureStackHCI-kluster.

Name	Typ	Description
description	string	Beskrivning av steg.
endTimeUtc	string	Sluttid för steg.
exception	string[]	Lista över undantag i Distribution av AzureStackHCI-kluster.
fullStepIndex	string	FullStepIndex i steg.
name	string	Namnet på steget.
startTimeUtc	string	Starttid för steg.
status	string	Status för steg. Tillåtna värden är "Error", "Success", "InProgress"
steps	DeploymentStep[]	Lista över kapslade steg i Distribution av AzureStackHCI-kluster.

DeviceLogCollectionStatus

Uppräkning

Representerar status för en loggsamlingsåtgärd.

Värde	Description
NotStarted	Logginsamlingsåtgärden har inte initierats.
Running	Anger att logginsamlingsåtgärden körs för närvarande.
Failed	Anger att logginsamlingsåtgärden misslyckades.
Succeeded	Anger att logginsamlingsåtgärden har slutförts.
Canceled	Anger att logginsamlingsåtgärden har slutförts.

EceActionStatus

Objekt

Ece-åtgärdsplanens distributionsstatus för AzureStackHCI-kluster.

Name	Typ	Description
status	string	Status för ECE-åtgärden AzureStackHCI-klusterdistribution.
steps	DeploymentStep[]	Lista över steg i Distribution av AzureStackHCI-kluster.

EdgeDeviceKind

Uppräkning

Typ av edge-enhet.

Värde	Description
HCI	Arc-aktiverad gränsenhet med HCI OS.

ErrorAdditionalInfo

Objekt

Ytterligare information om resurshanteringsfelet.

Name	Typ	Description
info	object	Ytterligare information.
type	string	Ytterligare informationstyp.

ErrorDetail

Objekt

Felinformationen.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Ytterligare information om felet.
code	string	Felkoden.
details	ErrorDetail[]	Felinformationen.
message	string	Felmeddelandet.
target	string	Felmålet.

ErrorResponse

Objekt

Felsvar

Name	Typ	Description
error	ErrorDetail	Felobjektet.

HciCollectLogJobProperties

Objekt

Representerar egenskaperna för ett HCI Collect Log-jobb.

Name	Typ	Description
deploymentMode	DeploymentMode	Distributionsläge för att utlösa jobb.
endTimeUtc	string (date-time)	UTC-datum och tid då jobbet slutfördes.
fromDate	string (date-time)	Från datum för logginsamling.
jobId	string	Unikt, oföränderligt jobb-ID.
jobType	string: CollectLog	Jobbtyp för att stödja polymorfa resurser.
lastLogGenerated	string (date-time)	Hittills för logginsamling.
provisioningState	ProvisioningState	Jobbetableringstillstånd
reportedProperties	LogCollectionReportedProperties	rapporterade egenskaper för logginsamlingsjobb.
startTimeUtc	string (date-time)	UTC-datum och tid då jobbet startades.
status	JobStatus	Status för Edge-enhetsjobbet.
toDate	string (date-time)	Hittills för logginsamling.

HciEdgeDeviceJob

Objekt

Edge-enhetsjobb för Azure Stack HCI-lösning.

Name	Typ	Standardvärde	Description
id	string (arm-id)		Fullständigt kvalificerat resurs-ID för resursen. Till exempel "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
kind	string: HCI	HCI	Edge-lösningstyp för att stödja polymorfa resurser.
name	string		Namnet på resursen
properties	HciEdgeDeviceJobProperties: HciCollectLogJobProperties HciRemoteSupportJobProperties		Egenskaper för HCI Edge-enhetsjobb
systemData	systemData		Azure Resource Manager-metadata som innehåller createdBy och modifiedBy information.
type	string		Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts"

HciEdgeDeviceJobType

Uppräkning

Jobbtyp stöds.

Värde	Description
CollectLog	Jobb för att samla in loggar från enheten.
RemoteSupport	Jobb för att tillhandahålla fjärrstöd till enheten.

HciRemoteSupportJobProperties

Objekt

Representerar egenskaperna för ett fjärrstödsjobb för HCI.

Name	Typ	Description
accessLevel	RemoteSupportAccessLevel	Åtkomstnivå för fjärrsupport.
deploymentMode	DeploymentMode	Distributionsläge för att utlösa jobb.
endTimeUtc	string (date-time)	UTC-datum och tid då jobbet slutfördes.
expirationTimestamp	string (date-time)	Tidsstämpel för förfallotid för fjärrsupport.
jobId	string	Unikt, oföränderligt jobb-ID.
jobType	string: RemoteSupport	Jobbtyp för att stödja polymorfa resurser.
provisioningState	ProvisioningState	Jobbetableringstillstånd
reportedProperties	RemoteSupportJobReportedProperties	rapporterade egenskaper för logginsamlingsjobb.
startTimeUtc	string (date-time)	UTC-datum och tid då jobbet startades.
status	JobStatus	Status för Edge-enhetsjobbet.
type	RemoteSupportType	Fjärrsupporttyp.

JobStatus

Uppräkning

Representerar de olika statusar som ett jobb kan ha under hela livscykeln.

Värde	Description
NotSpecified	Jobbstatusen har inte angetts.
ValidationInProgress	Jobbet genomgår för närvarande validering.
ValidationSuccess	Jobbet har godkänts.
ValidationFailed	Jobbet har misslyckats med valideringen.
DeploymentInProgress	Jobbets distribution pågår för närvarande.
DeploymentFailed	Jobbets distribution misslyckades.
DeploymentSuccess	Jobbet har distribuerats.
Succeeded	Jobbet har slutförts.
Failed	Jobbet misslyckades.
Canceled	Jobbet har avbrutits.
Paused	Jobbet har pausats.
Scheduled	Jobbet är schemalagt att köras.

LogCollectionJobSession

Objekt

Representerar en session för insamling av loggar från en gränsenhet.

Name	Typ	Description
correlationId	string	En unik identifierare för att korrelera den här loggsamlingssessionen med andra åtgärder eller sessioner.
endTime	string	Tidsstämpeln när loggsamlingen avslutades, i ISO 8601-format.
logSize	integer (int32)	Storleken på de insamlade loggarna i byte.
startTime	string	Tidsstämpeln när loggsamlingen startade i ISO 8601-format.
status	DeviceLogCollectionStatus	Status för loggsamlingssessionen.
timeCollected	string	Den totala tiden loggar samlades in för, i ISO 8601 varaktighet format.

LogCollectionReportedProperties

Objekt

Representerar de rapporterade egenskaperna för ett logginsamlingsjobb.

Name	Typ	Description
deploymentStatus	EceActionStatus	Distributionsstatus för jobbet.
logCollectionSessionDetails	LogCollectionJobSession[]	Information om loggsamlingssessionen.
percentComplete	integer (int32)	Procentandelen av jobbet som är slutfört.
validationStatus	EceActionStatus	Valideringsstatus för jobbet.

ProvisioningState

Uppräkning

Etableringstillståndet för en resurs.

Värde	Description
Succeeded	Resursen har skapats.
Failed	Det gick inte att skapa resurser.
Canceled	Resursskapandet avbröts.
NotSpecified	Resursetableringstillståndet har inte angetts
Provisioning	Resursen etableras
Updating	Resursen uppdateras
Deleting	Resursen tas bort
Accepted	Begäran om resursskapande har godkänts

RemoteSupportAccessLevel

Uppräkning

Definierar nivån för beviljad fjärrsupportåtkomst.

Värde	Description
None	Ingen fjärrsupportåtkomst beviljas.
Diagnostics	Åtkomsten är endast begränsad till diagnostikinformation.
DiagnosticsAndRepair	Åtkomsten innehåller diagnostikinformation och möjligheten att utföra reparationer.

RemoteSupportJobNodeSettings

Objekt

Representerar inställningarna för en fjärrsupportnod.

Name	Typ	Description
connectionErrorMessage	string	Felmeddelandet, om det finns något, från det senaste anslutningsförsöket.
connectionStatus	string	Den aktuella anslutningsstatusen för fjärrsupportsessionen.
createdAt	string (date-time)	Tidsstämpeln när nodinställningarna skapades i UTC.
state	string	Tillståndet för fjärrsupportnoden.
updatedAt	string (date-time)	Tidsstämpeln när nodinställningarna senast uppdaterades, i UTC.

RemoteSupportJobReportedProperties

Objekt

Representerar de rapporterade egenskaperna för ett fjärrsupportjobb.

Name	Typ	Description
deploymentStatus	EceActionStatus	Distributionsstatus för jobbet.
nodeSettings	RemoteSupportJobNodeSettings	Valfria inställningar för att konfigurera noden för fjärrstöd.
percentComplete	integer (int32)	Procentandelen av jobbet som är slutfört.
sessionDetails	RemoteSupportSession[]	Information om fjärrsupportsessionen.
validationStatus	EceActionStatus	Valideringsstatus för jobbet.

RemoteSupportSession

Objekt

Representerar en fjärrsupportsession.

Name	Typ	Description
accessLevel	RemoteSupportAccessLevel	Åtkomstnivån som beviljades under fjärrsupportsessionen.
sessionEndTime	string (date-time)	Sluttiden för fjärrsupportsessionen i UTC.
sessionId	string	Unikt sessions-ID.
sessionStartTime	string (date-time)	Starttiden för fjärrsupportsessionen i UTC.
transcriptLocation	string	Platsen där sessionsavskriften lagras.

RemoteSupportType

Uppräkning

Definierar vilken typ av fjärrsupportåtgärd som ska utföras på en gränsenhet.

Värde	Description
Enable	Aktiverar fjärrstöd för gränsenheten.
Revoke	Återkallar tidigare beviljad fjärrsupportåtkomst för gränsenheten.

systemData

Objekt

Metadata som rör skapande och senaste ändring av resursen.

Name	Typ	Description
createdAt	string (date-time)	Tidsstämpeln för resursskapande (UTC).
createdBy	string	Identiteten som skapade resursen.
createdByType	createdByType	Den typ av identitet som skapade resursen.
lastModifiedAt	string (date-time)	Tidsstämpeln för resursens senaste ändring (UTC)
lastModifiedBy	string	Identiteten som senast ändrade resursen.
lastModifiedByType	createdByType	Den typ av identitet som senast ändrade resursen.