Package version:

Interface ContainerApps

Interface representing a ContainerApps.

interface ContainerApps {
    beginCreateOrUpdate(resourceGroupName: string, containerAppName: string, containerAppEnvelope: ContainerApp, options?: ContainerAppsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<ContainerApp>, ContainerApp>>;
    beginCreateOrUpdateAndWait(resourceGroupName: string, containerAppName: string, containerAppEnvelope: ContainerApp, options?: ContainerAppsCreateOrUpdateOptionalParams): Promise<ContainerApp>;
    beginDelete(resourceGroupName: string, containerAppName: string, options?: ContainerAppsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>;
    beginDeleteAndWait(resourceGroupName: string, containerAppName: string, options?: ContainerAppsDeleteOptionalParams): Promise<void>;
    beginStart(resourceGroupName: string, containerAppName: string, options?: ContainerAppsStartOptionalParams): Promise<SimplePollerLike<OperationState<ContainerApp>, ContainerApp>>;
    beginStartAndWait(resourceGroupName: string, containerAppName: string, options?: ContainerAppsStartOptionalParams): Promise<ContainerApp>;
    beginStop(resourceGroupName: string, containerAppName: string, options?: ContainerAppsStopOptionalParams): Promise<SimplePollerLike<OperationState<ContainerApp>, ContainerApp>>;
    beginStopAndWait(resourceGroupName: string, containerAppName: string, options?: ContainerAppsStopOptionalParams): Promise<ContainerApp>;
    beginUpdate(resourceGroupName: string, containerAppName: string, containerAppEnvelope: ContainerApp, options?: ContainerAppsUpdateOptionalParams): Promise<SimplePollerLike<OperationState<ContainerApp>, ContainerApp>>;
    beginUpdateAndWait(resourceGroupName: string, containerAppName: string, containerAppEnvelope: ContainerApp, options?: ContainerAppsUpdateOptionalParams): Promise<ContainerApp>;
    get(resourceGroupName: string, containerAppName: string, options?: ContainerAppsGetOptionalParams): Promise<ContainerApp>;
    getAuthToken(resourceGroupName: string, containerAppName: string, options?: ContainerAppsGetAuthTokenOptionalParams): Promise<ContainerAppAuthToken>;
    listByResourceGroup(resourceGroupName: string, options?: ContainerAppsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<ContainerApp>;
    listBySubscription(options?: ContainerAppsListBySubscriptionOptionalParams): PagedAsyncIterableIterator<ContainerApp>;
    listCustomHostNameAnalysis(resourceGroupName: string, containerAppName: string, options?: ContainerAppsListCustomHostNameAnalysisOptionalParams): Promise<CustomHostnameAnalysisResult>;
    listSecrets(resourceGroupName: string, containerAppName: string, options?: ContainerAppsListSecretsOptionalParams): Promise<SecretsCollection>;
}

Index

Methods

beginCreateOrUpdate beginCreateOrUpdateAndWait beginDelete beginDeleteAndWait beginStart beginStartAndWait beginStop beginStopAndWait beginUpdate beginUpdateAndWait get getAuthToken listByResourceGroup listBySubscription listCustomHostNameAnalysis listSecrets

Methods

beginCreateOrUpdate

beginCreateOrUpdate(resourceGroupName, containerAppName, containerAppEnvelope, options?): Promise<SimplePollerLike<OperationState<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
- Optionaloptions: ContainerAppsCreateOrUpdateOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<ContainerApp>, ContainerApp>>
- Defined in operationsInterfaces/containerApps.ts:71

beginCreateOrUpdateAndWait

beginCreateOrUpdateAndWait(resourceGroupName, containerAppName, containerAppEnvelope, options?): 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
- Optionaloptions: ContainerAppsCreateOrUpdateOptionalParams
  The options parameters.
Returns Promise<ContainerApp>
- Defined in operationsInterfaces/containerApps.ts:89

beginDelete

beginDelete(resourceGroupName, containerAppName, options?): Promise<SimplePollerLike<OperationState<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.
- Optionaloptions: ContainerAppsDeleteOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<void>, void>>
- Defined in operationsInterfaces/containerApps.ts:101

beginDeleteAndWait

beginDeleteAndWait(resourceGroupName, containerAppName, options?): 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.
- Optionaloptions: ContainerAppsDeleteOptionalParams
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/containerApps.ts:112

beginStart

beginStart(resourceGroupName, containerAppName, options?): Promise<SimplePollerLike<OperationState<ContainerApp>, ContainerApp>>
Start a container app
Parameters
- resourceGroupName: string
  The name of the resource group. The name is case insensitive.
- containerAppName: string
  Name of the Container App.
- Optionaloptions: ContainerAppsStartOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<ContainerApp>, ContainerApp>>
- Defined in operationsInterfaces/containerApps.ts:187

beginStartAndWait

beginStartAndWait(resourceGroupName, containerAppName, options?): Promise<ContainerApp>
Start a container app
Parameters
- resourceGroupName: string
  The name of the resource group. The name is case insensitive.
- containerAppName: string
  Name of the Container App.
- Optionaloptions: ContainerAppsStartOptionalParams
  The options parameters.
Returns Promise<ContainerApp>
- Defined in operationsInterfaces/containerApps.ts:203

beginStop

beginStop(resourceGroupName, containerAppName, options?): Promise<SimplePollerLike<OperationState<ContainerApp>, ContainerApp>>
Stop a container app
Parameters
- resourceGroupName: string
  The name of the resource group. The name is case insensitive.
- containerAppName: string
  Name of the Container App.
- Optionaloptions: ContainerAppsStopOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<ContainerApp>, ContainerApp>>
- Defined in operationsInterfaces/containerApps.ts:214

beginStopAndWait

beginStopAndWait(resourceGroupName, containerAppName, options?): Promise<ContainerApp>
Stop a container app
Parameters
- resourceGroupName: string
  The name of the resource group. The name is case insensitive.
- containerAppName: string
  Name of the Container App.
- Optionaloptions: ContainerAppsStopOptionalParams
  The options parameters.
Returns Promise<ContainerApp>
- Defined in operationsInterfaces/containerApps.ts:230

beginUpdate

beginUpdate(resourceGroupName, containerAppName, containerAppEnvelope, options?): Promise<SimplePollerLike<OperationState<ContainerApp>, ContainerApp>>
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
- Optionaloptions: ContainerAppsUpdateOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<ContainerApp>, ContainerApp>>
- Defined in operationsInterfaces/containerApps.ts:124

beginUpdateAndWait

beginUpdateAndWait(resourceGroupName, containerAppName, containerAppEnvelope, options?): Promise<ContainerApp>
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
- Optionaloptions: ContainerAppsUpdateOptionalParams
  The options parameters.
Returns Promise<ContainerApp>
- Defined in operationsInterfaces/containerApps.ts:142

get

get(resourceGroupName, containerAppName, options?): 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.
- Optionaloptions: ContainerAppsGetOptionalParams
  The options parameters.
Returns Promise<ContainerApp>
- Defined in operationsInterfaces/containerApps.ts:59

getAuthToken

getAuthToken(resourceGroupName, containerAppName, options?): 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.
- Optionaloptions: ContainerAppsGetAuthTokenOptionalParams
  The options parameters.
Returns Promise<ContainerAppAuthToken>
- Defined in operationsInterfaces/containerApps.ts:176

listByResourceGroup

listByResourceGroup(resourceGroupName, options?): 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.
- Optionaloptions: ContainerAppsListByResourceGroupOptionalParams
  The options parameters.
Returns PagedAsyncIterableIterator<ContainerApp>
- Defined in operationsInterfaces/containerApps.ts:49

listBySubscription

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

listCustomHostNameAnalysis

listCustomHostNameAnalysis(resourceGroupName, containerAppName, options?): 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.
- Optionaloptions: ContainerAppsListCustomHostNameAnalysisOptionalParams
  The options parameters.
Returns Promise<CustomHostnameAnalysisResult>
- Defined in operationsInterfaces/containerApps.ts:154

listSecrets

listSecrets(resourceGroupName, containerAppName, options?): 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.
- Optionaloptions: ContainerAppsListSecretsOptionalParams
  The options parameters.
Returns Promise<SecretsCollection>
- Defined in operationsInterfaces/containerApps.ts:165

Interface ContainerApps

Index

Methods

Methods

beginCreateOrUpdate

Parameters

Returns Promise<SimplePollerLike<OperationState<ContainerApp>, ContainerApp>>

beginCreateOrUpdateAndWait

Parameters

Returns Promise<ContainerApp>

beginDelete

Parameters

Returns Promise<SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait

Parameters

Returns Promise<void>

beginStart

Parameters

Returns Promise<SimplePollerLike<OperationState<ContainerApp>, ContainerApp>>

beginStartAndWait

Parameters

Returns Promise<ContainerApp>

beginStop

Parameters

Returns Promise<SimplePollerLike<OperationState<ContainerApp>, ContainerApp>>

beginStopAndWait

Parameters

Returns Promise<ContainerApp>

beginUpdate

Parameters

Returns Promise<SimplePollerLike<OperationState<ContainerApp>, ContainerApp>>

beginUpdateAndWait

Parameters

Returns Promise<ContainerApp>

get

Parameters

Returns Promise<ContainerApp>

getAuthToken

Parameters

Returns Promise<ContainerAppAuthToken>

listByResourceGroup

Parameters

Returns PagedAsyncIterableIterator<ContainerApp>

listBySubscription

Parameters

Returns PagedAsyncIterableIterator<ContainerApp>

listCustomHostNameAnalysis

Parameters

Returns Promise<CustomHostnameAnalysisResult>

listSecrets

Parameters

Returns Promise<SecretsCollection>

Settings