Addons - List By Role

Служба:: Data Box Edge/Data Box Gateway

Версия API:: 2023-12-01

Список всех аддонов, настроенных в роли.

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
deviceName	path	True	string	Имя устройства.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Имя группы ресурсов. Имя не зависит от регистра.
roleName	path	True	string	Имя роли.
subscriptionId	path	True	string minLength: 1	Идентификатор целевой подписки.
api-version	query	True	string minLength: 1	Версия API, используемая для данной операции.

Ответы

Имя	Тип	Описание
200 OK	AddonList	Операция Azure успешно завершена.
Other Status Codes	CloudError	Непредвиденное сообщение об ошибке.

Безопасность

azure_auth

Поток OAuth2 Azure Active Directory.

Тип: oauth2
Течь: implicit
URL авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

RoleListAddOns

Образец запроса

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

Пример ответа

Код состояния:: 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"
      }
    }
  ]
}

Определения

Имя	Описание
AddonList	Коллекция всех дополнений Role на устройстве Azure Stack Edge.
AddonState	Состояние подготовки аддона
AddonType	Тип надстройки.
ArcAddon	Аддон Arc.
AsymmetricEncryptedSecret	Представляют секреты, предназначенные для шифрования, с помощью асимметричной пары ключей.
Authentication	Механизм аутентификации для устройств IoT.
CloudError	Ответ на ошибку службы.
CloudErrorBody	Ответ на ошибку службы.
createdByType	Тип удостоверения, создавшего ресурс.
EncryptionAlgorithm	Алгоритм, используемый для шифрования "Значение".
HostPlatformType	Платформа, на которой размещена среда выполнения.
IoTAddon	Аддон IoT.
IoTDeviceInfo	Метаданные устройства IoT/устройства IoT Edge, которое необходимо настроить.
PlatformType	Хост ОС поддерживается аддоном Arc.
SymmetricKey	Симметричный ключ для проверки подлинности.
systemData	Метаданные, относящиеся к созданию и последнему изменении ресурса.

AddonList

Объект

Коллекция всех дополнений Role на устройстве Azure Stack Edge.

Имя	Тип	Описание
nextLink	string (uri)	Ссылка на следующую страницу элементов
value	Addon[]: ArcAddon[] IoTAddon[]	Элементы Addon на этой странице

AddonState

Перечисление

Состояние подготовки аддона

Ценность	Описание
Invalid
Creating
Created
Updating
Reconfiguring
Failed
Deleting

AddonType

Перечисление

Тип надстройки.

Ценность	Описание
IotEdge
ArcForKubernetes

ArcAddon

Объект

Аддон Arc.

Имя	Тип	Описание
id	string	Полный идентификатор ресурса для ресурса. Пример - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
kind	string: ArcForKubernetes pattern: ^[-\w\._,$\\$]+$	Тип надстройки.
name	string	Имя ресурса
properties.hostPlatform	PlatformType	Хост ОС поддерживается аддоном Arc.
properties.hostPlatformType	HostPlatformType	Платформа, на которой размещена среда выполнения.
properties.provisioningState	AddonState	Состояние подготовки аддона
properties.resourceGroupName	string	Имя группы ресурсов Arc
properties.resourceLocation	string	Расположение ресурса Arc
properties.resourceName	string	Имя ресурса Arc
properties.subscriptionId	string	Идентификатор подписки на ресурс Arc
properties.version	string	Версия ресурса Arc
systemData	systemData	Метаданные Azure Resource Manager, содержащие данные createdBy и modifiedBy.
type	string	Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts"

AsymmetricEncryptedSecret

Объект

Представляют секреты, предназначенные для шифрования, с помощью асимметричной пары ключей.

Имя	Тип	Описание
encryptionAlgorithm	EncryptionAlgorithm	Алгоритм, используемый для шифрования "Значение".
encryptionCertThumbprint	string (password)	Сертификат отпечатка, используемый для шифрования "Значение". Если значение незашифровывается, оно будет иметь значение NULL.
value	string	Значение секрета.

Authentication

Объект

