Apps interface
Interface representing a Apps.
Methods
Method Details
beginCreateOrUpdate(string, string, string, AppResource, AppsCreateOrUpdateOptionalParams)
Create a new App or update an exiting App.
function beginCreateOrUpdate(resourceGroupName: string, serviceName: string, appName: string, appResource: AppResource, options?: AppsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<AppResource>, AppResource>>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
- options
- AppsCreateOrUpdateOptionalParams
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<AppResource>, AppResource>>
beginCreateOrUpdateAndWait(string, string, string, AppResource, AppsCreateOrUpdateOptionalParams)
Create a new App or update an exiting App.
function beginCreateOrUpdateAndWait(resourceGroupName: string, serviceName: string, appName: string, appResource: AppResource, options?: AppsCreateOrUpdateOptionalParams): Promise<AppResource>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
- options
- AppsCreateOrUpdateOptionalParams
The options parameters.
Returns
Promise<AppResource>
beginDelete(string, string, string, AppsDeleteOptionalParams)
Operation to delete an App.
function beginDelete(resourceGroupName: string, serviceName: string, appName: string, options?: AppsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>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.
- options
- AppsDeleteOptionalParams
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginDeleteAndWait(string, string, string, AppsDeleteOptionalParams)
Operation to delete an App.
function beginDeleteAndWait(resourceGroupName: string, serviceName: string, appName: string, options?: AppsDeleteOptionalParams): Promise<void>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.
- options
- AppsDeleteOptionalParams
The options parameters.
Returns
Promise<void>
beginSetActiveDeployments(string, string, string, ActiveDeploymentCollection, AppsSetActiveDeploymentsOptionalParams)
Set existing Deployment under the app as active
function beginSetActiveDeployments(resourceGroupName: string, serviceName: string, appName: string, activeDeploymentCollection: ActiveDeploymentCollection, options?: AppsSetActiveDeploymentsOptionalParams): Promise<SimplePollerLike<OperationState<AppResource>, AppResource>>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.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<AppResource>, AppResource>>
beginSetActiveDeploymentsAndWait(string, string, string, ActiveDeploymentCollection, AppsSetActiveDeploymentsOptionalParams)
Set existing Deployment under the app as active
function beginSetActiveDeploymentsAndWait(resourceGroupName: string, serviceName: string, appName: string, activeDeploymentCollection: ActiveDeploymentCollection, options?: AppsSetActiveDeploymentsOptionalParams): Promise<AppResource>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.
The options parameters.
Returns
Promise<AppResource>
beginUpdate(string, string, string, AppResource, AppsUpdateOptionalParams)
Operation to update an exiting App.
function beginUpdate(resourceGroupName: string, serviceName: string, appName: string, appResource: AppResource, options?: AppsUpdateOptionalParams): Promise<SimplePollerLike<OperationState<AppResource>, AppResource>>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
- options
- AppsUpdateOptionalParams
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<AppResource>, AppResource>>
beginUpdateAndWait(string, string, string, AppResource, AppsUpdateOptionalParams)
Operation to update an exiting App.
function beginUpdateAndWait(resourceGroupName: string, serviceName: string, appName: string, appResource: AppResource, options?: AppsUpdateOptionalParams): Promise<AppResource>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
- options
- AppsUpdateOptionalParams
The options parameters.
Returns
Promise<AppResource>
get(string, string, string, AppsGetOptionalParams)
Get an App and its properties.
function get(resourceGroupName: string, serviceName: string, appName: string, options?: AppsGetOptionalParams): Promise<AppResource>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.
- options
- AppsGetOptionalParams
The options parameters.
Returns
Promise<AppResource>
getResourceUploadUrl(string, string, string, AppsGetResourceUploadUrlOptionalParams)
Get an resource upload URL for an App, which may be artifacts or source archive.
function getResourceUploadUrl(resourceGroupName: string, serviceName: string, appName: string, options?: AppsGetResourceUploadUrlOptionalParams): Promise<ResourceUploadDefinition>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.
The options parameters.
Returns
Promise<ResourceUploadDefinition>
list(string, string, AppsListOptionalParams)
Handles requests to list all resources in a Service.
function list(resourceGroupName: string, serviceName: string, options?: AppsListOptionalParams): PagedAsyncIterableIterator<AppResource, AppResource[], PageSettings>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.
- options
- AppsListOptionalParams
The options parameters.
Returns
validateDomain(string, string, string, CustomDomainValidatePayload, AppsValidateDomainOptionalParams)
Check the resource name is valid as well as not in use.
function validateDomain(resourceGroupName: string, serviceName: string, appName: string, validatePayload: CustomDomainValidatePayload, options?: AppsValidateDomainOptionalParams): Promise<CustomDomainValidateResult>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
- options
- AppsValidateDomainOptionalParams
The options parameters.
Returns
Promise<CustomDomainValidateResult>