Udostępnij za pośrednictwem


Microsoft.Devices IotHubs 2021-03-03-preview

Definicja zasobu Bicep

Typ zasobu IotHubs można wdrożyć przy użyciu operacji docelowych:

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.

Format zasobu

Aby utworzyć zasób Microsoft.Devices/IotHubs, dodaj następujący kod Bicep do szablonu.

resource symbolicname 'Microsoft.Devices/IotHubs@2021-03-03-preview' = {
  etag: 'string'
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  location: 'string'
  name: 'string'
  properties: {
    authorizationPolicies: [
      {
        keyName: 'string'
        primaryKey: 'string'
        rights: 'string'
        secondaryKey: 'string'
      }
    ]
    cloudToDevice: {
      defaultTtlAsIso8601: 'string'
      feedback: {
        lockDurationAsIso8601: 'string'
        maxDeliveryCount: int
        ttlAsIso8601: 'string'
      }
      maxDeliveryCount: int
    }
    comments: 'string'
    deviceStreams: {
      streamingEndpoints: [
        'string'
      ]
    }
    enableFileUploadNotifications: bool
    encryption: {
      keySource: 'string'
      keyVaultProperties: [
        {
          identity: {
            userAssignedIdentity: 'string'
          }
          keyIdentifier: 'string'
        }
      ]
    }
    eventHubEndpoints: {
      {customized property}: {
        partitionCount: int
        retentionTimeInDays: int
      }
    }
    features: 'string'
    ipFilterRules: [
      {
        action: 'string'
        filterName: 'string'
        ipMask: 'string'
      }
    ]
    messagingEndpoints: {
      {customized property}: {
        lockDurationAsIso8601: 'string'
        maxDeliveryCount: int
        ttlAsIso8601: 'string'
      }
    }
    minTlsVersion: 'string'
    networkRuleSets: {
      applyToBuiltInEventHubEndpoint: bool
      defaultAction: 'string'
      ipRules: [
        {
          action: 'string'
          filterName: 'string'
          ipMask: 'string'
        }
      ]
    }
    privateEndpointConnections: [
      {
        properties: {
          privateEndpoint: {}
          privateLinkServiceConnectionState: {
            actionsRequired: 'string'
            description: 'string'
            status: 'string'
          }
        }
      }
    ]
    publicNetworkAccess: 'string'
    routing: {
      endpoints: {
        eventHubs: [
          {
            authenticationType: 'string'
            connectionString: 'string'
            endpointUri: 'string'
            entityPath: 'string'
            id: 'string'
            identity: {
              userAssignedIdentity: 'string'
            }
            name: 'string'
            resourceGroup: 'string'
            subscriptionId: 'string'
          }
        ]
        serviceBusQueues: [
          {
            authenticationType: 'string'
            connectionString: 'string'
            endpointUri: 'string'
            entityPath: 'string'
            id: 'string'
            identity: {
              userAssignedIdentity: 'string'
            }
            name: 'string'
            resourceGroup: 'string'
            subscriptionId: 'string'
          }
        ]
        serviceBusTopics: [
          {
            authenticationType: 'string'
            connectionString: 'string'
            endpointUri: 'string'
            entityPath: 'string'
            id: 'string'
            identity: {
              userAssignedIdentity: 'string'
            }
            name: 'string'
            resourceGroup: 'string'
            subscriptionId: 'string'
          }
        ]
        storageContainers: [
          {
            authenticationType: 'string'
            batchFrequencyInSeconds: int
            connectionString: 'string'
            containerName: 'string'
            encoding: 'string'
            endpointUri: 'string'
            fileNameFormat: 'string'
            id: 'string'
            identity: {
              userAssignedIdentity: 'string'
            }
            maxChunkSizeInBytes: int
            name: 'string'
            resourceGroup: 'string'
            subscriptionId: 'string'
          }
        ]
      }
      enrichments: [
        {
          endpointNames: [
            'string'
          ]
          key: 'string'
          value: 'string'
        }
      ]
      fallbackRoute: {
        condition: 'string'
        endpointNames: [
          'string'
        ]
        isEnabled: bool
        name: 'string'
        source: 'string'
      }
      routes: [
        {
          condition: 'string'
          endpointNames: [
            'string'
          ]
          isEnabled: bool
          name: 'string'
          source: 'string'
        }
      ]
    }
    storageEndpoints: {
      {customized property}: {
        authenticationType: 'string'
        connectionString: 'string'
        containerName: 'string'
        identity: {
          userAssignedIdentity: 'string'
        }
        sasTtlAsIso8601: 'string'
      }
    }
  }
  sku: {
    capacity: int
    name: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Wartości właściwości

ArmIdentity

Nazwa Opis Wartość
typ Typ tożsamości używany 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ść

ArmUserIdentity

Nazwa Opis Wartość

CloudToDeviceProperties

Nazwa Opis Wartość
defaultTtlAsIso8601 Domyślny czas wygaśnięcia komunikatów z chmury do urządzenia w kolejce urządzeń. Zobacz: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. struna
sprzężenie zwrotne Właściwości kolejki opinii dla komunikatów z chmury do urządzenia. FeedbackProperties
maxDeliveryCount Maksymalna liczba dostaw komunikatów z chmury do urządzenia w kolejce urządzeń. Zobacz: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. Int

Ograniczenia:
Minimalna wartość = 1
Wartość maksymalna = 100

EncryptionPropertiesDescription

Nazwa Opis Wartość
keySource Źródło klucza. struna
keyVaultProperties Właściwości klucza keyVault. KeyVaultKeyProperties[]

Wzbogacaniewłaściwości

Nazwa Opis Wartość
endpointNames Lista punktów końcowych, dla których wzbogacenie jest stosowane do komunikatu. string[] (wymagane)
klucz Klucz lub nazwa właściwości wzbogacania. ciąg (wymagany)
wartość Wartość właściwości wzbogacania. ciąg (wymagany)

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

FallbackRouteProperties

Nazwa Opis Wartość
warunek Warunek, który jest oceniany w celu zastosowania trasy rezerwowej. Jeśli warunek nie zostanie podany, zostanie on domyślnie obliczony na wartość true. Aby uzyskać informacje o gramatyce, zobacz: /azure/iot-hub/iot-hub-devguide-query-language struna
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)
isEnabled Służy do określania, czy trasa rezerwowa jest włączona. bool (wymagane)
nazwa Nazwa trasy. Nazwa może zawierać tylko znaki alfanumeryczne, kropki, podkreślenia, łączniki, ma maksymalną długość 64 znaków i musi być unikatowa. struna
źródło Źródło, do którego ma zostać zastosowana reguła routingu. Na przykład DeviceMessages "DeviceConnectionStateEvents"
"DeviceJobLifecycleEvents"
"DeviceLifecycleEvents"
"DeviceMessages"
"DigitalTwinChangeEvents"
"Nieprawidłowy"
"TwinChangeEvents" (wymagane)

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. struna
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
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. struna

IotHubProperties

Nazwa Opis Wartość
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 w chmurze do urządzenia w usłudze IoT Hub. CloudToDeviceProperties
Komentarze Komentarze centrum IoT Hub. struna
deviceStreams Urządzenie przesyła strumieniowo właściwości iothub. IotHubPropertiesDeviceStreams
enableFileUploadNotifications Jeśli wartość True, powiadomienia dotyczące przekazywania plików są włączone. Bool
szyfrowanie Właściwości szyfrowania centrum IoT Hub. EncryptionPropertiesDescription
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 Hub. "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 starszej niż 1.2 zostali odrzuceni. struna
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"
Routingu Właściwości związane z routingiem centrum IoT Hub. Zobacz: /azure/iot-hub/iot-hub-devguide-messaging RoutingWłaściwości
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, co powoduje zgłoszenie błędu. IotHubPropertiesStorageEndpoints

IotHubPropertiesDeviceStreams

Nazwa Opis Wartość
streamingEndpoints Lista punktów końcowych strumieni urządzeń. string[]

IotHubPropertiesEventHubEndpoints

Nazwa Opis Wartość

IotHubPropertiesMessagingEndpoints

Nazwa Opis Wartość

IotHubPropertiesStorageEndpoints

Nazwa Opis Wartość

IotHubSkuInfo

Nazwa Opis Wartość
pojemność Liczba aprowizowania jednostek usługi IoT Hub. Zobacz: /azure/azure-subscription-service-limits#iot-hub-limits. Int
nazwa Nazwa jednostki SKU. "B1"
"B2"
"B3"
"F1"
"S1"
"S2"
"S3" (wymagane)

IpFilterRule

Nazwa Opis Wartość
akcja Żądana akcja żądań przechwyconych przez tę regułę. "Zaakceptuj"
"Odrzuć" (wymagane)
filterName Nazwa reguły filtru adresów IP. ciąg (wymagany)
maska ip Ciąg zawierający zakres adresów IP w notacji CIDR dla reguły. ciąg (wymagany)

KeyVaultKeyProperties

Nazwa Opis Wartość
tożsamość Właściwości tożsamości zarządzanej klucza usługi KeyVault. ManagedIdentity
keyIdentifier Identyfikator klucza. struna

Identyfikator zarządzany

Nazwa Opis Wartość
userAssignedIdentity Tożsamość przypisana przez użytkownika. struna

MessagingEndpointProperties

Nazwa Opis Wartość
lockDurationAsIso8601 Czas trwania blokady. Zobacz: /azure/iot-hub/iot-hub-devguide-file-upload. struna
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. struna

Microsoft.Devices/IotHubs

Nazwa Opis Wartość
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. struna
tożsamość Tożsamości zarządzane dla usługi IotHub. ArmIdentity
lokalizacja Lokalizacja zasobu. ciąg (wymagany)
nazwa Nazwa zasobu ciąg (wymagany)
Właściwości Właściwości usługi IotHub IotHubProperties
Numer jednostki magazynowej Informacje o jednostce SKU usługi IotHub IotHubSkuInfo (wymagane)
Tagi Tagi zasobów Słownik nazw tagów i wartości. Zobacz tagi w szablonach

NetworkRuleSetIpRule

Nazwa Opis Wartość
akcja Akcja filtru IP "Zezwalaj"
filterName Nazwa reguły filtru adresów IP. ciąg (wymagany)
maska ip Ciąg zawierający zakres adresów IP w notacji CIDR dla reguły. ciąg (wymagany)

NetworkRuleSetProperties

Nazwa Opis Wartość
applyToBuiltInEventHubEndpoint Jeśli wartość True, zestaw reguł sieciowych jest również stosowany do aplikacji BuiltIn EventHub EndPoint usługi IotHub bool (wymagane)
defaultAction Domyślna akcja dla zestawu reguł sieci "Zezwalaj"
"Odmów"
ipRules Lista reguł adresów IP NetworkRuleSetIpRule[] (wymagane)

PrivateEndpoint

Nazwa Opis Wartość

PrivateEndpointConnection

Nazwa Opis Wartość
Właściwości 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)

