Microsoft.DataBoxEdge dataBoxEdgeDevices/roles 2020-05-01-preview

  • Статья

Определение ресурса Bicep

Тип ресурса dataBoxEdgeDevices/roles можно развернуть с помощью операций, предназначенных для:

Список измененных свойств в каждой версии API см. в журнале изменений.

Формат ресурсов

Чтобы создать ресурс Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles, добавьте в шаблон следующий Bicep.

resource symbolicname 'Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles@2020-05-01-preview' = {
  name: 'string'
  kind: 'string'
  parent: resourceSymbolicName
  // For remaining properties, see dataBoxEdgeDevices/roles objects
}

Объекты dataBoxEdgeDevices/roles

Задайте свойство kind , чтобы указать тип объекта .

Для Интернета вещей используйте:

  kind: 'IOT'
  properties: {
    hostPlatform: 'string'
    ioTDeviceDetails: {
      authentication: {
        symmetricKey: {
          connectionString: {
            encryptionAlgorithm: 'string'
            encryptionCertThumbprint: 'string'
            value: 'string'
          }
        }
      }
      deviceId: 'string'
      ioTHostHub: 'string'
      ioTHostHubId: 'string'
    }
    ioTEdgeAgentInfo: {
      imageName: 'string'
      imageRepository: {
        imageRepositoryUrl: 'string'
        password: {
          encryptionAlgorithm: 'string'
          encryptionCertThumbprint: 'string'
          value: 'string'
        }
        userName: 'string'
      }
      tag: 'string'
    }
    ioTEdgeDeviceDetails: {
      authentication: {
        symmetricKey: {
          connectionString: {
            encryptionAlgorithm: 'string'
            encryptionCertThumbprint: 'string'
            value: 'string'
          }
        }
      }
      deviceId: 'string'
      ioTHostHub: 'string'
      ioTHostHubId: 'string'
    }
    roleStatus: 'string'
    shareMappings: [
      {
        shareId: 'string'
      }
    ]
  }

Значения свойств

dataBoxEdgeDevices/roles

Имя Описание Значение
name имя ресурса.

Узнайте, как задать имена и типы для дочерних ресурсов в Bicep.		 строка (обязательно)
kind Установка типа объекта IOT (обязательно)
родитель В Bicep можно указать родительский ресурс для дочернего ресурса. Это свойство необходимо добавить только в том случае, если дочерний ресурс объявлен вне родительского ресурса.

Дополнительные сведения см. в разделе Дочерний ресурс за пределами родительского ресурса.		 Символьное имя ресурса типа: dataBoxEdgeDevices

IoTRole

Имя Описание Значение
kind Тип роли. IOT (обязательно)
properties Свойства, относящиеся к роли Интернета вещей. IoTRoleProperties

IoTRoleProperties

Имя Описание Значение
hostPlatform ОС узла, поддерживаемая ролью Интернета вещей. Linux
Windows (обязательно)
ioTDeviceDetails Метаданные устройства Интернета вещей, к которым необходимо подключить пограничное устройство Data Box. IoTDeviceInfo (обязательно)
ioTEdgeAgentInfo Сведения об агенте Iot Edge для скачивания агента и начальной загрузки среды выполнения Интернета вещей. IoTEdgeAgentInfo
ioTEdgeDeviceDetails Устройство IoT Edge, для которого необходимо настроить роль Интернета вещей. IoTDeviceInfo (обязательно)
roleStatus Состояние роли. "Отключено"
"Включено" (обязательно)
shareMappings Точки подключения общих папок в роли. MountPointMap[]

IoTDeviceInfo

Имя Описание Значение
проверка подлинности Зашифрованное устройство Интернета вещей или устройство IoT Edge строка подключения. Аутентификация
deviceId Идентификатор устройства Интернета вещей или пограничного устройства. строка (обязательно)
ioTHostHub Имя узла для Центра Интернета вещей, связанного с устройством. строка (обязательно)
ioTHostHubId Идентификатор центра Интернета вещей, связанного с устройством. строка

Аутентификация

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

SymmetricKey

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

AsymmetricEncryptedSecret

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

IoTEdgeAgentInfo

Имя Описание Значение
imageName Имя образа агента IoT Edge. string (обязательно)
imageRepository Сведения о репозитории образов. ImageRepositoryCredential
тег Тег изображения. string (обязательно)

ImageRepositoryCredential

Имя Описание Значение
imageRepositoryUrl URL-адрес репозитория изображений (например, mcr.microsoft.com). string (обязательно)
password Пароль пользователя репозитория. AsymmetricEncryptedSecret
userName Имя пользователя репозитория. string (обязательно)

