ContainerApps interface
Interface representing a ContainerApps.
Methods
Method Details
beginCreateOrUpdate(string, string, ContainerApp, ContainerAppsCreateOrUpdateOptionalParams)
Description for Create or update a Container App.
function beginCreateOrUpdate(resourceGroupName: string, name: string, containerAppEnvelope: ContainerApp, options?: ContainerAppsCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<ContainerApp>, ContainerApp>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- name
-
string
Name of the Container App.
- containerAppEnvelope
- ContainerApp
Properties used to create a container app
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<ContainerApp>, ContainerApp>>
beginCreateOrUpdateAndWait(string, string, ContainerApp, ContainerAppsCreateOrUpdateOptionalParams)
Description for Create or update a Container App.
function beginCreateOrUpdateAndWait(resourceGroupName: string, name: string, containerAppEnvelope: ContainerApp, options?: ContainerAppsCreateOrUpdateOptionalParams): Promise<ContainerApp>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- name
-
string
Name of the Container App.
- containerAppEnvelope
- ContainerApp
Properties used to create a container app
The options parameters.
Returns
Promise<ContainerApp>
beginDelete(string, string, ContainerAppsDeleteOptionalParams)
Description for Delete a Container App.
function beginDelete(resourceGroupName: string, name: string, options?: ContainerAppsDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- name
-
string
Name of the Container App.
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginDeleteAndWait(string, string, ContainerAppsDeleteOptionalParams)
Description for Delete a Container App.
function beginDeleteAndWait(resourceGroupName: string, name: string, options?: ContainerAppsDeleteOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- name
-
string
Name of the Container App.
The options parameters.
Returns
Promise<void>
get(string, string, ContainerAppsGetOptionalParams)
Get the properties of a Container App.
function get(resourceGroupName: string, name: string, options?: ContainerAppsGetOptionalParams): Promise<ContainerApp>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- name
-
string
Name of the Container App.
- options
- ContainerAppsGetOptionalParams
The options parameters.
Returns
Promise<ContainerApp>
listByResourceGroup(string, ContainerAppsListByResourceGroupOptionalParams)
Get the Container Apps in a given resource group.
function listByResourceGroup(resourceGroupName: string, options?: ContainerAppsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<ContainerApp, ContainerApp[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
The options parameters.
Returns
listBySubscription(ContainerAppsListBySubscriptionOptionalParams)
Get the Container Apps in a given subscription.
function listBySubscription(options?: ContainerAppsListBySubscriptionOptionalParams): PagedAsyncIterableIterator<ContainerApp, ContainerApp[], PageSettings>Parameters
The options parameters.
Returns
listCustomHostNameAnalysis(string, string, ContainerAppsListCustomHostNameAnalysisOptionalParams)
Analyzes a custom hostname for a Container App
function listCustomHostNameAnalysis(resourceGroupName: string, containerAppName: string, options?: ContainerAppsListCustomHostNameAnalysisOptionalParams): Promise<CustomHostnameAnalysisResult>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- containerAppName
-
string
Name of the Container App.
The options parameters.
Returns
Promise<CustomHostnameAnalysisResult>
listSecrets(string, string, ContainerAppsListSecretsOptionalParams)
List secrets for a container app
function listSecrets(resourceGroupName: string, name: string, options?: ContainerAppsListSecretsOptionalParams): Promise<SecretsCollection>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- name
-
string
Name of the Container App.
The options parameters.
Returns
Promise<SecretsCollection>
update(string, string, ContainerAppPatch, ContainerAppsUpdateOptionalParams)
Patches a Container App. Currently only patching of tags is supported
function update(resourceGroupName: string, name: string, containerAppEnvelope: ContainerAppPatch, options?: ContainerAppsUpdateOptionalParams): Promise<ContainerApp>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- name
-
string
Name of the Container App.
- containerAppEnvelope
- ContainerAppPatch
Properties of a container app that need to be updated
The options parameters.
Returns
Promise<ContainerApp>
