Condividi tramite


Iot Hub Resource - Get

Ottenere i metadati non correlati alla sicurezza di un hub IoT.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}?api-version=2023-06-30

Parametri dell'URI

Nome In Necessario Tipo Descrizione
resourceGroupName
path True

string

Nome del gruppo di risorse che contiene l'hub IoT.

resourceName
path True

string

Nome dell'hub IoT.

subscriptionId
path True

string

L'identificatore della sottoscrizione.

api-version
query True

string

Versione dell'API.

Risposte

Nome Tipo Descrizione
200 OK

IotHubDescription

Il corpo contiene tutte le proprietà non di sicurezza dell'hub IoT. Le proprietà correlate alla sicurezza sono impostate su Null.

Other Status Codes

ErrorDetails

DefaultErrorResponse

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome Descrizione
user_impersonation rappresentare l'account utente

Esempio

IotHubResource_Get

Esempio di richiesta

GET https://management.azure.com/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub?api-version=2023-06-30

Risposta di esempio

{
  "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub",
  "name": "testHub",
  "type": "Microsoft.Devices/IotHubs",
  "location": "centraluseuap",
  "tags": {},
  "etag": "AAAAAAFD6M4=",
  "properties": {
    "state": "Active",
    "provisioningState": "Succeeded",
    "ipFilterRules": [
      {
        "filterName": "rule1",
        "action": "Accept",
        "ipMask": "131.117.159.53"
      },
      {
        "filterName": "rule2",
        "action": "Accept",
        "ipMask": "157.55.59.128/25"
      }
    ],
    "networkRuleSets": {
      "defaultAction": "Deny",
      "applyToBuiltInEventHubEndpoint": true,
      "ipRules": [
        {
          "filterName": "rule1",
          "action": "Allow",
          "ipMask": "131.117.159.53"
        },
        {
          "filterName": "rule2",
          "action": "Allow",
          "ipMask": "157.55.59.128/25"
        }
      ]
    },
    "hostName": "iot-dps-cit-hub-1.azure-devices.net",
    "eventHubEndpoints": {
      "events": {
        "retentionTimeInDays": 1,
        "partitionCount": 2,
        "partitionIds": [
          "0",
          "1"
        ],
        "path": "iot-dps-cit-hub-1",
        "endpoint": "sb://iothub-ns-iot-dps-ci-245306-76aca8e13b.servicebus.windows.net/"
      }
    },
    "routing": {
      "endpoints": {
        "serviceBusQueues": [],
        "serviceBusTopics": [],
        "eventHubs": [],
        "storageContainers": []
      },
      "routes": [],
      "fallbackRoute": {
        "source": "DeviceMessages",
        "condition": "true",
        "endpointNames": [
          "events"
        ],
        "isEnabled": true
      }
    },
    "storageEndpoints": {
      "$default": {
        "sasTtlAsIso8601": "PT1H",
        "connectionString": "",
        "containerName": ""
      }
    },
    "messagingEndpoints": {
      "fileNotifications": {
        "lockDurationAsIso8601": "PT1M",
        "ttlAsIso8601": "PT1H",
        "maxDeliveryCount": 10
      }
    },
    "enableFileUploadNotifications": false,
    "cloudToDevice": {
      "maxDeliveryCount": 10,
      "defaultTtlAsIso8601": "PT1H",
      "feedback": {
        "lockDurationAsIso8601": "PT1M",
        "ttlAsIso8601": "PT1H",
        "maxDeliveryCount": 10
      }
    },
    "features": "None",
    "locations": [
      {
        "location": "West US",
        "role": "primary"
      },
      {
        "location": "East US",
        "role": "secondary"
      }
    ],
    "minTlsVersion": "1.2"
  },
  "sku": {
    "name": "S1",
    "tier": "Standard",
    "capacity": 1
  },
  "systemData": {
    "createdAt": "2021-01-30T00:28:38.963Z"
  }
}

Definizioni

Nome Descrizione
AccessRights

Autorizzazioni assegnate ai criteri di accesso condiviso.

ArmIdentity
ArmUserIdentity
AuthenticationType

Specifica il tipo di autenticazione usato per la connessione all'account di archiviazione.

authenticationType

Metodo usato per eseguire l'autenticazione nell'endpoint della coda del bus di servizio

