次の方法で共有

Iot Hub Resource - Create Or Update

  • リファレンス
サービス:
IoT Hub
API バージョン:
2023-06-30

IoT ハブのメタデータをCreateまたは更新します。 プロパティを変更する通常のパターンは、IoT ハブのメタデータとセキュリティ メタデータを取得し、それらを新しい本文で変更された値と組み合わせて IoT ハブを更新することです。 JSON に特定のプロパティがない場合、IoT Hubを更新すると、これらの値が既定にフォールバックし、予期しない動作が発生する可能性があります。

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}?api-version=2023-06-30

URI パラメーター

名前 / 必須 型 説明
resourceGroupName
 path True

string

IoT ハブを含むリソース グループの名前。
resourceName
 path True

string

IoT ハブの名前。
subscriptionId
 path True

string

サブスクリプションの識別子です。
api-version
 query True

string

API のバージョン。

要求ヘッダー

名前 必須 型 説明
If-Match

string

IoT Hubの ETag。 まったく新しいIoT Hubを作成するには、 を指定しないでください。 既存のIoT Hubを更新するために必要です。

要求本文

名前 必須 型 説明
location True

string

リソースの場所。
sku True

IotHubSkuInfo

IotHub SKU 情報
etag

string

Etag フィールドは必須 ではありません 。 応答本文で指定する場合は、通常の ETag 規則に従ってヘッダーとしても指定する必要があります。
identity

ArmIdentity

IotHub のマネージド ID。
properties

IotHubProperties

IotHub プロパティ
tags

object

リソース タグ。

応答

名前 型 説明
200 OK

IotHubDescription

これは、作成または更新操作の状態ポーリング要求への応答として返されます。 本文には、移行プロビジョニング状態を示すリソース表現が含まれています。
201 Created

IotHubDescription

この操作の実行には時間がかかります。 検証が完了すると、操作は 201 を返します。 応答には、状態 URL を含む Azure-AsyncOperation ヘッダーが含まれています。 クライアントは、操作の状態の状態 URL をポーリングする必要があります。 成功した場合、操作は HTTP 状態コード 201 (OK) を返します。
Other Status Codes

ErrorDetails

DefaultErrorResponse

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前 説明
user_impersonation ユーザー アカウントの借用

例

IotHubResource_AddCosmosDbEndpoint
IotHubResource_CreateOrUpdate

IotHubResource_AddCosmosDbEndpoint

要求のサンプル

PUT https://management.azure.com/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub?api-version=2023-06-30

{
  "location": "centraluseuap",
  "tags": {},
  "etag": "AAAAAAFD6M4=",
  "properties": {
    "ipFilterRules": [],
    "networkRuleSets": {
      "defaultAction": "Deny",
      "applyToBuiltInEventHubEndpoint": true,
      "ipRules": [
        {
          "filterName": "rule1",
          "action": "Allow",
          "ipMask": "131.117.159.53"
        },
        {
          "filterName": "rule2",
          "action": "Allow",
          "ipMask": "157.55.59.128/25"
        }
      ]
    },
    "eventHubEndpoints": {
      "events": {
        "retentionTimeInDays": 1,
        "partitionCount": 2
      }
    },
    "routing": {
      "endpoints": {
        "serviceBusQueues": [],
        "serviceBusTopics": [],
        "eventHubs": [],
        "storageContainers": [],
        "cosmosDBSqlContainers": [
          {
            "primaryKey": "<primary-key>",
            "secondaryKey": "<secondary-key>",
            "authenticationType": "keyBased",
            "containerName": "test",
            "databaseName": "systemstore",
            "endpointUri": "https://test-systemstore-test2.documents.azure.com",
            "name": "endpointcosmos",
            "partitionKeyName": "keystamped",
            "partitionKeyTemplate": "{deviceid}-{YYYY}-{MM}",
            "resourceGroup": "rg-test",
            "subscriptionId": "<subscription-id>"
          }
        ]
      },
      "routes": [],
      "fallbackRoute": {
        "name": "$fallback",
        "source": "DeviceMessages",
        "condition": "true",
        "endpointNames": [
          "events"
        ],
        "isEnabled": true
      }
    },
    "storageEndpoints": {
      "$default": {
        "sasTtlAsIso8601": "PT1H",
        "connectionString": "",
        "containerName": ""
      }
    },
    "messagingEndpoints": {
      "fileNotifications": {
        "lockDurationAsIso8601": "PT1M",
        "ttlAsIso8601": "PT1H",
        "maxDeliveryCount": 10
      }
    },
    "enableFileUploadNotifications": false,
    "cloudToDevice": {
      "maxDeliveryCount": 10,
      "defaultTtlAsIso8601": "PT1H",
      "feedback": {
        "lockDurationAsIso8601": "PT1M",
        "ttlAsIso8601": "PT1H",
        "maxDeliveryCount": 10
      }
    },
    "features": "None",
    "minTlsVersion": "1.2",
    "enableDataResidency": false
  },
  "sku": {
    "name": "S1",
    "capacity": 1
  }
}

応答のサンプル

