Edge Device Jobs - Get

Hizmet:: Azure Stack HCI

API Sürümü:: 2024-09-01-preview

EdgeDeviceJob alma

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
edgeDeviceName	path	True	string pattern: ^[a-zA-Z0-9-]{3,24}$	EdgeDevice adı
jobsName	path	True	string pattern: ^[a-zA-Z0-9-]{3,24}$	EdgeDevice İşi Adı
resourceUri	path	True	string	Kaynağın tam Azure Resource manager tanımlayıcısı.
api-version	query	True	string minLength: 1	Bu işlem için kullanılacak API sürümü.

Yanıtlar

Name	Tür	Description
200 OK	EdgeDeviceJob: HciEdgeDeviceJob	Azure işlemi başarıyla tamamlandı.
Other Status Codes	ErrorResponse	Beklenmeyen bir hata yanıtı.

Güvenlik

azure_auth

Azure Active Directory OAuth2 Akışı.

Tür: oauth2
Akış: implicit
Yetkilendirme URL’si: https://login.microsoftonline.com/common/oauth2/authorize

Kapsamlar

Name	Description
user_impersonation	kullanıcı hesabınızın kimliğine bürünme

Örnekler

EdgeDeviceJobs_Get_RemoteSupport

Örnek isteği

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

Örnek yanıt

Durum kodu:: 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"
  }
}

Tanımlar

Name	Description
createdByType	Kaynağı oluşturan kimliğin türü.
DeploymentMode	İşi tetikleme dağıtım modu.
DeploymentStep	AzureStackHCI Kümesinin Adımı.
DeviceLogCollectionStatus	Günlük toplama işleminin durumunu temsil eder.
EceActionStatus	AzureStackHCI Kümesi için ECE eylem planı dağıtım durumu.
EdgeDeviceKind	Edge cihaz türü.
ErrorAdditionalInfo	Kaynak yönetimi hatası ek bilgileri.
ErrorDetail	Hata ayrıntısı.
ErrorResponse	Hata yanıtı
HciCollectLogJobProperties	Bir HCI Toplama Günlüğü işinin özelliklerini temsil eder.
HciEdgeDeviceJob	Azure Stack HCI çözümü için Edge cihaz işi.
HciEdgeDeviceJobType	İş Türü desteklenir.
HciRemoteSupportJobProperties	HCI için uzaktan destek işinin özelliklerini temsil eder.
JobStatus	Bir işin yaşam döngüsü boyunca sahip olabileceği çeşitli durumları temsil eder.
LogCollectionJobSession	Uç cihazdan günlükleri toplamak için bir oturumu temsil eder.
LogCollectionReportedProperties	Günlük toplama işinin bildirilen özelliklerini temsil eder.
ProvisioningState	Kaynağın sağlama durumu.
RemoteSupportAccessLevel	Verilen uzaktan destek erişim düzeyini tanımlar.
RemoteSupportJobNodeSettings	Uzak destek düğümünün ayarlarını temsil eder.
RemoteSupportJobReportedProperties	Uzaktan destek işinin bildirilen özelliklerini temsil eder.
RemoteSupportSession	Uzak destek oturumlarını temsil eder.
RemoteSupportType	Bir uç cihazda gerçekleştirilecek uzaktan destek eyleminin türünü tanımlar.
systemData	Kaynağın oluşturulması ve son değiştirilmesiyle ilgili meta veriler.

createdByType

Listeleme

Kaynağı oluşturan kimliğin türü.

Değer	Description
User
Application
ManagedIdentity
Key

DeploymentMode

Listeleme

İşi tetikleme dağıtım modu.

Değer	Description
Validate	Küme için ECE eylem dağıtımlarını doğrulama.
Deploy	Küme için ECE eylem dağıtımı dağıtma.

DeploymentStep

Object

AzureStackHCI Kümesinin Adımı.