Capabilities

Funzionalità e funzionalità abilitate per l'hub IoT.

CloudToDeviceProperties

Proprietà di messaggistica da cloud a dispositivo dell'hub IoT.

createdByType

Tipo di identità che ha creato la risorsa.

DefaultAction

Azione predefinita per il set di regole di rete

EnrichmentProperties

Le proprietà di un arricchimento applicato all'hub IoT ai messaggi recapitati agli endpoint.

ErrorDetails

Dettagli errore.

EventHubProperties

Proprietà dell'endpoint compatibile con Hub eventi di cui è stato effettuato il provisioning usate dall'hub IoT.

FallbackRouteProperties

Proprietà della route di fallback. L'hub IoT usa queste proprietà quando indirizza i messaggi all'endpoint di fallback.

FeedbackProperties

Proprietà della coda di feedback per i messaggi da cloud a dispositivo.

IotHubDescription

Descrizione dell'hub IoT.

IotHubLocationDescription

Rappresentazione pubblica di una delle posizioni in cui viene effettuato il provisioning di una risorsa.

IotHubProperties

Proprietà di un hub IoT.

IotHubReplicaRoleType

Il ruolo dell'area può essere primario o secondario. L'area primaria è la posizione in cui è attualmente stato effettuato il provisioning dell'hub IoT. L'area secondaria è l'area associata del ripristino di emergenza di Azure e anche l'area in cui l'hub IoT può eseguire il failover.

IotHubSku

Nome dello SKU.

IotHubSkuInfo

Informazioni sullo SKU dell'hub IoT.

IotHubSkuTier

Livello di fatturazione per l'hub IoT.

IpFilterActionType

Azione desiderata per le richieste acquisite da questa regola.

IpFilterRule

Regole di filtro IP per l'hub IoT.

ManagedIdentity

Proprietà dell'identità gestita.

MessagingEndpointProperties

Proprietà degli endpoint di messaggistica usati da questo hub IoT.

NetworkRuleIPAction

Azione filtro IP

NetworkRuleSetIpRule

Regola IP da applicare come parte del set di regole di rete

NetworkRuleSetProperties

Proprietà del set di regole di rete di IotHub

PrivateEndpoint

Proprietà dell'endpoint privato di una connessione endpoint privato

PrivateEndpointConnection

Connessione dell'endpoint privato di un IotHub

PrivateEndpointConnectionProperties

Proprietà di una connessione endpoint privato

PrivateLinkServiceConnectionState

Stato corrente di una connessione endpoint privato

PrivateLinkServiceConnectionStatus

Stato di una connessione endpoint privato

PublicNetworkAccess

Indica se le richieste dalla rete pubblica sono consentite

ResourceIdentityType

Tipo di identità usata per la risorsa. Il tipo 'SystemAssigned, UserAssigned' include sia un'identità creata in modo implicito che un set di identità assegnate dall'utente. Il tipo 'None' rimuoverà tutte le identità dal servizio.

RouteProperties

Proprietà di una regola di routing usata dall'hub IoT per instradare i messaggi agli endpoint.

RoutingCosmosDBSqlApiProperties

Proprietà correlate a un endpoint del contenitore SQL di Cosmos DB.

RoutingEndpoints

Le proprietà correlate agli endpoint personalizzati a cui l'hub IoT instrada i messaggi in base alle regole di routing. Un massimo di 10 endpoint personalizzati è consentito in tutti i tipi di endpoint per gli hub a pagamento e solo 1 endpoint personalizzato è consentito in tutti i tipi di endpoint per gli hub gratuiti.

RoutingEventHubProperties

Proprietà correlate a un endpoint dell'hub eventi.

RoutingProperties

Proprietà correlate al routing dell'hub IoT. Vedere: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging

RoutingServiceBusQueueEndpointProperties

Proprietà correlate ai tipi di endpoint della coda del bus di servizio.

RoutingServiceBusTopicEndpointProperties

Proprietà correlate ai tipi di endpoint dell'argomento del bus di servizio.

RoutingSource

Origine a cui applicare la regola di routing, ad esempio DeviceMessages.

RoutingStorageContainerProperties

Proprietà correlate a un endpoint del contenitore di archiviazione.

SharedAccessSignatureAuthorizationRule