MountPointMap

Имя Описание Значение
shareId Идентификатор общей папки, подключенной к виртуальной машине роли. string (обязательно)

Определение ресурса шаблона ARM

Тип ресурса dataBoxEdgeDevices/roles можно развернуть с помощью операций, предназначенных для:

Список измененных свойств в каждой версии API см. в журнале изменений.

Формат ресурсов

Чтобы создать ресурс Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles, добавьте следующий код JSON в шаблон.

{
  "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles",
  "apiVersion": "2020-05-01-preview",
  "name": "string",
  "kind": "string",
  // For remaining properties, see dataBoxEdgeDevices/roles objects
}

Объекты dataBoxEdgeDevices/roles

Задайте свойство kind , чтобы указать тип объекта .

Для Интернета вещей используйте:

  "kind": "IOT",
  "properties": {
    "hostPlatform": "string",
    "ioTDeviceDetails": {
      "authentication": {
        "symmetricKey": {
          "connectionString": {
            "encryptionAlgorithm": "string",
            "encryptionCertThumbprint": "string",
            "value": "string"
          }
        }
      },
      "deviceId": "string",
      "ioTHostHub": "string",
      "ioTHostHubId": "string"
    },
    "ioTEdgeAgentInfo": {
      "imageName": "string",
      "imageRepository": {
        "imageRepositoryUrl": "string",
        "password": {
          "encryptionAlgorithm": "string",
          "encryptionCertThumbprint": "string",
          "value": "string"
        },
        "userName": "string"
      },
      "tag": "string"
    },
    "ioTEdgeDeviceDetails": {
      "authentication": {
        "symmetricKey": {
          "connectionString": {
            "encryptionAlgorithm": "string",
            "encryptionCertThumbprint": "string",
            "value": "string"
          }
        }
      },
      "deviceId": "string",
      "ioTHostHub": "string",
      "ioTHostHubId": "string"
    },
    "roleStatus": "string",
    "shareMappings": [
      {
        "shareId": "string"
      }
    ]
  }

Значения свойств

dataBoxEdgeDevices/roles

Имя Описание Значение
тип Тип ресурса Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles
версия_API Версия API ресурсов '2020-05-01-preview'
name имя ресурса.

Узнайте, как задать имена и типы для дочерних ресурсов в шаблонах JSON ARM.		 string (обязательно)
kind Установка типа объекта IOT (обязательно)

IoTRole

Имя Описание Значение
kind Тип роли. "IOT" (обязательно)
properties Свойства, относящиеся к роли Интернета вещей. IoTRoleProperties

IoTRoleProperties

Имя Описание Значение
hostPlatform ОС узла, поддерживаемая ролью Интернета вещей. Linux
"Windows" (обязательно)
ioTDeviceDetails Метаданные устройства Интернета вещей, к которым необходимо подключить пограничное устройство Data Box. IoTDeviceInfo (обязательно)
ioTEdgeAgentInfo Сведения об агенте Ioot Edge для скачивания агента и начальной загрузки среды выполнения iot. IoTEdgeAgentInfo
ioTEdgeDeviceDetails Устройство IoT Edge, для которого необходимо настроить роль Интернета вещей. IoTDeviceInfo (обязательно)
roleStatus Состояние роли. "Отключено"
"Включено" (обязательно)
shareMappings Подключение точек общих папок в роли. MountPointMap[]

IoTDeviceInfo

Имя Описание Значение
проверка подлинности Зашифрованное устройство Интернета вещей или устройство IoT Edge строка подключения. Аутентификация
deviceId Идентификатор устройства Интернета вещей или пограничного устройства. string (обязательно)
ioTHostHub Имя узла для Центра Интернета вещей, связанного с устройством. string (обязательно)
ioTHostHubId Идентификатор центра Интернета вещей, связанного с устройством. строка

Аутентификация

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

SymmetricKey

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

AsymmetricEncryptedSecret

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

IoTEdgeAgentInfo

Имя Описание Значение
imageName Имя образа агента IoT Edge. string (обязательно)
imageRepository Сведения о репозитории образов. ImageRepositoryCredential
тег Тег изображения. string (обязательно)

ImageRepositoryCredential

Имя Описание Значение
imageRepositoryUrl URL-адрес репозитория изображений (например, mcr.microsoft.com). string (обязательно)
password Пароль пользователя репозитория. AsymmetricEncryptedSecret
userName Имя пользователя репозитория. string (обязательно)

MountPointMap

