Nota:
El acceso a esta página requiere autorización. Puede intentar iniciar sesión o cambiar directorios.
El acceso a esta página requiere autorización. Puede intentar cambiar los directorios.
Definición de recursos de Bicep
El tipo de recurso digitalTwinsInstances/endpoints se puede implementar con operaciones destinadas a:
- grupos de recursos: consulte comandos de implementación de grupos de recursos
Para obtener una lista de las propiedades modificadas en cada versión de API, consulte registro de cambios.
Ejemplos de uso
Ejemplos de Bicep
Un ejemplo básico de implementación de Digital Twins Endpoint.
param resourceName string = 'acctest0001'
param location string = 'westeurope'
resource digitalTwinsInstance 'Microsoft.DigitalTwins/digitalTwinsInstances@2020-12-01' = {
name: resourceName
location: location
}
resource namespace 'Microsoft.ServiceBus/namespaces@2022-01-01-preview' = {
name: resourceName
location: location
sku: {
capacity: 0
name: 'Standard'
tier: 'Standard'
}
properties: {
disableLocalAuth: false
publicNetworkAccess: 'Enabled'
zoneRedundant: false
}
}
resource endpoint 'Microsoft.DigitalTwins/digitalTwinsInstances/endpoints@2020-12-01' = {
name: resourceName
parent: digitalTwinsInstance
properties: {
authenticationType: 'KeyBased'
deadLetterSecret: ''
endpointType: 'ServiceBus'
primaryConnectionString: authorizationRule.listKeys().primaryConnectionString
secondaryConnectionString: authorizationRule.listKeys().secondaryConnectionString
}
}
resource topic 'Microsoft.ServiceBus/namespaces/topics@2021-06-01-preview' = {
name: resourceName
parent: namespace
properties: {
enableBatchedOperations: false
enableExpress: false
enablePartitioning: false
maxSizeInMegabytes: 5120
requiresDuplicateDetection: false
status: 'Active'
supportOrdering: false
}
}
resource authorizationRule 'Microsoft.ServiceBus/namespaces/topics/authorizationRules@2021-06-01-preview' = {
name: resourceName
parent: topic
properties: {
rights: [
'Send'
]
}
}
Módulos comprobados de Azure
Los siguientes módulos comprobados de Azure se pueden usar para implementar este tipo de recurso.
| Module | Descripción |
|---|---|
| Instancia de Gemelos Digitales - Endpoint | Módulo Hijo AVM para Instancia de Digital Twins - Endpoint |
Formato de recurso
Para crear un recurso Microsoft.DigitalTwins/digitalTwinsInstances/endpoints, agregue el siguiente bicep a la plantilla.
resource symbolicname 'Microsoft.DigitalTwins/digitalTwinsInstances/endpoints@2022-10-31' = {
parent: resourceSymbolicName
name: 'string'
properties: {
authenticationType: 'string'
deadLetterSecret: 'string'
deadLetterUri: 'string'
identity: {
type: 'string'
userAssignedIdentity: 'string'
}
endpointType: 'string'
// For remaining properties, see DigitalTwinsEndpointResourceProperties objects
}
}
Objetos DigitalTwinsEndpointResourceProperties
Establezca la propiedad endpointType para especificar el tipo de objeto.
Para EventGrid, use:
{
accessKey1: 'string'
accessKey2: 'string'
endpointType: 'EventGrid'
TopicEndpoint: 'string'
}
Para eventHub, use:
{
connectionStringPrimaryKey: 'string'
connectionStringSecondaryKey: 'string'
endpointType: 'EventHub'
endpointUri: 'string'
entityPath: 'string'
}
Para serviceBus, use:
{
endpointType: 'ServiceBus'
endpointUri: 'string'
entityPath: 'string'
primaryConnectionString: 'string'
secondaryConnectionString: 'string'
}
Valores de propiedad
Microsoft.DigitalTwins/digitalTwinsInstances/endpoints
| Nombre | Descripción | Valor |
|---|---|---|
| nombre | El nombre del recurso | cuerda Restricciones: Longitud mínima = 2 Longitud máxima = 49 Patrón = ^(?![0-9]+$)(?!-)[a-zA-Z0-9-]{2,49}[a-zA-Z0-9]$ (obligatorio) |
| padre | En Bicep, puede especificar el recurso primario para un recurso secundario. Solo tiene que agregar esta propiedad cuando el recurso secundario se declara fuera del recurso primario. Para obtener más información, consulte recurso secundario fuera del recurso primario. |
Nombre simbólico del recurso de tipo: digitalTwinsInstances |
| Propiedades | Propiedades del recurso de punto de conexión DigitalTwinsInstance. | digitalTwinsEndpointResourceProperties (obligatorio) |
DigitalTwinsEndpointResourceProperties
| Nombre | Descripción | Valor |
|---|---|---|
| Tipo de autenticación | Especifica el tipo de autenticación que se usa para conectarse al punto de conexión. El valor predeterminado es "KeyBased". Si se selecciona "KeyBased", se debe especificar una cadena de conexión (al menos la cadena de conexión principal). Si se selecciona "IdentityBased", se deben especificar las propiedades endpointUri y entityPath. | 'Basado en la identidad' 'Basado en claves' |
| deadLetterSecret | Secreto de almacenamiento de mensajes fallidos para la autenticación basada en claves. Se ofuscará durante la lectura. | cuerda Restricciones: Valor confidencial. Pase como parámetro seguro. |
| deadLetterUri | Dirección URL de almacenamiento de mensajes fallidos para la autenticación basada en identidades. | cuerda |
| endpointType | Establezca en "EventGrid" para el tipo EventGrid. Establezca en "EventHub" para el tipo EventHub. Establezca en "ServiceBus" para el tipo ServiceBus. | 'Cuadrícula de eventos' 'Centro de eventos' 'ServiceBus' (obligatorio) |
| identidad | Propiedades de identidad administrada para el punto de conexión. | managedIdentityReference |
EventGrid
| Nombre | Descripción | Valor |
|---|---|---|
| accessKey1 | Clave de acceso secundaria de EventGrid. Se ofuscará durante la lectura. | cuerda Restricciones: Valor confidencial. Pase como parámetro seguro. (obligatorio) |
| accessKey2 | Clave de acceso secundaria de EventGrid. Se ofuscará durante la lectura. | cuerda Restricciones: Valor confidencial. Pase como parámetro seguro. |
| endpointType | El tipo de punto de conexión de Digital Twins | 'EventGrid' (obligatorio) |
| TopicEndpoint | Punto de conexión de tema de EventGrid. | string (obligatorio) |
Centro de eventos
| Nombre | Descripción | Valor |
|---|---|---|
| connectionStringPrimaryKey | PrimaryConnectionString del punto de conexión para la autenticación basada en claves. Se ofuscará durante la lectura. | cuerda Restricciones: Valor confidencial. Pase como parámetro seguro. |
| connectionStringSecondaryKey | SecondaryConnectionString del punto de conexión para la autenticación basada en claves. Se ofuscará durante la lectura. | cuerda Restricciones: Valor confidencial. Pase como parámetro seguro. |
| endpointType | El tipo de punto de conexión de Digital Twins | 'EventHub' (obligatorio) |
| endpointUri | Dirección URL del espacio de nombres de EventHub para la autenticación basada en identidades. Debe incluir el protocolo "sb://". | cuerda |
| entityPath | Nombre de EventHub en el espacio de nombres de EventHub para la autenticación basada en identidades. | cuerda |
ManagedIdentityReference
| Nombre | Descripción | Valor |
|---|---|---|
| tipo | Tipo de identidad administrada usada. | 'SystemAssigned' 'Asignado por el usuario' |
| userAssignedIdentity | Identificador de recurso de ARM de identidad de usuario si el tipo de identidad administrada es "UserAssigned". | cuerda |
ServiceBus
| Nombre | Descripción | Valor |
|---|---|---|
| endpointType | El tipo de punto de conexión de Digital Twins | 'ServiceBus' (obligatorio) |
| endpointUri | Dirección URL del espacio de nombres serviceBus para la autenticación basada en identidades. Debe incluir el protocolo "sb://". | cuerda |
| entityPath | Nombre del tema de ServiceBus para la autenticación basada en identidades. | cuerda |
| primaryConnectionString | PrimaryConnectionString del punto de conexión para la autenticación basada en claves. Se ofuscará durante la lectura. | cuerda Restricciones: Valor confidencial. Pase como parámetro seguro. |
| secondaryConnectionString | SecondaryConnectionString del punto de conexión para la autenticación basada en claves. Se ofuscará durante la lectura. | cuerda Restricciones: Valor confidencial. Pase como parámetro seguro. |
Definición de recursos de plantilla de ARM
El tipo de recurso digitalTwinsInstances/endpoints se puede implementar con operaciones destinadas a:
- Grupos de recursos - Véase comandos de despliegue de grupos de recursos Para una lista de propiedades modificadas en cada versión de la API, consulte registro de cambios.
Ejemplos de uso
Formato de recurso
Para crear un recurso Microsoft.DigitalTwins/digitalTwinsInstances/endpoints, agregue el siguiente JSON a la plantilla.
{
"type": "Microsoft.DigitalTwins/digitalTwinsInstances/endpoints",
"apiVersion": "2022-10-31",
"name": "string",
"properties": {
"authenticationType": "string",
"deadLetterSecret": "string",
"deadLetterUri": "string",
"identity": {
"type": "string",
"userAssignedIdentity": "string"
},
"endpointType": "string"
// For remaining properties, see DigitalTwinsEndpointResourceProperties objects
}
}
Objetos DigitalTwinsEndpointResourceProperties
Establezca la propiedad endpointType para especificar el tipo de objeto.
Para EventGrid, use:
{
"accessKey1": "string",
"accessKey2": "string",
"endpointType": "EventGrid",
"TopicEndpoint": "string"
}
Para eventHub, use:
{
"connectionStringPrimaryKey": "string",
"connectionStringSecondaryKey": "string",
"endpointType": "EventHub",
"endpointUri": "string",
"entityPath": "string"
}
Para serviceBus, use:
{
"endpointType": "ServiceBus",
"endpointUri": "string",
"entityPath": "string",
"primaryConnectionString": "string",
"secondaryConnectionString": "string"
}
Valores de propiedad
Microsoft.DigitalTwins/digitalTwinsInstances/endpoints
DigitalTwinsEndpointResourceProperties
| Nombre | Descripción | Valor |
|---|---|---|
| Tipo de autenticación | Especifica el tipo de autenticación que se usa para conectarse al punto de conexión. El valor predeterminado es "KeyBased". Si se selecciona "KeyBased", se debe especificar una cadena de conexión (al menos la cadena de conexión principal). Si se selecciona "IdentityBased", se deben especificar las propiedades endpointUri y entityPath. | 'Basado en la identidad' 'Basado en claves' |
| deadLetterSecret | Secreto de almacenamiento de mensajes fallidos para la autenticación basada en claves. Se ofuscará durante la lectura. | cuerda Restricciones: Valor confidencial. Pase como parámetro seguro. |
| deadLetterUri | Dirección URL de almacenamiento de mensajes fallidos para la autenticación basada en identidades. | cuerda |
| endpointType | Establezca en "EventGrid" para el tipo EventGrid. Establezca en "EventHub" para el tipo EventHub. Establezca en "ServiceBus" para el tipo ServiceBus. | 'Cuadrícula de eventos' 'Centro de eventos' 'ServiceBus' (obligatorio) |
| identidad | Propiedades de identidad administrada para el punto de conexión. | managedIdentityReference |
EventGrid
| Nombre | Descripción | Valor |
|---|---|---|
| accessKey1 | Clave de acceso secundaria de EventGrid. Se ofuscará durante la lectura. | cuerda Restricciones: Valor confidencial. Pase como parámetro seguro. (obligatorio) |
| accessKey2 | Clave de acceso secundaria de EventGrid. Se ofuscará durante la lectura. | cuerda Restricciones: Valor confidencial. Pase como parámetro seguro. |
| endpointType | El tipo de punto de conexión de Digital Twins | 'EventGrid' (obligatorio) |
| TopicEndpoint | Punto de conexión de tema de EventGrid. | string (obligatorio) |
Centro de eventos
| Nombre | Descripción | Valor |
|---|---|---|
| connectionStringPrimaryKey | PrimaryConnectionString del punto de conexión para la autenticación basada en claves. Se ofuscará durante la lectura. | cuerda Restricciones: Valor confidencial. Pase como parámetro seguro. |
| connectionStringSecondaryKey | SecondaryConnectionString del punto de conexión para la autenticación basada en claves. Se ofuscará durante la lectura. | cuerda Restricciones: Valor confidencial. Pase como parámetro seguro. |
| endpointType | El tipo de punto de conexión de Digital Twins | 'EventHub' (obligatorio) |
| endpointUri | Dirección URL del espacio de nombres de EventHub para la autenticación basada en identidades. Debe incluir el protocolo "sb://". | cuerda |
| entityPath | Nombre de EventHub en el espacio de nombres de EventHub para la autenticación basada en identidades. | cuerda |
ManagedIdentityReference
| Nombre | Descripción | Valor |
|---|---|---|
| tipo | Tipo de identidad administrada usada. | 'SystemAssigned' 'Asignado por el usuario' |
| userAssignedIdentity | Identificador de recurso de ARM de identidad de usuario si el tipo de identidad administrada es "UserAssigned". | cuerda |
ServiceBus
| Nombre | Descripción | Valor |
|---|---|---|
| endpointType | El tipo de punto de conexión de Digital Twins | 'ServiceBus' (obligatorio) |
| endpointUri | Dirección URL del espacio de nombres serviceBus para la autenticación basada en identidades. Debe incluir el protocolo "sb://". | cuerda |
| entityPath | Nombre del tema de ServiceBus para la autenticación basada en identidades. | cuerda |
| primaryConnectionString | PrimaryConnectionString del punto de conexión para la autenticación basada en claves. Se ofuscará durante la lectura. | cuerda Restricciones: Valor confidencial. Pase como parámetro seguro. |
| secondaryConnectionString | SecondaryConnectionString del punto de conexión para la autenticación basada en claves. Se ofuscará durante la lectura. | cuerda Restricciones: Valor confidencial. Pase como parámetro seguro. |
Definición de recursos de Terraform (proveedor AzAPI)
El tipo de recurso digitalTwinsInstances/endpoints se puede implementar con operaciones destinadas a:
- Grupos de recursos Para una lista de propiedades modificadas en cada versión de la API, consulte registro de cambios.
Ejemplos de uso
Ejemplos de Terraform
Un ejemplo básico de implementación de Digital Twins Endpoint.
terraform {
required_providers {
azapi = {
source = "Azure/azapi"
}
}
}
provider "azapi" {
skip_provider_registration = false
}
variable "resource_name" {
type = string
default = "acctest0001"
}
variable "location" {
type = string
default = "westeurope"
}
resource "azapi_resource" "resourceGroup" {
type = "Microsoft.Resources/resourceGroups@2020-06-01"
name = var.resource_name
location = var.location
}
resource "azapi_resource" "namespace" {
type = "Microsoft.ServiceBus/namespaces@2022-01-01-preview"
parent_id = azapi_resource.resourceGroup.id
name = var.resource_name
location = var.location
body = {
properties = {
disableLocalAuth = false
publicNetworkAccess = "Enabled"
zoneRedundant = false
}
sku = {
capacity = 0
name = "Standard"
tier = "Standard"
}
}
schema_validation_enabled = false
response_export_values = ["*"]
}
resource "azapi_resource" "digitalTwinsInstance" {
type = "Microsoft.DigitalTwins/digitalTwinsInstances@2020-12-01"
parent_id = azapi_resource.resourceGroup.id
name = var.resource_name
location = var.location
body = {
}
schema_validation_enabled = false
response_export_values = ["*"]
}
resource "azapi_resource" "topic" {
type = "Microsoft.ServiceBus/namespaces/topics@2021-06-01-preview"
parent_id = azapi_resource.namespace.id
name = var.resource_name
body = {
properties = {
enableBatchedOperations = false
enableExpress = false
enablePartitioning = false
maxSizeInMegabytes = 5120
requiresDuplicateDetection = false
status = "Active"
supportOrdering = false
}
}
schema_validation_enabled = false
response_export_values = ["*"]
}
resource "azapi_resource" "authorizationRule" {
type = "Microsoft.ServiceBus/namespaces/topics/authorizationRules@2021-06-01-preview"
parent_id = azapi_resource.topic.id
name = var.resource_name
body = {
properties = {
rights = [
"Send",
]
}
}
schema_validation_enabled = false
response_export_values = ["*"]
}
data "azapi_resource_action" "listKeys" {
type = "Microsoft.ServiceBus/namespaces/topics/authorizationRules@2021-06-01-preview"
resource_id = azapi_resource.authorizationRule.id
action = "listKeys"
response_export_values = ["*"]
}
resource "azapi_resource" "endpoint" {
type = "Microsoft.DigitalTwins/digitalTwinsInstances/endpoints@2020-12-01"
parent_id = azapi_resource.digitalTwinsInstance.id
name = var.resource_name
body = {
properties = {
authenticationType = "KeyBased"
deadLetterSecret = ""
endpointType = "ServiceBus"
primaryConnectionString = data.azapi_resource_action.listKeys.output.primaryConnectionString
secondaryConnectionString = data.azapi_resource_action.listKeys.output.secondaryConnectionString
}
}
schema_validation_enabled = false
response_export_values = ["*"]
lifecycle {
ignore_changes = [body.properties.primaryConnectionString, body.properties.secondaryConnectionString]
}
}
Formato de recurso
Para crear un recurso Microsoft.DigitalTwins/digitalTwinsInstances/endpoints, agregue el siguiente terraform a la plantilla.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DigitalTwins/digitalTwinsInstances/endpoints@2022-10-31"
name = "string"
parent_id = "string"
body = {
properties = {
authenticationType = "string"
deadLetterSecret = "string"
deadLetterUri = "string"
identity = {
type = "string"
userAssignedIdentity = "string"
}
endpointType = "string"
// For remaining properties, see DigitalTwinsEndpointResourceProperties objects
}
}
}
Objetos DigitalTwinsEndpointResourceProperties
Establezca la propiedad endpointType para especificar el tipo de objeto.
Para EventGrid, use:
{
accessKey1 = "string"
accessKey2 = "string"
endpointType = "EventGrid"
TopicEndpoint = "string"
}
Para eventHub, use:
{
connectionStringPrimaryKey = "string"
connectionStringSecondaryKey = "string"
endpointType = "EventHub"
endpointUri = "string"
entityPath = "string"
}
Para serviceBus, use:
{
endpointType = "ServiceBus"
endpointUri = "string"
entityPath = "string"
primaryConnectionString = "string"
secondaryConnectionString = "string"
}
Valores de propiedad
Microsoft.DigitalTwins/digitalTwinsInstances/endpoints
| Nombre | Descripción | Valor |
|---|---|---|
| nombre | El nombre del recurso | cuerda Restricciones: Longitud mínima = 2 Longitud máxima = 49 Patrón = ^(?![0-9]+$)(?!-)[a-zA-Z0-9-]{2,49}[a-zA-Z0-9]$ (obligatorio) |
| parent_id | Identificador del recurso que es el elemento primario de este recurso. | Identificador del recurso de tipo: digitalTwinsInstances |
| Propiedades | Propiedades del recurso de punto de conexión DigitalTwinsInstance. | digitalTwinsEndpointResourceProperties (obligatorio) |
| tipo | El tipo de recurso | "Microsoft.DigitalTwins/digitalTwinsInstances/endpoints@2022-10-31" |
DigitalTwinsEndpointResourceProperties
| Nombre | Descripción | Valor |
|---|---|---|
| Tipo de autenticación | Especifica el tipo de autenticación que se usa para conectarse al punto de conexión. El valor predeterminado es "KeyBased". Si se selecciona "KeyBased", se debe especificar una cadena de conexión (al menos la cadena de conexión principal). Si se selecciona "IdentityBased", se deben especificar las propiedades endpointUri y entityPath. | 'Basado en la identidad' 'Basado en claves' |
| deadLetterSecret | Secreto de almacenamiento de mensajes fallidos para la autenticación basada en claves. Se ofuscará durante la lectura. | cuerda Restricciones: Valor confidencial. Pase como parámetro seguro. |
| deadLetterUri | Dirección URL de almacenamiento de mensajes fallidos para la autenticación basada en identidades. | cuerda |
| endpointType | Establezca en "EventGrid" para el tipo EventGrid. Establezca en "EventHub" para el tipo EventHub. Establezca en "ServiceBus" para el tipo ServiceBus. | 'Cuadrícula de eventos' 'Centro de eventos' 'ServiceBus' (obligatorio) |
| identidad | Propiedades de identidad administrada para el punto de conexión. | managedIdentityReference |
EventGrid
| Nombre | Descripción | Valor |
|---|---|---|
| accessKey1 | Clave de acceso secundaria de EventGrid. Se ofuscará durante la lectura. | cuerda Restricciones: Valor confidencial. Pase como parámetro seguro. (obligatorio) |
| accessKey2 | Clave de acceso secundaria de EventGrid. Se ofuscará durante la lectura. | cuerda Restricciones: Valor confidencial. Pase como parámetro seguro. |
| endpointType | El tipo de punto de conexión de Digital Twins | 'EventGrid' (obligatorio) |
| TopicEndpoint | Punto de conexión de tema de EventGrid. | string (obligatorio) |
Centro de eventos
| Nombre | Descripción | Valor |
|---|---|---|
| connectionStringPrimaryKey | PrimaryConnectionString del punto de conexión para la autenticación basada en claves. Se ofuscará durante la lectura. | cuerda Restricciones: Valor confidencial. Pase como parámetro seguro. |
| connectionStringSecondaryKey | SecondaryConnectionString del punto de conexión para la autenticación basada en claves. Se ofuscará durante la lectura. | cuerda Restricciones: Valor confidencial. Pase como parámetro seguro. |
| endpointType | El tipo de punto de conexión de Digital Twins | 'EventHub' (obligatorio) |
| endpointUri | Dirección URL del espacio de nombres de EventHub para la autenticación basada en identidades. Debe incluir el protocolo "sb://". | cuerda |
| entityPath | Nombre de EventHub en el espacio de nombres de EventHub para la autenticación basada en identidades. | cuerda |
ManagedIdentityReference
| Nombre | Descripción | Valor |
|---|---|---|
| tipo | Tipo de identidad administrada usada. | 'SystemAssigned' 'Asignado por el usuario' |
| userAssignedIdentity | Identificador de recurso de ARM de identidad de usuario si el tipo de identidad administrada es "UserAssigned". | cuerda |
ServiceBus
| Nombre | Descripción | Valor |
|---|---|---|
| endpointType | El tipo de punto de conexión de Digital Twins | 'ServiceBus' (obligatorio) |
| endpointUri | Dirección URL del espacio de nombres serviceBus para la autenticación basada en identidades. Debe incluir el protocolo "sb://". | cuerda |
| entityPath | Nombre del tema de ServiceBus para la autenticación basada en identidades. | cuerda |
| primaryConnectionString | PrimaryConnectionString del punto de conexión para la autenticación basada en claves. Se ofuscará durante la lectura. | cuerda Restricciones: Valor confidencial. Pase como parámetro seguro. |
| secondaryConnectionString | SecondaryConnectionString del punto de conexión para la autenticación basada en claves. Se ofuscará durante la lectura. | cuerda Restricciones: Valor confidencial. Pase como parámetro seguro. |