Proprietà di un criterio di accesso condiviso dell'hub IoT.

StorageEndpointProperties

Proprietà dell'endpoint di Archiviazione di Azure per il caricamento di file.

systemData

Metadati relativi alla creazione e all'ultima modifica della risorsa.

AccessRights

Autorizzazioni assegnate ai criteri di accesso condiviso.

Valore Descrizione
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

ArmIdentity

Nome Tipo Descrizione
principalId

string

ID entità

tenantId

string

Tenant Id

type

ResourceIdentityType

Tipo di identità usata per la risorsa. Il tipo 'SystemAssigned, UserAssigned' include sia un'identità creata in modo implicito che un set di identità assegnate dall'utente. Il tipo 'None' rimuoverà tutte le identità dal servizio.

userAssignedIdentities

<string,  ArmUserIdentity>

ArmUserIdentity

Nome Tipo Descrizione
clientId

string

principalId

string

AuthenticationType

Specifica il tipo di autenticazione usato per la connessione all'account di archiviazione.

Valore Descrizione
identityBased
keyBased

authenticationType

Metodo usato per eseguire l'autenticazione nell'endpoint della coda del bus di servizio

Valore Descrizione
identityBased
keyBased

Capabilities

Funzionalità e funzionalità abilitate per l'hub IoT.

Valore Descrizione
DeviceManagement
None

CloudToDeviceProperties

Proprietà di messaggistica da cloud a dispositivo dell'hub IoT.

Nome Tipo Descrizione
defaultTtlAsIso8601

string (duration)

Durata predefinita per i messaggi da cloud a dispositivo nella coda del dispositivo. Vedere: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.

feedback

FeedbackProperties

Proprietà della coda di feedback per i messaggi da cloud a dispositivo.

maxDeliveryCount

integer (int32)

minimum: 1
maximum: 100

Numero massimo di recapito per i messaggi da cloud a dispositivo nella coda del dispositivo. Vedere: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.

createdByType

Tipo di identità che ha creato la risorsa.

Valore Descrizione
Application
Key
ManagedIdentity
User

DefaultAction

Azione predefinita per il set di regole di rete

Valore Descrizione
Allow
Deny

EnrichmentProperties

Le proprietà di un arricchimento applicato all'hub IoT ai messaggi recapitati agli endpoint.

Nome Tipo Descrizione
endpointNames

string[]

Elenco di endpoint per cui viene applicato l'arricchimento al messaggio.

key

string

Chiave o nome per la proprietà di arricchimento.

value

string

Valore per la proprietà di arricchimento.

ErrorDetails

Dettagli errore.

Nome Tipo Descrizione
code

string

Codice di errore.

details

string

Dettagli dell'errore.

httpStatusCode

string

Codice di stato HTTP.

message

string

Messaggio di errore.

EventHubProperties

Proprietà dell'endpoint compatibile con Hub eventi di cui è stato effettuato il provisioning usate dall'hub IoT.

Nome Tipo Descrizione
endpoint

string

Endpoint compatibile con Hub eventi.

partitionCount

integer (int32)

Numero di partizioni per la ricezione di messaggi da dispositivo a cloud nell'endpoint compatibile con Hub eventi. Vedere: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages.

partitionIds

string[]

ID di partizione nell'endpoint compatibile con Hub eventi.

path

string

Nome compatibile con Hub eventi.

retentionTimeInDays

integer (int64)

Tempo di conservazione per i messaggi da dispositivo a cloud in giorni. Vedere: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages

FallbackRouteProperties

Proprietà della route di fallback. L'hub IoT usa queste proprietà quando indirizza i messaggi all'endpoint di fallback.

Nome Tipo Descrizione
condition

string

Condizione valutata per applicare la route di fallback. Se la condizione non viene fornita, restituisce true per impostazione predefinita. Per la grammatica, vedere: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language

endpointNames

string[]

Elenco di endpoint a cui vengono indirizzati i messaggi che soddisfano la condizione. Attualmente è consentito solo 1 endpoint.

isEnabled

boolean

Consente di specificare se la route di fallback è abilitata.

name

string

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.

source

RoutingSource

Origine a cui applicare la regola di routing. Ad esempio, DeviceMessages

FeedbackProperties

Proprietà della coda di feedback per i messaggi da cloud a dispositivo.

