Skip to main content

web_apps

Creates, updates, deletes, gets or lists a web_apps resource.

Overview

Nameweb_apps
TypeResource
Idazure.app_service.web_apps

Fields

The following fields are returned by SELECT queries:

Module information returned.

NameDatatypeDescription
idstringResource Id.
namestringResource Name.
kindstringKind of resource.
propertiesobjectProcessModuleInfo resource specific properties
typestringResource type.

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
get_instance_process_module_slotselectresourceGroupName, name, processId, baseAddress, slot, instanceId, subscriptionIdDescription for Get process information by its ID for a specific scaled-out instance in a web site.
get_instance_process_moduleselectresourceGroupName, name, processId, baseAddress, instanceId, subscriptionIdDescription for Get process information by its ID for a specific scaled-out instance in a web site.
get_instance_process_slotselectresourceGroupName, name, processId, slot, instanceId, subscriptionIdDescription for Get process information by its ID for a specific scaled-out instance in a web site.
list_instance_process_modules_slotselectresourceGroupName, name, processId, slot, instanceId, subscriptionIdDescription for List module information for a process by its ID for a specific scaled-out instance in a web site.
list_instance_process_threads_slotselectresourceGroupName, name, processId, slot, instanceId, subscriptionIdDescription for List the threads in a process by its ID for a specific scaled-out instance in a web site.
get_instance_processselectresourceGroupName, name, processId, instanceId, subscriptionIdDescription for Get process information by its ID for a specific scaled-out instance in a web site.
list_instance_process_modulesselectresourceGroupName, name, processId, instanceId, subscriptionIdDescription for List module information for a process by its ID for a specific scaled-out instance in a web site.
list_instance_process_threadsselectresourceGroupName, name, processId, instanceId, subscriptionIdDescription for List the threads in a process by its ID for a specific scaled-out instance in a web site.
get_instance_function_slotselectresourceGroupName, name, functionName, slot, subscriptionIdDescription for Get function information by its ID for web site, or a deployment slot.
get_instance_ms_deploy_status_slotselectresourceGroupName, name, slot, instanceId, subscriptionIdDescription for Get the status of the last MSDeploy operation.
get_instance_ms_deploy_log_slotselectresourceGroupName, name, slot, instanceId, subscriptionIdDescription for Get the MSDeploy Log for the last MSDeploy operation.
list_instance_processes_slotselectresourceGroupName, name, slot, instanceId, subscriptionIdDescription for Get list of processes for a web site, or a deployment slot, or for a specific scaled-out instance in a web site.
get_instance_workflow_slotselectsubscriptionId, resourceGroupName, name, slot, workflowName
get_instance_ms_deploy_statusselectresourceGroupName, name, instanceId, subscriptionIdDescription for Get the status of the last MSDeploy operation.
get_instance_ms_deploy_logselectresourceGroupName, name, instanceId, subscriptionIdDescription for Get the MSDeploy Log for the last MSDeploy operation.
list_instance_processesselectresourceGroupName, name, instanceId, subscriptionIdDescription for Get list of processes for a web site, or a deployment slot, or for a specific scaled-out instance in a web site.
list_backup_slotsselectresourceGroupName, name, slot, subscriptionIdDescription for Gets existing backups of an app.
get_diagnostic_logs_config_slotselectresourceGroupName, name, slot, subscriptionIdDescription for Gets the logging configuration of an app.
list_instance_functions_slotselectresourceGroupName, name, slot, subscriptionIdDescription for List the functions for a web site, or a deployment slot.
list_instance_identifiers_slotselectresourceGroupName, name, slot, subscriptionIdDescription for Gets all scale-out instances of an app.
list_instance_workflows_slotselectsubscriptionId, resourceGroupName, name, slot
getselectresourceGroupName, name, subscriptionIdDescription for Gets the details of a web, mobile, or API app.
get_diagnostic_logs_configselectresourceGroupName, name, subscriptionIdDescription for Gets the logging configuration of an app.
list_instance_identifiersselectresourceGroupName, name, subscriptionIdDescription for Gets all scale-out instances of an app.
list_by_resource_groupselectresourceGroupName, subscriptionIdincludeSlotsDescription for Gets all web, mobile, and API apps in the specified resource group.
listselectsubscriptionIdDescription for Get all apps for a subscription.
create_or_updateinsertresourceGroupName, name, subscriptionIdDescription for Creates a new web, mobile, or API app in an existing resource group, or updates an existing app.
updateupdateresourceGroupName, name, subscriptionIdDescription for Creates a new web, mobile, or API app in an existing resource group, or updates an existing app.
delete_instance_process_slotdeleteresourceGroupName, name, processId, slot, instanceId, subscriptionIdDescription for Terminate a process by its ID for a web site, or a deployment slot, or specific scaled-out instance in a web site.
delete_instance_processdeleteresourceGroupName, name, processId, instanceId, subscriptionIdDescription for Terminate a process by its ID for a web site, or a deployment slot, or specific scaled-out instance in a web site.
delete_instance_function_slotdeleteresourceGroupName, name, functionName, slot, subscriptionIdDescription for Delete a function for web site, or a deployment slot.
deletedeleteresourceGroupName, name, subscriptionIddeleteMetrics, deleteEmptyServerFarmDescription for Deletes a web, mobile, or API app, or one of the deployment slots.
analyze_custom_hostnameexecresourceGroupName, name, subscriptionIdhostNameDescription for Analyze a custom hostname.
apply_slot_config_to_productionexecresourceGroupName, name, subscriptionId, targetSlot, preserveVnetDescription for Applies the configuration settings from the target slot onto the current slot.
backupexecresourceGroupName, name, subscriptionIdDescription for Creates a backup of an app.
restoreexecresourceGroupName, name, backupId, subscriptionIdDescription for Restores a specific backup to another app (or deployment slot, if specified).
recover_site_configuration_snapshotexecresourceGroupName, name, snapshotId, subscriptionIdDescription for Reverts the configuration of an app to a previous snapshot.
start_continuous_web_jobexecresourceGroupName, name, webJobName, subscriptionIdDescription for Start a continuous web job for an app, or a deployment slot.
stop_continuous_web_jobexecresourceGroupName, name, webJobName, subscriptionIdDescription for Stop a continuous web job for an app, or a deployment slot.
discover_backupexecresourceGroupName, name, subscriptionIdDescription for 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.
sync_functionsexecresourceGroupName, name, subscriptionIdDescription for Syncs function trigger metadata to the management database
get_instance_process_dumpexecresourceGroupName, name, processId, instanceId, subscriptionIdDescription for Get a memory dump of a process by its ID for a specific scaled-out instance in a web site.
is_cloneableexecresourceGroupName, name, subscriptionIdDescription for Shows whether an app can be cloned to another resource group or subscription.
migrate_storageexecsubscriptionName, resourceGroupName, name, subscriptionIdDescription for Restores a web app.
migrate_my_sqlexecresourceGroupName, name, subscriptionIdDescription for Migrates a local (in-app) MySql database to a remote MySql database.
start_web_site_network_traceexecresourceGroupName, name, subscriptionIddurationInSeconds, maxFrameLength, sasUrlDescription for Start capturing network packets for the site (To be deprecated).
start_web_site_network_trace_operationexecresourceGroupName, name, subscriptionIddurationInSeconds, maxFrameLength, sasUrlDescription for Start capturing network packets for the site.
stop_web_site_network_traceexecresourceGroupName, name, subscriptionIdDescription for Stop ongoing capturing network packets for the site.
generate_new_site_publishing_passwordexecresourceGroupName, name, subscriptionIdDescription for Generates a new publishing password for an app (or deployment slot, if specified).
add_premier_add_onexecresourceGroupName, name, premierAddOnName, subscriptionIdDescription for Updates a named add-on of an app.
put_private_access_vnetexecresourceGroupName, name, subscriptionIdDescription for Sets data around private site access enablement and authorized Virtual Networks that can access the site.
approve_or_reject_private_endpoint_connectionexecresourceGroupName, name, privateEndpointConnectionName, subscriptionIdDescription for Approves or rejects a private endpoint connection
reset_production_slot_configexecresourceGroupName, name, subscriptionIdDescription for Resets the configuration settings of the current slot if they were previously modified by calling the API with POST.
restartexecresourceGroupName, name, subscriptionIdsoftRestart, synchronousDescription for Restarts an app (or deployment slot, if specified).
restore_from_backup_blobexecresourceGroupName, name, subscriptionIdDescription for Restores an app from a backup blob in Azure Storage.
restore_from_deleted_appexecresourceGroupName, name, subscriptionIdDescription for Restores a deleted web app to this web app.
restore_snapshotexecresourceGroupName, name, subscriptionIdDescription for Restores a web app from a snapshot.
install_site_extensionexecresourceGroupName, name, siteExtensionId, subscriptionIdDescription for Install site extension on a web site, or a deployment slot.
analyze_custom_hostname_slotexecresourceGroupName, name, slot, subscriptionIdhostNameDescription for Analyze a custom hostname.
apply_slot_configuration_slotexecresourceGroupName, name, slot, subscriptionId, targetSlot, preserveVnetDescription for Applies the configuration settings from the target slot onto the current slot.
backup_slotexecresourceGroupName, name, slot, subscriptionIdDescription for Creates a backup of an app.
restore_slotexecresourceGroupName, name, backupId, slot, subscriptionIdDescription for Restores a specific backup to another app (or deployment slot, if specified).
recover_site_configuration_snapshot_slotexecresourceGroupName, name, snapshotId, slot, subscriptionIdDescription for Reverts the configuration of an app to a previous snapshot.
start_continuous_web_job_slotexecresourceGroupName, name, webJobName, slot, subscriptionIdDescription for Start a continuous web job for an app, or a deployment slot.
stop_continuous_web_job_slotexecresourceGroupName, name, webJobName, slot, subscriptionIdDescription for Stop a continuous web job for an app, or a deployment slot.
discover_backup_slotexecresourceGroupName, name, slot, subscriptionIdDescription for 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.
sync_functions_slotexecresourceGroupName, name, slot, subscriptionIdDescription for Syncs function trigger metadata to the management database
get_instance_process_dump_slotexecresourceGroupName, name, processId, slot, instanceId, subscriptionIdDescription for Get a memory dump of a process by its ID for a specific scaled-out instance in a web site.
is_cloneable_slotexecresourceGroupName, name, slot, subscriptionIdDescription for Shows whether an app can be cloned to another resource group or subscription.
start_web_site_network_trace_slotexecresourceGroupName, name, slot, subscriptionIddurationInSeconds, maxFrameLength, sasUrlDescription for Start capturing network packets for the site (To be deprecated).
start_web_site_network_trace_operation_slotexecresourceGroupName, name, slot, subscriptionIddurationInSeconds, maxFrameLength, sasUrlDescription for Start capturing network packets for the site.
stop_web_site_network_trace_slotexecresourceGroupName, name, slot, subscriptionIdDescription for Stop ongoing capturing network packets for the site.
generate_new_site_publishing_password_slotexecresourceGroupName, name, slot, subscriptionIdDescription for Generates a new publishing password for an app (or deployment slot, if specified).
add_premier_add_on_slotexecresourceGroupName, name, premierAddOnName, slot, subscriptionIdDescription for Updates a named add-on of an app.
put_private_access_vnet_slotexecresourceGroupName, name, slot, subscriptionIdDescription for Sets data around private site access enablement and authorized Virtual Networks that can access the site.
approve_or_reject_private_endpoint_connection_slotexecresourceGroupName, name, privateEndpointConnectionName, slot, subscriptionIdDescription for Approves or rejects a private endpoint connection
reset_slot_configuration_slotexecresourceGroupName, name, slot, subscriptionIdDescription for Resets the configuration settings of the current slot if they were previously modified by calling the API with POST.
restart_slotexecresourceGroupName, name, slot, subscriptionIdsoftRestart, synchronousDescription for Restarts an app (or deployment slot, if specified).
restore_from_backup_blob_slotexecresourceGroupName, name, slot, subscriptionIdDescription for Restores an app from a backup blob in Azure Storage.
restore_from_deleted_app_slotexecresourceGroupName, name, slot, subscriptionIdDescription for Restores a deleted web app to this web app.
restore_snapshot_slotexecresourceGroupName, name, slot, subscriptionIdDescription for Restores a web app from a snapshot.
install_site_extension_slotexecresourceGroupName, name, siteExtensionId, slot, subscriptionIdDescription for Install site extension on a web site, or a deployment slot.
swap_slot_slotexecresourceGroupName, name, slot, subscriptionId, targetSlot, preserveVnetDescription for Swaps two deployment slots of an app.
start_slotexecresourceGroupName, name, slot, subscriptionIdDescription for Starts an app (or deployment slot, if specified).
start_network_trace_slotexecresourceGroupName, name, slot, subscriptionIddurationInSeconds, maxFrameLength, sasUrlDescription for Start capturing network packets for the site.
stop_slotexecresourceGroupName, name, slot, subscriptionIdDescription for Stops an app (or deployment slot, if specified).
stop_network_trace_slotexecresourceGroupName, name, slot, subscriptionIdDescription for Stop ongoing capturing network packets for the site.
sync_repository_slotexecresourceGroupName, name, slot, subscriptionIdDescription for Sync web app repository.
sync_function_triggers_slotexecresourceGroupName, name, slot, subscriptionIdDescription for Syncs function trigger metadata to the management database
run_triggered_web_job_slotexecresourceGroupName, name, webJobName, slot, subscriptionIdDescription for Run a triggered web job for an app, or a deployment slot.
swap_slot_with_productionexecresourceGroupName, name, subscriptionId, targetSlot, preserveVnetDescription for Swaps two deployment slots of an app.
startexecresourceGroupName, name, subscriptionIdDescription for Starts an app (or deployment slot, if specified).
start_network_traceexecresourceGroupName, name, subscriptionIddurationInSeconds, maxFrameLength, sasUrlDescription for Start capturing network packets for the site.
stopexecresourceGroupName, name, subscriptionIdDescription for Stops an app (or deployment slot, if specified).
stop_network_traceexecresourceGroupName, name, subscriptionIdDescription for Stop ongoing capturing network packets for the site.
sync_repositoryexecresourceGroupName, name, subscriptionIdDescription for Sync web app repository.
sync_function_triggersexecresourceGroupName, name, subscriptionIdDescription for Syncs function trigger metadata to the management database
run_triggered_web_jobexecresourceGroupName, name, webJobName, subscriptionIdDescription for Run a triggered web job for an app, or a deployment slot.
deploy_workflow_artifactsexecsubscriptionId, resourceGroupName, nameDescription for Creates the artifacts for web site, or a deployment slot.
deploy_workflow_artifacts_slotexecsubscriptionId, resourceGroupName, name, slotDescription for Creates the artifacts for web site, or a deployment slot.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
backupIdstringID of the backup.
baseAddressstringModule base address.
functionNamestringFunction name.
instanceIdstringID of a specific scaled-out instance. This is the value of the name property in the JSON response from "GET api/sites/{siteName}/instances".
namestringSite name.
premierAddOnNamestringAdd-on name.
privateEndpointConnectionNamestring
processIdstringPID.
resourceGroupNamestringName of the resource group to which the resource belongs.
siteExtensionIdstringSite extension name.
slotstringName of the deployment slot.
snapshotIdstringThe ID of the snapshot to read.
subscriptionIdstringYour Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
subscriptionNamestringAzure subscription.
webJobNamestringName of Web Job.
workflowNamestringWorkflow name.
deleteEmptyServerFarmbooleanSpecify false if you want to keep empty App Service plan. By default, empty App Service plan is deleted.
deleteMetricsbooleanIf true, web app metrics are also deleted.
durationInSecondsinteger (int32)The duration to keep capturing in seconds.
hostNamestringCustom hostname.
includeSlotsbooleanSpecify <strong>true</strong> to include deployment slots in results. The default is false, which only gives you the production slot of all apps.
maxFrameLengthinteger (int32)The maximum frame length in bytes (Optional).
sasUrlstringThe Blob URL to store capture file.
softRestartbooleanSpecify true to apply the configuration settings and restarts the app only if necessary. By default, the API always restarts and reprovisions the app.
synchronousbooleanSpecify true to block until the app is restarted. By default, it is set to false, and the API responds immediately (asynchronous).