状態コード:
200 
{
  "id": "/subscriptions/ae24ff83-d2ca-4fc8-9717-05dae4bba489/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub",
  "name": "testHub",
  "type": "Microsoft.Devices/IotHubs",
  "location": "centraluseuap",
  "tags": {},
  "etag": "AAAAAAFD6M4=",
  "properties": {
    "state": "Active",
    "provisioningState": "Succeeded",
    "ipFilterRules": [
      {
        "filterName": "rule1",
        "action": "Accept",
        "ipMask": "131.117.159.53"
      },
      {
        "filterName": "rule2",
        "action": "Accept",
        "ipMask": "157.55.59.128/25"
      }
    ],
    "networkRuleSets": {
      "defaultAction": "Deny",
      "applyToBuiltInEventHubEndpoint": true,
      "ipRules": [
        {
          "filterName": "rule1",
          "action": "Allow",
          "ipMask": "131.117.159.53"
        },
        {
          "filterName": "rule2",
          "action": "Allow",
          "ipMask": "157.55.59.128/25"
        }
      ]
    },
    "hostName": "iot-dps-cit-hub-1.azure-devices.net",
    "eventHubEndpoints": {
      "events": {
        "retentionTimeInDays": 1,
        "partitionCount": 2,
        "partitionIds": [
          "0",
          "1"
        ],
        "path": "iot-dps-cit-hub-1",
        "endpoint": "sb://iothub-ns-iot-dps-ci-245306-76aca8e13b.servicebus.windows.net/"
      }
    },
    "routing": {
      "endpoints": {
        "serviceBusQueues": [],
        "serviceBusTopics": [],
        "eventHubs": [],
        "storageContainers": [],
        "cosmosDBSqlContainers": [
          {
            "id": "009208fa-9cb7-4b90-bfbd-f40086e766c9",
            "authenticationType": "keyBased",
            "containerName": "test",
            "databaseName": "systemstore",
            "endpointUri": "https://test-systemstore-test2.documents.azure.com",
            "name": "endpointcosmos",
            "partitionKeyName": "keystamped",
            "partitionKeyTemplate": "{deviceid}-{YYYY}-{MM}",
            "resourceGroup": "rg-test",
            "subscriptionId": "<subscription-id>"
          }
        ]
      },
      "routes": [],
      "fallbackRoute": {
        "name": "$fallback",
        "source": "DeviceMessages",
        "condition": "true",
        "endpointNames": [
          "events"
        ],
        "isEnabled": true
      }
    },
    "storageEndpoints": {
      "$default": {
        "sasTtlAsIso8601": "PT1H",
        "connectionString": "",
        "containerName": ""
      }
    },
    "messagingEndpoints": {
      "fileNotifications": {
        "lockDurationAsIso8601": "PT1M",
        "ttlAsIso8601": "PT1H",
        "maxDeliveryCount": 10
      }
    },
    "enableFileUploadNotifications": false,
    "cloudToDevice": {
      "maxDeliveryCount": 10,
      "defaultTtlAsIso8601": "PT1H",
      "feedback": {
        "lockDurationAsIso8601": "PT1M",
        "ttlAsIso8601": "PT1H",
        "maxDeliveryCount": 10
      }
    },
    "features": "None",
    "minTlsVersion": "1.2",
    "enableDataResidency": false
  },
  "sku": {
    "name": "S1",
    "tier": "Standard",
    "capacity": 1
  },
  "systemData": {
    "createdAt": "2021-01-30T00:28:38.963Z"
  }
}
状態コード:
201 
{
  "id": "/subscriptions/ae24ff83-d2ca-4fc8-9717-05dae4bba489/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub",
  "name": "testHub",
  "type": "Microsoft.Devices/IotHubs",
  "location": "centraluseuap",
  "tags": {},
  "etag": "AAAAAAFD6M4=",
  "properties": {
    "state": "Active",
    "provisioningState": "Succeeded",
    "ipFilterRules": [
      {
        "filterName": "rule1",
        "action": "Accept",
        "ipMask": "131.117.159.53"
      },
      {
        "filterName": "rule2",
        "action": "Accept",
        "ipMask": "157.55.59.128/25"
      }
    ],
    "networkRuleSets": {
      "defaultAction": "Deny",
      "applyToBuiltInEventHubEndpoint": true,
      "ipRules": [
        {
          "filterName": "rule1",
          "action": "Allow",
          "ipMask": "131.117.159.53"
        },
        {
          "filterName": "rule2",
          "action": "Allow",
          "ipMask": "157.55.59.128/25"
        }
      ]
    },
    "hostName": "iot-dps-cit-hub-1.azure-devices.net",
    "eventHubEndpoints": {
      "events": {
        "retentionTimeInDays": 1,
        "partitionCount": 2,
        "partitionIds": [
          "0",
          "1"
        ],
        "path": "iot-dps-cit-hub-1",
        "endpoint": "sb://iothub-ns-iot-dps-ci-245306-76aca8e13b.servicebus.windows.net/"
      }
    },
    "routing": {
      "endpoints": {
        "serviceBusQueues": [],
        "serviceBusTopics": [],
        "eventHubs": [],
        "storageContainers": [],
        "cosmosDBSqlContainers": [
          {
            "id": "009208fa-9cb7-4b90-bfbd-f40086e766c9",
            "authenticationType": "keyBased",
            "containerName": "test",
            "databaseName": "systemstore",
            "endpointUri": "https://test-systemstore-test2.documents.azure.com",
            "name": "endpointcosmos",
            "partitionKeyName": "keystamped",
            "partitionKeyTemplate": "{deviceid}-{YYYY}-{MM}",
            "resourceGroup": "rg-test",
            "subscriptionId": "<subscription-id>"
          }
        ]
      },
      "routes": [],
      "fallbackRoute": {
        "name": "$fallback",
        "source": "DeviceMessages",
        "condition": "true",
        "endpointNames": [
          "events"
        ],
        "isEnabled": true
      }
    },
    "storageEndpoints": {
      "$default": {
        "sasTtlAsIso8601": "PT1H",
        "connectionString": "",
        "containerName": ""
      }
    },
    "messagingEndpoints": {
      "fileNotifications": {
        "lockDurationAsIso8601": "PT1M",
        "ttlAsIso8601": "PT1H",
        "maxDeliveryCount": 10
      }
    },
    "enableFileUploadNotifications": false,
    "cloudToDevice": {
      "maxDeliveryCount": 10,
      "defaultTtlAsIso8601": "PT1H",
      "feedback": {
        "lockDurationAsIso8601": "PT1M",
        "ttlAsIso8601": "PT1H",
        "maxDeliveryCount": 10
      }
    },
    "features": "None",
    "minTlsVersion": "1.2",
    "enableDataResidency": false
  },
  "sku": {
    "name": "S1",
    "tier": "Standard",
    "capacity": 1
  },
  "systemData": {
    "createdAt": "2021-01-30T00:28:38.963Z"
  }
}

IotHubResource_CreateOrUpdate

要求のサンプル

PUT https://management.azure.com/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub?api-version=2023-06-30