PrivateLinkServiceConnectionState

Nazwa Opis Wartość
actionsRequired Akcje wymagane dla połączenia prywatnego punktu końcowego struna
opis Opis bieżącego stanu połączenia prywatnego punktu końcowego ciąg (wymagany)
stan Stan połączenia prywatnego punktu końcowego "Zatwierdzone"
"Rozłączono"
"Oczekujące"
"Odrzucono" (wymagane)

Tagi zasobów

Nazwa Opis Wartość

Właściwości trasy

Nazwa Opis Wartość
warunek Warunek, który jest obliczany w celu zastosowania reguły routingu. Jeśli nie podano warunku, wartość jest domyślnie obliczana na wartość true. W przypadku gramatyki zobacz: /azure/iot-hub/iot-hub-devguide-query-language struna
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)
isEnabled Służy do określania, czy trasa jest włączona. bool (wymagane)
nazwa Nazwa trasy. Nazwa może zawierać tylko znaki alfanumeryczne, kropki, podkreślenia, łączniki, ma maksymalną długość 64 znaków i musi być unikatowa. struna

Ograniczenia:
Wzorzec = ^[A-Za-z0-9-._]{1,64}$ (wymagane)
źródło Źródłem, do którego ma być zastosowana reguła routingu, na przykład DeviceMessages. "DeviceConnectionStateEvents"
"DeviceJobLifecycleEvents"
"DeviceLifecycleEvents"
"DeviceMessages"
"DigitalTwinChangeEvents"
"Nieprawidłowy"
"TwinChangeEvents" (wymagane)

Punkty routingu

Nazwa Opis Wartość
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[]

RoutingEventHubProperties

Nazwa Opis Wartość
authenticationType Metoda używana do uwierzytelniania względem punktu końcowego centrum zdarzeń "identityBased"
"keyBased"
connectionString Parametry połączenia punktu końcowego centrum zdarzeń. struna
endpointUri Adres URL punktu końcowego centrum zdarzeń. Musi zawierać protokół sb:// struna
entityPath Nazwa centrum zdarzeń w przestrzeni nazw centrum zdarzeń struna
id Identyfikator punktu końcowego centrum zdarzeń struna
tożsamość Właściwości tożsamości zarządzanej punktu końcowego centrum zdarzeń routingu. ManagedIdentity
nazwa 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. struna

Ograniczenia:
Wzorzec = ^[A-Za-z0-9-._]{1,64}$ (wymagane)
resourceGroup Nazwa grupy zasobów punktu końcowego centrum zdarzeń. struna
subscriptionId Identyfikator subskrypcji punktu końcowego centrum zdarzeń. struna

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. Dozwolone jest maksymalnie 10 niestandardowych punktów końcowych 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. RoutingEndpoints
wzbogacania Lista wzbogaceń 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 powrotna, 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 ustawiona, komunikaty, które nie spełniają żadnego z warunków określonych w sekcji "trasy", są kierowane do wbudowanego punktu końcowego usługi EventHub. 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 dozwolonych jest maksymalnie 100 reguł routingu, a w przypadku bezpłatnych centrów dozwolonych jest maksymalnie 5 reguł routingu. RouteProperties[]

