azure.mgmt.iothubprovisioningservices.models module

class azure.mgmt.iothubprovisioningservices.models.AccessRightsDescription(value)[source]

Bases: str, enum.Enum

Rights that this key has.

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.AllocationPolicy(value)[source]

Bases: str, enum.Enum

Allocation policy to be used by this provisioning service.

GEO_LATENCY = 'GeoLatency'
HASHED = 'Hashed'
STATIC = 'Static'
class azure.mgmt.iothubprovisioningservices.models.AsyncOperationResult(*, status: Optional[str] = None, error: Optional[_models.ErrorMessage] = None, **kwargs)[source]

Bases: azure.mgmt.iothubprovisioningservices._serialization.Model

Result of a long running operation.

Variables

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

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

Keyword Arguments

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

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

class azure.mgmt.iothubprovisioningservices.models.CertificateBodyDescription(*, certificate: Optional[str] = None, is_verified: Optional[bool] = None, **kwargs)[source]

Bases: azure.mgmt.iothubprovisioningservices._serialization.Model

The JSON-serialized X509 Certificate.

Variables

  • certificate (str) – Base-64 representation of the X509 leaf certificate .cer file or just .pem file content.

  • is_verified (bool) – True indicates that the certificate will be created in verified state and proof of possession will not be required.

Keyword Arguments

  • certificate (str) – Base-64 representation of the X509 leaf certificate .cer file or just .pem file content.

  • is_verified (bool) – True indicates that the certificate will be created in verified state and proof of possession will not be required.

class azure.mgmt.iothubprovisioningservices.models.CertificateListDescription(*, value: Optional[List[_models.CertificateResponse]] = None, **kwargs)[source]

Bases: azure.mgmt.iothubprovisioningservices._serialization.Model

The JSON-serialized array of Certificate objects.

Variables

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

Keyword Arguments

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

class azure.mgmt.iothubprovisioningservices.models.CertificateProperties(*, is_verified: Optional[bool] = None, certificate: Optional[bytes] = None, **kwargs)[source]

Bases: azure.mgmt.iothubprovisioningservices._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.

  • certificate (bytes) – base-64 representation of X509 certificate .cer file or just .pem file content.

  • created (datetime) – The certificate’s creation date and time.

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

Keyword Arguments

  • is_verified (bool) – Determines whether certificate has been verified.

  • certificate (bytes) – base-64 representation of X509 certificate .cer file or just .pem file content.

class azure.mgmt.iothubprovisioningservices.models.CertificatePurpose(value)[source]

Bases: str, enum.Enum

CertificatePurpose.

CLIENT_AUTHENTICATION = 'clientAuthentication'
SERVER_AUTHENTICATION = 'serverAuthentication'
class azure.mgmt.iothubprovisioningservices.models.CertificateResponse(*, properties: Optional[_models.CertificateProperties] = None, **kwargs)[source]

Bases: azure.mgmt.iothubprovisioningservices._serialization.Model

The X509 Certificate.

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

Variables

  • properties (CertificateProperties) – properties of a certificate.

  • id (str) – The resource identifier.

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

  • etag (str) – The entity tag.

  • type (str) – The resource type.

  • system_data (SystemData) – Metadata pertaining to creation and last modification of the resource.

Keyword Arguments

properties (CertificateProperties) – properties of a certificate.

class azure.mgmt.iothubprovisioningservices.models.CreatedByType(value)[source]

Bases: str, enum.Enum

The type of identity that created the resource.

APPLICATION = 'Application'
KEY = 'Key'
MANAGED_IDENTITY = 'ManagedIdentity'
USER = 'User'
class azure.mgmt.iothubprovisioningservices.models.ErrorDetails(**kwargs)[source]

