azure.mgmt.iothubprovisioningservices.models module

exception azure.mgmt.iothubprovisioningservices.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.iothubprovisioningservices.models.ErrorMesssage(*, code: str = None, message: str = None, details: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

Error response containing message and code.

Parameters
  • code (str) – standard error code

  • message (str) – standard error description

  • details (str) – detailed summary of error

class azure.mgmt.iothubprovisioningservices.models.AsyncOperationResult(*, status: str = None, error=None, **kwargs)[source]

Bases: msrest.serialization.Model

Result of a long running operation.

Parameters
  • status (str) – current status of a long running operation.

  • error (ErrorMesssage) – Error message containing code, description and details

class azure.mgmt.iothubprovisioningservices.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 creation date and time.

  • updated (datetime) – The certificate’s last update date and time.

class azure.mgmt.iothubprovisioningservices.models.CertificateResponse(*, 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) – properties of a certificate

Variables
  • id (str) – The resource identifier.

  • name (str) – The name of the certificate.

  • etag (str) – The entity tag.

  • type (str) – The resource type.

class azure.mgmt.iothubprovisioningservices.models.CertificateListDescription(*, value=None, **kwargs)[source]

Bases: msrest.serialization.Model

The JSON-serialized array of Certificate objects.

Parameters

value (list[CertificateResponse]) – The array of Certificate objects.

class azure.mgmt.iothubprovisioningservices.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.iothubprovisioningservices.models.IotDpsSkuInfo(*, name=None, capacity: int = None, **kwargs)[source]

Bases: msrest.serialization.Model

List of possible provisoning service SKUs.

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

Parameters
  • name (str or IotDpsSku) – Sku name. Possible values include: ‘S1’

  • capacity (long) – The number of units to provision

Variables

tier (str) – Pricing tier name of the provisioning service.

class azure.mgmt.iothubprovisioningservices.models.IotHubDefinitionDescription(*, connection_string: str, location: str, apply_allocation_policy: bool = None, allocation_weight: int = None, **kwargs)[source]

Bases: msrest.serialization.Model

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.

Parameters
  • apply_allocation_policy (bool) – flag for applying allocationPolicy or not for a given iot hub.

  • allocation_weight (int) – weight to apply for a given iot h.

  • connection_string (str) – Required. Connection string og the IoT hub.

  • location (str) – Required. ARM region of the IoT hub.

Variables

name (str) – Host name of the IoT hub.

class azure.mgmt.iothubprovisioningservices.models.SharedAccessSignatureAuthorizationRuleAccessRightsDescription(*, key_name: str, rights, primary_key: str = None, secondary_key: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

Description of the shared access key.

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

Parameters
  • key_name (str) – Required. Name of the key.

  • primary_key (str) – Primary SAS key value.

  • secondary_key (str) – Secondary SAS key value.

  • rights (str or AccessRightsDescription) – Required. Rights that this key has. Possible values include: ‘ServiceConfig’, ‘EnrollmentRead’, ‘EnrollmentWrite’, ‘DeviceConnect’, ‘RegistrationStatusRead’, ‘RegistrationStatusWrite’

class azure.mgmt.iothubprovisioningservices.models.IotDpsPropertiesDescription(*, state=None, provisioning_state: str = None, iot_hubs=None, allocation_policy=None, authorization_policies=None, **kwargs)[source]

Bases: msrest.serialization.Model

the service specific properties of a provisoning service, including keys, linked iot hubs, current state, and system generated properties such as hostname and idScope.

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

Parameters
  • state (str or State) – Current state of the provisioning service. Possible values include: ‘Activating’, ‘Active’, ‘Deleting’, ‘Deleted’, ‘ActivationFailed’, ‘DeletionFailed’, ‘Transitioning’, ‘Suspending’, ‘Suspended’, ‘Resuming’, ‘FailingOver’, ‘FailoverFailed’

  • provisioning_state (str) – The ARM provisioning state of the provisioning service.

  • iot_hubs (list[IotHubDefinitionDescription]) – List of IoT hubs assosciated with this provisioning service.

  • allocation_policy (str or AllocationPolicy) – Allocation policy to be used by this provisioning service. Possible values include: ‘Hashed’, ‘GeoLatency’, ‘Static’

  • authorization_policies (list[SharedAccessSignatureAuthorizationRuleAccessRightsDescription]) – List of authorization keys for a provisioning service.

Variables
  • service_operations_host_name (str) – Service endpoint for provisioning service.

  • device_provisioning_host_name (str) – Device endpoint for this provisioning service.

  • id_scope (str) – Unique identifier of this provisioning service.

class azure.mgmt.iothubprovisioningservices.models.ProvisioningServiceDescription(*, location: str, properties, sku, tags=None, etag: str = None, **kwargs)[source]

Bases: azure.mgmt.iothubprovisioningservices.models.resource.Resource

The description of the provisioning service.

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
  • id (str) – The resource identifier.

  • name (str) – The resource name.

  • type (str) – The resource type.

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 (IotDpsPropertiesDescription) – Required. Service specific properties for a provisioning service

  • sku (IotDpsSkuInfo) – Required. Sku info for a provisioning Service.

class azure.mgmt.iothubprovisioningservices.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.

Variables
  • id (str) – The resource identifier.

  • name (str) – The resource name.

  • type (str) – The resource type.

Parameters
  • location (str) – Required. The resource location.

  • tags (dict[str, str]) – The resource tags.

class azure.mgmt.iothubprovisioningservices.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.

Variables
  • provider (str) – Service provider: Microsoft Devices.

  • resource (str) – Resource Type: ProvisioningServices.

  • operation (str) – Name of the operation.

class azure.mgmt.iothubprovisioningservices.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.iothubprovisioningservices.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.

Variables
  • code (str) – The error code.

  • http_status_code (str) – The HTTP status code.

  • message (str) – The error message.

  • details (str) – The error details.

class azure.mgmt.iothubprovisioningservices.models.IotDpsSkuDefinition(*, name=None, **kwargs)[source]

Bases: msrest.serialization.Model

Available Sku’s of tier and units.

Parameters

name (str or IotDpsSku) – Sku name. Possible values include: ‘S1’

class azure.mgmt.iothubprovisioningservices.models.OperationInputs(*, name: str, **kwargs)[source]

Bases: msrest.serialization.Model

Input values for operation results call.

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

Parameters

name (str) – Required. The name of the Provisioning Service to check.

class azure.mgmt.iothubprovisioningservices.models.NameAvailabilityInfo(*, name_available: bool = None, reason=None, message: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

Description of name availability.

Parameters
  • name_available (bool) – specifies if a name is available or not

  • reason (str or NameUnavailabilityReason) – specifies the reason a name is unavailable. Possible values include: ‘Invalid’, ‘AlreadyExists’

  • message (str) – message containing a etailed reason name is unavailable

class azure.mgmt.iothubprovisioningservices.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 a Provisioning Service instance.

Parameters

tags (dict[str, str]) – Resource tags

class azure.mgmt.iothubprovisioningservices.models.VerificationCodeResponseProperties(*, verification_code: str = None, subject: str = None, expiry: str = None, thumbprint: str = None, is_verified: bool = None, created: str = None, updated: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

VerificationCodeResponseProperties.

Parameters
  • verification_code (str) – Verification code.

  • subject (str) – Certificate subject.

  • expiry (str) – Code expiry.

  • thumbprint (str) – Certificate thumbprint.

  • is_verified (bool) – Indicate if the certificate is verified by owner of private key.

  • created (str) – Certificate created time.

  • updated (str) – Certificate updated time.

class azure.mgmt.iothubprovisioningservices.models.VerificationCodeResponse(*, properties=None, **kwargs)[source]

Bases: msrest.serialization.Model

Description of the response of the verification code.

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

Variables
  • name (str) – Name of certificate.

  • etag (str) – Request etag.

  • id (str) – The resource identifier.

  • type (str) – The resource type.

Parameters

properties (VerificationCodeResponseProperties) –

class azure.mgmt.iothubprovisioningservices.models.VerificationCodeRequest(*, 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.iothubprovisioningservices.models.OperationPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of Operation object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.iothubprovisioningservices.models.ProvisioningServiceDescriptionPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of ProvisioningServiceDescription object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.iothubprovisioningservices.models.IotDpsSkuDefinitionPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of IotDpsSkuDefinition object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.iothubprovisioningservices.models.SharedAccessSignatureAuthorizationRuleAccessRightsDescriptionPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of SharedAccessSignatureAuthorizationRuleAccessRightsDescription object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.iothubprovisioningservices.models.IotDpsSku[source]

Bases: str, enum.Enum

An enumeration.

s1 = 'S1'
class azure.mgmt.iothubprovisioningservices.models.State[source]

Bases: str, enum.Enum

An enumeration.

activating = 'Activating'
activation_failed = 'ActivationFailed'
active = 'Active'
deleted = 'Deleted'
deleting = 'Deleting'
deletion_failed = 'DeletionFailed'
failing_over = 'FailingOver'
failover_failed = 'FailoverFailed'
resuming = 'Resuming'
suspended = 'Suspended'
suspending = 'Suspending'
transitioning = 'Transitioning'
class azure.mgmt.iothubprovisioningservices.models.AllocationPolicy[source]

Bases: str, enum.Enum

An enumeration.

geo_latency = 'GeoLatency'
hashed = 'Hashed'
static = 'Static'
class azure.mgmt.iothubprovisioningservices.models.AccessRightsDescription[source]

Bases: str, enum.Enum

An enumeration.

device_connect = 'DeviceConnect'
enrollment_read = 'EnrollmentRead'
enrollment_write = 'EnrollmentWrite'
registration_status_read = 'RegistrationStatusRead'
registration_status_write = 'RegistrationStatusWrite'
service_config = 'ServiceConfig'
class azure.mgmt.iothubprovisioningservices.models.NameUnavailabilityReason[source]

Bases: str, enum.Enum

An enumeration.

already_exists = 'AlreadyExists'
invalid = 'Invalid'
class azure.mgmt.iothubprovisioningservices.models.CertificatePurpose[source]

Bases: str, enum.Enum

An enumeration.

client_authentication = 'clientAuthentication'
server_authentication = 'serverAuthentication'