azure.mgmt.iothubprovisioningservices.operations module¶
-
class
azure.mgmt.iothubprovisioningservices.operations.DpsCertificateOperations(client, config, serializer, deserializer)[source]¶ Bases:
objectDpsCertificateOperations operations.
You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.
- Variables
models – Alias to model classes used in this operation group.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
-
create_or_update(resource_group_name: str, provisioning_service_name: str, certificate_name: str, certificate_description: azure.mgmt.iothubprovisioningservices.models._models_py3.CertificateBodyDescription, if_match: Optional[str] = None, **kwargs: Any) → azure.mgmt.iothubprovisioningservices.models._models_py3.CertificateResponse[source]¶ Upload the certificate to the provisioning service.
Add new certificate or update an existing certificate.
- Parameters
resource_group_name (str) – Resource group identifier.
provisioning_service_name (str) – The name of the provisioning service.
certificate_name (str) – The name of the certificate create or update.
certificate_description (CertificateBodyDescription) – The certificate body.
if_match (str) – ETag of the certificate. This is required to update an existing certificate, and ignored while creating a brand new certificate.
- 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
~azure.core.exceptions.HttpResponseError
-
delete(resource_group_name: str, if_match: str, provisioning_service_name: str, certificate_name: str, certificate_name1: Optional[str] = None, certificate_raw_bytes: Optional[bytearray] = 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.
if_match (str) – ETag of the certificate.
provisioning_service_name (str) – The name of the provisioning service.
certificate_name (str) – This is a mandatory field, and is the logical name of the certificate that the provisioning service will access by.
certificate_name1 (str) – This is optional, and it is the Common Name of the certificate.
certificate_raw_bytes (bytearray) – Raw data within the certificate.
certificate_is_verified (bool) – Indicates if certificate has been verified by owner of the private key.
certificate_purpose (str or CertificatePurpose) – A description that mentions the purpose of the certificate.
certificate_created (datetime) – Time the certificate is created.
certificate_last_updated (datetime) – Time the certificate is last updated.
certificate_has_private_key (bool) – Indicates if the certificate contains a private key.
certificate_nonce (str) – Random number generated to indicate Proof of Possession.
- 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
~azure.core.exceptions.HttpResponseError
-
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[bytearray] = 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.
if_match (str) – ETag of the certificate. This is required to update an existing certificate, and ignored while creating a brand new certificate.
resource_group_name (str) – name of resource group.
provisioning_service_name (str) – Name of provisioning service.
certificate_name1 (str) – Common Name for the certificate.
certificate_raw_bytes (bytearray) – Raw data of certificate.
certificate_is_verified (bool) – Indicates if the certificate has been verified by owner of the private key.
certificate_purpose (str or CertificatePurpose) – Description mentioning the purpose of the certificate.
certificate_created (datetime) – Certificate creation time.
certificate_last_updated (datetime) – Certificate last updated time.
certificate_has_private_key (bool) – Indicates if the certificate contains private key.
certificate_nonce (str) – Random number generated to indicate Proof of Possession.
- 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
~azure.core.exceptions.HttpResponseError
-
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
- 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
~azure.core.exceptions.HttpResponseError
-
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
~azure.core.exceptions.HttpResponseError
-
verify_certificate(certificate_name: str, if_match: str, resource_group_name: str, provisioning_service_name: str, request: azure.mgmt.iothubprovisioningservices.models._models_py3.VerificationCodeRequest, certificate_name1: Optional[str] = None, certificate_raw_bytes: Optional[bytearray] = 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.CertificateResponse[source]¶ 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.
if_match (str) – ETag of the certificate.
resource_group_name (str) – Resource group name.
provisioning_service_name (str) – Provisioning service name.
request (VerificationCodeRequest) – The name of the certificate.
certificate_name1 (str) – Common Name for the certificate.
certificate_raw_bytes (bytearray) – Raw data of certificate.
certificate_is_verified (bool) – Indicates if the certificate has been verified by owner of the private key.
certificate_purpose (str or CertificatePurpose) – Describe the purpose of the certificate.
certificate_created (datetime) – Certificate creation time.
certificate_last_updated (datetime) – Certificate last updated time.
certificate_has_private_key (bool) – Indicates if the certificate contains private key.
certificate_nonce (str) – Random number generated to indicate Proof of Possession.
- 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
~azure.core.exceptions.HttpResponseError
-
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(client, config, serializer, deserializer)[source]¶ Bases:
objectIotDpsResourceOperations operations.
You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.
- Variables
models – Alias to model classes used in this operation group.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
-
begin_create_or_update(resource_group_name: str, provisioning_service_name: str, iot_dps_description: azure.mgmt.iothubprovisioningservices.models._models_py3.ProvisioningServiceDescription, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.iothubprovisioningservices.models._models_py3.ProvisioningServiceDescription][source]¶ 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.
provisioning_service_name (str) – Name of provisioning service to create or update.
iot_dps_description (ProvisioningServiceDescription) – Description of the provisioning service to create or update.
- 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 ProvisioningServiceDescription or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
begin_create_or_update_private_endpoint_connection(resource_group_name: str, resource_name: str, private_endpoint_connection_name: str, private_endpoint_connection: azure.mgmt.iothubprovisioningservices.models._models_py3.PrivateEndpointConnection, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.iothubprovisioningservices.models._models_py3.PrivateEndpointConnection][source]¶ 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.
resource_name (str) – The name of the provisioning service.
private_endpoint_connection_name (str) – The name of the private endpoint connection.
private_endpoint_connection (PrivateEndpointConnection) – The private endpoint connection with updated properties.
- 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
~azure.core.exceptions.HttpResponseError
-
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
~azure.core.exceptions.HttpResponseError
-
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
~azure.core.exceptions.HttpResponseError
-
begin_update(resource_group_name: str, provisioning_service_name: str, provisioning_service_tags: azure.mgmt.iothubprovisioningservices.models._models_py3.TagsResource, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.iothubprovisioningservices.models._models_py3.ProvisioningServiceDescription][source]¶ 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.
provisioning_service_name (str) – Name of provisioning service to create or update.
provisioning_service_tags (TagsResource) – Updated tag information to set into the provisioning service instance.
- 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 ProvisioningServiceDescription or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
check_provisioning_service_name_availability(arguments: azure.mgmt.iothubprovisioningservices.models._models_py3.OperationInputs, **kwargs: Any) → azure.mgmt.iothubprovisioningservices.models._models_py3.NameAvailabilityInfo[source]¶ 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) – Set the name parameter in the OperationInputs structure to the name of the provisioning service to check.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
NameAvailabilityInfo, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
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
~azure.core.exceptions.HttpResponseError
-
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.
resource_group_name (str) – Resource group identifier.
provisioning_service_name (str) – Name of provisioning service that the operation is running on.
asyncinfo (str) – Async header used to poll on the status of the operation, obtained while creating the long running operation.
- 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
~azure.core.exceptions.HttpResponseError
-
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
~azure.core.exceptions.HttpResponseError
-
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
~azure.core.exceptions.HttpResponseError
-
list_by_resource_group(resource_group_name: str, **kwargs: Any) → Iterable[azure.mgmt.iothubprovisioningservices.models._models_py3.ProvisioningServiceDescriptionListResult][source]¶ Get a list of all provisioning services in the given resource group.
- Parameters
resource_group_name (str) – Resource group identifier.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either ProvisioningServiceDescriptionListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_subscription(**kwargs: Any) → Iterable[azure.mgmt.iothubprovisioningservices.models._models_py3.ProvisioningServiceDescriptionListResult][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 ProvisioningServiceDescriptionListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_keys(provisioning_service_name: str, resource_group_name: str, **kwargs: Any) → Iterable[azure.mgmt.iothubprovisioningservices.models._models_py3.SharedAccessSignatureAuthorizationRuleListResult][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 SharedAccessSignatureAuthorizationRuleListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
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
~azure.core.exceptions.HttpResponseError
-
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
~azure.core.exceptions.HttpResponseError
-
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
~azure.core.exceptions.HttpResponseError
-
list_valid_skus(provisioning_service_name: str, resource_group_name: str, **kwargs: Any) → Iterable[azure.mgmt.iothubprovisioningservices.models._models_py3.IotDpsSkuDefinitionListResult][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 IotDpsSkuDefinitionListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
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(client, config, serializer, deserializer)[source]¶ Bases:
objectOperations operations.
You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.
- Variables
models – Alias to model classes used in this operation group.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
-
list(**kwargs: Any) → Iterable[azure.mgmt.iothubprovisioningservices.models._models_py3.OperationListResult][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 OperationListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
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'>¶