Addons - List By Role

Usługa:: Data Box Edge/Data Box Gateway

Wersja interfejsu API:: 2023-12-01

Wyświetla listę wszystkich dodatków skonfigurowanych w roli.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
deviceName	path	True	string	Nazwa urządzenia.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
roleName	path	True	string	Nazwa roli.
subscriptionId	path	True	string minLength: 1	Identyfikator subskrypcji docelowej.
api-version	query	True	string minLength: 1	Wersja interfejsu API do użycia dla tej operacji.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	AddonList	Operacja platformy Azure została zakończona pomyślnie.
Other Status Codes	CloudError	Nieoczekiwana odpowiedź na błąd.

Zabezpieczenia

azure_auth

Przepływ OAuth2 w usłudze Azure Active Directory.

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresów

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

RoleListAddOns

Przykładowe zapytanie

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

Przykładowa odpowiedź

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

Definicje

Nazwa	Opis
AddonList	Kolekcja wszystkich dodatków Role na urządzeniu Azure Stack Edge.
AddonState	Stan aprowizacji dodatków
AddonType	Typ dodatku.
ArcAddon	Dodatek do łuku.
AsymmetricEncryptedSecret	Reprezentują wpisy tajne przeznaczone do szyfrowania za pomocą asymetrycznej pary kluczy.
Authentication	Mechanizm uwierzytelniania dla urządzeń IoT.
CloudError	Odpowiedź na błąd z usługi.
CloudErrorBody	Odpowiedź na błąd z usługi.
createdByType	Typ tożsamości, która utworzyła zasób.
EncryptionAlgorithm	Algorytm używany do szyfrowania wartości.
HostPlatformType	Platforma, na której hostowane jest środowisko uruchomieniowe.
IoTAddon	Dodatek IoT.
IoTDeviceInfo	Metadane urządzenia IoT/urządzenia IoT Edge, które mają zostać skonfigurowane.
PlatformType	System operacyjny hosta obsługiwany przez dodatek Arc.
SymmetricKey	Klucz symetryczny na potrzeby uwierzytelniania.
systemData	Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

AddonList

Sprzeciwiać się

Kolekcja wszystkich dodatków Role na urządzeniu Azure Stack Edge.

Nazwa	Typ	Opis
nextLink	string (uri)	Link do następnej strony z elementami
value	Addon[]: ArcAddon[] IoTAddon[]	Elementy dodatku na tej stronie

AddonState

Wyliczenie

Stan aprowizacji dodatków

Wartość	Opis
Invalid
Creating
Created
Updating
Reconfiguring
Failed
Deleting

AddonType

Wyliczenie

Typ dodatku.

Wartość	Opis
IotEdge
ArcForKubernetes

ArcAddon

Sprzeciwiać się

Dodatek do łuku.

Nazwa	Typ	Opis
id	string	W pełni kwalifikowany identyfikator zasobu dla zasobu. Przykład - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
kind	string: ArcForKubernetes pattern: ^[-\w\._,$\\$]+$	Typ dodatku.
name	string	Nazwa zasobu
properties.hostPlatform	PlatformType	System operacyjny hosta obsługiwany przez dodatek Arc.
properties.hostPlatformType	HostPlatformType	Platforma, na której hostowane jest środowisko uruchomieniowe.
properties.provisioningState	AddonState	Stan aprowizacji dodatków
properties.resourceGroupName	string	Nazwa grupy zasobów usługi Arc
properties.resourceLocation	string	Lokalizacja zasobu usługi Arc
properties.resourceName	string	Nazwa zasobu usługi Arc
properties.subscriptionId	string	Identyfikator subskrypcji zasobu usługi Arc
properties.version	string	Wersja zasobu usługi Arc
systemData	systemData	Metadane usługi Azure Resource Manager zawierające informacje „createdBy” i „modifiedBy”.
type	string	Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts"

AsymmetricEncryptedSecret

Sprzeciwiać się

Reprezentują wpisy tajne przeznaczone do szyfrowania za pomocą asymetrycznej pary kluczy.

Nazwa	Typ	Opis
encryptionAlgorithm	EncryptionAlgorithm	Algorytm używany do szyfrowania wartości.
encryptionCertThumbprint	string (password)	Certyfikat odcisku palca używany do szyfrowania wartości. Jeśli wartość jest niezaszyfrowana, będzie mieć wartość null.
value	string	Wartość wpisu tajnego.

Authentication

Sprzeciwiać się

Mechanizm uwierzytelniania dla urządzeń IoT.

