Microsoft.Devices IotHubs

• 最新の を する
• 2023-06-30
• 2023-06-30-プレビュー
• 2022-11-15-プレビュー
• 2022-04-30-プレビュー
• 2021-07-02
• 2021-07-02-プレビュー
• 2021-07-01
• 2021-07-01-プレビュー
• 2021-03-31
• 2021-03-03-プレビュー
• 2021-02-01-プレビュー
• 2020-08-31
• 2020-08-31-プレビュー
• 2020-08-01
• 2020-07-10プレビュー
• 2020-06-15
• 2020-04-01
• 2020-03-01
• 2019-11-04
• 2019-07-01-プレビュー
• 2019-03-22
• 2019-03-22-プレビュー
• 2018-12-01-プレビュー
• 2018-04-01
• 2018-01-22
• 2017-07-01
• 2017-01-19
• 2016-02-03

Bicep リソース定義

IotHubs リソースの種類は、次をターゲットとする操作と共にデプロイできます。

• リソース グループの - リソース グループのデプロイ コマンド 参照

各 API バージョンで変更されたプロパティの一覧については、変更ログの参照してください。

リソースの形式

Microsoft.Devices/IotHubs リソースを作成するには、次の Bicep をテンプレートに追加します。

resource symbolicname 'Microsoft.Devices/IotHubs@2023-06-30' = {
  etag: 'string'
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  location: 'string'
  name: 'string'
  properties: {
    allowedFqdnList: [
      'string'
    ]
    authorizationPolicies: [
      {
        keyName: 'string'
        primaryKey: 'string'
        rights: 'string'
        secondaryKey: 'string'
      }
    ]
    cloudToDevice: {
      defaultTtlAsIso8601: 'string'
      feedback: {
        lockDurationAsIso8601: 'string'
        maxDeliveryCount: int
        ttlAsIso8601: 'string'
      }
      maxDeliveryCount: int
    }
    comments: 'string'
    disableDeviceSAS: bool
    disableLocalAuth: bool
    disableModuleSAS: bool
    enableDataResidency: bool
    enableFileUploadNotifications: bool
    eventHubEndpoints: {
      {customized property}: {
        partitionCount: int
        retentionTimeInDays: int
      }
    }
    features: 'string'
    ipFilterRules: [
      {
        action: 'string'
        filterName: 'string'
        ipMask: 'string'
      }
    ]
    messagingEndpoints: {
      {customized property}: {
        lockDurationAsIso8601: 'string'
        maxDeliveryCount: int
        ttlAsIso8601: 'string'
      }
    }
    minTlsVersion: 'string'
    networkRuleSets: {
      applyToBuiltInEventHubEndpoint: bool
      defaultAction: 'string'
      ipRules: [
        {
          action: 'string'
          filterName: 'string'
          ipMask: 'string'
        }
      ]
    }
    privateEndpointConnections: [
      {
        properties: {
          privateEndpoint: {}
          privateLinkServiceConnectionState: {
            actionsRequired: 'string'
            description: 'string'
            status: 'string'
          }
        }
      }
    ]
    publicNetworkAccess: 'string'
    restrictOutboundNetworkAccess: bool
    routing: {
      endpoints: {
        cosmosDBSqlContainers: [
          {
            authenticationType: 'string'
            containerName: 'string'
            databaseName: 'string'
            endpointUri: 'string'
            identity: {
              userAssignedIdentity: 'string'
            }
            name: 'string'
            partitionKeyName: 'string'
            partitionKeyTemplate: 'string'
            primaryKey: 'string'
            resourceGroup: 'string'
            secondaryKey: 'string'
            subscriptionId: 'string'
          }
        ]
        eventHubs: [
          {
            authenticationType: 'string'
            connectionString: 'string'
            endpointUri: 'string'
            entityPath: 'string'
            id: 'string'
            identity: {
              userAssignedIdentity: 'string'
            }
            name: 'string'
            resourceGroup: 'string'
            subscriptionId: 'string'
          }
        ]
        serviceBusQueues: [
          {
            authenticationType: 'string'
            connectionString: 'string'
            endpointUri: 'string'
            entityPath: 'string'
            id: 'string'
            identity: {
              userAssignedIdentity: 'string'
            }
            name: 'string'
            resourceGroup: 'string'
            subscriptionId: 'string'
          }
        ]
        serviceBusTopics: [
          {
            authenticationType: 'string'
            connectionString: 'string'
            endpointUri: 'string'
            entityPath: 'string'
            id: 'string'
            identity: {
              userAssignedIdentity: 'string'
            }
            name: 'string'
            resourceGroup: 'string'
            subscriptionId: 'string'
          }
        ]
        storageContainers: [
          {
            authenticationType: 'string'
            batchFrequencyInSeconds: int
            connectionString: 'string'
            containerName: 'string'
            encoding: 'string'
            endpointUri: 'string'
            fileNameFormat: 'string'
            id: 'string'
            identity: {
              userAssignedIdentity: 'string'
            }
            maxChunkSizeInBytes: int
            name: 'string'
            resourceGroup: 'string'
            subscriptionId: 'string'
          }
        ]
      }
      enrichments: [
        {
          endpointNames: [
            'string'
          ]
          key: 'string'
          value: 'string'
        }
      ]
      fallbackRoute: {
        condition: 'string'
        endpointNames: [
          'string'
        ]
        isEnabled: bool
        name: 'string'
        source: 'string'
      }
      routes: [
        {
          condition: 'string'
          endpointNames: [
            'string'
          ]
          isEnabled: bool
          name: 'string'
          source: 'string'
        }
      ]
    }
    storageEndpoints: {
      {customized property}: {
        authenticationType: 'string'
        connectionString: 'string'
        containerName: 'string'
        identity: {
          userAssignedIdentity: 'string'
        }
        sasTtlAsIso8601: 'string'
      }
    }
  }
  sku: {
    capacity: int
    name: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

プロパティ値

Microsoft.Devices/IotHubs

名前	形容	価値
etag	Etag フィールドは 必要ありません。 応答本文で指定する場合は、通常の ETag 規則に従ってヘッダーとしても指定する必要があります。	糸
同一性	IotHub のマネージド ID。	armIdentity の
場所	リソースの場所。	string (必須)
名前	リソース名	string (必須)
プロパティ	IotHub プロパティ	IotHubProperties の
エスケーユー	IotHub SKU 情報	IotHubSkuInfo (必須)
タグ	リソース タグ	タグ名と値のディクショナリ。 テンプレート の タグを参照してください

アームアイデンティティ

名前	形容	価値
種類	リソースに使用される ID の種類。 型 'SystemAssigned, UserAssigned' には、暗黙的に作成された ID とユーザー割り当て ID のセットの両方が含まれます。 型 'None' は、サービスからすべての ID を削除します。	「なし」 'システム割り当て' 'SystemAssigned,UserAssigned' 'UserAssigned'
userAssignedIdentities (ユーザー割り当て済みアイデンティティ)	<ArmUserIdentity> の辞書	armIdentityUserAssignedIdentities の

ArmIdentityUserAssignedIdentities

名前	形容	価値

ArmUserIdentity (英語)

名前	形容	価値

CloudToDeviceProperties (CloudToDeviceプロパティ)

名前	形容	価値
デフォルトTtlAsIso8601	デバイス キュー内のクラウドからデバイスへのメッセージの既定の有効期間。 /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages を参照してください。	糸
フィードバック	クラウドからデバイスへのメッセージのフィードバック キューのプロパティ。	フィードバックプロパティ
マックスデリバリーカウント	デバイス キュー内のクラウドからデバイスへのメッセージの最大配信数。 /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages を参照してください。	int 制約： 最小値 = 1 最大値 = 100

エンリッチメントプロパティ

名前	形容	価値
エンドポイント名	エンリッチメントがメッセージに適用されるエンドポイントの一覧。	string[] (必須)
鍵	エンリッチメント プロパティのキーまたは名前。	string (必須)
価値	エンリッチメント プロパティの値。	string (必須)

EventHubプロパティ

名前	形容	価値
パーティション数	Event Hub と互換性のあるエンドポイントでデバイスからクラウドへのメッセージを受信するためのパーティションの数。 /azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages を参照してください。	整数 (int)
retentionTimeInDays (日数)	デバイスからクラウドへのメッセージのリテンション期間 (日数)。 参照先: /azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages	整数 (int)

フォールバックルートプロパティ

名前	形容	価値
条件	フォールバック ルートを適用するために評価される条件。 条件が指定されていない場合、既定では true と評価されます。 文法については、/azure/iot-hub/iot-hub-devguide-query-language を参照してください。	糸
エンドポイント名	条件を満たすメッセージのルーティング先となるエンドポイントの一覧。 現在、許可されているエンドポイントは 1 つだけです。	string[] (必須)
有効化されている	フォールバック ルートを有効にするかどうかを指定するために使用します。	bool (必須)
名前	ルートの名前。 名前には、英数字、ピリオド、アンダースコア、ハイフンのみを含めることができます。最大長は 64 文字で、一意である必要があります。	糸
源	ルーティング規則の適用先となるソース。 たとえば、DeviceMessages	'DeviceConnectionStateEvents' 'DeviceJobLifecycleEvents' 「DeviceLifecycleEvents」 「デバイスメッセージ」 「無効」 'TwinChangeEvents' (必須)

フィードバックプロパティ

名前	形容	価値
ロックデュレーションAsIso8601	フィードバック キューのロック期間。 /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages を参照してください。	糸
マックスデリバリーカウント	IoT ハブがフィードバック キューにメッセージを配信しようとした回数。 /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages を参照してください。	int 制約： 最小値 = 1 最大値 = 100
ttlAsISO8601の	メッセージが IoT ハブによって期限切れになるまでにメッセージを使用できる期間。 /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages を参照してください。	糸

IotHubプロパティ

名前	形容	価値
allowedFqdnリスト	IoT Hub からのエグレスで許可される FQDN (完全修飾ドメイン名) の一覧。	文字列[]
authorizationPolicies (認証ポリシー)	IoT ハブへの接続をセキュリティで保護するために使用できる共有アクセス ポリシー。	SharedAccessSignatureAuthorizationルール[]
cloudToDevice	IoT Hub のクラウドからデバイスへのメッセージング プロパティ。	CloudToDeviceProperties (CloudToDeviceプロパティ)
コメント	IoT Hub のコメント。	糸
disableDeviceSASの	true の場合、すべてのデバイス (Edge デバイスを含むがモジュールを除く) スコープ SAS キーは認証に使用できません。	ブール (bool)
disableLocalAuth	true の場合、IoT ハブ スコープの SAS キーを持つ SAS トークンは認証に使用できません。	ブール (bool)
disableModuleSASの	true の場合、すべてのモジュール スコープ SAS キーを認証に使用できません。	ブール (bool)
enableDataResidency	このプロパティを true に設定すると、データ所在地が有効になり、ディザスター リカバリーが無効になります。	ブール (bool)
enableFileUploadNotifications (英語)	True の場合、ファイルのアップロード通知が有効になります。	ブール (bool)
eventHubEndpoints	Event Hub と互換性のあるエンドポイントのプロパティ。 このディクショナリに使用できる唯一のキーはイベントです。 このキーは、IoT ハブの作成または更新呼び出しを行う際にディクショナリに存在する必要があります。	IotHubPropertiesEventHubEndpoints を する
顔立ち	IoT ハブで有効になっている機能。	「デバイスマネジメント」 「なし」
ipFilterRules	IP フィルター規則。	IpFilterルール[]
メッセージングエンドポイント	ファイル アップロード通知キューのメッセージング エンドポイントプロパティ。	IotHubPropertiesメッセージングエンドポイント
minTlsバージョン	このハブをサポートする TLS の最小バージョンを指定します。 1.2 より前の TLS バージョンを使用するクライアントを拒否するには、"1.2" に設定できます。	糸
ネットワークルールセット	IotHub のネットワーク ルール セットプロパティ	NetworkRuleSetProperties (ネットワークルールセットプロパティ)
privateEndpointConnections(プライベートエンドポイント接続)	この IotHub で作成されたプライベート エンドポイント接続	プライベートエンドポイント接続[]
publicNetworkAccess (パブリックネットワークアクセス)	パブリック ネットワークからの要求が許可されるかどうか	「無効」 「有効」
restrictOutboundNetworkAccess	true の場合、IotHub からのエグレスは、allowedFqdnList 経由で構成されている許可された FQDN のみに制限されます。	ブール (bool)
ルーティング	IoT ハブのルーティング関連のプロパティ。 参照: /azure/iot-hub/iot-hub-devguide-messaging	ルーティングプロパティ
ストレージエンドポイント	ファイルをアップロードできる Azure Storage エンドポイントの一覧。 現在、構成できる Azure Storage アカウントは 1 つだけであり、そのキーを$defaultにする必要があります。 複数のストレージ アカウントを指定すると、エラーがスローされます。 enableFileUploadNotifications プロパティが True に設定されている場合、このプロパティの値を指定しないと、エラーがスローされます。	IotHubPropertiesStorageエンドポイント

IotHubPropertiesEventHubエンドポイント

名前	形容	価値

IotHubPropertiesメッセージングエンドポイント

名前	形容	価値

IotHubPropertiesStorageエンドポイント

名前	形容	価値

IotHubSkuInfo (英語)

名前	形容	価値
能力	プロビジョニングされた IoT Hub ユニットの数。 /azure/azure-subscription-service-limits#iot-hub-limits を参照してください。	整数 (int)
名前	SKU の名前。	「B1」 「B2」 「B3」 「F1」 「S1」 「S2」 'S3' (必須)

IpFilterRule の略

名前	形容	価値
アクション	このルールによってキャプチャされた要求に対して必要なアクション。	「受け入れる」 'Reject' (必須)
フィルター名	IP フィルター規則の名前。	string (必須)
イップマスク	規則の IP アドレス範囲を CIDR 表記で含む文字列。	string (必須)

マネージド アイデンティティ

名前	形容	価値
ユーザー割り当てアイデンティティ	ユーザー割り当て ID。	糸

メッセージングエンドポイントプロパティ

名前	形容	価値
ロックデュレーションAsIso8601	ロック期間。 /azure/iot-hub/iot-hub-devguide-file-upload を参照してください。	糸
マックスデリバリーカウント	IoT ハブがメッセージの配信を試みる回数。 /azure/iot-hub/iot-hub-devguide-file-upload を参照してください。	int 制約： 最小値 = 1 最大値 = 100
ttlAsISO8601の	メッセージが IoT ハブによって期限切れになるまでにメッセージを使用できる期間。 /azure/iot-hub/iot-hub-devguide-file-upload を参照してください。	糸

NetworkRuleSetIpRule

名前	形容	価値
アクション	IP フィルター アクション	「許可する」
フィルター名	IP フィルター規則の名前。	string (必須)
イップマスク	規則の IP アドレス範囲を CIDR 表記で含む文字列。	string (必須)

NetworkRuleSetProperties (ネットワークルールセットプロパティ)

名前	形容	価値
applyToBuiltInEventHubエンドポイント	True の場合、ネットワーク ルール セットは IotHub の BuiltIn EventHub EndPoint にも適用されます	bool (必須)
デフォルトアクション	ネットワーク ルール セットの既定のアクション	「許可する」 「否定する」
ipルール	IP 規則の一覧	NetworkRuleSetIpRule[] (必須)

プライベートエンドポイント

名前	形容	価値

プライベートエンドポイント接続

名前	形容	価値
プロパティ	プライベート エンドポイント接続のプロパティ	PrivateEndpointConnectionProperties (必須)

プライベートエンドポイント接続プロパティ

名前	形容	価値
プライベートエンドポイント	プライベート エンドポイント接続のプライベート エンドポイント プロパティ	PrivateEndpoint を する
privateLinkServiceConnectionState	プライベート エンドポイント接続の現在の状態	PrivateLinkServiceConnectionState (必須)

PrivateLinkServiceConnectionState (英語)

名前	形容	価値
アクション必須	プライベート エンドポイント接続に必要なアクション	糸
形容	プライベート エンドポイント接続の現在の状態の説明	string (必須)
地位	プライベート エンドポイント接続の状態	「承認済み」 「切断」 「保留中」 'Rejected' (必須)

リソースタグ

名前	形容	価値

ルートプロパティ

名前	形容	価値
条件	ルーティング規則を適用するために評価される条件。 条件が指定されていない場合は、既定で true に評価されます。 文法については、/azure/iot-hub/iot-hub-devguide-query-language を参照してください。	糸
エンドポイント名	条件を満たすメッセージがルーティングされるエンドポイントの一覧。 現在、許可されているエンドポイントは 1 つだけです。	string[] (必須)
有効化されている	ルートを有効にするかどうかを指定するために使用します。	bool (必須)
名前	ルートの名前。 名前には、英数字、ピリオド、アンダースコア、ハイフンのみを含めることができます。最大長は 64 文字で、一意である必要があります。	糸 制約： パターン = ^[A-Za-z0-9-._]{1,64}$ (必須)
源	ルーティング規則を適用するソース (DeviceMessages など)。	'DeviceConnectionStateEvents' 'DeviceJobLifecycleEvents' 「DeviceLifecycleEvents」 「デバイスメッセージ」 「無効」 'TwinChangeEvents' (必須)

ルーティングCosmosDBSqlApiProperties

名前	形容	価値
認証タイプ	Cosmos DB SQL コンテナー エンドポイントに対する認証に使用されるメソッド	「アイデンティティベース」 'keyBased'
コンテナ名	Cosmos DB データベース内の Cosmos DB SQL コンテナーの名前。	string (必須)
データベース名	Cosmos DB アカウント内の Cosmos DB データベースの名前。	string (必須)
エンドポイントURI	Cosmos DB アカウントの URL。 プロトコル https:// を含める必要があります	string (必須)
同一性	Cosmos DB コンテナー エンドポイントのルーティングのマネージド ID プロパティ。	マネージド アイデンティティ
名前	このエンドポイントを識別する名前。 名前には英数字、ピリオド、アンダースコア、ハイフンのみを含めることができます。最大長は 64 文字です。 予約されている名前は、イベント、fileNotifications、$defaultです。 エンドポイント名は、エンドポイントの種類間で一意である必要があります。	糸 制約： パターン = ^[A-Za-z0-9-._]{1,64}$ (必須)
partitionKeyName (パーティションキー名)	この Cosmos DB SQL コンテナーに関連付けられているパーティション キーの名前 (存在する場合)。 これは省略可能なパラメーターです。	糸
partitionKeyTemplate (パーティションキーテンプレート)	この Cosmos DB SQL コンテナーで使用する合成パーティション キー値を生成するためのテンプレート。 テンプレートには、{iothub}、{deviceid}、{DD}、{MM}、{YYYY} のいずれかのプレースホルダーが少なくとも 1 つ含まれている必要があります。 1 つのプレースホルダーは最大で 1 回指定できますが、順序とプレースホルダー以外のコンポーネントは任意です。 このパラメーターは、PartitionKeyName が指定されている場合にのみ必要です。	糸
プライマリキー	Cosmos DB アカウントの主キー。	糸 制約： 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。
resourceGroup	Cosmos DB アカウントのリソース グループの名前。	糸
セカンダリキー	Cosmos DB アカウントのセカンダリ キー。	糸 制約： 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。
サブスクリプションID	Cosmos DB アカウントのサブスクリプション識別子。	糸

ルーティングエンドポイント

名前	形容	価値
cosmosDBSqlコンテナ	IoT Hub がルーティング規則に基づいてメッセージをルーティングする Cosmos DB コンテナー エンドポイントの一覧。	RoutingCosmosDBSqlApiプロパティ[]
イベントハブ	ルーティング規則に基づいて、IoT Hub がメッセージをルーティングする Event Hubs エンドポイントの一覧。 この一覧には、組み込みの Event Hubs エンドポイントは含まれません。	RoutingEventHubプロパティ[]
サービスバスキュー	ルーティング規則に基づいて、IoT ハブがメッセージをルーティングする Service Bus キュー エンドポイントの一覧。	ルーティングサービスバスキューエンドポイントプロパティ[]
サービスバストピック	ルーティング規則に基づいて、IoT ハブがメッセージをルーティングする Service Bus トピック エンドポイントの一覧。	RoutingServiceBusTopicEndpointProperties[]
貯蔵コンテナ用	ルーティング規則に基づいて、IoT Hub がメッセージをルーティングするストレージ コンテナー エンドポイントの一覧。	ルーティングストレージコンテナプロパティ[]

ルーティングEventHubProperties

名前	形容	価値
認証タイプ	イベント ハブ エンドポイントに対する認証に使用されるメソッド	「アイデンティティベース」 'keyBased'
コネクションストリング	イベント ハブ エンドポイントの接続文字列。	糸
エンドポイントURI	イベント ハブ エンドポイントの URL。 プロトコル sb:// を含める必要があります	糸
エンティティパス	イベント ハブ名前空間のイベント ハブ名	糸
身分証明書	イベント ハブ エンドポイントの ID	糸
同一性	ルーティング イベント ハブ エンドポイントのマネージド ID プロパティ。	マネージド アイデンティティ
名前	このエンドポイントを識別する名前。 名前には英数字、ピリオド、アンダースコア、ハイフンのみを含めることができます。最大長は 64 文字です。 予約されている名前は、イベント、fileNotifications、$defaultです。 エンドポイント名は、エンドポイントの種類間で一意である必要があります。	糸 制約： パターン = ^[A-Za-z0-9-._]{1,64}$ (必須)
resourceGroup	イベント ハブ エンドポイントのリソース グループの名前。	糸
サブスクリプションID	イベント ハブ エンドポイントのサブスクリプション識別子。	糸

ルーティングプロパティ

名前	形容	価値
エンドポイント	IoT ハブがルーティング規則に基づいてメッセージをルーティングするカスタム エンドポイントに関連するプロパティ。 有料ハブのすべての種類のすべてのエンドポイントで最大 10 個のカスタム エンドポイントが許可され、無料ハブのすべてのエンドポイントの種類で許可されるカスタム エンドポイントは 1 つだけです。	RoutingEndpoints の
エンリッチメント	組み込みエンドポイントとカスタム エンドポイントに配信されるメッセージに IoT ハブが適用するユーザー指定のエンリッチメントの一覧。 参照: https://aka.ms/telemetryoneventgrid	エンリッチメントプロパティ[]
フォールバックルート	"routes" セクションで指定された条件が満たされていない場合にフォールバック ルートとして使用されるルートのプロパティ。 これは省略可能なパラメーターです。 このプロパティがテンプレートに存在しない場合、フォールバック ルートは既定で無効になります。	FallbackRouteProperties の
ルート	IoT ハブが組み込みエンドポイントとカスタム エンドポイントにメッセージをルーティングするために使用するユーザー指定のルーティング規則の一覧。 有料ハブには最大 100 個のルーティング規則が許可され、無料ハブでは最大 5 つのルーティング規則が許可されます。	ルートプロパティ[]

ルーティングサービスバスキューエンドポイントプロパティ

名前	形容	価値
認証タイプ	Service Bus キュー エンドポイントに対する認証に使用されるメソッド	「アイデンティティベース」 'keyBased'
コネクションストリング	Service Bus キュー エンドポイントの接続文字列。	糸
エンドポイントURI	Service Bus キュー エンドポイントの URL。 プロトコル sb:// を含める必要があります	糸
エンティティパス	Service Bus 名前空間のキュー名	糸
身分証明書	Service Bus キュー エンドポイントの ID	糸
同一性	ルーティング サービス バス キュー エンドポイントのマネージド ID プロパティ。	マネージド アイデンティティ
名前	このエンドポイントを識別する名前。 名前には英数字、ピリオド、アンダースコア、ハイフンのみを含めることができます。最大長は 64 文字です。 予約されている名前は、イベント、fileNotifications、$defaultです。 エンドポイント名は、エンドポイントの種類間で一意である必要があります。 実際のキュー名と同じ名前である必要はありません。	糸 制約： パターン = ^[A-Za-z0-9-._]{1,64}$ (必須)
resourceGroup	Service Bus キュー エンドポイントのリソース グループの名前。	糸
サブスクリプションID	Service Bus キュー エンドポイントのサブスクリプション識別子。	糸

RoutingServiceBusTopicEndpointProperties (ルーティング サービスバス トピック エンドポイント プロパティ)

名前	形容	価値
認証タイプ	Service Bus トピック エンドポイントに対する認証に使用されるメソッド	「アイデンティティベース」 'keyBased'
コネクションストリング	Service Bus トピック エンドポイントの接続文字列。	糸
エンドポイントURI	Service Bus トピック エンドポイントの URL。 プロトコル sb:// を含める必要があります	糸
エンティティパス	Service Bus トピックのキュー名	糸
身分証明書	Service Bus トピック エンドポイントの ID	糸
同一性	ルーティング サービス バス トピック エンドポイントのマネージド ID プロパティ。	マネージド アイデンティティ
名前	このエンドポイントを識別する名前。 名前には英数字、ピリオド、アンダースコア、ハイフンのみを含めることができます。最大長は 64 文字です。 予約されている名前は、イベント、fileNotifications、$defaultです。 エンドポイント名は、エンドポイントの種類間で一意である必要があります。 名前は、実際のトピック名と同じである必要はありません。	糸 制約： パターン = ^[A-Za-z0-9-._]{1,64}$ (必須)
resourceGroup	Service Bus トピック エンドポイントのリソース グループの名前。	糸
サブスクリプションID	Service Bus トピック エンドポイントのサブスクリプション識別子。	糸

ルーティングストレージコンテナプロパティ

名前	形容	価値
認証タイプ	ストレージ エンドポイントに対する認証に使用されるメソッド	「アイデンティティベース」 'keyBased'
batchFrequencyInSeconds (バッチ周波数イン秒)	BLOB がストレージに書き込まれる時間間隔。 値は 60 ~ 720 秒にする必要があります。 既定値は 300 秒です。	int 制約： 最小値 = 60 最大値 = 720
コネクションストリング	ストレージ アカウントの接続文字列。	糸
コンテナ名	ストレージ アカウント内のストレージ コンテナーの名前。	string (必須)
エンコーディング	メッセージを BLOB にシリアル化するために使用されるエンコード。 サポートされる値は、'avro'、'avrodeflate'、および 'JSON' です。 既定値は 'avro' です。	「アブロ」 「アブロデフレート」 「JSON」
エンドポイントURI	ストレージ エンドポイントの URL。 プロトコル https:// を含める必要があります	糸
fileNameFormat(ファイル名フォーマット)	BLOB のファイル名の形式。 既定の形式は {iothub}/{partition}/{YYYY}/{MM}/{DD}/{HH}/{mm} です。 すべてのパラメーターは必須ですが、順序を変更できます。	糸
身分証明書	ストレージ コンテナー エンドポイントの ID	糸
同一性	ルーティング ストレージ エンドポイントのマネージド ID プロパティ。	マネージド アイデンティティ
maxChunkSizeInBytes	ストレージに書き込まれる各 BLOB の最大バイト数。 値は、10485760(10 MB) から 524288000(500 MB) の間である必要があります。 既定値は 314572800(300 MB) です。	int 制約： 最小値 = 10485760 最大値 = 524288000
名前	このエンドポイントを識別する名前。 名前には英数字、ピリオド、アンダースコア、ハイフンのみを含めることができます。最大長は 64 文字です。 予約されている名前は、イベント、fileNotifications、$defaultです。 エンドポイント名は、エンドポイントの種類間で一意である必要があります。	糸 制約： パターン = ^[A-Za-z0-9-._]{1,64}$ (必須)
resourceGroup	ストレージ アカウントのリソース グループの名前。	糸
サブスクリプションID	ストレージ アカウントのサブスクリプション識別子。	糸

SharedAccessSignatureAuthorizationRule

名前	形容	価値
キー名	共有アクセス ポリシーの名前。	string (必須)
プライマリキー	主キー。	糸
権利	共有アクセス ポリシーに割り当てられたアクセス許可。	「デバイスコネクト」 'レジストリ読み取り' 'レジストリ読み取り、デバイス接続' 'レジストリ読み取り、レジストリ書き込み' 'RegistryRead,RegistryWrite, DeviceConnect' 'RegistryRead,RegistryWrite, ServiceConnect' 'RegistryRead、RegistryWrite、ServiceConnect、DeviceConnect' 'レジストリ読み取り、サービスコネクト' 'RegistryRead、ServiceConnect、DeviceConnect' 'レジストリライト' 'レジストリライト、デバイスコネクト' 「レジストリライト、サービスコネクト」 'RegistryWrite、ServiceConnect、DeviceConnect' 「サービスコネクト」 'ServiceConnect, DeviceConnect' (必須)
セカンダリキー	セカンダリ キー。	糸

ストレージエンドポイントプロパティ

名前	形容	価値
認証タイプ	ストレージ アカウントへの接続に使用する認証の種類を指定します。	「アイデンティティベース」 'keyBased'
コネクションストリング	ファイルがアップロードされる Azure Storage アカウントの接続文字列。	string (必須)
コンテナ名	ファイルをアップロードするルート コンテナーの名前。 コンテナーは存在する必要はありませんが、指定された connectionString を使用して作成できる必要があります。	string (必須)
同一性	ファイルアップロード用のストレージ エンドポイントのマネージド ID プロパティ。	マネージド アイデンティティ
sasTtlAsIso8601	IoT Hub によって生成されたファイルアップロード用の SAS URI が有効な期間。 /azure/iot-hub/iot-hub-devguide-file-upload#file-upload-notification-configuration-options を参照してください。	糸

使用例

Azure クイック スタートのサンプル

次 Azure クイック スタート テンプレート、このリソースの種類をデプロイするための Bicep サンプルが含まれています。

Bicep ファイル	形容
IoT Hub と Device to Cloud Consumer Group を作成する	このテンプレートを使用すると、デバイスを含む IoT Hub インスタンスをクラウドにデプロイし、クラウドからデバイス メッセージング構成に、デバイスをクラウド コンシューマー グループにデプロイできます。
IoT Hub Device Provisioning Service を作成する	このテンプレートを使用すると、IoT ハブと IoT Hub Device Provisioning Service を作成し、2 つのサービスをリンクできます。
IoT Hub アカウント、インスタンス、IoT Hub の Device Update を作成する	このテンプレートは、アカウントと、インスタンスをリンクするインスタンスとハブを作成します。 必要なアクセス ポリシー、ルート、およびコンシューマー グループを使用してハブを構成します。
Azure IoT Hub を含む MedTech サービスをデプロイする	MedTech サービスは、複数のデバイスからデバイス データを取り込み、デバイス データを FHIR Observations に変換し、Azure Health Data Services FHIR サービスに保持するように設計された Azure Health Data Services の 1 つです。
ARM テンプレートを使用して IoT Hub を作成し、メッセージをルーティングして表示	このテンプレートを使用して、IoT Hub とストレージ アカウントをデプロイします。 ストレージにルーティングされたハブにメッセージを送信するアプリを実行し、結果を表示します。

ARM テンプレート リソース定義

IotHubs リソースの種類は、次をターゲットとする操作と共にデプロイできます。

• リソース グループの - リソース グループのデプロイ コマンド 参照

各 API バージョンで変更されたプロパティの一覧については、変更ログの参照してください。

リソースの形式

Microsoft.Devices/IotHubs リソースを作成するには、次の JSON をテンプレートに追加します。

{
  "type": "Microsoft.Devices/IotHubs",
  "apiVersion": "2023-06-30",
  "name": "string",
  "etag": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
      }
    }
  },
  "location": "string",
  "properties": {
    "allowedFqdnList": [ "string" ],
    "authorizationPolicies": [
      {
        "keyName": "string",
        "primaryKey": "string",
        "rights": "string",
        "secondaryKey": "string"
      }
    ],
    "cloudToDevice": {
      "defaultTtlAsIso8601": "string",
      "feedback": {
        "lockDurationAsIso8601": "string",
        "maxDeliveryCount": "int",
        "ttlAsIso8601": "string"
      },
      "maxDeliveryCount": "int"
    },
    "comments": "string",
    "disableDeviceSAS": "bool",
    "disableLocalAuth": "bool",
    "disableModuleSAS": "bool",
    "enableDataResidency": "bool",
    "enableFileUploadNotifications": "bool",
    "eventHubEndpoints": {
      "{customized property}": {
        "partitionCount": "int",
        "retentionTimeInDays": "int"
      }
    },
    "features": "string",
    "ipFilterRules": [
      {
        "action": "string",
        "filterName": "string",
        "ipMask": "string"
      }
    ],
    "messagingEndpoints": {
      "{customized property}": {
        "lockDurationAsIso8601": "string",
        "maxDeliveryCount": "int",
        "ttlAsIso8601": "string"
      }
    },
    "minTlsVersion": "string",
    "networkRuleSets": {
      "applyToBuiltInEventHubEndpoint": "bool",
      "defaultAction": "string",
      "ipRules": [
        {
          "action": "string",
          "filterName": "string",
          "ipMask": "string"
        }
      ]
    },
    "privateEndpointConnections": [
      {
        "properties": {
          "privateEndpoint": {
          },
          "privateLinkServiceConnectionState": {
            "actionsRequired": "string",
            "description": "string",
            "status": "string"
          }
        }
      }
    ],
    "publicNetworkAccess": "string",
    "restrictOutboundNetworkAccess": "bool",
    "routing": {
      "endpoints": {
        "cosmosDBSqlContainers": [
          {
            "authenticationType": "string",
            "containerName": "string",
            "databaseName": "string",
            "endpointUri": "string",
            "identity": {
              "userAssignedIdentity": "string"
            },
            "name": "string",
            "partitionKeyName": "string",
            "partitionKeyTemplate": "string",
            "primaryKey": "string",
            "resourceGroup": "string",
            "secondaryKey": "string",
            "subscriptionId": "string"
          }
        ],
        "eventHubs": [
          {
            "authenticationType": "string",
            "connectionString": "string",
            "endpointUri": "string",
            "entityPath": "string",
            "id": "string",
            "identity": {
              "userAssignedIdentity": "string"
            },
            "name": "string",
            "resourceGroup": "string",
            "subscriptionId": "string"
          }
        ],
        "serviceBusQueues": [
          {
            "authenticationType": "string",
            "connectionString": "string",
            "endpointUri": "string",
            "entityPath": "string",
            "id": "string",
            "identity": {
              "userAssignedIdentity": "string"
            },
            "name": "string",
            "resourceGroup": "string",
            "subscriptionId": "string"
          }
        ],
        "serviceBusTopics": [
          {
            "authenticationType": "string",
            "connectionString": "string",
            "endpointUri": "string",
            "entityPath": "string",
            "id": "string",
            "identity": {
              "userAssignedIdentity": "string"
            },
            "name": "string",
            "resourceGroup": "string",
            "subscriptionId": "string"
          }
        ],
        "storageContainers": [
          {
            "authenticationType": "string",
            "batchFrequencyInSeconds": "int",
            "connectionString": "string",
            "containerName": "string",
            "encoding": "string",
            "endpointUri": "string",
            "fileNameFormat": "string",
            "id": "string",
            "identity": {
              "userAssignedIdentity": "string"
            },
            "maxChunkSizeInBytes": "int",
            "name": "string",
            "resourceGroup": "string",
            "subscriptionId": "string"
          }
        ]
      },
      "enrichments": [
        {
          "endpointNames": [ "string" ],
          "key": "string",
          "value": "string"
        }
      ],
      "fallbackRoute": {
        "condition": "string",
        "endpointNames": [ "string" ],
        "isEnabled": "bool",
        "name": "string",
        "source": "string"
      },
      "routes": [
        {
          "condition": "string",
          "endpointNames": [ "string" ],
          "isEnabled": "bool",
          "name": "string",
          "source": "string"
        }
      ]
    },
    "storageEndpoints": {
      "{customized property}": {
        "authenticationType": "string",
        "connectionString": "string",
        "containerName": "string",
        "identity": {
          "userAssignedIdentity": "string"
        },
        "sasTtlAsIso8601": "string"
      }
    }
  },
  "sku": {
    "capacity": "int",
    "name": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

プロパティ値

Microsoft.Devices/IotHubs

名前	形容	価値
apiVersion (英語)	API のバージョン	'2023-06-30'
etag	Etag フィールドは 必要ありません。 応答本文で指定する場合は、通常の ETag 規則に従ってヘッダーとしても指定する必要があります。	糸
同一性	IotHub のマネージド ID。	armIdentity の
場所	リソースの場所。	string (必須)
名前	リソース名	string (必須)
プロパティ	IotHub プロパティ	IotHubProperties の
エスケーユー	IotHub SKU 情報	IotHubSkuInfo (必須)
タグ	リソース タグ	タグ名と値のディクショナリ。 テンプレート の タグを参照してください
種類	リソースの種類	'Microsoft.Devices/IotHubs'

アームアイデンティティ

名前	形容	価値
種類	リソースに使用される ID の種類。 型 'SystemAssigned, UserAssigned' には、暗黙的に作成された ID とユーザー割り当て ID のセットの両方が含まれます。 型 'None' は、サービスからすべての ID を削除します。	「なし」 'システム割り当て' 'SystemAssigned,UserAssigned' 'UserAssigned'
userAssignedIdentities (ユーザー割り当て済みアイデンティティ)	<ArmUserIdentity> の辞書	armIdentityUserAssignedIdentities の

ArmIdentityUserAssignedIdentities

名前	形容	価値

ArmUserIdentity (英語)

名前	形容	価値

CloudToDeviceProperties (CloudToDeviceプロパティ)

名前	形容	価値
デフォルトTtlAsIso8601	デバイス キュー内のクラウドからデバイスへのメッセージの既定の有効期間。 /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages を参照してください。	糸
フィードバック	クラウドからデバイスへのメッセージのフィードバック キューのプロパティ。	フィードバックプロパティ
マックスデリバリーカウント	デバイス キュー内のクラウドからデバイスへのメッセージの最大配信数。 /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages を参照してください。	int 制約： 最小値 = 1 最大値 = 100

エンリッチメントプロパティ

名前	形容	価値
エンドポイント名	エンリッチメントがメッセージに適用されるエンドポイントの一覧。	string[] (必須)
鍵	エンリッチメント プロパティのキーまたは名前。	string (必須)
価値	エンリッチメント プロパティの値。	string (必須)

EventHubプロパティ

名前	形容	価値
パーティション数	Event Hub と互換性のあるエンドポイントでデバイスからクラウドへのメッセージを受信するためのパーティションの数。 /azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages を参照してください。	整数 (int)
retentionTimeInDays (日数)	デバイスからクラウドへのメッセージのリテンション期間 (日数)。 参照先: /azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages	整数 (int)

フォールバックルートプロパティ

名前	形容	価値
条件	フォールバック ルートを適用するために評価される条件。 条件が指定されていない場合、既定では true と評価されます。 文法については、/azure/iot-hub/iot-hub-devguide-query-language を参照してください。	糸
エンドポイント名	条件を満たすメッセージのルーティング先となるエンドポイントの一覧。 現在、許可されているエンドポイントは 1 つだけです。	string[] (必須)
有効化されている	フォールバック ルートを有効にするかどうかを指定するために使用します。	bool (必須)
名前	ルートの名前。 名前には、英数字、ピリオド、アンダースコア、ハイフンのみを含めることができます。最大長は 64 文字で、一意である必要があります。	糸
源	ルーティング規則の適用先となるソース。 たとえば、DeviceMessages	'DeviceConnectionStateEvents' 'DeviceJobLifecycleEvents' 「DeviceLifecycleEvents」 「デバイスメッセージ」 「無効」 'TwinChangeEvents' (必須)

フィードバックプロパティ

名前	形容	価値
ロックデュレーションAsIso8601	フィードバック キューのロック期間。 /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages を参照してください。	糸
マックスデリバリーカウント	IoT ハブがフィードバック キューにメッセージを配信しようとした回数。 /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages を参照してください。	int 制約： 最小値 = 1 最大値 = 100
ttlAsISO8601の	メッセージが IoT ハブによって期限切れになるまでにメッセージを使用できる期間。 /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages を参照してください。	糸

IotHubプロパティ

名前	形容	価値
allowedFqdnリスト	IoT Hub からのエグレスで許可される FQDN (完全修飾ドメイン名) の一覧。	文字列[]
authorizationPolicies (認証ポリシー)	IoT ハブへの接続をセキュリティで保護するために使用できる共有アクセス ポリシー。	SharedAccessSignatureAuthorizationルール[]
cloudToDevice	IoT Hub のクラウドからデバイスへのメッセージング プロパティ。	CloudToDeviceProperties (CloudToDeviceプロパティ)
コメント	IoT Hub のコメント。	糸
disableDeviceSASの	true の場合、すべてのデバイス (Edge デバイスを含むがモジュールを除く) スコープ SAS キーは認証に使用できません。	ブール (bool)
disableLocalAuth	true の場合、IoT ハブ スコープの SAS キーを持つ SAS トークンは認証に使用できません。	ブール (bool)
disableModuleSASの	true の場合、すべてのモジュール スコープ SAS キーを認証に使用できません。	ブール (bool)
enableDataResidency	このプロパティを true に設定すると、データ所在地が有効になり、ディザスター リカバリーが無効になります。	ブール (bool)
enableFileUploadNotifications (英語)	True の場合、ファイルのアップロード通知が有効になります。	ブール (bool)
eventHubEndpoints	Event Hub と互換性のあるエンドポイントのプロパティ。 このディクショナリに使用できる唯一のキーはイベントです。 このキーは、IoT ハブの作成または更新呼び出しを行う際にディクショナリに存在する必要があります。	IotHubPropertiesEventHubEndpoints を する
顔立ち	IoT ハブで有効になっている機能。	「デバイスマネジメント」 「なし」
ipFilterRules	IP フィルター規則。	IpFilterルール[]
メッセージングエンドポイント	ファイル アップロード通知キューのメッセージング エンドポイントプロパティ。	IotHubPropertiesメッセージングエンドポイント
minTlsバージョン	このハブをサポートする TLS の最小バージョンを指定します。 1.2 より前の TLS バージョンを使用するクライアントを拒否するには、"1.2" に設定できます。	糸
ネットワークルールセット	IotHub のネットワーク ルール セットプロパティ	NetworkRuleSetProperties (ネットワークルールセットプロパティ)
privateEndpointConnections(プライベートエンドポイント接続)	この IotHub で作成されたプライベート エンドポイント接続	プライベートエンドポイント接続[]
publicNetworkAccess (パブリックネットワークアクセス)	パブリック ネットワークからの要求が許可されるかどうか	「無効」 「有効」
restrictOutboundNetworkAccess	true の場合、IotHub からのエグレスは、allowedFqdnList 経由で構成されている許可された FQDN のみに制限されます。	ブール (bool)
ルーティング	IoT ハブのルーティング関連のプロパティ。 参照: /azure/iot-hub/iot-hub-devguide-messaging	ルーティングプロパティ
ストレージエンドポイント	ファイルをアップロードできる Azure Storage エンドポイントの一覧。 現在、構成できる Azure Storage アカウントは 1 つだけであり、そのキーを$defaultにする必要があります。 複数のストレージ アカウントを指定すると、エラーがスローされます。 enableFileUploadNotifications プロパティが True に設定されている場合、このプロパティの値を指定しないと、エラーがスローされます。	IotHubPropertiesStorageエンドポイント

IotHubPropertiesEventHubエンドポイント

名前	形容	価値

IotHubPropertiesメッセージングエンドポイント

名前	形容	価値

IotHubPropertiesStorageエンドポイント

名前	形容	価値

IotHubSkuInfo (英語)

名前	形容	価値
能力	プロビジョニングされた IoT Hub ユニットの数。 /azure/azure-subscription-service-limits#iot-hub-limits を参照してください。	整数 (int)
名前	SKU の名前。	「B1」 「B2」 「B3」 「F1」 「S1」 「S2」 'S3' (必須)

IpFilterRule の略

名前	形容	価値
アクション	このルールによってキャプチャされた要求に対して必要なアクション。	「受け入れる」 'Reject' (必須)
フィルター名	IP フィルター規則の名前。	string (必須)
イップマスク	規則の IP アドレス範囲を CIDR 表記で含む文字列。	string (必須)

マネージド アイデンティティ

名前	形容	価値
ユーザー割り当てアイデンティティ	ユーザー割り当て ID。	糸

メッセージングエンドポイントプロパティ

名前	形容	価値
ロックデュレーションAsIso8601	ロック期間。 /azure/iot-hub/iot-hub-devguide-file-upload を参照してください。	糸
マックスデリバリーカウント	IoT ハブがメッセージの配信を試みる回数。 /azure/iot-hub/iot-hub-devguide-file-upload を参照してください。	int 制約： 最小値 = 1 最大値 = 100
ttlAsISO8601の	メッセージが IoT ハブによって期限切れになるまでにメッセージを使用できる期間。 /azure/iot-hub/iot-hub-devguide-file-upload を参照してください。	糸

NetworkRuleSetIpRule

名前	形容	価値
アクション	IP フィルター アクション	「許可する」
フィルター名	IP フィルター規則の名前。	string (必須)
イップマスク	規則の IP アドレス範囲を CIDR 表記で含む文字列。	string (必須)

NetworkRuleSetProperties (ネットワークルールセットプロパティ)

名前	形容	価値
applyToBuiltInEventHubエンドポイント	True の場合、ネットワーク ルール セットは IotHub の BuiltIn EventHub EndPoint にも適用されます	bool (必須)
デフォルトアクション	ネットワーク ルール セットの既定のアクション	「許可する」 「否定する」
ipルール	IP 規則の一覧	NetworkRuleSetIpRule[] (必須)

プライベートエンドポイント

名前	形容	価値

プライベートエンドポイント接続

名前	形容	価値
プロパティ	プライベート エンドポイント接続のプロパティ	PrivateEndpointConnectionProperties (必須)

プライベートエンドポイント接続プロパティ

名前	形容	価値
プライベートエンドポイント	プライベート エンドポイント接続のプライベート エンドポイント プロパティ	PrivateEndpoint を する
privateLinkServiceConnectionState	プライベート エンドポイント接続の現在の状態	PrivateLinkServiceConnectionState (必須)

PrivateLinkServiceConnectionState (英語)

名前	形容	価値
アクション必須	プライベート エンドポイント接続に必要なアクション	糸
形容	プライベート エンドポイント接続の現在の状態の説明	string (必須)
地位	プライベート エンドポイント接続の状態	「承認済み」 「切断」 「保留中」 'Rejected' (必須)

リソースタグ

名前	形容	価値

ルートプロパティ

名前	形容	価値
条件	ルーティング規則を適用するために評価される条件。 条件が指定されていない場合は、既定で true に評価されます。 文法については、/azure/iot-hub/iot-hub-devguide-query-language を参照してください。	糸
エンドポイント名	条件を満たすメッセージがルーティングされるエンドポイントの一覧。 現在、許可されているエンドポイントは 1 つだけです。	string[] (必須)
有効化されている	ルートを有効にするかどうかを指定するために使用します。	bool (必須)
名前	ルートの名前。 名前には、英数字、ピリオド、アンダースコア、ハイフンのみを含めることができます。最大長は 64 文字で、一意である必要があります。	糸 制約： パターン = ^[A-Za-z0-9-._]{1,64}$ (必須)
源	ルーティング規則を適用するソース (DeviceMessages など)。	'DeviceConnectionStateEvents' 'DeviceJobLifecycleEvents' 「DeviceLifecycleEvents」 「デバイスメッセージ」 「無効」 'TwinChangeEvents' (必須)

ルーティングCosmosDBSqlApiProperties

名前	形容	価値
認証タイプ	Cosmos DB SQL コンテナー エンドポイントに対する認証に使用されるメソッド	「アイデンティティベース」 'keyBased'
コンテナ名	Cosmos DB データベース内の Cosmos DB SQL コンテナーの名前。	string (必須)
データベース名	Cosmos DB アカウント内の Cosmos DB データベースの名前。	string (必須)
エンドポイントURI	Cosmos DB アカウントの URL。 プロトコル https:// を含める必要があります	string (必須)
同一性	Cosmos DB コンテナー エンドポイントのルーティングのマネージド ID プロパティ。	マネージド アイデンティティ
名前	このエンドポイントを識別する名前。 名前には英数字、ピリオド、アンダースコア、ハイフンのみを含めることができます。最大長は 64 文字です。 予約されている名前は、イベント、fileNotifications、$defaultです。 エンドポイント名は、エンドポイントの種類間で一意である必要があります。	糸 制約： パターン = ^[A-Za-z0-9-._]{1,64}$ (必須)
partitionKeyName (パーティションキー名)	この Cosmos DB SQL コンテナーに関連付けられているパーティション キーの名前 (存在する場合)。 これは省略可能なパラメーターです。	糸
partitionKeyTemplate (パーティションキーテンプレート)	この Cosmos DB SQL コンテナーで使用する合成パーティション キー値を生成するためのテンプレート。 テンプレートには、{iothub}、{deviceid}、{DD}、{MM}、{YYYY} のいずれかのプレースホルダーが少なくとも 1 つ含まれている必要があります。 1 つのプレースホルダーは最大で 1 回指定できますが、順序とプレースホルダー以外のコンポーネントは任意です。 このパラメーターは、PartitionKeyName が指定されている場合にのみ必要です。	糸
プライマリキー	Cosmos DB アカウントの主キー。	糸 制約： 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。
resourceGroup	Cosmos DB アカウントのリソース グループの名前。	糸
セカンダリキー	Cosmos DB アカウントのセカンダリ キー。	糸 制約： 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。
サブスクリプションID	Cosmos DB アカウントのサブスクリプション識別子。	糸

ルーティングエンドポイント

名前	形容	価値
cosmosDBSqlコンテナ	IoT Hub がルーティング規則に基づいてメッセージをルーティングする Cosmos DB コンテナー エンドポイントの一覧。	RoutingCosmosDBSqlApiプロパティ[]
イベントハブ	ルーティング規則に基づいて、IoT Hub がメッセージをルーティングする Event Hubs エンドポイントの一覧。 この一覧には、組み込みの Event Hubs エンドポイントは含まれません。	RoutingEventHubプロパティ[]
サービスバスキュー	ルーティング規則に基づいて、IoT ハブがメッセージをルーティングする Service Bus キュー エンドポイントの一覧。	ルーティングサービスバスキューエンドポイントプロパティ[]
サービスバストピック	ルーティング規則に基づいて、IoT ハブがメッセージをルーティングする Service Bus トピック エンドポイントの一覧。	RoutingServiceBusTopicEndpointProperties[]
貯蔵コンテナ用	ルーティング規則に基づいて、IoT Hub がメッセージをルーティングするストレージ コンテナー エンドポイントの一覧。	ルーティングストレージコンテナプロパティ[]

ルーティングEventHubProperties

名前	形容	価値
認証タイプ	イベント ハブ エンドポイントに対する認証に使用されるメソッド	「アイデンティティベース」 'keyBased'
コネクションストリング	イベント ハブ エンドポイントの接続文字列。	糸
エンドポイントURI	イベント ハブ エンドポイントの URL。 プロトコル sb:// を含める必要があります	糸
エンティティパス	イベント ハブ名前空間のイベント ハブ名	糸
身分証明書	イベント ハブ エンドポイントの ID	糸
同一性	ルーティング イベント ハブ エンドポイントのマネージド ID プロパティ。	マネージド アイデンティティ
名前	このエンドポイントを識別する名前。 名前には英数字、ピリオド、アンダースコア、ハイフンのみを含めることができます。最大長は 64 文字です。 予約されている名前は、イベント、fileNotifications、$defaultです。 エンドポイント名は、エンドポイントの種類間で一意である必要があります。	糸 制約： パターン = ^[A-Za-z0-9-._]{1,64}$ (必須)
resourceGroup	イベント ハブ エンドポイントのリソース グループの名前。	糸
サブスクリプションID	イベント ハブ エンドポイントのサブスクリプション識別子。	糸

ルーティングプロパティ

名前	形容	価値
エンドポイント	IoT ハブがルーティング規則に基づいてメッセージをルーティングするカスタム エンドポイントに関連するプロパティ。 有料ハブのすべての種類のすべてのエンドポイントで最大 10 個のカスタム エンドポイントが許可され、無料ハブのすべてのエンドポイントの種類で許可されるカスタム エンドポイントは 1 つだけです。	RoutingEndpoints の
エンリッチメント	組み込みエンドポイントとカスタム エンドポイントに配信されるメッセージに IoT ハブが適用するユーザー指定のエンリッチメントの一覧。 参照: https://aka.ms/telemetryoneventgrid	エンリッチメントプロパティ[]
フォールバックルート	"routes" セクションで指定された条件が満たされていない場合にフォールバック ルートとして使用されるルートのプロパティ。 これは省略可能なパラメーターです。 このプロパティがテンプレートに存在しない場合、フォールバック ルートは既定で無効になります。	FallbackRouteProperties の
ルート	IoT ハブが組み込みエンドポイントとカスタム エンドポイントにメッセージをルーティングするために使用するユーザー指定のルーティング規則の一覧。 有料ハブには最大 100 個のルーティング規則が許可され、無料ハブでは最大 5 つのルーティング規則が許可されます。	ルートプロパティ[]

ルーティングサービスバスキューエンドポイントプロパティ

名前	形容	価値
認証タイプ	Service Bus キュー エンドポイントに対する認証に使用されるメソッド	「アイデンティティベース」 'keyBased'
コネクションストリング	Service Bus キュー エンドポイントの接続文字列。	糸
エンドポイントURI	Service Bus キュー エンドポイントの URL。 プロトコル sb:// を含める必要があります	糸
エンティティパス	Service Bus 名前空間のキュー名	糸
身分証明書	Service Bus キュー エンドポイントの ID	糸
同一性	ルーティング サービス バス キュー エンドポイントのマネージド ID プロパティ。	マネージド アイデンティティ
名前	このエンドポイントを識別する名前。 名前には英数字、ピリオド、アンダースコア、ハイフンのみを含めることができます。最大長は 64 文字です。 予約されている名前は、イベント、fileNotifications、$defaultです。 エンドポイント名は、エンドポイントの種類間で一意である必要があります。 実際のキュー名と同じ名前である必要はありません。	糸 制約： パターン = ^[A-Za-z0-9-._]{1,64}$ (必須)
resourceGroup	Service Bus キュー エンドポイントのリソース グループの名前。	糸
サブスクリプションID	Service Bus キュー エンドポイントのサブスクリプション識別子。	糸

RoutingServiceBusTopicEndpointProperties (ルーティング サービスバス トピック エンドポイント プロパティ)

名前	形容	価値
認証タイプ	Service Bus トピック エンドポイントに対する認証に使用されるメソッド	「アイデンティティベース」 'keyBased'
コネクションストリング	Service Bus トピック エンドポイントの接続文字列。	糸
エンドポイントURI	Service Bus トピック エンドポイントの URL。 プロトコル sb:// を含める必要があります	糸
エンティティパス	Service Bus トピックのキュー名	糸
身分証明書	Service Bus トピック エンドポイントの ID	糸
同一性	ルーティング サービス バス トピック エンドポイントのマネージド ID プロパティ。	マネージド アイデンティティ
名前	このエンドポイントを識別する名前。 名前には英数字、ピリオド、アンダースコア、ハイフンのみを含めることができます。最大長は 64 文字です。 予約されている名前は、イベント、fileNotifications、$defaultです。 エンドポイント名は、エンドポイントの種類間で一意である必要があります。 名前は、実際のトピック名と同じである必要はありません。	糸 制約： パターン = ^[A-Za-z0-9-._]{1,64}$ (必須)
resourceGroup	Service Bus トピック エンドポイントのリソース グループの名前。	糸
サブスクリプションID	Service Bus トピック エンドポイントのサブスクリプション識別子。	糸

ルーティングストレージコンテナプロパティ

名前	形容	価値
認証タイプ	ストレージ エンドポイントに対する認証に使用されるメソッド	「アイデンティティベース」 'keyBased'
batchFrequencyInSeconds (バッチ周波数イン秒)	BLOB がストレージに書き込まれる時間間隔。 値は 60 ~ 720 秒にする必要があります。 既定値は 300 秒です。	int 制約： 最小値 = 60 最大値 = 720
コネクションストリング	ストレージ アカウントの接続文字列。	糸
コンテナ名	ストレージ アカウント内のストレージ コンテナーの名前。	string (必須)
エンコーディング	メッセージを BLOB にシリアル化するために使用されるエンコード。 サポートされる値は、'avro'、'avrodeflate'、および 'JSON' です。 既定値は 'avro' です。	「アブロ」 「アブロデフレート」 「JSON」
エンドポイントURI	ストレージ エンドポイントの URL。 プロトコル https:// を含める必要があります	糸
fileNameFormat(ファイル名フォーマット)	BLOB のファイル名の形式。 既定の形式は {iothub}/{partition}/{YYYY}/{MM}/{DD}/{HH}/{mm} です。 すべてのパラメーターは必須ですが、順序を変更できます。	糸
身分証明書	ストレージ コンテナー エンドポイントの ID	糸
同一性	ルーティング ストレージ エンドポイントのマネージド ID プロパティ。	マネージド アイデンティティ
maxChunkSizeInBytes	ストレージに書き込まれる各 BLOB の最大バイト数。 値は、10485760(10 MB) から 524288000(500 MB) の間である必要があります。 既定値は 314572800(300 MB) です。	int 制約： 最小値 = 10485760 最大値 = 524288000
名前	このエンドポイントを識別する名前。 名前には英数字、ピリオド、アンダースコア、ハイフンのみを含めることができます。最大長は 64 文字です。 予約されている名前は、イベント、fileNotifications、$defaultです。 エンドポイント名は、エンドポイントの種類間で一意である必要があります。	糸 制約： パターン = ^[A-Za-z0-9-._]{1,64}$ (必須)
resourceGroup	ストレージ アカウントのリソース グループの名前。	糸
サブスクリプションID	ストレージ アカウントのサブスクリプション識別子。	糸

SharedAccessSignatureAuthorizationRule

名前	形容	価値
キー名	共有アクセス ポリシーの名前。	string (必須)
プライマリキー	主キー。	糸
権利	共有アクセス ポリシーに割り当てられたアクセス許可。	「デバイスコネクト」 'レジストリ読み取り' 'レジストリ読み取り、デバイス接続' 'レジストリ読み取り、レジストリ書き込み' 'RegistryRead,RegistryWrite, DeviceConnect' 'RegistryRead,RegistryWrite, ServiceConnect' 'RegistryRead、RegistryWrite、ServiceConnect、DeviceConnect' 'レジストリ読み取り、サービスコネクト' 'RegistryRead、ServiceConnect、DeviceConnect' 'レジストリライト' 'レジストリライト、デバイスコネクト' 「レジストリライト、サービスコネクト」 'RegistryWrite、ServiceConnect、DeviceConnect' 「サービスコネクト」 'ServiceConnect, DeviceConnect' (必須)
セカンダリキー	セカンダリ キー。	糸

ストレージエンドポイントプロパティ

名前	形容	価値
認証タイプ	ストレージ アカウントへの接続に使用する認証の種類を指定します。	「アイデンティティベース」 'keyBased'
コネクションストリング	ファイルがアップロードされる Azure Storage アカウントの接続文字列。	string (必須)
コンテナ名	ファイルをアップロードするルート コンテナーの名前。 コンテナーは存在する必要はありませんが、指定された connectionString を使用して作成できる必要があります。	string (必須)
同一性	ファイルアップロード用のストレージ エンドポイントのマネージド ID プロパティ。	マネージド アイデンティティ
sasTtlAsIso8601	IoT Hub によって生成されたファイルアップロード用の SAS URI が有効な期間。 /azure/iot-hub/iot-hub-devguide-file-upload#file-upload-notification-configuration-options を参照してください。	糸

使用例

Azure のクイック スタート テンプレート

このリソースの種類 デプロイする Azure クイック スタート テンプレート 次に示します。

テンプレート	形容
IoT Hub を使用して従量課金制 (PAYG) 環境を作成する Azure にデプロイする	このテンプレートを使用すると、IoT Hub からのイベントを使用するように構成された従量課金制 (PAYG) Time Series Insights 環境をデプロイできます。
IoT Hub と Device to Cloud Consumer Group を作成する Azure にデプロイする	このテンプレートを使用すると、デバイスを含む IoT Hub インスタンスをクラウドにデプロイし、クラウドからデバイス メッセージング構成に、デバイスをクラウド コンシューマー グループにデプロイできます。
IoT Hub と Ubuntu エッジ シミュレーター を作成する Azure にデプロイする	このテンプレートでは、IOT ハブと仮想マシン Ubuntu エッジ シミュレーターが作成されます。
IoT Hub Device Provisioning Service を作成する Azure にデプロイする	このテンプレートを使用すると、IoT ハブと IoT Hub Device Provisioning Service を作成し、2 つのサービスをリンクできます。
IoT Hub アカウント、インスタンス、IoT Hub の Device Update を作成する Azure にデプロイする	このテンプレートは、アカウントと、インスタンスをリンクするインスタンスとハブを作成します。 必要なアクセス ポリシー、ルート、およびコンシューマー グループを使用してハブを構成します。
Azure IoT Hub を含む MedTech サービスをデプロイする Azure にデプロイする	MedTech サービスは、複数のデバイスからデバイス データを取り込み、デバイス データを FHIR Observations に変換し、Azure Health Data Services FHIR サービスに保持するように設計された Azure Health Data Services の 1 つです。
ARM テンプレートを使用して IoT Hub を作成し、メッセージをルーティングして表示 Azure にデプロイする	このテンプレートを使用して、IoT Hub とストレージ アカウントをデプロイします。 ストレージにルーティングされたハブにメッセージを送信するアプリを実行し、結果を表示します。

Terraform (AzAPI プロバイダー) リソース定義

IotHubs リソースの種類は、次をターゲットとする操作と共にデプロイできます。

• リソース グループの

各 API バージョンで変更されたプロパティの一覧については、変更ログの参照してください。

リソースの形式

Microsoft.Devices/IotHubs リソースを作成するには、次の Terraform をテンプレートに追加します。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Devices/IotHubs@2023-06-30"
  name = "string"
  parent_id = "string"
  identity {
    type = "string"
    identity_ids = [
      "string"
    ]
  }
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    etag = "string"
    properties = {
      allowedFqdnList = [
        "string"
      ]
      authorizationPolicies = [
        {
          keyName = "string"
          primaryKey = "string"
          rights = "string"
          secondaryKey = "string"
        }
      ]
      cloudToDevice = {
        defaultTtlAsIso8601 = "string"
        feedback = {
          lockDurationAsIso8601 = "string"
          maxDeliveryCount = int
          ttlAsIso8601 = "string"
        }
        maxDeliveryCount = int
      }
      comments = "string"
      disableDeviceSAS = bool
      disableLocalAuth = bool
      disableModuleSAS = bool
      enableDataResidency = bool
      enableFileUploadNotifications = bool
      eventHubEndpoints = {
        {customized property} = {
          partitionCount = int
          retentionTimeInDays = int
        }
      }
      features = "string"
      ipFilterRules = [
        {
          action = "string"
          filterName = "string"
          ipMask = "string"
        }
      ]
      messagingEndpoints = {
        {customized property} = {
          lockDurationAsIso8601 = "string"
          maxDeliveryCount = int
          ttlAsIso8601 = "string"
        }
      }
      minTlsVersion = "string"
      networkRuleSets = {
        applyToBuiltInEventHubEndpoint = bool
        defaultAction = "string"
        ipRules = [
          {
            action = "string"
            filterName = "string"
            ipMask = "string"
          }
        ]
      }
      privateEndpointConnections = [
        {
          properties = {
            privateEndpoint = {
            }
            privateLinkServiceConnectionState = {
              actionsRequired = "string"
              description = "string"
              status = "string"
            }
          }
        }
      ]
      publicNetworkAccess = "string"
      restrictOutboundNetworkAccess = bool
      routing = {
        endpoints = {
          cosmosDBSqlContainers = [
            {
              authenticationType = "string"
              containerName = "string"
              databaseName = "string"
              endpointUri = "string"
              identity = {
                userAssignedIdentity = "string"
              }
              name = "string"
              partitionKeyName = "string"
              partitionKeyTemplate = "string"
              primaryKey = "string"
              resourceGroup = "string"
              secondaryKey = "string"
              subscriptionId = "string"
            }
          ]
          eventHubs = [
            {
              authenticationType = "string"
              connectionString = "string"
              endpointUri = "string"
              entityPath = "string"
              id = "string"
              identity = {
                userAssignedIdentity = "string"
              }
              name = "string"
              resourceGroup = "string"
              subscriptionId = "string"
            }
          ]
          serviceBusQueues = [
            {
              authenticationType = "string"
              connectionString = "string"
              endpointUri = "string"
              entityPath = "string"
              id = "string"
              identity = {
                userAssignedIdentity = "string"
              }
              name = "string"
              resourceGroup = "string"
              subscriptionId = "string"
            }
          ]
          serviceBusTopics = [
            {
              authenticationType = "string"
              connectionString = "string"
              endpointUri = "string"
              entityPath = "string"
              id = "string"
              identity = {
                userAssignedIdentity = "string"
              }
              name = "string"
              resourceGroup = "string"
              subscriptionId = "string"
            }
          ]
          storageContainers = [
            {
              authenticationType = "string"
              batchFrequencyInSeconds = int
              connectionString = "string"
              containerName = "string"
              encoding = "string"
              endpointUri = "string"
              fileNameFormat = "string"
              id = "string"
              identity = {
                userAssignedIdentity = "string"
              }
              maxChunkSizeInBytes = int
              name = "string"
              resourceGroup = "string"
              subscriptionId = "string"
            }
          ]
        }
        enrichments = [
          {
            endpointNames = [
              "string"
            ]
            key = "string"
            value = "string"
          }
        ]
        fallbackRoute = {
          condition = "string"
          endpointNames = [
            "string"
          ]
          isEnabled = bool
          name = "string"
          source = "string"
        }
        routes = [
          {
            condition = "string"
            endpointNames = [
              "string"
            ]
            isEnabled = bool
            name = "string"
            source = "string"
          }
        ]
      }
      storageEndpoints = {
        {customized property} = {
          authenticationType = "string"
          connectionString = "string"
          containerName = "string"
          identity = {
            userAssignedIdentity = "string"
          }
          sasTtlAsIso8601 = "string"
        }
      }
    }
    sku = {
      capacity = int
      name = "string"
    }
  }
}