Bases: azure.mgmt.iothubprovisioningservices._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.ErrorMessage(*, code: Optional[str] = None, message: Optional[str] = None, details: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.iothubprovisioningservices._serialization.Model

Error response containing message and code.

Variables

  • code (str) – standard error code.

  • message (str) – standard error description.

  • details (str) – detailed summary of error.

Keyword Arguments

  • code (str) – standard error code.

  • message (str) – standard error description.

  • details (str) – detailed summary of error.

class azure.mgmt.iothubprovisioningservices.models.GroupIdInformation(*, properties: _models.GroupIdInformationProperties, **kwargs)[source]

Bases: azure.mgmt.iothubprovisioningservices._serialization.Model

The group information for creating a private endpoint on a 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
Keyword Arguments

properties (GroupIdInformationProperties) – The properties for a group information object. Required.

class azure.mgmt.iothubprovisioningservices.models.GroupIdInformationProperties(*, group_id: Optional[str] = None, required_members: Optional[List[str]] = None, required_zone_names: Optional[List[str]] = None, **kwargs)[source]

Bases: azure.mgmt.iothubprovisioningservices._serialization.Model

The properties for a group information object.

Variables

  • group_id (str) – The group id.

  • required_members (list[str]) – The required members for a specific group id.

  • required_zone_names (list[str]) – The required DNS zones for a specific group id.

Keyword Arguments

  • group_id (str) – The group id.

  • required_members (list[str]) – The required members for a specific group id.

  • required_zone_names (list[str]) – The required DNS zones for a specific group id.

class azure.mgmt.iothubprovisioningservices.models.IotDpsPropertiesDescription(*, state: Optional[Union[str, _models.State]] = None, public_network_access: Optional[Union[str, _models.PublicNetworkAccess]] = None, ip_filter_rules: Optional[List[_models.IpFilterRule]] = None, private_endpoint_connections: Optional[List[_models.PrivateEndpointConnection]] = None, provisioning_state: Optional[str] = None, iot_hubs: Optional[List[_models.IotHubDefinitionDescription]] = None, allocation_policy: Optional[Union[str, _models.AllocationPolicy]] = None, authorization_policies: Optional[List[_models.SharedAccessSignatureAuthorizationRuleAccessRightsDescription]] = None, enable_data_residency: Optional[bool] = None, **kwargs)[source]

Bases: azure.mgmt.iothubprovisioningservices._serialization.Model

the service specific properties of a provisioning 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.

Variables

  • state (str or State) – Current state of the provisioning service. Known values are: “Activating”, “Active”, “Deleting”, “Deleted”, “ActivationFailed”, “DeletionFailed”, “Transitioning”, “Suspending”, “Suspended”, “Resuming”, “FailingOver”, and “FailoverFailed”.

  • public_network_access (str or PublicNetworkAccess) – Whether requests from Public Network are allowed. Known values are: “Enabled” and “Disabled”.

  • ip_filter_rules (list[IpFilterRule]) – The IP filter rules.

  • private_endpoint_connections (list[PrivateEndpointConnection]) – Private endpoint connections created on this IotHub.

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

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

  • allocation_policy (str or AllocationPolicy) – Allocation policy to be used by this provisioning service. Known values are: “Hashed”, “GeoLatency”, and “Static”.

  • 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.

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

  • enable_data_residency (bool) – Optional. Indicates if the DPS instance has Data Residency enabled, removing the cross geo-pair disaster recovery.

Keyword Arguments

  • state (str or State) – Current state of the provisioning service. Known values are: “Activating”, “Active”, “Deleting”, “Deleted”, “ActivationFailed”, “DeletionFailed”, “Transitioning”, “Suspending”, “Suspended”, “Resuming”, “FailingOver”, and “FailoverFailed”.

  • public_network_access (str or PublicNetworkAccess) – Whether requests from Public Network are allowed. Known values are: “Enabled” and “Disabled”.

  • ip_filter_rules (list[IpFilterRule]) – The IP filter rules.

  • private_endpoint_connections (list[PrivateEndpointConnection]) – Private endpoint connections created on this IotHub.

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

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

  • allocation_policy (str or AllocationPolicy) – Allocation policy to be used by this provisioning service. Known values are: “Hashed”, “GeoLatency”, and “Static”.

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

  • enable_data_residency (bool) – Optional. Indicates if the DPS instance has Data Residency enabled, removing the cross geo-pair disaster recovery.

class azure.mgmt.iothubprovisioningservices.models.IotDpsSku(value)[source]

Bases: str, enum.Enum

Sku name.

S1 = 'S1'
class azure.mgmt.iothubprovisioningservices.models.IotDpsSkuDefinition(*, name: Optional[Union[str, _models.IotDpsSku]] = None, **kwargs)[source]

Bases: azure.mgmt.iothubprovisioningservices._serialization.Model

Available SKUs of tier and units.

Variables

name (str or IotDpsSku) – Sku name. “S1”

Keyword Arguments

name (str or IotDpsSku) – Sku name. “S1”

class azure.mgmt.iothubprovisioningservices.models.IotDpsSkuDefinitionListResult(*, value: Optional[List[_models.IotDpsSkuDefinition]] = None, **kwargs)[source]

Bases: azure.mgmt.iothubprovisioningservices._serialization.Model

List of available SKUs.

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

Variables
Keyword Arguments

value (list[IotDpsSkuDefinition]) – The list of SKUs.

class azure.mgmt.iothubprovisioningservices.models.IotDpsSkuInfo(*, name: Optional[Union[str, _models.IotDpsSku]] = None, capacity: Optional[int] = None, **kwargs)[source]

Bases: azure.mgmt.iothubprovisioningservices._serialization.Model

List of possible provisioning service SKUs.

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

Variables

  • name (str or IotDpsSku) – Sku name. “S1”

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

  • capacity (int) – The number of units to provision.

Keyword Arguments

  • name (str or IotDpsSku) – Sku name. “S1”

  • capacity (int) – The number of units to provision.

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

Bases: azure.mgmt.iothubprovisioningservices._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.

Variables

  • 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.

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

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

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

Keyword Arguments

  • 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) – Connection string of the IoT hub. Required.

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

