Web Apps interface

createOrUpdateRelayServiceConnectionSlot(string, string, string, string, RelayServiceConnectionEntity, WebAppsCreateOrUpdateRelayServiceConnectionSlotOptionalParams)

Creates a new hybrid connection configuration (PUT), or updates an existing one (PATCH).

function createOrUpdateRelayServiceConnectionSlot(resourceGroupName: string, name: string, entityName: string, slot: string, connectionEnvelope: RelayServiceConnectionEntity, options?: WebAppsCreateOrUpdateRelayServiceConnectionSlotOptionalParams): Promise<RelayServiceConnectionEntity>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

entityName: string

Name of the hybrid connection configuration.

slot: string

Name of the deployment slot. If a slot is not specified, the API will create or update a hybrid connection for the production slot.

connectionEnvelope: RelayServiceConnectionEntity

Details of the hybrid connection configuration.

options: WebAppsCreateOrUpdateRelayServiceConnectionSlotOptionalParams

The options parameters.

Returns

createOrUpdateSwiftVirtualNetworkConnection(string, string, SwiftVirtualNetwork, WebAppsCreateOrUpdateSwiftVirtualNetworkConnectionOptionalParams)

Integrates this Web App with a Virtual Network. This requires that 1) "swiftSupported" is true when doing a GET against this resource, and 2) that the target Subnet has already been delegated, and is not in use by another App Service Plan other than the one this App is in.

function createOrUpdateSwiftVirtualNetworkConnection(resourceGroupName: string, name: string, connectionEnvelope: SwiftVirtualNetwork, options?: WebAppsCreateOrUpdateSwiftVirtualNetworkConnectionOptionalParams): Promise<SwiftVirtualNetwork>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

connectionEnvelope: SwiftVirtualNetwork

Properties of the Virtual Network connection. See example.

options: WebAppsCreateOrUpdateSwiftVirtualNetworkConnectionOptionalParams

The options parameters.

Returns

Promise<SwiftVirtualNetwork>

createOrUpdateSwiftVirtualNetworkConnectionSlot(string, string, string, SwiftVirtualNetwork, WebAppsCreateOrUpdateSwiftVirtualNetworkConnectionSlotOptionalParams)

function createOrUpdateSwiftVirtualNetworkConnectionSlot(resourceGroupName: string, name: string, slot: string, connectionEnvelope: SwiftVirtualNetwork, options?: WebAppsCreateOrUpdateSwiftVirtualNetworkConnectionSlotOptionalParams): Promise<SwiftVirtualNetwork>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

slot: string

Name of the deployment slot. If a slot is not specified, the API will add or update connections for the production slot.

connectionEnvelope: SwiftVirtualNetwork

Properties of the Virtual Network connection. See example.

options: WebAppsCreateOrUpdateSwiftVirtualNetworkConnectionSlotOptionalParams

The options parameters.

Returns

Promise<SwiftVirtualNetwork>

createOrUpdateVnetConnection(string, string, string, VnetInfo, WebAppsCreateOrUpdateVnetConnectionOptionalParams)

Adds a Virtual Network connection to an app or slot (PUT) or updates the connection properties (PATCH).

function createOrUpdateVnetConnection(resourceGroupName: string, name: string, vnetName: string, connectionEnvelope: VnetInfo, options?: WebAppsCreateOrUpdateVnetConnectionOptionalParams): Promise<VnetInfo>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

vnetName: string

Name of an existing Virtual Network.

connectionEnvelope: VnetInfo

Properties of the Virtual Network connection. See example.

options: WebAppsCreateOrUpdateVnetConnectionOptionalParams

The options parameters.

Returns

Promise<VnetInfo>

createOrUpdateVnetConnectionGateway(string, string, string, string, VnetGateway, WebAppsCreateOrUpdateVnetConnectionGatewayOptionalParams)

Adds a gateway to a connected Virtual Network (PUT) or updates it (PATCH).

function createOrUpdateVnetConnectionGateway(resourceGroupName: string, name: string, vnetName: string, gatewayName: string, connectionEnvelope: VnetGateway, options?: WebAppsCreateOrUpdateVnetConnectionGatewayOptionalParams): Promise<VnetGateway>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

vnetName: string

Name of the Virtual Network.

gatewayName: string

Name of the gateway. Currently, the only supported string is "primary".

connectionEnvelope: VnetGateway

The properties to update this gateway with.

options: WebAppsCreateOrUpdateVnetConnectionGatewayOptionalParams

The options parameters.

Returns

Promise<VnetGateway>

createOrUpdateVnetConnectionGatewaySlot(string, string, string, string, string, VnetGateway, WebAppsCreateOrUpdateVnetConnectionGatewaySlotOptionalParams)

Adds a gateway to a connected Virtual Network (PUT) or updates it (PATCH).

function createOrUpdateVnetConnectionGatewaySlot(resourceGroupName: string, name: string, vnetName: string, gatewayName: string, slot: string, connectionEnvelope: VnetGateway, options?: WebAppsCreateOrUpdateVnetConnectionGatewaySlotOptionalParams): Promise<VnetGateway>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

vnetName: string

Name of the Virtual Network.

gatewayName: string

Name of the gateway. Currently, the only supported string is "primary".

slot: string

Name of the deployment slot. If a slot is not specified, the API will add or update a gateway for the production slot's Virtual Network.

connectionEnvelope: VnetGateway

The properties to update this gateway with.

options: WebAppsCreateOrUpdateVnetConnectionGatewaySlotOptionalParams

The options parameters.

Returns

Promise<VnetGateway>

createOrUpdateVnetConnectionSlot(string, string, string, string, VnetInfo, WebAppsCreateOrUpdateVnetConnectionSlotOptionalParams)

Adds a Virtual Network connection to an app or slot (PUT) or updates the connection properties (PATCH).

function createOrUpdateVnetConnectionSlot(resourceGroupName: string, name: string, vnetName: string, slot: string, connectionEnvelope: VnetInfo, options?: WebAppsCreateOrUpdateVnetConnectionSlotOptionalParams): Promise<VnetInfo>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

vnetName: string

Name of an existing Virtual Network.

slot: string

Name of the deployment slot. If a slot is not specified, the API will add or update connections for the production slot.

connectionEnvelope: VnetInfo

Properties of the Virtual Network connection. See example.

options: WebAppsCreateOrUpdateVnetConnectionSlotOptionalParams

The options parameters.

Returns

Promise<VnetInfo>

delete(string, string, WebAppsDeleteOptionalParams)

Deletes a web, mobile, or API app, or one of the deployment slots.