プロパティ値

Microsoft.Devices/IotHubs

名前	形容	価値
etag	Etag フィールドは 必要ありません。 応答本文で指定する場合は、通常の ETag 規則に従ってヘッダーとしても指定する必要があります。	糸
同一性	IotHub のマネージド ID。	armIdentity の
場所	リソースの場所。	string (必須)
名前	リソース名	string (必須)
プロパティ	IotHub プロパティ	IotHubProperties の
エスケーユー	IotHub SKU 情報	IotHubSkuInfo (必須)
タグ	リソース タグ	タグ名と値のディクショナリ。
種類	リソースの種類	「Microsoft.Devices/IotHubs@2023-06-30」

アームアイデンティティ

名前	形容	価値
種類	リソースに使用される ID の種類。 型 'SystemAssigned, UserAssigned' には、暗黙的に作成された ID とユーザー割り当て ID のセットの両方が含まれます。 型 'None' は、サービスからすべての ID を削除します。	「なし」 'システム割り当て' 'SystemAssigned,UserAssigned' 'UserAssigned'
userAssignedIdentities (ユーザー割り当て済みアイデンティティ)	<ArmUserIdentity> の辞書	armIdentityUserAssignedIdentities の

ArmIdentityUserAssignedIdentities

名前	形容	価値