Name	Tür	Description
description	string	Adım açıklaması.
endTimeUtc	string	Adımın bitiş saati.
exception	string[]	AzureStackHCI Kümesi Dağıtımındaki özel durumların listesi.
fullStepIndex	string	Adımın FullStepIndex'i.
name	string	Adım adı.
startTimeUtc	string	Adımın başlangıç saati.
status	string	Adımın durumu. İzin verilen değerler :'Error', 'Success', 'InProgress'
steps	DeploymentStep[]	AzureStackHCI Kümesi Dağıtımı'nın iç içe adımlarının listesi.

DeviceLogCollectionStatus

Listeleme

Günlük toplama işleminin durumunu temsil eder.

Değer	Description
NotStarted	Günlük toplama işlemi başlatılmadı.
Running	Günlük toplama işleminin şu anda çalıştığını gösterir.
Failed	Günlük toplama işleminin başarısız olduğunu gösterir.
Succeeded	Günlük toplama işleminin başarıyla tamamlandığını gösterir.
Canceled	Günlük toplama işleminin başarıyla tamamlandığını gösterir.

EceActionStatus

Object

AzureStackHCI Kümesi için ECE eylem planı dağıtım durumu.

Name	Tür	Description
status	string	AzureStackHCI Kümesi Dağıtımı ECE eyleminin durumu.
steps	DeploymentStep[]	AzureStackHCI Küme Dağıtımı adımlarının listesi.

EdgeDeviceKind

Listeleme

Edge cihaz türü.

Değer	Description
HCI	HCI işletim sistemi ile arc özellikli uç cihazı.

ErrorAdditionalInfo

Object

Kaynak yönetimi hatası ek bilgileri.

Name	Tür	Description
info	object	Ek bilgiler.
type	string	Ek bilgi türü.

ErrorDetail

Object

Hata ayrıntısı.

Name	Tür	Description
additionalInfo	ErrorAdditionalInfo[]	Hata ek bilgileri.
code	string	Hata kodu.
details	ErrorDetail[]	Hata ayrıntıları.
message	string	Hata iletisi.
target	string	Hata hedefi.

ErrorResponse

Object

Hata yanıtı

Name	Tür	Description
error	ErrorDetail	Hata nesnesi.

HciCollectLogJobProperties

Object

Bir HCI Toplama Günlüğü işinin özelliklerini temsil eder.

Name	Tür	Description
deploymentMode	DeploymentMode	İşi tetikleme dağıtım modu.
endTimeUtc	string (date-time)	İşin tamamlandığı UTC tarihi ve saati.
fromDate	string (date-time)	Günlük toplama için başlangıç tarihi.
jobId	string	Benzersiz, sabit iş kimliği.
jobType	string: CollectLog	Çok biçimli kaynağı desteklemek için İş Türü.
lastLogGenerated	string (date-time)	Günlük toplama için bugüne kadar.
provisioningState	ProvisioningState	İş sağlama durumu
reportedProperties	LogCollectionReportedProperties	günlük toplama işi bildirilen özellikler.
startTimeUtc	string (date-time)	İşin başlatıldığı UTC tarihi ve saati.
status	JobStatus	Edge cihaz işinin durumu.
toDate	string (date-time)	Günlük toplama için bugüne kadar.

HciEdgeDeviceJob

Object

Azure Stack HCI çözümü için Edge cihaz işi.

Name	Tür	Default value	Description
id	string (arm-id)		Kaynağın tam kaynak kimliği. Örneğin, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
kind	string: HCI	HCI	Çok biçimli kaynağı desteklemek için Edge Çözümü türü.
name	string		Kaynağın adı
properties	HciEdgeDeviceJobProperties: HciCollectLogJobProperties HciRemoteSupportJobProperties		HCI Edge cihaz işi özellikleri
systemData	systemData		createdBy ve modifiedBy bilgilerini içeren Azure Resource Manager meta verileri.
type	string		Kaynağın türü. Örneğin, "Microsoft.Compute/virtualMachines" veya "Microsoft.Storage/storageAccounts"

