Addons - List By Role

Servizio:: Data Box Edge/Data Box Gateway

Versione API:: 2023-12-01

Elenca tutti i componenti aggiuntivi configurati nel ruolo.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
deviceName	path	True	string	Nome del dispositivo.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nome del gruppo di risorse. Il nome è insensibile alle maiuscole e minuscole.
roleName	path	True	string	Nome ruolo.
subscriptionId	path	True	string minLength: 1	ID della sottoscrizione di destinazione.
api-version	query	True	string minLength: 1	Versione dell'API da usare per questa operazione.

Risposte

Nome	Tipo	Descrizione
200 OK	AddonList	L'operazione di Azure è stata completata correttamente.
Other Status Codes	CloudError	Risposta di errore imprevista.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

RoleListAddOns

Esempio di richiesta

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

Risposta di esempio

Codice di stato:: 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"
      }
    }
  ]
}

Definizioni

Nome	Descrizione
AddonList	Raccolta di tutti i componenti aggiuntivi del ruolo nel dispositivo Azure Stack Edge.
AddonState	Stato di provisioning dell'add-on
AddonType	Tipo di componente aggiuntivo.
ArcAddon	Componente aggiuntivo Arco.
AsymmetricEncryptedSecret	Rappresentano i segreti destinati alla crittografia con coppia di chiavi asimmetriche.
Authentication	Meccanismo di autenticazione per i dispositivi IoT.
CloudError	Risposta di errore dal servizio.
CloudErrorBody	Risposta di errore dal servizio.
createdByType	Tipo di identità che ha creato la risorsa.
EncryptionAlgorithm	Algoritmo utilizzato per crittografare "Value".
HostPlatformType	Piattaforma in cui è ospitato il runtime.
IoTAddon	Add-on IoT.
IoTDeviceInfo	Metadati del dispositivo IoT/dispositivo IoT Edge da configurare.
PlatformType	Sistema operativo host supportato dall'add-on Arc.
SymmetricKey	Chiave simmetrica per l'autenticazione.
systemData	Metadati relativi alla creazione e all'ultima modifica della risorsa.

AddonList

Oggetto

Raccolta di tutti i componenti aggiuntivi del ruolo nel dispositivo Azure Stack Edge.

Nome	Tipo	Descrizione
nextLink	string (uri)	Il link alla pagina successiva degli elementi
value	Addon[]: ArcAddon[] IoTAddon[]	Elementi del componente aggiuntivo in questa pagina

AddonState

Enumerazione

Stato di provisioning dell'add-on

Valore	Descrizione
Invalid
Creating
Created
Updating
Reconfiguring
Failed
Deleting

AddonType

Enumerazione

Tipo di componente aggiuntivo.

Valore	Descrizione
IotEdge
ArcForKubernetes

ArcAddon

Oggetto

Componente aggiuntivo Arco.

Nome	Tipo	Descrizione
id	string	ID risorsa completo per la risorsa. Ad esempio: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
kind	string: ArcForKubernetes pattern: ^[-\w\._,$\\$]+$	Tipo di componente aggiuntivo.
name	string	Nome della risorsa
properties.hostPlatform	PlatformType	Sistema operativo host supportato dall'add-on Arc.
properties.hostPlatformType	HostPlatformType	Piattaforma in cui è ospitato il runtime.
properties.provisioningState	AddonState	Stato di provisioning dell'add-on
properties.resourceGroupName	string	Nome del gruppo di risorse Arc
properties.resourceLocation	string	Percorso risorsa Arc
properties.resourceName	string	Nome risorsa Arc
properties.subscriptionId	string	ID sottoscrizione risorsa Arc
properties.version	string	Versione della risorsa Arc
systemData	systemData	Metadati di Azure Resource Manager contenenti informazioni createdBy e modifiedBy.
type	string	Tipo di risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

AsymmetricEncryptedSecret

Oggetto

Rappresentano i segreti destinati alla crittografia con coppia di chiavi asimmetriche.

Nome	Tipo	Descrizione
encryptionAlgorithm	EncryptionAlgorithm	Algoritmo utilizzato per crittografare "Value".
encryptionCertThumbprint	string (password)	Certificato di identificazione personale usato per crittografare "Valore". Se il valore non è crittografato, sarà Null.
value	string	Valore del segreto.

Authentication

Oggetto

