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


Службы подготовки Microsoft.Devices

Определение ресурсов Bicep

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

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

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

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

resource symbolicname 'Microsoft.Devices/provisioningServices@2025-02-01-preview' = {
  etag: 'string'
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  location: 'string'
  name: 'string'
  properties: {
    allocationPolicy: 'string'
    authorizationPolicies: [
      {
        keyName: 'string'
        primaryKey: 'string'
        rights: 'string'
        secondaryKey: 'string'
      }
    ]
    enableDataResidency: bool
    iotHubs: [
      {
        allocationWeight: int
        applyAllocationPolicy: bool
        authenticationType: 'string'
        connectionString: 'string'
        location: 'string'
        selectedUserAssignedIdentityResourceId: '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'
  sku: {
    capacity: int
    name: 'string'
  }
  subscriptionid: 'string'
  tags: {
    {customized property}: 'string'
  }
}

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

IotDpsPropertiesDescription

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

IotDpsSkuInfo

Имя Описание Ценность
способность Количество единиц для подготовки int
имя Имя SKU. 'S1'

IotHubDefinitionDescription

Имя Описание Ценность
Объем выделения вес, применяемый для заданного iot h. int
applyAllocationPolicy флаг для применения allocationPolicy или нет для заданного концентратора iot. bool
authenticationType Тип проверки подлинности IotHub MI: KeyBased, UserAssigned, SystemAssigned. KeyBased
SystemAssigned
UserAssigned
connectionString Строка подключения центра Интернета вещей. струна
местоположение Область ARM центра Интернета вещей. строка (обязательно)
selectedUserAssignedIdentityResourceId Выбранный идентификатор ресурса удостоверения, назначенный пользователем, связанный с Центром Интернета вещей. Это необходимо при проверке подлинности UserAssigned. струна

IpFilterRule

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

ManagedServiceIdentity

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

Microsoft.Devices/provisioningServices

Имя Описание Ценность
etag Поле Etag не требуется. Если он указан в тексте ответа, он также должен быть предоставлен в качестве заголовка для обычного соглашения ETag. струна
тождество Управляемые удостоверения для службы подготовки. ManagedServiceIdentity
местоположение Расположение ресурса. строка (обязательно)
имя Имя ресурса строка (обязательно)
свойства Свойства конкретной службы для службы подготовки IotDpsPropertiesDescription (обязательно)
resourcegroup Группа ресурсов ресурса. струна
SKU Сведения о SKU для службы подготовки. IotDpsSkuInfo (обязательно)
subscriptionid Идентификатор подписки ресурса. струна
Теги Теги ресурсов Словарь имен и значений тегов. См. теги в шаблонах

PrivateEndpoint

Имя Описание Ценность

PrivateEndpointConnection

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

PrivateEndpointConnectionProperties

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

PrivateLinkServiceConnectionState

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

ResourceTags

Имя Описание Ценность

SharedAccessSignatureAuthorizationRuleAccessRightsDescription

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

UserAssignedIdentities

Имя Описание Ценность

UserAssignedIdentity

Имя Описание Ценность

Примеры краткого руководства

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

Bicep-файл Описание
создание службы подготовки устройств Центра Интернета вещей Этот шаблон позволяет создать центр Интернета вещей и службу подготовки устройств Центра Интернета вещей и связать две службы.

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

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

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

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

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

{
  "type": "Microsoft.Devices/provisioningServices",
  "apiVersion": "2025-02-01-preview",
  "name": "string",
  "etag": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
      }
    }
  },
  "location": "string",
  "properties": {
    "allocationPolicy": "string",
    "authorizationPolicies": [
      {
        "keyName": "string",
        "primaryKey": "string",
        "rights": "string",
        "secondaryKey": "string"
      }
    ],
    "enableDataResidency": "bool",
    "iotHubs": [
      {
        "allocationWeight": "int",
        "applyAllocationPolicy": "bool",
        "authenticationType": "string",
        "connectionString": "string",
        "location": "string",
        "selectedUserAssignedIdentityResourceId": "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",
  "sku": {
    "capacity": "int",
    "name": "string"
  },
  "subscriptionid": "string",
  "tags": {
    "{customized property}": "string"
  }
}

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

IotDpsPropertiesDescription

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

IotDpsSkuInfo

Имя Описание Ценность
способность Количество единиц для подготовки int
имя Имя SKU. 'S1'

IotHubDefinitionDescription

Имя Описание Ценность
Объем выделения вес, применяемый для заданного iot h. int
applyAllocationPolicy флаг для применения allocationPolicy или нет для заданного концентратора iot. bool
authenticationType Тип проверки подлинности IotHub MI: KeyBased, UserAssigned, SystemAssigned. KeyBased
SystemAssigned
UserAssigned
connectionString Строка подключения центра Интернета вещей. струна
местоположение Область ARM центра Интернета вещей. строка (обязательно)
selectedUserAssignedIdentityResourceId Выбранный идентификатор ресурса удостоверения, назначенный пользователем, связанный с Центром Интернета вещей. Это необходимо при проверке подлинности UserAssigned. струна

IpFilterRule

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

ManagedServiceIdentity

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

Microsoft.Devices/provisioningServices

Имя Описание Ценность
apiVersion Версия API '2025-02-01-preview'
etag Поле Etag не требуется. Если он указан в тексте ответа, он также должен быть предоставлен в качестве заголовка для обычного соглашения ETag. струна
тождество Управляемые удостоверения для службы подготовки. ManagedServiceIdentity
местоположение Расположение ресурса. строка (обязательно)
имя Имя ресурса строка (обязательно)
свойства Свойства конкретной службы для службы подготовки IotDpsPropertiesDescription (обязательно)
resourcegroup Группа ресурсов ресурса. струна
SKU Сведения о SKU для службы подготовки. IotDpsSkuInfo (обязательно)
subscriptionid Идентификатор подписки ресурса. струна
Теги Теги ресурсов Словарь имен и значений тегов. См. теги в шаблонах
тип Тип ресурса "Microsoft.Devices/provisioningServices"

PrivateEndpoint

Имя Описание Ценность

PrivateEndpointConnection

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

PrivateEndpointConnectionProperties

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

PrivateLinkServiceConnectionState

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

ResourceTags

Имя Описание Ценность

SharedAccessSignatureAuthorizationRuleAccessRightsDescription

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

UserAssignedIdentities

Имя Описание Ценность

UserAssignedIdentity

Имя Описание Ценность

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

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

Шаблон Описание
Создание симулятора IOT Hub и Ubuntu edge

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

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

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

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

  • групп ресурсов

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

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

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Devices/provisioningServices@2025-02-01-preview"
  name = "string"
  etag = "string"
  identity = {
    type = "string"
    userAssignedIdentities = {
      {customized property} = {
      }
    }
  }
  location = "string"
  resourcegroup = "string"
  sku = {
    capacity = int
    name = "string"
  }
  subscriptionid = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      allocationPolicy = "string"
      authorizationPolicies = [
        {
          keyName = "string"
          primaryKey = "string"
          rights = "string"
          secondaryKey = "string"
        }
      ]
      enableDataResidency = bool
      iotHubs = [
        {
          allocationWeight = int
          applyAllocationPolicy = bool
          authenticationType = "string"
          connectionString = "string"
          location = "string"
          selectedUserAssignedIdentityResourceId = "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"
    }
  })
}

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

IotDpsPropertiesDescription

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

IotDpsSkuInfo

Имя Описание Ценность
способность Количество единиц для подготовки int
имя Имя SKU. 'S1'

IotHubDefinitionDescription

Имя Описание Ценность
Объем выделения вес, применяемый для заданного iot h. int
applyAllocationPolicy флаг для применения allocationPolicy или нет для заданного концентратора iot. bool
authenticationType Тип проверки подлинности IotHub MI: KeyBased, UserAssigned, SystemAssigned. KeyBased
SystemAssigned
UserAssigned
connectionString Строка подключения центра Интернета вещей. струна
местоположение Область ARM центра Интернета вещей. строка (обязательно)
selectedUserAssignedIdentityResourceId Выбранный идентификатор ресурса удостоверения, назначенный пользователем, связанный с Центром Интернета вещей. Это необходимо при проверке подлинности UserAssigned. струна

IpFilterRule

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

ManagedServiceIdentity

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

Microsoft.Devices/provisioningServices

Имя Описание Ценность
etag Поле Etag не требуется. Если он указан в тексте ответа, он также должен быть предоставлен в качестве заголовка для обычного соглашения ETag. струна
тождество Управляемые удостоверения для службы подготовки. ManagedServiceIdentity
местоположение Расположение ресурса. строка (обязательно)
имя Имя ресурса строка (обязательно)
свойства Свойства конкретной службы для службы подготовки IotDpsPropertiesDescription (обязательно)
resourcegroup Группа ресурсов ресурса. струна
SKU Сведения о SKU для службы подготовки. IotDpsSkuInfo (обязательно)
subscriptionid Идентификатор подписки ресурса. струна
Теги Теги ресурсов Словарь имен и значений тегов.
тип Тип ресурса "Microsoft.Devices/provisioningServices@2025-02-01-preview"

PrivateEndpoint

Имя Описание Ценность

PrivateEndpointConnection

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

PrivateEndpointConnectionProperties

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

PrivateLinkServiceConnectionState

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

ResourceTags

Имя Описание Ценность

SharedAccessSignatureAuthorizationRuleAccessRightsDescription

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

UserAssignedIdentities

Имя Описание Ценность

UserAssignedIdentity

Имя Описание Ценность