{
  "location": "centraluseuap",
  "tags": {},
  "etag": "AAAAAAFD6M4=",
  "properties": {
    "ipFilterRules": [],
    "networkRuleSets": {
      "defaultAction": "Deny",
      "applyToBuiltInEventHubEndpoint": true,
      "ipRules": [
        {
          "filterName": "rule1",
          "action": "Allow",
          "ipMask": "131.117.159.53"
        },
        {
          "filterName": "rule2",
          "action": "Allow",
          "ipMask": "157.55.59.128/25"
        }
      ]
    },
    "eventHubEndpoints": {
      "events": {
        "retentionTimeInDays": 1,
        "partitionCount": 2
      }
    },
    "routing": {
      "endpoints": {
        "serviceBusQueues": [],
        "serviceBusTopics": [],
        "eventHubs": [],
        "storageContainers": []
      },
      "routes": [],
      "fallbackRoute": {
        "name": "$fallback",
        "source": "DeviceMessages",
        "condition": "true",
        "endpointNames": [
          "events"
        ],
        "isEnabled": true
      }
    },
    "storageEndpoints": {
      "$default": {
        "sasTtlAsIso8601": "PT1H",
        "connectionString": "",
        "containerName": ""
      }
    },
    "messagingEndpoints": {
      "fileNotifications": {
        "lockDurationAsIso8601": "PT1M",
        "ttlAsIso8601": "PT1H",
        "maxDeliveryCount": 10
      }
    },
    "enableFileUploadNotifications": false,
    "cloudToDevice": {
      "maxDeliveryCount": 10,
      "defaultTtlAsIso8601": "PT1H",
      "feedback": {
        "lockDurationAsIso8601": "PT1M",
        "ttlAsIso8601": "PT1H",
        "maxDeliveryCount": 10
      }
    },
    "features": "None",
    "minTlsVersion": "1.2",
    "enableDataResidency": false
  },
  "sku": {
    "name": "S1",
    "capacity": 1
  }
}

応答のサンプル

状態コード:
200 
{
  "id": "/subscriptions/ae24ff83-d2ca-4fc8-9717-05dae4bba489/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub",
  "name": "testHub",
  "type": "Microsoft.Devices/IotHubs",
  "location": "centraluseuap",
  "tags": {},
  "etag": "AAAAAAFD6M4=",
  "properties": {
    "state": "Active",
    "provisioningState": "Succeeded",
    "ipFilterRules": [
      {
        "filterName": "rule1",
        "action": "Accept",
        "ipMask": "131.117.159.53"
      },
      {
        "filterName": "rule2",
        "action": "Accept",
        "ipMask": "157.55.59.128/25"
      }
    ],
    "networkRuleSets": {
      "defaultAction": "Deny",
      "applyToBuiltInEventHubEndpoint": true,
      "ipRules": [
        {
          "filterName": "rule1",
          "action": "Allow",
          "ipMask": "131.117.159.53"
        },
        {
          "filterName": "rule2",
          "action": "Allow",
          "ipMask": "157.55.59.128/25"
        }
      ]
    },
    "hostName": "iot-dps-cit-hub-1.azure-devices.net",
    "eventHubEndpoints": {
      "events": {
        "retentionTimeInDays": 1,
        "partitionCount": 2,
        "partitionIds": [
          "0",
          "1"
        ],
        "path": "iot-dps-cit-hub-1",
        "endpoint": "sb://iothub-ns-iot-dps-ci-245306-76aca8e13b.servicebus.windows.net/"
      }
    },
    "routing": {
      "endpoints": {
        "serviceBusQueues": [],
        "serviceBusTopics": [],
        "eventHubs": [],
        "storageContainers": []
      },
      "routes": [],
      "fallbackRoute": {
        "name": "$fallback",
        "source": "DeviceMessages",
        "condition": "true",
        "endpointNames": [
          "events"
        ],
        "isEnabled": true
      }
    },
    "storageEndpoints": {
      "$default": {
        "sasTtlAsIso8601": "PT1H",
        "connectionString": "",
        "containerName": ""
      }
    },
    "messagingEndpoints": {
      "fileNotifications": {
        "lockDurationAsIso8601": "PT1M",
        "ttlAsIso8601": "PT1H",
        "maxDeliveryCount": 10
      }
    },
    "enableFileUploadNotifications": false,
    "cloudToDevice": {
      "maxDeliveryCount": 10,
      "defaultTtlAsIso8601": "PT1H",
      "feedback": {
        "lockDurationAsIso8601": "PT1M",
        "ttlAsIso8601": "PT1H",
        "maxDeliveryCount": 10
      }
    },
    "features": "None",
    "minTlsVersion": "1.2",
    "enableDataResidency": false
  },
  "sku": {
    "name": "S1",
    "tier": "Standard",
    "capacity": 1
  },
  "systemData": {
    "createdAt": "2021-01-30T00:28:38.963Z"
  }
}
状態コード:
201 
{
  "id": "/subscriptions/ae24ff83-d2ca-4fc8-9717-05dae4bba489/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub",
  "name": "testHub",
  "type": "Microsoft.Devices/IotHubs",
  "location": "centraluseuap",
  "tags": {},
  "etag": "AAAAAAFD6M4=",
  "properties": {
    "state": "Active",
    "provisioningState": "Succeeded",
    "ipFilterRules": [
      {
        "filterName": "rule1",
        "action": "Accept",
        "ipMask": "131.117.159.53"
      },
      {
        "filterName": "rule2",
        "action": "Accept",
        "ipMask": "157.55.59.128/25"
      }
    ],
    "networkRuleSets": {
      "defaultAction": "Deny",
      "applyToBuiltInEventHubEndpoint": true,
      "ipRules": [
        {
          "filterName": "rule1",
          "action": "Allow",
          "ipMask": "131.117.159.53"
        },
        {
          "filterName": "rule2",
          "action": "Allow",
          "ipMask": "157.55.59.128/25"
        }
      ]
    },
    "hostName": "iot-dps-cit-hub-1.azure-devices.net",
    "eventHubEndpoints": {
      "events": {
        "retentionTimeInDays": 1,
        "partitionCount": 2,
        "partitionIds": [
          "0",
          "1"
        ],
        "path": "iot-dps-cit-hub-1",
        "endpoint": "sb://iothub-ns-iot-dps-ci-245306-76aca8e13b.servicebus.windows.net/"
      }
    },
    "routing": {
      "endpoints": {
        "serviceBusQueues": [],
        "serviceBusTopics": [],
        "eventHubs": [],
        "storageContainers": []
      },
      "routes": [],
      "fallbackRoute": {
        "name": "$fallback",
        "source": "DeviceMessages",
        "condition": "true",
        "endpointNames": [
          "events"
        ],
        "isEnabled": true
      }
    },
    "storageEndpoints": {
      "$default": {
        "sasTtlAsIso8601": "PT1H",
        "connectionString": "",
        "containerName": ""
      }
    },
    "messagingEndpoints": {
      "fileNotifications": {
        "lockDurationAsIso8601": "PT1M",
        "ttlAsIso8601": "PT1H",
        "maxDeliveryCount": 10
      }
    },
    "enableFileUploadNotifications": false,
    "cloudToDevice": {
      "maxDeliveryCount": 10,
      "defaultTtlAsIso8601": "PT1H",
      "feedback": {
        "lockDurationAsIso8601": "PT1M",
        "ttlAsIso8601": "PT1H",
        "maxDeliveryCount": 10
      }
    },
    "features": "None",
    "minTlsVersion": "1.2",
    "enableDataResidency": false
  },
  "sku": {
    "name": "S1",
    "tier": "Standard",
    "capacity": 1
  },
  "systemData": {
    "createdAt": "2021-01-30T00:28:38.963Z"
  }
}

