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

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

Methods

NameAccessible byRequired ParamsDescription
getSELECTname, resourceGroupName, subscriptionIdDescription for Gets the details of a web, mobile, or API app.
get_diagnostic_logs_configSELECTname, resourceGroupName, subscriptionIdDescription for Gets the logging configuration of an app.
get_diagnostic_logs_config_slotSELECTname, resourceGroupName, slot, subscriptionIdDescription for Gets the logging configuration of an app.
get_instance_function_slotSELECTfunctionName, name, resourceGroupName, slot, subscriptionIdDescription for Get function information by its ID for web site, or a deployment slot.
get_instance_ms_deploy_logSELECTinstanceId, name, resourceGroupName, subscriptionIdDescription for Get the MSDeploy Log for the last MSDeploy operation.
get_instance_ms_deploy_log_slotSELECTinstanceId, name, resourceGroupName, slot, subscriptionIdDescription for Get the MSDeploy Log for the last MSDeploy operation.
get_instance_ms_deploy_statusSELECTinstanceId, name, resourceGroupName, subscriptionIdDescription for Get the status of the last MSDeploy operation.
get_instance_ms_deploy_status_slotSELECTinstanceId, name, resourceGroupName, slot, subscriptionIdDescription for Get the status of the last MSDeploy operation.
get_instance_processSELECTinstanceId, name, processId, resourceGroupName, subscriptionIdDescription for Get process information by its ID for a specific scaled-out instance in a web site.
get_instance_process_moduleSELECTbaseAddress, instanceId, name, processId, resourceGroupName, subscriptionIdDescription for Get process information by its ID for a specific scaled-out instance in a web site.
get_instance_process_module_slotSELECTbaseAddress, instanceId, name, processId, resourceGroupName, slot, subscriptionIdDescription for Get process information by its ID for a specific scaled-out instance in a web site.
get_instance_process_slotSELECTinstanceId, name, processId, resourceGroupName, slot, subscriptionIdDescription for Get process information by its ID for a specific scaled-out instance in a web site.
get_instance_workflow_slotSELECTname, resourceGroupName, slot, subscriptionId, workflowName
listSELECTsubscriptionIdDescription for Get all apps for a subscription.
list_backup_slotsSELECTname, resourceGroupName, slot, subscriptionIdDescription for Gets existing backups of an app.
list_by_resource_groupSELECTresourceGroupName, subscriptionIdDescription for Gets all web, mobile, and API apps in the specified resource group.
list_instance_functions_slotSELECTname, resourceGroupName, slot, subscriptionIdDescription for List the functions for a web site, or a deployment slot.
list_instance_identifiersSELECTname, resourceGroupName, subscriptionIdDescription for Gets all scale-out instances of an app.
list_instance_identifiers_slotSELECTname, resourceGroupName, slot, subscriptionIdDescription for Gets all scale-out instances of an app.
list_instance_process_modulesSELECTinstanceId, name, processId, resourceGroupName, subscriptionIdDescription for List module information for a process by its ID for a specific scaled-out instance in a web site.
list_instance_process_modules_slotSELECTinstanceId, name, processId, resourceGroupName, slot, subscriptionIdDescription for List module information for a process by its ID for a specific scaled-out instance in a web site.
list_instance_process_threadsSELECTinstanceId, name, processId, resourceGroupName, subscriptionIdDescription for List the threads in a process by its ID for a specific scaled-out instance in a web site.
list_instance_process_threads_slotSELECTinstanceId, name, processId, resourceGroupName, slot, subscriptionIdDescription for List the threads in a process by its ID for a specific scaled-out instance in a web site.
list_instance_processesSELECTinstanceId, name, resourceGroupName, 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_instance_processes_slotSELECTinstanceId, name, resourceGroupName, slot, 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_instance_workflows_slotSELECTname, resourceGroupName, slot, subscriptionId
create_or_updateINSERTname, resourceGroupName, subscriptionIdDescription for Creates a new web, mobile, or API app in an existing resource group, or updates an existing app.
deleteDELETEname, resourceGroupName, subscriptionIdDescription for Deletes a web, mobile, or API app, or one of the deployment slots.
delete_instance_function_slotDELETEfunctionName, name, resourceGroupName, slot, subscriptionIdDescription for Delete a function for web site, or a deployment slot.
delete_instance_processDELETEinstanceId, name, processId, resourceGroupName, 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_process_slotDELETEinstanceId, name, processId, resourceGroupName, slot, 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.
updateUPDATEname, resourceGroupName, subscriptionIdDescription for Creates a new web, mobile, or API app in an existing resource group, or updates an existing app.
add_premier_add_onEXECname, premierAddOnName, resourceGroupName, subscriptionIdDescription for Updates a named add-on of an app.
add_premier_add_on_slotEXECname, premierAddOnName, resourceGroupName, slot, subscriptionIdDescription for Updates a named add-on of an app.
analyze_custom_hostnameEXECname, resourceGroupName, subscriptionIdDescription for Analyze a custom hostname.
analyze_custom_hostname_slotEXECname, resourceGroupName, slot, subscriptionIdDescription for Analyze a custom hostname.
apply_slot_config_to_productionEXECname, resourceGroupName, subscriptionId, data__preserveVnet, data__targetSlotDescription for Applies the configuration settings from the target slot onto the current slot.
apply_slot_configuration_slotEXECname, resourceGroupName, slot, subscriptionId, data__preserveVnet, data__targetSlotDescription for Applies the configuration settings from the target slot onto the current slot.
approve_or_reject_private_endpoint_connectionEXECname, privateEndpointConnectionName, resourceGroupName, subscriptionIdDescription for Approves or rejects a private endpoint connection
approve_or_reject_private_endpoint_connection_slotEXECname, privateEndpointConnectionName, resourceGroupName, slot, subscriptionIdDescription for Approves or rejects a private endpoint connection
backupEXECname, resourceGroupName, subscriptionIdDescription for Creates a backup of an app.
backup_slotEXECname, resourceGroupName, slot, subscriptionIdDescription for Creates a backup of an app.
deploy_workflow_artifactsEXECname, resourceGroupName, subscriptionIdDescription for Creates the artifacts for web site, or a deployment slot.
deploy_workflow_artifacts_slotEXECname, resourceGroupName, slot, subscriptionIdDescription for Creates the artifacts for web site, or a deployment slot.
discover_backupEXECname, resourceGroupName, 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.
discover_backup_slotEXECname, resourceGroupName, 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.
generate_new_site_publishing_passwordEXECname, resourceGroupName, subscriptionIdDescription for Generates a new publishing password for an app (or deployment slot, if specified).
generate_new_site_publishing_password_slotEXECname, resourceGroupName, slot, subscriptionIdDescription for Generates a new publishing password for an app (or deployment slot, if specified).
get_instance_process_dumpEXECinstanceId, name, processId, resourceGroupName, subscriptionIdDescription for Get a memory dump of a process by its ID for a specific scaled-out instance in a web site.
get_instance_process_dump_slotEXECinstanceId, name, processId, resourceGroupName, slot, subscriptionIdDescription for Get a memory dump of a process by its ID for a specific scaled-out instance in a web site.
install_site_extensionEXECname, resourceGroupName, siteExtensionId, subscriptionIdDescription for Install site extension on a web site, or a deployment slot.
install_site_extension_slotEXECname, resourceGroupName, siteExtensionId, slot, subscriptionIdDescription for Install site extension on a web site, or a deployment slot.
is_cloneableEXECname, resourceGroupName, subscriptionIdDescription for Shows whether an app can be cloned to another resource group or subscription.
is_cloneable_slotEXECname, resourceGroupName, slot, subscriptionIdDescription for Shows whether an app can be cloned to another resource group or subscription.
migrate_my_sqlEXECname, resourceGroupName, subscriptionIdDescription for Migrates a local (in-app) MySql database to a remote MySql database.
migrate_storageEXECname, resourceGroupName, subscriptionId, subscriptionNameDescription for Restores a web app.
put_private_access_vnetEXECname, resourceGroupName, subscriptionIdDescription for Sets data around private site access enablement and authorized Virtual Networks that can access the site.
put_private_access_vnet_slotEXECname, resourceGroupName, slot, subscriptionIdDescription for Sets data around private site access enablement and authorized Virtual Networks that can access the site.
recover_site_configuration_snapshotEXECname, resourceGroupName, snapshotId, subscriptionIdDescription for Reverts the configuration of an app to a previous snapshot.
recover_site_configuration_snapshot_slotEXECname, resourceGroupName, slot, snapshotId, subscriptionIdDescription for Reverts the configuration of an app to a previous snapshot.
reset_production_slot_configEXECname, resourceGroupName, subscriptionIdDescription for Resets the configuration settings of the current slot if they were previously modified by calling the API with POST.
reset_slot_configuration_slotEXECname, resourceGroupName, slot, subscriptionIdDescription for Resets the configuration settings of the current slot if they were previously modified by calling the API with POST.
restartEXECname, resourceGroupName, subscriptionIdDescription for Restarts an app (or deployment slot, if specified).
restart_slotEXECname, resourceGroupName, slot, subscriptionIdDescription for Restarts an app (or deployment slot, if specified).
restoreEXECbackupId, name, resourceGroupName, subscriptionIdDescription for Restores a specific backup to another app (or deployment slot, if specified).
restore_from_backup_blobEXECname, resourceGroupName, subscriptionIdDescription for Restores an app from a backup blob in Azure Storage.
restore_from_backup_blob_slotEXECname, resourceGroupName, slot, subscriptionIdDescription for Restores an app from a backup blob in Azure Storage.
restore_from_deleted_appEXECname, resourceGroupName, subscriptionIdDescription for Restores a deleted web app to this web app.
restore_from_deleted_app_slotEXECname, resourceGroupName, slot, subscriptionIdDescription for Restores a deleted web app to this web app.
restore_slotEXECbackupId, name, resourceGroupName, slot, subscriptionIdDescription for Restores a specific backup to another app (or deployment slot, if specified).
restore_snapshotEXECname, resourceGroupName, subscriptionIdDescription for Restores a web app from a snapshot.
restore_snapshot_slotEXECname, resourceGroupName, slot, subscriptionIdDescription for Restores a web app from a snapshot.
run_triggered_web_jobEXECname, resourceGroupName, subscriptionId, webJobNameDescription for Run a triggered web job for an app, or a deployment slot.
run_triggered_web_job_slotEXECname, resourceGroupName, slot, subscriptionId, webJobNameDescription for Run a triggered web job for an app, or a deployment slot.
startEXECname, resourceGroupName, subscriptionIdDescription for Starts an app (or deployment slot, if specified).
start_continuous_web_jobEXECname, resourceGroupName, subscriptionId, webJobNameDescription for Start a continuous web job for an app, or a deployment slot.
start_continuous_web_job_slotEXECname, resourceGroupName, slot, subscriptionId, webJobNameDescription for Start a continuous web job for an app, or a deployment slot.
start_network_traceEXECname, resourceGroupName, subscriptionIdDescription for Start capturing network packets for the site.
start_network_trace_slotEXECname, resourceGroupName, slot, subscriptionIdDescription for Start capturing network packets for the site.
start_slotEXECname, resourceGroupName, slot, subscriptionIdDescription for Starts an app (or deployment slot, if specified).
start_web_site_network_traceEXECname, resourceGroupName, subscriptionIdDescription for Start capturing network packets for the site (To be deprecated).
start_web_site_network_trace_operationEXECname, resourceGroupName, subscriptionIdDescription for Start capturing network packets for the site.
start_web_site_network_trace_operation_slotEXECname, resourceGroupName, slot, subscriptionIdDescription for Start capturing network packets for the site.
start_web_site_network_trace_slotEXECname, resourceGroupName, slot, subscriptionIdDescription for Start capturing network packets for the site (To be deprecated).
stopEXECname, resourceGroupName, subscriptionIdDescription for Stops an app (or deployment slot, if specified).
stop_continuous_web_jobEXECname, resourceGroupName, subscriptionId, webJobNameDescription for Stop a continuous web job for an app, or a deployment slot.
stop_continuous_web_job_slotEXECname, resourceGroupName, slot, subscriptionId, webJobNameDescription for Stop a continuous web job for an app, or a deployment slot.
stop_network_traceEXECname, resourceGroupName, subscriptionIdDescription for Stop ongoing capturing network packets for the site.
stop_network_trace_slotEXECname, resourceGroupName, slot, subscriptionIdDescription for Stop ongoing capturing network packets for the site.
stop_slotEXECname, resourceGroupName, slot, subscriptionIdDescription for Stops an app (or deployment slot, if specified).
stop_web_site_network_traceEXECname, resourceGroupName, subscriptionIdDescription for Stop ongoing capturing network packets for the site.
stop_web_site_network_trace_slotEXECname, resourceGroupName, slot, subscriptionIdDescription for Stop ongoing capturing network packets for the site.
swap_slot_slotEXECname, resourceGroupName, slot, subscriptionId, data__preserveVnet, data__targetSlotDescription for Swaps two deployment slots of an app.
swap_slot_with_productionEXECname, resourceGroupName, subscriptionId, data__preserveVnet, data__targetSlotDescription for Swaps two deployment slots of an app.
sync_function_triggersEXECname, resourceGroupName, subscriptionIdDescription for Syncs function trigger metadata to the management database
sync_function_triggers_slotEXECname, resourceGroupName, slot, subscriptionIdDescription for Syncs function trigger metadata to the management database
sync_functionsEXECname, resourceGroupName, subscriptionIdDescription for Syncs function trigger metadata to the management database
sync_functions_slotEXECname, resourceGroupName, slot, subscriptionIdDescription for Syncs function trigger metadata to the management database
sync_repositoryEXECname, resourceGroupName, subscriptionIdDescription for Sync web app repository.
sync_repository_slotEXECname, resourceGroupName, slot, subscriptionIdDescription for Sync web app repository.

SELECT examples

Description for Get all apps for a subscription.

SELECT
id,
name,
kind,
properties,
type
FROM azure.app_service.web_apps
WHERE subscriptionId = '{{ subscriptionId }}';

INSERT example

Use the following StackQL query and manifest file to create a new web_apps resource.

/*+ create */
INSERT INTO azure.app_service.web_apps (
name,
resourceGroupName,
subscriptionId,
kind,
location,
tags,
properties,
identity,
extendedLocation
)
SELECT
'{{ name }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ kind }}',
'{{ location }}',
'{{ tags }}',
'{{ properties }}',
'{{ identity }}',
'{{ extendedLocation }}'
;

UPDATE example

Updates a web_apps resource.

/*+ update */
UPDATE azure.app_service.web_apps
SET
kind = '{{ kind }}',
properties = '{{ properties }}',
identity = '{{ identity }}'
WHERE
name = '{{ name }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

DELETE example

Deletes the specified web_apps resource.

/*+ delete */
DELETE FROM azure.app_service.web_apps
WHERE name = '{{ name }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';