Meccanismo di autenticazione per i dispositivi IoT.

Nome	Tipo	Descrizione
symmetricKey	SymmetricKey	Chiave simmetrica per l'autenticazione.

CloudError

Oggetto

Risposta di errore dal servizio.

Nome	Tipo	Descrizione
error	CloudErrorBody	Dettagli dell'errore.

CloudErrorBody

Oggetto

Risposta di errore dal servizio.

Nome	Tipo	Descrizione
code	string	Identificatore dell'errore. I codici sono invarianti e devono essere utilizzati a livello di codice.
details	CloudErrorBody[]	Elenco di dettagli aggiuntivi sull'errore.
message	string	Messaggio che descrive l'errore, destinato a essere adatto per la visualizzazione in un'interfaccia utente.

createdByType

Enumerazione

Tipo di identità che ha creato la risorsa.

Valore	Descrizione
User
Application
ManagedIdentity
Key

EncryptionAlgorithm

Enumerazione

Algoritmo utilizzato per crittografare "Value".

Valore	Descrizione
None
AES256
RSAES_PKCS1_v_1_5

HostPlatformType

Enumerazione

Piattaforma in cui è ospitato il runtime.

Valore	Descrizione
KubernetesCluster
LinuxVM

IoTAddon

Oggetto

Add-on IoT.

Nome	Tipo	Descrizione
id	string	ID risorsa completo per la risorsa. Ad esempio: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
kind	string: IotEdge pattern: ^[-\w\._,$\\$]+$	Tipo di componente aggiuntivo.
name	string	Nome della risorsa
properties.hostPlatform	PlatformType	Sistema operativo host supportato dall'add-on IoT.
properties.hostPlatformType	HostPlatformType	Piattaforma in cui è ospitato il runtime.
properties.ioTDeviceDetails	IoTDeviceInfo	Metadati del dispositivo IoT a cui deve essere connessa l'appliance.
properties.ioTEdgeDeviceDetails	IoTDeviceInfo	Dispositivo IoT Edge a cui deve essere configurato il componente aggiuntivo IoT.
properties.provisioningState	AddonState	Stato di provisioning dell'add-on
properties.version	string	Versione di IoT in esecuzione nell'appliance.
systemData	systemData	Metadati di Azure Resource Manager contenenti informazioni createdBy e modifiedBy.
type	string	Tipo di risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

IoTDeviceInfo

Oggetto

Metadati del dispositivo IoT/dispositivo IoT Edge da configurare.

Nome	Tipo	Descrizione
authentication	Authentication	Stringa di connessione del dispositivo IoT/dispositivo IoT edge crittografata.
deviceId	string	ID del dispositivo IoT/edge.
ioTHostHub	string	Nome host per l'hub IoT associato al dispositivo.
ioTHostHubId	string	ID per l'hub IoT associato al dispositivo.

PlatformType

Enumerazione

Sistema operativo host supportato dall'add-on Arc.

Valore	Descrizione
Windows
Linux

SymmetricKey

Oggetto

Chiave simmetrica per l'autenticazione.

Nome	Tipo	Descrizione
connectionString	AsymmetricEncryptedSecret	Stringa di connessione basata sulla chiave simmetrica.

systemData

Oggetto

Metadati relativi alla creazione e all'ultima modifica della risorsa.

Nome	Tipo	Descrizione
createdAt	string (date-time)	Timestamp della creazione della risorsa (UTC).
createdBy	string	Identità che ha creato la risorsa.
createdByType	createdByType	Tipo di identità che ha creato la risorsa.
lastModifiedAt	string (date-time)	Timestamp dell'ultima modifica della risorsa (UTC)
lastModifiedBy	string	Identità che ha modificato l'ultima volta la risorsa.
lastModifiedByType	createdByType	Tipo di identità che ha modificato l'ultima volta la risorsa.

Condividi tramite

Addons - List By Role

Parametri dell'URI

Risposte

Sicurezza

azure_auth

Ambiti

Esempio

RoleListAddOns

Esempio di richiesta

Risposta di esempio

Definizioni

AddonList

AddonState

AddonType

ArcAddon

AsymmetricEncryptedSecret

Authentication

CloudError

CloudErrorBody

createdByType

EncryptionAlgorithm

HostPlatformType

IoTAddon

IoTDeviceInfo

PlatformType

SymmetricKey

systemData