Compartir a través de


Microsoft.Devices provisioningServices 2020-01-01

Definición de recursos de Bicep

El tipo de recurso provisioningServices se puede implementar con operaciones destinadas a:

Para obtener una lista de las propiedades modificadas en cada versión de api, consulte registro de cambios.

Formato de los recursos

Para crear un recurso Microsoft.Devices/provisioningServices, agregue el siguiente bicep a la plantilla.

resource symbolicname 'Microsoft.Devices/provisioningServices@2020-01-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  sku: {
    capacity: int
    name: 'S1'
  }
  etag: 'string'
  properties: {
    allocationPolicy: 'string'
    authorizationPolicies: [
      {
        keyName: 'string'
        primaryKey: 'string'
        rights: 'string'
        secondaryKey: 'string'
        keyName: 'string'
        primaryKey: 'string'
        rights: 'string'
        secondaryKey: 'string'
      }
    ]
    iotHubs: [
      {
        allocationWeight: int
        applyAllocationPolicy: bool
        connectionString: 'string'
        location: 'string'
      }
    ]
    ipFilterRules: [
      {
        action: 'string'
        filterName: 'string'
        ipMask: 'string'
        target: 'string'
      }
    ]
    provisioningState: 'string'
    state: 'string'
  }
}

Valores de propiedad

provisioningServices

Nombre Descripción Value
name El nombre del recurso string (obligatorio)

Límite de caracteres: 3-64

Caracteres válidos:
Caracteres alfanuméricos y guiones.

Termine con un carácter alfanumérico.
ubicación Ubicación del recurso. string (obligatorio)
etiquetas Etiquetas del recurso. Diccionario de nombres y valores de etiqueta. Consulte Etiquetas en plantillas.
sku Información de SKU para un servicio de aprovisionamiento. IotDpsSkuInfo (obligatorio)
ETag El campo Etag no es obligatorio. Si se proporciona en el cuerpo de la respuesta, también debe proporcionarse como encabezado según la convención de ETag normal. string
properties Propiedades específicas del servicio para un servicio de aprovisionamiento IotDpsPropertiesDescription (obligatorio)

IotDpsPropertiesDescription

Nombre Descripción Valor
allocationPolicy Directiva de asignación que usará este servicio de aprovisionamiento. "GeoLatency"
'Hashed'
'Static'
authorizationPolicies Lista de claves de autorización para un servicio de aprovisionamiento. SharedAccessSignatureAuthorizationRuleAccessRightsDe...[]
iotHubs Lista de centros de IoT asociados a este servicio de aprovisionamiento. IotHubDefinitionDescription[]
ipFilterRules Las reglas de filtro IP. IpFilterRule[]
provisioningState Estado de aprovisionamiento de ARM del servicio de aprovisionamiento. string
state Estado actual del servicio de aprovisionamiento. "Activación"
"ActivationFailed"
'Activo'
'Eliminado'
'Eliminar'
'DeletionFailed'
'Conmutación por error'
'FailoverFailed'
'Reanudación'
'Suspendido'
'Suspending'
'Transición'

SharedAccessSignatureAuthorizationRuleAccessRightsDe...

Nombre Descripción Valor
keyName Nombre de la clave. string (obligatorio)
primaryKey Valor de clave SAS principal. string
derechos Derechos que tiene esta clave. "DeviceConnect"
'EnrollmentRead'
"EnrollmentWrite"
'RegistrationStatusRead'
'RegistrationStatusWrite'
'ServiceConfig' (obligatorio)
secondaryKey Valor de clave SAS secundaria. string
keyName Nombre de la clave. string (obligatorio)
primaryKey Valor de clave SAS principal. string
derechos Derechos que tiene esta clave. "DeviceConnect"
'EnrollmentRead'
"EnrollmentWrite"
'RegistrationStatusRead'
'RegistrationStatusWrite'
'ServiceConfig' (obligatorio)
secondaryKey Valor de clave SAS secundaria. string

IotHubDefinitionDescription

