Compartir a través de

Aprovisionamiento de Microsoft.DevicesServices 2022-12-12

  • Artículo

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 recurso

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

resource symbolicname 'Microsoft.Devices/provisioningServices@2022-12-12' = {
  etag: 'string'
  location: 'string'
  name: 'string'
  properties: {
    allocationPolicy: 'string'
    authorizationPolicies: [
      {
        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'
  sku: {
    capacity: int
    name: 'string'
  }
  subscriptionid: 'string'
  tags: {
    {customized property}: 'string'
  }
}

Valores de propiedad

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. SharedAccessSignatureAuthorizationRuleAccessRightsDescription[]
enableDataResidency Opcional.
Indica si la instancia de DPS tiene habilitada la residencia de datos, quitando la recuperación ante desastres entre pares geográficos.		 Bool
iotHubs Lista de centros de IoT asociados a este servicio de aprovisionamiento. IotHubDefinitionDescription[]
ipFilterRules Reglas de filtro IP. ipFilterRule[]
portalOperationsHostName Punto de conexión del portal para habilitar CORS para este servicio de aprovisionamiento. cuerda
privateEndpointConnections Conexiones de punto de conexión privado creadas en este IotHub privateEndpointConnection[]
provisioningState Estado de aprovisionamiento de ARM del servicio de aprovisionamiento. cuerda
publicNetworkAccess Indica si se permiten solicitudes de la red pública 'Deshabilitado'
'Habilitado'
estado Estado actual del servicio de aprovisionamiento. "Activación"
'ActivationFailed'
'Activo'
'Eliminado'
"Eliminar"
'DeletionFailed'
'Conmutación por error'
'FailoverFailed'
"Reanudación"
'Suspendido'
'Suspender'
"Transición"

IotDpsSkuInfo

Nombre Descripción Valor
capacidad Número de unidades que se van a aprovisionar Int
nombre Nombre de la SKU. 'S1'

IotHubDefinitionDescription

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

IpFilterRule

Nombre Descripción Valor
acción Acción deseada para las solicitudes capturadas por esta regla. 'Aceptar'
'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)
blanco Destino de las solicitudes capturadas por esta regla. 'all'
'deviceApi'
'serviceApi'

Microsoft.Devices/provisioningServices

Nombre Descripción Valor
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 ETag normal. cuerda
ubicación Ubicación del recurso. string (obligatorio)
nombre El nombre del recurso string (obligatorio)
Propiedades Propiedades específicas del servicio para un servicio de aprovisionamiento IotDpsPropertiesDescription (obligatorio)
grupo de recursos El grupo de recursos del recurso. cuerda
Sku Información de SKU para un servicio de aprovisionamiento. IotDpsSkuInfo (obligatorio)
subscriptionid Identificador de suscripción del recurso. cuerda
Etiquetas Etiquetas de recursos Diccionario de nombres y valores de etiqueta. Consulte etiquetas de en plantillas

PrivateEndpoint

Nombre Descripción Valor

PrivateEndpointConnection

Nombre Descripción Valor
Propiedades Propiedades de una conexión de punto de conexión privado privateEndpointConnectionProperties (obligatorio)

PrivateEndpointConnectionProperties

Nombre Descripción Valor
privateEndpoint La propiedad de punto de conexión privado de una conexión de punto de conexión privado PrivateEndpoint
privateLinkServiceConnectionState Estado actual de una conexión de punto de conexión privado privateLinkServiceConnectionState (obligatorio)

PrivateLinkServiceConnectionState

Nombre Descripción Valor
actionsRequired Acciones necesarias para una conexión de punto de conexión privado cuerda
descripción Descripción del estado actual de una conexión de punto de conexión privado string (obligatorio)
estado Estado de una conexión de punto de conexión privado 'Aprobado'
'Desconectado'
'Pendiente'
'Rechazado' (obligatorio)

ResourceTags

Nombre Descripción Valor

SharedAccessSignatureAuthorizationRuleAccessRightsDescription

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

Ejemplos de inicio rápido

En los ejemplos de inicio rápido siguientes se implementa este tipo de recurso.

Archivo de Bicep Descripción
Creación de una instancia de IoT Hub Device Provisioning Service Esta plantilla le permite crear un centro de IoT y un servicio 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 recurso

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

{
  "type": "Microsoft.Devices/provisioningServices",
  "apiVersion": "2022-12-12",
  "name": "string",
  "etag": "string",
  "location": "string",
  "properties": {
    "allocationPolicy": "string",
    "authorizationPolicies": [
      {
        "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",
  "sku": {
    "capacity": "int",
    "name": "string"
  },
  "subscriptionid": "string",
  "tags": {
    "{customized property}": "string"
  }
}

Valores de propiedad

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. SharedAccessSignatureAuthorizationRuleAccessRightsDescription[]
enableDataResidency Opcional.
Indica si la instancia de DPS tiene habilitada la residencia de datos, quitando la recuperación ante desastres entre pares geográficos.		 Bool
iotHubs Lista de centros de IoT asociados a este servicio de aprovisionamiento. IotHubDefinitionDescription[]
ipFilterRules Reglas de filtro IP. ipFilterRule[]
portalOperationsHostName Punto de conexión del portal para habilitar CORS para este servicio de aprovisionamiento. cuerda
privateEndpointConnections Conexiones de punto de conexión privado creadas en este IotHub privateEndpointConnection[]
provisioningState Estado de aprovisionamiento de ARM del servicio de aprovisionamiento. cuerda
publicNetworkAccess Indica si se permiten solicitudes de la red pública 'Deshabilitado'
'Habilitado'
estado Estado actual del servicio de aprovisionamiento. "Activación"
'ActivationFailed'
'Activo'
'Eliminado'
"Eliminar"
'DeletionFailed'
'Conmutación por error'
'FailoverFailed'
"Reanudación"
'Suspendido'
'Suspender'
"Transición"

IotDpsSkuInfo

Nombre Descripción Valor
capacidad Número de unidades que se van a aprovisionar Int
nombre Nombre de la SKU. 'S1'

IotHubDefinitionDescription

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

IpFilterRule

Nombre Descripción Valor
acción Acción deseada para las solicitudes capturadas por esta regla. 'Aceptar'
'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)
blanco Destino de las solicitudes capturadas por esta regla. 'all'
'deviceApi'
'serviceApi'

Microsoft.Devices/provisioningServices

Nombre Descripción Valor
apiVersion La versión de api '2022-12-12'
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 ETag normal. cuerda
ubicación Ubicación del recurso. string (obligatorio)
nombre El nombre del recurso string (obligatorio)
Propiedades Propiedades específicas del servicio para un servicio de aprovisionamiento IotDpsPropertiesDescription (obligatorio)
grupo de recursos El grupo de recursos del recurso. cuerda
Sku Información de SKU para un servicio de aprovisionamiento. IotDpsSkuInfo (obligatorio)
subscriptionid Identificador de suscripción del recurso. cuerda
Etiquetas Etiquetas de recursos Diccionario de nombres y valores de etiqueta. Consulte etiquetas de en plantillas
tipo El tipo de recurso "Microsoft.Devices/provisioningServices"

PrivateEndpoint

Nombre Descripción Valor

PrivateEndpointConnection

Nombre Descripción Valor
Propiedades Propiedades de una conexión de punto de conexión privado privateEndpointConnectionProperties (obligatorio)

PrivateEndpointConnectionProperties

Nombre Descripción Valor
privateEndpoint La propiedad de punto de conexión privado de una conexión de punto de conexión privado PrivateEndpoint
privateLinkServiceConnectionState Estado actual de una conexión de punto de conexión privado privateLinkServiceConnectionState (obligatorio)

PrivateLinkServiceConnectionState

Nombre Descripción Valor
actionsRequired Acciones necesarias para una conexión de punto de conexión privado cuerda
descripción Descripción del estado actual de una conexión de punto de conexión privado string (obligatorio)
estado Estado de una conexión de punto de conexión privado 'Aprobado'
'Desconectado'
'Pendiente'
'Rechazado' (obligatorio)

ResourceTags

Nombre Descripción Valor

SharedAccessSignatureAuthorizationRuleAccessRightsDescription

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

Plantillas de inicio rápido

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

Plantilla Descripción
Crear un simulador perimetral de Ubuntu y un centro de IOT

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

Implementación en Azure 		Esta plantilla le permite crear un centro de IoT y un servicio 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 de

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

Formato de recurso

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Devices/provisioningServices@2022-12-12"
  name = "string"
  etag = "string"
  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
          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"
    }
  })
}

Valores de propiedad

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. SharedAccessSignatureAuthorizationRuleAccessRightsDescription[]
enableDataResidency Opcional.
Indica si la instancia de DPS tiene habilitada la residencia de datos, quitando la recuperación ante desastres entre pares geográficos.		 Bool
iotHubs Lista de centros de IoT asociados a este servicio de aprovisionamiento. IotHubDefinitionDescription[]
ipFilterRules Reglas de filtro IP. ipFilterRule[]
portalOperationsHostName Punto de conexión del portal para habilitar CORS para este servicio de aprovisionamiento. cuerda
privateEndpointConnections Conexiones de punto de conexión privado creadas en este IotHub privateEndpointConnection[]
provisioningState Estado de aprovisionamiento de ARM del servicio de aprovisionamiento. cuerda
publicNetworkAccess Indica si se permiten solicitudes de la red pública 'Deshabilitado'
'Habilitado'
estado Estado actual del servicio de aprovisionamiento. "Activación"
'ActivationFailed'
'Activo'
'Eliminado'
"Eliminar"
'DeletionFailed'
'Conmutación por error'
'FailoverFailed'
"Reanudación"
'Suspendido'
'Suspender'
"Transición"

IotDpsSkuInfo

Nombre Descripción Valor
capacidad Número de unidades que se van a aprovisionar Int
nombre Nombre de la SKU. 'S1'

IotHubDefinitionDescription

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

IpFilterRule

Nombre Descripción Valor
acción Acción deseada para las solicitudes capturadas por esta regla. 'Aceptar'
'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)
blanco Destino de las solicitudes capturadas por esta regla. 'all'
'deviceApi'
'serviceApi'

Microsoft.Devices/provisioningServices

Nombre Descripción Valor
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 ETag normal. cuerda
ubicación Ubicación del recurso. string (obligatorio)
nombre El nombre del recurso string (obligatorio)
Propiedades Propiedades específicas del servicio para un servicio de aprovisionamiento IotDpsPropertiesDescription (obligatorio)
grupo de recursos El grupo de recursos del recurso. cuerda
Sku Información de SKU para un servicio de aprovisionamiento. IotDpsSkuInfo (obligatorio)
subscriptionid Identificador de suscripción del recurso. cuerda
Etiquetas Etiquetas de recursos Diccionario de nombres y valores de etiqueta.
tipo El tipo de recurso "Microsoft.Devices/provisioningServices@2022-12-12"

PrivateEndpoint

Nombre Descripción Valor

PrivateEndpointConnection

Nombre Descripción Valor
Propiedades Propiedades de una conexión de punto de conexión privado privateEndpointConnectionProperties (obligatorio)

PrivateEndpointConnectionProperties

Nombre Descripción Valor
privateEndpoint La propiedad de punto de conexión privado de una conexión de punto de conexión privado PrivateEndpoint
privateLinkServiceConnectionState Estado actual de una conexión de punto de conexión privado privateLinkServiceConnectionState (obligatorio)

PrivateLinkServiceConnectionState

Nombre Descripción Valor
actionsRequired Acciones necesarias para una conexión de punto de conexión privado cuerda
descripción Descripción del estado actual de una conexión de punto de conexión privado string (obligatorio)
estado Estado de una conexión de punto de conexión privado 'Aprobado'
'Desconectado'
'Pendiente'
'Rechazado' (obligatorio)

ResourceTags

Nombre Descripción Valor

SharedAccessSignatureAuthorizationRuleAccessRightsDescription

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