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


Подготовка Microsoft.DevicesСлужбы 2023-03-01-preview

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

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

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

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

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

resource symbolicname 'Microsoft.Devices/provisioningServices@2023-03-01-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  sku: {
    capacity: int
    name: 'S1'
  }
  etag: 'string'
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  properties: {
    allocationPolicy: 'string'
    authorizationPolicies: [
      {
        keyName: 'string'
        primaryKey: 'string'
        rights: 'string'
        secondaryKey: 'string'
        keyName: 'string'
        primaryKey: 'string'
        rights: 'string'
        secondaryKey: 'string'
      }
    ]
    enableDataResidency: bool
    iotHubs: [
      {
        allocationWeight: int
        applyAllocationPolicy: bool
        connectionString: 'string'
        location: 'string'
      }
    ]
    ipFilterRules: [
      {
        action: 'string'
        filterName: 'string'
        ipMask: 'string'
        target: 'string'
      }
    ]
    portalOperationsHostName: 'string'
    privateEndpointConnections: [
      {
        properties: {
          privateEndpoint: {}
          privateLinkServiceConnectionState: {
            actionsRequired: 'string'
            description: 'string'
            status: 'string'
          }
        }
      }
    ]
    provisioningState: 'string'
    publicNetworkAccess: 'string'
    state: 'string'
  }
  resourcegroup: 'string'
  subscriptionid: 'string'
}

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

provisioningServices

Имя Описание Значение
name имя ресурса. string (обязательно)

Ограничение символов: 3-64

Допустимые символы:
Буквенно-цифровые символы и дефисы.

Заканчивается буквенно-цифровым символом.
location Местоположение ресурса. string (обязательно)
tags Теги ресурса. Словарь имен и значений тегов. См . раздел Теги в шаблонах
sku Сведения о номере SKU для службы подготовки. IotDpsSkuInfo (обязательно)
etag Поле Etag не является обязательным. Если он указан в тексте ответа, он также должен быть указан в виде заголовка в соответствии с обычным соглашением ETag. строка
удостоверение Управляемые удостоверения для службы подготовки. Управляемое удостоверение службы
properties Свойства службы для службы подготовки IotDpsPropertiesDescription (обязательно)
группа ресурсов Группа ресурсов ресурса. строка
subscriptionid Идентификатор подписки ресурса. строка

Управляемое удостоверение службы

Имя Описание Значение
тип Тип управляемого удостоверения службы (где разрешены типы SystemAssigned и UserAssigned). "Нет"
SystemAssigned
"SystemAssigned,UserAssigned"
UserAssigned (обязательно)
userAssignedIdentities Набор назначенных пользователем удостоверений, связанных с ресурсом. Ключи словаря userAssignedIdentities будут иметь идентификаторы ресурсов ARM в формате :/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Значения словаря могут быть пустыми объектами ({}) в запросах. UserAssignedIdentities

UserAssignedIdentities

Имя Описание Значение
{настраиваемое свойство} UserAssignedIdentity

UserAssignedIdentity

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

IotDpsPropertiesDescription

Имя Описание Значение
AllocationPolicy Политика распределения, используемая этой службой подготовки. "GeoLatency"
'Hashed'
"Статический"
authorizationPolicies Список ключей авторизации для службы подготовки. SharedAccessSignatureAuthorizationRuleAccessRightsDe...[]
enableDataResidency Необязательный элемент.
Указывает, включен ли экземпляр DPS Data Residency, удаляя аварийное восстановление между геопарными парами.
bool
IotHubs Список Центров Интернета вещей, связанных с этой службой подготовки. IotHubDefinitionDescription[]
IpFilterRules Правила фильтрации IP-адресов. IpFilterRule[]
portalOperationsHostName Конечная точка портала для включения CORS для этой службы подготовки. строка
privateEndpointConnections Подключения к частной конечной точке, созданные на этом сайте Интернета вещей PrivateEndpointConnection[]
provisioningState Состояние подготовки ARM службы подготовки. строка
publicNetworkAccess Разрешены ли запросы из общедоступной сети "Отключено"
"Включено"
Состояние Текущее состояние службы подготовки. "Активация"
ActivationFailed
"Активный"
"Удалено"
"Удаление"
"УдалениеFailed"
FailingOver
FailoverFailed
"Возобновление"
"Приостановлено"
Приостановка
"Переход"

SharedAccessSignatureAuthorizationRuleAccessRightsDe...