HciEdgeDeviceJobType

Listeleme

İş Türü desteklenir.

Değer	Description
CollectLog	Cihazdan günlükleri toplama işi.
RemoteSupport	Cihaza uzaktan destek sağlama işi.

HciRemoteSupportJobProperties

Object

HCI için uzaktan destek işinin özelliklerini temsil eder.

Name	Tür	Description
accessLevel	RemoteSupportAccessLevel	Uzaktan destek erişim düzeyi.
deploymentMode	DeploymentMode	İşi tetikleme dağıtım modu.
endTimeUtc	string (date-time)	İşin tamamlandığı UTC tarihi ve saati.
expirationTimestamp	string (date-time)	Uzaktan destek süre sonu zaman damgası.
jobId	string	Benzersiz, sabit iş kimliği.
jobType	string: RemoteSupport	Çok biçimli kaynağı desteklemek için İş Türü.
provisioningState	ProvisioningState	İş sağlama durumu
reportedProperties	RemoteSupportJobReportedProperties	günlük toplama işi bildirilen özellikler.
startTimeUtc	string (date-time)	İşin başlatıldığı UTC tarihi ve saati.
status	JobStatus	Edge cihaz işinin durumu.
type	RemoteSupportType	Uzaktan destek türü.

JobStatus

Listeleme

Bir işin yaşam döngüsü boyunca sahip olabileceği çeşitli durumları temsil eder.

Değer	Description
NotSpecified	İş durumu belirtilmedi.
ValidationInProgress	İş şu anda doğrulanıyor.
ValidationSuccess	İş doğrulamayı başarıyla geçti.
ValidationFailed	İş doğrulanamadı.
DeploymentInProgress	İşin dağıtımı şu anda devam ediyor.
DeploymentFailed	İşin dağıtımı başarısız oldu.
DeploymentSuccess	İş başarıyla dağıtıldı.
Succeeded	İş başarılı oldu.
Failed	İş başarısız oldu.
Canceled	İş iptal edildi.
Paused	İş duraklatıldı.
Scheduled	İş çalıştırılacak şekilde zamanlandı.

LogCollectionJobSession

Object

Uç cihazdan günlükleri toplamak için bir oturumu temsil eder.

Name	Tür	Description
correlationId	string	Bu günlük toplama oturumunu diğer işlemler veya oturumlarla ilişkilendirmek için benzersiz bir tanımlayıcı.
endTime	string	Iso 8601 biçiminde günlük toplamanın sona erdiğinde zaman damgası.
logSize	integer (int32)	Toplanan günlüklerin bayt cinsinden boyutu.
startTime	string	Iso 8601 biçiminde günlük toplama başlatıldığında zaman damgası.
status	DeviceLogCollectionStatus	Günlük toplama oturumunun durumu.
timeCollected	string	Toplam süre günlükleri ISO 8601 süre biçiminde toplandı.

LogCollectionReportedProperties

Object

Günlük toplama işinin bildirilen özelliklerini temsil eder.

Name	Tür	Description
deploymentStatus	EceActionStatus	İşin dağıtım durumu.
logCollectionSessionDetails	LogCollectionJobSession[]	Günlük toplama oturumunun ayrıntıları.
percentComplete	integer (int32)	Tamamlanan işin yüzdesi.
validationStatus	EceActionStatus	İşin doğrulama durumu.

ProvisioningState

Listeleme

Kaynağın sağlama durumu.

Değer	Description
Succeeded	Kaynak oluşturuldu.
Failed	Kaynak oluşturulamadı.
Canceled	Kaynak oluşturma işlemi iptal edildi.
NotSpecified	Kaynak sağlama durumu belirtilmemiş
Provisioning	Kaynak sağlanıyor
Updating	Kaynak güncelleştiriliyor
Deleting	Kaynak siliniyor
Accepted	Kaynak oluşturma isteği kabul edildi

RemoteSupportAccessLevel

