Addons - List By Role

Dienst:: Data Box Edge/Data Box Gateway

API-Version:: 2023-12-01

Listet alle Addons auf, die in der Rolle konfiguriert sind.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
deviceName	path	True	string	Der Name des Geräts.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
roleName	path	True	string	Der Name der Rolle.
subscriptionId	path	True	string minLength: 1	Die ID des Zielabonnements.
api-version	query	True	string minLength: 1	Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.

Antworten

Name	Typ	Beschreibung
200 OK	AddonList	Der Azure-Vorgang wurde erfolgreich abgeschlossen.
Other Status Codes	CloudError	Unerwartete Fehlerantwort.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

RoleListAddOns

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:: 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"
      }
    }
  ]
}

Definitionen

Name	Beschreibung
AddonList	Sammlung aller Rollen-Add-Ons auf dem Azure Stack Edge-Gerät.
AddonState	Status der Addon-Bereitstellung
AddonType	Addontyp.
ArcAddon	Arc-Addon.
AsymmetricEncryptedSecret	Stellen Sie die Geheimnisse dar, die für die Verschlüsselung mit einem asymmetrischen Schlüsselpaar vorgesehen sind.
Authentication	Authentifizierungsmechanismus für IoT-Geräte.
CloudError	Eine Fehlerantwort des Diensts.
CloudErrorBody	Eine Fehlerantwort des Diensts.
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
EncryptionAlgorithm	Der Algorithmus, der zum Verschlüsseln von "Value" verwendet wird.
HostPlatformType	Plattform, auf der die Runtime gehostet wird.
IoTAddon	IoT-Addon.
IoTDeviceInfo	Metadaten des zu konfigurierenden IoT-Geräts/IoT Edge-Geräts.
PlatformType	Host-Betriebssystem, das vom Arc-Addon unterstützt wird.
SymmetricKey	Symmetrischer Schlüssel für die Authentifizierung.
systemData	Metadaten zur Erstellung und letzten Änderung der Ressource.

AddonList

Objekt

Sammlung aller Rollen-Add-Ons auf dem Azure Stack Edge-Gerät.

Name	Typ	Beschreibung
nextLink	string (uri)	Der Link zur nächsten Seite von Elementen
value	Addon[]: ArcAddon[] IoTAddon[]	Die Addon-Elemente auf dieser Seite

AddonState

Enumeration

Status der Addon-Bereitstellung

Wert	Beschreibung
Invalid
Creating
Created
Updating
Reconfiguring
Failed
Deleting

AddonType

Enumeration

Addontyp.

Wert	Beschreibung
IotEdge
ArcForKubernetes

ArcAddon

Objekt

Arc-Addon.

Name	Typ	Beschreibung
id	string	Vollqualifizierte Ressourcen-ID für die Ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
kind	string: ArcForKubernetes pattern: ^[-\w\._,$\\$]+$	Addontyp.
name	string	Der Name der Ressource
properties.hostPlatform	PlatformType	Host-Betriebssystem, das vom Arc-Addon unterstützt wird.
properties.hostPlatformType	HostPlatformType	Plattform, auf der die Runtime gehostet wird.
properties.provisioningState	AddonState	Status der Addon-Bereitstellung
properties.resourceGroupName	string	Arc-Ressourcengruppenname
properties.resourceLocation	string	Arc-Ressourcenspeicherort
properties.resourceName	string	Arc-Ressourcenname
properties.subscriptionId	string	Arc-Ressourcenabonnement-ID
properties.version	string	Version der Arc-Ressource
systemData	systemData	Azure Resource Manager-Metadaten, die createdBy- und modifiedBy-Informationen enthalten.
type	string	Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

AsymmetricEncryptedSecret

Objekt

Stellen Sie die Geheimnisse dar, die für die Verschlüsselung mit einem asymmetrischen Schlüsselpaar vorgesehen sind.

Name	Typ	Beschreibung
encryptionAlgorithm	EncryptionAlgorithm	Der Algorithmus, der zum Verschlüsseln von "Value" verwendet wird.
encryptionCertThumbprint	string (password)	Fingerabdruckzertifikat, das zum Verschlüsseln von "Value" verwendet wird. Wenn der Wert unverschlüsselt ist, ist er NULL.
value	string	Der Wert des geheimen Schlüssels.

Authentication

Objekt

