ContainerAppsOperations Class
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
<xref:container_apps> attribute.
- Inheritance
-
builtins.objectContainerAppsOperations
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
|
The name of the resource group. The name is case insensitive. Required. |
|
container_app_name
Required
|
Name of the Container App. Required. |
|
container_app_envelope
Required
|
Properties used to create a container app. Is either a ContainerApp type or a IO[bytes] type. Required. |
Returns
| Type | Description |
|---|---|
|
An instance of AsyncLROPoller that returns either ContainerApp or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
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
|
The name of the resource group. The name is case insensitive. Required. |
|
container_app_name
Required
|
Name of the Container App. Required. |
Returns
| Type | Description |
|---|---|
|
An instance of AsyncLROPoller that returns either None or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
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
|
The name of the resource group. The name is case insensitive. Required. |
|
container_app_name
Required
|
Name of the Container App. Required. |
Returns
| Type | Description |
|---|---|
|
An instance of AsyncLROPoller that returns either ContainerApp or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
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
|
The name of the resource group. The name is case insensitive. Required. |
|
container_app_name
Required
|
Name of the Container App. Required. |
Returns
| Type | Description |
|---|---|
|
An instance of AsyncLROPoller that returns either ContainerApp or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
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
|
The name of the resource group. The name is case insensitive. Required. |
|
container_app_name
Required
|
Name of the Container App. Required. |
|
container_app_envelope
Required
|
Properties of a Container App that need to be updated. Is either a ContainerApp type or a IO[bytes] type. Required. |
Returns
| Type | Description |
|---|---|
|
An instance of AsyncLROPoller that returns either ContainerApp or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
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) -> ContainerAppParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group. The name is case insensitive. Required. |
|
container_app_name
Required
|
Name of the Container App. Required. |
Returns
| Type | Description |
|---|---|
|
ContainerApp or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
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) -> ContainerAppAuthTokenParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group. The name is case insensitive. Required. |
|
container_app_name
Required
|
Name of the Container App. Required. |
Returns
| Type | Description |
|---|---|
|
ContainerAppAuthToken or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
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) -> AsyncIterable[ContainerApp]Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group. The name is case insensitive. Required. |
Returns
| Type | Description |
|---|---|
|
An iterator like instance of either ContainerApp or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
list_by_subscription
Get the Container Apps in a given subscription.
Get the Container Apps in a given subscription.
list_by_subscription(**kwargs: Any) -> AsyncIterable[ContainerApp]Returns
| Type | Description |
|---|---|
|
An iterator like instance of either ContainerApp or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
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) -> CustomHostnameAnalysisResultParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group. The name is case insensitive. Required. |
|
container_app_name
Required
|
Name of the Container App. Required. |
|
custom_hostname
Required
|
Custom hostname. Default value is None. |
Returns
| Type | Description |
|---|---|
|
CustomHostnameAnalysisResult or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
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) -> SecretsCollectionParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group. The name is case insensitive. Required. |
|
container_app_name
Required
|
Name of the Container App. Required. |
Returns
| Type | Description |
|---|---|
|
SecretsCollection 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'>
Azure SDK for Python