Nazwa	Typ	Opis
symmetricKey	SymmetricKey	Klucz symetryczny na potrzeby uwierzytelniania.

CloudError

Sprzeciwiać się

Odpowiedź na błąd z usługi.

Nazwa	Typ	Opis
error	CloudErrorBody	Szczegóły błędu.

CloudErrorBody

Sprzeciwiać się

Odpowiedź na błąd z usługi.

Nazwa	Typ	Opis
code	string	Identyfikator błędu. Kody są niezmienne i mają być używane programowo.
details	CloudErrorBody[]	Lista dodatkowych szczegółów dotyczących błędu.
message	string	Komunikat opisujący błąd, który ma być odpowiedni do wyświetlania w interfejsie użytkownika.

createdByType

Wyliczenie

Typ tożsamości, która utworzyła zasób.

Wartość	Opis
User
Application
ManagedIdentity
Key

EncryptionAlgorithm

Wyliczenie

Algorytm używany do szyfrowania wartości.

Wartość	Opis
None
AES256
RSAES_PKCS1_v_1_5

HostPlatformType

Wyliczenie

Platforma, na której hostowane jest środowisko uruchomieniowe.

Wartość	Opis
KubernetesCluster
LinuxVM

IoTAddon

Sprzeciwiać się

Dodatek IoT.

Nazwa	Typ	Opis
id	string	W pełni kwalifikowany identyfikator zasobu dla zasobu. Przykład - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
kind	string: IotEdge pattern: ^[-\w\._,$\\$]+$	Typ dodatku.
name	string	Nazwa zasobu
properties.hostPlatform	PlatformType	System operacyjny hosta obsługiwany przez dodatek IoT.
properties.hostPlatformType	HostPlatformType	Platforma, na której hostowane jest środowisko uruchomieniowe.
properties.ioTDeviceDetails	IoTDeviceInfo	Metadane urządzenia IoT, z którymi urządzenie musi być połączone.
properties.ioTEdgeDeviceDetails	IoTDeviceInfo	Urządzenie usługi IoT Edge, do którego należy skonfigurować dodatek IoT.
properties.provisioningState	AddonState	Stan aprowizacji dodatków
properties.version	string	Wersja IoT uruchomiona na urządzeniu.
systemData	systemData	Metadane usługi Azure Resource Manager zawierające informacje „createdBy” i „modifiedBy”.
type	string	Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts"

IoTDeviceInfo

Sprzeciwiać się

Metadane urządzenia IoT/urządzenia IoT Edge, które mają zostać skonfigurowane.

Nazwa	Typ	Opis
authentication	Authentication	Zaszyfrowane parametry połączenia urządzenia usługi IoT/usługi IoT Edge.
deviceId	string	Identyfikator urządzenia IoT/urządzenia brzegowego.
ioTHostHub	string	Nazwa hosta centrum IoT skojarzonego z urządzeniem.
ioTHostHubId	string	Identyfikator centrum IoT skojarzonego z urządzeniem.

PlatformType

Wyliczenie

System operacyjny hosta obsługiwany przez dodatek Arc.

Wartość	Opis
Windows
Linux

SymmetricKey

Sprzeciwiać się

Klucz symetryczny na potrzeby uwierzytelniania.

Nazwa	Typ	Opis
connectionString	AsymmetricEncryptedSecret	Parametry połączenia oparte na kluczu symetrycznym.

systemData

Sprzeciwiać się

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

Nazwa	Typ	Opis
createdAt	string (date-time)	Sygnatura czasowa tworzenia zasobu (UTC).
createdBy	string	Tożsamość, która utworzyła zasób.
createdByType	createdByType	Typ tożsamości, która utworzyła zasób.
lastModifiedAt	string (date-time)	Znacznik czasu ostatniej modyfikacji zasobu (UTC)
lastModifiedBy	string	Tożsamość, która ostatnio zmodyfikowała zasób.
lastModifiedByType	createdByType	Typ tożsamości, która ostatnio zmodyfikowała zasób.

Udostępnij za pośrednictwem

Addons - List By Role

Parametry identyfikatora URI

Odpowiedzi

Zabezpieczenia

azure_auth

Zakresów

Przykłady

RoleListAddOns

Przykładowe zapytanie

Przykładowa odpowiedź

Definicje

AddonList

AddonState

AddonType

ArcAddon

AsymmetricEncryptedSecret

Authentication

CloudError

CloudErrorBody

createdByType

EncryptionAlgorithm

HostPlatformType

IoTAddon

IoTDeviceInfo

PlatformType

SymmetricKey

systemData