Имя Описание Значение
keyName Имя ключа. string (обязательно)
primaryKey Значение первичного ключа SAS. строка
права Права, которые имеет этот ключ. DeviceConnect
EnrollmentRead
EnrollmentWrite
RegistrationStatusRead
RegistrationStatusWrite
ServiceConfig (обязательно)
secondaryKey Значение вторичного ключа SAS. строка
keyName Имя ключа. string (обязательно)
primaryKey Значение первичного ключа SAS. строка
права Права, которые имеет этот ключ. DeviceConnect
EnrollmentRead
EnrollmentWrite
RegistrationStatusRead
RegistrationStatusWrite
ServiceConfig (обязательно)
secondaryKey Значение вторичного ключа SAS. строка

IotHubDefinitionDescription

Имя Описание Значение
allocationWeight вес для применения для заданного iot h. INT
applyAllocationPolicy флаг для применения allocationPolicy или нет для данного центра Интернета вещей. bool
connectionString Строка подключения Центра Интернета вещей. string (обязательно)
location Регион ARM Центра Интернета вещей. string (обязательно)

IpFilterRule

Имя Описание Значение
action Требуемое действие для запросов, отслеживаемых этим правилом. "Принять"
"Отклонить" (обязательно)
filterName Имя правила фильтрации IP-адресов. string (обязательно)
ipMask Строка, содержащая диапазон IP-адресов в нотации CIDR для правила. string (обязательно)
target Целевой объект для запросов, зафиксированных этим правилом. 'all'
deviceApi
serviceApi

PrivateEndpointConnection

Имя Описание Значение
properties Свойства подключения к частной конечной точке PrivateEndpointConnectionProperties (обязательно)

PrivateEndpointConnectionProperties

Имя Описание Значение
privateEndpoint Свойство частной конечной точки подключения к частной конечной точке PrivateEndpoint
privateLinkServiceConnectionState Текущее состояние подключения к частной конечной точке PrivateLinkServiceConnectionState (обязательно)

PrivateEndpoint

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

PrivateLinkServiceConnectionState

Имя Описание Значение
ActionsRequired Действия, необходимые для подключения к частной конечной точке строка
description Описание текущего состояния подключения к частной конечной точке строка (обязательно)
status Состояние подключения к частной конечной точке "Утверждено"
"Отключено"
"Ожидание"
"Отклонено" (обязательно)

IotDpsSkuInfo

Имя Описание Значение
Емкость Количество единиц для подготовки INT
name Имя номера SKU. 'S1'

Шаблоны быстрого запуска

Следующие шаблоны быстрого запуска развертывают этот тип ресурса.

Шаблон Описание
Создание пограничного симулятора Центра Интернета вещей и Ubuntu

Развертывание в Azure
Этот шаблон создает пограничный симулятор Центра Интернета вещей и виртуальной машины Ubuntu.
Создание службы подготовки устройств Центр Интернета вещей

Развертывание в Azure
Этот шаблон позволяет создать Центр Интернета вещей и службу подготовки устройств Центр Интернета вещей, а также связать эти две службы.

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

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

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

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

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

{
  "type": "Microsoft.Devices/provisioningServices",
  "apiVersion": "2023-03-01-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "sku": {
    "capacity": "int",
    "name": "S1"
  },
  "etag": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {}
    }
  },
  "properties": {
    "allocationPolicy": "string",
    "authorizationPolicies": [
      {
        "keyName": "string",
        "primaryKey": "string",
        "rights": "string",
        "secondaryKey": "string",
        "keyName": "string",
        "primaryKey": "string",
        "rights": "string",
        "secondaryKey": "string"
      }
    ],
    "enableDataResidency": "bool",
    "iotHubs": [
      {
        "allocationWeight": "int",
        "applyAllocationPolicy": "bool",
        "connectionString": "string",
        "location": "string"
      }
    ],
    "ipFilterRules": [
      {
        "action": "string",
        "filterName": "string",
        "ipMask": "string",
        "target": "string"
      }
    ],
    "portalOperationsHostName": "string",
    "privateEndpointConnections": [
      {
        "properties": {
          "privateEndpoint": {},
          "privateLinkServiceConnectionState": {
            "actionsRequired": "string",
            "description": "string",
            "status": "string"
          }
        }
      }
    ],
    "provisioningState": "string",
    "publicNetworkAccess": "string",
    "state": "string"
  },
  "resourcegroup": "string",
  "subscriptionid": "string"
}

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