Nome Tipo Descrizione
lockDurationAsIso8601

string (duration)

Durata del blocco per la coda di commenti e suggerimenti. Vedere: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.

maxDeliveryCount

integer (int32)

minimum: 1
maximum: 100

Numero di tentativi di recapito dell'hub IoT nella coda di feedback. Vedere: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.

ttlAsIso8601

string (duration)

Periodo di tempo per il quale un messaggio è disponibile per l'utilizzo prima della scadenza dell'hub IoT. Vedere: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.

IotHubDescription

Descrizione dell'hub IoT.

Nome Tipo Descrizione
etag

string

Il campo Etag è non obbligatorio. Se viene specificato nel corpo della risposta, deve anche essere fornito come intestazione in base alla normale convenzione ETag.

id

string

Identificatore della risorsa.

identity

ArmIdentity

Identità gestite per IotHub.

location

string

Percorso della risorsa.

name

string

pattern: ^(?![0-9]+$)(?!-)[a-zA-Z0-9-]{2,49}[a-zA-Z0-9]$

Nome della risorsa.

properties

IotHubProperties

Proprietà IotHub

sku

IotHubSkuInfo

Informazioni sullo SKU IotHub

systemData

systemData

Metadati di sistema relativi a questa risorsa.

tags

object

Tag di risorsa.

type

string

Tipo di risorsa.

IotHubLocationDescription

Rappresentazione pubblica di una delle posizioni in cui viene effettuato il provisioning di una risorsa.

Nome Tipo Descrizione
location

string

Nome dell'area di Azure

role

IotHubReplicaRoleType

Il ruolo dell'area può essere primario o secondario. L'area primaria è la posizione in cui è attualmente stato effettuato il provisioning dell'hub IoT. L'area secondaria è l'area associata del ripristino di emergenza di Azure e anche l'area in cui l'hub IoT può eseguire il failover.

IotHubProperties

Proprietà di un hub IoT.

Nome Tipo Descrizione
allowedFqdnList

string[]

Elenco degli FQDN consentiti (nome di dominio completo) per l'uscita dall'hub Iot.

authorizationPolicies

SharedAccessSignatureAuthorizationRule[]

I criteri di accesso condiviso che è possibile usare per proteggere una connessione all'hub IoT.

cloudToDevice

CloudToDeviceProperties

Proprietà di messaggistica da cloud a dispositivo dell'hub IoT.

comments

string

Commenti dell'hub IoT.

disableDeviceSAS

boolean

Se true, non è possibile usare tutte le chiavi di firma di accesso condiviso con ambito dispositivo(inclusi i dispositivi Edge ma esclusi i moduli) per l'autenticazione.

disableLocalAuth

boolean

Se true, non è possibile usare i token di firma di accesso condiviso con ambito hub Iot per l'autenticazione.

disableModuleSAS

boolean

Se true, non è possibile usare tutte le chiavi di firma di accesso condiviso con ambito modulo per l'autenticazione.

enableDataResidency

boolean

Questa proprietà, se impostata su true, consentirà la residenza dei dati, disabilitando quindi il ripristino di emergenza.

enableFileUploadNotifications

boolean

Se True, le notifiche di caricamento dei file sono abilitate.

eventHubEndpoints

<string,  EventHubProperties>

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.

features

Capabilities

Funzionalità e funzionalità abilitate per l'hub IoT.

hostName

string

Nome dell'host.

ipFilterRules

IpFilterRule[]

Regole di filtro IP.

locations

IotHubLocationDescription[]

Posizione primaria e secondaria per l'hub iot

messagingEndpoints

<string,  MessagingEndpointProperties>

Proprietà dell'endpoint di messaggistica per la coda di notifica di caricamento file.

minTlsVersion

string

Specifica la versione minima di TLS da supportare per questo hub. Può essere impostato su "1.2" per fare in modo che i client che usano una versione TLS precedente alla 1.2 vengano rifiutati.

networkRuleSets

NetworkRuleSetProperties

Proprietà del set di regole di rete di IotHub

privateEndpointConnections

PrivateEndpointConnection[]

Connessioni endpoint private create in questo IotHub

provisioningState

string

Stato del provisioning.

publicNetworkAccess

PublicNetworkAccess

