azure.mgmt.appcontainers.operations module

Raises:

delete(resource_group_name: str, environment_name: str, certificate_name: str, **kwargs: Any) → None[source]

Deletes the specified Certificate.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
environment_name (str) – Name of the Managed Environment. Required.
certificate_name (str) – Name of the Certificate. Required.

Returns:

None or the result of cls(response)

Return type:

None

Raises:

get(resource_group_name: str, environment_name: str, certificate_name: str, **kwargs: Any) → Certificate[source]

Get the specified Certificate.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
environment_name (str) – Name of the Managed Environment. Required.
certificate_name (str) – Name of the Certificate. Required.

Returns:

Certificate or the result of cls(response)

Return type:

Raises:

ItemPaged[Certificate]

list(resource_group_name: str, environment_name: str, **kwargs: Any) → Iterable[Certificate][source]

Get the Certificates in a given managed environment.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
environment_name (str) – Name of the Managed Environment. Required.

Returns:

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

Return type:

Raises:

update(resource_group_name: str, environment_name: str, certificate_name: str, certificate_envelope: CertificatePatch | IO[bytes], **kwargs: Any) → Certificate[source]

Update properties of a certificate.

Patches a certificate. Currently only patching of tags is supported.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
environment_name (str) – Name of the Managed Environment. Required.
certificate_name (str) – Name of the Certificate. Required.
certificate_envelope (CertificatePatch or IO[bytes]) – Properties of a certificate that need to be updated. Is either a CertificatePatch type or a IO[bytes] type. Required.

Returns:

Certificate or the result of cls(response)

Return type:

Raises:

models = <module 'azure.mgmt.appcontainers.models' from '/mnt/vss/_work/1/s/sdk/appcontainers/azure-mgmt-appcontainers/.tox/sphinx/lib/python3.13/site-packages/azure/mgmt/appcontainers/models/__init__.py'>

class azure.mgmt.appcontainers.operations.ConnectedEnvironmentsCertificatesOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ContainerAppsAPIClient’s connected_environments_certificates attribute.

create_or_update(resource_group_name: str, connected_environment_name: str, certificate_name: str, certificate_envelope: Certificate | IO[bytes] | None = None, **kwargs: Any) → Certificate[source]

Create or Update a Certificate.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
connected_environment_name (str) – Name of the Connected Environment. Required.
certificate_name (str) – Name of the Certificate. Required.
certificate_envelope (Certificate or IO[bytes]) – Certificate to be created or updated. Is either a Certificate type or a IO[bytes] type. Default value is None.

Returns:

Certificate or the result of cls(response)

Return type:

Raises:

delete(resource_group_name: str, connected_environment_name: str, certificate_name: str, **kwargs: Any) → None[source]

Deletes the specified Certificate.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
connected_environment_name (str) – Name of the Connected Environment. Required.
certificate_name (str) – Name of the Certificate. Required.

Returns:

None or the result of cls(response)

Return type:

None

Raises:

get(resource_group_name: str, connected_environment_name: str, certificate_name: str, **kwargs: Any) → Certificate[source]

Get the specified Certificate.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
connected_environment_name (str) – Name of the Connected Environment. Required.
certificate_name (str) – Name of the Certificate. Required.

Returns:

Certificate or the result of cls(response)

Return type:

Raises:

ItemPaged[Certificate]

list(resource_group_name: str, connected_environment_name: str, **kwargs: Any) → Iterable[Certificate][source]

Get the Certificates in a given connected environment.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
connected_environment_name (str) – Name of the Connected Environment. Required.

Returns:

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

Return type:

Raises:

update(resource_group_name: str, connected_environment_name: str, certificate_name: str, certificate_envelope: CertificatePatch | IO[bytes], **kwargs: Any) → Certificate[source]

Update properties of a certificate.

Patches a certificate. Currently only patching of tags is supported.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
connected_environment_name (str) – Name of the Connected Environment. Required.
certificate_name (str) – Name of the Certificate. Required.
certificate_envelope (CertificatePatch or IO[bytes]) – Properties of a certificate that need to be updated. Is either a CertificatePatch type or a IO[bytes] type. Required.

Returns:

Certificate or the result of cls(response)

Return type:

Raises:

models = <module 'azure.mgmt.appcontainers.models' from '/mnt/vss/_work/1/s/sdk/appcontainers/azure-mgmt-appcontainers/.tox/sphinx/lib/python3.13/site-packages/azure/mgmt/appcontainers/models/__init__.py'>

class azure.mgmt.appcontainers.operations.ConnectedEnvironmentsDaprComponentsOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ContainerAppsAPIClient’s connected_environments_dapr_components attribute.

create_or_update(resource_group_name: str, connected_environment_name: str, component_name: str, dapr_component_envelope: DaprComponent | IO[bytes], **kwargs: Any) → DaprComponent[source]

Creates or updates a Dapr Component.

Creates or updates a Dapr Component in a connected environment.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
connected_environment_name (str) – Name of the connected environment. Required.
component_name (str) – Name of the Dapr Component. Required.
dapr_component_envelope (DaprComponent or IO[bytes]) – Configuration details of the Dapr Component. Is either a DaprComponent type or a IO[bytes] type. Required.

Returns:

DaprComponent or the result of cls(response)

Return type:

Raises:

delete(resource_group_name: str, connected_environment_name: str, component_name: str, **kwargs: Any) → None[source]

Delete a Dapr Component.

Delete a Dapr Component from a connected environment.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
connected_environment_name (str) – Name of the connected environment. Required.
component_name (str) – Name of the Dapr Component. Required.

Returns:

None or the result of cls(response)

Return type:

None

Raises:

get(resource_group_name: str, connected_environment_name: str, component_name: str, **kwargs: Any) → DaprComponent[source]

Get a dapr component.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
connected_environment_name (str) – Name of the connected environment. Required.
component_name (str) – Name of the Dapr Component. Required.

Returns:

DaprComponent or the result of cls(response)

Return type:

Raises:

ItemPaged[DaprComponent]

list(resource_group_name: str, connected_environment_name: str, **kwargs: Any) → Iterable[DaprComponent][source]

Get the Dapr Components for a connected environment.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
connected_environment_name (str) – Name of the connected environment. Required.

Returns:

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

Return type:

Raises:

list_secrets(resource_group_name: str, connected_environment_name: str, component_name: str, **kwargs: Any) → DaprSecretsCollection[source]