ArmUserIdentity (英語)

名前	形容	価値

CloudToDeviceProperties (CloudToDeviceプロパティ)

名前	形容	価値
デフォルトTtlAsIso8601	デバイス キュー内のクラウドからデバイスへのメッセージの既定の有効期間。 /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages を参照してください。	糸
フィードバック	クラウドからデバイスへのメッセージのフィードバック キューのプロパティ。	フィードバックプロパティ
マックスデリバリーカウント	デバイス キュー内のクラウドからデバイスへのメッセージの最大配信数。 /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages を参照してください。	int 制約： 最小値 = 1 最大値 = 100

エンリッチメントプロパティ

名前	形容	価値
エンドポイント名	エンリッチメントがメッセージに適用されるエンドポイントの一覧。	string[] (必須)
鍵	エンリッチメント プロパティのキーまたは名前。	string (必須)
価値	エンリッチメント プロパティの値。	string (必須)

EventHubプロパティ

名前	形容	価値
パーティション数	Event Hub と互換性のあるエンドポイントでデバイスからクラウドへのメッセージを受信するためのパーティションの数。 /azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages を参照してください。	整数 (int)
retentionTimeInDays (日数)	デバイスからクラウドへのメッセージのリテンション期間 (日数)。 参照先: /azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages	整数 (int)

