Microsoft.Devices IotHubs
Definicja zasobu Bicep
Typ zasobu IotHubs można wdrożyć z operacjami docelowymi:
- Grupy zasobów — zobacz polecenia wdrażania grupy zasobów
Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennik zmian.
Format zasobu
Aby utworzyć zasób Microsoft.Devices/IotHubs, dodaj następujący kod Bicep do szablonu.
resource symbolicname 'Microsoft.Devices/IotHubs@2023-06-30' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
sku: {
capacity: int
name: 'string'
}
etag: 'string'
identity: {
type: 'string'
userAssignedIdentities: {
{customized property}: {}
}
}
properties: {
allowedFqdnList: [
'string'
]
authorizationPolicies: [
{
keyName: 'string'
primaryKey: 'string'
rights: 'string'
secondaryKey: 'string'
keyName: 'string'
primaryKey: 'string'
rights: 'string'
secondaryKey: 'string'
}
]
cloudToDevice: {
defaultTtlAsIso8601: 'string'
feedback: {
lockDurationAsIso8601: 'string'
maxDeliveryCount: int
ttlAsIso8601: 'string'
}
maxDeliveryCount: int
}
comments: 'string'
disableDeviceSAS: bool
disableLocalAuth: bool
disableModuleSAS: bool
enableDataResidency: bool
enableFileUploadNotifications: bool
eventHubEndpoints: {
{customized property}: {
partitionCount: int
retentionTimeInDays: int
}
}
features: 'string'
ipFilterRules: [
{
action: 'string'
filterName: 'string'
ipMask: 'string'
}
]
messagingEndpoints: {
{customized property}: {
lockDurationAsIso8601: 'string'
maxDeliveryCount: int
ttlAsIso8601: 'string'
}
}
minTlsVersion: 'string'
networkRuleSets: {
applyToBuiltInEventHubEndpoint: bool
defaultAction: 'string'
ipRules: [
{
action: 'Allow'
filterName: 'string'
ipMask: 'string'
}
]
}
privateEndpointConnections: [
{
properties: {
privateEndpoint: {}
privateLinkServiceConnectionState: {
actionsRequired: 'string'
description: 'string'
status: 'string'
}
}
}
]
publicNetworkAccess: 'string'
restrictOutboundNetworkAccess: bool
routing: {
endpoints: {
cosmosDBSqlContainers: [
{
authenticationType: 'string'
containerName: 'string'
databaseName: 'string'
endpointUri: 'string'
identity: {
userAssignedIdentity: 'string'
}
name: 'string'
partitionKeyName: 'string'
partitionKeyTemplate: 'string'
primaryKey: 'string'
resourceGroup: 'string'
secondaryKey: 'string'
subscriptionId: 'string'
}
]
eventHubs: [
{
authenticationType: 'string'
connectionString: 'string'
endpointUri: 'string'
entityPath: 'string'
id: 'string'
identity: {
userAssignedIdentity: 'string'
}
name: 'string'
resourceGroup: 'string'
subscriptionId: 'string'
}
]
serviceBusQueues: [
{
authenticationType: 'string'
connectionString: 'string'
endpointUri: 'string'
entityPath: 'string'
id: 'string'
identity: {
userAssignedIdentity: 'string'
}
name: 'string'
resourceGroup: 'string'
subscriptionId: 'string'
}
]
serviceBusTopics: [
{
authenticationType: 'string'
connectionString: 'string'
endpointUri: 'string'
entityPath: 'string'
id: 'string'
identity: {
userAssignedIdentity: 'string'
}
name: 'string'
resourceGroup: 'string'
subscriptionId: 'string'
}
]
storageContainers: [
{
authenticationType: 'string'
batchFrequencyInSeconds: int
connectionString: 'string'
containerName: 'string'
encoding: 'string'
endpointUri: 'string'
fileNameFormat: 'string'
id: 'string'
identity: {
userAssignedIdentity: 'string'
}
maxChunkSizeInBytes: int
name: 'string'
resourceGroup: 'string'
subscriptionId: 'string'
}
]
}
enrichments: [
{
endpointNames: [
'string'
]
key: 'string'
value: 'string'
}
]
fallbackRoute: {
condition: 'string'
endpointNames: [
'string'
]
isEnabled: bool
name: 'string'
source: 'string'
}
routes: [
{
condition: 'string'
endpointNames: [
'string'
]
isEnabled: bool
name: 'string'
source: 'string'
}
]
}
storageEndpoints: {
{customized property}: {
authenticationType: 'string'
connectionString: 'string'
containerName: 'string'
identity: {
userAssignedIdentity: 'string'
}
sasTtlAsIso8601: 'string'
}
}
}
}
Wartości właściwości
IotHubs
Nazwa | Opis | Wartość |
---|---|---|
name | Nazwa zasobu | ciąg (wymagany) Limit znaków: 3–50 Prawidłowe znaki: Alfanumeryczne i łączniki. Nie można zakończyć łącznikiem. Nazwa zasobu musi być unikatowa na platformie Azure. |
location | Lokalizacja zasobu. | ciąg (wymagany) |
tags | Tagi zasobów. | Słownik nazw tagów i wartości. Zobacz Tagi w szablonach |
sku | Informacje o jednostce SKU usługi IotHub | IotHubSkuInfo (wymagane) |
Etag | Pole Etag nie jest wymagane. Jeśli jest on podany w treści odpowiedzi, musi być również podany jako nagłówek zgodnie z normalną konwencją ETag. | ciąg |
identity | Tożsamości zarządzane dla usługi IotHub. | ArmIdentity |
properties | Właściwości usługi IotHub | IotHubProperties |
ArmIdentity
Nazwa | Opis | Wartość |
---|---|---|
typ | Typ tożsamości używanej dla zasobu. Typ "SystemAssigned, UserAssigned" zawiera zarówno niejawnie utworzoną tożsamość, jak i zestaw tożsamości przypisanych przez użytkownika. Typ "Brak" spowoduje usunięcie wszystkich tożsamości z usługi. | "Brak" "SystemAssigned" "SystemAssigned, UserAssigned" "UserAssigned" |
userAssignedIdentities | Słownik {ArmUserIdentity} | ArmIdentityUserAssignedIdentities |
ArmIdentityUserAssignedIdentities
Nazwa | Opis | Wartość |
---|---|---|
{niestandardowa właściwość} | ArmUserIdentity |
ArmUserIdentity
Ten obiekt nie zawiera żadnych właściwości do ustawienia podczas wdrażania. Wszystkie właściwości to ReadOnly.
IotHubProperties
Nazwa | Opis | Wartość |
---|---|---|
allowedFqdnList | Lista dozwolonych nazw FQDN (w pełni kwalifikowana nazwa domeny) dla ruchu wychodzącego z usługi IoT Hub. | ciąg[] |
authorizationPolicies | Zasady dostępu współdzielonego, których można użyć do zabezpieczenia połączenia z centrum IoT. | SharedAccessSignatureAuthorizationRule[] |
cloudToDevice | Właściwości obsługi komunikatów z chmury do urządzenia w usłudze IoT Hub. | CloudToDeviceProperties |
komentarze | Komentarze do centrum IoT Hub. | ciąg |
disableDeviceSAS | Jeśli to prawda, nie można używać wszystkich urządzeń (w tym urządzeń brzegowych, ale z wyłączeniem modułów) kluczy SAS w zakresie. | bool |
disableLocalAuth | Jeśli to prawda, tokeny SAS z kluczami sygnatur dostępu współdzielonego o zakresie usługi Iot Hub nie mogą być używane do uwierzytelniania. | bool |
disableModuleSAS | Jeśli ma wartość true, nie można użyć wszystkich kluczy sygnatury dostępu współdzielonego o zakresie modułu do uwierzytelniania. | bool |
enableDataResidency | Ta właściwość po ustawieniu wartości true włączy miejsce przechowywania danych, co spowoduje wyłączenie odzyskiwania po awarii. | bool |
enableFileUploadNotifications | Jeśli wartość True, powiadomienia o przekazaniu plików są włączone. | bool |
eventHubEndpoints | Właściwości punktu końcowego zgodnego z centrum zdarzeń. Jedynymi możliwymi kluczami do tego słownika są zdarzenia. Ten klucz musi być obecny w słowniku podczas tworzenia lub aktualizowania wywołań dla centrum IoT. | IotHubPropertiesEventHubEndpoints |
funkcje | Możliwości i funkcje włączone dla centrum IoT. | "DeviceManagement" "Brak" |
ipFilterRules | Reguły filtrowania adresów IP. | IpFilterRule[] |
messagingEndpoints | Właściwości punktu końcowego obsługi komunikatów dla kolejki powiadomień przekazywania pliku. | IotHubPropertiesMessagingEndpoints |
minTlsVersion | Określa minimalną wersję protokołu TLS do obsługi tego centrum. Można ustawić wartość "1.2", aby klienci korzystający z protokołu TLS w wersji poniżej 1.2 zostali odrzuconi. | ciąg |
networkRuleSets | Właściwości zestawu reguł sieciowych usługi IotHub | NetworkRuleSetProperties |
privateEndpointConnections | Połączenia prywatnego punktu końcowego utworzone w tej usłudze IotHub | PrivateEndpointConnection[] |
publicNetworkAccess | Czy żądania z sieci publicznej są dozwolone | "Wyłączone" "Włączone" |
restrictOutboundNetworkAccess | W przypadku wartości true ruch wychodzący z usługi IotHub będzie ograniczony tylko do dozwolonych nazw FQDN skonfigurowanych za pośrednictwem listy allowedFqdnList. | bool |
Routingu | Właściwości powiązane z routingiem centrum IoT. Zobacz: /azure/iot-hub/iot-hub-devguide-messaging | Właściwości routingu |
storageEndpoints | Lista punktów końcowych usługi Azure Storage, w których można przekazywać pliki. Obecnie można skonfigurować tylko jedno konto usługi Azure Storage i musi mieć swój klucz jako $default. Określenie więcej niż jednego konta magazynu powoduje wystąpienie błędu. Nie określając wartości dla tej właściwości, gdy właściwość enableFileUploadNotifications ma wartość True, powoduje wystąpienie błędu. | IotHubPropertiesStorageEndpoints |
SharedAccessSignatureAuthorizationRule
Nazwa | Opis | Wartość |
---|---|---|
keyName | Nazwa zasad dostępu współdzielonego. | ciąg (wymagany) |
primaryKey | Klucz podstawowy. | ciąg |
Prawa | Uprawnienia przypisane do zasad dostępu współdzielonego. | "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" (wymagane) |
secondaryKey | Klucz pomocniczy. | ciąg |
keyName | Nazwa zasad dostępu współdzielonego. | ciąg (wymagany) |
primaryKey | Klucz podstawowy. | ciąg |
Prawa | Uprawnienia przypisane do zasad dostępu współdzielonego. | "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" (wymagane) |
secondaryKey | Klucz pomocniczy. | ciąg |
CloudToDeviceProperties
Nazwa | Opis | Wartość |
---|---|---|
defaultTtlAsIso8601 | Domyślny czas wygaśnięcia komunikatów z chmury do urządzenia w kolejce urządzenia. Zobacz: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | ciąg |
Opinie | Właściwości kolejki opinii dla komunikatów z chmury do urządzenia. | OpinieWłaściwości |
maxDeliveryCount | Maksymalna liczba dostarczania komunikatów z chmury do urządzenia w kolejce urządzenia. Zobacz: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | int Ograniczenia: Minimalna wartość = 1 Maksymalna wartość = 100 |
OpinieWłaściwości
Nazwa | Opis | Wartość |
---|---|---|
lockDurationAsIso8601 | Czas trwania blokady kolejki opinii. Zobacz: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | ciąg |
maxDeliveryCount | Liczba prób dostarczenia komunikatu w kolejce opinii przez centrum IoT Hub. Zobacz: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | int Ograniczenia: Minimalna wartość = 1 Maksymalna wartość = 100 |
ttlAsIso8601 | Okres, przez który komunikat jest dostępny do użytku, zanim wygaśnie przez centrum IoT. Zobacz: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | ciąg |
IotHubPropertiesEventHubEndpoints
Nazwa | Opis | Wartość |
---|---|---|
{niestandardowa właściwość} | EventHubProperties |
EventHubProperties
Nazwa | Opis | Wartość |
---|---|---|
partitionCount | Liczba partycji do odbierania komunikatów z urządzenia do chmury w punkcie końcowym zgodnym z centrum zdarzeń. Zobacz: /azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages. | int |
retentionTimeInDays | Czas przechowywania komunikatów z urządzenia do chmury w dniach. Zobacz: /azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages | int |
IpFilterRule
Nazwa | Opis | Wartość |
---|---|---|
action | Żądana akcja żądań przechwyconych przez tę regułę. | "Akceptuj" "Odrzuć" (wymagane) |
Filtername | Nazwa reguły filtrowania adresów IP. | ciąg (wymagany) |
ipMask | Ciąg zawierający zakres adresów IP w notacji CIDR dla reguły. | ciąg (wymagany) |
IotHubPropertiesMessagingEndpoints
Nazwa | Opis | Wartość |
---|---|---|
{niestandardowa właściwość} | MessagingEndpointProperties |
MessagingEndpointProperties
Nazwa | Opis | Wartość |
---|---|---|
lockDurationAsIso8601 | Czas trwania blokady. Zobacz: /azure/iot-hub/iot-hub-devguide-file-upload. | ciąg |
maxDeliveryCount | Liczba prób dostarczenia komunikatu przez centrum IoT Hub. Zobacz: /azure/iot-hub/iot-hub-devguide-file-upload. | int Ograniczenia: Minimalna wartość = 1 Maksymalna wartość = 100 |
ttlAsIso8601 | Okres, przez który komunikat jest dostępny do użytku, zanim wygaśnie przez centrum IoT. Zobacz: /azure/iot-hub/iot-hub-devguide-file-upload. | ciąg |
NetworkRuleSetProperties
Nazwa | Opis | Wartość |
---|---|---|
applyToBuiltInEventHubEndpoint | Jeśli wartość True, zestaw reguł sieciowych jest również stosowany do aplikacji BuiltIn EventHub EndPoint of IotHub | bool (wymagane) |
defaultAction | Domyślna akcja dla zestawu reguł sieciowych | "Zezwalaj" "Odmów" |
ipRules | Lista reguł adresów IP | NetworkRuleSetIpRule[] (wymagane) |
NetworkRuleSetIpRule
Nazwa | Opis | Wartość |
---|---|---|
action | Akcja filtru IP | "Zezwalaj" |
Filtername | Nazwa reguły filtrowania adresów IP. | ciąg (wymagany) |
ipMask | Ciąg zawierający zakres adresów IP w notacji CIDR dla reguły. | ciąg (wymagany) |
PrivateEndpointConnection
Nazwa | Opis | Wartość |
---|---|---|
properties | Właściwości połączenia prywatnego punktu końcowego | PrivateEndpointConnectionProperties (wymagane) |
PrivateEndpointConnectionProperties
Nazwa | Opis | Wartość |
---|---|---|
privateEndpoint | Właściwość prywatnego punktu końcowego połączenia prywatnego punktu końcowego | PrivateEndpoint |
privateLinkServiceConnectionState | Bieżący stan połączenia prywatnego punktu końcowego | PrivateLinkServiceConnectionState (wymagane) |
PrivateEndpoint
Ten obiekt nie zawiera żadnych właściwości do ustawienia podczas wdrażania. Wszystkie właściwości to ReadOnly.
PrivateLinkServiceConnectionState
Nazwa | Opis | Wartość |
---|---|---|
actionsRequired | Akcje wymagane dla połączenia prywatnego punktu końcowego | ciąg |
description (opis) | Opis bieżącego stanu połączenia prywatnego punktu końcowego | ciąg (wymagany) |
status | Stan połączenia prywatnego punktu końcowego | "Zatwierdzone" "Rozłączone" "Oczekujące" "Odrzucono" (wymagane) |
Właściwości routingu
Nazwa | Opis | Wartość |
---|---|---|
Punkty końcowe | Właściwości związane z niestandardowymi punktami końcowymi, do których centrum IoT kieruje komunikaty na podstawie reguł routingu. Maksymalnie 10 niestandardowych punktów końcowych jest dozwolonych we wszystkich typach punktów końcowych dla płatnych centrów, a tylko 1 niestandardowy punkt końcowy jest dozwolony we wszystkich typach punktów końcowych dla bezpłatnych centrów. | Punkty routingu |
wzbogacenia | Lista wzbogacenia udostępnianych przez użytkownika, które centrum IoT ma zastosowanie do komunikatów dostarczanych do wbudowanych i niestandardowych punktów końcowych. Zobacz: https://aka.ms/telemetryoneventgrid |
WzbogacanieWłaściwości[] |
rezerwowaroute | Właściwości trasy, która jest używana jako trasa rezerwowa, gdy żaden z warunków określonych w sekcji "trasy" nie jest spełniony. Jest to opcjonalny parametr. Jeśli ta właściwość nie jest obecna w szablonie, trasa rezerwowa jest domyślnie wyłączona. | FallbackRouteProperties |
Trasy | Lista reguł routingu udostępnianych przez użytkownika używanych przez centrum IoT do kierowania komunikatów do wbudowanych i niestandardowych punktów końcowych. Dla płatnych centrów dozwolone jest maksymalnie 100 reguł routingu, a dla bezpłatnych centrów dozwolone jest maksymalnie 5 reguł routingu. | RouteProperties[] |
Punkty routingu
Nazwa | Opis | Wartość |
---|---|---|
cosmosDBSqlContainers | Lista punktów końcowych kontenera usługi Cosmos DB, do których usługa IoT Hub kieruje komunikaty na podstawie reguł routingu. | RoutingCosmosDBSqlApiProperties[] |
eventHubs | Lista punktów końcowych usługi Event Hubs, do których usługa IoT Hub kieruje komunikaty na podstawie reguł routingu. Ta lista nie zawiera wbudowanego punktu końcowego usługi Event Hubs. | RoutingEventHubProperties[] |
serviceBusQueues | Lista punktów końcowych kolejki usługi Service Bus, do których usługa IoT Hub kieruje komunikaty na podstawie reguł routingu. | RoutingServiceBusQueueEndpointProperties[] |
serviceBusTopics | Lista punktów końcowych tematu usługi Service Bus, do których centrum IoT kieruje komunikaty na podstawie reguł routingu. | RoutingServiceBusTopicEndpointProperties[] |
storageContainers | Lista punktów końcowych kontenera magazynu, do których usługa IoT Hub kieruje komunikaty na podstawie reguł routingu. | RoutingStorageContainerProperties[] |
RoutingCosmosDBSqlApiProperties
Nazwa | Opis | Wartość |
---|---|---|
authenticationType | Metoda używana do uwierzytelniania względem punktu końcowego kontenera SQL usługi Cosmos DB | "identityBased" "keyBased" |
containerName | Nazwa kontenera sql usługi Cosmos DB w bazie danych cosmos DB. | ciąg (wymagany) |
databaseName | Nazwa bazy danych cosmos DB na koncie usługi Cosmos DB. | ciąg (wymagany) |
endpointUri | Adres URL konta usługi Cosmos DB. Musi zawierać protokół https:// |
ciąg (wymagany) |
identity | Właściwości tożsamości zarządzanej dotyczące routingu punktu końcowego kontenera usługi Cosmos DB. | ManagedIdentity |
name | Nazwa identyfikująca ten punkt końcowy. Nazwa może zawierać tylko znaki alfanumeryczne, kropki, podkreślenia, łączniki i ma maksymalną długość 64 znaków. Następujące nazwy są zarezerwowane: zdarzenia, fileNotifications, $default. Nazwy punktów końcowych muszą być unikatowe w różnych typach punktów końcowych. | ciąg (wymagany) Ograniczenia: Wzorzec = ^[A-Za-z0-9-._]{1,64}$ |
partitionKeyName | Nazwa klucza partycji skojarzonego z tym kontenerem SQL usługi Cosmos DB, jeśli istnieje. Jest to opcjonalny parametr. | ciąg |
partitionKeyTemplate | Szablon do generowania syntetycznej wartości klucza partycji do użycia z tym kontenerem SQL usługi Cosmos DB. Szablon musi zawierać co najmniej jeden z następujących symboli zastępczych: {iothub}, {deviceid}, {DD}, {MM}i {RRRR}. Każdy symbol zastępczy może być określony co najwyżej raz, ale składniki kolejności i symboli zastępczych są dowolne. Ten parametr jest wymagany tylko wtedy, gdy określono parametr PartitionKeyName. | ciąg |
primaryKey | Klucz podstawowy konta usługi Cosmos DB. | ciąg Ograniczenia: Wartość wrażliwa. Przekaż jako bezpieczny parametr. |
resourceGroup | Nazwa grupy zasobów konta usługi Cosmos DB. | ciąg |
secondaryKey | Klucz pomocniczy konta usługi Cosmos DB. | ciąg Ograniczenia: Wartość wrażliwa. Przekaż jako bezpieczny parametr. |
subscriptionId | Identyfikator subskrypcji konta usługi Cosmos DB. | ciąg |
ManagedIdentity
Nazwa | Opis | Wartość |
---|---|---|
userAssignedIdentity | Tożsamość przypisana przez użytkownika. | ciąg |
RoutingEventHubProperties
Nazwa | Opis | Wartość |
---|---|---|
authenticationType | Metoda używana do uwierzytelniania względem punktu końcowego centrum zdarzeń | "identityBased" "keyBased" |
Parametry połączenia | Parametry połączenia punktu końcowego centrum zdarzeń. | ciąg |
endpointUri | Adres URL punktu końcowego centrum zdarzeń. Musi zawierać sb:// protokołu | ciąg |
entityPath | Nazwa centrum zdarzeń w przestrzeni nazw centrum zdarzeń | ciąg |
identyfikator | Identyfikator punktu końcowego centrum zdarzeń | ciąg |
identity | Właściwości tożsamości zarządzanej punktu końcowego centrum zdarzeń. | ManagedIdentity |
name | Nazwa identyfikująca ten punkt końcowy. Nazwa może zawierać tylko znaki alfanumeryczne, kropki, podkreślenia, łączniki i ma maksymalną długość 64 znaków. Następujące nazwy są zarezerwowane: zdarzenia, fileNotifications, $default. Nazwy punktów końcowych muszą być unikatowe w różnych typach punktów końcowych. | ciąg (wymagany) Ograniczenia: Wzorzec = ^[A-Za-z0-9-._]{1,64}$ |
resourceGroup | Nazwa grupy zasobów punktu końcowego centrum zdarzeń. | ciąg |
subscriptionId | Identyfikator subskrypcji punktu końcowego centrum zdarzeń. | ciąg |
RoutingServiceBusQueueEndpointProperties
Nazwa | Opis | Wartość |
---|---|---|
authenticationType | Metoda używana do uwierzytelniania względem punktu końcowego kolejki usługi Service Bus | "identityBased" "keyBased" |
Parametry połączenia | Parametry połączenia punktu końcowego kolejki usługi Service Bus. | ciąg |
endpointUri | Adres URL punktu końcowego kolejki usługi Service Bus. Musi zawierać sb:// protokołu | ciąg |
entityPath | Nazwa kolejki w przestrzeni nazw usługi Service Bus | ciąg |
identyfikator | Identyfikator punktu końcowego kolejki usługi Service Bus | ciąg |
identity | Właściwości tożsamości zarządzanej punktu końcowego kolejki usługi Service Bus. | ManagedIdentity |
name | Nazwa identyfikująca ten punkt końcowy. Nazwa może zawierać tylko znaki alfanumeryczne, kropki, podkreślenia, łączniki i ma maksymalną długość 64 znaków. Następujące nazwy są zarezerwowane: zdarzenia, fileNotifications, $default. Nazwy punktów końcowych muszą być unikatowe w różnych typach punktów końcowych. Nazwa nie musi być taka sama jak rzeczywista nazwa kolejki. | ciąg (wymagany) Ograniczenia: Wzorzec = ^[A-Za-z0-9-._]{1,64}$ |
resourceGroup | Nazwa grupy zasobów punktu końcowego kolejki usługi Service Bus. | ciąg |
subscriptionId | Identyfikator subskrypcji punktu końcowego kolejki usługi Service Bus. | ciąg |
Właściwości routinguServiceBusTopicEndpointProperties
Nazwa | Opis | Wartość |
---|---|---|
authenticationType | Metoda używana do uwierzytelniania względem punktu końcowego tematu usługi Service Bus | "identityBased" "keyBased" |
Parametry połączenia | Parametry połączenia punktu końcowego tematu usługi Service Bus. | ciąg |
endpointUri | Adres URL punktu końcowego tematu usługi Service Bus. Musi zawierać sb:// protokołu | ciąg |
entityPath | Nazwa kolejki w temacie usługi Service Bus | ciąg |
identyfikator | Identyfikator punktu końcowego tematu usługi Service Bus | ciąg |
identity | Właściwości tożsamości zarządzanej punktu końcowego tematu usługi Service Bus. | ManagedIdentity |
name | Nazwa identyfikująca ten punkt końcowy. Nazwa może zawierać tylko znaki alfanumeryczne, kropki, podkreślenia, łączniki i ma maksymalną długość 64 znaków. Następujące nazwy są zarezerwowane: zdarzenia, fileNotifications, $default. Nazwy punktów końcowych muszą być unikatowe w różnych typach punktów końcowych. Nazwa nie musi być taka sama jak rzeczywista nazwa tematu. | ciąg (wymagany) Ograniczenia: Wzorzec = ^[A-Za-z0-9-._]{1,64}$ |
resourceGroup | Nazwa grupy zasobów punktu końcowego tematu usługi Service Bus. | ciąg |
subscriptionId | Identyfikator subskrypcji punktu końcowego tematu usługi Service Bus. | ciąg |
RoutingStorageContainerProperties
Nazwa | Opis | Wartość |
---|---|---|
authenticationType | Metoda używana do uwierzytelniania w punkcie końcowym magazynu | "identityBased" "keyBased" |
batchFrequencyInSeconds | Przedział czasu, w którym obiekty blob są zapisywane w magazynie. Wartość powinna należeć do przedziału od 60 do 720 sekund. Wartość domyślna to 300 sekund. | int Ograniczenia: Minimalna wartość = 60 Maksymalna wartość = 720 |
Parametry połączenia | Parametry połączenia konta magazynu. | ciąg |
containerName | Nazwa kontenera magazynu na koncie magazynu. | ciąg (wymagany) |
encoding | Kodowanie używane do serializacji komunikatów do obiektów blob. Obsługiwane wartości to "avro", "avrodeflate" i "JSON". Wartość domyślna to "avro". | "Avro" "AvroDeflate" "JSON" |
endpointUri | Adres URL punktu końcowego magazynu. Musi zawierać protokół https:// |
ciąg |
fileNameFormat | Format nazwy pliku dla obiektu blob. Domyślny format to {iothub}/{partition}/{RRRR}/{MM}/{DD}/{HH}/{mm}.{mm}. Wszystkie parametry są obowiązkowe, ale można zmienić kolejność. | ciąg |
identyfikator | Identyfikator punktu końcowego kontenera magazynu | ciąg |
identity | Właściwości tożsamości zarządzanej punktu końcowego magazynu routingu. | ManagedIdentity |
maxChunkSizeInBytes | Maksymalna liczba bajtów dla każdego obiektu blob zapisanego w magazynie. Wartość powinna należeć do 10485760 (10 MB) i 524288000(500 MB). Wartość domyślna to 314572800 (300 MB). | int Ograniczenia: Minimalna wartość = 10485760 Maksymalna wartość = 524288000 |
name | Nazwa identyfikująca ten punkt końcowy. Nazwa może zawierać tylko znaki alfanumeryczne, kropki, podkreślenia, łączniki i ma maksymalną długość 64 znaków. Następujące nazwy są zarezerwowane: zdarzenia, fileNotifications, $default. Nazwy punktów końcowych muszą być unikatowe w różnych typach punktów końcowych. | ciąg (wymagany) Ograniczenia: Wzorzec = ^[A-Za-z0-9-._]{1,64}$ |
resourceGroup | Nazwa grupy zasobów konta magazynu. | ciąg |
subscriptionId | Identyfikator subskrypcji konta magazynu. | ciąg |
WzbogacanieWłaściwości
Nazwa | Opis | Wartość |
---|---|---|
endpointNames | Lista punktów końcowych, dla których wzbogacenie jest stosowane do komunikatu. | string[] (wymagane) Ograniczenia: Minimalna długość = 1 |
key | Klucz lub nazwa właściwości wzbogacania. | ciąg (wymagany) |
wartość | Wartość właściwości wzbogacania. | ciąg (wymagany) |
FallbackRouteProperties
Nazwa | Opis | Wartość |
---|---|---|
Warunek | Warunek, który jest oceniany w celu zastosowania trasy powrotu. Jeśli warunek nie zostanie podany, zostanie on obliczony domyślnie na wartość true. W przypadku gramatyki zobacz: /azure/iot-hub/iot-hub-devguide-query-language | ciąg |
endpointNames | Lista punktów końcowych, do których są kierowane komunikaty spełniające warunek. Obecnie dozwolony jest tylko 1 punkt końcowy. | string[] (wymagane) Ograniczenia: Minimalna długość = 1 Maksymalna długość = 1 |
Isenabled | Służy do określania, czy trasa rezerwowa jest włączona. | bool (wymagane) |
name | Nazwa trasy. Nazwa może zawierać tylko znaki alfanumeryczne, kropki, podkreślenia, łączniki, ma maksymalną długość 64 znaków i musi być unikatowa. | ciąg |
source | Źródło, do którego ma zostać zastosowana reguła routingu. Na przykład DeviceMessages | "DeviceConnectionStateEvents" "DeviceJobLifecycleEvents" "DeviceLifecycleEvents" "DeviceMessages" "Nieprawidłowy" "TwinChangeEvents" (wymagane) |
RouteProperties
Nazwa | Opis | Wartość |
---|---|---|
Warunek | Warunek, który jest oceniany w celu zastosowania reguły rozsyłania. Jeśli warunek nie zostanie podany, zostanie obliczona wartość true domyślnie. Aby uzyskać informacje na temat gramatyki, zobacz: /azure/iot-hub/iot-hub-devguide-query-language | ciąg |
endpointNames | Lista punktów końcowych, do których są kierowane komunikaty spełniające warunek. Obecnie dozwolony jest tylko jeden punkt końcowy. | string[] (wymagane) Ograniczenia: Minimalna długość = 1 Maksymalna długość = 1 |
Isenabled | Służy do określania, czy trasa jest włączona. | bool (wymagane) |
name | Nazwa trasy. Nazwa może zawierać tylko znaki alfanumeryczne, kropki, podkreślenia, łączniki, ma maksymalną długość 64 znaków i musi być unikatowa. | ciąg (wymagany) Ograniczenia: Wzorzec = ^[A-Za-z0-9-._]{1,64}$ |
source | Źródło, do którego ma zostać zastosowana reguła routingu, na przykład DeviceMessages. | "DeviceConnectionStateEvents" "DeviceJobLifecycleEvents" "DeviceLifecycleEvents" "DeviceMessages" "Nieprawidłowy" "TwinChangeEvents" (wymagane) |
IotHubPropertiesStorageEndpoints
Nazwa | Opis | Wartość |
---|---|---|
{niestandardowa właściwość} | Właściwości punktu końcowego magazynu |
Właściwości punktu końcowego magazynu
Nazwa | Opis | Wartość |
---|---|---|
authenticationType | Określa typ uwierzytelniania używany do nawiązywania połączenia z kontem magazynu. | "identityBased" "keyBased" |
Parametry połączenia | Parametry połączenia dla konta usługi Azure Storage, do którego są przekazywane pliki. | ciąg (wymagany) |
containerName | Nazwa kontenera głównego, w którym są przekazywane pliki. Kontener nie musi istnieć, ale powinien być creatable przy użyciu określonego parametru connectionString. | ciąg (wymagany) |
identity | Właściwości tożsamości zarządzanej punktu końcowego magazynu na potrzeby przekazywania plików. | ManagedIdentity |
sasTtlAsIso8601 | Okres, dla którego identyfikator URI sygnatury dostępu współdzielonego wygenerowany przez IoT Hub przekazywania plików jest prawidłowy. Zobacz: /azure/iot-hub/iot-hub-devguide-file-upload#file-upload-notification-configuration-options. | ciąg |
IotHubSkuInfo
Nazwa | Opis | Wartość |
---|---|---|
capacity | Liczba aprowizowania jednostek IoT Hub. Zobacz: /azure/azure-subscription-service-limits#iot-hub-limits. | int |
name | Nazwa jednostki SKU. | "B1" "B2" "B3" "F1" "S1" "S2" "S3" (wymagane) |
Szablony szybkiego startu
Następujące szablony szybkiego startu wdrażają ten typ zasobu.
Template | Opis |
---|---|
Tworzenie symulatora usługi IOT Hub i ubuntu edge |
Ten szablon tworzy symulator usługi IOT Hub i maszyny wirtualnej Ubuntu edge. |
Tworzenie komunikatów IoT Hub, kierowanie i wyświetlanie komunikatów za pomocą szablonu usługi ARM |
Użyj tego szablonu, aby wdrożyć IoT Hub i konto magazynu. Uruchom aplikację, aby wysyłać komunikaty do centrum, które są kierowane do magazynu, a następnie wyświetlić wyniki. |
Tworzenie usługi IoT Hub Device Provisioning |
Ten szablon umożliwia utworzenie centrum IoT i usługi IoT Hub Device Provisioning Service oraz połączenie tych dwóch usług. |
Tworzenie IoT Hub i grupy odbiorców urządzenia do chmury |
Ten szablon umożliwia wdrożenie wystąpienia IoT Hub z urządzeniem w chmurze i w chmurze w konfiguracjach obsługi komunikatów urządzeń oraz urządzenia w grupie odbiorców w chmurze. |
Tworzenie aktualizacji urządzenia dla konta IoT Hub, wystąpienia, IoT Hub |
Ten szablon tworzy konto oraz wystąpienie i centrum w celu połączenia wystąpienia z. Konfiguruje centrum z niezbędnymi zasadami dostępu, trasami i grupą konsumentów. |
Wdrażanie usługi MedTech, w tym Azure IoT Hub |
Usługa MedTech jest jedną z usług Azure Health Data Services zaprojektowanych do pozyskiwania danych urządzeń z wielu urządzeń, przekształcania danych urządzenia w obserwacje FHIR, które są następnie utrwalane w usłudze FHIR usług Azure Health Data Services. |
Tworzenie środowiska płatności zgodnie z rzeczywistym użyciem (PAYG) za pomocą IoT Hub |
Ten szablon umożliwia wdrożenie środowiska usługi Time Series Insights z płatnością zgodnie z rzeczywistym użyciem (PAYG), które jest skonfigurowane do korzystania z zdarzeń z IoT Hub. |
Definicja zasobu szablonu usługi ARM
Typ zasobu IotHubs można wdrożyć przy użyciu operacji docelowych:
- Grupy zasobów — zobacz polecenia wdrażania grupy zasobów
Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennik zmian.
Format zasobu
Aby utworzyć zasób Microsoft.Devices/IotHubs, dodaj następujący kod JSON do szablonu.
{
"type": "Microsoft.Devices/IotHubs",
"apiVersion": "2023-06-30",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"sku": {
"capacity": "int",
"name": "string"
},
"etag": "string",
"identity": {
"type": "string",
"userAssignedIdentities": {
"{customized property}": {}
}
},
"properties": {
"allowedFqdnList": [ "string" ],
"authorizationPolicies": [
{
"keyName": "string",
"primaryKey": "string",
"rights": "string",
"secondaryKey": "string",
"keyName": "string",
"primaryKey": "string",
"rights": "string",
"secondaryKey": "string"
}
],
"cloudToDevice": {
"defaultTtlAsIso8601": "string",
"feedback": {
"lockDurationAsIso8601": "string",
"maxDeliveryCount": "int",
"ttlAsIso8601": "string"
},
"maxDeliveryCount": "int"
},
"comments": "string",
"disableDeviceSAS": "bool",
"disableLocalAuth": "bool",
"disableModuleSAS": "bool",
"enableDataResidency": "bool",
"enableFileUploadNotifications": "bool",
"eventHubEndpoints": {
"{customized property}": {
"partitionCount": "int",
"retentionTimeInDays": "int"
}
},
"features": "string",
"ipFilterRules": [
{
"action": "string",
"filterName": "string",
"ipMask": "string"
}
],
"messagingEndpoints": {
"{customized property}": {
"lockDurationAsIso8601": "string",
"maxDeliveryCount": "int",
"ttlAsIso8601": "string"
}
},
"minTlsVersion": "string",
"networkRuleSets": {
"applyToBuiltInEventHubEndpoint": "bool",
"defaultAction": "string",
"ipRules": [
{
"action": "Allow",
"filterName": "string",
"ipMask": "string"
}
]
},
"privateEndpointConnections": [
{
"properties": {
"privateEndpoint": {},
"privateLinkServiceConnectionState": {
"actionsRequired": "string",
"description": "string",
"status": "string"
}
}
}
],
"publicNetworkAccess": "string",
"restrictOutboundNetworkAccess": "bool",
"routing": {
"endpoints": {
"cosmosDBSqlContainers": [
{
"authenticationType": "string",
"containerName": "string",
"databaseName": "string",
"endpointUri": "string",
"identity": {
"userAssignedIdentity": "string"
},
"name": "string",
"partitionKeyName": "string",
"partitionKeyTemplate": "string",
"primaryKey": "string",
"resourceGroup": "string",
"secondaryKey": "string",
"subscriptionId": "string"
}
],
"eventHubs": [
{
"authenticationType": "string",
"connectionString": "string",
"endpointUri": "string",
"entityPath": "string",
"id": "string",
"identity": {
"userAssignedIdentity": "string"
},
"name": "string",
"resourceGroup": "string",
"subscriptionId": "string"
}
],
"serviceBusQueues": [
{
"authenticationType": "string",
"connectionString": "string",
"endpointUri": "string",
"entityPath": "string",
"id": "string",
"identity": {
"userAssignedIdentity": "string"
},
"name": "string",
"resourceGroup": "string",
"subscriptionId": "string"
}
],
"serviceBusTopics": [
{
"authenticationType": "string",
"connectionString": "string",
"endpointUri": "string",
"entityPath": "string",
"id": "string",
"identity": {
"userAssignedIdentity": "string"
},
"name": "string",
"resourceGroup": "string",
"subscriptionId": "string"
}
],
"storageContainers": [
{
"authenticationType": "string",
"batchFrequencyInSeconds": "int",
"connectionString": "string",
"containerName": "string",
"encoding": "string",
"endpointUri": "string",
"fileNameFormat": "string",
"id": "string",
"identity": {
"userAssignedIdentity": "string"
},
"maxChunkSizeInBytes": "int",
"name": "string",
"resourceGroup": "string",
"subscriptionId": "string"
}
]
},
"enrichments": [
{
"endpointNames": [ "string" ],
"key": "string",
"value": "string"
}
],
"fallbackRoute": {
"condition": "string",
"endpointNames": [ "string" ],
"isEnabled": "bool",
"name": "string",
"source": "string"
},
"routes": [
{
"condition": "string",
"endpointNames": [ "string" ],
"isEnabled": "bool",
"name": "string",
"source": "string"
}
]
},
"storageEndpoints": {
"{customized property}": {
"authenticationType": "string",
"connectionString": "string",
"containerName": "string",
"identity": {
"userAssignedIdentity": "string"
},
"sasTtlAsIso8601": "string"
}
}
}
}
Wartości właściwości
IotHubs
Nazwa | Opis | Wartość |
---|---|---|
typ | Typ zasobu | "Microsoft.Devices/IotHubs" |
apiVersion | Wersja interfejsu API zasobów | '2023-06-30' |
name | Nazwa zasobu | ciąg (wymagany) Limit znaków: 3–50 Prawidłowe znaki: Alfanumeryczne i łączniki. Nie można zakończyć łącznikiem. Nazwa zasobu musi być unikatowa na platformie Azure. |
location | Lokalizacja zasobu. | ciąg (wymagany) |
tags | Tagi zasobów. | Słownik nazw tagów i wartości. Zobacz Tagi w szablonach |
sku | Informacje o jednostce SKU usługi IotHub | IotHubSkuInfo (wymagane) |
Etag | Pole Etag nie jest wymagane. Jeśli jest on podany w treści odpowiedzi, musi być również podany jako nagłówek zgodnie z normalną konwencją ETag. | ciąg |
identity | Tożsamości zarządzane dla usługi IotHub. | Identyfikator armidentity |
properties | Właściwości usługi IotHub | IotHubProperties |
Identyfikator armidentity
Nazwa | Opis | Wartość |
---|---|---|
typ | Typ tożsamości używanej dla zasobu. Typ "SystemAssigned, UserAssigned" zawiera zarówno niejawnie utworzoną tożsamość, jak i zestaw tożsamości przypisanych przez użytkownika. Typ "None" spowoduje usunięcie tożsamości z usługi. | "Brak" "SystemAssigned" "SystemAssigned, UserAssigned" "UserAssigned" |
userAssignedIdentities | Słownik {ArmUserIdentity} | ArmIdentityUserAssignedIdentities |
ArmIdentityUserAssignedIdentities
Nazwa | Opis | Wartość |
---|---|---|
{niestandardowa właściwość} | ArmUserIdentity |
ArmUserIdentity
Ten obiekt nie zawiera żadnych właściwości do ustawienia podczas wdrażania. Wszystkie właściwości to ReadOnly.
IotHubProperties
Nazwa | Opis | Wartość |
---|---|---|
allowedFqdnList | Lista dozwolonych nazw FQDN (w pełni kwalifikowana nazwa domeny) dla ruchu wychodzącego z usługi Iot Hub. | ciąg[] |
authorizationPolicies | Zasady dostępu współdzielonego, których można użyć do zabezpieczenia połączenia z centrum IoT. | SharedAccessSignatureAuthorizationRule[] |
cloudToDevice | Właściwości komunikatów z chmury do urządzenia w usłudze IoT Hub. | CloudToDeviceProperties |
komentarze | Komentarze centrum IoT Hub. | ciąg |
disableDeviceSAS | Jeśli ma wartość true, nie można używać wszystkich urządzeń (w tym urządzeń brzegowych, ale z wyłączeniem modułów) kluczy sas o określonym zakresie. | bool |
disableLocalAuth | Jeśli jest to prawda, tokeny SAS z kluczami sygnatury dostępu współdzielonego o zakresie Iot hub nie mogą być używane do uwierzytelniania. | bool |
disableModuleSAS | Jeśli ma wartość true, nie można użyć wszystkich kluczy sygnatury dostępu współdzielonego o zakresie modułu do uwierzytelniania. | bool |
enableDataResidency | Ta właściwość po ustawieniu wartości true włączy miejsce przechowywania danych, co spowoduje wyłączenie odzyskiwania po awarii. | bool |
enableFileUploadNotifications | Jeśli wartość True, powiadomienia dotyczące przekazywania plików są włączone. | bool |
eventHubEndpoints | Właściwości punktu końcowego zgodnego z centrum zdarzeń. Jedynymi możliwymi kluczami do tego słownika są zdarzenia. Ten klucz musi być obecny w słowniku podczas tworzenia lub aktualizowania wywołań dla centrum IoT. | IotHubPropertiesEventHubEndpoints |
funkcje | Możliwości i funkcje włączone dla centrum IoT. | "DeviceManagement" "Brak" |
ipFilterRules | Reguły filtrowania adresów IP. | IpFilterRule[] |
messagingEndpoints | Właściwości punktu końcowego obsługi komunikatów dla kolejki powiadomień przekazywania plików. | IotHubPropertiesMessagingEndpoints |
minTlsVersion | Określa minimalną wersję protokołu TLS do obsługi dla tego centrum. Można ustawić wartość "1.2", aby klienci korzystający z protokołu TLS w wersji starszej niż 1.2 zostali odrzuceni. | ciąg |
networkRuleSets | Właściwości zestawu reguł sieciowych usługi IotHub | NetworkRuleSetProperties |
privateEndpointConnections | Połączenia prywatnego punktu końcowego utworzone w tej usłudze IotHub | PrivateEndpointConnection[] |
publicNetworkAccess | Czy żądania z sieci publicznej są dozwolone | "Wyłączone" "Włączone" |
restrictOutboundNetworkAccess | W przypadku wartości true ruch wychodzący z usługi IotHub będzie ograniczony tylko do dozwolonych nazw FQDN skonfigurowanych za pośrednictwem listy allowedFqdnList. | bool |
Routingu | Właściwości powiązane z routingiem centrum IoT. Zobacz: /azure/iot-hub/iot-hub-devguide-messaging | Właściwości routingu |
storageEndpoints | Lista punktów końcowych usługi Azure Storage, w których można przekazywać pliki. Obecnie można skonfigurować tylko jedno konto usługi Azure Storage i musi mieć jego klucz jako $default. Określenie więcej niż jednego konta magazynu powoduje zgłoszenie błędu. Nie określono wartości dla tej właściwości, gdy właściwość enableFileUploadNotifications jest ustawiona na wartość True, powoduje zgłoszenie błędu. | IotHubPropertiesStorageEndpoints |
SharedAccessSignatureAuthorizationRule
Nazwa | Opis | Wartość |
---|---|---|
keyName | Nazwa zasad dostępu współdzielonego. | ciąg (wymagany) |
primaryKey | Klucz podstawowy. | ciąg |
Prawa | Uprawnienia przypisane do zasad dostępu współdzielonego. | "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" (wymagane) |
secondaryKey | Klucz pomocniczy. | ciąg |
keyName | Nazwa zasad dostępu współdzielonego. | ciąg (wymagany) |
primaryKey | Klucz podstawowy. | ciąg |
Prawa | Uprawnienia przypisane do zasad dostępu współdzielonego. | "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" (wymagane) |
secondaryKey | Klucz pomocniczy. | ciąg |
CloudToDeviceProperties
Nazwa | Opis | Wartość |
---|---|---|
defaultTtlAsIso8601 | Domyślny czas wygaśnięcia komunikatów z chmury do urządzenia w kolejce urządzenia. Zobacz: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | ciąg |
Opinie | Właściwości kolejki opinii dla komunikatów z chmury do urządzenia. | OpinieWłaściwości |
maxDeliveryCount | Maksymalna liczba dostarczania komunikatów z chmury do urządzenia w kolejce urządzenia. Zobacz: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | int Ograniczenia: Minimalna wartość = 1 Maksymalna wartość = 100 |
OpinieWłaściwości
Nazwa | Opis | Wartość |
---|---|---|
lockDurationAsIso8601 | Czas trwania blokady kolejki opinii. Zobacz: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | ciąg |
maxDeliveryCount | Liczba prób dostarczenia komunikatu w kolejce opinii przez centrum IoT Hub. Zobacz: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | int Ograniczenia: Minimalna wartość = 1 Maksymalna wartość = 100 |
ttlAsIso8601 | Okres, przez który komunikat jest dostępny do użytku, zanim wygaśnie przez centrum IoT. Zobacz: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | ciąg |
IotHubPropertiesEventHubEndpoints
Nazwa | Opis | Wartość |
---|---|---|
{niestandardowa właściwość} | EventHubProperties |
EventHubProperties
Nazwa | Opis | Wartość |
---|---|---|
partitionCount | Liczba partycji do odbierania komunikatów z urządzenia do chmury w punkcie końcowym zgodnym z centrum zdarzeń. Zobacz: /azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages. | int |
retentionTimeInDays | Czas przechowywania komunikatów z urządzenia do chmury w dniach. Zobacz: /azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages | int |
IpFilterRule
Nazwa | Opis | Wartość |
---|---|---|
action | Żądana akcja żądań przechwyconych przez tę regułę. | "Akceptuj" "Odrzuć" (wymagane) |
Filtername | Nazwa reguły filtrowania adresów IP. | ciąg (wymagany) |
ipMask | Ciąg zawierający zakres adresów IP w notacji CIDR dla reguły. | ciąg (wymagany) |
IotHubPropertiesMessagingEndpoints
Nazwa | Opis | Wartość |
---|---|---|
{niestandardowa właściwość} | MessagingEndpointProperties |
MessagingEndpointProperties
Nazwa | Opis | Wartość |
---|---|---|
lockDurationAsIso8601 | Czas trwania blokady. Zobacz: /azure/iot-hub/iot-hub-devguide-file-upload. | ciąg |
maxDeliveryCount | Liczba prób dostarczenia komunikatu przez centrum IoT Hub. Zobacz: /azure/iot-hub/iot-hub-devguide-file-upload. | int Ograniczenia: Minimalna wartość = 1 Maksymalna wartość = 100 |
ttlAsIso8601 | Okres, przez który komunikat jest dostępny do użytku, zanim wygaśnie przez centrum IoT. Zobacz: /azure/iot-hub/iot-hub-devguide-file-upload. | ciąg |
NetworkRuleSetProperties
Nazwa | Opis | Wartość |
---|---|---|
applyToBuiltInEventHubEndpoint | Jeśli wartość True, zestaw reguł sieci jest również stosowany do aplikacji BuiltIn EventHub EndPoint of IotHub | bool (wymagane) |
defaultAction | Domyślna akcja dla zestawu reguł sieci | "Zezwalaj" "Odmów" |
adresy IPRules | Lista reguł adresów IP | NetworkRuleSetIpRule[] (wymagane) |
NetworkRuleSetIpRule
Nazwa | Opis | Wartość |
---|---|---|
action | Akcja filtru IP | "Zezwalaj" |
Filtername | Nazwa reguły filtru adresów IP. | ciąg (wymagany) |
ipMask | Ciąg zawierający zakres adresów IP w notacji CIDR dla reguły. | ciąg (wymagany) |
PrivateEndpointConnection
Nazwa | Opis | Wartość |
---|---|---|
properties | Właściwości połączenia prywatnego punktu końcowego | PrivateEndpointConnectionProperties (wymagane) |
PrivateEndpointConnectionProperties
Nazwa | Opis | Wartość |
---|---|---|
privateEndpoint | Właściwość prywatnego punktu końcowego połączenia prywatnego punktu końcowego | PrivateEndpoint |
privateLinkServiceConnectionState | Bieżący stan połączenia prywatnego punktu końcowego | PrivateLinkServiceConnectionState (wymagane) |
PrivateEndpoint
Ten obiekt nie zawiera żadnych właściwości do ustawienia podczas wdrażania. Wszystkie właściwości to ReadOnly.
PrivateLinkServiceConnectionState
Nazwa | Opis | Wartość |
---|---|---|
actionsRequired | Akcje wymagane dla połączenia prywatnego punktu końcowego | ciąg |
description (opis) | Opis bieżącego stanu połączenia prywatnego punktu końcowego | ciąg (wymagany) |
status | Stan połączenia prywatnego punktu końcowego | "Zatwierdzone" "Rozłączono" "Oczekujące" "Odrzucono" (wymagane) |
Właściwości routingu
Nazwa | Opis | Wartość |
---|---|---|
Punkty końcowe | Właściwości związane z niestandardowymi punktami końcowymi, do których centrum IoT kieruje komunikaty na podstawie reguł routingu. Maksymalnie 10 niestandardowych punktów końcowych jest dozwolonych we wszystkich typach punktów końcowych dla płatnych centrów, a tylko 1 niestandardowy punkt końcowy jest dozwolony we wszystkich typach punktów końcowych dla bezpłatnych centrów. | Punkty końcowe routingu |
wzbogacania | Lista wzbogaceń dostarczonych przez użytkownika, które centrum IoT ma zastosowanie do komunikatów dostarczanych do wbudowanych i niestandardowych punktów końcowych. Zobacz: https://aka.ms/telemetryoneventgrid |
WzbogacanieWłaściwości[] |
rezerwowa usługaRoute | Właściwości trasy, która jest używana jako trasa powrotna, gdy żaden z warunków określonych w sekcji "routes" nie jest spełniony. Jest to opcjonalny parametr. Jeśli ta właściwość nie jest obecna w szablonie, trasa rezerwowa jest domyślnie wyłączona. | FallbackRouteProperties |
Trasy | Lista reguł routingu udostępnianych przez użytkownika, których usługa IoT Hub używa do kierowania komunikatów do wbudowanych i niestandardowych punktów końcowych. Dla płatnych koncentratorów dozwolonych jest maksymalnie 100 reguł routingu, a w przypadku bezpłatnych koncentratorów dozwolonych jest maksymalnie 5 reguł routingu. | RouteProperties[] |
Punkty końcowe routingu
Nazwa | Opis | Wartość |
---|---|---|
cosmosDBSqlContainers | Lista punktów końcowych kontenera usługi Cosmos DB, do których usługa IoT Hub kieruje komunikaty na podstawie reguł routingu. | RoutingCosmosDBSqlApiProperties[] |
eventHubs | Lista punktów końcowych usługi Event Hubs, do których usługa IoT Hub kieruje komunikaty na podstawie reguł routingu. Ta lista nie zawiera wbudowanego punktu końcowego usługi Event Hubs. | RoutingEventHubProperties[] |
serviceBusQueues | Lista punktów końcowych kolejki usługi Service Bus, do których usługa IoT Hub kieruje komunikaty na podstawie reguł routingu. | RoutingServiceBusQueueEndpointProperties[] |
serviceBusTopics | Lista punktów końcowych tematu usługi Service Bus, do których centrum IoT kieruje komunikaty na podstawie reguł routingu. | RoutingServiceBusTopicEndpointProperties[] |
storageContainers | Lista punktów końcowych kontenera magazynu, do których usługa IoT Hub kieruje komunikaty na podstawie reguł routingu. | RoutingStorageContainerProperties[] |
RoutingCosmosDBSqlApiProperties
Nazwa | Opis | Wartość |
---|---|---|
authenticationType | Metoda używana do uwierzytelniania względem punktu końcowego kontenera SQL usługi Cosmos DB | "identityBased" "keyBased" |
containerName | Nazwa kontenera sql usługi Cosmos DB w bazie danych cosmos DB. | ciąg (wymagany) |
databaseName | Nazwa bazy danych cosmos DB na koncie usługi Cosmos DB. | ciąg (wymagany) |
endpointUri | Adres URL konta usługi Cosmos DB. Musi zawierać protokół https:// |
ciąg (wymagany) |
identity | Właściwości tożsamości zarządzanej dotyczące routingu punktu końcowego kontenera usługi Cosmos DB. | ManagedIdentity |
name | Nazwa identyfikująca ten punkt końcowy. Nazwa może zawierać tylko znaki alfanumeryczne, kropki, podkreślenia, łączniki i ma maksymalną długość 64 znaków. Następujące nazwy są zarezerwowane: zdarzenia, fileNotifications, $default. Nazwy punktów końcowych muszą być unikatowe w różnych typach punktów końcowych. | ciąg (wymagany) Ograniczenia: Wzorzec = ^[A-Za-z0-9-._]{1,64}$ |
partitionKeyName | Nazwa klucza partycji skojarzonego z tym kontenerem SQL usługi Cosmos DB, jeśli istnieje. Jest to opcjonalny parametr. | ciąg |
partitionKeyTemplate | Szablon do generowania syntetycznej wartości klucza partycji do użycia z tym kontenerem SQL usługi Cosmos DB. Szablon musi zawierać co najmniej jeden z następujących symboli zastępczych: {iothub}, {deviceid}, {DD}, {MM}i {RRRR}. Każdy symbol zastępczy może być określony co najwyżej raz, ale składniki kolejności i symboli zastępczych są dowolne. Ten parametr jest wymagany tylko wtedy, gdy określono parametr PartitionKeyName. | ciąg |
primaryKey | Klucz podstawowy konta usługi Cosmos DB. | ciąg Ograniczenia: Wartość wrażliwa. Przekaż jako bezpieczny parametr. |
resourceGroup | Nazwa grupy zasobów konta usługi Cosmos DB. | ciąg |
secondaryKey | Klucz pomocniczy konta usługi Cosmos DB. | ciąg Ograniczenia: Wartość wrażliwa. Przekaż jako bezpieczny parametr. |
subscriptionId | Identyfikator subskrypcji konta usługi Cosmos DB. | ciąg |
ManagedIdentity
Nazwa | Opis | Wartość |
---|---|---|
userAssignedIdentity | Tożsamość przypisana przez użytkownika. | ciąg |
RoutingEventHubProperties
Nazwa | Opis | Wartość |
---|---|---|
authenticationType | Metoda używana do uwierzytelniania względem punktu końcowego centrum zdarzeń | "identityBased" "keyBased" |
Parametry połączenia | Parametry połączenia punktu końcowego centrum zdarzeń. | ciąg |
endpointUri | Adres URL punktu końcowego centrum zdarzeń. Musi zawierać sb:// protokołu | ciąg |
entityPath | Nazwa centrum zdarzeń w przestrzeni nazw centrum zdarzeń | ciąg |
identyfikator | Identyfikator punktu końcowego centrum zdarzeń | ciąg |
identity | Właściwości tożsamości zarządzanej punktu końcowego centrum zdarzeń. | ManagedIdentity |
name | Nazwa identyfikująca ten punkt końcowy. Nazwa może zawierać tylko znaki alfanumeryczne, kropki, podkreślenia, łączniki i ma maksymalną długość 64 znaków. Następujące nazwy są zarezerwowane: zdarzenia, fileNotifications, $default. Nazwy punktów końcowych muszą być unikatowe w różnych typach punktów końcowych. | ciąg (wymagany) Ograniczenia: Wzorzec = ^[A-Za-z0-9-._]{1,64}$ |
resourceGroup | Nazwa grupy zasobów punktu końcowego centrum zdarzeń. | ciąg |
subscriptionId | Identyfikator subskrypcji punktu końcowego centrum zdarzeń. | ciąg |
RoutingServiceBusQueueEndpointProperties
Nazwa | Opis | Wartość |
---|---|---|
authenticationType | Metoda używana do uwierzytelniania względem punktu końcowego kolejki usługi Service Bus | "identityBased" "keyBased" |
Parametry połączenia | Parametry połączenia punktu końcowego kolejki usługi Service Bus. | ciąg |
endpointUri | Adres URL punktu końcowego kolejki usługi Service Bus. Musi zawierać sb:// protokołu | ciąg |
entityPath | Nazwa kolejki w przestrzeni nazw usługi Service Bus | ciąg |
identyfikator | Identyfikator punktu końcowego kolejki usługi Service Bus | ciąg |
identity | Właściwości tożsamości zarządzanej punktu końcowego kolejki usługi Service Bus. | ManagedIdentity |
name | Nazwa identyfikująca ten punkt końcowy. Nazwa może zawierać tylko znaki alfanumeryczne, kropki, podkreślenia, łączniki i ma maksymalną długość 64 znaków. Następujące nazwy są zarezerwowane: zdarzenia, fileNotifications, $default. Nazwy punktów końcowych muszą być unikatowe w różnych typach punktów końcowych. Nazwa nie musi być taka sama jak rzeczywista nazwa kolejki. | ciąg (wymagany) Ograniczenia: Wzorzec = ^[A-Za-z0-9-._]{1,64}$ |
resourceGroup | Nazwa grupy zasobów punktu końcowego kolejki usługi Service Bus. | ciąg |
subscriptionId | Identyfikator subskrypcji punktu końcowego kolejki usługi Service Bus. | ciąg |
Właściwości routinguServiceBusTopicEndpointProperties
Nazwa | Opis | Wartość |
---|---|---|
authenticationType | Metoda używana do uwierzytelniania względem punktu końcowego tematu usługi Service Bus | "identityBased" "keyBased" |
Parametry połączenia | Parametry połączenia punktu końcowego tematu usługi Service Bus. | ciąg |
endpointUri | Adres URL punktu końcowego tematu usługi Service Bus. Musi zawierać sb:// protokołu | ciąg |
entityPath | Nazwa kolejki w temacie usługi Service Bus | ciąg |
identyfikator | Identyfikator punktu końcowego tematu usługi Service Bus | ciąg |
identity | Właściwości tożsamości zarządzanej punktu końcowego tematu usługi Service Bus. | ManagedIdentity |
name | Nazwa identyfikująca ten punkt końcowy. Nazwa może zawierać tylko znaki alfanumeryczne, kropki, podkreślenia, łączniki i ma maksymalną długość 64 znaków. Następujące nazwy są zarezerwowane: zdarzenia, fileNotifications, $default. Nazwy punktów końcowych muszą być unikatowe w różnych typach punktów końcowych. Nazwa nie musi być taka sama jak rzeczywista nazwa tematu. | ciąg (wymagany) Ograniczenia: Wzorzec = ^[A-Za-z0-9-._]{1,64}$ |
resourceGroup | Nazwa grupy zasobów punktu końcowego tematu usługi Service Bus. | ciąg |
subscriptionId | Identyfikator subskrypcji punktu końcowego tematu usługi Service Bus. | ciąg |
RoutingStorageContainerProperties
Nazwa | Opis | Wartość |
---|---|---|
authenticationType | Metoda używana do uwierzytelniania w punkcie końcowym magazynu | "identityBased" "keyBased" |
batchFrequencyInSeconds | Przedział czasu, w którym obiekty blob są zapisywane w magazynie. Wartość powinna należeć do przedziału od 60 do 720 sekund. Wartość domyślna to 300 sekund. | int Ograniczenia: Wartość minimalna = 60 Wartość maksymalna = 720 |
Parametry połączenia | Parametry połączenia konta magazynu. | ciąg |
containerName | Nazwa kontenera magazynu na koncie magazynu. | ciąg (wymagany) |
encoding | Kodowanie używane do serializacji komunikatów do obiektów blob. Obsługiwane wartości to "avro", "avrodeflate" i "JSON". Wartość domyślna to "avro". | "Avro" "AvroDeflate" "JSON" |
endpointUri | Adres URL punktu końcowego magazynu. Musi zawierać protokół https:// |
ciąg |
fileNameFormat | Format nazwy pliku dla obiektu blob. Domyślny format to {iothub}/{partition}/{RRRR}/{MM}/{DD}/{HH}/{mm}. Wszystkie parametry są obowiązkowe, ale można zmienić ich kolejność. | ciąg |
identyfikator | Identyfikator punktu końcowego kontenera magazynu | ciąg |
identity | Właściwości tożsamości zarządzanej punktu końcowego magazynu routingu. | ManagedIdentity |
maxChunkSizeInBytes | Maksymalna liczba bajtów dla każdego obiektu blob zapisywanego w magazynie. Wartość powinna należeć do zakresu od 10485760(10 MB) do 524288000(500 MB). Wartość domyślna to 314572800(300 MB). | int Ograniczenia: Minimalna wartość = 10485760 Wartość maksymalna = 524288000 |
name | Nazwa identyfikująca ten punkt końcowy. Nazwa może zawierać tylko znaki alfanumeryczne, kropki, podkreślenia, łączniki i ma maksymalną długość 64 znaków. Następujące nazwy są zarezerwowane: zdarzenia, fileNotifications, $default. Nazwy punktów końcowych muszą być unikatowe w różnych typach punktów końcowych. | ciąg (wymagany) Ograniczenia: Wzorzec = ^[A-Za-z0-9-._]{1,64}$ |
resourceGroup | Nazwa grupy zasobów konta magazynu. | ciąg |
subscriptionId | Identyfikator subskrypcji konta magazynu. | ciąg |
Właściwości wzbogacania
Nazwa | Opis | Wartość |
---|---|---|
endpointNames | Lista punktów końcowych, dla których wzbogacanie jest stosowane do komunikatu. | string[] (wymagane) Ograniczenia: Minimalna długość = 1 |
key | Klucz lub nazwa właściwości wzbogacania. | ciąg (wymagany) |
wartość | Wartość właściwości wzbogacania. | ciąg (wymagany) |
FallbackRouteProperties
Nazwa | Opis | Wartość |
---|---|---|
Warunek | Warunek, który jest oceniany w celu zastosowania trasy powrotu. Jeśli warunek nie zostanie podany, domyślnie zostanie obliczona wartość true. Aby uzyskać informacje na temat gramatyki, zobacz: /azure/iot-hub/iot-hub-devguide-query-language | ciąg |
endpointNames | Lista punktów końcowych, do których są kierowane komunikaty spełniające warunek. Obecnie dozwolony jest tylko 1 punkt końcowy. | string[] (wymagane) Ograniczenia: Minimalna długość = 1 Maksymalna długość = 1 |
Isenabled | Służy do określania, czy trasa rezerwowa jest włączona. | bool (wymagane) |
name | Nazwa trasy. Nazwa może zawierać tylko znaki alfanumeryczne, kropki, podkreślenia, łączniki, ma maksymalną długość 64 znaków i musi być unikatowa. | ciąg |
source | Źródło, do którego ma zostać zastosowana reguła rozsyłania. Na przykład DeviceMessages | "DeviceConnectionStateEvents" "DeviceJobLifecycleEvents" "DeviceLifecycleEvents" "DeviceMessages" "Nieprawidłowy" "TwinChangeEvents" (wymagane) |
Właściwości trasy
Nazwa | Opis | Wartość |
---|---|---|
Warunek | Warunek, który jest oceniany w celu zastosowania reguły rozsyłania. Jeśli warunek nie zostanie podany, zostanie obliczona wartość true domyślnie. W przypadku gramatyki zobacz: /azure/iot-hub/iot-hub-devguide-query-language | ciąg |
endpointNames | Lista punktów końcowych, do których są kierowane komunikaty spełniające warunek. Obecnie dozwolony jest tylko jeden punkt końcowy. | string[] (wymagane) Ograniczenia: Minimalna długość = 1 Maksymalna długość = 1 |
Isenabled | Służy do określania, czy trasa jest włączona. | bool (wymagane) |
name | Nazwa trasy. Nazwa może zawierać tylko znaki alfanumeryczne, kropki, podkreślenia, łączniki, ma maksymalną długość 64 znaków i musi być unikatowa. | ciąg (wymagany) Ograniczenia: Wzorzec = ^[A-Za-z0-9-._]{1,64}$ |
source | Źródłem, do którego ma zostać zastosowana reguła routingu, na przykład DeviceMessages. | "DeviceConnectionStateEvents" "DeviceJobLifecycleEvents" "DeviceLifecycleEvents" "DeviceMessages" "Nieprawidłowy" "TwinChangeEvents" (wymagane) |
IotHubPropertiesStorageEndpoints
Nazwa | Opis | Wartość |
---|---|---|
{niestandardowa właściwość} | StorageEndpointProperties |
StorageEndpointProperties
Nazwa | Opis | Wartość |
---|---|---|
authenticationType | Określa typ uwierzytelniania używany do nawiązywania połączenia z kontem magazynu. | "identityBased" "keyBased" |
Parametry połączenia | Parametry połączenia dla konta usługi Azure Storage, do którego są przekazywane pliki. | ciąg (wymagany) |
containerName | Nazwa kontenera głównego, w którym są przekazywane pliki. Kontener nie musi istnieć, ale powinien być creatable przy użyciu określonego parametru connectionString. | ciąg (wymagany) |
identity | Właściwości tożsamości zarządzanej punktu końcowego magazynu na potrzeby przekazywania plików. | ManagedIdentity |
sasTtlAsIso8601 | Okres, dla którego identyfikator URI sygnatury dostępu współdzielonego wygenerowany przez IoT Hub przekazywania plików jest prawidłowy. Zobacz: /azure/iot-hub/iot-hub-devguide-file-upload#file-upload-notification-configuration-options. | ciąg |
IotHubSkuInfo
Nazwa | Opis | Wartość |
---|---|---|
capacity | Liczba aprowizowanych jednostek IoT Hub. Zobacz: /azure/azure-subscription-service-limits#iot-hub-limits. | int |
name | Nazwa jednostki SKU. | "B1" "B2" "B3" "F1" "S1" "S2" "S3" (wymagane) |
Szablony szybkiego startu
Następujące szablony szybkiego startu wdrażają ten typ zasobu.
Template | Opis |
---|---|
Tworzenie symulatora usługi IOT Hub i ubuntu edge |
Ten szablon tworzy symulator usługi IOT Hub i maszyny wirtualnej Ubuntu edge. |
Tworzenie komunikatów IoT Hub, kierowanie i wyświetlanie komunikatów przy użyciu szablonu usługi ARM |
Użyj tego szablonu, aby wdrożyć IoT Hub i konto magazynu. Uruchom aplikację, aby wysyłać komunikaty do centrum, które są kierowane do magazynu, a następnie wyświetlać wyniki. |
Tworzenie usługi IoT Hub Device Provisioning Service |
Ten szablon umożliwia utworzenie centrum IoT i usługi IoT Hub Device Provisioning Oraz połączenie tych dwóch usług. |
Tworzenie IoT Hub i grupy odbiorców urządzenia do chmury |
Ten szablon umożliwia wdrożenie wystąpienia IoT Hub z urządzeniem w chmurze i w chmurze w konfiguracjach obsługi komunikatów urządzeń oraz urządzenia w grupie odbiorców w chmurze. |
Tworzenie aktualizacji urządzenia dla konta IoT Hub, wystąpienia, IoT Hub |
Ten szablon tworzy konto, a wystąpienie i centrum w celu połączenia wystąpienia z nim. Konfiguruje centrum z niezbędnymi zasadami dostępu, trasami i grupą odbiorców. |
Wdrażanie usługi MedTech, w tym Azure IoT Hub |
Usługa MedTech jest jedną z usług Azure Health Data Services zaprojektowanych do pozyskiwania danych urządzeń z wielu urządzeń, przekształcania danych urządzenia w obserwacje FHIR, które są następnie utrwalane w usłudze FHIR usług Azure Health Data Services. |
Tworzenie środowiska płatności zgodnie z rzeczywistym użyciem (PAYG) za pomocą IoT Hub |
Ten szablon umożliwia wdrożenie środowiska usługi Time Series Insights z płatnością zgodnie z rzeczywistym użyciem (PAYG), które jest skonfigurowane do korzystania z zdarzeń z IoT Hub. |
Definicja zasobu narzędzia Terraform (dostawcy AzAPI)
Typ zasobu IotHubs można wdrożyć przy użyciu operacji docelowych:
- Grupy zasobów
Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennik zmian.
Format zasobu
Aby utworzyć zasób Microsoft.Devices/IotHubs, dodaj następujący program Terraform do szablonu.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Devices/IotHubs@2023-06-30"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
identity {
type = "string"
identity_ids = []
}
body = jsonencode({
properties = {
allowedFqdnList = [
"string"
]
authorizationPolicies = [
{
keyName = "string"
primaryKey = "string"
rights = "string"
secondaryKey = "string"
keyName = "string"
primaryKey = "string"
rights = "string"
secondaryKey = "string"
}
]
cloudToDevice = {
defaultTtlAsIso8601 = "string"
feedback = {
lockDurationAsIso8601 = "string"
maxDeliveryCount = int
ttlAsIso8601 = "string"
}
maxDeliveryCount = int
}
comments = "string"
disableDeviceSAS = bool
disableLocalAuth = bool
disableModuleSAS = bool
enableDataResidency = bool
enableFileUploadNotifications = bool
eventHubEndpoints = {
{customized property} = {
partitionCount = int
retentionTimeInDays = int
}
}
features = "string"
ipFilterRules = [
{
action = "string"
filterName = "string"
ipMask = "string"
}
]
messagingEndpoints = {
{customized property} = {
lockDurationAsIso8601 = "string"
maxDeliveryCount = int
ttlAsIso8601 = "string"
}
}
minTlsVersion = "string"
networkRuleSets = {
applyToBuiltInEventHubEndpoint = bool
defaultAction = "string"
ipRules = [
{
action = "Allow"
filterName = "string"
ipMask = "string"
}
]
}
privateEndpointConnections = [
{
properties = {
privateEndpoint = {}
privateLinkServiceConnectionState = {
actionsRequired = "string"
description = "string"
status = "string"
}
}
}
]
publicNetworkAccess = "string"
restrictOutboundNetworkAccess = bool
routing = {
endpoints = {
cosmosDBSqlContainers = [
{
authenticationType = "string"
containerName = "string"
databaseName = "string"
endpointUri = "string"
identity = {
userAssignedIdentity = "string"
}
name = "string"
partitionKeyName = "string"
partitionKeyTemplate = "string"
primaryKey = "string"
resourceGroup = "string"
secondaryKey = "string"
subscriptionId = "string"
}
]
eventHubs = [
{
authenticationType = "string"
connectionString = "string"
endpointUri = "string"
entityPath = "string"
id = "string"
identity = {
userAssignedIdentity = "string"
}
name = "string"
resourceGroup = "string"
subscriptionId = "string"
}
]
serviceBusQueues = [
{
authenticationType = "string"
connectionString = "string"
endpointUri = "string"
entityPath = "string"
id = "string"
identity = {
userAssignedIdentity = "string"
}
name = "string"
resourceGroup = "string"
subscriptionId = "string"
}
]
serviceBusTopics = [
{
authenticationType = "string"
connectionString = "string"
endpointUri = "string"
entityPath = "string"
id = "string"
identity = {
userAssignedIdentity = "string"
}
name = "string"
resourceGroup = "string"
subscriptionId = "string"
}
]
storageContainers = [
{
authenticationType = "string"
batchFrequencyInSeconds = int
connectionString = "string"
containerName = "string"
encoding = "string"
endpointUri = "string"
fileNameFormat = "string"
id = "string"
identity = {
userAssignedIdentity = "string"
}
maxChunkSizeInBytes = int
name = "string"
resourceGroup = "string"
subscriptionId = "string"
}
]
}
enrichments = [
{
endpointNames = [
"string"
]
key = "string"
value = "string"
}
]
fallbackRoute = {
condition = "string"
endpointNames = [
"string"
]
isEnabled = bool
name = "string"
source = "string"
}
routes = [
{
condition = "string"
endpointNames = [
"string"
]
isEnabled = bool
name = "string"
source = "string"
}
]
}
storageEndpoints = {
{customized property} = {
authenticationType = "string"
connectionString = "string"
containerName = "string"
identity = {
userAssignedIdentity = "string"
}
sasTtlAsIso8601 = "string"
}
}
}
sku = {
capacity = int
name = "string"
}
etag = "string"
})
}
Wartości właściwości
IotHubs
Nazwa | Opis | Wartość |
---|---|---|
typ | Typ zasobu | "Microsoft.Devices/IotHubs@2023-06-30" |
name | Nazwa zasobu | ciąg (wymagany) Limit znaków: 3–50 Prawidłowe znaki: Alfanumeryczne i łączniki. Nie można zakończyć łącznikiem. Nazwa zasobu musi być unikatowa na platformie Azure. |
location | Lokalizacja zasobu. | ciąg (wymagany) |
parent_id | Aby przeprowadzić wdrożenie w grupie zasobów, użyj identyfikatora tej grupy zasobów. | ciąg (wymagany) |
tags | Tagi zasobów. | Słownik nazw tagów i wartości. |
sku | Informacje o jednostce SKU usługi IotHub | IotHubSkuInfo (wymagane) |
Etag | Pole Etag nie jest wymagane. Jeśli jest on podany w treści odpowiedzi, musi być również podany jako nagłówek zgodnie z normalną konwencją ETag. | ciąg |
identity | Tożsamości zarządzane dla usługi IotHub. | ArmIdentity |
properties | Właściwości usługi IotHub | IotHubProperties |
ArmIdentity
Nazwa | Opis | Wartość |
---|---|---|
typ | Typ tożsamości używanej dla zasobu. Typ "SystemAssigned, UserAssigned" zawiera zarówno niejawnie utworzoną tożsamość, jak i zestaw tożsamości przypisanych przez użytkownika. Typ "Brak" spowoduje usunięcie wszystkich tożsamości z usługi. | "SystemAssigned" "SystemAssigned, UserAssigned" "UserAssigned" |
identity_ids | Słownik {ArmUserIdentity} | Tablica identyfikatorów tożsamości użytkowników. |
ArmIdentityUserAssignedIdentities
Nazwa | Opis | Wartość |
---|---|---|
{niestandardowa właściwość} | ArmUserIdentity |
ArmUserIdentity
Ten obiekt nie zawiera żadnych właściwości do ustawienia podczas wdrażania. Wszystkie właściwości to ReadOnly.
IotHubProperties
Nazwa | Opis | Wartość |
---|---|---|
allowedFqdnList | Lista dozwolonych nazw FQDN (w pełni kwalifikowana nazwa domeny) dla ruchu wychodzącego z usługi IoT Hub. | ciąg[] |
authorizationPolicies | Zasady dostępu współdzielonego, których można użyć do zabezpieczenia połączenia z centrum IoT. | SharedAccessSignatureAuthorizationRule[] |
cloudToDevice | Właściwości obsługi komunikatów z chmury do urządzenia w usłudze IoT Hub. | CloudToDeviceProperties |
komentarze | Komentarze do centrum IoT Hub. | ciąg |
disableDeviceSAS | Jeśli to prawda, nie można używać wszystkich urządzeń (w tym urządzeń brzegowych, ale z wyłączeniem modułów) kluczy SAS w zakresie. | bool |
disableLocalAuth | Jeśli to prawda, tokeny SAS z kluczami sygnatur dostępu współdzielonego o zakresie usługi Iot Hub nie mogą być używane do uwierzytelniania. | bool |
disableModuleSAS | Jeśli to prawda, nie można użyć wszystkich kluczy SAS o zakresie modułu do uwierzytelniania. | bool |
enableDataResidency | Ta właściwość po ustawieniu wartości true włączy rezydencję danych, co spowoduje wyłączenie odzyskiwania po awarii. | bool |
enableFileUploadNotifications | Jeśli wartość True, powiadomienia dotyczące przekazywania plików są włączone. | bool |
eventHubEndpoints | Właściwości punktu końcowego zgodnego z centrum zdarzeń. Jedynymi możliwymi kluczami do tego słownika są zdarzenia. Ten klucz musi być obecny w słowniku podczas tworzenia lub aktualizowania wywołań dla centrum IoT. | IotHubPropertiesEventHubEndpoints |
funkcje | Możliwości i funkcje włączone dla centrum IoT. | "DeviceManagement" "Brak" |
ipFilterRules | Reguły filtrowania adresów IP. | IpFilterRule[] |
messagingEndpoints | Właściwości punktu końcowego obsługi komunikatów dla kolejki powiadomień przekazywania pliku. | IotHubPropertiesMessagingEndpoints |
minTlsVersion | Określa minimalną wersję protokołu TLS do obsługi tego centrum. Można ustawić wartość "1.2", aby klienci korzystający z protokołu TLS w wersji poniżej 1.2 zostali odrzuconi. | ciąg |
networkRuleSets | Właściwości zestawu reguł sieciowych usługi IotHub | NetworkRuleSetProperties |
privateEndpointConnections | Połączenia prywatnego punktu końcowego utworzone w tej usłudze IotHub | PrivateEndpointConnection[] |
publicNetworkAccess | Czy żądania z sieci publicznej są dozwolone | "Wyłączone" "Włączone" |
restrictOutboundNetworkAccess | W przypadku wartości true ruch wychodzący z usługi IotHub będzie ograniczony tylko do dozwolonych nazw FQDN skonfigurowanych za pośrednictwem listy allowedFqdnList. | bool |
Routingu | Właściwości powiązane z routingiem centrum IoT. Zobacz: /azure/iot-hub/iot-hub-devguide-messaging | Właściwości routingu |
storageEndpoints | Lista punktów końcowych usługi Azure Storage, w których można przekazywać pliki. Obecnie można skonfigurować tylko jedno konto usługi Azure Storage i musi mieć swój klucz jako $default. Określenie więcej niż jednego konta magazynu powoduje wystąpienie błędu. Nie określając wartości dla tej właściwości, gdy właściwość enableFileUploadNotifications ma wartość True, powoduje wystąpienie błędu. | IotHubPropertiesStorageEndpoints |
SharedAccessSignatureAuthorizationRule
Nazwa | Opis | Wartość |
---|---|---|
keyName | Nazwa zasad dostępu współdzielonego. | ciąg (wymagany) |
primaryKey | Klucz podstawowy. | ciąg |
Prawa | Uprawnienia przypisane do zasad dostępu współdzielonego. | "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" (wymagane) |
secondaryKey | Klucz pomocniczy. | ciąg |
keyName | Nazwa zasad dostępu współdzielonego. | ciąg (wymagany) |
primaryKey | Klucz podstawowy. | ciąg |
Prawa | Uprawnienia przypisane do zasad dostępu współdzielonego. | "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" (wymagane) |
secondaryKey | Klucz pomocniczy. | ciąg |
CloudToDeviceProperties
Nazwa | Opis | Wartość |
---|---|---|
defaultTtlAsIso8601 | Domyślny czas wygaśnięcia komunikatów z chmury do urządzenia w kolejce urządzenia. Zobacz: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | ciąg |
Opinie | Właściwości kolejki opinii dla komunikatów z chmury do urządzenia. | OpinieWłaściwości |
maxDeliveryCount | Maksymalna liczba dostarczania komunikatów z chmury do urządzenia w kolejce urządzenia. Zobacz: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | int Ograniczenia: Minimalna wartość = 1 Wartość maksymalna = 100 |
OpinieWłaściwości
Nazwa | Opis | Wartość |
---|---|---|
lockDurationAsIso8601 | Czas trwania blokady kolejki opinii. Zobacz: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | ciąg |
maxDeliveryCount | Liczba prób dostarczenia komunikatu w kolejce opinii przez centrum IoT. Zobacz: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | int Ograniczenia: Minimalna wartość = 1 Wartość maksymalna = 100 |
ttlAsIso8601 | Okres, przez który komunikat jest dostępny do użytku, zanim wygaśnie przez centrum IoT. Zobacz: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | ciąg |
IotHubPropertiesEventHubEndpoints
Nazwa | Opis | Wartość |
---|---|---|
{niestandardowa właściwość} | EventHubProperties |
EventHubProperties
Nazwa | Opis | Wartość |
---|---|---|
partitionCount | Liczba partycji do odbierania komunikatów z urządzenia do chmury w punkcie końcowym zgodnym z centrum zdarzeń. Zobacz: /azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages. | int |
retentionTimeInDays | Czas przechowywania komunikatów z urządzenia do chmury w dniach. Zobacz: /azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages | int |
IpFilterRule
Nazwa | Opis | Wartość |
---|---|---|
action | Żądana akcja żądań przechwyconych przez tę regułę. | "Akceptuj" "Odrzuć" (wymagane) |
Filtername | Nazwa reguły filtrowania adresów IP. | ciąg (wymagany) |
ipMask | Ciąg zawierający zakres adresów IP w notacji CIDR dla reguły. | ciąg (wymagany) |
IotHubPropertiesMessagingEndpoints
Nazwa | Opis | Wartość |
---|---|---|
{niestandardowa właściwość} | MessagingEndpointProperties |
MessagingEndpointProperties
Nazwa | Opis | Wartość |
---|---|---|
lockDurationAsIso8601 | Czas trwania blokady. Zobacz: /azure/iot-hub/iot-hub-devguide-file-upload. | ciąg |
maxDeliveryCount | Liczba prób dostarczenia komunikatu przez centrum IoT Hub. Zobacz: /azure/iot-hub/iot-hub-devguide-file-upload. | int Ograniczenia: Minimalna wartość = 1 Wartość maksymalna = 100 |
ttlAsIso8601 | Okres, przez który komunikat jest dostępny do użytku, zanim wygaśnie przez centrum IoT. Zobacz: /azure/iot-hub/iot-hub-devguide-file-upload. | ciąg |
NetworkRuleSetProperties
Nazwa | Opis | Wartość |
---|---|---|
applyToBuiltInEventHubEndpoint | Jeśli wartość True, zestaw reguł sieci jest również stosowany do aplikacji BuiltIn EventHub EndPoint of IotHub | bool (wymagane) |
defaultAction | Domyślna akcja dla zestawu reguł sieci | "Zezwalaj" "Odmów" |
adresy IPRules | Lista reguł adresów IP | NetworkRuleSetIpRule[] (wymagane) |
NetworkRuleSetIpRule
Nazwa | Opis | Wartość |
---|---|---|
action | Akcja filtru IP | "Zezwalaj" |
Filtername | Nazwa reguły filtrowania adresów IP. | ciąg (wymagany) |
ipMask | Ciąg zawierający zakres adresów IP w notacji CIDR dla reguły. | ciąg (wymagany) |
PrivateEndpointConnection
Nazwa | Opis | Wartość |
---|---|---|
properties | Właściwości połączenia prywatnego punktu końcowego | PrivateEndpointConnectionProperties (wymagane) |
PrivateEndpointConnectionProperties
Nazwa | Opis | Wartość |
---|---|---|
privateEndpoint | Właściwość prywatnego punktu końcowego połączenia prywatnego punktu końcowego | PrivateEndpoint |
privateLinkServiceConnectionState | Bieżący stan połączenia prywatnego punktu końcowego | PrivateLinkServiceConnectionState (wymagane) |
PrivateEndpoint
Ten obiekt nie zawiera żadnych właściwości do ustawienia podczas wdrażania. Wszystkie właściwości to ReadOnly.
PrivateLinkServiceConnectionState
Nazwa | Opis | Wartość |
---|---|---|
actionsRequired | Akcje wymagane dla połączenia prywatnego punktu końcowego | ciąg |
description (opis) | Opis bieżącego stanu połączenia prywatnego punktu końcowego | ciąg (wymagany) |
status | Stan połączenia prywatnego punktu końcowego | "Zatwierdzone" "Rozłączone" "Oczekujące" "Odrzucone" (wymagane) |
Właściwości routingu
Nazwa | Opis | Wartość |
---|---|---|
Punkty końcowe | Właściwości związane z niestandardowymi punktami końcowymi, do których centrum IoT kieruje komunikaty na podstawie reguł routingu. Maksymalnie 10 niestandardowych punktów końcowych jest dozwolonych we wszystkich typach punktów końcowych dla płatnych centrów, a tylko 1 niestandardowy punkt końcowy jest dozwolony we wszystkich typach punktów końcowych dla bezpłatnych centrów. | Punkty routingu |
wzbogacenia | Lista wzbogacenia udostępnianych przez użytkownika, które centrum IoT ma zastosowanie do komunikatów dostarczanych do wbudowanych i niestandardowych punktów końcowych. Zobacz: https://aka.ms/telemetryoneventgrid |
WzbogacanieWłaściwości[] |
rezerwowaroute | Właściwości trasy, która jest używana jako trasa rezerwowa, gdy żaden z warunków określonych w sekcji "trasy" nie jest spełniony. Jest to opcjonalny parametr. Jeśli ta właściwość nie jest obecna w szablonie, trasa rezerwowa jest domyślnie wyłączona. | FallbackRouteProperties |
Trasy | Lista reguł routingu udostępnianych przez użytkownika używanych przez centrum IoT do kierowania komunikatów do wbudowanych i niestandardowych punktów końcowych. Dla płatnych centrów dozwolone jest maksymalnie 100 reguł routingu, a dla bezpłatnych centrów dozwolone jest maksymalnie 5 reguł routingu. | RouteProperties[] |
Punkty routingu
Nazwa | Opis | Wartość |
---|---|---|
cosmosDBSqlContainers | Lista punktów końcowych kontenera usługi Cosmos DB, do których usługa IoT Hub kieruje komunikaty na podstawie reguł routingu. | RoutingCosmosDBSqlApiProperties[] |
eventHubs | Lista punktów końcowych usługi Event Hubs, do których usługa IoT Hub kieruje komunikaty na podstawie reguł routingu. Ta lista nie zawiera wbudowanego punktu końcowego usługi Event Hubs. | RoutingEventHubProperties[] |
serviceBusQueues | Lista punktów końcowych kolejki usługi Service Bus, do których usługa IoT Hub kieruje komunikaty na podstawie reguł routingu. | RoutingServiceBusQueueEndpointProperties[] |
serviceBusTopics | Lista punktów końcowych tematu usługi Service Bus, do których centrum IoT kieruje komunikaty na podstawie reguł routingu. | RoutingServiceBusTopicEndpointProperties[] |
storageContainers | Lista punktów końcowych kontenera magazynu, do których usługa IoT Hub kieruje komunikaty na podstawie reguł routingu. | RoutingStorageContainerProperties[] |
RoutingCosmosDBSqlApiProperties
Nazwa | Opis | Wartość |
---|---|---|
authenticationType | Metoda używana do uwierzytelniania względem punktu końcowego kontenera sql usługi Cosmos DB | "identityBased" "keyBased" |
containerName | Nazwa kontenera sql usługi Cosmos DB w bazie danych cosmos DB. | ciąg (wymagany) |
databaseName | Nazwa bazy danych cosmos DB na koncie usługi Cosmos DB. | ciąg (wymagany) |
endpointUri | Adres URL konta usługi Cosmos DB. Musi zawierać protokół https:// |
ciąg (wymagany) |
identity | Właściwości tożsamości zarządzanej dotyczące routingu punktu końcowego kontenera usługi Cosmos DB. | ManagedIdentity |
name | Nazwa identyfikująca ten punkt końcowy. Nazwa może zawierać tylko znaki alfanumeryczne, kropki, podkreślenia, łączniki i ma maksymalną długość 64 znaków. Następujące nazwy są zarezerwowane: zdarzenia, fileNotifications, $default. Nazwy punktów końcowych muszą być unikatowe w różnych typach punktów końcowych. | ciąg (wymagany) Ograniczenia: Wzorzec = ^[A-Za-z0-9-._]{1,64}$ |
partitionKeyName | Nazwa klucza partycji skojarzonego z tym kontenerem sql usługi Cosmos DB, jeśli istnieje. Jest to opcjonalny parametr. | ciąg |
partitionKeyTemplate | Szablon służący do generowania syntetycznej wartości klucza partycji do użycia z tym kontenerem sql usługi Cosmos DB. Szablon musi zawierać co najmniej jeden z następujących symboli zastępczych: {iothub}, {deviceid}, {DD}, {MM}i {RRRR}. Każdy symbol zastępczy może być określony co najwyżej raz, ale składniki kolejności i symboli zastępczych są dowolne. Ten parametr jest wymagany tylko wtedy, gdy określono parametr PartitionKeyName. | ciąg |
primaryKey | Klucz podstawowy konta usługi Cosmos DB. | ciąg Ograniczenia: Wartość wrażliwa. Przekaż jako bezpieczny parametr. |
resourceGroup | Nazwa grupy zasobów konta usługi Cosmos DB. | ciąg |
secondaryKey | Klucz pomocniczy konta usługi Cosmos DB. | ciąg Ograniczenia: Wartość wrażliwa. Przekaż jako bezpieczny parametr. |
subscriptionId | Identyfikator subskrypcji konta usługi Cosmos DB. | ciąg |
ManagedIdentity
Nazwa | Opis | Wartość |
---|---|---|
userAssignedIdentity | Tożsamość przypisana przez użytkownika. | ciąg |
RoutingEventHubProperties
Nazwa | Opis | Wartość |
---|---|---|
authenticationType | Metoda używana do uwierzytelniania względem punktu końcowego centrum zdarzeń | "identityBased" "keyBased" |
Parametry połączenia | Parametry połączenia punktu końcowego centrum zdarzeń. | ciąg |
endpointUri | Adres URL punktu końcowego centrum zdarzeń. Musi zawierać protokół sb:// | ciąg |
entityPath | Nazwa centrum zdarzeń w przestrzeni nazw centrum zdarzeń | ciąg |
identyfikator | Identyfikator punktu końcowego centrum zdarzeń | ciąg |
identity | Właściwości tożsamości zarządzanej punktu końcowego centrum zdarzeń routingu. | ManagedIdentity |
name | Nazwa identyfikująca ten punkt końcowy. Nazwa może zawierać tylko znaki alfanumeryczne, kropki, podkreślenia, łączniki i ma maksymalną długość 64 znaków. Następujące nazwy są zarezerwowane: zdarzenia, fileNotifications, $default. Nazwy punktów końcowych muszą być unikatowe w różnych typach punktów końcowych. | ciąg (wymagany) Ograniczenia: Wzorzec = ^[A-Za-z0-9-._]{1,64}$ |
resourceGroup | Nazwa grupy zasobów punktu końcowego centrum zdarzeń. | ciąg |
subscriptionId | Identyfikator subskrypcji punktu końcowego centrum zdarzeń. | ciąg |
RoutingServiceBusQueueEndpointProperties
Nazwa | Opis | Wartość |
---|---|---|
authenticationType | Metoda używana do uwierzytelniania względem punktu końcowego kolejki usługi Service Bus | "identityBased" "keyBased" |
Parametry połączenia | Parametry połączenia punktu końcowego kolejki usługi Service Bus. | ciąg |
endpointUri | Adres URL punktu końcowego kolejki usługi Service Bus. Musi zawierać protokół sb:// | ciąg |
entityPath | Nazwa kolejki w przestrzeni nazw usługi Service Bus | ciąg |
identyfikator | Identyfikator punktu końcowego kolejki usługi Service Bus | ciąg |
identity | Właściwości tożsamości zarządzanej punktu końcowego kolejki usługi Service Bus. | ManagedIdentity |
name | Nazwa identyfikująca ten punkt końcowy. Nazwa może zawierać tylko znaki alfanumeryczne, kropki, podkreślenia, łączniki i ma maksymalną długość 64 znaków. Następujące nazwy są zarezerwowane: zdarzenia, fileNotifications, $default. Nazwy punktów końcowych muszą być unikatowe w różnych typach punktów końcowych. Nazwa nie musi być taka sama jak rzeczywista nazwa kolejki. | ciąg (wymagany) Ograniczenia: Wzorzec = ^[A-Za-z0-9-._]{1,64}$ |
resourceGroup | Nazwa grupy zasobów punktu końcowego kolejki usługi Service Bus. | ciąg |
subscriptionId | Identyfikator subskrypcji punktu końcowego kolejki usługi Service Bus. | ciąg |
RoutingServiceBusTopicEndpointProperties
Nazwa | Opis | Wartość |
---|---|---|
authenticationType | Metoda używana do uwierzytelniania względem punktu końcowego tematu usługi Service Bus | "identityBased" "keyBased" |
Parametry połączenia | Parametry połączenia punktu końcowego tematu usługi Service Bus. | ciąg |
endpointUri | Adres URL punktu końcowego tematu usługi Service Bus. Musi zawierać protokół sb:// | ciąg |
entityPath | Nazwa kolejki w temacie usługi Service Bus | ciąg |
identyfikator | Identyfikator punktu końcowego tematu usługi Service Bus | ciąg |
identity | Właściwości tożsamości zarządzanej punktu końcowego tematu usługi Service Bus routingu. | ManagedIdentity |
name | Nazwa identyfikująca ten punkt końcowy. Nazwa może zawierać tylko znaki alfanumeryczne, kropki, podkreślenia, łączniki i ma maksymalną długość 64 znaków. Następujące nazwy są zarezerwowane: zdarzenia, fileNotifications, $default. Nazwy punktów końcowych muszą być unikatowe w różnych typach punktów końcowych. Nazwa nie musi być taka sama jak rzeczywista nazwa tematu. | ciąg (wymagany) Ograniczenia: Wzorzec = ^[A-Za-z0-9-._]{1,64}$ |
resourceGroup | Nazwa grupy zasobów punktu końcowego tematu usługi Service Bus. | ciąg |
subscriptionId | Identyfikator subskrypcji punktu końcowego tematu usługi Service Bus. | ciąg |
RoutingStorageContainerProperties
Nazwa | Opis | Wartość |
---|---|---|
authenticationType | Metoda używana do uwierzytelniania w punkcie końcowym magazynu | "identityBased" "keyBased" |
batchFrequencyInSeconds | Interwał czasu, w którym obiekty blob są zapisywane w magazynie. Wartość powinna wynosić od 60 do 720 sekund. Wartość domyślna to 300 sekund. | int Ograniczenia: Minimalna wartość = 60 Maksymalna wartość = 720 |
Parametry połączenia | Parametry połączenia konta magazynu. | ciąg |
containerName | Nazwa kontenera magazynu na koncie magazynu. | ciąg (wymagany) |
encoding | Kodowanie używane do serializacji komunikatów do obiektów blob. Obsługiwane wartości to "avro", "avrodeflate" i "JSON". Wartość domyślna to "avro". | "Avro" "AvroDeflate" "JSON" |
endpointUri | Adres URL punktu końcowego magazynu. Musi zawierać protokół https:// |
ciąg |
fileNameFormat | Format nazwy pliku dla obiektu blob. Domyślny format to {iothub}/{partition}/{RRRR}/{MM}/{DD}/{HH}/{mm}. Wszystkie parametry są obowiązkowe, ale można zmienić ich kolejność. | ciąg |
identyfikator | Identyfikator punktu końcowego kontenera magazynu | ciąg |
identity | Właściwości tożsamości zarządzanej punktu końcowego magazynu routingu. | ManagedIdentity |
maxChunkSizeInBytes | Maksymalna liczba bajtów dla każdego obiektu blob zapisywanego w magazynie. Wartość powinna należeć do zakresu od 10485760(10 MB) do 524288000(500 MB). Wartość domyślna to 314572800(300 MB). | int Ograniczenia: Minimalna wartość = 10485760 Wartość maksymalna = 524288000 |
name | Nazwa identyfikująca ten punkt końcowy. Nazwa może zawierać tylko znaki alfanumeryczne, kropki, podkreślenia, łączniki i ma maksymalną długość 64 znaków. Następujące nazwy są zarezerwowane: zdarzenia, fileNotifications, $default. Nazwy punktów końcowych muszą być unikatowe w różnych typach punktów końcowych. | ciąg (wymagany) Ograniczenia: Wzorzec = ^[A-Za-z0-9-._]{1,64}$ |
resourceGroup | Nazwa grupy zasobów konta magazynu. | ciąg |
subscriptionId | Identyfikator subskrypcji konta magazynu. | ciąg |
Właściwości wzbogacania
Nazwa | Opis | Wartość |
---|---|---|
endpointNames | Lista punktów końcowych, dla których wzbogacanie jest stosowane do komunikatu. | string[] (wymagane) Ograniczenia: Minimalna długość = 1 |
key | Klucz lub nazwa właściwości wzbogacania. | ciąg (wymagany) |
wartość | Wartość właściwości wzbogacania. | ciąg (wymagany) |
FallbackRouteProperties
Nazwa | Opis | Wartość |
---|---|---|
Warunek | Warunek, który jest oceniany w celu zastosowania trasy powrotu. Jeśli warunek nie zostanie podany, domyślnie zostanie obliczona wartość true. Aby uzyskać informacje na temat gramatyki, zobacz: /azure/iot-hub/iot-hub-devguide-query-language | ciąg |
endpointNames | Lista punktów końcowych, do których są kierowane komunikaty spełniające warunek. Obecnie dozwolony jest tylko 1 punkt końcowy. | string[] (wymagane) Ograniczenia: Minimalna długość = 1 Maksymalna długość = 1 |
Isenabled | Służy do określania, czy trasa rezerwowa jest włączona. | bool (wymagane) |
name | Nazwa trasy. Nazwa może zawierać tylko znaki alfanumeryczne, kropki, podkreślenia, łączniki, ma maksymalną długość 64 znaków i musi być unikatowa. | ciąg |
source | Źródło, do którego ma zostać zastosowana reguła rozsyłania. Na przykład DeviceMessages | "DeviceConnectionStateEvents" "DeviceJobLifecycleEvents" "DeviceLifecycleEvents" "DeviceMessages" "Nieprawidłowy" "TwinChangeEvents" (wymagane) |
Właściwości trasy
Nazwa | Opis | Wartość |
---|---|---|
Warunek | Warunek, który jest oceniany w celu zastosowania reguły rozsyłania. Jeśli warunek nie zostanie podany, zostanie obliczona wartość true domyślnie. Aby uzyskać informacje na temat gramatyki, zobacz: /azure/iot-hub/iot-hub-devguide-query-language | ciąg |
endpointNames | Lista punktów końcowych, do których są kierowane komunikaty spełniające warunek. Obecnie dozwolony jest tylko jeden punkt końcowy. | string[] (wymagane) Ograniczenia: Minimalna długość = 1 Maksymalna długość = 1 |
Isenabled | Służy do określania, czy trasa jest włączona. | bool (wymagane) |
name | Nazwa trasy. Nazwa może zawierać tylko znaki alfanumeryczne, kropki, podkreślenia, łączniki, ma maksymalną długość 64 znaków i musi być unikatowa. | ciąg (wymagany) Ograniczenia: Wzorzec = ^[A-Za-z0-9-._]{1,64}$ |
source | Źródło, do którego ma zostać zastosowana reguła routingu, na przykład DeviceMessages. | "DeviceConnectionStateEvents" "DeviceJobLifecycleEvents" "DeviceLifecycleEvents" "DeviceMessages" "Nieprawidłowy" "TwinChangeEvents" (wymagane) |
IotHubPropertiesStorageEndpoints
Nazwa | Opis | Wartość |
---|---|---|
{niestandardowa właściwość} | Właściwości punktu końcowego magazynu |
Właściwości punktu końcowego magazynu
Nazwa | Opis | Wartość |
---|---|---|
authenticationType | Określa typ uwierzytelniania używany do nawiązywania połączenia z kontem magazynu. | "identityBased" "keyBased" |
Parametry połączenia | Parametry połączenia dla konta usługi Azure Storage, do którego są przekazywane pliki. | ciąg (wymagany) |
containerName | Nazwa kontenera głównego, w którym są przekazywane pliki. Kontener nie musi istnieć, ale powinien być creatable przy użyciu określonego parametru connectionString. | ciąg (wymagany) |
identity | Właściwości tożsamości zarządzanej punktu końcowego magazynu na potrzeby przekazywania plików. | ManagedIdentity |
sasTtlAsIso8601 | Okres, dla którego identyfikator URI sygnatury dostępu współdzielonego wygenerowany przez IoT Hub przekazywania plików jest prawidłowy. Zobacz: /azure/iot-hub/iot-hub-devguide-file-upload#file-upload-notification-configuration-options. | ciąg |
IotHubSkuInfo
Nazwa | Opis | Wartość |
---|---|---|
capacity | Liczba aprowizowania jednostek IoT Hub. Zobacz: /azure/azure-subscription-service-limits#iot-hub-limits. | int |
name | Nazwa jednostki SKU. | "B1" "B2" "B3" "F1" "S1" "S2" "S3" (wymagane) |