SELECT examples

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

SELECT
id,
name,
kind,
properties,
type
FROM azure.app_service.web_apps
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND name = '{{ name }}' -- required
AND processId = '{{ processId }}' -- required
AND baseAddress = '{{ baseAddress }}' -- required
AND slot = '{{ slot }}' -- required
AND instanceId = '{{ instanceId }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

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

INSERT INTO azure.app_service.web_apps (
data__properties,
data__identity,
data__extendedLocation,
resourceGroupName,
name,
subscriptionId
)
SELECT
'{{ properties }}',
'{{ identity }}',
'{{ extendedLocation }}',
'{{ resourceGroupName }}',
'{{ name }}',
'{{ subscriptionId }}'
RETURNING
id,
name,
extendedLocation,
identity,
properties,
systemData,
type
;

UPDATE examples

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

UPDATE azure.app_service.web_apps
SET
data__kind = '{{ kind }}',
data__properties = '{{ properties }}',
data__identity = '{{ identity }}'
WHERE
resourceGroupName = '{{ resourceGroupName }}' --required
AND name = '{{ name }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
RETURNING
id,
name,
extendedLocation,
identity,
properties,
systemData,
type;

DELETE examples

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

DELETE FROM azure.app_service.web_apps
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND name = '{{ name }}' --required
AND processId = '{{ processId }}' --required
AND slot = '{{ slot }}' --required
AND instanceId = '{{ instanceId }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;

Lifecycle Methods

Description for Analyze a custom hostname.

EXEC azure.app_service.web_apps.analyze_custom_hostname 
@resourceGroupName='{{ resourceGroupName }}' --required,
@name='{{ name }}' --required,
@subscriptionId='{{ subscriptionId }}' --required,
@hostName='{{ hostName }}'
;