Addons - List By Role

Layanan:: Data Box Edge/Data Box Gateway

Versi API:: 2023-12-01

Mencantumkan semua addon yang dikonfigurasi dalam peran.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/roles/{roleName}/addons?api-version=2023-12-01

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
deviceName	path	True	string	Nama perangkat.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nama grup sumber daya. Nama tidak sensitif terhadap penggunaan huruf besar atau kecil.
roleName	path	True	string	Nama peran.
subscriptionId	path	True	string minLength: 1	ID langganan target.
api-version	query	True	string minLength: 1	Versi API yang digunakan untuk operasi ini.

Respons

Nama	Jenis	Deskripsi
200 OK	AddonList	Operasi Azure berhasil diselesaikan.
Other Status Codes	CloudError	Respons kesalahan tak terduga.

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory.

Jenis: oauth2
Alur: implicit
URL Otorisasi: https://login.microsoftonline.com/common/oauth2/authorize

Cakupan

Nama	Deskripsi
user_impersonation	meniru akun pengguna Anda

Contoh

RoleListAddOns

Permintaan sampel

HTTP

GET https://management.azure.com/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/roles/IoTRole1/addons?api-version=2023-12-01

Respon sampel

Kode status:: 200

{
  "value": [
    {
      "name": "arcName",
      "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles/addons",
      "id": "/subscriptions/0d44739e-0563-474f-97e7-24a0cdb23b29/resourcegroups/prpare/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/addonExamples/roles/kubernetesRole/addons/arcName",
      "kind": "ArcForKubernetes",
      "properties": {
        "hostPlatform": "Linux",
        "hostPlatformType": "KubernetesCluster",
        "provisioningState": "Created",
        "resourceGroupName": "testrg1",
        "resourceLocation": "EastUS",
        "resourceName": "testresource1",
        "subscriptionId": "0d44739e-0563-474f-97e7-24a0cdb23b29",
        "version": "0.2.18"
      }
    }
  ]
}

Definisi

Nama	Deskripsi
AddonList	Kumpulan semua addon Peran pada perangkat Azure Stack Edge.
AddonState	Status Penyediaan Addon
AddonType	Jenis addon.
ArcAddon	Tambahan Busur.
AsymmetricEncryptedSecret	Mewakili rahasia yang dimaksudkan untuk enkripsi dengan pasangan kunci asimetris.
Authentication	Mekanisme autentikasi untuk perangkat IoT.
CloudError	Respons kesalahan dari layanan.
CloudErrorBody	Respons kesalahan dari layanan.
createdByType	Jenis identitas yang membuat sumber daya.
EncryptionAlgorithm	Algoritma yang digunakan untuk mengenkripsi "Nilai".
HostPlatformType	Platform tempat runtime dihosting.
IoTAddon	Addon IoT.
IoTDeviceInfo	Metadata perangkat IoT/perangkat IoT Edge yang akan dikonfigurasi.
PlatformType	OS Host didukung oleh addon Arc.
SymmetricKey	Kunci konten untuk autentikasi.
systemData	Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.

AddonList

Objek

Kumpulan semua addon Peran pada perangkat Azure Stack Edge.

Nama	Jenis	Deskripsi
nextLink	string (uri)	Tautan ke halaman item berikutnya
value	Addon[]: ArcAddon[] IoTAddon[]	Item Addon pada halaman ini

AddonState

Enumerasi

Status Penyediaan Addon

Nilai	Deskripsi
Invalid
Creating
Created
Updating
Reconfiguring
Failed
Deleting

AddonType

Enumerasi

Jenis addon.

Nilai	Deskripsi
IotEdge
ArcForKubernetes

ArcAddon

Objek

Tambahan Busur.

Nama	Jenis	Deskripsi
id	string	ID sumber daya yang sepenuhnya memenuhi syarat untuk sumber daya. Misalnya - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
kind	string: ArcForKubernetes pattern: ^[-\w\._,$\\$]+$	Jenis addon.
name	string	Nama sumber daya
properties.hostPlatform	PlatformType	OS Host didukung oleh addon Arc.
properties.hostPlatformType	HostPlatformType	Platform tempat runtime dihosting.
properties.provisioningState	AddonState	Status Penyediaan Addon
properties.resourceGroupName	string	Nama grup sumber daya Arc
properties.resourceLocation	string	Lokasi sumber daya Arc
properties.resourceName	string	Nama sumber daya Arc
properties.subscriptionId	string	Id langganan sumber daya Arc
properties.version	string	Versi sumber daya busur
systemData	systemData	Metadata Azure Resource Manager yang berisi informasi createBy dan modifiedBy.
type	string	Jenis sumber daya. Misalnya "Microsoft.Compute/virtualMachines" atau "Microsoft.Storage/storageAccounts"

AsymmetricEncryptedSecret

Objek