フォールバックルートプロパティ

名前	形容	価値
条件	フォールバック ルートを適用するために評価される条件。 条件が指定されていない場合、既定では true と評価されます。 文法については、/azure/iot-hub/iot-hub-devguide-query-language を参照してください。	糸
エンドポイント名	条件を満たすメッセージのルーティング先となるエンドポイントの一覧。 現在、許可されているエンドポイントは 1 つだけです。	string[] (必須)
有効化されている	フォールバック ルートを有効にするかどうかを指定するために使用します。	bool (必須)
名前	ルートの名前。 名前には、英数字、ピリオド、アンダースコア、ハイフンのみを含めることができます。最大長は 64 文字で、一意である必要があります。	糸
源	ルーティング規則の適用先となるソース。 たとえば、DeviceMessages	'DeviceConnectionStateEvents' 'DeviceJobLifecycleEvents' 「DeviceLifecycleEvents」 「デバイスメッセージ」 「無効」 'TwinChangeEvents' (必須)

フィードバックプロパティ

名前	形容	価値
ロックデュレーションAsIso8601	フィードバック キューのロック期間。 /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages を参照してください。	糸
マックスデリバリーカウント	IoT ハブがフィードバック キューにメッセージを配信しようとした回数。 /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages を参照してください。	int 制約： 最小値 = 1 最大値 = 100
ttlAsISO8601の	メッセージが IoT ハブによって期限切れになるまでにメッセージを使用できる期間。 /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages を参照してください。	糸

