Addons - List By Role

Service:: Data Box Edge/Data Box Gateway

Version de l’API:: 2023-12-01

Répertorie tous les addons configurés dans le rôle.

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

Paramètres d’URI

Nom	Dans	Obligatoire	Type	Description
deviceName	path	True	string	Nom de l’appareil.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nom du groupe de ressources. Le nom ne respecte pas la casse.
roleName	path	True	string	Nom du rôle.
subscriptionId	path	True	string minLength: 1	ID de l’abonnement cible.
api-version	query	True	string minLength: 1	Version de l’API à utiliser pour cette opération.

Réponses

Nom	Type	Description
200 OK	AddonList	L’opération Azure s’est terminée avec succès.
Other Status Codes	CloudError	Réponse d’erreur inattendue.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory.

Type: oauth2
Couler: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	emprunter l’identité de votre compte d’utilisateur

Exemples

RoleListAddOns

Demande d’échantillon

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

Exemple de réponse

Code d’état:: 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"
      }
    }
  ]
}

Définitions

Nom	Description
AddonList	Collection de tous les addons Role sur l’appareil Azure Stack Edge.
AddonState	État de provisionnement de l’addon
AddonType	Type de module complémentaire.
ArcAddon	Arc Addon.
AsymmetricEncryptedSecret	Représenter les secrets destinés au chiffrement avec une paire de clés asymétrique.
Authentication	Mécanisme d’authentification pour les appareils IoT.
CloudError	Réponse d’erreur du service.
CloudErrorBody	Réponse d’erreur du service.
createdByType	Type d’identité qui a créé la ressource.
EncryptionAlgorithm	Algorithme utilisé pour chiffrer « Value ».
HostPlatformType	Plate-forme sur laquelle le runtime est hébergé.
IoTAddon	Addon IoT.
IoTDeviceInfo	Métadonnées de l’appareil IoT/appareil IoT Edge à configurer.
PlatformType	Système d’exploitation hôte pris en charge par l’addon Arc.
SymmetricKey	Clé symétrique pour l’authentification.
systemData	Métadonnées relatives à la création et à la dernière modification de la ressource.

AddonList

Objet

Collection de tous les addons Role sur l’appareil Azure Stack Edge.

Nom	Type	Description
nextLink	string (uri)	Le lien vers la page suivante des éléments
value	Addon[]: ArcAddon[] IoTAddon[]	Éléments du module complémentaire sur cette page

AddonState

Énumération

État de provisionnement de l’addon

Valeur	Description
Invalid
Creating
Created
Updating
Reconfiguring
Failed
Deleting

AddonType

Énumération

Type de module complémentaire.

Valeur	Description
IotEdge
ArcForKubernetes

ArcAddon

Objet

Arc Addon.

Nom	Type	Description
id	string	ID de ressource complet pour la ressource. ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
kind	string: ArcForKubernetes pattern: ^[-\w\._,$\\$]+$	Type de module complémentaire.
name	string	Nom de la ressource
properties.hostPlatform	PlatformType	Système d’exploitation hôte pris en charge par l’addon Arc.
properties.hostPlatformType	HostPlatformType	Plate-forme sur laquelle le runtime est hébergé.
properties.provisioningState	AddonState	État de provisionnement de l’addon
properties.resourceGroupName	string	Nom du groupe de ressources Arc
properties.resourceLocation	string	Emplacement des ressources Arc
properties.resourceName	string	Nom de la ressource Arc
properties.subscriptionId	string	ID d’abonnement aux ressources Arc
properties.version	string	Version de la ressource Arc
systemData	systemData	Métadonnées Azure Resource Manager contenant les informations createdBy et modifiedBy.
type	string	Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

AsymmetricEncryptedSecret

Objet

Représenter les secrets destinés au chiffrement avec une paire de clés asymétrique.

Nom	Type	Description
encryptionAlgorithm	EncryptionAlgorithm	Algorithme utilisé pour chiffrer « Value ».
encryptionCertThumbprint	string (password)	Certificat d’empreinte utilisé pour chiffrer « Valeur ». Si la valeur n’est pas chiffrée, elle est null.
value	string	Valeur du secret.

