Microsoft.DigitalTwins digitalTwinsЭкземпляры/конечные точки 2022-10-31

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

Тип ресурса digitalTwinsInstances/endpoints можно развернуть с помощью операций, предназначенных для следующих операций:

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

Примеры использования

Примеры Bicep

Простой пример развертывания 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'
    ]
  }
}

Проверенные модули Azure

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

Module Описание
Экземпляр цифровых двойников — конечная точка Дочерний модуль AVM для экземпляра цифровых двойников — конечная точка

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

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

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
  }
}

Объекты DigitalTwinsEndpointResourceProperties

Задайте свойство endpointType, чтобы указать тип объекта.

Для EventGridиспользуйте:

{
  accessKey1: 'string'
  accessKey2: 'string'
  endpointType: 'EventGrid'
  TopicEndpoint: 'string'
}

Для EventHubиспользуйте:

{
  connectionStringPrimaryKey: 'string'
  connectionStringSecondaryKey: 'string'
  endpointType: 'EventHub'
  endpointUri: 'string'
  entityPath: 'string'
}

Для ServiceBusиспользуйте:

{
  endpointType: 'ServiceBus'
  endpointUri: 'string'
  entityPath: 'string'
  primaryConnectionString: 'string'
  secondaryConnectionString: 'string'
}

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

Microsoft.DigitalTwins/DigitalTwinsInstances/конечные точки

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

Ограничения целостности:
Минимальная длина = 2
Максимальная длина = 49
Pattern = ^(?![0-9]+$)(?!-)[a-zA-Z0-9-]{2,49}[a-zA-Z0-9]$ (обязательно)
родитель В Bicep можно указать родительский ресурс для дочернего ресурса. Это свойство необходимо добавить, только если дочерний ресурс объявлен за пределами родительского ресурса.

Дополнительные сведения см. в разделе Дочерний ресурс за пределами родительского ресурса.
Символьное имя ресурса типа: digitalTwinsInstances
свойства Свойства ресурса конечной точки DigitalTwinsInstance. DigitalTwinsEndpointResourceProperties (обязательно)

DigitalTwinsEndpointResourceProperties

Имя Описание Ценность
тип аутентификации Указывает тип проверки подлинности, используемый для подключения к конечной точке. По умолчанию используется значение KeyBased. Если выбран параметр KeyBased, необходимо указать строку подключения (по крайней мере основную строку подключения). Если выбран параметр IdentityBased, необходимо указать свойства endpointUri и entityPath. IdentityBased
KeyBased
deadLetterSecret Секрет хранилища недоставленных писем для проверки подлинности на основе ключей. Будет замаскирован во время чтения. струна

Ограничения целостности:
Конфиденциальное значение. Передайте в качестве безопасного параметра.
deadLetterUri URL-адрес хранилища недоставленных писем для проверки подлинности на основе удостоверений. струна
endpointType Установите значение EventGrid для типа EventGrid. Установите значение EventHub для типа EventHub. Установите значение ServiceBus для типа ServiceBus. EventGrid
EventHub
ServiceBus (обязательно)
тождество Свойства управляемого удостоверения для конечной точки. ManagedIdentityReference

EventGrid

Имя Описание Ценность
Ключ доступа1 Дополнительный ключ доступа EventGrid. Будет замаскирован во время чтения. струна

Ограничения целостности:
Конфиденциальное значение. Передайте в качестве безопасного параметра. (обязательно)
Ключ доступа2 Дополнительный ключ доступа EventGrid. Будет замаскирован во время чтения. струна

Ограничения целостности:
Конфиденциальное значение. Передайте в качестве безопасного параметра.
endpointType Тип конечной точки Digital Twins EventGrid (обязательный)
Конечная точка темы Конечная точка раздела EventGrid. строка (обязательно)

EventHub

Имя Описание Ценность
connectionStringPrimaryKey PrimaryConnectionString конечной точки для проверки подлинности на основе ключей. Будет замаскирован во время чтения. струна