定義

名前 説明
AccessRights

共有アクセス ポリシーに割り当てられたアクセス許可。
ArmIdentity
ArmUserIdentity
AuthenticationType

ストレージ アカウントへの接続に使用される認証の種類を指定します。
authenticationType

Service Bus キュー エンドポイントに対する認証に使用されるメソッド
Capabilities

IoT ハブで有効になっている機能。
CloudToDeviceProperties

IoT ハブのクラウドからデバイスへのメッセージング プロパティ。
createdByType

リソースを作成した ID の種類。
DefaultAction

ネットワーク ルール セットの既定のアクション
EnrichmentProperties

IoT ハブがエンドポイントに配信されるメッセージに適用されるエンリッチメントのプロパティ。
ErrorDetails

エラーの詳細。
EventHubProperties

IoT ハブで使用されるプロビジョニングされた Event Hub 互換エンドポイントのプロパティ。
FallbackRouteProperties

フォールバック ルートのプロパティ。 IoT Hubは、フォールバック エンドポイントにメッセージをルーティングするときに、これらのプロパティを使用します。
FeedbackProperties

クラウドからデバイスへのメッセージのフィードバック キューのプロパティ。
IotHubDescription

IoT ハブの説明。
IotHubLocationDescription

リソースがプロビジョニングされている場所の 1 つのパブリック表現。
IotHubProperties

IoT ハブのプロパティ。
IotHubReplicaRoleType

リージョンのロールは、プライマリまたはセカンダリのいずれかになります。 プライマリ リージョンは、IoT ハブが現在プロビジョニングされている場所です。 セカンダリ リージョンは、Azure ディザスター リカバリー (DR) のペアになっているリージョンと、IoT ハブがフェールオーバーできるリージョンです。
IotHubSku

SKU の名前。
IotHubSkuInfo

IoT ハブの SKU に関する情報。
IotHubSkuTier

IoT ハブの課金レベル。
IpFilterActionType

このルールによってキャプチャされた要求に対して必要なアクション。
IpFilterRule

IoT ハブの IP フィルター規則。
ManagedIdentity

マネージド ID のプロパティ。
MessagingEndpointProperties

この IoT ハブで使用されるメッセージング エンドポイントのプロパティ。
NetworkRuleIPAction

IP フィルター アクション
NetworkRuleSetIpRule

ネットワーク 規則セットの一部として適用される IP 規則
NetworkRuleSetProperties

IotHub のネットワーク ルール セットのプロパティ
PrivateEndpoint

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

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

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

プライベート エンドポイント接続の現在の状態
PrivateLinkServiceConnectionStatus

プライベート エンドポイント接続の状態
PublicNetworkAccess

パブリック ネットワークからの要求が許可されるかどうか
ResourceIdentityType

リソースに使用される ID の種類。 種類 "SystemAssigned、UserAssigned" には、暗黙的に作成された ID とユーザー割り当て ID のセットの両方が含まれます。 型 'None' は、サービスからすべての ID を削除します。
RouteProperties

IoT ハブがエンドポイントにメッセージをルーティングするために使用するルーティング規則のプロパティ。
RoutingCosmosDBSqlApiProperties

Cosmos DB SQL コンテナー エンドポイントに関連するプロパティ。
RoutingEndpoints

IoT ハブがルーティング規則に基づいてメッセージをルーティングするカスタム エンドポイントに関連するプロパティ。 有料ハブのすべてのエンドポイントの種類で最大 10 個のカスタム エンドポイントが許可され、無料ハブのすべてのエンドポイントの種類で許可されるカスタム エンドポイントは 1 つだけです。
RoutingEventHubProperties

イベント ハブ エンドポイントに関連するプロパティ。
RoutingProperties

IoT ハブのルーティング関連のプロパティ。 https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging を参照
RoutingServiceBusQueueEndpointProperties

Service Bus キュー エンドポイントの種類に関連するプロパティ。
RoutingServiceBusTopicEndpointProperties

Service Bus トピック エンドポイントの種類に関連するプロパティ。
RoutingSource

ルーティング規則を適用するソース (DeviceMessages など)。
RoutingStorageContainerProperties

ストレージ コンテナー エンドポイントに関連するプロパティ。
SharedAccessSignatureAuthorizationRule

IoT ハブの共有アクセス ポリシーのプロパティ。
StorageEndpointProperties

ファイルアップロード用の Azure Storage エンドポイントのプロパティ。
systemData

リソースの作成と最後の変更に関連するメタデータ。

AccessRights

共有アクセス ポリシーに割り当てられたアクセス許可。

名前 型 説明
DeviceConnect

string

RegistryRead

string

RegistryRead, DeviceConnect

string

RegistryRead, RegistryWrite

string

RegistryRead, RegistryWrite, DeviceConnect

string

RegistryRead, RegistryWrite, ServiceConnect

string

RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect

string

RegistryRead, ServiceConnect

string

RegistryRead, ServiceConnect, DeviceConnect

string

RegistryWrite

string

RegistryWrite, DeviceConnect

string

RegistryWrite, ServiceConnect

string

RegistryWrite, ServiceConnect, DeviceConnect

string

ServiceConnect

string

ServiceConnect, DeviceConnect

string

ArmIdentity

名前 型 説明
principalId

string

プリンシパル ID
tenantId

string

テナント ID
type

ResourceIdentityType