IotHubプロパティ

名前	形容	価値
allowedFqdnリスト	IoT Hub からのエグレスで許可される FQDN (完全修飾ドメイン名) の一覧。	文字列[]
authorizationPolicies (認証ポリシー)	IoT ハブへの接続をセキュリティで保護するために使用できる共有アクセス ポリシー。	SharedAccessSignatureAuthorizationルール[]
cloudToDevice	IoT Hub のクラウドからデバイスへのメッセージング プロパティ。	CloudToDeviceProperties (CloudToDeviceプロパティ)
コメント	IoT Hub のコメント。	糸
disableDeviceSASの	true の場合、すべてのデバイス (Edge デバイスを含むがモジュールを除く) スコープ SAS キーは認証に使用できません。	ブール (bool)
disableLocalAuth	true の場合、IoT ハブ スコープの SAS キーを持つ SAS トークンは認証に使用できません。	ブール (bool)
disableModuleSASの	true の場合、すべてのモジュール スコープ SAS キーを認証に使用できません。	ブール (bool)
enableDataResidency	このプロパティを true に設定すると、データ所在地が有効になり、ディザスター リカバリーが無効になります。	ブール (bool)
enableFileUploadNotifications (英語)	True の場合、ファイルのアップロード通知が有効になります。	ブール (bool)
eventHubEndpoints	Event Hub と互換性のあるエンドポイントのプロパティ。 このディクショナリに使用できる唯一のキーはイベントです。 このキーは、IoT ハブの作成または更新呼び出しを行う際にディクショナリに存在する必要があります。	IotHubPropertiesEventHubEndpoints を する
顔立ち	IoT ハブで有効になっている機能。	「デバイスマネジメント」 「なし」
ipFilterRules	IP フィルター規則。	IpFilterルール[]
メッセージングエンドポイント	ファイル アップロード通知キューのメッセージング エンドポイントプロパティ。	IotHubPropertiesメッセージングエンドポイント
minTlsバージョン	このハブをサポートする TLS の最小バージョンを指定します。 1.2 より前の TLS バージョンを使用するクライアントを拒否するには、"1.2" に設定できます。	糸
ネットワークルールセット	IotHub のネットワーク ルール セットプロパティ	NetworkRuleSetProperties (ネットワークルールセットプロパティ)
privateEndpointConnections(プライベートエンドポイント接続)	この IotHub で作成されたプライベート エンドポイント接続	プライベートエンドポイント接続[]
publicNetworkAccess (パブリックネットワークアクセス)	パブリック ネットワークからの要求が許可されるかどうか	「無効」 「有効」
restrictOutboundNetworkAccess	true の場合、IotHub からのエグレスは、allowedFqdnList 経由で構成されている許可された FQDN のみに制限されます。	ブール (bool)
ルーティング	IoT ハブのルーティング関連のプロパティ。 参照: /azure/iot-hub/iot-hub-devguide-messaging	ルーティングプロパティ
ストレージエンドポイント	ファイルをアップロードできる Azure Storage エンドポイントの一覧。 現在、構成できる Azure Storage アカウントは 1 つだけであり、そのキーを$defaultにする必要があります。 複数のストレージ アカウントを指定すると、エラーがスローされます。 enableFileUploadNotifications プロパティが True に設定されている場合、このプロパティの値を指定しないと、エラーがスローされます。	IotHubPropertiesStorageエンドポイント