provisioningServices

Имя Описание Значение
тип Тип ресурса Microsoft.Devices/provisioningServices
версия_API Версия API ресурсов '2023-03-01-preview'
name имя ресурса. строка (обязательно)

Ограничение символов: 3–64

Допустимые символы:
Буквенно-цифровые символы и дефисы.

Заканчивается буквенно-цифровым символом.
location Местоположение ресурса. строка (обязательно)
tags Теги ресурса. Словарь имен и значений тегов. См . раздел Теги в шаблонах
sku Сведения о номере SKU для службы подготовки. IotDpsSkuInfo (обязательно)
etag Поле Etag не является обязательным. Если он указан в тексте ответа, он также должен быть указан в качестве заголовка в соответствии с обычным соглашением ETag. строка
удостоверение Управляемые удостоверения для службы подготовки. Управляемое удостоверение службы
properties Свойства службы для службы подготовки IotDpsPropertiesDescription (обязательно)
группа ресурсов Группа ресурсов ресурса. строка
subscriptionid Идентификатор подписки ресурса. строка

Управляемое удостоверение службы

Имя Описание Значение
тип Тип управляемого удостоверения службы (где разрешены типы SystemAssigned и UserAssigned). "Нет"
SystemAssigned
"SystemAssigned,UserAssigned"
UserAssigned (обязательно)
userAssignedIdentities Набор назначенных пользователем удостоверений, связанных с ресурсом. Ключи словаря userAssignedIdentities будут иметь идентификаторы ресурсов ARM в формате :/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Значения словаря могут быть пустыми объектами ({}) в запросах. UserAssignedIdentities

UserAssignedIdentities

Имя Описание Значение
{настраиваемое свойство} UserAssignedIdentity

UserAssignedIdentity

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

IotDpsPropertiesDescription

Имя Описание Значение
AllocationPolicy Политика распределения, используемая этой службой подготовки. "GeoLatency"
'Hashed'
"Статический"
authorizationPolicies Список ключей авторизации для службы подготовки. SharedAccessSignatureAuthorizationRuleAccessRightsDe...[]
enableDataResidency Необязательный элемент.
Указывает, включен ли экземпляр DPS Data Residency, удаляя аварийное восстановление между геопарными парами.
bool
IotHubs Список Центров Интернета вещей, связанных с этой службой подготовки. IotHubDefinitionDescription[]
IpFilterRules Правила фильтрации IP-адресов. IpFilterRule[]
portalOperationsHostName Конечная точка портала для включения CORS для этой службы подготовки. строка
privateEndpointConnections Подключения к частной конечной точке, созданные на этом сайте Интернета вещей PrivateEndpointConnection[]
provisioningState Состояние подготовки ARM службы подготовки. строка
publicNetworkAccess Разрешены ли запросы из общедоступной сети "Отключено"
"Включено"
Состояние Текущее состояние службы подготовки. "Активация"
ActivationFailed
"Активный"
"Удалено"
"Удаление"
"УдалениеFailed"
FailingOver
FailoverFailed
"Возобновление"
"Приостановлено"
Приостановка
"Переход"

SharedAccessSignatureAuthorizationRuleAccessRightsDe...

Имя Описание Значение
keyName Имя ключа. string (обязательно)
primaryKey Значение первичного ключа SAS. строка
права Права, которые имеет этот ключ. DeviceConnect
EnrollmentRead
EnrollmentWrite
RegistrationStatusRead
RegistrationStatusWrite
ServiceConfig (обязательно)
secondaryKey Значение вторичного ключа SAS. строка
keyName Имя ключа. string (обязательно)
primaryKey Значение первичного ключа SAS. строка
права Права, которые имеет этот ключ. DeviceConnect
EnrollmentRead
EnrollmentWrite
RegistrationStatusRead
RegistrationStatusWrite
ServiceConfig (обязательно)
secondaryKey Значение вторичного ключа SAS. строка

IotHubDefinitionDescription

Имя Описание Значение
allocationWeight вес для применения для заданного iot h. INT
applyAllocationPolicy флаг для применения allocationPolicy или нет для данного центра Интернета вещей. bool
connectionString Строка подключения Центра Интернета вещей. string (обязательно)
location Регион ARM Центра Интернета вещей. string (обязательно)

IpFilterRule