リソースに使用される ID の種類。 種類 "SystemAssigned、UserAssigned" には、暗黙的に作成された ID とユーザー割り当て ID のセットの両方が含まれます。 型 'None' は、サービスからすべての ID を削除します。
userAssignedIdentities

<string,  ArmUserIdentity>

ArmUserIdentity

名前 型 説明
clientId

string

principalId

string

AuthenticationType

ストレージ アカウントへの接続に使用される認証の種類を指定します。

名前 型 説明
identityBased

string

keyBased

string

authenticationType

Service Bus キュー エンドポイントに対する認証に使用されるメソッド

名前 型 説明
identityBased

string

keyBased

string

Capabilities

IoT ハブで有効になっている機能。

名前 型 説明
DeviceManagement

string

None

string

CloudToDeviceProperties

IoT ハブのクラウドからデバイスへのメッセージング プロパティ。

名前 型 説明
defaultTtlAsIso8601

string

デバイス キュー内の cloud-to-device メッセージの既定の有効期間。 https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages をご覧ください。
feedback

FeedbackProperties

クラウドからデバイスへのメッセージのフィードバック キューのプロパティ。
maxDeliveryCount

integer

デバイス キュー内の cloud-to-device メッセージの最大配信数。 https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages をご覧ください。

createdByType

リソースを作成した ID の種類。

名前 型 説明
Application

string

Key

string

ManagedIdentity

string

User

string

DefaultAction

ネットワーク ルール セットの既定のアクション

名前 型 説明
Allow

string

Deny

string

EnrichmentProperties

IoT ハブがエンドポイントに配信されるメッセージに適用されるエンリッチメントのプロパティ。

名前 型 説明
endpointNames

string[]

エンリッチメントがメッセージに適用されるエンドポイントの一覧。
key

string

エンリッチメント プロパティのキーまたは名前。
value

string

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

ErrorDetails

エラーの詳細。

名前 型 説明
code

string

エラー コード。
details

string

エラーの詳細です。
httpStatusCode

string

HTTP 状態コード。
message

string

エラー メッセージ。

EventHubProperties

IoT ハブで使用されるプロビジョニングされた Event Hub 互換エンドポイントのプロパティ。

名前 型 説明
endpoint

string

Event Hub 互換エンドポイント。
partitionCount

integer

Event Hub 互換エンドポイントでデバイスからクラウドへのメッセージを受信するためのパーティションの数。 https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages をご覧ください。
partitionIds

string[]

Event Hub 互換エンドポイントのパーティション ID。
path

string

イベント ハブ互換の名前。
retentionTimeInDays

integer

デバイスからクラウドへのメッセージの保持時間 (日数)。 https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages を参照

FallbackRouteProperties

フォールバック ルートのプロパティ。 IoT Hubは、フォールバック エンドポイントにメッセージをルーティングするときに、これらのプロパティを使用します。

名前 型 説明
condition

string

フォールバック ルートを適用するために評価される条件。 条件が指定されていない場合、既定では true と評価されます。 文法については、次を参照してください。 https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language
endpointNames

string[]

条件を満たすメッセージのルーティング先となるエンドポイントの一覧。 現在、許可されているエンドポイントは 1 つだけです。
isEnabled

boolean

フォールバック ルートを有効にするかどうかを指定するために使用します。
name

string

ルートの名前。 名前には、英数字、ピリオド、アンダースコア、ハイフンのみを含めることができます。最大長は 64 文字で、一意である必要があります。
source

RoutingSource

ルーティング規則を適用するソース。 たとえば、DeviceMessages

FeedbackProperties

クラウドからデバイスへのメッセージのフィードバック キューのプロパティ。

名前 型 説明
lockDurationAsIso8601

string

フィードバック キューのロック期間。 https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages をご覧ください。
maxDeliveryCount

integer

IoT ハブがフィードバック キューにメッセージを配信しようとした回数。 https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages をご覧ください。
ttlAsIso8601

string

IoT ハブによって有効期限が切れる前にメッセージを使用できる期間。 https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages をご覧ください。

IotHubDescription

IoT ハブの説明。

名前 型 説明
etag

string

Etag フィールドは必須 ではありません 。 応答本文で指定する場合は、通常の ETag 規則に従ってヘッダーとしても指定する必要があります。
id

string

リソース識別子。
identity

ArmIdentity

IotHub のマネージド ID。
location

string

リソースの場所。
name

string

リソースの名前。
properties

IotHubProperties

IotHub プロパティ
sku

IotHubSkuInfo

IotHub SKU 情報
systemData

systemData

このリソースに関連するシステム メタデータ。
tags

object

リソース タグ。
type

string

リソースの種類。

IotHubLocationDescription

リソースがプロビジョニングされている場所の 1 つのパブリック表現。

名前 型 説明
location

string

Azure リージョンの名前
role

IotHubReplicaRoleType

リージョンのロールは、プライマリまたはセカンダリのいずれかになります。 プライマリ リージョンは、IoT ハブが現在プロビジョニングされている場所です。 セカンダリ リージョンは、Azure ディザスター リカバリー (DR) のペアになっているリージョンと、IoT ハブがフェールオーバーできるリージョンです。

IotHubProperties

IoT ハブのプロパティ。

名前 型 説明
allowedFqdnList

string[]

Iot Hub からのエグレスで許可される FQDN (完全修飾ドメイン名) の一覧。
authorizationPolicies

SharedAccessSignatureAuthorizationRule[]

IoT ハブへの接続をセキュリティで保護するために使用できる共有アクセス ポリシー。
cloudToDevice

CloudToDeviceProperties

IoT ハブのクラウドからデバイスへのメッセージング プロパティ。
comments

string

IoT ハブのコメント。
disableDeviceSAS

boolean

true の場合、すべてのデバイス (Edge デバイスを含むが、モジュールを除く) スコープの SAS キーは認証に使用できません。
disableLocalAuth

boolean

true の場合、IoT ハブ スコープの SAS キーを持つ SAS トークンを認証に使用できません。
disableModuleSAS

boolean

true の場合、モジュール スコープのすべての SAS キーを認証に使用できません。
enableDataResidency

boolean

このプロパティを true に設定すると、データ所在地が有効になり、ディザスター リカバリーが無効になります。
enableFileUploadNotifications

boolean

True の場合、ファイルのアップロード通知が有効になります。
eventHubEndpoints

<string,  EventHubProperties>

