IotDpsResourceOperations Class

IotDpsResourceOperations async 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.

Inheritance

builtins.object

IotDpsResourceOperations

Constructor

IotDpsResourceOperations(client, config, serializer, deserializer)

Parameters

Name	Description
client Required	Client for service requests.
config Required	Configuration of service client.
serializer Required	An object model serializer.
deserializer Required	An object model deserializer.

Variables

Name	Description
models	Alias to model classes used in this operation group.

Methods

begin_create_or_update	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.
begin_create_or_update_private_endpoint_connection	Create or update private endpoint connection. Create or update the status of a private endpoint connection with the specified name.
begin_delete	Delete the Provisioning Service. Deletes the Provisioning Service.
begin_delete_private_endpoint_connection	Delete private endpoint connection. Delete private endpoint connection with the specified name.
begin_update	Update an existing provisioning service's tags. Update an existing provisioning service's tags. to update other fields use the CreateOrUpdate method.
check_provisioning_service_name_availability	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.
get	Get the non-security related metadata of the provisioning service. Get the metadata of the provisioning service without SAS keys.
get_operation_result	Gets the status of a long running operation, such as create, update or delete a provisioning service.
get_private_endpoint_connection	Get private endpoint connection. Get private endpoint connection properties.
get_private_link_resources	Get the specified private link resource. Get the specified private link resource for the given provisioning service.
list_by_resource_group	Get a list of all provisioning services in the given resource group.
list_by_subscription	Get all the provisioning services in a subscription. List all the provisioning services for a given subscription id.
list_keys	Get the security metadata for a provisioning service. List the primary and secondary keys for a provisioning service.
list_keys_for_key_name	Get a shared access policy by name from a provisioning service. List primary and secondary keys for a specific key name.
list_private_endpoint_connections	List private endpoint connections. List private endpoint connection properties.
list_private_link_resources	List private link resources. List private link resources for the given provisioning service.
list_valid_skus	Get the list of valid SKUs for a provisioning service. Gets the list of valid SKUs and tiers for a provisioning service.

begin_create_or_update

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.

async begin_create_or_update(resource_group_name: str, provisioning_service_name: str, iot_dps_description: ProvisioningServiceDescription, **kwargs: Any) -> AsyncLROPoller[ProvisioningServiceDescription]

Parameters

Name	Description
resource_group_name Required	str Resource group identifier.
provisioning_service_name Required	str Name of provisioning service to create or update.
iot_dps_description Required	ProvisioningServiceDescription Description of the provisioning service to create or update.

Keyword-Only Parameters

Name	Description
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 AsyncPollingMethod By default, your polling method will be AsyncARMPolling. 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

Type	Description
AsyncLROPoller[ProvisioningServiceDescription]	An instance of AsyncLROPoller that returns either ProvisioningServiceDescription or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_create_or_update_private_endpoint_connection

Create or update private endpoint connection.

Create or update the status of a private endpoint connection with the specified name.

async begin_create_or_update_private_endpoint_connection(resource_group_name: str, resource_name: str, private_endpoint_connection_name: str, private_endpoint_connection: PrivateEndpointConnection, **kwargs: Any) -> AsyncLROPoller[PrivateEndpointConnection]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group that contains the provisioning service.
resource_name Required	str The name of the provisioning service.
private_endpoint_connection_name Required	str The name of the private endpoint connection.
private_endpoint_connection Required	PrivateEndpointConnection The private endpoint connection with updated properties.

Keyword-Only Parameters

Name	Description
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 AsyncPollingMethod By default, your polling method will be AsyncARMPolling. 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

Type	Description
AsyncLROPoller[PrivateEndpointConnection]	An instance of AsyncLROPoller that returns either PrivateEndpointConnection or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_delete

Delete the Provisioning Service.

Deletes the Provisioning Service.

async begin_delete(provisioning_service_name: str, resource_group_name: str, **kwargs: Any) -> AsyncLROPoller[None]

Parameters

