IotDpsResourceOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

<xref:iot_dps_resource> attribute.

Constructor

IotDpsResourceOperations(*args, **kwargs)

Methods

begin_create_or_update	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 the status of a private endpoint connection with the specified name.
begin_delete	Deletes the Provisioning Service.
begin_delete_private_endpoint_connection	Delete private endpoint connection with the specified name.
begin_update	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 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 properties.
get_private_link_resources	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	List all the provisioning services for a given subscription id.
list_keys	List the primary and secondary keys for a provisioning service.
list_keys_for_key_name	List primary and secondary keys for a specific key name.
list_private_endpoint_connections	List private endpoint connection properties.
list_private_link_resources	List private link resources for the given provisioning service.
list_valid_skus	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. 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(resource_group_name: str, provisioning_service_name: str, iot_dps_description: _models.ProvisioningServiceDescription, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.ProvisioningServiceDescription]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
provisioning_service_name Required	str Name of the provisioning service to retrieve. Required.
iot_dps_description Required	ProvisioningServiceDescription or ProvisioningServiceDescription or IO[bytes] Description of the provisioning service to create or update. Is either a ProvisioningServiceDescription type or a IO[bytes] type. Required.

Returns

Type	Description
LROPoller[ProvisioningServiceDescription]	An instance of LROPoller that returns ProvisioningServiceDescription. The ProvisioningServiceDescription is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

begin_create_or_update_private_endpoint_connection

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

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]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
resource_name Required	str Name of the provisioning service to retrieve. Required.
private_endpoint_connection_name Required	str The name of the private endpoint connection. Required.
private_endpoint_connection Required	PrivateEndpointConnection or PrivateEndpointConnection or IO[bytes] The private endpoint connection with updated properties. Is either a PrivateEndpointConnection type or a IO[bytes] type. Required.

Returns

Type	Description
LROPoller[PrivateEndpointConnection]	An instance of LROPoller that returns PrivateEndpointConnection. The PrivateEndpointConnection is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

begin_delete

Deletes the Provisioning Service.

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

Parameters

Name	Description
provisioning_service_name Required	str Name of the provisioning service to retrieve. Required.
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.

Returns

Type	Description
LROPoller[None]	An instance of LROPoller that returns None

Exceptions

Type	Description
HttpResponseError

begin_delete_private_endpoint_connection

Delete private endpoint connection with the specified name.

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

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
resource_name Required	str Name of the provisioning service to retrieve. Required.
private_endpoint_connection_name Required	str The name of the private endpoint connection. Required.

Returns

Type	Description
LROPoller[PrivateEndpointConnection]	An instance of LROPoller that returns PrivateEndpointConnection. The PrivateEndpointConnection is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

begin_update

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

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]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
provisioning_service_name Required	str Name of the provisioning service to retrieve. Required.
provisioning_service_tags Required	TagsResource or TagsResource or IO[bytes] Updated tag information to set into the provisioning service instance. Is either a TagsResource type or a IO[bytes] type. Required.

Returns

Type	Description
LROPoller[ProvisioningServiceDescription]	An instance of LROPoller that returns ProvisioningServiceDescription. The ProvisioningServiceDescription is compatible with MutableMapping

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.

check_provisioning_service_name_availability(arguments: _models.OperationInputs, *, content_type: str = 'application/json', **kwargs: Any) -> _models.NameAvailabilityInfo

Parameters

Name	Description
arguments Required	OperationInputs or OperationInputs or IO[bytes] The request body. Is either a OperationInputs type or a IO[bytes] type. Required.

Returns

Type	Description
NameAvailabilityInfo	NameAvailabilityInfo. The NameAvailabilityInfo is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

get

Get the metadata of the provisioning service without SAS keys.

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. Required.
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.

Returns

Type	Description
ProvisioningServiceDescription	ProvisioningServiceDescription. The ProvisioningServiceDescription is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

get_operation_result

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

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

Parameters

