ContainerApps interface
Interface representing a ContainerApps.
Methods
Method Details
beginCreateOrUpdate(string, string, ContainerApp, ContainerAppsCreateOrUpdateOptionalParams)
Create or update a Container App.
function beginCreateOrUpdate(resourceGroupName: string, containerAppName: string, containerAppEnvelope: ContainerApp, options?: ContainerAppsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<ContainerApp>, ContainerApp>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- containerAppName
-
string
Name of the Container App.
- containerAppEnvelope
- ContainerApp
Properties used to create a container app
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<ContainerApp>, ContainerApp>>
beginCreateOrUpdateAndWait(string, string, ContainerApp, ContainerAppsCreateOrUpdateOptionalParams)
Create or update a Container App.
function beginCreateOrUpdateAndWait(resourceGroupName: string, containerAppName: string, containerAppEnvelope: ContainerApp, options?: ContainerAppsCreateOrUpdateOptionalParams): Promise<ContainerApp>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- containerAppName
-
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)
Delete a Container App.
function beginDelete(resourceGroupName: string, containerAppName: string, options?: ContainerAppsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>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<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginDeleteAndWait(string, string, ContainerAppsDeleteOptionalParams)
Delete a Container App.
function beginDeleteAndWait(resourceGroupName: string, containerAppName: string, options?: ContainerAppsDeleteOptionalParams): Promise<void>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<void>
beginStart(string, string, ContainerAppsStartOptionalParams)
Start a container app
function beginStart(resourceGroupName: string, containerAppName: string, options?: ContainerAppsStartOptionalParams): Promise<SimplePollerLike<OperationState<ContainerApp>, ContainerApp>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- containerAppName
-
string
Name of the Container App.
- options
- ContainerAppsStartOptionalParams
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<ContainerApp>, ContainerApp>>
beginStartAndWait(string, string, ContainerAppsStartOptionalParams)
Start a container app
function beginStartAndWait(resourceGroupName: string, containerAppName: string, options?: ContainerAppsStartOptionalParams): Promise<ContainerApp>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- containerAppName
-
string
Name of the Container App.
- options
- ContainerAppsStartOptionalParams
The options parameters.
Returns
Promise<ContainerApp>
beginStop(string, string, ContainerAppsStopOptionalParams)
Stop a container app
function beginStop(resourceGroupName: string, containerAppName: string, options?: ContainerAppsStopOptionalParams): Promise<SimplePollerLike<OperationState<ContainerApp>, ContainerApp>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- containerAppName
-
string
Name of the Container App.
- options
- ContainerAppsStopOptionalParams
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<ContainerApp>, ContainerApp>>
beginStopAndWait(string, string, ContainerAppsStopOptionalParams)
Stop a container app
function beginStopAndWait(resourceGroupName: string, containerAppName: string, options?: ContainerAppsStopOptionalParams): Promise<ContainerApp>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- containerAppName
-
string
Name of the Container App.
- options
- ContainerAppsStopOptionalParams
The options parameters.
Returns
Promise<ContainerApp>
beginUpdate(string, string, ContainerApp, ContainerAppsUpdateOptionalParams)
Patches a Container App using JSON Merge Patch
function beginUpdate(resourceGroupName: string, containerAppName: string, containerAppEnvelope: ContainerApp, options?: ContainerAppsUpdateOptionalParams): Promise<SimplePollerLike<OperationState<ContainerApp>, ContainerApp>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- containerAppName
-
string
Name of the Container App.
- containerAppEnvelope
- ContainerApp
Properties of a Container App that need to be updated
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<ContainerApp>, ContainerApp>>
beginUpdateAndWait(string, string, ContainerApp, ContainerAppsUpdateOptionalParams)
Patches a Container App using JSON Merge Patch
function beginUpdateAndWait(resourceGroupName: string, containerAppName: string, containerAppEnvelope: ContainerApp, options?: ContainerAppsUpdateOptionalParams): Promise<ContainerApp>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- containerAppName
-
string
Name of the Container App.
- containerAppEnvelope
- ContainerApp
Properties of a Container App that need to be updated
The options parameters.
Returns
Promise<ContainerApp>
get(string, string, ContainerAppsGetOptionalParams)
Get the properties of a Container App.
function get(resourceGroupName: string, containerAppName: string, options?: ContainerAppsGetOptionalParams): Promise<ContainerApp>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- containerAppName
-
string
Name of the Container App.
- options
- ContainerAppsGetOptionalParams
The options parameters.
Returns
Promise<ContainerApp>
getAuthToken(string, string, ContainerAppsGetAuthTokenOptionalParams)
Get auth token for a container app
function getAuthToken(resourceGroupName: string, containerAppName: string, options?: ContainerAppsGetAuthTokenOptionalParams): Promise<ContainerAppAuthToken>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<ContainerAppAuthToken>
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, containerAppName: string, options?: ContainerAppsListSecretsOptionalParams): Promise<SecretsCollection>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<SecretsCollection>