Ограничения целостности:
Конфиденциальное значение. Передайте в качестве безопасного параметра.
connectionStringSecondaryKey SecondaryConnectionString конечной точки для проверки подлинности на основе ключей. Будет замаскирован во время чтения. струна

Ограничения целостности:
Конфиденциальное значение. Передайте в качестве безопасного параметра.
endpointType Тип конечной точки Digital Twins EventHub (обязательно)
endpointUri URL-адрес пространства имен EventHub для проверки подлинности на основе удостоверений. Он должен включать протокол "sb://". струна
entityPath Имя EventHub в пространстве имен EventHub для проверки подлинности на основе удостоверений. струна

ManagedIdentityReference

Имя Описание Ценность
тип Тип управляемого удостоверения, используемого. SystemAssigned
UserAssigned
ИдентификацияПользователя Идентификатор ресурса ARM удостоверения пользователя, если тип управляемого удостоверения — UserAssigned. струна

Сервисная шина

Имя Описание Ценность
endpointType Тип конечной точки Digital Twins ServiceBus (обязательно)
endpointUri URL-адрес пространства имен ServiceBus для проверки подлинности на основе удостоверений. Он должен включать протокол "sb://". струна
entityPath Имя раздела ServiceBus для проверки подлинности на основе удостоверений. струна
первичная строка подключения PrimaryConnectionString конечной точки для проверки подлинности на основе ключей. Будет замаскирован во время чтения. струна

Ограничения целостности:
Конфиденциальное значение. Передайте в качестве безопасного параметра.
secondaryConnectionString SecondaryConnectionString конечной точки для проверки подлинности на основе ключей. Будет замаскирован во время чтения. струна

Ограничения целостности:
Конфиденциальное значение. Передайте в качестве безопасного параметра.

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

Тип ресурса digitalTwinsInstances/endpoints можно развернуть с помощью операций, предназначенных для следующих операций:

Примеры использования

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

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

{
  "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
  }
}

Объекты DigitalTwinsEndpointResourceProperties

Задайте свойство endpointType, чтобы указать тип объекта.

Для EventGridиспользуйте:

{
  "accessKey1": "string",
  "accessKey2": "string",
  "endpointType": "EventGrid",
  "TopicEndpoint": "string"
}

Для EventHubиспользуйте:

{
  "connectionStringPrimaryKey": "string",
  "connectionStringSecondaryKey": "string",
  "endpointType": "EventHub",
  "endpointUri": "string",
  "entityPath": "string"
}

Для ServiceBusиспользуйте:

{
  "endpointType": "ServiceBus",
  "endpointUri": "string",
  "entityPath": "string",
  "primaryConnectionString": "string",
  "secondaryConnectionString": "string"
}

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

Microsoft.DigitalTwins/DigitalTwinsInstances/конечные точки

Имя Описание Ценность
apiVersion Версия API '2022-10-31'
имя Имя ресурса струна

Ограничения целостности:
Минимальная длина = 2
Максимальная длина = 49
Pattern = ^(?![0-9]+$)(?!-)[a-zA-Z0-9-]{2,49}[a-zA-Z0-9]$ (обязательно)
свойства Свойства ресурса конечной точки DigitalTwinsInstance. DigitalTwinsEndpointResourceProperties (обязательно)
тип Тип ресурса "Microsoft.DigitalTwins/digitalTwinsInstances/endpoints"

DigitalTwinsEndpointResourceProperties

Имя Описание Ценность
тип аутентификации Указывает тип проверки подлинности, используемый для подключения к конечной точке. По умолчанию используется значение KeyBased. Если выбран параметр KeyBased, необходимо указать строку подключения (по крайней мере основную строку подключения). Если выбран параметр IdentityBased, необходимо указать свойства endpointUri и entityPath. IdentityBased
KeyBased
deadLetterSecret Секрет хранилища недоставленных писем для проверки подлинности на основе ключей. Будет замаскирован во время чтения. струна

Ограничения целостности:
Конфиденциальное значение. Передайте в качестве безопасного параметра.
deadLetterUri URL-адрес хранилища недоставленных писем для проверки подлинности на основе удостоверений. струна
endpointType Установите значение EventGrid для типа EventGrid. Установите значение EventHub для типа EventHub. Установите значение ServiceBus для типа ServiceBus. EventGrid
EventHub
ServiceBus (обязательно)
тождество Свойства управляемого удостоверения для конечной точки. ManagedIdentityReference