Indica se le richieste dalla rete pubblica sono consentite

restrictOutboundNetworkAccess

boolean

Se true, l'uscita da IotHub sarà limitata solo ai nomi di dominio completi consentiti configurati tramite allowedFqdnList.

routing

RoutingProperties

Proprietà correlate al routing dell'hub IoT. Vedere: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging

state

string

Stato dell'hub.

storageEndpoints

<string,  StorageEndpointProperties>

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.

IotHubReplicaRoleType

Il ruolo dell'area può essere primario o secondario. L'area primaria è la posizione in cui è attualmente stato effettuato il provisioning dell'hub IoT. L'area secondaria è l'area associata del ripristino di emergenza di Azure e anche l'area in cui l'hub IoT può eseguire il failover.

Valore Descrizione
primary
secondary

IotHubSku

Nome dello SKU.

Valore Descrizione
B1
B2
B3
F1
S1
S2
S3

IotHubSkuInfo

Informazioni sullo SKU dell'hub IoT.

Nome Tipo Descrizione
capacity

integer (int64)

Numero di unità dell'hub IoT di cui è stato effettuato il provisioning. Vedere: https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits.

name

IotHubSku

Nome dello SKU.

tier

IotHubSkuTier

Livello di fatturazione per l'hub IoT.

IotHubSkuTier

Livello di fatturazione per l'hub IoT.

Valore Descrizione
Basic
Free
Standard

IpFilterActionType

Azione desiderata per le richieste acquisite da questa regola.

Valore Descrizione
Accept
Reject

IpFilterRule

Regole di filtro IP per l'hub IoT.

Nome Tipo Descrizione
action

IpFilterActionType

Azione desiderata per le richieste acquisite da questa regola.

filterName

string

Nome della regola di filtro IP.

ipMask

string

Stringa che contiene l'intervallo di indirizzi IP nella notazione CIDR per la regola.

ManagedIdentity

Proprietà dell'identità gestita.

Nome Tipo Descrizione
userAssignedIdentity

string

Identità assegnata dall'utente.

MessagingEndpointProperties

Proprietà degli endpoint di messaggistica usati da questo hub IoT.

Nome Tipo Descrizione
lockDurationAsIso8601

string (duration)

Durata del blocco. Vedere: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload.

maxDeliveryCount

integer (int32)

minimum: 1
maximum: 100

Numero di tentativi di recapitare un messaggio nell'hub IoT. Vedere: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload.

ttlAsIso8601

string (duration)

Periodo di tempo per il quale un messaggio è disponibile per l'utilizzo prima della scadenza dell'hub IoT. Vedere: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload.

NetworkRuleIPAction

Azione filtro IP

Valore Descrizione
Allow

NetworkRuleSetIpRule

Regola IP da applicare come parte del set di regole di rete

Nome Tipo Valore predefinito Descrizione
action

NetworkRuleIPAction

Allow

Azione filtro IP

filterName

string

Nome della regola di filtro IP.

ipMask

string

Stringa che contiene l'intervallo di indirizzi IP nella notazione CIDR per la regola.

NetworkRuleSetProperties

Proprietà del set di regole di rete di IotHub

Nome Tipo Valore predefinito Descrizione
applyToBuiltInEventHubEndpoint

boolean

Se True, anche il set di regole di rete viene applicato a BuiltIn EventHub EndPoint di IotHub

defaultAction

DefaultAction

Deny

Azione predefinita per il set di regole di rete

ipRules

NetworkRuleSetIpRule[]

Elenco delle regole IP

PrivateEndpoint

Proprietà dell'endpoint privato di una connessione endpoint privato

Nome Tipo Descrizione
id

string

Identificatore della risorsa.

PrivateEndpointConnection

Connessione dell'endpoint privato di un IotHub

Nome Tipo Descrizione
id

string

Identificatore della risorsa.

name

string

Nome della risorsa.

properties

PrivateEndpointConnectionProperties

Proprietà di una connessione endpoint privato

type

string

Tipo di risorsa.

PrivateEndpointConnectionProperties

Proprietà di una connessione endpoint privato

Nome Tipo Descrizione
privateEndpoint

PrivateEndpoint

Proprietà dell'endpoint privato di una connessione endpoint privato

privateLinkServiceConnectionState

PrivateLinkServiceConnectionState

