Condividi tramite


Microsoft.Devices IotHubs

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 di risorsa

Per creare una risorsa Microsoft.Devices/IotHubs, aggiungere il bicep seguente al modello.

resource symbolicname 'Microsoft.Devices/IotHubs@2023-06-30' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  sku: {
    capacity: int
    name: 'string'
  }
  etag: 'string'
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  properties: {
    allowedFqdnList: [
      'string'
    ]
    authorizationPolicies: [
      {
        keyName: 'string'
        primaryKey: 'string'
        rights: 'string'
        secondaryKey: 'string'
        keyName: 'string'
        primaryKey: 'string'
        rights: 'string'
        secondaryKey: 'string'
      }
    ]
    cloudToDevice: {
      defaultTtlAsIso8601: 'string'
      feedback: {
        lockDurationAsIso8601: 'string'
        maxDeliveryCount: int
        ttlAsIso8601: 'string'
      }
      maxDeliveryCount: int
    }
    comments: 'string'
    disableDeviceSAS: bool
    disableLocalAuth: bool
    disableModuleSAS: bool
    enableDataResidency: bool
    enableFileUploadNotifications: bool
    eventHubEndpoints: {
      {customized property}: {
        partitionCount: int
        retentionTimeInDays: int
      }
    }
    features: 'string'
    ipFilterRules: [
      {
        action: 'string'
        filterName: 'string'
        ipMask: 'string'
      }
    ]
    messagingEndpoints: {
      {customized property}: {
        lockDurationAsIso8601: 'string'
        maxDeliveryCount: int
        ttlAsIso8601: 'string'
      }
    }
    minTlsVersion: 'string'
    networkRuleSets: {
      applyToBuiltInEventHubEndpoint: bool
      defaultAction: 'string'
      ipRules: [
        {
          action: 'Allow'
          filterName: 'string'
          ipMask: 'string'
        }
      ]
    }
    privateEndpointConnections: [
      {
        properties: {
          privateEndpoint: {}
          privateLinkServiceConnectionState: {
            actionsRequired: 'string'
            description: 'string'
            status: 'string'
          }
        }
      }
    ]
    publicNetworkAccess: 'string'
    restrictOutboundNetworkAccess: bool
    routing: {
      endpoints: {
        cosmosDBSqlContainers: [
          {
            authenticationType: 'string'
            containerName: 'string'
            databaseName: 'string'
            endpointUri: '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'
      }
    }
  }
}

Valori delle proprietà

Hub IoT

Nome Descrizione valore
name Nome della risorsa stringa (obbligatorio)

Limite di caratteri: 3-50

Caratteri validi:
Caratteri alfanumerici e trattini.

Non può terminare con un trattino.

Il nome della risorsa deve essere univoco in Azure.
posizione Percorso della risorsa. stringa (obbligatorio)
tags Tag di risorsa. Dizionario di nomi e valori di tag. Vedere Tag nei modelli
sku Informazioni sullo SKU IotHub IotHubSkuInfo (obbligatorio)
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. string
identity Identità gestite per IotHub. ArmIdentity
properties Proprietà di IotHub IotHubProperties

ArmIdentity

Nome Descrizione Valore
tipo 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 "Nessuno" rimuoverà le identità dal servizio. 'Nessuno'
'SystemAssigned'
'SystemAssigned, UserAssigned'
'UserAssigned'
userAssignedIdentities Dizionario di {ArmUserIdentity} ArmIdentityUserAssignedIdentities

ArmIdentityUserAssignedIdentities

Nome Descrizione Valore
{proprietà personalizzata} ArmUserIdentity

ArmUserIdentity

Questo oggetto non contiene proprietà da impostare durante la distribuzione. Tutte le proprietà sono ReadOnly.

IotHubProperties

Nome Descrizione Valore
allowedFqdnList Elenco di nomi di dominio completi 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
comments Commenti dell'hub IoT. string
disableDeviceSAS Se true, non è possibile usare tutte le chiavi di firma di accesso condiviso con ambito dispositivo(inclusi i dispositivi Perimetrali ma esclusi i moduli) per l'autenticazione. bool
disableLocalAuth Se true, i token di firma di accesso condiviso con chiavi di firma di accesso condiviso con ambito hub Iot non possono essere usati 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
enableDataResidency Questa proprietà, se impostata su true, consentirà la residenza dei dati, disabilitando il ripristino di emergenza. bool
enableFileUploadNotifications Se True, le notifiche di caricamento dei file sono abilitate. bool
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
funzionalità 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" in modo che i client che usano una versione TLS inferiore alla 1.2 vengano rifiutati. string
networkRuleSets Proprietà del set di regole di rete di IotHub NetworkRuleSetProperties
privateEndpointConnections Connessioni endpoint privato 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
routing 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

SharedAccessSignatureAuthorizationRule

Nome Descrizione Valore
keyName Nome dei criteri di accesso condiviso. stringa (obbligatorio)
primaryKey Chiave primaria. string
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. string
keyName Nome dei criteri di accesso condiviso. stringa (obbligatorio)
primaryKey Chiave primaria. string
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. string

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#da cloud a dispositivo-messages. string
feedback 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#da cloud a dispositivo-messages. INT

Vincoli:
Valore minimo = 1
Valore massimo = 100

FeedbackProprietà

Nome Descrizione Valore
lockDurationAsIso8601 Durata del blocco per la coda dei commenti e suggerimenti. Vedere: /azure/iot-hub/iot-hub-devguide-messaging#da cloud a dispositivo-messages. string
maxDeliveryCount Numero di tentativi di recapitare un messaggio nella coda dei commenti e suggerimenti dell'hub IoT. Vedere: /azure/iot-hub/iot-hub-devguide-messaging#da cloud a dispositivo-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#da cloud a dispositivo-messages. string

IotHubPropertiesEventHubEndpoints

Nome Descrizione Valore
{proprietà personalizzata} EventHubProperties

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

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 contenente l'intervallo di indirizzi IP nella notazione CIDR per la regola. stringa (obbligatorio)

IotHubPropertiesMessagingEndpoints

Nome Descrizione Valore
{proprietà personalizzata} MessagingEndpointProperties

MessagingEndpointProperties

Nome Descrizione Valore
lockDurationAsIso8601 Durata del blocco. Vedere: /azure/iot-hub/iot-hub-devguide-file-upload. string
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. string

NetworkRuleSetProperties

Nome Descrizione Valore
applyToBuiltInEventHubEndpoint Se True, il set di regole di rete viene applicato anche a BuiltIn EventHub EndPoint di IotHub bool (obbligatorio)
Defaultaction Azione predefinita per il set di regole di rete 'Allow'
'Deny'
ipRules Elenco delle regole IP NetworkRuleSetIpRule[] (obbligatorio)

NetworkRuleSetIpRule

Nome Descrizione Valore
azione Azione filtro IP 'Allow'
filterName Nome della regola di filtro IP. stringa (obbligatoria)
ipMask Stringa contenente l'intervallo di indirizzi IP nella notazione CIDR per la regola. stringa (obbligatoria)

PrivateEndpointConnection

Nome Descrizione Valore
properties Proprietà di una connessione endpoint privato PrivateEndpointConnectionProperties (obbligatorio)

PrivateEndpointConnectionProperties

Nome Descrizione Valore
privateEndpoint Proprietà dell'endpoint privato di una connessione endpoint privato PrivateEndpoint
privateLinkServiceConnectionState Stato corrente di una connessione endpoint privato PrivateLinkServiceConnectionState (obbligatorio)

PrivateEndpoint

Questo oggetto non contiene proprietà da impostare durante la distribuzione. Tutte le proprietà sono ReadOnly.

PrivateLinkServiceConnectionState

Nome Descrizione Valore
actionsRequired Azioni necessarie per una connessione endpoint privato string
description Descrizione dello stato corrente di una connessione endpoint privato stringa (obbligatoria)
status Stato di una connessione endpoint privato 'Approvato'
'Disconnesso'
'In sospeso'
'Rifiutato' (obbligatorio)

RoutingProperties

Nome Descrizione Valore
endpoints Le proprietà correlate agli endpoint personalizzati a cui l'hub IoT indirizza 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 hub gratuiti. RoutingEndpoints
arricchimenti Elenco degli arricchimenti forniti dall'utente che l'hub IoT si applica ai messaggi da recapitare agli endpoint predefiniti e personalizzati. Vedere: https://aka.ms/telemetryoneventgrid EnrichmentProperties[]
fallbackRoute Le proprietà della route usate come route di fallback quando non vengono soddisfatte nessuna delle condizioni specificate nella sezione "route". Questo parametro è facoltativo. Quando questa proprietà non è presente nel modello, la route di fallback è disabilitata per impostazione predefinita. FallbackRouteProperties
route Elenco delle regole di routing fornite dall'utente usate dall'hub IoT per instradare i messaggi agli endpoint predefiniti e personalizzati. Per hub a pagamento sono consentiti un massimo di 100 regole di routing e sono consentite un massimo di 5 regole di routing. RouteProperties[]

RoutingEndpoints

Nome Descrizione Valore
cosmosDBSqlContainers Elenco degli endpoint del contenitore Cosmos DB a cui l'hub IoT indirizza i messaggi in base alle regole di routing. RoutingCosmosDBSqlApiProperties[]
eventHubs Elenco degli endpoint dell'hub eventi a cui l'hub IoT indirizza i messaggi, in base alle regole di routing. Questo elenco non include l'endpoint di Hub eventi predefinito. RoutingEventHubProperties[]
serviceBusQueues Elenco degli 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 instrada i messaggi in base alle regole di routing. RoutingServiceBusTopicEndpointProperties[]
storageContainers L'elenco degli endpoint del contenitore di archiviazione a cui l'hub IoT indirizza i messaggi in base alle regole di routing. RoutingStorageContainerProperties[]

RoutingCosmosDBSqlApiProperties

Nome Descrizione Valore
authenticationType Metodo usato per eseguire l'autenticazione nell'endpoint del contenitore SQL di Cosmos DB 'identityBased'
'keyBased'
containerName Nome del contenitore sql cosmos DB nel database cosmos DB. stringa (obbligatorio)
databaseName Nome del database cosmos DB nell'account cosmos DB. stringa (obbligatorio)
endpointUri URL dell'account cosmos DB. Deve includere il protocollo https:// stringa (obbligatorio)
identity Proprietà dell'identità gestita dell'endpoint del contenitore cosmos DB. ManagedIdentity
name 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. stringa (obbligatorio)

Vincoli:
Pattern = ^[A-Za-z0-9-._]{1,64}$
partitionKeyName Nome della chiave di partizione associata a questo contenitore SQL di Cosmos DB, se presente. Questo parametro è facoltativo. string
partitionKeyTemplate Modello per la generazione di un valore di chiave di partizione sintetica da usare con questo contenitore SQL di Cosmos DB. Il modello deve includere almeno uno dei segnaposto seguenti: {iothub}, {deviceid}, {DD}, {MM}e {AAAA}. Qualsiasi segnaposto può essere specificato al massimo una volta, ma i componenti order e non segnaposto sono arbitrari. Questo parametro è obbligatorio solo se partitionKeyName è specificato. string
primaryKey Chiave primaria dell'account cosmos DB. string

Vincoli:
Valore sensibile. Passare come parametro sicuro.
resourceGroup Nome del gruppo di risorse dell'account cosmos DB. string
secondaryKey Chiave secondaria dell'account cosmos DB. string

Vincoli:
Valore sensibile. Passare come parametro sicuro.
subscriptionId Identificatore della sottoscrizione dell'account cosmos DB. string

ManagedIdentity

Nome Descrizione Valore
userAssignedIdentity Identità assegnata dall'utente. string

RoutingEventHubProperties

Nome Descrizione Valore
authenticationType Metodo usato per eseguire l'autenticazione nell'endpoint dell'hub eventi 'identityBased'
'keyBased'
connectionString Il stringa di connessione dell'endpoint dell'hub eventi. string
endpointUri URL dell'endpoint dell'hub eventi. Deve includere il protocollo sb:// string
entityPath Nome dell'hub eventi nello spazio dei nomi dell'hub eventi string
id ID dell'endpoint dell'hub eventi string
identity Proprietà dell'identità gestita dell'endpoint dell'hub eventi di routing. ManagedIdentity
name 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. stringa (obbligatorio)

Vincoli:
Pattern = ^[A-Za-z0-9-._]{1,64}$
resourceGroup Nome del gruppo di risorse dell'endpoint dell'hub eventi. string
subscriptionId Identificatore della sottoscrizione dell'endpoint dell'hub eventi. string

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. string
endpointUri URL dell'endpoint della coda del bus di servizio. Deve includere il protocollo sb:// string
entityPath Nome della coda nello spazio dei nomi del bus di servizio string
id ID dell'endpoint della coda del bus di servizio string
identity Proprietà dell'identità gestita dell'endpoint della coda del bus di servizio di routing. ManagedIdentity
name 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 essere uguale al nome effettivo della coda. stringa (obbligatoria)

Vincoli:
Pattern = ^[A-Za-z0-9-._]{1,64}$
resourceGroup Nome del gruppo di risorse dell'endpoint della coda del bus di servizio. string
subscriptionId Identificatore della sottoscrizione dell'endpoint della coda del bus di servizio. string

RoutingServiceBusTopicEndpointProperties

Nome Descrizione Valore
authenticationType Metodo usato per l'autenticazione nell'endpoint dell'argomento del bus di servizio 'identityBased'
'keyBased'
connectionString Stringa di connessione dell'endpoint dell'argomento del bus di servizio. string
endpointUri URL dell'endpoint dell'argomento del bus di servizio. Deve includere il protocollo sb:// string
entityPath Nome della coda nell'argomento del bus di servizio string
id ID dell'endpoint dell'argomento del bus di servizio string
identity Proprietà dell'identità gestita dell'endpoint dell'argomento del bus di servizio di routing. ManagedIdentity
name 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 essere uguale al nome dell'argomento effettivo. stringa (obbligatoria)

Vincoli:
Pattern = ^[A-Za-z0-9-._]{1,64}$
resourceGroup Nome del gruppo di risorse dell'endpoint dell'argomento del bus di servizio. string
subscriptionId Identificatore della sottoscrizione dell'endpoint dell'argomento del bus di servizio. string

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 Il stringa di connessione dell'account di archiviazione. string
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:// string
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. string
id ID dell'endpoint del contenitore di archiviazione string
identity Proprietà dell'identità gestita dell'endpoint di archiviazione di routing. ManagedIdentity
maxChunkSizeInBytes Numero massimo di byte per ogni BLOB scritto nell'archiviazione. Il valore deve essere compreso tra 10485760(10 MB) e 524288000(500 MB). Il valore predefinito è 314572800(300 MB). INT

Vincoli:
Valore minimo = 10485760
Valore massimo = 524288000
name 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. stringa (obbligatorio)

Vincoli:
Pattern = ^[A-Za-z0-9-._]{1,64}$
resourceGroup Nome del gruppo di risorse dell'account di archiviazione. string
subscriptionId Identificatore della sottoscrizione dell'account di archiviazione. string

ArricchimentoProprietà

Nome Descrizione Valore
endpointNames Elenco di endpoint per cui viene applicato l'arricchimento al messaggio. string[] (obbligatorio)

Vincoli:
Lunghezza minima = 1
Key Chiave o nome per la proprietà di arricchimento. stringa (obbligatorio)
Valore Valore della proprietà di arricchimento. stringa (obbligatorio)

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 string
endpointNames Elenco di endpoint a cui vengono indirizzati i messaggi che soddisfano la condizione. Attualmente è consentito solo 1 endpoint. string[] (obbligatorio)

Vincoli:
Lunghezza minima = 1
Lunghezza massima = 1
isEnabled Consente di specificare se la route di fallback è abilitata. bool (obbligatorio)
name Nome della route. Il nome può includere solo caratteri alfanumerici, punti, caratteri di sottolineatura, trattini, lunghezza massima di 64 caratteri e deve essere univoco. string
source Origine a cui applicare la regola di routing. Ad esempio, DeviceMessages 'DeviceConnectionStateEvents'
'DeviceJobLifecycleEvents'
'DeviceLifecycleEvents'
'DeviceMessages'
'Invalid'
'TwinChangeEvents' (obbligatorio)

RouteProperties

Nome Descrizione Valore
condizione Condizione valutata per applicare la regola di routing. Se non viene fornita alcuna condizione, restituisce true per impostazione predefinita. Per la grammatica, vedere: /azure/iot-hub/iot-hub-devguide-query-language string
endpointNames Elenco di endpoint a cui vengono indirizzati i messaggi che soddisfano la condizione. Attualmente è consentito un solo endpoint. string[] (obbligatorio)

Vincoli:
Lunghezza minima = 1
Lunghezza massima = 1
isEnabled Consente di specificare se una route è abilitata. bool (obbligatorio)
name Nome della route. Il nome può includere solo caratteri alfanumerici, punti, caratteri di sottolineatura, trattini, lunghezza massima di 64 caratteri e deve essere univoco. stringa (obbligatorio)

Vincoli:
Pattern = ^[A-Za-z0-9-._]{1,64}$
source Origine a cui deve essere applicata la regola di routing, ad esempio DeviceMessages. 'DeviceConnectionStateEvents'
'DeviceJobLifecycleEvents'
'DeviceLifecycleEvents'
'DeviceMessages'
'Invalid'
'TwinChangeEvents' (obbligatorio)

IotHubPropertiesStorageEndpoints

Nome Descrizione Valore
{proprietà personalizzata} StorageEndpointProperties

StorageEndpointProperties

Nome Descrizione Valore
authenticationType Specifica il tipo di autenticazione utilizzato per la connessione all'account di archiviazione. 'identityBased'
'keyBased'
connectionString Il 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)
identity 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 da hub IoT per il caricamento di file è valido. Vedere: /azure/iot-hub/iot-hub-devguide-file-upload#file-upload-upload-notification-configuration-options. string