Имя Описание Значение
action Требуемое действие для запросов, отслеживаемых этим правилом. "Принять"
"Отклонить" (обязательно)
filterName Имя правила фильтрации IP-адресов. string (обязательно)
ipMask Строка, содержащая диапазон IP-адресов в нотации CIDR для правила. string (обязательно)
target Целевой объект для запросов, захваченных этим правилом. 'all'
deviceApi
'serviceApi'

PrivateEndpointConnection

Имя Описание Значение
properties Свойства подключения к частной конечной точке PrivateEndpointConnectionProperties (обязательно)

PrivateEndpointConnectionProperties

Имя Описание Значение
privateEndpoint Свойство частной конечной точки подключения к частной конечной точке PrivateEndpoint
privateLinkServiceConnectionState Текущее состояние подключения к частной конечной точке PrivateLinkServiceConnectionState (обязательно)

PrivateEndpoint

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

PrivateLinkServiceConnectionState

Имя Описание Значение
actionsRequired Действия, необходимые для подключения к частной конечной точке строка
description Описание текущего состояния подключения к частной конечной точке string (обязательно)
status Состояние подключения к частной конечной точке "Утверждено"
"Отключено"
"Ожидание"
"Отклонено" (обязательно)

IotDpsSkuInfo

Имя Описание Значение
Емкость Число подготовленных единиц INT
name Имя номера SKU. 'S1'

Шаблоны быстрого запуска

Следующие шаблоны быстрого запуска развертывают этот тип ресурса.

Шаблон Описание
Создание пограничного симулятора Центра Интернета вещей и Ubuntu

Развертывание в Azure
Этот шаблон создает пограничный симулятор Центра Интернета вещей и виртуальной машины Ubuntu.
Создание службы подготовки устройств Центр Интернета вещей

Развертывание в Azure
Этот шаблон позволяет создать Центр Интернета вещей и службу подготовки устройств Центр Интернета вещей, а также связать эти две службы.

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

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

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

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

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

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Devices/provisioningServices@2023-03-01-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  identity {
    type = "string"
    identity_ids = []
  }
  body = jsonencode({
    properties = {
      allocationPolicy = "string"
      authorizationPolicies = [
        {
          keyName = "string"
          primaryKey = "string"
          rights = "string"
          secondaryKey = "string"
          keyName = "string"
          primaryKey = "string"
          rights = "string"
          secondaryKey = "string"
        }
      ]
      enableDataResidency = bool
      iotHubs = [
        {
          allocationWeight = int
          applyAllocationPolicy = bool
          connectionString = "string"
          location = "string"
        }
      ]
      ipFilterRules = [
        {
          action = "string"
          filterName = "string"
          ipMask = "string"
          target = "string"
        }
      ]
      portalOperationsHostName = "string"
      privateEndpointConnections = [
        {
          properties = {
            privateEndpoint = {}
            privateLinkServiceConnectionState = {
              actionsRequired = "string"
              description = "string"
              status = "string"
            }
          }
        }
      ]
      provisioningState = "string"
      publicNetworkAccess = "string"
      state = "string"
    }
    resourcegroup = "string"
    subscriptionid = "string"
    sku = {
      capacity = int
      name = "S1"
    }
    etag = "string"
  })
}

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

provisioningServices

Имя Описание Значение
тип Тип ресурса Microsoft.Devices/provisioningServices@2023-03-01-preview
name имя ресурса. строка (обязательно)

Ограничение символов: 3–64

Допустимые символы:
Буквенно-цифровые символы и дефисы.

Заканчивается буквенно-цифровым символом.
location Местоположение ресурса. строка (обязательно)
parent_id Чтобы выполнить развертывание в группе ресурсов, используйте идентификатор этой группы ресурсов. строка (обязательно)
tags Теги ресурса. Словарь имен и значений тегов.
sku Сведения о номере SKU для службы подготовки. IotDpsSkuInfo (обязательно)
etag Поле Etag не является обязательным. Если он указан в тексте ответа, он также должен быть указан в качестве заголовка в соответствии с обычным соглашением ETag. строка
удостоверение Управляемые удостоверения для службы подготовки. Управляемое удостоверение службы
properties Свойства службы для службы подготовки IotDpsPropertiesDescription (обязательно)
группа ресурсов Группа ресурсов ресурса. строка
subscriptionid Идентификатор подписки ресурса. строка

Управляемое удостоверение службы