Stato corrente di una connessione endpoint privato

PrivateLinkServiceConnectionState

Stato corrente di una connessione endpoint privato

Nome Tipo Descrizione
actionsRequired

string

Azioni necessarie per una connessione all'endpoint privato

description

string

Descrizione dello stato corrente di una connessione endpoint privato

status

PrivateLinkServiceConnectionStatus

Stato di una connessione endpoint privato

PrivateLinkServiceConnectionStatus

Stato di una connessione endpoint privato

Valore Descrizione
Approved
Disconnected
Pending
Rejected

PublicNetworkAccess

Indica se le richieste dalla rete pubblica sono consentite

Valore Descrizione
Disabled
Enabled

ResourceIdentityType

Tipo di identità usata per la risorsa. Il tipo 'SystemAssigned, UserAssigned' include sia un'identità creata in modo implicito che un set di identità assegnate dall'utente. Il tipo 'None' rimuoverà tutte le identità dal servizio.

Valore Descrizione
None
SystemAssigned
SystemAssigned, UserAssigned
UserAssigned

RouteProperties

Proprietà di una regola di routing usata dall'hub IoT per instradare i messaggi agli endpoint.

Nome Tipo Descrizione
condition

string

Condizione valutata per applicare la regola di routing. Se non viene specificata alcuna condizione, restituisce true per impostazione predefinita. Per la grammatica, vedere: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language

endpointNames

string[]

Elenco di endpoint a cui vengono indirizzati i messaggi che soddisfano la condizione. Attualmente è consentito un solo endpoint.

isEnabled

boolean

Consente di specificare se una route è abilitata.

name

string

pattern: ^[A-Za-z0-9-._]{1,64}$

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.

source

RoutingSource

Origine a cui applicare la regola di routing, ad esempio DeviceMessages.

RoutingCosmosDBSqlApiProperties

Proprietà correlate a un endpoint del contenitore SQL di Cosmos DB.

Nome Tipo Descrizione
authenticationType

authenticationType

Metodo usato per eseguire l'autenticazione nell'endpoint del contenitore SQL di Cosmos DB

containerName

string

Nome del contenitore sql cosmos DB nel database cosmos DB.

databaseName

string

Nome del database cosmos DB nell'account cosmos DB.

endpointUri

string (uri)

URL dell'account cosmos DB. Deve includere il protocollo https://

id

string

ID dell'endpoint del contenitore SQL di Cosmos DB

identity

ManagedIdentity

Proprietà dell'identità gestita dell'endpoint del contenitore cosmos DB di routing.

name

string

pattern: ^[A-Za-z0-9-._]{1,64}$

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.

partitionKeyName

string

Nome della chiave di partizione associata a questo contenitore sql cosmos DB, se presente. Questo è un parametro opzionale.

partitionKeyTemplate

string

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 di ordine e non segnaposto sono arbitrari. Questo parametro è obbligatorio solo se è specificato PartitionKeyName.

primaryKey

string

Chiave primaria dell'account cosmos DB.

resourceGroup

string

Nome del gruppo di risorse dell'account cosmos DB.

secondaryKey

string

Chiave secondaria dell'account cosmos DB.

subscriptionId

string

Identificatore della sottoscrizione dell'account cosmos DB.

RoutingEndpoints

Le proprietà correlate agli endpoint personalizzati a cui l'hub IoT instrada i messaggi in base alle regole di routing. Un massimo di 10 endpoint personalizzati è consentito in tutti i tipi di endpoint per gli hub a pagamento e solo 1 endpoint personalizzato è consentito in tutti i tipi di endpoint per gli hub gratuiti.

Nome Tipo Descrizione
cosmosDBSqlContainers

RoutingCosmosDBSqlApiProperties[]

Elenco di endpoint del contenitore Cosmos DB a cui l'hub IoT instrada i messaggi, in base alle regole di routing.

eventHubs

RoutingEventHubProperties[]

Elenco di endpoint di Hub eventi a cui l'hub IoT instrada i messaggi, in base alle regole di routing. Questo elenco non include l'endpoint predefinito di Hub eventi.

serviceBusQueues

RoutingServiceBusQueueEndpointProperties[]

Elenco di endpoint della coda del bus di servizio a cui l'hub IoT indirizza i messaggi, in base alle regole di routing.

