azure.mgmt.iothub.models module¶
-
class
azure.mgmt.iothub.models.
CertificateVerificationDescription
(*, certificate: str = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
The JSON-serialized leaf certificate.
- Parameters
certificate (str) – base-64 representation of X509 certificate .cer file or just .pem file content.
-
class
azure.mgmt.iothub.models.
CertificateBodyDescription
(*, certificate: str = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
The JSON-serialized X509 Certificate.
- Parameters
certificate (str) – base-64 representation of the X509 leaf certificate .cer file or just .pem file content.
-
class
azure.mgmt.iothub.models.
CertificateProperties
(**kwargs)[source]¶ Bases:
msrest.serialization.Model
The description of an X509 CA Certificate.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
subject (str) – The certificate’s subject name.
expiry (datetime) – The certificate’s expiration date and time.
thumbprint (str) – The certificate’s thumbprint.
is_verified (bool) – Determines whether certificate has been verified.
created (datetime) – The certificate’s create date and time.
updated (datetime) – The certificate’s last update date and time.
-
class
azure.mgmt.iothub.models.
CertificateDescription
(*, properties=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
The X509 Certificate.
Variables are only populated by the server, and will be ignored when sending a request.
- Parameters
properties (CertificateProperties) –
- Variables
-
class
azure.mgmt.iothub.models.
CertificateListDescription
(*, value=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
The JSON-serialized array of Certificate objects.
- Parameters
value (list[CertificateDescription]) – The array of Certificate objects.
-
class
azure.mgmt.iothub.models.
CertificatePropertiesWithNonce
(**kwargs)[source]¶ Bases:
msrest.serialization.Model
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.
- Variables
subject (str) – The certificate’s subject name.
expiry (datetime) – The certificate’s expiration date and time.
thumbprint (str) – The certificate’s thumbprint.
is_verified (bool) – Determines whether certificate has been verified.
created (datetime) – The certificate’s create date and time.
updated (datetime) – The certificate’s last update date and time.
verification_code (str) – The certificate’s verification code that will be used for proof of possession.
-
class
azure.mgmt.iothub.models.
CertificateWithNonceDescription
(*, properties=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
The X509 Certificate.
Variables are only populated by the server, and will be ignored when sending a request.
- Parameters
properties (CertificatePropertiesWithNonce) –
- Variables
Bases:
msrest.serialization.Model
The properties of an IoT hub shared access policy.
All required parameters must be populated in order to send to Azure.
- Parameters
key_name (str) – Required. The name of the shared access policy.
primary_key (str) – The primary key.
secondary_key (str) – The secondary key.
rights (str or AccessRights) – Required. The permissions assigned to the shared access policy. Possible values include: ‘RegistryRead’, ‘RegistryWrite’, ‘ServiceConnect’, ‘DeviceConnect’, ‘RegistryRead, RegistryWrite’, ‘RegistryRead, ServiceConnect’, ‘RegistryRead, DeviceConnect’, ‘RegistryWrite, ServiceConnect’, ‘RegistryWrite, DeviceConnect’, ‘ServiceConnect, DeviceConnect’, ‘RegistryRead, RegistryWrite, ServiceConnect’, ‘RegistryRead, RegistryWrite, DeviceConnect’, ‘RegistryRead, ServiceConnect, DeviceConnect’, ‘RegistryWrite, ServiceConnect, DeviceConnect’, ‘RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect’
-
class
azure.mgmt.iothub.models.
IpFilterRule
(*, filter_name: str, action, ip_mask: str, **kwargs)[source]¶ Bases:
msrest.serialization.Model
The IP filter rules for the IoT hub.
All required parameters must be populated in order to send to Azure.
- Parameters
filter_name (str) – Required. The name of the IP filter rule.
action (str or IpFilterActionType) – Required. The desired action for requests captured by this rule. Possible values include: ‘Accept’, ‘Reject’
ip_mask (str) – Required. A string that contains the IP address range in CIDR notation for the rule.
-
class
azure.mgmt.iothub.models.
EventHubProperties
(*, retention_time_in_days: int = None, partition_count: int = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
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.
- Parameters
retention_time_in_days (long) – The retention time for device-to-cloud messages in days. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages
partition_count (int) – The number of partitions for receiving device-to-cloud messages in the Event Hub-compatible endpoint. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages.
- Variables
partition_ids (list[str]) – The partition ids in the Event Hub-compatible endpoint.
path (str) – The Event Hub-compatible name.
endpoint (str) – The Event Hub-compatible endpoint.
-
class
azure.mgmt.iothub.models.
RoutingServiceBusQueueEndpointProperties
(*, connection_string: str, name: str, subscription_id: str = None, resource_group: str = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
The properties related to service bus queue endpoint types.
All required parameters must be populated in order to send to Azure.
- Parameters
connection_string (str) – Required. The connection string of the service bus queue endpoint.
name (str) – Required. The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, operationsMonitoringEvents, fileNotifications, $default. Endpoint names must be unique across endpoint types. The name need not be the same as the actual queue name.
subscription_id (str) – The subscription identifier of the service bus queue endpoint.
resource_group (str) – The name of the resource group of the service bus queue endpoint.
-
class
azure.mgmt.iothub.models.
RoutingServiceBusTopicEndpointProperties
(*, connection_string: str, name: str, subscription_id: str = None, resource_group: str = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
The properties related to service bus topic endpoint types.
All required parameters must be populated in order to send to Azure.
- Parameters
connection_string (str) – Required. The connection string of the service bus topic endpoint.
name (str) – Required. The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, operationsMonitoringEvents, fileNotifications, $default. Endpoint names must be unique across endpoint types. The name need not be the same as the actual topic name.
subscription_id (str) – The subscription identifier of the service bus topic endpoint.
resource_group (str) – The name of the resource group of the service bus topic endpoint.
-
class
azure.mgmt.iothub.models.
RoutingEventHubProperties
(*, connection_string: str, name: str, subscription_id: str = None, resource_group: str = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
The properties related to an event hub endpoint.
All required parameters must be populated in order to send to Azure.
- Parameters
connection_string (str) – Required. The connection string of the event hub endpoint.
name (str) – Required. The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, operationsMonitoringEvents, fileNotifications, $default. Endpoint names must be unique across endpoint types.
subscription_id (str) – The subscription identifier of the event hub endpoint.
resource_group (str) – The name of the resource group of the event hub endpoint.
-
class
azure.mgmt.iothub.models.
RoutingStorageContainerProperties
(*, connection_string: str, name: str, container_name: str, subscription_id: str = None, resource_group: str = None, file_name_format: str = None, batch_frequency_in_seconds: int = None, max_chunk_size_in_bytes: int = None, encoding: str = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
The properties related to a storage container endpoint.
All required parameters must be populated in order to send to Azure.
- Parameters
connection_string (str) – Required. The connection string of the storage account.
name (str) – Required. The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, operationsMonitoringEvents, fileNotifications, $default. Endpoint names must be unique across endpoint types.
subscription_id (str) – The subscription identifier of the storage account.
resource_group (str) – The name of the resource group of the storage account.
container_name (str) – Required. The name of storage container in the storage account.
file_name_format (str) – File name format for the blob. Default format is {iothub}/{partition}/{YYYY}/{MM}/{DD}/{HH}/{mm}. All parameters are mandatory but can be reordered.
batch_frequency_in_seconds (int) – Time interval at which blobs are written to storage. Value should be between 60 and 720 seconds. Default value is 300 seconds.
max_chunk_size_in_bytes (int) – Maximum number of bytes for each blob written to storage. Value should be between 10485760(10MB) and 524288000(500MB). Default value is 314572800(300MB).
encoding (str) – Encoding that is used to serialize messages to blobs. Supported values are ‘avro’ and ‘avrodeflate’. Default value is ‘avro’.
-
class
azure.mgmt.iothub.models.
RoutingEndpoints
(*, service_bus_queues=None, service_bus_topics=None, event_hubs=None, storage_containers=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
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.
- Parameters
service_bus_queues (list[RoutingServiceBusQueueEndpointProperties]) – The list of Service Bus queue endpoints that IoT hub routes the messages to, based on the routing rules.
service_bus_topics (list[RoutingServiceBusTopicEndpointProperties]) – The list of Service Bus topic endpoints that the IoT hub routes the messages to, based on the routing rules.
event_hubs (list[RoutingEventHubProperties]) – The list of Event Hubs endpoints that IoT hub routes messages to, based on the routing rules. This list does not include the built-in Event Hubs endpoint.
storage_containers (list[RoutingStorageContainerProperties]) – The list of storage container endpoints that IoT hub routes messages to, based on the routing rules.
-
class
azure.mgmt.iothub.models.
RouteProperties
(*, name: str, source, endpoint_names, is_enabled: bool, condition: str = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
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.
- Parameters
name (str) – Required. The name of the route. The name can only include alphanumeric characters, periods, underscores, hyphens, has a maximum length of 64 characters, and must be unique.
source (str or RoutingSource) – Required. The source that the routing rule is to be applied to, such as DeviceMessages. Possible values include: ‘DeviceMessages’, ‘TwinChangeEvents’, ‘DeviceLifecycleEvents’, ‘DeviceJobLifecycleEvents’
condition (str) – The condition that is evaluated to apply the routing rule. If no condition is provided, it evaluates to true by default. For grammar, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language
endpoint_names (list[str]) – Required. The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed.
is_enabled (bool) – Required. Used to specify whether a route is enabled.
-
class
azure.mgmt.iothub.models.
FallbackRouteProperties
(*, endpoint_names, is_enabled: bool, name: str = None, condition: str = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
The properties of the fallback route. IoT Hub uses these properties when it routes messages to the fallback endpoint.
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.
- Parameters
name (str) – The name of the route. The name can only include alphanumeric characters, periods, underscores, hyphens, has a maximum length of 64 characters, and must be unique.
condition (str) – The condition which is evaluated in order to apply the fallback route. If the condition is not provided it will evaluate to true by default. For grammar, See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language
endpoint_names (list[str]) – Required. The list of endpoints to which the messages that satisfy the condition are routed to. Currently only 1 endpoint is allowed.
is_enabled (bool) – Required. Used to specify whether the fallback route is enabled.
- Variables
source (str) – Required. The source to which the routing rule is to be applied to. For example, DeviceMessages. Default value: “DeviceMessages” .
-
source
= 'DeviceMessages'¶
-
class
azure.mgmt.iothub.models.
RoutingProperties
(*, endpoints=None, routes=None, fallback_route=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
The routing related properties of the IoT hub. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging.
- Parameters
endpoints (RoutingEndpoints) –
routes (list[RouteProperties]) – The list of user-provided routing rules that the IoT hub uses to route messages to built-in and custom endpoints. A maximum of 100 routing rules are allowed for paid hubs and a maximum of 5 routing rules are allowed for free hubs.
fallback_route (FallbackRouteProperties) – The properties of the route that is used as a fall-back route when none of the conditions specified in the ‘routes’ section are met. This is an optional parameter. When this property is not set, the messages which do not meet any of the conditions specified in the ‘routes’ section get routed to the built-in eventhub endpoint.
-
class
azure.mgmt.iothub.models.
StorageEndpointProperties
(*, connection_string: str, container_name: str, sas_ttl_as_iso8601=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
The properties of the Azure Storage endpoint for file upload.
All required parameters must be populated in order to send to Azure.
- Parameters
sas_ttl_as_iso8601 (timedelta) – The period of time for which the the SAS URI generated by IoT Hub for file upload is valid. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload#file-upload-notification-configuration-options.
connection_string (str) – Required. The connection string for the Azure Storage account to which files are uploaded.
container_name (str) – Required. The name of the root container where you upload files. The container need not exist but should be creatable using the connectionString specified.
-
class
azure.mgmt.iothub.models.
MessagingEndpointProperties
(*, lock_duration_as_iso8601=None, ttl_as_iso8601=None, max_delivery_count: int = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
The properties of the messaging endpoints used by this IoT hub.
- Parameters
lock_duration_as_iso8601 (timedelta) – The lock duration. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload.
ttl_as_iso8601 (timedelta) – The period of time for which a message is available to consume before it is expired by the IoT hub. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload.
max_delivery_count (int) – The number of times the IoT hub attempts to deliver a message. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload.
-
class
azure.mgmt.iothub.models.
FeedbackProperties
(*, lock_duration_as_iso8601=None, ttl_as_iso8601=None, max_delivery_count: int = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
The properties of the feedback queue for cloud-to-device messages.
- Parameters
lock_duration_as_iso8601 (timedelta) – The lock duration for the feedback queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.
ttl_as_iso8601 (timedelta) – The period of time for which a message is available to consume before it is expired by the IoT hub. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.
max_delivery_count (int) – The number of times the IoT hub attempts to deliver a message on the feedback queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.
-
class
azure.mgmt.iothub.models.
CloudToDeviceProperties
(*, max_delivery_count: int = None, default_ttl_as_iso8601=None, feedback=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
The IoT hub cloud-to-device messaging properties.
- Parameters
max_delivery_count (int) – The max delivery count for cloud-to-device messages in the device queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.
default_ttl_as_iso8601 (timedelta) – The default time to live for cloud-to-device messages in the device queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.
feedback (FeedbackProperties) –
-
class
azure.mgmt.iothub.models.
OperationsMonitoringProperties
(*, events=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
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.
- Parameters
events (dict[str, str or OperationMonitoringLevel]) –
-
class
azure.mgmt.iothub.models.
IotHubProperties
(*, authorization_policies=None, ip_filter_rules=None, event_hub_endpoints=None, routing=None, storage_endpoints=None, messaging_endpoints=None, enable_file_upload_notifications: bool = None, cloud_to_device=None, comments: str = None, operations_monitoring_properties=None, features=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
The properties of an IoT hub.
Variables are only populated by the server, and will be ignored when sending a request.
- Parameters
authorization_policies (list[SharedAccessSignatureAuthorizationRule]) – The shared access policies you can use to secure a connection to the IoT hub.
ip_filter_rules (list[IpFilterRule]) – The IP filter rules.
event_hub_endpoints (dict[str, EventHubProperties]) – The Event Hub-compatible endpoint properties. The possible keys to this dictionary are events and operationsMonitoringEvents. Both of these keys have to be present in the dictionary while making create or update calls for the IoT hub.
routing (RoutingProperties) –
storage_endpoints (dict[str, StorageEndpointProperties]) – The list of Azure Storage endpoints where you can upload files. Currently you can configure only one Azure Storage account and that MUST have its key as $default. Specifying more than one storage account causes an error to be thrown. Not specifying a value for this property when the enableFileUploadNotifications property is set to True, causes an error to be thrown.
messaging_endpoints (dict[str, MessagingEndpointProperties]) – The messaging endpoint properties for the file upload notification queue.
enable_file_upload_notifications (bool) – If True, file upload notifications are enabled.
cloud_to_device (CloudToDeviceProperties) –
comments (str) – IoT hub comments.
operations_monitoring_properties (OperationsMonitoringProperties) –
features (str or Capabilities) – The capabilities and features enabled for the IoT hub. Possible values include: ‘None’, ‘DeviceManagement’
- Variables
provisioning_state (str) – The provisioning state.
state (str) – Thehub state state.
host_name (str) – The name of the host.
-
class
azure.mgmt.iothub.models.
IotHubSkuInfo
(*, name, capacity: int = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
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.
- Parameters
name (str or IotHubSku) – Required. The name of the SKU. Possible values include: ‘F1’, ‘S1’, ‘S2’, ‘S3’, ‘B1’, ‘B2’, ‘B3’
capacity (long) – The number of provisioned IoT Hub units. See: https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits.
- Variables
tier (str or IotHubSkuTier) – The billing tier for the IoT hub. Possible values include: ‘Free’, ‘Standard’, ‘Basic’
-
class
azure.mgmt.iothub.models.
IotHubDescription
(*, location: str, sku, tags=None, etag: str = None, properties=None, **kwargs)[source]¶ Bases:
azure.mgmt.iothub.models.resource.Resource
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.
- Variables
- Parameters
location (str) – Required. The resource location.
tags (dict[str, str]) – The resource tags.
etag (str) – The Etag field is not required. If it is provided in the response body, it must also be provided as a header per the normal ETag convention.
properties (IotHubProperties) –
sku (IotHubSkuInfo) – Required.
-
class
azure.mgmt.iothub.models.
Resource
(*, location: str, tags=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
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.
-
class
azure.mgmt.iothub.models.
OperationDisplay
(**kwargs)[source]¶ Bases:
msrest.serialization.Model
The object that represents the operation.
Variables are only populated by the server, and will be ignored when sending a request.
-
class
azure.mgmt.iothub.models.
Operation
(*, display=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
IoT Hub REST API operation.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
name (str) – Operation name: {provider}/{resource}/{read | write | action | delete}
- Parameters
display (OperationDisplay) – The object that represents the operation.
-
class
azure.mgmt.iothub.models.
ErrorDetails
(**kwargs)[source]¶ Bases:
msrest.serialization.Model
Error details.
Variables are only populated by the server, and will be ignored when sending a request.
-
exception
azure.mgmt.iothub.models.
ErrorDetailsException
(deserialize, response, *args)[source]¶ Bases:
msrest.exceptions.HttpOperationError
Server responsed with exception of type: ‘ErrorDetails’.
- Parameters
deserialize – A deserializer
response – Server response to be deserialized.
-
class
azure.mgmt.iothub.models.
IotHubQuotaMetricInfo
(**kwargs)[source]¶ Bases:
msrest.serialization.Model
Quota metrics properties.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
name (str) – The name of the quota metric.
current_value (long) – The current value for the quota metric.
max_value (long) – The maximum value of the quota metric.
-
class
azure.mgmt.iothub.models.
RegistryStatistics
(**kwargs)[source]¶ Bases:
msrest.serialization.Model
Identity registry statistics.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
total_device_count (long) – The total count of devices in the identity registry.
enabled_device_count (long) – The count of enabled devices in the identity registry.
disabled_device_count (long) – The count of disabled devices in the identity registry.
-
class
azure.mgmt.iothub.models.
JobResponse
(**kwargs)[source]¶ Bases:
msrest.serialization.Model
The properties of the Job Response object.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
job_id (str) – The job identifier.
start_time_utc (datetime) – The start time of the job.
end_time_utc (datetime) – The time the job stopped processing.
type (str or JobType) – The type of the job. Possible values include: ‘unknown’, ‘export’, ‘import’, ‘backup’, ‘readDeviceProperties’, ‘writeDeviceProperties’, ‘updateDeviceConfiguration’, ‘rebootDevice’, ‘factoryResetDevice’, ‘firmwareUpdate’
status (str or JobStatus) – The status of the job. Possible values include: ‘unknown’, ‘enqueued’, ‘running’, ‘completed’, ‘failed’, ‘cancelled’
failure_reason (str) – If status == failed, this string containing the reason for the failure.
status_message (str) – The status message for the job.
parent_job_id (str) – The job identifier of the parent job, if any.
-
class
azure.mgmt.iothub.models.
IotHubCapacity
(**kwargs)[source]¶ Bases:
msrest.serialization.Model
IoT Hub capacity information.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
minimum (long) – The minimum number of units.
maximum (long) – The maximum number of units.
default (long) – The default number of units.
scale_type (str or IotHubScaleType) – The type of the scaling enabled. Possible values include: ‘Automatic’, ‘Manual’, ‘None’
-
class
azure.mgmt.iothub.models.
IotHubSkuDescription
(*, sku, capacity, **kwargs)[source]¶ Bases:
msrest.serialization.Model
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.
- Variables
resource_type (str) – The type of the resource.
- Parameters
sku (IotHubSkuInfo) – Required. The type of the resource.
capacity (IotHubCapacity) – Required.
-
class
azure.mgmt.iothub.models.
TagsResource
(*, tags=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
A container holding only the Tags for a resource, allowing the user to update the tags on an IoT Hub instance.
- Parameters
tags (dict[str, str]) – Resource tags
-
class
azure.mgmt.iothub.models.
EventHubConsumerGroupInfo
(*, properties=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
The properties of the EventHubConsumerGroupInfo object.
Variables are only populated by the server, and will be ignored when sending a request.
-
class
azure.mgmt.iothub.models.
OperationInputs
(*, name: str, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Input values.
All required parameters must be populated in order to send to Azure.
- Parameters
name (str) – Required. The name of the IoT hub to check.
-
class
azure.mgmt.iothub.models.
IotHubNameAvailabilityInfo
(*, message: str = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
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.
- Variables
name_available (bool) – The value which indicates whether the provided name is available.
reason (str or IotHubNameUnavailabilityReason) – The reason for unavailability. Possible values include: ‘Invalid’, ‘AlreadyExists’
- Parameters
message (str) – The detailed reason message.
-
class
azure.mgmt.iothub.models.
ExportDevicesRequest
(*, export_blob_container_uri: str, exclude_keys: bool, **kwargs)[source]¶ Bases:
msrest.serialization.Model
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.
- Parameters
export_blob_container_uri (str) – Required. The export blob container URI.
exclude_keys (bool) – Required. The value indicating whether keys should be excluded during export.
-
class
azure.mgmt.iothub.models.
ImportDevicesRequest
(*, input_blob_container_uri: str, output_blob_container_uri: str, **kwargs)[source]¶ Bases:
msrest.serialization.Model
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.
- Parameters
input_blob_container_uri (str) – Required. The input blob container URI.
output_blob_container_uri (str) – Required. The output blob container URI.
-
class
azure.mgmt.iothub.models.
OperationPaged
(*args, **kwargs)[source]¶ Bases:
msrest.paging.Paged
A paging container for iterating over a list of
Operation
objectBring async to Paging.
“async_command” is mandatory keyword argument for this mixin to work.
-
class
azure.mgmt.iothub.models.
IotHubDescriptionPaged
(*args, **kwargs)[source]¶ Bases:
msrest.paging.Paged
A paging container for iterating over a list of
IotHubDescription
objectBring async to Paging.
“async_command” is mandatory keyword argument for this mixin to work.
-
class
azure.mgmt.iothub.models.
IotHubSkuDescriptionPaged
(*args, **kwargs)[source]¶ Bases:
msrest.paging.Paged
A paging container for iterating over a list of
IotHubSkuDescription
objectBring async to Paging.
“async_command” is mandatory keyword argument for this mixin to work.
-
class
azure.mgmt.iothub.models.
EventHubConsumerGroupInfoPaged
(*args, **kwargs)[source]¶ Bases:
msrest.paging.Paged
A paging container for iterating over a list of
EventHubConsumerGroupInfo
objectBring async to Paging.
“async_command” is mandatory keyword argument for this mixin to work.
-
class
azure.mgmt.iothub.models.
JobResponsePaged
(*args, **kwargs)[source]¶ Bases:
msrest.paging.Paged
A paging container for iterating over a list of
JobResponse
objectBring async to Paging.
“async_command” is mandatory keyword argument for this mixin to work.
-
class
azure.mgmt.iothub.models.
IotHubQuotaMetricInfoPaged
(*args, **kwargs)[source]¶ Bases:
msrest.paging.Paged
A paging container for iterating over a list of
IotHubQuotaMetricInfo
objectBring async to Paging.
“async_command” is mandatory keyword argument for this mixin to work.
Bases:
msrest.paging.Paged
A paging container for iterating over a list of
SharedAccessSignatureAuthorizationRule
objectBring async to Paging.
“async_command” is mandatory keyword argument for this mixin to work.
-
class
azure.mgmt.iothub.models.
AccessRights
[source]¶ Bases:
str
,enum.Enum
An enumeration.
-
device_connect
= 'DeviceConnect'¶
-
registry_read
= 'RegistryRead'¶
-
registry_read_device_connect
= 'RegistryRead, DeviceConnect'¶
-
registry_read_registry_write
= 'RegistryRead, RegistryWrite'¶
-
registry_read_registry_write_device_connect
= 'RegistryRead, RegistryWrite, DeviceConnect'¶
-
registry_read_registry_write_service_connect
= 'RegistryRead, RegistryWrite, ServiceConnect'¶
-
registry_read_registry_write_service_connect_device_connect
= 'RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect'¶
-
registry_read_service_connect
= 'RegistryRead, ServiceConnect'¶
-
registry_read_service_connect_device_connect
= 'RegistryRead, ServiceConnect, DeviceConnect'¶
-
registry_write
= 'RegistryWrite'¶
-
registry_write_device_connect
= 'RegistryWrite, DeviceConnect'¶
-
registry_write_service_connect
= 'RegistryWrite, ServiceConnect'¶
-
registry_write_service_connect_device_connect
= 'RegistryWrite, ServiceConnect, DeviceConnect'¶
-
service_connect
= 'ServiceConnect'¶
-
service_connect_device_connect
= 'ServiceConnect, DeviceConnect'¶
-
-
class
azure.mgmt.iothub.models.
IpFilterActionType
[source]¶ Bases:
str
,enum.Enum
An enumeration.
-
accept
= 'Accept'¶
-
reject
= 'Reject'¶
-
-
class
azure.mgmt.iothub.models.
RoutingSource
[source]¶ Bases:
str
,enum.Enum
An enumeration.
-
device_job_lifecycle_events
= 'DeviceJobLifecycleEvents'¶
-
device_lifecycle_events
= 'DeviceLifecycleEvents'¶
-
device_messages
= 'DeviceMessages'¶
-
twin_change_events
= 'TwinChangeEvents'¶
-
-
class
azure.mgmt.iothub.models.
OperationMonitoringLevel
[source]¶ Bases:
str
,enum.Enum
An enumeration.
-
error
= 'Error'¶
-
error_information
= 'Error, Information'¶
-
information
= 'Information'¶
-
none
= 'None'¶
-
-
class
azure.mgmt.iothub.models.
Capabilities
[source]¶ Bases:
str
,enum.Enum
An enumeration.
-
device_management
= 'DeviceManagement'¶
-
none
= 'None'¶
-
-
class
azure.mgmt.iothub.models.
IotHubSku
[source]¶ Bases:
str
,enum.Enum
An enumeration.
-
b1
= 'B1'¶
-
b2
= 'B2'¶
-
b3
= 'B3'¶
-
f1
= 'F1'¶
-
s1
= 'S1'¶
-
s2
= 'S2'¶
-
s3
= 'S3'¶
-
-
class
azure.mgmt.iothub.models.
IotHubSkuTier
[source]¶ Bases:
str
,enum.Enum
An enumeration.
-
basic
= 'Basic'¶
-
free
= 'Free'¶
-
standard
= 'Standard'¶
-
-
class
azure.mgmt.iothub.models.
JobType
[source]¶ Bases:
str
,enum.Enum
An enumeration.
-
backup
= 'backup'¶
-
export
= 'export'¶
-
factory_reset_device
= 'factoryResetDevice'¶
-
firmware_update
= 'firmwareUpdate'¶
-
import_enum
= 'import'¶
-
read_device_properties
= 'readDeviceProperties'¶
-
reboot_device
= 'rebootDevice'¶
-
unknown
= 'unknown'¶
-
update_device_configuration
= 'updateDeviceConfiguration'¶
-
write_device_properties
= 'writeDeviceProperties'¶
-
-
class
azure.mgmt.iothub.models.
JobStatus
[source]¶ Bases:
str
,enum.Enum
An enumeration.
-
cancelled
= 'cancelled'¶
-
completed
= 'completed'¶
-
enqueued
= 'enqueued'¶
-
failed
= 'failed'¶
-
running
= 'running'¶
-
unknown
= 'unknown'¶
-
-
class
azure.mgmt.iothub.models.
IotHubScaleType
[source]¶ Bases:
str
,enum.Enum
An enumeration.
-
automatic
= 'Automatic'¶
-
manual
= 'Manual'¶
-
none
= 'None'¶
-
Bases:
str
,enum.Enum
An enumeration.