Authentifizierungsmechanismus für IoT-Geräte.

Name	Typ	Beschreibung
symmetricKey	SymmetricKey	Symmetrischer Schlüssel für die Authentifizierung.

CloudError

Objekt

Eine Fehlerantwort des Diensts.

Name	Typ	Beschreibung
error	CloudErrorBody	Die Fehlerdetails.

CloudErrorBody

Objekt

Eine Fehlerantwort des Diensts.

Name	Typ	Beschreibung
code	string	Ein Bezeichner für den Fehler. Codes sind unveränderlich und sollen programmgesteuert genutzt werden.
details	CloudErrorBody[]	Eine Liste mit zusätzlichen Details zum Fehler.
message	string	Eine Meldung, die den Fehler beschreibt, der für die Anzeige in einer Benutzeroberfläche geeignet ist.

createdByType

Enumeration

Der Identitätstyp, der die Ressource erstellt hat.

Wert	Beschreibung
User
Application
ManagedIdentity
Key

EncryptionAlgorithm

Enumeration

Der Algorithmus, der zum Verschlüsseln von "Value" verwendet wird.

Wert	Beschreibung
None
AES256
RSAES_PKCS1_v_1_5

HostPlatformType

Enumeration

Plattform, auf der die Runtime gehostet wird.

Wert	Beschreibung
KubernetesCluster
LinuxVM

IoTAddon

Objekt

IoT-Addon.

Name	Typ	Beschreibung
id	string	Vollqualifizierte Ressourcen-ID für die Ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
kind	string: IotEdge pattern: ^[-\w\._,$\\$]+$	Addontyp.
name	string	Der Name der Ressource
properties.hostPlatform	PlatformType	Hostbetriebssystem, das vom IoT-Addon unterstützt wird.
properties.hostPlatformType	HostPlatformType	Plattform, auf der die Runtime gehostet wird.
properties.ioTDeviceDetails	IoTDeviceInfo	IoT-Gerätemetadaten, mit denen die Appliance verbunden werden muss.
properties.ioTEdgeDeviceDetails	IoTDeviceInfo	IoT-Edgegerät, für das das IoT-Addon konfiguriert werden muss.
properties.provisioningState	AddonState	Status der Addon-Bereitstellung
properties.version	string	IoT-Version, die auf der Appliance ausgeführt wird.
systemData	systemData	Azure Resource Manager-Metadaten, die createdBy- und modifiedBy-Informationen enthalten.
type	string	Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

IoTDeviceInfo

Objekt

Metadaten des zu konfigurierenden IoT-Geräts/IoT Edge-Geräts.

Name	Typ	Beschreibung
authentication	Authentication	Verschlüsselte IoT-Geräte-/IoT-Edgegeräteverbindungszeichenfolge.
deviceId	string	ID des IoT-Geräts/Edgegeräts.
ioTHostHub	string	Hostname für den IoT-Hub, der dem Gerät zugeordnet ist.
ioTHostHubId	string	ID für den IoT-Hub, der dem Gerät zugeordnet ist.

PlatformType

Enumeration

Host-Betriebssystem, das vom Arc-Addon unterstützt wird.

Wert	Beschreibung
Windows
Linux

SymmetricKey

Objekt

Symmetrischer Schlüssel für die Authentifizierung.

Name	Typ	Beschreibung
connectionString	AsymmetricEncryptedSecret	Verbindungszeichenfolge basierend auf dem symmetrischen Schlüssel.

systemData

Objekt

Metadaten zur Erstellung und letzten Änderung der Ressource.

Name	Typ	Beschreibung
createdAt	string (date-time)	Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy	string	Die Identität, die die Ressource erstellt hat.
createdByType	createdByType	Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt	string (date-time)	Der Zeitstempel der letzten Änderung der Ressource (UTC)
lastModifiedBy	string	Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType	createdByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.

Freigeben über

Addons - List By Role

URI-Parameter

Antworten

Sicherheit

azure_auth

Bereiche

Beispiele

RoleListAddOns

Beispielanforderung

Beispiel für eine Antwort

Definitionen

AddonList

AddonState

AddonType

ArcAddon

AsymmetricEncryptedSecret

Authentication

CloudError

CloudErrorBody

createdByType

EncryptionAlgorithm

HostPlatformType

IoTAddon

IoTDeviceInfo

PlatformType

SymmetricKey

systemData