IotHubSkuInfo

Nome Descrizione Valore
capacità Numero di unità di hub IoT di cui è stato effettuato il provisioning. Vedere: /azure/azure-subscription-service-limits#iot-hub-limits. INT
name Il nome della SKU. 'B1'
'B2'
'B3'
'F1'
'S1'
'S2'
'S3' (obbligatorio)

Modelli di avvio rapido

I modelli di avvio rapido seguenti distribuiscono questo tipo di risorsa.

Modello Descrizione
Creare un simulatore perimetrale hub IOT e Ubuntu

Distribuisci in Azure
Questo modello crea un hub IOT e un simulatore perimetrale Ubuntu macchina virtuale.
Usare il modello di Resource Manager per creare hub IoT, indirizzare e visualizzare i messaggi

Distribuisci in Azure
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.
Creare un servizio Device Provisioning hub IoT

Distribuisci in Azure
Questo modello consente di creare un hub IoT e un hub IoT servizio Device Provisioning e collegare i due servizi tra loro.
Creare un hub IoT e un gruppo di consumer da dispositivo a cloud

Distribuisci in Azure
Questo modello consente di distribuire un'istanza di hub IoT con dispositivo nel cloud e nel cloud nelle configurazioni di messaggistica dei dispositivi e un dispositivo nel gruppo di consumer cloud.
Creare l'aggiornamento del dispositivo per hub IoT account, istanza hub IoT

