ConnectedEnvironmentsOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

ContainerAppsAPIClient's

<xref:connected_environments> attribute.

Inheritance
builtins.object
ConnectedEnvironmentsOperations

Constructor

ConnectedEnvironmentsOperations(*args, **kwargs)

Methods

begin_create_or_update

Creates or updates an connectedEnvironment.

begin_delete

Delete an connectedEnvironment.

Delete an connectedEnvironment.

check_name_availability

Checks the resource connectedEnvironmentName availability.

Checks if resource connectedEnvironmentName is available.

get

Get the properties of an connectedEnvironment.

list_by_resource_group

Get all connectedEnvironments in a resource group.

list_by_subscription

Get all connectedEnvironments for a subscription.

Get all connectedEnvironments for a subscription.

update

Update connected Environment's properties.

Patches a Managed Environment. Only patching of tags is supported currently.

begin_create_or_update

Creates or updates an connectedEnvironment.

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

Parameters

Name Description
resource_group_name
Required
str

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

connected_environment_name
Required
str

Name of the connectedEnvironment. Required.

environment_envelope
Required

Configuration details of the connectedEnvironment. Is either a ConnectedEnvironment type or a IO[bytes] type. Required.

Returns

Type Description

An instance of LROPoller that returns either ConnectedEnvironment or the result of cls(response)

Exceptions

Type Description

begin_delete

Delete an connectedEnvironment.

Delete an connectedEnvironment.

begin_delete(resource_group_name: str, connected_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.

connected_environment_name
Required
str

Name of the connectedEnvironment. Required.

Returns

Type Description

An instance of LROPoller that returns either None or the result of cls(response)

Exceptions

Type Description

check_name_availability

Checks the resource connectedEnvironmentName availability.

Checks if resource connectedEnvironmentName is available.

check_name_availability(resource_group_name: str, connected_environment_name: str, check_name_availability_request: _models.CheckNameAvailabilityRequest, *, content_type: str = 'application/json', **kwargs: Any) -> _models.CheckNameAvailabilityResponse

Parameters

Name Description
resource_group_name
Required
str

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

connected_environment_name
Required
str

Name of the Managed Environment. Required.

check_name_availability_request
Required

The check connectedEnvironmentName availability request. Is either a CheckNameAvailabilityRequest type or a IO[bytes] type. Required.

Returns

Type Description

CheckNameAvailabilityResponse or the result of cls(response)

Exceptions

Type Description

get

Get the properties of an connectedEnvironment.

get(resource_group_name: str, connected_environment_name: str, **kwargs: Any) -> ConnectedEnvironment

Parameters

Name Description
resource_group_name
Required
str

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

connected_environment_name
Required
str

Name of the connectedEnvironment. Required.

Returns

Type Description

ConnectedEnvironment or the result of cls(response)

Exceptions

Type Description

list_by_resource_group

Get all connectedEnvironments in a resource group.

list_by_resource_group(resource_group_name: str, **kwargs: Any) -> Iterable[ConnectedEnvironment]

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 either ConnectedEnvironment or the result of cls(response)

Exceptions

Type Description

list_by_subscription

Get all connectedEnvironments for a subscription.

Get all connectedEnvironments for a subscription.

list_by_subscription(**kwargs: Any) -> Iterable[ConnectedEnvironment]

Returns

Type Description

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

Exceptions

Type Description

update

Update connected Environment's properties.

Patches a Managed Environment. Only patching of tags is supported currently.

update(resource_group_name: str, connected_environment_name: str, **kwargs: Any) -> ConnectedEnvironment

Parameters

Name Description
resource_group_name
Required
str

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

connected_environment_name
Required
str

Name of the connectedEnvironment. Required.

Returns

Type Description

ConnectedEnvironment or the result of cls(response)

Exceptions

Type Description

Attributes

models

models = <module 'azure.mgmt.appcontainers.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\appcontainers\\models\\__init__.py'>