Edge Device Jobs - Get

Service:

Azure Stack HCI

API-versie:

2024-09-01-preview

Een EdgeDeviceJob ophalen

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

URI-parameters

Name	In	Vereist	Type	Description
edgeDeviceName	path	True	string pattern: ^[a-zA-Z0-9-]{3,24}$	De naam van de EdgeDevice
jobsName	path	True	string pattern: ^[a-zA-Z0-9-]{3,24}$	Naam van EdgeDevice-taak
resourceUri	path	True	string	De volledig gekwalificeerde Azure Resource Manager-id van de resource.
api-version	query	True	string minLength: 1	De API-versie die voor deze bewerking moet worden gebruikt.

Antwoorden

Name	Type	Description
200 OK	EdgeDeviceJob: HciEdgeDeviceJob	De Azure-bewerking is voltooid.
Other Status Codes	ErrorResponse	Een onverwachte foutreactie.

Beveiliging

azure_auth

OAuth2-stroom voor Azure Active Directory.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

EdgeDeviceJobs_Get_RemoteSupport

Voorbeeldaanvraag

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

Voorbeeldrespons

Statuscode:

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

Definities

Name	Description
createdByType	Het type identiteit waarmee de resource is gemaakt.
DeploymentMode	Implementatiemodus om taak te activeren.
DeploymentStep	De stap van het AzureStackHCI-cluster.
DeviceLogCollectionStatus	Vertegenwoordigt de status van een bewerking voor het verzamelen van logboeken.
EceActionStatus	De implementatiestatus van het ECE-actieplan voor AzureStackHCI-cluster.
EdgeDeviceKind	Soort Edge-apparaat.
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorDetail	De foutdetails.
ErrorResponse	Foutreactie
HciCollectLogJobProperties	Vertegenwoordigt de eigenschappen van een HCI Collect Log-taak.
HciEdgeDeviceJob	Edge-apparaattaak voor Azure Stack HCI-oplossing.
HciEdgeDeviceJobType	Taaktype ondersteund.
HciRemoteSupportJobProperties	Vertegenwoordigt de eigenschappen van een externe ondersteuningstaak voor HCI.
JobStatus	Vertegenwoordigt de verschillende statussen die een taak gedurende de levenscyclus kan hebben.
LogCollectionJobSession	Vertegenwoordigt een sessie voor het verzamelen van logboeken vanaf een edge-apparaat.
LogCollectionReportedProperties	Vertegenwoordigt de gerapporteerde eigenschappen van een logboekverzamelingstaak.
ProvisioningState	De inrichtingsstatus van een resource.
RemoteSupportAccessLevel	Hiermee definieert u het niveau van externe ondersteuningstoegang verleend.
RemoteSupportJobNodeSettings	Vertegenwoordigt de instellingen van een extern ondersteuningsknooppunt.
RemoteSupportJobReportedProperties	Vertegenwoordigt de gerapporteerde eigenschappen van een externe ondersteuningstaak.
RemoteSupportSession	Vertegenwoordigt een sessie voor externe ondersteuning.
RemoteSupportType	Hiermee definieert u het type externe ondersteuningsactie dat moet worden uitgevoerd op een edge-apparaat.
systemData	Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.

createdByType

Inventarisatie

Het type identiteit waarmee de resource is gemaakt.

Waarde	Description
User
Application
ManagedIdentity
Key

DeploymentMode

Inventarisatie

Implementatiemodus om taak te activeren.

Waarde	Description
Validate	Ece-actie-implementatie valideren voor een cluster.
Deploy	Ece-actie-implementatie implementeren voor een cluster.

DeploymentStep

Object

De stap van het AzureStackHCI-cluster.

Name	Type	Description
description	string	Beschrijving van stap.
endTimeUtc	string	Eindtijd van stap.
exception	string[]	Lijst met uitzonderingen in AzureStackHCI-clusterimplementatie.
fullStepIndex	string	FullStepIndex van stap.
name	string	Naam van stap.
startTimeUtc	string	Begintijd van stap.
status	string	Status van stap. Toegestane waarden zijn Fout, Geslaagd, InProgress
steps	DeploymentStep[]	Lijst met geneste stappen van AzureStackHCI-clusterimplementatie.

DeviceLogCollectionStatus

Inventarisatie

Vertegenwoordigt de status van een bewerking voor het verzamelen van logboeken.

Waarde	Description
NotStarted	De bewerking voor het verzamelen van logboeken is niet gestart.
Running	Geeft aan dat de bewerking voor het verzamelen van logboeken momenteel wordt uitgevoerd.
Failed	Geeft aan dat de bewerking voor het verzamelen van logboeken is mislukt.
Succeeded	Geeft aan dat de bewerking voor het verzamelen van logboeken is voltooid.
Canceled	Geeft aan dat de bewerking voor het verzamelen van logboeken is voltooid.

EceActionStatus

Object

De implementatiestatus van het ECE-actieplan voor AzureStackHCI-cluster.