Механизм аутентификации для устройств IoT.

Имя	Тип	Описание
symmetricKey	SymmetricKey	Симметричный ключ для проверки подлинности.

CloudError

Объект

Ответ на ошибку службы.

Имя	Тип	Описание
error	CloudErrorBody	Сведения об ошибке.

CloudErrorBody

Объект

Ответ на ошибку службы.

Имя	Тип	Описание
code	string	Идентификатор ошибки. Коды являются инвариантными и предназначены для программного использования.
details	CloudErrorBody[]	Список дополнительных сведений об ошибке.
message	string	Сообщение, описывающее ошибку, предназначенное для отображения в пользовательском интерфейсе.

createdByType

Перечисление

Тип удостоверения, создавшего ресурс.

Ценность	Описание
User
Application
ManagedIdentity
Key

EncryptionAlgorithm

Перечисление

Алгоритм, используемый для шифрования "Значение".

Ценность	Описание
None
AES256
RSAES_PKCS1_v_1_5

HostPlatformType

Перечисление

Платформа, на которой размещена среда выполнения.

Ценность	Описание
KubernetesCluster
LinuxVM

IoTAddon

Объект

Аддон IoT.

Имя	Тип	Описание
id	string	Полный идентификатор ресурса для ресурса. Пример - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
kind	string: IotEdge pattern: ^[-\w\._,$\\$]+$	Тип надстройки.
name	string	Имя ресурса
properties.hostPlatform	PlatformType	Хост ОС поддерживается дополнением IoT.
properties.hostPlatformType	HostPlatformType	Платформа, на которой размещена среда выполнения.
properties.ioTDeviceDetails	IoTDeviceInfo	Метаданные устройства Интернета вещей, к которым необходимо подключить устройство.
properties.ioTEdgeDeviceDetails	IoTDeviceInfo	Устройство IoT edge, для которого необходимо настроить надстройку Интернета вещей.
properties.provisioningState	AddonState	Состояние подготовки аддона
properties.version	string	Версия IoT, работающая на устройстве.
systemData	systemData	Метаданные Azure Resource Manager, содержащие данные createdBy и modifiedBy.
type	string	Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts"

IoTDeviceInfo

Объект

Метаданные устройства IoT/устройства IoT Edge, которое необходимо настроить.

Имя	Тип	Описание
authentication	Authentication	Зашифрованное устройство Интернета вещей или строка подключения устройства IoT edge.
deviceId	string	Идентификатор устройства Интернета вещей или пограничного устройства.
ioTHostHub	string	Имя узла для Центра Интернета вещей, связанного с устройством.
ioTHostHubId	string	Идентификатор центра Интернета вещей, связанного с устройством.

PlatformType

Перечисление

Хост ОС поддерживается аддоном Arc.

Ценность	Описание
Windows
Linux

SymmetricKey

Объект

Симметричный ключ для проверки подлинности.

Имя	Тип	Описание
connectionString	AsymmetricEncryptedSecret	Строка подключения на основе симметричного ключа.

systemData

Объект

Метаданные, относящиеся к созданию и последнему изменении ресурса.

Имя	Тип	Описание
createdAt	string (date-time)	Метка времени создания ресурса (UTC).
createdBy	string	Удостоверение, создающее ресурс.
createdByType	createdByType	Тип удостоверения, создавшего ресурс.
lastModifiedAt	string (date-time)	Метка времени последнего изменения ресурса (UTC)
lastModifiedBy	string	Идентификатор, который последний раз изменил ресурс.
lastModifiedByType	createdByType	Тип удостоверения, который последний раз изменил ресурс.

Поделиться через

Addons - List By Role

Параметры URI

Ответы

Безопасность

azure_auth

Области

Примеры

RoleListAddOns

Образец запроса

Пример ответа

Определения

AddonList

AddonState

AddonType

ArcAddon

AsymmetricEncryptedSecret

Authentication

CloudError

CloudErrorBody

createdByType

EncryptionAlgorithm

HostPlatformType

IoTAddon

IoTDeviceInfo

PlatformType

SymmetricKey

systemData