Microsoft.Devices IotHubs 2022-04-30-preview
Bicep-resourcedefinitie
Het resourcetype IotHubs kan worden geïmplementeerd met bewerkingen die zijn gericht op:
- Resourcegroepen - Zie opdrachten voor resourcegroepimplementatie
Zie wijzigingenlogboek voor een lijst met gewijzigde eigenschappen in elke API-versie.
Resource-indeling
Als u een Microsoft.Devices/IotHubs-resource wilt maken, voegt u de volgende Bicep toe aan uw sjabloon.
resource symbolicname 'Microsoft.Devices/IotHubs@2022-04-30-preview' = {
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'
deviceStreams: {
streamingEndpoints: [
'string'
]
}
disableDeviceSAS: bool
disableLocalAuth: bool
disableModuleSAS: bool
enableDataResidency: bool
enableFileUploadNotifications: bool
encryption: {
keySource: 'string'
keyVaultProperties: [
{
identity: {
userAssignedIdentity: 'string'
}
keyIdentifier: 'string'
}
]
}
eventHubEndpoints: {
{customized property}: {
partitionCount: int
retentionTimeInDays: int
}
}
features: 'string'
ipFilterRules: [
{
action: 'string'
filterName: 'string'
ipMask: 'string'
}
]
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
rootCertificate: {
enableRootCertificateV2: bool
}
routing: {
endpoints: {
cosmosDBSqlCollections: [
{
authenticationType: 'string'
collectionName: 'string'
databaseName: 'string'
endpointUri: 'string'
id: 'string'
identity: {
userAssignedIdentity: 'string'
}
name: 'string'
partitionKeyName: 'string'
partitionKeyTemplate: 'string'
primaryKey: 'string'
resourceGroup: 'string'
secondaryKey: 'string'
subscriptionId: 'string'
}
]
eventHubs: [
{
authenticationType: 'string'
connectionString: 'string'
endpointUri: 'string'
entityPath: 'string'
id: 'string'
identity: {
userAssignedIdentity: 'string'
}
name: 'string'
resourceGroup: 'string'
subscriptionId: 'string'
}
]
serviceBusQueues: [
{
authenticationType: 'string'
connectionString: 'string'
endpointUri: 'string'
entityPath: 'string'
id: 'string'
identity: {
userAssignedIdentity: 'string'
}
name: 'string'
resourceGroup: 'string'
subscriptionId: 'string'
}
]
serviceBusTopics: [
{
authenticationType: 'string'
connectionString: 'string'
endpointUri: 'string'
entityPath: 'string'
id: 'string'
identity: {
userAssignedIdentity: 'string'
}
name: 'string'
resourceGroup: 'string'
subscriptionId: 'string'
}
]
storageContainers: [
{
authenticationType: 'string'
batchFrequencyInSeconds: int
connectionString: 'string'
containerName: 'string'
encoding: 'string'
endpointUri: 'string'
fileNameFormat: 'string'
id: 'string'
identity: {
userAssignedIdentity: 'string'
}
maxChunkSizeInBytes: int
name: 'string'
resourceGroup: 'string'
subscriptionId: 'string'
}
]
}
enrichments: [
{
endpointNames: [
'string'
]
key: 'string'
value: 'string'
}
]
fallbackRoute: {
condition: 'string'
endpointNames: [
'string'
]
isEnabled: bool
name: 'string'
source: 'string'
}
routes: [
{
condition: 'string'
endpointNames: [
'string'
]
isEnabled: bool
name: 'string'
source: 'string'
}
]
}
storageEndpoints: {
{customized property}: {
authenticationType: 'string'
connectionString: 'string'
containerName: 'string'
identity: {
userAssignedIdentity: 'string'
}
sasTtlAsIso8601: 'string'
}
}
}
}
Eigenschapswaarden
IotHubs
Naam | Description | Waarde |
---|---|---|
naam | De resourcenaam | tekenreeks (vereist) Tekenlimiet: 3-50 Geldige tekens: Alfanumeriek en afbreekstreepjes. Kan niet eindigen met een afbreekstreepje. De resourcenaam moet uniek zijn in Azure. |
location | De resourcelocatie. | tekenreeks (vereist) |
tags | De resourcetags. | Woordenlijst met tagnamen en -waarden. Tags in sjablonen bekijken |
sku | IotHub SKU-informatie | IotHubSkuInfo (vereist) |
etag | Het veld Etag is niet vereist. Als deze is opgegeven in de hoofdtekst van het antwoord, moet deze ook worden opgegeven als een header volgens de normale ETag-conventie. | tekenreeks |
identity | De beheerde identiteiten voor de IotHub. | ArmIdentity |
properties | IotHub-eigenschappen | IotHubProperties |
ArmIdentity
Naam | Description | Waarde |
---|---|---|
type | Het type identiteit dat voor de resource wordt gebruikt. Het type 'SystemAssigned,UserAssigned' bevat zowel een impliciet gemaakte identiteit als een set door de gebruiker toegewezen identiteiten. Met het type 'Geen' worden alle identiteiten uit de service verwijderd. | 'Geen' 'SystemAssigned' 'SystemAssigned, UserAssigned' 'UserAssigned' |
userAssignedIdentities | Woordenlijst van {ArmUserIdentity} | ArmIdentityUserAssignedId-entiteiten |
ArmIdentityUserAssignedId-entiteiten
Naam | Description | Waarde |
---|---|---|
{aangepaste eigenschap} | ArmUserIdentity |
ArmUserIdentity
Dit object bevat geen eigenschappen die tijdens de implementatie moeten worden ingesteld. Alle eigenschappen zijn ReadOnly.
IotHubProperties
Naam | Description | Waarde |
---|---|---|
allowedFqdnList | Lijst met toegestane FQDN's (Fully Qualified Domain Name) voor uitgaand verkeer van IoT Hub. | tekenreeks[] |
authorizationPolicies | Het beleid voor gedeelde toegang dat u kunt gebruiken om een verbinding met de IoT-hub te beveiligen. | SharedAccessSignatureAuthorizationRule[] |
cloudToDevice | De eigenschappen van cloud-naar-apparaat-berichten van IoT Hub. | CloudToDeviceProperties |
opmerkingen | Opmerkingen bij IoT Hub. | tekenreeks |
deviceStreams | Het apparaat streamt eigenschappen van iothub. | IotHubPropertiesDeviceStreams |
disableDeviceSAS | Als dit waar is, kunnen alle SAS-sleutels met een bereik van het apparaat (inclusief Edge-apparaten, maar met uitzondering van modules) niet worden gebruikt voor verificatie. | booleaans |
disableLocalAuth | Als dit waar is, kunnen SAS-tokens met SAS-sleutels met ioT-hubbereik niet worden gebruikt voor verificatie. | booleaans |
disableModuleSAS | Als dit waar is, kunnen niet alle SAS-sleutels binnen het modulebereik worden gebruikt voor verificatie. | booleaans |
enableDataResidency | Als deze eigenschap is ingesteld op true, wordt gegevenslocatie ingeschakeld, waardoor herstel na noodgevallen wordt uitgeschakeld. | booleaans |
enableFileUploadNotifications | Indien waar, zijn meldingen voor het uploaden van bestanden ingeschakeld. | booleaans |
versleuteling | De versleutelingseigenschappen voor de IoT-hub. | EncryptionPropertiesDescription |
eventHubEndpoints | De event hub-compatibele eindpunteigenschappen. De enige mogelijke sleutels voor deze woordenlijst zijn gebeurtenissen. Deze sleutel moet aanwezig zijn in de woordenlijst tijdens het maken of bijwerken van aanroepen voor de IoT-hub. | IotHubPropertiesEventHubEndpoints |
features | De mogelijkheden en functies die zijn ingeschakeld voor de IoT-hub. | 'DeviceManagement' 'Geen' |
ipFilterRules | De IP-filterregels. | IpFilterRule[] |
messagingEndpoints | De eigenschappen van het berichteneindpunt voor de meldingswachtrij voor het uploaden van bestanden. | IotHubPropertiesMessagingEndpoints |
minTlsVersion | Hiermee geeft u de minimale TLS-versie die moet worden ondersteund voor deze hub. Kan worden ingesteld op '1.2' zodat clients die een TLS-versie lager dan 1.2 gebruiken, worden geweigerd. | tekenreeks |
networkRuleSets | Eigenschappen van netwerkregelset van IotHub | NetworkRuleSetProperties |
privateEndpointConnections | Privé-eindpuntverbindingen die zijn gemaakt op deze IotHub | PrivateEndpointConnection[] |
publicNetworkAccess | Of aanvragen van het openbare netwerk zijn toegestaan | 'Uitgeschakeld' Ingeschakeld |
restrictOutboundNetworkAccess | Indien waar, wordt uitgaand verkeer van IotHub beperkt tot alleen de toegestane FQDN's die zijn geconfigureerd via allowedFqdnList. | booleaans |
rootCertificate | Informatie over dit eigenschappenarchief met betrekking tot basiscertificaten | RootCertificateProperties |
Routering | De routeringsgerelateerde eigenschappen van de IoT-hub. Zie: /azure/iot-hub/iot-hub-devguide-messaging | RouteringEigenschappen |
storageEndpoints | De lijst met Azure Storage-eindpunten waar u bestanden kunt uploaden. Op dit moment kunt u slechts één Azure Storage-account configureren en dat moet de sleutel hebben als $default. Als u meer dan één opslagaccount opgeeft, wordt er een fout gegenereerd. Als u geen waarde voor deze eigenschap opgeeft wanneer de eigenschap enableFileUploadNotifications is ingesteld op True, wordt er een fout gegenereerd. | IotHubPropertiesStorageEndpoints |
SharedAccessSignatureAuthorizationRule
Naam | Description | Waarde |
---|---|---|
keyName | De naam van het beleid voor gedeelde toegang. | tekenreeks (vereist) |
primaryKey | De primaire sleutel. | tekenreeks |
Rechten | De machtigingen die zijn toegewezen aan het beleid voor gedeelde toegang. | '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' (vereist) |
secondaryKey | De secundaire sleutel. | tekenreeks |
keyName | De naam van het beleid voor gedeelde toegang. | tekenreeks (vereist) |
primaryKey | De primaire sleutel. | tekenreeks |
Rechten | De machtigingen die zijn toegewezen aan het beleid voor gedeelde toegang. | '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' (vereist) |
secondaryKey | De secundaire sleutel. | tekenreeks |
CloudToDeviceProperties
Naam | Description | Waarde |
---|---|---|
defaultTtlAsIso8601 | De standaardtijd voor cloud-naar-apparaat-berichten in de apparaatwachtrij. Zie: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | tekenreeks |
Feedback | De eigenschappen van de feedbackwachtrij voor cloud-naar-apparaat-berichten. | FeedbackEigenschappen |
maxDeliveryCount | Het maximale aantal bezorging voor cloud-naar-apparaat-berichten in de apparaatwachtrij. Zie: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | int Beperkingen: Minimumwaarde = 1 Maximale waarde = 100 |
FeedbackEigenschappen
Naam | Description | Waarde |
---|---|---|
lockDurationAsIso8601 | De vergrendelingsduur voor de feedbackwachtrij. Zie: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | tekenreeks |
maxDeliveryCount | Het aantal keren dat de IoT-hub een bericht probeert af te leveren in de feedbackwachtrij. Zie: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | int Beperkingen: Minimumwaarde = 1 Maximale waarde = 100 |
ttlAsIso8601 | De periode waarin een bericht kan worden gebruikt voordat het is verlopen door de IoT-hub. Zie: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | tekenreeks |
IotHubPropertiesDeviceStreams
Naam | Description | Waarde |
---|---|---|
streamingEndpoints | Lijst met eindpunten voor apparaatstreams. | tekenreeks[] |
EncryptionPropertiesDescription
Naam | Description | Waarde |
---|---|---|
keySource | De bron van de sleutel. | tekenreeks |
keyVaultEigenschappen | De eigenschappen van de KeyVault-sleutel. | KeyVaultKeyProperties[] |
KeyVaultKeyProperties
Naam | Description | Waarde |
---|---|---|
identity | Eigenschappen van beheerde identiteit van KeyVault-sleutel. | ManagedIdentity |
keyIdentifier | De id van de sleutel. | tekenreeks |
ManagedIdentity
Naam | Description | Waarde |
---|---|---|
userAssignedIdentity | De door de gebruiker toegewezen identiteit. | tekenreeks |
IotHubPropertiesEventHubEndpoints
Naam | Description | Waarde |
---|---|---|
{aangepaste eigenschap} | EventHubProperties |
EventHubProperties
Naam | Description | Waarde |
---|---|---|
partitionCount | Het aantal partities voor het ontvangen van apparaat-naar-cloud-berichten in het event hub-compatibele eindpunt. Zie: /azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages. | int |
retentionTimeInDays | De bewaartijd voor apparaat-naar-cloud-berichten in dagen. Zie: /azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages | int |
IpFilterRule
Naam | Description | Waarde |
---|---|---|
action | De gewenste actie voor aanvragen die door deze regel zijn vastgelegd. | 'Accepteren' 'Weigeren' (vereist) |
filterName | De naam van de IP-filterregel. | tekenreeks (vereist) |
ipMask | Een tekenreeks die het IP-adresbereik bevat in CIDR-notatie voor de regel. | tekenreeks (vereist) |
IotHubPropertiesMessagingEndpoints
Naam | Description | Waarde |
---|---|---|
{aangepaste eigenschap} | MessagingEndpointProperties |
MessagingEndpointProperties
Naam | Description | Waarde |
---|---|---|
lockDurationAsIso8601 | De duur van de vergrendeling. Zie: /azure/iot-hub/iot-hub-devguide-file-upload. | tekenreeks |
maxDeliveryCount | Het aantal keren dat de IoT-hub een bericht probeert af te leveren. Zie: /azure/iot-hub/iot-hub-devguide-file-upload. | int Beperkingen: Minimumwaarde = 1 Maximale waarde = 100 |
ttlAsIso8601 | De periode waarin een bericht kan worden gebruikt voordat het is verlopen door de IoT-hub. Zie: /azure/iot-hub/iot-hub-devguide-file-upload. | tekenreeks |
NetworkRuleSetProperties
Naam | Description | Waarde |
---|---|---|
applyToBuiltInEventHubEndpoint | Indien waar, wordt netwerkregelset ook toegepast op BuiltIn EventHub EndPoint van IotHub | bool (vereist) |
defaultAction | Standaardactie voor netwerkregelset | 'Toestaan' 'Weigeren' |
ipRules | Lijst met IP-regels | NetworkRuleSetIpRule[] (vereist) |
NetworkRuleSetIpRule
Naam | Description | Waarde |
---|---|---|
action | IP-filteractie | 'Toestaan' |
filterName | Naam van de IP-filterregel. | tekenreeks (vereist) |
ipMask | Een tekenreeks die het IP-adresbereik bevat in CIDR-notatie voor de regel. | tekenreeks (vereist) |
PrivateEndpointConnection
Naam | Description | Waarde |
---|---|---|
properties | De eigenschappen van een privé-eindpuntverbinding | PrivateEndpointConnectionProperties (vereist) |
PrivateEndpointConnectionProperties
Naam | Description | Waarde |
---|---|---|
privateEndpoint | De privé-eindpunteigenschap van een privé-eindpuntverbinding | PrivateEndpoint |
privateLinkServiceConnectionState | De huidige status van een privé-eindpuntverbinding | PrivateLinkServiceConnectionState (vereist) |
PrivateEndpoint
Dit object bevat geen eigenschappen die tijdens de implementatie moeten worden ingesteld. Alle eigenschappen zijn Alleen-lezen.
PrivateLinkServiceConnectionState
Naam | Description | Waarde |
---|---|---|
actionsRequired | Vereiste acties voor een privé-eindpuntverbinding | tekenreeks |
beschrijving | De beschrijving voor de huidige status van een privé-eindpuntverbinding | tekenreeks (vereist) |
status | De status van een privé-eindpuntverbinding | 'Goedgekeurd' 'Verbinding verbroken' 'In behandeling' 'Geweigerd' (vereist) |
RootCertificateProperties
Naam | Description | Waarde |
---|---|---|
enableRootCertificateV2 | Als deze eigenschap is ingesteld op true, gebruikt de hub het G2-certificaat; Hoewel deze is ingesteld op false, gebruikt de hub Baltimore Cert. | booleaans |
RouteringEigenschappen
Naam | Description | Waarde |
---|---|---|
Eindpunten | De eigenschappen met betrekking tot de aangepaste eindpunten waarnaar uw IoT-hub berichten routeert op basis van de routeringsregels. Er zijn maximaal 10 aangepaste eindpunten toegestaan voor alle eindpunttypen voor betaalde hubs en er is slechts 1 aangepast eindpunt toegestaan voor alle eindpunttypen voor gratis hubs. | RoutingEndpoints |
verrijkingen | De lijst met door de gebruiker geleverde verrijkingen die de IoT-hub toepast op berichten die moeten worden bezorgd bij ingebouwde en aangepaste eindpunten. Zie: https://aka.ms/telemetryoneventgrid |
VerrijkingEigenschappen[] |
fallbackRoute | De eigenschappen van de route die wordt gebruikt als een terugvalroute wanneer aan geen van de voorwaarden in de sectie 'routes' wordt voldaan. Dit is een optionele parameter. Wanneer deze eigenschap niet is ingesteld, worden de berichten die niet voldoen aan een van de voorwaarden die zijn opgegeven in de sectie Routes doorgestuurd naar het ingebouwde EventHub-eindpunt. | FallbackRouteProperties |
Routes | De lijst met door de gebruiker verstrekte routeringsregels die door de IoT-hub worden gebruikt om berichten te routeren naar ingebouwde en aangepaste eindpunten. Er zijn maximaal 100 regels voor doorsturen toegestaan voor betaalde hubs en maximaal 5 routeringsregels voor gratis hubs. | RouteProperties[] |
RoutingEndpoints
Naam | Description | Waarde |
---|---|---|
cosmosDBSqlCollections | De lijst met Cosmos DB-verzamelingseindpunten waarnaar IoT Hub berichten routeert op basis van de routeringsregels. | RoutingCosmosDBSqlApiProperties[] |
eventHubs | De lijst met Event Hubs-eindpunten waarnaar IoT Hub berichten routeert op basis van de routeringsregels. Deze lijst bevat niet het ingebouwde Event Hubs-eindpunt. | RoutingEventHubProperties[] |
serviceBusQueues | De lijst met Service Bus-wachtrijeindpunten waarnaar IoT Hub de berichten routeert, op basis van de routeringsregels. | RoutingServiceBusQueueEndpointProperties[] |
serviceBusTopics | De lijst met Service Bus-onderwerpeindpunten waarnaar de IoT-hub de berichten routeert op basis van de routeringsregels. | RoutingServiceBusTopicEndpointProperties[] |
storageContainers | De lijst met opslagcontainereindpunten waarnaar IoT Hub berichten routeert op basis van de routeringsregels. | RoutingStorageContainerProperties[] |
RoutingCosmosDBSqlApiProperties
Naam | Description | Waarde |
---|---|---|
authenticationType | Methode die wordt gebruikt voor verificatie op het eindpunt van de SQL-verzameling van Cosmos DB | 'identityBased' 'keyBased' |
collectionName | De naam van de cosmos DB SQL-verzameling in de cosmos DB-database. | tekenreeks (vereist) |
databaseName | De naam van de cosmos DB-database in het Cosmos DB-account. | tekenreeks (vereist) |
endpointUri | De URL van het Cosmos DB-account. Het moet het protocol bevatten https:// |
tekenreeks (vereist) |
id | Id van het sql-verzamelingseindpunt van Cosmos DB | tekenreeks |
identity | Eigenschappen van beheerde identiteit van routering cosmos DB-verzamelingseindpunt. | ManagedIdentity |
naam | De naam die dit eindpunt identificeert. De naam mag alleen alfanumerieke tekens, punten, onderstrepingstekens, afbreekstreepjes bevatten en heeft een maximale lengte van 64 tekens. De volgende namen zijn gereserveerd: gebeurtenissen, fileNotifications $default. Eindpuntnamen moeten uniek zijn voor verschillende eindpunttypen. | tekenreeks (vereist) Beperkingen: Patroon = ^[A-Za-z0-9-._]{1,64}$ |
partitionKeyName | De naam van de partitiesleutel die is gekoppeld aan deze Cosmos DB SQL-verzameling, indien aanwezig. Dit is een optionele parameter. | tekenreeks |
partitionKeyTemplate | De sjabloon voor het genereren van een synthetische partitiesleutelwaarde voor gebruik met deze cosmos DB SQL-verzameling. De sjabloon moet ten minste een van de volgende tijdelijke aanduidingen bevatten: {iothub}, {deviceid}, {DD}, {MM} en {JJJJ}. Een tijdelijke aanduiding kan maximaal één keer worden opgegeven, maar order- en niet-tijdelijke aanduidingen zijn willekeurig. Deze parameter is alleen vereist als PartitionKeyName is opgegeven. | tekenreeks |
primaryKey | De primaire sleutel van het cosmos DB-account. | tekenreeks Beperkingen: Gevoelige waarde. Doorgeven als een beveiligde parameter. |
resourceGroup | De naam van de resourcegroep van het Cosmos DB-account. | tekenreeks |
secondaryKey | De secundaire sleutel van het cosmos DB-account. | tekenreeks Beperkingen: Gevoelige waarde. Doorgeven als een beveiligde parameter. |
subscriptionId | De abonnements-id van het cosmos DB-account. | tekenreeks |
RoutingEventHubProperties
Naam | Description | Waarde |
---|---|---|
authenticationType | Methode die wordt gebruikt voor verificatie bij het Event Hub-eindpunt | 'identityBased' 'keyBased' |
connectionString | De verbindingsreeks van het Event Hub-eindpunt. | tekenreeks Beperkingen: Gevoelige waarde. Doorgeven als een beveiligde parameter. |
endpointUri | De URL van het Event Hub-eindpunt. Deze moet het protocol bevatten sb:// | tekenreeks |
entityPath | Event Hub-naam in de Event Hub-naamruimte | tekenreeks |
id | Id van het Event Hub-eindpunt | tekenreeks |
identity | Eigenschappen van beheerde identiteit van routering event hub-eindpunt. | ManagedIdentity |
naam | De naam die dit eindpunt identificeert. De naam mag alleen alfanumerieke tekens, punten, onderstrepingstekens, afbreekstreepjes bevatten en heeft een maximale lengte van 64 tekens. De volgende namen zijn gereserveerd: gebeurtenissen, fileNotifications $default. Eindpuntnamen moeten uniek zijn voor verschillende eindpunttypen. | tekenreeks (vereist) Beperkingen: Patroon = ^[A-Za-z0-9-._]{1,64}$ |
resourceGroup | De naam van de resourcegroep van het Event Hub-eindpunt. | tekenreeks |
subscriptionId | De abonnements-id van het Event Hub-eindpunt. | tekenreeks |
RoutingServiceBusQueueEndpointProperties
Naam | Description | Waarde |
---|---|---|
authenticationType | Methode die wordt gebruikt voor verificatie op het service bus-wachtrijeindpunt | 'identityBased' 'keyBased' |
connectionString | De verbindingsreeks van het service bus-wachtrijeindpunt. | tekenreeks Beperkingen: Gevoelige waarde. Doorgeven als een beveiligde parameter. |
endpointUri | De URL van het service bus-wachtrijeindpunt. Deze moet het protocol bevatten sb:// | tekenreeks |
entityPath | Wachtrijnaam in de Service Bus-naamruimte | tekenreeks |
id | Id van het service bus-wachtrijeindpunt | tekenreeks |
identity | Eigenschappen van beheerde identiteit van routeringsservicebuswachtrijeindpunt. | ManagedIdentity |
naam | De naam die dit eindpunt identificeert. De naam mag alleen alfanumerieke tekens, punten, onderstrepingstekens, afbreekstreepjes bevatten en heeft een maximale lengte van 64 tekens. De volgende namen zijn gereserveerd: gebeurtenissen, fileNotifications $default. Eindpuntnamen moeten uniek zijn voor verschillende eindpunttypen. De naam hoeft niet hetzelfde te zijn als de werkelijke wachtrijnaam. | tekenreeks (vereist) Beperkingen: Patroon = ^[A-Za-z0-9-._]{1,64}$ |
resourceGroup | De naam van de resourcegroep van het service bus-wachtrijeindpunt. | tekenreeks |
subscriptionId | De abonnements-id van het service bus-wachtrijeindpunt. | tekenreeks |
RoutingServiceBusTopicEndpointProperties
Naam | Description | Waarde |
---|---|---|
authenticationType | Methode die wordt gebruikt voor verificatie op het eindpunt van het Service Bus-onderwerp | 'identityBased' 'keyBased' |
connectionString | De verbindingsreeks van het service bus-onderwerpeindpunt. | tekenreeks Beperkingen: Gevoelige waarde. Doorgeven als een beveiligde parameter. |
endpointUri | De URL van het service bus-onderwerpeindpunt. Deze moet het protocol bevatten sb:// | tekenreeks |
entityPath | Wachtrijnaam in het Service Bus-onderwerp | tekenreeks |
id | Id van het service bus-onderwerpeindpunt | tekenreeks |
identity | Eigenschappen van beheerde identiteit van het eindpunt van het routeringsservicebusonderwerp. | ManagedIdentity |
naam | De naam die dit eindpunt identificeert. De naam mag alleen alfanumerieke tekens, punten, onderstrepingstekens, afbreekstreepjes bevatten en heeft een maximale lengte van 64 tekens. De volgende namen zijn gereserveerd: gebeurtenissen, fileNotifications $default. Eindpuntnamen moeten uniek zijn voor verschillende eindpunttypen. De naam hoeft niet hetzelfde te zijn als de werkelijke onderwerpnaam. | tekenreeks (vereist) Beperkingen: Patroon = ^[A-Za-z0-9-._]{1,64}$ |
resourceGroup | De naam van de resourcegroep van het service bus-onderwerpeindpunt. | tekenreeks |
subscriptionId | De abonnements-id van het service bus-onderwerpeindpunt. | tekenreeks |
RoutingStorageContainerProperties
Naam | Description | Waarde |
---|---|---|
authenticationType | Methode die wordt gebruikt voor verificatie bij het opslageindpunt | 'identityBased' 'keyBased' |
batchFrequencyInSeconds | Tijdsinterval waarin blobs naar de opslag worden geschreven. De waarde moet tussen 60 en 720 seconden zijn. De standaardwaarde is 300 seconden. | int Beperkingen: Minimumwaarde = 60 Maximale waarde = 720 |
connectionString | De verbindingsreeks van het opslagaccount. | tekenreeks Beperkingen: Gevoelige waarde. Doorgeven als een beveiligde parameter. |
containerName | De naam van de opslagcontainer in het opslagaccount. | tekenreeks (vereist) |
Codering | Codering die wordt gebruikt om berichten naar blobs te serialiseren. Ondersteunde waarden zijn 'avro', 'avrodeflate' en 'JSON'. De standaardwaarde is 'avro'. | 'Avro' 'AvroDeflate' JSON |
endpointUri | De URL van het opslageindpunt. Het moet het protocol bevatten https:// |
tekenreeks |
fileNameFormat | Bestandsindeling voor de blob. De standaardindeling is {iothub}/{partition}/{JJJJ}/{MM}/{DD}/{HH}/{mm}. Alle parameters zijn verplicht, maar kunnen opnieuw worden gerangschikt. | tekenreeks |
id | Id van het eindpunt van de opslagcontainer | tekenreeks |
identity | Eigenschappen van beheerde identiteit van routeringsopslageindpunt. | ManagedIdentity |
maxChunkSizeInBytes | Maximum aantal bytes voor elke blob die naar de opslag wordt geschreven. De waarde moet tussen 10485760(10 MB) en 524288000(500 MB) zijn. De standaardwaarde is 314572800(300 MB). | int Beperkingen: Minimumwaarde = 10485760 Maximumwaarde = 524288000 |
naam | De naam die dit eindpunt identificeert. De naam mag alleen alfanumerieke tekens, punten, onderstrepingstekens, afbreekstreepjes bevatten en heeft een maximale lengte van 64 tekens. De volgende namen zijn gereserveerd: gebeurtenissen, fileNotifications $default. Eindpuntnamen moeten uniek zijn voor verschillende eindpunttypen. | tekenreeks (vereist) Beperkingen: Patroon = ^[A-Za-z0-9-._]{1,64}$ |
resourceGroup | De naam van de resourcegroep van het opslagaccount. | tekenreeks |
subscriptionId | De abonnements-id van het opslagaccount. | tekenreeks |
VerrijkingEigenschappen
Naam | Description | Waarde |
---|---|---|
endpointNames | De lijst met eindpunten waarvoor de verrijking wordt toegepast op het bericht. | tekenreeks[] (vereist) Beperkingen: Minimale lengte = 1 |
sleutel | De sleutel of naam voor de verrijkingseigenschap. | tekenreeks (vereist) |
waarde | De waarde voor de verrijkingseigenschap. | tekenreeks (vereist) |
FallbackRouteProperties
Naam | Description | Waarde |
---|---|---|
Voorwaarde | De voorwaarde die wordt geëvalueerd om de terugvalroute toe te passen. Als de voorwaarde niet is opgegeven, wordt standaard als true geëvalueerd. Zie voor grammatica: /azure/iot-hub/iot-hub-devguide-query-language | tekenreeks |
endpointNames | De lijst met eindpunten waarnaar de berichten die aan de voorwaarde voldoen, worden doorgestuurd. Momenteel is slechts één eindpunt toegestaan. | tekenreeks[] (vereist) Beperkingen: Minimale lengte = 1 Maximale lengte = 1 |
isEnabled | Wordt gebruikt om op te geven of de terugvalroute is ingeschakeld. | bool (vereist) |
naam | De naam van de route. De naam mag alleen alfanumerieke tekens, punten, onderstrepingstekens, afbreekstreepjes bevatten, heeft een maximale lengte van 64 tekens en moet uniek zijn. | tekenreeks |
source | De bron waarop de routeringsregel moet worden toegepast. Bijvoorbeeld DeviceMessages | 'DeviceConnectionStateEvents' 'DeviceJobLifecycleEvents' 'DeviceLifecycleEvents' 'DeviceMessages' 'DigitalTwinChangeEvents' Ongeldig 'MqttBrokerMessages' 'TwinChangeEvents' (vereist) |
RouteEigenschappen
Naam | Description | Waarde |
---|---|---|
Voorwaarde | De voorwaarde die wordt geëvalueerd om de regel voor doorsturen toe te passen. Als er geen voorwaarde is opgegeven, wordt standaard waar geëvalueerd. Zie voor grammatica: /azure/iot-hub/iot-hub-devguide-query-language | tekenreeks |
endpointNames | De lijst met eindpunten waarnaar berichten worden doorgestuurd die voldoen aan de voorwaarde. Momenteel is slechts één eindpunt toegestaan. | tekenreeks[] (vereist) Beperkingen: Minimale lengte = 1 Maximale lengte = 1 |
isEnabled | Wordt gebruikt om op te geven of een route is ingeschakeld. | bool (vereist) |
naam | De naam van de route. De naam mag alleen alfanumerieke tekens, punten, onderstrepingstekens, afbreekstreepjes bevatten, heeft een maximale lengte van 64 tekens en moet uniek zijn. | tekenreeks (vereist) Beperkingen: Patroon = ^[A-Za-z0-9-._]{1,64}$ |
source | De bron waarop de routeringsregel moet worden toegepast, zoals DeviceMessages. | 'DeviceConnectionStateEvents' 'DeviceJobLifecycleEvents' 'DeviceLifecycleEvents' 'DeviceMessages' 'DigitalTwinChangeEvents' Ongeldig 'MqttBrokerMessages' 'TwinChangeEvents' (vereist) |
IotHubPropertiesStorageEndpoints
Naam | Description | Waarde |
---|---|---|
{aangepaste eigenschap} | StorageEndpointProperties |
StorageEndpointProperties
Naam | Description | Waarde |
---|---|---|
authenticationType | Hiermee geeft u het verificatietype op dat wordt gebruikt om verbinding te maken met het opslagaccount. | 'identityBased' 'keyBased' |
connectionString | De verbindingsreeks voor het Azure Storage-account waarnaar bestanden worden geüpload. | tekenreeks (vereist) |
containerName | De naam van de hoofdcontainer waarin u bestanden uploadt. De container hoeft niet te bestaan, maar moet wel kunnen worden gemaakt met behulp van de opgegeven connectionString. | tekenreeks (vereist) |
identity | Eigenschappen van beheerde identiteit van opslageindpunt voor het uploaden van bestanden. | ManagedIdentity |
sasTtlAsIso8601 | De periode waarin de SAS-URI die is gegenereerd door IoT Hub voor het uploaden van bestanden geldig is. Zie: /azure/iot-hub/iot-hub-devguide-file-upload#file-upload-notification-configuration-options. | tekenreeks |
IotHubSkuInfo
Naam | Description | Waarde |
---|---|---|
capacity | Het aantal ingerichte IoT Hub eenheden. Zie: /azure/azure-subscription-service-limits#iot-hub-limits. | int |
naam | De naam van de SKU. | "B1" "B2" "B3" 'F1' 'S1' 'S2' 'S3' (vereist) |
Snelstartsjablonen
Met de volgende quickstart-sjablonen wordt dit resourcetype geïmplementeerd.
Template | Beschrijving |
---|---|
Een IOT Hub- en Ubuntu Edge-simulator maken |
Met deze sjabloon maakt u een IOT-hub en virtuele machine Ubuntu Edge-simulator. |
ARM-sjabloon gebruiken om IoT Hub te maken, berichten te routeren en weer te geven |
Gebruik deze sjabloon om een IoT Hub en een opslagaccount te implementeren. Voer een app uit om berichten naar de hub te verzenden die naar de opslag worden gerouteerd en bekijk vervolgens de resultaten. |
Een IoT Hub Device Provisioning Service maken |
Met deze sjabloon kunt u een IoT-hub en een IoT Hub Device Provisioning Service maken en de twee services aan elkaar koppelen. |
Een IoT Hub en een consumentengroep voor apparaat naar cloud maken |
Met deze sjabloon kunt u een IoT Hub-exemplaar implementeren met apparaat-naar-cloud- en cloud-naar-apparaat-berichtconfiguraties en een consumentengroep van apparaat naar cloud. |
Device Update maken voor IoT Hub-account, exemplaar IoT Hub |
Met deze sjabloon maakt u een account en een exemplaar en een hub om het exemplaar aan te koppelen. De hub wordt geconfigureerd met het benodigde toegangsbeleid, de routes en de consumentengroep. |
De MedTech-service implementeren, inclusief een Azure IoT Hub |
De MedTech-service is een van de Azure Health Data Services die is ontworpen om apparaatgegevens van meerdere apparaten op te nemen en de apparaatgegevens te transformeren in FHIR-waarnemingen, die vervolgens worden bewaard in de Azure Health Data Services FHIR-service. |
Een PAYG-omgeving (Pay As You Go) maken met een IoT Hub |
Met deze sjabloon kunt u een Pay As You Go(PAYG) Time Series Insights-omgeving implementeren die is geconfigureerd voor het verbruik van gebeurtenissen van een IoT Hub. |
Resourcedefinitie van ARM-sjabloon
Het resourcetype IotHubs kan worden geïmplementeerd met bewerkingen die zijn gericht op:
- Resourcegroepen - Zie opdrachten voor resourcegroepimplementatie
Zie wijzigingenlogboek voor een lijst met gewijzigde eigenschappen in elke API-versie.
Resource-indeling
Als u een Microsoft.Devices/IotHubs-resource wilt maken, voegt u de volgende JSON toe aan uw sjabloon.
{
"type": "Microsoft.Devices/IotHubs",
"apiVersion": "2022-04-30-preview",
"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",
"deviceStreams": {
"streamingEndpoints": [ "string" ]
},
"disableDeviceSAS": "bool",
"disableLocalAuth": "bool",
"disableModuleSAS": "bool",
"enableDataResidency": "bool",
"enableFileUploadNotifications": "bool",
"encryption": {
"keySource": "string",
"keyVaultProperties": [
{
"identity": {
"userAssignedIdentity": "string"
},
"keyIdentifier": "string"
}
]
},
"eventHubEndpoints": {
"{customized property}": {
"partitionCount": "int",
"retentionTimeInDays": "int"
}
},
"features": "string",
"ipFilterRules": [
{
"action": "string",
"filterName": "string",
"ipMask": "string"
}
],
"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",
"rootCertificate": {
"enableRootCertificateV2": "bool"
},
"routing": {
"endpoints": {
"cosmosDBSqlCollections": [
{
"authenticationType": "string",
"collectionName": "string",
"databaseName": "string",
"endpointUri": "string",
"id": "string",
"identity": {
"userAssignedIdentity": "string"
},
"name": "string",
"partitionKeyName": "string",
"partitionKeyTemplate": "string",
"primaryKey": "string",
"resourceGroup": "string",
"secondaryKey": "string",
"subscriptionId": "string"
}
],
"eventHubs": [
{
"authenticationType": "string",
"connectionString": "string",
"endpointUri": "string",
"entityPath": "string",
"id": "string",
"identity": {
"userAssignedIdentity": "string"
},
"name": "string",
"resourceGroup": "string",
"subscriptionId": "string"
}
],
"serviceBusQueues": [
{
"authenticationType": "string",
"connectionString": "string",
"endpointUri": "string",
"entityPath": "string",
"id": "string",
"identity": {
"userAssignedIdentity": "string"
},
"name": "string",
"resourceGroup": "string",
"subscriptionId": "string"
}
],
"serviceBusTopics": [
{
"authenticationType": "string",
"connectionString": "string",
"endpointUri": "string",
"entityPath": "string",
"id": "string",
"identity": {
"userAssignedIdentity": "string"
},
"name": "string",
"resourceGroup": "string",
"subscriptionId": "string"
}
],
"storageContainers": [
{
"authenticationType": "string",
"batchFrequencyInSeconds": "int",
"connectionString": "string",
"containerName": "string",
"encoding": "string",
"endpointUri": "string",
"fileNameFormat": "string",
"id": "string",
"identity": {
"userAssignedIdentity": "string"
},
"maxChunkSizeInBytes": "int",
"name": "string",
"resourceGroup": "string",
"subscriptionId": "string"
}
]
},
"enrichments": [
{
"endpointNames": [ "string" ],
"key": "string",
"value": "string"
}
],
"fallbackRoute": {
"condition": "string",
"endpointNames": [ "string" ],
"isEnabled": "bool",
"name": "string",
"source": "string"
},
"routes": [
{
"condition": "string",
"endpointNames": [ "string" ],
"isEnabled": "bool",
"name": "string",
"source": "string"
}
]
},
"storageEndpoints": {
"{customized property}": {
"authenticationType": "string",
"connectionString": "string",
"containerName": "string",
"identity": {
"userAssignedIdentity": "string"
},
"sasTtlAsIso8601": "string"
}
}
}
}
Eigenschapswaarden
IotHubs
Naam | Description | Waarde |
---|---|---|
type | Het resourcetype | 'Microsoft.Devices/IotHubs' |
apiVersion | De resource-API-versie | '30-04-2022-preview' |
naam | De resourcenaam | tekenreeks (vereist) Tekenlimiet: 3-50 Geldige tekens: Alfanumeriek en afbreekstreepjes. Kan niet eindigen met een afbreekstreepje. De resourcenaam moet uniek zijn in Azure. |
location | De resourcelocatie. | tekenreeks (vereist) |
tags | De resourcetags. | Woordenlijst met tagnamen en -waarden. Tags in sjablonen bekijken |
sku | IotHub SKU-informatie | IotHubSkuInfo (vereist) |
etag | Het veld Etag is niet vereist. Als deze is opgegeven in de hoofdtekst van het antwoord, moet deze ook worden opgegeven als een header volgens de normale ETag-conventie. | tekenreeks |
identity | De beheerde identiteiten voor de IotHub. | ArmIdentity |
properties | IotHub-eigenschappen | IotHubProperties |
ArmIdentity
Naam | Description | Waarde |
---|---|---|
type | Het type identiteit dat voor de resource wordt gebruikt. Het type 'SystemAssigned,UserAssigned' bevat zowel een impliciet gemaakte identiteit als een set door de gebruiker toegewezen identiteiten. Met het type 'Geen' worden alle identiteiten uit de service verwijderd. | 'Geen' 'SystemAssigned' 'SystemAssigned, UserAssigned' 'UserAssigned' |
userAssignedIdentities | Woordenlijst van {ArmUserIdentity} | ArmIdentityUserAssignedId-entiteiten |
ArmIdentityUserAssignedId-entiteiten
Naam | Description | Waarde |
---|---|---|
{aangepaste eigenschap} | ArmUserIdentity |
ArmUserIdentity
Dit object bevat geen eigenschappen die tijdens de implementatie moeten worden ingesteld. Alle eigenschappen zijn Alleen-lezen.
IotHubProperties
Naam | Description | Waarde |
---|---|---|
allowedFqdnList | Lijst met toegestane FQDN's (Fully Qualified Domain Name) voor uitgaand verkeer van IoT Hub. | tekenreeks[] |
authorizationPolicies | Het beleid voor gedeelde toegang dat u kunt gebruiken om een verbinding met de IoT-hub te beveiligen. | SharedAccessSignatureAuthorizationRule[] |
cloudToDevice | De cloud-naar-apparaat-berichteneigenschappen van de IoT-hub. | CloudToDeviceProperties |
opmerkingen | IoT Hub-opmerkingen. | tekenreeks |
deviceStreams | Het apparaat streamt eigenschappen van iothub. | IotHubPropertiesDeviceStreams |
disableDeviceSAS | Als dit waar is, kunnen alle sas-sleutels met een bereik van het apparaat (inclusief Edge-apparaten, maar met uitzondering van modules) niet worden gebruikt voor verificatie. | booleaans |
disableLocalAuth | Als dit waar is, kunnen SAS-tokens met SAS-sleutels met ioT-hubbereik niet worden gebruikt voor verificatie. | booleaans |
disableModuleSAS | Als dit waar is, kunnen niet alle SAS-sleutels binnen het modulebereik worden gebruikt voor verificatie. | booleaans |
enableDataResidency | Als deze eigenschap is ingesteld op true, wordt gegevenslocatie ingeschakeld, waardoor herstel na noodgevallen wordt uitgeschakeld. | booleaans |
enableFileUploadNotifications | Indien waar, zijn meldingen voor het uploaden van bestanden ingeschakeld. | booleaans |
versleuteling | De versleutelingseigenschappen voor de IoT-hub. | EncryptionPropertiesDescription |
eventHubEndpoints | De event hub-compatibele eindpunteigenschappen. De enige mogelijke sleutels voor deze woordenlijst zijn gebeurtenissen. Deze sleutel moet aanwezig zijn in de woordenlijst tijdens het maken of bijwerken van aanroepen voor de IoT-hub. | IotHubPropertiesEventHubEndpoints |
features | De mogelijkheden en functies die zijn ingeschakeld voor de IoT-hub. | 'DeviceManagement' 'Geen' |
ipFilterRules | De IP-filterregels. | IpFilterRule[] |
messagingEndpoints | De eigenschappen van het berichteneindpunt voor de meldingswachtrij voor het uploaden van bestanden. | IotHubPropertiesMessagingEndpoints |
minTlsVersion | Hiermee geeft u de minimale TLS-versie die moet worden ondersteund voor deze hub. Kan worden ingesteld op '1.2' zodat clients die een TLS-versie lager dan 1.2 gebruiken, worden geweigerd. | tekenreeks |
networkRuleSets | Eigenschappen van netwerkregelset van IotHub | NetworkRuleSetProperties |
privateEndpointConnections | Privé-eindpuntverbindingen die zijn gemaakt op deze IotHub | PrivateEndpointConnection[] |
publicNetworkAccess | Of aanvragen van het openbare netwerk zijn toegestaan | 'Uitgeschakeld' Ingeschakeld |
restrictOutboundNetworkAccess | Indien waar, wordt uitgaand verkeer van IotHub beperkt tot alleen de toegestane FQDN's die zijn geconfigureerd via allowedFqdnList. | booleaans |
rootCertificate | Informatie over dit eigenschappenarchief met betrekking tot basiscertificaten | RootCertificateProperties |
Routering | De routeringsgerelateerde eigenschappen van de IoT-hub. Zie: /azure/iot-hub/iot-hub-devguide-messaging | RouteringEigenschappen |
storageEndpoints | De lijst met Azure Storage-eindpunten waar u bestanden kunt uploaden. Op dit moment kunt u slechts één Azure Storage-account configureren en dat moet de sleutel hebben als $default. Als u meer dan één opslagaccount opgeeft, wordt er een fout gegenereerd. Als u geen waarde voor deze eigenschap opgeeft wanneer de eigenschap enableFileUploadNotifications is ingesteld op True, wordt er een fout gegenereerd. | IotHubPropertiesStorageEndpoints |
SharedAccessSignatureAuthorizationRule
Naam | Description | Waarde |
---|---|---|
keyName | De naam van het beleid voor gedeelde toegang. | tekenreeks (vereist) |
primaryKey | De primaire sleutel. | tekenreeks |
Rechten | De machtigingen die zijn toegewezen aan het beleid voor gedeelde toegang. | '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' (vereist) |
secondaryKey | De secundaire sleutel. | tekenreeks |
keyName | De naam van het beleid voor gedeelde toegang. | tekenreeks (vereist) |
primaryKey | De primaire sleutel. | tekenreeks |
Rechten | De machtigingen die zijn toegewezen aan het beleid voor gedeelde toegang. | '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' (vereist) |
secondaryKey | De secundaire sleutel. | tekenreeks |
CloudToDeviceProperties
Naam | Description | Waarde |
---|---|---|
defaultTtlAsIso8601 | De standaardtijd voor cloud-naar-apparaat-berichten in de apparaatwachtrij. Zie: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | tekenreeks |
Feedback | De eigenschappen van de feedbackwachtrij voor cloud-naar-apparaat-berichten. | FeedbackEigenschappen |
maxDeliveryCount | Het maximale aantal bezorging voor cloud-naar-apparaat-berichten in de apparaatwachtrij. Zie: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | int Beperkingen: Minimumwaarde = 1 Maximale waarde = 100 |
FeedbackEigenschappen
Naam | Description | Waarde |
---|---|---|
lockDurationAsIso8601 | De vergrendelingsduur voor de feedbackwachtrij. Zie: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | tekenreeks |
maxDeliveryCount | Het aantal keren dat de IoT-hub een bericht probeert af te leveren in de feedbackwachtrij. Zie: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | int Beperkingen: Minimumwaarde = 1 Maximumwaarde = 100 |
ttlAsIso8601 | De periode waarin een bericht beschikbaar is om te gebruiken voordat het is verlopen door de IoT-hub. Zie: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | tekenreeks |
IotHubPropertiesDeviceStreams
Naam | Description | Waarde |
---|---|---|
streamingEndpoints | Lijst met eindpunten voor apparaatstreams. | tekenreeks[] |
EncryptionPropertiesDescription
Naam | Description | Waarde |
---|---|---|
keySource | De bron van de sleutel. | tekenreeks |
keyVaultProperties | De eigenschappen van de KeyVault-sleutel. | KeyVaultKeyProperties[] |
KeyVaultKeyProperties
Naam | Description | Waarde |
---|---|---|
identity | Eigenschappen van beheerde identiteit van KeyVault-sleutel. | ManagedIdentity |
keyIdentifier | De id van de sleutel. | tekenreeks |
ManagedIdentity
Naam | Description | Waarde |
---|---|---|
userAssignedIdentity | De door de gebruiker toegewezen identiteit. | tekenreeks |
IotHubPropertiesEventHubEndpoints
Naam | Description | Waarde |
---|---|---|
{aangepaste eigenschap} | EventHubProperties |
EventHubProperties
Naam | Description | Waarde |
---|---|---|
partitionCount | Het aantal partities voor het ontvangen van apparaat-naar-cloud-berichten in het event hub-compatibele eindpunt. Zie: /azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages. | int |
retentionTimeInDays | De bewaartijd voor apparaat-naar-cloud-berichten in dagen. Zie: /azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages | int |
IpFilterRule
Naam | Description | Waarde |
---|---|---|
action | De gewenste actie voor aanvragen die met deze regel zijn vastgelegd. | 'Accepteren' 'Weigeren' (vereist) |
filterName | De naam van de IP-filterregel. | tekenreeks (vereist) |
ipMask | Een tekenreeks die het IP-adresbereik in CIDR-notatie voor de regel bevat. | tekenreeks (vereist) |
IotHubPropertiesMessagingEndpoints
Naam | Description | Waarde |
---|---|---|
{aangepaste eigenschap} | MessagingEndpointProperties |
MessagingEndpointProperties
Naam | Description | Waarde |
---|---|---|
lockDurationAsIso8601 | De vergrendelingsduur. Zie: /azure/iot-hub/iot-hub-devguide-file-upload. | tekenreeks |
maxDeliveryCount | Het aantal keren dat de IoT-hub een bericht probeert af te leveren. Zie: /azure/iot-hub/iot-hub-devguide-file-upload. | int Beperkingen: Minimumwaarde = 1 Maximumwaarde = 100 |
ttlAsIso8601 | De periode waarin een bericht beschikbaar is om te gebruiken voordat het is verlopen door de IoT-hub. Zie: /azure/iot-hub/iot-hub-devguide-file-upload. | tekenreeks |
NetworkRuleSetProperties
Naam | Description | Waarde |
---|---|---|
applyToBuiltInEventHubEndpoint | Indien waar, wordt netwerkregelset ook toegepast op BuiltIn EventHub EndPoint van IotHub | bool (vereist) |
defaultAction | Standaardactie voor netwerkregelset | 'Toestaan' 'Weigeren' |
ipRules | Lijst met IP-regels | NetworkRuleSetIpRule[] (vereist) |
NetworkRuleSetIpRule
Naam | Description | Waarde |
---|---|---|
action | IP-filteractie | 'Toestaan' |
filterName | Naam van de IP-filterregel. | tekenreeks (vereist) |
ipMask | Een tekenreeks die het IP-adresbereik bevat in CIDR-notatie voor de regel. | tekenreeks (vereist) |
PrivateEndpointConnection
Naam | Description | Waarde |
---|---|---|
properties | De eigenschappen van een privé-eindpuntverbinding | PrivateEndpointConnectionProperties (vereist) |
PrivateEndpointConnectionProperties
Naam | Description | Waarde |
---|---|---|
privateEndpoint | De privé-eindpunteigenschap van een privé-eindpuntverbinding | PrivateEndpoint |
privateLinkServiceConnectionState | De huidige status van een privé-eindpuntverbinding | PrivateLinkServiceConnectionState (vereist) |
PrivateEndpoint
Dit object bevat geen eigenschappen die tijdens de implementatie moeten worden ingesteld. Alle eigenschappen zijn Alleen-lezen.
PrivateLinkServiceConnectionState
Naam | Description | Waarde |
---|---|---|
actionsRequired | Vereiste acties voor een privé-eindpuntverbinding | tekenreeks |
beschrijving | De beschrijving voor de huidige status van een privé-eindpuntverbinding | tekenreeks (vereist) |
status | De status van een privé-eindpuntverbinding | 'Goedgekeurd' 'Verbinding verbroken' 'In behandeling' 'Geweigerd' (vereist) |
RootCertificateProperties
Naam | Description | Waarde |
---|---|---|
enableRootCertificateV2 | Als deze eigenschap is ingesteld op true, gebruikt hub G2-certificaat; terwijl deze is ingesteld op false, maakt hub gebruik van Baltimore Cert. | booleaans |
RouteringEigenschappen
Naam | Description | Waarde |
---|---|---|
Eindpunten | De eigenschappen met betrekking tot de aangepaste eindpunten waarnaar uw IoT-hub berichten routeert op basis van de routeringsregels. Er zijn maximaal 10 aangepaste eindpunten toegestaan voor alle eindpunttypen voor betaalde hubs en slechts 1 aangepast eindpunt is toegestaan voor alle eindpunttypen voor gratis hubs. | RoutingEndpoints |
verrijkingen | De lijst met door de gebruiker verstrekte verrijkingen die door de IoT-hub worden toegepast op berichten die moeten worden afgeleverd bij ingebouwde en aangepaste eindpunten. Zie: https://aka.ms/telemetryoneventgrid |
VerrijkingEigenschappen[] |
fallbackRoute | De eigenschappen van de route die wordt gebruikt als een terugvalroute wanneer aan geen van de voorwaarden in de sectie 'routes' wordt voldaan. Dit is een optionele parameter. Wanneer deze eigenschap niet is ingesteld, worden de berichten die niet voldoen aan een van de voorwaarden die zijn opgegeven in de sectie routes doorgestuurd naar het ingebouwde eventhub-eindpunt. | FallbackRouteProperties |
Routes | De lijst met door de gebruiker verstrekte routeringsregels die door de IoT-hub worden gebruikt om berichten te routeren naar ingebouwde en aangepaste eindpunten. Er zijn maximaal 100 routeringsregels toegestaan voor betaalde hubs en er zijn maximaal 5 routeringsregels toegestaan voor gratis hubs. | RouteEigenschappen[] |
RoutingEndpoints
Naam | Description | Waarde |
---|---|---|
cosmosDBSqlCollections | De lijst met Cosmos DB-verzamelingseindpunten waarnaar IoT Hub berichten routeert op basis van de routeringsregels. | RoutingCosmosDBSqlApiProperties[] |
eventHubs | De lijst met Event Hubs-eindpunten waarnaar IoT Hub berichten doorstuurt, op basis van de routeringsregels. Deze lijst bevat niet het ingebouwde Event Hubs-eindpunt. | RoutingEventHubProperties[] |
serviceBusQueues | De lijst met Service Bus-wachtrijeindpunten waarnaar IoT Hub de berichten routeert op basis van de routeringsregels. | RoutingServiceBusQueueEndpointProperties[] |
serviceBusTopics | De lijst met Service Bus-onderwerpeindpunten waarnaar de IoT-hub de berichten routeert op basis van de routeringsregels. | RoutingServiceBusTopicEndpointProperties[] |
storageContainers | De lijst met opslagcontainereindpunten waarnaar IoT Hub berichten routeert op basis van de routeringsregels. | RoutingStorageContainerProperties[] |
RoutingCosmosDBSqlApiProperties
Naam | Description | Waarde |
---|---|---|
authenticationType | Methode die wordt gebruikt om te verifiëren bij het eindpunt van de sql-verzameling van Cosmos DB | 'identityBased' 'keyBased' |
collectionName | De naam van de sql-verzameling cosmos DB in de cosmos DB-database. | tekenreeks (vereist) |
databaseName | De naam van de cosmos DB-database in het cosmos DB-account. | tekenreeks (vereist) |
endpointUri | De URL van het cosmos DB-account. Het moet het protocol bevatten https:// |
tekenreeks (vereist) |
id | Id van het eindpunt van de sql-verzameling van Cosmos DB | tekenreeks |
identity | Eigenschappen van beheerde identiteit van routering cosmos DB-verzamelingseindpunt. | ManagedIdentity |
naam | De naam die dit eindpunt identificeert. De naam mag alleen alfanumerieke tekens, punten, onderstrepingstekens, afbreekstreepjes bevatten en heeft een maximale lengte van 64 tekens. De volgende namen zijn gereserveerd: events, fileNotifications, $default. Eindpuntnamen moeten uniek zijn voor verschillende eindpunttypen. | tekenreeks (vereist) Beperkingen: Patroon = ^[A-Za-z0-9-._]{1,64}$ |
partitionKeyName | De naam van de partitiesleutel die is gekoppeld aan deze cosmos DB SQL-verzameling, indien aanwezig. Dit is een optionele parameter. | tekenreeks |
partitionKeyTemplate | De sjabloon voor het genereren van een synthetische partitiesleutelwaarde voor gebruik met deze cosmos DB SQL-verzameling. De sjabloon moet ten minste een van de volgende tijdelijke aanduidingen bevatten: {iothub}, {deviceid}, {DD}, {MM} en {JJJJ}. Een tijdelijke aanduiding kan maximaal één keer worden opgegeven, maar volgorde en niet-tijdelijke aanduidingen zijn willekeurig. Deze parameter is alleen vereist als PartitionKeyName is opgegeven. | tekenreeks |
primaryKey | De primaire sleutel van het cosmos DB-account. | tekenreeks Beperkingen: Gevoelige waarde. Doorgeven als een beveiligde parameter. |
resourceGroup | De naam van de resourcegroep van het cosmos DB-account. | tekenreeks |
secondaryKey | De secundaire sleutel van het cosmos DB-account. | tekenreeks Beperkingen: Gevoelige waarde. Doorgeven als een beveiligde parameter. |
subscriptionId | De abonnements-id van het cosmos DB-account. | tekenreeks |
RoutingEventHubProperties
Naam | Description | Waarde |
---|---|---|
authenticationType | Methode die wordt gebruikt voor verificatie bij het Event Hub-eindpunt | 'identityBased' 'keyBased' |
connectionString | De verbindingsreeks van het Event Hub-eindpunt. | tekenreeks Beperkingen: Gevoelige waarde. Doorgeven als een beveiligde parameter. |
endpointUri | De URL van het Event Hub-eindpunt. Deze moet het protocol bevatten sb:// | tekenreeks |
entityPath | Event Hub-naam in de Event Hub-naamruimte | tekenreeks |
id | Id van het Event Hub-eindpunt | tekenreeks |
identity | Beheerde identiteitseigenschappen van routering event hub-eindpunt. | ManagedIdentity |
naam | De naam die dit eindpunt identificeert. De naam mag alleen alfanumerieke tekens, punten, onderstrepingstekens, afbreekstreepjes bevatten en heeft een maximale lengte van 64 tekens. De volgende namen zijn gereserveerd: events, fileNotifications, $default. Eindpuntnamen moeten uniek zijn voor verschillende eindpunttypen. | tekenreeks (vereist) Beperkingen: Patroon = ^[A-Za-z0-9-._]{1,64}$ |
resourceGroup | De naam van de resourcegroep van het Event Hub-eindpunt. | tekenreeks |
subscriptionId | De abonnements-id van het Event Hub-eindpunt. | tekenreeks |
RoutingServiceBusQueueEndpointProperties
Naam | Description | Waarde |
---|---|---|
authenticationType | Methode die wordt gebruikt voor verificatie op het service bus-wachtrijeindpunt | 'identityBased' 'keyBased' |
connectionString | De verbindingsreeks van het service bus-wachtrijeindpunt. | tekenreeks Beperkingen: Gevoelige waarde. Doorgeven als een beveiligde parameter. |
endpointUri | De URL van het service bus-wachtrijeindpunt. Deze moet het protocol bevatten sb:// | tekenreeks |
entityPath | Wachtrijnaam in de Service Bus-naamruimte | tekenreeks |
id | Id van het service bus-wachtrijeindpunt | tekenreeks |
identity | Eigenschappen van beheerde identiteit van het service bus-wachtrijeindpunt voor routering. | ManagedIdentity |
naam | De naam die dit eindpunt identificeert. De naam mag alleen alfanumerieke tekens, punten, onderstrepingstekens, afbreekstreepjes bevatten en heeft een maximale lengte van 64 tekens. De volgende namen zijn gereserveerd: events, fileNotifications, $default. Eindpuntnamen moeten uniek zijn voor verschillende eindpunttypen. De naam hoeft niet hetzelfde te zijn als de werkelijke wachtrijnaam. | tekenreeks (vereist) Beperkingen: Patroon = ^[A-Za-z0-9-._]{1,64}$ |
resourceGroup | De naam van de resourcegroep van het service bus-wachtrijeindpunt. | tekenreeks |
subscriptionId | De abonnements-id van het service bus-wachtrijeindpunt. | tekenreeks |
RoutingServiceBusTopicEndpointProperties
Naam | Description | Waarde |
---|---|---|
authenticationType | Methode die wordt gebruikt voor verificatie op het eindpunt van het Service Bus-onderwerp | 'identityBased' 'keyBased' |
connectionString | De verbindingsreeks van het eindpunt van het service bus-onderwerp. | tekenreeks Beperkingen: Gevoelige waarde. Doorgeven als een beveiligde parameter. |
endpointUri | De URL van het service bus-onderwerpeindpunt. Deze moet het protocol bevatten sb:// | tekenreeks |
entityPath | Wachtrijnaam in het Service Bus-onderwerp | tekenreeks |
id | Id van het eindpunt van het Service Bus-onderwerp | tekenreeks |
identity | Eigenschappen van beheerde identiteit van het eindpunt van het routeringsservicebusonderwerp. | ManagedIdentity |
naam | De naam die dit eindpunt identificeert. De naam mag alleen alfanumerieke tekens, punten, onderstrepingstekens, afbreekstreepjes bevatten en heeft een maximale lengte van 64 tekens. De volgende namen zijn gereserveerd: events, fileNotifications, $default. Eindpuntnamen moeten uniek zijn voor verschillende eindpunttypen. De naam hoeft niet hetzelfde te zijn als de werkelijke onderwerpnaam. | tekenreeks (vereist) Beperkingen: Patroon = ^[A-Za-z0-9-._]{1,64}$ |
resourceGroup | De naam van de resourcegroep van het service bus-onderwerpeindpunt. | tekenreeks |
subscriptionId | De abonnements-id van het eindpunt van het service bus-onderwerp. | tekenreeks |
RoutingStorageContainerProperties
Naam | Description | Waarde |
---|---|---|
authenticationType | Methode die wordt gebruikt voor verificatie op het opslageindpunt | 'identityBased' 'keyBased' |
batchFrequencyInSeconds | Tijdsinterval waarmee blobs naar de opslag worden geschreven. De waarde moet tussen 60 en 720 seconden zijn. De standaardwaarde is 300 seconden. | int Beperkingen: Minimumwaarde = 60 Maximumwaarde = 720 |
connectionString | De verbindingsreeks van het opslagaccount. | tekenreeks Beperkingen: Gevoelige waarde. Doorgeven als een beveiligde parameter. |
containerName | De naam van de opslagcontainer in het opslagaccount. | tekenreeks (vereist) |
Codering | Codering die wordt gebruikt voor het serialiseren van berichten naar blobs. Ondersteunde waarden zijn 'avro', 'avrodeflate' en 'JSON'. De standaardwaarde is avro. | 'Avro' 'AvroDeflate' 'JSON' |
endpointUri | De URL van het opslageindpunt. Het moet het protocol bevatten https:// |
tekenreeks |
fileNameFormat | Bestandsnaamindeling voor de blob. De standaardindeling is {iothub}/{partition}/{JJJJ}/{MM}/{DD}/{HH}/{mm}. Alle parameters zijn verplicht, maar kunnen opnieuw worden gerangschikt. | tekenreeks |
id | Id van het eindpunt van de opslagcontainer | tekenreeks |
identity | Eigenschappen van beheerde identiteit van het eindpunt van de routeringsopslag. | ManagedIdentity |
maxChunkSizeInBytes | Maximum aantal bytes voor elke blob die naar de opslag wordt geschreven. De waarde moet tussen 10485760 (10 MB) en 524288000 (500 MB) zijn. De standaardwaarde is 314572800(300 MB). | int Beperkingen: Minimumwaarde = 10485760 Maximumwaarde = 524288000 |
naam | De naam die dit eindpunt identificeert. De naam mag alleen alfanumerieke tekens, punten, onderstrepingstekens, afbreekstreepjes bevatten en heeft een maximale lengte van 64 tekens. De volgende namen zijn gereserveerd: events, fileNotifications, $default. Eindpuntnamen moeten uniek zijn voor verschillende eindpunttypen. | tekenreeks (vereist) Beperkingen: Patroon = ^[A-Za-z0-9-._]{1,64}$ |
resourceGroup | De naam van de resourcegroep van het opslagaccount. | tekenreeks |
subscriptionId | De abonnements-id van het opslagaccount. | tekenreeks |
VerrijkingEigenschappen
Naam | Description | Waarde |
---|---|---|
endpointNames | De lijst met eindpunten waarvoor de verrijking wordt toegepast op het bericht. | tekenreeks[] (vereist) Beperkingen: Minimale lengte = 1 |
sleutel | De sleutel of naam voor de verrijkingseigenschap. | tekenreeks (vereist) |
waarde | De waarde voor de verrijkingseigenschap. | tekenreeks (vereist) |
FallbackRouteProperties
Naam | Description | Waarde |
---|---|---|
Voorwaarde | De voorwaarde die wordt geëvalueerd om de terugvalroute toe te passen. Als de voorwaarde niet is opgegeven, wordt standaard waar geëvalueerd. Zie voor grammatica: /azure/iot-hub/iot-hub-devguide-query-language | tekenreeks |
endpointNames | De lijst met eindpunten waarnaar de berichten die aan de voorwaarde voldoen, worden doorgestuurd. Momenteel is slechts één eindpunt toegestaan. | tekenreeks[] (vereist) Beperkingen: Minimale lengte = 1 Maximale lengte = 1 |
isEnabled | Wordt gebruikt om op te geven of de terugvalroute is ingeschakeld. | bool (vereist) |
naam | De naam van de route. De naam mag alleen alfanumerieke tekens, punten, onderstrepingstekens, afbreekstreepjes bevatten, heeft een maximale lengte van 64 tekens en moet uniek zijn. | tekenreeks |
source | De bron waarop de regel voor doorsturen moet worden toegepast. Bijvoorbeeld DeviceMessages | 'DeviceConnectionStateEvents' 'DeviceJobLifecycleEvents' 'DeviceLifecycleEvents' 'DeviceMessages' 'DigitalTwinChangeEvents' 'Ongeldig' 'MqttBrokerMessages' 'TwinChangeEvents' (vereist) |
RouteEigenschappen
Naam | Description | Waarde |
---|---|---|
Voorwaarde | De voorwaarde die wordt geëvalueerd om de regel voor doorsturen toe te passen. Als er geen voorwaarde wordt opgegeven, wordt standaard waar geëvalueerd. Zie voor grammatica: /azure/iot-hub/iot-hub-devguide-query-language | tekenreeks |
endpointNames | De lijst met eindpunten waarnaar berichten worden doorgestuurd die voldoen aan de voorwaarde. Momenteel is slechts één eindpunt toegestaan. | tekenreeks[] (vereist) Beperkingen: Minimale lengte = 1 Maximale lengte = 1 |
isEnabled | Wordt gebruikt om op te geven of een route is ingeschakeld. | bool (vereist) |
naam | De naam van de route. De naam mag alleen alfanumerieke tekens, punten, onderstrepingstekens, afbreekstreepjes bevatten, heeft een maximale lengte van 64 tekens en moet uniek zijn. | tekenreeks (vereist) Beperkingen: Patroon = ^[A-Za-z0-9-._]{1,64}$ |
source | De bron waarop de routeringsregel moet worden toegepast, zoals DeviceMessages. | 'DeviceConnectionStateEvents' 'DeviceJobLifecycleEvents' 'DeviceLifecycleEvents' 'DeviceMessages' 'DigitalTwinChangeEvents' 'Ongeldig' 'MqttBrokerMessages' 'TwinChangeEvents' (vereist) |
IotHubPropertiesStorageEndpoints
Naam | Description | Waarde |
---|---|---|
{aangepaste eigenschap} | StorageEndpointProperties |
StorageEndpointProperties
Naam | Description | Waarde |
---|---|---|
authenticationType | Hiermee geeft u het verificatietype op dat wordt gebruikt om verbinding te maken met het opslagaccount. | 'identityBased' 'keyBased' |
connectionString | De verbindingsreeks voor het Azure Storage-account waarnaar bestanden worden geüpload. | tekenreeks (vereist) |
containerName | De naam van de hoofdcontainer waarin u bestanden uploadt. De container hoeft niet te bestaan, maar moet wel worden gemaakt met behulp van de opgegeven connectionString. | tekenreeks (vereist) |
identity | Eigenschappen van beheerde identiteit van opslageindpunt voor het uploaden van bestanden. | ManagedIdentity |
sasTtlAsIso8601 | De periode waarin de SAS-URI die is gegenereerd door IoT Hub voor het uploaden van bestanden geldig is. Zie: /azure/iot-hub/iot-hub-devguide-file-upload#file-upload-notification-configuration-options. | tekenreeks |
IotHubSkuInfo
Naam | Description | Waarde |
---|---|---|
capacity | Het aantal ingerichte IoT Hub eenheden. Zie: /azure/azure-subscription-service-limits#iot-hub-limits. | int |
naam | De naam van de SKU. | 'B1' "B2" "B3" 'F1' 'S1' 'S2' 'S3' (vereist) |
Snelstartsjablonen
Met de volgende snelstartsjablonen wordt dit resourcetype geïmplementeerd.
Template | Beschrijving |
---|---|
Een IOT Hub- en Ubuntu Edge-simulator maken |
Met deze sjabloon maakt u een IOT Hub en virtuele Machine Ubuntu Edge-simulator. |
ARM-sjabloon gebruiken om IoT Hub te maken, berichten te routeren en weer te geven |
Gebruik deze sjabloon om een IoT Hub en een opslagaccount te implementeren. Voer een app uit om berichten naar de hub te verzenden die naar de opslag worden gerouteerd en bekijk vervolgens de resultaten. |
Een IoT Hub Device Provisioning Service maken |
Met deze sjabloon kunt u een IoT-hub en een IoT Hub Device Provisioning Service maken en de twee services aan elkaar koppelen. |
Een IoT Hub en een consumergroep voor apparaat naar cloud maken |
Met deze sjabloon kunt u een IoT Hub-exemplaar implementeren met apparaat-naar-cloud- en cloud-naar-apparaatberichtenconfiguraties en een apparaat naar een cloudgebruikersgroep. |
Device Update maken voor IoT Hub account, exemplaar IoT Hub |
Met deze sjabloon maakt u een account, een exemplaar en een hub om het exemplaar aan te koppelen. De hub wordt geconfigureerd met het benodigde toegangsbeleid, de routes en de consumentengroep. |
De MedTech-service implementeren, inclusief een Azure IoT Hub |
De MedTech-service is een van de Azure Health Data Services die is ontworpen om apparaatgegevens van meerdere apparaten op te nemen en de apparaatgegevens te transformeren in FHIR-waarnemingen, die vervolgens worden bewaard in de Azure Health Data Services FHIR-service. |
Een pay-as-you-go-omgeving maken met een IoT Hub |
Met deze sjabloon kunt u een Pay As You Go-omgeving (PAYG) Time Series Insights implementeren die is geconfigureerd voor het verbruik van gebeurtenissen van een IoT Hub. |
Terraform-resourcedefinitie (AzAPI-provider)
Het resourcetype IotHubs kan worden geïmplementeerd met bewerkingen die zijn gericht op:
- Resourcegroepen
Zie wijzigingenlogboek voor een lijst met gewijzigde eigenschappen in elke API-versie.
Resource-indeling
Als u een Microsoft.Devices/IotHubs-resource wilt maken, voegt u de volgende Terraform toe aan uw sjabloon.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Devices/IotHubs@2022-04-30-preview"
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"
deviceStreams = {
streamingEndpoints = [
"string"
]
}
disableDeviceSAS = bool
disableLocalAuth = bool
disableModuleSAS = bool
enableDataResidency = bool
enableFileUploadNotifications = bool
encryption = {
keySource = "string"
keyVaultProperties = [
{
identity = {
userAssignedIdentity = "string"
}
keyIdentifier = "string"
}
]
}
eventHubEndpoints = {
{customized property} = {
partitionCount = int
retentionTimeInDays = int
}
}
features = "string"
ipFilterRules = [
{
action = "string"
filterName = "string"
ipMask = "string"
}
]
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
rootCertificate = {
enableRootCertificateV2 = bool
}
routing = {
endpoints = {
cosmosDBSqlCollections = [
{
authenticationType = "string"
collectionName = "string"
databaseName = "string"
endpointUri = "string"
id = "string"
identity = {
userAssignedIdentity = "string"
}
name = "string"
partitionKeyName = "string"
partitionKeyTemplate = "string"
primaryKey = "string"
resourceGroup = "string"
secondaryKey = "string"
subscriptionId = "string"
}
]
eventHubs = [
{
authenticationType = "string"
connectionString = "string"
endpointUri = "string"
entityPath = "string"
id = "string"
identity = {
userAssignedIdentity = "string"
}
name = "string"
resourceGroup = "string"
subscriptionId = "string"
}
]
serviceBusQueues = [
{
authenticationType = "string"
connectionString = "string"
endpointUri = "string"
entityPath = "string"
id = "string"
identity = {
userAssignedIdentity = "string"
}
name = "string"
resourceGroup = "string"
subscriptionId = "string"
}
]
serviceBusTopics = [
{
authenticationType = "string"
connectionString = "string"
endpointUri = "string"
entityPath = "string"
id = "string"
identity = {
userAssignedIdentity = "string"
}
name = "string"
resourceGroup = "string"
subscriptionId = "string"
}
]
storageContainers = [
{
authenticationType = "string"
batchFrequencyInSeconds = int
connectionString = "string"
containerName = "string"
encoding = "string"
endpointUri = "string"
fileNameFormat = "string"
id = "string"
identity = {
userAssignedIdentity = "string"
}
maxChunkSizeInBytes = int
name = "string"
resourceGroup = "string"
subscriptionId = "string"
}
]
}
enrichments = [
{
endpointNames = [
"string"
]
key = "string"
value = "string"
}
]
fallbackRoute = {
condition = "string"
endpointNames = [
"string"
]
isEnabled = bool
name = "string"
source = "string"
}
routes = [
{
condition = "string"
endpointNames = [
"string"
]
isEnabled = bool
name = "string"
source = "string"
}
]
}
storageEndpoints = {
{customized property} = {
authenticationType = "string"
connectionString = "string"
containerName = "string"
identity = {
userAssignedIdentity = "string"
}
sasTtlAsIso8601 = "string"
}
}
}
sku = {
capacity = int
name = "string"
}
etag = "string"
})
}
Eigenschapswaarden
IotHubs
Naam | Description | Waarde |
---|---|---|
type | Het resourcetype | "Microsoft.Devices/IotHubs@2022-04-30-preview" |
naam | De resourcenaam | tekenreeks (vereist) Tekenlimiet: 3-50 Geldige tekens: Alfanumerieken en afbreekstreepjes. Kan niet eindigen met een afbreekstreepje. De resourcenaam moet uniek zijn in Azure. |
location | De resourcelocatie. | tekenreeks (vereist) |
parent_id | Als u wilt implementeren in een resourcegroep, gebruikt u de id van die resourcegroep. | tekenreeks (vereist) |
tags | De resourcetags. | Woordenlijst met tagnamen en -waarden. |
sku | IotHub SKU-informatie | IotHubSkuInfo (vereist) |
etag | Het veld Etag is niet vereist. Als deze is opgegeven in de hoofdtekst van het antwoord, moet deze ook worden opgegeven als een header volgens de normale ETag-conventie. | tekenreeks |
identity | De beheerde identiteiten voor de IotHub. | ArmIdentity |
properties | IotHub-eigenschappen | IotHubProperties |
ArmIdentity
Naam | Description | Waarde |
---|---|---|
type | Het type identiteit dat voor de resource wordt gebruikt. Het type 'SystemAssigned,UserAssigned' bevat zowel een impliciet gemaakte identiteit als een set door de gebruiker toegewezen identiteiten. Met het type 'Geen' worden alle identiteiten uit de service verwijderd. | "SystemAssigned" "SystemAssigned, UserAssigned" "UserAssigned" |
identity_ids | Woordenlijst van {ArmUserIdentity} | Matrix met gebruikersidentiteits-id's. |
ArmIdentityUserAssignedId-entiteiten
Naam | Description | Waarde |
---|---|---|
{aangepaste eigenschap} | ArmUserIdentity |
ArmUserIdentity
Dit object bevat geen eigenschappen die tijdens de implementatie moeten worden ingesteld. Alle eigenschappen zijn Alleen-lezen.
IotHubProperties
Naam | Description | Waarde |
---|---|---|
allowedFqdnList | Lijst met toegestane FQDN's (Fully Qualified Domain Name) voor uitgaand verkeer van IoT Hub. | tekenreeks[] |
authorizationPolicies | Het beleid voor gedeelde toegang dat u kunt gebruiken om een verbinding met de IoT-hub te beveiligen. | SharedAccessSignatureAuthorizationRule[] |
cloudToDevice | De eigenschappen van cloud-naar-apparaat-berichten van IoT Hub. | CloudToDeviceProperties |
opmerkingen | Opmerkingen bij IoT Hub. | tekenreeks |
deviceStreams | Het apparaat streamt eigenschappen van iothub. | IotHubPropertiesDeviceStreams |
disableDeviceSAS | Als dit waar is, kunnen alle SAS-sleutels met een bereik van het apparaat (inclusief Edge-apparaten, maar met uitzondering van modules) niet worden gebruikt voor verificatie. | booleaans |
disableLocalAuth | Als dit waar is, kunnen SAS-tokens met SAS-sleutels met ioT-hubbereik niet worden gebruikt voor verificatie. | booleaans |
disableModuleSAS | Als dit waar is, kunnen niet alle SAS-sleutels met modulebereik worden gebruikt voor verificatie. | booleaans |
enableDataResidency | Als deze eigenschap is ingesteld op true, wordt gegevenslocatie ingeschakeld, waardoor herstel na noodgevallen wordt uitgeschakeld. | booleaans |
enableFileUploadNotifications | Als waar is, zijn meldingen voor het uploaden van bestanden ingeschakeld. | booleaans |
versleuteling | De versleutelingseigenschappen voor de IoT-hub. | EncryptionPropertiesDescription |
eventHubEndpoints | De eigenschappen van het Event Hub-compatibele eindpunt. De enige mogelijke sleutels voor deze woordenlijst zijn gebeurtenissen. Deze sleutel moet aanwezig zijn in de woordenlijst tijdens het maken of bijwerken van aanroepen voor de IoT-hub. | IotHubPropertiesEventHubEndpoints |
features | De mogelijkheden en functies die zijn ingeschakeld voor de IoT-hub. | "DeviceManagement" "Geen" |
ipFilterRules | De IP-filterregels. | IpFilterRule[] |
messagingEndpoints | De berichteindpunteigenschappen voor de meldingswachtrij voor het uploaden van bestanden. | IotHubPropertiesMessagingEndpoints |
minTlsVersion | Hiermee geeft u de minimale TLS-versie te ondersteunen voor deze hub. Kan worden ingesteld op '1.2', zodat clients die een TLS-versie lager dan 1.2 gebruiken, worden geweigerd. | tekenreeks |
networkRuleSets | Eigenschappen van netwerkregelset van IotHub | NetworkRuleSetProperties |
privateEndpointConnections | Privé-eindpuntverbindingen die zijn gemaakt op deze IotHub | PrivateEndpointConnection[] |
publicNetworkAccess | Of aanvragen van het openbare netwerk zijn toegestaan | "Uitgeschakeld" "Ingeschakeld" |
restrictOutboundNetworkAccess | Als dit waar is, wordt uitgaand verkeer van IotHub beperkt tot alleen de toegestane FQDN's die zijn geconfigureerd via allowedFqdnList. | booleaans |
rootCertificate | Met deze eigenschap wordt informatie over het basiscertificaat opgeslagen | RootCertificateProperties |
Routering | De routeringsgerelateerde eigenschappen van de IoT-hub. Zie: /azure/iot-hub/iot-hub-devguide-messaging | RouteringEigenschappen |
storageEndpoints | De lijst met Azure Storage-eindpunten waar u bestanden kunt uploaden. Momenteel kunt u slechts één Azure Storage-account configureren en dat moet de bijbehorende sleutel hebben als $default. Als u meer dan één opslagaccount opgeeft, wordt er een fout gegenereerd. Als u geen waarde voor deze eigenschap opgeeft wanneer de eigenschap enableFileUploadNotifications is ingesteld op True, wordt er een fout gegenereerd. | IotHubPropertiesStorageEndpoints |
SharedAccessSignatureAuthorizationRule
Naam | Description | Waarde |
---|---|---|
keyName | De naam van het beleid voor gedeelde toegang. | tekenreeks (vereist) |
primaryKey | De primaire sleutel. | tekenreeks |
Rechten | De machtigingen die zijn toegewezen aan het beleid voor gedeelde toegang. | "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' (vereist) |
secondaryKey | De secundaire sleutel. | tekenreeks |
keyName | De naam van het beleid voor gedeelde toegang. | tekenreeks (vereist) |
primaryKey | De primaire sleutel. | tekenreeks |
Rechten | De machtigingen die zijn toegewezen aan het beleid voor gedeelde toegang. | "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' (vereist) |
secondaryKey | De secundaire sleutel. | tekenreeks |
CloudToDeviceProperties
Naam | Description | Waarde |
---|---|---|
defaultTtlAsIso8601 | De standaardtijd voor cloud-naar-apparaat-berichten in de apparaatwachtrij. Zie: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | tekenreeks |
Feedback | De eigenschappen van de feedbackwachtrij voor cloud-naar-apparaat-berichten. | FeedbackEigenschappen |
maxDeliveryCount | Het maximale aantal bezorgingen voor cloud-naar-apparaat-berichten in de apparaatwachtrij. Zie: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | int Beperkingen: Minimumwaarde = 1 Maximumwaarde = 100 |
FeedbackEigenschappen
Naam | Description | Waarde |
---|---|---|
lockDurationAsIso8601 | De vergrendelingsduur voor de feedbackwachtrij. Zie: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | tekenreeks |
maxDeliveryCount | Het aantal keren dat de IoT-hub een bericht probeert af te leveren in de feedbackwachtrij. Zie: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | int Beperkingen: Minimumwaarde = 1 Maximumwaarde = 100 |
ttlAsIso8601 | De periode waarin een bericht beschikbaar is om te gebruiken voordat het is verlopen door de IoT-hub. Zie: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | tekenreeks |
IotHubPropertiesDeviceStreams
Naam | Description | Waarde |
---|---|---|
streamingEndpoints | Lijst met eindpunten voor apparaatstreams. | tekenreeks[] |
EncryptionPropertiesDescription
Naam | Description | Waarde |
---|---|---|
keySource | De bron van de sleutel. | tekenreeks |
keyVaultProperties | De eigenschappen van de KeyVault-sleutel. | KeyVaultKeyProperties[] |
KeyVaultKeyProperties
Naam | Description | Waarde |
---|---|---|
identity | Eigenschappen van beheerde identiteit van KeyVault-sleutel. | ManagedIdentity |
keyIdentifier | De id van de sleutel. | tekenreeks |
ManagedIdentity
Naam | Description | Waarde |
---|---|---|
userAssignedIdentity | De door de gebruiker toegewezen identiteit. | tekenreeks |
IotHubPropertiesEventHubEndpoints
Naam | Description | Waarde |
---|---|---|
{aangepaste eigenschap} | EventHubProperties |
EventHubProperties
Naam | Description | Waarde |
---|---|---|
partitionCount | Het aantal partities voor het ontvangen van apparaat-naar-cloud-berichten in het event hub-compatibele eindpunt. Zie: /azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages. | int |
retentionTimeInDays | De bewaartijd voor apparaat-naar-cloud-berichten in dagen. Zie: /azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages | int |
IpFilterRule
Naam | Description | Waarde |
---|---|---|
action | De gewenste actie voor aanvragen die door deze regel zijn vastgelegd. | "Accepteren" 'Weigeren' (vereist) |
filterName | De naam van de IP-filterregel. | tekenreeks (vereist) |
ipMask | Een tekenreeks die het IP-adresbereik bevat in CIDR-notatie voor de regel. | tekenreeks (vereist) |
IotHubPropertiesMessagingEndpoints
Naam | Description | Waarde |
---|---|---|
{aangepaste eigenschap} | MessagingEndpointProperties |
MessagingEndpointProperties
Naam | Description | Waarde |
---|---|---|
lockDurationAsIso8601 | De duur van de vergrendeling. Zie: /azure/iot-hub/iot-hub-devguide-file-upload. | tekenreeks |
maxDeliveryCount | Het aantal keren dat de IoT-hub een bericht probeert af te leveren. Zie: /azure/iot-hub/iot-hub-devguide-file-upload. | int Beperkingen: Minimumwaarde = 1 Maximale waarde = 100 |
ttlAsIso8601 | De periode waarin een bericht kan worden gebruikt voordat het is verlopen door de IoT-hub. Zie: /azure/iot-hub/iot-hub-devguide-file-upload. | tekenreeks |
NetworkRuleSetProperties
Naam | Description | Waarde |
---|---|---|
applyToBuiltInEventHubEndpoint | Indien waar, wordt netwerkregelset ook toegepast op BuiltIn EventHub EndPoint van IotHub | bool (vereist) |
defaultAction | Standaardactie voor netwerkregelset | "Toestaan" "Weigeren" |
ipRules | Lijst met IP-regels | NetworkRuleSetIpRule[] (vereist) |
NetworkRuleSetIpRule
Naam | Description | Waarde |
---|---|---|
action | IP-filteractie | "Toestaan" |
filterName | Naam van de IP-filterregel. | tekenreeks (vereist) |
ipMask | Een tekenreeks die het IP-adresbereik bevat in CIDR-notatie voor de regel. | tekenreeks (vereist) |
PrivateEndpointConnection
Naam | Description | Waarde |
---|---|---|
properties | De eigenschappen van een privé-eindpuntverbinding | PrivateEndpointConnectionProperties (vereist) |
PrivateEndpointConnectionProperties
Naam | Description | Waarde |
---|---|---|
privateEndpoint | De privé-eindpunteigenschap van een privé-eindpuntverbinding | PrivateEndpoint |
privateLinkServiceConnectionState | De huidige status van een privé-eindpuntverbinding | PrivateLinkServiceConnectionState (vereist) |
PrivateEndpoint
Dit object bevat geen eigenschappen die tijdens de implementatie moeten worden ingesteld. Alle eigenschappen zijn ReadOnly.
PrivateLinkServiceConnectionState
Naam | Description | Waarde |
---|---|---|
actionsRequired | Vereiste acties voor een privé-eindpuntverbinding | tekenreeks |
beschrijving | De beschrijving voor de huidige status van een privé-eindpuntverbinding | tekenreeks (vereist) |
status | De status van een privé-eindpuntverbinding | "Goedgekeurd" "Verbinding verbroken" "In behandeling" 'Geweigerd' (vereist) |
RootCertificateProperties
Naam | Description | Waarde |
---|---|---|
enableRootCertificateV2 | Als deze eigenschap is ingesteld op true, gebruikt de hub het G2-certificaat; Hoewel deze is ingesteld op false, gebruikt de hub Baltimore Cert. | booleaans |
RouteringEigenschappen
Naam | Description | Waarde |
---|---|---|
Eindpunten | De eigenschappen met betrekking tot de aangepaste eindpunten waarnaar uw IoT-hub berichten routeert op basis van de routeringsregels. Er zijn maximaal 10 aangepaste eindpunten toegestaan voor alle eindpunttypen voor betaalde hubs en er is slechts 1 aangepast eindpunt toegestaan voor alle eindpunttypen voor gratis hubs. | RoutingEndpoints |
verrijkingen | De lijst met door de gebruiker geleverde verrijkingen die de IoT-hub toepast op berichten die moeten worden bezorgd bij ingebouwde en aangepaste eindpunten. Zie: https://aka.ms/telemetryoneventgrid |
VerrijkingEigenschappen[] |
fallbackRoute | De eigenschappen van de route die wordt gebruikt als een terugvalroute wanneer aan geen van de voorwaarden in de sectie 'routes' wordt voldaan. Dit is een optionele parameter. Wanneer deze eigenschap niet is ingesteld, worden de berichten die niet voldoen aan een van de voorwaarden die zijn opgegeven in de sectie Routes doorgestuurd naar het ingebouwde EventHub-eindpunt. | FallbackRouteProperties |
Routes | De lijst met door de gebruiker verstrekte routeringsregels die door de IoT-hub worden gebruikt om berichten te routeren naar ingebouwde en aangepaste eindpunten. Er zijn maximaal 100 regels voor doorsturen toegestaan voor betaalde hubs en maximaal 5 routeringsregels voor gratis hubs. | RouteProperties[] |
RoutingEndpoints
Naam | Description | Waarde |
---|---|---|
cosmosDBSqlCollections | De lijst met Cosmos DB-verzamelingseindpunten waarnaar IoT Hub berichten routeert op basis van de routeringsregels. | RoutingCosmosDBSqlApiProperties[] |
eventHubs | De lijst met Event Hubs-eindpunten waarnaar IoT Hub berichten routeert op basis van de routeringsregels. Deze lijst bevat niet het ingebouwde Event Hubs-eindpunt. | RoutingEventHubProperties[] |
serviceBusQueues | De lijst met Service Bus-wachtrijeindpunten waarnaar IoT Hub de berichten routeert, op basis van de routeringsregels. | RoutingServiceBusQueueEndpointProperties[] |
serviceBusTopics | De lijst met Service Bus-onderwerpeindpunten waarnaar de IoT-hub de berichten routeert op basis van de routeringsregels. | RoutingServiceBusTopicEndpointProperties[] |
storageContainers | De lijst met opslagcontainereindpunten waarnaar IoT Hub berichten routeert op basis van de routeringsregels. | RoutingStorageContainerProperties[] |
RoutingCosmosDBSqlApiProperties
Naam | Description | Waarde |
---|---|---|
authenticationType | Methode die wordt gebruikt voor verificatie op het eindpunt van de SQL-verzameling van Cosmos DB | "identityBased" "keyBased" |
collectionName | De naam van de cosmos DB SQL-verzameling in de cosmos DB-database. | tekenreeks (vereist) |
databaseName | De naam van de cosmos DB-database in het Cosmos DB-account. | tekenreeks (vereist) |
endpointUri | De URL van het Cosmos DB-account. Het moet het protocol bevatten https:// |
tekenreeks (vereist) |
id | Id van het sql-verzamelingseindpunt van Cosmos DB | tekenreeks |
identity | Eigenschappen van beheerde identiteit van routering cosmos DB-verzamelingseindpunt. | ManagedIdentity |
naam | De naam die dit eindpunt identificeert. De naam mag alleen alfanumerieke tekens, punten, onderstrepingstekens, afbreekstreepjes bevatten en heeft een maximale lengte van 64 tekens. De volgende namen zijn gereserveerd: gebeurtenissen, fileNotifications $default. Eindpuntnamen moeten uniek zijn voor verschillende eindpunttypen. | tekenreeks (vereist) Beperkingen: Patroon = ^[A-Za-z0-9-._]{1,64}$ |
partitionKeyName | De naam van de partitiesleutel die is gekoppeld aan deze Cosmos DB SQL-verzameling, indien aanwezig. Dit is een optionele parameter. | tekenreeks |
partitionKeyTemplate | De sjabloon voor het genereren van een synthetische partitiesleutelwaarde voor gebruik met deze cosmos DB SQL-verzameling. De sjabloon moet ten minste een van de volgende tijdelijke aanduidingen bevatten: {iothub}, {deviceid}, {DD}, {MM} en {JJJJ}. Een tijdelijke aanduiding kan maximaal één keer worden opgegeven, maar order- en niet-tijdelijke aanduidingen zijn willekeurig. Deze parameter is alleen vereist als PartitionKeyName is opgegeven. | tekenreeks |
primaryKey | De primaire sleutel van het cosmos DB-account. | tekenreeks Beperkingen: Gevoelige waarde. Doorgeven als een beveiligde parameter. |
resourceGroup | De naam van de resourcegroep van het Cosmos DB-account. | tekenreeks |
secondaryKey | De secundaire sleutel van het cosmos DB-account. | tekenreeks Beperkingen: Gevoelige waarde. Doorgeven als een beveiligde parameter. |
subscriptionId | De abonnements-id van het cosmos DB-account. | tekenreeks |
RoutingEventHubProperties
Naam | Description | Waarde |
---|---|---|
authenticationType | Methode die wordt gebruikt voor verificatie bij het Event Hub-eindpunt | "identityBased" "keyBased" |
connectionString | De verbindingsreeks van het Event Hub-eindpunt. | tekenreeks Beperkingen: Gevoelige waarde. Doorgeven als een beveiligde parameter. |
endpointUri | De URL van het Event Hub-eindpunt. Deze moet het protocol bevatten sb:// | tekenreeks |
entityPath | Event Hub-naam in de Event Hub-naamruimte | tekenreeks |
id | Id van het Event Hub-eindpunt | tekenreeks |
identity | Eigenschappen van beheerde identiteit van routering event hub-eindpunt. | ManagedIdentity |
naam | De naam die dit eindpunt identificeert. De naam mag alleen alfanumerieke tekens, punten, onderstrepingstekens, afbreekstreepjes bevatten en heeft een maximale lengte van 64 tekens. De volgende namen zijn gereserveerd: gebeurtenissen, fileNotifications $default. Eindpuntnamen moeten uniek zijn voor verschillende eindpunttypen. | tekenreeks (vereist) Beperkingen: Patroon = ^[A-Za-z0-9-._]{1,64}$ |
resourceGroup | De naam van de resourcegroep van het Event Hub-eindpunt. | tekenreeks |
subscriptionId | De abonnements-id van het Event Hub-eindpunt. | tekenreeks |
RoutingServiceBusQueueEndpointProperties
Naam | Description | Waarde |
---|---|---|
authenticationType | Methode die wordt gebruikt voor verificatie op het service bus-wachtrijeindpunt | "identityBased" "keyBased" |
connectionString | De verbindingsreeks van het service bus-wachtrijeindpunt. | tekenreeks Beperkingen: Gevoelige waarde. Doorgeven als een beveiligde parameter. |
endpointUri | De URL van het service bus-wachtrijeindpunt. Deze moet het protocol bevatten sb:// | tekenreeks |
entityPath | Wachtrijnaam in de Service Bus-naamruimte | tekenreeks |
id | Id van het service bus-wachtrijeindpunt | tekenreeks |
identity | Eigenschappen van beheerde identiteit van routeringsservicebuswachtrijeindpunt. | ManagedIdentity |
naam | De naam die dit eindpunt identificeert. De naam mag alleen alfanumerieke tekens, punten, onderstrepingstekens, afbreekstreepjes bevatten en heeft een maximale lengte van 64 tekens. De volgende namen zijn gereserveerd: gebeurtenissen, fileNotifications $default. Eindpuntnamen moeten uniek zijn voor verschillende eindpunttypen. De naam hoeft niet hetzelfde te zijn als de werkelijke wachtrijnaam. | tekenreeks (vereist) Beperkingen: Patroon = ^[A-Za-z0-9-._]{1,64}$ |
resourceGroup | De naam van de resourcegroep van het service bus-wachtrijeindpunt. | tekenreeks |
subscriptionId | De abonnements-id van het service bus-wachtrijeindpunt. | tekenreeks |
RoutingServiceBusTopicEndpointProperties
Naam | Description | Waarde |
---|---|---|
authenticationType | Methode die wordt gebruikt voor verificatie op het eindpunt van het Service Bus-onderwerp | "identityBased" "keyBased" |
connectionString | De verbindingsreeks van het service bus-onderwerpeindpunt. | tekenreeks Beperkingen: Gevoelige waarde. Doorgeven als een beveiligde parameter. |
endpointUri | De URL van het service bus-onderwerpeindpunt. Deze moet het protocol bevatten sb:// | tekenreeks |
entityPath | Wachtrijnaam in het Service Bus-onderwerp | tekenreeks |
id | Id van het service bus-onderwerpeindpunt | tekenreeks |
identity | Eigenschappen van beheerde identiteit van het eindpunt van het routeringsservicebusonderwerp. | ManagedIdentity |
naam | De naam die dit eindpunt identificeert. De naam mag alleen alfanumerieke tekens, punten, onderstrepingstekens, afbreekstreepjes bevatten en heeft een maximale lengte van 64 tekens. De volgende namen zijn gereserveerd: gebeurtenissen, fileNotifications $default. Eindpuntnamen moeten uniek zijn voor verschillende eindpunttypen. De naam hoeft niet hetzelfde te zijn als de werkelijke onderwerpnaam. | tekenreeks (vereist) Beperkingen: Patroon = ^[A-Za-z0-9-._]{1,64}$ |
resourceGroup | De naam van de resourcegroep van het service bus-onderwerpeindpunt. | tekenreeks |
subscriptionId | De abonnements-id van het service bus-onderwerpeindpunt. | tekenreeks |
RoutingStorageContainerProperties
Naam | Description | Waarde |
---|---|---|
authenticationType | Methode die wordt gebruikt voor verificatie bij het opslageindpunt | "identityBased" "keyBased" |
batchFrequencyInSeconds | Tijdsinterval waarin blobs naar de opslag worden geschreven. De waarde moet tussen 60 en 720 seconden zijn. De standaardwaarde is 300 seconden. | int Beperkingen: Minimumwaarde = 60 Maximale waarde = 720 |
connectionString | De verbindingsreeks van het opslagaccount. | tekenreeks Beperkingen: Gevoelige waarde. Doorgeven als een beveiligde parameter. |
containerName | De naam van de opslagcontainer in het opslagaccount. | tekenreeks (vereist) |
Codering | Codering die wordt gebruikt om berichten naar blobs te serialiseren. Ondersteunde waarden zijn 'avro', 'avrodeflate' en 'JSON'. De standaardwaarde is 'avro'. | "Avro" "AvroDeflate" "JSON" |
endpointUri | De URL van het opslageindpunt. Het moet het protocol bevatten https:// |
tekenreeks |
fileNameFormat | Bestandsindeling voor de blob. De standaardindeling is {iothub}/{partition}/{JJJJ}/{MM}/{DD}/{HH}/{mm}. Alle parameters zijn verplicht, maar kunnen opnieuw worden gerangschikt. | tekenreeks |
id | Id van het eindpunt van de opslagcontainer | tekenreeks |
identity | Eigenschappen van beheerde identiteit van routeringsopslageindpunt. | ManagedIdentity |
maxChunkSizeInBytes | Maximum aantal bytes voor elke blob die naar de opslag wordt geschreven. De waarde moet tussen 10485760(10 MB) en 524288000(500 MB) zijn. De standaardwaarde is 314572800(300 MB). | int Beperkingen: Minimumwaarde = 10485760 Maximumwaarde = 524288000 |
naam | De naam die dit eindpunt identificeert. De naam mag alleen alfanumerieke tekens, punten, onderstrepingstekens, afbreekstreepjes bevatten en heeft een maximale lengte van 64 tekens. De volgende namen zijn gereserveerd: gebeurtenissen, fileNotifications $default. Eindpuntnamen moeten uniek zijn voor verschillende eindpunttypen. | tekenreeks (vereist) Beperkingen: Patroon = ^[A-Za-z0-9-._]{1,64}$ |
resourceGroup | De naam van de resourcegroep van het opslagaccount. | tekenreeks |
subscriptionId | De abonnements-id van het opslagaccount. | tekenreeks |
VerrijkingEigenschappen
Naam | Description | Waarde |
---|---|---|
endpointNames | De lijst met eindpunten waarvoor de verrijking wordt toegepast op het bericht. | tekenreeks[] (vereist) Beperkingen: Minimale lengte = 1 |
sleutel | De sleutel of naam voor de verrijkingseigenschap. | tekenreeks (vereist) |
waarde | De waarde voor de verrijkingseigenschap. | tekenreeks (vereist) |
FallbackRouteProperties
Naam | Description | Waarde |
---|---|---|
Voorwaarde | De voorwaarde die wordt geëvalueerd om de terugvalroute toe te passen. Als de voorwaarde niet is opgegeven, wordt standaard als true geëvalueerd. Zie voor grammatica: /azure/iot-hub/iot-hub-devguide-query-language | tekenreeks |
endpointNames | De lijst met eindpunten waarnaar de berichten die aan de voorwaarde voldoen, worden doorgestuurd. Momenteel is slechts één eindpunt toegestaan. | tekenreeks[] (vereist) Beperkingen: Minimale lengte = 1 Maximale lengte = 1 |
isEnabled | Wordt gebruikt om op te geven of de terugvalroute is ingeschakeld. | bool (vereist) |
naam | De naam van de route. De naam mag alleen alfanumerieke tekens, punten, onderstrepingstekens, afbreekstreepjes bevatten, heeft een maximale lengte van 64 tekens en moet uniek zijn. | tekenreeks |
source | De bron waarop de routeringsregel moet worden toegepast. Bijvoorbeeld DeviceMessages | "DeviceConnectionStateEvents" "DeviceJobLifecycleEvents" "DeviceLifecycleEvents" "DeviceMessages" "DigitalTwinChangeEvents" "Ongeldig" "MqttBrokerMessages" "TwinChangeEvents" (vereist) |
RouteEigenschappen
Naam | Description | Waarde |
---|---|---|
Voorwaarde | De voorwaarde die wordt geëvalueerd om de regel voor doorsturen toe te passen. Als er geen voorwaarde is opgegeven, wordt standaard waar geëvalueerd. Zie voor grammatica: /azure/iot-hub/iot-hub-devguide-query-language | tekenreeks |
endpointNames | De lijst met eindpunten waarnaar berichten worden doorgestuurd die voldoen aan de voorwaarde. Momenteel is slechts één eindpunt toegestaan. | tekenreeks[] (vereist) Beperkingen: Minimale lengte = 1 Maximale lengte = 1 |
isEnabled | Wordt gebruikt om op te geven of een route is ingeschakeld. | bool (vereist) |
naam | De naam van de route. De naam mag alleen alfanumerieke tekens, punten, onderstrepingstekens, afbreekstreepjes bevatten, heeft een maximale lengte van 64 tekens en moet uniek zijn. | tekenreeks (vereist) Beperkingen: Patroon = ^[A-Za-z0-9-._]{1,64}$ |
source | De bron waarop de routeringsregel moet worden toegepast, zoals DeviceMessages. | "DeviceConnectionStateEvents" "DeviceJobLifecycleEvents" "DeviceLifecycleEvents" "DeviceMessages" "DigitalTwinChangeEvents" "Ongeldig" "MqttBrokerMessages" "TwinChangeEvents" (vereist) |
IotHubPropertiesStorageEndpoints
Naam | Description | Waarde |
---|---|---|
{aangepaste eigenschap} | StorageEndpointProperties |
StorageEndpointProperties
Naam | Description | Waarde |
---|---|---|
authenticationType | Hiermee geeft u het verificatietype op dat wordt gebruikt om verbinding te maken met het opslagaccount. | "identityBased" "keyBased" |
connectionString | De verbindingsreeks voor het Azure Storage-account waarnaar bestanden worden geüpload. | tekenreeks (vereist) |
containerName | De naam van de hoofdcontainer waarin u bestanden uploadt. De container hoeft niet te bestaan, maar moet wel worden gemaakt met behulp van de opgegeven connectionString. | tekenreeks (vereist) |
identity | Eigenschappen van beheerde identiteit van opslageindpunt voor het uploaden van bestanden. | ManagedIdentity |
sasTtlAsIso8601 | De periode waarin de SAS-URI die is gegenereerd door IoT Hub voor het uploaden van bestanden geldig is. Zie: /azure/iot-hub/iot-hub-devguide-file-upload#file-upload-notification-configuration-options. | tekenreeks |
IotHubSkuInfo
Naam | Description | Waarde |
---|---|---|
capacity | Het aantal ingerichte IoT Hub eenheden. Zie: /azure/azure-subscription-service-limits#iot-hub-limits. | int |
naam | De naam van de SKU. | "B1" "B2" "B3" "F1" "S1" "S2" "S3" (vereist) |