Name	Description
provisioning_service_name Required	str Name of provisioning service to delete.
resource_group_name Required	str Resource group identifier.

Keyword-Only Parameters

Name	Description
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 AsyncPollingMethod By default, your polling method will be AsyncARMPolling. 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

Type	Description
AsyncLROPoller[None]	An instance of AsyncLROPoller that returns either None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_delete_private_endpoint_connection

Delete private endpoint connection.

Delete private endpoint connection with the specified name.

async begin_delete_private_endpoint_connection(resource_group_name: str, resource_name: str, private_endpoint_connection_name: str, **kwargs: Any) -> AsyncLROPoller[PrivateEndpointConnection]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group that contains the provisioning service.
resource_name Required	str The name of the provisioning service.
private_endpoint_connection_name Required	str The name of the private endpoint connection.

Keyword-Only Parameters

Name	Description
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 AsyncPollingMethod By default, your polling method will be AsyncARMPolling. 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

Type	Description
AsyncLROPoller[PrivateEndpointConnection]	An instance of AsyncLROPoller that returns either PrivateEndpointConnection or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_update

Update an existing provisioning service's tags.

Update an existing provisioning service's tags. to update other fields use the CreateOrUpdate method.

async begin_update(resource_group_name: str, provisioning_service_name: str, provisioning_service_tags: TagsResource, **kwargs: Any) -> AsyncLROPoller[ProvisioningServiceDescription]

Parameters

Name	Description
resource_group_name Required	str Resource group identifier.
provisioning_service_name Required	str Name of provisioning service to create or update.
provisioning_service_tags Required	TagsResource Updated tag information to set into the provisioning service instance.

Keyword-Only Parameters

Name	Description
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 AsyncPollingMethod By default, your polling method will be AsyncARMPolling. 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

Type	Description
AsyncLROPoller[ProvisioningServiceDescription]	An instance of AsyncLROPoller that returns either ProvisioningServiceDescription or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

check_provisioning_service_name_availability

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.

async check_provisioning_service_name_availability(arguments: OperationInputs, **kwargs: Any) -> NameAvailabilityInfo

Parameters

Name	Description
arguments Required	OperationInputs Set the name parameter in the OperationInputs structure to the name of the provisioning service to check.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
NameAvailabilityInfo	NameAvailabilityInfo, or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get

Get the non-security related metadata of the provisioning service.

Get the metadata of the provisioning service without SAS keys.

async get(provisioning_service_name: str, resource_group_name: str, **kwargs: Any) -> ProvisioningServiceDescription

Parameters

Name	Description
provisioning_service_name Required	str Name of the provisioning service to retrieve.
resource_group_name Required	str Resource group name.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
ProvisioningServiceDescription	ProvisioningServiceDescription, or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get_operation_result

Gets the status of a long running operation, such as create, update or delete a provisioning service.

async get_operation_result(operation_id: str, resource_group_name: str, provisioning_service_name: str, asyncinfo: str = 'true', **kwargs: Any) -> AsyncOperationResult

Parameters

Name	Description
operation_id Required	str Operation id corresponding to long running operation. Use this to poll for the status.
resource_group_name Required	str Resource group identifier.
provisioning_service_name Required	str Name of provisioning service that the operation is running on.
asyncinfo Required	str Async header used to poll on the status of the operation, obtained while creating the long running operation.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
AsyncOperationResult	AsyncOperationResult, or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get_private_endpoint_connection

Get private endpoint connection.

Get private endpoint connection properties.

async get_private_endpoint_connection(resource_group_name: str, resource_name: str, private_endpoint_connection_name: str, **kwargs: Any) -> PrivateEndpointConnection

Parameters

Name	Description
resource_group_name Required	str The name of the resource group that contains the provisioning service.
resource_name Required	str The name of the provisioning service.
private_endpoint_connection_name Required	str The name of the private endpoint connection.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
PrivateEndpointConnection	PrivateEndpointConnection, or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get_private_link_resources

Get the specified private link resource.

