ContainerAppsOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

ContainerAppsAPIClient's

<xref:container_apps> attribute.

Constructor

ContainerAppsOperations(*args, **kwargs)

Methods

begin_create_or_update	Create or update a Container App. Create or update a Container App.
begin_delete	Delete a Container App. Delete a Container App.
begin_start	Start a container app. Start a container app.
begin_stop	Stop a container app. Stop a container app.
begin_update	Update properties of a Container App. Patches a Container App using JSON Merge Patch.
get	Get the properties of a Container App. Get the properties of a Container App.
get_auth_token	Get auth token for a container app. Get auth token for a container app.
list_by_resource_group	Get the Container Apps in a given resource group. Get the Container Apps in a given resource group.
list_by_subscription	Get the Container Apps in a given subscription. Get the Container Apps in a given subscription.
list_custom_host_name_analysis	Analyzes a custom hostname for a Container App. Analyzes a custom hostname for a Container App.
list_secrets	List secrets for a container app. List secrets for a container app.

begin_create_or_update

Create or update a Container App.

Create or update a Container App.

async begin_create_or_update(resource_group_name: str, container_app_name: str, container_app_envelope: _models.ContainerApp, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.ContainerApp]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
container_app_name Required	str Name of the Container App. Required.
container_app_envelope Required	ContainerApp or ContainerApp or IO[bytes] Properties used to create a container app. Is either a ContainerApp type or a IO[bytes] type. Required.

Returns

Type	Description
AsyncLROPoller[ContainerApp]	An instance of AsyncLROPoller that returns ContainerApp. The ContainerApp is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

begin_delete

Delete a Container App.

Delete a Container App.

async begin_delete(resource_group_name: str, container_app_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.
container_app_name Required	str Name of the Container App. Required.

Returns

Type	Description
AsyncLROPoller[None]	An instance of AsyncLROPoller that returns None

Exceptions

Type	Description
HttpResponseError

begin_start

Start a container app.

Start a container app.

async begin_start(resource_group_name: str, container_app_name: str, **kwargs: Any) -> AsyncLROPoller[ContainerApp]

Parameters

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

Returns

Type	Description
AsyncLROPoller[ContainerApp]	An instance of AsyncLROPoller that returns ContainerApp. The ContainerApp is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

begin_stop

Stop a container app.

Stop a container app.

async begin_stop(resource_group_name: str, container_app_name: str, **kwargs: Any) -> AsyncLROPoller[ContainerApp]

Parameters

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

Returns

Type	Description
AsyncLROPoller[ContainerApp]	An instance of AsyncLROPoller that returns ContainerApp. The ContainerApp is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

begin_update

Update properties of a Container App.

Patches a Container App using JSON Merge Patch.

async begin_update(resource_group_name: str, container_app_name: str, container_app_envelope: _models.ContainerApp, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.ContainerApp]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
container_app_name Required	str Name of the Container App. Required.
container_app_envelope Required	ContainerApp or ContainerApp or IO[bytes] Properties of a Container App that need to be updated. Is either a ContainerApp type or a IO[bytes] type. Required.

Returns

Type	Description
AsyncLROPoller[ContainerApp]	An instance of AsyncLROPoller that returns ContainerApp. The ContainerApp is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

get

Get the properties of a Container App.

Get the properties of a Container App.

async get(resource_group_name: str, container_app_name: str, **kwargs: Any) -> ContainerApp

Parameters

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

Returns

Type	Description
ContainerApp	ContainerApp. The ContainerApp is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

get_auth_token

Get auth token for a container app.

Get auth token for a container app.

async get_auth_token(resource_group_name: str, container_app_name: str, **kwargs: Any) -> ContainerAppAuthToken

Parameters

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

Returns

Type	Description
ContainerAppAuthToken	ContainerAppAuthToken. The ContainerAppAuthToken is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

list_by_resource_group

Get the Container Apps in a given resource group.

Get the Container Apps in a given resource group.

list_by_resource_group(resource_group_name: str, **kwargs: Any) -> AsyncItemPaged[ContainerApp]

Parameters

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

Returns

Type	Description
AsyncItemPaged[ContainerApp]	An iterator like instance of ContainerApp

Exceptions

Type	Description
HttpResponseError

list_by_subscription

Get the Container Apps in a given subscription.

Get the Container Apps in a given subscription.

list_by_subscription(**kwargs: Any) -> AsyncItemPaged[ContainerApp]

Returns

Type	Description
AsyncItemPaged[ContainerApp]	An iterator like instance of ContainerApp

Exceptions

Type	Description
HttpResponseError

list_custom_host_name_analysis

Analyzes a custom hostname for a Container App.

Analyzes a custom hostname for a Container App.

async list_custom_host_name_analysis(resource_group_name: str, container_app_name: str, *, custom_hostname: str | None = None, **kwargs: Any) -> CustomHostnameAnalysisResult

Parameters

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

Keyword-Only Parameters

Name	Description
custom_hostname	str Custom hostname. Default value is None. Default value: None

Returns

Type	Description
CustomHostnameAnalysisResult	CustomHostnameAnalysisResult. The CustomHostnameAnalysisResult is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

list_secrets

List secrets for a container app.

List secrets for a container app.

async list_secrets(resource_group_name: str, container_app_name: str, **kwargs: Any) -> SecretsCollection

Parameters

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

Returns

Type	Description
SecretsCollection	SecretsCollection. The SecretsCollection is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError