Microsoft.Devices IotHubs 2022-11-15-preview

• 最新
• 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@2022-11-15-preview' = {
  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'
    deviceStreams: {
      streamingEndpoints: [
        'string'
      ]
    }
    disableDeviceSAS: bool
    disableLocalAuth: bool
    disableModuleSAS: bool
    enableDataResidency: bool
    enableFileUploadNotifications: bool
    encryption: {
      keySource: 'string'
      keyVaultProperties: [
        {
          identity: {
            userAssignedIdentity: 'string'
          }
          keyIdentifier: 'string'
        }
      ]
    }
    eventHubEndpoints: {
      {customized property}: {
        partitionCount: int
        retentionTimeInDays: int
      }
    }
    features: 'string'
    ipFilterRules: [
      {
        action: 'string'
        filterName: 'string'
        ipMask: 'string'
      }
    ]
    ipVersion: '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
    rootCertificate: {
      enableRootCertificateV2: bool
    }
    routing: {
      endpoints: {
        cosmosDBSqlCollections: [
          {
            authenticationType: 'string'
            collectionName: 'string'
            databaseName: 'string'
            endpointUri: 'string'
            id: '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'
  }
}

屬性值

ArmIdentity

名字	描述	價值
類型	用於資源的身分識別類型。 類型 'SystemAssigned，UserAssigned' 包含隱含建立的身分識別和一組使用者指派的身分識別。 類型 『None』 會從服務中移除任何身分識別。	'None' 'SystemAssigned' 'SystemAssigned， UserAssigned' 'UserAssigned'
userAssignedIdentities	<ArmUserIdentity> 字典	ArmIdentityUserAssignedIdentities

ArmIdentityUserAssignedIdentities

名字	描述	價值

ArmUserIdentity

名字	描述	價值

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

EncryptionPropertiesDescription

名字	描述	價值
keySource	金鑰的來源。	字串
keyVaultProperties	KeyVault 金鑰的屬性。	KeyVaultKeyProperties[]

EnrichmentProperties

名字	描述	價值
endpointNames	擴充套用至訊息的端點清單。	string[] （必要）
鑰匙	擴充屬性的索引鍵或名稱。	字串 （必要）
價值	擴充屬性的值。	字串 （必要）

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

FallbackRouteProperties

名字	描述	價值
條件	評估要套用後援路由的條件。 如果未提供條件，則預設會評估為 true。 如需文法，請參閱：/azure/iot-hub/iot-hub-devguide-query-language	字串
endpointNames	符合條件的訊息會路由傳送至的端點清單。 目前只允許 1 個端點。	string[] （必要）
isEnabled	用來指定是否啟用後援路由。	布林 （必要）
名字	路由的名稱。 名稱只能包含英數位元、句號、底線、連字元，長度上限為64個字元，而且必須是唯一的。	字串
源	要套用路由規則的來源。 例如，DeviceMessages	'DeviceConnectionStateEvents' 'DeviceJobLifecycleEvents' 'DeviceLifecycleEvents' 'DeviceMessages' 'DigitalTwinChangeEvents' 'Invalid' 'MqttBrokerMessages' 'TwinChangeEvents' （必要）

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

名字	描述	價值
allowedFqdnList	允許從 Iot 中樞輸出的 FQDN（完整功能變數名稱）清單。	string[]
authorizationPolicies	您可以用來保護IoT中樞連線的共用存取原則。	SharedAccessSignatureAuthorizationRule[]
cloudToDevice	IoT 中樞雲端到裝置傳訊屬性。	CloudToDeviceProperties
評論	IoT 中樞批注。	字串
deviceStreams	裝置會串流 iothub 的屬性。	IotHubPropertiesDeviceStreams
disableDeviceSAS	如果為 true，則所有裝置（包括 Edge 裝置，但不包括模組）限定範圍的 SAS 金鑰都無法用於驗證。	bool
disableLocalAuth	如果為 true，則無法將具有 Iot 中樞範圍的 SAS 金鑰 SAS 令牌用於驗證。	bool
disableModuleSAS	如果為 true，則所有模組範圍的 SAS 金鑰都無法用於驗證。	bool
enableDataResidency	當設定為 true 時，這個屬性會啟用數據落地，因此會停用災害復原。	bool
enableFileUploadNotifications	如果為 True，則會啟用檔案上傳通知。	bool
加密	IoT 中樞的加密屬性。	EncryptionPropertiesDescription
eventHubEndpoints	事件中樞相容的端點屬性。 這個字典的唯一可能索引鍵是事件。 在建立或更新IoT中樞的呼叫時，此金鑰必須存在於字典中。	IotHubPropertiesEventHubEndpoints
特徵	針對IoT中樞啟用的功能和功能。	'DeviceManagement' 'None'
ipFilterRules	IP 篩選規則。	IpFilterRule[]
ipVersion	此屬性會指定中樞目前正在使用的IP版本。	'ipv4' 'ipv4ipv6' 'ipv6'
messagingEndpoints	檔案上傳通知佇列的傳訊端點屬性。	IotHubPropertiesMessagingEndpoints
minTlsVersion	指定要支援此中樞的最低 TLS 版本。 可以設定為 「1.2」 ，讓使用 1.2 以下 TLS 版本的用戶端遭到拒絕。	字串
networkRuleSets	IotHub 的網路規則集屬性	NetworkRuleSetProperties
privateEndpointConnections	在此IotHub上建立的私人端點連線	PrivateEndpointConnection[]
publicNetworkAccess	是否允許來自公用網路的要求	'Disabled' 'Enabled'
restrictOutboundNetworkAccess	如果為 true，則來自 IotHub 的輸出將僅限於透過 allowedFqdnList 設定的允許 FQDN。	bool
rootCertificate	此屬性會儲存跟證書相關信息	RootCertificateProperties
路由	IoT 中樞的路由相關屬性。 請參閱：/azure/iot-hub/iot-hub-devguide-messaging	RoutingProperties
storageEndpoints	您可以在其中上傳檔案的 Azure 記憶體端點清單。 目前您只能設定一個 Azure 記憶體帳戶，且必須將其密鑰設定為$default。 指定多個記憶體帳戶會導致擲回錯誤。 當 enableFileUploadNotifications 屬性設定為 True 時，未指定此屬性的值，會導致擲回錯誤。	IotHubPropertiesStorageEndpoints

IotHubPropertiesDeviceStreams

名字	描述	價值
streamingEndpoints	裝置串流端點的清單。	string[]

IotHubPropertiesEventHubEndpoints

名字	描述	價值

IotHubPropertiesMessagingEndpoints

名字	描述	價值

IotHubPropertiesStorageEndpoints

名字	描述	價值

IotHubSkuInfo

名字	描述	價值
能力	布建的IoT中樞單位數目。 請參閱：/azure/azure-subscription-service-limits#iot-hub-limits。	int
名字	SKU 的名稱。	'B1' 'B2' 'B3' 'F1' 'S1' 'S2' 'S3' （必要）

IpFilterRule

名字	描述	價值
行動	此規則所擷取要求所需的動作。	'Accept' '拒絕' （必要）
filterName	IP 篩選規則的名稱。	字串 （必要）
ipMask	字串，包含規則之 CIDR 表示法中的 IP 位址範圍。	字串 （必要）

KeyVaultKeyProperties

名字	描述	價值
身份	KeyVault Key 的受控識別屬性。	ManagedIdentity
keyIdentifier	金鑰的識別碼。	字串

ManagedIdentity

名字	描述	價值
userAssignedIdentity	使用者指派的身分識別。	字串

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 慣例提供它作為標頭。	字串
身份	IotHub 的受控識別。	ArmIdentity
位置	資源位置。	字串 （必要）
名字	資源名稱	字串 （必要）
性能	IotHub 屬性	IotHubProperties
sku	IotHub SKU 資訊	IotHubSkuInfo （必要）
標籤	資源標籤	標記名稱和值的字典。 請參閱範本中的 標籤

NetworkRuleSetIpRule

名字	描述	價值
行動	IP 篩選動作	'Allow'
filterName	IP 篩選規則的名稱。	字串 （必要）
ipMask	字串，包含規則之 CIDR 表示法中的 IP 位址範圍。	字串 （必要）

NetworkRuleSetProperties

名字	描述	價值
applyToBuiltInEventHubEndpoint	如果為 True，則網路規則集也會套用至 IotHub 的 BuiltIn EventHub EndPoint	布林 （必要）
defaultAction	網路規則集的預設動作	'Allow' 'Deny'
ipRules	IP 規則清單	NetworkRuleSetIpRule[] （必要）

PrivateEndpoint

名字	描述	價值

PrivateEndpointConnection

名字	描述	價值
性能	私人端點連線的屬性	PrivateEndpointConnectionProperties （必要）

PrivateEndpointConnectionProperties

名字	描述	價值
privateEndpoint	私人端點連線的私人端點屬性	PrivateEndpoint
privateLinkServiceConnectionState	私人端點連線的目前狀態	PrivateLinkServiceConnectionState （必要）

PrivateLinkServiceConnectionState

名字	描述	價值
actionsRequired	私人端點連線所需的動作	字串
描述	私人端點連線目前狀態的描述	字串 （必要）
地位	私人端點連線的狀態	「已核准」 'Disconnected' 'Pending' '拒絕' （必要）

ResourceTags

名字	描述	價值

RootCertificateProperties

名字	描述	價值
enableRootCertificateV2	當設定為 true 時，中樞會使用 G2 憑證;雖然設定為 false，但中樞會使用 Baltimore Cert。	bool

RouteProperties

名字	描述	價值
條件	評估為套用路由規則的條件。 如果未提供任何條件，則預設會評估為 true。 如需文法，請參閱：/azure/iot-hub/iot-hub-devguide-query-language	字串
endpointNames	路由傳送符合條件之訊息的端點清單。 目前只允許一個端點。	string[] （必要）
isEnabled	用來指定是否啟用路由。	布林 （必要）
名字	路由的名稱。 名稱只能包含英數位元、句號、底線、連字元，長度上限為64個字元，而且必須是唯一的。	字串 約束： 模式 = ^[A-Za-z0-9-._]{1,64}$ （必要）
源	要套用路由規則的來源，例如 DeviceMessages。	'DeviceConnectionStateEvents' 'DeviceJobLifecycleEvents' 'DeviceLifecycleEvents' 'DeviceMessages' 'DigitalTwinChangeEvents' 'Invalid' 'MqttBrokerMessages' 'TwinChangeEvents' （必要）

RoutingCosmosDBSqlApiProperties

名字	描述	價值
authenticationType	用來對cosmos DB sql 集合端點進行驗證的方法	'identityBased' 'keyBased'
collectionName	cosmos DB 資料庫中 cosmos DB sql 集合的名稱。	字串 （必要）
databaseName	cosmos DB 帳戶中 cosmos DB 資料庫的名稱。	字串 （必要）
endpointUri	cosmos DB 帳戶的 URL。 它必須包含通訊協定 https://	字串 （必要）
id	cosmos DB sql 集合端點的標識符	字串
身份	路由cosmos DB集合端點的受控識別屬性。	ManagedIdentity
名字	識別此端點的名稱。 名稱只能包含英數位元、句號、底線、連字元，且長度上限為64個字元。 下列名稱為保留：事件、fileNotifications、$default。 端點名稱在端點類型之間必須是唯一的。	字串 約束： 模式 = ^[A-Za-z0-9-._]{1,64}$ （必要）
partitionKeyName	如果存在，則為與此 cosmos DB sql 集合相關聯的分割區索引鍵名稱。 這是選擇性參數。	字串
partitionKeyTemplate	用來產生綜合分割區索引鍵值的範本，以便與這個 cosmos DB sql 集合搭配使用。 範本至少必須包含下列其中一個佔位元：{iothub}、{deviceid}、{DD}、{MM}和 {YYYY}。 任何一個佔位元最多可以指定一次，但順序和非佔位元元元件都是任意的。 只有在指定 PartitionKeyName 時，才需要此參數。	字串
primaryKey	cosmos DB 帳戶的主鍵。	字串 約束： 敏感性值。 以安全參數的形式傳入。
resourceGroup	cosmos DB 帳戶的資源群組名稱。	字串
secondaryKey	cosmos DB 帳戶的次要密鑰。	字串 約束： 敏感性值。 以安全參數的形式傳入。
subscriptionId	cosmos DB 帳戶的訂用帳戶標識碼。	字串

RoutingEndpoints

名字	描述	價值
cosmosDBSqlCollections	IoT 中樞根據路由規則將訊息路由傳送至的Cosmos DB集合端點清單。	RoutingCosmosDBSqlApiProperties[]
eventHubs	IoT 中樞根據路由規則將訊息路由傳送至的事件中樞端點清單。 此清單不包含內建事件中樞端點。	RoutingEventHubProperties[]
serviceBusQueues	IoT 中樞根據路由規則，將訊息路由傳送至的服務總線佇列端點清單。	RoutingServiceBusQueueEndpointProperties[]
serviceBusTopics	IoT 中樞根據路由規則，將訊息路由傳送至的服務總線主題端點清單。	RoutingServiceBusTopicEndpointProperties[]
storageContainers	IoT 中樞根據路由規則將訊息路由傳送至的記憶體容器端點清單。	RoutingStorageContainerProperties[]

RoutingEventHubProperties

名字	描述	價值
authenticationType	用來對事件中樞端點進行驗證的方法	'identityBased' 'keyBased'
connectionString	事件中樞端點的連接字串。	字串 約束： 敏感性值。 以安全參數的形式傳入。
endpointUri	事件中樞端點的 URL。 它必須包含通訊協定 sb://	字串
entityPath	事件中樞命名空間上的事件中樞名稱	字串
id	事件中樞端點的標識碼	字串
身份	路由事件中樞端點的受控識別屬性。	ManagedIdentity
名字	識別此端點的名稱。 名稱只能包含英數位元、句號、底線、連字元，且長度上限為64個字元。 下列名稱為保留：事件、fileNotifications、$default。 端點名稱在端點類型之間必須是唯一的。	字串 約束： 模式 = ^[A-Za-z0-9-._]{1,64}$ （必要）
resourceGroup	事件中樞端點的資源群組名稱。	字串
subscriptionId	事件中樞端點的訂用帳戶標識碼。	字串

RoutingProperties

名字	描述	價值
端點	與IoT中樞根據路由規則路由訊息的自定義端點相關的屬性。 付費中樞的所有端點類型最多允許10個自定義端點，而且免費中樞的所有端點類型只允許1個自定義端點。	RoutingEndpoints
擴充	IoT 中樞套用至要傳遞至內建和自定義端點的訊息的使用者提供擴充清單。 請參閱：https://aka.ms/telemetryoneventgrid	擴充屬性[]
fallbackRoute	當不符合 『routes』 區段中所指定條件時，路由的屬性會當做後援路由使用。 這是選擇性參數。 未設定此屬性時，不符合 『routes』 區段中指定之任何條件的訊息會路由傳送至內建 eventhub 端點。	FallbackRouteProperties
路線	IoT 中樞用來將訊息路由傳送至內建和自定義端點的使用者提供路由規則清單。 付費中樞最多允許 100 個路由規則，免費中樞最多允許 5 個路由規則。	RouteProperties[]

RoutingServiceBusQueueEndpointProperties

名字	描述	價值
authenticationType	用來對服務總線佇列端點進行驗證的方法	'identityBased' 'keyBased'
connectionString	服務總線佇列端點的連接字串。	字串 約束： 敏感性值。 以安全參數的形式傳入。
endpointUri	服務總線佇列端點的 URL。 它必須包含通訊協定 sb://	字串
entityPath	服務總線命名空間上的佇列名稱	字串
id	服務總線佇列端點的標識碼	字串
身份	路由服務總線佇列端點的受控識別屬性。	ManagedIdentity
名字	識別此端點的名稱。 名稱只能包含英數位元、句號、底線、連字元，且長度上限為64個字元。 下列名稱為保留：事件、fileNotifications、$default。 端點名稱在端點類型之間必須是唯一的。 名稱不需要與實際佇列名稱相同。	字串 約束： 模式 = ^[A-Za-z0-9-._]{1,64}$ （必要）
resourceGroup	服務總線佇列端點的資源群組名稱。	字串
subscriptionId	服務總線佇列端點的訂用帳戶標識碼。	字串

RoutingServiceBusTopicEndpointProperties

名字	描述	價值
authenticationType	用來對服務總線主題端點進行驗證的方法	'identityBased' 'keyBased'
connectionString	服務總線主題端點的連接字串。	字串 約束： 敏感性值。 以安全參數的形式傳入。
endpointUri	服務總線主題端點的 URL。 它必須包含通訊協定 sb://	字串
entityPath	服務總線主題上的佇列名稱	字串
id	服務總線主題端點的標識碼	字串
身份	路由服務總線主題端點的受控識別屬性。	ManagedIdentity
名字	識別此端點的名稱。 名稱只能包含英數位元、句號、底線、連字元，且長度上限為64個字元。 下列名稱為保留：事件、fileNotifications、$default。 端點名稱在端點類型之間必須是唯一的。 名稱與實際主題名稱不一樣。	字串 約束： 模式 = ^[A-Za-z0-9-._]{1,64}$ （必要）
resourceGroup	服務總線主題端點的資源群組名稱。	字串
subscriptionId	服務總線主題端點的訂用帳戶標識碼。	字串

RoutingStorageContainerProperties

名字	描述	價值
authenticationType	用來對記憶體端點進行驗證的方法	'identityBased' 'keyBased'
batchFrequencyInSeconds	Blob 寫入記憶體的時間間隔。 值應介於 60 到 720 秒之間。 預設值為300秒。	int 約束： 最小值 = 60 最大值 = 720
connectionString	記憶體帳戶的連接字串。	字串 約束： 敏感性值。 以安全參數的形式傳入。
containerName	記憶體帳戶中的記憶體容器名稱。	字串 （必要）
編碼	用來將訊息串行化至 Blob 的編碼方式。 支援的值為 'avro'、'avrodeflate' 和 'JSON'。 預設值為 『avro』。	'Avro' 'AvroDeflate' 'JSON'
endpointUri	記憶體端點的 URL。 它必須包含通訊協定 https://	字串
fileNameFormat	Blob 的檔名格式。 默認格式為 {iothub}/{partition}/{YYYY}/{MM}/{DD}/{HH}/{mm}。 所有參數都是必要參數，但可以重新排序。	字串
id	記憶體容器端點的標識碼	字串
身份	路由記憶體端點的受控識別屬性。	ManagedIdentity
maxChunkSizeInBytes	寫入記憶體之每個 Blob 的最大位元元組數目。 值應介於 10485760（10MB） 和 524288000（500MB） 之間。 預設值為 314572800（300MB）。	int 約束： 最小值 = 10485760 最大值 = 524288000
名字	識別此端點的名稱。 名稱只能包含英數位元、句號、底線、連字元，且長度上限為64個字元。 下列名稱為保留：事件、fileNotifications、$default。 端點名稱在端點類型之間必須是唯一的。	字串 約束： 模式 = ^[A-Za-z0-9-._]{1,64}$ （必要）
resourceGroup	記憶體帳戶的資源群組名稱。	字串
subscriptionId	記憶體帳戶的訂用帳戶標識碼。	字串

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

名字	描述	價值
authenticationType	指定用於連線到記憶體帳戶的驗證類型。	'identityBased' 'keyBased'
connectionString	上傳檔案之 Azure 記憶體帳戶的連接字串。	字串 （必要）
containerName	您上傳檔案的根容器名稱。 容器不需要存在，但應該使用指定的 connectionString 來建立。	字串 （必要）
身份	用於檔案上傳之記憶體端點的受控識別屬性。	ManagedIdentity
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": "2022-11-15-preview",
  "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",
    "deviceStreams": {
      "streamingEndpoints": [ "string" ]
    },
    "disableDeviceSAS": "bool",
    "disableLocalAuth": "bool",
    "disableModuleSAS": "bool",
    "enableDataResidency": "bool",
    "enableFileUploadNotifications": "bool",
    "encryption": {
      "keySource": "string",
      "keyVaultProperties": [
        {
          "identity": {
            "userAssignedIdentity": "string"
          },
          "keyIdentifier": "string"
        }
      ]
    },
    "eventHubEndpoints": {
      "{customized property}": {
        "partitionCount": "int",
        "retentionTimeInDays": "int"
      }
    },
    "features": "string",
    "ipFilterRules": [
      {
        "action": "string",
        "filterName": "string",
        "ipMask": "string"
      }
    ],
    "ipVersion": "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",
    "rootCertificate": {
      "enableRootCertificateV2": "bool"
    },
    "routing": {
      "endpoints": {
        "cosmosDBSqlCollections": [
          {
            "authenticationType": "string",
            "collectionName": "string",
            "databaseName": "string",
            "endpointUri": "string",
            "id": "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"
  }
}

屬性值

ArmIdentity

名字	描述	價值
類型	用於資源的身分識別類型。 類型 'SystemAssigned，UserAssigned' 包含隱含建立的身分識別和一組使用者指派的身分識別。 類型 『None』 會從服務中移除任何身分識別。	'None' 'SystemAssigned' 'SystemAssigned， UserAssigned' 'UserAssigned'
userAssignedIdentities	<ArmUserIdentity> 字典	ArmIdentityUserAssignedIdentities

ArmIdentityUserAssignedIdentities

名字	描述	價值

ArmUserIdentity

名字	描述	價值

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

EncryptionPropertiesDescription

名字	描述	價值
keySource	金鑰的來源。	字串
keyVaultProperties	KeyVault 金鑰的屬性。	KeyVaultKeyProperties[]

EnrichmentProperties

名字	描述	價值
endpointNames	擴充套用至訊息的端點清單。	string[] （必要）
鑰匙	擴充屬性的索引鍵或名稱。	字串 （必要）
價值	擴充屬性的值。	字串 （必要）

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

FallbackRouteProperties

名字	描述	價值
條件	評估要套用後援路由的條件。 如果未提供條件，則預設會評估為 true。 如需文法，請參閱：/azure/iot-hub/iot-hub-devguide-query-language	字串
endpointNames	符合條件的訊息會路由傳送至的端點清單。 目前只允許 1 個端點。	string[] （必要）
isEnabled	用來指定是否啟用後援路由。	布林 （必要）
名字	路由的名稱。 名稱只能包含英數位元、句號、底線、連字元，長度上限為64個字元，而且必須是唯一的。	字串
源	要套用路由規則的來源。 例如，DeviceMessages	'DeviceConnectionStateEvents' 'DeviceJobLifecycleEvents' 'DeviceLifecycleEvents' 'DeviceMessages' 'DigitalTwinChangeEvents' 'Invalid' 'MqttBrokerMessages' 'TwinChangeEvents' （必要）

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

名字	描述	價值
allowedFqdnList	允許從 Iot 中樞輸出的 FQDN（完整功能變數名稱）清單。	string[]
authorizationPolicies	您可以用來保護IoT中樞連線的共用存取原則。	SharedAccessSignatureAuthorizationRule[]
cloudToDevice	IoT 中樞雲端到裝置傳訊屬性。	CloudToDeviceProperties
評論	IoT 中樞批注。	字串
deviceStreams	裝置會串流 iothub 的屬性。	IotHubPropertiesDeviceStreams
disableDeviceSAS	如果為 true，則所有裝置（包括 Edge 裝置，但不包括模組）限定範圍的 SAS 金鑰都無法用於驗證。	bool
disableLocalAuth	如果為 true，則無法將具有 Iot 中樞範圍的 SAS 金鑰 SAS 令牌用於驗證。	bool
disableModuleSAS	如果為 true，則所有模組範圍的 SAS 金鑰都無法用於驗證。	bool
enableDataResidency	當設定為 true 時，這個屬性會啟用數據落地，因此會停用災害復原。	bool
enableFileUploadNotifications	如果為 True，則會啟用檔案上傳通知。	bool
加密	IoT 中樞的加密屬性。	EncryptionPropertiesDescription
eventHubEndpoints	事件中樞相容的端點屬性。 這個字典的唯一可能索引鍵是事件。 在建立或更新IoT中樞的呼叫時，此金鑰必須存在於字典中。	IotHubPropertiesEventHubEndpoints
特徵	針對IoT中樞啟用的功能和功能。	'DeviceManagement' 'None'
ipFilterRules	IP 篩選規則。	IpFilterRule[]
ipVersion	此屬性會指定中樞目前正在使用的IP版本。	'ipv4' 'ipv4ipv6' 'ipv6'
messagingEndpoints	檔案上傳通知佇列的傳訊端點屬性。	IotHubPropertiesMessagingEndpoints
minTlsVersion	指定要支援此中樞的最低 TLS 版本。 可以設定為 「1.2」 ，讓使用 1.2 以下 TLS 版本的用戶端遭到拒絕。	字串
networkRuleSets	IotHub 的網路規則集屬性	NetworkRuleSetProperties
privateEndpointConnections	在此IotHub上建立的私人端點連線	PrivateEndpointConnection[]
publicNetworkAccess	是否允許來自公用網路的要求	'Disabled' 'Enabled'
restrictOutboundNetworkAccess	如果為 true，則來自 IotHub 的輸出將僅限於透過 allowedFqdnList 設定的允許 FQDN。	bool
rootCertificate	此屬性會儲存跟證書相關信息	RootCertificateProperties
路由	IoT 中樞的路由相關屬性。 請參閱：/azure/iot-hub/iot-hub-devguide-messaging	RoutingProperties
storageEndpoints	您可以在其中上傳檔案的 Azure 記憶體端點清單。 目前您只能設定一個 Azure 記憶體帳戶，且必須將其密鑰設定為$default。 指定多個記憶體帳戶會導致擲回錯誤。 當 enableFileUploadNotifications 屬性設定為 True 時，未指定此屬性的值，會導致擲回錯誤。	IotHubPropertiesStorageEndpoints

IotHubPropertiesDeviceStreams

名字	描述	價值
streamingEndpoints	裝置串流端點的清單。	string[]

IotHubPropertiesEventHubEndpoints

名字	描述	價值

IotHubPropertiesMessagingEndpoints

名字	描述	價值

IotHubPropertiesStorageEndpoints

名字	描述	價值

IotHubSkuInfo

名字	描述	價值
能力	布建的IoT中樞單位數目。 請參閱：/azure/azure-subscription-service-limits#iot-hub-limits。	int
名字	SKU 的名稱。	'B1' 'B2' 'B3' 'F1' 'S1' 'S2' 'S3' （必要）

IpFilterRule

名字	描述	價值
行動	此規則所擷取要求所需的動作。	'Accept' '拒絕' （必要）
filterName	IP 篩選規則的名稱。	字串 （必要）
ipMask	字串，包含規則之 CIDR 表示法中的 IP 位址範圍。	字串 （必要）

KeyVaultKeyProperties

名字	描述	價值
身份	KeyVault Key 的受控識別屬性。	ManagedIdentity
keyIdentifier	金鑰的識別碼。	字串

ManagedIdentity

名字	描述	價值
userAssignedIdentity	使用者指派的身分識別。	字串

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 版本	'2022-11-15-preview'
etag	Etag 欄位 不需要。 如果在響應主體中提供，則也必須根據一般 ETag 慣例提供它作為標頭。	字串
身份	IotHub 的受控識別。	ArmIdentity
位置	資源位置。	字串 （必要）
名字	資源名稱	字串 （必要）
性能	IotHub 屬性	IotHubProperties
sku	IotHub SKU 資訊	IotHubSkuInfo （必要）
標籤	資源標籤	標記名稱和值的字典。 請參閱範本中的 標籤
類型	資源類型	'Microsoft.Devices/IotHubs'

NetworkRuleSetIpRule

名字	描述	價值
行動	IP 篩選動作	'Allow'
filterName	IP 篩選規則的名稱。	字串 （必要）
ipMask	字串，包含規則之 CIDR 表示法中的 IP 位址範圍。	字串 （必要）

NetworkRuleSetProperties

名字	描述	價值
applyToBuiltInEventHubEndpoint	如果為 True，則網路規則集也會套用至 IotHub 的 BuiltIn EventHub EndPoint	布林 （必要）
defaultAction	網路規則集的預設動作	'Allow' 'Deny'
ipRules	IP 規則清單	NetworkRuleSetIpRule[] （必要）

PrivateEndpoint

名字	描述	價值

PrivateEndpointConnection

名字	描述	價值
性能	私人端點連線的屬性	PrivateEndpointConnectionProperties （必要）

PrivateEndpointConnectionProperties

名字	描述	價值
privateEndpoint	私人端點連線的私人端點屬性	PrivateEndpoint
privateLinkServiceConnectionState	私人端點連線的目前狀態	PrivateLinkServiceConnectionState （必要）

PrivateLinkServiceConnectionState

名字	描述	價值
actionsRequired	私人端點連線所需的動作	字串
描述	私人端點連線目前狀態的描述	字串 （必要）
地位	私人端點連線的狀態	「已核准」 'Disconnected' 'Pending' '拒絕' （必要）

ResourceTags

名字	描述	價值

RootCertificateProperties

名字	描述	價值
enableRootCertificateV2	當設定為 true 時，中樞會使用 G2 憑證;雖然設定為 false，但中樞會使用 Baltimore Cert。	bool

RouteProperties

名字	描述	價值
條件	評估為套用路由規則的條件。 如果未提供任何條件，則預設會評估為 true。 如需文法，請參閱：/azure/iot-hub/iot-hub-devguide-query-language	字串
endpointNames	路由傳送符合條件之訊息的端點清單。 目前只允許一個端點。	string[] （必要）
isEnabled	用來指定是否啟用路由。	布林 （必要）
名字	路由的名稱。 名稱只能包含英數位元、句號、底線、連字元，長度上限為64個字元，而且必須是唯一的。	字串 約束： 模式 = ^[A-Za-z0-9-._]{1,64}$ （必要）
源	要套用路由規則的來源，例如 DeviceMessages。	'DeviceConnectionStateEvents' 'DeviceJobLifecycleEvents' 'DeviceLifecycleEvents' 'DeviceMessages' 'DigitalTwinChangeEvents' 'Invalid' 'MqttBrokerMessages' 'TwinChangeEvents' （必要）

RoutingCosmosDBSqlApiProperties

名字	描述	價值
authenticationType	用來對cosmos DB sql 集合端點進行驗證的方法	'identityBased' 'keyBased'
collectionName	cosmos DB 資料庫中 cosmos DB sql 集合的名稱。	字串 （必要）
databaseName	cosmos DB 帳戶中 cosmos DB 資料庫的名稱。	字串 （必要）
endpointUri	cosmos DB 帳戶的 URL。 它必須包含通訊協定 https://	字串 （必要）
id	cosmos DB sql 集合端點的標識符	字串
身份	路由cosmos DB集合端點的受控識別屬性。	ManagedIdentity
名字	識別此端點的名稱。 名稱只能包含英數位元、句號、底線、連字元，且長度上限為64個字元。 下列名稱為保留：事件、fileNotifications、$default。 端點名稱在端點類型之間必須是唯一的。	字串 約束： 模式 = ^[A-Za-z0-9-._]{1,64}$ （必要）
partitionKeyName	如果存在，則為與此 cosmos DB sql 集合相關聯的分割區索引鍵名稱。 這是選擇性參數。	字串
partitionKeyTemplate	用來產生綜合分割區索引鍵值的範本，以便與這個 cosmos DB sql 集合搭配使用。 範本至少必須包含下列其中一個佔位元：{iothub}、{deviceid}、{DD}、{MM}和 {YYYY}。 任何一個佔位元最多可以指定一次，但順序和非佔位元元元件都是任意的。 只有在指定 PartitionKeyName 時，才需要此參數。	字串
primaryKey	cosmos DB 帳戶的主鍵。	字串 約束： 敏感性值。 以安全參數的形式傳入。
resourceGroup	cosmos DB 帳戶的資源群組名稱。	字串
secondaryKey	cosmos DB 帳戶的次要密鑰。	字串 約束： 敏感性值。 以安全參數的形式傳入。
subscriptionId	cosmos DB 帳戶的訂用帳戶標識碼。	字串

RoutingEndpoints

名字	描述	價值
cosmosDBSqlCollections	IoT 中樞根據路由規則將訊息路由傳送至的Cosmos DB集合端點清單。	RoutingCosmosDBSqlApiProperties[]
eventHubs	IoT 中樞根據路由規則將訊息路由傳送至的事件中樞端點清單。 此清單不包含內建事件中樞端點。	RoutingEventHubProperties[]
serviceBusQueues	IoT 中樞根據路由規則，將訊息路由傳送至的服務總線佇列端點清單。	RoutingServiceBusQueueEndpointProperties[]
serviceBusTopics	IoT 中樞根據路由規則，將訊息路由傳送至的服務總線主題端點清單。	RoutingServiceBusTopicEndpointProperties[]
storageContainers	IoT 中樞根據路由規則將訊息路由傳送至的記憶體容器端點清單。	RoutingStorageContainerProperties[]

RoutingEventHubProperties

名字	描述	價值
authenticationType	用來對事件中樞端點進行驗證的方法	'identityBased' 'keyBased'
connectionString	事件中樞端點的連接字串。	字串 約束： 敏感性值。 以安全參數的形式傳入。
endpointUri	事件中樞端點的 URL。 它必須包含通訊協定 sb://	字串
entityPath	事件中樞命名空間上的事件中樞名稱	字串
id	事件中樞端點的標識碼	字串
身份	路由事件中樞端點的受控識別屬性。	ManagedIdentity
名字	識別此端點的名稱。 名稱只能包含英數位元、句號、底線、連字元，且長度上限為64個字元。 下列名稱為保留：事件、fileNotifications、$default。 端點名稱在端點類型之間必須是唯一的。	字串 約束： 模式 = ^[A-Za-z0-9-._]{1,64}$ （必要）
resourceGroup	事件中樞端點的資源群組名稱。	字串
subscriptionId	事件中樞端點的訂用帳戶標識碼。	字串

RoutingProperties

名字	描述	價值
端點	與IoT中樞根據路由規則路由訊息的自定義端點相關的屬性。 付費中樞的所有端點類型最多允許10個自定義端點，而且免費中樞的所有端點類型只允許1個自定義端點。	RoutingEndpoints
擴充	IoT 中樞套用至要傳遞至內建和自定義端點的訊息的使用者提供擴充清單。 請參閱：https://aka.ms/telemetryoneventgrid	擴充屬性[]
fallbackRoute	當不符合 『routes』 區段中所指定條件時，路由的屬性會當做後援路由使用。 這是選擇性參數。 未設定此屬性時，不符合 『routes』 區段中指定之任何條件的訊息會路由傳送至內建 eventhub 端點。	FallbackRouteProperties
路線	IoT 中樞用來將訊息路由傳送至內建和自定義端點的使用者提供路由規則清單。 付費中樞最多允許 100 個路由規則，免費中樞最多允許 5 個路由規則。	RouteProperties[]

RoutingServiceBusQueueEndpointProperties

名字	描述	價值
authenticationType	用來對服務總線佇列端點進行驗證的方法	'identityBased' 'keyBased'
connectionString	服務總線佇列端點的連接字串。	字串 約束： 敏感性值。 以安全參數的形式傳入。
endpointUri	服務總線佇列端點的 URL。 它必須包含通訊協定 sb://	字串
entityPath	服務總線命名空間上的佇列名稱	字串
id	服務總線佇列端點的標識碼	字串
身份	路由服務總線佇列端點的受控識別屬性。	ManagedIdentity
名字	識別此端點的名稱。 名稱只能包含英數位元、句號、底線、連字元，且長度上限為64個字元。 下列名稱為保留：事件、fileNotifications、$default。 端點名稱在端點類型之間必須是唯一的。 名稱不需要與實際佇列名稱相同。	字串 約束： 模式 = ^[A-Za-z0-9-._]{1,64}$ （必要）
resourceGroup	服務總線佇列端點的資源群組名稱。	字串
subscriptionId	服務總線佇列端點的訂用帳戶標識碼。	字串

RoutingServiceBusTopicEndpointProperties

名字	描述	價值
authenticationType	用來對服務總線主題端點進行驗證的方法	'identityBased' 'keyBased'
connectionString	服務總線主題端點的連接字串。	字串 約束： 敏感性值。 以安全參數的形式傳入。
endpointUri	服務總線主題端點的 URL。 它必須包含通訊協定 sb://	字串
entityPath	服務總線主題上的佇列名稱	字串
id	服務總線主題端點的標識碼	字串
身份	路由服務總線主題端點的受控識別屬性。	ManagedIdentity
名字	識別此端點的名稱。 名稱只能包含英數位元、句號、底線、連字元，且長度上限為64個字元。 下列名稱為保留：事件、fileNotifications、$default。 端點名稱在端點類型之間必須是唯一的。 名稱與實際主題名稱不一樣。	字串 約束： 模式 = ^[A-Za-z0-9-._]{1,64}$ （必要）
resourceGroup	服務總線主題端點的資源群組名稱。	字串
subscriptionId	服務總線主題端點的訂用帳戶標識碼。	字串

RoutingStorageContainerProperties

名字	描述	價值
authenticationType	用來對記憶體端點進行驗證的方法	'identityBased' 'keyBased'
batchFrequencyInSeconds	Blob 寫入記憶體的時間間隔。 值應介於 60 到 720 秒之間。 預設值為300秒。	int 約束： 最小值 = 60 最大值 = 720
connectionString	記憶體帳戶的連接字串。	字串 約束： 敏感性值。 以安全參數的形式傳入。
containerName	記憶體帳戶中的記憶體容器名稱。	字串 （必要）
編碼	用來將訊息串行化至 Blob 的編碼方式。 支援的值為 'avro'、'avrodeflate' 和 'JSON'。 預設值為 『avro』。	'Avro' 'AvroDeflate' 'JSON'
endpointUri	記憶體端點的 URL。 它必須包含通訊協定 https://	字串
fileNameFormat	Blob 的檔名格式。 默認格式為 {iothub}/{partition}/{YYYY}/{MM}/{DD}/{HH}/{mm}。 所有參數都是必要參數，但可以重新排序。	字串
id	記憶體容器端點的標識碼	字串
身份	路由記憶體端點的受控識別屬性。	ManagedIdentity
maxChunkSizeInBytes	寫入記憶體之每個 Blob 的最大位元元組數目。 值應介於 10485760（10MB） 和 524288000（500MB） 之間。 預設值為 314572800（300MB）。	int 約束： 最小值 = 10485760 最大值 = 524288000
名字	識別此端點的名稱。 名稱只能包含英數位元、句號、底線、連字元，且長度上限為64個字元。 下列名稱為保留：事件、fileNotifications、$default。 端點名稱在端點類型之間必須是唯一的。	字串 約束： 模式 = ^[A-Za-z0-9-._]{1,64}$ （必要）
resourceGroup	記憶體帳戶的資源群組名稱。	字串
subscriptionId	記憶體帳戶的訂用帳戶標識碼。	字串

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

名字	描述	價值
authenticationType	指定用於連線到記憶體帳戶的驗證類型。	'identityBased' 'keyBased'
connectionString	上傳檔案之 Azure 記憶體帳戶的連接字串。	字串 （必要）
containerName	您上傳檔案的根容器名稱。 容器不需要存在，但應該使用指定的 connectionString 來建立。	字串 （必要）
身份	用於檔案上傳之記憶體端點的受控識別屬性。	ManagedIdentity
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@2022-11-15-preview"
  name = "string"
  etag = "string"
  identity = {
    type = "string"
    userAssignedIdentities = {
      {customized property} = {
      }
    }
  }
  location = "string"
  sku = {
    capacity = int
    name = "string"
  }
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    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"
      deviceStreams = {
        streamingEndpoints = [
          "string"
        ]
      }
      disableDeviceSAS = bool
      disableLocalAuth = bool
      disableModuleSAS = bool
      enableDataResidency = bool
      enableFileUploadNotifications = bool
      encryption = {
        keySource = "string"
        keyVaultProperties = [
          {
            identity = {
              userAssignedIdentity = "string"
            }
            keyIdentifier = "string"
          }
        ]
      }
      eventHubEndpoints = {
        {customized property} = {
          partitionCount = int
          retentionTimeInDays = int
        }
      }
      features = "string"
      ipFilterRules = [
        {
          action = "string"
          filterName = "string"
          ipMask = "string"
        }
      ]
      ipVersion = "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
      rootCertificate = {
        enableRootCertificateV2 = bool
      }
      routing = {
        endpoints = {
          cosmosDBSqlCollections = [
            {
              authenticationType = "string"
              collectionName = "string"
              databaseName = "string"
              endpointUri = "string"
              id = "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"
        }
      }
    }
  })
}

屬性值

ArmIdentity

名字	描述	價值
類型	用於資源的身分識別類型。 類型 'SystemAssigned，UserAssigned' 包含隱含建立的身分識別和一組使用者指派的身分識別。 類型 『None』 會從服務中移除任何身分識別。	'None' 'SystemAssigned' 'SystemAssigned， UserAssigned' 'UserAssigned'
userAssignedIdentities	<ArmUserIdentity> 字典	ArmIdentityUserAssignedIdentities

ArmIdentityUserAssignedIdentities

名字	描述	價值

ArmUserIdentity

名字	描述	價值

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

EncryptionPropertiesDescription

名字	描述	價值
keySource	金鑰的來源。	字串
keyVaultProperties	KeyVault 金鑰的屬性。	KeyVaultKeyProperties[]

EnrichmentProperties

名字	描述	價值
endpointNames	擴充套用至訊息的端點清單。	string[] （必要）
鑰匙	擴充屬性的索引鍵或名稱。	字串 （必要）
價值	擴充屬性的值。	字串 （必要）

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

FallbackRouteProperties

名字	描述	價值
條件	評估要套用後援路由的條件。 如果未提供條件，則預設會評估為 true。 如需文法，請參閱：/azure/iot-hub/iot-hub-devguide-query-language	字串
endpointNames	符合條件的訊息會路由傳送至的端點清單。 目前只允許 1 個端點。	string[] （必要）
isEnabled	用來指定是否啟用後援路由。	布林 （必要）
名字	路由的名稱。 名稱只能包含英數位元、句號、底線、連字元，長度上限為64個字元，而且必須是唯一的。	字串
源	要套用路由規則的來源。 例如，DeviceMessages	'DeviceConnectionStateEvents' 'DeviceJobLifecycleEvents' 'DeviceLifecycleEvents' 'DeviceMessages' 'DigitalTwinChangeEvents' 'Invalid' 'MqttBrokerMessages' 'TwinChangeEvents' （必要）

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

名字	描述	價值
allowedFqdnList	允許從 Iot 中樞輸出的 FQDN（完整功能變數名稱）清單。	string[]
authorizationPolicies	您可以用來保護IoT中樞連線的共用存取原則。	SharedAccessSignatureAuthorizationRule[]
cloudToDevice	IoT 中樞雲端到裝置傳訊屬性。	CloudToDeviceProperties
評論	IoT 中樞批注。	字串
deviceStreams	裝置會串流 iothub 的屬性。	IotHubPropertiesDeviceStreams
disableDeviceSAS	如果為 true，則所有裝置（包括 Edge 裝置，但不包括模組）限定範圍的 SAS 金鑰都無法用於驗證。	bool
disableLocalAuth	如果為 true，則無法將具有 Iot 中樞範圍的 SAS 金鑰 SAS 令牌用於驗證。	bool
disableModuleSAS	如果為 true，則所有模組範圍的 SAS 金鑰都無法用於驗證。	bool
enableDataResidency	當設定為 true 時，這個屬性會啟用數據落地，因此會停用災害復原。	bool
enableFileUploadNotifications	如果為 True，則會啟用檔案上傳通知。	bool
加密	IoT 中樞的加密屬性。	EncryptionPropertiesDescription
eventHubEndpoints	事件中樞相容的端點屬性。 這個字典的唯一可能索引鍵是事件。 在建立或更新IoT中樞的呼叫時，此金鑰必須存在於字典中。	IotHubPropertiesEventHubEndpoints
特徵	針對IoT中樞啟用的功能和功能。	'DeviceManagement' 'None'
ipFilterRules	IP 篩選規則。	IpFilterRule[]
ipVersion	此屬性會指定中樞目前正在使用的IP版本。	'ipv4' 'ipv4ipv6' 'ipv6'
messagingEndpoints	檔案上傳通知佇列的傳訊端點屬性。	IotHubPropertiesMessagingEndpoints
minTlsVersion	指定要支援此中樞的最低 TLS 版本。 可以設定為 「1.2」 ，讓使用 1.2 以下 TLS 版本的用戶端遭到拒絕。	字串
networkRuleSets	IotHub 的網路規則集屬性	NetworkRuleSetProperties
privateEndpointConnections	在此IotHub上建立的私人端點連線	PrivateEndpointConnection[]
publicNetworkAccess	是否允許來自公用網路的要求	'Disabled' 'Enabled'
restrictOutboundNetworkAccess	如果為 true，則來自 IotHub 的輸出將僅限於透過 allowedFqdnList 設定的允許 FQDN。	bool
rootCertificate	此屬性會儲存跟證書相關信息	RootCertificateProperties
路由	IoT 中樞的路由相關屬性。 請參閱：/azure/iot-hub/iot-hub-devguide-messaging	RoutingProperties
storageEndpoints	您可以在其中上傳檔案的 Azure 記憶體端點清單。 目前您只能設定一個 Azure 記憶體帳戶，且必須將其密鑰設定為$default。 指定多個記憶體帳戶會導致擲回錯誤。 當 enableFileUploadNotifications 屬性設定為 True 時，未指定此屬性的值，會導致擲回錯誤。	IotHubPropertiesStorageEndpoints

IotHubPropertiesDeviceStreams

名字	描述	價值
streamingEndpoints	裝置串流端點的清單。	string[]

IotHubPropertiesEventHubEndpoints

名字	描述	價值

IotHubPropertiesMessagingEndpoints

名字	描述	價值

IotHubPropertiesStorageEndpoints

名字	描述	價值

IotHubSkuInfo

名字	描述	價值
能力	布建的IoT中樞單位數目。 請參閱：/azure/azure-subscription-service-limits#iot-hub-limits。	int
名字	SKU 的名稱。	'B1' 'B2' 'B3' 'F1' 'S1' 'S2' 'S3' （必要）

IpFilterRule

名字	描述	價值
行動	此規則所擷取要求所需的動作。	'Accept' '拒絕' （必要）
filterName	IP 篩選規則的名稱。	字串 （必要）
ipMask	字串，包含規則之 CIDR 表示法中的 IP 位址範圍。	字串 （必要）

KeyVaultKeyProperties

名字	描述	價值
身份	KeyVault Key 的受控識別屬性。	ManagedIdentity
keyIdentifier	金鑰的識別碼。	字串

ManagedIdentity

名字	描述	價值
userAssignedIdentity	使用者指派的身分識別。	字串

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 慣例提供它作為標頭。	字串
身份	IotHub 的受控識別。	ArmIdentity
位置	資源位置。	字串 （必要）
名字	資源名稱	字串 （必要）
性能	IotHub 屬性	IotHubProperties
sku	IotHub SKU 資訊	IotHubSkuInfo （必要）
標籤	資源標籤	標記名稱和值的字典。
類型	資源類型	“Microsoft.Devices/IotHubs@2022-11-15-preview”

NetworkRuleSetIpRule

名字	描述	價值
行動	IP 篩選動作	'Allow'
filterName	IP 篩選規則的名稱。	字串 （必要）
ipMask	字串，包含規則之 CIDR 表示法中的 IP 位址範圍。	字串 （必要）

NetworkRuleSetProperties

名字	描述	價值
applyToBuiltInEventHubEndpoint	如果為 True，則網路規則集也會套用至 IotHub 的 BuiltIn EventHub EndPoint	布林 （必要）
defaultAction	網路規則集的預設動作	'Allow' 'Deny'
ipRules	IP 規則清單	NetworkRuleSetIpRule[] （必要）

PrivateEndpoint

名字	描述	價值

PrivateEndpointConnection

名字	描述	價值
性能	私人端點連線的屬性	PrivateEndpointConnectionProperties （必要）

PrivateEndpointConnectionProperties

名字	描述	價值
privateEndpoint	私人端點連線的私人端點屬性	PrivateEndpoint
privateLinkServiceConnectionState	私人端點連線的目前狀態	PrivateLinkServiceConnectionState （必要）

PrivateLinkServiceConnectionState

名字	描述	價值
actionsRequired	私人端點連線所需的動作	字串
描述	私人端點連線目前狀態的描述	字串 （必要）
地位	私人端點連線的狀態	「已核准」 'Disconnected' 'Pending' '拒絕' （必要）

ResourceTags

名字	描述	價值

RootCertificateProperties

名字	描述	價值
enableRootCertificateV2	當設定為 true 時，中樞會使用 G2 憑證;雖然設定為 false，但中樞會使用 Baltimore Cert。	bool

RouteProperties

名字	描述	價值
條件	評估為套用路由規則的條件。 如果未提供任何條件，則預設會評估為 true。 如需文法，請參閱：/azure/iot-hub/iot-hub-devguide-query-language	字串
endpointNames	路由傳送符合條件之訊息的端點清單。 目前只允許一個端點。	string[] （必要）
isEnabled	用來指定是否啟用路由。	布林 （必要）
名字	路由的名稱。 名稱只能包含英數位元、句號、底線、連字元，長度上限為64個字元，而且必須是唯一的。	字串 約束： 模式 = ^[A-Za-z0-9-._]{1,64}$ （必要）
源	要套用路由規則的來源，例如 DeviceMessages。	'DeviceConnectionStateEvents' 'DeviceJobLifecycleEvents' 'DeviceLifecycleEvents' 'DeviceMessages' 'DigitalTwinChangeEvents' 'Invalid' 'MqttBrokerMessages' 'TwinChangeEvents' （必要）

RoutingCosmosDBSqlApiProperties

名字	描述	價值
authenticationType	用來對cosmos DB sql 集合端點進行驗證的方法	'identityBased' 'keyBased'
collectionName	cosmos DB 資料庫中 cosmos DB sql 集合的名稱。	字串 （必要）
databaseName	cosmos DB 帳戶中 cosmos DB 資料庫的名稱。	字串 （必要）
endpointUri	cosmos DB 帳戶的 URL。 它必須包含通訊協定 https://	字串 （必要）
id	cosmos DB sql 集合端點的標識符	字串
身份	路由cosmos DB集合端點的受控識別屬性。	ManagedIdentity
名字	識別此端點的名稱。 名稱只能包含英數位元、句號、底線、連字元，且長度上限為64個字元。 下列名稱為保留：事件、fileNotifications、$default。 端點名稱在端點類型之間必須是唯一的。	字串 約束： 模式 = ^[A-Za-z0-9-._]{1,64}$ （必要）
partitionKeyName	如果存在，則為與此 cosmos DB sql 集合相關聯的分割區索引鍵名稱。 這是選擇性參數。	字串
partitionKeyTemplate	用來產生綜合分割區索引鍵值的範本，以便與這個 cosmos DB sql 集合搭配使用。 範本至少必須包含下列其中一個佔位元：{iothub}、{deviceid}、{DD}、{MM}和 {YYYY}。 任何一個佔位元最多可以指定一次，但順序和非佔位元元元件都是任意的。 只有在指定 PartitionKeyName 時，才需要此參數。	字串
primaryKey	cosmos DB 帳戶的主鍵。	字串 約束： 敏感性值。 以安全參數的形式傳入。
resourceGroup	cosmos DB 帳戶的資源群組名稱。	字串
secondaryKey	cosmos DB 帳戶的次要密鑰。	字串 約束： 敏感性值。 以安全參數的形式傳入。
subscriptionId	cosmos DB 帳戶的訂用帳戶標識碼。	字串

RoutingEndpoints

名字	描述	價值
cosmosDBSqlCollections	IoT 中樞根據路由規則將訊息路由傳送至的Cosmos DB集合端點清單。	RoutingCosmosDBSqlApiProperties[]
eventHubs	IoT 中樞根據路由規則將訊息路由傳送至的事件中樞端點清單。 此清單不包含內建事件中樞端點。	RoutingEventHubProperties[]
serviceBusQueues	IoT 中樞根據路由規則，將訊息路由傳送至的服務總線佇列端點清單。	RoutingServiceBusQueueEndpointProperties[]
serviceBusTopics	IoT 中樞根據路由規則，將訊息路由傳送至的服務總線主題端點清單。	RoutingServiceBusTopicEndpointProperties[]
storageContainers	IoT 中樞根據路由規則將訊息路由傳送至的記憶體容器端點清單。	RoutingStorageContainerProperties[]

RoutingEventHubProperties

名字	描述	價值
authenticationType	用來對事件中樞端點進行驗證的方法	'identityBased' 'keyBased'
connectionString	事件中樞端點的連接字串。	字串 約束： 敏感性值。 以安全參數的形式傳入。
endpointUri	事件中樞端點的 URL。 它必須包含通訊協定 sb://	字串
entityPath	事件中樞命名空間上的事件中樞名稱	字串
id	事件中樞端點的標識碼	字串
身份	路由事件中樞端點的受控識別屬性。	ManagedIdentity
名字	識別此端點的名稱。 名稱只能包含英數位元、句號、底線、連字元，且長度上限為64個字元。 下列名稱為保留：事件、fileNotifications、$default。 端點名稱在端點類型之間必須是唯一的。	字串 約束： 模式 = ^[A-Za-z0-9-._]{1,64}$ （必要）
resourceGroup	事件中樞端點的資源群組名稱。	字串
subscriptionId	事件中樞端點的訂用帳戶標識碼。	字串

RoutingProperties

名字	描述	價值
端點	與IoT中樞根據路由規則路由訊息的自定義端點相關的屬性。 付費中樞的所有端點類型最多允許10個自定義端點，而且免費中樞的所有端點類型只允許1個自定義端點。	RoutingEndpoints
擴充	IoT 中樞套用至要傳遞至內建和自定義端點的訊息的使用者提供擴充清單。 請參閱：https://aka.ms/telemetryoneventgrid	擴充屬性[]
fallbackRoute	當不符合 『routes』 區段中所指定條件時，路由的屬性會當做後援路由使用。 這是選擇性參數。 未設定此屬性時，不符合 『routes』 區段中指定之任何條件的訊息會路由傳送至內建 eventhub 端點。	FallbackRouteProperties
路線	IoT 中樞用來將訊息路由傳送至內建和自定義端點的使用者提供路由規則清單。 付費中樞最多允許 100 個路由規則，免費中樞最多允許 5 個路由規則。	RouteProperties[]

RoutingServiceBusQueueEndpointProperties

名字	描述	價值
authenticationType	用來對服務總線佇列端點進行驗證的方法	'identityBased' 'keyBased'
connectionString	服務總線佇列端點的連接字串。	字串 約束： 敏感性值。 以安全參數的形式傳入。
endpointUri	服務總線佇列端點的 URL。 它必須包含通訊協定 sb://	字串
entityPath	服務總線命名空間上的佇列名稱	字串
id	服務總線佇列端點的標識碼	字串
身份	路由服務總線佇列端點的受控識別屬性。	ManagedIdentity
名字	識別此端點的名稱。 名稱只能包含英數位元、句號、底線、連字元，且長度上限為64個字元。 下列名稱為保留：事件、fileNotifications、$default。 端點名稱在端點類型之間必須是唯一的。 名稱不需要與實際佇列名稱相同。	字串 約束： 模式 = ^[A-Za-z0-9-._]{1,64}$ （必要）
resourceGroup	服務總線佇列端點的資源群組名稱。	字串
subscriptionId	服務總線佇列端點的訂用帳戶標識碼。	字串

RoutingServiceBusTopicEndpointProperties

名字	描述	價值
authenticationType	用來對服務總線主題端點進行驗證的方法	'identityBased' 'keyBased'
connectionString	服務總線主題端點的連接字串。	字串 約束： 敏感性值。 以安全參數的形式傳入。
endpointUri	服務總線主題端點的 URL。 它必須包含通訊協定 sb://	字串
entityPath	服務總線主題上的佇列名稱	字串
id	服務總線主題端點的標識碼	字串
身份	路由服務總線主題端點的受控識別屬性。	ManagedIdentity
名字	識別此端點的名稱。 名稱只能包含英數位元、句號、底線、連字元，且長度上限為64個字元。 下列名稱為保留：事件、fileNotifications、$default。 端點名稱在端點類型之間必須是唯一的。 名稱與實際主題名稱不一樣。	字串 約束： 模式 = ^[A-Za-z0-9-._]{1,64}$ （必要）
resourceGroup	服務總線主題端點的資源群組名稱。	字串
subscriptionId	服務總線主題端點的訂用帳戶標識碼。	字串

RoutingStorageContainerProperties

名字	描述	價值
authenticationType	用來對記憶體端點進行驗證的方法	'identityBased' 'keyBased'
batchFrequencyInSeconds	Blob 寫入記憶體的時間間隔。 值應介於 60 到 720 秒之間。 預設值為300秒。	int 約束： 最小值 = 60 最大值 = 720
connectionString	記憶體帳戶的連接字串。	字串 約束： 敏感性值。 以安全參數的形式傳入。
containerName	記憶體帳戶中的記憶體容器名稱。	字串 （必要）
編碼	用來將訊息串行化至 Blob 的編碼方式。 支援的值為 'avro'、'avrodeflate' 和 'JSON'。 預設值為 『avro』。	'Avro' 'AvroDeflate' 'JSON'
endpointUri	記憶體端點的 URL。 它必須包含通訊協定 https://	字串
fileNameFormat	Blob 的檔名格式。 默認格式為 {iothub}/{partition}/{YYYY}/{MM}/{DD}/{HH}/{mm}。 所有參數都是必要參數，但可以重新排序。	字串
id	記憶體容器端點的標識碼	字串
身份	路由記憶體端點的受控識別屬性。	ManagedIdentity
maxChunkSizeInBytes	寫入記憶體之每個 Blob 的最大位元元組數目。 值應介於 10485760（10MB） 和 524288000（500MB） 之間。 預設值為 314572800（300MB）。	int 約束： 最小值 = 10485760 最大值 = 524288000
名字	識別此端點的名稱。 名稱只能包含英數位元、句號、底線、連字元，且長度上限為64個字元。 下列名稱為保留：事件、fileNotifications、$default。 端點名稱在端點類型之間必須是唯一的。	字串 約束： 模式 = ^[A-Za-z0-9-._]{1,64}$ （必要）
resourceGroup	記憶體帳戶的資源群組名稱。	字串
subscriptionId	記憶體帳戶的訂用帳戶標識碼。	字串

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

名字	描述	價值
authenticationType	指定用於連線到記憶體帳戶的驗證類型。	'identityBased' 'keyBased'
connectionString	上傳檔案之 Azure 記憶體帳戶的連接字串。	字串 （必要）
containerName	您上傳檔案的根容器名稱。 容器不需要存在，但應該使用指定的 connectionString 來建立。	字串 （必要）
身份	用於檔案上傳之記憶體端點的受控識別屬性。	ManagedIdentity
sasTtlAsIso8601	IoT 中樞針對檔案上傳所產生的SAS URI有效期間。 請參閱：/azure/iot-hub/iot-hub-devguide-file-upload#file-upload-notification-configuration-options。	字串