IotHubPropertiesEventHubエンドポイント

名前	形容	価値

IotHubPropertiesメッセージングエンドポイント

名前	形容	価値

IotHubPropertiesStorageエンドポイント

名前	形容	価値

IotHubSkuInfo (英語)

名前	形容	価値
能力	プロビジョニングされた IoT Hub ユニットの数。 /azure/azure-subscription-service-limits#iot-hub-limits を参照してください。	整数 (int)
名前	SKU の名前。	「B1」 「B2」 「B3」 「F1」 「S1」 「S2」 'S3' (必須)

IpFilterRule の略

名前	形容	価値
アクション	このルールによってキャプチャされた要求に対して必要なアクション。	「受け入れる」 'Reject' (必須)
フィルター名	IP フィルター規則の名前。	string (必須)
イップマスク	規則の IP アドレス範囲を CIDR 表記で含む文字列。	string (必須)

マネージド アイデンティティ

名前	形容	価値
ユーザー割り当てアイデンティティ	ユーザー割り当て ID。	糸

メッセージングエンドポイントプロパティ

名前	形容	価値
ロックデュレーションAsIso8601	ロック期間。 /azure/iot-hub/iot-hub-devguide-file-upload を参照してください。	糸
マックスデリバリーカウント	IoT ハブがメッセージの配信を試みる回数。 /azure/iot-hub/iot-hub-devguide-file-upload を参照してください。	int 制約： 最小値 = 1 最大値 = 100
ttlAsISO8601の	メッセージが IoT ハブによって期限切れになるまでにメッセージを使用できる期間。 /azure/iot-hub/iot-hub-devguide-file-upload を参照してください。	糸