serviceBusTopics

RoutingServiceBusTopicEndpointProperties[]

Elenco di endpoint dell'argomento del bus di servizio a cui l'hub IoT indirizza i messaggi, in base alle regole di routing.

storageContainers

RoutingStorageContainerProperties[]

Elenco di endpoint del contenitore di archiviazione a cui l'hub IoT instrada i messaggi in base alle regole di routing.

RoutingEventHubProperties

Proprietà correlate a un endpoint dell'hub eventi.

Nome Tipo Descrizione
authenticationType

authenticationType

Metodo usato per l'autenticazione nell'endpoint dell'hub eventi

connectionString

string

Stringa di connessione dell'endpoint dell'hub eventi.

endpointUri

string

URL dell'endpoint dell'hub eventi. Deve includere il protocollo sb://

entityPath

string

Nome dell'hub eventi nello spazio dei nomi dell'hub eventi

id

string

ID dell'endpoint dell'hub eventi

identity

ManagedIdentity

Proprietà dell'identità gestita dell'endpoint dell'hub eventi di routing.

name

string

pattern: ^[A-Za-z0-9-._]{1,64}$

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.

resourceGroup

string

Nome del gruppo di risorse dell'endpoint dell'hub eventi.

subscriptionId

string

Identificatore della sottoscrizione dell'endpoint dell'hub eventi.

RoutingProperties

Proprietà correlate al routing dell'hub IoT. Vedere: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging

Nome Tipo Descrizione
endpoints

RoutingEndpoints

Le proprietà correlate agli endpoint personalizzati a cui l'hub IoT instrada i messaggi in base alle regole di routing. Un massimo di 10 endpoint personalizzati è consentito in tutti i tipi di endpoint per gli hub a pagamento e solo 1 endpoint personalizzato è consentito in tutti i tipi di endpoint per gli hub gratuiti.

enrichments

EnrichmentProperties[]

Elenco di arricchimenti forniti dall'utente che l'hub IoT applica ai messaggi da recapitare agli endpoint predefiniti e personalizzati. Vedere: https://aka.ms/telemetryoneventgrid

fallbackRoute

FallbackRouteProperties

Proprietà della route utilizzata come route di fallback quando non vengono soddisfatte le condizioni specificate nella sezione "route". Questo è un parametro opzionale. Quando questa proprietà non è presente nel modello, la route di fallback è disabilitata per impostazione predefinita.

routes

RouteProperties[]

Elenco di regole di routing fornite dall'utente usate dall'hub IoT per instradare i messaggi agli endpoint predefiniti e personalizzati. Per gli hub a pagamento sono consentiti un massimo di 100 regole di routing e sono consentite un massimo di 5 regole di routing per hub gratuiti.

RoutingServiceBusQueueEndpointProperties

Proprietà correlate ai tipi di endpoint della coda del bus di servizio.

Nome Tipo Descrizione
authenticationType

authenticationType

Metodo usato per eseguire l'autenticazione nell'endpoint della coda del bus di servizio

connectionString

string

Stringa di connessione dell'endpoint della coda del bus di servizio.

endpointUri

string

URL dell'endpoint della coda del bus di servizio. Deve includere il protocollo sb://

entityPath

string

Nome della coda nello spazio dei nomi del bus di servizio

id

string

ID dell'endpoint della coda del bus di servizio

identity

ManagedIdentity

Proprietà dell'identità gestita dell'endpoint della coda del bus di servizio di routing.

name

string

pattern: ^[A-Za-z0-9-._]{1,64}$

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.

resourceGroup

string

Nome del gruppo di risorse dell'endpoint della coda del bus di servizio.

subscriptionId

string

Identificatore della sottoscrizione dell'endpoint della coda del bus di servizio.

RoutingServiceBusTopicEndpointProperties

Proprietà correlate ai tipi di endpoint dell'argomento del bus di servizio.

Nome Tipo Descrizione
authenticationType

authenticationType

Metodo usato per eseguire l'autenticazione nell'endpoint dell'argomento del bus di servizio

connectionString

string

Stringa di connessione dell'endpoint dell'argomento del bus di servizio.

endpointUri

string

URL dell'endpoint dell'argomento del bus di servizio. Deve includere il protocollo sb://

entityPath

