Azure.ResourceManager.IotHub.Models Namespace
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Classes
ArmIotHubModelFactory |
Model factory for models. |
CloudToDeviceFeedbackQueueProperties |
The properties of the feedback queue for cloud-to-device messages. |
CloudToDeviceProperties |
The IoT hub cloud-to-device messaging properties. |
EventHubCompatibleEndpointProperties |
The properties of the provisioned Event Hub-compatible endpoint used by the IoT hub. |
EventHubConsumerGroupInfoCreateOrUpdateContent |
The EventHub consumer group. |
ExportDevicesContent |
Use to provide parameters when requesting an export of all devices in the IoT hub. |
IotHubCapacity |
IoT Hub capacity information. |
IotHubCertificateProperties |
The description of an X509 CA Certificate. |
IotHubCertificatePropertiesWithNonce |
The description of an X509 CA Certificate including the challenge nonce issued for the Proof-Of-Possession flow. |
IotHubCertificateVerificationContent |
The JSON-serialized leaf certificate. |
IotHubCertificateWithNonceDescription |
The X509 Certificate. |
IotHubDescriptionPatch |
A container holding only the Tags for a resource, allowing the user to update the tags on an IoT Hub instance. |
IotHubEndpointHealthInfo |
The health data for an endpoint. |
IotHubEnrichmentProperties |
The properties of an enrichment that your IoT hub applies to messages delivered to endpoints. |
IotHubFailoverContent |
Use to provide failover region when requesting manual Failover for a hub. |
IotHubFallbackRouteProperties |
The properties of the fallback route. IoT Hub uses these properties when it routes messages to the fallback endpoint. |
IotHubImportDevicesContent |
Use to provide parameters when requesting an import of all devices in the hub. |
IotHubIPFilterRule |
The IP filter rules for the IoT hub. |
IotHubJobInfo |
The properties of the Job Response object. |
IotHubLocationDescription |
Public representation of one of the locations where a resource is provisioned. |
IotHubMatchedRoute |
Routes that matched. |
IotHubNameAvailabilityContent |
Input values. |
IotHubNameAvailabilityResponse |
The properties indicating whether a given IoT hub name is available. |
IotHubNetworkRuleSetIPRule |
IP Rule to be applied as part of Network Rule Set. |
IotHubNetworkRuleSetProperties |
Network Rule Set Properties of IotHub. |
IotHubPrivateEndpointConnectionProperties |
The properties of a private endpoint connection. |
IotHubPrivateEndpointGroupInformationProperties |
The properties for a group information object. |
IotHubPrivateLinkServiceConnectionState |
The current state of a private endpoint connection. |
IotHubProperties |
The properties of an IoT hub. |
IotHubQuotaMetricInfo |
Quota metrics properties. |
IotHubRegistryStatistics |
Identity registry statistics. |
IotHubRoutingProperties |
The routing related properties of the IoT hub. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging. |
IotHubSkuDescription |
SKU properties. |
IotHubSkuInfo |
Information about the SKU of the IoT hub. |
IotHubStorageEndpointProperties |
The properties of the Azure Storage endpoint for file upload. |
IotHubTestAllRoutesContent |
Input for testing all routes. |
IotHubTestAllRoutesResult |
Result of testing all routes. |
IotHubTestRouteContent |
Input for testing route. |
IotHubTestRouteResult |
Result of testing one route. |
IotHubTypeName |
Name of Iot Hub type. |
IotHubUserSubscriptionQuota |
User subscription quota response. |
MessagingEndpointProperties |
The properties of the messaging endpoints used by this IoT hub. |
RouteCompilationError |
Compilation error when evaluating route. |
RouteErrorPosition |
Position where the route error happened. |
RouteErrorRange |
Range of route errors. |
RoutingCosmosDBSqlApiProperties |
The properties related to a cosmos DB sql container endpoint. |
RoutingEndpoints |
The properties related to the custom endpoints to which your IoT hub routes messages based on the routing rules. A maximum of 10 custom endpoints are allowed across all endpoint types for paid hubs and only 1 custom endpoint is allowed across all endpoint types for free hubs. |
RoutingEventHubProperties |
The properties related to an event hub endpoint. |
RoutingMessage |
Routing message. |
RoutingRuleProperties |
The properties of a routing rule that your IoT hub uses to route messages to endpoints. |
RoutingServiceBusQueueEndpointProperties |
The properties related to service bus queue endpoint types. |
RoutingServiceBusTopicEndpointProperties |
The properties related to service bus topic endpoint types. |
RoutingStorageContainerProperties |
The properties related to a storage container endpoint. |
RoutingTwin |
Twin reference input parameter. This is an optional parameter. |
RoutingTwinProperties |
The RoutingTwinProperties. |
SharedAccessSignatureAuthorizationRule |
The properties of an IoT hub shared access policy. |
Structs
IotHubAuthenticationType |
Specifies authentication type being used for connecting to the storage account. |
IotHubCapability |
The capabilities and features enabled for the IoT hub. |
IotHubEndpointHealthStatus |
Health statuses have following meanings. The 'healthy' status shows that the endpoint is accepting messages as expected. The 'unhealthy' status shows that the endpoint is not accepting messages as expected and IoT Hub is retrying to send data to this endpoint. The status of an unhealthy endpoint will be updated to healthy when IoT Hub has established an eventually consistent state of health. The 'dead' status shows that the endpoint is not accepting messages, after IoT Hub retried sending messages for the retrial period. See IoT Hub metrics to identify errors and monitor issues with endpoints. The 'unknown' status shows that the IoT Hub has not established a connection with the endpoint. No messages have been delivered to or rejected from this endpoint. |
IotHubJobType |
The type of the job. |
IotHubNetworkRuleIPAction |
IP Filter Action. |
IotHubNetworkRuleSetDefaultAction |
Default Action for Network Rule Set. |
IotHubPrivateLinkServiceConnectionStatus |
The status of a private endpoint connection. |
IotHubPublicNetworkAccess |
Whether requests from Public Network are allowed. |
IotHubReplicaRoleType |
The role of the region, can be either primary or secondary. The primary region is where the IoT hub is currently provisioned. The secondary region is the Azure disaster recovery (DR) paired region and also the region where the IoT hub can failover to. |
IotHubRoutingSource |
The source that the routing rule is to be applied to, such as DeviceMessages. |
IotHubSku |
The name of the SKU. |
IotHubTestResultStatus |
Result of testing route. |
RouteErrorSeverity |
Severity of the route error. |
RoutingStorageContainerPropertiesEncoding |
Encoding that is used to serialize messages to blobs. Supported values are 'avro', 'avrodeflate', and 'JSON'. Default value is 'avro'. |
Enums
IotHubIPFilterActionType |
The desired action for requests captured by this rule. |
IotHubJobStatus |
The status of the job. |
IotHubNameUnavailableReason |
The reason for unavailability. |
IotHubScaleType |
The type of the scaling enabled. |
IotHubSharedAccessRight |
The permissions assigned to the shared access policy. |
IotHubSkuTier |
The billing tier for the IoT hub. |