Apps | @azure/arm-appplatform

Interface representing a Apps.

Hierarchy

Apps

Implemented by

AppsImpl

Index

Methods

beginCreateOrUpdate

beginCreateOrUpdate(resourceGroupName: string, serviceName: string, appName: string, appResource: AppResource, options?: AppsCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<AppsCreateOrUpdateResponse>, AppsCreateOrUpdateResponse>>

- Defined in operationsInterfaces/apps.ts:69
Create a new App or update an exiting App.

Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- serviceName: string
  
  The name of the Service resource.
- appName: string
  
  The name of the App resource.
- appResource: AppResource
  
  Parameters for the create or update operation
- Optional options: AppsCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<AppsCreateOrUpdateResponse>, AppsCreateOrUpdateResponse>>

beginCreateOrUpdateAndWait

beginCreateOrUpdateAndWait(resourceGroupName: string, serviceName: string, appName: string, appResource: AppResource, options?: AppsCreateOrUpdateOptionalParams): Promise<AppsCreateOrUpdateResponse>

- Defined in operationsInterfaces/apps.ts:90
Create a new App or update an exiting App.

Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- serviceName: string
  
  The name of the Service resource.
- appName: string
  
  The name of the App resource.
- appResource: AppResource
  
  Parameters for the create or update operation
- Optional options: AppsCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<AppsCreateOrUpdateResponse>

beginDelete

beginDelete(resourceGroupName: string, serviceName: string, appName: string, options?: AppsDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

- Defined in operationsInterfaces/apps.ts:105
Operation to delete an App.

Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- serviceName: string
  
  The name of the Service resource.
- appName: string
  
  The name of the App resource.
- Optional options: AppsDeleteOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteAndWait

beginDeleteAndWait(resourceGroupName: string, serviceName: string, appName: string, options?: AppsDeleteOptionalParams): Promise<void>

- Defined in operationsInterfaces/apps.ts:119
Operation to delete an App.

Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- serviceName: string
  
  The name of the Service resource.
- appName: string
  
  The name of the App resource.
- Optional options: AppsDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>

beginSetActiveDeployments

beginSetActiveDeployments(resourceGroupName: string, serviceName: string, appName: string, activeDeploymentCollection: ActiveDeploymentCollection, options?: AppsSetActiveDeploymentsOptionalParams): Promise<PollerLike<PollOperationState<AppsSetActiveDeploymentsResponse>, AppsSetActiveDeploymentsResponse>>

- Defined in operationsInterfaces/apps.ts:182
Set existing Deployment under the app as active

Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- serviceName: string
  
  The name of the Service resource.
- appName: string
  
  The name of the App resource.
- activeDeploymentCollection: ActiveDeploymentCollection
  
  A list of Deployment name to be active.
- Optional options: AppsSetActiveDeploymentsOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<AppsSetActiveDeploymentsResponse>, AppsSetActiveDeploymentsResponse>>

beginSetActiveDeploymentsAndWait

beginSetActiveDeploymentsAndWait(resourceGroupName: string, serviceName: string, appName: string, activeDeploymentCollection: ActiveDeploymentCollection, options?: AppsSetActiveDeploymentsOptionalParams): Promise<AppsSetActiveDeploymentsResponse>

- Defined in operationsInterfaces/apps.ts:203
Set existing Deployment under the app as active

Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- serviceName: string
  
  The name of the Service resource.
- appName: string
  
  The name of the App resource.
- activeDeploymentCollection: ActiveDeploymentCollection
  
  A list of Deployment name to be active.
- Optional options: AppsSetActiveDeploymentsOptionalParams
  
  The options parameters.
Returns Promise<AppsSetActiveDeploymentsResponse>

beginUpdate

beginUpdate(resourceGroupName: string, serviceName: string, appName: string, appResource: AppResource, options?: AppsUpdateOptionalParams): Promise<PollerLike<PollOperationState<AppsUpdateResponse>, AppsUpdateResponse>>

- Defined in operationsInterfaces/apps.ts:134
Operation to update an exiting App.

Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- serviceName: string
  
  The name of the Service resource.
- appName: string
  
  The name of the App resource.
- appResource: AppResource
  
  Parameters for the update operation
- Optional options: AppsUpdateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<AppsUpdateResponse>, AppsUpdateResponse>>

beginUpdateAndWait

beginUpdateAndWait(resourceGroupName: string, serviceName: string, appName: string, appResource: AppResource, options?: AppsUpdateOptionalParams): Promise<AppsUpdateResponse>

- Defined in operationsInterfaces/apps.ts:152
Operation to update an exiting App.

Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- serviceName: string
  
  The name of the Service resource.
- appName: string
  
  The name of the App resource.
- appResource: AppResource
  
  Parameters for the update operation
- Optional options: AppsUpdateOptionalParams
  
  The options parameters.
Returns Promise<AppsUpdateResponse>

get

get(resourceGroupName: string, serviceName: string, appName: string, options?: AppsGetOptionalParams): Promise<AppsGetResponse>

- Defined in operationsInterfaces/apps.ts:54
Get an App and its properties.

Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- serviceName: string
  
  The name of the Service resource.
- appName: string
  
  The name of the App resource.
- Optional options: AppsGetOptionalParams
  
  The options parameters.
Returns Promise<AppsGetResponse>

getResourceUploadUrl

getResourceUploadUrl(resourceGroupName: string, serviceName: string, appName: string, options?: AppsGetResourceUploadUrlOptionalParams): Promise<AppsGetResourceUploadUrlResponse>

- Defined in operationsInterfaces/apps.ts:167
Get an resource upload URL for an App, which may be artifacts or source archive.

Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- serviceName: string
  
  The name of the Service resource.
- appName: string
  
  The name of the App resource.
- Optional options: AppsGetResourceUploadUrlOptionalParams
  
  The options parameters.
Returns Promise<AppsGetResourceUploadUrlResponse>

list

list(resourceGroupName: string, serviceName: string, options?: AppsListOptionalParams): PagedAsyncIterableIterator<AppResource>

- Defined in operationsInterfaces/apps.ts:41
Handles requests to list all resources in a Service.

Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- serviceName: string
  
  The name of the Service resource.
- Optional options: AppsListOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<AppResource>

validateDomain

validateDomain(resourceGroupName: string, serviceName: string, appName: string, validatePayload: CustomDomainValidatePayload, options?: AppsValidateDomainOptionalParams): Promise<AppsValidateDomainResponse>

- Defined in operationsInterfaces/apps.ts:219
Check the resource name is valid as well as not in use.

Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- serviceName: string
  
  The name of the Service resource.
- appName: string
  
  The name of the App resource.
- validatePayload: CustomDomainValidatePayload
  
  Custom domain payload to be validated
- Optional options: AppsValidateDomainOptionalParams
  
  The options parameters.
Returns Promise<AppsValidateDomainResponse>

Hierarchy

Implemented by

Index

Methods

Methods

beginCreateOrUpdate

Parameters

resourceGroupName: string

serviceName: string

appName: string

appResource: AppResource

Optional options: AppsCreateOrUpdateOptionalParams

Returns Promise<PollerLike<PollOperationState<AppsCreateOrUpdateResponse>, AppsCreateOrUpdateResponse>>

beginCreateOrUpdateAndWait

Parameters

resourceGroupName: string

serviceName: string

appName: string

appResource: AppResource

Optional options: AppsCreateOrUpdateOptionalParams

Returns Promise<AppsCreateOrUpdateResponse>

beginDelete

Parameters

resourceGroupName: string

serviceName: string

appName: string

Optional options: AppsDeleteOptionalParams

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

beginDeleteAndWait

Parameters

resourceGroupName: string

serviceName: string

appName: string

Optional options: AppsDeleteOptionalParams

Returns Promise<void>

beginSetActiveDeployments

Parameters

resourceGroupName: string

serviceName: string

appName: string

activeDeploymentCollection: ActiveDeploymentCollection

Optional options: AppsSetActiveDeploymentsOptionalParams

Returns Promise<PollerLike<PollOperationState<AppsSetActiveDeploymentsResponse>, AppsSetActiveDeploymentsResponse>>

beginSetActiveDeploymentsAndWait

Parameters

resourceGroupName: string

serviceName: string

appName: string

activeDeploymentCollection: ActiveDeploymentCollection

Optional options: AppsSetActiveDeploymentsOptionalParams

Returns Promise<AppsSetActiveDeploymentsResponse>

beginUpdate

Parameters

resourceGroupName: string

serviceName: string

appName: string

appResource: AppResource

Optional options: AppsUpdateOptionalParams

Returns Promise<PollerLike<PollOperationState<AppsUpdateResponse>, AppsUpdateResponse>>

beginUpdateAndWait

Parameters

resourceGroupName: string

serviceName: string

appName: string

appResource: AppResource

Optional options: AppsUpdateOptionalParams

Returns Promise<AppsUpdateResponse>

get

Parameters

resourceGroupName: string

serviceName: string

appName: string

Optional options: AppsGetOptionalParams

Returns Promise<AppsGetResponse>

getResourceUploadUrl

Parameters

resourceGroupName: string

serviceName: string

appName: string

Optional options: AppsGetResourceUploadUrlOptionalParams