Package version:

Interface Apps

Interface representing a Apps.

Hierarchy

Apps

Index

Methods

beginCreateOrUpdate beginCreateOrUpdateAndWait beginDelete beginDeleteAndWait beginSetActiveDeployments beginSetActiveDeploymentsAndWait beginUpdate beginUpdateAndWait get getResourceUploadUrl list validateDomain

Methods

beginCreateOrUpdate

beginCreateOrUpdate(resourceGroupName: string, serviceName: string, appName: string, appResource: AppResource, options?: AppsCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<AppResource>, AppResource>>
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<AppResource>, AppResource>>
- Defined in operationsInterfaces/apps.ts:69

beginCreateOrUpdateAndWait

beginCreateOrUpdateAndWait(resourceGroupName: string, serviceName: string, appName: string, appResource: AppResource, options?: AppsCreateOrUpdateOptionalParams): Promise<AppResource>
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<AppResource>
- Defined in operationsInterfaces/apps.ts:90

beginDelete

beginDelete(resourceGroupName: string, serviceName: string, appName: string, options?: AppsDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>
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>>
- Defined in operationsInterfaces/apps.ts:105

beginDeleteAndWait

beginDeleteAndWait(resourceGroupName: string, serviceName: string, appName: string, options?: AppsDeleteOptionalParams): Promise<void>
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>
- Defined in operationsInterfaces/apps.ts:119

beginSetActiveDeployments

beginSetActiveDeployments(resourceGroupName: string, serviceName: string, appName: string, activeDeploymentCollection: ActiveDeploymentCollection, options?: AppsSetActiveDeploymentsOptionalParams): Promise<PollerLike<PollOperationState<AppResource>, AppResource>>
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<AppResource>, AppResource>>
- Defined in operationsInterfaces/apps.ts:182

beginSetActiveDeploymentsAndWait

beginSetActiveDeploymentsAndWait(resourceGroupName: string, serviceName: string, appName: string, activeDeploymentCollection: ActiveDeploymentCollection, options?: AppsSetActiveDeploymentsOptionalParams): Promise<AppResource>
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<AppResource>
- Defined in operationsInterfaces/apps.ts:203

beginUpdate

beginUpdate(resourceGroupName: string, serviceName: string, appName: string, appResource: AppResource, options?: AppsUpdateOptionalParams): Promise<PollerLike<PollOperationState<AppResource>, AppResource>>
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<AppResource>, AppResource>>
- Defined in operationsInterfaces/apps.ts:134

beginUpdateAndWait

beginUpdateAndWait(resourceGroupName: string, serviceName: string, appName: string, appResource: AppResource, options?: AppsUpdateOptionalParams): Promise<AppResource>
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<AppResource>
- Defined in operationsInterfaces/apps.ts:152

get

get(resourceGroupName: string, serviceName: string, appName: string, options?: AppsGetOptionalParams): Promise<AppResource>
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<AppResource>
- Defined in operationsInterfaces/apps.ts:54

getResourceUploadUrl

getResourceUploadUrl(resourceGroupName: string, serviceName: string, appName: string, options?: AppsGetResourceUploadUrlOptionalParams): Promise<ResourceUploadDefinition>
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<ResourceUploadDefinition>
- Defined in operationsInterfaces/apps.ts:167

list

list(resourceGroupName: string, serviceName: string, options?: AppsListOptionalParams): PagedAsyncIterableIterator<AppResource>
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>
- Defined in operationsInterfaces/apps.ts:41

validateDomain

validateDomain(resourceGroupName: string, serviceName: string, appName: string, validatePayload: CustomDomainValidatePayload, options?: AppsValidateDomainOptionalParams): Promise<CustomDomainValidateResult>
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<CustomDomainValidateResult>
- Defined in operationsInterfaces/apps.ts:219

Interface Apps

Hierarchy

Index

Methods

Methods

beginCreateOrUpdate

Parameters

resourceGroupName: string

serviceName: string

appName: string

appResource: AppResource

Optional options: AppsCreateOrUpdateOptionalParams

Returns Promise<PollerLike<PollOperationState<AppResource>, AppResource>>

beginCreateOrUpdateAndWait

Parameters

resourceGroupName: string

serviceName: string

appName: string

appResource: AppResource

Optional options: AppsCreateOrUpdateOptionalParams

Returns Promise<AppResource>

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<AppResource>, AppResource>>

beginSetActiveDeploymentsAndWait

Parameters

resourceGroupName: string

serviceName: string

appName: string

activeDeploymentCollection: ActiveDeploymentCollection

Optional options: AppsSetActiveDeploymentsOptionalParams

Returns Promise<AppResource>

beginUpdate

Parameters

resourceGroupName: string

serviceName: string

appName: string

appResource: AppResource

Optional options: AppsUpdateOptionalParams

Returns Promise<PollerLike<PollOperationState<AppResource>, AppResource>>

beginUpdateAndWait

Parameters

resourceGroupName: string

serviceName: string

appName: string

appResource: AppResource

Optional options: AppsUpdateOptionalParams

Returns Promise<AppResource>

get

Parameters

resourceGroupName: string

serviceName: string

appName: string

Optional options: AppsGetOptionalParams

Returns Promise<AppResource>

getResourceUploadUrl

Parameters

resourceGroupName: string

serviceName: string

appName: string

Optional options: AppsGetResourceUploadUrlOptionalParams

`Optional` options: AppsCreateOrUpdateOptionalParams

`Optional` options: AppsCreateOrUpdateOptionalParams

`Optional` options: AppsDeleteOptionalParams

`Optional` options: AppsDeleteOptionalParams

`Optional` options: AppsSetActiveDeploymentsOptionalParams

`Optional` options: AppsSetActiveDeploymentsOptionalParams

`Optional` options: AppsUpdateOptionalParams

`Optional` options: AppsUpdateOptionalParams

`Optional` options: AppsGetOptionalParams

`Optional` options: AppsGetResourceUploadUrlOptionalParams

`Optional` options: AppsListOptionalParams

`Optional` options: AppsValidateDomainOptionalParams