azure.mgmt.iotcentral.operations module

class azure.mgmt.iotcentral.operations.AppsOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through IotCentralClient’s apps attribute.

begin_create_or_update(resource_group_name: str, resource_name: str, app: _models.App, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.App][source]
begin_create_or_update(resource_group_name: str, resource_name: str, app: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.App]

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

  • resource_group_name (str) – The name of the resource group that contains the IoT Central application. Required.

  • resource_name (str) – The ARM resource name of the IoT Central application. Required.

  • app (App or IO) – The IoT Central application metadata and security metadata. Is either a model type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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

LROPoller[App]

Raises

HttpResponseError –

begin_delete(resource_group_name: str, resource_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]

Delete an IoT Central application.

Parameters

  • resource_group_name (str) – The name of the resource group that contains the IoT Central application. Required.

  • resource_name (str) – The ARM resource name of the IoT Central application. Required.

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

LROPoller[None]

Raises

HttpResponseError –

begin_update(resource_group_name: str, resource_name: str, app_patch: _models.AppPatch, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.App][source]
begin_update(resource_group_name: str, resource_name: str, app_patch: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.App]

Update the metadata of an IoT Central application.

Parameters

  • resource_group_name (str) – The name of the resource group that contains the IoT Central application. Required.

  • resource_name (str) – The ARM resource name of the IoT Central application. Required.

  • app_patch (AppPatch or IO) – The IoT Central application metadata and security metadata. Is either a model type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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

LROPoller[App]

Raises

HttpResponseError –

check_name_availability(operation_inputs: _models.OperationInputs, *, content_type: str = "'application/json'", **kwargs: Any) → _models.AppAvailabilityInfo[source]
check_name_availability(operation_inputs: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.AppAvailabilityInfo

Check if an IoT Central application name is available.

Parameters

operation_inputs (OperationInputs or IO) – Set the name parameter in the OperationInputs structure to the name of the IoT Central application to check. Is either a model type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • cls (callable) – A custom type or function that will be passed the direct response

Returns

AppAvailabilityInfo or the result of cls(response)

Return type

AppAvailabilityInfo

Raises

HttpResponseError –

check_subdomain_availability(operation_inputs: _models.OperationInputs, *, content_type: str = "'application/json'", **kwargs: Any) → _models.AppAvailabilityInfo[source]
check_subdomain_availability(operation_inputs: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.AppAvailabilityInfo

Check if an IoT Central application subdomain is available.

Parameters

operation_inputs (OperationInputs or IO) – Set the name parameter in the OperationInputs structure to the subdomain of the IoT Central application to check. Is either a model type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • cls (callable) – A custom type or function that will be passed the direct response

Returns

AppAvailabilityInfo or the result of cls(response)

Return type

AppAvailabilityInfo

Raises

HttpResponseError –

get(resource_group_name: str, resource_name: str, **kwargs: Any) → azure.mgmt.iotcentral.models._models_py3.App[source]

Get the metadata of an IoT Central application.

Parameters

  • resource_group_name (str) – The name of the resource group that contains the IoT Central application. Required.

  • resource_name (str) – The ARM resource name of the IoT Central application. Required.

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

App

Raises

HttpResponseError –

list_by_resource_group(resource_group_name: str, **kwargs: Any) → Iterable[azure.mgmt.iotcentral.models._models_py3.App][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. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either App or the result of cls(response)

Return type

ItemPaged[App]

Raises

HttpResponseError –

list_by_subscription(**kwargs: Any) → Iterable[azure.mgmt.iotcentral.models._models_py3.App][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 App or the result of cls(response)

Return type

ItemPaged[App]

Raises

HttpResponseError –

list_templates(**kwargs: Any) → Iterable[azure.mgmt.iotcentral.models._models_py3.AppTemplate][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 AppTemplate or the result of cls(response)

Return type

ItemPaged[AppTemplate]

Raises

HttpResponseError –

models = <module 'azure.mgmt.iotcentral.models' from '/mnt/vss/_work/1/s/sdk/iothub/azure-mgmt-iotcentral/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/iotcentral/models/__init__.py'>
class azure.mgmt.iotcentral.operations.Operations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through IotCentralClient’s operations attribute.

list(**kwargs: Any) → Iterable[azure.mgmt.iotcentral.models._models_py3.Operation][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 Operation or the result of cls(response)

Return type

ItemPaged[Operation]

Raises

HttpResponseError –

models = <module 'azure.mgmt.iotcentral.models' from '/mnt/vss/_work/1/s/sdk/iothub/azure-mgmt-iotcentral/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/iotcentral/models/__init__.py'>