class azure.mgmt.iothubprovisioningservices.models.IpFilterActionType(value)[source]

Bases: str, enum.Enum

The desired action for requests captured by this rule.

ACCEPT = 'Accept'
REJECT = 'Reject'
class azure.mgmt.iothubprovisioningservices.models.IpFilterRule(*, filter_name: str, action: Union[str, _models.IpFilterActionType], ip_mask: str, target: Optional[Union[str, _models.IpFilterTargetType]] = None, **kwargs)[source]

Bases: azure.mgmt.iothubprovisioningservices._serialization.Model

The IP filter rules for a provisioning Service.

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

Variables

  • filter_name (str) – The name of the IP filter rule. Required.

  • action (str or IpFilterActionType) – The desired action for requests captured by this rule. Required. Known values are: “Accept” and “Reject”.

  • ip_mask (str) – A string that contains the IP address range in CIDR notation for the rule. Required.

  • target (str or IpFilterTargetType) – Target for requests captured by this rule. Known values are: “all”, “serviceApi”, and “deviceApi”.

Keyword Arguments

  • filter_name (str) – The name of the IP filter rule. Required.

  • action (str or IpFilterActionType) – The desired action for requests captured by this rule. Required. Known values are: “Accept” and “Reject”.

  • ip_mask (str) – A string that contains the IP address range in CIDR notation for the rule. Required.

  • target (str or IpFilterTargetType) – Target for requests captured by this rule. Known values are: “all”, “serviceApi”, and “deviceApi”.

class azure.mgmt.iothubprovisioningservices.models.IpFilterTargetType(value)[source]

Bases: str, enum.Enum

Target for requests captured by this rule.

ALL = 'all'
DEVICE_API = 'deviceApi'
SERVICE_API = 'serviceApi'
class azure.mgmt.iothubprovisioningservices.models.NameAvailabilityInfo(*, name_available: Optional[bool] = None, reason: Optional[Union[str, _models.NameUnavailabilityReason]] = None, message: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.iothubprovisioningservices._serialization.Model

Description of name availability.

Variables

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

  • reason (str or NameUnavailabilityReason) – specifies the reason a name is unavailable. Known values are: “Invalid” and “AlreadyExists”.

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

Keyword Arguments

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

  • reason (str or NameUnavailabilityReason) – specifies the reason a name is unavailable. Known values are: “Invalid” and “AlreadyExists”.

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

class azure.mgmt.iothubprovisioningservices.models.NameUnavailabilityReason(value)[source]

Bases: str, enum.Enum

specifies the reason a name is unavailable.

ALREADY_EXISTS = 'AlreadyExists'
INVALID = 'Invalid'
class azure.mgmt.iothubprovisioningservices.models.Operation(*, display: Optional[_models.OperationDisplay] = None, **kwargs)[source]

Bases: azure.mgmt.iothubprovisioningservices._serialization.Model

Provisioning Service 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}.

  • display (OperationDisplay) – The object that represents the operation.

Keyword Arguments

display (OperationDisplay) – The object that represents the operation.

class azure.mgmt.iothubprovisioningservices.models.OperationDisplay(**kwargs)[source]

Bases: azure.mgmt.iothubprovisioningservices._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.OperationInputs(*, name: str, **kwargs)[source]

Bases: azure.mgmt.iothubprovisioningservices._serialization.Model

Input values for operation results call.

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

Variables

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

Keyword Arguments

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

class azure.mgmt.iothubprovisioningservices.models.OperationListResult(**kwargs)[source]

Bases: azure.mgmt.iothubprovisioningservices._serialization.Model

Result of the request to list provisioning service 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.

Variables

  • value (list[Operation]) – Provisioning service operations supported by the Microsoft.Devices resource provider.

  • next_link (str) – URL to get the next set of operation list results if there are any.

class azure.mgmt.iothubprovisioningservices.models.PrivateEndpoint(**kwargs)[source]

Bases: azure.mgmt.iothubprovisioningservices._serialization.Model