Distribuisci in Azure
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

Distribuisci in 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.
Creare un ambiente con pagamento in base al consumo (PAYG) con un hub IoT

Distribuisci in Azure
Questo modello consente di distribuire un ambiente Time Series Insights con pagamento in base al consumo (PayG) configurato per l'utilizzo di eventi da un hub IoT.

Definizione della risorsa modello di Resource Manager

Il tipo di risorsa IotHubs può essere distribuito con operazioni destinate:

Per un elenco delle proprietà modificate in ogni versione dell'API, vedere log delle modifiche.

Formato di risorsa

Per creare una risorsa Microsoft.Devices/IotHubs, aggiungere il codice JSON seguente al modello.

{
  "type": "Microsoft.Devices/IotHubs",
  "apiVersion": "2023-06-30",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "sku": {
    "capacity": "int",
    "name": "string"
  },
  "etag": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {}
    }
  },
  "properties": {
    "allowedFqdnList": [ "string" ],
    "authorizationPolicies": [
      {
        "keyName": "string",
        "primaryKey": "string",
        "rights": "string",
        "secondaryKey": "string",
        "keyName": "string",
        "primaryKey": "string",
        "rights": "string",
        "secondaryKey": "string"
      }
    ],
    "cloudToDevice": {
      "defaultTtlAsIso8601": "string",
      "feedback": {
        "lockDurationAsIso8601": "string",
        "maxDeliveryCount": "int",
        "ttlAsIso8601": "string"
      },
      "maxDeliveryCount": "int"
    },
    "comments": "string",
    "disableDeviceSAS": "bool",
    "disableLocalAuth": "bool",
    "disableModuleSAS": "bool",
    "enableDataResidency": "bool",
    "enableFileUploadNotifications": "bool",
    "eventHubEndpoints": {
      "{customized property}": {
        "partitionCount": "int",
        "retentionTimeInDays": "int"
      }
    },
    "features": "string",
    "ipFilterRules": [
      {
        "action": "string",
        "filterName": "string",
        "ipMask": "string"
      }
    ],
    "messagingEndpoints": {
      "{customized property}": {
        "lockDurationAsIso8601": "string",
        "maxDeliveryCount": "int",
        "ttlAsIso8601": "string"
      }
    },
    "minTlsVersion": "string",
    "networkRuleSets": {
      "applyToBuiltInEventHubEndpoint": "bool",
      "defaultAction": "string",
      "ipRules": [
        {
          "action": "Allow",
          "filterName": "string",
          "ipMask": "string"
        }
      ]
    },
    "privateEndpointConnections": [
      {
        "properties": {
          "privateEndpoint": {},
          "privateLinkServiceConnectionState": {
            "actionsRequired": "string",
            "description": "string",
            "status": "string"
          }
        }
      }
    ],
    "publicNetworkAccess": "string",
    "restrictOutboundNetworkAccess": "bool",
    "routing": {
      "endpoints": {
        "cosmosDBSqlContainers": [
          {
            "authenticationType": "string",
            "containerName": "string",
            "databaseName": "string",
            "endpointUri": "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"
      }
    }
  }
}

Valori delle proprietà

Hub IoT

Nome Descrizione Valore
tipo Tipo di risorsa 'Microsoft.Devices/IotHubs'
apiVersion Versione dell'API risorsa '2023-06-30'
name Nome della risorsa stringa (obbligatoria)

Limite di caratteri: 3-50

Caratteri validi:
Caratteri alfanumerici e trattini.

Non può terminare con un trattino.

Il nome della risorsa deve essere univoco in Azure.
posizione Percorso della risorsa. stringa (obbligatoria)
tags Tag di risorsa. Dizionario dei nomi e dei valori dei tag. Vedere Tag nei modelli
sku Informazioni sullo SKU IotHub IotHubSkuInfo (obbligatorio)
etag Il campo Etag non è obbligatorio. Se viene fornito nel corpo della risposta, deve essere fornito anche come intestazione per la normale convenzione ETag. string
identity Identità gestite per IotHub. ArmIdentity
properties Proprietà IotHub IotHubProperties

ArmIdentity

Nome Descrizione Valore
tipo Tipo di identità utilizzata 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 'Nessuno' rimuoverà le identità dal servizio. 'Nessuno'
'SystemAssigned'
'SystemAssigned, UserAssigned'
'UserAssigned'
userAssignedIdentities Dizionario di {ArmUserIdentity} ArmIdentityUserAssignedIdentities

ArmIdentityUserAssignedIdentities

Nome Descrizione Valore
{proprietà personalizzata} ArmUserIdentity

ArmUserIdentity

Questo oggetto non contiene proprietà da impostare durante la distribuzione. Tutte le proprietà sono ReadOnly.

IotHubProperties

Nome Descrizione Valore
allowedFqdnList Elenco di FQDNs 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
comments Commenti dell'hub IoT. string
disableDeviceSAS Se true, non è possibile usare tutte le chiavi SAS 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 dell'hub Iot per l'autenticazione. bool
disableModuleSAS Se true, non è possibile usare tutte le chiavi sas con ambito modulo per l'autenticazione. bool
enableDataResidency Questa proprietà, se impostata su true, consentirà la residenza dei dati, disabilitando quindi il ripristino di emergenza. bool
enableFileUploadNotifications Se True, le notifiche di caricamento dei file sono abilitate. bool
eventHubEndpoints Proprietà dell'endpoint compatibili con Hub eventi. Le uniche chiavi possibili per questo dizionario sono eventi. Questa chiave deve essere presente nel dizionario durante l'esecuzione di chiamate di creazione o aggiornamento per l'hub IoT. IotHubPropertiesEventHubEndpoints
funzionalità 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 TLS da supportare per questo hub. Può essere impostato su "1.2" per avere client che usano una versione TLS inferiore alla versione 1.2 da rifiutare. string
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'
limitOutboundNetworkAccess Se true, l'uscita da IotHub sarà limitata solo agli FQDN consentiti configurati tramite allowedFqdnList. bool
routing 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 file. Attualmente è possibile configurare un solo account di archiviazione di Azure e che deve avere la chiave come $default. Se si specificano più account di archiviazione, viene generato un errore. Non specificando un valore per questa proprietà quando la proprietà enableFileUploadNotifications è impostata su True, genera un errore. IotHubPropertiesStorageEndpoints

SharedAccessSignatureAuthorizationRule

Nome Descrizione Valore
keyName Nome dei criteri di accesso condiviso. stringa (obbligatoria)
primaryKey Chiave primaria. string
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. string
keyName Nome dei criteri di accesso condiviso. stringa (obbligatoria)
primaryKey Chiave primaria. string
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. string

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#da cloud a dispositivo-messages. string
feedback 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#da cloud a dispositivo-messages. INT

Vincoli:
Valore minimo = 1
Valore massimo = 100

FeedbackProprietà

Nome Descrizione Valore
lockDurationAsIso8601 Durata del blocco per la coda dei commenti e suggerimenti. Vedere: /azure/iot-hub/iot-hub-devguide-messaging#da cloud a dispositivo-messages. string
maxDeliveryCount Numero di tentativi di recapitare un messaggio nella coda dei commenti e suggerimenti dell'hub IoT. Vedere: /azure/iot-hub/iot-hub-devguide-messaging#da cloud a dispositivo-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#da cloud a dispositivo-messages. string

IotHubPropertiesEventHubEndpoints

Nome Descrizione Valore
{proprietà personalizzata} EventHubProperties

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

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 contenente l'intervallo di indirizzi IP nella notazione CIDR per la regola. stringa (obbligatorio)

IotHubPropertiesMessagingEndpoints

Nome Descrizione Valore
{proprietà personalizzata} MessagingEndpointProperties

MessagingEndpointProperties

Nome Descrizione Valore
lockDurationAsIso8601 Durata del blocco. Vedere: /azure/iot-hub/iot-hub-devguide-file-upload. string
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. string

NetworkRuleSetProperties

Nome Descrizione Valore
applyToBuiltInEventHubEndpoint Se True, il set di regole di rete viene applicato anche a BuiltIn EventHub EndPoint di IotHub bool (obbligatorio)
Defaultaction Azione predefinita per il set di regole di rete 'Allow'
'Deny'
ipRules Elenco delle regole IP NetworkRuleSetIpRule[] (obbligatorio)

NetworkRuleSetIpRule

Nome Descrizione Valore
azione Azione filtro IP 'Allow'
filterName Nome della regola di filtro IP. stringa (obbligatoria)
ipMask Stringa contenente l'intervallo di indirizzi IP nella notazione CIDR per la regola. stringa (obbligatoria)

PrivateEndpointConnection

Nome Descrizione Valore
properties Proprietà di una connessione endpoint privato PrivateEndpointConnectionProperties (obbligatorio)

PrivateEndpointConnectionProperties

Nome Descrizione Valore
privateEndpoint Proprietà dell'endpoint privato di una connessione endpoint privato PrivateEndpoint
privateLinkServiceConnectionState Stato corrente di una connessione endpoint privato PrivateLinkServiceConnectionState (obbligatorio)

PrivateEndpoint

Questo oggetto non contiene proprietà da impostare durante la distribuzione. Tutte le proprietà sono ReadOnly.

PrivateLinkServiceConnectionState

Nome Descrizione Valore
actionsRequired Azioni necessarie per una connessione endpoint privato string
description Descrizione dello stato corrente di una connessione endpoint privato stringa (obbligatoria)
status Stato di una connessione endpoint privato 'Approvato'
'Disconnesso'
'In sospeso'
'Rifiutato' (obbligatorio)

RoutingProperties

Nome Descrizione Valore
endpoints Le proprietà correlate agli endpoint personalizzati a cui l'hub IoT indirizza 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 hub gratuiti. RoutingEndpoints
arricchimenti Elenco degli arricchimenti forniti dall'utente che l'hub IoT si applica ai messaggi da recapitare agli endpoint predefiniti e personalizzati. Vedere: https://aka.ms/telemetryoneventgrid EnrichmentProperties[]
fallbackRoute Le proprietà della route usate come route di fallback quando non vengono soddisfatte nessuna delle condizioni specificate nella sezione "route". Questo parametro è facoltativo. Quando questa proprietà non è presente nel modello, la route di fallback è disabilitata per impostazione predefinita. FallbackRouteProperties
route Elenco delle regole di routing fornite dall'utente usate dall'hub IoT per instradare i messaggi agli endpoint predefiniti e personalizzati. Per hub a pagamento sono consentiti un massimo di 100 regole di routing e sono consentite un massimo di 5 regole di routing. RouteProperties[]

RoutingEndpoints

Nome Descrizione Valore
cosmosDBSqlContainers Elenco degli endpoint del contenitore Cosmos DB a cui l'hub IoT indirizza i messaggi in base alle regole di routing. RoutingCosmosDBSqlApiProperties[]
eventHubs Elenco degli endpoint dell'hub eventi a cui l'hub IoT indirizza i messaggi, in base alle regole di routing. Questo elenco non include l'endpoint di Hub eventi predefinito. RoutingEventHubProperties[]
serviceBusQueues Elenco degli endpoint della coda del bus di servizio a cui l'hub IoT indirizza i messaggi in base alle regole di routing. RoutingServiceBusQueueEndpointProperties[]
serviceBusTopics Elenco degli endpoint dell'argomento del bus di servizio a cui l'hub IoT indirizza i messaggi in base alle regole di routing. RoutingServiceBusTopicEndpointProperties[]
storageContainers Elenco degli endpoint del contenitore di archiviazione a cui l'hub IoT indirizza i messaggi in base alle regole di routing. RoutingStorageContainerProperties[]

RoutingCosmosDBSqlApiProperties

Nome Descrizione Valore
authenticationType Metodo usato per eseguire l'autenticazione nell'endpoint del contenitore SQL cosmos DB 'identityBased'
'keyBased'
containerName Nome del contenitore sql cosmos DB nel database cosmos DB. stringa (obbligatoria)
databaseName Nome del database cosmos DB nell'account cosmos DB. stringa (obbligatoria)
endpointUri URL dell'account cosmos DB. Deve includere il protocollo https:// stringa (obbligatoria)
identity Proprietà dell'identità gestita dell'endpoint del contenitore cosmos DB. ManagedIdentity
name 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. stringa (obbligatoria)

Vincoli:
Pattern = ^[A-Za-z0-9-._]{1,64}$
partitionKeyName Nome della chiave di partizione associata a questo contenitore sql cosmos DB se presente. Questo parametro è facoltativo. string
partitionKeyTemplate Modello per la generazione di un valore di chiave di partizione sintetica da usare con questo contenitore sql cosmos DB. Il modello deve includere almeno uno dei segnaposto seguenti: {iothub}, {deviceid}, {DD}, {MM}e {AAAA}. Qualsiasi segnaposto può essere specificato al massimo una volta, ma i componenti di ordine e non segnaposto sono arbitrari. Questo parametro è obbligatorio solo se PartitionKeyName è specificato. string
primaryKey Chiave primaria dell'account cosmos DB. string

Vincoli:
Valore sensibile. Passare come parametro sicuro.
resourceGroup Nome del gruppo di risorse dell'account cosmos DB. string
secondaryKey Chiave secondaria dell'account cosmos DB. string

Vincoli:
Valore sensibile. Passare come parametro sicuro.
subscriptionId Identificatore della sottoscrizione dell'account cosmos DB. string

ManagedIdentity

Nome Descrizione Valore
userAssignedIdentity Identità assegnata dall'utente. string

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. string
endpointUri URL dell'endpoint dell'hub eventi. Deve includere il protocollo sb:// string
entityPath Nome dell'hub eventi nello spazio dei nomi dell'hub eventi string
id ID dell'endpoint dell'hub eventi string
identity Proprietà dell'identità gestita dell'endpoint dell'hub eventi di routing. ManagedIdentity
name 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. stringa (obbligatoria)

Vincoli:
Pattern = ^[A-Za-z0-9-._]{1,64}$
resourceGroup Nome del gruppo di risorse dell'endpoint dell'hub eventi. string
subscriptionId Identificatore della sottoscrizione dell'endpoint dell'hub eventi. string

RoutingServiceBusQueueEndpointProperties

Nome Descrizione Valore
authenticationType Metodo usato per eseguire l'autenticazione nell'endpoint della coda del bus di servizio 'identityBased'
'keyBased'
connectionString Il stringa di connessione dell'endpoint della coda del bus di servizio. string
endpointUri URL dell'endpoint della coda del bus di servizio. Deve includere il protocollo sb:// string
entityPath Nome della coda nello spazio dei nomi del bus di servizio string
id ID dell'endpoint della coda del bus di servizio string
identity Proprietà dell'identità gestita dell'endpoint della coda del bus di servizio di routing. ManagedIdentity
name 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. stringa (obbligatorio)

Vincoli:
Pattern = ^[A-Za-z0-9-._]{1,64}$
resourceGroup Nome del gruppo di risorse dell'endpoint della coda del bus di servizio. string
subscriptionId Identificatore della sottoscrizione dell'endpoint della coda del bus di servizio. string

RoutingServiceBusTopicEndpointProperties

Nome Descrizione Valore
authenticationType Metodo usato per eseguire l'autenticazione nell'endpoint dell'argomento del bus di servizio 'identityBased'
'keyBased'
connectionString Il stringa di connessione dell'endpoint dell'argomento del bus di servizio. string
endpointUri URL dell'endpoint dell'argomento del bus di servizio. Deve includere il protocollo sb:// string
entityPath Nome della coda nell'argomento del bus di servizio string
id ID dell'endpoint dell'argomento del bus di servizio string
identity Proprietà dell'identità gestita dell'endpoint dell'argomento del bus di servizio di routing. ManagedIdentity
name 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. stringa (obbligatorio)

Vincoli:
Pattern = ^[A-Za-z0-9-._]{1,64}$
resourceGroup Nome del gruppo di risorse dell'endpoint dell'argomento del bus di servizio. string
subscriptionId Identificatore della sottoscrizione dell'endpoint dell'argomento del bus di servizio. string

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 Il stringa di connessione dell'account di archiviazione. string
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:// string
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. string
id ID dell'endpoint del contenitore di archiviazione string
identity Proprietà dell'identità gestita dell'endpoint di archiviazione di routing. ManagedIdentity
maxChunkSizeInBytes Numero massimo di byte per ogni BLOB scritto nell'archiviazione. Il valore deve essere compreso tra 10485760(10 MB) e 524288000(500 MB). Il valore predefinito è 314572800(300 MB). INT

Vincoli:
Valore minimo = 10485760
Valore massimo = 524288000
name 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. stringa (obbligatorio)

Vincoli:
Pattern = ^[A-Za-z0-9-._]{1,64}$
resourceGroup Nome del gruppo di risorse dell'account di archiviazione. string
subscriptionId Identificatore della sottoscrizione dell'account di archiviazione. string

ArricchimentoProprietà

Nome Descrizione Valore
endpointNames Elenco di endpoint per cui viene applicato l'arricchimento al messaggio. string[] (obbligatorio)

Vincoli:
Lunghezza minima = 1
Key Chiave o nome per la proprietà di arricchimento. stringa (obbligatorio)
Valore Valore della proprietà di arricchimento. stringa (obbligatorio)

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 string
endpointNames Elenco di endpoint a cui vengono indirizzati i messaggi che soddisfano la condizione. Attualmente è consentito solo 1 endpoint. string[] (obbligatorio)

Vincoli:
Lunghezza minima = 1
Lunghezza massima = 1
isEnabled Consente di specificare se la route di fallback è abilitata. bool (obbligatorio)
name Nome della route. Il nome può includere solo caratteri alfanumerici, punti, caratteri di sottolineatura, trattini, lunghezza massima di 64 caratteri e deve essere univoco. string
source Origine a cui applicare la regola di routing. Ad esempio, DeviceMessages 'DeviceConnectionStateEvents'
'DeviceJobLifecycleEvents'
'DeviceLifecycleEvents'
'DeviceMessages'
'Invalid'
'TwinChangeEvents' (obbligatorio)

RouteProperties

Nome Descrizione Valore
condizione Condizione valutata per applicare la regola di routing. Se non viene fornita alcuna condizione, restituisce true per impostazione predefinita. Per la grammatica, vedere: /azure/iot-hub/iot-hub-devguide-query-language string
endpointNames Elenco di endpoint a cui vengono indirizzati i messaggi che soddisfano la condizione. Attualmente è consentito un solo endpoint. string[] (obbligatorio)

Vincoli:
Lunghezza minima = 1
Lunghezza massima = 1
isEnabled Consente di specificare se una route è abilitata. bool (obbligatorio)
name Nome della route. Il nome può includere solo caratteri alfanumerici, punti, caratteri di sottolineatura, trattini, lunghezza massima di 64 caratteri e deve essere univoco. stringa (obbligatorio)

Vincoli:
Pattern = ^[A-Za-z0-9-._]{1,64}$
source Origine a cui deve essere applicata la regola di routing, ad esempio DeviceMessages. 'DeviceConnectionStateEvents'
'DeviceJobLifecycleEvents'
'DeviceLifecycleEvents'
'DeviceMessages'
'Invalid'
'TwinChangeEvents' (obbligatorio)

IotHubPropertiesStorageEndpoints

Nome Descrizione Valore
{proprietà personalizzata} StorageEndpointProperties

StorageEndpointProperties

Nome Descrizione Valore
authenticationType Specifica il tipo di autenticazione utilizzato per la connessione all'account di archiviazione. 'identityBased'
'keyBased'
connectionString Il 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)
identity 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 da hub IoT per il caricamento di file è valido. Vedere: /azure/iot-hub/iot-hub-devguide-file-upload#file-upload-upload-notification-configuration-options. string

