Package com.azure.resourcemanager.iothub.models

Package containing the data models for IotHubClient. Use this API to manage the IoT hubs in your Azure subscription.

Interface Summary

Interface	Description
CertificateDescription	An immutable client-side representation of CertificateDescription.
CertificateDescription.Definition	The entirety of the CertificateDescription definition.
CertificateDescription.DefinitionStages	The CertificateDescription definition stages.
CertificateDescription.DefinitionStages.Blank	The first stage of the CertificateDescription definition.
CertificateDescription.DefinitionStages.WithCreate	The stage of the CertificateDescription definition which contains all the minimum required properties for the resource to be created, but also allows for any other optional properties to be specified.
CertificateDescription.DefinitionStages.WithIfMatch	The stage of the CertificateDescription definition allowing to specify ifMatch.
CertificateDescription.DefinitionStages.WithParentResource	The stage of the CertificateDescription definition allowing to specify parent resource.
CertificateDescription.DefinitionStages.WithProperties	The stage of the CertificateDescription definition allowing to specify properties.
CertificateDescription.Update	The template for CertificateDescription update.
CertificateDescription.UpdateStages	The CertificateDescription update stages.
CertificateDescription.UpdateStages.WithIfMatch	The stage of the CertificateDescription update allowing to specify ifMatch.
CertificateDescription.UpdateStages.WithProperties	The stage of the CertificateDescription update allowing to specify properties.
CertificateListDescription	An immutable client-side representation of CertificateListDescription.
Certificates	Resource collection API of Certificates.
CertificateWithNonceDescription	An immutable client-side representation of CertificateWithNonceDescription.
EndpointHealthData	An immutable client-side representation of EndpointHealthData.
EventHubConsumerGroupInfo	An immutable client-side representation of EventHubConsumerGroupInfo.
EventHubConsumerGroupInfo.Definition	The entirety of the EventHubConsumerGroupInfo definition.
EventHubConsumerGroupInfo.DefinitionStages	The EventHubConsumerGroupInfo definition stages.
EventHubConsumerGroupInfo.DefinitionStages.Blank	The first stage of the EventHubConsumerGroupInfo definition.
EventHubConsumerGroupInfo.DefinitionStages.WithCreate	The stage of the EventHubConsumerGroupInfo definition which contains all the minimum required properties for the resource to be created, but also allows for any other optional properties to be specified.
EventHubConsumerGroupInfo.DefinitionStages.WithParentResource	The stage of the EventHubConsumerGroupInfo definition allowing to specify parent resource.
EventHubConsumerGroupInfo.DefinitionStages.WithProperties	The stage of the EventHubConsumerGroupInfo definition allowing to specify properties.
GroupIdInformation	An immutable client-side representation of GroupIdInformation.
IotHubDescription	An immutable client-side representation of IotHubDescription.
IotHubDescription.Definition	The entirety of the IotHubDescription definition.
IotHubDescription.DefinitionStages	The IotHubDescription definition stages.
IotHubDescription.DefinitionStages.Blank	The first stage of the IotHubDescription definition.
IotHubDescription.DefinitionStages.WithCreate	The stage of the IotHubDescription definition which contains all the minimum required properties for the resource to be created, but also allows for any other optional properties to be specified.
IotHubDescription.DefinitionStages.WithEtag	The stage of the IotHubDescription definition allowing to specify etag.
IotHubDescription.DefinitionStages.WithIdentity	The stage of the IotHubDescription definition allowing to specify identity.
IotHubDescription.DefinitionStages.WithIfMatch	The stage of the IotHubDescription definition allowing to specify ifMatch.
IotHubDescription.DefinitionStages.WithLocation	The stage of the IotHubDescription definition allowing to specify location.
IotHubDescription.DefinitionStages.WithProperties	The stage of the IotHubDescription definition allowing to specify properties.
IotHubDescription.DefinitionStages.WithResourceGroup	The stage of the IotHubDescription definition allowing to specify parent resource.
IotHubDescription.DefinitionStages.WithSku	The stage of the IotHubDescription definition allowing to specify sku.
IotHubDescription.DefinitionStages.WithTags	The stage of the IotHubDescription definition allowing to specify tags.
IotHubDescription.Update	The template for IotHubDescription update.
IotHubDescription.UpdateStages	The IotHubDescription update stages.
IotHubDescription.UpdateStages.WithTags	The stage of the IotHubDescription update allowing to specify tags.
IotHubNameAvailabilityInfo	An immutable client-side representation of IotHubNameAvailabilityInfo.
IotHubQuotaMetricInfo	An immutable client-side representation of IotHubQuotaMetricInfo.
IotHubResources	Resource collection API of IotHubResources.
IotHubs	Resource collection API of IotHubs.
IotHubSkuDescription	An immutable client-side representation of IotHubSkuDescription.
JobResponse	An immutable client-side representation of JobResponse.
Operation	An immutable client-side representation of Operation.
Operations	Resource collection API of Operations.
PrivateEndpointConnection	An immutable client-side representation of PrivateEndpointConnection.
PrivateEndpointConnections	Resource collection API of PrivateEndpointConnections.
PrivateLinkResources	An immutable client-side representation of PrivateLinkResources.
PrivateLinkResourcesOperations	Resource collection API of PrivateLinkResourcesOperations.
RegistryStatistics	An immutable client-side representation of RegistryStatistics.
ResourceProviderCommons	Resource collection API of ResourceProviderCommons.
SharedAccessSignatureAuthorizationRule	An immutable client-side representation of SharedAccessSignatureAuthorizationRule.
TestAllRoutesResult	An immutable client-side representation of TestAllRoutesResult.
TestRouteResult	An immutable client-side representation of TestRouteResult.
UserSubscriptionQuotaListResult	An immutable client-side representation of UserSubscriptionQuotaListResult.