The private endpoint property of a private endpoint connection.

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

Variables

id (str) – The resource identifier.

class azure.mgmt.iothubprovisioningservices.models.PrivateEndpointConnection(*, properties: _models.PrivateEndpointConnectionProperties, **kwargs)[source]

Bases: azure.mgmt.iothubprovisioningservices._serialization.Model

The private endpoint connection of a 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.

  • properties (PrivateEndpointConnectionProperties) – The properties of a private endpoint connection. Required.

  • system_data (SystemData) – Metadata pertaining to creation and last modification of the resource.

Keyword Arguments

properties (PrivateEndpointConnectionProperties) – The properties of a private endpoint connection. Required.

class azure.mgmt.iothubprovisioningservices.models.PrivateEndpointConnectionProperties(*, private_link_service_connection_state: _models.PrivateLinkServiceConnectionState, private_endpoint: Optional[_models.PrivateEndpoint] = None, **kwargs)[source]

Bases: azure.mgmt.iothubprovisioningservices._serialization.Model

The properties of a private endpoint connection.

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

Variables

  • private_endpoint (PrivateEndpoint) – The private endpoint property of a private endpoint connection.

  • private_link_service_connection_state (PrivateLinkServiceConnectionState) – The current state of a private endpoint connection. Required.

Keyword Arguments

  • private_endpoint (PrivateEndpoint) – The private endpoint property of a private endpoint connection.

  • private_link_service_connection_state (PrivateLinkServiceConnectionState) – The current state of a private endpoint connection. Required.

class azure.mgmt.iothubprovisioningservices.models.PrivateLinkResources(*, value: Optional[List[_models.GroupIdInformation]] = None, **kwargs)[source]

Bases: azure.mgmt.iothubprovisioningservices._serialization.Model

The available private link resources for a provisioning service.

Variables

value (list[GroupIdInformation]) – The list of available private link resources for a provisioning service.

Keyword Arguments

value (list[GroupIdInformation]) – The list of available private link resources for a provisioning service.