Event Hub 互換エンドポイントのプロパティ。 このディクショナリに使用できるキーはイベントのみです。 このキーは、IoT ハブの作成または更新呼び出しを行う際にディクショナリに存在する必要があります。
features

Capabilities

IoT ハブで有効になっている機能。
hostName

string

ホストの名前。
ipFilterRules

IpFilterRule[]

IP フィルター規則。
locations

IotHubLocationDescription[]

IoT ハブのプライマリとセカンダリの場所
messagingEndpoints

<string,  MessagingEndpointProperties>

ファイル アップロード通知キューのメッセージング エンドポイント プロパティ。
minTlsVersion

string

このハブでサポートする TLS の最小バージョンを指定します。 1.2 未満の TLS バージョンを使用するクライアントを拒否するには、"1.2" に設定できます。
networkRuleSets

NetworkRuleSetProperties

IotHub のネットワーク ルール セットのプロパティ
privateEndpointConnections

PrivateEndpointConnection[]

この IotHub で作成されたプライベート エンドポイント接続
provisioningState

string

プロビジョニングの状態。
publicNetworkAccess

PublicNetworkAccess

パブリック ネットワークからの要求が許可されるかどうか
restrictOutboundNetworkAccess

boolean

true の場合、IotHub からのエグレスは、allowedFqdnList 経由で構成されている許可された FQDN のみに制限されます。
routing

RoutingProperties

IoT ハブのルーティング関連のプロパティ。 https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging を参照
state

string

ハブの状態。
storageEndpoints

<string,  StorageEndpointProperties>

ファイルをアップロードできる Azure Storage エンドポイントの一覧。 現在、構成できる Azure Storage アカウントは 1 つだけで、そのキーを$defaultにする必要があります。 複数のストレージ アカウントを指定すると、エラーがスローされます。 enableFileUploadNotifications プロパティが True に設定されている場合、このプロパティの値を指定しないと、エラーがスローされます。

IotHubReplicaRoleType

リージョンのロールは、プライマリまたはセカンダリのいずれかになります。 プライマリ リージョンは、IoT ハブが現在プロビジョニングされている場所です。 セカンダリ リージョンは、Azure ディザスター リカバリー (DR) のペアになっているリージョンと、IoT ハブがフェールオーバーできるリージョンです。

名前 型 説明
primary

string

secondary

string

IotHubSku

SKU の名前。

名前 型 説明
B1

string

B2

string

B3

string

F1

string

S1

string

S2

string

S3

string

IotHubSkuInfo

IoT ハブの SKU に関する情報。

名前 型 説明
capacity

integer

プロビジョニングされたIoT Hubユニットの数。 https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits をご覧ください。
name

IotHubSku

SKU の名前。
tier

IotHubSkuTier

IoT ハブの課金レベル。

IotHubSkuTier

IoT ハブの課金レベル。

名前 型 説明
Basic

string

Free

string

Standard

string

IpFilterActionType

このルールによってキャプチャされた要求に対して必要なアクション。

名前 型 説明
Accept

string

Reject

string

IpFilterRule

IoT ハブの IP フィルター規則。

名前 型 説明
action

IpFilterActionType

このルールによってキャプチャされた要求に対して必要なアクション。
filterName

string

IP フィルター規則の名前。
ipMask

string

ルールの CIDR 表記の IP アドレス範囲を含む文字列。

ManagedIdentity

マネージド ID のプロパティ。

名前 型 説明
userAssignedIdentity

string

ユーザー割り当て ID。

MessagingEndpointProperties

この IoT ハブで使用されるメッセージング エンドポイントのプロパティ。

名前 型 説明
lockDurationAsIso8601

string

ロック期間。 https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload をご覧ください。
maxDeliveryCount

integer

IoT ハブがメッセージの配信を試行する回数。 https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload をご覧ください。
ttlAsIso8601

string

IoT ハブによって有効期限が切れる前にメッセージを使用できる期間。 https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload をご覧ください。

NetworkRuleIPAction

IP フィルター アクション

名前 型 説明
Allow

string

NetworkRuleSetIpRule

ネットワーク 規則セットの一部として適用される IP 規則

名前 型 規定値 説明
action

NetworkRuleIPAction

Allow

IP フィルター アクション
filterName

string

IP フィルター規則の名前。
ipMask

string

ルールの CIDR 表記の IP アドレス範囲を含む文字列。

NetworkRuleSetProperties

IotHub のネットワーク ルール セットのプロパティ

名前 型 規定値 説明
applyToBuiltInEventHubEndpoint

boolean

True の場合、ネットワーク ルール セットは IotHub の BuiltIn EventHub EndPoint にも適用されます
defaultAction

DefaultAction

Deny

ネットワーク ルール セットの既定のアクション
ipRules

NetworkRuleSetIpRule[]

IP ルールの一覧

PrivateEndpoint

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

名前 型 説明
id

string

リソース識別子。

PrivateEndpointConnection

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

名前 型 説明
id

string

リソース識別子。
name

string

リソースの名前。
properties

PrivateEndpointConnectionProperties

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

string

リソースの種類。

PrivateEndpointConnectionProperties

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

名前 型 説明
privateEndpoint

PrivateEndpoint

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

PrivateLinkServiceConnectionState

プライベート エンドポイント接続の現在の状態

PrivateLinkServiceConnectionState

プライベート エンドポイント接続の現在の状態

名前 型 説明
actionsRequired

string

プライベート エンドポイント接続に必要なアクション
description

string

プライベート エンドポイント接続の現在の状態の説明
status

PrivateLinkServiceConnectionStatus

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

PrivateLinkServiceConnectionStatus

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

名前 型 説明
Approved

string

Disconnected

string

Pending

string

Rejected

string

PublicNetworkAccess

パブリック ネットワークからの要求が許可されるかどうか

名前 型 説明
Disabled

string

Enabled

string

ResourceIdentityType

リソースに使用される ID の種類。 種類 "SystemAssigned、UserAssigned" には、暗黙的に作成された ID とユーザー割り当て ID のセットの両方が含まれます。 型 'None' は、サービスからすべての ID を削除します。

名前 型 説明
None

string

SystemAssigned

string

SystemAssigned, UserAssigned

string

UserAssigned

string

RouteProperties

IoT ハブがエンドポイントにメッセージをルーティングするために使用するルーティング規則のプロパティ。

名前 型 説明
condition

string

