Addons - List By Role

Tjänst:: Data Box Edge/Data Box Gateway

API-version:: 2023-12-01

Visar en lista över alla tillägg som är konfigurerade i rollen.

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

URI-parametrar

Namn	I	Krävs	Typ	Beskrivning
deviceName	path	True	string	Namnet på enheten.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
roleName	path	True	string	Namnet på rollen.
subscriptionId	path	True	string minLength: 1	ID för målprenumerationen.
api-version	query	True	string minLength: 1	Den API-version som ska användas för den här åtgärden.

Svaren

Namn	Typ	Beskrivning
200 OK	AddonList	Azure-åtgärden har slutförts.
Other Status Codes	CloudError	Ett oväntat felsvar.

Säkerhet

azure_auth

Azure Active Directory OAuth2-flöde.

Typ: oauth2
Rinna: implicit
URL för auktorisering: https://login.microsoftonline.com/common/oauth2/authorize

Scope

Namn	Beskrivning
user_impersonation	personifiera ditt användarkonto

Exempel

RoleListAddOns

Exempel på begäran

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

Exempel på svar

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

Definitioner

Namn	Beskrivning
AddonList	Samling av alla rolltillägg på Azure Stack Edge-enheten.
AddonState	Tillstånd för tillhandahållande av tillägg
AddonType	Addon-typ.
ArcAddon	Arc tillägg.
AsymmetricEncryptedSecret	Representerar de hemligheter som är avsedda för kryptering med asymmetriskt nyckelpar.
Authentication	Autentiseringsmekanism för IoT-enheter.
CloudError	Ett felsvar från tjänsten.
CloudErrorBody	Ett felsvar från tjänsten.
createdByType	Den typ av identitet som skapade resursen.
EncryptionAlgorithm	Algoritmen som används för att kryptera "Värde".
HostPlatformType	Plattform där körningen finns.
IoTAddon	IoT-tillägg.
IoTDeviceInfo	Metadata för IoT-enhet/IoT Edge enhet som ska konfigureras.
PlatformType	Värdoperativsystemet stöds av Arc-tillägget.
SymmetricKey	Symmetrisk nyckel för autentisering.
systemData	Metadata som rör skapande och senaste ändring av resursen.

AddonList

Objekt

Samling av alla rolltillägg på Azure Stack Edge-enheten.

Namn	Typ	Beskrivning
nextLink	string (uri)	Länken till nästa sida med objekt
value	Addon[]: ArcAddon[] IoTAddon[]	Addon-objekten på den här sidan

AddonState

Uppräkning

Tillstånd för tillhandahållande av tillägg

Värde	Beskrivning
Invalid
Creating
Created
Updating
Reconfiguring
Failed
Deleting

AddonType

Uppräkning

Addon-typ.

Värde	Beskrivning
IotEdge
ArcForKubernetes

ArcAddon

Objekt

Arc tillägg.

Namn	Typ	Beskrivning
id	string	Fullständigt kvalificerat resurs-ID för resursen. Ex – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
kind	string: ArcForKubernetes pattern: ^[-\w\._,$\\$]+$	Addon-typ.
name	string	Namnet på resursen
properties.hostPlatform	PlatformType	Värdoperativsystemet stöds av Arc-tillägget.
properties.hostPlatformType	HostPlatformType	Plattform där körningen finns.
properties.provisioningState	AddonState	Tillstånd för tillhandahållande av tillägg
properties.resourceGroupName	string	Namn på Arc-resursgrupp
properties.resourceLocation	string	Arc-resursplats
properties.resourceName	string	Arc-resursnamn
properties.subscriptionId	string	Arc-resursprenumerations-ID
properties.version	string	Version av Arc-resurs
systemData	systemData	Azure Resource Manager-metadata som innehåller createdBy och modifiedBy information.
type	string	Resurstypen. T.ex. "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts"

AsymmetricEncryptedSecret

Objekt

Representerar de hemligheter som är avsedda för kryptering med asymmetriskt nyckelpar.

Namn	Typ	Beskrivning
encryptionAlgorithm	EncryptionAlgorithm	Algoritmen som används för att kryptera "Värde".
encryptionCertThumbprint	string (password)	Tumavtryckscertifikat som används för att kryptera "Värde". Om värdet är okrypterat blir det null.
value	string	Hemlighetens värde.

