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.

async begin_create_or_update(resource_group_name: str, connected_environment_name: str, environment_envelope: _models.ConnectedEnvironment, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_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	ConnectedEnvironment or IO Configuration details of the connectedEnvironment. Is either a ConnectedEnvironment type or a IO type. Required.

Keyword-Only Parameters

Name	Description
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 AsyncPollingMethod By default, your polling method will be AsyncARMPolling. 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

Type	Description
AsyncLROPoller[ConnectedEnvironment]	An instance of AsyncLROPoller that returns either ConnectedEnvironment or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_delete

Delete an connectedEnvironment.

Delete an connectedEnvironment.

async begin_delete(resource_group_name: str, connected_environment_name: str, **kwargs: Any) -> AsyncLROPoller[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.

Keyword-Only Parameters

Name	Description
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 By default, your polling method will be AsyncARMPolling. 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

Type	Description
AsyncLROPoller[None]	An instance of AsyncLROPoller that returns either None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

check_name_availability

Checks the resource connectedEnvironmentName availability.

Checks if resource connectedEnvironmentName is available.

async 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	CheckNameAvailabilityRequest or IO The check connectedEnvironmentName availability request. Is either a CheckNameAvailabilityRequest type or a IO type. Required.

Keyword-Only Parameters

Name	Description
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

Type	Description
CheckNameAvailabilityResponse	CheckNameAvailabilityResponse or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get

Get the properties of an connectedEnvironment.

async 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.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
ConnectedEnvironment	ConnectedEnvironment or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_by_resource_group

Get all connectedEnvironments in a resource group.

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

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
AsyncItemPaged[ConnectedEnvironment]	An iterator like instance of either ConnectedEnvironment or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_by_subscription

Get all connectedEnvironments for a subscription.

Get all connectedEnvironments for a subscription.

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

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
AsyncItemPaged[ConnectedEnvironment]	An iterator like instance of either ConnectedEnvironment or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

update

Update connected Environment's properties.

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

async 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.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
ConnectedEnvironment	ConnectedEnvironment or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

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