Name	Type	Description
status	string	Status van ECE-actie AzureStackHCI-clusterimplementatie.
steps	DeploymentStep[]	Lijst met stappen van AzureStackHCI-clusterimplementatie.

EdgeDeviceKind

Inventarisatie

Soort Edge-apparaat.

Waarde	Description
HCI	Edge-apparaat met Arc met HCI OS.

ErrorAdditionalInfo

Object

Aanvullende informatie over de resourcebeheerfout.

Name	Type	Description
info	object	De aanvullende informatie.
type	string	Het extra informatietype.

ErrorDetail

Object

De foutdetails.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	De fout bevat aanvullende informatie.
code	string	De foutcode.
details	ErrorDetail[]	De foutdetails.
message	string	Het foutbericht.
target	string	Het foutdoel.

ErrorResponse

Object

Foutreactie

Name	Type	Description
error	ErrorDetail	Het foutobject.

HciCollectLogJobProperties

Object

Vertegenwoordigt de eigenschappen van een HCI Collect Log-taak.

Name	Type	Description
deploymentMode	DeploymentMode	Implementatiemodus om taak te activeren.
endTimeUtc	string (date-time)	De UTC-datum en -tijd waarop de taak is voltooid.
fromDate	string (date-time)	Vanaf de datum voor het verzamelen van logboeken.
jobId	string	Unieke, onveranderbare taak-id.
jobType	string: CollectLog	Taaktype ter ondersteuning van polymorfe resources.
lastLogGenerated	string (date-time)	Tot heden voor logboekverzameling.
provisioningState	ProvisioningState	Inrichtingsstatus van taak
reportedProperties	LogCollectionReportedProperties	gerapporteerde eigenschappen van logboekverzamelingstaak.
startTimeUtc	string (date-time)	De UTC-datum en -tijd waarop de taak is gestart.
status	JobStatus	Status van edge-apparaattaak.
toDate	string (date-time)	Tot heden voor logboekverzameling.

HciEdgeDeviceJob

Object

Edge-apparaattaak voor Azure Stack HCI-oplossing.

Name	Type	Default value	Description
id	string (arm-id)		Volledig gekwalificeerde resource-id voor de resource. Bijvoorbeeld /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceType}/{resourceName}"
kind	string: HCI	HCI	Edge-oplossingstype ter ondersteuning van polymorfe resources.
name	string		De naam van de resource
properties	HciEdgeDeviceJobProperties: HciCollectLogJobProperties HciRemoteSupportJobProperties		Eigenschappen van HCI Edge-apparaattaak
systemData	systemData		Azure Resource Manager-metagegevens met createdBy- en modifiedBy-gegevens.
type	string		Het type resource. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts'

HciEdgeDeviceJobType

Inventarisatie

Taaktype ondersteund.

Waarde	Description
CollectLog	Taak voor het verzamelen van logboeken van het apparaat.
RemoteSupport	Taak voor het bieden van externe ondersteuning aan het apparaat.

HciRemoteSupportJobProperties

Object

Vertegenwoordigt de eigenschappen van een externe ondersteuningstaak voor HCI.

Name	Type	Description
accessLevel	RemoteSupportAccessLevel	Toegangsniveau voor externe ondersteuning.
deploymentMode	DeploymentMode	Implementatiemodus om taak te activeren.
endTimeUtc	string (date-time)	De UTC-datum en -tijd waarop de taak is voltooid.
expirationTimestamp	string (date-time)	Verlooptijdstempel voor externe ondersteuning.
jobId	string	Unieke, onveranderbare taak-id.
jobType	string: RemoteSupport	Taaktype ter ondersteuning van polymorfe resources.
provisioningState	ProvisioningState	Inrichtingsstatus van taak
reportedProperties	RemoteSupportJobReportedProperties	gerapporteerde eigenschappen van logboekverzamelingstaak.
startTimeUtc	string (date-time)	De UTC-datum en -tijd waarop de taak is gestart.
status	JobStatus	Status van edge-apparaattaak.
type	RemoteSupportType	Type externe ondersteuning.

JobStatus

Inventarisatie

Vertegenwoordigt de verschillende statussen die een taak gedurende de levenscyclus kan hebben.

Waarde	Description
NotSpecified	De taakstatus is niet opgegeven.
ValidationInProgress	De taak wordt momenteel gevalideerd.
ValidationSuccess	De taak is geslaagd voor validatie.
ValidationFailed	De taak is mislukt.
DeploymentInProgress	De implementatie van de taak wordt momenteel uitgevoerd.
DeploymentFailed	De implementatie van de taak is mislukt.
DeploymentSuccess	De taak is geïmplementeerd.
Succeeded	De taak is voltooid.
Failed	De taak is mislukt.
Canceled	De taak is geannuleerd.
Paused	De taak is onderbroken.
Scheduled	De taak wordt gepland om uit te voeren.

LogCollectionJobSession

Object

Vertegenwoordigt een sessie voor het verzamelen van logboeken vanaf een edge-apparaat.