Nombre Descripción Valor
allocationWeight peso que se va a aplicar a un determinado iot h. int
applyAllocationPolicy marca para aplicar allocationPolicy o no para un centro de IoT determinado. bool
connectionString Cadena de conexión og del centro de IoT. string (obligatorio)
ubicación Región arm del centro de IoT. string (obligatorio)

IpFilterRule

Nombre Descripción Valor
action Acción deseada para las solicitudes capturadas por esta regla. 'Accept'
'Reject' (obligatorio)
filterName Nombre de la regla de filtro IP. string (obligatorio)
ipMask Cadena que contiene el intervalo de direcciones IP en notación CIDR para la regla. string (obligatorio)
Destino Destino de las solicitudes capturadas por esta regla. 'all'
"deviceApi"
'serviceApi'

IotDpsSkuInfo

Nombre Descripción Valor
capacity Número de unidades que se van a aprovisionar int
name Nombre de SKU. 'S1'

Plantillas de inicio rápido

Las siguientes plantillas de inicio rápido implementan este tipo de recurso.

Plantilla Descripción
Creación de un simulador perimetral de IOT Hub y Ubuntu

Implementación en Azure
Esta plantilla crea un simulador perimetral de Ubuntu de IOT Hub y máquina virtual.
Creación de un servicio IoT Hub Device Provisioning

Implementación en Azure
Esta plantilla le permite crear un centro de IoT y un servicio de IoT Hub Device Provisioning y vincular los dos servicios juntos.

Definición de recursos de plantilla de ARM

El tipo de recurso provisioningServices se puede implementar con operaciones destinadas a:

Para obtener una lista de las propiedades modificadas en cada versión de api, consulte registro de cambios.

Formato de los recursos

Para crear un recurso Microsoft.Devices/provisioningServices, agregue el siguiente json a la plantilla.

{
  "type": "Microsoft.Devices/provisioningServices",
  "apiVersion": "2020-01-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "sku": {
    "capacity": "int",
    "name": "S1"
  },
  "etag": "string",
  "properties": {
    "allocationPolicy": "string",
    "authorizationPolicies": [
      {
        "keyName": "string",
        "primaryKey": "string",
        "rights": "string",
        "secondaryKey": "string",
        "keyName": "string",
        "primaryKey": "string",
        "rights": "string",
        "secondaryKey": "string"
      }
    ],
    "iotHubs": [
      {
        "allocationWeight": "int",
        "applyAllocationPolicy": "bool",
        "connectionString": "string",
        "location": "string"
      }
    ],
    "ipFilterRules": [
      {
        "action": "string",
        "filterName": "string",
        "ipMask": "string",
        "target": "string"
      }
    ],
    "provisioningState": "string",
    "state": "string"
  }
}

Valores de propiedad

provisioningServices

Nombre Descripción Value
type Tipo de recurso "Microsoft.Devices/provisioningServices"
apiVersion La versión de la API de recursos '2020-01-01'
name El nombre del recurso string (obligatorio)

Límite de caracteres: 3-64

Caracteres válidos:
Caracteres alfanuméricos y guiones.

Termine con un carácter alfanumérico.
ubicación Ubicación del recurso. string (obligatorio)
etiquetas Etiquetas del recurso. Diccionario de nombres y valores de etiqueta. Consulte Etiquetas en plantillas.
sku Información de SKU para un servicio de aprovisionamiento. IotDpsSkuInfo (obligatorio)
ETag El campo Etag no es obligatorio. Si se proporciona en el cuerpo de la respuesta, también debe proporcionarse como encabezado según la convención de ETag normal. string
properties Propiedades específicas del servicio para un servicio de aprovisionamiento IotDpsPropertiesDescription (obligatorio)

IotDpsPropertiesDescription