EventGrid

Имя Описание Ценность
Ключ доступа1 Дополнительный ключ доступа EventGrid. Будет замаскирован во время чтения. струна

Ограничения целостности:
Конфиденциальное значение. Передайте в качестве безопасного параметра. (обязательно)
Ключ доступа2 Дополнительный ключ доступа EventGrid. Будет замаскирован во время чтения. струна

Ограничения целостности:
Конфиденциальное значение. Передайте в качестве безопасного параметра.
endpointType Тип конечной точки Digital Twins EventGrid (обязательный)
Конечная точка темы Конечная точка раздела EventGrid. строка (обязательно)

EventHub

Имя Описание Ценность
connectionStringPrimaryKey PrimaryConnectionString конечной точки для проверки подлинности на основе ключей. Будет замаскирован во время чтения. струна

Ограничения целостности:
Конфиденциальное значение. Передайте в качестве безопасного параметра.
connectionStringSecondaryKey SecondaryConnectionString конечной точки для проверки подлинности на основе ключей. Будет замаскирован во время чтения. струна

Ограничения целостности:
Конфиденциальное значение. Передайте в качестве безопасного параметра.
endpointType Тип конечной точки Digital Twins EventHub (обязательно)
endpointUri URL-адрес пространства имен EventHub для проверки подлинности на основе удостоверений. Он должен включать протокол "sb://". струна
entityPath Имя EventHub в пространстве имен EventHub для проверки подлинности на основе удостоверений. струна

ManagedIdentityReference

Имя Описание Ценность
тип Тип управляемого удостоверения, используемого. SystemAssigned
UserAssigned
ИдентификацияПользователя Идентификатор ресурса ARM удостоверения пользователя, если тип управляемого удостоверения — UserAssigned. струна

Сервисная шина

Имя Описание Ценность
endpointType Тип конечной точки Digital Twins ServiceBus (обязательно)
endpointUri URL-адрес пространства имен ServiceBus для проверки подлинности на основе удостоверений. Он должен включать протокол "sb://". струна
entityPath Имя раздела ServiceBus для проверки подлинности на основе удостоверений. струна
первичная строка подключения PrimaryConnectionString конечной точки для проверки подлинности на основе ключей. Будет замаскирован во время чтения. струна

Ограничения целостности:
Конфиденциальное значение. Передайте в качестве безопасного параметра.
secondaryConnectionString SecondaryConnectionString конечной точки для проверки подлинности на основе ключей. Будет замаскирован во время чтения. струна

Ограничения целостности:
Конфиденциальное значение. Передайте в качестве безопасного параметра.

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

Тип ресурса digitalTwinsInstances/endpoints можно развернуть с помощью операций, предназначенных для следующих операций:

Примеры использования

Примеры Terraform

Простой пример развертывания 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]
  }
}

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

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

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
    }
  }
}

Объекты DigitalTwinsEndpointResourceProperties

Задайте свойство endpointType, чтобы указать тип объекта.

Для EventGridиспользуйте:

{
  accessKey1 = "string"
  accessKey2 = "string"
  endpointType = "EventGrid"
  TopicEndpoint = "string"
}

Для EventHubиспользуйте:

{
  connectionStringPrimaryKey = "string"
  connectionStringSecondaryKey = "string"
  endpointType = "EventHub"
  endpointUri = "string"
  entityPath = "string"
}

Для ServiceBusиспользуйте:

{
  endpointType = "ServiceBus"
  endpointUri = "string"
  entityPath = "string"
  primaryConnectionString = "string"
  secondaryConnectionString = "string"
}

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

Microsoft.DigitalTwins/DigitalTwinsInstances/конечные точки

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