RoutingServiceBusQueueEndpointProperties

Nazwa Opis Wartość
authenticationType Metoda używana do uwierzytelniania względem punktu końcowego kolejki usługi Service Bus "identityBased"
"keyBased"
connectionString Parametry połączenia punktu końcowego kolejki usługi Service Bus. struna
endpointUri Adres URL punktu końcowego kolejki usługi Service Bus. Musi zawierać protokół sb:// struna
entityPath Nazwa kolejki w przestrzeni nazw usługi Service Bus struna
id Identyfikator punktu końcowego kolejki usługi Service Bus struna
tożsamość Właściwości tożsamości zarządzanej punktu końcowego kolejki usługi Service Bus. ManagedIdentity
nazwa 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. struna

Ograniczenia:
Wzorzec = ^[A-Za-z0-9-._]{1,64}$ (wymagane)
resourceGroup Nazwa grupy zasobów punktu końcowego kolejki usługi Service Bus. struna
subscriptionId Identyfikator subskrypcji punktu końcowego kolejki usługi Service Bus. struna

RoutingServiceBusTopicEndpointProperties

Nazwa Opis Wartość
authenticationType Metoda używana do uwierzytelniania względem punktu końcowego tematu usługi Service Bus "identityBased"
"keyBased"
connectionString Parametry połączenia punktu końcowego tematu usługi Service Bus. struna
endpointUri Adres URL punktu końcowego tematu usługi Service Bus. Musi zawierać protokół sb:// struna
entityPath Nazwa kolejki w temacie usługi Service Bus struna
id Identyfikator punktu końcowego tematu usługi Service Bus struna
tożsamość Właściwości tożsamości zarządzanej punktu końcowego tematu usługi Service Bus. ManagedIdentity
nazwa 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. struna

Ograniczenia:
Wzorzec = ^[A-Za-z0-9-._]{1,64}$ (wymagane)
resourceGroup Nazwa grupy zasobów punktu końcowego tematu usługi Service Bus. struna
subscriptionId Identyfikator subskrypcji punktu końcowego tematu usługi Service Bus. struna

RoutingStorageContainerProperties

Nazwa Opis Wartość
authenticationType Metoda używana do uwierzytelniania względem punktu końcowego 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
Wartość maksymalna = 720
connectionString Parametry połączenia konta magazynu. struna
containerName Nazwa kontenera magazynu na koncie magazynu. ciąg (wymagany)
kodowanie 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:// struna
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ść. struna
id Identyfikator punktu końcowego kontenera magazynu struna
tożsamość 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 zakresu od 10485760(10 MB) do 524288000(500 MB). Wartość domyślna to 314572800(300 MB). Int

Ograniczenia:
Minimalna wartość = 10485760
Wartość maksymalna = 524288000
nazwa 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. struna

Ograniczenia:
Wzorzec = ^[A-Za-z0-9-._]{1,64}$ (wymagane)
resourceGroup Nazwa grupy zasobów konta magazynu. struna
subscriptionId Identyfikator subskrypcji konta magazynu. struna

SharedAccessSignatureAuthorizationRule

Nazwa Opis Wartość
keyName Nazwa zasad dostępu współdzielonego. ciąg (wymagany)
primaryKey Klucz podstawowy. struna
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. struna

StorageEndpointProperties

Nazwa Opis Wartość
authenticationType Określa typ uwierzytelniania używany do nawiązywania połączenia z kontem magazynu. "identityBased"
"keyBased"
connectionString 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)
tożsamość 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 usługę IoT Hub na potrzeby przekazywania plików jest prawidłowy. Zobacz: /azure/iot-hub/iot-hub-devguide-file-upload#file-upload-notification-configuration-options. struna

Przykłady z przewodnika Szybki start

W poniższych przykładach szybkiego startu wdrożono ten typ zasobu.

Plik Bicep Opis
tworzenie usługi IoT Hub i grupy odbiorców urządzenia do chmury Ten szablon umożliwia wdrożenie wystąpienia usługi 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 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 aktualizacji urządzenia dla konta usługi IoT Hub, wystąpienia, usługi IoT Hub Ten szablon tworzy konto, wystąpienie i centrum w celu połączenia wystąpienia z nim. Konfiguruje koncentrator z niezbędnymi zasadami dostępu, trasami i grupą konsumentów.
Wdrażanie usługi MedTech, w tym usługi 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 następnie są utrwalane w usłudze FHIR usług Azure Health Data Services.
Tworzenie usługi IoT Hub za pomocą szablonu usługi ARM, kierowanie i wyświetlanie komunikatów Użyj tego szablonu, aby wdrożyć usługę 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.

Definicja zasobu szablonu usługi ARM

Typ zasobu IotHubs można wdrożyć przy użyciu operacji docelowych:

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.

Format zasobu

Aby utworzyć zasób Microsoft.Devices/IotHubs, dodaj następujący kod JSON do szablonu.