ルーティング規則を適用するために評価される条件。 条件が指定されていない場合、既定では true と評価されます。 文法については、次を参照してください。 https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language
endpointNames

string[]

条件を満たすメッセージがルーティングされるエンドポイントの一覧。 現在、許可されているエンドポイントは 1 つだけです。
isEnabled

boolean

ルートを有効にするかどうかを指定するために使用します。
name

string

ルートの名前。 名前には、英数字、ピリオド、アンダースコア、ハイフンのみを含めることができます。最大長は 64 文字で、一意である必要があります。
source

RoutingSource

ルーティング規則を適用するソース (DeviceMessages など)。

RoutingCosmosDBSqlApiProperties

Cosmos DB SQL コンテナー エンドポイントに関連するプロパティ。

名前 型 説明
authenticationType

authenticationType

Cosmos DB sql コンテナー エンドポイントに対する認証に使用されるメソッド
containerName

string

Cosmos DB データベース内の cosmos DB sql コンテナーの名前。
databaseName

string

Cosmos DB アカウント内の Cosmos DB データベースの名前。
endpointUri

string

Cosmos DB アカウントの URL。 プロトコル https:// を含める必要があります
id

string

Cosmos DB sql コンテナー エンドポイントの ID
identity

ManagedIdentity

Cosmos DB コンテナー エンドポイントのルーティングのマネージド ID プロパティ。
name

string

このエンドポイントを識別する名前。 名前には英数字、ピリオド、アンダースコア、ハイフンのみを含めることができます。最大長は 64 文字です。 次の名前が予約されています: events、fileNotifications、$default。 エンドポイント名は、エンドポイントの種類間で一意である必要があります。
partitionKeyName

string

この cosmos DB SQL コンテナーに関連付けられているパーティション キーの名前 (存在する場合)。 これは省略可能なパラメーターです。
partitionKeyTemplate

string

この cosmos DB sql コンテナーで使用する合成パーティション キー値を生成するためのテンプレート。 テンプレートには、{iothub}、{deviceid}、{DD}、{MM}、{YYYY} のいずれかのプレースホルダーが少なくとも 1 つ含まれている必要があります。 1 つのプレースホルダーは最大で 1 回指定できますが、順序コンポーネントとプレースホルダー以外のコンポーネントは任意です。 このパラメーターは、PartitionKeyName が指定されている場合にのみ必要です。
primaryKey

string

Cosmos DB アカウントの主キー。
resourceGroup

string

Cosmos DB アカウントのリソース グループの名前。
secondaryKey

string

Cosmos DB アカウントのセカンダリ キー。
subscriptionId

string

Cosmos DB アカウントのサブスクリプション識別子。

RoutingEndpoints

IoT ハブがルーティング規則に基づいてメッセージをルーティングするカスタム エンドポイントに関連するプロパティ。 有料ハブのすべてのエンドポイントの種類で最大 10 個のカスタム エンドポイントが許可され、無料ハブのすべてのエンドポイントの種類で許可されるカスタム エンドポイントは 1 つだけです。

名前 型 説明
cosmosDBSqlContainers

RoutingCosmosDBSqlApiProperties[]

ルーティング規則に基づいて、IoT ハブがメッセージをルーティングする Cosmos DB コンテナー エンドポイントの一覧。
eventHubs

RoutingEventHubProperties[]

ルーティング規則に基づいて、IoT ハブがメッセージをルーティングする Event Hubs エンドポイントの一覧。 この一覧には、組み込みの Event Hubs エンドポイントは含まれません。
serviceBusQueues

RoutingServiceBusQueueEndpointProperties[]

ルーティング規則に基づいて、IoT ハブがメッセージをルーティングする Service Bus キュー エンドポイントの一覧。
serviceBusTopics

RoutingServiceBusTopicEndpointProperties[]

ルーティング規則に基づいて、IoT ハブがメッセージをルーティングする Service Bus トピック エンドポイントの一覧。
storageContainers

RoutingStorageContainerProperties[]

IoT ハブがルーティング規則に基づいてメッセージをルーティングするストレージ コンテナー エンドポイントの一覧。

RoutingEventHubProperties

イベント ハブ エンドポイントに関連するプロパティ。

名前 型 説明
authenticationType

authenticationType

イベント ハブ エンドポイントに対する認証に使用されるメソッド
connectionString

string

イベント ハブ エンドポイントの接続文字列。
endpointUri

string

イベント ハブ エンドポイントの URL。 プロトコル sb:// を含める必要があります
entityPath

string

イベント ハブ名前空間のイベント ハブ名
id

string

イベント ハブ エンドポイントの ID
identity

ManagedIdentity

ルーティング イベント ハブ エンドポイントのマネージド ID プロパティ。
name

string

このエンドポイントを識別する名前。 名前には英数字、ピリオド、アンダースコア、ハイフンのみを含めることができます。最大長は 64 文字です。 次の名前が予約されています: events、fileNotifications、$default。 エンドポイント名は、エンドポイントの種類間で一意である必要があります。
resourceGroup

string

イベント ハブ エンドポイントのリソース グループの名前。
subscriptionId

string

イベント ハブ エンドポイントのサブスクリプション識別子。

RoutingProperties

IoT ハブのルーティング関連のプロパティ。 https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging を参照

名前 型 説明
endpoints

RoutingEndpoints

IoT ハブがルーティング規則に基づいてメッセージをルーティングするカスタム エンドポイントに関連するプロパティ。 有料ハブのすべてのエンドポイントの種類で最大 10 個のカスタム エンドポイントが許可され、無料ハブのすべてのエンドポイントの種類で許可されるカスタム エンドポイントは 1 つだけです。
enrichments

EnrichmentProperties[]

IoT ハブが組み込みエンドポイントとカスタム エンドポイントに配信するメッセージに適用されるユーザー指定のエンリッチメントの一覧。 https://aka.ms/telemetryoneventgrid を参照
fallbackRoute

FallbackRouteProperties

[ルート] セクションで指定された条件が満たされない場合にフォールバック ルートとして使用されるルートのプロパティ。 これは省略可能なパラメーターです。 このプロパティがテンプレートに存在しない場合、フォールバック ルートは既定で無効になります。
routes

RouteProperties[]

IoT ハブが組み込みエンドポイントとカスタム エンドポイントにメッセージをルーティングするために使用するユーザー指定のルーティング規則の一覧。 有料ハブでは最大 100 個のルーティング規則が許可され、無料ハブでは最大 5 つのルーティング規則が許可されます。

