azure.mgmt.iothubprovisioningservices.operations module¶
-
class
azure.mgmt.iothubprovisioningservices.operations.
DpsCertificateOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
IotDpsClient
’sdps_certificate
attribute.-
create_or_update
(resource_group_name: str, provisioning_service_name: str, certificate_name: str, certificate_description: _models.CertificateResponse, if_match: Optional[str] = None, *, content_type: str = "'application/json'", **kwargs: Any) → _models.CertificateResponse[source]¶ -
create_or_update
(resource_group_name: str, provisioning_service_name: str, certificate_name: str, certificate_description: IO, if_match: Optional[str] = None, *, content_type: str = "'application/json'", **kwargs: Any) → _models.CertificateResponse Upload the certificate to the provisioning service.
Add new certificate or update an existing certificate.
- Parameters
resource_group_name (str) – Resource group identifier. Required.
provisioning_service_name (str) – The name of the provisioning service. Required.
certificate_name (str) – The name of the certificate create or update. Required.
certificate_description (CertificateResponse or IO) – The certificate body. Is either a model type or a IO type. Required.
if_match (str) – ETag of the certificate. This is required to update an existing certificate, and ignored while creating a brand new certificate. Default value is None.
- Keyword Arguments
- Returns
CertificateResponse or the result of cls(response)
- Return type
- Raises
-
delete
(resource_group_name: str, if_match: str, provisioning_service_name: str, certificate_name: str, certificate_name1: Optional[str] = None, certificate_raw_bytes: Optional[bytes] = None, certificate_is_verified: Optional[bool] = None, certificate_purpose: Optional[Union[str, azure.mgmt.iothubprovisioningservices.models._iot_dps_client_enums.CertificatePurpose]] = None, certificate_created: Optional[datetime.datetime] = None, certificate_last_updated: Optional[datetime.datetime] = None, certificate_has_private_key: Optional[bool] = None, certificate_nonce: Optional[str] = None, **kwargs: Any) → None[source]¶ Delete the Provisioning Service Certificate.
Deletes the specified certificate associated with the Provisioning Service.
- Parameters
resource_group_name (str) – Resource group identifier. Required.
if_match (str) – ETag of the certificate. Required.
provisioning_service_name (str) – The name of the provisioning service. Required.
certificate_name (str) – This is a mandatory field, and is the logical name of the certificate that the provisioning service will access by. Required.
certificate_name1 (str) – This is optional, and it is the Common Name of the certificate. Default value is None.
certificate_raw_bytes (bytes) – Raw data within the certificate. Default value is None.
certificate_is_verified (bool) – Indicates if certificate has been verified by owner of the private key. Default value is None.
certificate_purpose (str or CertificatePurpose) – A description that mentions the purpose of the certificate. Known values are: “clientAuthentication” and “serverAuthentication”. Default value is None.
certificate_created (datetime) – Time the certificate is created. Default value is None.
certificate_last_updated (datetime) – Time the certificate is last updated. Default value is None.
certificate_has_private_key (bool) – Indicates if the certificate contains a private key. Default value is None.
certificate_nonce (str) – Random number generated to indicate Proof of Possession. Default value is None.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
None or the result of cls(response)
- Return type
- Raises
-
generate_verification_code
(certificate_name: str, if_match: str, resource_group_name: str, provisioning_service_name: str, certificate_name1: Optional[str] = None, certificate_raw_bytes: Optional[bytes] = None, certificate_is_verified: Optional[bool] = None, certificate_purpose: Optional[Union[str, azure.mgmt.iothubprovisioningservices.models._iot_dps_client_enums.CertificatePurpose]] = None, certificate_created: Optional[datetime.datetime] = None, certificate_last_updated: Optional[datetime.datetime] = None, certificate_has_private_key: Optional[bool] = None, certificate_nonce: Optional[str] = None, **kwargs: Any) → azure.mgmt.iothubprovisioningservices.models._models_py3.VerificationCodeResponse[source]¶ Generate verification code for Proof of Possession.
- Parameters
certificate_name (str) – The mandatory logical name of the certificate, that the provisioning service uses to access. Required.
if_match (str) – ETag of the certificate. This is required to update an existing certificate, and ignored while creating a brand new certificate. Required.
resource_group_name (str) – name of resource group. Required.
provisioning_service_name (str) – Name of provisioning service. Required.
certificate_name1 (str) – Common Name for the certificate. Default value is None.
certificate_raw_bytes (bytes) – Raw data of certificate. Default value is None.
certificate_is_verified (bool) – Indicates if the certificate has been verified by owner of the private key. Default value is None.
certificate_purpose (str or CertificatePurpose) – Description mentioning the purpose of the certificate. Known values are: “clientAuthentication” and “serverAuthentication”. Default value is None.
certificate_created (datetime) – Certificate creation time. Default value is None.
certificate_last_updated (datetime) – Certificate last updated time. Default value is None.
certificate_has_private_key (bool) – Indicates if the certificate contains private key. Default value is None.
certificate_nonce (str) – Random number generated to indicate Proof of Possession. Default value is None.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
VerificationCodeResponse or the result of cls(response)
- Return type
- Raises
-
get
(certificate_name: str, resource_group_name: str, provisioning_service_name: str, if_match: Optional[str] = None, **kwargs: Any) → azure.mgmt.iothubprovisioningservices.models._models_py3.CertificateResponse[source]¶ Get the certificate from the provisioning service.
- Parameters
certificate_name (str) – Name of the certificate to retrieve. Required.
resource_group_name (str) – Resource group identifier. Required.
provisioning_service_name (str) – Name of the provisioning service the certificate is associated with. Required.
if_match (str) – ETag of the certificate. Default value is None.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
CertificateResponse or the result of cls(response)
- Return type
- Raises
-
list
(resource_group_name: str, provisioning_service_name: str, **kwargs: Any) → azure.mgmt.iothubprovisioningservices.models._models_py3.CertificateListDescription[source]¶ Get all the certificates tied to the provisioning service.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
CertificateListDescription or the result of cls(response)
- Return type
- Raises
-
verify_certificate
(certificate_name: str, if_match: str, resource_group_name: str, provisioning_service_name: str, request: _models.VerificationCodeRequest, certificate_name1: Optional[str] = None, certificate_raw_bytes: Optional[bytes] = None, certificate_is_verified: Optional[bool] = None, certificate_purpose: Optional[Union[str, _models.CertificatePurpose]] = None, certificate_created: Optional[datetime.datetime] = None, certificate_last_updated: Optional[datetime.datetime] = None, certificate_has_private_key: Optional[bool] = None, certificate_nonce: Optional[str] = None, *, content_type: str = "'application/json'", **kwargs: Any) → _models.CertificateResponse[source]¶ -
verify_certificate
(certificate_name: str, if_match: str, resource_group_name: str, provisioning_service_name: str, request: IO, certificate_name1: Optional[str] = None, certificate_raw_bytes: Optional[bytes] = None, certificate_is_verified: Optional[bool] = None, certificate_purpose: Optional[Union[str, _models.CertificatePurpose]] = None, certificate_created: Optional[datetime.datetime] = None, certificate_last_updated: Optional[datetime.datetime] = None, certificate_has_private_key: Optional[bool] = None, certificate_nonce: Optional[str] = None, *, content_type: str = "'application/json'", **kwargs: Any) → _models.CertificateResponse Verify certificate’s private key possession.
Verifies the certificate’s private key possession by providing the leaf cert issued by the verifying pre uploaded certificate.
- Parameters
certificate_name (str) – The mandatory logical name of the certificate, that the provisioning service uses to access. Required.
if_match (str) – ETag of the certificate. Required.
resource_group_name (str) – Resource group name. Required.
provisioning_service_name (str) – Provisioning service name. Required.
request (VerificationCodeRequest or IO) – The name of the certificate. Is either a model type or a IO type. Required.
certificate_name1 (str) – Common Name for the certificate. Default value is None.
certificate_raw_bytes (bytes) – Raw data of certificate. Default value is None.
certificate_is_verified (bool) – Indicates if the certificate has been verified by owner of the private key. Default value is None.
certificate_purpose (str or CertificatePurpose) – Describe the purpose of the certificate. Known values are: “clientAuthentication” and “serverAuthentication”. Default value is None.
certificate_created (datetime) – Certificate creation time. Default value is None.
certificate_last_updated (datetime) – Certificate last updated time. Default value is None.
certificate_has_private_key (bool) – Indicates if the certificate contains private key. Default value is None.
certificate_nonce (str) – Random number generated to indicate Proof of Possession. Default value is None.
- Keyword Arguments
- Returns
CertificateResponse or the result of cls(response)
- Return type
- Raises
-
models
= <module 'azure.mgmt.iothubprovisioningservices.models' from '/mnt/vss/_work/1/s/sdk/iothub/azure-mgmt-iothubprovisioningservices/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/iothubprovisioningservices/models/__init__.py'>¶
-
-
class
azure.mgmt.iothubprovisioningservices.operations.
IotDpsResourceOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
IotDpsClient
’siot_dps_resource
attribute.-
begin_create_or_update
(resource_group_name: str, provisioning_service_name: str, iot_dps_description: _models.ProvisioningServiceDescription, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ProvisioningServiceDescription][source]¶ -
begin_create_or_update
(resource_group_name: str, provisioning_service_name: str, iot_dps_description: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ProvisioningServiceDescription] Create or update the metadata of the provisioning service.
Create or update the metadata of the provisioning service. The usual pattern to modify a property is to retrieve the provisioning service metadata and security metadata, and then combine them with the modified values in a new body to update the provisioning service.
- Parameters
resource_group_name (str) – Resource group identifier. Required.
provisioning_service_name (str) – Name of provisioning service to create or update. Required.
iot_dps_description (ProvisioningServiceDescription or IO) – Description of the provisioning service to create or update. Is either a model type or a IO type. Required.
- Keyword Arguments
content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.
- Returns
An instance of LROPoller that returns either ProvisioningServiceDescription or the result of cls(response)
- Return type
- Raises
-
begin_create_or_update_private_endpoint_connection
(resource_group_name: str, resource_name: str, private_endpoint_connection_name: str, private_endpoint_connection: _models.PrivateEndpointConnection, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.PrivateEndpointConnection][source]¶ -
begin_create_or_update_private_endpoint_connection
(resource_group_name: str, resource_name: str, private_endpoint_connection_name: str, private_endpoint_connection: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.PrivateEndpointConnection] Create or update private endpoint connection.
Create or update the status of a private endpoint connection with the specified name.
- Parameters
resource_group_name (str) – The name of the resource group that contains the provisioning service. Required.
resource_name (str) – The name of the provisioning service. Required.
private_endpoint_connection_name (str) – The name of the private endpoint connection. Required.
private_endpoint_connection (PrivateEndpointConnection or IO) – The private endpoint connection with updated properties. Is either a model type or a IO type. Required.
- Keyword Arguments
content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.
- Returns
An instance of LROPoller that returns either PrivateEndpointConnection or the result of cls(response)
- Return type
- Raises
-
begin_delete
(provisioning_service_name: str, resource_group_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶ Delete the Provisioning Service.
Deletes the Provisioning Service.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.
- Returns
An instance of LROPoller that returns either None or the result of cls(response)
- Return type
- Raises
-
begin_delete_private_endpoint_connection
(resource_group_name: str, resource_name: str, private_endpoint_connection_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.iothubprovisioningservices.models._models_py3.PrivateEndpointConnection][source]¶ Delete private endpoint connection.
Delete private endpoint connection with the specified name.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.
- Returns
An instance of LROPoller that returns either PrivateEndpointConnection or the result of cls(response)
- Return type
- Raises
-
begin_update
(resource_group_name: str, provisioning_service_name: str, provisioning_service_tags: _models.TagsResource, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ProvisioningServiceDescription][source]¶ -
begin_update
(resource_group_name: str, provisioning_service_name: str, provisioning_service_tags: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ProvisioningServiceDescription] Update an existing provisioning service’s tags.
Update an existing provisioning service’s tags. to update other fields use the CreateOrUpdate method.
- Parameters
resource_group_name (str) – Resource group identifier. Required.
provisioning_service_name (str) – Name of provisioning service to create or update. Required.
provisioning_service_tags (TagsResource or IO) – Updated tag information to set into the provisioning service instance. Is either a model type or a IO type. Required.
- Keyword Arguments
content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.
- Returns
An instance of LROPoller that returns either ProvisioningServiceDescription or the result of cls(response)
- Return type
- Raises
-
check_provisioning_service_name_availability
(arguments: _models.OperationInputs, *, content_type: str = "'application/json'", **kwargs: Any) → _models.NameAvailabilityInfo[source]¶ -
check_provisioning_service_name_availability
(arguments: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.NameAvailabilityInfo Check if a provisioning service name is available.
Check if a provisioning service name is available. This will validate if the name is syntactically valid and if the name is usable.
- Parameters
arguments (OperationInputs or IO) – Set the name parameter in the OperationInputs structure to the name of the provisioning service to check. Is either a model type or a IO type. Required.
- Keyword Arguments
- Returns
NameAvailabilityInfo or the result of cls(response)
- Return type
- Raises
-
get
(provisioning_service_name: str, resource_group_name: str, **kwargs: Any) → azure.mgmt.iothubprovisioningservices.models._models_py3.ProvisioningServiceDescription[source]¶ Get the non-security related metadata of the provisioning service.
Get the metadata of the provisioning service without SAS keys.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
ProvisioningServiceDescription or the result of cls(response)
- Return type
- Raises
-
get_operation_result
(operation_id: str, resource_group_name: str, provisioning_service_name: str, asyncinfo: str = 'true', **kwargs: Any) → azure.mgmt.iothubprovisioningservices.models._models_py3.AsyncOperationResult[source]¶ Gets the status of a long running operation, such as create, update or delete a provisioning service.
- Parameters
operation_id (str) – Operation id corresponding to long running operation. Use this to poll for the status. Required.
resource_group_name (str) – Resource group identifier. Required.
provisioning_service_name (str) – Name of provisioning service that the operation is running on. Required.
asyncinfo (str) – Async header used to poll on the status of the operation, obtained while creating the long running operation. Default value is “true”.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
AsyncOperationResult or the result of cls(response)
- Return type
- Raises
-
get_private_endpoint_connection
(resource_group_name: str, resource_name: str, private_endpoint_connection_name: str, **kwargs: Any) → azure.mgmt.iothubprovisioningservices.models._models_py3.PrivateEndpointConnection[source]¶ Get private endpoint connection.
Get private endpoint connection properties.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
PrivateEndpointConnection or the result of cls(response)
- Return type
- Raises
-
get_private_link_resources
(resource_group_name: str, resource_name: str, group_id: str, **kwargs: Any) → azure.mgmt.iothubprovisioningservices.models._models_py3.GroupIdInformation[source]¶ Get the specified private link resource.
Get the specified private link resource for the given provisioning service.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
GroupIdInformation or the result of cls(response)
- Return type
- Raises
-
list_by_resource_group
(resource_group_name: str, **kwargs: Any) → Iterable[azure.mgmt.iothubprovisioningservices.models._models_py3.ProvisioningServiceDescription][source]¶ Get a list of all provisioning services in the given resource group.
- Parameters
resource_group_name (str) – Resource group identifier. Required.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either ProvisioningServiceDescription or the result of cls(response)
- Return type
- Raises
-
list_by_subscription
(**kwargs: Any) → Iterable[azure.mgmt.iothubprovisioningservices.models._models_py3.ProvisioningServiceDescription][source]¶ Get all the provisioning services in a subscription.
List all the provisioning services for a given subscription id.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either ProvisioningServiceDescription or the result of cls(response)
- Return type
- Raises
-
list_keys
(provisioning_service_name: str, resource_group_name: str, **kwargs: Any) → Iterable[azure.mgmt.iothubprovisioningservices.models._models_py3.SharedAccessSignatureAuthorizationRuleAccessRightsDescription][source]¶ Get the security metadata for a provisioning service.
List the primary and secondary keys for a provisioning service.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either SharedAccessSignatureAuthorizationRuleAccessRightsDescription or the result of cls(response)
- Return type
ItemPaged[SharedAccessSignatureAuthorizationRuleAccessRightsDescription]
- Raises
-
list_keys_for_key_name
(provisioning_service_name: str, key_name: str, resource_group_name: str, **kwargs: Any) → azure.mgmt.iothubprovisioningservices.models._models_py3.SharedAccessSignatureAuthorizationRuleAccessRightsDescription[source]¶ Get a shared access policy by name from a provisioning service.
List primary and secondary keys for a specific key name.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
SharedAccessSignatureAuthorizationRuleAccessRightsDescription or the result of cls(response)
- Return type
SharedAccessSignatureAuthorizationRuleAccessRightsDescription
- Raises
-
list_private_endpoint_connections
(resource_group_name: str, resource_name: str, **kwargs: Any) → List[azure.mgmt.iothubprovisioningservices.models._models_py3.PrivateEndpointConnection][source]¶ List private endpoint connections.
List private endpoint connection properties.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
list of PrivateEndpointConnection or the result of cls(response)
- Return type
- Raises
-
list_private_link_resources
(resource_group_name: str, resource_name: str, **kwargs: Any) → azure.mgmt.iothubprovisioningservices.models._models_py3.PrivateLinkResources[source]¶ List private link resources.
List private link resources for the given provisioning service.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
PrivateLinkResources or the result of cls(response)
- Return type
- Raises
-
list_valid_skus
(provisioning_service_name: str, resource_group_name: str, **kwargs: Any) → Iterable[azure.mgmt.iothubprovisioningservices.models._models_py3.IotDpsSkuDefinition][source]¶ Get the list of valid SKUs for a provisioning service.
Gets the list of valid SKUs and tiers for a provisioning service.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either IotDpsSkuDefinition or the result of cls(response)
- Return type
- Raises
-
models
= <module 'azure.mgmt.iothubprovisioningservices.models' from '/mnt/vss/_work/1/s/sdk/iothub/azure-mgmt-iothubprovisioningservices/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/iothubprovisioningservices/models/__init__.py'>¶
-
-
class
azure.mgmt.iothubprovisioningservices.operations.
Operations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
IotDpsClient
’soperations
attribute.-
list
(**kwargs: Any) → Iterable[azure.mgmt.iothubprovisioningservices.models._models_py3.Operation][source]¶ Lists all of the available Microsoft.Devices REST API operations.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either Operation or the result of cls(response)
- Return type
- Raises
-
models
= <module 'azure.mgmt.iothubprovisioningservices.models' from '/mnt/vss/_work/1/s/sdk/iothub/azure-mgmt-iothubprovisioningservices/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/iothubprovisioningservices/models/__init__.py'>¶
-