Name	Type	Description
correlationId	string	Een unieke id voor het correleren van deze logboekverzamelingssessie met andere bewerkingen of sessies.
endTime	string	De tijdstempel waarop het verzamelen van logboeken is beëindigd, in ISO 8601-indeling.
logSize	integer (int32)	De grootte van de verzamelde logboeken in bytes.
startTime	string	De tijdstempel waarop logboekverzameling is gestart, in ISO 8601-indeling.
status	DeviceLogCollectionStatus	De status van de sessie voor het verzamelen van logboeken.
timeCollected	string	De totale tijdlogboeken zijn verzameld voor, in ISO 8601-duurnotatie.

LogCollectionReportedProperties

Object

Vertegenwoordigt de gerapporteerde eigenschappen van een logboekverzamelingstaak.

Name	Type	Description
deploymentStatus	EceActionStatus	Implementatiestatus van taak.
logCollectionSessionDetails	LogCollectionJobSession[]	Details van de sessie voor het verzamelen van logboeken.
percentComplete	integer (int32)	Het percentage van de taak dat is voltooid.
validationStatus	EceActionStatus	Validatiestatus van taak.

ProvisioningState

Inventarisatie

De inrichtingsstatus van een resource.

Waarde	Description
Succeeded	De resource is gemaakt.
Failed	Het maken van resources is mislukt.
Canceled	Het maken van resources is geannuleerd.
NotSpecified	De inrichtingsstatus van de resource is niet opgegeven
Provisioning	De resource wordt ingericht
Updating	De resource wordt bijgewerkt
Deleting	De resource wordt verwijderd
Accepted	De aanvraag voor het maken van resources is geaccepteerd

RemoteSupportAccessLevel

Inventarisatie

Hiermee definieert u het niveau van externe ondersteuningstoegang verleend.

Waarde	Description
None	Er wordt geen externe ondersteuningstoegang verleend.
Diagnostics	Toegang is beperkt tot alleen diagnostische gegevens.
DiagnosticsAndRepair	Access bevat diagnostische gegevens en de mogelijkheid om reparaties uit te voeren.

RemoteSupportJobNodeSettings

Object

Vertegenwoordigt de instellingen van een extern ondersteuningsknooppunt.

Name	Type	Description
connectionErrorMessage	string	Het foutbericht, indien aanwezig, van de laatste verbindingspoging.
connectionStatus	string	De huidige verbindingsstatus van de sessie voor externe ondersteuning.
createdAt	string (date-time)	De tijdstempel waarop de knooppuntinstellingen zijn gemaakt, in UTC.
state	string	De status van het knooppunt voor externe ondersteuning.
updatedAt	string (date-time)	De tijdstempel waarop de knooppuntinstellingen voor het laatst zijn bijgewerkt, in UTC.

RemoteSupportJobReportedProperties

Object

Vertegenwoordigt de gerapporteerde eigenschappen van een externe ondersteuningstaak.

Name	Type	Description
deploymentStatus	EceActionStatus	Implementatiestatus van taak.
nodeSettings	RemoteSupportJobNodeSettings	Optionele instellingen voor het configureren van het knooppunt voor externe ondersteuning.
percentComplete	integer (int32)	Het percentage van de taak dat is voltooid.
sessionDetails	RemoteSupportSession[]	Details van de sessie voor externe ondersteuning.
validationStatus	EceActionStatus	Validatiestatus van taak.

RemoteSupportSession

Object

Vertegenwoordigt een sessie voor externe ondersteuning.

Name	Type	Description
accessLevel	RemoteSupportAccessLevel	Het toegangsniveau dat wordt verleend tijdens de sessie voor externe ondersteuning.
sessionEndTime	string (date-time)	De eindtijd van de sessie voor externe ondersteuning, in UTC.
sessionId	string	Unieke sessie-id.
sessionStartTime	string (date-time)	De begintijd van de sessie voor externe ondersteuning, in UTC.
transcriptLocation	string	De locatie waar de sessietranscriptie is opgeslagen.

RemoteSupportType

Inventarisatie

Hiermee definieert u het type externe ondersteuningsactie dat moet worden uitgevoerd op een edge-apparaat.

Waarde	Description
Enable	Hiermee schakelt u externe ondersteuning voor het edge-apparaat in.
Revoke	Hiermee wordt eerder externe ondersteuningstoegang voor het edge-apparaat ingetrokken.

systemData

Object

Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.

Name	Type	Description
createdAt	string (date-time)	De tijdstempel van het maken van resources (UTC).
createdBy	string	De identiteit waarmee de resource is gemaakt.
createdByType	createdByType	Het type identiteit waarmee de resource is gemaakt.
lastModifiedAt	string (date-time)	De tijdstempel van de laatste wijziging van de resource (UTC)
lastModifiedBy	string	De identiteit die de resource voor het laatst heeft gewijzigd.
lastModifiedByType	createdByType	Het type identiteit dat de resource voor het laatst heeft gewijzigd.