NetworkRuleSetIpRule

名前	形容	価値
アクション	IP フィルター アクション	「許可する」
フィルター名	IP フィルター規則の名前。	string (必須)
イップマスク	規則の IP アドレス範囲を CIDR 表記で含む文字列。	string (必須)

NetworkRuleSetProperties (ネットワークルールセットプロパティ)

名前	形容	価値
applyToBuiltInEventHubエンドポイント	True の場合、ネットワーク ルール セットは IotHub の BuiltIn EventHub EndPoint にも適用されます	bool (必須)
デフォルトアクション	ネットワーク ルール セットの既定のアクション	「許可する」 「否定する」
ipルール	IP 規則の一覧	NetworkRuleSetIpRule[] (必須)

プライベートエンドポイント

名前	形容	価値

プライベートエンドポイント接続

名前	形容	価値
プロパティ	プライベート エンドポイント接続のプロパティ	PrivateEndpointConnectionProperties (必須)

プライベートエンドポイント接続プロパティ

名前	形容	価値
プライベートエンドポイント	プライベート エンドポイント接続のプライベート エンドポイント プロパティ	PrivateEndpoint を する
privateLinkServiceConnectionState	プライベート エンドポイント接続の現在の状態	PrivateLinkServiceConnectionState (必須)

PrivateLinkServiceConnectionState (英語)

名前	形容	価値
アクション必須	プライベート エンドポイント接続に必要なアクション	糸
形容	プライベート エンドポイント接続の現在の状態の説明	string (必須)
地位	プライベート エンドポイント接続の状態	「承認済み」 「切断」 「保留中」 'Rejected' (必須)

リソースタグ

名前	形容	価値

ルートプロパティ

名前	形容	価値
条件	ルーティング規則を適用するために評価される条件。 条件が指定されていない場合は、既定で true に評価されます。 文法については、/azure/iot-hub/iot-hub-devguide-query-language を参照してください。	糸
エンドポイント名	条件を満たすメッセージがルーティングされるエンドポイントの一覧。 現在、許可されているエンドポイントは 1 つだけです。	string[] (必須)
有効化されている	ルートを有効にするかどうかを指定するために使用します。	bool (必須)
名前	ルートの名前。 名前には、英数字、ピリオド、アンダースコア、ハイフンのみを含めることができます。最大長は 64 文字で、一意である必要があります。	糸 制約： パターン = ^[A-Za-z0-9-._]{1,64}$ (必須)
源	ルーティング規則を適用するソース (DeviceMessages など)。	'DeviceConnectionStateEvents' 'DeviceJobLifecycleEvents' 「DeviceLifecycleEvents」 「デバイスメッセージ」 「無効」 'TwinChangeEvents' (必須)

ルーティングCosmosDBSqlApiProperties