Authentication

Objekt

Autentiseringsmekanism för IoT-enheter.

Namn	Typ	Beskrivning
symmetricKey	SymmetricKey	Symmetrisk nyckel för autentisering.

CloudError

Objekt

Ett felsvar från tjänsten.

Namn	Typ	Beskrivning
error	CloudErrorBody	Felinformationen.

CloudErrorBody

Objekt

Ett felsvar från tjänsten.

Namn	Typ	Beskrivning
code	string	En identifierare för felet. Koder är invarianta och är avsedda att användas programmatiskt.
details	CloudErrorBody[]	En lista med ytterligare information om felet.
message	string	Ett meddelande som beskriver felet, avsett att vara lämpligt för visning i ett användargränssnitt.

createdByType

Uppräkning

Den typ av identitet som skapade resursen.

Värde	Beskrivning
User
Application
ManagedIdentity
Key

EncryptionAlgorithm

Uppräkning

Algoritmen som används för att kryptera "Värde".

Värde	Beskrivning
None
AES256
RSAES_PKCS1_v_1_5

HostPlatformType

Uppräkning

Plattform där körningen finns.

Värde	Beskrivning
KubernetesCluster
LinuxVM

IoTAddon

Objekt

IoT-tillägg.

Namn	Typ	Beskrivning
id	string	Fullständigt kvalificerat resurs-ID för resursen. Ex – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
kind	string: IotEdge pattern: ^[-\w\._,$\\$]+$	Addon-typ.
name	string	Namnet på resursen
properties.hostPlatform	PlatformType	Värdoperativsystemet stöds av IoT-tillägget.
properties.hostPlatformType	HostPlatformType	Plattform där körningen finns.
properties.ioTDeviceDetails	IoTDeviceInfo	IoT-enhetsmetadata som enheten måste vara ansluten till.
properties.ioTEdgeDeviceDetails	IoTDeviceInfo	IoT Edge-enhet som IoT Addon måste konfigureras till.
properties.provisioningState	AddonState	Tillstånd för tillhandahållande av tillägg
properties.version	string	Version av IoT som körs på installationen.
systemData	systemData	Azure Resource Manager-metadata som innehåller createdBy och modifiedBy information.
type	string	Resurstypen. T.ex. "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts"

IoTDeviceInfo

Objekt

Metadata för IoT-enhet/IoT Edge enhet som ska konfigureras.

Namn	Typ	Beskrivning
authentication	Authentication	Krypterad IoT-enhet/IoT Edge-enhetsanslutningssträng.
deviceId	string	ID för IoT-enheten/gränsenheten.
ioTHostHub	string	Värdnamn för den IoT-hubb som är associerad med enheten.
ioTHostHubId	string	ID för den IoT-hubb som är associerad med enheten.

PlatformType

Uppräkning

Värdoperativsystemet stöds av Arc-tillägget.

Värde	Beskrivning
Windows
Linux

SymmetricKey

Objekt

Symmetrisk nyckel för autentisering.

Namn	Typ	Beskrivning
connectionString	AsymmetricEncryptedSecret	Anslutningssträng baserat på den symmetriska nyckeln.

systemData

Objekt

Metadata som rör skapande och senaste ändring av resursen.

Namn	Typ	Beskrivning
createdAt	string (date-time)	Tidsstämpeln för resursskapande (UTC).
createdBy	string	Identiteten som skapade resursen.
createdByType	createdByType	Den typ av identitet som skapade resursen.
lastModifiedAt	string (date-time)	Tidsstämpeln för resursens senaste ändring (UTC)
lastModifiedBy	string	Identiteten som senast ändrade resursen.
lastModifiedByType	createdByType	Den typ av identitet som senast ändrade resursen.

Dela via

Addons - List By Role

URI-parametrar

Svaren

Säkerhet

azure_auth

Scope

Exempel

RoleListAddOns

Exempel på begäran

Exempel på svar

Definitioner

AddonList

AddonState

AddonType

ArcAddon

AsymmetricEncryptedSecret

Authentication

CloudError

CloudErrorBody

createdByType

EncryptionAlgorithm

HostPlatformType

IoTAddon

IoTDeviceInfo

PlatformType

SymmetricKey

systemData