Bicep リソース定義
アカウント リソースの種類は、次をターゲットとする操作でデプロイできます。
各 API バージョンで変更されたプロパティの一覧については、変更ログの
リソースの形式
Microsoft.DeviceUpdate/accounts リソースを作成するには、次の Bicep をテンプレートに追加します。
resource symbolicname 'Microsoft.DeviceUpdate/accounts@2023-07-01' = {
scope: resourceSymbolicName or scope
identity: {
type: 'string'
userAssignedIdentities: {
{customized property}: {}
}
}
location: 'string'
name: 'string'
properties: {
encryption: {
keyVaultKeyUri: 'string'
userAssignedIdentity: 'string'
}
privateEndpointConnections: [
{
properties: {
groupIds: [
'string'
]
privateEndpoint: {}
privateLinkServiceConnectionState: {
actionsRequired: 'string'
description: 'string'
status: 'string'
}
}
}
]
publicNetworkAccess: 'string'
sku: 'string'
}
tags: {
{customized property}: 'string'
}
}
プロパティ値
Microsoft.DeviceUpdate/アカウント
| 名前 | 形容 | 価値 |
|---|---|---|
| ID | リソースに使用される ID の種類。 | ManagedServiceIdentity の |
| 位置 | リソースが存在する地理的な場所 | string (必須) |
| 名前 | リソース名 | 糸 制約: 最小長 = 3 最大長 = 24 パターン = ^[A-Za-z0-9]+(-[A-Za-z0-9]+)*$ (必須) |
| プロパティ | Device Update アカウントのプロパティ。 | アカウントプロパティ |
| スコープ | デプロイ スコープとは異なるスコープでリソースを作成するときに使用します。 | このプロパティをリソースのシンボリック名に設定して、拡張リソースを適用します。 |
| タグ | リソース タグ | タグ名と値のディクショナリ。 テンプレート の |
アカウントプロパティ
| 名前 | 形容 | 価値 |
|---|---|---|
| 暗号化 | 保存時の CMK 暗号化プロパティ | 暗号化 |
| privateEndpointConnections(プライベートエンドポイント接続) | アカウントに関連付けられているプライベート エンドポイント接続の一覧。 | プライベートエンドポイント接続[] |
| publicNetworkAccess (パブリックネットワークアクセス) | アカウントに対してパブリック ネットワーク アクセスが許可されているかどうか。 | 「無効」 「有効」 |
| エスケーユー | デバイス更新 SKU | 「無料」 「スタンダード」 |
暗号化
| 名前 | 形容 | 価値 |
|---|---|---|
| keyVaultKeyUri | キー コンテナーの URI | 文字列 |
| ユーザー割り当てアイデンティティ | キー コンテナーへのアクセスに使用するユーザー割り当て ID の完全な resourceId。 ID もアカウントに割り当てる必要があります | 文字列 |
マネージドサービスアイデンティティ
| 名前 | 形容 | 価値 |
|---|---|---|
| 型 | マネージド サービス ID の種類 (SystemAssigned 型と UserAssigned 型の両方が許可されます)。 | 「なし」 'システム割り当て' 'システム割り当て済み、ユーザー割り当て済み' 'UserAssigned' (必須) |
| userAssignedIdentities (ユーザー割り当て済みアイデンティティ) | リソースに関連付けられているユーザー割り当て ID のセット。 userAssignedIdentities ディクショナリ キーは、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} という形式の ARM リソース ID になります。 ディクショナリ値は、要求内の空のオブジェクト ({}) にすることができます。 | UserAssignedIdentities の |
プライベートエンドポイント
| 名前 | 形容 | 価値 |
|---|
プライベートエンドポイント接続
| 名前 | 形容 | 価値 |
|---|---|---|
| プロパティ | リソースのプロパティ。 | PrivateEndpointConnectionProperties (必須) |
プライベートエンドポイント接続プロパティ
| 名前 | 形容 | 価値 |
|---|---|---|
| グループID | グループ ID の配列。 | 文字列[] |
| プライベートエンドポイント | プライベート エンドポイントのリソース。 | PrivateEndpoint を |
| privateLinkServiceConnectionState | サービス コンシューマーとプロバイダー間の接続の状態に関する情報のコレクション。 | PrivateLinkServiceConnectionState (必須) |
PrivateLinkServiceConnectionState (英語)
| 名前 | 形容 | 価値 |
|---|---|---|
| アクション必須 | サービス プロバイダーの変更にコンシューマーの更新が必要かどうかを示すメッセージ。 | 文字列 |
| 形容 | 接続の承認/拒否の理由。 | 文字列 |
| 状態 | 接続がサービスの所有者によって承認/拒否/削除されたかどうかを示します。 | 「承認済み」 「保留中」 「拒否されました」 |
追跡リソースタグ
| 名前 | 形容 | 価値 |
|---|
UserAssignedIdentities (ユーザー割り当てアイデンティティ)
| 名前 | 形容 | 価値 |
|---|
ユーザー割り当て識別子
| 名前 | 形容 | 価値 |
|---|
使用例
Azure クイック スタートのサンプル
次 Azure クイック スタート テンプレート、このリソースの種類をデプロイするための Bicep サンプルが含まれています。
| Bicep ファイル | 形容 |
|---|---|
| IoT Hub アカウントの Device Update を作成する | このテンプレートは、パブリック DNS レコードを提供し、データ プレーンに対して REST API 呼び出しを行えるようにするアカウントを作成します。 その後、ユーザーはアカウントの下にインスタンスを作成し、それを IoT Hub にリンクしてサービスの使用を開始する必要があります。 |
| IoT Hub アカウント、インスタンス、IoT Hub の Device Update を作成する | このテンプレートは、アカウントと、インスタンスをリンクするインスタンスとハブを作成します。 必要なアクセス ポリシー、ルート、およびコンシューマー グループを使用してハブを構成します。 |
ARM テンプレート リソース定義
アカウント リソースの種類は、次をターゲットとする操作でデプロイできます。
各 API バージョンで変更されたプロパティの一覧については、変更ログの
リソースの形式
Microsoft.DeviceUpdate/accounts リソースを作成するには、次の JSON をテンプレートに追加します。
{
"type": "Microsoft.DeviceUpdate/accounts",
"apiVersion": "2023-07-01",
"name": "string",
"identity": {
"type": "string",
"userAssignedIdentities": {
"{customized property}": {
}
}
},
"location": "string",
"properties": {
"encryption": {
"keyVaultKeyUri": "string",
"userAssignedIdentity": "string"
},
"privateEndpointConnections": [
{
"properties": {
"groupIds": [ "string" ],
"privateEndpoint": {
},
"privateLinkServiceConnectionState": {
"actionsRequired": "string",
"description": "string",
"status": "string"
}
}
}
],
"publicNetworkAccess": "string",
"sku": "string"
},
"tags": {
"{customized property}": "string"
}
}
プロパティ値
Microsoft.DeviceUpdate/アカウント
| 名前 | 形容 | 価値 |
|---|---|---|
| apiVersion (英語) | API のバージョン | '2023-07-01' |
| ID | リソースに使用される ID の種類。 | ManagedServiceIdentity の |
| 位置 | リソースが存在する地理的な場所 | string (必須) |
| 名前 | リソース名 | 糸 制約: 最小長 = 3 最大長 = 24 パターン = ^[A-Za-z0-9]+(-[A-Za-z0-9]+)*$ (必須) |
| プロパティ | Device Update アカウントのプロパティ。 | アカウントプロパティ |
| タグ | リソース タグ | タグ名と値のディクショナリ。 テンプレート の |
| 型 | リソースの種類 | 'Microsoft.DeviceUpdate/accounts' |
アカウントプロパティ
| 名前 | 形容 | 価値 |
|---|---|---|
| 暗号化 | 保存時の CMK 暗号化プロパティ | 暗号化 |
| privateEndpointConnections(プライベートエンドポイント接続) | アカウントに関連付けられているプライベート エンドポイント接続の一覧。 | プライベートエンドポイント接続[] |
| publicNetworkAccess (パブリックネットワークアクセス) | アカウントに対してパブリック ネットワーク アクセスが許可されているかどうか。 | 「無効」 「有効」 |
| エスケーユー | デバイス更新 SKU | 「無料」 「スタンダード」 |
暗号化
| 名前 | 形容 | 価値 |
|---|---|---|
| keyVaultKeyUri | キー コンテナーの URI | 文字列 |
| ユーザー割り当てアイデンティティ | キー コンテナーへのアクセスに使用するユーザー割り当て ID の完全な resourceId。 ID もアカウントに割り当てる必要があります | 文字列 |
マネージドサービスアイデンティティ
| 名前 | 形容 | 価値 |
|---|---|---|
| 型 | マネージド サービス ID の種類 (SystemAssigned 型と UserAssigned 型の両方が許可されます)。 | 「なし」 'システム割り当て' 'システム割り当て済み、ユーザー割り当て済み' 'UserAssigned' (必須) |
| userAssignedIdentities (ユーザー割り当て済みアイデンティティ) | リソースに関連付けられているユーザー割り当て ID のセット。 userAssignedIdentities ディクショナリ キーは、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} という形式の ARM リソース ID になります。 ディクショナリ値は、要求内の空のオブジェクト ({}) にすることができます。 | UserAssignedIdentities の |
プライベートエンドポイント
| 名前 | 形容 | 価値 |
|---|
プライベートエンドポイント接続
| 名前 | 形容 | 価値 |
|---|---|---|
| プロパティ | リソースのプロパティ。 | PrivateEndpointConnectionProperties (必須) |
プライベートエンドポイント接続プロパティ
| 名前 | 形容 | 価値 |
|---|---|---|
| グループID | グループ ID の配列。 | 文字列[] |
| プライベートエンドポイント | プライベート エンドポイントのリソース。 | PrivateEndpoint を |
| privateLinkServiceConnectionState | サービス コンシューマーとプロバイダー間の接続の状態に関する情報のコレクション。 | PrivateLinkServiceConnectionState (必須) |
PrivateLinkServiceConnectionState (英語)
| 名前 | 形容 | 価値 |
|---|---|---|
| アクション必須 | サービス プロバイダーの変更にコンシューマーの更新が必要かどうかを示すメッセージ。 | 文字列 |
| 形容 | 接続の承認/拒否の理由。 | 文字列 |
| 状態 | 接続がサービスの所有者によって承認/拒否/削除されたかどうかを示します。 | 「承認済み」 「保留中」 「拒否されました」 |
追跡リソースタグ
| 名前 | 形容 | 価値 |
|---|
UserAssignedIdentities (ユーザー割り当てアイデンティティ)
| 名前 | 形容 | 価値 |
|---|
ユーザー割り当て識別子
| 名前 | 形容 | 価値 |
|---|
使用例
Azure クイック スタート テンプレート
このリソースの種類 デプロイする Azure クイック スタート テンプレート 次に示します。
| テンプレート | 形容 |
|---|---|
|
IoT Hub アカウントの Device Update を作成する Azure にデプロイする |
このテンプレートは、パブリック DNS レコードを提供し、データ プレーンに対して REST API 呼び出しを行えるようにするアカウントを作成します。 その後、ユーザーはアカウントの下にインスタンスを作成し、それを IoT Hub にリンクしてサービスの使用を開始する必要があります。 |
|
IoT Hub アカウント、インスタンス、IoT Hub の Device Update を作成する Azure にデプロイする |
このテンプレートは、アカウントと、インスタンスをリンクするインスタンスとハブを作成します。 必要なアクセス ポリシー、ルート、およびコンシューマー グループを使用してハブを構成します。 |
Terraform (AzAPI プロバイダー) リソース定義
アカウント リソースの種類は、次をターゲットとする操作でデプロイできます。
各 API バージョンで変更されたプロパティの一覧については、変更ログの
リソースの形式
Microsoft.DeviceUpdate/accounts リソースを作成するには、次の Terraform をテンプレートに追加します。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DeviceUpdate/accounts@2023-07-01"
name = "string"
parent_id = "string"
identity {
type = "string"
identity_ids = [
"string"
]
}
location = "string"
tags = {
{customized property} = "string"
}
body = {
properties = {
encryption = {
keyVaultKeyUri = "string"
userAssignedIdentity = "string"
}
privateEndpointConnections = [
{
properties = {
groupIds = [
"string"
]
privateEndpoint = {
}
privateLinkServiceConnectionState = {
actionsRequired = "string"
description = "string"
status = "string"
}
}
}
]
publicNetworkAccess = "string"
sku = "string"
}
}
}
プロパティ値
Microsoft.DeviceUpdate/アカウント
| 名前 | 形容 | 価値 |
|---|---|---|
| ID | リソースに使用される ID の種類。 | ManagedServiceIdentity の |
| 位置 | リソースが存在する地理的な場所 | string (必須) |
| 名前 | リソース名 | 糸 制約: 最小長 = 3 最大長 = 24 パターン = ^[A-Za-z0-9]+(-[A-Za-z0-9]+)*$ (必須) |
| parent_id | この拡張リソースを適用するリソースの ID。 | string (必須) |
| プロパティ | Device Update アカウントのプロパティ。 | アカウントプロパティ |
| タグ | リソース タグ | タグ名と値のディクショナリ。 |
| 型 | リソースの種類 | "Microsoft.DeviceUpdate/accounts@2023-07-01" (マイクロソフト デバイス更新プログラム/-07-01) |
アカウントプロパティ
| 名前 | 形容 | 価値 |
|---|---|---|
| 暗号化 | 保存時の CMK 暗号化プロパティ | 暗号化 |
| privateEndpointConnections(プライベートエンドポイント接続) | アカウントに関連付けられているプライベート エンドポイント接続の一覧。 | プライベートエンドポイント接続[] |
| publicNetworkAccess (パブリックネットワークアクセス) | アカウントに対してパブリック ネットワーク アクセスが許可されているかどうか。 | 「無効」 「有効」 |
| エスケーユー | デバイス更新 SKU | 「無料」 「スタンダード」 |
暗号化
| 名前 | 形容 | 価値 |
|---|---|---|
| keyVaultKeyUri | キー コンテナーの URI | 文字列 |
| ユーザー割り当てアイデンティティ | キー コンテナーへのアクセスに使用するユーザー割り当て ID の完全な resourceId。 ID もアカウントに割り当てる必要があります | 文字列 |
マネージドサービスアイデンティティ
| 名前 | 形容 | 価値 |
|---|---|---|
| 型 | マネージド サービス ID の種類 (SystemAssigned 型と UserAssigned 型の両方が許可されます)。 | 「なし」 'システム割り当て' 'システム割り当て済み、ユーザー割り当て済み' 'UserAssigned' (必須) |
| userAssignedIdentities (ユーザー割り当て済みアイデンティティ) | リソースに関連付けられているユーザー割り当て ID のセット。 userAssignedIdentities ディクショナリ キーは、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} という形式の ARM リソース ID になります。 ディクショナリ値は、要求内の空のオブジェクト ({}) にすることができます。 | UserAssignedIdentities の |
プライベートエンドポイント
| 名前 | 形容 | 価値 |
|---|
プライベートエンドポイント接続
| 名前 | 形容 | 価値 |
|---|---|---|
| プロパティ | リソースのプロパティ。 | PrivateEndpointConnectionProperties (必須) |
プライベートエンドポイント接続プロパティ
| 名前 | 形容 | 価値 |
|---|---|---|
| グループID | グループ ID の配列。 | 文字列[] |
| プライベートエンドポイント | プライベート エンドポイントのリソース。 | PrivateEndpoint を |
| privateLinkServiceConnectionState | サービス コンシューマーとプロバイダー間の接続の状態に関する情報のコレクション。 | PrivateLinkServiceConnectionState (必須) |
PrivateLinkServiceConnectionState (英語)
| 名前 | 形容 | 価値 |
|---|---|---|
| アクション必須 | サービス プロバイダーの変更にコンシューマーの更新が必要かどうかを示すメッセージ。 | 文字列 |
| 形容 | 接続の承認/拒否の理由。 | 文字列 |
| 状態 | 接続がサービスの所有者によって承認/拒否/削除されたかどうかを示します。 | 「承認済み」 「保留中」 「拒否されました」 |
追跡リソースタグ
| 名前 | 形容 | 価値 |
|---|
UserAssignedIdentities (ユーザー割り当てアイデンティティ)
| 名前 | 形容 | 価値 |
|---|
ユーザー割り当て識別子
| 名前 | 形容 | 価値 |
|---|
使用例
Terraformサンプル
IoT Hub デバイス更新アカウントのデプロイの基本的な例。
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" "account" {
type = "Microsoft.DeviceUpdate/accounts@2022-10-01"
parent_id = azapi_resource.resourceGroup.id
name = var.resource_name
location = var.location
body = {
properties = {
publicNetworkAccess = "Enabled"
sku = "Standard"
}
}
schema_validation_enabled = false
response_export_values = ["*"]
}