IotHubSkuInfo

Nome Descrizione Valore
capacità Numero di unità di hub IoT di cui è stato effettuato il provisioning. Vedere: /azure/azure-subscription-service-limits#iot-hub-limits. INT
name Il nome della SKU. 'B1'
'B2'
'B3'
'F1'
'S1'
'S2'
'S3' (obbligatorio)

Modelli di avvio rapido

I modelli di avvio rapido seguenti distribuiscono questo tipo di risorsa.

Modello Descrizione
Creare un simulatore perimetrale hub IOT e Ubuntu

Distribuisci in Azure
Questo modello crea un hub IOT e un simulatore perimetrale Ubuntu macchina virtuale.
Usare il modello di Resource Manager per creare hub IoT, indirizzare e visualizzare i messaggi

Distribuisci in Azure
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.
Creare un servizio Device Provisioning hub IoT

Distribuisci in Azure
Questo modello consente di creare un hub IoT e un hub IoT servizio Device Provisioning e collegare i due servizi tra loro.
Creare un hub IoT e un gruppo di consumer da dispositivo a cloud

Distribuisci in Azure
Questo modello consente di distribuire un'istanza di hub IoT con dispositivo nel cloud e nel cloud nelle configurazioni di messaggistica dei dispositivi e un dispositivo nel gruppo di consumer cloud.
Creare l'aggiornamento del dispositivo per hub IoT account, istanza hub IoT