Nombre Descripción Valor
allocationPolicy Directiva de asignación que usará este servicio de aprovisionamiento. "GeoLatency"
'Hashed'
'Static'
authorizationPolicies Lista de claves de autorización para un servicio de aprovisionamiento. SharedAccessSignatureAuthorizationRuleAccessRightsDe...[]
iotHubs Lista de centros de IoT asociados a este servicio de aprovisionamiento. IotHubDefinitionDescription[]
ipFilterRules Las reglas de filtro IP. IpFilterRule[]
provisioningState Estado de aprovisionamiento de ARM del servicio de aprovisionamiento. string
state Estado actual del servicio de aprovisionamiento. "Activación"
"ActivationFailed"
'Activo'
'Eliminado'
'Eliminar'
'DeletionFailed'
'Conmutación por error'
'FailoverFailed'
'Reanudación'
'Suspendido'
'Suspending'
'Transición'

SharedAccessSignatureAuthorizationRuleAccessRightsDe...

Nombre Descripción Valor
keyName Nombre de la clave. string (obligatorio)
primaryKey Valor de clave SAS principal. string
derechos Derechos que tiene esta clave. "DeviceConnect"
'EnrollmentRead'
"EnrollmentWrite"
'RegistrationStatusRead'
'RegistrationStatusWrite'
'ServiceConfig' (obligatorio)
secondaryKey Valor de clave SAS secundaria. string
keyName Nombre de la clave. string (obligatorio)
primaryKey Valor de clave SAS principal. string
derechos Derechos que tiene esta clave. "DeviceConnect"
'EnrollmentRead'
"EnrollmentWrite"
'RegistrationStatusRead'
'RegistrationStatusWrite'
'ServiceConfig' (obligatorio)
secondaryKey Valor de clave SAS secundaria. string

IotHubDefinitionDescription

Nombre Descripción Valor
allocationWeight peso que se va a aplicar a un determinado iot h. int
applyAllocationPolicy marca para aplicar allocationPolicy o no para un centro de IoT determinado. bool
connectionString Cadena de conexión og del centro de IoT. string (obligatorio)
ubicación Región arm del centro de IoT. string (obligatorio)

IpFilterRule

Nombre Descripción Valor
action Acción deseada para las solicitudes capturadas por esta regla. 'Accept'
'Reject' (obligatorio)
filterName Nombre de la regla de filtro IP. string (obligatorio)
ipMask Cadena que contiene el intervalo de direcciones IP en notación CIDR para la regla. string (obligatorio)
Destino Destino de las solicitudes capturadas por esta regla. 'all'
"deviceApi"
'serviceApi'

IotDpsSkuInfo

Nombre Descripción Valor
capacity Número de unidades que se van a aprovisionar int
name Nombre de SKU. 'S1'

Plantillas de inicio rápido

Las siguientes plantillas de inicio rápido implementan este tipo de recurso.

Plantilla Descripción
Creación de un simulador perimetral de IOT Hub y Ubuntu

Implementación en Azure
Esta plantilla crea un simulador perimetral de Ubuntu de IOT Hub y máquina virtual.
Creación de un servicio IoT Hub Device Provisioning

Implementación en Azure
Esta plantilla le permite crear un centro de IoT y un servicio de IoT Hub Device Provisioning y vincular los dos servicios juntos.

Definición de recursos de Terraform (proveedor AzAPI)

El tipo de recurso provisioningServices se puede implementar con operaciones destinadas a:

  • Grupos de recursos

Para obtener una lista de las propiedades modificadas en cada versión de api, consulte registro de cambios.

Formato de los recursos

Para crear un recurso Microsoft.Devices/provisioningServices, agregue el siguiente terraform a la plantilla.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Devices/provisioningServices@2020-01-01"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      allocationPolicy = "string"
      authorizationPolicies = [
        {
          keyName = "string"
          primaryKey = "string"
          rights = "string"
          secondaryKey = "string"
          keyName = "string"
          primaryKey = "string"
          rights = "string"
          secondaryKey = "string"
        }
      ]
      iotHubs = [
        {
          allocationWeight = int
          applyAllocationPolicy = bool
          connectionString = "string"
          location = "string"
        }
      ]
      ipFilterRules = [
        {
          action = "string"
          filterName = "string"
          ipMask = "string"
          target = "string"
        }
      ]
      provisioningState = "string"
      state = "string"
    }
    sku = {
      capacity = int
      name = "S1"
    }
    etag = "string"
  })
}