{
  "type": "Microsoft.Devices/IotHubs",
  "apiVersion": "2021-03-03-preview",
  "name": "string",
  "etag": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
      }
    }
  },
  "location": "string",
  "properties": {
    "authorizationPolicies": [
      {
        "keyName": "string",
        "primaryKey": "string",
        "rights": "string",
        "secondaryKey": "string"
      }
    ],
    "cloudToDevice": {
      "defaultTtlAsIso8601": "string",
      "feedback": {
        "lockDurationAsIso8601": "string",
        "maxDeliveryCount": "int",
        "ttlAsIso8601": "string"
      },
      "maxDeliveryCount": "int"
    },
    "comments": "string",
    "deviceStreams": {
      "streamingEndpoints": [ "string" ]
    },
    "enableFileUploadNotifications": "bool",
    "encryption": {
      "keySource": "string",
      "keyVaultProperties": [
        {
          "identity": {
            "userAssignedIdentity": "string"
          },
          "keyIdentifier": "string"
        }
      ]
    },
    "eventHubEndpoints": {
      "{customized property}": {
        "partitionCount": "int",
        "retentionTimeInDays": "int"
      }
    },
    "features": "string",
    "ipFilterRules": [
      {
        "action": "string",
        "filterName": "string",
        "ipMask": "string"
      }
    ],
    "messagingEndpoints": {
      "{customized property}": {
        "lockDurationAsIso8601": "string",
        "maxDeliveryCount": "int",
        "ttlAsIso8601": "string"
      }
    },
    "minTlsVersion": "string",
    "networkRuleSets": {
      "applyToBuiltInEventHubEndpoint": "bool",
      "defaultAction": "string",
      "ipRules": [
        {
          "action": "string",
          "filterName": "string",
          "ipMask": "string"
        }
      ]
    },
    "privateEndpointConnections": [
      {
        "properties": {
          "privateEndpoint": {
          },
          "privateLinkServiceConnectionState": {
            "actionsRequired": "string",
            "description": "string",
            "status": "string"
          }
        }
      }
    ],
    "publicNetworkAccess": "string",
    "routing": {
      "endpoints": {
        "eventHubs": [
          {
            "authenticationType": "string",
            "connectionString": "string",
            "endpointUri": "string",
            "entityPath": "string",
            "id": "string",
            "identity": {
              "userAssignedIdentity": "string"
            },
            "name": "string",
            "resourceGroup": "string",
            "subscriptionId": "string"
          }
        ],
        "serviceBusQueues": [
          {
            "authenticationType": "string",
            "connectionString": "string",
            "endpointUri": "string",
            "entityPath": "string",
            "id": "string",
            "identity": {
              "userAssignedIdentity": "string"
            },
            "name": "string",
            "resourceGroup": "string",
            "subscriptionId": "string"
          }
        ],
        "serviceBusTopics": [
          {
            "authenticationType": "string",
            "connectionString": "string",
            "endpointUri": "string",
            "entityPath": "string",
            "id": "string",
            "identity": {
              "userAssignedIdentity": "string"
            },
            "name": "string",
            "resourceGroup": "string",
            "subscriptionId": "string"
          }
        ],
        "storageContainers": [
          {
            "authenticationType": "string",
            "batchFrequencyInSeconds": "int",
            "connectionString": "string",
            "containerName": "string",
            "encoding": "string",
            "endpointUri": "string",
            "fileNameFormat": "string",
            "id": "string",
            "identity": {
              "userAssignedIdentity": "string"
            },
            "maxChunkSizeInBytes": "int",
            "name": "string",
            "resourceGroup": "string",
            "subscriptionId": "string"
          }
        ]
      },
      "enrichments": [
        {
          "endpointNames": [ "string" ],
          "key": "string",
          "value": "string"
        }
      ],
      "fallbackRoute": {
        "condition": "string",
        "endpointNames": [ "string" ],
        "isEnabled": "bool",
        "name": "string",
        "source": "string"
      },
      "routes": [
        {
          "condition": "string",
          "endpointNames": [ "string" ],
          "isEnabled": "bool",
          "name": "string",
          "source": "string"
        }
      ]
    },
    "storageEndpoints": {
      "{customized property}": {
        "authenticationType": "string",
        "connectionString": "string",
        "containerName": "string",
        "identity": {
          "userAssignedIdentity": "string"
        },
        "sasTtlAsIso8601": "string"
      }
    }
  },
  "sku": {
    "capacity": "int",
    "name": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Wartości właściwości

ArmIdentity

Nazwa Opis Wartość
typ Typ tożsamości używany 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ść

ArmUserIdentity

Nazwa Opis Wartość

CloudToDeviceProperties

Nazwa Opis Wartość
defaultTtlAsIso8601 Domyślny czas wygaśnięcia komunikatów z chmury do urządzenia w kolejce urządzeń. Zobacz: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. struna
sprzężenie zwrotne Właściwości kolejki opinii dla komunikatów z chmury do urządzenia. FeedbackProperties
maxDeliveryCount Maksymalna liczba dostaw komunikatów z chmury do urządzenia w kolejce urządzeń. Zobacz: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. Int

Ograniczenia:
Minimalna wartość = 1
Wartość maksymalna = 100

EncryptionPropertiesDescription

Nazwa Opis Wartość
keySource Źródło klucza. struna
keyVaultProperties Właściwości klucza keyVault. KeyVaultKeyProperties[]

Wzbogacaniewłaściwości

Nazwa Opis Wartość
endpointNames Lista punktów końcowych, dla których wzbogacenie jest stosowane do komunikatu. string[] (wymagane)
klucz Klucz lub nazwa właściwości wzbogacania. ciąg (wymagany)
wartość Wartość właściwości wzbogacania. ciąg (wymagany)

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

FallbackRouteProperties

Nazwa Opis Wartość
warunek Warunek, który jest oceniany w celu zastosowania trasy rezerwowej. Jeśli warunek nie zostanie podany, zostanie on domyślnie obliczony na wartość true. Aby uzyskać informacje o gramatyce, zobacz: /azure/iot-hub/iot-hub-devguide-query-language struna
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)
isEnabled Służy do określania, czy trasa rezerwowa jest włączona. bool (wymagane)
nazwa Nazwa trasy. Nazwa może zawierać tylko znaki alfanumeryczne, kropki, podkreślenia, łączniki, ma maksymalną długość 64 znaków i musi być unikatowa. struna
źródło Źródło, do którego ma zostać zastosowana reguła routingu. Na przykład DeviceMessages "DeviceConnectionStateEvents"
"DeviceJobLifecycleEvents"
"DeviceLifecycleEvents"
"DeviceMessages"
"DigitalTwinChangeEvents"
"Nieprawidłowy"
"TwinChangeEvents" (wymagane)

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. struna
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
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. struna

IotHubProperties

Nazwa Opis Wartość
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 w chmurze do urządzenia w usłudze IoT Hub. CloudToDeviceProperties
Komentarze Komentarze centrum IoT Hub. struna
deviceStreams Urządzenie przesyła strumieniowo właściwości iothub. IotHubPropertiesDeviceStreams
enableFileUploadNotifications Jeśli wartość True, powiadomienia dotyczące przekazywania plików są włączone. Bool
szyfrowanie Właściwości szyfrowania centrum IoT Hub. EncryptionPropertiesDescription
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 Hub. "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 starszej niż 1.2 zostali odrzuceni. struna
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"
Routingu Właściwości związane z routingiem centrum IoT Hub. Zobacz: /azure/iot-hub/iot-hub-devguide-messaging RoutingWłaściwości
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, co powoduje zgłoszenie błędu. IotHubPropertiesStorageEndpoints

IotHubPropertiesDeviceStreams

Nazwa Opis Wartość
streamingEndpoints Lista punktów końcowych strumieni urządzeń. string[]

IotHubPropertiesEventHubEndpoints

Nazwa Opis Wartość

IotHubPropertiesMessagingEndpoints

Nazwa Opis Wartość

IotHubPropertiesStorageEndpoints

Nazwa Opis Wartość

IotHubSkuInfo

Nazwa Opis Wartość
pojemność Liczba aprowizowania jednostek usługi IoT Hub. Zobacz: /azure/azure-subscription-service-limits#iot-hub-limits. Int
nazwa Nazwa jednostki SKU. "B1"
"B2"
"B3"
"F1"
"S1"
"S2"
"S3" (wymagane)

IpFilterRule

Nazwa Opis Wartość
akcja Żądana akcja żądań przechwyconych przez tę regułę. "Zaakceptuj"
"Odrzuć" (wymagane)
filterName Nazwa reguły filtru adresów IP. ciąg (wymagany)
maska ip Ciąg zawierający zakres adresów IP w notacji CIDR dla reguły. ciąg (wymagany)

KeyVaultKeyProperties

Nazwa Opis Wartość
tożsamość Właściwości tożsamości zarządzanej klucza usługi KeyVault. ManagedIdentity
keyIdentifier Identyfikator klucza. struna