List secrets for a dapr component.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
connected_environment_name (str) – Name of the connected environment. Required.
component_name (str) – Name of the Dapr Component. Required.

Returns:

DaprSecretsCollection or the result of cls(response)

Return type:

DaprSecretsCollection

Raises:

LROPoller[ConnectedEnvironment]

models = <module 'azure.mgmt.appcontainers.models' from '/mnt/vss/_work/1/s/sdk/appcontainers/azure-mgmt-appcontainers/.tox/sphinx/lib/python3.13/site-packages/azure/mgmt/appcontainers/models/__init__.py'>

class azure.mgmt.appcontainers.operations.ConnectedEnvironmentsOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ContainerAppsAPIClient’s connected_environments attribute.

begin_create_or_update(resource_group_name: str, connected_environment_name: str, environment_envelope: ConnectedEnvironment | IO[bytes], **kwargs: Any) → LROPoller[ConnectedEnvironment][source]

Creates or updates an connectedEnvironment.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
connected_environment_name (str) – Name of the connectedEnvironment. Required.
environment_envelope (ConnectedEnvironment or IO[bytes]) – Configuration details of the connectedEnvironment. Is either a ConnectedEnvironment type or a IO[bytes] type. Required.

Returns:

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

Return type:

Raises:

begin_delete(resource_group_name: str, connected_environment_name: str, **kwargs: Any) → LROPoller[None][source]

Delete an connectedEnvironment.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
connected_environment_name (str) – Name of the connectedEnvironment. Required.

Returns:

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

Return type:

LROPoller[None]

Raises:

CheckNameAvailabilityResponse

check_name_availability(resource_group_name: str, connected_environment_name: str, check_name_availability_request: CheckNameAvailabilityRequest | IO[bytes], **kwargs: Any) → CheckNameAvailabilityResponse[source]

Checks the resource connectedEnvironmentName availability.

Checks if resource connectedEnvironmentName is available.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
connected_environment_name (str) – Name of the Managed Environment. Required.
check_name_availability_request (CheckNameAvailabilityRequest or IO[bytes]) – The check connectedEnvironmentName availability request. Is either a CheckNameAvailabilityRequest type or a IO[bytes] type. Required.

Returns:

CheckNameAvailabilityResponse or the result of cls(response)

Return type:

Raises:

get(resource_group_name: str, connected_environment_name: str, **kwargs: Any) → ConnectedEnvironment[source]

Get the properties of an connectedEnvironment.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
connected_environment_name (str) – Name of the connectedEnvironment. Required.

Returns:

ConnectedEnvironment or the result of cls(response)

Return type:

ConnectedEnvironment

Raises:

list_by_resource_group(resource_group_name: str, **kwargs: Any) → Iterable[ConnectedEnvironment][source]

Get all connectedEnvironments in a resource group.

Parameters:: resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
Returns:: An iterator like instance of either ConnectedEnvironment or the result of cls(response)
Return type:: ItemPaged[ConnectedEnvironment]
Raises:: HttpResponseError –

list_by_subscription(**kwargs: Any) → Iterable[ConnectedEnvironment][source]

Get all connectedEnvironments for a subscription.

Returns:: An iterator like instance of either ConnectedEnvironment or the result of cls(response)
Return type:: ItemPaged[ConnectedEnvironment]
Raises:: HttpResponseError –

update(resource_group_name: str, connected_environment_name: str, **kwargs: Any) → ConnectedEnvironment[source]

Update connected Environment’s properties.

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

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
connected_environment_name (str) – Name of the connectedEnvironment. Required.

Returns:

ConnectedEnvironment or the result of cls(response)

Return type:

ConnectedEnvironment

Raises:

ConnectedEnvironmentStorage

models = <module 'azure.mgmt.appcontainers.models' from '/mnt/vss/_work/1/s/sdk/appcontainers/azure-mgmt-appcontainers/.tox/sphinx/lib/python3.13/site-packages/azure/mgmt/appcontainers/models/__init__.py'>

class azure.mgmt.appcontainers.operations.ConnectedEnvironmentsStoragesOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ContainerAppsAPIClient’s connected_environments_storages attribute.

create_or_update(resource_group_name: str, connected_environment_name: str, storage_name: str, storage_envelope: ConnectedEnvironmentStorage | IO[bytes], **kwargs: Any) → ConnectedEnvironmentStorage[source]

Create or update storage for a connectedEnvironment.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
connected_environment_name (str) – Name of the Environment. Required.
storage_name (str) – Name of the storage. Required.
storage_envelope (ConnectedEnvironmentStorage or IO[bytes]) – Configuration details of storage. Is either a ConnectedEnvironmentStorage type or a IO[bytes] type. Required.

Returns:

ConnectedEnvironmentStorage or the result of cls(response)

Return type:

Raises:

delete(resource_group_name: str, connected_environment_name: str, storage_name: str, **kwargs: Any) → None[source]

Delete storage for a connectedEnvironment.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
connected_environment_name (str) – Name of the Environment. Required.
storage_name (str) – Name of the storage. Required.

Returns:

None or the result of cls(response)

Return type:

None

Raises:

ConnectedEnvironmentStorage

get(resource_group_name: str, connected_environment_name: str, storage_name: str, **kwargs: Any) → ConnectedEnvironmentStorage[source]

Get storage for a connectedEnvironment.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
connected_environment_name (str) – Name of the Environment. Required.
storage_name (str) – Name of the storage. Required.

Returns:

ConnectedEnvironmentStorage or the result of cls(response)

Return type:

Raises:

ConnectedEnvironmentStoragesCollection

list(resource_group_name: str, connected_environment_name: str, **kwargs: Any) → ConnectedEnvironmentStoragesCollection[source]

Get all storages for a connectedEnvironment.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
connected_environment_name (str) – Name of the Environment. Required.

Returns:

ConnectedEnvironmentStoragesCollection or the result of cls(response)

Return type:

Raises:

models = <module 'azure.mgmt.appcontainers.models' from '/mnt/vss/_work/1/s/sdk/appcontainers/azure-mgmt-appcontainers/.tox/sphinx/lib/python3.13/site-packages/azure/mgmt/appcontainers/models/__init__.py'>

class azure.mgmt.appcontainers.operations.ContainerAppsAPIClientOperationsMixin[source]

Bases: ContainerAppsAPIClientMixinABC

get_custom_domain_verification_id(**kwargs: Any) → str[source]

Get the verification id of a subscription used for verifying custom domains.

Returns:: str or the result of cls(response)
Return type:: str
Raises:: HttpResponseError –

