Microsoft.Devices IotHubs 2021-07-01-preview
- più recenti
- 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
03-03-2021 - 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
- 12-12-01-preview 2018
- 2018-04-01
- 2018-01-22
- 2017-07-01
- 2017-01-19
- 2016-02-03
Definizione di risorsa Bicep
Il tipo di risorsa IotHubs può essere distribuito con operazioni destinate a:
Per un elenco delle proprietà modificate in ogni versione dell'API, vedere log delle modifiche.
Formato risorsa
Per creare una risorsa Microsoft.Devices/IotHubs, aggiungere il bicep seguente al modello.
resource symbolicname 'Microsoft.Devices/IotHubs@2021-07-01-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
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'
}
]
messagingEndpoints: {
{customized property}: {
lockDurationAsIso8601: 'string'
maxDeliveryCount: int
ttlAsIso8601: 'string'
}
}
minTlsVersion: 'string'
networkRuleSets: {
applyToBuiltInEventHubEndpoint: bool
defaultAction: 'string'
ipRules: [
{
action: 'string'
filterName: 'string'
ipMask: 'string'
}
]
}
privateEndpointConnections: [
{
properties: {
privateEndpoint: {}
privateLinkServiceConnectionState: {
actionsRequired: 'string'
description: 'string'
status: 'string'
}
}
}
]
publicNetworkAccess: 'string'
restrictOutboundNetworkAccess: bool
routing: {
endpoints: {
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'
}
}
Valori delle proprietà
ArmIdentity
| Nome | Descrizione | Valore |
|---|---|---|
| digitare | Tipo di identità usata per la risorsa. Il tipo 'SystemAssigned,UserAssigned' include sia un'identità creata in modo implicito che un set di identità assegnate dall'utente. Il tipo 'None' rimuoverà tutte le identità dal servizio. | 'Nessuno' 'SystemAssigned' 'SystemAssigned, UserAssigned' 'UserAssigned' |
| userAssignedIdentities | Dizionario di <armUserIdentity> | ArmIdentityUserAssignedIdentities |
ArmIdentityUserAssignedIdentities
| Nome | Descrizione | Valore |
|---|
ArmUserIdentity
| Nome | Descrizione | Valore |
|---|
CloudToDeviceProperties
| Nome | Descrizione | Valore |
|---|---|---|
| defaultTtlAsIso8601 | Durata predefinita per i messaggi da cloud a dispositivo nella coda del dispositivo. Vedere: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | corda |
| Valutazione | Proprietà della coda di feedback per i messaggi da cloud a dispositivo. | FeedbackProprietà |
| maxDeliveryCount | Numero massimo di recapito per i messaggi da cloud a dispositivo nella coda del dispositivo. Vedere: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | Int Vincoli: Valore minimo = 1 Valore massimo = 100 |
EncryptionPropertiesDescription
| Nome | Descrizione | Valore |
|---|---|---|
| keySource | Origine della chiave. | corda |
| keyVaultProperties | Proprietà della chiave dell'insieme di credenziali delle chiavi. | KeyVaultKeyProperties[] |
Proprietà di arricchimento
| Nome | Descrizione | Valore |
|---|---|---|
| endpointNames | Elenco di endpoint per cui viene applicato l'arricchimento al messaggio. | string[] (obbligatorio) |
| chiave | Chiave o nome per la proprietà di arricchimento. | stringa (obbligatorio) |
| valore | Valore per la proprietà di arricchimento. | stringa (obbligatorio) |
EventHubProperties
| Nome | Descrizione | Valore |
|---|---|---|
| partitionCount | Numero di partizioni per la ricezione di messaggi da dispositivo a cloud nell'endpoint compatibile con Hub eventi. Vedere: /azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages. | Int |
| retentionTimeInDays | Tempo di conservazione per i messaggi da dispositivo a cloud in giorni. Vedere: /azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages | Int |
FallbackRouteProperties
| Nome | Descrizione | Valore |
|---|---|---|
| condizione | Condizione valutata per applicare la route di fallback. Se la condizione non viene fornita, restituisce true per impostazione predefinita. Per la grammatica, vedere: /azure/iot-hub/iot-hub-devguide-query-language | corda |
| endpointNames | Elenco di endpoint a cui vengono indirizzati i messaggi che soddisfano la condizione. Attualmente è consentito solo 1 endpoint. | string[] (obbligatorio) |
| isEnabled | Consente di specificare se la route di fallback è abilitata. | bool (obbligatorio) |
| nome | Nome della route. Il nome può includere solo caratteri alfanumerici, punti, caratteri di sottolineatura, trattini, ha una lunghezza massima di 64 caratteri e deve essere univoco. | corda |
| fonte | Origine a cui applicare la regola di routing. Ad esempio, DeviceMessages | 'DeviceConnectionStateEvents' 'DeviceJobLifecycleEvents' 'DeviceLifecycleEvents' 'DeviceMessages' 'DigitalTwinChangeEvents' 'Invalid' 'MqttBrokerMessages' 'TwinChangeEvents' (obbligatorio) |
FeedbackProperties
| Nome | Descrizione | Valore |
|---|---|---|
| lockDurationAsIso8601 | Durata del blocco per la coda di commenti e suggerimenti. Vedere: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | corda |
| maxDeliveryCount | Numero di tentativi di recapito dell'hub IoT nella coda di feedback. Vedere: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | Int Vincoli: Valore minimo = 1 Valore massimo = 100 |
| ttlAsIso8601 | Periodo di tempo per il quale un messaggio è disponibile per l'utilizzo prima della scadenza dell'hub IoT. Vedere: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | corda |
IotHubProperties
| Nome | Descrizione | Valore |
|---|---|---|
| allowedFqdnList | Elenco degli FQDN consentiti (nome di dominio completo) per l'uscita dall'hub Iot. | string[] |
| authorizationPolicies | I criteri di accesso condiviso che è possibile usare per proteggere una connessione all'hub IoT. | SharedAccessSignatureAuthorizationRule[] |
| cloudToDevice | Proprietà di messaggistica da cloud a dispositivo dell'hub IoT. | CloudToDeviceProperties |
| Commenti | Commenti dell'hub IoT. | corda |
| deviceStreams | Le proprietà dei flussi del dispositivo di iothub. | IotHubPropertiesDeviceStreams |
| disableDeviceSAS | Se true, non è possibile usare tutte le chiavi di firma di accesso condiviso con ambito dispositivo(inclusi i dispositivi Edge ma esclusi i moduli) per l'autenticazione. | Bool |
| disableLocalAuth | Se true, non è possibile usare i token di firma di accesso condiviso con ambito hub Iot per l'autenticazione. | Bool |
| disableModuleSAS | Se true, non è possibile usare tutte le chiavi di firma di accesso condiviso con ambito modulo per l'autenticazione. | Bool |
| enableFileUploadNotifications | Se True, le notifiche di caricamento dei file sono abilitate. | Bool |
| codifica | Proprietà di crittografia per l'hub IoT. | EncryptionPropertiesDescription |
| eventHubEndpoints | Proprietà dell'endpoint compatibili con Hub eventi. Le uniche chiavi possibili per questo dizionario sono gli eventi. Questa chiave deve essere presente nel dizionario durante l'esecuzione di chiamate di creazione o aggiornamento per l'hub IoT. | IotHubPropertiesEventHubEndpoints |
| tratti somatici | Funzionalità e funzionalità abilitate per l'hub IoT. | 'DeviceManagement' 'Nessuno' |
| ipFilterRules | Regole di filtro IP. | IpFilterRule[] |
| messagingEndpoints | Proprietà dell'endpoint di messaggistica per la coda di notifica di caricamento file. | IotHubPropertiesMessagingEndpoints |
| minTlsVersion | Specifica la versione minima di TLS da supportare per questo hub. Può essere impostato su "1.2" per fare in modo che i client che usano una versione TLS precedente alla 1.2 vengano rifiutati. | corda |
| networkRuleSets | Proprietà del set di regole di rete di IotHub | NetworkRuleSetProperties |
| privateEndpointConnections | Connessioni endpoint private create in questo IotHub | PrivateEndpointConnection[] |
| publicNetworkAccess | Indica se le richieste dalla rete pubblica sono consentite | 'Disabilitato' 'Enabled' |
| restrictOutboundNetworkAccess | Se true, l'uscita da IotHub sarà limitata solo ai nomi di dominio completi consentiti configurati tramite allowedFqdnList. | Bool |
| instradamento | Proprietà correlate al routing dell'hub IoT. Vedere: /azure/iot-hub/iot-hub-devguide-messaging | RoutingProperties |
| storageEndpoints | Elenco degli endpoint di Archiviazione di Azure in cui è possibile caricare i file. Attualmente è possibile configurare un solo account di archiviazione di Azure e che DEVE avere la relativa chiave come $default. Se si specificano più account di archiviazione, viene generato un errore. Se non si specifica un valore per questa proprietà quando la proprietà enableFileUploadNotifications è impostata su True, viene generato un errore. | IotHubPropertiesStorageEndpoints |
IotHubPropertiesDeviceStreams
| Nome | Descrizione | Valore |
|---|---|---|
| streamingEndpoints | Elenco degli endpoint dei flussi di dispositivo. | string[] |
IotHubPropertiesEventHubEndpoints
| Nome | Descrizione | Valore |
|---|
IotHubPropertiesMessagingEndpoints
| Nome | Descrizione | Valore |
|---|
IotHubPropertiesStorageEndpoints
| Nome | Descrizione | Valore |
|---|
IotHubSkuInfo
| Nome | Descrizione | Valore |
|---|---|---|
| capacità | Numero di unità dell'hub IoT di cui è stato effettuato il provisioning. Vedere: /azure/azure-subscription-service-limits#iot-hub-limits. | Int |
| nome | Nome dello SKU. | 'B1' 'B2' 'B3' 'F1' 'S1' 'S2' 'S3' (obbligatorio) |
IpFilterRule
| Nome | Descrizione | Valore |
|---|---|---|
| azione | Azione desiderata per le richieste acquisite da questa regola. | 'Accept' 'Reject' (obbligatorio) |
| filterName | Nome della regola di filtro IP. | stringa (obbligatorio) |
| ipMask | Stringa che contiene l'intervallo di indirizzi IP nella notazione CIDR per la regola. | stringa (obbligatorio) |
KeyVaultKeyProperties
| Nome | Descrizione | Valore |
|---|---|---|
| identità | Proprietà dell'identità gestita di KeyVault Key. | ManagedIdentity |
| keyIdentifier | Identificatore della chiave. | corda |
ManagedIdentity
| Nome | Descrizione | Valore |
|---|---|---|
| userAssignedIdentity | Identità assegnata dall'utente. | corda |
Proprietà MessagingEndpoint
| Nome | Descrizione | Valore |
|---|---|---|
| lockDurationAsIso8601 | Durata del blocco. Vedere: /azure/iot-hub/iot-hub-devguide-file-upload. | corda |
| maxDeliveryCount | Numero di tentativi di recapitare un messaggio nell'hub IoT. Vedere: /azure/iot-hub/iot-hub-devguide-file-upload. | Int Vincoli: Valore minimo = 1 Valore massimo = 100 |
| ttlAsIso8601 | Periodo di tempo per il quale un messaggio è disponibile per l'utilizzo prima della scadenza dell'hub IoT. Vedere: /azure/iot-hub/iot-hub-devguide-file-upload. | corda |
Microsoft.Devices/IotHubs
| Nome | Descrizione | Valore |
|---|---|---|
| etag | Il campo Etag è non obbligatorio. Se viene specificato nel corpo della risposta, deve anche essere fornito come intestazione in base alla normale convenzione ETag. | corda |
| identità | Identità gestite per IotHub. | armIdentity |
| ubicazione | Percorso della risorsa. | stringa (obbligatorio) |
| nome | Nome della risorsa | stringa (obbligatorio) |
| proprietà | Proprietà IotHub | IotHubProperties |
| Sku | Informazioni sullo SKU IotHub | IotHubSkuInfo (obbligatorio) |
| Tag | Tag delle risorse | Dizionario di nomi e valori di tag. Vedere tag nei modelli |
NetworkRuleSetIpRule
| Nome | Descrizione | Valore |
|---|---|---|
| azione | Azione filtro IP | 'Consenti' |
| filterName | Nome della regola di filtro IP. | stringa (obbligatorio) |
| ipMask | Stringa che contiene l'intervallo di indirizzi IP nella notazione CIDR per la regola. | stringa (obbligatorio) |
NetworkRuleSetProperties
| Nome | Descrizione | Valore |
|---|---|---|
| applyToBuiltInEventHubEndpoint | Se True, anche il set di regole di rete viene applicato a BuiltIn EventHub EndPoint di IotHub | bool (obbligatorio) |
| defaultAction | Azione predefinita per il set di regole di rete | 'Consenti' 'Deny' |
| ipRules | Elenco delle regole IP | NetworkRuleSetIpRule[] (obbligatorio) |
PrivateEndpoint
| Nome | Descrizione | Valore |
|---|
PrivateEndpointConnection
| Nome | Descrizione | Valore |
|---|---|---|
| proprietà | Proprietà di una connessione endpoint privato | PrivateEndpointConnectionProperties (obbligatorio) |
PrivateEndpointConnectionProperties
PrivateLinkServiceConnectionState
| Nome | Descrizione | Valore |
|---|---|---|
| actionsRequired | Azioni necessarie per una connessione all'endpoint privato | corda |
| descrizione | Descrizione dello stato corrente di una connessione endpoint privato | stringa (obbligatorio) |
| stato | Stato di una connessione endpoint privato | 'Approvato' 'Disconnesso' 'In sospeso' 'Rejected' (obbligatorio) |
ResourceTags
| Nome | Descrizione | Valore |
|---|
RouteProperties
| Nome | Descrizione | Valore |
|---|---|---|
| condizione | Condizione valutata per applicare la regola di routing. Se non viene specificata alcuna condizione, restituisce true per impostazione predefinita. Per la grammatica, vedere: /azure/iot-hub/iot-hub-devguide-query-language | corda |
| endpointNames | Elenco di endpoint a cui vengono indirizzati i messaggi che soddisfano la condizione. Attualmente è consentito un solo endpoint. | string[] (obbligatorio) |
| isEnabled | Consente di specificare se una route è abilitata. | bool (obbligatorio) |
| nome | Nome della route. Il nome può includere solo caratteri alfanumerici, punti, caratteri di sottolineatura, trattini, ha una lunghezza massima di 64 caratteri e deve essere univoco. | corda Vincoli: Pattern = ^[A-Za-z0-9-._]{1,64}$ (obbligatorio) |
| fonte | Origine a cui applicare la regola di routing, ad esempio DeviceMessages. | 'DeviceConnectionStateEvents' 'DeviceJobLifecycleEvents' 'DeviceLifecycleEvents' 'DeviceMessages' 'DigitalTwinChangeEvents' 'Invalid' 'MqttBrokerMessages' 'TwinChangeEvents' (obbligatorio) |
RoutingEndpoints
| Nome | Descrizione | Valore |
|---|---|---|
| eventHubs | Elenco di endpoint di Hub eventi a cui l'hub IoT instrada i messaggi, in base alle regole di routing. Questo elenco non include l'endpoint predefinito di Hub eventi. | RoutingEventHubProperties[] |
| serviceBusQueues | Elenco di endpoint della coda del bus di servizio a cui l'hub IoT indirizza i messaggi, in base alle regole di routing. | RoutingServiceBusQueueEndpointProperties[] |
| serviceBusTopics | Elenco di endpoint dell'argomento del bus di servizio a cui l'hub IoT indirizza i messaggi, in base alle regole di routing. | RoutingServiceBusTopicEndpointProperties[] |
| storageContainers | Elenco di endpoint del contenitore di archiviazione a cui l'hub IoT instrada i messaggi in base alle regole di routing. | RoutingStorageContainerProperties[] |
RoutingEventHubProperties
| Nome | Descrizione | Valore |
|---|---|---|
| authenticationType | Metodo usato per l'autenticazione nell'endpoint dell'hub eventi | 'identityBased' 'keyBased' |
| connectionString | Stringa di connessione dell'endpoint dell'hub eventi. | corda |
| endpointUri | URL dell'endpoint dell'hub eventi. Deve includere il protocollo sb:// | corda |
| entityPath | Nome dell'hub eventi nello spazio dei nomi dell'hub eventi | corda |
| Id | ID dell'endpoint dell'hub eventi | corda |
| identità | Proprietà dell'identità gestita dell'endpoint dell'hub eventi di routing. | ManagedIdentity |
| nome | Nome che identifica questo endpoint. Il nome può includere solo caratteri alfanumerici, punti, caratteri di sottolineatura, trattini e ha una lunghezza massima di 64 caratteri. I nomi seguenti sono riservati: eventi, fileNotifications, $default. I nomi degli endpoint devono essere univoci tra i tipi di endpoint. | corda Vincoli: Pattern = ^[A-Za-z0-9-._]{1,64}$ (obbligatorio) |
| resourceGroup | Nome del gruppo di risorse dell'endpoint dell'hub eventi. | corda |
| subscriptionId | Identificatore della sottoscrizione dell'endpoint dell'hub eventi. | corda |
RoutingProprietà
| Nome | Descrizione | Valore |
|---|---|---|
| Endpoint | Le proprietà correlate agli endpoint personalizzati a cui l'hub IoT instrada i messaggi in base alle regole di routing. Un massimo di 10 endpoint personalizzati è consentito in tutti i tipi di endpoint per gli hub a pagamento e solo 1 endpoint personalizzato è consentito in tutti i tipi di endpoint per gli hub gratuiti. | routingEndpoints |
| arricchimenti | Elenco di arricchimenti forniti dall'utente che l'hub IoT applica ai messaggi da recapitare agli endpoint predefiniti e personalizzati. Vedere: https://aka.ms/telemetryoneventgrid | proprietà di arricchimento |
| fallbackRoute | Proprietà della route utilizzata come route di fallback quando non vengono soddisfatte le condizioni specificate nella sezione "route". Si tratta di un parametro facoltativo. Quando questa proprietà non è impostata, i messaggi che non soddisfano alcuna delle condizioni specificate nella sezione "route" vengono indirizzati all'endpoint eventhub predefinito. | FallbackRouteProperties |
| Itinerari | Elenco di regole di routing fornite dall'utente usate dall'hub IoT per instradare i messaggi agli endpoint predefiniti e personalizzati. Per gli hub a pagamento sono consentiti un massimo di 100 regole di routing e sono consentite un massimo di 5 regole di routing per hub gratuiti. | proprietà route[] |
RoutingServiceBusQueueEndpointProperties
| Nome | Descrizione | Valore |
|---|---|---|
| authenticationType | Metodo usato per eseguire l'autenticazione nell'endpoint della coda del bus di servizio | 'identityBased' 'keyBased' |
| connectionString | Stringa di connessione dell'endpoint della coda del bus di servizio. | corda |
| endpointUri | URL dell'endpoint della coda del bus di servizio. Deve includere il protocollo sb:// | corda |
| entityPath | Nome della coda nello spazio dei nomi del bus di servizio | corda |
| Id | ID dell'endpoint della coda del bus di servizio | corda |
| identità | Proprietà dell'identità gestita dell'endpoint della coda del bus di servizio di routing. | ManagedIdentity |
| nome | Nome che identifica questo endpoint. Il nome può includere solo caratteri alfanumerici, punti, caratteri di sottolineatura, trattini e ha una lunghezza massima di 64 caratteri. I nomi seguenti sono riservati: eventi, fileNotifications, $default. I nomi degli endpoint devono essere univoci tra i tipi di endpoint. Il nome non deve corrispondere al nome effettivo della coda. | corda Vincoli: Pattern = ^[A-Za-z0-9-._]{1,64}$ (obbligatorio) |
| resourceGroup | Nome del gruppo di risorse dell'endpoint della coda del bus di servizio. | corda |
| subscriptionId | Identificatore della sottoscrizione dell'endpoint della coda del bus di servizio. | corda |
RoutingServiceBusTopicEndpointProperties
| Nome | Descrizione | Valore |
|---|---|---|
| authenticationType | Metodo usato per eseguire l'autenticazione nell'endpoint dell'argomento del bus di servizio | 'identityBased' 'keyBased' |
| connectionString | Stringa di connessione dell'endpoint dell'argomento del bus di servizio. | corda |
| endpointUri | URL dell'endpoint dell'argomento del bus di servizio. Deve includere il protocollo sb:// | corda |
| entityPath | Nome della coda nell'argomento del bus di servizio | corda |
| Id | ID dell'endpoint dell'argomento del bus di servizio | corda |
| identità | Proprietà dell'identità gestita dell'endpoint dell'argomento del bus di servizio di routing. | ManagedIdentity |
| nome | Nome che identifica questo endpoint. Il nome può includere solo caratteri alfanumerici, punti, caratteri di sottolineatura, trattini e ha una lunghezza massima di 64 caratteri. I nomi seguenti sono riservati: eventi, fileNotifications, $default. I nomi degli endpoint devono essere univoci tra i tipi di endpoint. Il nome non deve corrispondere al nome effettivo dell'argomento. | corda Vincoli: Pattern = ^[A-Za-z0-9-._]{1,64}$ (obbligatorio) |
| resourceGroup | Nome del gruppo di risorse dell'endpoint dell'argomento del bus di servizio. | corda |
| subscriptionId | Identificatore della sottoscrizione dell'endpoint dell'argomento del bus di servizio. | corda |
RoutingStorageContainerProperties
| Nome | Descrizione | Valore |
|---|---|---|
| authenticationType | Metodo usato per l'autenticazione nell'endpoint di archiviazione | 'identityBased' 'keyBased' |
| batchFrequencyInSeconds | Intervallo di tempo in cui i BLOB vengono scritti nell'archiviazione. Il valore deve essere compreso tra 60 e 720 secondi. Il valore predefinito è 300 secondi. | Int Vincoli: Valore minimo = 60 Valore massimo = 720 |
| connectionString | Stringa di connessione dell'account di archiviazione. | corda |
| containerName | Nome del contenitore di archiviazione nell'account di archiviazione. | stringa (obbligatorio) |
| codifica | Codifica utilizzata per serializzare i messaggi nei BLOB. I valori supportati sono 'avro', 'avrodeflate' e 'JSON'. Il valore predefinito è 'avro'. | 'Avro' 'AvroDeflate' 'JSON' |
| endpointUri | URL dell'endpoint di archiviazione. Deve includere il protocollo https:// | corda |
| fileNameFormat | Formato del nome file per il BLOB. Il formato predefinito è {iothub}/{partition}/{AAAA}/{MM}/{DD}/{HH}/{mm}. Tutti i parametri sono obbligatori, ma possono essere riordinati. | corda |
| Id | ID dell'endpoint del contenitore di archiviazione | corda |
| identità | Proprietà dell'identità gestita dell'endpoint di archiviazione di routing. | ManagedIdentity |
| maxChunkSizeInBytes | Numero massimo di byte per ogni BLOB scritto nell'archivio. Il valore deve essere compreso tra 10485760(10MB) e 524288000(500 MB). Il valore predefinito è 314572800(300 MB). | Int Vincoli: Valore minimo = 10485760 Valore massimo = 524288000 |
| nome | Nome che identifica questo endpoint. Il nome può includere solo caratteri alfanumerici, punti, caratteri di sottolineatura, trattini e ha una lunghezza massima di 64 caratteri. I nomi seguenti sono riservati: eventi, fileNotifications, $default. I nomi degli endpoint devono essere univoci tra i tipi di endpoint. | corda Vincoli: Pattern = ^[A-Za-z0-9-._]{1,64}$ (obbligatorio) |
| resourceGroup | Nome del gruppo di risorse dell'account di archiviazione. | corda |
| subscriptionId | Identificatore della sottoscrizione dell'account di archiviazione. | corda |
SharedAccessSignatureAuthorizationRule
| Nome | Descrizione | Valore |
|---|---|---|
| keyName | Nome dei criteri di accesso condiviso. | stringa (obbligatorio) |
| primaryKey | Chiave primaria. | corda |
| diritti | Autorizzazioni assegnate ai criteri di accesso condiviso. | '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' (obbligatorio) |
| secondaryKey | Chiave secondaria. | corda |
StorageEndpointProperties
| Nome | Descrizione | Valore |
|---|---|---|
| authenticationType | Specifica il tipo di autenticazione usato per la connessione all'account di archiviazione. | 'identityBased' 'keyBased' |
| connectionString | Stringa di connessione per l'account di archiviazione di Azure in cui vengono caricati i file. | stringa (obbligatorio) |
| containerName | Nome del contenitore radice in cui si caricano i file. Il contenitore non deve esistere, ma deve essere creato usando connectionString specificato. | stringa (obbligatorio) |
| identità | Proprietà dell'identità gestita dell'endpoint di archiviazione per il caricamento di file. | ManagedIdentity |
| sasTtlAsIso8601 | Periodo di tempo per il quale l'URI di firma di accesso condiviso generato dall'hub IoT per il caricamento di file è valido. Vedere: /azure/iot-hub/iot-hub-devguide-file-upload#file-upload-upload-notification-configuration-options. | corda |
Esempi di avvio rapido
Gli esempi di avvio rapido seguenti distribuiscono questo tipo di risorsa.
| Bicep File | Descrizione |
|---|---|
| Creare un hub IoT e un gruppo di consumer da dispositivo a cloud | Questo modello consente di distribuire un'istanza dell'hub IoT con dispositivo nel cloud e nel cloud nelle configurazioni di messaggistica dei dispositivi e un dispositivo nel gruppo di consumer cloud. |
| Creare un servizio Device Provisioning in hub IoT | Questo modello consente di creare un hub IoT e un servizio Device Provisioning in hub IoT e collegare i due servizi. |
| Creare l'aggiornamento dei dispositivi per l'account dell'hub IoT, l'istanza, l'hub IoT | Questo modello crea un account e un'istanza e un hub con cui collegare l'istanza. Configura l'hub con i criteri di accesso, le route e il gruppo di consumer necessari. |
| Distribuire il servizio MedTech, incluso un hub IoT di Azure | Il servizio MedTech è uno dei servizi dati di Integrità di Azure progettato per inserire i dati dei dispositivi da più dispositivi, trasformare i dati del dispositivo in osservazioni FHIR, che vengono quindi mantenuti nel servizio FHIR di Servizi dati di integrità di Azure. |
| Usare il modello di Resource Manager per creare l'hub IoT, indirizzare e visualizzare i messaggi | Usare questo modello per distribuire un hub IoT e un account di archiviazione. Eseguire un'app per inviare messaggi all'hub indirizzati all'archiviazione, quindi visualizzare i risultati. |
Definizione di risorsa del modello di Resource Manager
Il tipo di risorsa IotHubs può essere distribuito con operazioni destinate a:
Per un elenco delle proprietà modificate in ogni versione dell'API, vedere log delle modifiche.
Formato risorsa
Per creare una risorsa Microsoft.Devices/IotHubs, aggiungere il codice JSON seguente al modello.
{
"type": "Microsoft.Devices/IotHubs",
"apiVersion": "2021-07-01-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",
"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"
}
],
"messagingEndpoints": {
"{customized property}": {
"lockDurationAsIso8601": "string",
"maxDeliveryCount": "int",
"ttlAsIso8601": "string"
}
},
"minTlsVersion": "string",
"networkRuleSets": {
"applyToBuiltInEventHubEndpoint": "bool",
"defaultAction": "string",
"ipRules": [
{
"action": "string",
"filterName": "string",
"ipMask": "string"
}
]
},
"privateEndpointConnections": [
{
"properties": {
"privateEndpoint": {
},
"privateLinkServiceConnectionState": {
"actionsRequired": "string",
"description": "string",
"status": "string"
}
}
}
],
"publicNetworkAccess": "string",
"restrictOutboundNetworkAccess": "bool",
"routing": {
"endpoints": {
"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"
}
}
Valori delle proprietà
ArmIdentity
| Nome | Descrizione | Valore |
|---|---|---|
| digitare | Tipo di identità usata per la risorsa. Il tipo 'SystemAssigned,UserAssigned' include sia un'identità creata in modo implicito che un set di identità assegnate dall'utente. Il tipo 'None' rimuoverà tutte le identità dal servizio. | 'Nessuno' 'SystemAssigned' 'SystemAssigned, UserAssigned' 'UserAssigned' |
| userAssignedIdentities | Dizionario di <armUserIdentity> | ArmIdentityUserAssignedIdentities |
ArmIdentityUserAssignedIdentities
| Nome | Descrizione | Valore |
|---|
ArmUserIdentity
| Nome | Descrizione | Valore |
|---|
CloudToDeviceProperties
| Nome | Descrizione | Valore |
|---|---|---|
| defaultTtlAsIso8601 | Durata predefinita per i messaggi da cloud a dispositivo nella coda del dispositivo. Vedere: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | corda |
| Valutazione | Proprietà della coda di feedback per i messaggi da cloud a dispositivo. | FeedbackProprietà |
| maxDeliveryCount | Numero massimo di recapito per i messaggi da cloud a dispositivo nella coda del dispositivo. Vedere: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | Int Vincoli: Valore minimo = 1 Valore massimo = 100 |
EncryptionPropertiesDescription
| Nome | Descrizione | Valore |
|---|---|---|
| keySource | Origine della chiave. | corda |
| keyVaultProperties | Proprietà della chiave dell'insieme di credenziali delle chiavi. | KeyVaultKeyProperties[] |
Proprietà di arricchimento
| Nome | Descrizione | Valore |
|---|---|---|
| endpointNames | Elenco di endpoint per cui viene applicato l'arricchimento al messaggio. | string[] (obbligatorio) |
| chiave | Chiave o nome per la proprietà di arricchimento. | stringa (obbligatorio) |
| valore | Valore per la proprietà di arricchimento. | stringa (obbligatorio) |
EventHubProperties
| Nome | Descrizione | Valore |
|---|---|---|
| partitionCount | Numero di partizioni per la ricezione di messaggi da dispositivo a cloud nell'endpoint compatibile con Hub eventi. Vedere: /azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages. | Int |
| retentionTimeInDays | Tempo di conservazione per i messaggi da dispositivo a cloud in giorni. Vedere: /azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages | Int |
FallbackRouteProperties
| Nome | Descrizione | Valore |
|---|---|---|
| condizione | Condizione valutata per applicare la route di fallback. Se la condizione non viene fornita, restituisce true per impostazione predefinita. Per la grammatica, vedere: /azure/iot-hub/iot-hub-devguide-query-language | corda |
| endpointNames | Elenco di endpoint a cui vengono indirizzati i messaggi che soddisfano la condizione. Attualmente è consentito solo 1 endpoint. | string[] (obbligatorio) |
| isEnabled | Consente di specificare se la route di fallback è abilitata. | bool (obbligatorio) |
| nome | Nome della route. Il nome può includere solo caratteri alfanumerici, punti, caratteri di sottolineatura, trattini, ha una lunghezza massima di 64 caratteri e deve essere univoco. | corda |
| fonte | Origine a cui applicare la regola di routing. Ad esempio, DeviceMessages | 'DeviceConnectionStateEvents' 'DeviceJobLifecycleEvents' 'DeviceLifecycleEvents' 'DeviceMessages' 'DigitalTwinChangeEvents' 'Invalid' 'MqttBrokerMessages' 'TwinChangeEvents' (obbligatorio) |
FeedbackProperties
| Nome | Descrizione | Valore |
|---|---|---|
| lockDurationAsIso8601 | Durata del blocco per la coda di commenti e suggerimenti. Vedere: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | corda |
| maxDeliveryCount | Numero di tentativi di recapito dell'hub IoT nella coda di feedback. Vedere: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | Int Vincoli: Valore minimo = 1 Valore massimo = 100 |
| ttlAsIso8601 | Periodo di tempo per il quale un messaggio è disponibile per l'utilizzo prima della scadenza dell'hub IoT. Vedere: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | corda |
IotHubProperties
| Nome | Descrizione | Valore |
|---|---|---|
| allowedFqdnList | Elenco degli FQDN consentiti (nome di dominio completo) per l'uscita dall'hub Iot. | string[] |
| authorizationPolicies | I criteri di accesso condiviso che è possibile usare per proteggere una connessione all'hub IoT. | SharedAccessSignatureAuthorizationRule[] |
| cloudToDevice | Proprietà di messaggistica da cloud a dispositivo dell'hub IoT. | CloudToDeviceProperties |
| Commenti | Commenti dell'hub IoT. | corda |
| deviceStreams | Le proprietà dei flussi del dispositivo di iothub. | IotHubPropertiesDeviceStreams |
| disableDeviceSAS | Se true, non è possibile usare tutte le chiavi di firma di accesso condiviso con ambito dispositivo(inclusi i dispositivi Edge ma esclusi i moduli) per l'autenticazione. | Bool |
| disableLocalAuth | Se true, non è possibile usare i token di firma di accesso condiviso con ambito hub Iot per l'autenticazione. | Bool |
| disableModuleSAS | Se true, non è possibile usare tutte le chiavi di firma di accesso condiviso con ambito modulo per l'autenticazione. | Bool |
| enableFileUploadNotifications | Se True, le notifiche di caricamento dei file sono abilitate. | Bool |
| codifica | Proprietà di crittografia per l'hub IoT. | EncryptionPropertiesDescription |
| eventHubEndpoints | Proprietà dell'endpoint compatibili con Hub eventi. Le uniche chiavi possibili per questo dizionario sono gli eventi. Questa chiave deve essere presente nel dizionario durante l'esecuzione di chiamate di creazione o aggiornamento per l'hub IoT. | IotHubPropertiesEventHubEndpoints |
| tratti somatici | Funzionalità e funzionalità abilitate per l'hub IoT. | 'DeviceManagement' 'Nessuno' |
| ipFilterRules | Regole di filtro IP. | IpFilterRule[] |
| messagingEndpoints | Proprietà dell'endpoint di messaggistica per la coda di notifica di caricamento file. | IotHubPropertiesMessagingEndpoints |
| minTlsVersion | Specifica la versione minima di TLS da supportare per questo hub. Può essere impostato su "1.2" per fare in modo che i client che usano una versione TLS precedente alla 1.2 vengano rifiutati. | corda |
| networkRuleSets | Proprietà del set di regole di rete di IotHub | NetworkRuleSetProperties |
| privateEndpointConnections | Connessioni endpoint private create in questo IotHub | PrivateEndpointConnection[] |
| publicNetworkAccess | Indica se le richieste dalla rete pubblica sono consentite | 'Disabilitato' 'Enabled' |
| restrictOutboundNetworkAccess | Se true, l'uscita da IotHub sarà limitata solo ai nomi di dominio completi consentiti configurati tramite allowedFqdnList. | Bool |
| instradamento | Proprietà correlate al routing dell'hub IoT. Vedere: /azure/iot-hub/iot-hub-devguide-messaging | RoutingProperties |
| storageEndpoints | Elenco degli endpoint di Archiviazione di Azure in cui è possibile caricare i file. Attualmente è possibile configurare un solo account di archiviazione di Azure e che DEVE avere la relativa chiave come $default. Se si specificano più account di archiviazione, viene generato un errore. Se non si specifica un valore per questa proprietà quando la proprietà enableFileUploadNotifications è impostata su True, viene generato un errore. | IotHubPropertiesStorageEndpoints |
IotHubPropertiesDeviceStreams
| Nome | Descrizione | Valore |
|---|---|---|
| streamingEndpoints | Elenco degli endpoint dei flussi di dispositivo. | string[] |
IotHubPropertiesEventHubEndpoints
| Nome | Descrizione | Valore |
|---|
IotHubPropertiesMessagingEndpoints
| Nome | Descrizione | Valore |
|---|
IotHubPropertiesStorageEndpoints
| Nome | Descrizione | Valore |
|---|
IotHubSkuInfo
| Nome | Descrizione | Valore |
|---|---|---|
| capacità | Numero di unità dell'hub IoT di cui è stato effettuato il provisioning. Vedere: /azure/azure-subscription-service-limits#iot-hub-limits. | Int |
| nome | Nome dello SKU. | 'B1' 'B2' 'B3' 'F1' 'S1' 'S2' 'S3' (obbligatorio) |
IpFilterRule
| Nome | Descrizione | Valore |
|---|---|---|
| azione | Azione desiderata per le richieste acquisite da questa regola. | 'Accept' 'Reject' (obbligatorio) |
| filterName | Nome della regola di filtro IP. | stringa (obbligatorio) |
| ipMask | Stringa che contiene l'intervallo di indirizzi IP nella notazione CIDR per la regola. | stringa (obbligatorio) |
KeyVaultKeyProperties
| Nome | Descrizione | Valore |
|---|---|---|
| identità | Proprietà dell'identità gestita di KeyVault Key. | ManagedIdentity |
| keyIdentifier | Identificatore della chiave. | corda |
ManagedIdentity
| Nome | Descrizione | Valore |
|---|---|---|
| userAssignedIdentity | Identità assegnata dall'utente. | corda |
Proprietà MessagingEndpoint
| Nome | Descrizione | Valore |
|---|---|---|
| lockDurationAsIso8601 | Durata del blocco. Vedere: /azure/iot-hub/iot-hub-devguide-file-upload. | corda |
| maxDeliveryCount | Numero di tentativi di recapitare un messaggio nell'hub IoT. Vedere: /azure/iot-hub/iot-hub-devguide-file-upload. | Int Vincoli: Valore minimo = 1 Valore massimo = 100 |
| ttlAsIso8601 | Periodo di tempo per il quale un messaggio è disponibile per l'utilizzo prima della scadenza dell'hub IoT. Vedere: /azure/iot-hub/iot-hub-devguide-file-upload. | corda |
Microsoft.Devices/IotHubs
| Nome | Descrizione | Valore |
|---|---|---|
| apiVersion | Versione dell'API | '2021-07-01-preview' |
| etag | Il campo Etag è non obbligatorio. Se viene specificato nel corpo della risposta, deve anche essere fornito come intestazione in base alla normale convenzione ETag. | corda |
| identità | Identità gestite per IotHub. | armIdentity |
| ubicazione | Percorso della risorsa. | stringa (obbligatorio) |
| nome | Nome della risorsa | stringa (obbligatorio) |
| proprietà | Proprietà IotHub | IotHubProperties |
| Sku | Informazioni sullo SKU IotHub | IotHubSkuInfo (obbligatorio) |
| Tag | Tag delle risorse | Dizionario di nomi e valori di tag. Vedere tag nei modelli |
| digitare | Tipo di risorsa | 'Microsoft.Devices/IotHubs' |
NetworkRuleSetIpRule
| Nome | Descrizione | Valore |
|---|---|---|
| azione | Azione filtro IP | 'Consenti' |
| filterName | Nome della regola di filtro IP. | stringa (obbligatorio) |
| ipMask | Stringa che contiene l'intervallo di indirizzi IP nella notazione CIDR per la regola. | stringa (obbligatorio) |
NetworkRuleSetProperties
| Nome | Descrizione | Valore |
|---|---|---|
| applyToBuiltInEventHubEndpoint | Se True, anche il set di regole di rete viene applicato a BuiltIn EventHub EndPoint di IotHub | bool (obbligatorio) |
| defaultAction | Azione predefinita per il set di regole di rete | 'Consenti' 'Deny' |
| ipRules | Elenco delle regole IP | NetworkRuleSetIpRule[] (obbligatorio) |
PrivateEndpoint
| Nome | Descrizione | Valore |
|---|
PrivateEndpointConnection
| Nome | Descrizione | Valore |
|---|---|---|
| proprietà | Proprietà di una connessione endpoint privato | PrivateEndpointConnectionProperties (obbligatorio) |
PrivateEndpointConnectionProperties
PrivateLinkServiceConnectionState
| Nome | Descrizione | Valore |
|---|---|---|
| actionsRequired | Azioni necessarie per una connessione all'endpoint privato | corda |
| descrizione | Descrizione dello stato corrente di una connessione endpoint privato | stringa (obbligatorio) |
| stato | Stato di una connessione endpoint privato | 'Approvato' 'Disconnesso' 'In sospeso' 'Rejected' (obbligatorio) |
ResourceTags
| Nome | Descrizione | Valore |
|---|
RouteProperties
| Nome | Descrizione | Valore |
|---|---|---|
| condizione | Condizione valutata per applicare la regola di routing. Se non viene specificata alcuna condizione, restituisce true per impostazione predefinita. Per la grammatica, vedere: /azure/iot-hub/iot-hub-devguide-query-language | corda |
| endpointNames | Elenco di endpoint a cui vengono indirizzati i messaggi che soddisfano la condizione. Attualmente è consentito un solo endpoint. | string[] (obbligatorio) |
| isEnabled | Consente di specificare se una route è abilitata. | bool (obbligatorio) |
| nome | Nome della route. Il nome può includere solo caratteri alfanumerici, punti, caratteri di sottolineatura, trattini, ha una lunghezza massima di 64 caratteri e deve essere univoco. | corda Vincoli: Pattern = ^[A-Za-z0-9-._]{1,64}$ (obbligatorio) |
| fonte | Origine a cui applicare la regola di routing, ad esempio DeviceMessages. | 'DeviceConnectionStateEvents' 'DeviceJobLifecycleEvents' 'DeviceLifecycleEvents' 'DeviceMessages' 'DigitalTwinChangeEvents' 'Invalid' 'MqttBrokerMessages' 'TwinChangeEvents' (obbligatorio) |
RoutingEndpoints
| Nome | Descrizione | Valore |
|---|---|---|
| eventHubs | Elenco di endpoint di Hub eventi a cui l'hub IoT instrada i messaggi, in base alle regole di routing. Questo elenco non include l'endpoint predefinito di Hub eventi. | RoutingEventHubProperties[] |
| serviceBusQueues | Elenco di endpoint della coda del bus di servizio a cui l'hub IoT indirizza i messaggi, in base alle regole di routing. | RoutingServiceBusQueueEndpointProperties[] |
| serviceBusTopics | Elenco di endpoint dell'argomento del bus di servizio a cui l'hub IoT indirizza i messaggi, in base alle regole di routing. | RoutingServiceBusTopicEndpointProperties[] |
| storageContainers | Elenco di endpoint del contenitore di archiviazione a cui l'hub IoT instrada i messaggi in base alle regole di routing. | RoutingStorageContainerProperties[] |
RoutingEventHubProperties
| Nome | Descrizione | Valore |
|---|---|---|
| authenticationType | Metodo usato per l'autenticazione nell'endpoint dell'hub eventi | 'identityBased' 'keyBased' |
| connectionString | Stringa di connessione dell'endpoint dell'hub eventi. | corda |
| endpointUri | URL dell'endpoint dell'hub eventi. Deve includere il protocollo sb:// | corda |
| entityPath | Nome dell'hub eventi nello spazio dei nomi dell'hub eventi | corda |
| Id | ID dell'endpoint dell'hub eventi | corda |
| identità | Proprietà dell'identità gestita dell'endpoint dell'hub eventi di routing. | ManagedIdentity |
| nome | Nome che identifica questo endpoint. Il nome può includere solo caratteri alfanumerici, punti, caratteri di sottolineatura, trattini e ha una lunghezza massima di 64 caratteri. I nomi seguenti sono riservati: eventi, fileNotifications, $default. I nomi degli endpoint devono essere univoci tra i tipi di endpoint. | corda Vincoli: Pattern = ^[A-Za-z0-9-._]{1,64}$ (obbligatorio) |
| resourceGroup | Nome del gruppo di risorse dell'endpoint dell'hub eventi. | corda |
| subscriptionId | Identificatore della sottoscrizione dell'endpoint dell'hub eventi. | corda |
RoutingProprietà
| Nome | Descrizione | Valore |
|---|---|---|
| Endpoint | Le proprietà correlate agli endpoint personalizzati a cui l'hub IoT instrada i messaggi in base alle regole di routing. Un massimo di 10 endpoint personalizzati è consentito in tutti i tipi di endpoint per gli hub a pagamento e solo 1 endpoint personalizzato è consentito in tutti i tipi di endpoint per gli hub gratuiti. | routingEndpoints |
| arricchimenti | Elenco di arricchimenti forniti dall'utente che l'hub IoT applica ai messaggi da recapitare agli endpoint predefiniti e personalizzati. Vedere: https://aka.ms/telemetryoneventgrid | proprietà di arricchimento |
| fallbackRoute | Proprietà della route utilizzata come route di fallback quando non vengono soddisfatte le condizioni specificate nella sezione "route". Si tratta di un parametro facoltativo. Quando questa proprietà non è impostata, i messaggi che non soddisfano alcuna delle condizioni specificate nella sezione "route" vengono indirizzati all'endpoint eventhub predefinito. | FallbackRouteProperties |
| Itinerari | Elenco di regole di routing fornite dall'utente usate dall'hub IoT per instradare i messaggi agli endpoint predefiniti e personalizzati. Per gli hub a pagamento sono consentiti un massimo di 100 regole di routing e sono consentite un massimo di 5 regole di routing per hub gratuiti. | proprietà route[] |
RoutingServiceBusQueueEndpointProperties
| Nome | Descrizione | Valore |
|---|---|---|
| authenticationType | Metodo usato per eseguire l'autenticazione nell'endpoint della coda del bus di servizio | 'identityBased' 'keyBased' |
| connectionString | Stringa di connessione dell'endpoint della coda del bus di servizio. | corda |
| endpointUri | URL dell'endpoint della coda del bus di servizio. Deve includere il protocollo sb:// | corda |
| entityPath | Nome della coda nello spazio dei nomi del bus di servizio | corda |
| Id | ID dell'endpoint della coda del bus di servizio | corda |
| identità | Proprietà dell'identità gestita dell'endpoint della coda del bus di servizio di routing. | ManagedIdentity |
| nome | Nome che identifica questo endpoint. Il nome può includere solo caratteri alfanumerici, punti, caratteri di sottolineatura, trattini e ha una lunghezza massima di 64 caratteri. I nomi seguenti sono riservati: eventi, fileNotifications, $default. I nomi degli endpoint devono essere univoci tra i tipi di endpoint. Il nome non deve corrispondere al nome effettivo della coda. | corda Vincoli: Pattern = ^[A-Za-z0-9-._]{1,64}$ (obbligatorio) |
| resourceGroup | Nome del gruppo di risorse dell'endpoint della coda del bus di servizio. | corda |
| subscriptionId | Identificatore della sottoscrizione dell'endpoint della coda del bus di servizio. | corda |
RoutingServiceBusTopicEndpointProperties
| Nome | Descrizione | Valore |
|---|---|---|
| authenticationType | Metodo usato per eseguire l'autenticazione nell'endpoint dell'argomento del bus di servizio | 'identityBased' 'keyBased' |
| connectionString | Stringa di connessione dell'endpoint dell'argomento del bus di servizio. | corda |
| endpointUri | URL dell'endpoint dell'argomento del bus di servizio. Deve includere il protocollo sb:// | corda |
| entityPath | Nome della coda nell'argomento del bus di servizio | corda |
| Id | ID dell'endpoint dell'argomento del bus di servizio | corda |
| identità | Proprietà dell'identità gestita dell'endpoint dell'argomento del bus di servizio di routing. | ManagedIdentity |
| nome | Nome che identifica questo endpoint. Il nome può includere solo caratteri alfanumerici, punti, caratteri di sottolineatura, trattini e ha una lunghezza massima di 64 caratteri. I nomi seguenti sono riservati: eventi, fileNotifications, $default. I nomi degli endpoint devono essere univoci tra i tipi di endpoint. Il nome non deve corrispondere al nome effettivo dell'argomento. | corda Vincoli: Pattern = ^[A-Za-z0-9-._]{1,64}$ (obbligatorio) |
| resourceGroup | Nome del gruppo di risorse dell'endpoint dell'argomento del bus di servizio. | corda |
| subscriptionId | Identificatore della sottoscrizione dell'endpoint dell'argomento del bus di servizio. | corda |
RoutingStorageContainerProperties
| Nome | Descrizione | Valore |
|---|---|---|
| authenticationType | Metodo usato per l'autenticazione nell'endpoint di archiviazione | 'identityBased' 'keyBased' |
| batchFrequencyInSeconds | Intervallo di tempo in cui i BLOB vengono scritti nell'archiviazione. Il valore deve essere compreso tra 60 e 720 secondi. Il valore predefinito è 300 secondi. | Int Vincoli: Valore minimo = 60 Valore massimo = 720 |
| connectionString | Stringa di connessione dell'account di archiviazione. | corda |
| containerName | Nome del contenitore di archiviazione nell'account di archiviazione. | stringa (obbligatorio) |
| codifica | Codifica utilizzata per serializzare i messaggi nei BLOB. I valori supportati sono 'avro', 'avrodeflate' e 'JSON'. Il valore predefinito è 'avro'. | 'Avro' 'AvroDeflate' 'JSON' |
| endpointUri | URL dell'endpoint di archiviazione. Deve includere il protocollo https:// | corda |
| fileNameFormat | Formato del nome file per il BLOB. Il formato predefinito è {iothub}/{partition}/{AAAA}/{MM}/{DD}/{HH}/{mm}. Tutti i parametri sono obbligatori, ma possono essere riordinati. | corda |
| Id | ID dell'endpoint del contenitore di archiviazione | corda |
| identità | Proprietà dell'identità gestita dell'endpoint di archiviazione di routing. | ManagedIdentity |
| maxChunkSizeInBytes | Numero massimo di byte per ogni BLOB scritto nell'archivio. Il valore deve essere compreso tra 10485760(10MB) e 524288000(500 MB). Il valore predefinito è 314572800(300 MB). | Int Vincoli: Valore minimo = 10485760 Valore massimo = 524288000 |
| nome | Nome che identifica questo endpoint. Il nome può includere solo caratteri alfanumerici, punti, caratteri di sottolineatura, trattini e ha una lunghezza massima di 64 caratteri. I nomi seguenti sono riservati: eventi, fileNotifications, $default. I nomi degli endpoint devono essere univoci tra i tipi di endpoint. | corda Vincoli: Pattern = ^[A-Za-z0-9-._]{1,64}$ (obbligatorio) |
| resourceGroup | Nome del gruppo di risorse dell'account di archiviazione. | corda |
| subscriptionId | Identificatore della sottoscrizione dell'account di archiviazione. | corda |
SharedAccessSignatureAuthorizationRule
| Nome | Descrizione | Valore |
|---|---|---|
| keyName | Nome dei criteri di accesso condiviso. | stringa (obbligatorio) |
| primaryKey | Chiave primaria. | corda |
| diritti | Autorizzazioni assegnate ai criteri di accesso condiviso. | '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' (obbligatorio) |
| secondaryKey | Chiave secondaria. | corda |
StorageEndpointProperties
| Nome | Descrizione | Valore |
|---|---|---|
| authenticationType | Specifica il tipo di autenticazione usato per la connessione all'account di archiviazione. | 'identityBased' 'keyBased' |
| connectionString | Stringa di connessione per l'account di archiviazione di Azure in cui vengono caricati i file. | stringa (obbligatorio) |
| containerName | Nome del contenitore radice in cui si caricano i file. Il contenitore non deve esistere, ma deve essere creato usando connectionString specificato. | stringa (obbligatorio) |
| identità | Proprietà dell'identità gestita dell'endpoint di archiviazione per il caricamento di file. | ManagedIdentity |
| sasTtlAsIso8601 | Periodo di tempo per il quale l'URI di firma di accesso condiviso generato dall'hub IoT per il caricamento di file è valido. Vedere: /azure/iot-hub/iot-hub-devguide-file-upload#file-upload-upload-notification-configuration-options. | corda |
Modelli di avvio rapido
I modelli di avvio rapido seguenti distribuiscono questo tipo di risorsa.
| Sagoma | Descrizione |
|---|---|
Creare un ambiente con pagamento in base al consumo con un hub IoT
|
Questo modello consente di distribuire un ambiente Time Series Insights con pagamento in base al consumo configurato per l'utilizzo di eventi da un hub IoT. |
|
Creare un hub IoT e un gruppo di consumer da dispositivo a cloud
|
Questo modello consente di distribuire un'istanza dell'hub IoT con dispositivo nel cloud e nel cloud nelle configurazioni di messaggistica dei dispositivi e un dispositivo nel gruppo di consumer cloud. |
|
Creare un hub IOT e un simulatore perimetrale Ubuntu
|
Questo modello crea un hub IOT e un simulatore perimetrale Ubuntu della macchina virtuale. |
|
Creare un servizio Device Provisioning in hub IoT
|
Questo modello consente di creare un hub IoT e un servizio Device Provisioning in hub IoT e collegare i due servizi. |
|
Creare l'aggiornamento dei dispositivi per l'account dell'hub IoT, l'istanza, l'hub IoT
|
Questo modello crea un account e un'istanza e un hub con cui collegare l'istanza. Configura l'hub con i criteri di accesso, le route e il gruppo di consumer necessari. |
|
Distribuire il servizio MedTech, incluso un hub IoT di Azure
|
Il servizio MedTech è uno dei servizi dati di Integrità di Azure progettato per inserire i dati dei dispositivi da più dispositivi, trasformare i dati del dispositivo in osservazioni FHIR, che vengono quindi mantenuti nel servizio FHIR di Servizi dati di integrità di Azure. |
|
Usare il modello di Resource Manager per creare l'hub IoT, indirizzare e visualizzare i messaggi
|
Usare questo modello per distribuire un hub IoT e un account di archiviazione. Eseguire un'app per inviare messaggi all'hub indirizzati all'archiviazione, quindi visualizzare i risultati. |
Definizione di risorsa Terraform (provider AzAPI)
Il tipo di risorsa IotHubs può essere distribuito con operazioni destinate a:
- gruppi di risorse
Per un elenco delle proprietà modificate in ogni versione dell'API, vedere log delle modifiche.
Formato risorsa
Per creare una risorsa Microsoft.Devices/IotHubs, aggiungere il comando Terraform seguente al modello.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Devices/IotHubs@2021-07-01-preview"
name = "string"
etag = "string"
identity = {
type = "string"
userAssignedIdentities = {
{customized property} = {
}
}
}
location = "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
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"
}
]
messagingEndpoints = {
{customized property} = {
lockDurationAsIso8601 = "string"
maxDeliveryCount = int
ttlAsIso8601 = "string"
}
}
minTlsVersion = "string"
networkRuleSets = {
applyToBuiltInEventHubEndpoint = bool
defaultAction = "string"
ipRules = [
{
action = "string"
filterName = "string"
ipMask = "string"
}
]
}
privateEndpointConnections = [
{
properties = {
privateEndpoint = {
}
privateLinkServiceConnectionState = {
actionsRequired = "string"
description = "string"
status = "string"
}
}
}
]
publicNetworkAccess = "string"
restrictOutboundNetworkAccess = bool
routing = {
endpoints = {
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"
}
}
Valori delle proprietà
ArmIdentity
| Nome | Descrizione | Valore |
|---|---|---|
| digitare | Tipo di identità usata per la risorsa. Il tipo 'SystemAssigned,UserAssigned' include sia un'identità creata in modo implicito che un set di identità assegnate dall'utente. Il tipo 'None' rimuoverà tutte le identità dal servizio. | 'Nessuno' 'SystemAssigned' 'SystemAssigned, UserAssigned' 'UserAssigned' |
| userAssignedIdentities | Dizionario di <armUserIdentity> | ArmIdentityUserAssignedIdentities |
ArmIdentityUserAssignedIdentities
| Nome | Descrizione | Valore |
|---|
ArmUserIdentity
| Nome | Descrizione | Valore |
|---|
CloudToDeviceProperties
| Nome | Descrizione | Valore |
|---|---|---|
| defaultTtlAsIso8601 | Durata predefinita per i messaggi da cloud a dispositivo nella coda del dispositivo. Vedere: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | corda |
| Valutazione | Proprietà della coda di feedback per i messaggi da cloud a dispositivo. | FeedbackProprietà |
| maxDeliveryCount | Numero massimo di recapito per i messaggi da cloud a dispositivo nella coda del dispositivo. Vedere: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | Int Vincoli: Valore minimo = 1 Valore massimo = 100 |
EncryptionPropertiesDescription
| Nome | Descrizione | Valore |
|---|---|---|
| keySource | Origine della chiave. | corda |
| keyVaultProperties | Proprietà della chiave dell'insieme di credenziali delle chiavi. | KeyVaultKeyProperties[] |
Proprietà di arricchimento
| Nome | Descrizione | Valore |
|---|---|---|
| endpointNames | Elenco di endpoint per cui viene applicato l'arricchimento al messaggio. | string[] (obbligatorio) |
| chiave | Chiave o nome per la proprietà di arricchimento. | stringa (obbligatorio) |
| valore | Valore per la proprietà di arricchimento. | stringa (obbligatorio) |
EventHubProperties
| Nome | Descrizione | Valore |
|---|---|---|
| partitionCount | Numero di partizioni per la ricezione di messaggi da dispositivo a cloud nell'endpoint compatibile con Hub eventi. Vedere: /azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages. | Int |
| retentionTimeInDays | Tempo di conservazione per i messaggi da dispositivo a cloud in giorni. Vedere: /azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages | Int |
FallbackRouteProperties
| Nome | Descrizione | Valore |
|---|---|---|
| condizione | Condizione valutata per applicare la route di fallback. Se la condizione non viene fornita, restituisce true per impostazione predefinita. Per la grammatica, vedere: /azure/iot-hub/iot-hub-devguide-query-language | corda |
| endpointNames | Elenco di endpoint a cui vengono indirizzati i messaggi che soddisfano la condizione. Attualmente è consentito solo 1 endpoint. | string[] (obbligatorio) |
| isEnabled | Consente di specificare se la route di fallback è abilitata. | bool (obbligatorio) |
| nome | Nome della route. Il nome può includere solo caratteri alfanumerici, punti, caratteri di sottolineatura, trattini, ha una lunghezza massima di 64 caratteri e deve essere univoco. | corda |
| fonte | Origine a cui applicare la regola di routing. Ad esempio, DeviceMessages | 'DeviceConnectionStateEvents' 'DeviceJobLifecycleEvents' 'DeviceLifecycleEvents' 'DeviceMessages' 'DigitalTwinChangeEvents' 'Invalid' 'MqttBrokerMessages' 'TwinChangeEvents' (obbligatorio) |
FeedbackProperties
| Nome | Descrizione | Valore |
|---|---|---|
| lockDurationAsIso8601 | Durata del blocco per la coda di commenti e suggerimenti. Vedere: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | corda |
| maxDeliveryCount | Numero di tentativi di recapito dell'hub IoT nella coda di feedback. Vedere: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | Int Vincoli: Valore minimo = 1 Valore massimo = 100 |
| ttlAsIso8601 | Periodo di tempo per il quale un messaggio è disponibile per l'utilizzo prima della scadenza dell'hub IoT. Vedere: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | corda |
IotHubProperties
| Nome | Descrizione | Valore |
|---|---|---|
| allowedFqdnList | Elenco degli FQDN consentiti (nome di dominio completo) per l'uscita dall'hub Iot. | string[] |
| authorizationPolicies | I criteri di accesso condiviso che è possibile usare per proteggere una connessione all'hub IoT. | SharedAccessSignatureAuthorizationRule[] |
| cloudToDevice | Proprietà di messaggistica da cloud a dispositivo dell'hub IoT. | CloudToDeviceProperties |
| Commenti | Commenti dell'hub IoT. | corda |
| deviceStreams | Le proprietà dei flussi del dispositivo di iothub. | IotHubPropertiesDeviceStreams |
| disableDeviceSAS | Se true, non è possibile usare tutte le chiavi di firma di accesso condiviso con ambito dispositivo(inclusi i dispositivi Edge ma esclusi i moduli) per l'autenticazione. | Bool |
| disableLocalAuth | Se true, non è possibile usare i token di firma di accesso condiviso con ambito hub Iot per l'autenticazione. | Bool |
| disableModuleSAS | Se true, non è possibile usare tutte le chiavi di firma di accesso condiviso con ambito modulo per l'autenticazione. | Bool |
| enableFileUploadNotifications | Se True, le notifiche di caricamento dei file sono abilitate. | Bool |
| codifica | Proprietà di crittografia per l'hub IoT. | EncryptionPropertiesDescription |
| eventHubEndpoints | Proprietà dell'endpoint compatibili con Hub eventi. Le uniche chiavi possibili per questo dizionario sono gli eventi. Questa chiave deve essere presente nel dizionario durante l'esecuzione di chiamate di creazione o aggiornamento per l'hub IoT. | IotHubPropertiesEventHubEndpoints |
| tratti somatici | Funzionalità e funzionalità abilitate per l'hub IoT. | 'DeviceManagement' 'Nessuno' |
| ipFilterRules | Regole di filtro IP. | IpFilterRule[] |
| messagingEndpoints | Proprietà dell'endpoint di messaggistica per la coda di notifica di caricamento file. | IotHubPropertiesMessagingEndpoints |
| minTlsVersion | Specifica la versione minima di TLS da supportare per questo hub. Può essere impostato su "1.2" per fare in modo che i client che usano una versione TLS precedente alla 1.2 vengano rifiutati. | corda |
| networkRuleSets | Proprietà del set di regole di rete di IotHub | NetworkRuleSetProperties |
| privateEndpointConnections | Connessioni endpoint private create in questo IotHub | PrivateEndpointConnection[] |
| publicNetworkAccess | Indica se le richieste dalla rete pubblica sono consentite | 'Disabilitato' 'Enabled' |
| restrictOutboundNetworkAccess | Se true, l'uscita da IotHub sarà limitata solo ai nomi di dominio completi consentiti configurati tramite allowedFqdnList. | Bool |
| instradamento | Proprietà correlate al routing dell'hub IoT. Vedere: /azure/iot-hub/iot-hub-devguide-messaging | RoutingProperties |
| storageEndpoints | Elenco degli endpoint di Archiviazione di Azure in cui è possibile caricare i file. Attualmente è possibile configurare un solo account di archiviazione di Azure e che DEVE avere la relativa chiave come $default. Se si specificano più account di archiviazione, viene generato un errore. Se non si specifica un valore per questa proprietà quando la proprietà enableFileUploadNotifications è impostata su True, viene generato un errore. | IotHubPropertiesStorageEndpoints |
IotHubPropertiesDeviceStreams
| Nome | Descrizione | Valore |
|---|---|---|
| streamingEndpoints | Elenco degli endpoint dei flussi di dispositivo. | string[] |
IotHubPropertiesEventHubEndpoints
| Nome | Descrizione | Valore |
|---|
IotHubPropertiesMessagingEndpoints
| Nome | Descrizione | Valore |
|---|
IotHubPropertiesStorageEndpoints
| Nome | Descrizione | Valore |
|---|
IotHubSkuInfo
| Nome | Descrizione | Valore |
|---|---|---|
| capacità | Numero di unità dell'hub IoT di cui è stato effettuato il provisioning. Vedere: /azure/azure-subscription-service-limits#iot-hub-limits. | Int |
| nome | Nome dello SKU. | 'B1' 'B2' 'B3' 'F1' 'S1' 'S2' 'S3' (obbligatorio) |
IpFilterRule
| Nome | Descrizione | Valore |
|---|---|---|
| azione | Azione desiderata per le richieste acquisite da questa regola. | 'Accept' 'Reject' (obbligatorio) |
| filterName | Nome della regola di filtro IP. | stringa (obbligatorio) |
| ipMask | Stringa che contiene l'intervallo di indirizzi IP nella notazione CIDR per la regola. | stringa (obbligatorio) |
KeyVaultKeyProperties
| Nome | Descrizione | Valore |
|---|---|---|
| identità | Proprietà dell'identità gestita di KeyVault Key. | ManagedIdentity |
| keyIdentifier | Identificatore della chiave. | corda |
ManagedIdentity
| Nome | Descrizione | Valore |
|---|---|---|
| userAssignedIdentity | Identità assegnata dall'utente. | corda |
Proprietà MessagingEndpoint
| Nome | Descrizione | Valore |
|---|---|---|
| lockDurationAsIso8601 | Durata del blocco. Vedere: /azure/iot-hub/iot-hub-devguide-file-upload. | corda |
| maxDeliveryCount | Numero di tentativi di recapitare un messaggio nell'hub IoT. Vedere: /azure/iot-hub/iot-hub-devguide-file-upload. | Int Vincoli: Valore minimo = 1 Valore massimo = 100 |
| ttlAsIso8601 | Periodo di tempo per il quale un messaggio è disponibile per l'utilizzo prima della scadenza dell'hub IoT. Vedere: /azure/iot-hub/iot-hub-devguide-file-upload. | corda |
Microsoft.Devices/IotHubs
| Nome | Descrizione | Valore |
|---|---|---|
| etag | Il campo Etag è non obbligatorio. Se viene specificato nel corpo della risposta, deve anche essere fornito come intestazione in base alla normale convenzione ETag. | corda |
| identità | Identità gestite per IotHub. | armIdentity |
| ubicazione | Percorso della risorsa. | stringa (obbligatorio) |
| nome | Nome della risorsa | stringa (obbligatorio) |
| proprietà | Proprietà IotHub | IotHubProperties |
| Sku | Informazioni sullo SKU IotHub | IotHubSkuInfo (obbligatorio) |
| Tag | Tag delle risorse | Dizionario di nomi e valori di tag. |
| digitare | Tipo di risorsa | "Microsoft.Devices/IotHubs@2021-07-01-preview" |
NetworkRuleSetIpRule
| Nome | Descrizione | Valore |
|---|---|---|
| azione | Azione filtro IP | 'Consenti' |
| filterName | Nome della regola di filtro IP. | stringa (obbligatorio) |
| ipMask | Stringa che contiene l'intervallo di indirizzi IP nella notazione CIDR per la regola. | stringa (obbligatorio) |
NetworkRuleSetProperties
| Nome | Descrizione | Valore |
|---|---|---|
| applyToBuiltInEventHubEndpoint | Se True, anche il set di regole di rete viene applicato a BuiltIn EventHub EndPoint di IotHub | bool (obbligatorio) |
| defaultAction | Azione predefinita per il set di regole di rete | 'Consenti' 'Deny' |
| ipRules | Elenco delle regole IP | NetworkRuleSetIpRule[] (obbligatorio) |
PrivateEndpoint
| Nome | Descrizione | Valore |
|---|
PrivateEndpointConnection
| Nome | Descrizione | Valore |
|---|---|---|
| proprietà | Proprietà di una connessione endpoint privato | PrivateEndpointConnectionProperties (obbligatorio) |
PrivateEndpointConnectionProperties
PrivateLinkServiceConnectionState
| Nome | Descrizione | Valore |
|---|---|---|
| actionsRequired | Azioni necessarie per una connessione all'endpoint privato | corda |
| descrizione | Descrizione dello stato corrente di una connessione endpoint privato | stringa (obbligatorio) |
| stato | Stato di una connessione endpoint privato | 'Approvato' 'Disconnesso' 'In sospeso' 'Rejected' (obbligatorio) |
ResourceTags
| Nome | Descrizione | Valore |
|---|
RouteProperties
| Nome | Descrizione | Valore |
|---|---|---|
| condizione | Condizione valutata per applicare la regola di routing. Se non viene specificata alcuna condizione, restituisce true per impostazione predefinita. Per la grammatica, vedere: /azure/iot-hub/iot-hub-devguide-query-language | corda |
| endpointNames | Elenco di endpoint a cui vengono indirizzati i messaggi che soddisfano la condizione. Attualmente è consentito un solo endpoint. | string[] (obbligatorio) |
| isEnabled | Consente di specificare se una route è abilitata. | bool (obbligatorio) |
| nome | Nome della route. Il nome può includere solo caratteri alfanumerici, punti, caratteri di sottolineatura, trattini, ha una lunghezza massima di 64 caratteri e deve essere univoco. | corda Vincoli: Pattern = ^[A-Za-z0-9-._]{1,64}$ (obbligatorio) |
| fonte | Origine a cui applicare la regola di routing, ad esempio DeviceMessages. | 'DeviceConnectionStateEvents' 'DeviceJobLifecycleEvents' 'DeviceLifecycleEvents' 'DeviceMessages' 'DigitalTwinChangeEvents' 'Invalid' 'MqttBrokerMessages' 'TwinChangeEvents' (obbligatorio) |
RoutingEndpoints
| Nome | Descrizione | Valore |
|---|---|---|
| eventHubs | Elenco di endpoint di Hub eventi a cui l'hub IoT instrada i messaggi, in base alle regole di routing. Questo elenco non include l'endpoint predefinito di Hub eventi. | RoutingEventHubProperties[] |
| serviceBusQueues | Elenco di endpoint della coda del bus di servizio a cui l'hub IoT indirizza i messaggi, in base alle regole di routing. | RoutingServiceBusQueueEndpointProperties[] |
| serviceBusTopics | Elenco di endpoint dell'argomento del bus di servizio a cui l'hub IoT indirizza i messaggi, in base alle regole di routing. | RoutingServiceBusTopicEndpointProperties[] |
| storageContainers | Elenco di endpoint del contenitore di archiviazione a cui l'hub IoT instrada i messaggi in base alle regole di routing. | RoutingStorageContainerProperties[] |
RoutingEventHubProperties
| Nome | Descrizione | Valore |
|---|---|---|
| authenticationType | Metodo usato per l'autenticazione nell'endpoint dell'hub eventi | 'identityBased' 'keyBased' |
| connectionString | Stringa di connessione dell'endpoint dell'hub eventi. | corda |
| endpointUri | URL dell'endpoint dell'hub eventi. Deve includere il protocollo sb:// | corda |
| entityPath | Nome dell'hub eventi nello spazio dei nomi dell'hub eventi | corda |
| Id | ID dell'endpoint dell'hub eventi | corda |
| identità | Proprietà dell'identità gestita dell'endpoint dell'hub eventi di routing. | ManagedIdentity |
| nome | Nome che identifica questo endpoint. Il nome può includere solo caratteri alfanumerici, punti, caratteri di sottolineatura, trattini e ha una lunghezza massima di 64 caratteri. I nomi seguenti sono riservati: eventi, fileNotifications, $default. I nomi degli endpoint devono essere univoci tra i tipi di endpoint. | corda Vincoli: Pattern = ^[A-Za-z0-9-._]{1,64}$ (obbligatorio) |
| resourceGroup | Nome del gruppo di risorse dell'endpoint dell'hub eventi. | corda |
| subscriptionId | Identificatore della sottoscrizione dell'endpoint dell'hub eventi. | corda |
RoutingProprietà
| Nome | Descrizione | Valore |
|---|---|---|
| Endpoint | Le proprietà correlate agli endpoint personalizzati a cui l'hub IoT instrada i messaggi in base alle regole di routing. Un massimo di 10 endpoint personalizzati è consentito in tutti i tipi di endpoint per gli hub a pagamento e solo 1 endpoint personalizzato è consentito in tutti i tipi di endpoint per gli hub gratuiti. | routingEndpoints |
| arricchimenti | Elenco di arricchimenti forniti dall'utente che l'hub IoT applica ai messaggi da recapitare agli endpoint predefiniti e personalizzati. Vedere: https://aka.ms/telemetryoneventgrid | proprietà di arricchimento |
| fallbackRoute | Proprietà della route utilizzata come route di fallback quando non vengono soddisfatte le condizioni specificate nella sezione "route". Si tratta di un parametro facoltativo. Quando questa proprietà non è impostata, i messaggi che non soddisfano alcuna delle condizioni specificate nella sezione "route" vengono indirizzati all'endpoint eventhub predefinito. | FallbackRouteProperties |
| Itinerari | Elenco di regole di routing fornite dall'utente usate dall'hub IoT per instradare i messaggi agli endpoint predefiniti e personalizzati. Per gli hub a pagamento sono consentiti un massimo di 100 regole di routing e sono consentite un massimo di 5 regole di routing per hub gratuiti. | proprietà route[] |
RoutingServiceBusQueueEndpointProperties
| Nome | Descrizione | Valore |
|---|---|---|
| authenticationType | Metodo usato per eseguire l'autenticazione nell'endpoint della coda del bus di servizio | 'identityBased' 'keyBased' |
| connectionString | Stringa di connessione dell'endpoint della coda del bus di servizio. | corda |
| endpointUri | URL dell'endpoint della coda del bus di servizio. Deve includere il protocollo sb:// | corda |
| entityPath | Nome della coda nello spazio dei nomi del bus di servizio | corda |
| Id | ID dell'endpoint della coda del bus di servizio | corda |
| identità | Proprietà dell'identità gestita dell'endpoint della coda del bus di servizio di routing. | ManagedIdentity |
| nome | Nome che identifica questo endpoint. Il nome può includere solo caratteri alfanumerici, punti, caratteri di sottolineatura, trattini e ha una lunghezza massima di 64 caratteri. I nomi seguenti sono riservati: eventi, fileNotifications, $default. I nomi degli endpoint devono essere univoci tra i tipi di endpoint. Il nome non deve corrispondere al nome effettivo della coda. | corda Vincoli: Pattern = ^[A-Za-z0-9-._]{1,64}$ (obbligatorio) |
| resourceGroup | Nome del gruppo di risorse dell'endpoint della coda del bus di servizio. | corda |
| subscriptionId | Identificatore della sottoscrizione dell'endpoint della coda del bus di servizio. | corda |
RoutingServiceBusTopicEndpointProperties
| Nome | Descrizione | Valore |
|---|---|---|
| authenticationType | Metodo usato per eseguire l'autenticazione nell'endpoint dell'argomento del bus di servizio | 'identityBased' 'keyBased' |
| connectionString | Stringa di connessione dell'endpoint dell'argomento del bus di servizio. | corda |
| endpointUri | URL dell'endpoint dell'argomento del bus di servizio. Deve includere il protocollo sb:// | corda |
| entityPath | Nome della coda nell'argomento del bus di servizio | corda |
| Id | ID dell'endpoint dell'argomento del bus di servizio | corda |
| identità | Proprietà dell'identità gestita dell'endpoint dell'argomento del bus di servizio di routing. | ManagedIdentity |
| nome | Nome che identifica questo endpoint. Il nome può includere solo caratteri alfanumerici, punti, caratteri di sottolineatura, trattini e ha una lunghezza massima di 64 caratteri. I nomi seguenti sono riservati: eventi, fileNotifications, $default. I nomi degli endpoint devono essere univoci tra i tipi di endpoint. Il nome non deve corrispondere al nome effettivo dell'argomento. | corda Vincoli: Pattern = ^[A-Za-z0-9-._]{1,64}$ (obbligatorio) |
| resourceGroup | Nome del gruppo di risorse dell'endpoint dell'argomento del bus di servizio. | corda |
| subscriptionId | Identificatore della sottoscrizione dell'endpoint dell'argomento del bus di servizio. | corda |
RoutingStorageContainerProperties
| Nome | Descrizione | Valore |
|---|---|---|
| authenticationType | Metodo usato per l'autenticazione nell'endpoint di archiviazione | 'identityBased' 'keyBased' |
| batchFrequencyInSeconds | Intervallo di tempo in cui i BLOB vengono scritti nell'archiviazione. Il valore deve essere compreso tra 60 e 720 secondi. Il valore predefinito è 300 secondi. | Int Vincoli: Valore minimo = 60 Valore massimo = 720 |
| connectionString | Stringa di connessione dell'account di archiviazione. | corda |
| containerName | Nome del contenitore di archiviazione nell'account di archiviazione. | stringa (obbligatorio) |
| codifica | Codifica utilizzata per serializzare i messaggi nei BLOB. I valori supportati sono 'avro', 'avrodeflate' e 'JSON'. Il valore predefinito è 'avro'. | 'Avro' 'AvroDeflate' 'JSON' |
| endpointUri | URL dell'endpoint di archiviazione. Deve includere il protocollo https:// | corda |
| fileNameFormat | Formato del nome file per il BLOB. Il formato predefinito è {iothub}/{partition}/{AAAA}/{MM}/{DD}/{HH}/{mm}. Tutti i parametri sono obbligatori, ma possono essere riordinati. | corda |
| Id | ID dell'endpoint del contenitore di archiviazione | corda |
| identità | Proprietà dell'identità gestita dell'endpoint di archiviazione di routing. | ManagedIdentity |
| maxChunkSizeInBytes | Numero massimo di byte per ogni BLOB scritto nell'archivio. Il valore deve essere compreso tra 10485760(10MB) e 524288000(500 MB). Il valore predefinito è 314572800(300 MB). | Int Vincoli: Valore minimo = 10485760 Valore massimo = 524288000 |
| nome | Nome che identifica questo endpoint. Il nome può includere solo caratteri alfanumerici, punti, caratteri di sottolineatura, trattini e ha una lunghezza massima di 64 caratteri. I nomi seguenti sono riservati: eventi, fileNotifications, $default. I nomi degli endpoint devono essere univoci tra i tipi di endpoint. | corda Vincoli: Pattern = ^[A-Za-z0-9-._]{1,64}$ (obbligatorio) |
| resourceGroup | Nome del gruppo di risorse dell'account di archiviazione. | corda |
| subscriptionId | Identificatore della sottoscrizione dell'account di archiviazione. | corda |
SharedAccessSignatureAuthorizationRule
| Nome | Descrizione | Valore |
|---|---|---|
| keyName | Nome dei criteri di accesso condiviso. | stringa (obbligatorio) |
| primaryKey | Chiave primaria. | corda |
| diritti | Autorizzazioni assegnate ai criteri di accesso condiviso. | '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' (obbligatorio) |
| secondaryKey | Chiave secondaria. | corda |
StorageEndpointProperties
| Nome | Descrizione | Valore |
|---|---|---|
| authenticationType | Specifica il tipo di autenticazione usato per la connessione all'account di archiviazione. | 'identityBased' 'keyBased' |
| connectionString | Stringa di connessione per l'account di archiviazione di Azure in cui vengono caricati i file. | stringa (obbligatorio) |
| containerName | Nome del contenitore radice in cui si caricano i file. Il contenitore non deve esistere, ma deve essere creato usando connectionString specificato. | stringa (obbligatorio) |
| identità | Proprietà dell'identità gestita dell'endpoint di archiviazione per il caricamento di file. | ManagedIdentity |
| sasTtlAsIso8601 | Periodo di tempo per il quale l'URI di firma di accesso condiviso generato dall'hub IoT per il caricamento di file è valido. Vedere: /azure/iot-hub/iot-hub-devguide-file-upload#file-upload-upload-notification-configuration-options. | corda |