Microsoft.Devices provisioningServices 2021-10-15
Definición de recursos de Bicep
El tipo de recurso provisioningServices se puede implementar con operaciones destinadas a:
- Grupos de recursos: consulte los comandos de implementación del grupo 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 bicep a la plantilla.
resource symbolicname 'Microsoft.Devices/provisioningServices@2021-10-15' = {
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'
}
]
enableDataResidency: bool
iotHubs: [
{
allocationWeight: int
applyAllocationPolicy: bool
connectionString: 'string'
location: 'string'
}
]
ipFilterRules: [
{
action: 'string'
filterName: 'string'
ipMask: 'string'
target: 'string'
}
]
privateEndpointConnections: [
{
properties: {
privateEndpoint: {}
privateLinkServiceConnectionState: {
actionsRequired: 'string'
description: 'string'
status: 'string'
}
}
}
]
provisioningState: 'string'
publicNetworkAccess: '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...[] |
| enableDataResidency | Opcional. Indica si la instancia de DPS tiene Data Residency habilitado, 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 | Las reglas de filtro IP. | IpFilterRule[] |
| privateEndpointConnections | Conexiones de punto de conexión privado creadas en este IotHub | PrivateEndpointConnection[] |
| provisioningState | Estado de aprovisionamiento de ARM del servicio de aprovisionamiento. | string |
| publicNetworkAccess | Indica si se permiten solicitudes de red pública | 'Deshabilitado' 'Habilitado' |
| 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 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' |
PrivateEndpointConnection
| Nombre | Descripción | Valor |
|---|---|---|
| properties | 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) |
PrivateEndpoint
Este objeto no contiene ninguna propiedad que se va a establecer durante la implementación. Todas las propiedades son ReadOnly.
PrivateLinkServiceConnectionState
| Nombre | Descripción | Valor |
|---|---|---|
| actionsRequired | Acciones necesarias para una conexión de punto de conexión privado | string |
| description | Descripción del estado actual de una conexión de punto de conexión privado | string (obligatorio) |
| status | Estado de una conexión de punto de conexión privado | 'Aprobado' 'Desconectado' 'Pendiente' 'Rechazado' (obligatorio) |
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 |
Esta plantilla crea un simulador perimetral de Ubuntu de IOT Hub y máquina virtual. |
| Creación de un servicio de aprovisionamiento de dispositivos IoT Hub |
Esta plantilla le permite crear un centro de IoT y un servicio de aprovisionamiento de dispositivos IoT Hub 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:
- Grupos de recursos: consulte los comandos de implementación del grupo 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 json a la plantilla.
{
"type": "Microsoft.Devices/provisioningServices",
"apiVersion": "2021-10-15",
"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"
}
],
"enableDataResidency": "bool",
"iotHubs": [
{
"allocationWeight": "int",
"applyAllocationPolicy": "bool",
"connectionString": "string",
"location": "string"
}
],
"ipFilterRules": [
{
"action": "string",
"filterName": "string",
"ipMask": "string",
"target": "string"
}
],
"privateEndpointConnections": [
{
"properties": {
"privateEndpoint": {},
"privateLinkServiceConnectionState": {
"actionsRequired": "string",
"description": "string",
"status": "string"
}
}
}
],
"provisioningState": "string",
"publicNetworkAccess": "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 | '2021-10-15' |
| 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 se debe proporcionar como un encabezado según la convención 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...[] |
| enableDataResidency | Opcional. Indica si la instancia de DPS tiene Data Residency habilitada, 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[] |
| privateEndpointConnections | Conexiones de punto de conexión privado creadas en este IotHub | PrivateEndpointConnection[] |
| provisioningState | Estado de aprovisionamiento de ARM del servicio de aprovisionamiento. | string |
| publicNetworkAccess | Indica si se permiten solicitudes de la red pública | 'Deshabilitado' 'Habilitado' |
| 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 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' |
PrivateEndpointConnection
| Nombre | Descripción | Valor |
|---|---|---|
| properties | 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) |
PrivateEndpoint
Este objeto no contiene ninguna propiedad que se establezca durante la implementación. Todas las propiedades son ReadOnly.
PrivateLinkServiceConnectionState
| Nombre | Descripción | Valor |
|---|---|---|
| actionsRequired | Acciones necesarias para una conexión de punto de conexión privado | string |
| description | Descripción del estado actual de una conexión de punto de conexión privado | string (obligatorio) |
| status | Estado de una conexión de punto de conexión privado | 'Aprobado' 'Desconectado' 'Pendiente' 'Rechazado' (obligatorio) |
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 |
Esta plantilla crea un simulador perimetral de Ubuntu de IOT Hub y máquina virtual. |
| Creación de un servicio de aprovisionamiento de dispositivos IoT Hub |
Esta plantilla le permite crear un centro de IoT y un servicio de aprovisionamiento de dispositivos IoT Hub 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@2021-10-15"
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"
}
]
enableDataResidency = bool
iotHubs = [
{
allocationWeight = int
applyAllocationPolicy = bool
connectionString = "string"
location = "string"
}
]
ipFilterRules = [
{
action = "string"
filterName = "string"
ipMask = "string"
target = "string"
}
]
privateEndpointConnections = [
{
properties = {
privateEndpoint = {}
privateLinkServiceConnectionState = {
actionsRequired = "string"
description = "string"
status = "string"
}
}
}
]
provisioningState = "string"
publicNetworkAccess = "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@2021-10-15" |
| 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 se debe proporcionar como un encabezado según la convención 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...[] |
| enableDataResidency | Opcional. Indica si la instancia de DPS tiene Data Residency habilitada, 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 | Las reglas de filtro IP. | IpFilterRule[] |
| privateEndpointConnections | Conexiones de punto de conexión privado creadas en este IotHub | PrivateEndpointConnection[] |
| provisioningState | Estado de aprovisionamiento de ARM del servicio de aprovisionamiento. | string |
| publicNetworkAccess | Indica si se permiten solicitudes de red pública | "Deshabilitado" "Habilitado" |
| state | Estado actual del servicio de aprovisionamiento. | "Activación" "ActivationFailed" "Activo" "Eliminado" "Eliminación" "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 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 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. | "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" |
PrivateEndpointConnection
| Nombre | Descripción | Valor |
|---|---|---|
| properties | 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) |
PrivateEndpoint
Este objeto no contiene ninguna propiedad que se va a establecer durante la implementación. Todas las propiedades son ReadOnly.
PrivateLinkServiceConnectionState
| Nombre | Descripción | Valor |
|---|---|---|
| actionsRequired | Acciones necesarias para una conexión de punto de conexión privado | string |
| description | Descripción del estado actual de una conexión de punto de conexión privado | string (obligatorio) |
| status | Estado de una conexión de punto de conexión privado | "Aprobado" "Desconectado" "Pendiente" "Rechazado" (obligatorio) |
IotDpsSkuInfo
| Nombre | Descripción | Valor |
|---|---|---|
| capacity | Número de unidades que se van a aprovisionar | int |
| name | Nombre de SKU. | "S1" |
Comentarios
Próximamente: A lo largo de 2024 iremos eliminando gradualmente GitHub Issues como mecanismo de comentarios sobre el contenido y lo sustituiremos por un nuevo sistema de comentarios. Para más información, vea: https://aka.ms/ContentUserFeedback.
Enviar y ver comentarios de