Bicep リソース定義
digitalTwinsInstances/endpoints リソースの種類は、次をターゲットとする操作と共にデプロイできます。
- リソース グループの - リソース グループのデプロイ コマンド 参照
各 API バージョンで変更されたプロパティの一覧については、変更ログの
使用例
Bicep サンプル
Digital Twins エンドポイントのデプロイの基本的な例。
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 パターン = ^(?![0-9]+$)(?!-)[a-zA-Z0-9-]{2,49}[a-zA-Z0-9]$ (必須) |
| 親 | Bicep では、子リソースの親リソースを指定できます。 このプロパティを追加する必要があるのは、子リソースが親リソースの外部で宣言されている場合のみです。 詳細については、「親リソースの外部 |
種類のリソースのシンボル名: digitalTwinsInstances |
| プロパティ | DigitalTwinsInstance エンドポイント リソースのプロパティ。 | DigitalTwinsEndpointResourceProperties (必須) |
DigitalTwinsEndpointResourceProperties (英語)
| 名前 | 形容 | 価値 |
|---|---|---|
| 認証タイプ | エンドポイントへの接続に使用する認証の種類を指定します。 既定値は 'KeyBased' です。 'KeyBased' が選択されている場合は、接続文字列 (少なくともプライマリ接続文字列) を指定する必要があります。 'IdentityBased' が選択されている場合は、endpointUri プロパティと entityPath プロパティを指定する必要があります。 | 「アイデンティティベース」 「キーベース」 |
| デッドレターシークレット | キーベースの認証用の配信不能ストレージ シークレット。 読み取り中に難読化されます。 | 糸 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 |
| デッドレターウリ | ID ベースの認証用の配信不能ストレージ URL。 | 文字列 |
| エンドポイントタイプ | EventGridの種類 |
「イベントグリッド」 「イベントハブ」 'ServiceBus' (必須) |
| ID | エンドポイントのマネージド ID プロパティ。 | ManagedIdentityReference (英語) |
イベントグリッド
| 名前 | 形容 | 価値 |
|---|---|---|
| アクセスキー1 | EventGrid セカンダリ アクセス キー。 読み取り中に難読化されます。 | 糸 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 (必須) |
| accessKey2 (アクセスキー2) | EventGrid セカンダリ アクセス キー。 読み取り中に難読化されます。 | 糸 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 |
| エンドポイントタイプ | Digital Twins エンドポイントの種類 | 'EventGrid' (必須) |
| トピックエンドポイント | EventGrid トピック エンドポイント。 | string (必須) |
イベントハブ
| 名前 | 形容 | 価値 |
|---|---|---|
| connectionStringプライマリキー | キーベース認証のエンドポイントの PrimaryConnectionString。 読み取り中に難読化されます。 | 糸 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 |
| connectionStringSecondaryKey (接続文字列セカンダリキー) | キーベースの認証用のエンドポイントの SecondaryConnectionString。 読み取り中に難読化されます。 | 糸 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 |
| エンドポイントタイプ | Digital Twins エンドポイントの種類 | 'EventHub' (必須) |
| エンドポイントURI | ID ベースの認証用の EventHub 名前空間の URL。 プロトコル 'sb://' を含める必要があります。 | 文字列 |
| エンティティパス | ID ベースの認証用の EventHub 名前空間の EventHub 名。 | 文字列 |
ManagedIdentityReference (英語)
| 名前 | 形容 | 価値 |
|---|---|---|
| 型 | 使用されるマネージド ID の種類。 | 'システム割り当て' 'UserAssigned' |
| ユーザー割り当てアイデンティティ | マネージド ID の種類が "UserAssigned" の場合のユーザー ID ARM リソース ID。 | 文字列 |
サービスバス
| 名前 | 形容 | 価値 |
|---|---|---|
| エンドポイントタイプ | Digital Twins エンドポイントの種類 | 'ServiceBus' (必須) |
| エンドポイントURI | ID ベースの認証用の ServiceBus 名前空間の URL。 プロトコル 'sb://' を含める必要があります。 | 文字列 |
| エンティティパス | ID ベースの認証の ServiceBus トピック名。 | 文字列 |
| プライマリ接続文字列 | キーベース認証のエンドポイントの PrimaryConnectionString。 読み取り中に難読化されます。 | 糸 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 |
| セカンダリ接続文字列 | キーベースの認証用のエンドポイントの SecondaryConnectionString。 読み取り中に難読化されます。 | 糸 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 |
ARM テンプレート リソース定義
digitalTwinsInstances/endpoints リソースの種類は、次をターゲットとする操作と共にデプロイできます。
- リソースグループ - リソースグループのデプロイコマンドを参照してください。 各APIバージョンの変更プロパティ一覧は 変更ログをご覧ください。
使用例
リソースの形式
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 パターン = ^(?![0-9]+$)(?!-)[a-zA-Z0-9-]{2,49}[a-zA-Z0-9]$ (必須) |
| プロパティ | DigitalTwinsInstance エンドポイント リソースのプロパティ。 | DigitalTwinsEndpointResourceProperties (必須) |
| 型 | リソースの種類 | 'Microsoft.DigitalTwins/digitalTwinsInstances/endpoints' |
DigitalTwinsEndpointResourceProperties (英語)
| 名前 | 形容 | 価値 |
|---|---|---|
| 認証タイプ | エンドポイントへの接続に使用する認証の種類を指定します。 既定値は 'KeyBased' です。 'KeyBased' が選択されている場合は、接続文字列 (少なくともプライマリ接続文字列) を指定する必要があります。 'IdentityBased' が選択されている場合は、endpointUri プロパティと entityPath プロパティを指定する必要があります。 | 「アイデンティティベース」 「キーベース」 |
| デッドレターシークレット | キーベースの認証用の配信不能ストレージ シークレット。 読み取り中に難読化されます。 | 糸 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 |
| デッドレターウリ | ID ベースの認証用の配信不能ストレージ URL。 | 文字列 |
| エンドポイントタイプ | EventGridの種類 |
「イベントグリッド」 「イベントハブ」 'ServiceBus' (必須) |
| ID | エンドポイントのマネージド ID プロパティ。 | ManagedIdentityReference (英語) |
イベントグリッド
| 名前 | 形容 | 価値 |
|---|---|---|
| アクセスキー1 | EventGrid セカンダリ アクセス キー。 読み取り中に難読化されます。 | 糸 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 (必須) |
| accessKey2 (アクセスキー2) | EventGrid セカンダリ アクセス キー。 読み取り中に難読化されます。 | 糸 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 |
| エンドポイントタイプ | Digital Twins エンドポイントの種類 | 'EventGrid' (必須) |
| トピックエンドポイント | EventGrid トピック エンドポイント。 | string (必須) |
イベントハブ
| 名前 | 形容 | 価値 |
|---|---|---|
| connectionStringプライマリキー | キーベース認証のエンドポイントの PrimaryConnectionString。 読み取り中に難読化されます。 | 糸 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 |
| connectionStringSecondaryKey (接続文字列セカンダリキー) | キーベースの認証用のエンドポイントの SecondaryConnectionString。 読み取り中に難読化されます。 | 糸 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 |
| エンドポイントタイプ | Digital Twins エンドポイントの種類 | 'EventHub' (必須) |
| エンドポイントURI | ID ベースの認証用の EventHub 名前空間の URL。 プロトコル 'sb://' を含める必要があります。 | 文字列 |
| エンティティパス | ID ベースの認証用の EventHub 名前空間の EventHub 名。 | 文字列 |
ManagedIdentityReference (英語)
| 名前 | 形容 | 価値 |
|---|---|---|
| 型 | 使用されるマネージド ID の種類。 | 'システム割り当て' 'UserAssigned' |
| ユーザー割り当てアイデンティティ | マネージド ID の種類が "UserAssigned" の場合のユーザー ID ARM リソース ID。 | 文字列 |
サービスバス
| 名前 | 形容 | 価値 |
|---|---|---|
| エンドポイントタイプ | Digital Twins エンドポイントの種類 | 'ServiceBus' (必須) |
| エンドポイントURI | ID ベースの認証用の ServiceBus 名前空間の URL。 プロトコル 'sb://' を含める必要があります。 | 文字列 |
| エンティティパス | ID ベースの認証の ServiceBus トピック名。 | 文字列 |
| プライマリ接続文字列 | キーベース認証のエンドポイントの PrimaryConnectionString。 読み取り中に難読化されます。 | 糸 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 |
| セカンダリ接続文字列 | キーベースの認証用のエンドポイントの SecondaryConnectionString。 読み取り中に難読化されます。 | 糸 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 |
Terraform (AzAPI プロバイダー) リソース定義
digitalTwinsInstances/endpoints リソースの種類は、次をターゲットとする操作と共にデプロイできます。
- リソースグループ 各APIバージョンの変更プロパティ一覧については、 変更ログをご覧ください。
使用例
Terraformサンプル
Digital Twins エンドポイントのデプロイの基本的な例。
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 パターン = ^(?![0-9]+$)(?!-)[a-zA-Z0-9-]{2,49}[a-zA-Z0-9]$ (必須) |
| parent_id | このリソースの親であるリソースの ID。 | 種類のリソースの ID: digitalTwinsInstances |
| プロパティ | DigitalTwinsInstance エンドポイント リソースのプロパティ。 | DigitalTwinsEndpointResourceProperties (必須) |
| 型 | リソースの種類 | "Microsoft.DigitalTwins/digitalTwinsInstances/endpoints@2022-10-31" |
DigitalTwinsEndpointResourceProperties (英語)
| 名前 | 形容 | 価値 |
|---|---|---|
| 認証タイプ | エンドポイントへの接続に使用する認証の種類を指定します。 既定値は 'KeyBased' です。 'KeyBased' が選択されている場合は、接続文字列 (少なくともプライマリ接続文字列) を指定する必要があります。 'IdentityBased' が選択されている場合は、endpointUri プロパティと entityPath プロパティを指定する必要があります。 | 「アイデンティティベース」 「キーベース」 |
| デッドレターシークレット | キーベースの認証用の配信不能ストレージ シークレット。 読み取り中に難読化されます。 | 糸 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 |
| デッドレターウリ | ID ベースの認証用の配信不能ストレージ URL。 | 文字列 |
| エンドポイントタイプ | EventGridの種類 |
「イベントグリッド」 「イベントハブ」 'ServiceBus' (必須) |
| ID | エンドポイントのマネージド ID プロパティ。 | ManagedIdentityReference (英語) |
イベントグリッド
| 名前 | 形容 | 価値 |
|---|---|---|
| アクセスキー1 | EventGrid セカンダリ アクセス キー。 読み取り中に難読化されます。 | 糸 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 (必須) |
| accessKey2 (アクセスキー2) | EventGrid セカンダリ アクセス キー。 読み取り中に難読化されます。 | 糸 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 |
| エンドポイントタイプ | Digital Twins エンドポイントの種類 | 'EventGrid' (必須) |
| トピックエンドポイント | EventGrid トピック エンドポイント。 | string (必須) |
イベントハブ
| 名前 | 形容 | 価値 |
|---|---|---|
| connectionStringプライマリキー | キーベース認証のエンドポイントの PrimaryConnectionString。 読み取り中に難読化されます。 | 糸 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 |
| connectionStringSecondaryKey (接続文字列セカンダリキー) | キーベースの認証用のエンドポイントの SecondaryConnectionString。 読み取り中に難読化されます。 | 糸 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 |
| エンドポイントタイプ | Digital Twins エンドポイントの種類 | 'EventHub' (必須) |
| エンドポイントURI | ID ベースの認証用の EventHub 名前空間の URL。 プロトコル 'sb://' を含める必要があります。 | 文字列 |
| エンティティパス | ID ベースの認証用の EventHub 名前空間の EventHub 名。 | 文字列 |
ManagedIdentityReference (英語)
| 名前 | 形容 | 価値 |
|---|---|---|
| 型 | 使用されるマネージド ID の種類。 | 'システム割り当て' 'UserAssigned' |
| ユーザー割り当てアイデンティティ | マネージド ID の種類が "UserAssigned" の場合のユーザー ID ARM リソース ID。 | 文字列 |
サービスバス
| 名前 | 形容 | 価値 |
|---|---|---|
| エンドポイントタイプ | Digital Twins エンドポイントの種類 | 'ServiceBus' (必須) |
| エンドポイントURI | ID ベースの認証用の ServiceBus 名前空間の URL。 プロトコル 'sb://' を含める必要があります。 | 文字列 |
| エンティティパス | ID ベースの認証の ServiceBus トピック名。 | 文字列 |
| プライマリ接続文字列 | キーベース認証のエンドポイントの PrimaryConnectionString。 読み取り中に難読化されます。 | 糸 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 |
| セカンダリ接続文字列 | キーベースの認証用のエンドポイントの SecondaryConnectionString。 読み取り中に難読化されます。 | 糸 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 |