Class Summary

Class	Description
ArmIdentity	The ArmIdentity model.
ArmUserIdentity	The ArmUserIdentity model.
AuthenticationType	Defines values for AuthenticationType.
Capabilities	Defines values for Capabilities.
CertificateProperties	The description of an X509 CA Certificate.
CertificatePropertiesWithNonce	The description of an X509 CA Certificate including the challenge nonce issued for the Proof-Of-Possession flow.
CertificateVerificationDescription	The JSON-serialized leaf certificate.
CloudToDeviceProperties	The IoT hub cloud-to-device messaging properties.
DefaultAction	Defines values for DefaultAction.
EndpointHealthDataListResult	The JSON-serialized array of EndpointHealthData objects with a next link.
EndpointHealthStatus	Defines values for EndpointHealthStatus.
EnrichmentProperties	The properties of an enrichment that your IoT hub applies to messages delivered to endpoints.
ErrorDetails	Error details.
EventHubConsumerGroupBodyDescription	The EventHub consumer group.
EventHubConsumerGroupName	The EventHub consumer group name.
EventHubConsumerGroupsListResult	The JSON-serialized array of Event Hub-compatible consumer group names with a next link.
EventHubProperties	The properties of the provisioned Event Hub-compatible endpoint used by the IoT hub.
ExportDevicesRequest	Use to provide parameters when requesting an export of all devices in the IoT hub.
FailoverInput	Use to provide failover region when requesting manual Failover for a hub.
FallbackRouteProperties	The properties of the fallback route.
FeedbackProperties	The properties of the feedback queue for cloud-to-device messages.
GroupIdInformationProperties	The properties for a group information object.
ImportDevicesRequest	Use to provide parameters when requesting an import of all devices in the hub.
IotHubCapacity	IoT Hub capacity information.
IotHubDescriptionListResult	The JSON-serialized array of IotHubDescription objects with a next link.
IotHubLocationDescription	Public representation of one of the locations where a resource is provisioned.
IotHubProperties	The properties of an IoT hub.
IotHubQuotaMetricInfoListResult	The JSON-serialized array of IotHubQuotaMetricInfo objects with a next link.
IotHubReplicaRoleType	Defines values for IotHubReplicaRoleType.
IotHubSku	Defines values for IotHubSku.
IotHubSkuDescriptionListResult	The JSON-serialized array of IotHubSkuDescription objects with a next link.
IotHubSkuInfo	Information about the SKU of the IoT hub.
IpFilterRule	The IP filter rules for the IoT hub.
JobResponseListResult	The JSON-serialized array of JobResponse objects with a next link.
JobType	Defines values for JobType.
ManagedIdentity	The properties of the Managed identity.
MatchedRoute	Routes that matched.
MessagingEndpointProperties	The properties of the messaging endpoints used by this IoT hub.
Name	Name of Iot Hub type.
NetworkRuleIpAction	Defines values for NetworkRuleIpAction.
NetworkRuleSetIpRule	IP Rule to be applied as part of Network Rule Set.
NetworkRuleSetProperties	Network Rule Set Properties of IotHub.
OperationDisplay	The object that represents the operation.
OperationInputs	Input values.
OperationListResult	Result of the request to list IoT Hub operations.
PrivateEndpoint	The private endpoint property of a private endpoint connection.
PrivateEndpointConnectionProperties	The properties of a private endpoint connection.
PrivateLinkServiceConnectionState	The current state of a private endpoint connection.
PrivateLinkServiceConnectionStatus	Defines values for PrivateLinkServiceConnectionStatus.
PublicNetworkAccess	Defines values for PublicNetworkAccess.
RouteCompilationError	Compilation error when evaluating route.
RouteErrorPosition	Position where the route error happened.
RouteErrorRange	Range of route errors.
RouteErrorSeverity	Defines values for RouteErrorSeverity.
RouteProperties	The properties of a routing rule that your IoT hub uses to route messages to endpoints.
RoutingEndpoints	The properties related to the custom endpoints to which your IoT hub routes messages based on the routing rules.
RoutingEventHubProperties	The properties related to an event hub endpoint.
RoutingMessage	Routing message.
RoutingProperties	The routing related properties of the IoT hub.
RoutingServiceBusQueueEndpointProperties	The properties related to service bus queue endpoint types.
RoutingServiceBusTopicEndpointProperties	The properties related to service bus topic endpoint types.
RoutingSource	Defines values for RoutingSource.
RoutingStorageContainerProperties	The properties related to a storage container endpoint.
RoutingStorageContainerPropertiesEncoding	Defines values for RoutingStorageContainerPropertiesEncoding.
RoutingTwin	Twin reference input parameter.
RoutingTwinProperties	The RoutingTwinProperties model.
SharedAccessSignatureAuthorizationRuleListResult	The list of shared access policies with a next link.
StorageEndpointProperties	The properties of the Azure Storage endpoint for file upload.
TagsResource	A container holding only the Tags for a resource, allowing the user to update the tags on an IoT Hub instance.
TestAllRoutesInput	Input for testing all routes.
TestResultStatus	Defines values for TestResultStatus.
TestRouteInput	Input for testing route.
TestRouteResultDetails	Detailed result of testing a route.
UserSubscriptionQuota	User subscription quota response.

Enum Summary

Enum	Description
AccessRights	Defines values for AccessRights.
IotHubNameUnavailabilityReason	Defines values for IotHubNameUnavailabilityReason.
IotHubScaleType	Defines values for IotHubScaleType.
IotHubSkuTier	Defines values for IotHubSkuTier.
IpFilterActionType	Defines values for IpFilterActionType.
JobStatus	Defines values for JobStatus.
ResourceIdentityType	Defines values for ResourceIdentityType.

Exception Summary

Exception	Description
ErrorDetailsException	Exception thrown for an invalid response with ErrorDetails information.