Package version:

Interface ContainerApps

Interface representing a ContainerApps.

Hierarchy

ContainerApps

Index

Methods

beginCreateOrUpdate beginCreateOrUpdateAndWait beginDelete beginDeleteAndWait beginUpdate beginUpdateAndWait get getAuthToken listByResourceGroup listBySubscription listCustomHostNameAnalysis listSecrets

Methods

beginCreateOrUpdate

beginCreateOrUpdate(resourceGroupName: string, containerAppName: string, containerAppEnvelope: ContainerApp, options?: ContainerAppsCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<ContainerApp>, ContainerApp>>
Create or update a Container App.
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
- Optional options: ContainerAppsCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<ContainerApp>, ContainerApp>>
- Defined in operationsInterfaces/containerApps.ts:66

beginCreateOrUpdateAndWait

beginCreateOrUpdateAndWait(resourceGroupName: string, containerAppName: string, containerAppEnvelope: ContainerApp, options?: ContainerAppsCreateOrUpdateOptionalParams): Promise<ContainerApp>
Create or update a Container App.
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
- Optional options: ContainerAppsCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<ContainerApp>
- Defined in operationsInterfaces/containerApps.ts:84

beginDelete

beginDelete(resourceGroupName: string, containerAppName: string, options?: ContainerAppsDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>
Delete a Container App.
Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- containerAppName: string
  
  Name of the Container App.
- Optional options: ContainerAppsDeleteOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>
- Defined in operationsInterfaces/containerApps.ts:96

beginDeleteAndWait

beginDeleteAndWait(resourceGroupName: string, containerAppName: string, options?: ContainerAppsDeleteOptionalParams): Promise<void>
Delete a Container App.
Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- containerAppName: string
  
  Name of the Container App.
- Optional options: ContainerAppsDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/containerApps.ts:107

beginUpdate

beginUpdate(resourceGroupName: string, containerAppName: string, containerAppEnvelope: ContainerApp, options?: ContainerAppsUpdateOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>
Patches a Container App using JSON Merge Patch
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
- Optional options: ContainerAppsUpdateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>
- Defined in operationsInterfaces/containerApps.ts:119

beginUpdateAndWait

beginUpdateAndWait(resourceGroupName: string, containerAppName: string, containerAppEnvelope: ContainerApp, options?: ContainerAppsUpdateOptionalParams): Promise<void>
Patches a Container App using JSON Merge Patch
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
- Optional options: ContainerAppsUpdateOptionalParams
  
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/containerApps.ts:132

get

get(resourceGroupName: string, containerAppName: string, options?: ContainerAppsGetOptionalParams): Promise<ContainerApp>
Get the properties of a Container App.
Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- containerAppName: string
  
  Name of the Container App.
- Optional options: ContainerAppsGetOptionalParams
  
  The options parameters.
Returns Promise<ContainerApp>
- Defined in operationsInterfaces/containerApps.ts:54

getAuthToken

getAuthToken(resourceGroupName: string, containerAppName: string, options?: ContainerAppsGetAuthTokenOptionalParams): Promise<ContainerAppAuthToken>
Get auth token for a container app
Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- containerAppName: string
  
  Name of the Container App.
- Optional options: ContainerAppsGetAuthTokenOptionalParams
  
  The options parameters.
Returns Promise<ContainerAppAuthToken>
- Defined in operationsInterfaces/containerApps.ts:166

listByResourceGroup

listByResourceGroup(resourceGroupName: string, options?: ContainerAppsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<ContainerApp>
Get the Container Apps in a given resource group.
Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- Optional options: ContainerAppsListByResourceGroupOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<ContainerApp>
- Defined in operationsInterfaces/containerApps.ts:44

listBySubscription

listBySubscription(options?: ContainerAppsListBySubscriptionOptionalParams): PagedAsyncIterableIterator<ContainerApp>
Get the Container Apps in a given subscription.
Parameters
- Optional options: ContainerAppsListBySubscriptionOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<ContainerApp>
- Defined in operationsInterfaces/containerApps.ts:36

listCustomHostNameAnalysis

listCustomHostNameAnalysis(resourceGroupName: string, containerAppName: string, options?: ContainerAppsListCustomHostNameAnalysisOptionalParams): Promise<CustomHostnameAnalysisResult>
Analyzes a custom hostname for a Container App
Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- containerAppName: string
  
  Name of the Container App.
- Optional options: ContainerAppsListCustomHostNameAnalysisOptionalParams
  
  The options parameters.
Returns Promise<CustomHostnameAnalysisResult>
- Defined in operationsInterfaces/containerApps.ts:144

listSecrets

listSecrets(resourceGroupName: string, containerAppName: string, options?: ContainerAppsListSecretsOptionalParams): Promise<SecretsCollection>
List secrets for a container app
Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- containerAppName: string
  
  Name of the Container App.
- Optional options: ContainerAppsListSecretsOptionalParams
  
  The options parameters.
Returns Promise<SecretsCollection>
- Defined in operationsInterfaces/containerApps.ts:155

Interface ContainerApps

Hierarchy

Index

Methods

Methods

beginCreateOrUpdate

Parameters

resourceGroupName: string

containerAppName: string

containerAppEnvelope: ContainerApp

Optional options: ContainerAppsCreateOrUpdateOptionalParams

Returns Promise<PollerLike<PollOperationState<ContainerApp>, ContainerApp>>

beginCreateOrUpdateAndWait

Parameters

resourceGroupName: string

containerAppName: string

containerAppEnvelope: ContainerApp

Optional options: ContainerAppsCreateOrUpdateOptionalParams

Returns Promise<ContainerApp>

beginDelete

Parameters

resourceGroupName: string

containerAppName: string

Optional options: ContainerAppsDeleteOptionalParams

Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteAndWait

Parameters

resourceGroupName: string

containerAppName: string

Optional options: ContainerAppsDeleteOptionalParams

Returns Promise<void>

beginUpdate

Parameters

resourceGroupName: string

containerAppName: string

containerAppEnvelope: ContainerApp

Optional options: ContainerAppsUpdateOptionalParams

Returns Promise<PollerLike<PollOperationState<void>, void>>

beginUpdateAndWait

Parameters

resourceGroupName: string

containerAppName: string

containerAppEnvelope: ContainerApp

Optional options: ContainerAppsUpdateOptionalParams

Returns Promise<void>

get

Parameters

resourceGroupName: string

containerAppName: string

Optional options: ContainerAppsGetOptionalParams

Returns Promise<ContainerApp>

getAuthToken

Parameters

resourceGroupName: string

containerAppName: string

Optional options: ContainerAppsGetAuthTokenOptionalParams

Returns Promise<ContainerAppAuthToken>

listByResourceGroup

Parameters

resourceGroupName: string

Optional options: ContainerAppsListByResourceGroupOptionalParams

Returns PagedAsyncIterableIterator<ContainerApp>

listBySubscription

Parameters

Optional options: ContainerAppsListBySubscriptionOptionalParams

Returns PagedAsyncIterableIterator<ContainerApp>

listCustomHostNameAnalysis

Parameters

resourceGroupName: string

containerAppName: string

Optional options: ContainerAppsListCustomHostNameAnalysisOptionalParams

Returns Promise<CustomHostnameAnalysisResult>

listSecrets

Parameters

resourceGroupName: string

containerAppName: string

Optional options: ContainerAppsListSecretsOptionalParams

Returns Promise<SecretsCollection>

Settings

Member Visibility

`Optional` options: ContainerAppsCreateOrUpdateOptionalParams

`Optional` options: ContainerAppsCreateOrUpdateOptionalParams

`Optional` options: ContainerAppsDeleteOptionalParams

`Optional` options: ContainerAppsDeleteOptionalParams

`Optional` options: ContainerAppsUpdateOptionalParams

`Optional` options: ContainerAppsUpdateOptionalParams

`Optional` options: ContainerAppsGetOptionalParams

`Optional` options: ContainerAppsGetAuthTokenOptionalParams

`Optional` options: ContainerAppsListByResourceGroupOptionalParams

`Optional` options: ContainerAppsListBySubscriptionOptionalParams

`Optional` options: ContainerAppsListCustomHostNameAnalysisOptionalParams

`Optional` options: ContainerAppsListSecretsOptionalParams