RoutingServiceBusQueueEndpointProperties

Service Bus キュー エンドポイントの種類に関連するプロパティ。

名前 型 説明
authenticationType

authenticationType

Service Bus キュー エンドポイントに対する認証に使用されるメソッド
connectionString

string

Service Bus キュー エンドポイントの接続文字列。
endpointUri

string

Service Bus キュー エンドポイントの URL。 プロトコル sb:// を含める必要があります
entityPath

string

Service Bus 名前空間のキュー名
id

string

Service Bus キュー エンドポイントの ID
identity

ManagedIdentity

ルーティング サービス バス キュー エンドポイントのマネージド ID プロパティ。
name

string

このエンドポイントを識別する名前。 名前には英数字、ピリオド、アンダースコア、ハイフンのみを含めることができます。最大長は 64 文字です。 次の名前が予約されています: events、fileNotifications、$default。 エンドポイント名は、エンドポイントの種類間で一意である必要があります。 この名前は、実際のキュー名と同じである必要はありません。
resourceGroup

string

Service Bus キュー エンドポイントのリソース グループの名前。
subscriptionId

string

Service Bus キュー エンドポイントのサブスクリプション識別子。

RoutingServiceBusTopicEndpointProperties

Service Bus トピック エンドポイントの種類に関連するプロパティ。

名前 型 説明
authenticationType

authenticationType

Service Bus トピック エンドポイントに対する認証に使用されるメソッド
connectionString

string

Service Bus トピック エンドポイントの接続文字列。
endpointUri

string

Service Bus トピック エンドポイントの URL。 プロトコル sb:// を含める必要があります
entityPath

string

Service Bus トピックのキュー名
id

string

Service Bus トピック エンドポイントの ID
identity

ManagedIdentity

ルーティング サービス バス トピック エンドポイントのマネージド ID プロパティ。
name

string

このエンドポイントを識別する名前。 名前には英数字、ピリオド、アンダースコア、ハイフンのみを含めることができます。最大長は 64 文字です。 次の名前が予約されています: events、fileNotifications、$default。 エンドポイント名は、エンドポイントの種類間で一意である必要があります。 名前は、実際のトピック名と同じである必要はありません。
resourceGroup

string

Service Bus トピック エンドポイントのリソース グループの名前。
subscriptionId

string

Service Bus トピック エンドポイントのサブスクリプション識別子。

RoutingSource

ルーティング規則を適用するソース (DeviceMessages など)。

名前 型 説明
DeviceConnectionStateEvents

string

DeviceJobLifecycleEvents

string

DeviceLifecycleEvents

string

DeviceMessages

string

Invalid

string

TwinChangeEvents

string

RoutingStorageContainerProperties

ストレージ コンテナー エンドポイントに関連するプロパティ。

名前 型 説明
authenticationType

authenticationType

ストレージ エンドポイントに対する認証に使用されるメソッド
batchFrequencyInSeconds

integer

BLOB がストレージに書き込まれる時間間隔。 値は 60 ~ 720 秒にする必要があります。 既定値は 300 秒です。
connectionString

string

ストレージ アカウントの接続文字列。
containerName

string

ストレージ アカウント内のストレージ コンテナーの名前。
encoding enum:
  • Avro
  • AvroDeflate
  • JSON

メッセージを BLOB にシリアル化するために使用されるエンコード。 サポートされている値は、'avro'、'avrodeflate'、および 'JSON' です。 既定値は 'avro' です。
endpointUri

string

ストレージ エンドポイントの URL。 プロトコル https:// を含める必要があります
fileNameFormat

string

BLOB のファイル名の形式。 既定の形式は {iothub}/{partition}/{YYYY}/{MM}/{DD}/{HH}/{mm} です。 すべてのパラメーターは必須ですが、順序を変更できます。
id

string

ストレージ コンテナー エンドポイントの ID
identity

ManagedIdentity

ルーティング ストレージ エンドポイントのマネージド ID プロパティ。
maxChunkSizeInBytes

integer

ストレージに書き込まれる各 BLOB の最大バイト数。 値は、10485760(10 MB) から 524288000(500 MB) の間である必要があります。 既定値は 314572800(300 MB) です。
name

string

このエンドポイントを識別する名前。 名前には英数字、ピリオド、アンダースコア、ハイフンのみを含めることができます。最大長は 64 文字です。 次の名前が予約されています: events、fileNotifications、$default。 エンドポイント名は、エンドポイントの種類間で一意である必要があります。
resourceGroup

string

ストレージ アカウントのリソース グループの名前。
subscriptionId

string

ストレージ アカウントのサブスクリプション識別子。

SharedAccessSignatureAuthorizationRule

IoT ハブの共有アクセス ポリシーのプロパティ。

名前 型 説明
keyName

string

共有アクセス ポリシーの名前。
primaryKey

string

主キー。
rights

AccessRights

共有アクセス ポリシーに割り当てられたアクセス許可。
secondaryKey

string

セカンダリ キー。

StorageEndpointProperties

ファイルアップロード用の Azure Storage エンドポイントのプロパティ。

名前 型 説明
authenticationType

AuthenticationType

ストレージ アカウントへの接続に使用される認証の種類を指定します。
connectionString

string

ファイルがアップロードされる Azure Storage アカウントの接続文字列。
containerName

string

ファイルをアップロードするルート コンテナーの名前。 コンテナーは存在する必要はありませんが、指定された connectionString を使用して作成できる必要があります。
identity

ManagedIdentity

ファイルアップロード用のストレージ エンドポイントのマネージド ID プロパティ。
sasTtlAsIso8601

string

ファイルアップロードのIoT Hubによって生成された SAS URI が有効な期間。 https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload#file-upload-notification-configuration-options をご覧ください。

systemData

リソースの作成と最後の変更に関連するメタデータ。

名前 型 説明
createdAt

string

リソース作成のタイムスタンプ (UTC)。
createdBy

string

リソースを作成した ID。
createdByType

createdByType

リソースを作成した ID の種類。
lastModifiedAt

string

リソースの最終変更のタイムスタンプ (UTC)
lastModifiedBy

string

リソースを最後に変更した ID。
lastModifiedByType

createdByType

リソースを最後に変更した ID の種類。