Distribuisci in Azure
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

Distribuisci in Azure
Il servizio MedTech è uno dei servizi dati di integrità di Azure progettati per inserire i dati dei dispositivi da più dispositivi, trasformare i dati del dispositivo in osservazioni FHIR, che vengono quindi resi persistenti nel servizio FHIR di Servizi di integrità di Azure.
Creare un ambiente con pagamento in base al consumo con un hub IoT

Distribuisci in Azure
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.

Definizione della 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 di risorsa

Per creare una risorsa Microsoft.Devices/IotHubs, aggiungere il codice Terraform seguente al modello.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Devices/IotHubs@2023-06-30"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  identity {
    type = "string"
    identity_ids = []
  }
  body = jsonencode({
    properties = {
      allowedFqdnList = [
        "string"
      ]
      authorizationPolicies = [
        {
          keyName = "string"
          primaryKey = "string"
          rights = "string"
          secondaryKey = "string"
          keyName = "string"
          primaryKey = "string"
          rights = "string"
          secondaryKey = "string"
        }
      ]
      cloudToDevice = {
        defaultTtlAsIso8601 = "string"
        feedback = {
          lockDurationAsIso8601 = "string"
          maxDeliveryCount = int
          ttlAsIso8601 = "string"
        }
        maxDeliveryCount = int
      }
      comments = "string"
      disableDeviceSAS = bool
      disableLocalAuth = bool
      disableModuleSAS = bool
      enableDataResidency = bool
      enableFileUploadNotifications = bool
      eventHubEndpoints = {
        {customized property} = {
          partitionCount = int
          retentionTimeInDays = int
        }
      }
      features = "string"
      ipFilterRules = [
        {
          action = "string"
          filterName = "string"
          ipMask = "string"
        }
      ]
      messagingEndpoints = {
        {customized property} = {
          lockDurationAsIso8601 = "string"
          maxDeliveryCount = int
          ttlAsIso8601 = "string"
        }
      }
      minTlsVersion = "string"
      networkRuleSets = {
        applyToBuiltInEventHubEndpoint = bool
        defaultAction = "string"
        ipRules = [
          {
            action = "Allow"
            filterName = "string"
            ipMask = "string"
          }
        ]
      }
      privateEndpointConnections = [
        {
          properties = {
            privateEndpoint = {}
            privateLinkServiceConnectionState = {
              actionsRequired = "string"
              description = "string"
              status = "string"
            }
          }
        }
      ]
      publicNetworkAccess = "string"
      restrictOutboundNetworkAccess = bool
      routing = {
        endpoints = {
          cosmosDBSqlContainers = [
            {
              authenticationType = "string"
              containerName = "string"
              databaseName = "string"
              endpointUri = "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"
    }
    etag = "string"
  })
}

Valori delle proprietà

Hub IoT

Nome Descrizione Valore
tipo Tipo di risorsa "Microsoft.Devices/IotHubs@2023-06-30"
name Nome della risorsa stringa (obbligatoria)

Limite di caratteri: 3-50

Caratteri validi:
Caratteri alfanumerici e trattini.

Non può terminare con un trattino.

Il nome della risorsa deve essere univoco in Azure.
posizione Percorso della risorsa. stringa (obbligatoria)
parent_id Per distribuire in un gruppo di risorse, usare l'ID del gruppo di risorse. stringa (obbligatoria)
tags Tag di risorsa. Dizionario dei nomi e dei valori dei tag.
sku Informazioni sullo SKU IotHub IotHubSkuInfo (obbligatorio)
etag Il campo Etag non è obbligatorio. Se viene fornito nel corpo della risposta, deve essere fornito anche come intestazione per la normale convenzione ETag. string
identity Identità gestite per IotHub. ArmIdentity
properties Proprietà IotHub IotHubProperties

ArmIdentity

Nome Descrizione Valore
tipo Tipo di identità utilizzata 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 'Nessuno' rimuoverà le identità dal servizio. "SystemAssigned"
"SystemAssigned, UserAssigned"
"UserAssigned"
identity_ids Dizionario di {ArmUserIdentity} Matrice di ID identità utente.

ArmIdentityUserAssignedIdentities

Nome Descrizione Valore
{proprietà personalizzata} ArmUserIdentity

ArmUserIdentity

Questo oggetto non contiene proprietà da impostare durante la distribuzione. Tutte le proprietà sono ReadOnly.

IotHubProperties

Nome Descrizione Valore
allowedFqdnList Elenco di FQDNs 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
comments Commenti dell'hub IoT. string
disableDeviceSAS Se true, non è possibile usare tutte le chiavi SAS 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 dell'hub Iot per l'autenticazione. bool
disableModuleSAS Se true, non è possibile usare tutte le chiavi sas con ambito modulo per l'autenticazione. bool
enableDataResidency Questa proprietà, se impostata su true, consentirà la residenza dei dati, disabilitando quindi il ripristino di emergenza. bool
enableFileUploadNotifications Se True, le notifiche di caricamento dei file sono abilitate. bool
eventHubEndpoints Proprietà dell'endpoint compatibili con Hub eventi. Le uniche chiavi possibili per questo dizionario sono eventi. Questa chiave deve essere presente nel dizionario durante l'esecuzione di chiamate di creazione o aggiornamento per l'hub IoT. IotHubPropertiesEventHubEndpoints
funzionalità Funzionalità e funzionalità abilitate per l'hub IoT. "DeviceManagement"
"None"
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 TLS da supportare per questo hub. Può essere impostato su "1.2" per avere client che usano una versione TLS inferiore alla versione 1.2 da rifiutare. string
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"
"Abilitato"
limitOutboundNetworkAccess Se true, l'uscita da IotHub sarà limitata solo agli FQDN consentiti configurati tramite allowedFqdnList. bool
routing 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 file. Attualmente è possibile configurare un solo account di archiviazione di Azure e che deve avere la chiave come $default. Se si specificano più account di archiviazione, viene generato un errore. Non specificando un valore per questa proprietà quando la proprietà enableFileUploadNotifications è impostata su True, genera un errore. IotHubPropertiesStorageEndpoints

SharedAccessSignatureAuthorizationRule

Nome Descrizione Valore
keyName Nome dei criteri di accesso condiviso. stringa (obbligatoria)
primaryKey Chiave primaria. string
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. string
keyName Nome dei criteri di accesso condiviso. stringa (obbligatoria)
primaryKey Chiave primaria. string
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. string

CloudToDeviceProperties

Nome Descrizione Valore
defaultTtlAsIso8601 Ora predefinita per i messaggi da cloud a dispositivo nella coda del dispositivo. Vedere: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. string
feedback Proprietà della coda di feedback per i messaggi da cloud a dispositivo. Proprietà feedback
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

Proprietà feedback

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. string
maxDeliveryCount Numero di volte in cui l'hub IoT tenta di recapitare un messaggio 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 che sia scaduto dall'hub IoT. Vedere: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. string

IotHubPropertiesEventHubEndpoints

Nome Descrizione Valore
{proprietà personalizzata} EventHubProperties

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

IpFilterRule

Nome Descrizione Valore
azione Azione desiderata per le richieste acquisite da questa regola. "Accetta"
"Rifiuta" (obbligatorio)
filterName Nome della regola di filtro IP. stringa (obbligatoria)
ipMask Stringa contenente l'intervallo di indirizzi IP nella notazione CIDR per la regola. stringa (obbligatoria)

IotHubPropertiesMessagingEndpoints

Nome Descrizione Valore
{proprietà personalizzata} MessagingEndpointProperties

MessagingEndpointProperties

Nome Descrizione Valore
lockDurationAsIso8601 Durata del blocco. Vedere: /azure/iot-hub/iot-hub-devguide-file-upload. string
maxDeliveryCount Numero di volte in cui l'hub IoT tenta di recapitare un messaggio. 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 che sia scaduto dall'hub IoT. Vedere: /azure/iot-hub/iot-hub-devguide-file-upload. string

NetworkRuleSetProperties

Nome Descrizione Valore
applyToBuiltInEventHubEndpoint Se True, il set di regole di rete viene applicato anche a BuiltIn EventHub EndPoint di IotHub bool (obbligatorio)
Defaultaction Azione predefinita per il set di regole di rete "Consenti"
"Nega"
ipRules Elenco di regole IP NetworkRuleSetIpRule[] (obbligatorio)

NetworkRuleSetIpRule

Nome Descrizione Valore
azione Azione filtro IP "Consenti"
filterName Nome della regola di filtro IP. stringa (obbligatorio)
ipMask Stringa contenente l'intervallo di indirizzi IP nella notazione CIDR per la regola. stringa (obbligatorio)

PrivateEndpointConnection

Nome Descrizione Valore
properties Proprietà di una connessione endpoint privato PrivateEndpointConnectionProperties (obbligatorio)

PrivateEndpointConnectionProperties

Nome Descrizione Valore
privateEndpoint Proprietà dell'endpoint privato di una connessione all'endpoint privato PrivateEndpoint
privateLinkServiceConnectionState Stato corrente di una connessione endpoint privato PrivateLinkServiceConnectionState (obbligatorio)

PrivateEndpoint

Questo oggetto non contiene proprietà da impostare durante la distribuzione. Tutte le proprietà sono ReadOnly.

PrivateLinkServiceConnectionState

Nome Descrizione Valore
actionsRequired Azioni necessarie per una connessione endpoint privato string
description Descrizione dello stato corrente di una connessione all'endpoint privato stringa (obbligatorio)
status Stato di una connessione endpoint privato "Approvato"
"Disconnesso"
"In sospeso"
"Rifiutato" (obbligatorio)

RoutingProperties

Nome Descrizione Valore
endpoints Le proprietà correlate agli endpoint personalizzati a cui l'hub IoT instrada i messaggi in base alle regole di routing. È consentito un massimo di 10 endpoint personalizzati 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 si applica ai messaggi da recapitare agli endpoint predefiniti e personalizzati. Vedere: https://aka.ms/telemetryoneventgrid EnrichmentProperties[]
fallbackRoute Le proprietà della route utilizzate come route di fallback quando non vengono soddisfatte le condizioni specificate nella sezione "route". Questo parametro è facoltativo. Quando questa proprietà non è presente nel modello, la route di fallback è disabilitata per impostazione predefinita. FallbackRouteProperties
route Elenco di regole di routing fornite dall'utente usate dall'hub IoT per instradare i messaggi agli endpoint predefiniti e personalizzati. Sono consentite al massimo 100 regole di routing per gli hub a pagamento e sono consentite al massimo 5 regole di routing per gli hub gratuiti. RouteProperties[]

RoutingEndpoints

Nome Descrizione Valore
cosmosDBSqlContainers Elenco di endpoint del contenitore Cosmos DB a cui l'hub IoT indirizza i messaggi in base alle regole di routing. RoutingCosmosDBSqlApiProperties[]
eventHubs Elenco di endpoint di Hub eventi a cui l'hub IoT indirizza 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 instrada i messaggi in base alle regole di routing. RoutingServiceBusTopicEndpointProperties[]
storageContainers L'elenco degli endpoint del contenitore di archiviazione a cui l'hub IoT indirizza i messaggi in base alle regole di routing. RoutingStorageContainerProperties[]

RoutingCosmosDBSqlApiProperties

Nome Descrizione Valore
authenticationType Metodo usato per eseguire l'autenticazione nell'endpoint del contenitore SQL di Cosmos DB "identityBased"
"keyBased"
containerName Nome del contenitore sql cosmos DB nel database cosmos DB. stringa (obbligatoria)
databaseName Nome del database cosmos DB nell'account cosmos DB. stringa (obbligatoria)
endpointUri URL dell'account cosmos DB. Deve includere il protocollo https:// stringa (obbligatoria)
identity Proprietà dell'identità gestita dell'endpoint del contenitore cosmos DB. ManagedIdentity
name 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. stringa (obbligatoria)

Vincoli:
Pattern = ^[A-Za-z0-9-._]{1,64}$
partitionKeyName Nome della chiave di partizione associata a questo contenitore sql cosmos DB se presente. Questo parametro è facoltativo. string
partitionKeyTemplate Modello per la generazione di un valore di chiave di partizione sintetica da usare con questo contenitore sql cosmos DB. Il modello deve includere almeno uno dei segnaposto seguenti: {iothub}, {deviceid}, {DD}, {MM}e {AAAA}. Qualsiasi segnaposto può essere specificato al massimo una volta, ma i componenti di ordine e non segnaposto sono arbitrari. Questo parametro è obbligatorio solo se PartitionKeyName è specificato. string
primaryKey Chiave primaria dell'account cosmos DB. string

Vincoli:
Valore sensibile. Passare come parametro sicuro.
resourceGroup Nome del gruppo di risorse dell'account cosmos DB. string
secondaryKey Chiave secondaria dell'account cosmos DB. string

Vincoli:
Valore sensibile. Passare come parametro sicuro.
subscriptionId Identificatore della sottoscrizione dell'account cosmos DB. string

ManagedIdentity

Nome Descrizione Valore
userAssignedIdentity Identità assegnata dall'utente. string

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. string
endpointUri URL dell'endpoint dell'hub eventi. Deve includere il protocollo sb:// string
entityPath Nome dell'hub eventi nello spazio dei nomi dell'hub eventi string
id ID dell'endpoint dell'hub eventi string
identity Proprietà dell'identità gestita dell'endpoint dell'hub eventi di routing. ManagedIdentity
name 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. stringa (obbligatoria)

Vincoli:
Pattern = ^[A-Za-z0-9-._]{1,64}$
resourceGroup Nome del gruppo di risorse dell'endpoint dell'hub eventi. string
subscriptionId Identificatore della sottoscrizione dell'endpoint dell'hub eventi. string

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. string
endpointUri URL dell'endpoint della coda del bus di servizio. Deve includere il protocollo sb:// string
entityPath Nome della coda nello spazio dei nomi del bus di servizio string
id ID dell'endpoint della coda del bus di servizio string
identity Proprietà dell'identità gestita dell'endpoint della coda del bus di servizio di routing. ManagedIdentity
name 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 essere uguale al nome effettivo della coda. stringa (obbligatoria)

Vincoli:
Pattern = ^[A-Za-z0-9-._]{1,64}$
resourceGroup Nome del gruppo di risorse dell'endpoint della coda del bus di servizio. string
subscriptionId Identificatore della sottoscrizione dell'endpoint della coda del bus di servizio. string

RoutingServiceBusTopicEndpointProperties

Nome Descrizione Valore
authenticationType Metodo usato per l'autenticazione nell'endpoint dell'argomento del bus di servizio "identityBased"
"keyBased"
connectionString Stringa di connessione dell'endpoint dell'argomento del bus di servizio. string
endpointUri URL dell'endpoint dell'argomento del bus di servizio. Deve includere il protocollo sb:// string
entityPath Nome della coda nell'argomento del bus di servizio string
id ID dell'endpoint dell'argomento del bus di servizio string
identity Proprietà dell'identità gestita dell'endpoint dell'argomento del bus di servizio di routing. ManagedIdentity
name 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 essere uguale al nome dell'argomento effettivo. stringa (obbligatoria)

Vincoli:
Pattern = ^[A-Za-z0-9-._]{1,64}$
resourceGroup Nome del gruppo di risorse dell'endpoint dell'argomento del bus di servizio. string
subscriptionId Identificatore della sottoscrizione dell'endpoint dell'argomento del bus di servizio. string

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. string
containerName Nome del contenitore di archiviazione nell'account di archiviazione. stringa (obbligatoria)
codifica Codifica usata 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:// string
fileNameFormat Formato del nome file per il BLOB. Il formato predefinito è {iothub}/{partition}/{YYY}/{MM}/{DD}/{HH}/{mm}. Tutti i parametri sono obbligatori, ma possono essere riordinati. string
id ID dell'endpoint del contenitore di archiviazione string
identity Proprietà dell'identità gestita dell'endpoint di archiviazione di routing. ManagedIdentity
maxChunkSizeInBytes Numero massimo di byte per ogni BLOB scritto nell'archiviazione. Il valore deve essere compreso tra 10485760(10 MB) e 524288000(500 MB). Il valore predefinito è 314572800(300 MB). INT

Vincoli:
Valore minimo = 10485760
Valore massimo = 524288000
name 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. stringa (obbligatoria)

Vincoli:
Pattern = ^[A-Za-z0-9-._]{1,64}$
resourceGroup Nome del gruppo di risorse dell'account di archiviazione. string
subscriptionId Identificatore della sottoscrizione dell'account di archiviazione. string

Proprietà di arricchimento

Nome Descrizione Valore
endpointNames Elenco di endpoint per i quali viene applicato l'arricchimento al messaggio. string[] (obbligatorio)

Vincoli:
Lunghezza minima = 1
Key Chiave o nome per la proprietà di arricchimento. stringa (obbligatoria)
Valore Valore della proprietà di arricchimento. stringa (obbligatoria)

FallbackRouteProperties

Nome Descrizione Valore
condizione Condizione valutata per applicare la route di fallback. Se la condizione non viene fornita, verrà valutata su true per impostazione predefinita. Per la grammatica, vedere: /azure/iot-hub/iot-hub-devguide-query-language string
endpointNames Elenco di endpoint a cui vengono indirizzati i messaggi che soddisfano la condizione. Attualmente è consentito solo 1 endpoint. string[] (obbligatorio)

Vincoli:
Lunghezza minima = 1
Lunghezza massima = 1
isEnabled Usato per specificare se la route di fallback è abilitata. bool (obbligatorio)
name 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. string
source Origine a cui applicare la regola di routing. Ad esempio, DeviceMessages "DeviceConnectionStateEvents"
"DeviceJobLifecycleEvents"
"DeviceLifecycleEvents"
"DeviceMessages"
"Non valido"
"TwinChangeEvents" (obbligatorio)

RouteProperties

Nome Descrizione Valore
condizione Condizione valutata per applicare la regola di routing. Se non viene fornita alcuna condizione, restituisce true per impostazione predefinita. Per la grammatica, vedere: /azure/iot-hub/iot-hub-devguide-query-language string
endpointNames Elenco di endpoint a cui vengono indirizzati i messaggi che soddisfano la condizione. Attualmente è consentito un solo endpoint. string[] (obbligatorio)

Vincoli:
Lunghezza minima = 1
Lunghezza massima = 1
isEnabled Usato per specificare se è abilitata una route. bool (obbligatorio)
name 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. stringa (obbligatoria)

Vincoli:
Pattern = ^[A-Za-z0-9-._]{1,64}$
source Origine a cui deve essere applicata la regola di routing, ad esempio DeviceMessages. "DeviceConnectionStateEvents"
"DeviceJobLifecycleEvents"
"DeviceLifecycleEvents"
"DeviceMessages"
"Non valido"
"TwinChangeEvents" (obbligatorio)

IotHubPropertiesStorageEndpoints

Nome Descrizione Valore
{proprietà personalizzata} StorageEndpointProperties

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 (obbligatoria)
containerName Nome del contenitore radice in cui si caricano i file. Il contenitore non deve esistere ma deve essere creato usando il connectionString specificato. stringa (obbligatoria)
identity 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 da hub IoT per il caricamento di file è valido. Vedere: /azure/iot-hub/iot-hub-devguide-file-upload#file-upload-notification-configuration-options. string

IotHubSkuInfo

Nome Descrizione Valore
capacità Numero di unità di hub IoT di cui è stato effettuato il provisioning. Vedere: /azure/azure-subscription-service-limits#iot-hub-limits. INT
name Il nome della SKU. "B1"
"B2"
"B3"
"F1"
"S1"
"S2"
"S3" (obbligatorio)