Identyfikator zarządzany

Nazwa Opis Wartość
userAssignedIdentity Tożsamość przypisana przez użytkownika. struna

MessagingEndpointProperties

Nazwa Opis Wartość
lockDurationAsIso8601 Czas trwania blokady. Zobacz: /azure/iot-hub/iot-hub-devguide-file-upload. struna
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. struna

Microsoft.Devices/IotHubs

Nazwa Opis Wartość
apiVersion Wersja interfejsu API "2021-03-03-preview"
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. struna
tożsamość Tożsamości zarządzane dla usługi IotHub. ArmIdentity
lokalizacja Lokalizacja zasobu. ciąg (wymagany)
nazwa Nazwa zasobu ciąg (wymagany)
Właściwości Właściwości usługi IotHub IotHubProperties
Numer jednostki magazynowej Informacje o jednostce SKU usługi IotHub IotHubSkuInfo (wymagane)
Tagi Tagi zasobów Słownik nazw tagów i wartości. Zobacz tagi w szablonach
typ Typ zasobu "Microsoft.Devices/IotHubs"

NetworkRuleSetIpRule

Nazwa Opis Wartość
akcja Akcja filtru IP "Zezwalaj"
filterName Nazwa reguły filtru adresów IP. ciąg (wymagany)
maska ip Ciąg zawierający zakres adresów IP w notacji CIDR dla reguły. ciąg (wymagany)

NetworkRuleSetProperties

Nazwa Opis Wartość
applyToBuiltInEventHubEndpoint Jeśli wartość True, zestaw reguł sieciowych jest również stosowany do aplikacji BuiltIn EventHub EndPoint usługi IotHub bool (wymagane)
defaultAction Domyślna akcja dla zestawu reguł sieci "Zezwalaj"
"Odmów"
ipRules Lista reguł adresów IP NetworkRuleSetIpRule[] (wymagane)

PrivateEndpoint

Nazwa Opis Wartość

PrivateEndpointConnection

Nazwa Opis Wartość
Właściwości 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)

PrivateLinkServiceConnectionState

Nazwa Opis Wartość
actionsRequired Akcje wymagane dla połączenia prywatnego punktu końcowego struna
opis Opis bieżącego stanu połączenia prywatnego punktu końcowego ciąg (wymagany)
stan Stan połączenia prywatnego punktu końcowego "Zatwierdzone"
"Rozłączono"
"Oczekujące"
"Odrzucono" (wymagane)

Tagi zasobów

Nazwa Opis Wartość

Właściwości trasy

Nazwa Opis Wartość
warunek Warunek, który jest obliczany w celu zastosowania reguły routingu. Jeśli nie podano warunku, wartość jest domyślnie obliczana na wartość true. W przypadku gramatyki zobacz: /azure/iot-hub/iot-hub-devguide-query-language struna
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)
isEnabled Służy do określania, czy trasa jest włączona. bool (wymagane)
nazwa Nazwa trasy. Nazwa może zawierać tylko znaki alfanumeryczne, kropki, podkreślenia, łączniki, ma maksymalną długość 64 znaków i musi być unikatowa. struna

Ograniczenia:
Wzorzec = ^[A-Za-z0-9-._]{1,64}$ (wymagane)
źródło Źródłem, do którego ma być zastosowana reguła routingu, na przykład DeviceMessages. "DeviceConnectionStateEvents"
"DeviceJobLifecycleEvents"
"DeviceLifecycleEvents"
"DeviceMessages"
"DigitalTwinChangeEvents"
"Nieprawidłowy"
"TwinChangeEvents" (wymagane)

Punkty routingu

Nazwa Opis Wartość
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[]

RoutingEventHubProperties

Nazwa Opis Wartość
authenticationType Metoda używana do uwierzytelniania względem punktu końcowego centrum zdarzeń "identityBased"
"keyBased"
connectionString Parametry połączenia punktu końcowego centrum zdarzeń. struna
endpointUri Adres URL punktu końcowego centrum zdarzeń. Musi zawierać protokół sb:// struna
entityPath Nazwa centrum zdarzeń w przestrzeni nazw centrum zdarzeń struna
id Identyfikator punktu końcowego centrum zdarzeń struna
tożsamość Właściwości tożsamości zarządzanej punktu końcowego centrum zdarzeń routingu. ManagedIdentity
nazwa 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. struna

Ograniczenia:
Wzorzec = ^[A-Za-z0-9-._]{1,64}$ (wymagane)
resourceGroup Nazwa grupy zasobów punktu końcowego centrum zdarzeń. struna
subscriptionId Identyfikator subskrypcji punktu końcowego centrum zdarzeń. struna

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. Dozwolone jest maksymalnie 10 niestandardowych punktów końcowych 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. RoutingEndpoints
wzbogacania Lista wzbogaceń 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 powrotna, 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 ustawiona, komunikaty, które nie spełniają żadnego z warunków określonych w sekcji "trasy", są kierowane do wbudowanego punktu końcowego usługi EventHub. 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 dozwolonych jest maksymalnie 100 reguł routingu, a w przypadku bezpłatnych centrów dozwolonych jest maksymalnie 5 reguł routingu. RouteProperties[]

RoutingServiceBusQueueEndpointProperties

Nazwa Opis Wartość
authenticationType Metoda używana do uwierzytelniania względem punktu końcowego kolejki usługi Service Bus "identityBased"
"keyBased"
connectionString Parametry połączenia punktu końcowego kolejki usługi Service Bus. struna
endpointUri Adres URL punktu końcowego kolejki usługi Service Bus. Musi zawierać protokół sb:// struna
entityPath Nazwa kolejki w przestrzeni nazw usługi Service Bus struna
id Identyfikator punktu końcowego kolejki usługi Service Bus struna
tożsamość Właściwości tożsamości zarządzanej punktu końcowego kolejki usługi Service Bus. ManagedIdentity
nazwa 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. struna

Ograniczenia:
Wzorzec = ^[A-Za-z0-9-._]{1,64}$ (wymagane)
resourceGroup Nazwa grupy zasobów punktu końcowego kolejki usługi Service Bus. struna
subscriptionId Identyfikator subskrypcji punktu końcowego kolejki usługi Service Bus. struna

RoutingServiceBusTopicEndpointProperties

Nazwa Opis Wartość
authenticationType Metoda używana do uwierzytelniania względem punktu końcowego tematu usługi Service Bus "identityBased"
"keyBased"
connectionString Parametry połączenia punktu końcowego tematu usługi Service Bus. struna
endpointUri Adres URL punktu końcowego tematu usługi Service Bus. Musi zawierać protokół sb:// struna
entityPath Nazwa kolejki w temacie usługi Service Bus struna
id Identyfikator punktu końcowego tematu usługi Service Bus struna
tożsamość Właściwości tożsamości zarządzanej punktu końcowego tematu usługi Service Bus. ManagedIdentity
nazwa 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. struna