Authentication

Objet

Mécanisme d’authentification pour les appareils IoT.

Nom	Type	Description
symmetricKey	SymmetricKey	Clé symétrique pour l’authentification.

CloudError

Objet

Réponse d’erreur du service.

Nom	Type	Description
error	CloudErrorBody	Détails de l’erreur.

CloudErrorBody

Objet

Réponse d’erreur du service.

Nom	Type	Description
code	string	Identificateur de l’erreur. Les codes sont invariants et sont destinés à être consommés par programme.
details	CloudErrorBody[]	Liste des détails supplémentaires sur l’erreur.
message	string	Message décrivant l’erreur, destiné à être adapté à l’affichage dans une interface utilisateur.

createdByType

Énumération

Type d’identité qui a créé la ressource.

Valeur	Description
User
Application
ManagedIdentity
Key

EncryptionAlgorithm

Énumération

Algorithme utilisé pour chiffrer « Value ».

Valeur	Description
None
AES256
RSAES_PKCS1_v_1_5

HostPlatformType

Énumération

Plate-forme sur laquelle le runtime est hébergé.

Valeur	Description
KubernetesCluster
LinuxVM

IoTAddon

Objet

Addon IoT.

Nom	Type	Description
id	string	ID de ressource complet pour la ressource. ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
kind	string: IotEdge pattern: ^[-\w\._,$\\$]+$	Type de module complémentaire.
name	string	Nom de la ressource
properties.hostPlatform	PlatformType	Système d’exploitation hôte pris en charge par l’addon IoT.
properties.hostPlatformType	HostPlatformType	Plate-forme sur laquelle le runtime est hébergé.
properties.ioTDeviceDetails	IoTDeviceInfo	Métadonnées d’appareil IoT auxquelles l’appliance doit être connectée.
properties.ioTEdgeDeviceDetails	IoTDeviceInfo	Appareil IoT Edge auquel le module complémentaire IoT doit être configuré.
properties.provisioningState	AddonState	État de provisionnement de l’addon
properties.version	string	Version de l’IoT exécutée sur l’appliance.
systemData	systemData	Métadonnées Azure Resource Manager contenant les informations createdBy et modifiedBy.
type	string	Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

IoTDeviceInfo

Objet

Métadonnées de l’appareil IoT/appareil IoT Edge à configurer.

Nom	Type	Description
authentication	Authentication	Chaîne de connexion d’appareil IoT/IoT edge chiffrée.
deviceId	string	ID de l’appareil IoT/périphérique.
ioTHostHub	string	Nom d’hôte du hub IoT associé à l’appareil.
ioTHostHubId	string	ID du hub IoT associé à l’appareil.

PlatformType

Énumération

Système d’exploitation hôte pris en charge par l’addon Arc.

Valeur	Description
Windows
Linux

SymmetricKey

Objet

Clé symétrique pour l’authentification.

Nom	Type	Description
connectionString	AsymmetricEncryptedSecret	Chaîne de connexion basée sur la clé symétrique.

systemData

Objet

Métadonnées relatives à la création et à la dernière modification de la ressource.

Nom	Type	Description
createdAt	string (date-time)	Horodatage de la création de ressources (UTC).
createdBy	string	Identité qui a créé la ressource.
createdByType	createdByType	Type d’identité qui a créé la ressource.
lastModifiedAt	string (date-time)	Horodatage de la dernière modification de ressource (UTC)
lastModifiedBy	string	Identité qui a modifié la ressource pour la dernière fois.
lastModifiedByType	createdByType	Type d’identité qui a modifié la ressource pour la dernière fois.

Partager via

Addons - List By Role

Paramètres d’URI

Réponses

Sécurité

azure_auth

Étendues

Exemples

RoleListAddOns

Demande d’échantillon

Exemple de réponse

Définitions

AddonList

AddonState

AddonType

ArcAddon

AsymmetricEncryptedSecret

Authentication

CloudError

CloudErrorBody

createdByType

EncryptionAlgorithm

HostPlatformType

IoTAddon

IoTDeviceInfo

PlatformType

SymmetricKey

systemData