ManagedEnvironmentsOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

ContainerAppsAPIClient's

<xref:managed_environments> attribute.

Constructor

ManagedEnvironmentsOperations(*args, **kwargs)

Methods

begin_create_or_update

Creates or updates a Managed Environment.

Creates or updates a Managed Environment used to host container apps.

begin_delete

Delete a Managed Environment.

Delete a Managed Environment if it does not have any container apps.

begin_update

Update Managed Environment's properties.

Patches a Managed Environment using JSON Merge Patch.

get

Get the properties of a Managed Environment.

Get the properties of a Managed Environment used to host container apps.

get_auth_token

Get auth token for a managed environment.

Checks if resource name is available.

list_by_resource_group

Get all the Environments in a resource group.

Get all the Managed Environments in a resource group.

list_by_subscription

Get all Environments for a subscription.

Get all Managed Environments for a subscription.

list_workload_profile_states

Get all workload Profile States for a Managed Environment..

Get all workload Profile States for a Managed Environment.

begin_create_or_update

Creates or updates a Managed Environment.

Creates or updates a Managed Environment used to host container apps.

begin_create_or_update(resource_group_name: str, environment_name: str, environment_envelope: _models.ManagedEnvironment, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.ManagedEnvironment]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. The name is case insensitive. Required.

environment_name
Required
str

Name of the Environment. Required.

environment_envelope
Required

Configuration details of the Environment. Is either a ManagedEnvironment type or a IO[bytes] type. Required.

Returns

Type Description

An instance of LROPoller that returns ManagedEnvironment. The ManagedEnvironment is compatible with MutableMapping

Exceptions

Type Description

begin_delete

Delete a Managed Environment.

Delete a Managed Environment if it does not have any container apps.

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

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. The name is case insensitive. Required.

environment_name
Required
str

Name of the Environment. Required.

Returns

Type Description

An instance of LROPoller that returns None

Exceptions

Type Description

begin_update

Update Managed Environment's properties.

Patches a Managed Environment using JSON Merge Patch.

begin_update(resource_group_name: str, environment_name: str, environment_envelope: _models.ManagedEnvironment, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.ManagedEnvironment]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. The name is case insensitive. Required.

environment_name
Required
str

Name of the Environment. Required.

environment_envelope
Required

Configuration details of the Environment. Is either a ManagedEnvironment type or a IO[bytes] type. Required.

Returns

Type Description

An instance of LROPoller that returns ManagedEnvironment. The ManagedEnvironment is compatible with MutableMapping

Exceptions

Type Description

get

Get the properties of a Managed Environment.

Get the properties of a Managed Environment used to host container apps.

get(resource_group_name: str, environment_name: str, **kwargs: Any) -> ManagedEnvironment

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. The name is case insensitive. Required.

environment_name
Required
str

Name of the Environment. Required.

Returns

Type Description

ManagedEnvironment. The ManagedEnvironment is compatible with MutableMapping

Exceptions

Type Description

get_auth_token

Get auth token for a managed environment.

Checks if resource name is available.

get_auth_token(resource_group_name: str, environment_name: str, **kwargs: Any) -> EnvironmentAuthToken

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. The name is case insensitive. Required.

environment_name
Required
str

Name of the Environment. Required.

Returns

Type Description

EnvironmentAuthToken. The EnvironmentAuthToken is compatible with MutableMapping

Exceptions

Type Description

list_by_resource_group

Get all the Environments in a resource group.

Get all the Managed Environments in a resource group.

list_by_resource_group(resource_group_name: str, **kwargs: Any) -> ItemPaged[ManagedEnvironment]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. The name is case insensitive. Required.

Returns

Type Description

An iterator like instance of ManagedEnvironment

Exceptions

Type Description

list_by_subscription

Get all Environments for a subscription.

Get all Managed Environments for a subscription.

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

Returns

Type Description

An iterator like instance of ManagedEnvironment

Exceptions

Type Description

list_workload_profile_states

Get all workload Profile States for a Managed Environment..

Get all workload Profile States for a Managed Environment.

list_workload_profile_states(resource_group_name: str, environment_name: str, **kwargs: Any) -> ItemPaged[WorkloadProfileStates]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. The name is case insensitive. Required.

environment_name
Required
str

Name of the Environment. Required.

Returns

Type Description

An iterator like instance of WorkloadProfileStates

Exceptions

Type Description