Mewakili rahasia yang dimaksudkan untuk enkripsi dengan pasangan kunci asimetris.

Nama	Jenis	Deskripsi
encryptionAlgorithm	EncryptionAlgorithm	Algoritma yang digunakan untuk mengenkripsi "Nilai".
encryptionCertThumbprint	string (password)	Sertifikat thumbprint yang digunakan untuk mengenkripsi "Nilai". Jika nilai tidak terenkripsi, nilai tersebut akan null.
value	string	Nilai rahasia.

Authentication

Objek

Mekanisme autentikasi untuk perangkat IoT.

Nama	Jenis	Deskripsi
symmetricKey	SymmetricKey	Kunci konten untuk autentikasi.

CloudError

Objek

Respons kesalahan dari layanan.

Nama	Jenis	Deskripsi
error	CloudErrorBody	Detail kesalahan.

CloudErrorBody

Objek

Respons kesalahan dari layanan.

Nama	Jenis	Deskripsi
code	string	Pengidentifikasi untuk kesalahan. Kode invarian dan dimaksudkan untuk dikonsumsi secara terprogram.
details	CloudErrorBody[]	Daftar detail tambahan tentang kesalahan.
message	string	Pesan yang menjelaskan kesalahan, dimaksudkan agar cocok untuk ditampilkan di antarmuka pengguna.

createdByType

Enumerasi

Jenis identitas yang membuat sumber daya.

Nilai	Deskripsi
User
Application
ManagedIdentity
Key

EncryptionAlgorithm

Enumerasi

Algoritma yang digunakan untuk mengenkripsi "Nilai".

Nilai	Deskripsi
None
AES256
RSAES_PKCS1_v_1_5

HostPlatformType

Enumerasi

Platform tempat runtime dihosting.

Nilai	Deskripsi
KubernetesCluster
LinuxVM

IoTAddon

Objek

Addon IoT.

Nama	Jenis	Deskripsi
id	string	ID sumber daya yang sepenuhnya memenuhi syarat untuk sumber daya. Misalnya - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
kind	string: IotEdge pattern: ^[-\w\._,$\\$]+$	Jenis addon.
name	string	Nama sumber daya
properties.hostPlatform	PlatformType	OS host didukung oleh addon IoT.
properties.hostPlatformType	HostPlatformType	Platform tempat runtime dihosting.
properties.ioTDeviceDetails	IoTDeviceInfo	Metadata perangkat IoT yang perlu disambungkan oleh appliance.
properties.ioTEdgeDeviceDetails	IoTDeviceInfo	Perangkat IoT edge tempat Addon IoT perlu dikonfigurasi.
properties.provisioningState	AddonState	Status Penyediaan Addon
properties.version	string	Versi IoT yang berjalan pada appliance.
systemData	systemData	Metadata Azure Resource Manager yang berisi informasi createBy dan modifiedBy.
type	string	Jenis sumber daya. Misalnya "Microsoft.Compute/virtualMachines" atau "Microsoft.Storage/storageAccounts"

IoTDeviceInfo

Objek

Metadata perangkat IoT/perangkat IoT Edge yang akan dikonfigurasi.

Nama	Jenis	Deskripsi
authentication	Authentication	String koneksi perangkat IoT/IoT edge terenkripsi.
deviceId	string	ID perangkat IoT/perangkat edge.
ioTHostHub	string	Nama host untuk hub IoT yang terkait dengan perangkat.
ioTHostHubId	string	Id untuk hub IoT yang terkait dengan perangkat.

PlatformType

Enumerasi

OS Host didukung oleh addon Arc.

Nilai	Deskripsi
Windows
Linux

SymmetricKey

Objek

Kunci konten untuk autentikasi.

Nama	Jenis	Deskripsi
connectionString	AsymmetricEncryptedSecret	String koneksi berdasarkan kunci konten.

systemData

Objek

Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.

Nama	Jenis	Deskripsi
createdAt	string (date-time)	Tanda waktu pembuatan sumber daya (UTC).
createdBy	string	Identitas yang membuat sumber daya.
createdByType	createdByType	Jenis identitas yang membuat sumber daya.
lastModifiedAt	string (date-time)	Tanda waktu modifikasi terakhir sumber daya (UTC)
lastModifiedBy	string	Identitas yang terakhir mengubah sumber daya.
lastModifiedByType	createdByType	Jenis identitas yang terakhir memodifikasi sumber daya.

Bagikan melalui

Addons - List By Role

Parameter URI

Respons

Keamanan

azure_auth

Cakupan

Contoh

RoleListAddOns

Permintaan sampel

Respon sampel

Definisi

AddonList

AddonState

AddonType

ArcAddon

AsymmetricEncryptedSecret

Authentication

CloudError

CloudErrorBody

createdByType

EncryptionAlgorithm

HostPlatformType

IoTAddon

IoTDeviceInfo

PlatformType

SymmetricKey

systemData