Get the specified private link resource for the given provisioning service.

async get_private_link_resources(resource_group_name: str, resource_name: str, group_id: str, **kwargs: Any) -> GroupIdInformation

Parameters

Name	Description
resource_group_name Required	str The name of the resource group that contains the provisioning service.
resource_name Required	str The name of the provisioning service.
group_id Required	str The name of the private link resource.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
GroupIdInformation	GroupIdInformation, or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_by_resource_group

Get a list of all provisioning services in the given resource group.

list_by_resource_group(resource_group_name: str, **kwargs: Any) -> AsyncIterable[ProvisioningServiceDescriptionListResult]

Parameters

Name	Description
resource_group_name Required	str Resource group identifier.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
AsyncItemPaged[ProvisioningServiceDescriptionListResult]	An iterator like instance of either ProvisioningServiceDescriptionListResult or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_by_subscription

Get all the provisioning services in a subscription.

List all the provisioning services for a given subscription id.

list_by_subscription(**kwargs: Any) -> AsyncIterable[ProvisioningServiceDescriptionListResult]

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
AsyncItemPaged[ProvisioningServiceDescriptionListResult]	An iterator like instance of either ProvisioningServiceDescriptionListResult or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_keys

Get the security metadata for a provisioning service.

List the primary and secondary keys for a provisioning service.

list_keys(provisioning_service_name: str, resource_group_name: str, **kwargs: Any) -> AsyncIterable[SharedAccessSignatureAuthorizationRuleListResult]

Parameters

Name	Description
provisioning_service_name Required	str The provisioning service name to get the shared access keys for.
resource_group_name Required	str resource group name.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
AsyncItemPaged[SharedAccessSignatureAuthorizationRuleListResult]	An iterator like instance of either SharedAccessSignatureAuthorizationRuleListResult or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_keys_for_key_name

Get a shared access policy by name from a provisioning service.

List primary and secondary keys for a specific key name.

async list_keys_for_key_name(provisioning_service_name: str, key_name: str, resource_group_name: str, **kwargs: Any) -> SharedAccessSignatureAuthorizationRuleAccessRightsDescription

Parameters

Name	Description
provisioning_service_name Required	str Name of the provisioning service.
key_name Required	str Logical key name to get key-values for.
resource_group_name Required	str The name of the resource group that contains the provisioning service.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
SharedAccessSignatureAuthorizationRuleAccessRightsDescription	SharedAccessSignatureAuthorizationRuleAccessRightsDescription, or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_private_endpoint_connections

List private endpoint connections.

List private endpoint connection properties.

async list_private_endpoint_connections(resource_group_name: str, resource_name: str, **kwargs: Any) -> List[PrivateEndpointConnection]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group that contains the provisioning service.
resource_name Required	str The name of the provisioning service.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
list[PrivateEndpointConnection]	list of PrivateEndpointConnection, or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_private_link_resources

List private link resources.

List private link resources for the given provisioning service.

async list_private_link_resources(resource_group_name: str, resource_name: str, **kwargs: Any) -> PrivateLinkResources

Parameters

Name	Description
resource_group_name Required	str The name of the resource group that contains the provisioning service.
resource_name Required	str The name of the provisioning service.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
PrivateLinkResources	PrivateLinkResources, or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_valid_skus

Get the list of valid SKUs for a provisioning service.

Gets the list of valid SKUs and tiers for a provisioning service.

list_valid_skus(provisioning_service_name: str, resource_group_name: str, **kwargs: Any) -> AsyncIterable[IotDpsSkuDefinitionListResult]

Parameters

Name	Description
provisioning_service_name Required	str Name of provisioning service.
resource_group_name Required	str Name of resource group.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
AsyncItemPaged[IotDpsSkuDefinitionListResult]	An iterator like instance of either IotDpsSkuDefinitionListResult or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

Attributes

models

models = <module 'azure.mgmt.iothubprovisioningservices.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\iothubprovisioningservices\\models\\__init__.py'>