名前	形容	価値
認証タイプ	Cosmos DB SQL コンテナー エンドポイントに対する認証に使用されるメソッド	「アイデンティティベース」 'keyBased'
コンテナ名	Cosmos DB データベース内の Cosmos DB SQL コンテナーの名前。	string (必須)
データベース名	Cosmos DB アカウント内の Cosmos DB データベースの名前。	string (必須)
エンドポイントURI	Cosmos DB アカウントの URL。 プロトコル https:// を含める必要があります	string (必須)
同一性	Cosmos DB コンテナー エンドポイントのルーティングのマネージド ID プロパティ。	マネージド アイデンティティ
名前	このエンドポイントを識別する名前。 名前には英数字、ピリオド、アンダースコア、ハイフンのみを含めることができます。最大長は 64 文字です。 予約されている名前は、イベント、fileNotifications、$defaultです。 エンドポイント名は、エンドポイントの種類間で一意である必要があります。	糸 制約： パターン = ^[A-Za-z0-9-._]{1,64}$ (必須)
partitionKeyName (パーティションキー名)	この Cosmos DB SQL コンテナーに関連付けられているパーティション キーの名前 (存在する場合)。 これは省略可能なパラメーターです。	糸
partitionKeyTemplate (パーティションキーテンプレート)	この Cosmos DB SQL コンテナーで使用する合成パーティション キー値を生成するためのテンプレート。 テンプレートには、{iothub}、{deviceid}、{DD}、{MM}、{YYYY} のいずれかのプレースホルダーが少なくとも 1 つ含まれている必要があります。 1 つのプレースホルダーは最大で 1 回指定できますが、順序とプレースホルダー以外のコンポーネントは任意です。 このパラメーターは、PartitionKeyName が指定されている場合にのみ必要です。	糸
プライマリキー	Cosmos DB アカウントの主キー。	糸 制約： 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。
resourceGroup	Cosmos DB アカウントのリソース グループの名前。	糸
セカンダリキー	Cosmos DB アカウントのセカンダリ キー。	糸 制約： 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。
サブスクリプションID	Cosmos DB アカウントのサブスクリプション識別子。	糸

ルーティングエンドポイント

名前	形容	価値
cosmosDBSqlコンテナ	IoT Hub がルーティング規則に基づいてメッセージをルーティングする Cosmos DB コンテナー エンドポイントの一覧。	RoutingCosmosDBSqlApiプロパティ[]
イベントハブ	ルーティング規則に基づいて、IoT Hub がメッセージをルーティングする Event Hubs エンドポイントの一覧。 この一覧には、組み込みの Event Hubs エンドポイントは含まれません。	RoutingEventHubプロパティ[]
サービスバスキュー	ルーティング規則に基づいて、IoT ハブがメッセージをルーティングする Service Bus キュー エンドポイントの一覧。	ルーティングサービスバスキューエンドポイントプロパティ[]
サービスバストピック	ルーティング規則に基づいて、IoT ハブがメッセージをルーティングする Service Bus トピック エンドポイントの一覧。	RoutingServiceBusTopicEndpointProperties[]
貯蔵コンテナ用	ルーティング規則に基づいて、IoT Hub がメッセージをルーティングするストレージ コンテナー エンドポイントの一覧。	ルーティングストレージコンテナプロパティ[]

ルーティングEventHubProperties

名前	形容	価値
認証タイプ	イベント ハブ エンドポイントに対する認証に使用されるメソッド	「アイデンティティベース」 'keyBased'
コネクションストリング	イベント ハブ エンドポイントの接続文字列。	糸
エンドポイントURI	イベント ハブ エンドポイントの URL。 プロトコル sb:// を含める必要があります	糸
エンティティパス	イベント ハブ名前空間のイベント ハブ名	糸
身分証明書	イベント ハブ エンドポイントの ID	糸
同一性	ルーティング イベント ハブ エンドポイントのマネージド ID プロパティ。	マネージド アイデンティティ
名前	このエンドポイントを識別する名前。 名前には英数字、ピリオド、アンダースコア、ハイフンのみを含めることができます。最大長は 64 文字です。 予約されている名前は、イベント、fileNotifications、$defaultです。 エンドポイント名は、エンドポイントの種類間で一意である必要があります。	糸 制約： パターン = ^[A-Za-z0-9-._]{1,64}$ (必須)
resourceGroup	イベント ハブ エンドポイントのリソース グループの名前。	糸
サブスクリプションID	イベント ハブ エンドポイントのサブスクリプション識別子。	糸

ルーティングプロパティ

名前	形容	価値
エンドポイント	IoT ハブがルーティング規則に基づいてメッセージをルーティングするカスタム エンドポイントに関連するプロパティ。 有料ハブのすべての種類のすべてのエンドポイントで最大 10 個のカスタム エンドポイントが許可され、無料ハブのすべてのエンドポイントの種類で許可されるカスタム エンドポイントは 1 つだけです。	RoutingEndpoints の
エンリッチメント	組み込みエンドポイントとカスタム エンドポイントに配信されるメッセージに IoT ハブが適用するユーザー指定のエンリッチメントの一覧。 参照: https://aka.ms/telemetryoneventgrid	エンリッチメントプロパティ[]
フォールバックルート	"routes" セクションで指定された条件が満たされていない場合にフォールバック ルートとして使用されるルートのプロパティ。 これは省略可能なパラメーターです。 このプロパティがテンプレートに存在しない場合、フォールバック ルートは既定で無効になります。	FallbackRouteProperties の
ルート	IoT ハブが組み込みエンドポイントとカスタム エンドポイントにメッセージをルーティングするために使用するユーザー指定のルーティング規則の一覧。 有料ハブには最大 100 個のルーティング規則が許可され、無料ハブでは最大 5 つのルーティング規則が許可されます。	ルートプロパティ[]

ルーティングサービスバスキューエンドポイントプロパティ

名前	形容	価値
認証タイプ	Service Bus キュー エンドポイントに対する認証に使用されるメソッド	「アイデンティティベース」 'keyBased'
コネクションストリング	Service Bus キュー エンドポイントの接続文字列。	糸
エンドポイントURI	Service Bus キュー エンドポイントの URL。 プロトコル sb:// を含める必要があります	糸
エンティティパス	Service Bus 名前空間のキュー名	糸
身分証明書	Service Bus キュー エンドポイントの ID	糸
同一性	ルーティング サービス バス キュー エンドポイントのマネージド ID プロパティ。	マネージド アイデンティティ
名前	このエンドポイントを識別する名前。 名前には英数字、ピリオド、アンダースコア、ハイフンのみを含めることができます。最大長は 64 文字です。 予約されている名前は、イベント、fileNotifications、$defaultです。 エンドポイント名は、エンドポイントの種類間で一意である必要があります。 実際のキュー名と同じ名前である必要はありません。	糸 制約： パターン = ^[A-Za-z0-9-._]{1,64}$ (必須)
resourceGroup	Service Bus キュー エンドポイントのリソース グループの名前。	糸
サブスクリプションID	Service Bus キュー エンドポイントのサブスクリプション識別子。	糸

RoutingServiceBusTopicEndpointProperties (ルーティング サービスバス トピック エンドポイント プロパティ)

名前	形容	価値
認証タイプ	Service Bus トピック エンドポイントに対する認証に使用されるメソッド	「アイデンティティベース」 'keyBased'
コネクションストリング	Service Bus トピック エンドポイントの接続文字列。	糸
エンドポイントURI	Service Bus トピック エンドポイントの URL。 プロトコル sb:// を含める必要があります	糸
エンティティパス	Service Bus トピックのキュー名	糸
身分証明書	Service Bus トピック エンドポイントの ID	糸
同一性	ルーティング サービス バス トピック エンドポイントのマネージド ID プロパティ。	マネージド アイデンティティ
名前	このエンドポイントを識別する名前。 名前には英数字、ピリオド、アンダースコア、ハイフンのみを含めることができます。最大長は 64 文字です。 予約されている名前は、イベント、fileNotifications、$defaultです。 エンドポイント名は、エンドポイントの種類間で一意である必要があります。 名前は、実際のトピック名と同じである必要はありません。	糸 制約： パターン = ^[A-Za-z0-9-._]{1,64}$ (必須)
resourceGroup	Service Bus トピック エンドポイントのリソース グループの名前。	糸
サブスクリプションID	Service Bus トピック エンドポイントのサブスクリプション識別子。	糸

ルーティングストレージコンテナプロパティ

名前	形容	価値
認証タイプ	ストレージ エンドポイントに対する認証に使用されるメソッド	「アイデンティティベース」 'keyBased'
batchFrequencyInSeconds (バッチ周波数イン秒)	BLOB がストレージに書き込まれる時間間隔。 値は 60 ~ 720 秒にする必要があります。 既定値は 300 秒です。	int 制約： 最小値 = 60 最大値 = 720
コネクションストリング	ストレージ アカウントの接続文字列。	糸
コンテナ名	ストレージ アカウント内のストレージ コンテナーの名前。	string (必須)
エンコーディング	メッセージを BLOB にシリアル化するために使用されるエンコード。 サポートされる値は、'avro'、'avrodeflate'、および 'JSON' です。 既定値は 'avro' です。	「アブロ」 「アブロデフレート」 「JSON」
エンドポイントURI	ストレージ エンドポイントの URL。 プロトコル https:// を含める必要があります	糸
fileNameFormat(ファイル名フォーマット)	BLOB のファイル名の形式。 既定の形式は {iothub}/{partition}/{YYYY}/{MM}/{DD}/{HH}/{mm} です。 すべてのパラメーターは必須ですが、順序を変更できます。	糸
身分証明書	ストレージ コンテナー エンドポイントの ID	糸
同一性	ルーティング ストレージ エンドポイントのマネージド ID プロパティ。	マネージド アイデンティティ
maxChunkSizeInBytes	ストレージに書き込まれる各 BLOB の最大バイト数。 値は、10485760(10 MB) から 524288000(500 MB) の間である必要があります。 既定値は 314572800(300 MB) です。	int 制約： 最小値 = 10485760 最大値 = 524288000
名前	このエンドポイントを識別する名前。 名前には英数字、ピリオド、アンダースコア、ハイフンのみを含めることができます。最大長は 64 文字です。 予約されている名前は、イベント、fileNotifications、$defaultです。 エンドポイント名は、エンドポイントの種類間で一意である必要があります。	糸 制約： パターン = ^[A-Za-z0-9-._]{1,64}$ (必須)
resourceGroup	ストレージ アカウントのリソース グループの名前。	糸
サブスクリプションID	ストレージ アカウントのサブスクリプション識別子。	糸

SharedAccessSignatureAuthorizationRule

名前	形容	価値
キー名	共有アクセス ポリシーの名前。	string (必須)
プライマリキー	主キー。	糸
権利	共有アクセス ポリシーに割り当てられたアクセス許可。	「デバイスコネクト」 'レジストリ読み取り' 'レジストリ読み取り、デバイス接続' 'レジストリ読み取り、レジストリ書き込み' 'RegistryRead,RegistryWrite, DeviceConnect' 'RegistryRead,RegistryWrite, ServiceConnect' 'RegistryRead、RegistryWrite、ServiceConnect、DeviceConnect' 'レジストリ読み取り、サービスコネクト' 'RegistryRead、ServiceConnect、DeviceConnect' 'レジストリライト' 'レジストリライト、デバイスコネクト' 「レジストリライト、サービスコネクト」 'RegistryWrite、ServiceConnect、DeviceConnect' 「サービスコネクト」 'ServiceConnect, DeviceConnect' (必須)
セカンダリキー	セカンダリ キー。	糸

ストレージエンドポイントプロパティ

名前	形容	価値
認証タイプ	ストレージ アカウントへの接続に使用する認証の種類を指定します。	「アイデンティティベース」 'keyBased'
コネクションストリング	ファイルがアップロードされる Azure Storage アカウントの接続文字列。	string (必須)
コンテナ名	ファイルをアップロードするルート コンテナーの名前。 コンテナーは存在する必要はありませんが、指定された connectionString を使用して作成できる必要があります。	string (必須)
同一性	ファイルアップロード用のストレージ エンドポイントのマネージド ID プロパティ。	マネージド アイデンティティ
sasTtlAsIso8601	IoT Hub によって生成されたファイルアップロード用の SAS URI が有効な期間。 /azure/iot-hub/iot-hub-devguide-file-upload#file-upload-notification-configuration-options を参照してください。	糸