class azure.mgmt.iothubprovisioningservices.models.PrivateLinkServiceConnectionState(*, status: Union[str, _models.PrivateLinkServiceConnectionStatus], description: str, actions_required: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.iothubprovisioningservices._serialization.Model

The current state of a private endpoint connection.

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

Variables

  • status (str or PrivateLinkServiceConnectionStatus) – The status of a private endpoint connection. Required. Known values are: “Pending”, “Approved”, “Rejected”, and “Disconnected”.

  • description (str) – The description for the current state of a private endpoint connection. Required.

  • actions_required (str) – Actions required for a private endpoint connection.

Keyword Arguments

  • status (str or PrivateLinkServiceConnectionStatus) – The status of a private endpoint connection. Required. Known values are: “Pending”, “Approved”, “Rejected”, and “Disconnected”.

  • description (str) – The description for the current state of a private endpoint connection. Required.

  • actions_required (str) – Actions required for a private endpoint connection.

class azure.mgmt.iothubprovisioningservices.models.PrivateLinkServiceConnectionStatus(value)[source]

Bases: str, enum.Enum

The status of a private endpoint connection.

APPROVED = 'Approved'
DISCONNECTED = 'Disconnected'
PENDING = 'Pending'
REJECTED = 'Rejected'
class azure.mgmt.iothubprovisioningservices.models.ProvisioningServiceDescription(*, location: str, properties: _models.IotDpsPropertiesDescription, sku: _models.IotDpsSkuInfo, tags: Optional[Dict[str, str]] = None, etag: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.iothubprovisioningservices.models._models_py3.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.

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

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

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

  • system_data (SystemData) – Metadata pertaining to creation and last modification of the resource.

Keyword Arguments

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

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

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

class azure.mgmt.iothubprovisioningservices.models.ProvisioningServiceDescriptionListResult(*, value: Optional[List[_models.ProvisioningServiceDescription]] = None, **kwargs)[source]

Bases: azure.mgmt.iothubprovisioningservices._serialization.Model

List of provisioning service descriptions.

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

Variables
Keyword Arguments

value (list[ProvisioningServiceDescription]) – List of provisioning service descriptions.

class azure.mgmt.iothubprovisioningservices.models.PublicNetworkAccess(value)[source]

Bases: str, enum.Enum

Whether requests from Public Network are allowed.

DISABLED = 'Disabled'
ENABLED = 'Enabled'
class azure.mgmt.iothubprovisioningservices.models.Resource(*, location: str, tags: Optional[Dict[str, str]] = None, **kwargs)[source]

Bases: azure.mgmt.iothubprovisioningservices._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.

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

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

Keyword Arguments

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

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

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

Bases: azure.mgmt.iothubprovisioningservices._serialization.Model

Description of the shared access key.

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

Variables

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

  • primary_key (str) – Primary SAS key value.

  • secondary_key (str) – Secondary SAS key value.

  • rights (str or AccessRightsDescription) – Rights that this key has. Required. Known values are: “ServiceConfig”, “EnrollmentRead”, “EnrollmentWrite”, “DeviceConnect”, “RegistrationStatusRead”, and “RegistrationStatusWrite”.

Keyword Arguments

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

  • primary_key (str) – Primary SAS key value.

  • secondary_key (str) – Secondary SAS key value.

  • rights (str or AccessRightsDescription) – Rights that this key has. Required. Known values are: “ServiceConfig”, “EnrollmentRead”, “EnrollmentWrite”, “DeviceConnect”, “RegistrationStatusRead”, and “RegistrationStatusWrite”.

class azure.mgmt.iothubprovisioningservices.models.SharedAccessSignatureAuthorizationRuleListResult(*, value: Optional[List[_models.SharedAccessSignatureAuthorizationRuleAccessRightsDescription]] = None, **kwargs)[source]

Bases: azure.mgmt.iothubprovisioningservices._serialization.Model

List of shared access keys.

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

Variables
Keyword Arguments

value (list[SharedAccessSignatureAuthorizationRuleAccessRightsDescription]) – The list of shared access policies.

class azure.mgmt.iothubprovisioningservices.models.State(value)[source]

Bases: str, enum.Enum

Current state of the provisioning service.

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.SystemData(*, created_by: Optional[str] = None, created_by_type: Optional[Union[str, _models.CreatedByType]] = None, created_at: Optional[datetime.datetime] = None, last_modified_by: Optional[str] = None, last_modified_by_type: Optional[Union[str, _models.CreatedByType]] = None, last_modified_at: Optional[datetime.datetime] = None, **kwargs)[source]

Bases: azure.mgmt.iothubprovisioningservices._serialization.Model

Metadata pertaining to creation and last modification of the resource.

Variables

  • created_by (str) – The identity that created the resource.

  • created_by_type (str or CreatedByType) – The type of identity that created the resource. Known values are: “User”, “Application”, “ManagedIdentity”, and “Key”.

  • created_at (datetime) – The timestamp of resource creation (UTC).

  • last_modified_by (str) – The identity that last modified the resource.

  • last_modified_by_type (str or CreatedByType) – The type of identity that last modified the resource. Known values are: “User”, “Application”, “ManagedIdentity”, and “Key”.

  • last_modified_at (datetime) – The timestamp of resource last modification (UTC).

Keyword Arguments

  • created_by (str) – The identity that created the resource.

  • created_by_type (str or CreatedByType) – The type of identity that created the resource. Known values are: “User”, “Application”, “ManagedIdentity”, and “Key”.

  • created_at (datetime) – The timestamp of resource creation (UTC).

  • last_modified_by (str) – The identity that last modified the resource.

  • last_modified_by_type (str or CreatedByType) – The type of identity that last modified the resource. Known values are: “User”, “Application”, “ManagedIdentity”, and “Key”.

  • last_modified_at (datetime) – The timestamp of resource last modification (UTC).

class azure.mgmt.iothubprovisioningservices.models.TagsResource(*, tags: Optional[Dict[str, str]] = None, **kwargs)[source]

Bases: azure.mgmt.iothubprovisioningservices._serialization.Model

A container holding only the Tags for a resource, allowing the user to update the tags on a Provisioning Service instance.

Variables

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

Keyword Arguments

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

class azure.mgmt.iothubprovisioningservices.models.VerificationCodeRequest(*, certificate: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.iothubprovisioningservices._serialization.Model

The JSON-serialized leaf certificate.

Variables

certificate (str) – base-64 representation of X509 certificate .cer file or just .pem file content.

Keyword Arguments

certificate (str) – base-64 representation of X509 certificate .cer file or just .pem file content.

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

Bases: azure.mgmt.iothubprovisioningservices._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
Keyword Arguments

properties (VerificationCodeResponseProperties) –

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

Bases: azure.mgmt.iothubprovisioningservices._serialization.Model

VerificationCodeResponseProperties.

Variables

  • 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.

  • certificate (bytes) – base-64 representation of X509 certificate .cer file or just .pem file content.

  • created (str) – Certificate created time.

  • updated (str) – Certificate updated time.

Keyword Arguments

  • 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.

  • certificate (bytes) – base-64 representation of X509 certificate .cer file or just .pem file content.

  • created (str) – Certificate created time.

  • updated (str) – Certificate updated time.