Ограничения целостности:
Минимальная длина = 2
Максимальная длина = 49
Pattern = ^(?![0-9]+$)(?!-)[a-zA-Z0-9-]{2,49}[a-zA-Z0-9]$ (обязательно)
идентификатор_родителя Идентификатор ресурса, который является родительским для этого ресурса. Идентификатор ресурса типа: digitalTwinsInstances
свойства Свойства ресурса конечной точки DigitalTwinsInstance. DigitalTwinsEndpointResourceProperties (обязательно)
тип Тип ресурса "Microsoft.DigitalTwins/DigitalTwinsInstances/endpoints@2022-10-31"

DigitalTwinsEndpointResourceProperties

Имя Описание Ценность
тип аутентификации Указывает тип проверки подлинности, используемый для подключения к конечной точке. По умолчанию используется значение KeyBased. Если выбран параметр KeyBased, необходимо указать строку подключения (по крайней мере основную строку подключения). Если выбран параметр IdentityBased, необходимо указать свойства endpointUri и entityPath. IdentityBased
KeyBased
deadLetterSecret Секрет хранилища недоставленных писем для проверки подлинности на основе ключей. Будет замаскирован во время чтения. струна

Ограничения целостности:
Конфиденциальное значение. Передайте в качестве безопасного параметра.
deadLetterUri URL-адрес хранилища недоставленных писем для проверки подлинности на основе удостоверений. струна
endpointType Установите значение EventGrid для типа EventGrid. Установите значение EventHub для типа EventHub. Установите значение ServiceBus для типа ServiceBus. EventGrid
EventHub
ServiceBus (обязательно)
тождество Свойства управляемого удостоверения для конечной точки. ManagedIdentityReference

EventGrid

Имя Описание Ценность
Ключ доступа1 Дополнительный ключ доступа EventGrid. Будет замаскирован во время чтения. струна

Ограничения целостности:
Конфиденциальное значение. Передайте в качестве безопасного параметра. (обязательно)
Ключ доступа2 Дополнительный ключ доступа EventGrid. Будет замаскирован во время чтения. струна

Ограничения целостности:
Конфиденциальное значение. Передайте в качестве безопасного параметра.
endpointType Тип конечной точки Digital Twins EventGrid (обязательный)
Конечная точка темы Конечная точка раздела EventGrid. строка (обязательно)

EventHub

Имя Описание Ценность
connectionStringPrimaryKey PrimaryConnectionString конечной точки для проверки подлинности на основе ключей. Будет замаскирован во время чтения. струна

Ограничения целостности:
Конфиденциальное значение. Передайте в качестве безопасного параметра.
connectionStringSecondaryKey SecondaryConnectionString конечной точки для проверки подлинности на основе ключей. Будет замаскирован во время чтения. струна

Ограничения целостности:
Конфиденциальное значение. Передайте в качестве безопасного параметра.
endpointType Тип конечной точки Digital Twins EventHub (обязательно)
endpointUri URL-адрес пространства имен EventHub для проверки подлинности на основе удостоверений. Он должен включать протокол "sb://". струна
entityPath Имя EventHub в пространстве имен EventHub для проверки подлинности на основе удостоверений. струна

ManagedIdentityReference

Имя Описание Ценность
тип Тип управляемого удостоверения, используемого. SystemAssigned
UserAssigned
ИдентификацияПользователя Идентификатор ресурса ARM удостоверения пользователя, если тип управляемого удостоверения — UserAssigned. струна

Сервисная шина

Имя Описание Ценность
endpointType Тип конечной точки Digital Twins ServiceBus (обязательно)
endpointUri URL-адрес пространства имен ServiceBus для проверки подлинности на основе удостоверений. Он должен включать протокол "sb://". струна
entityPath Имя раздела ServiceBus для проверки подлинности на основе удостоверений. струна
первичная строка подключения PrimaryConnectionString конечной точки для проверки подлинности на основе ключей. Будет замаскирован во время чтения. струна

Ограничения целостности:
Конфиденциальное значение. Передайте в качестве безопасного параметра.
secondaryConnectionString SecondaryConnectionString конечной точки для проверки подлинности на основе ключей. Будет замаскирован во время чтения. струна

Ограничения целостности:
Конфиденциальное значение. Передайте в качестве безопасного параметра.