Ograniczenia:
Wzorzec = ^[A-Za-z0-9-._]{1,64}$ (wymagane)
resourceGroup Nazwa grupy zasobów punktu końcowego tematu usługi Service Bus. struna
subscriptionId Identyfikator subskrypcji punktu końcowego tematu usługi Service Bus. struna

RoutingStorageContainerProperties

Nazwa Opis Wartość
authenticationType Metoda używana do uwierzytelniania względem punktu końcowego 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
Wartość maksymalna = 720
connectionString Parametry połączenia konta magazynu. struna
containerName Nazwa kontenera magazynu na koncie magazynu. ciąg (wymagany)
kodowanie 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:// struna
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ść. struna
id Identyfikator punktu końcowego kontenera magazynu struna
tożsamość 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 zakresu od 10485760(10 MB) do 524288000(500 MB). Wartość domyślna to 314572800(300 MB). Int

Ograniczenia:
Minimalna wartość = 10485760
Wartość maksymalna = 524288000
nazwa 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. struna

Ograniczenia:
Wzorzec = ^[A-Za-z0-9-._]{1,64}$ (wymagane)
resourceGroup Nazwa grupy zasobów konta magazynu. struna
subscriptionId Identyfikator subskrypcji konta magazynu. struna

SharedAccessSignatureAuthorizationRule

Nazwa Opis Wartość
keyName Nazwa zasad dostępu współdzielonego. ciąg (wymagany)
primaryKey Klucz podstawowy. struna
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. struna

StorageEndpointProperties

Nazwa Opis Wartość
authenticationType Określa typ uwierzytelniania używany do nawiązywania połączenia z kontem magazynu. "identityBased"
"keyBased"
connectionString 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)
tożsamość 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 usługę IoT Hub na potrzeby przekazywania plików jest prawidłowy. Zobacz: /azure/iot-hub/iot-hub-devguide-file-upload#file-upload-notification-configuration-options. struna

Szablony szybkiego startu

Następujące szablony szybkiego startu wdrażają ten typ zasobu.

Szablon Opis
tworzenie środowiska płatności zgodnie z rzeczywistym użyciem (PAYG) przy użyciu usługi IoT Hub

wdrażanie w usłudze Azure
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 ze zdarzeń z usługi IoT Hub.
tworzenie usługi IoT Hub i grupy odbiorców urządzenia do chmury

wdrażanie w usłudze Azure
Ten szablon umożliwia wdrożenie wystąpienia usługi 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 symulatora usługi IOT Hub i ubuntu edge

wdrażanie w usłudze Azure
Ten szablon umożliwia utworzenie symulatora brzegowego centrum IOT i maszyny wirtualnej z systemem Ubuntu.
tworzenie usługi IoT Hub Device Provisioning Service

wdrażanie w usłudze Azure
Ten szablon umożliwia utworzenie centrum IoT i usługi IoT Hub Device Provisioning Oraz połączenie tych dwóch usług.
Tworzenie aktualizacji urządzenia dla konta usługi IoT Hub, wystąpienia, usługi IoT Hub

wdrażanie w usłudze Azure
Ten szablon tworzy konto, wystąpienie i centrum w celu połączenia wystąpienia z nim. Konfiguruje koncentrator z niezbędnymi zasadami dostępu, trasami i grupą konsumentów.
Wdrażanie usługi MedTech, w tym usługi Azure IoT Hub

wdrażanie w usłudze Azure
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 następnie są utrwalane w usłudze FHIR usług Azure Health Data Services.
Tworzenie usługi IoT Hub za pomocą szablonu usługi ARM, kierowanie i wyświetlanie komunikatów

wdrażanie w usłudze Azure
Użyj tego szablonu, aby wdrożyć usługę 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.

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 dziennika 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@2021-03-03-preview"
  name = "string"
  etag = "string"
  identity = {
    type = "string"
    userAssignedIdentities = {
      {customized property} = {
      }
    }
  }
  location = "string"
  sku = {
    capacity = int
    name = "string"
  }
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      authorizationPolicies = [
        {
          keyName = "string"
          primaryKey = "string"
          rights = "string"
          secondaryKey = "string"
        }
      ]
      cloudToDevice = {
        defaultTtlAsIso8601 = "string"
        feedback = {
          lockDurationAsIso8601 = "string"
          maxDeliveryCount = int
          ttlAsIso8601 = "string"
        }
        maxDeliveryCount = int
      }
      comments = "string"
      deviceStreams = {
        streamingEndpoints = [
          "string"
        ]
      }
      enableFileUploadNotifications = bool
      encryption = {
        keySource = "string"
        keyVaultProperties = [
          {
            identity = {
              userAssignedIdentity = "string"
            }
            keyIdentifier = "string"
          }
        ]
      }
      eventHubEndpoints = {
        {customized property} = {
          partitionCount = int
          retentionTimeInDays = int
        }
      }
      features = "string"
      ipFilterRules = [
        {
          action = "string"
          filterName = "string"
          ipMask = "string"
        }
      ]
      messagingEndpoints = {
        {customized property} = {
          lockDurationAsIso8601 = "string"
          maxDeliveryCount = int
          ttlAsIso8601 = "string"
        }
      }
      minTlsVersion = "string"
      networkRuleSets = {
        applyToBuiltInEventHubEndpoint = bool
        defaultAction = "string"
        ipRules = [
          {
            action = "string"
            filterName = "string"
            ipMask = "string"
          }
        ]
      }
      privateEndpointConnections = [
        {
          properties = {
            privateEndpoint = {
            }
            privateLinkServiceConnectionState = {
              actionsRequired = "string"
              description = "string"
              status = "string"
            }
          }
        }
      ]
      publicNetworkAccess = "string"
      routing = {
        endpoints = {
          eventHubs = [
            {
              authenticationType = "string"
              connectionString = "string"
              endpointUri = "string"
              entityPath = "string"
              id = "string"
              identity = {
                userAssignedIdentity = "string"
              }
              name = "string"
              resourceGroup = "string"
              subscriptionId = "string"
            }
          ]
          serviceBusQueues = [
            {
              authenticationType = "string"
              connectionString = "string"
              endpointUri = "string"
              entityPath = "string"
              id = "string"
              identity = {
                userAssignedIdentity = "string"
              }
              name = "string"
              resourceGroup = "string"
              subscriptionId = "string"
            }
          ]
          serviceBusTopics = [
            {
              authenticationType = "string"
              connectionString = "string"
              endpointUri = "string"
              entityPath = "string"
              id = "string"
              identity = {
                userAssignedIdentity = "string"
              }
              name = "string"
              resourceGroup = "string"
              subscriptionId = "string"
            }
          ]
          storageContainers = [
            {
              authenticationType = "string"
              batchFrequencyInSeconds = int
              connectionString = "string"
              containerName = "string"
              encoding = "string"
              endpointUri = "string"
              fileNameFormat = "string"
              id = "string"
              identity = {
                userAssignedIdentity = "string"
              }
              maxChunkSizeInBytes = int
              name = "string"
              resourceGroup = "string"
              subscriptionId = "string"
            }
          ]
        }
        enrichments = [
          {
            endpointNames = [
              "string"
            ]
            key = "string"
            value = "string"
          }
        ]
        fallbackRoute = {
          condition = "string"
          endpointNames = [
            "string"
          ]
          isEnabled = bool
          name = "string"
          source = "string"
        }
        routes = [
          {
            condition = "string"
            endpointNames = [
              "string"
            ]
            isEnabled = bool
            name = "string"
            source = "string"
          }
        ]
      }
      storageEndpoints = {
        {customized property} = {
          authenticationType = "string"
          connectionString = "string"
          containerName = "string"
          identity = {
            userAssignedIdentity = "string"
          }
          sasTtlAsIso8601 = "string"
        }
      }
    }
  })
}

