IotHubProperties interface
IoT ハブのプロパティ。
プロパティ
| allowed |
IoT Hub からのエグレスで許可される FQDN (完全修飾ドメイン名) の一覧。 |
| authorization |
IoT ハブへの接続をセキュリティで保護するために使用できる共有アクセス ポリシー。 |
| cloud |
IoT Hub のクラウドからデバイスへのメッセージング プロパティ。 |
| comments | IoT Hub のコメント。 |
| disable |
true の場合、すべてのデバイス (Edge デバイスを含むがモジュールを除く) スコープ SAS キーは認証に使用できません。 |
| disable |
true の場合、IoT ハブ スコープの SAS キーを持つ SAS トークンは認証に使用できません。 |
| disable |
true の場合、すべてのモジュール スコープ SAS キーを認証に使用できません。 |
| enable |
このプロパティを true に設定すると、データ所在地が有効になり、ディザスター リカバリーが無効になります。 |
| enable |
True の場合、ファイルのアップロード通知が有効になります。 |
| event |
Event Hub と互換性のあるエンドポイントのプロパティ。 このディクショナリに使用できる唯一のキーはイベントです。 このキーは、IoT ハブの作成または更新呼び出しを行う際にディクショナリに存在する必要があります。 |
| features | IoT ハブで有効になっている機能。 |
| host |
ホストの名前。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。 |
| ip |
IP フィルター規則。 |
| locations | IoT ハブのプライマリとセカンダリの場所注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。 |
| messaging |
ファイル アップロード通知キューのメッセージング エンドポイントプロパティ。 |
| min |
このハブをサポートする TLS の最小バージョンを指定します。 1.2 より前の TLS バージョンを使用するクライアントを拒否するには、"1.2" に設定できます。 |
| network |
IotHub のネットワーク ルール セットプロパティ |
| private |
この IotHub で作成されたプライベート エンドポイント接続 |
| provisioning |
プロビジョニングの状態。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。 |
| public |
パブリック ネットワークからの要求が許可されるかどうか |
| restrict |
true の場合、IotHub からのエグレスは、allowedFqdnList 経由で構成されている許可された FQDN のみに制限されます。 |
| routing | IoT ハブのルーティング関連のプロパティ。 参照: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging |
| state | ハブの状態。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。 |
| storage |
ファイルをアップロードできる Azure Storage エンドポイントの一覧。 現在、構成できる Azure Storage アカウントは 1 つだけであり、そのキーを$defaultにする必要があります。 複数のストレージ アカウントを指定すると、エラーがスローされます。 enableFileUploadNotifications プロパティが True に設定されている場合、このプロパティの値を指定しないと、エラーがスローされます。 |
プロパティの詳細
allowedFqdnList
IoT Hub からのエグレスで許可される FQDN (完全修飾ドメイン名) の一覧。
allowedFqdnList?: string[]
プロパティ値
string[]
authorizationPolicies
IoT ハブへの接続をセキュリティで保護するために使用できる共有アクセス ポリシー。
authorizationPolicies?: SharedAccessSignatureAuthorizationRule[]
プロパティ値
cloudToDevice
IoT Hub のクラウドからデバイスへのメッセージング プロパティ。
cloudToDevice?: CloudToDeviceProperties
プロパティ値
comments
IoT Hub のコメント。
comments?: string
プロパティ値
string
disableDeviceSAS
true の場合、すべてのデバイス (Edge デバイスを含むがモジュールを除く) スコープ SAS キーは認証に使用できません。
disableDeviceSAS?: boolean
プロパティ値
boolean
disableLocalAuth
true の場合、IoT ハブ スコープの SAS キーを持つ SAS トークンは認証に使用できません。
disableLocalAuth?: boolean
プロパティ値
boolean
disableModuleSAS
true の場合、すべてのモジュール スコープ SAS キーを認証に使用できません。
disableModuleSAS?: boolean
プロパティ値
boolean
enableDataResidency
このプロパティを true に設定すると、データ所在地が有効になり、ディザスター リカバリーが無効になります。
enableDataResidency?: boolean
プロパティ値
boolean
enableFileUploadNotifications
True の場合、ファイルのアップロード通知が有効になります。
enableFileUploadNotifications?: boolean
プロパティ値
boolean
eventHubEndpoints
Event Hub と互換性のあるエンドポイントのプロパティ。 このディクショナリに使用できる唯一のキーはイベントです。 このキーは、IoT ハブの作成または更新呼び出しを行う際にディクショナリに存在する必要があります。
eventHubEndpoints?: {[propertyName: string]: EventHubProperties}
プロパティ値
{[propertyName: string]: EventHubProperties}
features
IoT ハブで有効になっている機能。
features?: string
プロパティ値
string
hostName
ホストの名前。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
hostName?: string
プロパティ値
string
ipFilterRules
locations
IoT ハブのプライマリとセカンダリの場所注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
locations?: IotHubLocationDescription[]
プロパティ値
messagingEndpoints
ファイル アップロード通知キューのメッセージング エンドポイントプロパティ。
messagingEndpoints?: {[propertyName: string]: MessagingEndpointProperties}
プロパティ値
{[propertyName: string]: MessagingEndpointProperties}
minTlsVersion
このハブをサポートする TLS の最小バージョンを指定します。 1.2 より前の TLS バージョンを使用するクライアントを拒否するには、"1.2" に設定できます。
minTlsVersion?: string
プロパティ値
string
networkRuleSets
IotHub のネットワーク ルール セットプロパティ
networkRuleSets?: NetworkRuleSetProperties
プロパティ値
privateEndpointConnections
この IotHub で作成されたプライベート エンドポイント接続
privateEndpointConnections?: PrivateEndpointConnection[]
プロパティ値
provisioningState
プロビジョニングの状態。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
provisioningState?: string
プロパティ値
string
publicNetworkAccess
パブリック ネットワークからの要求が許可されるかどうか
publicNetworkAccess?: string
プロパティ値
string
restrictOutboundNetworkAccess
true の場合、IotHub からのエグレスは、allowedFqdnList 経由で構成されている許可された FQDN のみに制限されます。
restrictOutboundNetworkAccess?: boolean
プロパティ値
boolean
routing
IoT ハブのルーティング関連のプロパティ。 参照: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging
routing?: RoutingProperties
プロパティ値
state
ハブの状態。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
state?: string
プロパティ値
string
storageEndpoints
ファイルをアップロードできる Azure Storage エンドポイントの一覧。 現在、構成できる Azure Storage アカウントは 1 つだけであり、そのキーを$defaultにする必要があります。 複数のストレージ アカウントを指定すると、エラーがスローされます。 enableFileUploadNotifications プロパティが True に設定されている場合、このプロパティの値を指定しないと、エラーがスローされます。
storageEndpoints?: {[propertyName: string]: StorageEndpointProperties}
プロパティ値
{[propertyName: string]: StorageEndpointProperties}