Valores de propiedad

provisioningServices

Nombre Descripción Value
type Tipo de recurso "Microsoft.Devices/provisioningServices@2020-01-01"
name El nombre del recurso string (obligatorio)

Límite de caracteres: 3-64

Caracteres válidos:
Caracteres alfanuméricos y guiones.

Termine con un carácter alfanumérico.
ubicación Ubicación del recurso. string (obligatorio)
parent_id Para realizar la implementación en un grupo de recursos, use el identificador de ese grupo de recursos. string (obligatorio)
etiquetas Etiquetas del recurso. Diccionario de nombres y valores de etiqueta.
sku Información de SKU para un servicio de aprovisionamiento. IotDpsSkuInfo (obligatorio)
ETag El campo Etag no es obligatorio. Si se proporciona en el cuerpo de la respuesta, también debe proporcionarse como encabezado según la convención de ETag normal. string
properties Propiedades específicas del servicio para un servicio de aprovisionamiento IotDpsPropertiesDescription (obligatorio)

IotDpsPropertiesDescription

Nombre Descripción Valor
allocationPolicy Directiva de asignación que usará este servicio de aprovisionamiento. "GeoLatency"
"Hashed"
"Estático"
authorizationPolicies Lista de claves de autorización para un servicio de aprovisionamiento. SharedAccessSignatureAuthorizationRuleAccessRightsDe...[]
iotHubs Lista de centros de IoT asociados a este servicio de aprovisionamiento. IotHubDefinitionDescription[]
ipFilterRules Reglas de filtro IP. IpFilterRule[]
provisioningState Estado de aprovisionamiento de ARM del servicio de aprovisionamiento. string
state Estado actual del servicio de aprovisionamiento. "Activación"
"ActivationFailed"
"Activo"
"Eliminado"
"Eliminar"
"DeletionFailed"
"Conmutación por error"
"FailoverFailed"
"Reanudación"
"Suspendido"
"Suspender"
"Transición"

SharedAccessSignatureAuthorizationRuleAccessRightsDe...

Nombre Descripción Valor
keyName Nombre de la clave. string (obligatorio)
primaryKey Valor de clave SAS principal. string
derechos Derechos que tiene esta clave. "DeviceConnect"
"EnrollmentRead"
"EnrollmentWrite"
"RegistrationStatusRead"
"RegistrationStatusWrite"
"ServiceConfig" (obligatorio)
secondaryKey Valor de clave SAS secundario. string
keyName Nombre de la clave. string (obligatorio)
primaryKey Valor de clave SAS principal. string
derechos Derechos que tiene esta clave. "DeviceConnect"
"EnrollmentRead"
"EnrollmentWrite"
"RegistrationStatusRead"
"RegistrationStatusWrite"
"ServiceConfig" (obligatorio)
secondaryKey Valor de clave SAS secundario. string

IotHubDefinitionDescription

Nombre Descripción Valor
allocationWeight peso que se va a aplicar para un iot h determinado. int
applyAllocationPolicy marca para aplicar allocationPolicy o no para un centro de IoT determinado. bool
connectionString Cadena de conexión og del centro de IoT. string (obligatorio)
ubicación Región de ARM del centro de IoT. string (obligatorio)

IpFilterRule

Nombre Descripción Valor
action La acción deseada para las solicitudes capturadas por esta regla. "Aceptar"
"Rechazar" (obligatorio)
filterName Nombre de la regla de filtro IP. string (obligatorio)
ipMask Cadena que contiene el intervalo de direcciones IP en notación CIDR para la regla. string (obligatorio)
Destino Destino de las solicitudes capturadas por esta regla. "todo"
"deviceApi"
"serviceApi"

IotDpsSkuInfo

Nombre Descripción Valor
capacity Número de unidades que se van a aprovisionar int
name Nombre de SKU. "S1"