Microsoft.Devices IotHubs 2016-02-03
- 最新
- 2023-06-30
- 2023-06-30-preview
- 2022-11-15-preview
- 2022-04-30-preview
- 2021-07-02
- 2021-07-02-preview
- 2021-07-01
- 2021-07-01-preview
- 2021-03-31
- 2021-03-03-preview
- 2021-02-01-preview
- 2020-08-31
- 2020-08-31-preview
- 2020-08-01
- 2020-07-10-preview
- 2020-06-15
- 2020-04-01
- 2020-03-01
- 2019-11-04
- 2019-07-01-preview
- 2019-03-22
- 2019-03-22-preview
- 2018-12-01-preview
- 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@2016-02-03' = {
etag: 'string'
location: 'string'
name: 'string'
properties: {
authorizationPolicies: [
{
keyName: 'string'
primaryKey: 'string'
rights: 'string'
secondaryKey: 'string'
}
]
cloudToDevice: {
defaultTtlAsIso8601: 'string'
feedback: {
lockDurationAsIso8601: 'string'
maxDeliveryCount: int
ttlAsIso8601: 'string'
}
maxDeliveryCount: int
}
comments: 'string'
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'
}
}
operationsMonitoringProperties: {
events: {
{customized property}: 'string'
}
}
storageEndpoints: {
{customized property}: {
connectionString: 'string'
containerName: 'string'
sasTtlAsIso8601: 'string'
}
}
}
resourcegroup: 'string'
sku: {
capacity: int
name: 'string'
}
subscriptionid: 'string'
tags: {
{customized property}: 'string'
}
}
屬性值
CloudToDeviceProperties
名字 | 描述 | 價值 |
---|---|---|
defaultTtlAsIso8601 | 裝置佇列中雲端到裝置訊息的預設存留時間。 請參閱:/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages。 | 字串 |
反饋 | 雲端到裝置訊息的意見反應佇列屬性。 | FeedbackProperties |
maxDeliveryCount | 裝置佇列中雲端到裝置訊息的傳遞計數上限。 請參閱:/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages。 | int 約束: 最小值 = 1 最大值 = 100 |
EventHubProperties
名字 | 描述 | 價值 |
---|---|---|
partitionCount | 在事件中樞相容端點中接收裝置到雲端訊息的數據分割數目。 請參閱:/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 |
FeedbackProperties
名字 | 描述 | 價值 |
---|---|---|
lockDurationAsIso8601 | 意見反應佇列的鎖定持續時間。 請參閱:/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages。 | 字串 |
maxDeliveryCount | 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。 | 字串 |
IotHubProperties
名字 | 描述 | 價值 |
---|---|---|
authorizationPolicies | 您可以用來保護IoT中樞連線的共用存取原則。 | SharedAccessSignatureAuthorizationRule[] |
cloudToDevice | IoT 中樞雲端到裝置傳訊屬性。 | CloudToDeviceProperties |
評論 | 評論。 | 字串 |
enableFileUploadNotifications | 如果為 True,則會啟用檔案上傳通知。 | bool |
eventHubEndpoints | 事件中樞相容的端點屬性。 此字典的可能索引鍵是事件和 operationsMonitoringEvents。 這兩個索引鍵都必須存在於字典中,同時建立或更新IoT中樞的呼叫。 | IotHubPropertiesEventHubEndpoints |
特徵 | 針對IoT中樞啟用的功能和功能。 | 'DeviceManagement' 'None' |
ipFilterRules | IP 篩選規則。 | IpFilterRule[] |
messagingEndpoints | 檔案上傳通知佇列的傳訊端點屬性。 | IotHubPropertiesMessagingEndpoints |
operationsMonitoringProperties | IoT 中樞的作業監視屬性。 字典的可能索引鍵包括 Connections、DeviceTelemetry、C2DCommands、DeviceIdentityOperations、FileUploadOperations。 | OperationsMonitoringProperties |
storageEndpoints | 您可以在其中上傳檔案的 Azure 記憶體端點清單。 目前您只能設定一個 Azure 記憶體帳戶,且必須將其密鑰設定為$default。 指定多個記憶體帳戶會導致擲回錯誤。 當 enableFileUploadNotifications 屬性設定為 True 時,未指定此屬性的值,會導致擲回錯誤。 | IotHubPropertiesStorageEndpoints |
IotHubPropertiesEventHubEndpoints
名字 | 描述 | 價值 |
---|
IotHubPropertiesMessagingEndpoints
名字 | 描述 | 價值 |
---|
IotHubPropertiesStorageEndpoints
名字 | 描述 | 價值 |
---|
IotHubSkuInfo
名字 | 描述 | 價值 |
---|---|---|
能力 | 布建的IoT中樞單位數目。 請參閱:/azure/azure-subscription-service-limits#iot-hub-limits。 | int (必要) |
名字 | SKU 的名稱。 | 'F1' 'S1' 'S2' 'S3' (必要) |
IpFilterRule
名字 | 描述 | 價值 |
---|---|---|
行動 | 此規則所擷取要求所需的動作。 | 'Accept' '拒絕' (必要) |
filterName | IP 篩選規則的名稱。 | 字串 (必要) |
ipMask | 字串,包含規則之 CIDR 表示法中的 IP 位址範圍。 | 字串 (必要) |
MessagingEndpointProperties
名字 | 描述 | 價值 |
---|---|---|
lockDurationAsIso8601 | 鎖定持續時間。 請參閱:/azure/iot-hub/iot-hub-devguide-file-upload。 | 字串 |
maxDeliveryCount | IoT 中樞嘗試傳遞訊息的次數。 請參閱:/azure/iot-hub/iot-hub-devguide-file-upload。 | int 約束: 最小值 = 1 最大值 = 100 |
ttlAsIso8601 | 訊息在IoT中樞過期之前可供取用的期間。 請參閱:/azure/iot-hub/iot-hub-devguide-file-upload。 | 字串 |
Microsoft.Devices/IotHubs
名字 | 描述 | 價值 |
---|---|---|
etag | Etag 欄位 不需要。 如果在響應主體中提供,則也必須根據一般 ETag 慣例提供它作為標頭。 | 字串 |
位置 | 資源位置。 | 字串 (必要) |
名字 | 資源名稱 | 字串 (必要) |
性能 | IoT 中樞的屬性。 | IotHubProperties |
resourcegroup | 包含IoT中樞的資源群組名稱。 資源組名可唯一識別訂用帳戶內的資源群組。 | 字串 (必要) |
sku | IoT 中樞 SKU 的相關信息。 | IotHubSkuInfo (必要) |
subscriptionid | 訂用帳戶標識碼。 | 字串 (必要) |
標籤 | 資源標籤 | 標記名稱和值的字典。 請參閱範本中的 標籤 |
OperationsMonitoringProperties
名字 | 描述 | 價值 |
---|---|---|
事件 | <OperationMonitoringLevel> 字典 | OperationsMonitoringPropertiesEvents |
OperationsMonitoringPropertiesEvents
名字 | 描述 | 價值 |
---|
ResourceTags
名字 | 描述 | 價值 |
---|
SharedAccessSignatureAuthorizationRule
名字 | 描述 | 價值 |
---|---|---|
keyName | 共用存取原則的名稱。 | 字串 (必要) |
primaryKey | 主鍵。 | 字串 |
權利 | 指派給共用存取原則的許可權。 | 'DeviceConnect' 'RegistryRead' 'RegistryRead, DeviceConnect' 'RegistryRead, RegistryWrite' 'RegistryRead, RegistryWrite, DeviceConnect' 'RegistryRead, RegistryWrite, ServiceConnect' 'RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect' 'RegistryRead, ServiceConnect' 'RegistryRead, ServiceConnect, DeviceConnect' 'RegistryWrite' 'RegistryWrite, DeviceConnect' 'RegistryWrite, ServiceConnect' 'RegistryWrite, ServiceConnect, DeviceConnect' 'ServiceConnect' 'ServiceConnect, DeviceConnect' (必要) |
secondaryKey | 次要金鑰。 | 字串 |
StorageEndpointProperties
名字 | 描述 | 價值 |
---|---|---|
connectionString | 上傳檔案之 Azure 記憶體帳戶的連接字串。 | 字串 (必要) |
containerName | 您上傳檔案的根容器名稱。 容器不需要存在,但應該使用指定的 connectionString 來建立。 | 字串 (必要) |
sasTtlAsIso8601 | IoT 中樞針對檔案上傳所產生的SAS URI有效期間。 請參閱:/azure/iot-hub/iot-hub-devguide-file-upload#file-upload-notification-configuration-options。 | 字串 |
快速入門範例
下列快速入門範例會部署此資源類型。
Bicep 檔案 | 描述 |
---|---|
建立IoT中樞和裝置至雲端取用者群組 | 此範本可讓您將裝置部署到雲端和雲端的IoT中樞實例,以將裝置傳訊組態和裝置部署到雲端取用者群組。 |
建立IoT中樞裝置布建服務 | 此範本可讓您建立IoT中樞和IoT中樞裝置布建服務,並將這兩個服務連結在一起。 |
建立IoT中樞帳戶、實例、IoT 中樞 的裝置更新 | 此範本會建立帳戶,以及實例和中樞來鏈接實例。 它會使用必要的存取原則、路由和取用者群組來設定中樞。 |
部署 MedTech 服務,包括 Azure IoT 中樞 | MedTech 服務是 Azure Health Data Services 的其中一個,其設計目的是從多個裝置內嵌裝置數據,將裝置數據轉換成 FHIR 觀察,然後保存在 Azure Health Data Services FHIR 服務中。 |
使用ARM範本建立IoT中樞、路由和檢視訊息 | 使用此範本來部署IoT中樞和記憶體帳戶。 執行應用程式以將訊息傳送至路由傳送至記憶體的中樞,然後檢視結果。 |
ARM 樣本資源定義
IotHubs 資源類型可以使用目標作業來部署:
- 資源群組 - 請參閱 資源群組部署命令
如需每個 API 版本中已變更屬性的清單,請參閱 變更記錄檔。
資源格式
若要建立 Microsoft.Devices/IotHubs 資源,請將下列 JSON 新增至範本。
{
"type": "Microsoft.Devices/IotHubs",
"apiVersion": "2016-02-03",
"name": "string",
"etag": "string",
"location": "string",
"properties": {
"authorizationPolicies": [
{
"keyName": "string",
"primaryKey": "string",
"rights": "string",
"secondaryKey": "string"
}
],
"cloudToDevice": {
"defaultTtlAsIso8601": "string",
"feedback": {
"lockDurationAsIso8601": "string",
"maxDeliveryCount": "int",
"ttlAsIso8601": "string"
},
"maxDeliveryCount": "int"
},
"comments": "string",
"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"
}
},
"operationsMonitoringProperties": {
"events": {
"{customized property}": "string"
}
},
"storageEndpoints": {
"{customized property}": {
"connectionString": "string",
"containerName": "string",
"sasTtlAsIso8601": "string"
}
}
},
"resourcegroup": "string",
"sku": {
"capacity": "int",
"name": "string"
},
"subscriptionid": "string",
"tags": {
"{customized property}": "string"
}
}
屬性值
CloudToDeviceProperties
名字 | 描述 | 價值 |
---|---|---|
defaultTtlAsIso8601 | 裝置佇列中雲端到裝置訊息的預設存留時間。 請參閱:/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages。 | 字串 |
反饋 | 雲端到裝置訊息的意見反應佇列屬性。 | FeedbackProperties |
maxDeliveryCount | 裝置佇列中雲端到裝置訊息的傳遞計數上限。 請參閱:/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages。 | int 約束: 最小值 = 1 最大值 = 100 |
EventHubProperties
名字 | 描述 | 價值 |
---|---|---|
partitionCount | 在事件中樞相容端點中接收裝置到雲端訊息的數據分割數目。 請參閱:/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 |
FeedbackProperties
名字 | 描述 | 價值 |
---|---|---|
lockDurationAsIso8601 | 意見反應佇列的鎖定持續時間。 請參閱:/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages。 | 字串 |
maxDeliveryCount | 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。 | 字串 |
IotHubProperties
名字 | 描述 | 價值 |
---|---|---|
authorizationPolicies | 您可以用來保護IoT中樞連線的共用存取原則。 | SharedAccessSignatureAuthorizationRule[] |
cloudToDevice | IoT 中樞雲端到裝置傳訊屬性。 | CloudToDeviceProperties |
評論 | 評論。 | 字串 |
enableFileUploadNotifications | 如果為 True,則會啟用檔案上傳通知。 | bool |
eventHubEndpoints | 事件中樞相容的端點屬性。 此字典的可能索引鍵是事件和 operationsMonitoringEvents。 這兩個索引鍵都必須存在於字典中,同時建立或更新IoT中樞的呼叫。 | IotHubPropertiesEventHubEndpoints |
特徵 | 針對IoT中樞啟用的功能和功能。 | 'DeviceManagement' 'None' |
ipFilterRules | IP 篩選規則。 | IpFilterRule[] |
messagingEndpoints | 檔案上傳通知佇列的傳訊端點屬性。 | IotHubPropertiesMessagingEndpoints |
operationsMonitoringProperties | IoT 中樞的作業監視屬性。 字典的可能索引鍵包括 Connections、DeviceTelemetry、C2DCommands、DeviceIdentityOperations、FileUploadOperations。 | OperationsMonitoringProperties |
storageEndpoints | 您可以在其中上傳檔案的 Azure 記憶體端點清單。 目前您只能設定一個 Azure 記憶體帳戶,且必須將其密鑰設定為$default。 指定多個記憶體帳戶會導致擲回錯誤。 當 enableFileUploadNotifications 屬性設定為 True 時,未指定此屬性的值,會導致擲回錯誤。 | IotHubPropertiesStorageEndpoints |
IotHubPropertiesEventHubEndpoints
名字 | 描述 | 價值 |
---|
IotHubPropertiesMessagingEndpoints
名字 | 描述 | 價值 |
---|
IotHubPropertiesStorageEndpoints
名字 | 描述 | 價值 |
---|
IotHubSkuInfo
名字 | 描述 | 價值 |
---|---|---|
能力 | 布建的IoT中樞單位數目。 請參閱:/azure/azure-subscription-service-limits#iot-hub-limits。 | int (必要) |
名字 | SKU 的名稱。 | 'F1' 'S1' 'S2' 'S3' (必要) |
IpFilterRule
名字 | 描述 | 價值 |
---|---|---|
行動 | 此規則所擷取要求所需的動作。 | 'Accept' '拒絕' (必要) |
filterName | IP 篩選規則的名稱。 | 字串 (必要) |
ipMask | 字串,包含規則之 CIDR 表示法中的 IP 位址範圍。 | 字串 (必要) |
MessagingEndpointProperties
名字 | 描述 | 價值 |
---|---|---|
lockDurationAsIso8601 | 鎖定持續時間。 請參閱:/azure/iot-hub/iot-hub-devguide-file-upload。 | 字串 |
maxDeliveryCount | IoT 中樞嘗試傳遞訊息的次數。 請參閱:/azure/iot-hub/iot-hub-devguide-file-upload。 | int 約束: 最小值 = 1 最大值 = 100 |
ttlAsIso8601 | 訊息在IoT中樞過期之前可供取用的期間。 請參閱:/azure/iot-hub/iot-hub-devguide-file-upload。 | 字串 |
Microsoft.Devices/IotHubs
名字 | 描述 | 價值 |
---|---|---|
apiVersion | API 版本 | '2016-02-03' |
etag | Etag 欄位 不需要。 如果在響應主體中提供,則也必須根據一般 ETag 慣例提供它作為標頭。 | 字串 |
位置 | 資源位置。 | 字串 (必要) |
名字 | 資源名稱 | 字串 (必要) |
性能 | IoT 中樞的屬性。 | IotHubProperties |
resourcegroup | 包含IoT中樞的資源群組名稱。 資源組名可唯一識別訂用帳戶內的資源群組。 | 字串 (必要) |
sku | IoT 中樞 SKU 的相關信息。 | IotHubSkuInfo (必要) |
subscriptionid | 訂用帳戶標識碼。 | 字串 (必要) |
標籤 | 資源標籤 | 標記名稱和值的字典。 請參閱範本中的 標籤 |
類型 | 資源類型 | 'Microsoft.Devices/IotHubs' |
OperationsMonitoringProperties
名字 | 描述 | 價值 |
---|---|---|
事件 | <OperationMonitoringLevel> 字典 | OperationsMonitoringPropertiesEvents |
OperationsMonitoringPropertiesEvents
名字 | 描述 | 價值 |
---|
ResourceTags
名字 | 描述 | 價值 |
---|
SharedAccessSignatureAuthorizationRule
名字 | 描述 | 價值 |
---|---|---|
keyName | 共用存取原則的名稱。 | 字串 (必要) |
primaryKey | 主鍵。 | 字串 |
權利 | 指派給共用存取原則的許可權。 | 'DeviceConnect' 'RegistryRead' 'RegistryRead, DeviceConnect' 'RegistryRead, RegistryWrite' 'RegistryRead, RegistryWrite, DeviceConnect' 'RegistryRead, RegistryWrite, ServiceConnect' 'RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect' 'RegistryRead, ServiceConnect' 'RegistryRead, ServiceConnect, DeviceConnect' 'RegistryWrite' 'RegistryWrite, DeviceConnect' 'RegistryWrite, ServiceConnect' 'RegistryWrite, ServiceConnect, DeviceConnect' 'ServiceConnect' 'ServiceConnect, DeviceConnect' (必要) |
secondaryKey | 次要金鑰。 | 字串 |
StorageEndpointProperties
名字 | 描述 | 價值 |
---|---|---|
connectionString | 上傳檔案之 Azure 記憶體帳戶的連接字串。 | 字串 (必要) |
containerName | 您上傳檔案的根容器名稱。 容器不需要存在,但應該使用指定的 connectionString 來建立。 | 字串 (必要) |
sasTtlAsIso8601 | IoT 中樞針對檔案上傳所產生的SAS URI有效期間。 請參閱:/azure/iot-hub/iot-hub-devguide-file-upload#file-upload-notification-configuration-options。 | 字串 |
快速入門範本
下列快速入門範本會部署此資源類型。
範本 | 描述 |
---|---|
使用IoT中樞建立隨用隨付環境 |
此範本可讓您部署已設定為取用 IoT 中樞事件的隨用隨付時間序列深入解析環境。 |
建立IoT中樞和裝置至雲端取用者群組 |
此範本可讓您將裝置部署到雲端和雲端的IoT中樞實例,以將裝置傳訊組態和裝置部署到雲端取用者群組。 |
建立 IOT 中樞和 Ubuntu 邊緣模擬器 |
此範本會建立 IOT 中樞和虛擬機 Ubuntu 邊緣模擬器。 |
建立IoT中樞裝置布建服務 |
此範本可讓您建立IoT中樞和IoT中樞裝置布建服務,並將這兩個服務連結在一起。 |
建立IoT中樞帳戶、實例、IoT 中樞 的裝置更新 |
此範本會建立帳戶,以及實例和中樞來鏈接實例。 它會使用必要的存取原則、路由和取用者群組來設定中樞。 |
部署 MedTech 服務,包括 Azure IoT 中樞 |
MedTech 服務是 Azure Health Data Services 的其中一個,其設計目的是從多個裝置內嵌裝置數據,將裝置數據轉換成 FHIR 觀察,然後保存在 Azure Health Data Services FHIR 服務中。 |
使用ARM範本建立IoT中樞、路由和檢視訊息 |
使用此範本來部署IoT中樞和記憶體帳戶。 執行應用程式以將訊息傳送至路由傳送至記憶體的中樞,然後檢視結果。 |
Terraform (AzAPI 提供者) 資源定義
IotHubs 資源類型可以使用目標作業來部署:
- 資源群組
如需每個 API 版本中已變更屬性的清單,請參閱 變更記錄檔。
資源格式
若要建立 Microsoft.Devices/IotHubs 資源,請將下列 Terraform 新增至範本。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Devices/IotHubs@2016-02-03"
name = "string"
etag = "string"
location = "string"
resourcegroup = "string"
sku = {
capacity = int
name = "string"
}
subscriptionid = "string"
tags = {
{customized property} = "string"
}
body = jsonencode({
properties = {
authorizationPolicies = [
{
keyName = "string"
primaryKey = "string"
rights = "string"
secondaryKey = "string"
}
]
cloudToDevice = {
defaultTtlAsIso8601 = "string"
feedback = {
lockDurationAsIso8601 = "string"
maxDeliveryCount = int
ttlAsIso8601 = "string"
}
maxDeliveryCount = int
}
comments = "string"
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"
}
}
operationsMonitoringProperties = {
events = {
{customized property} = "string"
}
}
storageEndpoints = {
{customized property} = {
connectionString = "string"
containerName = "string"
sasTtlAsIso8601 = "string"
}
}
}
})
}
屬性值
CloudToDeviceProperties
名字 | 描述 | 價值 |
---|---|---|
defaultTtlAsIso8601 | 裝置佇列中雲端到裝置訊息的預設存留時間。 請參閱:/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages。 | 字串 |
反饋 | 雲端到裝置訊息的意見反應佇列屬性。 | FeedbackProperties |
maxDeliveryCount | 裝置佇列中雲端到裝置訊息的傳遞計數上限。 請參閱:/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages。 | int 約束: 最小值 = 1 最大值 = 100 |
EventHubProperties
名字 | 描述 | 價值 |
---|---|---|
partitionCount | 在事件中樞相容端點中接收裝置到雲端訊息的數據分割數目。 請參閱:/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 |
FeedbackProperties
名字 | 描述 | 價值 |
---|---|---|
lockDurationAsIso8601 | 意見反應佇列的鎖定持續時間。 請參閱:/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages。 | 字串 |
maxDeliveryCount | 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。 | 字串 |
IotHubProperties
名字 | 描述 | 價值 |
---|---|---|
authorizationPolicies | 您可以用來保護IoT中樞連線的共用存取原則。 | SharedAccessSignatureAuthorizationRule[] |
cloudToDevice | IoT 中樞雲端到裝置傳訊屬性。 | CloudToDeviceProperties |
評論 | 評論。 | 字串 |
enableFileUploadNotifications | 如果為 True,則會啟用檔案上傳通知。 | bool |
eventHubEndpoints | 事件中樞相容的端點屬性。 此字典的可能索引鍵是事件和 operationsMonitoringEvents。 這兩個索引鍵都必須存在於字典中,同時建立或更新IoT中樞的呼叫。 | IotHubPropertiesEventHubEndpoints |
特徵 | 針對IoT中樞啟用的功能和功能。 | 'DeviceManagement' 'None' |
ipFilterRules | IP 篩選規則。 | IpFilterRule[] |
messagingEndpoints | 檔案上傳通知佇列的傳訊端點屬性。 | IotHubPropertiesMessagingEndpoints |
operationsMonitoringProperties | IoT 中樞的作業監視屬性。 字典的可能索引鍵包括 Connections、DeviceTelemetry、C2DCommands、DeviceIdentityOperations、FileUploadOperations。 | OperationsMonitoringProperties |
storageEndpoints | 您可以在其中上傳檔案的 Azure 記憶體端點清單。 目前您只能設定一個 Azure 記憶體帳戶,且必須將其密鑰設定為$default。 指定多個記憶體帳戶會導致擲回錯誤。 當 enableFileUploadNotifications 屬性設定為 True 時,未指定此屬性的值,會導致擲回錯誤。 | IotHubPropertiesStorageEndpoints |
IotHubPropertiesEventHubEndpoints
名字 | 描述 | 價值 |
---|
IotHubPropertiesMessagingEndpoints
名字 | 描述 | 價值 |
---|
IotHubPropertiesStorageEndpoints
名字 | 描述 | 價值 |
---|
IotHubSkuInfo
名字 | 描述 | 價值 |
---|---|---|
能力 | 布建的IoT中樞單位數目。 請參閱:/azure/azure-subscription-service-limits#iot-hub-limits。 | int (必要) |
名字 | SKU 的名稱。 | 'F1' 'S1' 'S2' 'S3' (必要) |
IpFilterRule
名字 | 描述 | 價值 |
---|---|---|
行動 | 此規則所擷取要求所需的動作。 | 'Accept' '拒絕' (必要) |
filterName | IP 篩選規則的名稱。 | 字串 (必要) |
ipMask | 字串,包含規則之 CIDR 表示法中的 IP 位址範圍。 | 字串 (必要) |
MessagingEndpointProperties
名字 | 描述 | 價值 |
---|---|---|
lockDurationAsIso8601 | 鎖定持續時間。 請參閱:/azure/iot-hub/iot-hub-devguide-file-upload。 | 字串 |
maxDeliveryCount | IoT 中樞嘗試傳遞訊息的次數。 請參閱:/azure/iot-hub/iot-hub-devguide-file-upload。 | int 約束: 最小值 = 1 最大值 = 100 |
ttlAsIso8601 | 訊息在IoT中樞過期之前可供取用的期間。 請參閱:/azure/iot-hub/iot-hub-devguide-file-upload。 | 字串 |
Microsoft.Devices/IotHubs
名字 | 描述 | 價值 |
---|---|---|
etag | Etag 欄位 不需要。 如果在響應主體中提供,則也必須根據一般 ETag 慣例提供它作為標頭。 | 字串 |
位置 | 資源位置。 | 字串 (必要) |
名字 | 資源名稱 | 字串 (必要) |
性能 | IoT 中樞的屬性。 | IotHubProperties |
resourcegroup | 包含IoT中樞的資源群組名稱。 資源組名可唯一識別訂用帳戶內的資源群組。 | 字串 (必要) |
sku | IoT 中樞 SKU 的相關信息。 | IotHubSkuInfo (必要) |
subscriptionid | 訂用帳戶標識碼。 | 字串 (必要) |
標籤 | 資源標籤 | 標記名稱和值的字典。 |
類型 | 資源類型 | “Microsoft.Devices/IotHubs@2016-02-03” |
OperationsMonitoringProperties
名字 | 描述 | 價值 |
---|---|---|
事件 | <OperationMonitoringLevel> 字典 | OperationsMonitoringPropertiesEvents |
OperationsMonitoringPropertiesEvents
名字 | 描述 | 價值 |
---|
ResourceTags
名字 | 描述 | 價值 |
---|
SharedAccessSignatureAuthorizationRule
名字 | 描述 | 價值 |
---|---|---|
keyName | 共用存取原則的名稱。 | 字串 (必要) |
primaryKey | 主鍵。 | 字串 |
權利 | 指派給共用存取原則的許可權。 | 'DeviceConnect' 'RegistryRead' 'RegistryRead, DeviceConnect' 'RegistryRead, RegistryWrite' 'RegistryRead, RegistryWrite, DeviceConnect' 'RegistryRead, RegistryWrite, ServiceConnect' 'RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect' 'RegistryRead, ServiceConnect' 'RegistryRead, ServiceConnect, DeviceConnect' 'RegistryWrite' 'RegistryWrite, DeviceConnect' 'RegistryWrite, ServiceConnect' 'RegistryWrite, ServiceConnect, DeviceConnect' 'ServiceConnect' 'ServiceConnect, DeviceConnect' (必要) |
secondaryKey | 次要金鑰。 | 字串 |
StorageEndpointProperties
名字 | 描述 | 價值 |
---|---|---|
connectionString | 上傳檔案之 Azure 記憶體帳戶的連接字串。 | 字串 (必要) |
containerName | 您上傳檔案的根容器名稱。 容器不需要存在,但應該使用指定的 connectionString 來建立。 | 字串 (必要) |
sasTtlAsIso8601 | IoT 中樞針對檔案上傳所產生的SAS URI有效期間。 請參閱:/azure/iot-hub/iot-hub-devguide-file-upload#file-upload-notification-configuration-options。 | 字串 |