web_apps
Creates, updates, deletes, gets or lists a web_apps
resource.
Overview
Name | web_apps |
Type | Resource |
Id | azure.app_service.web_apps |
Fields
The following fields are returned by SELECT
queries:
- get_instance_process_module_slot
- get_instance_process_module
- get_instance_process_slot
- list_instance_process_modules_slot
- list_instance_process_threads_slot
- get_instance_process
- list_instance_process_modules
- list_instance_process_threads
- get_instance_function_slot
- get_instance_ms_deploy_status_slot
- get_instance_ms_deploy_log_slot
- list_instance_processes_slot
- get_instance_workflow_slot
- get_instance_ms_deploy_status
- get_instance_ms_deploy_log
- list_instance_processes
- list_backup_slots
- get_diagnostic_logs_config_slot
- list_instance_functions_slot
- list_instance_identifiers_slot
- list_instance_workflows_slot
- get
- get_diagnostic_logs_config
- list_instance_identifiers
- list_by_resource_group
- list
Module information returned.
Name | Datatype | Description |
---|---|---|
id | string | Resource Id. |
name | string | Resource Name. |
kind | string | Kind of resource. |
properties | object | ProcessModuleInfo resource specific properties |
type | string | Resource type. |
Module information returned.
Name | Datatype | Description |
---|---|---|
id | string | Resource Id. |
name | string | Resource Name. |
kind | string | Kind of resource. |
properties | object | ProcessModuleInfo resource specific properties |
type | string | Resource type. |
Process information returned.
Name | Datatype | Description |
---|---|---|
id | string | Resource Id. |
name | string | Resource Name. |
kind | string | Kind of resource. |
properties | object | ProcessInfo resource specific properties |
type | string | Resource type. |
Module information returned.
Name | Datatype | Description |
---|---|---|
id | string | Resource Id. |
name | string | Resource Name. |
kind | string | Kind of resource. |
properties | object | ProcessModuleInfo resource specific properties |
type | string | Resource type. |
Thread information returned.
Name | Datatype | Description |
---|---|---|
id | string | Resource Id. |
name | string | Resource Name. |
kind | string | Kind of resource. |
properties | object | ProcessThreadInfo resource specific properties |
type | string | Resource type. |
Process information returned.
Name | Datatype | Description |
---|---|---|
id | string | Resource Id. |
name | string | Resource Name. |
kind | string | Kind of resource. |
properties | object | ProcessInfo resource specific properties |
type | string | Resource type. |
Module information returned.
Name | Datatype | Description |
---|---|---|
id | string | Resource Id. |
name | string | Resource Name. |
kind | string | Kind of resource. |
properties | object | ProcessModuleInfo resource specific properties |
type | string | Resource type. |
Thread information returned.
Name | Datatype | Description |
---|---|---|
id | string | Resource Id. |
name | string | Resource Name. |
kind | string | Kind of resource. |
properties | object | ProcessThreadInfo resource specific properties |
type | string | Resource type. |
Function information returned.
Name | Datatype | Description |
---|---|---|
id | string | Resource Id. |
name | string | Resource Name. |
kind | string | Kind of resource. |
properties | object | FunctionEnvelope resource specific properties |
type | string | Resource type. |
Name | Datatype | Description |
---|---|---|
id | string | Resource Id. |
name | string | Resource Name. |
kind | string | Kind of resource. |
properties | object | MSDeployStatus resource specific properties |
type | string | Resource type. |
MSDeploy log returned.
Name | Datatype | Description |
---|---|---|
id | string | Resource Id. |
name | string | Resource Name. |
kind | string | Kind of resource. |
properties | object | MSDeployLog resource specific properties |
type | string | Resource type. |
Process terminated.
Name | Datatype | Description |
---|---|---|
id | string | Resource Id. |
name | string | Resource Name. |
kind | string | Kind of resource. |
properties | object | ProcessInfo resource specific properties |
type | string | Resource type. |
Workflow information returned.
Name | Datatype | Description |
---|---|---|
id | string | The resource id. |
name | string | Gets the resource name. |
kind | string | The resource kind. |
location | string | The resource location. |
properties | object | Additional workflow properties. |
type | string | Gets the resource type. |
Name | Datatype | Description |
---|---|---|
id | string | Resource Id. |
name | string | Resource Name. |
kind | string | Kind of resource. |
properties | object | MSDeployStatus resource specific properties |
type | string | Resource type. |
MSDeploy log returned.
Name | Datatype | Description |
---|---|---|
id | string | Resource Id. |
name | string | Resource Name. |
kind | string | Kind of resource. |
properties | object | MSDeployLog resource specific properties |
type | string | Resource type. |
Process terminated.
Name | Datatype | Description |
---|---|---|
id | string | Resource Id. |
name | string | Resource Name. |
kind | string | Kind of resource. |
properties | object | ProcessInfo resource specific properties |
type | string | Resource type. |
Name | Datatype | Description |
---|---|---|
id | string | Resource Id. |
name | string | Resource Name. |
kind | string | Kind of resource. |
properties | object | BackupItem resource specific properties |
type | string | Resource type. |
Name | Datatype | Description |
---|---|---|
id | string | Resource Id. |
name | string | Resource Name. |
kind | string | Kind of resource. |
properties | object | SiteLogsConfig resource specific properties |
type | string | Resource type. |
Function information returned.
Name | Datatype | Description |
---|---|---|
id | string | Resource Id. |
name | string | Resource Name. |
kind | string | Kind of resource. |
properties | object | FunctionEnvelope resource specific properties |
type | string | Resource type. |
Name | Datatype | Description |
---|---|---|
id | string | Resource Id. |
name | string | Resource Name. |
kind | string | Kind of resource. |
properties | object | WebSiteInstanceStatus resource specific properties |
type | string | Resource type. |
Workflow information returned.
Name | Datatype | Description |
---|---|---|
id | string | The resource id. |
name | string | Gets the resource name. |
kind | string | The resource kind. |
location | string | The resource location. |
properties | object | Additional workflow properties. |
type | string | Gets the resource type. |
OK.
Name | Datatype | Description |
---|---|---|
id | string (arm-id) | Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" |
name | string | The name of the resource |
extendedLocation | object | Extended Location. |
identity | object | Managed service identity. |
properties | object | Site resource specific properties |
systemData | object | Azure Resource Manager metadata containing createdBy and modifiedBy information. |
type | string | The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" |
Name | Datatype | Description |
---|---|---|
id | string | Resource Id. |
name | string | Resource Name. |
kind | string | Kind of resource. |
properties | object | SiteLogsConfig resource specific properties |
type | string | Resource type. |
Name | Datatype | Description |
---|---|---|
id | string | Resource Id. |
name | string | Resource Name. |
kind | string | Kind of resource. |
properties | object | WebSiteInstanceStatus resource specific properties |
type | string | Resource type. |
Name | Datatype | Description |
---|---|---|
id | string (arm-id) | Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" |
name | string | The name of the resource |
extendedLocation | object | Extended Location. |
identity | object | Managed service identity. |
properties | object | Site resource specific properties |
systemData | object | Azure Resource Manager metadata containing createdBy and modifiedBy information. |
type | string | The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" |
Name | Datatype | Description |
---|---|---|
id | string (arm-id) | Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" |
name | string | The name of the resource |
extendedLocation | object | Extended Location. |
identity | object | Managed service identity. |
properties | object | Site resource specific properties |
systemData | object | Azure Resource Manager metadata containing createdBy and modifiedBy information. |
type | string | The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" |
Methods
The following methods are available for this resource:
Name | Accessible by | Required Params | Optional Params | Description |
---|---|---|---|---|
get_instance_process_module_slot | select | resourceGroupName , name , processId , baseAddress , slot , instanceId , subscriptionId | Description for Get process information by its ID for a specific scaled-out instance in a web site. | |
get_instance_process_module | select | resourceGroupName , name , processId , baseAddress , instanceId , subscriptionId | Description for Get process information by its ID for a specific scaled-out instance in a web site. | |
get_instance_process_slot | select | resourceGroupName , name , processId , slot , instanceId , subscriptionId | Description for Get process information by its ID for a specific scaled-out instance in a web site. | |
list_instance_process_modules_slot | select | resourceGroupName , name , processId , slot , instanceId , subscriptionId | Description for List module information for a process by its ID for a specific scaled-out instance in a web site. | |
list_instance_process_threads_slot | select | resourceGroupName , name , processId , slot , instanceId , subscriptionId | Description for List the threads in a process by its ID for a specific scaled-out instance in a web site. | |
get_instance_process | select | resourceGroupName , name , processId , instanceId , subscriptionId | Description for Get process information by its ID for a specific scaled-out instance in a web site. | |
list_instance_process_modules | select | resourceGroupName , name , processId , instanceId , subscriptionId | Description for List module information for a process by its ID for a specific scaled-out instance in a web site. | |
list_instance_process_threads | select | resourceGroupName , name , processId , instanceId , subscriptionId | Description for List the threads in a process by its ID for a specific scaled-out instance in a web site. | |
get_instance_function_slot | select | resourceGroupName , name , functionName , slot , subscriptionId | Description for Get function information by its ID for web site, or a deployment slot. | |
get_instance_ms_deploy_status_slot | select | resourceGroupName , name , slot , instanceId , subscriptionId | Description for Get the status of the last MSDeploy operation. | |
get_instance_ms_deploy_log_slot | select | resourceGroupName , name , slot , instanceId , subscriptionId | Description for Get the MSDeploy Log for the last MSDeploy operation. | |
list_instance_processes_slot | select | resourceGroupName , name , slot , instanceId , subscriptionId | Description 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_slot | select | subscriptionId , resourceGroupName , name , slot , workflowName | ||
get_instance_ms_deploy_status | select | resourceGroupName , name , instanceId , subscriptionId | Description for Get the status of the last MSDeploy operation. | |
get_instance_ms_deploy_log | select | resourceGroupName , name , instanceId , subscriptionId | Description for Get the MSDeploy Log for the last MSDeploy operation. | |
list_instance_processes | select | resourceGroupName , name , instanceId , subscriptionId | Description 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_slots | select | resourceGroupName , name , slot , subscriptionId | Description for Gets existing backups of an app. | |
get_diagnostic_logs_config_slot | select | resourceGroupName , name , slot , subscriptionId | Description for Gets the logging configuration of an app. | |
list_instance_functions_slot | select | resourceGroupName , name , slot , subscriptionId | Description for List the functions for a web site, or a deployment slot. | |
list_instance_identifiers_slot | select | resourceGroupName , name , slot , subscriptionId | Description for Gets all scale-out instances of an app. | |
list_instance_workflows_slot | select | subscriptionId , resourceGroupName , name , slot | ||
get | select | resourceGroupName , name , subscriptionId | Description for Gets the details of a web, mobile, or API app. | |
get_diagnostic_logs_config | select | resourceGroupName , name , subscriptionId | Description for Gets the logging configuration of an app. | |
list_instance_identifiers | select | resourceGroupName , name , subscriptionId | Description for Gets all scale-out instances of an app. | |
list_by_resource_group | select | resourceGroupName , subscriptionId | includeSlots | Description for Gets all web, mobile, and API apps in the specified resource group. |
list | select | subscriptionId | Description for Get all apps for a subscription. | |
create_or_update | insert | resourceGroupName , name , subscriptionId | Description for Creates a new web, mobile, or API app in an existing resource group, or updates an existing app. | |
update | update | resourceGroupName , name , subscriptionId | Description for Creates a new web, mobile, or API app in an existing resource group, or updates an existing app. | |
delete_instance_process_slot | delete | resourceGroupName , name , processId , slot , instanceId , subscriptionId | 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_instance_process | delete | resourceGroupName , name , processId , instanceId , subscriptionId | 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_instance_function_slot | delete | resourceGroupName , name , functionName , slot , subscriptionId | Description for Delete a function for web site, or a deployment slot. | |
delete | delete | resourceGroupName , name , subscriptionId | deleteMetrics , deleteEmptyServerFarm | Description for Deletes a web, mobile, or API app, or one of the deployment slots. |
analyze_custom_hostname | exec | resourceGroupName , name , subscriptionId | hostName | Description for Analyze a custom hostname. |
apply_slot_config_to_production | exec | resourceGroupName , name , subscriptionId , targetSlot , preserveVnet | Description for Applies the configuration settings from the target slot onto the current slot. | |
backup | exec | resourceGroupName , name , subscriptionId | Description for Creates a backup of an app. | |
restore | exec | resourceGroupName , name , backupId , subscriptionId | Description for Restores a specific backup to another app (or deployment slot, if specified). | |
recover_site_configuration_snapshot | exec | resourceGroupName , name , snapshotId , subscriptionId | Description for Reverts the configuration of an app to a previous snapshot. | |
start_continuous_web_job | exec | resourceGroupName , name , webJobName , subscriptionId | Description for Start a continuous web job for an app, or a deployment slot. | |
stop_continuous_web_job | exec | resourceGroupName , name , webJobName , subscriptionId | Description for Stop a continuous web job for an app, or a deployment slot. | |
discover_backup | exec | resourceGroupName , name , subscriptionId | Description 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 | exec | resourceGroupName , name , subscriptionId | Description for Syncs function trigger metadata to the management database | |
get_instance_process_dump | exec | resourceGroupName , name , processId , instanceId , subscriptionId | Description for Get a memory dump of a process by its ID for a specific scaled-out instance in a web site. | |
is_cloneable | exec | resourceGroupName , name , subscriptionId | Description for Shows whether an app can be cloned to another resource group or subscription. | |
migrate_storage | exec | subscriptionName , resourceGroupName , name , subscriptionId | Description for Restores a web app. | |
migrate_my_sql | exec | resourceGroupName , name , subscriptionId | Description for Migrates a local (in-app) MySql database to a remote MySql database. | |
start_web_site_network_trace | exec | resourceGroupName , name , subscriptionId | durationInSeconds , maxFrameLength , sasUrl | Description for Start capturing network packets for the site (To be deprecated). |
start_web_site_network_trace_operation | exec | resourceGroupName , name , subscriptionId | durationInSeconds , maxFrameLength , sasUrl | Description for Start capturing network packets for the site. |
stop_web_site_network_trace | exec | resourceGroupName , name , subscriptionId | Description for Stop ongoing capturing network packets for the site. | |
generate_new_site_publishing_password | exec | resourceGroupName , name , subscriptionId | Description for Generates a new publishing password for an app (or deployment slot, if specified). | |
add_premier_add_on | exec | resourceGroupName , name , premierAddOnName , subscriptionId | Description for Updates a named add-on of an app. | |
put_private_access_vnet | exec | resourceGroupName , name , subscriptionId | Description for Sets data around private site access enablement and authorized Virtual Networks that can access the site. | |
approve_or_reject_private_endpoint_connection | exec | resourceGroupName , name , privateEndpointConnectionName , subscriptionId | Description for Approves or rejects a private endpoint connection | |
reset_production_slot_config | exec | resourceGroupName , name , subscriptionId | Description for Resets the configuration settings of the current slot if they were previously modified by calling the API with POST. | |
restart | exec | resourceGroupName , name , subscriptionId | softRestart , synchronous | Description for Restarts an app (or deployment slot, if specified). |
restore_from_backup_blob | exec | resourceGroupName , name , subscriptionId | Description for Restores an app from a backup blob in Azure Storage. | |
restore_from_deleted_app | exec | resourceGroupName , name , subscriptionId | Description for Restores a deleted web app to this web app. | |
restore_snapshot | exec | resourceGroupName , name , subscriptionId | Description for Restores a web app from a snapshot. | |
install_site_extension | exec | resourceGroupName , name , siteExtensionId , subscriptionId | Description for Install site extension on a web site, or a deployment slot. | |
analyze_custom_hostname_slot | exec | resourceGroupName , name , slot , subscriptionId | hostName | Description for Analyze a custom hostname. |
apply_slot_configuration_slot | exec | resourceGroupName , name , slot , subscriptionId , targetSlot , preserveVnet | Description for Applies the configuration settings from the target slot onto the current slot. | |
backup_slot | exec | resourceGroupName , name , slot , subscriptionId | Description for Creates a backup of an app. | |
restore_slot | exec | resourceGroupName , name , backupId , slot , subscriptionId | Description for Restores a specific backup to another app (or deployment slot, if specified). | |
recover_site_configuration_snapshot_slot | exec | resourceGroupName , name , snapshotId , slot , subscriptionId | Description for Reverts the configuration of an app to a previous snapshot. | |
start_continuous_web_job_slot | exec | resourceGroupName , name , webJobName , slot , subscriptionId | Description for Start a continuous web job for an app, or a deployment slot. | |
stop_continuous_web_job_slot | exec | resourceGroupName , name , webJobName , slot , subscriptionId | Description for Stop a continuous web job for an app, or a deployment slot. | |
discover_backup_slot | exec | resourceGroupName , name , slot , subscriptionId | Description 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_slot | exec | resourceGroupName , name , slot , subscriptionId | Description for Syncs function trigger metadata to the management database | |
get_instance_process_dump_slot | exec | resourceGroupName , name , processId , slot , instanceId , subscriptionId | Description for Get a memory dump of a process by its ID for a specific scaled-out instance in a web site. | |
is_cloneable_slot | exec | resourceGroupName , name , slot , subscriptionId | Description for Shows whether an app can be cloned to another resource group or subscription. | |
start_web_site_network_trace_slot | exec | resourceGroupName , name , slot , subscriptionId | durationInSeconds , maxFrameLength , sasUrl | Description for Start capturing network packets for the site (To be deprecated). |
start_web_site_network_trace_operation_slot | exec | resourceGroupName , name , slot , subscriptionId | durationInSeconds , maxFrameLength , sasUrl | Description for Start capturing network packets for the site. |
stop_web_site_network_trace_slot | exec | resourceGroupName , name , slot , subscriptionId | Description for Stop ongoing capturing network packets for the site. | |
generate_new_site_publishing_password_slot | exec | resourceGroupName , name , slot , subscriptionId | Description for Generates a new publishing password for an app (or deployment slot, if specified). | |
add_premier_add_on_slot | exec | resourceGroupName , name , premierAddOnName , slot , subscriptionId | Description for Updates a named add-on of an app. | |
put_private_access_vnet_slot | exec | resourceGroupName , name , slot , subscriptionId | Description for Sets data around private site access enablement and authorized Virtual Networks that can access the site. | |
approve_or_reject_private_endpoint_connection_slot | exec | resourceGroupName , name , privateEndpointConnectionName , slot , subscriptionId | Description for Approves or rejects a private endpoint connection | |
reset_slot_configuration_slot | exec | resourceGroupName , name , slot , subscriptionId | Description for Resets the configuration settings of the current slot if they were previously modified by calling the API with POST. | |
restart_slot | exec | resourceGroupName , name , slot , subscriptionId | softRestart , synchronous | Description for Restarts an app (or deployment slot, if specified). |
restore_from_backup_blob_slot | exec | resourceGroupName , name , slot , subscriptionId | Description for Restores an app from a backup blob in Azure Storage. | |
restore_from_deleted_app_slot | exec | resourceGroupName , name , slot , subscriptionId | Description for Restores a deleted web app to this web app. | |
restore_snapshot_slot | exec | resourceGroupName , name , slot , subscriptionId | Description for Restores a web app from a snapshot. | |
install_site_extension_slot | exec | resourceGroupName , name , siteExtensionId , slot , subscriptionId | Description for Install site extension on a web site, or a deployment slot. | |
swap_slot_slot | exec | resourceGroupName , name , slot , subscriptionId , targetSlot , preserveVnet | Description for Swaps two deployment slots of an app. | |
start_slot | exec | resourceGroupName , name , slot , subscriptionId | Description for Starts an app (or deployment slot, if specified). | |
start_network_trace_slot | exec | resourceGroupName , name , slot , subscriptionId | durationInSeconds , maxFrameLength , sasUrl | Description for Start capturing network packets for the site. |
stop_slot | exec | resourceGroupName , name , slot , subscriptionId | Description for Stops an app (or deployment slot, if specified). | |
stop_network_trace_slot | exec | resourceGroupName , name , slot , subscriptionId | Description for Stop ongoing capturing network packets for the site. | |
sync_repository_slot | exec | resourceGroupName , name , slot , subscriptionId | Description for Sync web app repository. | |
sync_function_triggers_slot | exec | resourceGroupName , name , slot , subscriptionId | Description for Syncs function trigger metadata to the management database | |
run_triggered_web_job_slot | exec | resourceGroupName , name , webJobName , slot , subscriptionId | Description for Run a triggered web job for an app, or a deployment slot. | |
swap_slot_with_production | exec | resourceGroupName , name , subscriptionId , targetSlot , preserveVnet | Description for Swaps two deployment slots of an app. | |
start | exec | resourceGroupName , name , subscriptionId | Description for Starts an app (or deployment slot, if specified). | |
start_network_trace | exec | resourceGroupName , name , subscriptionId | durationInSeconds , maxFrameLength , sasUrl | Description for Start capturing network packets for the site. |
stop | exec | resourceGroupName , name , subscriptionId | Description for Stops an app (or deployment slot, if specified). | |
stop_network_trace | exec | resourceGroupName , name , subscriptionId | Description for Stop ongoing capturing network packets for the site. | |
sync_repository | exec | resourceGroupName , name , subscriptionId | Description for Sync web app repository. | |
sync_function_triggers | exec | resourceGroupName , name , subscriptionId | Description for Syncs function trigger metadata to the management database | |
run_triggered_web_job | exec | resourceGroupName , name , webJobName , subscriptionId | Description for Run a triggered web job for an app, or a deployment slot. | |
deploy_workflow_artifacts | exec | subscriptionId , resourceGroupName , name | Description for Creates the artifacts for web site, or a deployment slot. | |
deploy_workflow_artifacts_slot | exec | subscriptionId , resourceGroupName , name , slot | Description 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.
Name | Datatype | Description |
---|---|---|
backupId | string | ID of the backup. |
baseAddress | string | Module base address. |
functionName | string | Function 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". |
name | string | Site name. |
premierAddOnName | string | Add-on name. |
privateEndpointConnectionName | string | |
processId | string | PID. |
resourceGroupName | string | Name of the resource group to which the resource belongs. |
siteExtensionId | string | Site extension name. |
slot | string | Name of the deployment slot. |
snapshotId | string | The ID of the snapshot to read. |
subscriptionId | string | Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). |
subscriptionName | string | Azure subscription. |
webJobName | string | Name of Web Job. |
workflowName | string | Workflow name. |
deleteEmptyServerFarm | boolean | Specify false if you want to keep empty App Service plan. By default, empty App Service plan is deleted. |
deleteMetrics | boolean | If true, web app metrics are also deleted. |
durationInSeconds | integer (int32) | The duration to keep capturing in seconds. |
hostName | string | Custom hostname. |
includeSlots | boolean | Specify <strong>true</strong> to include deployment slots in results. The default is false, which only gives you the production slot of all apps. |
maxFrameLength | integer (int32) | The maximum frame length in bytes (Optional). |
sasUrl | string | The Blob URL to store capture file. |
softRestart | boolean | Specify true to apply the configuration settings and restarts the app only if necessary. By default, the API always restarts and reprovisions the app. |
synchronous | boolean | Specify true to block until the app is restarted. By default, it is set to false, and the API responds immediately (asynchronous). |
SELECT
examples
- get_instance_process_module_slot
- get_instance_process_module
- get_instance_process_slot
- list_instance_process_modules_slot
- list_instance_process_threads_slot
- get_instance_process
- list_instance_process_modules
- list_instance_process_threads
- get_instance_function_slot
- get_instance_ms_deploy_status_slot
- get_instance_ms_deploy_log_slot
- list_instance_processes_slot
- get_instance_workflow_slot
- get_instance_ms_deploy_status
- get_instance_ms_deploy_log
- list_instance_processes
- list_backup_slots
- get_diagnostic_logs_config_slot
- list_instance_functions_slot
- list_instance_identifiers_slot
- list_instance_workflows_slot
- get
- get_diagnostic_logs_config
- list_instance_identifiers
- list_by_resource_group
- list
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
;
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 instanceId = '{{ instanceId }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;
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 slot = '{{ slot }}' -- required
AND instanceId = '{{ instanceId }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;
Description for List module information for a process 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 slot = '{{ slot }}' -- required
AND instanceId = '{{ instanceId }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;
Description for List the threads in a process 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 slot = '{{ slot }}' -- required
AND instanceId = '{{ instanceId }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;
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 instanceId = '{{ instanceId }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;
Description for List module information for a process 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 instanceId = '{{ instanceId }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;
Description for List the threads in a process 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 instanceId = '{{ instanceId }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;
Description for Get function information by its ID for web site, or a deployment slot.
SELECT
id,
name,
kind,
properties,
type
FROM azure.app_service.web_apps
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND name = '{{ name }}' -- required
AND functionName = '{{ functionName }}' -- required
AND slot = '{{ slot }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;
Description for Get the status of the last MSDeploy operation.
SELECT
id,
name,
kind,
properties,
type
FROM azure.app_service.web_apps
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND name = '{{ name }}' -- required
AND slot = '{{ slot }}' -- required
AND instanceId = '{{ instanceId }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;
Description for Get the MSDeploy Log for the last MSDeploy operation.
SELECT
id,
name,
kind,
properties,
type
FROM azure.app_service.web_apps
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND name = '{{ name }}' -- required
AND slot = '{{ slot }}' -- required
AND instanceId = '{{ instanceId }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;
Description for Get list of processes for a web site, or a deployment slot, or 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 slot = '{{ slot }}' -- required
AND instanceId = '{{ instanceId }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;
Workflow information returned.
SELECT
id,
name,
kind,
location,
properties,
type
FROM azure.app_service.web_apps
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND name = '{{ name }}' -- required
AND slot = '{{ slot }}' -- required
AND workflowName = '{{ workflowName }}' -- required
;
Description for Get the status of the last MSDeploy operation.
SELECT
id,
name,
kind,
properties,
type
FROM azure.app_service.web_apps
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND name = '{{ name }}' -- required
AND instanceId = '{{ instanceId }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;
Description for Get the MSDeploy Log for the last MSDeploy operation.
SELECT
id,
name,
kind,
properties,
type
FROM azure.app_service.web_apps
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND name = '{{ name }}' -- required
AND instanceId = '{{ instanceId }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;
Description for Get list of processes for a web site, or a deployment slot, or 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 instanceId = '{{ instanceId }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;
Description for Gets existing backups of an app.
SELECT
id,
name,
kind,
properties,
type
FROM azure.app_service.web_apps
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND name = '{{ name }}' -- required
AND slot = '{{ slot }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;
Description for Gets the logging configuration of an app.
SELECT
id,
name,
kind,
properties,
type
FROM azure.app_service.web_apps
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND name = '{{ name }}' -- required
AND slot = '{{ slot }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;
Description for List the functions for a web site, or a deployment slot.
SELECT
id,
name,
kind,
properties,
type
FROM azure.app_service.web_apps
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND name = '{{ name }}' -- required
AND slot = '{{ slot }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;
Description for Gets all scale-out instances of an app.
SELECT
id,
name,
kind,
properties,
type
FROM azure.app_service.web_apps
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND name = '{{ name }}' -- required
AND slot = '{{ slot }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;
Workflow information returned.
SELECT
id,
name,
kind,
location,
properties,
type
FROM azure.app_service.web_apps
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND name = '{{ name }}' -- required
AND slot = '{{ slot }}' -- required
;
Description for Gets the details of a web, mobile, or API app.
SELECT
id,
name,
extendedLocation,
identity,
properties,
systemData,
type
FROM azure.app_service.web_apps
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND name = '{{ name }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;
Description for Gets the logging configuration of an app.
SELECT
id,
name,
kind,
properties,
type
FROM azure.app_service.web_apps
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND name = '{{ name }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;
Description for Gets all scale-out instances of an app.
SELECT
id,
name,
kind,
properties,
type
FROM azure.app_service.web_apps
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND name = '{{ name }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;
Description for Gets all web, mobile, and API apps in the specified resource group.
SELECT
id,
name,
extendedLocation,
identity,
properties,
systemData,
type
FROM azure.app_service.web_apps
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND includeSlots = '{{ includeSlots }}'
;
Description for Get all apps for a subscription.
SELECT
id,
name,
extendedLocation,
identity,
properties,
systemData,
type
FROM azure.app_service.web_apps
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;
INSERT
examples
- create_or_update
- Manifest
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
;
# Description fields are for documentation purposes
- name: web_apps
props:
- name: resourceGroupName
value: string
description: Required parameter for the web_apps resource.
- name: name
value: string
description: Required parameter for the web_apps resource.
- name: subscriptionId
value: string
description: Required parameter for the web_apps resource.
- name: properties
value: object
description: |
Site resource specific properties
- name: identity
value: object
description: |
Managed service identity.
- name: extendedLocation
value: object
description: |
Extended Location.
UPDATE
examples
- update
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
- delete_instance_process_slot
- delete_instance_process
- delete_instance_function_slot
- delete
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
;
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 instanceId = '{{ instanceId }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;
Description for Delete a function for web site, or a deployment slot.
DELETE FROM azure.app_service.web_apps
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND name = '{{ name }}' --required
AND functionName = '{{ functionName }}' --required
AND slot = '{{ slot }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;
Description for Deletes a web, mobile, or API app, or one of the deployment slots.
DELETE FROM azure.app_service.web_apps
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND name = '{{ name }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
AND deleteMetrics = '{{ deleteMetrics }}'
AND deleteEmptyServerFarm = '{{ deleteEmptyServerFarm }}'
;
Lifecycle Methods
- analyze_custom_hostname
- apply_slot_config_to_production
- backup
- restore
- recover_site_configuration_snapshot
- start_continuous_web_job
- stop_continuous_web_job
- discover_backup
- sync_functions
- get_instance_process_dump
- is_cloneable
- migrate_storage
- migrate_my_sql
- start_web_site_network_trace
- start_web_site_network_trace_operation
- stop_web_site_network_trace
- generate_new_site_publishing_password
- add_premier_add_on
- put_private_access_vnet
- approve_or_reject_private_endpoint_connection
- reset_production_slot_config
- restart
- restore_from_backup_blob
- restore_from_deleted_app
- restore_snapshot
- install_site_extension
- analyze_custom_hostname_slot
- apply_slot_configuration_slot
- backup_slot
- restore_slot
- recover_site_configuration_snapshot_slot
- start_continuous_web_job_slot
- stop_continuous_web_job_slot
- discover_backup_slot
- sync_functions_slot
- get_instance_process_dump_slot
- is_cloneable_slot
- start_web_site_network_trace_slot
- start_web_site_network_trace_operation_slot
- stop_web_site_network_trace_slot
- generate_new_site_publishing_password_slot
- add_premier_add_on_slot
- put_private_access_vnet_slot
- approve_or_reject_private_endpoint_connection_slot
- reset_slot_configuration_slot
- restart_slot
- restore_from_backup_blob_slot
- restore_from_deleted_app_slot
- restore_snapshot_slot
- install_site_extension_slot
- swap_slot_slot
- start_slot
- start_network_trace_slot
- stop_slot
- stop_network_trace_slot
- sync_repository_slot
- sync_function_triggers_slot
- run_triggered_web_job_slot
- swap_slot_with_production
- start
- start_network_trace
- stop
- stop_network_trace
- sync_repository
- sync_function_triggers
- run_triggered_web_job
- deploy_workflow_artifacts
- deploy_workflow_artifacts_slot
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 }}'
;
Description for Applies the configuration settings from the target slot onto the current slot.
EXEC azure.app_service.web_apps.apply_slot_config_to_production
@resourceGroupName='{{ resourceGroupName }}' --required,
@name='{{ name }}' --required,
@subscriptionId='{{ subscriptionId }}' --required
@@json=
'{
"targetSlot": "{{ targetSlot }}",
"preserveVnet": {{ preserveVnet }}
}'
;
Description for Creates a backup of an app.
EXEC azure.app_service.web_apps.backup
@resourceGroupName='{{ resourceGroupName }}' --required,
@name='{{ name }}' --required,
@subscriptionId='{{ subscriptionId }}' --required
@@json=
'{
"kind": "{{ kind }}",
"properties": "{{ properties }}"
}'
;
Description for Restores a specific backup to another app (or deployment slot, if specified).
EXEC azure.app_service.web_apps.restore
@resourceGroupName='{{ resourceGroupName }}' --required,
@name='{{ name }}' --required,
@backupId='{{ backupId }}' --required,
@subscriptionId='{{ subscriptionId }}' --required
@@json=
'{
"kind": "{{ kind }}",
"properties": "{{ properties }}"
}'
;
Description for Reverts the configuration of an app to a previous snapshot.
EXEC azure.app_service.web_apps.recover_site_configuration_snapshot
@resourceGroupName='{{ resourceGroupName }}' --required,
@name='{{ name }}' --required,
@snapshotId='{{ snapshotId }}' --required,
@subscriptionId='{{ subscriptionId }}' --required
;
Description for Start a continuous web job for an app, or a deployment slot.
EXEC azure.app_service.web_apps.start_continuous_web_job
@resourceGroupName='{{ resourceGroupName }}' --required,
@name='{{ name }}' --required,
@webJobName='{{ webJobName }}' --required,
@subscriptionId='{{ subscriptionId }}' --required
;
Description for Stop a continuous web job for an app, or a deployment slot.
EXEC azure.app_service.web_apps.stop_continuous_web_job
@resourceGroupName='{{ resourceGroupName }}' --required,
@name='{{ name }}' --required,
@webJobName='{{ webJobName }}' --required,
@subscriptionId='{{ subscriptionId }}' --required
;
Description 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.
EXEC azure.app_service.web_apps.discover_backup
@resourceGroupName='{{ resourceGroupName }}' --required,
@name='{{ name }}' --required,
@subscriptionId='{{ subscriptionId }}' --required
@@json=
'{
"kind": "{{ kind }}",
"properties": "{{ properties }}"
}'
;
Description for Syncs function trigger metadata to the management database
EXEC azure.app_service.web_apps.sync_functions
@resourceGroupName='{{ resourceGroupName }}' --required,
@name='{{ name }}' --required,
@subscriptionId='{{ subscriptionId }}' --required
;
Description for Get a memory dump of a process by its ID for a specific scaled-out instance in a web site.
EXEC azure.app_service.web_apps.get_instance_process_dump
@resourceGroupName='{{ resourceGroupName }}' --required,
@name='{{ name }}' --required,
@processId='{{ processId }}' --required,
@instanceId='{{ instanceId }}' --required,
@subscriptionId='{{ subscriptionId }}' --required
;
Description for Shows whether an app can be cloned to another resource group or subscription.
EXEC azure.app_service.web_apps.is_cloneable
@resourceGroupName='{{ resourceGroupName }}' --required,
@name='{{ name }}' --required,
@subscriptionId='{{ subscriptionId }}' --required
;
Description for Restores a web app.
EXEC azure.app_service.web_apps.migrate_storage
@subscriptionName='{{ subscriptionName }}' --required,
@resourceGroupName='{{ resourceGroupName }}' --required,
@name='{{ name }}' --required,
@subscriptionId='{{ subscriptionId }}' --required
@@json=
'{
"kind": "{{ kind }}",
"properties": "{{ properties }}"
}'
;
Description for Migrates a local (in-app) MySql database to a remote MySql database.
EXEC azure.app_service.web_apps.migrate_my_sql
@resourceGroupName='{{ resourceGroupName }}' --required,
@name='{{ name }}' --required,
@subscriptionId='{{ subscriptionId }}' --required
@@json=
'{
"kind": "{{ kind }}",
"properties": "{{ properties }}"
}'
;
Description for Start capturing network packets for the site (To be deprecated).
EXEC azure.app_service.web_apps.start_web_site_network_trace
@resourceGroupName='{{ resourceGroupName }}' --required,
@name='{{ name }}' --required,
@subscriptionId='{{ subscriptionId }}' --required,
@durationInSeconds='{{ durationInSeconds }}',
@maxFrameLength='{{ maxFrameLength }}',
@sasUrl='{{ sasUrl }}'
;
Description for Start capturing network packets for the site.
EXEC azure.app_service.web_apps.start_web_site_network_trace_operation
@resourceGroupName='{{ resourceGroupName }}' --required,
@name='{{ name }}' --required,
@subscriptionId='{{ subscriptionId }}' --required,
@durationInSeconds='{{ durationInSeconds }}',
@maxFrameLength='{{ maxFrameLength }}',
@sasUrl='{{ sasUrl }}'
;
Description for Stop ongoing capturing network packets for the site.
EXEC azure.app_service.web_apps.stop_web_site_network_trace
@resourceGroupName='{{ resourceGroupName }}' --required,
@name='{{ name }}' --required,
@subscriptionId='{{ subscriptionId }}' --required
;
Description for Generates a new publishing password for an app (or deployment slot, if specified).
EXEC azure.app_service.web_apps.generate_new_site_publishing_password
@resourceGroupName='{{ resourceGroupName }}' --required,
@name='{{ name }}' --required,
@subscriptionId='{{ subscriptionId }}' --required
;
Description for Updates a named add-on of an app.
EXEC azure.app_service.web_apps.add_premier_add_on
@resourceGroupName='{{ resourceGroupName }}' --required,
@name='{{ name }}' --required,
@premierAddOnName='{{ premierAddOnName }}' --required,
@subscriptionId='{{ subscriptionId }}' --required
@@json=
'{
"properties": "{{ properties }}"
}'
;
Description for Sets data around private site access enablement and authorized Virtual Networks that can access the site.
EXEC azure.app_service.web_apps.put_private_access_vnet
@resourceGroupName='{{ resourceGroupName }}' --required,
@name='{{ name }}' --required,
@subscriptionId='{{ subscriptionId }}' --required
@@json=
'{
"kind": "{{ kind }}",
"properties": "{{ properties }}"
}'
;
Description for Approves or rejects a private endpoint connection
EXEC azure.app_service.web_apps.approve_or_reject_private_endpoint_connection
@resourceGroupName='{{ resourceGroupName }}' --required,
@name='{{ name }}' --required,
@privateEndpointConnectionName='{{ privateEndpointConnectionName }}' --required,
@subscriptionId='{{ subscriptionId }}' --required
@@json=
'{
"kind": "{{ kind }}",
"properties": "{{ properties }}"
}'
;
Description for Resets the configuration settings of the current slot if they were previously modified by calling the API with POST.
EXEC azure.app_service.web_apps.reset_production_slot_config
@resourceGroupName='{{ resourceGroupName }}' --required,
@name='{{ name }}' --required,
@subscriptionId='{{ subscriptionId }}' --required
;
Description for Restarts an app (or deployment slot, if specified).
EXEC azure.app_service.web_apps.restart
@resourceGroupName='{{ resourceGroupName }}' --required,
@name='{{ name }}' --required,
@subscriptionId='{{ subscriptionId }}' --required,
@softRestart={{ softRestart }},
@synchronous={{ synchronous }}
;
Description for Restores an app from a backup blob in Azure Storage.
EXEC azure.app_service.web_apps.restore_from_backup_blob
@resourceGroupName='{{ resourceGroupName }}' --required,
@name='{{ name }}' --required,
@subscriptionId='{{ subscriptionId }}' --required
@@json=
'{
"kind": "{{ kind }}",
"properties": "{{ properties }}"
}'
;
Description for Restores a deleted web app to this web app.
EXEC azure.app_service.web_apps.restore_from_deleted_app
@resourceGroupName='{{ resourceGroupName }}' --required,
@name='{{ name }}' --required,
@subscriptionId='{{ subscriptionId }}' --required
@@json=
'{
"kind": "{{ kind }}",
"properties": "{{ properties }}"
}'
;
Description for Restores a web app from a snapshot.
EXEC azure.app_service.web_apps.restore_snapshot
@resourceGroupName='{{ resourceGroupName }}' --required,
@name='{{ name }}' --required,
@subscriptionId='{{ subscriptionId }}' --required
@@json=
'{
"kind": "{{ kind }}",
"properties": "{{ properties }}"
}'
;
Description for Install site extension on a web site, or a deployment slot.
EXEC azure.app_service.web_apps.install_site_extension
@resourceGroupName='{{ resourceGroupName }}' --required,
@name='{{ name }}' --required,
@siteExtensionId='{{ siteExtensionId }}' --required,
@subscriptionId='{{ subscriptionId }}' --required
;
Description for Analyze a custom hostname.
EXEC azure.app_service.web_apps.analyze_custom_hostname_slot
@resourceGroupName='{{ resourceGroupName }}' --required,
@name='{{ name }}' --required,
@slot='{{ slot }}' --required,
@subscriptionId='{{ subscriptionId }}' --required,
@hostName='{{ hostName }}'
;
Description for Applies the configuration settings from the target slot onto the current slot.
EXEC azure.app_service.web_apps.apply_slot_configuration_slot
@resourceGroupName='{{ resourceGroupName }}' --required,
@name='{{ name }}' --required,
@slot='{{ slot }}' --required,
@subscriptionId='{{ subscriptionId }}' --required
@@json=
'{
"targetSlot": "{{ targetSlot }}",
"preserveVnet": {{ preserveVnet }}
}'
;
Description for Creates a backup of an app.
EXEC azure.app_service.web_apps.backup_slot
@resourceGroupName='{{ resourceGroupName }}' --required,
@name='{{ name }}' --required,
@slot='{{ slot }}' --required,
@subscriptionId='{{ subscriptionId }}' --required
@@json=
'{
"kind": "{{ kind }}",
"properties": "{{ properties }}"
}'
;
Description for Restores a specific backup to another app (or deployment slot, if specified).
EXEC azure.app_service.web_apps.restore_slot
@resourceGroupName='{{ resourceGroupName }}' --required,
@name='{{ name }}' --required,
@backupId='{{ backupId }}' --required,
@slot='{{ slot }}' --required,
@subscriptionId='{{ subscriptionId }}' --required
@@json=
'{
"kind": "{{ kind }}",
"properties": "{{ properties }}"
}'
;
Description for Reverts the configuration of an app to a previous snapshot.
EXEC azure.app_service.web_apps.recover_site_configuration_snapshot_slot
@resourceGroupName='{{ resourceGroupName }}' --required,
@name='{{ name }}' --required,
@snapshotId='{{ snapshotId }}' --required,
@slot='{{ slot }}' --required,
@subscriptionId='{{ subscriptionId }}' --required
;
Description for Start a continuous web job for an app, or a deployment slot.
EXEC azure.app_service.web_apps.start_continuous_web_job_slot
@resourceGroupName='{{ resourceGroupName }}' --required,
@name='{{ name }}' --required,
@webJobName='{{ webJobName }}' --required,
@slot='{{ slot }}' --required,
@subscriptionId='{{ subscriptionId }}' --required
;
Description for Stop a continuous web job for an app, or a deployment slot.
EXEC azure.app_service.web_apps.stop_continuous_web_job_slot
@resourceGroupName='{{ resourceGroupName }}' --required,
@name='{{ name }}' --required,
@webJobName='{{ webJobName }}' --required,
@slot='{{ slot }}' --required,
@subscriptionId='{{ subscriptionId }}' --required
;
Description 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.
EXEC azure.app_service.web_apps.discover_backup_slot
@resourceGroupName='{{ resourceGroupName }}' --required,
@name='{{ name }}' --required,
@slot='{{ slot }}' --required,
@subscriptionId='{{ subscriptionId }}' --required
@@json=
'{
"kind": "{{ kind }}",
"properties": "{{ properties }}"
}'
;
Description for Syncs function trigger metadata to the management database
EXEC azure.app_service.web_apps.sync_functions_slot
@resourceGroupName='{{ resourceGroupName }}' --required,
@name='{{ name }}' --required,
@slot='{{ slot }}' --required,
@subscriptionId='{{ subscriptionId }}' --required
;
Description for Get a memory dump of a process by its ID for a specific scaled-out instance in a web site.
EXEC azure.app_service.web_apps.get_instance_process_dump_slot
@resourceGroupName='{{ resourceGroupName }}' --required,
@name='{{ name }}' --required,
@processId='{{ processId }}' --required,
@slot='{{ slot }}' --required,
@instanceId='{{ instanceId }}' --required,
@subscriptionId='{{ subscriptionId }}' --required
;
Description for Shows whether an app can be cloned to another resource group or subscription.
EXEC azure.app_service.web_apps.is_cloneable_slot
@resourceGroupName='{{ resourceGroupName }}' --required,
@name='{{ name }}' --required,
@slot='{{ slot }}' --required,
@subscriptionId='{{ subscriptionId }}' --required
;
Description for Start capturing network packets for the site (To be deprecated).
EXEC azure.app_service.web_apps.start_web_site_network_trace_slot
@resourceGroupName='{{ resourceGroupName }}' --required,
@name='{{ name }}' --required,
@slot='{{ slot }}' --required,
@subscriptionId='{{ subscriptionId }}' --required,
@durationInSeconds='{{ durationInSeconds }}',
@maxFrameLength='{{ maxFrameLength }}',
@sasUrl='{{ sasUrl }}'
;
Description for Start capturing network packets for the site.
EXEC azure.app_service.web_apps.start_web_site_network_trace_operation_slot
@resourceGroupName='{{ resourceGroupName }}' --required,
@name='{{ name }}' --required,
@slot='{{ slot }}' --required,
@subscriptionId='{{ subscriptionId }}' --required,
@durationInSeconds='{{ durationInSeconds }}',
@maxFrameLength='{{ maxFrameLength }}',
@sasUrl='{{ sasUrl }}'
;
Description for Stop ongoing capturing network packets for the site.
EXEC azure.app_service.web_apps.stop_web_site_network_trace_slot
@resourceGroupName='{{ resourceGroupName }}' --required,
@name='{{ name }}' --required,
@slot='{{ slot }}' --required,
@subscriptionId='{{ subscriptionId }}' --required
;
Description for Generates a new publishing password for an app (or deployment slot, if specified).
EXEC azure.app_service.web_apps.generate_new_site_publishing_password_slot
@resourceGroupName='{{ resourceGroupName }}' --required,
@name='{{ name }}' --required,
@slot='{{ slot }}' --required,
@subscriptionId='{{ subscriptionId }}' --required
;
Description for Updates a named add-on of an app.
EXEC azure.app_service.web_apps.add_premier_add_on_slot
@resourceGroupName='{{ resourceGroupName }}' --required,
@name='{{ name }}' --required,
@premierAddOnName='{{ premierAddOnName }}' --required,
@slot='{{ slot }}' --required,
@subscriptionId='{{ subscriptionId }}' --required
@@json=
'{
"properties": "{{ properties }}"
}'
;
Description for Sets data around private site access enablement and authorized Virtual Networks that can access the site.
EXEC azure.app_service.web_apps.put_private_access_vnet_slot
@resourceGroupName='{{ resourceGroupName }}' --required,
@name='{{ name }}' --required,
@slot='{{ slot }}' --required,
@subscriptionId='{{ subscriptionId }}' --required
@@json=
'{
"kind": "{{ kind }}",
"properties": "{{ properties }}"
}'
;
Description for Approves or rejects a private endpoint connection
EXEC azure.app_service.web_apps.approve_or_reject_private_endpoint_connection_slot
@resourceGroupName='{{ resourceGroupName }}' --required,
@name='{{ name }}' --required,
@privateEndpointConnectionName='{{ privateEndpointConnectionName }}' --required,
@slot='{{ slot }}' --required,
@subscriptionId='{{ subscriptionId }}' --required
@@json=
'{
"kind": "{{ kind }}",
"properties": "{{ properties }}"
}'
;
Description for Resets the configuration settings of the current slot if they were previously modified by calling the API with POST.
EXEC azure.app_service.web_apps.reset_slot_configuration_slot
@resourceGroupName='{{ resourceGroupName }}' --required,
@name='{{ name }}' --required,
@slot='{{ slot }}' --required,
@subscriptionId='{{ subscriptionId }}' --required
;
Description for Restarts an app (or deployment slot, if specified).
EXEC azure.app_service.web_apps.restart_slot
@resourceGroupName='{{ resourceGroupName }}' --required,
@name='{{ name }}' --required,
@slot='{{ slot }}' --required,
@subscriptionId='{{ subscriptionId }}' --required,
@softRestart={{ softRestart }},
@synchronous={{ synchronous }}
;
Description for Restores an app from a backup blob in Azure Storage.
EXEC azure.app_service.web_apps.restore_from_backup_blob_slot
@resourceGroupName='{{ resourceGroupName }}' --required,
@name='{{ name }}' --required,
@slot='{{ slot }}' --required,
@subscriptionId='{{ subscriptionId }}' --required
@@json=
'{
"kind": "{{ kind }}",
"properties": "{{ properties }}"
}'
;
Description for Restores a deleted web app to this web app.
EXEC azure.app_service.web_apps.restore_from_deleted_app_slot
@resourceGroupName='{{ resourceGroupName }}' --required,
@name='{{ name }}' --required,
@slot='{{ slot }}' --required,
@subscriptionId='{{ subscriptionId }}' --required
@@json=
'{
"kind": "{{ kind }}",
"properties": "{{ properties }}"
}'
;
Description for Restores a web app from a snapshot.
EXEC azure.app_service.web_apps.restore_snapshot_slot
@resourceGroupName='{{ resourceGroupName }}' --required,
@name='{{ name }}' --required,
@slot='{{ slot }}' --required,
@subscriptionId='{{ subscriptionId }}' --required
@@json=
'{
"kind": "{{ kind }}",
"properties": "{{ properties }}"
}'
;
Description for Install site extension on a web site, or a deployment slot.
EXEC azure.app_service.web_apps.install_site_extension_slot
@resourceGroupName='{{ resourceGroupName }}' --required,
@name='{{ name }}' --required,
@siteExtensionId='{{ siteExtensionId }}' --required,
@slot='{{ slot }}' --required,
@subscriptionId='{{ subscriptionId }}' --required
;
Description for Swaps two deployment slots of an app.
EXEC azure.app_service.web_apps.swap_slot_slot
@resourceGroupName='{{ resourceGroupName }}' --required,
@name='{{ name }}' --required,
@slot='{{ slot }}' --required,
@subscriptionId='{{ subscriptionId }}' --required
@@json=
'{
"targetSlot": "{{ targetSlot }}",
"preserveVnet": {{ preserveVnet }}
}'
;
Description for Starts an app (or deployment slot, if specified).
EXEC azure.app_service.web_apps.start_slot
@resourceGroupName='{{ resourceGroupName }}' --required,
@name='{{ name }}' --required,
@slot='{{ slot }}' --required,
@subscriptionId='{{ subscriptionId }}' --required
;
Description for Start capturing network packets for the site.
EXEC azure.app_service.web_apps.start_network_trace_slot
@resourceGroupName='{{ resourceGroupName }}' --required,
@name='{{ name }}' --required,
@slot='{{ slot }}' --required,
@subscriptionId='{{ subscriptionId }}' --required,
@durationInSeconds='{{ durationInSeconds }}',
@maxFrameLength='{{ maxFrameLength }}',
@sasUrl='{{ sasUrl }}'
;
Description for Stops an app (or deployment slot, if specified).
EXEC azure.app_service.web_apps.stop_slot
@resourceGroupName='{{ resourceGroupName }}' --required,
@name='{{ name }}' --required,
@slot='{{ slot }}' --required,
@subscriptionId='{{ subscriptionId }}' --required
;
Description for Stop ongoing capturing network packets for the site.
EXEC azure.app_service.web_apps.stop_network_trace_slot
@resourceGroupName='{{ resourceGroupName }}' --required,
@name='{{ name }}' --required,
@slot='{{ slot }}' --required,
@subscriptionId='{{ subscriptionId }}' --required
;
Description for Sync web app repository.
EXEC azure.app_service.web_apps.sync_repository_slot
@resourceGroupName='{{ resourceGroupName }}' --required,
@name='{{ name }}' --required,
@slot='{{ slot }}' --required,
@subscriptionId='{{ subscriptionId }}' --required
;
Description for Syncs function trigger metadata to the management database
EXEC azure.app_service.web_apps.sync_function_triggers_slot
@resourceGroupName='{{ resourceGroupName }}' --required,
@name='{{ name }}' --required,
@slot='{{ slot }}' --required,
@subscriptionId='{{ subscriptionId }}' --required
;
Description for Run a triggered web job for an app, or a deployment slot.
EXEC azure.app_service.web_apps.run_triggered_web_job_slot
@resourceGroupName='{{ resourceGroupName }}' --required,
@name='{{ name }}' --required,
@webJobName='{{ webJobName }}' --required,
@slot='{{ slot }}' --required,
@subscriptionId='{{ subscriptionId }}' --required
;
Description for Swaps two deployment slots of an app.
EXEC azure.app_service.web_apps.swap_slot_with_production
@resourceGroupName='{{ resourceGroupName }}' --required,
@name='{{ name }}' --required,
@subscriptionId='{{ subscriptionId }}' --required
@@json=
'{
"targetSlot": "{{ targetSlot }}",
"preserveVnet": {{ preserveVnet }}
}'
;
Description for Starts an app (or deployment slot, if specified).
EXEC azure.app_service.web_apps.start
@resourceGroupName='{{ resourceGroupName }}' --required,
@name='{{ name }}' --required,
@subscriptionId='{{ subscriptionId }}' --required
;
Description for Start capturing network packets for the site.
EXEC azure.app_service.web_apps.start_network_trace
@resourceGroupName='{{ resourceGroupName }}' --required,
@name='{{ name }}' --required,
@subscriptionId='{{ subscriptionId }}' --required,
@durationInSeconds='{{ durationInSeconds }}',
@maxFrameLength='{{ maxFrameLength }}',
@sasUrl='{{ sasUrl }}'
;
Description for Stops an app (or deployment slot, if specified).
EXEC azure.app_service.web_apps.stop
@resourceGroupName='{{ resourceGroupName }}' --required,
@name='{{ name }}' --required,
@subscriptionId='{{ subscriptionId }}' --required
;
Description for Stop ongoing capturing network packets for the site.
EXEC azure.app_service.web_apps.stop_network_trace
@resourceGroupName='{{ resourceGroupName }}' --required,
@name='{{ name }}' --required,
@subscriptionId='{{ subscriptionId }}' --required
;
Description for Sync web app repository.
EXEC azure.app_service.web_apps.sync_repository
@resourceGroupName='{{ resourceGroupName }}' --required,
@name='{{ name }}' --required,
@subscriptionId='{{ subscriptionId }}' --required
;
Description for Syncs function trigger metadata to the management database
EXEC azure.app_service.web_apps.sync_function_triggers
@resourceGroupName='{{ resourceGroupName }}' --required,
@name='{{ name }}' --required,
@subscriptionId='{{ subscriptionId }}' --required
;
Description for Run a triggered web job for an app, or a deployment slot.
EXEC azure.app_service.web_apps.run_triggered_web_job
@resourceGroupName='{{ resourceGroupName }}' --required,
@name='{{ name }}' --required,
@webJobName='{{ webJobName }}' --required,
@subscriptionId='{{ subscriptionId }}' --required
;
Description for Creates the artifacts for web site, or a deployment slot.
EXEC azure.app_service.web_apps.deploy_workflow_artifacts
@subscriptionId='{{ subscriptionId }}' --required,
@resourceGroupName='{{ resourceGroupName }}' --required,
@name='{{ name }}' --required
@@json=
'{
"appSettings": "{{ appSettings }}",
"files": "{{ files }}",
"filesToDelete": "{{ filesToDelete }}"
}'
;
Description for Creates the artifacts for web site, or a deployment slot.
EXEC azure.app_service.web_apps.deploy_workflow_artifacts_slot
@subscriptionId='{{ subscriptionId }}' --required,
@resourceGroupName='{{ resourceGroupName }}' --required,
@name='{{ name }}' --required,
@slot='{{ slot }}' --required
@@json=
'{
"appSettings": "{{ appSettings }}",
"files": "{{ files }}",
"filesToDelete": "{{ filesToDelete }}"
}'
;