Имя Описание Значение
shareId Идентификатор общей папки, подключенной к виртуальной машине роли. строка (обязательно)

Определение ресурса Terraform (поставщик AzAPI)

Тип ресурса dataBoxEdgeDevices/roles можно развернуть с помощью операций, предназначенных для:

  • Группы ресурсов

Список измененных свойств в каждой версии API см. в журнале изменений.

Формат ресурсов

Чтобы создать ресурс Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles, добавьте в шаблон следующую terraform.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles@2020-05-01-preview"
  name = "string"
  parent_id = "string"
  // For remaining properties, see dataBoxEdgeDevices/roles objects
  body = jsonencode({
    kind = "string"
  })
}

Объекты dataBoxEdgeDevices/roles

Задайте свойство kind , чтобы указать тип объекта .

Для Интернета вещей используйте:

  kind = "IOT"
  properties = {
    hostPlatform = "string"
    ioTDeviceDetails = {
      authentication = {
        symmetricKey = {
          connectionString = {
            encryptionAlgorithm = "string"
            encryptionCertThumbprint = "string"
            value = "string"
          }
        }
      }
      deviceId = "string"
      ioTHostHub = "string"
      ioTHostHubId = "string"
    }
    ioTEdgeAgentInfo = {
      imageName = "string"
      imageRepository = {
        imageRepositoryUrl = "string"
        password = {
          encryptionAlgorithm = "string"
          encryptionCertThumbprint = "string"
          value = "string"
        }
        userName = "string"
      }
      tag = "string"
    }
    ioTEdgeDeviceDetails = {
      authentication = {
        symmetricKey = {
          connectionString = {
            encryptionAlgorithm = "string"
            encryptionCertThumbprint = "string"
            value = "string"
          }
        }
      }
      deviceId = "string"
      ioTHostHub = "string"
      ioTHostHubId = "string"
    }
    roleStatus = "string"
    shareMappings = [
      {
        shareId = "string"
      }
    ]
  }

Значения свойств

dataBoxEdgeDevices/roles

Имя Описание Значение
тип Тип ресурса "Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles@2020-05-01-preview"
name имя ресурса. строка (обязательно)
parent_id Идентификатор ресурса, который является родительским для этого ресурса. Идентификатор ресурса типа: dataBoxEdgeDevices
kind Установка типа объекта IOT (обязательно)

IoTRole

Имя Описание Значение
kind Тип роли. "IOT" (обязательно)
properties Свойства, относящиеся к роли Интернета вещей. IoTRoleProperties

IoTRoleProperties

Имя Описание Значение
hostPlatform ОС узла, поддерживаемая ролью Интернета вещей. "Linux"
"Windows" (обязательно)
ioTDeviceDetails Метаданные устройства Интернета вещей, к которым необходимо подключить пограничное устройство Data Box. IoTDeviceInfo (обязательно)
ioTEdgeAgentInfo Сведения об агенте Iot Edge для скачивания агента и начальной загрузки среды выполнения Интернета вещей. IoTEdgeAgentInfo
ioTEdgeDeviceDetails Устройство IoT Edge, для которого необходимо настроить роль Интернета вещей. IoTDeviceInfo (обязательно)
roleStatus Состояние роли. "Отключено"
"Enabled" (обязательно)
shareMappings Точки подключения общих папок в роли. MountPointMap[]

IoTDeviceInfo

Имя Описание Значение
проверка подлинности Зашифрованное устройство Интернета вещей или устройство IoT Edge строка подключения. Аутентификация
deviceId Идентификатор устройства Интернета вещей или пограничного устройства. строка (обязательно)
ioTHostHub Имя узла для Центра Интернета вещей, связанного с устройством. строка (обязательно)
ioTHostHubId Идентификатор центра Интернета вещей, связанного с устройством. строка

Аутентификация

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

SymmetricKey

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

AsymmetricEncryptedSecret

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

IoTEdgeAgentInfo

Имя Описание Значение
imageName Имя образа агента IoT Edge. строка (обязательно)
imageRepository Сведения о репозитории образов. ImageRepositoryCredential
тег Тег изображения. строка (обязательно)

ImageRepositoryCredential

Имя Описание Значение
imageRepositoryUrl URL-адрес репозитория образов (например, mcr.microsoft.com). строка (обязательно)
password Пароль пользователя репозитория. AsymmetricEncryptedSecret
userName Имя пользователя репозитория. строка (обязательно)

MountPointMap

Имя Описание Значение
shareId Идентификатор общей папки, подключенной к виртуальной машине роли. строка (обязательно)