azure.mgmt.iotcentral.operations module¶
-
class
azure.mgmt.iotcentral.operations.AppsOperations(client, config, serializer, deserializer)[source]¶ Bases:
objectAppsOperations 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, resource_name: str, app: ‘_models.App’, **kwargs: Any) → LROPoller[‘_models.App’][source]¶ Create or update the metadata of an IoT Central application. The usual pattern to modify a property is to retrieve the IoT Central application metadata and security metadata, and then combine them with the modified values in a new body to update the IoT Central application.
- 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 App or the result of cls(response)
- Return type
- Raises
-
begin_delete(resource_group_name: str, resource_name: str, **kwargs: Any) → LROPoller[None][source]¶ Delete an IoT Central application.
- 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_update(resource_group_name: str, resource_name: str, app_patch: ‘_models.AppPatch’, **kwargs: Any) → LROPoller[‘_models.App’][source]¶ Update the metadata of an IoT Central application.
- 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 App or the result of cls(response)
- Return type
- Raises
-
check_name_availability(operation_inputs: ‘_models.OperationInputs’, **kwargs: Any) → _models.AppAvailabilityInfo[source]¶ Check if an IoT Central application name is available.
- Parameters
operation_inputs (OperationInputs) – Set the name parameter in the OperationInputs structure to the name of the IoT Central application to check.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
AppAvailabilityInfo, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
check_subdomain_availability(operation_inputs: ‘_models.OperationInputs’, **kwargs: Any) → _models.AppAvailabilityInfo[source]¶ Check if an IoT Central application subdomain is available.
- Parameters
operation_inputs (OperationInputs) – Set the name parameter in the OperationInputs structure to the subdomain of the IoT Central application to check.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
AppAvailabilityInfo, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
get(resource_group_name: str, resource_name: str, **kwargs: Any) → _models.App[source]¶ Get the metadata of an IoT Central application.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
App, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_resource_group(resource_group_name: str, **kwargs: Any) → Iterable[‘_models.AppListResult’][source]¶ Get all the IoT Central Applications in a resource group.
- Parameters
resource_group_name (str) – The name of the resource group that contains the IoT Central application.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either AppListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_subscription(**kwargs: Any) → Iterable[‘_models.AppListResult’][source]¶ Get all IoT Central Applications in a subscription.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either AppListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_templates(**kwargs: Any) → Iterable[‘_models.AppTemplatesResult’][source]¶ Get all available application templates.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either AppTemplatesResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models= <module 'azure.mgmt.iotcentral.models' from '/mnt/vss/_work/1/s/sdk/iothub/azure-mgmt-iotcentral/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/iotcentral/models/__init__.py'>¶
-
class
azure.mgmt.iotcentral.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[‘_models.OperationListResult’][source]¶ Lists all of the available IoT Central Resource Provider 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.iotcentral.models' from '/mnt/vss/_work/1/s/sdk/iothub/azure-mgmt-iotcentral/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/iotcentral/models/__init__.py'>¶