job_execution(resource_group_name: str, job_name: str, job_execution_name: str, **kwargs: Any) → JobExecution[source]

Get details of a single job execution.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
job_name (str) – Job Name. Required.
job_execution_name (str) – Job execution name. Required.

Returns:

JobExecution or the result of cls(response)

Return type:

JobExecution

Raises:

class azure.mgmt.appcontainers.operations.ContainerAppsAuthConfigsOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ContainerAppsAPIClient’s container_apps_auth_configs attribute.

create_or_update(resource_group_name: str, container_app_name: str, auth_config_name: str, auth_config_envelope: AuthConfig | IO[bytes], **kwargs: Any) → AuthConfig[source]

Create or update the AuthConfig for a Container App.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
container_app_name (str) – Name of the Container App. Required.
auth_config_name (str) – Name of the Container App AuthConfig. Required.
auth_config_envelope (AuthConfig or IO[bytes]) – Properties used to create a Container App AuthConfig. Is either a AuthConfig type or a IO[bytes] type. Required.

Returns:

AuthConfig or the result of cls(response)

Return type:

AuthConfig

Raises:

delete(resource_group_name: str, container_app_name: str, auth_config_name: str, **kwargs: Any) → None[source]

Delete a Container App AuthConfig.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
container_app_name (str) – Name of the Container App. Required.
auth_config_name (str) – Name of the Container App AuthConfig. Required.

Returns:

None or the result of cls(response)

Return type:

None

Raises:

get(resource_group_name: str, container_app_name: str, auth_config_name: str, **kwargs: Any) → AuthConfig[source]

Get a AuthConfig of a Container App.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
container_app_name (str) – Name of the Container App. Required.
auth_config_name (str) – Name of the Container App AuthConfig. Required.

Returns:

AuthConfig or the result of cls(response)

Return type:

AuthConfig

Raises:

ItemPaged[AuthConfig]

list_by_container_app(resource_group_name: str, container_app_name: str, **kwargs: Any) → Iterable[AuthConfig][source]

Get the Container App AuthConfigs in a given resource group.

Parameters:

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

Returns:

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

Return type:

Raises:

models = <module 'azure.mgmt.appcontainers.models' from '/mnt/vss/_work/1/s/sdk/appcontainers/azure-mgmt-appcontainers/.tox/sphinx/lib/python3.13/site-packages/azure/mgmt/appcontainers/models/__init__.py'>

class azure.mgmt.appcontainers.operations.ContainerAppsDiagnosticsOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ContainerAppsAPIClient’s container_apps_diagnostics attribute.

get_detector(resource_group_name: str, container_app_name: str, detector_name: str, **kwargs: Any) → Diagnostics[source]

Get a diagnostics result of a Container App.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
container_app_name (str) – Name of the Container App. Required.
detector_name (str) – Name of the Container App Detector. Required.

Returns:

Diagnostics or the result of cls(response)

Return type:

Diagnostics

Raises:

get_revision(resource_group_name: str, container_app_name: str, revision_name: str, **kwargs: Any) → Revision[source]

Get a revision of a Container App.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
container_app_name (str) – Name of the Container App. Required.
revision_name (str) – Name of the Container App Revision. Required.

Returns:

Revision or the result of cls(response)

Return type:

Revision

Raises:

get_root(resource_group_name: str, container_app_name: str, **kwargs: Any) → ContainerApp[source]

Get the properties of a Container App.

Parameters:

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

Returns:

ContainerApp or the result of cls(response)

Return type:

ContainerApp

Raises:

ItemPaged[Diagnostics]

list_detectors(resource_group_name: str, container_app_name: str, **kwargs: Any) → Iterable[Diagnostics][source]

Get the list of diagnostics for a given Container App.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
container_app_name (str) – Name of the Container App for which detector info is needed. Required.

Returns:

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

Return type:

Raises:

list_revisions(resource_group_name: str, container_app_name: str, filter: str | None = None, **kwargs: Any) → Iterable[Revision][source]

Get the Revisions for a given Container App.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
container_app_name (str) – Name of the Container App for which Revisions are needed. Required.
filter (str) – The filter to apply on the operation. Default value is None.

Returns:

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

Return type:

ItemPaged[Revision]

Raises:

models = <module 'azure.mgmt.appcontainers.models' from '/mnt/vss/_work/1/s/sdk/appcontainers/azure-mgmt-appcontainers/.tox/sphinx/lib/python3.13/site-packages/azure/mgmt/appcontainers/models/__init__.py'>

class azure.mgmt.appcontainers.operations.ContainerAppsOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ContainerAppsAPIClient’s container_apps attribute.

begin_create_or_update(resource_group_name: str, container_app_name: str, container_app_envelope: ContainerApp | IO[bytes], **kwargs: Any) → LROPoller[ContainerApp][source]

Create or update a Container App.

Parameters:

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

Returns:

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

Return type:

Raises:

begin_delete(resource_group_name: str, container_app_name: str, **kwargs: Any) → LROPoller[None][source]

Delete a Container App.

Parameters:

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

Returns:

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

Return type:

LROPoller[None]

Raises:

begin_start(resource_group_name: str, container_app_name: str, **kwargs: Any) → LROPoller[ContainerApp][source]

Start a container app.

Parameters:

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

Returns:

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

Return type:

Raises:

begin_stop(resource_group_name: str, container_app_name: str, **kwargs: Any) → LROPoller[ContainerApp][source]

Stop a container app.

Parameters:

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

Returns:

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

Return type:

Raises:

begin_update(resource_group_name: str, container_app_name: str, container_app_envelope: ContainerApp | IO[bytes], **kwargs: Any) → LROPoller[ContainerApp][source]

Update properties of a Container App.