string

Nome della coda nell'argomento del bus di servizio

id

string

ID dell'endpoint dell'argomento del bus di servizio

identity

ManagedIdentity

Proprietà dell'identità gestita dell'endpoint dell'argomento del bus di servizio di routing.

name

string

pattern: ^[A-Za-z0-9-._]{1,64}$

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.

resourceGroup

string

Nome del gruppo di risorse dell'endpoint dell'argomento del bus di servizio.

subscriptionId

string

Identificatore della sottoscrizione dell'endpoint dell'argomento del bus di servizio.

RoutingSource

Origine a cui applicare la regola di routing, ad esempio DeviceMessages.

Valore Descrizione
DeviceConnectionStateEvents
DeviceJobLifecycleEvents
DeviceLifecycleEvents
DeviceMessages
Invalid
TwinChangeEvents

RoutingStorageContainerProperties

Proprietà correlate a un endpoint del contenitore di archiviazione.

Nome Tipo Descrizione
authenticationType

authenticationType

Metodo usato per l'autenticazione nell'endpoint di archiviazione

batchFrequencyInSeconds

integer (int32)

minimum: 60
maximum: 720

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.

connectionString

string

Stringa di connessione dell'account di archiviazione.

containerName

string

Nome del contenitore di archiviazione nell'account di archiviazione.

encoding enum:
  • Avro
  • AvroDeflate
  • JSON

Codifica utilizzata per serializzare i messaggi nei BLOB. I valori supportati sono 'avro', 'avrodeflate' e 'JSON'. Il valore predefinito è 'avro'.

endpointUri

string

URL dell'endpoint di archiviazione. Deve includere il protocollo https://

fileNameFormat

string

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.

id

string

ID dell'endpoint del contenitore di archiviazione

identity

ManagedIdentity

Proprietà dell'identità gestita dell'endpoint di archiviazione di routing.

maxChunkSizeInBytes

integer (int32)

minimum: 10485760
maximum: 524288000

Numero massimo di byte per ogni BLOB scritto nell'archivio. Il valore deve essere compreso tra 10485760(10MB) e 524288000(500 MB). Il valore predefinito è 314572800(300 MB).

name

string

pattern: ^[A-Za-z0-9-._]{1,64}$

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.

resourceGroup

string

Nome del gruppo di risorse dell'account di archiviazione.

subscriptionId

string

Identificatore della sottoscrizione dell'account di archiviazione.

SharedAccessSignatureAuthorizationRule

Proprietà di un criterio di accesso condiviso dell'hub IoT.

Nome Tipo Descrizione
keyName

string

Nome dei criteri di accesso condiviso.

primaryKey

string

Chiave primaria.

rights

AccessRights

Autorizzazioni assegnate ai criteri di accesso condiviso.

secondaryKey

string

Chiave secondaria.

StorageEndpointProperties

Proprietà dell'endpoint di Archiviazione di Azure per il caricamento di file.

Nome Tipo Descrizione
authenticationType

AuthenticationType

Specifica il tipo di autenticazione usato per la connessione all'account di archiviazione.

connectionString

string

Stringa di connessione per l'account di archiviazione di Azure in cui vengono caricati i file.

containerName

string

Nome del contenitore radice in cui si caricano i file. Il contenitore non deve esistere, ma deve essere creato usando connectionString specificato.

identity

ManagedIdentity

Proprietà dell'identità gestita dell'endpoint di archiviazione per il caricamento di file.

sasTtlAsIso8601

string (duration)

Periodo di tempo per il quale l'URI di firma di accesso condiviso generato dall'hub IoT per il caricamento di file è valido. Vedere: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload#file-upload-notification-configuration-options.

systemData

Metadati relativi alla creazione e all'ultima modifica della risorsa.

Nome Tipo Descrizione
createdAt

string (date-time)

Timestamp della creazione della risorsa (UTC).

createdBy

string

Identità che ha creato la risorsa.

createdByType

createdByType

Tipo di identità che ha creato la risorsa.

lastModifiedAt

string (date-time)

Timestamp dell'ultima modifica della risorsa (UTC)

lastModifiedBy

string

Identità che ha modificato l'ultima volta la risorsa.

lastModifiedByType

createdByType

Tipo di identità che ha modificato l'ultima volta la risorsa.