Wartości właściwości

ArmIdentity

Nazwa Opis Wartość
typ Typ tożsamości używany 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ść

ArmUserIdentity

Nazwa Opis Wartość

CloudToDeviceProperties

Nazwa Opis Wartość
defaultTtlAsIso8601 Domyślny czas wygaśnięcia komunikatów z chmury do urządzenia w kolejce urządzeń. Zobacz: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. struna
sprzężenie zwrotne Właściwości kolejki opinii dla komunikatów z chmury do urządzenia. FeedbackProperties
maxDeliveryCount Maksymalna liczba dostaw komunikatów z chmury do urządzenia w kolejce urządzeń. Zobacz: /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. Int

Ograniczenia:
Minimalna wartość = 1
Wartość maksymalna = 100

EncryptionPropertiesDescription

Nazwa Opis Wartość
keySource Źródło klucza. struna
keyVaultProperties Właściwości klucza keyVault. KeyVaultKeyProperties[]

Wzbogacaniewłaściwości

Nazwa Opis Wartość
endpointNames Lista punktów końcowych, dla których wzbogacenie jest stosowane do komunikatu. string[] (wymagane)
klucz Klucz lub nazwa właściwości wzbogacania. ciąg (wymagany)
wartość Wartość właściwości wzbogacania. ciąg (wymagany)

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

FallbackRouteProperties

Nazwa Opis Wartość
warunek Warunek, który jest oceniany w celu zastosowania trasy rezerwowej. Jeśli warunek nie zostanie podany, zostanie on domyślnie obliczony na wartość true. Aby uzyskać informacje o gramatyce, zobacz: /azure/iot-hub/iot-hub-devguide-query-language struna
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)
isEnabled Służy do określania, czy trasa rezerwowa jest włączona. bool (wymagane)
nazwa Nazwa trasy. Nazwa może zawierać tylko znaki alfanumeryczne, kropki, podkreślenia, łączniki, ma maksymalną długość 64 znaków i musi być unikatowa. struna
źródło Źródło, do którego ma zostać zastosowana reguła routingu. Na przykład DeviceMessages "DeviceConnectionStateEvents"
"DeviceJobLifecycleEvents"
"DeviceLifecycleEvents"
"DeviceMessages"
"DigitalTwinChangeEvents"
"Nieprawidłowy"
"TwinChangeEvents" (wymagane)

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. struna
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
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. struna

IotHubProperties

Nazwa Opis Wartość
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 w chmurze do urządzenia w usłudze IoT Hub. CloudToDeviceProperties
Komentarze Komentarze centrum IoT Hub. struna
deviceStreams Urządzenie przesyła strumieniowo właściwości iothub. IotHubPropertiesDeviceStreams
enableFileUploadNotifications Jeśli wartość True, powiadomienia dotyczące przekazywania plików są włączone. Bool
szyfrowanie Właściwości szyfrowania centrum IoT Hub. EncryptionPropertiesDescription
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 Hub. "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 starszej niż 1.2 zostali odrzuceni. struna
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"
Routingu Właściwości związane z routingiem centrum IoT Hub. Zobacz: /azure/iot-hub/iot-hub-devguide-messaging RoutingWłaściwości
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, co powoduje zgłoszenie błędu. IotHubPropertiesStorageEndpoints

IotHubPropertiesDeviceStreams

Nazwa Opis Wartość
streamingEndpoints Lista punktów końcowych strumieni urządzeń. string[]

IotHubPropertiesEventHubEndpoints

Nazwa Opis Wartość

IotHubPropertiesMessagingEndpoints

Nazwa Opis Wartość

IotHubPropertiesStorageEndpoints

Nazwa Opis Wartość

IotHubSkuInfo

Nazwa Opis Wartość
pojemność Liczba aprowizowania jednostek usługi IoT Hub. Zobacz: /azure/azure-subscription-service-limits#iot-hub-limits. Int
nazwa Nazwa jednostki SKU. "B1"
"B2"
"B3"
"F1"
"S1"
"S2"
"S3" (wymagane)

IpFilterRule

Nazwa Opis Wartość
akcja Żądana akcja żądań przechwyconych przez tę regułę. "Zaakceptuj"
"Odrzuć" (wymagane)
filterName Nazwa reguły filtru adresów IP. ciąg (wymagany)
maska ip Ciąg zawierający zakres adresów IP w notacji CIDR dla reguły. ciąg (wymagany)

KeyVaultKeyProperties

Nazwa Opis Wartość
tożsamość Właściwości tożsamości zarządzanej klucza usługi KeyVault. ManagedIdentity
keyIdentifier Identyfikator klucza. struna

Identyfikator zarządzany

Nazwa Opis Wartość
userAssignedIdentity Tożsamość przypisana przez użytkownika. struna

MessagingEndpointProperties

Nazwa Opis Wartość
lockDurationAsIso8601 Czas trwania blokady. Zobacz: /azure/iot-hub/iot-hub-devguide-file-upload. struna
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. struna

Microsoft.Devices/IotHubs

Nazwa Opis Wartość
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. struna
tożsamość Tożsamości zarządzane dla usługi IotHub. ArmIdentity
lokalizacja Lokalizacja zasobu. ciąg (wymagany)
nazwa Nazwa zasobu ciąg (wymagany)
Właściwości Właściwości usługi IotHub IotHubProperties
Numer jednostki magazynowej Informacje o jednostce SKU usługi IotHub IotHubSkuInfo (wymagane)
Tagi Tagi zasobów Słownik nazw tagów i wartości.
typ Typ zasobu "Microsoft.Devices/IotHubs@2021-03-03-preview"

NetworkRuleSetIpRule

Nazwa Opis Wartość
akcja Akcja filtru IP "Zezwalaj"
filterName Nazwa reguły filtru adresów IP. ciąg (wymagany)
maska ip Ciąg zawierający zakres adresów IP w notacji CIDR dla reguły. ciąg (wymagany)

NetworkRuleSetProperties

Nazwa Opis Wartość
applyToBuiltInEventHubEndpoint Jeśli wartość True, zestaw reguł sieciowych jest również stosowany do aplikacji BuiltIn EventHub EndPoint usługi IotHub bool (wymagane)
defaultAction Domyślna akcja dla zestawu reguł sieci "Zezwalaj"
"Odmów"
ipRules Lista reguł adresów IP NetworkRuleSetIpRule[] (wymagane)

