ContainerAppsOperations interface

Package:

@azure/arm-appcontainers

Interface representing a ContainerApps operations.

Properties

beginCreateOrUpdate
beginCreateOrUpdateAndWait
beginDelete
beginDeleteAndWait
beginStart
beginStartAndWait
beginStop
beginStopAndWait
beginUpdate
beginUpdateAndWait
createOrUpdate	Create or update a Container App.
delete	Delete a Container App.
get	Get the properties of a Container App.
getAuthToken	Get auth token for a container app
listByResourceGroup	Get the Container Apps in a given resource group.
listBySubscription	Get the Container Apps in a given subscription.
listCustomHostNameAnalysis	Analyzes a custom hostname for a Container App
listSecrets	List secrets for a container app
start	Start a container app
stop	Stop a container app
update	Patches a Container App using JSON Merge Patch

Property Details

beginCreateOrUpdate

Warning

This API is now deprecated.

use createOrUpdate instead

beginCreateOrUpdate: (resourceGroupName: string, containerAppName: string, containerAppEnvelope: ContainerApp, options?: ContainerAppsCreateOrUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<ContainerApp>, ContainerApp>>

Property Value

(resourceGroupName: string, containerAppName: string, containerAppEnvelope: ContainerApp, options?: ContainerAppsCreateOrUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<ContainerApp>, ContainerApp>>

beginCreateOrUpdateAndWait

Warning

This API is now deprecated.

use createOrUpdate instead

beginCreateOrUpdateAndWait: (resourceGroupName: string, containerAppName: string, containerAppEnvelope: ContainerApp, options?: ContainerAppsCreateOrUpdateOptionalParams) => Promise<ContainerApp>

Property Value

(resourceGroupName: string, containerAppName: string, containerAppEnvelope: ContainerApp, options?: ContainerAppsCreateOrUpdateOptionalParams) => Promise<ContainerApp>

beginDelete

Warning

This API is now deprecated.

use delete instead

beginDelete: (resourceGroupName: string, containerAppName: string, options?: ContainerAppsDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(resourceGroupName: string, containerAppName: string, options?: ContainerAppsDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait

Warning

This API is now deprecated.

use delete instead

beginDeleteAndWait: (resourceGroupName: string, containerAppName: string, options?: ContainerAppsDeleteOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, containerAppName: string, options?: ContainerAppsDeleteOptionalParams) => Promise<void>

beginStart

Warning

This API is now deprecated.

use start instead

beginStart: (resourceGroupName: string, containerAppName: string, options?: ContainerAppsStartOptionalParams) => Promise<SimplePollerLike<OperationState<ContainerApp>, ContainerApp>>

Property Value

(resourceGroupName: string, containerAppName: string, options?: ContainerAppsStartOptionalParams) => Promise<SimplePollerLike<OperationState<ContainerApp>, ContainerApp>>

beginStartAndWait

Warning

This API is now deprecated.

use start instead

beginStartAndWait: (resourceGroupName: string, containerAppName: string, options?: ContainerAppsStartOptionalParams) => Promise<ContainerApp>

Property Value

(resourceGroupName: string, containerAppName: string, options?: ContainerAppsStartOptionalParams) => Promise<ContainerApp>

beginStop

Warning

This API is now deprecated.

use stop instead

beginStop: (resourceGroupName: string, containerAppName: string, options?: ContainerAppsStopOptionalParams) => Promise<SimplePollerLike<OperationState<ContainerApp>, ContainerApp>>

Property Value

(resourceGroupName: string, containerAppName: string, options?: ContainerAppsStopOptionalParams) => Promise<SimplePollerLike<OperationState<ContainerApp>, ContainerApp>>

beginStopAndWait

Warning

This API is now deprecated.

use stop instead

beginStopAndWait: (resourceGroupName: string, containerAppName: string, options?: ContainerAppsStopOptionalParams) => Promise<ContainerApp>

Property Value

(resourceGroupName: string, containerAppName: string, options?: ContainerAppsStopOptionalParams) => Promise<ContainerApp>

beginUpdate

Warning

This API is now deprecated.

use update instead

beginUpdate: (resourceGroupName: string, containerAppName: string, containerAppEnvelope: ContainerApp, options?: ContainerAppsUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<ContainerApp>, ContainerApp>>

Property Value

(resourceGroupName: string, containerAppName: string, containerAppEnvelope: ContainerApp, options?: ContainerAppsUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<ContainerApp>, ContainerApp>>

beginUpdateAndWait

Warning

This API is now deprecated.

use update instead

beginUpdateAndWait: (resourceGroupName: string, containerAppName: string, containerAppEnvelope: ContainerApp, options?: ContainerAppsUpdateOptionalParams) => Promise<ContainerApp>

Property Value

(resourceGroupName: string, containerAppName: string, containerAppEnvelope: ContainerApp, options?: ContainerAppsUpdateOptionalParams) => Promise<ContainerApp>

createOrUpdate

Create or update a Container App.

createOrUpdate: (resourceGroupName: string, containerAppName: string, containerAppEnvelope: ContainerApp, options?: ContainerAppsCreateOrUpdateOptionalParams) => PollerLike<OperationState<ContainerApp>, ContainerApp>

Property Value

(resourceGroupName: string, containerAppName: string, containerAppEnvelope: ContainerApp, options?: ContainerAppsCreateOrUpdateOptionalParams) => PollerLike<OperationState<ContainerApp>, ContainerApp>

delete

Delete a Container App.

delete: (resourceGroupName: string, containerAppName: string, options?: ContainerAppsDeleteOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, containerAppName: string, options?: ContainerAppsDeleteOptionalParams) => PollerLike<OperationState<void>, void>

get

Get the properties of a Container App.

get: (resourceGroupName: string, containerAppName: string, options?: ContainerAppsGetOptionalParams) => Promise<ContainerApp>

Property Value

(resourceGroupName: string, containerAppName: string, options?: ContainerAppsGetOptionalParams) => Promise<ContainerApp>

getAuthToken

Get auth token for a container app

getAuthToken: (resourceGroupName: string, containerAppName: string, options?: ContainerAppsGetAuthTokenOptionalParams) => Promise<ContainerAppAuthToken>

Property Value

(resourceGroupName: string, containerAppName: string, options?: ContainerAppsGetAuthTokenOptionalParams) => Promise<ContainerAppAuthToken>

listByResourceGroup

Get the Container Apps in a given resource group.

listByResourceGroup: (resourceGroupName: string, options?: ContainerAppsListByResourceGroupOptionalParams) => PagedAsyncIterableIterator<ContainerApp, ContainerApp[], PageSettings>

Property Value

(resourceGroupName: string, options?: ContainerAppsListByResourceGroupOptionalParams) => PagedAsyncIterableIterator<ContainerApp, ContainerApp[], PageSettings>

listBySubscription

Get the Container Apps in a given subscription.

listBySubscription: (options?: ContainerAppsListBySubscriptionOptionalParams) => PagedAsyncIterableIterator<ContainerApp, ContainerApp[], PageSettings>

Property Value

(options?: ContainerAppsListBySubscriptionOptionalParams) => PagedAsyncIterableIterator<ContainerApp, ContainerApp[], PageSettings>

listCustomHostNameAnalysis

Analyzes a custom hostname for a Container App

listCustomHostNameAnalysis: (resourceGroupName: string, containerAppName: string, options?: ContainerAppsListCustomHostNameAnalysisOptionalParams) => Promise<CustomHostnameAnalysisResult>

Property Value

(resourceGroupName: string, containerAppName: string, options?: ContainerAppsListCustomHostNameAnalysisOptionalParams) => Promise<CustomHostnameAnalysisResult>

listSecrets

List secrets for a container app

listSecrets: (resourceGroupName: string, containerAppName: string, options?: ContainerAppsListSecretsOptionalParams) => Promise<SecretsCollection>

Property Value

(resourceGroupName: string, containerAppName: string, options?: ContainerAppsListSecretsOptionalParams) => Promise<SecretsCollection>

start

Start a container app

start: (resourceGroupName: string, containerAppName: string, options?: ContainerAppsStartOptionalParams) => PollerLike<OperationState<ContainerApp>, ContainerApp>

Property Value

(resourceGroupName: string, containerAppName: string, options?: ContainerAppsStartOptionalParams) => PollerLike<OperationState<ContainerApp>, ContainerApp>

stop

Stop a container app

stop: (resourceGroupName: string, containerAppName: string, options?: ContainerAppsStopOptionalParams) => PollerLike<OperationState<ContainerApp>, ContainerApp>

Property Value

(resourceGroupName: string, containerAppName: string, options?: ContainerAppsStopOptionalParams) => PollerLike<OperationState<ContainerApp>, ContainerApp>

update

Patches a Container App using JSON Merge Patch

update: (resourceGroupName: string, containerAppName: string, containerAppEnvelope: ContainerApp, options?: ContainerAppsUpdateOptionalParams) => PollerLike<OperationState<ContainerApp>, ContainerApp>

Property Value

(resourceGroupName: string, containerAppName: string, containerAppEnvelope: ContainerApp, options?: ContainerAppsUpdateOptionalParams) => PollerLike<OperationState<ContainerApp>, ContainerApp>