Listeleme

Verilen uzaktan destek erişim düzeyini tanımlar.

Değer	Description
None	Uzaktan destek erişimi verilmez.
Diagnostics	Erişim yalnızca tanılama bilgileriyle sınırlıdır.
DiagnosticsAndRepair	Access, tanılama bilgilerini ve onarımları gerçekleştirme özelliğini içerir.

RemoteSupportJobNodeSettings

Object

Uzak destek düğümünün ayarlarını temsil eder.

Name	Tür	Description
connectionErrorMessage	string	Varsa, son bağlantı girişiminden gelen hata iletisi.
connectionStatus	string	Uzak destek oturumunun geçerli bağlantı durumu.
createdAt	string (date-time)	Düğüm ayarlarının oluşturulduğu zaman damgası (UTC).
state	string	Uzak destek düğümünün durumu.
updatedAt	string (date-time)	Düğüm ayarlarının utc olarak en son güncelleştirildiği zaman damgası.

RemoteSupportJobReportedProperties

Object

Uzaktan destek işinin bildirilen özelliklerini temsil eder.

Name	Tür	Description
deploymentStatus	EceActionStatus	İşin dağıtım durumu.
nodeSettings	RemoteSupportJobNodeSettings	Düğümü uzaktan destek için yapılandırmaya yönelik isteğe bağlı ayarlar.
percentComplete	integer (int32)	Tamamlanan işin yüzdesi.
sessionDetails	RemoteSupportSession[]	Uzaktan destek oturumunun ayrıntıları.
validationStatus	EceActionStatus	İşin doğrulama durumu.

RemoteSupportSession

Object

Uzak destek oturumlarını temsil eder.

Name	Tür	Description
accessLevel	RemoteSupportAccessLevel	Uzaktan destek oturumu sırasında verilen erişim düzeyi.
sessionEndTime	string (date-time)	Uzak destek oturumunun bitiş saati (UTC).
sessionId	string	Benzersiz oturum kimliği.
sessionStartTime	string (date-time)	Uzak destek oturumunun başlangıç saati (UTC).
transcriptLocation	string	Oturum transkriptinin depolandığı konum.

RemoteSupportType

Listeleme

Bir uç cihazda gerçekleştirilecek uzaktan destek eyleminin türünü tanımlar.

Değer	Description
Enable	Uç cihaz için uzaktan desteği etkinleştirir.
Revoke	Uç cihaz için önceden verilmiş uzaktan destek erişimini iptal eder.

systemData

Object

Kaynağın oluşturulması ve son değiştirilmesiyle ilgili meta veriler.

Name	Tür	Description
createdAt	string (date-time)	Kaynak oluşturma (UTC) zaman damgası.
createdBy	string	Kaynağı oluşturan kimlik.
createdByType	createdByType	Kaynağı oluşturan kimliğin türü.
lastModifiedAt	string (date-time)	Kaynağın son değişikliğinin zaman damgası (UTC)
lastModifiedBy	string	Kaynağı en son değiştiren kimlik.
lastModifiedByType	createdByType	Kaynağı en son değiştiren kimlik türü.

Aracılığıyla paylaş

Edge Device Jobs - Get

URI Parametreleri

Yanıtlar

Güvenlik

azure_auth

Kapsamlar

Örnekler

EdgeDeviceJobs_Get_RemoteSupport

Örnek isteği

Örnek yanıt

Tanımlar

createdByType

DeploymentMode

DeploymentStep

DeviceLogCollectionStatus

EceActionStatus

EdgeDeviceKind

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

HciCollectLogJobProperties

HciEdgeDeviceJob

HciEdgeDeviceJobType

HciRemoteSupportJobProperties

JobStatus

LogCollectionJobSession

LogCollectionReportedProperties

ProvisioningState

RemoteSupportAccessLevel

RemoteSupportJobNodeSettings

RemoteSupportJobReportedProperties

RemoteSupportSession

RemoteSupportType

systemData