EnvironmentsOperations Class

EnvironmentsOperations 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
EnvironmentsOperations

Constructor

EnvironmentsOperations(client, config, serializer, deserializer)

Parameters

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

models

Alias to model classes used in this operation group.

Methods

begin_create_or_update

Create or update an environment in the specified subscription and resource group.

begin_update

Updates the environment with the specified name in the specified subscription and resource group.

delete

Deletes the environment with the specified name in the specified subscription and resource group.

get

Gets the environment with the specified name in the specified subscription and resource group.

list_by_resource_group

Lists all the available environments associated with the subscription and within the specified resource group.

list_by_subscription

Lists all the available environments within a subscription, irrespective of the resource groups.

begin_create_or_update

Create or update an environment in the specified subscription and resource group.

async begin_create_or_update(resource_group_name: str, environment_name: str, parameters: azure.mgmt.timeseriesinsights.models._models_py3.EnvironmentCreateOrUpdateParameters, **kwargs) -> azure.core.polling._async_poller.AsyncLROPoller[azure.mgmt.timeseriesinsights.models._models_py3.EnvironmentResource]

Parameters

resource_group_name
str
Required

Name of an Azure Resource group.

environment_name
str
Required

Name of the environment.

parameters
EnvironmentCreateOrUpdateParameters
Required

Parameters for creating an environment resource.

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

True for ARMPolling, False for no polling, or a polling object for 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 EnvironmentResource or the result of cls(response)

Return type

Exceptions

begin_update

Updates the environment with the specified name in the specified subscription and resource group.

async begin_update(resource_group_name: str, environment_name: str, environment_update_parameters: azure.mgmt.timeseriesinsights.models._models_py3.EnvironmentUpdateParameters, **kwargs) -> azure.core.polling._async_poller.AsyncLROPoller[azure.mgmt.timeseriesinsights.models._models_py3.EnvironmentResource]

Parameters

resource_group_name
str
Required

Name of an Azure Resource group.

environment_name
str
Required

The name of the Time Series Insights environment associated with the specified resource group.

environment_update_parameters
EnvironmentUpdateParameters
Required

Request object that contains the updated information for the environment.

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

True for ARMPolling, False for no polling, or a polling object for 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 EnvironmentResource or the result of cls(response)

Return type

Exceptions

delete

Deletes the environment with the specified name in the specified subscription and resource group.

async delete(resource_group_name: str, environment_name: str, **kwargs) -> None

Parameters

resource_group_name
str
Required

Name of an Azure Resource group.

environment_name
str
Required

The name of the Time Series Insights environment associated with the specified resource group.

cls
callable

A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

Exceptions

get

Gets the environment with the specified name in the specified subscription and resource group.

async get(resource_group_name: str, environment_name: str, expand: Optional[str] = None, **kwargs) -> azure.mgmt.timeseriesinsights.models._models_py3.EnvironmentResource

Parameters

resource_group_name
str
Required

Name of an Azure Resource group.

environment_name
str
Required

The name of the Time Series Insights environment associated with the specified resource group.

expand
str
default value: None

Setting $expand=status will include the status of the internal services of the environment in the Time Series Insights service.

cls
callable

A custom type or function that will be passed the direct response

Returns

EnvironmentResource, or the result of cls(response)

Return type

Exceptions

list_by_resource_group

Lists all the available environments associated with the subscription and within the specified resource group.

async list_by_resource_group(resource_group_name: str, **kwargs) -> azure.mgmt.timeseriesinsights.models._models_py3.EnvironmentListResponse

Parameters

resource_group_name
str
Required

Name of an Azure Resource group.

cls
callable

A custom type or function that will be passed the direct response

Returns

EnvironmentListResponse, or the result of cls(response)

Return type

Exceptions

list_by_subscription

Lists all the available environments within a subscription, irrespective of the resource groups.

async list_by_subscription(**kwargs) -> azure.mgmt.timeseriesinsights.models._models_py3.EnvironmentListResponse

Parameters

cls
callable

A custom type or function that will be passed the direct response

Returns

EnvironmentListResponse, or the result of cls(response)

Return type

Exceptions

Attributes

models

models = <module 'azure.mgmt.timeseriesinsights.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.9.13\\x64\\lib\\site-packages\\azure\\mgmt\\timeseriesinsights\\models\\__init__.py'>