function delete(resourceGroupName: string, name: string, options?: WebAppsDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app to delete.

options: WebAppsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

deleteBackup(string, string, string, WebAppsDeleteBackupOptionalParams)

Deletes a backup of an app by its ID.

function deleteBackup(resourceGroupName: string, name: string, backupId: string, options?: WebAppsDeleteBackupOptionalParams): Promise<void>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

backupId: string

ID of the backup.

options: WebAppsDeleteBackupOptionalParams

The options parameters.

Returns

Promise<void>

deleteBackupConfiguration(string, string, WebAppsDeleteBackupConfigurationOptionalParams)

Deletes the backup configuration of an app.

function deleteBackupConfiguration(resourceGroupName: string, name: string, options?: WebAppsDeleteBackupConfigurationOptionalParams): Promise<void>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

options: WebAppsDeleteBackupConfigurationOptionalParams

The options parameters.

Returns

Promise<void>

deleteBackupConfigurationSlot(string, string, string, WebAppsDeleteBackupConfigurationSlotOptionalParams)

Deletes the backup configuration of an app.

function deleteBackupConfigurationSlot(resourceGroupName: string, name: string, slot: string, options?: WebAppsDeleteBackupConfigurationSlotOptionalParams): Promise<void>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

slot: string

Name of the deployment slot. If a slot is not specified, the API will delete the backup configuration for the production slot.

options: WebAppsDeleteBackupConfigurationSlotOptionalParams

The options parameters.

Returns

Promise<void>

deleteBackupSlot(string, string, string, string, WebAppsDeleteBackupSlotOptionalParams)

Deletes a backup of an app by its ID.

function deleteBackupSlot(resourceGroupName: string, name: string, backupId: string, slot: string, options?: WebAppsDeleteBackupSlotOptionalParams): Promise<void>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

backupId: string

ID of the backup.

slot: string

Name of the deployment slot. If a slot is not specified, the API will delete a backup of the production slot.

options: WebAppsDeleteBackupSlotOptionalParams

The options parameters.

Returns

Promise<void>

deleteContinuousWebJob(string, string, string, WebAppsDeleteContinuousWebJobOptionalParams)

Delete a continuous web job by its ID for an app, or a deployment slot.

function deleteContinuousWebJob(resourceGroupName: string, name: string, webJobName: string, options?: WebAppsDeleteContinuousWebJobOptionalParams): Promise<void>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Site name.

webJobName: string

Name of Web Job.

options: WebAppsDeleteContinuousWebJobOptionalParams

The options parameters.

Returns

Promise<void>

deleteContinuousWebJobSlot(string, string, string, string, WebAppsDeleteContinuousWebJobSlotOptionalParams)

Delete a continuous web job by its ID for an app, or a deployment slot.

function deleteContinuousWebJobSlot(resourceGroupName: string, name: string, webJobName: string, slot: string, options?: WebAppsDeleteContinuousWebJobSlotOptionalParams): Promise<void>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Site name.

webJobName: string

Name of Web Job.

slot: string

Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.

options: WebAppsDeleteContinuousWebJobSlotOptionalParams

The options parameters.

Returns

Promise<void>

deleteDeployment(string, string, string, WebAppsDeleteDeploymentOptionalParams)

Delete a deployment by its ID for an app, or a deployment slot.

function deleteDeployment(resourceGroupName: string, name: string, id: string, options?: WebAppsDeleteDeploymentOptionalParams): Promise<void>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

id: string

Deployment ID.

options: WebAppsDeleteDeploymentOptionalParams

The options parameters.

Returns

Promise<void>

deleteDeploymentSlot(string, string, string, string, WebAppsDeleteDeploymentSlotOptionalParams)

Delete a deployment by its ID for an app, or a deployment slot.

function deleteDeploymentSlot(resourceGroupName: string, name: string, id: string, slot: string, options?: WebAppsDeleteDeploymentSlotOptionalParams): Promise<void>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

id: string

Deployment ID.

slot: string

Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.

options: WebAppsDeleteDeploymentSlotOptionalParams

The options parameters.

Returns

Promise<void>

deleteDomainOwnershipIdentifier(string, string, string, WebAppsDeleteDomainOwnershipIdentifierOptionalParams)

Deletes a domain ownership identifier for a web app.

function deleteDomainOwnershipIdentifier(resourceGroupName: string, name: string, domainOwnershipIdentifierName: string, options?: WebAppsDeleteDomainOwnershipIdentifierOptionalParams): Promise<void>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

domainOwnershipIdentifierName: string

Name of domain ownership identifier.

options: WebAppsDeleteDomainOwnershipIdentifierOptionalParams

The options parameters.

Returns

Promise<void>

deleteDomainOwnershipIdentifierSlot(string, string, string, string, WebAppsDeleteDomainOwnershipIdentifierSlotOptionalParams)

Deletes a domain ownership identifier for a web app.

function deleteDomainOwnershipIdentifierSlot(resourceGroupName: string, name: string, domainOwnershipIdentifierName: string, slot: string, options?: WebAppsDeleteDomainOwnershipIdentifierSlotOptionalParams): Promise<void>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

domainOwnershipIdentifierName: string

Name of domain ownership identifier.

slot: string

Name of the deployment slot. If a slot is not specified, the API will delete the binding for the production slot.

options: WebAppsDeleteDomainOwnershipIdentifierSlotOptionalParams

The options parameters.

Returns

Promise<void>

deleteFunction(string, string, string, WebAppsDeleteFunctionOptionalParams)

Delete a function for web site, or a deployment slot.

function deleteFunction(resourceGroupName: string, name: string, functionName: string, options?: WebAppsDeleteFunctionOptionalParams): Promise<void>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Site name.

functionName: string

Function name.

options: WebAppsDeleteFunctionOptionalParams

The options parameters.

Returns

Promise<void>

deleteFunctionSecret(string, string, string, string, WebAppsDeleteFunctionSecretOptionalParams)

Delete a function secret.

function deleteFunctionSecret(resourceGroupName: string, name: string, functionName: string, keyName: string, options?: WebAppsDeleteFunctionSecretOptionalParams): Promise<void>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Site name.

functionName: string

The name of the function.

keyName: string

The name of the key.

options: WebAppsDeleteFunctionSecretOptionalParams

The options parameters.

Returns

Promise<void>

deleteFunctionSecretSlot(string, string, string, string, string, WebAppsDeleteFunctionSecretSlotOptionalParams)

Delete a function secret.

function deleteFunctionSecretSlot(resourceGroupName: string, name: string, functionName: string, keyName: string, slot: string, options?: WebAppsDeleteFunctionSecretSlotOptionalParams): Promise<void>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Site name.

functionName: string

The name of the function.

keyName: string

The name of the key.

slot: string

Name of the deployment slot.

options: WebAppsDeleteFunctionSecretSlotOptionalParams

The options parameters.

Returns

Promise<void>

deleteHostNameBinding(string, string, string, WebAppsDeleteHostNameBindingOptionalParams)

Deletes a hostname binding for an app.

function deleteHostNameBinding(resourceGroupName: string, name: string, hostName: string, options?: WebAppsDeleteHostNameBindingOptionalParams): Promise<void>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

hostName: string

Hostname in the hostname binding.

options: WebAppsDeleteHostNameBindingOptionalParams

The options parameters.

Returns

Promise<void>

deleteHostNameBindingSlot(string, string, string, string, WebAppsDeleteHostNameBindingSlotOptionalParams)

Deletes a hostname binding for an app.

function deleteHostNameBindingSlot(resourceGroupName: string, name: string, slot: string, hostName: string, options?: WebAppsDeleteHostNameBindingSlotOptionalParams): Promise<void>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

slot: string

Name of the deployment slot. If a slot is not specified, the API will delete the binding for the production slot.

hostName: string

Hostname in the hostname binding.

options: WebAppsDeleteHostNameBindingSlotOptionalParams

The options parameters.

Returns

Promise<void>

deleteHostSecret(string, string, string, string, WebAppsDeleteHostSecretOptionalParams)

Delete a host level secret.

function deleteHostSecret(resourceGroupName: string, name: string, keyType: string, keyName: string, options?: WebAppsDeleteHostSecretOptionalParams): Promise<void>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Site name.

keyType: string

The type of host key.

keyName: string

The name of the key.

options: WebAppsDeleteHostSecretOptionalParams

The options parameters.

Returns

Promise<void>

deleteHostSecretSlot(string, string, string, string, string, WebAppsDeleteHostSecretSlotOptionalParams)

Delete a host level secret.

function deleteHostSecretSlot(resourceGroupName: string, name: string, keyType: string, keyName: string, slot: string, options?: WebAppsDeleteHostSecretSlotOptionalParams): Promise<void>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Site name.

keyType: string

The type of host key.

keyName: string

The name of the key.

slot: string

Name of the deployment slot.

options: WebAppsDeleteHostSecretSlotOptionalParams

The options parameters.

Returns

Promise<void>

deleteHybridConnection(string, string, string, string, WebAppsDeleteHybridConnectionOptionalParams)

Removes a Hybrid Connection from this site.

function deleteHybridConnection(resourceGroupName: string, name: string, namespaceName: string, relayName: string, options?: WebAppsDeleteHybridConnectionOptionalParams): Promise<void>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

The name of the web app.

namespaceName: string

The namespace for this hybrid connection.

relayName: string

The relay name for this hybrid connection.

options: WebAppsDeleteHybridConnectionOptionalParams

The options parameters.

Returns

Promise<void>

deleteHybridConnectionSlot(string, string, string, string, string, WebAppsDeleteHybridConnectionSlotOptionalParams)

Removes a Hybrid Connection from this site.

function deleteHybridConnectionSlot(resourceGroupName: string, name: string, namespaceName: string, relayName: string, slot: string, options?: WebAppsDeleteHybridConnectionSlotOptionalParams): Promise<void>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

The name of the web app.

namespaceName: string

The namespace for this hybrid connection.

relayName: string

The relay name for this hybrid connection.

slot: string

The name of the slot for the web app.

options: WebAppsDeleteHybridConnectionSlotOptionalParams

The options parameters.

Returns

Promise<void>

deleteInstanceFunctionSlot(string, string, string, string, WebAppsDeleteInstanceFunctionSlotOptionalParams)

Delete a function for web site, or a deployment slot.

function deleteInstanceFunctionSlot(resourceGroupName: string, name: string, functionName: string, slot: string, options?: WebAppsDeleteInstanceFunctionSlotOptionalParams): Promise<void>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Site name.

functionName: string

Function name.

slot: string

Name of the deployment slot.

options: WebAppsDeleteInstanceFunctionSlotOptionalParams

The options parameters.

Returns

Promise<void>

deleteInstanceProcess(string, string, string, string, WebAppsDeleteInstanceProcessOptionalParams)

Terminate a process by its ID for a web site, or a deployment slot, or specific scaled-out instance in a web site.

function deleteInstanceProcess(resourceGroupName: string, name: string, processId: string, instanceId: string, options?: WebAppsDeleteInstanceProcessOptionalParams): Promise<void>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Site name.

processId: string

PID.

instanceId: string

ID of a specific scaled-out instance. This is the value of the name property in the JSON response from "GET api/sites/{siteName}/instances".

options: WebAppsDeleteInstanceProcessOptionalParams

The options parameters.

Returns

Promise<void>

deleteInstanceProcessSlot(string, string, string, string, string, WebAppsDeleteInstanceProcessSlotOptionalParams)

Terminate a process by its ID for a web site, or a deployment slot, or specific scaled-out instance in a web site.

function deleteInstanceProcessSlot(resourceGroupName: string, name: string, processId: string, slot: string, instanceId: string, options?: WebAppsDeleteInstanceProcessSlotOptionalParams): Promise<void>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Site name.

processId: string

PID.

slot: string

Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.

instanceId: string

ID of a specific scaled-out instance. This is the value of the name property in the JSON response from "GET api/sites/{siteName}/instances".

options: WebAppsDeleteInstanceProcessSlotOptionalParams

The options parameters.

Returns

Promise<void>

deletePremierAddOn(string, string, string, WebAppsDeletePremierAddOnOptionalParams)

Delete a premier add-on from an app.

function deletePremierAddOn(resourceGroupName: string, name: string, premierAddOnName: string, options?: WebAppsDeletePremierAddOnOptionalParams): Promise<void>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

premierAddOnName: string

Add-on name.

options: WebAppsDeletePremierAddOnOptionalParams

The options parameters.

Returns

Promise<void>

deletePremierAddOnSlot(string, string, string, string, WebAppsDeletePremierAddOnSlotOptionalParams)

Delete a premier add-on from an app.

function deletePremierAddOnSlot(resourceGroupName: string, name: string, premierAddOnName: string, slot: string, options?: WebAppsDeletePremierAddOnSlotOptionalParams): Promise<void>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

premierAddOnName: string

Add-on name.

slot: string

Name of the deployment slot. If a slot is not specified, the API will delete the named add-on for the production slot.

options: WebAppsDeletePremierAddOnSlotOptionalParams

The options parameters.

Returns

Promise<void>

deleteProcess(string, string, string, WebAppsDeleteProcessOptionalParams)

Terminate a process by its ID for a web site, or a deployment slot, or specific scaled-out instance in a web site.

function deleteProcess(resourceGroupName: string, name: string, processId: string, options?: WebAppsDeleteProcessOptionalParams): Promise<void>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Site name.

processId: string

PID.

options: WebAppsDeleteProcessOptionalParams

The options parameters.

Returns

Promise<void>

deleteProcessSlot(string, string, string, string, WebAppsDeleteProcessSlotOptionalParams)

Terminate a process by its ID for a web site, or a deployment slot, or specific scaled-out instance in a web site.

function deleteProcessSlot(resourceGroupName: string, name: string, processId: string, slot: string, options?: WebAppsDeleteProcessSlotOptionalParams): Promise<void>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Site name.

processId: string

PID.

slot: string

Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.

options: WebAppsDeleteProcessSlotOptionalParams

The options parameters.

Returns

Promise<void>

deletePublicCertificate(string, string, string, WebAppsDeletePublicCertificateOptionalParams)

Deletes a hostname binding for an app.

function deletePublicCertificate(resourceGroupName: string, name: string, publicCertificateName: string, options?: WebAppsDeletePublicCertificateOptionalParams): Promise<void>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

publicCertificateName: string

Public certificate name.

options: WebAppsDeletePublicCertificateOptionalParams

The options parameters.

Returns

Promise<void>

deletePublicCertificateSlot(string, string, string, string, WebAppsDeletePublicCertificateSlotOptionalParams)

Deletes a hostname binding for an app.

function deletePublicCertificateSlot(resourceGroupName: string, name: string, slot: string, publicCertificateName: string, options?: WebAppsDeletePublicCertificateSlotOptionalParams): Promise<void>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

slot: string

Name of the deployment slot. If a slot is not specified, the API will delete the binding for the production slot.

publicCertificateName: string

Public certificate name.

options: WebAppsDeletePublicCertificateSlotOptionalParams

The options parameters.

Returns

Promise<void>

deleteRelayServiceConnection(string, string, string, WebAppsDeleteRelayServiceConnectionOptionalParams)

Deletes a relay service connection by its name.

function deleteRelayServiceConnection(resourceGroupName: string, name: string, entityName: string, options?: WebAppsDeleteRelayServiceConnectionOptionalParams): Promise<void>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

entityName: string

Name of the hybrid connection configuration.

options: WebAppsDeleteRelayServiceConnectionOptionalParams

The options parameters.

Returns

Promise<void>

deleteRelayServiceConnectionSlot(string, string, string, string, WebAppsDeleteRelayServiceConnectionSlotOptionalParams)

Deletes a relay service connection by its name.

function deleteRelayServiceConnectionSlot(resourceGroupName: string, name: string, entityName: string, slot: string, options?: WebAppsDeleteRelayServiceConnectionSlotOptionalParams): Promise<void>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

entityName: string

Name of the hybrid connection configuration.

slot: string

Name of the deployment slot. If a slot is not specified, the API will delete a hybrid connection for the production slot.

options: WebAppsDeleteRelayServiceConnectionSlotOptionalParams

The options parameters.

Returns

Promise<void>

deleteSiteExtension(string, string, string, WebAppsDeleteSiteExtensionOptionalParams)

Remove a site extension from a web site, or a deployment slot.

function deleteSiteExtension(resourceGroupName: string, name: string, siteExtensionId: string, options?: WebAppsDeleteSiteExtensionOptionalParams): Promise<void>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Site name.

siteExtensionId: string

Site extension name.

options: WebAppsDeleteSiteExtensionOptionalParams

The options parameters.

Returns

Promise<void>

deleteSiteExtensionSlot(string, string, string, string, WebAppsDeleteSiteExtensionSlotOptionalParams)

Remove a site extension from a web site, or a deployment slot.

function deleteSiteExtensionSlot(resourceGroupName: string, name: string, siteExtensionId: string, slot: string, options?: WebAppsDeleteSiteExtensionSlotOptionalParams): Promise<void>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Site name.

siteExtensionId: string

Site extension name.

slot: string

Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.

options: WebAppsDeleteSiteExtensionSlotOptionalParams

The options parameters.

Returns

Promise<void>

deleteSlot(string, string, string, WebAppsDeleteSlotOptionalParams)

Deletes a web, mobile, or API app, or one of the deployment slots.

function deleteSlot(resourceGroupName: string, name: string, slot: string, options?: WebAppsDeleteSlotOptionalParams): Promise<void>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app to delete.

slot: string

Name of the deployment slot to delete. By default, the API deletes the production slot.

options: WebAppsDeleteSlotOptionalParams

The options parameters.

Returns

Promise<void>

deleteSourceControl(string, string, WebAppsDeleteSourceControlOptionalParams)

Deletes the source control configuration of an app.

function deleteSourceControl(resourceGroupName: string, name: string, options?: WebAppsDeleteSourceControlOptionalParams): Promise<void>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

options: WebAppsDeleteSourceControlOptionalParams

The options parameters.

Returns

Promise<void>

deleteSourceControlSlot(string, string, string, WebAppsDeleteSourceControlSlotOptionalParams)

Deletes the source control configuration of an app.

function deleteSourceControlSlot(resourceGroupName: string, name: string, slot: string, options?: WebAppsDeleteSourceControlSlotOptionalParams): Promise<void>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

slot: string

Name of the deployment slot. If a slot is not specified, the API will delete the source control configuration for the production slot.

options: WebAppsDeleteSourceControlSlotOptionalParams

The options parameters.

Returns

Promise<void>

deleteSwiftVirtualNetwork(string, string, WebAppsDeleteSwiftVirtualNetworkOptionalParams)

Deletes a Swift Virtual Network connection from an app (or deployment slot).

function deleteSwiftVirtualNetwork(resourceGroupName: string, name: string, options?: WebAppsDeleteSwiftVirtualNetworkOptionalParams): Promise<void>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

options: WebAppsDeleteSwiftVirtualNetworkOptionalParams

The options parameters.

Returns

Promise<void>

deleteSwiftVirtualNetworkSlot(string, string, string, WebAppsDeleteSwiftVirtualNetworkSlotOptionalParams)

Deletes a Swift Virtual Network connection from an app (or deployment slot).

function deleteSwiftVirtualNetworkSlot(resourceGroupName: string, name: string, slot: string, options?: WebAppsDeleteSwiftVirtualNetworkSlotOptionalParams): Promise<void>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

slot: string

Name of the deployment slot. If a slot is not specified, the API will delete the connection for the production slot.

options: WebAppsDeleteSwiftVirtualNetworkSlotOptionalParams

The options parameters.

Returns

Promise<void>

deleteTriggeredWebJob(string, string, string, WebAppsDeleteTriggeredWebJobOptionalParams)

Delete a triggered web job by its ID for an app, or a deployment slot.

function deleteTriggeredWebJob(resourceGroupName: string, name: string, webJobName: string, options?: WebAppsDeleteTriggeredWebJobOptionalParams): Promise<void>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Site name.

webJobName: string

Name of Web Job.

options: WebAppsDeleteTriggeredWebJobOptionalParams

The options parameters.

Returns

Promise<void>

deleteTriggeredWebJobSlot(string, string, string, string, WebAppsDeleteTriggeredWebJobSlotOptionalParams)

Delete a triggered web job by its ID for an app, or a deployment slot.

function deleteTriggeredWebJobSlot(resourceGroupName: string, name: string, webJobName: string, slot: string, options?: WebAppsDeleteTriggeredWebJobSlotOptionalParams): Promise<void>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Site name.

webJobName: string

Name of Web Job.

slot: string

Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.

options: WebAppsDeleteTriggeredWebJobSlotOptionalParams

The options parameters.

Returns

Promise<void>

deleteVnetConnection(string, string, string, WebAppsDeleteVnetConnectionOptionalParams)

Deletes a connection from an app (or deployment slot to a named virtual network.

function deleteVnetConnection(resourceGroupName: string, name: string, vnetName: string, options?: WebAppsDeleteVnetConnectionOptionalParams): Promise<void>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

vnetName: string

Name of the virtual network.

options: WebAppsDeleteVnetConnectionOptionalParams

The options parameters.

Returns

Promise<void>

deleteVnetConnectionSlot(string, string, string, string, WebAppsDeleteVnetConnectionSlotOptionalParams)

Deletes a connection from an app (or deployment slot to a named virtual network.

function deleteVnetConnectionSlot(resourceGroupName: string, name: string, vnetName: string, slot: string, options?: WebAppsDeleteVnetConnectionSlotOptionalParams): Promise<void>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

vnetName: string

Name of the virtual network.

slot: string

Name of the deployment slot. If a slot is not specified, the API will delete the connection for the production slot.

options: WebAppsDeleteVnetConnectionSlotOptionalParams

The options parameters.

Returns

Promise<void>

discoverBackup(string, string, RestoreRequest, WebAppsDiscoverBackupOptionalParams)

Discovers an existing app backup that can be restored from a blob in Azure storage. Use this to get information about the databases stored in a backup.

function discoverBackup(resourceGroupName: string, name: string, request: RestoreRequest, options?: WebAppsDiscoverBackupOptionalParams): Promise<RestoreRequest>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

request: RestoreRequest

A RestoreRequest object that includes Azure storage URL and blog name for discovery of backup.

options: WebAppsDiscoverBackupOptionalParams

The options parameters.

Returns

Promise<RestoreRequest>

discoverBackupSlot(string, string, string, RestoreRequest, WebAppsDiscoverBackupSlotOptionalParams)

Discovers an existing app backup that can be restored from a blob in Azure storage. Use this to get information about the databases stored in a backup.

function discoverBackupSlot(resourceGroupName: string, name: string, slot: string, request: RestoreRequest, options?: WebAppsDiscoverBackupSlotOptionalParams): Promise<RestoreRequest>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

slot: string

Name of the deployment slot. If a slot is not specified, the API will perform discovery for the production slot.

request: RestoreRequest

A RestoreRequest object that includes Azure storage URL and blog name for discovery of backup.

options: WebAppsDiscoverBackupSlotOptionalParams

The options parameters.

Returns

Promise<RestoreRequest>

generateNewSitePublishingPassword(string, string, WebAppsGenerateNewSitePublishingPasswordOptionalParams)

Generates a new publishing password for an app (or deployment slot, if specified).

function generateNewSitePublishingPassword(resourceGroupName: string, name: string, options?: WebAppsGenerateNewSitePublishingPasswordOptionalParams): Promise<void>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

options: WebAppsGenerateNewSitePublishingPasswordOptionalParams

The options parameters.

Returns

Promise<void>

generateNewSitePublishingPasswordSlot(string, string, string, WebAppsGenerateNewSitePublishingPasswordSlotOptionalParams)

Generates a new publishing password for an app (or deployment slot, if specified).

function generateNewSitePublishingPasswordSlot(resourceGroupName: string, name: string, slot: string, options?: WebAppsGenerateNewSitePublishingPasswordSlotOptionalParams): Promise<void>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

slot: string

Name of the deployment slot. If a slot is not specified, the API generate a new publishing password for the production slot.

options: WebAppsGenerateNewSitePublishingPasswordSlotOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, WebAppsGetOptionalParams)

Gets the details of a web, mobile, or API app.

function get(resourceGroupName: string, name: string, options?: WebAppsGetOptionalParams): Promise<Site>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

options: WebAppsGetOptionalParams

The options parameters.

Returns

Promise<Site>

getAuthSettings(string, string, WebAppsGetAuthSettingsOptionalParams)

Gets the Authentication/Authorization settings of an app.

function getAuthSettings(resourceGroupName: string, name: string, options?: WebAppsGetAuthSettingsOptionalParams): Promise<SiteAuthSettings>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

options: WebAppsGetAuthSettingsOptionalParams

The options parameters.

Returns

Promise<SiteAuthSettings>

getAuthSettingsSlot(string, string, string, WebAppsGetAuthSettingsSlotOptionalParams)

Gets the Authentication/Authorization settings of an app.

function getAuthSettingsSlot(resourceGroupName: string, name: string, slot: string, options?: WebAppsGetAuthSettingsSlotOptionalParams): Promise<SiteAuthSettings>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

slot: string

Name of the deployment slot. If a slot is not specified, the API will get the settings for the production slot.

options: WebAppsGetAuthSettingsSlotOptionalParams

The options parameters.

Returns

Promise<SiteAuthSettings>

getBackupConfiguration(string, string, WebAppsGetBackupConfigurationOptionalParams)

Gets the backup configuration of an app.

function getBackupConfiguration(resourceGroupName: string, name: string, options?: WebAppsGetBackupConfigurationOptionalParams): Promise<BackupRequest>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

options: WebAppsGetBackupConfigurationOptionalParams

The options parameters.

Returns

Promise<BackupRequest>

getBackupConfigurationSlot(string, string, string, WebAppsGetBackupConfigurationSlotOptionalParams)

Gets the backup configuration of an app.

function getBackupConfigurationSlot(resourceGroupName: string, name: string, slot: string, options?: WebAppsGetBackupConfigurationSlotOptionalParams): Promise<BackupRequest>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

slot: string

Name of the deployment slot. If a slot is not specified, the API will get the backup configuration for the production slot.

options: WebAppsGetBackupConfigurationSlotOptionalParams

The options parameters.

Returns

Promise<BackupRequest>

getBackupStatus(string, string, string, WebAppsGetBackupStatusOptionalParams)

Gets a backup of an app by its ID.

function getBackupStatus(resourceGroupName: string, name: string, backupId: string, options?: WebAppsGetBackupStatusOptionalParams): Promise<BackupItem>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

backupId: string

ID of the backup.

options: WebAppsGetBackupStatusOptionalParams

The options parameters.

Returns

Promise<BackupItem>

getBackupStatusSlot(string, string, string, string, WebAppsGetBackupStatusSlotOptionalParams)

Gets a backup of an app by its ID.

function getBackupStatusSlot(resourceGroupName: string, name: string, backupId: string, slot: string, options?: WebAppsGetBackupStatusSlotOptionalParams): Promise<BackupItem>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

backupId: string

ID of the backup.

slot: string

Name of the deployment slot. If a slot is not specified, the API will get a backup of the production slot.

options: WebAppsGetBackupStatusSlotOptionalParams

The options parameters.

Returns

Promise<BackupItem>

getConfiguration(string, string, WebAppsGetConfigurationOptionalParams)

Gets the configuration of an app, such as platform version and bitness, default documents, virtual applications, Always On, etc.

function getConfiguration(resourceGroupName: string, name: string, options?: WebAppsGetConfigurationOptionalParams): Promise<SiteConfigResource>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

options: WebAppsGetConfigurationOptionalParams

The options parameters.

Returns

Promise<SiteConfigResource>

getConfigurationSlot(string, string, string, WebAppsGetConfigurationSlotOptionalParams)

Gets the configuration of an app, such as platform version and bitness, default documents, virtual applications, Always On, etc.

function getConfigurationSlot(resourceGroupName: string, name: string, slot: string, options?: WebAppsGetConfigurationSlotOptionalParams): Promise<SiteConfigResource>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

slot: string

Name of the deployment slot. If a slot is not specified, the API will return configuration for the production slot.

options: WebAppsGetConfigurationSlotOptionalParams

The options parameters.

Returns

Promise<SiteConfigResource>

getConfigurationSnapshot(string, string, string, WebAppsGetConfigurationSnapshotOptionalParams)

Gets a snapshot of the configuration of an app at a previous point in time.

function getConfigurationSnapshot(resourceGroupName: string, name: string, snapshotId: string, options?: WebAppsGetConfigurationSnapshotOptionalParams): Promise<SiteConfigResource>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

snapshotId: string

The ID of the snapshot to read.

options: WebAppsGetConfigurationSnapshotOptionalParams

The options parameters.

Returns

Promise<SiteConfigResource>

getConfigurationSnapshotSlot(string, string, string, string, WebAppsGetConfigurationSnapshotSlotOptionalParams)

Gets a snapshot of the configuration of an app at a previous point in time.

function getConfigurationSnapshotSlot(resourceGroupName: string, name: string, snapshotId: string, slot: string, options?: WebAppsGetConfigurationSnapshotSlotOptionalParams): Promise<SiteConfigResource>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

snapshotId: string

The ID of the snapshot to read.

slot: string

Name of the deployment slot. If a slot is not specified, the API will return configuration for the production slot.

options: WebAppsGetConfigurationSnapshotSlotOptionalParams

The options parameters.

Returns

Promise<SiteConfigResource>

getContainerLogsZip(string, string, WebAppsGetContainerLogsZipOptionalParams)

Gets the ZIP archived docker log files for the given site

function getContainerLogsZip(resourceGroupName: string, name: string, options?: WebAppsGetContainerLogsZipOptionalParams): Promise<WebAppsGetContainerLogsZipResponse>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of web app.

options: WebAppsGetContainerLogsZipOptionalParams

The options parameters.

Returns

Promise<WebAppsGetContainerLogsZipResponse>

getContainerLogsZipSlot(string, string, string, WebAppsGetContainerLogsZipSlotOptionalParams)

Gets the ZIP archived docker log files for the given site

function getContainerLogsZipSlot(resourceGroupName: string, name: string, slot: string, options?: WebAppsGetContainerLogsZipSlotOptionalParams): Promise<WebAppsGetContainerLogsZipSlotResponse>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of web app.

slot: string

Name of web app slot. If not specified then will default to production slot.

options: WebAppsGetContainerLogsZipSlotOptionalParams

The options parameters.

Returns

Promise<WebAppsGetContainerLogsZipSlotResponse>

getContinuousWebJob(string, string, string, WebAppsGetContinuousWebJobOptionalParams)

Gets a continuous web job by its ID for an app, or a deployment slot.

function getContinuousWebJob(resourceGroupName: string, name: string, webJobName: string, options?: WebAppsGetContinuousWebJobOptionalParams): Promise<ContinuousWebJob>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Site name.

webJobName: string

Name of Web Job.

options: WebAppsGetContinuousWebJobOptionalParams

The options parameters.

Returns

Promise<ContinuousWebJob>

getContinuousWebJobSlot(string, string, string, string, WebAppsGetContinuousWebJobSlotOptionalParams)

Gets a continuous web job by its ID for an app, or a deployment slot.

function getContinuousWebJobSlot(resourceGroupName: string, name: string, webJobName: string, slot: string, options?: WebAppsGetContinuousWebJobSlotOptionalParams): Promise<ContinuousWebJob>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Site name.

webJobName: string

Name of Web Job.

slot: string

Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.

options: WebAppsGetContinuousWebJobSlotOptionalParams

The options parameters.

Returns

Promise<ContinuousWebJob>

getDeployment(string, string, string, WebAppsGetDeploymentOptionalParams)

Get a deployment by its ID for an app, or a deployment slot.

function getDeployment(resourceGroupName: string, name: string, id: string, options?: WebAppsGetDeploymentOptionalParams): Promise<Deployment>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

id: string

Deployment ID.

options: WebAppsGetDeploymentOptionalParams

The options parameters.

Returns

Promise<Deployment>

getDeploymentSlot(string, string, string, string, WebAppsGetDeploymentSlotOptionalParams)

Get a deployment by its ID for an app, or a deployment slot.

function getDeploymentSlot(resourceGroupName: string, name: string, id: string, slot: string, options?: WebAppsGetDeploymentSlotOptionalParams): Promise<Deployment>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

id: string

Deployment ID.

slot: string

Name of the deployment slot. If a slot is not specified, the API gets a deployment for the production slot.

options: WebAppsGetDeploymentSlotOptionalParams

The options parameters.

Returns

Promise<Deployment>

getDiagnosticLogsConfiguration(string, string, WebAppsGetDiagnosticLogsConfigurationOptionalParams)

Gets the logging configuration of an app.

function getDiagnosticLogsConfiguration(resourceGroupName: string, name: string, options?: WebAppsGetDiagnosticLogsConfigurationOptionalParams): Promise<SiteLogsConfig>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

options: WebAppsGetDiagnosticLogsConfigurationOptionalParams

The options parameters.

Returns

Promise<SiteLogsConfig>

getDiagnosticLogsConfigurationSlot(string, string, string, WebAppsGetDiagnosticLogsConfigurationSlotOptionalParams)

Gets the logging configuration of an app.

function getDiagnosticLogsConfigurationSlot(resourceGroupName: string, name: string, slot: string, options?: WebAppsGetDiagnosticLogsConfigurationSlotOptionalParams): Promise<SiteLogsConfig>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

slot: string

Name of the deployment slot. If a slot is not specified, the API will get the logging configuration for the production slot.

options: WebAppsGetDiagnosticLogsConfigurationSlotOptionalParams

The options parameters.

Returns

Promise<SiteLogsConfig>

getDomainOwnershipIdentifier(string, string, string, WebAppsGetDomainOwnershipIdentifierOptionalParams)

Get domain ownership identifier for web app.

function getDomainOwnershipIdentifier(resourceGroupName: string, name: string, domainOwnershipIdentifierName: string, options?: WebAppsGetDomainOwnershipIdentifierOptionalParams): Promise<Identifier>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

domainOwnershipIdentifierName: string

Name of domain ownership identifier.

options: WebAppsGetDomainOwnershipIdentifierOptionalParams

The options parameters.

Returns

Promise<Identifier>

getDomainOwnershipIdentifierSlot(string, string, string, string, WebAppsGetDomainOwnershipIdentifierSlotOptionalParams)

Get domain ownership identifier for web app.

function getDomainOwnershipIdentifierSlot(resourceGroupName: string, name: string, domainOwnershipIdentifierName: string, slot: string, options?: WebAppsGetDomainOwnershipIdentifierSlotOptionalParams): Promise<Identifier>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

domainOwnershipIdentifierName: string

Name of domain ownership identifier.

slot: string

Name of the deployment slot. If a slot is not specified, the API will delete the binding for the production slot.

options: WebAppsGetDomainOwnershipIdentifierSlotOptionalParams

The options parameters.

Returns

Promise<Identifier>

getFunction(string, string, string, WebAppsGetFunctionOptionalParams)

Get function information by its ID for web site, or a deployment slot.

function getFunction(resourceGroupName: string, name: string, functionName: string, options?: WebAppsGetFunctionOptionalParams): Promise<FunctionEnvelope>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Site name.

functionName: string

Function name.

options: WebAppsGetFunctionOptionalParams

The options parameters.

Returns

Promise<FunctionEnvelope>

getFunctionsAdminToken(string, string, WebAppsGetFunctionsAdminTokenOptionalParams)

Fetch a short lived token that can be exchanged for a master key.

function getFunctionsAdminToken(resourceGroupName: string, name: string, options?: WebAppsGetFunctionsAdminTokenOptionalParams): Promise<WebAppsGetFunctionsAdminTokenResponse>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of web app.

options: WebAppsGetFunctionsAdminTokenOptionalParams

The options parameters.

Returns

Promise<WebAppsGetFunctionsAdminTokenResponse>

getFunctionsAdminTokenSlot(string, string, string, WebAppsGetFunctionsAdminTokenSlotOptionalParams)

Fetch a short lived token that can be exchanged for a master key.

function getFunctionsAdminTokenSlot(resourceGroupName: string, name: string, slot: string, options?: WebAppsGetFunctionsAdminTokenSlotOptionalParams): Promise<WebAppsGetFunctionsAdminTokenSlotResponse>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of web app.

slot: string

Name of web app slot. If not specified then will default to production slot.

options: WebAppsGetFunctionsAdminTokenSlotOptionalParams

The options parameters.

Returns

Promise<WebAppsGetFunctionsAdminTokenSlotResponse>

getHostNameBinding(string, string, string, WebAppsGetHostNameBindingOptionalParams)

Get the named hostname binding for an app (or deployment slot, if specified).

function getHostNameBinding(resourceGroupName: string, name: string, hostName: string, options?: WebAppsGetHostNameBindingOptionalParams): Promise<HostNameBinding>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

hostName: string

Hostname in the hostname binding.

options: WebAppsGetHostNameBindingOptionalParams

The options parameters.

Returns

Promise<HostNameBinding>

getHostNameBindingSlot(string, string, string, string, WebAppsGetHostNameBindingSlotOptionalParams)

Get the named hostname binding for an app (or deployment slot, if specified).

function getHostNameBindingSlot(resourceGroupName: string, name: string, slot: string, hostName: string, options?: WebAppsGetHostNameBindingSlotOptionalParams): Promise<HostNameBinding>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

slot: string

Name of the deployment slot. If a slot is not specified, the API the named binding for the production slot.

hostName: string

Hostname in the hostname binding.

options: WebAppsGetHostNameBindingSlotOptionalParams

The options parameters.

Returns

Promise<HostNameBinding>

getHybridConnection(string, string, string, string, WebAppsGetHybridConnectionOptionalParams)

Retrieves a specific Service Bus Hybrid Connection used by this Web App.

function getHybridConnection(resourceGroupName: string, name: string, namespaceName: string, relayName: string, options?: WebAppsGetHybridConnectionOptionalParams): Promise<HybridConnection>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

The name of the web app.

namespaceName: string

The namespace for this hybrid connection.

relayName: string

The relay name for this hybrid connection.

options: WebAppsGetHybridConnectionOptionalParams

The options parameters.

Returns

Promise<HybridConnection>

getHybridConnectionSlot(string, string, string, string, string, WebAppsGetHybridConnectionSlotOptionalParams)

Retrieves a specific Service Bus Hybrid Connection used by this Web App.

function getHybridConnectionSlot(resourceGroupName: string, name: string, namespaceName: string, relayName: string, slot: string, options?: WebAppsGetHybridConnectionSlotOptionalParams): Promise<HybridConnection>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

The name of the web app.

namespaceName: string

The namespace for this hybrid connection.

relayName: string

The relay name for this hybrid connection.

slot: string

The name of the slot for the web app.

options: WebAppsGetHybridConnectionSlotOptionalParams

The options parameters.

Returns

Promise<HybridConnection>

getInstanceFunctionSlot(string, string, string, string, WebAppsGetInstanceFunctionSlotOptionalParams)

Get function information by its ID for web site, or a deployment slot.

function getInstanceFunctionSlot(resourceGroupName: string, name: string, functionName: string, slot: string, options?: WebAppsGetInstanceFunctionSlotOptionalParams): Promise<FunctionEnvelope>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Site name.

functionName: string

Function name.

slot: string

Name of the deployment slot.

options: WebAppsGetInstanceFunctionSlotOptionalParams

The options parameters.

Returns

Promise<FunctionEnvelope>

getInstanceMSDeployLog(string, string, string, WebAppsGetInstanceMSDeployLogOptionalParams)

Get the MSDeploy Log for the last MSDeploy operation.

function getInstanceMSDeployLog(resourceGroupName: string, name: string, instanceId: string, options?: WebAppsGetInstanceMSDeployLogOptionalParams): Promise<MSDeployLog>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of web app.

instanceId: string

ID of web app instance.

options: WebAppsGetInstanceMSDeployLogOptionalParams

The options parameters.

Returns

Promise<MSDeployLog>

getInstanceMSDeployLogSlot(string, string, string, string, WebAppsGetInstanceMSDeployLogSlotOptionalParams)

Get the MSDeploy Log for the last MSDeploy operation.

function getInstanceMSDeployLogSlot(resourceGroupName: string, name: string, slot: string, instanceId: string, options?: WebAppsGetInstanceMSDeployLogSlotOptionalParams): Promise<MSDeployLog>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of web app.

slot: string

Name of web app slot. If not specified then will default to production slot.

instanceId: string

ID of web app instance.

options: WebAppsGetInstanceMSDeployLogSlotOptionalParams

The options parameters.

Returns

Promise<MSDeployLog>

getInstanceMsDeployStatus(string, string, string, WebAppsGetInstanceMsDeployStatusOptionalParams)

Get the status of the last MSDeploy operation.

function getInstanceMsDeployStatus(resourceGroupName: string, name: string, instanceId: string, options?: WebAppsGetInstanceMsDeployStatusOptionalParams): Promise<MSDeployStatus>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of web app.

instanceId: string

ID of web app instance.

options: WebAppsGetInstanceMsDeployStatusOptionalParams

The options parameters.

Returns

Promise<MSDeployStatus>

getInstanceMsDeployStatusSlot(string, string, string, string, WebAppsGetInstanceMsDeployStatusSlotOptionalParams)

Get the status of the last MSDeploy operation.

function getInstanceMsDeployStatusSlot(resourceGroupName: string, name: string, slot: string, instanceId: string, options?: WebAppsGetInstanceMsDeployStatusSlotOptionalParams): Promise<MSDeployStatus>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of web app.

slot: string

Name of web app slot. If not specified then will default to production slot.

instanceId: string

ID of web app instance.

options: WebAppsGetInstanceMsDeployStatusSlotOptionalParams

The options parameters.

Returns

Promise<MSDeployStatus>

getInstanceProcess(string, string, string, string, WebAppsGetInstanceProcessOptionalParams)

Get process information by its ID for a specific scaled-out instance in a web site.

function getInstanceProcess(resourceGroupName: string, name: string, processId: string, instanceId: string, options?: WebAppsGetInstanceProcessOptionalParams): Promise<ProcessInfo>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Site name.

processId: string

PID.

instanceId: string

ID of a specific scaled-out instance. This is the value of the name property in the JSON response from "GET api/sites/{siteName}/instances".

options: WebAppsGetInstanceProcessOptionalParams

The options parameters.

Returns

Promise<ProcessInfo>

getInstanceProcessDump(string, string, string, string, WebAppsGetInstanceProcessDumpOptionalParams)

Get a memory dump of a process by its ID for a specific scaled-out instance in a web site.

function getInstanceProcessDump(resourceGroupName: string, name: string, processId: string, instanceId: string, options?: WebAppsGetInstanceProcessDumpOptionalParams): Promise<WebAppsGetInstanceProcessDumpResponse>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Site name.

processId: string

PID.

instanceId: string

ID of a specific scaled-out instance. This is the value of the name property in the JSON response from "GET api/sites/{siteName}/instances".

options: WebAppsGetInstanceProcessDumpOptionalParams

The options parameters.

Returns

Promise<WebAppsGetInstanceProcessDumpResponse>

getInstanceProcessDumpSlot(string, string, string, string, string, WebAppsGetInstanceProcessDumpSlotOptionalParams)

Get a memory dump of a process by its ID for a specific scaled-out instance in a web site.

function getInstanceProcessDumpSlot(resourceGroupName: string, name: string, processId: string, slot: string, instanceId: string, options?: WebAppsGetInstanceProcessDumpSlotOptionalParams): Promise<WebAppsGetInstanceProcessDumpSlotResponse>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Site name.

processId: string

PID.

slot: string

Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.

instanceId: string

ID of a specific scaled-out instance. This is the value of the name property in the JSON response from "GET api/sites/{siteName}/instances".

options: WebAppsGetInstanceProcessDumpSlotOptionalParams

The options parameters.

Returns

Promise<WebAppsGetInstanceProcessDumpSlotResponse>

getInstanceProcessModule(string, string, string, string, string, WebAppsGetInstanceProcessModuleOptionalParams)

Get process information by its ID for a specific scaled-out instance in a web site.

function getInstanceProcessModule(resourceGroupName: string, name: string, processId: string, baseAddress: string, instanceId: string, options?: WebAppsGetInstanceProcessModuleOptionalParams): Promise<ProcessModuleInfo>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Site name.

processId: string

PID.

baseAddress: string

Module base address.

instanceId: string

ID of a specific scaled-out instance. This is the value of the name property in the JSON response from "GET api/sites/{siteName}/instances".

options: WebAppsGetInstanceProcessModuleOptionalParams

The options parameters.

Returns

Promise<ProcessModuleInfo>

getInstanceProcessModuleSlot(string, string, string, string, string, string, WebAppsGetInstanceProcessModuleSlotOptionalParams)

Get process information by its ID for a specific scaled-out instance in a web site.

function getInstanceProcessModuleSlot(resourceGroupName: string, name: string, processId: string, baseAddress: string, slot: string, instanceId: string, options?: WebAppsGetInstanceProcessModuleSlotOptionalParams): Promise<ProcessModuleInfo>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Site name.

processId: string

PID.

baseAddress: string

Module base address.

slot: string

Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.

instanceId: string

ID of a specific scaled-out instance. This is the value of the name property in the JSON response from "GET api/sites/{siteName}/instances".

options: WebAppsGetInstanceProcessModuleSlotOptionalParams

The options parameters.

Returns

Promise<ProcessModuleInfo>

getInstanceProcessSlot(string, string, string, string, string, WebAppsGetInstanceProcessSlotOptionalParams)

Get process information by its ID for a specific scaled-out instance in a web site.

function getInstanceProcessSlot(resourceGroupName: string, name: string, processId: string, slot: string, instanceId: string, options?: WebAppsGetInstanceProcessSlotOptionalParams): Promise<ProcessInfo>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Site name.

processId: string

PID.

slot: string

Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.

instanceId: string

ID of a specific scaled-out instance. This is the value of the name property in the JSON response from "GET api/sites/{siteName}/instances".

options: WebAppsGetInstanceProcessSlotOptionalParams

The options parameters.

Returns

Promise<ProcessInfo>

getInstanceProcessThread(string, string, string, string, string, WebAppsGetInstanceProcessThreadOptionalParams)

Get thread information by Thread ID for a specific process, in a specific scaled-out instance in a web site.

function getInstanceProcessThread(resourceGroupName: string, name: string, processId: string, threadId: string, instanceId: string, options?: WebAppsGetInstanceProcessThreadOptionalParams): Promise<ProcessThreadInfo>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Site name.

processId: string

PID.

threadId: string

TID.

instanceId: string

ID of a specific scaled-out instance. This is the value of the name property in the JSON response from "GET api/sites/{siteName}/instances".

options: WebAppsGetInstanceProcessThreadOptionalParams

The options parameters.

Returns

Promise<ProcessThreadInfo>

getInstanceProcessThreadSlot(string, string, string, string, string, string, WebAppsGetInstanceProcessThreadSlotOptionalParams)

Get thread information by Thread ID for a specific process, in a specific scaled-out instance in a web site.

function getInstanceProcessThreadSlot(resourceGroupName: string, name: string, processId: string, threadId: string, slot: string, instanceId: string, options?: WebAppsGetInstanceProcessThreadSlotOptionalParams): Promise<ProcessThreadInfo>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Site name.

processId: string

PID.

threadId: string

TID.

slot: string

Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.

instanceId: string

ID of a specific scaled-out instance. This is the value of the name property in the JSON response from "GET api/sites/{siteName}/instances".

options: WebAppsGetInstanceProcessThreadSlotOptionalParams

The options parameters.

Returns

Promise<ProcessThreadInfo>

getMigrateMySqlStatus(string, string, WebAppsGetMigrateMySqlStatusOptionalParams)

Returns the status of MySql in app migration, if one is active, and whether or not MySql in app is enabled

function getMigrateMySqlStatus(resourceGroupName: string, name: string, options?: WebAppsGetMigrateMySqlStatusOptionalParams): Promise<MigrateMySqlStatus>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of web app.

options: WebAppsGetMigrateMySqlStatusOptionalParams

The options parameters.

Returns

Promise<MigrateMySqlStatus>

getMigrateMySqlStatusSlot(string, string, string, WebAppsGetMigrateMySqlStatusSlotOptionalParams)

Returns the status of MySql in app migration, if one is active, and whether or not MySql in app is enabled

function getMigrateMySqlStatusSlot(resourceGroupName: string, name: string, slot: string, options?: WebAppsGetMigrateMySqlStatusSlotOptionalParams): Promise<MigrateMySqlStatus>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of web app.

slot: string

Name of the deployment slot.

options: WebAppsGetMigrateMySqlStatusSlotOptionalParams

The options parameters.

Returns

Promise<MigrateMySqlStatus>

getMSDeployLog(string, string, WebAppsGetMSDeployLogOptionalParams)

Get the MSDeploy Log for the last MSDeploy operation.

function getMSDeployLog(resourceGroupName: string, name: string, options?: WebAppsGetMSDeployLogOptionalParams): Promise<MSDeployLog>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of web app.

options: WebAppsGetMSDeployLogOptionalParams

The options parameters.

Returns

Promise<MSDeployLog>

getMSDeployLogSlot(string, string, string, WebAppsGetMSDeployLogSlotOptionalParams)

Get the MSDeploy Log for the last MSDeploy operation.

function getMSDeployLogSlot(resourceGroupName: string, name: string, slot: string, options?: WebAppsGetMSDeployLogSlotOptionalParams): Promise<MSDeployLog>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of web app.

slot: string

Name of web app slot. If not specified then will default to production slot.

options: WebAppsGetMSDeployLogSlotOptionalParams

The options parameters.

Returns

Promise<MSDeployLog>

getMSDeployStatus(string, string, WebAppsGetMSDeployStatusOptionalParams)

Get the status of the last MSDeploy operation.

function getMSDeployStatus(resourceGroupName: string, name: string, options?: WebAppsGetMSDeployStatusOptionalParams): Promise<MSDeployStatus>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of web app.

options: WebAppsGetMSDeployStatusOptionalParams

The options parameters.

Returns

Promise<MSDeployStatus>

getMSDeployStatusSlot(string, string, string, WebAppsGetMSDeployStatusSlotOptionalParams)

Get the status of the last MSDeploy operation.

function getMSDeployStatusSlot(resourceGroupName: string, name: string, slot: string, options?: WebAppsGetMSDeployStatusSlotOptionalParams): Promise<MSDeployStatus>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of web app.

slot: string

Name of web app slot. If not specified then will default to production slot.

options: WebAppsGetMSDeployStatusSlotOptionalParams

The options parameters.

Returns

Promise<MSDeployStatus>

getNetworkTraceOperation(string, string, string, WebAppsGetNetworkTraceOperationOptionalParams)

Gets a named operation for a network trace capturing (or deployment slot, if specified).

function getNetworkTraceOperation(resourceGroupName: string, name: string, operationId: string, options?: WebAppsGetNetworkTraceOperationOptionalParams): Promise<WebAppsGetNetworkTraceOperationResponse>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

operationId: string

GUID of the operation.

options: WebAppsGetNetworkTraceOperationOptionalParams

The options parameters.

Returns

Promise<WebAppsGetNetworkTraceOperationResponse>

getNetworkTraceOperationSlot(string, string, string, string, WebAppsGetNetworkTraceOperationSlotOptionalParams)

Gets a named operation for a network trace capturing (or deployment slot, if specified).

function getNetworkTraceOperationSlot(resourceGroupName: string, name: string, operationId: string, slot: string, options?: WebAppsGetNetworkTraceOperationSlotOptionalParams): Promise<WebAppsGetNetworkTraceOperationSlotResponse>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

operationId: string

GUID of the operation.

slot: string

Name of the deployment slot. If a slot is not specified, the API will get an operation for the production slot.

options: WebAppsGetNetworkTraceOperationSlotOptionalParams

The options parameters.

Returns

Promise<WebAppsGetNetworkTraceOperationSlotResponse>

getNetworkTraceOperationSlotV2(string, string, string, string, WebAppsGetNetworkTraceOperationSlotV2OptionalParams)

Gets a named operation for a network trace capturing (or deployment slot, if specified).

function getNetworkTraceOperationSlotV2(resourceGroupName: string, name: string, operationId: string, slot: string, options?: WebAppsGetNetworkTraceOperationSlotV2OptionalParams): Promise<WebAppsGetNetworkTraceOperationSlotV2Response>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

operationId: string

GUID of the operation.

slot: string

Name of the deployment slot. If a slot is not specified, the API will get an operation for the production slot.

options: WebAppsGetNetworkTraceOperationSlotV2OptionalParams

The options parameters.

Returns

Promise<WebAppsGetNetworkTraceOperationSlotV2Response>

getNetworkTraceOperationV2(string, string, string, WebAppsGetNetworkTraceOperationV2OptionalParams)

Gets a named operation for a network trace capturing (or deployment slot, if specified).

function getNetworkTraceOperationV2(resourceGroupName: string, name: string, operationId: string, options?: WebAppsGetNetworkTraceOperationV2OptionalParams): Promise<WebAppsGetNetworkTraceOperationV2Response>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

operationId: string

GUID of the operation.

options: WebAppsGetNetworkTraceOperationV2OptionalParams

The options parameters.

Returns

Promise<WebAppsGetNetworkTraceOperationV2Response>

getNetworkTraces(string, string, string, WebAppsGetNetworkTracesOptionalParams)

Gets a named operation for a network trace capturing (or deployment slot, if specified).

function getNetworkTraces(resourceGroupName: string, name: string, operationId: string, options?: WebAppsGetNetworkTracesOptionalParams): Promise<WebAppsGetNetworkTracesResponse>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

operationId: string

GUID of the operation.

options: WebAppsGetNetworkTracesOptionalParams

The options parameters.

Returns

Promise<WebAppsGetNetworkTracesResponse>

getNetworkTracesSlot(string, string, string, string, WebAppsGetNetworkTracesSlotOptionalParams)

Gets a named operation for a network trace capturing (or deployment slot, if specified).

function getNetworkTracesSlot(resourceGroupName: string, name: string, operationId: string, slot: string, options?: WebAppsGetNetworkTracesSlotOptionalParams): Promise<WebAppsGetNetworkTracesSlotResponse>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

operationId: string

GUID of the operation.

slot: string

Name of the deployment slot. If a slot is not specified, the API will get an operation for the production slot.

options: WebAppsGetNetworkTracesSlotOptionalParams

The options parameters.

Returns

Promise<WebAppsGetNetworkTracesSlotResponse>

getNetworkTracesSlotV2(string, string, string, string, WebAppsGetNetworkTracesSlotV2OptionalParams)

Gets a named operation for a network trace capturing (or deployment slot, if specified).

function getNetworkTracesSlotV2(resourceGroupName: string, name: string, operationId: string, slot: string, options?: WebAppsGetNetworkTracesSlotV2OptionalParams): Promise<WebAppsGetNetworkTracesSlotV2Response>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

operationId: string

GUID of the operation.

slot: string

Name of the deployment slot. If a slot is not specified, the API will get an operation for the production slot.

options: WebAppsGetNetworkTracesSlotV2OptionalParams

The options parameters.

Returns

Promise<WebAppsGetNetworkTracesSlotV2Response>

getNetworkTracesV2(string, string, string, WebAppsGetNetworkTracesV2OptionalParams)

Gets a named operation for a network trace capturing (or deployment slot, if specified).

function getNetworkTracesV2(resourceGroupName: string, name: string, operationId: string, options?: WebAppsGetNetworkTracesV2OptionalParams): Promise<WebAppsGetNetworkTracesV2Response>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

operationId: string

GUID of the operation.

options: WebAppsGetNetworkTracesV2OptionalParams

The options parameters.

Returns

Promise<WebAppsGetNetworkTracesV2Response>

getPremierAddOn(string, string, string, WebAppsGetPremierAddOnOptionalParams)

Gets a named add-on of an app.

function getPremierAddOn(resourceGroupName: string, name: string, premierAddOnName: string, options?: WebAppsGetPremierAddOnOptionalParams): Promise<PremierAddOn>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

premierAddOnName: string

Add-on name.

options: WebAppsGetPremierAddOnOptionalParams

The options parameters.

Returns

Promise<PremierAddOn>

getPremierAddOnSlot(string, string, string, string, WebAppsGetPremierAddOnSlotOptionalParams)

Gets a named add-on of an app.

function getPremierAddOnSlot(resourceGroupName: string, name: string, premierAddOnName: string, slot: string, options?: WebAppsGetPremierAddOnSlotOptionalParams): Promise<PremierAddOn>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

premierAddOnName: string

Add-on name.

slot: string

Name of the deployment slot. If a slot is not specified, the API will get the named add-on for the production slot.

options: WebAppsGetPremierAddOnSlotOptionalParams

The options parameters.

Returns

Promise<PremierAddOn>

getPrivateAccess(string, string, WebAppsGetPrivateAccessOptionalParams)

Gets data around private site access enablement and authorized Virtual Networks that can access the site.

function getPrivateAccess(resourceGroupName: string, name: string, options?: WebAppsGetPrivateAccessOptionalParams): Promise<PrivateAccess>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

The name of the web app.

options: WebAppsGetPrivateAccessOptionalParams

The options parameters.

Returns

Promise<PrivateAccess>

getPrivateAccessSlot(string, string, string, WebAppsGetPrivateAccessSlotOptionalParams)

Gets data around private site access enablement and authorized Virtual Networks that can access the site.

function getPrivateAccessSlot(resourceGroupName: string, name: string, slot: string, options?: WebAppsGetPrivateAccessSlotOptionalParams): Promise<PrivateAccess>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

The name of the web app.

slot: string

The name of the slot for the web app.

options: WebAppsGetPrivateAccessSlotOptionalParams

The options parameters.

Returns

Promise<PrivateAccess>

getProcess(string, string, string, WebAppsGetProcessOptionalParams)

Get process information by its ID for a specific scaled-out instance in a web site.

function getProcess(resourceGroupName: string, name: string, processId: string, options?: WebAppsGetProcessOptionalParams): Promise<ProcessInfo>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Site name.

processId: string

PID.

options: WebAppsGetProcessOptionalParams

The options parameters.

Returns

Promise<ProcessInfo>

getProcessDump(string, string, string, WebAppsGetProcessDumpOptionalParams)

Get a memory dump of a process by its ID for a specific scaled-out instance in a web site.

function getProcessDump(resourceGroupName: string, name: string, processId: string, options?: WebAppsGetProcessDumpOptionalParams): Promise<WebAppsGetProcessDumpResponse>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Site name.

processId: string

PID.

options: WebAppsGetProcessDumpOptionalParams

The options parameters.

Returns

Promise<WebAppsGetProcessDumpResponse>

getProcessDumpSlot(string, string, string, string, WebAppsGetProcessDumpSlotOptionalParams)

Get a memory dump of a process by its ID for a specific scaled-out instance in a web site.

function getProcessDumpSlot(resourceGroupName: string, name: string, processId: string, slot: string, options?: WebAppsGetProcessDumpSlotOptionalParams): Promise<WebAppsGetProcessDumpSlotResponse>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Site name.

processId: string

PID.

slot: string

Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.

options: WebAppsGetProcessDumpSlotOptionalParams

The options parameters.

Returns

Promise<WebAppsGetProcessDumpSlotResponse>

getProcessModule(string, string, string, string, WebAppsGetProcessModuleOptionalParams)

Get process information by its ID for a specific scaled-out instance in a web site.

function getProcessModule(resourceGroupName: string, name: string, processId: string, baseAddress: string, options?: WebAppsGetProcessModuleOptionalParams): Promise<ProcessModuleInfo>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Site name.

processId: string

PID.

baseAddress: string

Module base address.

options: WebAppsGetProcessModuleOptionalParams

The options parameters.

Returns

Promise<ProcessModuleInfo>

getProcessModuleSlot(string, string, string, string, string, WebAppsGetProcessModuleSlotOptionalParams)

Get process information by its ID for a specific scaled-out instance in a web site.

function getProcessModuleSlot(resourceGroupName: string, name: string, processId: string, baseAddress: string, slot: string, options?: WebAppsGetProcessModuleSlotOptionalParams): Promise<ProcessModuleInfo>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Site name.

processId: string

PID.

baseAddress: string

Module base address.

slot: string

Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.

options: WebAppsGetProcessModuleSlotOptionalParams

The options parameters.

Returns

Promise<ProcessModuleInfo>

getProcessSlot(string, string, string, string, WebAppsGetProcessSlotOptionalParams)

Get process information by its ID for a specific scaled-out instance in a web site.

function getProcessSlot(resourceGroupName: string, name: string, processId: string, slot: string, options?: WebAppsGetProcessSlotOptionalParams): Promise<ProcessInfo>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Site name.

processId: string

PID.

slot: string

Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.

options: WebAppsGetProcessSlotOptionalParams

The options parameters.

Returns

Promise<ProcessInfo>

getProcessThread(string, string, string, string, WebAppsGetProcessThreadOptionalParams)

Get thread information by Thread ID for a specific process, in a specific scaled-out instance in a web site.

function getProcessThread(resourceGroupName: string, name: string, processId: string, threadId: string, options?: WebAppsGetProcessThreadOptionalParams): Promise<ProcessThreadInfo>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Site name.

processId: string

PID.

threadId: string

TID.

options: WebAppsGetProcessThreadOptionalParams

The options parameters.

Returns

Promise<ProcessThreadInfo>

getProcessThreadSlot(string, string, string, string, string, WebAppsGetProcessThreadSlotOptionalParams)

Get thread information by Thread ID for a specific process, in a specific scaled-out instance in a web site.

function getProcessThreadSlot(resourceGroupName: string, name: string, processId: string, threadId: string, slot: string, options?: WebAppsGetProcessThreadSlotOptionalParams): Promise<ProcessThreadInfo>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Site name.

processId: string

PID.

threadId: string

TID.

slot: string

Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.

options: WebAppsGetProcessThreadSlotOptionalParams

The options parameters.

Returns

Promise<ProcessThreadInfo>

getPublicCertificate(string, string, string, WebAppsGetPublicCertificateOptionalParams)

Get the named public certificate for an app (or deployment slot, if specified).

function getPublicCertificate(resourceGroupName: string, name: string, publicCertificateName: string, options?: WebAppsGetPublicCertificateOptionalParams): Promise<PublicCertificate>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

publicCertificateName: string

Public certificate name.

options: WebAppsGetPublicCertificateOptionalParams

The options parameters.

Returns

Promise<PublicCertificate>

getPublicCertificateSlot(string, string, string, string, WebAppsGetPublicCertificateSlotOptionalParams)

Get the named public certificate for an app (or deployment slot, if specified).

function getPublicCertificateSlot(resourceGroupName: string, name: string, slot: string, publicCertificateName: string, options?: WebAppsGetPublicCertificateSlotOptionalParams): Promise<PublicCertificate>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

slot: string

Name of the deployment slot. If a slot is not specified, the API the named binding for the production slot.

publicCertificateName: string

Public certificate name.

options: WebAppsGetPublicCertificateSlotOptionalParams

The options parameters.

Returns

Promise<PublicCertificate>

getRelayServiceConnection(string, string, string, WebAppsGetRelayServiceConnectionOptionalParams)

Gets a hybrid connection configuration by its name.

function getRelayServiceConnection(resourceGroupName: string, name: string, entityName: string, options?: WebAppsGetRelayServiceConnectionOptionalParams): Promise<RelayServiceConnectionEntity>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

entityName: string

Name of the hybrid connection.

options: WebAppsGetRelayServiceConnectionOptionalParams

The options parameters.

Returns

getRelayServiceConnectionSlot(string, string, string, string, WebAppsGetRelayServiceConnectionSlotOptionalParams)

Gets a hybrid connection configuration by its name.

function getRelayServiceConnectionSlot(resourceGroupName: string, name: string, entityName: string, slot: string, options?: WebAppsGetRelayServiceConnectionSlotOptionalParams): Promise<RelayServiceConnectionEntity>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

entityName: string

Name of the hybrid connection.

slot: string

Name of the deployment slot. If a slot is not specified, the API will get a hybrid connection for the production slot.

options: WebAppsGetRelayServiceConnectionSlotOptionalParams

The options parameters.

Returns

getSiteExtension(string, string, string, WebAppsGetSiteExtensionOptionalParams)

Get site extension information by its ID for a web site, or a deployment slot.

function getSiteExtension(resourceGroupName: string, name: string, siteExtensionId: string, options?: WebAppsGetSiteExtensionOptionalParams): Promise<SiteExtensionInfo>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Site name.

siteExtensionId: string

Site extension name.

options: WebAppsGetSiteExtensionOptionalParams

The options parameters.

Returns

Promise<SiteExtensionInfo>

getSiteExtensionSlot(string, string, string, string, WebAppsGetSiteExtensionSlotOptionalParams)

Get site extension information by its ID for a web site, or a deployment slot.

function getSiteExtensionSlot(resourceGroupName: string, name: string, siteExtensionId: string, slot: string, options?: WebAppsGetSiteExtensionSlotOptionalParams): Promise<SiteExtensionInfo>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Site name.

siteExtensionId: string

Site extension name.

slot: string

Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.

options: WebAppsGetSiteExtensionSlotOptionalParams

The options parameters.

Returns

Promise<SiteExtensionInfo>

getSitePhpErrorLogFlag(string, string, WebAppsGetSitePhpErrorLogFlagOptionalParams)

Gets web app's event logs.

function getSitePhpErrorLogFlag(resourceGroupName: string, name: string, options?: WebAppsGetSitePhpErrorLogFlagOptionalParams): Promise<SitePhpErrorLogFlag>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of web app.

options: WebAppsGetSitePhpErrorLogFlagOptionalParams

The options parameters.

Returns

Promise<SitePhpErrorLogFlag>

getSitePhpErrorLogFlagSlot(string, string, string, WebAppsGetSitePhpErrorLogFlagSlotOptionalParams)

Gets web app's event logs.

function getSitePhpErrorLogFlagSlot(resourceGroupName: string, name: string, slot: string, options?: WebAppsGetSitePhpErrorLogFlagSlotOptionalParams): Promise<SitePhpErrorLogFlag>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of web app.

slot: string

Name of web app slot. If not specified then will default to production slot.

options: WebAppsGetSitePhpErrorLogFlagSlotOptionalParams

The options parameters.

Returns

Promise<SitePhpErrorLogFlag>

getSlot(string, string, string, WebAppsGetSlotOptionalParams)

Gets the details of a web, mobile, or API app.

function getSlot(resourceGroupName: string, name: string, slot: string, options?: WebAppsGetSlotOptionalParams): Promise<Site>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

slot: string

Name of the deployment slot. By default, this API returns the production slot.

options: WebAppsGetSlotOptionalParams

The options parameters.

Returns

Promise<Site>

getSourceControl(string, string, WebAppsGetSourceControlOptionalParams)

Gets the source control configuration of an app.

function getSourceControl(resourceGroupName: string, name: string, options?: WebAppsGetSourceControlOptionalParams): Promise<SiteSourceControl>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

options: WebAppsGetSourceControlOptionalParams

The options parameters.

Returns

Promise<SiteSourceControl>

getSourceControlSlot(string, string, string, WebAppsGetSourceControlSlotOptionalParams)

Gets the source control configuration of an app.

function getSourceControlSlot(resourceGroupName: string, name: string, slot: string, options?: WebAppsGetSourceControlSlotOptionalParams): Promise<SiteSourceControl>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

slot: string

Name of the deployment slot. If a slot is not specified, the API will get the source control configuration for the production slot.

options: WebAppsGetSourceControlSlotOptionalParams

The options parameters.

Returns

Promise<SiteSourceControl>

getSwiftVirtualNetworkConnection(string, string, WebAppsGetSwiftVirtualNetworkConnectionOptionalParams)

Gets a Swift Virtual Network connection.

function getSwiftVirtualNetworkConnection(resourceGroupName: string, name: string, options?: WebAppsGetSwiftVirtualNetworkConnectionOptionalParams): Promise<SwiftVirtualNetwork>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

options: WebAppsGetSwiftVirtualNetworkConnectionOptionalParams

The options parameters.

Returns

Promise<SwiftVirtualNetwork>

getSwiftVirtualNetworkConnectionSlot(string, string, string, WebAppsGetSwiftVirtualNetworkConnectionSlotOptionalParams)

Gets a Swift Virtual Network connection.

function getSwiftVirtualNetworkConnectionSlot(resourceGroupName: string, name: string, slot: string, options?: WebAppsGetSwiftVirtualNetworkConnectionSlotOptionalParams): Promise<SwiftVirtualNetwork>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

slot: string

Name of the deployment slot. If a slot is not specified, the API will get a gateway for the production slot's Virtual Network.

options: WebAppsGetSwiftVirtualNetworkConnectionSlotOptionalParams

The options parameters.

Returns

Promise<SwiftVirtualNetwork>

getTriggeredWebJob(string, string, string, WebAppsGetTriggeredWebJobOptionalParams)

Gets a triggered web job by its ID for an app, or a deployment slot.

function getTriggeredWebJob(resourceGroupName: string, name: string, webJobName: string, options?: WebAppsGetTriggeredWebJobOptionalParams): Promise<TriggeredWebJob>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Site name.

webJobName: string

Name of Web Job.

options: WebAppsGetTriggeredWebJobOptionalParams

The options parameters.

Returns

Promise<TriggeredWebJob>

getTriggeredWebJobHistory(string, string, string, string, WebAppsGetTriggeredWebJobHistoryOptionalParams)

Gets a triggered web job's history by its ID for an app, , or a deployment slot.

function getTriggeredWebJobHistory(resourceGroupName: string, name: string, webJobName: string, id: string, options?: WebAppsGetTriggeredWebJobHistoryOptionalParams): Promise<TriggeredJobHistory>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Site name.

webJobName: string

Name of Web Job.

id: string

History ID.

options: WebAppsGetTriggeredWebJobHistoryOptionalParams

The options parameters.

Returns

Promise<TriggeredJobHistory>

getTriggeredWebJobHistorySlot(string, string, string, string, string, WebAppsGetTriggeredWebJobHistorySlotOptionalParams)

Gets a triggered web job's history by its ID for an app, , or a deployment slot.

function getTriggeredWebJobHistorySlot(resourceGroupName: string, name: string, webJobName: string, id: string, slot: string, options?: WebAppsGetTriggeredWebJobHistorySlotOptionalParams): Promise<TriggeredJobHistory>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Site name.

webJobName: string

Name of Web Job.

id: string

History ID.

slot: string

Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.

options: WebAppsGetTriggeredWebJobHistorySlotOptionalParams

The options parameters.

Returns

Promise<TriggeredJobHistory>

getTriggeredWebJobSlot(string, string, string, string, WebAppsGetTriggeredWebJobSlotOptionalParams)

Gets a triggered web job by its ID for an app, or a deployment slot.

function getTriggeredWebJobSlot(resourceGroupName: string, name: string, webJobName: string, slot: string, options?: WebAppsGetTriggeredWebJobSlotOptionalParams): Promise<TriggeredWebJob>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Site name.

webJobName: string

Name of Web Job.

slot: string

Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.

options: WebAppsGetTriggeredWebJobSlotOptionalParams

The options parameters.

Returns

Promise<TriggeredWebJob>

getVnetConnection(string, string, string, WebAppsGetVnetConnectionOptionalParams)

Gets a virtual network the app (or deployment slot) is connected to by name.

function getVnetConnection(resourceGroupName: string, name: string, vnetName: string, options?: WebAppsGetVnetConnectionOptionalParams): Promise<VnetInfo>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

vnetName: string

Name of the virtual network.

options: WebAppsGetVnetConnectionOptionalParams

The options parameters.

Returns

Promise<VnetInfo>

getVnetConnectionGateway(string, string, string, string, WebAppsGetVnetConnectionGatewayOptionalParams)

Gets an app's Virtual Network gateway.

function getVnetConnectionGateway(resourceGroupName: string, name: string, vnetName: string, gatewayName: string, options?: WebAppsGetVnetConnectionGatewayOptionalParams): Promise<VnetGateway>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

vnetName: string

Name of the Virtual Network.

gatewayName: string

Name of the gateway. Currently, the only supported string is "primary".

options: WebAppsGetVnetConnectionGatewayOptionalParams

The options parameters.

Returns

Promise<VnetGateway>

getVnetConnectionGatewaySlot(string, string, string, string, string, WebAppsGetVnetConnectionGatewaySlotOptionalParams)

Gets an app's Virtual Network gateway.

function getVnetConnectionGatewaySlot(resourceGroupName: string, name: string, vnetName: string, gatewayName: string, slot: string, options?: WebAppsGetVnetConnectionGatewaySlotOptionalParams): Promise<VnetGateway>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

vnetName: string

Name of the Virtual Network.

gatewayName: string

Name of the gateway. Currently, the only supported string is "primary".

slot: string

Name of the deployment slot. If a slot is not specified, the API will get a gateway for the production slot's Virtual Network.

options: WebAppsGetVnetConnectionGatewaySlotOptionalParams

The options parameters.

Returns

Promise<VnetGateway>

getVnetConnectionSlot(string, string, string, string, WebAppsGetVnetConnectionSlotOptionalParams)

Gets a virtual network the app (or deployment slot) is connected to by name.

function getVnetConnectionSlot(resourceGroupName: string, name: string, vnetName: string, slot: string, options?: WebAppsGetVnetConnectionSlotOptionalParams): Promise<VnetInfo>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

vnetName: string

Name of the virtual network.

slot: string

Name of the deployment slot. If a slot is not specified, the API will get the named virtual network for the production slot.

options: WebAppsGetVnetConnectionSlotOptionalParams

The options parameters.

Returns

Promise<VnetInfo>

getWebJob(string, string, string, WebAppsGetWebJobOptionalParams)

Get webjob information for an app, or a deployment slot.

function getWebJob(resourceGroupName: string, name: string, webJobName: string, options?: WebAppsGetWebJobOptionalParams): Promise<WebJob>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Site name.

webJobName: string

Name of the web job.

options: WebAppsGetWebJobOptionalParams

The options parameters.

Returns

Promise<WebJob>

getWebJobSlot(string, string, string, string, WebAppsGetWebJobSlotOptionalParams)

Get webjob information for an app, or a deployment slot.

function getWebJobSlot(resourceGroupName: string, name: string, webJobName: string, slot: string, options?: WebAppsGetWebJobSlotOptionalParams): Promise<WebJob>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Site name.

webJobName: string

Name of the web job.

slot: string

Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.

options: WebAppsGetWebJobSlotOptionalParams

The options parameters.

Returns

Promise<WebJob>

getWebSiteContainerLogs(string, string, WebAppsGetWebSiteContainerLogsOptionalParams)

Gets the last lines of docker logs for the given site

function getWebSiteContainerLogs(resourceGroupName: string, name: string, options?: WebAppsGetWebSiteContainerLogsOptionalParams): Promise<WebAppsGetWebSiteContainerLogsResponse>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of web app.

options: WebAppsGetWebSiteContainerLogsOptionalParams

The options parameters.

Returns

Promise<WebAppsGetWebSiteContainerLogsResponse>

getWebSiteContainerLogsSlot(string, string, string, WebAppsGetWebSiteContainerLogsSlotOptionalParams)

Gets the last lines of docker logs for the given site

function getWebSiteContainerLogsSlot(resourceGroupName: string, name: string, slot: string, options?: WebAppsGetWebSiteContainerLogsSlotOptionalParams): Promise<WebAppsGetWebSiteContainerLogsSlotResponse>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of web app.

slot: string

Name of web app slot. If not specified then will default to production slot.

options: WebAppsGetWebSiteContainerLogsSlotOptionalParams

The options parameters.

Returns

Promise<WebAppsGetWebSiteContainerLogsSlotResponse>

isCloneable(string, string, WebAppsIsCloneableOptionalParams)

Shows whether an app can be cloned to another resource group or subscription.

function isCloneable(resourceGroupName: string, name: string, options?: WebAppsIsCloneableOptionalParams): Promise<SiteCloneability>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

options: WebAppsIsCloneableOptionalParams

The options parameters.

Returns

Promise<SiteCloneability>

isCloneableSlot(string, string, string, WebAppsIsCloneableSlotOptionalParams)

Shows whether an app can be cloned to another resource group or subscription.

function isCloneableSlot(resourceGroupName: string, name: string, slot: string, options?: WebAppsIsCloneableSlotOptionalParams): Promise<SiteCloneability>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

slot: string

Name of the deployment slot. By default, this API returns information on the production slot.

options: WebAppsIsCloneableSlotOptionalParams

The options parameters.

Returns

Promise<SiteCloneability>

list(WebAppsListOptionalParams)

Get all apps for a subscription.

function list(options?: WebAppsListOptionalParams): PagedAsyncIterableIterator<Site, Site[], PageSettings>

Parameters

options: WebAppsListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Site, Site[], PageSettings>

listApplicationSettings(string, string, WebAppsListApplicationSettingsOptionalParams)

Gets the application settings of an app.

function listApplicationSettings(resourceGroupName: string, name: string, options?: WebAppsListApplicationSettingsOptionalParams): Promise<StringDictionary>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

options: WebAppsListApplicationSettingsOptionalParams

The options parameters.

Returns

Promise<StringDictionary>

listApplicationSettingsSlot(string, string, string, WebAppsListApplicationSettingsSlotOptionalParams)

Gets the application settings of an app.

function listApplicationSettingsSlot(resourceGroupName: string, name: string, slot: string, options?: WebAppsListApplicationSettingsSlotOptionalParams): Promise<StringDictionary>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

slot: string

Name of the deployment slot. If a slot is not specified, the API will get the application settings for the production slot.

options: WebAppsListApplicationSettingsSlotOptionalParams

The options parameters.

Returns

Promise<StringDictionary>

listAzureStorageAccounts(string, string, WebAppsListAzureStorageAccountsOptionalParams)

Gets the Azure storage account configurations of an app.

function listAzureStorageAccounts(resourceGroupName: string, name: string, options?: WebAppsListAzureStorageAccountsOptionalParams): Promise<AzureStoragePropertyDictionaryResource>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

options: WebAppsListAzureStorageAccountsOptionalParams

The options parameters.

Returns

listAzureStorageAccountsSlot(string, string, string, WebAppsListAzureStorageAccountsSlotOptionalParams)

Gets the Azure storage account configurations of an app.

function listAzureStorageAccountsSlot(resourceGroupName: string, name: string, slot: string, options?: WebAppsListAzureStorageAccountsSlotOptionalParams): Promise<AzureStoragePropertyDictionaryResource>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

slot: string

Name of the deployment slot. If a slot is not specified, the API will update the Azure storage account configurations for the production slot.

options: WebAppsListAzureStorageAccountsSlotOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<SiteConfigResource, SiteConfigResource[], PageSettings>

listBackups(string, string, WebAppsListBackupsOptionalParams)

Gets existing backups of an app.

function listBackups(resourceGroupName: string, name: string, options?: WebAppsListBackupsOptionalParams): PagedAsyncIterableIterator<BackupItem, BackupItem[], PageSettings>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

options: WebAppsListBackupsOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<BackupItem, BackupItem[], PageSettings>

listBackupsSlot(string, string, string, WebAppsListBackupsSlotOptionalParams)

Gets existing backups of an app.

function listBackupsSlot(resourceGroupName: string, name: string, slot: string, options?: WebAppsListBackupsSlotOptionalParams): PagedAsyncIterableIterator<BackupItem, BackupItem[], PageSettings>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

slot: string

Name of the deployment slot. If a slot is not specified, the API will get backups of the production slot.

options: WebAppsListBackupsSlotOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<BackupItem, BackupItem[], PageSettings>

listBackupStatusSecrets(string, string, string, BackupRequest, WebAppsListBackupStatusSecretsOptionalParams)

Gets status of a web app backup that may be in progress, including secrets associated with the backup, such as the Azure Storage SAS URL. Also can be used to update the SAS URL for the backup if a new URL is passed in the request body.

function listBackupStatusSecrets(resourceGroupName: string, name: string, backupId: string, request: BackupRequest, options?: WebAppsListBackupStatusSecretsOptionalParams): Promise<BackupItem>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of web app.

backupId: string

ID of backup.

request: BackupRequest

Information on backup request.

options: WebAppsListBackupStatusSecretsOptionalParams

The options parameters.

Returns

Promise<BackupItem>

listBackupStatusSecretsSlot(string, string, string, string, BackupRequest, WebAppsListBackupStatusSecretsSlotOptionalParams)

function listBackupStatusSecretsSlot(resourceGroupName: string, name: string, backupId: string, slot: string, request: BackupRequest, options?: WebAppsListBackupStatusSecretsSlotOptionalParams): Promise<BackupItem>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of web app.

backupId: string

ID of backup.

slot: string

Name of web app slot. If not specified then will default to production slot.

request: BackupRequest

Information on backup request.

options: WebAppsListBackupStatusSecretsSlotOptionalParams

The options parameters.

Returns

Promise<BackupItem>

listByResourceGroup(string, WebAppsListByResourceGroupOptionalParams)

Gets all web, mobile, and API apps in the specified resource group.

function listByResourceGroup(resourceGroupName: string, options?: WebAppsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<Site, Site[], PageSettings>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

options: WebAppsListByResourceGroupOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Site, Site[], PageSettings>

listConfigurations(string, string, WebAppsListConfigurationsOptionalParams)

List the configurations of an app

function listConfigurations(resourceGroupName: string, name: string, options?: WebAppsListConfigurationsOptionalParams): PagedAsyncIterableIterator<SiteConfigResource, SiteConfigResource[], PageSettings>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

options: WebAppsListConfigurationsOptionalParams

The options parameters.

Returns

listConfigurationSnapshotInfo(string, string, WebAppsListConfigurationSnapshotInfoOptionalParams)

Gets a list of web app configuration snapshots identifiers. Each element of the list contains a timestamp and the ID of the snapshot.

function listConfigurationSnapshotInfo(resourceGroupName: string, name: string, options?: WebAppsListConfigurationSnapshotInfoOptionalParams): PagedAsyncIterableIterator<SiteConfigurationSnapshotInfo, SiteConfigurationSnapshotInfo[], PageSettings>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

options: WebAppsListConfigurationSnapshotInfoOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<SiteConfigurationSnapshotInfo, SiteConfigurationSnapshotInfo[], PageSettings>

listConfigurationSnapshotInfoSlot(string, string, string, WebAppsListConfigurationSnapshotInfoSlotOptionalParams)

Gets a list of web app configuration snapshots identifiers. Each element of the list contains a timestamp and the ID of the snapshot.

function listConfigurationSnapshotInfoSlot(resourceGroupName: string, name: string, slot: string, options?: WebAppsListConfigurationSnapshotInfoSlotOptionalParams): PagedAsyncIterableIterator<SiteConfigurationSnapshotInfo, SiteConfigurationSnapshotInfo[], PageSettings>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

slot: string

Name of the deployment slot. If a slot is not specified, the API will return configuration for the production slot.

options: WebAppsListConfigurationSnapshotInfoSlotOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<SiteConfigurationSnapshotInfo, SiteConfigurationSnapshotInfo[], PageSettings>

listConfigurationsSlot(string, string, string, WebAppsListConfigurationsSlotOptionalParams)

List the configurations of an app

function listConfigurationsSlot(resourceGroupName: string, name: string, slot: string, options?: WebAppsListConfigurationsSlotOptionalParams): PagedAsyncIterableIterator<SiteConfigResource, SiteConfigResource[], PageSettings>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

slot: string

Name of the deployment slot. If a slot is not specified, the API will return configuration for the production slot.

options: WebAppsListConfigurationsSlotOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<SiteConfigResource, SiteConfigResource[], PageSettings>

listConnectionStrings(string, string, WebAppsListConnectionStringsOptionalParams)

Gets the connection strings of an app.

function listConnectionStrings(resourceGroupName: string, name: string, options?: WebAppsListConnectionStringsOptionalParams): Promise<ConnectionStringDictionary>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

options: WebAppsListConnectionStringsOptionalParams

The options parameters.

Returns

listConnectionStringsSlot(string, string, string, WebAppsListConnectionStringsSlotOptionalParams)

Gets the connection strings of an app.

function listConnectionStringsSlot(resourceGroupName: string, name: string, slot: string, options?: WebAppsListConnectionStringsSlotOptionalParams): Promise<ConnectionStringDictionary>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

slot: string

Name of the deployment slot. If a slot is not specified, the API will get the connection settings for the production slot.

options: WebAppsListConnectionStringsSlotOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<ProcessModuleInfo, ProcessModuleInfo[], PageSettings>

listContinuousWebJobs(string, string, WebAppsListContinuousWebJobsOptionalParams)

List continuous web jobs for an app, or a deployment slot.

function listContinuousWebJobs(resourceGroupName: string, name: string, options?: WebAppsListContinuousWebJobsOptionalParams): PagedAsyncIterableIterator<ContinuousWebJob, ContinuousWebJob[], PageSettings>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Site name.

options: WebAppsListContinuousWebJobsOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<ContinuousWebJob, ContinuousWebJob[], PageSettings>

listContinuousWebJobsSlot(string, string, string, WebAppsListContinuousWebJobsSlotOptionalParams)

List continuous web jobs for an app, or a deployment slot.

function listContinuousWebJobsSlot(resourceGroupName: string, name: string, slot: string, options?: WebAppsListContinuousWebJobsSlotOptionalParams): PagedAsyncIterableIterator<ContinuousWebJob, ContinuousWebJob[], PageSettings>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Site name.

slot: string

Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.

options: WebAppsListContinuousWebJobsSlotOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<ContinuousWebJob, ContinuousWebJob[], PageSettings>

listDeploymentLog(string, string, string, WebAppsListDeploymentLogOptionalParams)

List deployment log for specific deployment for an app, or a deployment slot.

function listDeploymentLog(resourceGroupName: string, name: string, id: string, options?: WebAppsListDeploymentLogOptionalParams): Promise<Deployment>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

id: string

The ID of a specific deployment. This is the value of the name property in the JSON response from "GET /api/sites/{siteName}/deployments".

options: WebAppsListDeploymentLogOptionalParams

The options parameters.

Returns

Promise<Deployment>

listDeploymentLogSlot(string, string, string, string, WebAppsListDeploymentLogSlotOptionalParams)

List deployment log for specific deployment for an app, or a deployment slot.

function listDeploymentLogSlot(resourceGroupName: string, name: string, id: string, slot: string, options?: WebAppsListDeploymentLogSlotOptionalParams): Promise<Deployment>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

id: string

The ID of a specific deployment. This is the value of the name property in the JSON response from "GET /api/sites/{siteName}/deployments".

slot: string

Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.

options: WebAppsListDeploymentLogSlotOptionalParams

The options parameters.

Returns

Promise<Deployment>

listDeployments(string, string, WebAppsListDeploymentsOptionalParams)

List deployments for an app, or a deployment slot.

function listDeployments(resourceGroupName: string, name: string, options?: WebAppsListDeploymentsOptionalParams): PagedAsyncIterableIterator<Deployment, Deployment[], PageSettings>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

options: WebAppsListDeploymentsOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Deployment, Deployment[], PageSettings>

listDeploymentsSlot(string, string, string, WebAppsListDeploymentsSlotOptionalParams)

List deployments for an app, or a deployment slot.

function listDeploymentsSlot(resourceGroupName: string, name: string, slot: string, options?: WebAppsListDeploymentsSlotOptionalParams): PagedAsyncIterableIterator<Deployment, Deployment[], PageSettings>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

slot: string

Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.

options: WebAppsListDeploymentsSlotOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Deployment, Deployment[], PageSettings>

listDomainOwnershipIdentifiers(string, string, WebAppsListDomainOwnershipIdentifiersOptionalParams)

Lists ownership identifiers for domain associated with web app.

function listDomainOwnershipIdentifiers(resourceGroupName: string, name: string, options?: WebAppsListDomainOwnershipIdentifiersOptionalParams): PagedAsyncIterableIterator<Identifier, Identifier[], PageSettings>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

options: WebAppsListDomainOwnershipIdentifiersOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Identifier, Identifier[], PageSettings>

listDomainOwnershipIdentifiersSlot(string, string, string, WebAppsListDomainOwnershipIdentifiersSlotOptionalParams)

Lists ownership identifiers for domain associated with web app.

function listDomainOwnershipIdentifiersSlot(resourceGroupName: string, name: string, slot: string, options?: WebAppsListDomainOwnershipIdentifiersSlotOptionalParams): PagedAsyncIterableIterator<Identifier, Identifier[], PageSettings>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

slot: string

Name of the deployment slot. If a slot is not specified, the API will delete the binding for the production slot.

options: WebAppsListDomainOwnershipIdentifiersSlotOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Identifier, Identifier[], PageSettings>

listFunctionKeys(string, string, string, WebAppsListFunctionKeysOptionalParams)

Get function keys for a function in a web site, or a deployment slot.

function listFunctionKeys(resourceGroupName: string, name: string, functionName: string, options?: WebAppsListFunctionKeysOptionalParams): Promise<StringDictionary>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Site name.

functionName: string

Function name.

options: WebAppsListFunctionKeysOptionalParams

The options parameters.

Returns

Promise<StringDictionary>

listFunctionKeysSlot(string, string, string, string, WebAppsListFunctionKeysSlotOptionalParams)

Get function keys for a function in a web site, or a deployment slot.

function listFunctionKeysSlot(resourceGroupName: string, name: string, functionName: string, slot: string, options?: WebAppsListFunctionKeysSlotOptionalParams): Promise<StringDictionary>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Site name.

functionName: string

Function name.

slot: string

Name of the deployment slot.

options: WebAppsListFunctionKeysSlotOptionalParams

The options parameters.

Returns

Promise<StringDictionary>

listFunctions(string, string, WebAppsListFunctionsOptionalParams)

List the functions for a web site, or a deployment slot.

function listFunctions(resourceGroupName: string, name: string, options?: WebAppsListFunctionsOptionalParams): PagedAsyncIterableIterator<FunctionEnvelope, FunctionEnvelope[], PageSettings>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Site name.

options: WebAppsListFunctionsOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<FunctionEnvelope, FunctionEnvelope[], PageSettings>

listFunctionSecrets(string, string, string, WebAppsListFunctionSecretsOptionalParams)

Get function secrets for a function in a web site, or a deployment slot.

function listFunctionSecrets(resourceGroupName: string, name: string, functionName: string, options?: WebAppsListFunctionSecretsOptionalParams): Promise<FunctionSecrets>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Site name.

functionName: string

Function name.

options: WebAppsListFunctionSecretsOptionalParams

The options parameters.

Returns

Promise<FunctionSecrets>

listFunctionSecretsSlot(string, string, string, string, WebAppsListFunctionSecretsSlotOptionalParams)

Get function secrets for a function in a web site, or a deployment slot.

function listFunctionSecretsSlot(resourceGroupName: string, name: string, functionName: string, slot: string, options?: WebAppsListFunctionSecretsSlotOptionalParams): Promise<FunctionSecrets>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Site name.

functionName: string

Function name.

slot: string

Name of the deployment slot.

options: WebAppsListFunctionSecretsSlotOptionalParams

The options parameters.

Returns

Promise<FunctionSecrets>

listHostKeys(string, string, WebAppsListHostKeysOptionalParams)

Get host secrets for a function app.

function listHostKeys(resourceGroupName: string, name: string, options?: WebAppsListHostKeysOptionalParams): Promise<HostKeys>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Site name.

options: WebAppsListHostKeysOptionalParams

The options parameters.

Returns

Promise<HostKeys>

listHostKeysSlot(string, string, string, WebAppsListHostKeysSlotOptionalParams)

Get host secrets for a function app.

function listHostKeysSlot(resourceGroupName: string, name: string, slot: string, options?: WebAppsListHostKeysSlotOptionalParams): Promise<HostKeys>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Site name.

slot: string

Name of the deployment slot.

options: WebAppsListHostKeysSlotOptionalParams

The options parameters.

Returns

Promise<HostKeys>

listHostNameBindings(string, string, WebAppsListHostNameBindingsOptionalParams)

Get hostname bindings for an app or a deployment slot.

function listHostNameBindings(resourceGroupName: string, name: string, options?: WebAppsListHostNameBindingsOptionalParams): PagedAsyncIterableIterator<HostNameBinding, HostNameBinding[], PageSettings>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

options: WebAppsListHostNameBindingsOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<HostNameBinding, HostNameBinding[], PageSettings>

listHostNameBindingsSlot(string, string, string, WebAppsListHostNameBindingsSlotOptionalParams)

Get hostname bindings for an app or a deployment slot.

function listHostNameBindingsSlot(resourceGroupName: string, name: string, slot: string, options?: WebAppsListHostNameBindingsSlotOptionalParams): PagedAsyncIterableIterator<HostNameBinding, HostNameBinding[], PageSettings>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

slot: string

Name of the deployment slot. If a slot is not specified, the API gets hostname bindings for the production slot.

options: WebAppsListHostNameBindingsSlotOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<HostNameBinding, HostNameBinding[], PageSettings>

listHybridConnectionKeys(string, string, string, string, WebAppsListHybridConnectionKeysOptionalParams)

Gets the send key name and value for a Hybrid Connection.

function listHybridConnectionKeys(resourceGroupName: string, name: string, namespaceName: string, relayName: string, options?: WebAppsListHybridConnectionKeysOptionalParams): Promise<HybridConnectionKey>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

The name of the web app.

namespaceName: string

The namespace for this hybrid connection.

relayName: string

The relay name for this hybrid connection.

options: WebAppsListHybridConnectionKeysOptionalParams

The options parameters.

Returns

Promise<HybridConnectionKey>

listHybridConnectionKeysSlot(string, string, string, string, string, WebAppsListHybridConnectionKeysSlotOptionalParams)

Gets the send key name and value for a Hybrid Connection.

function listHybridConnectionKeysSlot(resourceGroupName: string, name: string, namespaceName: string, relayName: string, slot: string, options?: WebAppsListHybridConnectionKeysSlotOptionalParams): Promise<HybridConnectionKey>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

The name of the web app.

namespaceName: string

The namespace for this hybrid connection.

relayName: string

The relay name for this hybrid connection.

slot: string

The name of the slot for the web app.

options: WebAppsListHybridConnectionKeysSlotOptionalParams

The options parameters.

Returns

Promise<HybridConnectionKey>

listHybridConnections(string, string, WebAppsListHybridConnectionsOptionalParams)

Retrieves all Service Bus Hybrid Connections used by this Web App.

function listHybridConnections(resourceGroupName: string, name: string, options?: WebAppsListHybridConnectionsOptionalParams): Promise<HybridConnection>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

The name of the web app.

options: WebAppsListHybridConnectionsOptionalParams

The options parameters.

Returns

Promise<HybridConnection>

listHybridConnectionsSlot(string, string, string, WebAppsListHybridConnectionsSlotOptionalParams)

Retrieves all Service Bus Hybrid Connections used by this Web App.

function listHybridConnectionsSlot(resourceGroupName: string, name: string, slot: string, options?: WebAppsListHybridConnectionsSlotOptionalParams): Promise<HybridConnection>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

The name of the web app.

slot: string

The name of the slot for the web app.

options: WebAppsListHybridConnectionsSlotOptionalParams

The options parameters.

Returns

Promise<HybridConnection>

listInstanceFunctionsSlot(string, string, string, WebAppsListInstanceFunctionsSlotOptionalParams)

List the functions for a web site, or a deployment slot.

function listInstanceFunctionsSlot(resourceGroupName: string, name: string, slot: string, options?: WebAppsListInstanceFunctionsSlotOptionalParams): PagedAsyncIterableIterator<FunctionEnvelope, FunctionEnvelope[], PageSettings>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Site name.

slot: string

Name of the deployment slot.

options: WebAppsListInstanceFunctionsSlotOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<FunctionEnvelope, FunctionEnvelope[], PageSettings>

listInstanceIdentifiers(string, string, WebAppsListInstanceIdentifiersOptionalParams)

Gets all scale-out instances of an app.

function listInstanceIdentifiers(resourceGroupName: string, name: string, options?: WebAppsListInstanceIdentifiersOptionalParams): PagedAsyncIterableIterator<SiteInstance, SiteInstance[], PageSettings>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

options: WebAppsListInstanceIdentifiersOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<SiteInstance, SiteInstance[], PageSettings>

listInstanceIdentifiersSlot(string, string, string, WebAppsListInstanceIdentifiersSlotOptionalParams)

Gets all scale-out instances of an app.

function listInstanceIdentifiersSlot(resourceGroupName: string, name: string, slot: string, options?: WebAppsListInstanceIdentifiersSlotOptionalParams): PagedAsyncIterableIterator<SiteInstance, SiteInstance[], PageSettings>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

slot: string

Name of the deployment slot. If a slot is not specified, the API gets the production slot instances.

options: WebAppsListInstanceIdentifiersSlotOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<SiteInstance, SiteInstance[], PageSettings>

listInstanceProcesses(string, string, string, WebAppsListInstanceProcessesOptionalParams)

Get list of processes for a web site, or a deployment slot, or for a specific scaled-out instance in a web site.

function listInstanceProcesses(resourceGroupName: string, name: string, instanceId: string, options?: WebAppsListInstanceProcessesOptionalParams): PagedAsyncIterableIterator<ProcessInfo, ProcessInfo[], PageSettings>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Site name.

instanceId: string

ID of a specific scaled-out instance. This is the value of the name property in the JSON response from "GET api/sites/{siteName}/instances".

options: WebAppsListInstanceProcessesOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<ProcessInfo, ProcessInfo[], PageSettings>

listInstanceProcessesSlot(string, string, string, string, WebAppsListInstanceProcessesSlotOptionalParams)

Get list of processes for a web site, or a deployment slot, or for a specific scaled-out instance in a web site.

function listInstanceProcessesSlot(resourceGroupName: string, name: string, slot: string, instanceId: string, options?: WebAppsListInstanceProcessesSlotOptionalParams): PagedAsyncIterableIterator<ProcessInfo, ProcessInfo[], PageSettings>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Site name.

slot: string

Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.

instanceId: string

ID of a specific scaled-out instance. This is the value of the name property in the JSON response from "GET api/sites/{siteName}/instances".

options: WebAppsListInstanceProcessesSlotOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<ProcessInfo, ProcessInfo[], PageSettings>

listInstanceProcessModules(string, string, string, string, WebAppsListInstanceProcessModulesOptionalParams)

List module information for a process by its ID for a specific scaled-out instance in a web site.

function listInstanceProcessModules(resourceGroupName: string, name: string, processId: string, instanceId: string, options?: WebAppsListInstanceProcessModulesOptionalParams): PagedAsyncIterableIterator<ProcessModuleInfo, ProcessModuleInfo[], PageSettings>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Site name.

processId: string

PID.

instanceId: string

ID of a specific scaled-out instance. This is the value of the name property in the JSON response from "GET api/sites/{siteName}/instances".

options: WebAppsListInstanceProcessModulesOptionalParams

The options parameters.

Returns

listInstanceProcessModulesSlot(string, string, string, string, string, WebAppsListInstanceProcessModulesSlotOptionalParams)

List module information for a process by its ID for a specific scaled-out instance in a web site.

function listInstanceProcessModulesSlot(resourceGroupName: string, name: string, processId: string, slot: string, instanceId: string, options?: WebAppsListInstanceProcessModulesSlotOptionalParams): PagedAsyncIterableIterator<ProcessModuleInfo, ProcessModuleInfo[], PageSettings>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Site name.

processId: string

PID.

slot: string

Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.

instanceId: string

ID of a specific scaled-out instance. This is the value of the name property in the JSON response from "GET api/sites/{siteName}/instances".

options: WebAppsListInstanceProcessModulesSlotOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<ProcessModuleInfo, ProcessModuleInfo[], PageSettings>

listInstanceProcessThreads(string, string, string, string, WebAppsListInstanceProcessThreadsOptionalParams)

List the threads in a process by its ID for a specific scaled-out instance in a web site.

function listInstanceProcessThreads(resourceGroupName: string, name: string, processId: string, instanceId: string, options?: WebAppsListInstanceProcessThreadsOptionalParams): PagedAsyncIterableIterator<ProcessThreadInfo, ProcessThreadInfo[], PageSettings>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Site name.

processId: string

PID.

instanceId: string

ID of a specific scaled-out instance. This is the value of the name property in the JSON response from "GET api/sites/{siteName}/instances".

options: WebAppsListInstanceProcessThreadsOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<ProcessThreadInfo, ProcessThreadInfo[], PageSettings>

listInstanceProcessThreadsSlot(string, string, string, string, string, WebAppsListInstanceProcessThreadsSlotOptionalParams)

List the threads in a process by its ID for a specific scaled-out instance in a web site.

function listInstanceProcessThreadsSlot(resourceGroupName: string, name: string, processId: string, slot: string, instanceId: string, options?: WebAppsListInstanceProcessThreadsSlotOptionalParams): PagedAsyncIterableIterator<ProcessThreadInfo, ProcessThreadInfo[], PageSettings>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Site name.

processId: string

PID.

slot: string

Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.

instanceId: string

ID of a specific scaled-out instance. This is the value of the name property in the JSON response from "GET api/sites/{siteName}/instances".

options: WebAppsListInstanceProcessThreadsSlotOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<ProcessThreadInfo, ProcessThreadInfo[], PageSettings>

listMetadata(string, string, WebAppsListMetadataOptionalParams)

Gets the metadata of an app.

function listMetadata(resourceGroupName: string, name: string, options?: WebAppsListMetadataOptionalParams): Promise<StringDictionary>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

options: WebAppsListMetadataOptionalParams

The options parameters.

Returns

Promise<StringDictionary>

listMetadataSlot(string, string, string, WebAppsListMetadataSlotOptionalParams)

Gets the metadata of an app.

function listMetadataSlot(resourceGroupName: string, name: string, slot: string, options?: WebAppsListMetadataSlotOptionalParams): Promise<StringDictionary>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

slot: string

Name of the deployment slot. If a slot is not specified, the API will get the metadata for the production slot.

options: WebAppsListMetadataSlotOptionalParams

The options parameters.

Returns

Promise<StringDictionary>

listMetricDefinitions(string, string, WebAppsListMetricDefinitionsOptionalParams)

Gets all metric definitions of an app (or deployment slot, if specified).

function listMetricDefinitions(resourceGroupName: string, name: string, options?: WebAppsListMetricDefinitionsOptionalParams): PagedAsyncIterableIterator<ResourceMetricDefinition, ResourceMetricDefinition[], PageSettings>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

options: WebAppsListMetricDefinitionsOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<ResourceMetricDefinition, ResourceMetricDefinition[], PageSettings>

listMetricDefinitionsSlot(string, string, string, WebAppsListMetricDefinitionsSlotOptionalParams)

Gets all metric definitions of an app (or deployment slot, if specified).

function listMetricDefinitionsSlot(resourceGroupName: string, name: string, slot: string, options?: WebAppsListMetricDefinitionsSlotOptionalParams): PagedAsyncIterableIterator<ResourceMetricDefinition, ResourceMetricDefinition[], PageSettings>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

slot: string

Name of the deployment slot. If a slot is not specified, the API will get metric definitions of the production slot.

options: WebAppsListMetricDefinitionsSlotOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<ResourceMetricDefinition, ResourceMetricDefinition[], PageSettings>

listMetrics(string, string, WebAppsListMetricsOptionalParams)

Gets performance metrics of an app (or deployment slot, if specified).

function listMetrics(resourceGroupName: string, name: string, options?: WebAppsListMetricsOptionalParams): PagedAsyncIterableIterator<ResourceMetric, ResourceMetric[], PageSettings>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

options: WebAppsListMetricsOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<ResourceMetric, ResourceMetric[], PageSettings>

listMetricsSlot(string, string, string, WebAppsListMetricsSlotOptionalParams)

Gets performance metrics of an app (or deployment slot, if specified).

function listMetricsSlot(resourceGroupName: string, name: string, slot: string, options?: WebAppsListMetricsSlotOptionalParams): PagedAsyncIterableIterator<ResourceMetric, ResourceMetric[], PageSettings>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

slot: string

Name of the deployment slot. If a slot is not specified, the API will get metrics of the production slot.

options: WebAppsListMetricsSlotOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<ResourceMetric, ResourceMetric[], PageSettings>

listNetworkFeatures(string, string, string, WebAppsListNetworkFeaturesOptionalParams)

Gets all network features used by the app (or deployment slot, if specified).

function listNetworkFeatures(resourceGroupName: string, name: string, view: string, options?: WebAppsListNetworkFeaturesOptionalParams): Promise<NetworkFeatures>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

view: string

The type of view. This can either be "summary" or "detailed".

options: WebAppsListNetworkFeaturesOptionalParams

The options parameters.

Returns

Promise<NetworkFeatures>

listNetworkFeaturesSlot(string, string, string, string, WebAppsListNetworkFeaturesSlotOptionalParams)

Gets all network features used by the app (or deployment slot, if specified).

function listNetworkFeaturesSlot(resourceGroupName: string, name: string, view: string, slot: string, options?: WebAppsListNetworkFeaturesSlotOptionalParams): Promise<NetworkFeatures>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

view: string

The type of view. This can either be "summary" or "detailed".

slot: string

Name of the deployment slot. If a slot is not specified, the API will get network features for the production slot.

options: WebAppsListNetworkFeaturesSlotOptionalParams

The options parameters.

Returns

Promise<NetworkFeatures>

listPerfMonCounters(string, string, WebAppsListPerfMonCountersOptionalParams)

Gets perfmon counters for web app.

function listPerfMonCounters(resourceGroupName: string, name: string, options?: WebAppsListPerfMonCountersOptionalParams): PagedAsyncIterableIterator<PerfMonResponse, PerfMonResponse[], PageSettings>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of web app.

options: WebAppsListPerfMonCountersOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<PerfMonResponse, PerfMonResponse[], PageSettings>

listPerfMonCountersSlot(string, string, string, WebAppsListPerfMonCountersSlotOptionalParams)

Gets perfmon counters for web app.

function listPerfMonCountersSlot(resourceGroupName: string, name: string, slot: string, options?: WebAppsListPerfMonCountersSlotOptionalParams): PagedAsyncIterableIterator<PerfMonResponse, PerfMonResponse[], PageSettings>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of web app.

slot: string

Name of web app slot. If not specified then will default to production slot.

options: WebAppsListPerfMonCountersSlotOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<PerfMonResponse, PerfMonResponse[], PageSettings>

listPremierAddOns(string, string, WebAppsListPremierAddOnsOptionalParams)

Gets the premier add-ons of an app.

function listPremierAddOns(resourceGroupName: string, name: string, options?: WebAppsListPremierAddOnsOptionalParams): Promise<PremierAddOn>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

options: WebAppsListPremierAddOnsOptionalParams

The options parameters.

Returns

Promise<PremierAddOn>

listPremierAddOnsSlot(string, string, string, WebAppsListPremierAddOnsSlotOptionalParams)

Gets the premier add-ons of an app.

function listPremierAddOnsSlot(resourceGroupName: string, name: string, slot: string, options?: WebAppsListPremierAddOnsSlotOptionalParams): Promise<PremierAddOn>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

slot: string

Name of the deployment slot. If a slot is not specified, the API will get the premier add-ons for the production slot.

options: WebAppsListPremierAddOnsSlotOptionalParams

The options parameters.

Returns

Promise<PremierAddOn>

listProcesses(string, string, WebAppsListProcessesOptionalParams)

Get list of processes for a web site, or a deployment slot, or for a specific scaled-out instance in a web site.

function listProcesses(resourceGroupName: string, name: string, options?: WebAppsListProcessesOptionalParams): PagedAsyncIterableIterator<ProcessInfo, ProcessInfo[], PageSettings>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Site name.

options: WebAppsListProcessesOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<ProcessInfo, ProcessInfo[], PageSettings>

listProcessesSlot(string, string, string, WebAppsListProcessesSlotOptionalParams)

Get list of processes for a web site, or a deployment slot, or for a specific scaled-out instance in a web site.

function listProcessesSlot(resourceGroupName: string, name: string, slot: string, options?: WebAppsListProcessesSlotOptionalParams): PagedAsyncIterableIterator<ProcessInfo, ProcessInfo[], PageSettings>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Site name.

slot: string

Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.

options: WebAppsListProcessesSlotOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<ProcessInfo, ProcessInfo[], PageSettings>

listProcessModules(string, string, string, WebAppsListProcessModulesOptionalParams)

List module information for a process by its ID for a specific scaled-out instance in a web site.

function listProcessModules(resourceGroupName: string, name: string, processId: string, options?: WebAppsListProcessModulesOptionalParams): PagedAsyncIterableIterator<ProcessModuleInfo, ProcessModuleInfo[], PageSettings>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Site name.

processId: string

PID.

options: WebAppsListProcessModulesOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<ProcessModuleInfo, ProcessModuleInfo[], PageSettings>

listProcessModulesSlot(string, string, string, string, WebAppsListProcessModulesSlotOptionalParams)

List module information for a process by its ID for a specific scaled-out instance in a web site.

function listProcessModulesSlot(resourceGroupName: string, name: string, processId: string, slot: string, options?: WebAppsListProcessModulesSlotOptionalParams): PagedAsyncIterableIterator<ProcessModuleInfo, ProcessModuleInfo[], PageSettings>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Site name.

processId: string

PID.

slot: string

Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.

options: WebAppsListProcessModulesSlotOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<ProcessModuleInfo, ProcessModuleInfo[], PageSettings>

listProcessThreads(string, string, string, WebAppsListProcessThreadsOptionalParams)

List the threads in a process by its ID for a specific scaled-out instance in a web site.

function listProcessThreads(resourceGroupName: string, name: string, processId: string, options?: WebAppsListProcessThreadsOptionalParams): PagedAsyncIterableIterator<ProcessThreadInfo, ProcessThreadInfo[], PageSettings>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Site name.

processId: string

PID.

options: WebAppsListProcessThreadsOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<ProcessThreadInfo, ProcessThreadInfo[], PageSettings>

listProcessThreadsSlot(string, string, string, string, WebAppsListProcessThreadsSlotOptionalParams)

List the threads in a process by its ID for a specific scaled-out instance in a web site.

function listProcessThreadsSlot(resourceGroupName: string, name: string, processId: string, slot: string, options?: WebAppsListProcessThreadsSlotOptionalParams): PagedAsyncIterableIterator<ProcessThreadInfo, ProcessThreadInfo[], PageSettings>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Site name.

processId: string

PID.

slot: string

Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.

options: WebAppsListProcessThreadsSlotOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<ProcessThreadInfo, ProcessThreadInfo[], PageSettings>

listPublicCertificates(string, string, WebAppsListPublicCertificatesOptionalParams)

Get public certificates for an app or a deployment slot.

function listPublicCertificates(resourceGroupName: string, name: string, options?: WebAppsListPublicCertificatesOptionalParams): PagedAsyncIterableIterator<PublicCertificate, PublicCertificate[], PageSettings>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

options: WebAppsListPublicCertificatesOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<PublicCertificate, PublicCertificate[], PageSettings>

listPublicCertificatesSlot(string, string, string, WebAppsListPublicCertificatesSlotOptionalParams)

Get public certificates for an app or a deployment slot.

function listPublicCertificatesSlot(resourceGroupName: string, name: string, slot: string, options?: WebAppsListPublicCertificatesSlotOptionalParams): PagedAsyncIterableIterator<PublicCertificate, PublicCertificate[], PageSettings>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

slot: string

Name of the deployment slot. If a slot is not specified, the API gets hostname bindings for the production slot.

options: WebAppsListPublicCertificatesSlotOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<PublicCertificate, PublicCertificate[], PageSettings>

listPublishingProfileXmlWithSecrets(string, string, CsmPublishingProfileOptions, WebAppsListPublishingProfileXmlWithSecretsOptionalParams)

Gets the publishing profile for an app (or deployment slot, if specified).

function listPublishingProfileXmlWithSecrets(resourceGroupName: string, name: string, publishingProfileOptions: CsmPublishingProfileOptions, options?: WebAppsListPublishingProfileXmlWithSecretsOptionalParams): Promise<WebAppsListPublishingProfileXmlWithSecretsResponse>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

publishingProfileOptions: CsmPublishingProfileOptions

Specifies publishingProfileOptions for publishing profile. For example, use {"format": "FileZilla3"} to get a FileZilla publishing profile.

options: WebAppsListPublishingProfileXmlWithSecretsOptionalParams

The options parameters.

Returns

Promise<WebAppsListPublishingProfileXmlWithSecretsResponse>

listPublishingProfileXmlWithSecretsSlot(string, string, string, CsmPublishingProfileOptions, WebAppsListPublishingProfileXmlWithSecretsSlotOptionalParams)

Gets the publishing profile for an app (or deployment slot, if specified).

function listPublishingProfileXmlWithSecretsSlot(resourceGroupName: string, name: string, slot: string, publishingProfileOptions: CsmPublishingProfileOptions, options?: WebAppsListPublishingProfileXmlWithSecretsSlotOptionalParams): Promise<WebAppsListPublishingProfileXmlWithSecretsSlotResponse>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

slot: string

Name of the deployment slot. If a slot is not specified, the API will get the publishing profile for the production slot.

publishingProfileOptions: CsmPublishingProfileOptions

Specifies publishingProfileOptions for publishing profile. For example, use {"format": "FileZilla3"} to get a FileZilla publishing profile.

options: WebAppsListPublishingProfileXmlWithSecretsSlotOptionalParams

The options parameters.

Returns

Promise<WebAppsListPublishingProfileXmlWithSecretsSlotResponse>

listRelayServiceConnections(string, string, WebAppsListRelayServiceConnectionsOptionalParams)

Gets hybrid connections configured for an app (or deployment slot, if specified).

function listRelayServiceConnections(resourceGroupName: string, name: string, options?: WebAppsListRelayServiceConnectionsOptionalParams): Promise<RelayServiceConnectionEntity>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

options: WebAppsListRelayServiceConnectionsOptionalParams

The options parameters.

Returns

listRelayServiceConnectionsSlot(string, string, string, WebAppsListRelayServiceConnectionsSlotOptionalParams)

Gets hybrid connections configured for an app (or deployment slot, if specified).

function listRelayServiceConnectionsSlot(resourceGroupName: string, name: string, slot: string, options?: WebAppsListRelayServiceConnectionsSlotOptionalParams): Promise<RelayServiceConnectionEntity>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

slot: string

Name of the deployment slot. If a slot is not specified, the API will get hybrid connections for the production slot.

options: WebAppsListRelayServiceConnectionsSlotOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<SiteExtensionInfo, SiteExtensionInfo[], PageSettings>

listSiteExtensions(string, string, WebAppsListSiteExtensionsOptionalParams)

Get list of siteextensions for a web site, or a deployment slot.

function listSiteExtensions(resourceGroupName: string, name: string, options?: WebAppsListSiteExtensionsOptionalParams): PagedAsyncIterableIterator<SiteExtensionInfo, SiteExtensionInfo[], PageSettings>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Site name.

options: WebAppsListSiteExtensionsOptionalParams

The options parameters.

Returns

listSiteExtensionsSlot(string, string, string, WebAppsListSiteExtensionsSlotOptionalParams)

Get list of siteextensions for a web site, or a deployment slot.

function listSiteExtensionsSlot(resourceGroupName: string, name: string, slot: string, options?: WebAppsListSiteExtensionsSlotOptionalParams): PagedAsyncIterableIterator<SiteExtensionInfo, SiteExtensionInfo[], PageSettings>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Site name.

slot: string

Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.

options: WebAppsListSiteExtensionsSlotOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<SiteExtensionInfo, SiteExtensionInfo[], PageSettings>

listSitePushSettings(string, string, WebAppsListSitePushSettingsOptionalParams)

Gets the Push settings associated with web app.

function listSitePushSettings(resourceGroupName: string, name: string, options?: WebAppsListSitePushSettingsOptionalParams): Promise<PushSettings>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of web app.

options: WebAppsListSitePushSettingsOptionalParams

The options parameters.

Returns

Promise<PushSettings>

listSitePushSettingsSlot(string, string, string, WebAppsListSitePushSettingsSlotOptionalParams)

Gets the Push settings associated with web app.

function listSitePushSettingsSlot(resourceGroupName: string, name: string, slot: string, options?: WebAppsListSitePushSettingsSlotOptionalParams): Promise<PushSettings>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of web app.

slot: string

Name of web app slot. If not specified then will default to production slot.

options: WebAppsListSitePushSettingsSlotOptionalParams

The options parameters.

Returns

Promise<PushSettings>

listSlotConfigurationNames(string, string, WebAppsListSlotConfigurationNamesOptionalParams)

Gets the names of app settings and connection strings that stick to the slot (not swapped).

function listSlotConfigurationNames(resourceGroupName: string, name: string, options?: WebAppsListSlotConfigurationNamesOptionalParams): Promise<SlotConfigNamesResource>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

options: WebAppsListSlotConfigurationNamesOptionalParams

The options parameters.

Returns

Promise<SlotConfigNamesResource>

listSlotDifferencesFromProduction(string, string, CsmSlotEntity, WebAppsListSlotDifferencesFromProductionOptionalParams)

Get the difference in configuration settings between two web app slots.

function listSlotDifferencesFromProduction(resourceGroupName: string, name: string, slotSwapEntity: CsmSlotEntity, options?: WebAppsListSlotDifferencesFromProductionOptionalParams): PagedAsyncIterableIterator<SlotDifference, SlotDifference[], PageSettings>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

slotSwapEntity: CsmSlotEntity

JSON object that contains the target slot name. See example.

options: WebAppsListSlotDifferencesFromProductionOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<SlotDifference, SlotDifference[], PageSettings>

listSlotDifferencesSlot(string, string, string, CsmSlotEntity, WebAppsListSlotDifferencesSlotOptionalParams)

Get the difference in configuration settings between two web app slots.

function listSlotDifferencesSlot(resourceGroupName: string, name: string, slot: string, slotSwapEntity: CsmSlotEntity, options?: WebAppsListSlotDifferencesSlotOptionalParams): PagedAsyncIterableIterator<SlotDifference, SlotDifference[], PageSettings>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

slot: string

Name of the source slot. If a slot is not specified, the production slot is used as the source slot.

slotSwapEntity: CsmSlotEntity

JSON object that contains the target slot name. See example.

options: WebAppsListSlotDifferencesSlotOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<SlotDifference, SlotDifference[], PageSettings>

listSlots(string, string, WebAppsListSlotsOptionalParams)

Gets an app's deployment slots.

function listSlots(resourceGroupName: string, name: string, options?: WebAppsListSlotsOptionalParams): PagedAsyncIterableIterator<Site, Site[], PageSettings>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

options: WebAppsListSlotsOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Site, Site[], PageSettings>

listSnapshots(string, string, WebAppsListSnapshotsOptionalParams)

Returns all Snapshots to the user.

function listSnapshots(resourceGroupName: string, name: string, options?: WebAppsListSnapshotsOptionalParams): PagedAsyncIterableIterator<Snapshot, Snapshot[], PageSettings>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Website Name.

options: WebAppsListSnapshotsOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Snapshot, Snapshot[], PageSettings>

listSnapshotsFromDRSecondary(string, string, WebAppsListSnapshotsFromDRSecondaryOptionalParams)

Returns all Snapshots to the user from DRSecondary endpoint.

function listSnapshotsFromDRSecondary(resourceGroupName: string, name: string, options?: WebAppsListSnapshotsFromDRSecondaryOptionalParams): PagedAsyncIterableIterator<Snapshot, Snapshot[], PageSettings>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Website Name.

options: WebAppsListSnapshotsFromDRSecondaryOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Snapshot, Snapshot[], PageSettings>

listSnapshotsFromDRSecondarySlot(string, string, string, WebAppsListSnapshotsFromDRSecondarySlotOptionalParams)

Returns all Snapshots to the user from DRSecondary endpoint.

function listSnapshotsFromDRSecondarySlot(resourceGroupName: string, name: string, slot: string, options?: WebAppsListSnapshotsFromDRSecondarySlotOptionalParams): PagedAsyncIterableIterator<Snapshot, Snapshot[], PageSettings>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Website Name.

slot: string

Website Slot.

options: WebAppsListSnapshotsFromDRSecondarySlotOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Snapshot, Snapshot[], PageSettings>

listSnapshotsSlot(string, string, string, WebAppsListSnapshotsSlotOptionalParams)

Returns all Snapshots to the user.

function listSnapshotsSlot(resourceGroupName: string, name: string, slot: string, options?: WebAppsListSnapshotsSlotOptionalParams): PagedAsyncIterableIterator<Snapshot, Snapshot[], PageSettings>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Website Name.

slot: string

Website Slot.

options: WebAppsListSnapshotsSlotOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Snapshot, Snapshot[], PageSettings>

listSyncFunctionTriggers(string, string, WebAppsListSyncFunctionTriggersOptionalParams)

This is to allow calling via powershell and ARM template.

function listSyncFunctionTriggers(resourceGroupName: string, name: string, options?: WebAppsListSyncFunctionTriggersOptionalParams): Promise<FunctionSecrets>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

options: WebAppsListSyncFunctionTriggersOptionalParams

The options parameters.

Returns

Promise<FunctionSecrets>

listSyncFunctionTriggersSlot(string, string, string, WebAppsListSyncFunctionTriggersSlotOptionalParams)

This is to allow calling via powershell and ARM template.

function listSyncFunctionTriggersSlot(resourceGroupName: string, name: string, slot: string, options?: WebAppsListSyncFunctionTriggersSlotOptionalParams): Promise<FunctionSecrets>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

slot: string

Name of the deployment slot.

options: WebAppsListSyncFunctionTriggersSlotOptionalParams

The options parameters.

Returns

Promise<FunctionSecrets>

listSyncStatus(string, string, WebAppsListSyncStatusOptionalParams)

This is to allow calling via powershell and ARM template.

function listSyncStatus(resourceGroupName: string, name: string, options?: WebAppsListSyncStatusOptionalParams): Promise<void>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

options: WebAppsListSyncStatusOptionalParams

The options parameters.

Returns

Promise<void>

listSyncStatusSlot(string, string, string, WebAppsListSyncStatusSlotOptionalParams)

This is to allow calling via powershell and ARM template.

function listSyncStatusSlot(resourceGroupName: string, name: string, slot: string, options?: WebAppsListSyncStatusSlotOptionalParams): Promise<void>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

slot: string

Name of the deployment slot.

options: WebAppsListSyncStatusSlotOptionalParams

The options parameters.

Returns

Promise<void>

listTriggeredWebJobHistory(string, string, string, WebAppsListTriggeredWebJobHistoryOptionalParams)

List a triggered web job's history for an app, or a deployment slot.

function listTriggeredWebJobHistory(resourceGroupName: string, name: string, webJobName: string, options?: WebAppsListTriggeredWebJobHistoryOptionalParams): PagedAsyncIterableIterator<TriggeredJobHistory, TriggeredJobHistory[], PageSettings>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Site name.

webJobName: string

Name of Web Job.

options: WebAppsListTriggeredWebJobHistoryOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<TriggeredJobHistory, TriggeredJobHistory[], PageSettings>

listTriggeredWebJobHistorySlot(string, string, string, string, WebAppsListTriggeredWebJobHistorySlotOptionalParams)

List a triggered web job's history for an app, or a deployment slot.

function listTriggeredWebJobHistorySlot(resourceGroupName: string, name: string, webJobName: string, slot: string, options?: WebAppsListTriggeredWebJobHistorySlotOptionalParams): PagedAsyncIterableIterator<TriggeredJobHistory, TriggeredJobHistory[], PageSettings>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Site name.

webJobName: string

Name of Web Job.

slot: string

Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.

options: WebAppsListTriggeredWebJobHistorySlotOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<TriggeredJobHistory, TriggeredJobHistory[], PageSettings>

listTriggeredWebJobs(string, string, WebAppsListTriggeredWebJobsOptionalParams)

List triggered web jobs for an app, or a deployment slot.

function listTriggeredWebJobs(resourceGroupName: string, name: string, options?: WebAppsListTriggeredWebJobsOptionalParams): PagedAsyncIterableIterator<TriggeredWebJob, TriggeredWebJob[], PageSettings>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Site name.

options: WebAppsListTriggeredWebJobsOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<TriggeredWebJob, TriggeredWebJob[], PageSettings>

listTriggeredWebJobsSlot(string, string, string, WebAppsListTriggeredWebJobsSlotOptionalParams)

List triggered web jobs for an app, or a deployment slot.

function listTriggeredWebJobsSlot(resourceGroupName: string, name: string, slot: string, options?: WebAppsListTriggeredWebJobsSlotOptionalParams): PagedAsyncIterableIterator<TriggeredWebJob, TriggeredWebJob[], PageSettings>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Site name.

slot: string

Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.

options: WebAppsListTriggeredWebJobsSlotOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<TriggeredWebJob, TriggeredWebJob[], PageSettings>

listUsages(string, string, WebAppsListUsagesOptionalParams)

Gets the quota usage information of an app (or deployment slot, if specified).

function listUsages(resourceGroupName: string, name: string, options?: WebAppsListUsagesOptionalParams): PagedAsyncIterableIterator<CsmUsageQuota, CsmUsageQuota[], PageSettings>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

options: WebAppsListUsagesOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<CsmUsageQuota, CsmUsageQuota[], PageSettings>

listUsagesSlot(string, string, string, WebAppsListUsagesSlotOptionalParams)

Gets the quota usage information of an app (or deployment slot, if specified).

function listUsagesSlot(resourceGroupName: string, name: string, slot: string, options?: WebAppsListUsagesSlotOptionalParams): PagedAsyncIterableIterator<CsmUsageQuota, CsmUsageQuota[], PageSettings>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

slot: string

Name of the deployment slot. If a slot is not specified, the API will get quota information of the production slot.

options: WebAppsListUsagesSlotOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<CsmUsageQuota, CsmUsageQuota[], PageSettings>

listVnetConnections(string, string, WebAppsListVnetConnectionsOptionalParams)

Gets the virtual networks the app (or deployment slot) is connected to.

function listVnetConnections(resourceGroupName: string, name: string, options?: WebAppsListVnetConnectionsOptionalParams): Promise<WebAppsListVnetConnectionsResponse>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

options: WebAppsListVnetConnectionsOptionalParams

The options parameters.

Returns

Promise<WebAppsListVnetConnectionsResponse>

listVnetConnectionsSlot(string, string, string, WebAppsListVnetConnectionsSlotOptionalParams)

Gets the virtual networks the app (or deployment slot) is connected to.

function listVnetConnectionsSlot(resourceGroupName: string, name: string, slot: string, options?: WebAppsListVnetConnectionsSlotOptionalParams): Promise<WebAppsListVnetConnectionsSlotResponse>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

slot: string

Name of the deployment slot. If a slot is not specified, the API will get virtual network connections for the production slot.

options: WebAppsListVnetConnectionsSlotOptionalParams

The options parameters.

Returns

Promise<WebAppsListVnetConnectionsSlotResponse>

listWebJobs(string, string, WebAppsListWebJobsOptionalParams)

List webjobs for an app, or a deployment slot.

function listWebJobs(resourceGroupName: string, name: string, options?: WebAppsListWebJobsOptionalParams): PagedAsyncIterableIterator<WebJob, WebJob[], PageSettings>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Site name.

options: WebAppsListWebJobsOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<WebJob, WebJob[], PageSettings>

listWebJobsSlot(string, string, string, WebAppsListWebJobsSlotOptionalParams)

List webjobs for an app, or a deployment slot.

function listWebJobsSlot(resourceGroupName: string, name: string, slot: string, options?: WebAppsListWebJobsSlotOptionalParams): PagedAsyncIterableIterator<WebJob, WebJob[], PageSettings>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Site name.

slot: string

Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.

options: WebAppsListWebJobsSlotOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<WebJob, WebJob[], PageSettings>

putPrivateAccessVnet(string, string, PrivateAccess, WebAppsPutPrivateAccessVnetOptionalParams)

Sets data around private site access enablement and authorized Virtual Networks that can access the site.

function putPrivateAccessVnet(resourceGroupName: string, name: string, access: PrivateAccess, options?: WebAppsPutPrivateAccessVnetOptionalParams): Promise<PrivateAccess>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

The name of the web app.

access: PrivateAccess

The information for the private access

options: WebAppsPutPrivateAccessVnetOptionalParams

The options parameters.

Returns

Promise<PrivateAccess>

putPrivateAccessVnetSlot(string, string, string, PrivateAccess, WebAppsPutPrivateAccessVnetSlotOptionalParams)

Sets data around private site access enablement and authorized Virtual Networks that can access the site.

function putPrivateAccessVnetSlot(resourceGroupName: string, name: string, slot: string, access: PrivateAccess, options?: WebAppsPutPrivateAccessVnetSlotOptionalParams): Promise<PrivateAccess>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

The name of the web app.

slot: string

The name of the slot for the web app.

access: PrivateAccess

The information for the private access

options: WebAppsPutPrivateAccessVnetSlotOptionalParams

The options parameters.

Returns

Promise<PrivateAccess>

recoverSiteConfigurationSnapshot(string, string, string, WebAppsRecoverSiteConfigurationSnapshotOptionalParams)

Reverts the configuration of an app to a previous snapshot.

function recoverSiteConfigurationSnapshot(resourceGroupName: string, name: string, snapshotId: string, options?: WebAppsRecoverSiteConfigurationSnapshotOptionalParams): Promise<void>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

snapshotId: string

The ID of the snapshot to read.

options: WebAppsRecoverSiteConfigurationSnapshotOptionalParams

The options parameters.

Returns

Promise<void>

recoverSiteConfigurationSnapshotSlot(string, string, string, string, WebAppsRecoverSiteConfigurationSnapshotSlotOptionalParams)

Reverts the configuration of an app to a previous snapshot.

function recoverSiteConfigurationSnapshotSlot(resourceGroupName: string, name: string, snapshotId: string, slot: string, options?: WebAppsRecoverSiteConfigurationSnapshotSlotOptionalParams): Promise<void>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

snapshotId: string

The ID of the snapshot to read.

slot: string

Name of the deployment slot. If a slot is not specified, the API will return configuration for the production slot.

options: WebAppsRecoverSiteConfigurationSnapshotSlotOptionalParams

The options parameters.

Returns

Promise<void>

resetProductionSlotConfig(string, string, WebAppsResetProductionSlotConfigOptionalParams)

Resets the configuration settings of the current slot if they were previously modified by calling the API with POST.

function resetProductionSlotConfig(resourceGroupName: string, name: string, options?: WebAppsResetProductionSlotConfigOptionalParams): Promise<void>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

options: WebAppsResetProductionSlotConfigOptionalParams

The options parameters.

Returns

Promise<void>

resetSlotConfigurationSlot(string, string, string, WebAppsResetSlotConfigurationSlotOptionalParams)

Resets the configuration settings of the current slot if they were previously modified by calling the API with POST.

function resetSlotConfigurationSlot(resourceGroupName: string, name: string, slot: string, options?: WebAppsResetSlotConfigurationSlotOptionalParams): Promise<void>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

slot: string

Name of the deployment slot. If a slot is not specified, the API resets configuration settings for the production slot.

options: WebAppsResetSlotConfigurationSlotOptionalParams

The options parameters.

Returns

Promise<void>

restart(string, string, WebAppsRestartOptionalParams)

Restarts an app (or deployment slot, if specified).

function restart(resourceGroupName: string, name: string, options?: WebAppsRestartOptionalParams): Promise<void>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

options: WebAppsRestartOptionalParams

The options parameters.

Returns

Promise<void>

restartSlot(string, string, string, WebAppsRestartSlotOptionalParams)

Restarts an app (or deployment slot, if specified).

function restartSlot(resourceGroupName: string, name: string, slot: string, options?: WebAppsRestartSlotOptionalParams): Promise<void>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

slot: string

Name of the deployment slot. If a slot is not specified, the API will restart the production slot.

options: WebAppsRestartSlotOptionalParams

The options parameters.

Returns

Promise<void>

runTriggeredWebJob(string, string, string, WebAppsRunTriggeredWebJobOptionalParams)

Run a triggered web job for an app, or a deployment slot.

function runTriggeredWebJob(resourceGroupName: string, name: string, webJobName: string, options?: WebAppsRunTriggeredWebJobOptionalParams): Promise<void>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Site name.

webJobName: string

Name of Web Job.

options: WebAppsRunTriggeredWebJobOptionalParams

The options parameters.

Returns

Promise<void>

runTriggeredWebJobSlot(string, string, string, string, WebAppsRunTriggeredWebJobSlotOptionalParams)

Run a triggered web job for an app, or a deployment slot.

function runTriggeredWebJobSlot(resourceGroupName: string, name: string, webJobName: string, slot: string, options?: WebAppsRunTriggeredWebJobSlotOptionalParams): Promise<void>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Site name.

webJobName: string

Name of Web Job.

slot: string

Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.

options: WebAppsRunTriggeredWebJobSlotOptionalParams

The options parameters.

Returns

Promise<void>

start(string, string, WebAppsStartOptionalParams)

Starts an app (or deployment slot, if specified).

function start(resourceGroupName: string, name: string, options?: WebAppsStartOptionalParams): Promise<void>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

options: WebAppsStartOptionalParams

The options parameters.

Returns

Promise<void>

startContinuousWebJob(string, string, string, WebAppsStartContinuousWebJobOptionalParams)

Start a continuous web job for an app, or a deployment slot.

function startContinuousWebJob(resourceGroupName: string, name: string, webJobName: string, options?: WebAppsStartContinuousWebJobOptionalParams): Promise<void>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Site name.

webJobName: string

Name of Web Job.

options: WebAppsStartContinuousWebJobOptionalParams

The options parameters.

Returns

Promise<void>

startContinuousWebJobSlot(string, string, string, string, WebAppsStartContinuousWebJobSlotOptionalParams)

Start a continuous web job for an app, or a deployment slot.

function startContinuousWebJobSlot(resourceGroupName: string, name: string, webJobName: string, slot: string, options?: WebAppsStartContinuousWebJobSlotOptionalParams): Promise<void>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Site name.

webJobName: string

Name of Web Job.

slot: string

Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.

options: WebAppsStartContinuousWebJobSlotOptionalParams

The options parameters.

Returns

Promise<void>

startSlot(string, string, string, WebAppsStartSlotOptionalParams)

Starts an app (or deployment slot, if specified).

function startSlot(resourceGroupName: string, name: string, slot: string, options?: WebAppsStartSlotOptionalParams): Promise<void>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

slot: string

Name of the deployment slot. If a slot is not specified, the API will start the production slot.

options: WebAppsStartSlotOptionalParams

The options parameters.

Returns

Promise<void>

startWebSiteNetworkTrace(string, string, WebAppsStartWebSiteNetworkTraceOptionalParams)

Start capturing network packets for the site (To be deprecated).

function startWebSiteNetworkTrace(resourceGroupName: string, name: string, options?: WebAppsStartWebSiteNetworkTraceOptionalParams): Promise<WebAppsStartWebSiteNetworkTraceResponse>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

The name of the web app.

options: WebAppsStartWebSiteNetworkTraceOptionalParams

The options parameters.

Returns

Promise<WebAppsStartWebSiteNetworkTraceResponse>

startWebSiteNetworkTraceSlot(string, string, string, WebAppsStartWebSiteNetworkTraceSlotOptionalParams)

Start capturing network packets for the site (To be deprecated).

function startWebSiteNetworkTraceSlot(resourceGroupName: string, name: string, slot: string, options?: WebAppsStartWebSiteNetworkTraceSlotOptionalParams): Promise<WebAppsStartWebSiteNetworkTraceSlotResponse>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

The name of the web app.

slot: string

The name of the slot for this web app.

options: WebAppsStartWebSiteNetworkTraceSlotOptionalParams

The options parameters.

Returns

Promise<WebAppsStartWebSiteNetworkTraceSlotResponse>

stop(string, string, WebAppsStopOptionalParams)

Stops an app (or deployment slot, if specified).

function stop(resourceGroupName: string, name: string, options?: WebAppsStopOptionalParams): Promise<void>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

options: WebAppsStopOptionalParams

The options parameters.

Returns

Promise<void>

stopContinuousWebJob(string, string, string, WebAppsStopContinuousWebJobOptionalParams)

Stop a continuous web job for an app, or a deployment slot.

function stopContinuousWebJob(resourceGroupName: string, name: string, webJobName: string, options?: WebAppsStopContinuousWebJobOptionalParams): Promise<void>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Site name.

webJobName: string

Name of Web Job.

options: WebAppsStopContinuousWebJobOptionalParams

The options parameters.

Returns

Promise<void>

stopContinuousWebJobSlot(string, string, string, string, WebAppsStopContinuousWebJobSlotOptionalParams)

Stop a continuous web job for an app, or a deployment slot.

function stopContinuousWebJobSlot(resourceGroupName: string, name: string, webJobName: string, slot: string, options?: WebAppsStopContinuousWebJobSlotOptionalParams): Promise<void>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Site name.

webJobName: string

Name of Web Job.

slot: string

Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.

options: WebAppsStopContinuousWebJobSlotOptionalParams

The options parameters.

Returns

Promise<void>

stopNetworkTrace(string, string, WebAppsStopNetworkTraceOptionalParams)

Stop ongoing capturing network packets for the site.

function stopNetworkTrace(resourceGroupName: string, name: string, options?: WebAppsStopNetworkTraceOptionalParams): Promise<void>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

The name of the web app.

options: WebAppsStopNetworkTraceOptionalParams

The options parameters.

Returns

Promise<void>

stopNetworkTraceSlot(string, string, string, WebAppsStopNetworkTraceSlotOptionalParams)

Stop ongoing capturing network packets for the site.

function stopNetworkTraceSlot(resourceGroupName: string, name: string, slot: string, options?: WebAppsStopNetworkTraceSlotOptionalParams): Promise<void>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

The name of the web app.

slot: string

The name of the slot for this web app.

options: WebAppsStopNetworkTraceSlotOptionalParams

The options parameters.

Returns

Promise<void>

stopSlot(string, string, string, WebAppsStopSlotOptionalParams)

Stops an app (or deployment slot, if specified).

function stopSlot(resourceGroupName: string, name: string, slot: string, options?: WebAppsStopSlotOptionalParams): Promise<void>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

slot: string

Name of the deployment slot. If a slot is not specified, the API will stop the production slot.

options: WebAppsStopSlotOptionalParams

The options parameters.

Returns

Promise<void>

stopWebSiteNetworkTrace(string, string, WebAppsStopWebSiteNetworkTraceOptionalParams)

Stop ongoing capturing network packets for the site.

function stopWebSiteNetworkTrace(resourceGroupName: string, name: string, options?: WebAppsStopWebSiteNetworkTraceOptionalParams): Promise<void>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

The name of the web app.

options: WebAppsStopWebSiteNetworkTraceOptionalParams

The options parameters.

Returns

Promise<void>

stopWebSiteNetworkTraceSlot(string, string, string, WebAppsStopWebSiteNetworkTraceSlotOptionalParams)

Stop ongoing capturing network packets for the site.

function stopWebSiteNetworkTraceSlot(resourceGroupName: string, name: string, slot: string, options?: WebAppsStopWebSiteNetworkTraceSlotOptionalParams): Promise<void>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

The name of the web app.

slot: string

The name of the slot for this web app.

options: WebAppsStopWebSiteNetworkTraceSlotOptionalParams

The options parameters.

Returns

Promise<void>

syncFunctions(string, string, WebAppsSyncFunctionsOptionalParams)

Syncs function trigger metadata to the management database

function syncFunctions(resourceGroupName: string, name: string, options?: WebAppsSyncFunctionsOptionalParams): Promise<void>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

options: WebAppsSyncFunctionsOptionalParams

The options parameters.

Returns

Promise<void>

syncFunctionsSlot(string, string, string, WebAppsSyncFunctionsSlotOptionalParams)

Syncs function trigger metadata to the management database

function syncFunctionsSlot(resourceGroupName: string, name: string, slot: string, options?: WebAppsSyncFunctionsSlotOptionalParams): Promise<void>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

slot: string

Name of the deployment slot.

options: WebAppsSyncFunctionsSlotOptionalParams

The options parameters.

Returns

Promise<void>

syncFunctionTriggers(string, string, WebAppsSyncFunctionTriggersOptionalParams)

Syncs function trigger metadata to the management database

function syncFunctionTriggers(resourceGroupName: string, name: string, options?: WebAppsSyncFunctionTriggersOptionalParams): Promise<void>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

options: WebAppsSyncFunctionTriggersOptionalParams

The options parameters.

Returns

Promise<void>

syncFunctionTriggersSlot(string, string, string, WebAppsSyncFunctionTriggersSlotOptionalParams)

Syncs function trigger metadata to the management database

function syncFunctionTriggersSlot(resourceGroupName: string, name: string, slot: string, options?: WebAppsSyncFunctionTriggersSlotOptionalParams): Promise<void>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

slot: string

Name of the deployment slot.

options: WebAppsSyncFunctionTriggersSlotOptionalParams

The options parameters.

Returns

Promise<void>

syncRepository(string, string, WebAppsSyncRepositoryOptionalParams)

Sync web app repository.

function syncRepository(resourceGroupName: string, name: string, options?: WebAppsSyncRepositoryOptionalParams): Promise<void>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of web app.

options: WebAppsSyncRepositoryOptionalParams

The options parameters.

Returns

Promise<void>

syncRepositorySlot(string, string, string, WebAppsSyncRepositorySlotOptionalParams)

Sync web app repository.

function syncRepositorySlot(resourceGroupName: string, name: string, slot: string, options?: WebAppsSyncRepositorySlotOptionalParams): Promise<void>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of web app.

slot: string

Name of web app slot. If not specified then will default to production slot.

options: WebAppsSyncRepositorySlotOptionalParams

The options parameters.

Returns

Promise<void>

update(string, string, SitePatchResource, WebAppsUpdateOptionalParams)

Creates a new web, mobile, or API app in an existing resource group, or updates an existing app.

function update(resourceGroupName: string, name: string, siteEnvelope: SitePatchResource, options?: WebAppsUpdateOptionalParams): Promise<Site>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Unique name of the app to create or update. To create or update a deployment slot, use the {slot} parameter.

siteEnvelope: SitePatchResource

A JSON representation of the app properties. See example.

options: WebAppsUpdateOptionalParams

The options parameters.

Returns

Promise<Site>

updateApplicationSettings(string, string, StringDictionary, WebAppsUpdateApplicationSettingsOptionalParams)

Replaces the application settings of an app.

function updateApplicationSettings(resourceGroupName: string, name: string, appSettings: StringDictionary, options?: WebAppsUpdateApplicationSettingsOptionalParams): Promise<StringDictionary>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

appSettings: StringDictionary

Application settings of the app.

options: WebAppsUpdateApplicationSettingsOptionalParams

The options parameters.

Returns

Promise<StringDictionary>

updateApplicationSettingsSlot(string, string, string, StringDictionary, WebAppsUpdateApplicationSettingsSlotOptionalParams)

Replaces the application settings of an app.

function updateApplicationSettingsSlot(resourceGroupName: string, name: string, slot: string, appSettings: StringDictionary, options?: WebAppsUpdateApplicationSettingsSlotOptionalParams): Promise<StringDictionary>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

slot: string

Name of the deployment slot. If a slot is not specified, the API will update the application settings for the production slot.

appSettings: StringDictionary

Application settings of the app.

options: WebAppsUpdateApplicationSettingsSlotOptionalParams

The options parameters.

Returns

Promise<StringDictionary>

updateAuthSettings(string, string, SiteAuthSettings, WebAppsUpdateAuthSettingsOptionalParams)

Updates the Authentication / Authorization settings associated with web app.

function updateAuthSettings(resourceGroupName: string, name: string, siteAuthSettings: SiteAuthSettings, options?: WebAppsUpdateAuthSettingsOptionalParams): Promise<SiteAuthSettings>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of web app.

siteAuthSettings: SiteAuthSettings

Auth settings associated with web app.

options: WebAppsUpdateAuthSettingsOptionalParams

The options parameters.

Returns

Promise<SiteAuthSettings>

updateAuthSettingsSlot(string, string, string, SiteAuthSettings, WebAppsUpdateAuthSettingsSlotOptionalParams)

Updates the Authentication / Authorization settings associated with web app.

function updateAuthSettingsSlot(resourceGroupName: string, name: string, slot: string, siteAuthSettings: SiteAuthSettings, options?: WebAppsUpdateAuthSettingsSlotOptionalParams): Promise<SiteAuthSettings>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of web app.

slot: string

Name of web app slot. If not specified then will default to production slot.

siteAuthSettings: SiteAuthSettings

Auth settings associated with web app.

options: WebAppsUpdateAuthSettingsSlotOptionalParams

The options parameters.

Returns

Promise<SiteAuthSettings>

updateAzureStorageAccounts(string, string, AzureStoragePropertyDictionaryResource, WebAppsUpdateAzureStorageAccountsOptionalParams)

Updates the Azure storage account configurations of an app.

function updateAzureStorageAccounts(resourceGroupName: string, name: string, azureStorageAccounts: AzureStoragePropertyDictionaryResource, options?: WebAppsUpdateAzureStorageAccountsOptionalParams): Promise<AzureStoragePropertyDictionaryResource>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

azureStorageAccounts: AzureStoragePropertyDictionaryResource

Azure storage accounts of the app.

options: WebAppsUpdateAzureStorageAccountsOptionalParams

The options parameters.

Returns

updateAzureStorageAccountsSlot(string, string, string, AzureStoragePropertyDictionaryResource, WebAppsUpdateAzureStorageAccountsSlotOptionalParams)

Updates the Azure storage account configurations of an app.

function updateAzureStorageAccountsSlot(resourceGroupName: string, name: string, slot: string, azureStorageAccounts: AzureStoragePropertyDictionaryResource, options?: WebAppsUpdateAzureStorageAccountsSlotOptionalParams): Promise<AzureStoragePropertyDictionaryResource>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

slot: string

Name of the deployment slot. If a slot is not specified, the API will update the Azure storage account configurations for the production slot.

azureStorageAccounts: AzureStoragePropertyDictionaryResource

Azure storage accounts of the app.

options: WebAppsUpdateAzureStorageAccountsSlotOptionalParams

The options parameters.

Returns

updateBackupConfiguration(string, string, BackupRequest, WebAppsUpdateBackupConfigurationOptionalParams)

Updates the backup configuration of an app.

function updateBackupConfiguration(resourceGroupName: string, name: string, request: BackupRequest, options?: WebAppsUpdateBackupConfigurationOptionalParams): Promise<BackupRequest>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

request: BackupRequest

Edited backup configuration.

options: WebAppsUpdateBackupConfigurationOptionalParams

The options parameters.

Returns

Promise<BackupRequest>

updateBackupConfigurationSlot(string, string, string, BackupRequest, WebAppsUpdateBackupConfigurationSlotOptionalParams)

Updates the backup configuration of an app.

function updateBackupConfigurationSlot(resourceGroupName: string, name: string, slot: string, request: BackupRequest, options?: WebAppsUpdateBackupConfigurationSlotOptionalParams): Promise<BackupRequest>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

slot: string

Name of the deployment slot. If a slot is not specified, the API will update the backup configuration for the production slot.

request: BackupRequest

Edited backup configuration.

options: WebAppsUpdateBackupConfigurationSlotOptionalParams

The options parameters.

Returns

Promise<BackupRequest>

updateConfiguration(string, string, SiteConfigResource, WebAppsUpdateConfigurationOptionalParams)

Updates the configuration of an app.

function updateConfiguration(resourceGroupName: string, name: string, siteConfig: SiteConfigResource, options?: WebAppsUpdateConfigurationOptionalParams): Promise<SiteConfigResource>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

siteConfig: SiteConfigResource

JSON representation of a SiteConfig object. See example.

options: WebAppsUpdateConfigurationOptionalParams

The options parameters.

Returns

Promise<SiteConfigResource>

updateConfigurationSlot(string, string, string, SiteConfigResource, WebAppsUpdateConfigurationSlotOptionalParams)

Updates the configuration of an app.

function updateConfigurationSlot(resourceGroupName: string, name: string, slot: string, siteConfig: SiteConfigResource, options?: WebAppsUpdateConfigurationSlotOptionalParams): Promise<SiteConfigResource>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

slot: string

Name of the deployment slot. If a slot is not specified, the API will update configuration for the production slot.

siteConfig: SiteConfigResource

JSON representation of a SiteConfig object. See example.

options: WebAppsUpdateConfigurationSlotOptionalParams

The options parameters.

Returns

Promise<SiteConfigResource>

updateConnectionStrings(string, string, ConnectionStringDictionary, WebAppsUpdateConnectionStringsOptionalParams)

Replaces the connection strings of an app.

function updateConnectionStrings(resourceGroupName: string, name: string, connectionStrings: ConnectionStringDictionary, options?: WebAppsUpdateConnectionStringsOptionalParams): Promise<ConnectionStringDictionary>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

connectionStrings: ConnectionStringDictionary

Connection strings of the app or deployment slot. See example.

options: WebAppsUpdateConnectionStringsOptionalParams

The options parameters.

Returns

updateConnectionStringsSlot(string, string, string, ConnectionStringDictionary, WebAppsUpdateConnectionStringsSlotOptionalParams)

Replaces the connection strings of an app.

function updateConnectionStringsSlot(resourceGroupName: string, name: string, slot: string, connectionStrings: ConnectionStringDictionary, options?: WebAppsUpdateConnectionStringsSlotOptionalParams): Promise<ConnectionStringDictionary>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

slot: string

Name of the deployment slot. If a slot is not specified, the API will update the connection settings for the production slot.

connectionStrings: ConnectionStringDictionary

Connection strings of the app or deployment slot. See example.

options: WebAppsUpdateConnectionStringsSlotOptionalParams

The options parameters.

Returns

updateDiagnosticLogsConfig(string, string, SiteLogsConfig, WebAppsUpdateDiagnosticLogsConfigOptionalParams)

Updates the logging configuration of an app.

function updateDiagnosticLogsConfig(resourceGroupName: string, name: string, siteLogsConfig: SiteLogsConfig, options?: WebAppsUpdateDiagnosticLogsConfigOptionalParams): Promise<SiteLogsConfig>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

siteLogsConfig: SiteLogsConfig

A SiteLogsConfig JSON object that contains the logging configuration to change in the "properties" property.

options: WebAppsUpdateDiagnosticLogsConfigOptionalParams

The options parameters.

Returns

Promise<SiteLogsConfig>

updateDiagnosticLogsConfigSlot(string, string, string, SiteLogsConfig, WebAppsUpdateDiagnosticLogsConfigSlotOptionalParams)

Updates the logging configuration of an app.

function updateDiagnosticLogsConfigSlot(resourceGroupName: string, name: string, slot: string, siteLogsConfig: SiteLogsConfig, options?: WebAppsUpdateDiagnosticLogsConfigSlotOptionalParams): Promise<SiteLogsConfig>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

slot: string

Name of the deployment slot. If a slot is not specified, the API will update the logging configuration for the production slot.

siteLogsConfig: SiteLogsConfig

A SiteLogsConfig JSON object that contains the logging configuration to change in the "properties" property.

options: WebAppsUpdateDiagnosticLogsConfigSlotOptionalParams

The options parameters.

Returns

Promise<SiteLogsConfig>

updateDomainOwnershipIdentifier(string, string, string, Identifier, WebAppsUpdateDomainOwnershipIdentifierOptionalParams)

Creates a domain ownership identifier for web app, or updates an existing ownership identifier.

function updateDomainOwnershipIdentifier(resourceGroupName: string, name: string, domainOwnershipIdentifierName: string, domainOwnershipIdentifier: Identifier, options?: WebAppsUpdateDomainOwnershipIdentifierOptionalParams): Promise<Identifier>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

domainOwnershipIdentifierName: string

Name of domain ownership identifier.

domainOwnershipIdentifier: Identifier

A JSON representation of the domain ownership properties.

options: WebAppsUpdateDomainOwnershipIdentifierOptionalParams

The options parameters.

Returns

Promise<Identifier>

updateDomainOwnershipIdentifierSlot(string, string, string, string, Identifier, WebAppsUpdateDomainOwnershipIdentifierSlotOptionalParams)

Creates a domain ownership identifier for web app, or updates an existing ownership identifier.

function updateDomainOwnershipIdentifierSlot(resourceGroupName: string, name: string, domainOwnershipIdentifierName: string, slot: string, domainOwnershipIdentifier: Identifier, options?: WebAppsUpdateDomainOwnershipIdentifierSlotOptionalParams): Promise<Identifier>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

domainOwnershipIdentifierName: string

Name of domain ownership identifier.

slot: string

Name of the deployment slot. If a slot is not specified, the API will delete the binding for the production slot.

domainOwnershipIdentifier: Identifier

A JSON representation of the domain ownership properties.

options: WebAppsUpdateDomainOwnershipIdentifierSlotOptionalParams

The options parameters.

Returns

Promise<Identifier>

updateHybridConnection(string, string, string, string, HybridConnection, WebAppsUpdateHybridConnectionOptionalParams)

Creates a new Hybrid Connection using a Service Bus relay.

function updateHybridConnection(resourceGroupName: string, name: string, namespaceName: string, relayName: string, connectionEnvelope: HybridConnection, options?: WebAppsUpdateHybridConnectionOptionalParams): Promise<HybridConnection>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

The name of the web app.

namespaceName: string

The namespace for this hybrid connection.

relayName: string

The relay name for this hybrid connection.

connectionEnvelope: HybridConnection

The details of the hybrid connection.

options: WebAppsUpdateHybridConnectionOptionalParams

The options parameters.

Returns

Promise<HybridConnection>

updateHybridConnectionSlot(string, string, string, string, string, HybridConnection, WebAppsUpdateHybridConnectionSlotOptionalParams)

Creates a new Hybrid Connection using a Service Bus relay.

function updateHybridConnectionSlot(resourceGroupName: string, name: string, namespaceName: string, relayName: string, slot: string, connectionEnvelope: HybridConnection, options?: WebAppsUpdateHybridConnectionSlotOptionalParams): Promise<HybridConnection>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

The name of the web app.

namespaceName: string

The namespace for this hybrid connection.

relayName: string

The relay name for this hybrid connection.

slot: string

The name of the slot for the web app.

connectionEnvelope: HybridConnection

The details of the hybrid connection.

options: WebAppsUpdateHybridConnectionSlotOptionalParams

The options parameters.

Returns

Promise<HybridConnection>

updateMetadata(string, string, StringDictionary, WebAppsUpdateMetadataOptionalParams)

Replaces the metadata of an app.

function updateMetadata(resourceGroupName: string, name: string, metadata: StringDictionary, options?: WebAppsUpdateMetadataOptionalParams): Promise<StringDictionary>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

metadata: StringDictionary

Edited metadata of the app or deployment slot. See example.

options: WebAppsUpdateMetadataOptionalParams

The options parameters.

Returns

Promise<StringDictionary>

updateMetadataSlot(string, string, string, StringDictionary, WebAppsUpdateMetadataSlotOptionalParams)

Replaces the metadata of an app.

function updateMetadataSlot(resourceGroupName: string, name: string, slot: string, metadata: StringDictionary, options?: WebAppsUpdateMetadataSlotOptionalParams): Promise<StringDictionary>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

slot: string

Name of the deployment slot. If a slot is not specified, the API will update the metadata for the production slot.

metadata: StringDictionary

Edited metadata of the app or deployment slot. See example.

options: WebAppsUpdateMetadataSlotOptionalParams

The options parameters.

Returns

Promise<StringDictionary>

updatePremierAddOn(string, string, string, PremierAddOnPatchResource, WebAppsUpdatePremierAddOnOptionalParams)

Updates a named add-on of an app.

function updatePremierAddOn(resourceGroupName: string, name: string, premierAddOnName: string, premierAddOn: PremierAddOnPatchResource, options?: WebAppsUpdatePremierAddOnOptionalParams): Promise<PremierAddOn>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

premierAddOnName: string

Add-on name.

premierAddOn: PremierAddOnPatchResource

A JSON representation of the edited premier add-on.

options: WebAppsUpdatePremierAddOnOptionalParams

The options parameters.

Returns

Promise<PremierAddOn>

updatePremierAddOnSlot(string, string, string, string, PremierAddOnPatchResource, WebAppsUpdatePremierAddOnSlotOptionalParams)

Updates a named add-on of an app.

function updatePremierAddOnSlot(resourceGroupName: string, name: string, premierAddOnName: string, slot: string, premierAddOn: PremierAddOnPatchResource, options?: WebAppsUpdatePremierAddOnSlotOptionalParams): Promise<PremierAddOn>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

premierAddOnName: string

Add-on name.

slot: string

Name of the deployment slot. If a slot is not specified, the API will update the named add-on for the production slot.

premierAddOn: PremierAddOnPatchResource

A JSON representation of the edited premier add-on.

options: WebAppsUpdatePremierAddOnSlotOptionalParams

The options parameters.

Returns

Promise<PremierAddOn>

updateRelayServiceConnection(string, string, string, RelayServiceConnectionEntity, WebAppsUpdateRelayServiceConnectionOptionalParams)

Creates a new hybrid connection configuration (PUT), or updates an existing one (PATCH).

function updateRelayServiceConnection(resourceGroupName: string, name: string, entityName: string, connectionEnvelope: RelayServiceConnectionEntity, options?: WebAppsUpdateRelayServiceConnectionOptionalParams): Promise<RelayServiceConnectionEntity>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

entityName: string

Name of the hybrid connection configuration.

connectionEnvelope: RelayServiceConnectionEntity

Details of the hybrid connection configuration.

options: WebAppsUpdateRelayServiceConnectionOptionalParams

The options parameters.

Returns

updateRelayServiceConnectionSlot(string, string, string, string, RelayServiceConnectionEntity, WebAppsUpdateRelayServiceConnectionSlotOptionalParams)

Creates a new hybrid connection configuration (PUT), or updates an existing one (PATCH).

function updateRelayServiceConnectionSlot(resourceGroupName: string, name: string, entityName: string, slot: string, connectionEnvelope: RelayServiceConnectionEntity, options?: WebAppsUpdateRelayServiceConnectionSlotOptionalParams): Promise<RelayServiceConnectionEntity>

Parameters

resourceGroupName: string

Name of the resource group to which the resource belongs.

name: string

Name of the app.

entityName: string

Name of the hybrid connection configuration.

slot: string

Name of the deployment slot. If a slot is not specified, the API will create or update a hybrid connection for the production slot.

connectionEnvelope: RelayServiceConnectionEntity

Details of the hybrid connection configuration.

options: WebAppsUpdateRelayServiceConnectionSlotOptionalParams

The options parameters.

Returns