Patches a Container App using JSON Merge Patch.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
container_app_name (str) – Name of the Container App. Required.
container_app_envelope (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:

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

Return type:

Raises:

get(resource_group_name: str, container_app_name: str, **kwargs: Any) → ContainerApp[source]

Get the properties of a Container App.

Parameters:

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

Returns:

ContainerApp or the result of cls(response)

Return type:

ContainerApp

Raises:

get_auth_token(resource_group_name: str, container_app_name: str, **kwargs: Any) → ContainerAppAuthToken[source]

Get auth token for a container app.

Parameters:

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

Returns:

ContainerAppAuthToken or the result of cls(response)

Return type:

ContainerAppAuthToken

Raises:

CustomHostnameAnalysisResult

list_by_resource_group(resource_group_name: str, **kwargs: Any) → Iterable[ContainerApp][source]

Get the Container Apps in a given resource group.

Parameters:: resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
Returns:: An iterator like instance of either ContainerApp or the result of cls(response)
Return type:: ItemPaged[ContainerApp]
Raises:: HttpResponseError –

list_by_subscription(**kwargs: Any) → Iterable[ContainerApp][source]

Get the Container Apps in a given subscription.

Returns:: An iterator like instance of either ContainerApp or the result of cls(response)
Return type:: ItemPaged[ContainerApp]
Raises:: HttpResponseError –

list_custom_host_name_analysis(resource_group_name: str, container_app_name: str, custom_hostname: str | None = None, **kwargs: Any) → CustomHostnameAnalysisResult[source]

Analyzes a custom hostname for a Container App.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
container_app_name (str) – Name of the Container App. Required.
custom_hostname (str) – Custom hostname. Default value is None.

Returns:

CustomHostnameAnalysisResult or the result of cls(response)

Return type:

Raises:

list_secrets(resource_group_name: str, container_app_name: str, **kwargs: Any) → SecretsCollection[source]

List secrets for a container app.

Parameters:

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

Returns:

SecretsCollection or the result of cls(response)

Return type:

SecretsCollection

Raises:

models = <module 'azure.mgmt.appcontainers.models' from '/mnt/vss/_work/1/s/sdk/appcontainers/azure-mgmt-appcontainers/.tox/sphinx/lib/python3.13/site-packages/azure/mgmt/appcontainers/models/__init__.py'>

class azure.mgmt.appcontainers.operations.ContainerAppsRevisionReplicasOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ContainerAppsAPIClient’s container_apps_revision_replicas attribute.

get_replica(resource_group_name: str, container_app_name: str, revision_name: str, replica_name: str, **kwargs: Any) → Replica[source]

Get a replica for a Container App Revision.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
container_app_name (str) – Name of the Container App. Required.
revision_name (str) – Name of the Container App Revision. Required.
replica_name (str) – Name of the Container App Revision Replica. Required.

Returns:

Replica or the result of cls(response)

Return type:

Replica

Raises:

list_replicas(resource_group_name: str, container_app_name: str, revision_name: str, **kwargs: Any) → ReplicaCollection[source]

List replicas for a Container App Revision.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
container_app_name (str) – Name of the Container App. Required.
revision_name (str) – Name of the Container App Revision. Required.

Returns:

ReplicaCollection or the result of cls(response)

Return type:

ReplicaCollection

Raises:

models = <module 'azure.mgmt.appcontainers.models' from '/mnt/vss/_work/1/s/sdk/appcontainers/azure-mgmt-appcontainers/.tox/sphinx/lib/python3.13/site-packages/azure/mgmt/appcontainers/models/__init__.py'>

class azure.mgmt.appcontainers.operations.ContainerAppsRevisionsOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ContainerAppsAPIClient’s container_apps_revisions attribute.

activate_revision(resource_group_name: str, container_app_name: str, revision_name: str, **kwargs: Any) → None[source]

Activates a revision for a Container App.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
container_app_name (str) – Name of the Container App. Required.
revision_name (str) – Name of the Container App Revision. Required.

Returns:

None or the result of cls(response)

Return type:

None

Raises:

deactivate_revision(resource_group_name: str, container_app_name: str, revision_name: str, **kwargs: Any) → None[source]

Deactivates a revision for a Container App.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
container_app_name (str) – Name of the Container App. Required.
revision_name (str) – Name of the Container App Revision. Required.

Returns:

None or the result of cls(response)

Return type:

None

Raises:

get_revision(resource_group_name: str, container_app_name: str, revision_name: str, **kwargs: Any) → Revision[source]

Get a revision of a Container App.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
container_app_name (str) – Name of the Container App. Required.
revision_name (str) – Name of the Container App Revision. Required.

Returns:

Revision or the result of cls(response)

Return type:

Revision

Raises:

list_revisions(resource_group_name: str, container_app_name: str, filter: str | None = None, **kwargs: Any) → Iterable[Revision][source]

Get the Revisions for a given Container App.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
container_app_name (str) – Name of the Container App for which Revisions are needed. Required.
filter (str) – The filter to apply on the operation. Default value is None.

Returns:

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

Return type:

ItemPaged[Revision]

Raises:

restart_revision(resource_group_name: str, container_app_name: str, revision_name: str, **kwargs: Any) → None[source]

Restarts a revision for a Container App.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
container_app_name (str) – Name of the Container App. Required.
revision_name (str) – Name of the Container App Revision. Required.

Returns:

None or the result of cls(response)

Return type:

None

Raises:

LROPoller[SessionPool]

models = <module 'azure.mgmt.appcontainers.models' from '/mnt/vss/_work/1/s/sdk/appcontainers/azure-mgmt-appcontainers/.tox/sphinx/lib/python3.13/site-packages/azure/mgmt/appcontainers/models/__init__.py'>

class azure.mgmt.appcontainers.operations.ContainerAppsSessionPoolsOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ContainerAppsAPIClient’s container_apps_session_pools attribute.

begin_create_or_update(resource_group_name: str, session_pool_name: str, session_pool_envelope: SessionPool | IO[bytes], **kwargs: Any) → LROPoller[SessionPool][source]

Create or update a session pool.

Create or update a session pool with the given properties.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
session_pool_name (str) – Name of the session pool. Required.
session_pool_envelope (SessionPool or IO[bytes]) – Properties used to create a session pool. Is either a SessionPool type or a IO[bytes] type. Required.

Returns:

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

Return type:

Raises:

begin_delete(resource_group_name: str, session_pool_name: str, **kwargs: Any) → LROPoller[None][source]

Delete a session pool.

Delete the session pool with the given name.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
session_pool_name (str) – Name of the session pool. Required.

Returns:

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

Return type:

LROPoller[None]

Raises:

LROPoller[SessionPool]

begin_update(resource_group_name: str, session_pool_name: str, session_pool_envelope: SessionPoolUpdatableProperties | IO[bytes], **kwargs: Any) → LROPoller[SessionPool][source]

Update properties of a session pool.

Patches a session pool using JSON merge patch.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
session_pool_name (str) – Name of the session pool. Required.
session_pool_envelope (SessionPoolUpdatableProperties or IO[bytes]) – Properties used to create a session pool. Is either a SessionPoolUpdatableProperties type or a IO[bytes] type. Required.

Returns:

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

Return type:

Raises:

get(resource_group_name: str, session_pool_name: str, **kwargs: Any) → SessionPool[source]

Get the properties of a session pool.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
session_pool_name (str) – Name of the session pool. Required.

Returns:

SessionPool or the result of cls(response)

Return type:

SessionPool

Raises:

LROPoller[SourceControl]

list_by_resource_group(resource_group_name: str, **kwargs: Any) → Iterable[SessionPool][source]

Get the session pools in a given resource group of a subscription.

Parameters:: resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
Returns:: An iterator like instance of either SessionPool or the result of cls(response)
Return type:: ItemPaged[SessionPool]
Raises:: HttpResponseError –

list_by_subscription(**kwargs: Any) → Iterable[SessionPool][source]

Get the session pools in a given subscription.

Returns:: An iterator like instance of either SessionPool or the result of cls(response)
Return type:: ItemPaged[SessionPool]
Raises:: HttpResponseError –

models = <module 'azure.mgmt.appcontainers.models' from '/mnt/vss/_work/1/s/sdk/appcontainers/azure-mgmt-appcontainers/.tox/sphinx/lib/python3.13/site-packages/azure/mgmt/appcontainers/models/__init__.py'>

class azure.mgmt.appcontainers.operations.ContainerAppsSourceControlsOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ContainerAppsAPIClient’s container_apps_source_controls attribute.

begin_create_or_update(resource_group_name: str, container_app_name: str, source_control_name: str, source_control_envelope: SourceControl | IO[bytes], **kwargs: Any) → LROPoller[SourceControl][source]

Create or update the SourceControl for a Container App.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
container_app_name (str) – Name of the Container App. Required.
source_control_name (str) – Name of the Container App SourceControl. Required.
source_control_envelope (SourceControl or IO[bytes]) – Properties used to create a Container App SourceControl. Is either a SourceControl type or a IO[bytes] type. Required.

Returns:

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

Return type:

Raises:

begin_delete(resource_group_name: str, container_app_name: str, source_control_name: str, **kwargs: Any) → LROPoller[None][source]

Delete a Container App SourceControl.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
container_app_name (str) – Name of the Container App. Required.
source_control_name (str) – Name of the Container App SourceControl. Required.

Returns:

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

Return type:

LROPoller[None]

Raises:

get(resource_group_name: str, container_app_name: str, source_control_name: str, **kwargs: Any) → SourceControl[source]

Get a SourceControl of a Container App.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
container_app_name (str) – Name of the Container App. Required.
source_control_name (str) – Name of the Container App SourceControl. Required.

Returns:

SourceControl or the result of cls(response)

Return type:

SourceControl

Raises:

ItemPaged[SourceControl]

list_by_container_app(resource_group_name: str, container_app_name: str, **kwargs: Any) → Iterable[SourceControl][source]

Get the Container App SourceControls in a given resource group.

Parameters:

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

Returns:

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

Return type:

Raises:

models = <module 'azure.mgmt.appcontainers.models' from '/mnt/vss/_work/1/s/sdk/appcontainers/azure-mgmt-appcontainers/.tox/sphinx/lib/python3.13/site-packages/azure/mgmt/appcontainers/models/__init__.py'>

class azure.mgmt.appcontainers.operations.DaprComponentsOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ContainerAppsAPIClient’s dapr_components attribute.

create_or_update(resource_group_name: str, environment_name: str, component_name: str, dapr_component_envelope: DaprComponent | IO[bytes], **kwargs: Any) → DaprComponent[source]

Creates or updates a Dapr Component.

Creates or updates a Dapr Component in a Managed Environment.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
environment_name (str) – Name of the Managed Environment. Required.
component_name (str) – Name of the Dapr Component. Required.
dapr_component_envelope (DaprComponent or IO[bytes]) – Configuration details of the Dapr Component. Is either a DaprComponent type or a IO[bytes] type. Required.

Returns:

DaprComponent or the result of cls(response)

Return type:

Raises:

delete(resource_group_name: str, environment_name: str, component_name: str, **kwargs: Any) → None[source]

Delete a Dapr Component.

Delete a Dapr Component from a Managed Environment.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
environment_name (str) – Name of the Managed Environment. Required.
component_name (str) – Name of the Dapr Component. Required.

Returns:

None or the result of cls(response)

Return type:

None

Raises:

get(resource_group_name: str, environment_name: str, component_name: str, **kwargs: Any) → DaprComponent[source]

Get a dapr component.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
environment_name (str) – Name of the Managed Environment. Required.
component_name (str) – Name of the Dapr Component. Required.

Returns:

DaprComponent or the result of cls(response)

Return type:

Raises:

ItemPaged[DaprComponent]

list(resource_group_name: str, environment_name: str, **kwargs: Any) → Iterable[DaprComponent][source]

Get the Dapr Components for a managed environment.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
environment_name (str) – Name of the Managed Environment. Required.

Returns:

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

Return type:

Raises:

list_secrets(resource_group_name: str, environment_name: str, component_name: str, **kwargs: Any) → DaprSecretsCollection[source]

List secrets for a dapr component.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
environment_name (str) – Name of the Managed Environment. Required.
component_name (str) – Name of the Dapr Component. Required.

Returns:

DaprSecretsCollection or the result of cls(response)

Return type:

DaprSecretsCollection

Raises:

LROPoller[JavaComponent]

models = <module 'azure.mgmt.appcontainers.models' from '/mnt/vss/_work/1/s/sdk/appcontainers/azure-mgmt-appcontainers/.tox/sphinx/lib/python3.13/site-packages/azure/mgmt/appcontainers/models/__init__.py'>

class azure.mgmt.appcontainers.operations.JavaComponentsOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ContainerAppsAPIClient’s java_components attribute.

begin_create_or_update(resource_group_name: str, environment_name: str, name: str, java_component_envelope: JavaComponent | IO[bytes], **kwargs: Any) → LROPoller[JavaComponent][source]

Creates or updates a Java Component.

Creates or updates a Java Component in a Managed Environment.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
environment_name (str) – Name of the Managed Environment. Required.
name (str) – Name of the Java Component. Required.
java_component_envelope (JavaComponent or IO[bytes]) – Configuration details of the Java Component. Is either a JavaComponent type or a IO[bytes] type. Required.

Returns:

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

Return type:

Raises:

begin_delete(resource_group_name: str, environment_name: str, name: str, **kwargs: Any) → LROPoller[None][source]

Delete.

Delete a Java Component.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
environment_name (str) – Name of the Managed Environment. Required.
name (str) – Name of the Java Component. Required.

Returns:

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

Return type:

LROPoller[None]

Raises:

LROPoller[JavaComponent]

begin_update(resource_group_name: str, environment_name: str, name: str, java_component_envelope: JavaComponent | IO[bytes], **kwargs: Any) → LROPoller[JavaComponent][source]

Update properties of a Java Component.

Patches a Java Component using JSON Merge Patch.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
environment_name (str) – Name of the Managed Environment. Required.
name (str) – Name of the Java Component. Required.
java_component_envelope (JavaComponent or IO[bytes]) – Configuration details of the Java Component. Is either a JavaComponent type or a IO[bytes] type. Required.

Returns:

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

Return type:

Raises:

get(resource_group_name: str, environment_name: str, name: str, **kwargs: Any) → JavaComponent[source]

Get a Java Component.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
environment_name (str) – Name of the Managed Environment. Required.
name (str) – Name of the Java Component. Required.

Returns:

JavaComponent or the result of cls(response)

Return type:

JavaComponent

Raises:

ItemPaged[JavaComponent]

list(resource_group_name: str, environment_name: str, **kwargs: Any) → Iterable[JavaComponent][source]

Get the Java Components for a managed environment.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
environment_name (str) – Name of the Managed Environment. Required.

Returns:

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

Return type:

Raises:

ItemPaged[JobExecution]

models = <module 'azure.mgmt.appcontainers.models' from '/mnt/vss/_work/1/s/sdk/appcontainers/azure-mgmt-appcontainers/.tox/sphinx/lib/python3.13/site-packages/azure/mgmt/appcontainers/models/__init__.py'>

class azure.mgmt.appcontainers.operations.JobsExecutionsOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ContainerAppsAPIClient’s jobs_executions attribute.

list(resource_group_name: str, job_name: str, filter: str | None = None, **kwargs: Any) → Iterable[JobExecution][source]

Get a Container Apps Job’s executions.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
job_name (str) – Job Name. Required.
filter (str) – The filter to apply on the operation. Default value is None.

Returns:

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

Return type:

Raises:

models = <module 'azure.mgmt.appcontainers.models' from '/mnt/vss/_work/1/s/sdk/appcontainers/azure-mgmt-appcontainers/.tox/sphinx/lib/python3.13/site-packages/azure/mgmt/appcontainers/models/__init__.py'>

class azure.mgmt.appcontainers.operations.JobsOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ContainerAppsAPIClient’s jobs attribute.

begin_create_or_update(resource_group_name: str, job_name: str, job_envelope: Job | IO[bytes], **kwargs: Any) → LROPoller[Job][source]

Create or Update a Container Apps Job.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
job_name (str) – Job Name. Required.
job_envelope (Job or IO[bytes]) – Properties used to create a container apps job. Is either a Job type or a IO[bytes] type. Required.

Returns:

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

Return type:

LROPoller[Job]

Raises:

begin_delete(resource_group_name: str, job_name: str, **kwargs: Any) → LROPoller[None][source]

Delete a Container Apps Job.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
job_name (str) – Job Name. Required.

Returns:

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

Return type:

LROPoller[None]

Raises:

LROPoller[JobExecutionBase]

begin_start(resource_group_name: str, job_name: str, template: JobExecutionTemplate | IO[bytes] | None = None, **kwargs: Any) → LROPoller[JobExecutionBase][source]

Start a Container Apps Job.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
job_name (str) – Job Name. Required.
template (JobExecutionTemplate or IO[bytes]) – Properties used to start a job execution. Is either a JobExecutionTemplate type or a IO[bytes] type. Default value is None.

Returns:

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

Return type:

Raises:

begin_stop_execution(resource_group_name: str, job_name: str, job_execution_name: str, **kwargs: Any) → LROPoller[None][source]

Terminates execution of a running container apps job.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
job_name (str) – Job Name. Required.
job_execution_name (str) – Job execution name. Required.

Returns:

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

Return type:

LROPoller[None]

Raises:

LROPoller[ContainerAppJobExecutions]

begin_stop_multiple_executions(resource_group_name: str, job_name: str, **kwargs: Any) → LROPoller[ContainerAppJobExecutions][source]

Terminates execution of a running container apps job.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
job_name (str) – Job Name. Required.

Returns:

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

Return type:

Raises:

begin_update(resource_group_name: str, job_name: str, job_envelope: JobPatchProperties | IO[bytes], **kwargs: Any) → LROPoller[Job][source]

Update properties of a Container Apps Job.

Patches a Container Apps Job using JSON Merge Patch.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
job_name (str) – Job Name. Required.
job_envelope (JobPatchProperties or IO[bytes]) – Properties used to create a container apps job. Is either a JobPatchProperties type or a IO[bytes] type. Required.

Returns:

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

Return type:

LROPoller[Job]

Raises:

get(resource_group_name: str, job_name: str, **kwargs: Any) → Job[source]

Get the properties of a Container Apps Job.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
job_name (str) – Job Name. Required.

Returns:

Job or the result of cls(response)

Return type:

Job

Raises:

get_detector(resource_group_name: str, job_name: str, detector_name: str, **kwargs: Any) → Diagnostics[source]

Get the diagnostics data for a given Container App Job.

Get the diagnostics data for a Container App Job.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
job_name (str) – Job Name. Required.
detector_name (str) – Name of the Container App Job detector. Required.

Returns:

Diagnostics or the result of cls(response)

Return type:

Diagnostics

Raises:

ItemPaged[Diagnostics]

list_by_resource_group(resource_group_name: str, **kwargs: Any) → Iterable[Job][source]

Get the Container Apps Jobs in a given resource group.

Parameters:: resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
Returns:: An iterator like instance of either Job or the result of cls(response)
Return type:: ItemPaged[Job]
Raises:: HttpResponseError –

list_by_subscription(**kwargs: Any) → Iterable[Job][source]

Get the Container Apps Jobs in a given subscription.

Returns:: An iterator like instance of either Job or the result of cls(response)
Return type:: ItemPaged[Job]
Raises:: HttpResponseError –

list_detectors(resource_group_name: str, job_name: str, **kwargs: Any) → Iterable[Diagnostics][source]

Get the list of diagnostics for a given Container App Job.

Get the list of diagnostics for a Container App Job.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
job_name (str) – Job Name. Required.

Returns:

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

Return type:

Raises:

list_secrets(resource_group_name: str, job_name: str, **kwargs: Any) → JobSecretsCollection[source]

List secrets for a container apps job.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
job_name (str) – Job Name. Required.

Returns:

JobSecretsCollection or the result of cls(response)

Return type:

JobSecretsCollection

Raises:

proxy_get(resource_group_name: str, job_name: str, api_name: str, **kwargs: Any) → Job[source]

Get the properties of a Container App Job.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
job_name (str) – Job Name. Required.
api_name (str) – Proxy API Name for Container App Job. Required.

Returns:

Job or the result of cls(response)

Return type:

Job

Raises:

LROPoller[ManagedCertificate]

models = <module 'azure.mgmt.appcontainers.models' from '/mnt/vss/_work/1/s/sdk/appcontainers/azure-mgmt-appcontainers/.tox/sphinx/lib/python3.13/site-packages/azure/mgmt/appcontainers/models/__init__.py'>

class azure.mgmt.appcontainers.operations.ManagedCertificatesOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ContainerAppsAPIClient’s managed_certificates attribute.

begin_create_or_update(resource_group_name: str, environment_name: str, managed_certificate_name: str, managed_certificate_envelope: ManagedCertificate | IO[bytes] | None = None, **kwargs: Any) → LROPoller[ManagedCertificate][source]

Create or Update a Managed Certificate.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
environment_name (str) – Name of the Managed Environment. Required.
managed_certificate_name (str) – Name of the Managed Certificate. Required.
managed_certificate_envelope (ManagedCertificate or IO[bytes]) – Managed Certificate to be created or updated. Is either a ManagedCertificate type or a IO[bytes] type. Default value is None.

Returns:

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

Return type:

Raises:

delete(resource_group_name: str, environment_name: str, managed_certificate_name: str, **kwargs: Any) → None[source]

Deletes the specified Managed Certificate.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
environment_name (str) – Name of the Managed Environment. Required.
managed_certificate_name (str) – Name of the Managed Certificate. Required.

Returns:

None or the result of cls(response)

Return type:

None

Raises:

get(resource_group_name: str, environment_name: str, managed_certificate_name: str, **kwargs: Any) → ManagedCertificate[source]

Get the specified Managed Certificate.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
environment_name (str) – Name of the Managed Environment. Required.
managed_certificate_name (str) – Name of the Managed Certificate. Required.

Returns:

ManagedCertificate or the result of cls(response)

Return type:

ManagedCertificate

Raises:

ItemPaged[ManagedCertificate]

list(resource_group_name: str, environment_name: str, **kwargs: Any) → Iterable[ManagedCertificate][source]

Get the Managed Certificates in a given managed environment.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
environment_name (str) – Name of the Managed Environment. Required.

Returns:

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

Return type:

Raises:

update(resource_group_name: str, environment_name: str, managed_certificate_name: str, managed_certificate_envelope: ManagedCertificatePatch | IO[bytes], **kwargs: Any) → ManagedCertificate[source]

Update tags of a managed certificate.

Patches a managed certificate. Oly patching of tags is supported.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
environment_name (str) – Name of the Managed Environment. Required.
managed_certificate_name (str) – Name of the Managed Certificate. Required.
managed_certificate_envelope (ManagedCertificatePatch or IO[bytes]) – Properties of a managed certificate that need to be updated. Is either a ManagedCertificatePatch type or a IO[bytes] type. Required.

Returns:

ManagedCertificate or the result of cls(response)

Return type:

ManagedCertificate

Raises:

models = <module 'azure.mgmt.appcontainers.models' from '/mnt/vss/_work/1/s/sdk/appcontainers/azure-mgmt-appcontainers/.tox/sphinx/lib/python3.13/site-packages/azure/mgmt/appcontainers/models/__init__.py'>

class azure.mgmt.appcontainers.operations.ManagedEnvironmentDiagnosticsOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ContainerAppsAPIClient’s managed_environment_diagnostics attribute.

get_detector(resource_group_name: str, environment_name: str, detector_name: str, **kwargs: Any) → Diagnostics[source]

Get the diagnostics data for a given Managed Environment.

Get the diagnostics data for a Managed Environment used to host container apps.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
environment_name (str) – Name of the Environment. Required.
detector_name (str) – Name of the Managed Environment detector. Required.

Returns:

Diagnostics or the result of cls(response)

Return type:

Diagnostics

Raises:

list_detectors(resource_group_name: str, environment_name: str, **kwargs: Any) → DiagnosticsCollection[source]

Get the list of diagnostics for a given Managed Environment.

Get the list of diagnostics for a Managed Environment used to host container apps.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
environment_name (str) – Name of the Environment. Required.

Returns:

DiagnosticsCollection or the result of cls(response)

Return type:

DiagnosticsCollection

Raises:

models = <module 'azure.mgmt.appcontainers.models' from '/mnt/vss/_work/1/s/sdk/appcontainers/azure-mgmt-appcontainers/.tox/sphinx/lib/python3.13/site-packages/azure/mgmt/appcontainers/models/__init__.py'>

class azure.mgmt.appcontainers.operations.ManagedEnvironmentUsagesOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ContainerAppsAPIClient’s managed_environment_usages attribute.

list(resource_group_name: str, environment_name: str, **kwargs: Any) → Iterable[Usage][source]

Gets the current usage information as well as the limits for environment.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
environment_name (str) – Name of the Environment. Required.

Returns:

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

Return type:

ItemPaged[Usage]

Raises:

models = <module 'azure.mgmt.appcontainers.models' from '/mnt/vss/_work/1/s/sdk/appcontainers/azure-mgmt-appcontainers/.tox/sphinx/lib/python3.13/site-packages/azure/mgmt/appcontainers/models/__init__.py'>

class azure.mgmt.appcontainers.operations.ManagedEnvironmentsDiagnosticsOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ContainerAppsAPIClient’s managed_environments_diagnostics attribute.

get_root(resource_group_name: str, environment_name: str, **kwargs: Any) → ManagedEnvironment[source]

Get the properties of a Managed Environment.

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

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
environment_name (str) – Name of the Environment. Required.

Returns:

ManagedEnvironment or the result of cls(response)

Return type:

ManagedEnvironment

Raises:

LROPoller[ManagedEnvironment]

models = <module 'azure.mgmt.appcontainers.models' from '/mnt/vss/_work/1/s/sdk/appcontainers/azure-mgmt-appcontainers/.tox/sphinx/lib/python3.13/site-packages/azure/mgmt/appcontainers/models/__init__.py'>

class azure.mgmt.appcontainers.operations.ManagedEnvironmentsOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ContainerAppsAPIClient’s managed_environments attribute.

begin_create_or_update(resource_group_name: str, environment_name: str, environment_envelope: ManagedEnvironment | IO[bytes], **kwargs: Any) → LROPoller[ManagedEnvironment][source]

Creates or updates a Managed Environment.

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

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
environment_name (str) – Name of the Environment. Required.
environment_envelope (ManagedEnvironment or IO[bytes]) – Configuration details of the Environment. Is either a ManagedEnvironment type or a IO[bytes] type. Required.

Returns:

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

Return type:

Raises:

begin_delete(resource_group_name: str, environment_name: str, **kwargs: Any) → LROPoller[None][source]

Delete a Managed Environment.

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

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
environment_name (str) – Name of the Environment. Required.

Returns:

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

Return type:

LROPoller[None]

Raises:

LROPoller[ManagedEnvironment]

begin_update(resource_group_name: str, environment_name: str, environment_envelope: ManagedEnvironment | IO[bytes], **kwargs: Any) → LROPoller[ManagedEnvironment][source]

Update Managed Environment’s properties.

Patches a Managed Environment using JSON Merge Patch.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
environment_name (str) – Name of the Environment. Required.
environment_envelope (ManagedEnvironment or IO[bytes]) – Configuration details of the Environment. Is either a ManagedEnvironment type or a IO[bytes] type. Required.

Returns:

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

Return type:

Raises:

get(resource_group_name: str, environment_name: str, **kwargs: Any) → ManagedEnvironment[source]

Get the properties of a Managed Environment.

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

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
environment_name (str) – Name of the Environment. Required.

Returns:

ManagedEnvironment or the result of cls(response)

Return type:

ManagedEnvironment

Raises:

get_auth_token(resource_group_name: str, environment_name: str, **kwargs: Any) → EnvironmentAuthToken[source]

Get auth token for a managed environment.

Checks if resource name is available.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
environment_name (str) – Name of the Managed Environment. Required.

Returns:

EnvironmentAuthToken or the result of cls(response)

Return type:

EnvironmentAuthToken

Raises:

ItemPaged[WorkloadProfileStates]

list_by_resource_group(resource_group_name: str, **kwargs: Any) → Iterable[ManagedEnvironment][source]

Get all the Environments in a resource group.

Get all the Managed Environments in a resource group.

Parameters:: resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
Returns:: An iterator like instance of either ManagedEnvironment or the result of cls(response)
Return type:: ItemPaged[ManagedEnvironment]
Raises:: HttpResponseError –

list_by_subscription(**kwargs: Any) → Iterable[ManagedEnvironment][source]

Get all Environments for a subscription.

Get all Managed Environments for a subscription.

Returns:: An iterator like instance of either ManagedEnvironment or the result of cls(response)
Return type:: ItemPaged[ManagedEnvironment]
Raises:: HttpResponseError –

list_workload_profile_states(resource_group_name: str, environment_name: str, **kwargs: Any) → Iterable[WorkloadProfileStates][source]

Get all workload Profile States for a Managed Environment..

Get all workload Profile States for a Managed Environment.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
environment_name (str) – Name of the Managed Environment. Required.

Returns:

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

Return type:

Raises:

ManagedEnvironmentStorage

models = <module 'azure.mgmt.appcontainers.models' from '/mnt/vss/_work/1/s/sdk/appcontainers/azure-mgmt-appcontainers/.tox/sphinx/lib/python3.13/site-packages/azure/mgmt/appcontainers/models/__init__.py'>

class azure.mgmt.appcontainers.operations.ManagedEnvironmentsStoragesOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ContainerAppsAPIClient’s managed_environments_storages attribute.

create_or_update(resource_group_name: str, environment_name: str, storage_name: str, storage_envelope: ManagedEnvironmentStorage | IO[bytes], **kwargs: Any) → ManagedEnvironmentStorage[source]

Create or update storage for a managedEnvironment.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
environment_name (str) – Name of the Environment. Required.
storage_name (str) – Name of the storage. Required.
storage_envelope (ManagedEnvironmentStorage or IO[bytes]) – Configuration details of storage. Is either a ManagedEnvironmentStorage type or a IO[bytes] type. Required.

Returns:

ManagedEnvironmentStorage or the result of cls(response)

Return type:

Raises:

delete(resource_group_name: str, environment_name: str, storage_name: str, **kwargs: Any) → None[source]

Delete storage for a managedEnvironment.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
environment_name (str) – Name of the Environment. Required.
storage_name (str) – Name of the storage. Required.

Returns:

None or the result of cls(response)

Return type:

None

Raises:

ManagedEnvironmentStorage

get(resource_group_name: str, environment_name: str, storage_name: str, **kwargs: Any) → ManagedEnvironmentStorage[source]

Get storage for a managedEnvironment.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
environment_name (str) – Name of the Environment. Required.
storage_name (str) – Name of the storage. Required.

Returns:

ManagedEnvironmentStorage or the result of cls(response)

Return type:

Raises:

ManagedEnvironmentStoragesCollection

list(resource_group_name: str, environment_name: str, **kwargs: Any) → ManagedEnvironmentStoragesCollection[source]

Get all storages for a managedEnvironment.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
environment_name (str) – Name of the Environment. Required.

Returns:

ManagedEnvironmentStoragesCollection or the result of cls(response)

Return type:

Raises:

CheckNameAvailabilityResponse

models = <module 'azure.mgmt.appcontainers.models' from '/mnt/vss/_work/1/s/sdk/appcontainers/azure-mgmt-appcontainers/.tox/sphinx/lib/python3.13/site-packages/azure/mgmt/appcontainers/models/__init__.py'>

class azure.mgmt.appcontainers.operations.NamespacesOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ContainerAppsAPIClient’s namespaces attribute.

check_name_availability(resource_group_name: str, environment_name: str, check_name_availability_request: CheckNameAvailabilityRequest | IO[bytes], **kwargs: Any) → CheckNameAvailabilityResponse[source]

Checks the resource name availability.

Checks if resource name is available.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
environment_name (str) – Name of the Managed Environment. Required.
check_name_availability_request (CheckNameAvailabilityRequest or IO[bytes]) – The check name availability request. Is either a CheckNameAvailabilityRequest type or a IO[bytes] type. Required.

Returns:

CheckNameAvailabilityResponse or the result of cls(response)

Return type:

Raises: