models Package

Classes

CertificateBodyDescription

The JSON-serialized X509 Certificate.

CertificateDescription

The X509 Certificate.

Variables are only populated by the server, and will be ignored when sending a request.

CertificateListDescription

The JSON-serialized array of Certificate objects.

CertificateProperties

The description of an X509 CA Certificate.

Variables are only populated by the server, and will be ignored when sending a request.

CertificatePropertiesWithNonce

The description of an X509 CA Certificate including the challenge nonce issued for the Proof-Of-Possession flow.

Variables are only populated by the server, and will be ignored when sending a request.

CertificateVerificationDescription

The JSON-serialized leaf certificate.

CertificateWithNonceDescription

The X509 Certificate.

Variables are only populated by the server, and will be ignored when sending a request.

CloudToDeviceProperties

The IoT hub cloud-to-device messaging properties.

ErrorDetails

Error details.

Variables are only populated by the server, and will be ignored when sending a request.

EventHubConsumerGroupInfo

The properties of the EventHubConsumerGroupInfo object.

Variables are only populated by the server, and will be ignored when sending a request.

EventHubConsumerGroupsListResult

The JSON-serialized array of Event Hub-compatible consumer group names with a next link.

Variables are only populated by the server, and will be ignored when sending a request.

EventHubProperties

The properties of the provisioned Event Hub-compatible endpoint used by the IoT hub.

Variables are only populated by the server, and will be ignored when sending a request.

ExportDevicesRequest

Use to provide parameters when requesting an export of all devices in the IoT hub.

All required parameters must be populated in order to send to Azure.

FallbackRouteProperties

The properties of the fallback route. IoT Hub uses these properties when it routes messages to the fallback endpoint.

All required parameters must be populated in order to send to Azure.

FeedbackProperties

The properties of the feedback queue for cloud-to-device messages.

ImportDevicesRequest

Use to provide parameters when requesting an import of all devices in the hub.

All required parameters must be populated in order to send to Azure.

IotHubCapacity

IoT Hub capacity information.

Variables are only populated by the server, and will be ignored when sending a request.

IotHubDescription

The description of the IoT hub.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

IotHubDescriptionListResult

The JSON-serialized array of IotHubDescription objects with a next link.

Variables are only populated by the server, and will be ignored when sending a request.

IotHubNameAvailabilityInfo

The properties indicating whether a given IoT hub name is available.

Variables are only populated by the server, and will be ignored when sending a request.

IotHubProperties

The properties of an IoT hub.

Variables are only populated by the server, and will be ignored when sending a request.

IotHubQuotaMetricInfo

Quota metrics properties.

Variables are only populated by the server, and will be ignored when sending a request.

IotHubQuotaMetricInfoListResult

The JSON-serialized array of IotHubQuotaMetricInfo objects with a next link.

Variables are only populated by the server, and will be ignored when sending a request.

IotHubSkuDescription

SKU properties.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

IotHubSkuDescriptionListResult

The JSON-serialized array of IotHubSkuDescription objects with a next link.

Variables are only populated by the server, and will be ignored when sending a request.

IotHubSkuInfo

Information about the SKU of the IoT hub.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

IpFilterRule

The IP filter rules for the IoT hub.

All required parameters must be populated in order to send to Azure.

JobResponse

The properties of the Job Response object.

Variables are only populated by the server, and will be ignored when sending a request.

JobResponseListResult

The JSON-serialized array of JobResponse objects with a next link.

Variables are only populated by the server, and will be ignored when sending a request.

MessagingEndpointProperties

The properties of the messaging endpoints used by this IoT hub.

Operation

IoT Hub REST API operation.

Variables are only populated by the server, and will be ignored when sending a request.

OperationDisplay

The object that represents the operation.

Variables are only populated by the server, and will be ignored when sending a request.

OperationInputs

Input values.

All required parameters must be populated in order to send to Azure.

OperationListResult

Result of the request to list IoT Hub operations. It contains a list of operations and a URL link to get the next set of results.

Variables are only populated by the server, and will be ignored when sending a request.

OperationsMonitoringProperties

The operations monitoring properties for the IoT hub. The possible keys to the dictionary are Connections, DeviceTelemetry, C2DCommands, DeviceIdentityOperations, FileUploadOperations, Routes, D2CTwinOperations, C2DTwinOperations, TwinQueries, JobsOperations, DirectMethods.

RegistryStatistics

Identity registry statistics.

Variables are only populated by the server, and will be ignored when sending a request.

Resource

The common properties of an Azure resource.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

RouteProperties

The properties of a routing rule that your IoT hub uses to route messages to endpoints.

All required parameters must be populated in order to send to Azure.

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.

All required parameters must be populated in order to send to Azure.

RoutingProperties

The routing related properties of the IoT hub. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging.

RoutingServiceBusQueueEndpointProperties

The properties related to service bus queue endpoint types.

All required parameters must be populated in order to send to Azure.

RoutingServiceBusTopicEndpointProperties

The properties related to service bus topic endpoint types.

All required parameters must be populated in order to send to Azure.

RoutingStorageContainerProperties

The properties related to a storage container endpoint.

All required parameters must be populated in order to send to Azure.

SharedAccessSignatureAuthorizationRule

The properties of an IoT hub shared access policy.

All required parameters must be populated in order to send to Azure.

SharedAccessSignatureAuthorizationRuleListResult

The list of shared access policies with a next link.

Variables are only populated by the server, and will be ignored when sending a request.

StorageEndpointProperties

The properties of the Azure Storage endpoint for file upload.

All required parameters must be populated in order to send to Azure.

TagsResource

A container holding only the Tags for a resource, allowing the user to update the tags on an IoT Hub instance.

Enums

AccessRights

The permissions assigned to the shared access policy.

Capabilities

The capabilities and features enabled for the IoT hub.

IotHubNameUnavailabilityReason

The reason for unavailability.

IotHubScaleType

The type of the scaling enabled.

IotHubSku

The name of the SKU.

IotHubSkuTier

The billing tier for the IoT hub.

IpFilterActionType

The desired action for requests captured by this rule.

JobStatus

The status of the job.

JobType

The type of the job.

OperationMonitoringLevel

The operations monitoring level.

RoutingSource

The source that the routing rule is to be applied to, such as DeviceMessages.