Name	Description
operation_id Required	str Operation id corresponding to long running operation. Use this to poll for the status. Required.
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
provisioning_service_name Required	str Name of the provisioning service to retrieve. Required.

Keyword-Only Parameters

Name	Description
asyncinfo	str Async header used to poll on the status of the operation, obtained while creating the long running operation. Required.

Returns

Type	Description
AsyncOperationResult	AsyncOperationResult. The AsyncOperationResult is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

get_private_endpoint_connection

Get private endpoint connection properties.

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. The name is case insensitive. Required.
resource_name Required	str Name of the provisioning service to retrieve. Required.
private_endpoint_connection_name Required	str The name of the private endpoint connection. Required.

Returns

Type	Description
PrivateEndpointConnection	PrivateEndpointConnection. The PrivateEndpointConnection is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

get_private_link_resources

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

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. The name is case insensitive. Required.
resource_name Required	str Name of the provisioning service to retrieve. Required.
group_id Required	str The name of the private link resource. Required.

Returns

Type	Description
GroupIdInformation	GroupIdInformation. The GroupIdInformation is compatible with MutableMapping

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) -> ItemPaged[ProvisioningServiceDescription]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.

Returns

Type	Description
ItemPaged[ProvisioningServiceDescription]	An iterator like instance of ProvisioningServiceDescription

Exceptions

Type	Description
HttpResponseError

list_by_subscription

List all the provisioning services for a given subscription id.

list_by_subscription(**kwargs: Any) -> ItemPaged[ProvisioningServiceDescription]

Returns

Type	Description
ItemPaged[ProvisioningServiceDescription]	An iterator like instance of ProvisioningServiceDescription

Exceptions

Type	Description
HttpResponseError

list_keys

List the primary and secondary keys for a provisioning service.

list_keys(provisioning_service_name: str, resource_group_name: str, **kwargs: Any) -> ItemPaged[SharedAccessSignatureAuthorizationRuleAccessRightsDescription]

Parameters

Name	Description
provisioning_service_name Required	str Name of the provisioning service to retrieve. Required.
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.

Returns

Type	Description
ItemPaged[SharedAccessSignatureAuthorizationRuleAccessRightsDescription]	An iterator like instance of SharedAccessSignatureAuthorizationRuleAccessRightsDescription

Exceptions

Type	Description
HttpResponseError

list_keys_for_key_name

List primary and secondary keys for a specific key name.

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 to retrieve. Required.
key_name Required	str Logical key name to get key-values for. Required.
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.

Returns

Type	Description
SharedAccessSignatureAuthorizationRuleAccessRightsDescription	SharedAccessSignatureAuthorizationRuleAccessRightsDescription. The SharedAccessSignatureAuthorizationRuleAccessRightsDescription is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

list_private_endpoint_connections

List private endpoint connection properties.

list_private_endpoint_connections(resource_group_name: str, resource_name: str, **kwargs: Any) -> list[azure.mgmt.iothubprovisioningservices.models._models.PrivateEndpointConnection]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
resource_name Required	str Name of the provisioning service to retrieve. Required.

Returns

Type	Description
list[PrivateEndpointConnection]	list of PrivateEndpointConnection

Exceptions

Type	Description
HttpResponseError

list_private_link_resources

List private link resources for the given provisioning service.

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. The name is case insensitive. Required.
resource_name Required	str Name of the provisioning service to retrieve. Required.

Returns

Type	Description
PrivateLinkResources	PrivateLinkResources. The PrivateLinkResources is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

list_valid_skus

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) -> ItemPaged[IotDpsSkuDefinition]

Parameters

Name	Description
provisioning_service_name Required	str Name of the provisioning service to retrieve. Required.
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.

Returns

Type	Description
ItemPaged[IotDpsSkuDefinition]	An iterator like instance of IotDpsSkuDefinition

Exceptions

Type	Description
HttpResponseError

Feedback

Was this page helpful?