Имя Описание Значение
тип Тип управляемого удостоверения службы (где разрешены типы SystemAssigned и UserAssigned). "SystemAssigned"
"SystemAssigned,UserAssigned"
UserAssigned (обязательно)
identity_ids Набор удостоверений, назначаемых пользователем, связанных с ресурсом. Ключи словаря userAssignedIdentities будут иметь идентификаторы ресурсов ARM в формате :/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Значения словаря могут быть пустыми объектами ({}) в запросах. Массив идентификаторов удостоверений пользователей.

UserAssignedIdentities

Имя Описание Значение
{настроенное свойство} UserAssignedIdentity

UserAssignedIdentity

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

IotDpsPropertiesDescription

Имя Описание Значение
allocationPolicy Политика выделения, используемая этой службой подготовки. "GeoLatency"
"Hashed"
"Static"
authorizationPolicies Список ключей авторизации для службы подготовки. SharedAccessSignatureAuthorizationRuleAccessRightsDe...[]
enableDataResidency Необязательный элемент.
Указывает, включен ли экземпляр DPS Data Residency, удалив аварийное восстановление между парами геосов.
bool
iotHubs Список Центров Интернета вещей, связанных с этой службой подготовки. IotHubDefinitionDescription[]
ipFilterRules Правила фильтрации IP-адресов. IpFilterRule[]
portalOperationsHostName Конечная точка портала для включения CORS для этой службы подготовки. строка
privateEndpointConnections Подключения к частной конечной точке, созданные на этом сайте Интернета вещей PrivateEndpointConnection[]
provisioningState Состояние подготовки ARM службы подготовки. строка
publicNetworkAccess Разрешены ли запросы из общедоступной сети "Отключено"
"Включено"
Состояние Текущее состояние службы подготовки. "Активация"
ActivationFailed
"Активный"
"Удалено"
"Удаление"
"УдалениеFailed"
FailingOver
FailoverFailed
"Возобновление"
"Приостановлено"
"Приостановка"
"Переход"

SharedAccessSignatureAuthorizationRuleAccessRightsDe...

Имя Описание Значение
keyName Имя ключа. строка (обязательно)
primaryKey Значение первичного ключа SAS. строка
права Права, имеющиеся у этого ключа. DeviceConnect
EnrollmentRead
EnrollmentWrite
RegistrationStatusRead
RegistrationStatusWrite
ServiceConfig (обязательно)
secondaryKey Значение вторичного ключа SAS. строка
keyName Имя ключа. строка (обязательно)
primaryKey Значение первичного ключа SAS. строка
права Права, имеющиеся у этого ключа. DeviceConnect
EnrollmentRead
EnrollmentWrite
RegistrationStatusRead
RegistrationStatusWrite
ServiceConfig (обязательно)
secondaryKey Значение вторичного ключа SAS. строка

IotHubDefinitionDescription

Имя Описание Значение
allocationWeight вес для применения для заданного iot h. INT
applyAllocationPolicy флаг для применения allocationPolicy или нет для заданного центра Интернета вещей. bool
connectionString Строка подключения Центра Интернета вещей. строка (обязательно)
location Регион ARM Центра Интернета вещей. строка (обязательно)

IpFilterRule

Имя Описание Значение
action Требуемое действие для запросов, зафиксированных этим правилом. "Принять"
"Отклонить" (обязательно)
filterName Имя правила фильтрации IP-адресов. строка (обязательно)
ipMask Строка, содержащая диапазон IP-адресов в нотации CIDR для правила. string (обязательно)
target Целевой объект для запросов, захваченных этим правилом. "all"
"deviceApi"
"serviceApi"

PrivateEndpointConnection

Имя Описание Значение
properties Свойства подключения к частной конечной точке PrivateEndpointConnectionProperties (обязательно)

PrivateEndpointConnectionProperties

Имя Описание Значение
privateEndpoint Свойство частной конечной точки подключения к частной конечной точке PrivateEndpoint
privateLinkServiceConnectionState Текущее состояние подключения к частной конечной точке PrivateLinkServiceConnectionState (обязательно)

PrivateEndpoint

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

PrivateLinkServiceConnectionState

Имя Описание Значение
actionsRequired Действия, необходимые для подключения к частной конечной точке строка
description Описание текущего состояния подключения к частной конечной точке string (обязательно)
status Состояние подключения к частной конечной точке "Утверждено"
"Отключено"
"Ожидание"
"Отклонено" (обязательно)

IotDpsSkuInfo

Имя Описание Значение
Емкость Число подготовленных единиц INT
name Имя SKU. "S1"