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.objectIotDpsResourceOperations
Constructor
IotDpsResourceOperations(client, config, serializer, deserializer)Parameters
- client
Client for service requests.
- config
Configuration of service client.
- serializer
An object model serializer.
- deserializer
An object model deserializer.
Variables
- 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: azure.mgmt.iothubprovisioningservices.models._models_py3.ProvisioningServiceDescription, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[azure.mgmt.iothubprovisioningservices.models._models_py3.ProvisioningServiceDescription]Parameters
- iot_dps_description
- ProvisioningServiceDescription
Description of the provisioning service to create or update.
- 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
An instance of AsyncLROPoller that returns either ProvisioningServiceDescription or the result of cls(response)
Return type
Exceptions
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: azure.mgmt.iothubprovisioningservices.models._models_py3.PrivateEndpointConnection, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[azure.mgmt.iothubprovisioningservices.models._models_py3.PrivateEndpointConnection]Parameters
- resource_group_name
- str
The name of the resource group that contains the provisioning service.
- private_endpoint_connection
- PrivateEndpointConnection
The private endpoint connection with updated properties.
- 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
An instance of AsyncLROPoller that returns either PrivateEndpointConnection or the result of cls(response)
Return type
Exceptions
begin_delete
Delete the Provisioning Service.
Deletes the Provisioning Service.
async begin_delete(provisioning_service_name: str, resource_group_name: str, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[None]Parameters
- 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
An instance of AsyncLROPoller that returns either None or the result of cls(response)
Return type
Exceptions
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) -> azure.core.polling._async_poller.AsyncLROPoller[azure.mgmt.iothubprovisioningservices.models._models_py3.PrivateEndpointConnection]Parameters
- resource_group_name
- str
The name of the resource group that contains the provisioning service.
- 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
An instance of AsyncLROPoller that returns either PrivateEndpointConnection or the result of cls(response)
Return type
Exceptions
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: azure.mgmt.iothubprovisioningservices.models._models_py3.TagsResource, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[azure.mgmt.iothubprovisioningservices.models._models_py3.ProvisioningServiceDescription]Parameters
- provisioning_service_tags
- TagsResource
Updated tag information to set into the provisioning service instance.
- 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
An instance of AsyncLROPoller that returns either ProvisioningServiceDescription or the result of cls(response)
Return type
Exceptions
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: azure.mgmt.iothubprovisioningservices.models._models_py3.OperationInputs, **kwargs: Any) -> azure.mgmt.iothubprovisioningservices.models._models_py3.NameAvailabilityInfoParameters
- arguments
- OperationInputs
Set the name parameter in the OperationInputs structure to the name of the provisioning service to check.
- cls
- callable
A custom type or function that will be passed the direct response
Returns
NameAvailabilityInfo, or the result of cls(response)
Return type
Exceptions
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) -> azure.mgmt.iothubprovisioningservices.models._models_py3.ProvisioningServiceDescriptionParameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
ProvisioningServiceDescription, or the result of cls(response)
Return type
Exceptions
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) -> azure.mgmt.iothubprovisioningservices.models._models_py3.AsyncOperationResultParameters
- operation_id
- str
Operation id corresponding to long running operation. Use this to poll for the status.
- 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.
- cls
- callable
A custom type or function that will be passed the direct response
Returns
AsyncOperationResult, or the result of cls(response)
Return type
Exceptions
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) -> azure.mgmt.iothubprovisioningservices.models._models_py3.PrivateEndpointConnectionParameters
- resource_group_name
- str
The name of the resource group that contains the provisioning service.
- cls
- callable
A custom type or function that will be passed the direct response
Returns
PrivateEndpointConnection, or the result of cls(response)
Return type
Exceptions
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) -> azure.mgmt.iothubprovisioningservices.models._models_py3.GroupIdInformationParameters
- resource_group_name
- str
The name of the resource group that contains the provisioning service.
- cls
- callable
A custom type or function that will be passed the direct response
Returns
GroupIdInformation, or the result of cls(response)
Return type
Exceptions
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[azure.mgmt.iothubprovisioningservices.models._models_py3.ProvisioningServiceDescriptionListResult]Parameters
- 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
Exceptions
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[azure.mgmt.iothubprovisioningservices.models._models_py3.ProvisioningServiceDescriptionListResult]Parameters
- 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
Exceptions
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[azure.mgmt.iothubprovisioningservices.models._models_py3.SharedAccessSignatureAuthorizationRuleListResult]Parameters
- provisioning_service_name
- str
The provisioning service name to get the shared access keys for.
- 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
Exceptions
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) -> azure.mgmt.iothubprovisioningservices.models._models_py3.SharedAccessSignatureAuthorizationRuleAccessRightsDescriptionParameters
- resource_group_name
- str
The name of the resource group that contains the provisioning service.
- cls
- callable
A custom type or function that will be passed the direct response
Returns
SharedAccessSignatureAuthorizationRuleAccessRightsDescription, or the result of cls(response)
Return type
Exceptions
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[azure.mgmt.iothubprovisioningservices.models._models_py3.PrivateEndpointConnection]Parameters
- resource_group_name
- str
The name of the resource group that contains the provisioning service.
- 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
Exceptions
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) -> azure.mgmt.iothubprovisioningservices.models._models_py3.PrivateLinkResourcesParameters
- resource_group_name
- str
The name of the resource group that contains the provisioning service.
- cls
- callable
A custom type or function that will be passed the direct response
Returns
PrivateLinkResources, or the result of cls(response)
Return type
Exceptions
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[azure.mgmt.iothubprovisioningservices.models._models_py3.IotDpsSkuDefinitionListResult]Parameters
- 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
Exceptions
Attributes
models
models = <module 'azure.mgmt.iothubprovisioningservices.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.9.13\\x64\\lib\\site-packages\\azure\\mgmt\\iothubprovisioningservices\\models\\__init__.py'>Feedback
Submit and view feedback for