PrivateEndpoint

Nazwa Opis Wartość

PrivateEndpointConnection

Nazwa Opis Wartość
Właściwości 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)

PrivateLinkServiceConnectionState

Nazwa Opis Wartość
actionsRequired Akcje wymagane dla połączenia prywatnego punktu końcowego struna
opis Opis bieżącego stanu połączenia prywatnego punktu końcowego ciąg (wymagany)
stan Stan połączenia prywatnego punktu końcowego "Zatwierdzone"
"Rozłączono"
"Oczekujące"
"Odrzucono" (wymagane)

Tagi zasobów

Nazwa Opis Wartość

Właściwości trasy

Nazwa Opis Wartość
warunek Warunek, który jest obliczany w celu zastosowania reguły routingu. Jeśli nie podano warunku, wartość jest domyślnie obliczana na wartość true. W przypadku gramatyki zobacz: /azure/iot-hub/iot-hub-devguide-query-language struna
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)
isEnabled Służy do określania, czy trasa jest włączona. bool (wymagane)
nazwa Nazwa trasy. Nazwa może zawierać tylko znaki alfanumeryczne, kropki, podkreślenia, łączniki, ma maksymalną długość 64 znaków i musi być unikatowa. struna

Ograniczenia:
Wzorzec = ^[A-Za-z0-9-._]{1,64}$ (wymagane)
źródło Źródłem, do którego ma być zastosowana reguła routingu, na przykład DeviceMessages. "DeviceConnectionStateEvents"
"DeviceJobLifecycleEvents"
"DeviceLifecycleEvents"
"DeviceMessages"
"DigitalTwinChangeEvents"
"Nieprawidłowy"
"TwinChangeEvents" (wymagane)

Punkty routingu

Nazwa Opis Wartość
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[]

RoutingEventHubProperties

Nazwa Opis Wartość
authenticationType Metoda używana do uwierzytelniania względem punktu końcowego centrum zdarzeń "identityBased"
"keyBased"
connectionString Parametry połączenia punktu końcowego centrum zdarzeń. struna
endpointUri Adres URL punktu końcowego centrum zdarzeń. Musi zawierać protokół sb:// struna
entityPath Nazwa centrum zdarzeń w przestrzeni nazw centrum zdarzeń struna
id Identyfikator punktu końcowego centrum zdarzeń struna
tożsamość Właściwości tożsamości zarządzanej punktu końcowego centrum zdarzeń routingu. ManagedIdentity
nazwa 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. struna

Ograniczenia:
Wzorzec = ^[A-Za-z0-9-._]{1,64}$ (wymagane)
resourceGroup Nazwa grupy zasobów punktu końcowego centrum zdarzeń. struna
subscriptionId Identyfikator subskrypcji punktu końcowego centrum zdarzeń. struna

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. Dozwolone jest maksymalnie 10 niestandardowych punktów końcowych 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. RoutingEndpoints
wzbogacania Lista wzbogaceń 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 powrotna, 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 ustawiona, komunikaty, które nie spełniają żadnego z warunków określonych w sekcji "trasy", są kierowane do wbudowanego punktu końcowego usługi EventHub. 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 dozwolonych jest maksymalnie 100 reguł routingu, a w przypadku bezpłatnych centrów dozwolonych jest maksymalnie 5 reguł routingu. RouteProperties[]

RoutingServiceBusQueueEndpointProperties

Nazwa Opis Wartość
authenticationType Metoda używana do uwierzytelniania względem punktu końcowego kolejki usługi Service Bus "identityBased"
"keyBased"
connectionString Parametry połączenia punktu końcowego kolejki usługi Service Bus. struna
endpointUri Adres URL punktu końcowego kolejki usługi Service Bus. Musi zawierać protokół sb:// struna
entityPath Nazwa kolejki w przestrzeni nazw usługi Service Bus struna
id Identyfikator punktu końcowego kolejki usługi Service Bus struna
tożsamość Właściwości tożsamości zarządzanej punktu końcowego kolejki usługi Service Bus. ManagedIdentity
nazwa 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. struna

Ograniczenia:
Wzorzec = ^[A-Za-z0-9-._]{1,64}$ (wymagane)
resourceGroup Nazwa grupy zasobów punktu końcowego kolejki usługi Service Bus. struna
subscriptionId Identyfikator subskrypcji punktu końcowego kolejki usługi Service Bus. struna

RoutingServiceBusTopicEndpointProperties

Nazwa Opis Wartość
authenticationType Metoda używana do uwierzytelniania względem punktu końcowego tematu usługi Service Bus "identityBased"
"keyBased"
connectionString Parametry połączenia punktu końcowego tematu usługi Service Bus. struna
endpointUri Adres URL punktu końcowego tematu usługi Service Bus. Musi zawierać protokół sb:// struna
entityPath Nazwa kolejki w temacie usługi Service Bus struna
id Identyfikator punktu końcowego tematu usługi Service Bus struna
tożsamość Właściwości tożsamości zarządzanej punktu końcowego tematu usługi Service Bus. ManagedIdentity
nazwa 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. struna

Ograniczenia:
Wzorzec = ^[A-Za-z0-9-._]{1,64}$ (wymagane)
resourceGroup Nazwa grupy zasobów punktu końcowego tematu usługi Service Bus. struna
subscriptionId Identyfikator subskrypcji punktu końcowego tematu usługi Service Bus. struna

RoutingStorageContainerProperties

Nazwa Opis Wartość
authenticationType Metoda używana do uwierzytelniania względem punktu końcowego 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
Wartość maksymalna = 720
connectionString Parametry połączenia konta magazynu. struna
containerName Nazwa kontenera magazynu na koncie magazynu. ciąg (wymagany)
kodowanie 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:// struna
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ść. struna
id Identyfikator punktu końcowego kontenera magazynu struna
tożsamość 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 zakresu od 10485760(10 MB) do 524288000(500 MB). Wartość domyślna to 314572800(300 MB). Int

Ograniczenia:
Minimalna wartość = 10485760
Wartość maksymalna = 524288000
nazwa 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. struna

Ograniczenia:
Wzorzec = ^[A-Za-z0-9-._]{1,64}$ (wymagane)
resourceGroup Nazwa grupy zasobów konta magazynu. struna
subscriptionId Identyfikator subskrypcji konta magazynu. struna

SharedAccessSignatureAuthorizationRule

Nazwa Opis Wartość
keyName Nazwa zasad dostępu współdzielonego. ciąg (wymagany)
primaryKey Klucz podstawowy. struna
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. struna

StorageEndpointProperties

Nazwa Opis Wartość
authenticationType Określa typ uwierzytelniania używany do nawiązywania połączenia z kontem magazynu. "identityBased"
"keyBased"
connectionString 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)
tożsamość 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 usługę IoT Hub na potrzeby przekazywania plików jest prawidłowy. Zobacz: /azure/iot-hub/iot-hub-devguide-file-upload#file-upload-notification-configuration-options. struna