WebAppsOperations Class

WebAppsOperations async operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Inheritance

builtins.object

WebAppsOperations

Constructor

WebAppsOperations(client, config, serializer, deserializer)

Parameters

client

Required

Client for service requests.

config

Required

Configuration of service client.

serializer

Required

An object model serializer.

deserializer

Required

An object model deserializer.

Variables

models

Alias to model classes used in this operation group.

Methods

add_premier_add_on	Updates a named add-on of an app. Description for Updates a named add-on of an app.
add_premier_add_on_slot	Updates a named add-on of an app. Description for Updates a named add-on of an app.
analyze_custom_hostname	Analyze a custom hostname. Description for Analyze a custom hostname.
analyze_custom_hostname_slot	Analyze a custom hostname. Description for Analyze a custom hostname.
apply_slot_config_to_production	Applies the configuration settings from the target slot onto the current slot. Description for Applies the configuration settings from the target slot onto the current slot.
apply_slot_configuration_slot	Applies the configuration settings from the target slot onto the current slot. Description for Applies the configuration settings from the target slot onto the current slot.
backup	Creates a backup of an app. Description for Creates a backup of an app.
backup_slot	Creates a backup of an app. Description for Creates a backup of an app.
begin_approve_or_reject_private_endpoint_connection	Approves or rejects a private endpoint connection. Description for Approves or rejects a private endpoint connection.
begin_approve_or_reject_private_endpoint_connection_slot	Approves or rejects a private endpoint connection. Description for Approves or rejects a private endpoint connection.
begin_create_function	Create function for web site, or a deployment slot. Description for Create function for web site, or a deployment slot.
begin_create_instance_function_slot	Create function for web site, or a deployment slot. Description for Create function for web site, or a deployment slot.
begin_create_instance_ms_deploy_operation	Invoke the MSDeploy web app extension. Description for Invoke the MSDeploy web app extension.
begin_create_instance_ms_deploy_operation_slot	Invoke the MSDeploy web app extension. Description for Invoke the MSDeploy web app extension.
begin_create_ms_deploy_operation	Invoke the MSDeploy web app extension. Description for Invoke the MSDeploy web app extension.
begin_create_ms_deploy_operation_slot	Invoke the MSDeploy web app extension. Description for Invoke the MSDeploy web app extension.
begin_create_or_update	Creates a new web, mobile, or API app in an existing resource group, or updates an existing app. Description for Creates a new web, mobile, or API app in an existing resource group, or updates an existing app.
begin_create_or_update_slot	Creates a new web, mobile, or API app in an existing resource group, or updates an existing app. Description for Creates a new web, mobile, or API app in an existing resource group, or updates an existing app.
begin_create_or_update_source_control	Updates the source control configuration of an app. Description for Updates the source control configuration of an app.
begin_create_or_update_source_control_slot	Updates the source control configuration of an app. Description for Updates the source control configuration of an app.
begin_delete_private_endpoint_connection	Deletes a private endpoint connection. Description for Deletes a private endpoint connection.
begin_delete_private_endpoint_connection_slot	Deletes a private endpoint connection. Description for Deletes a private endpoint connection.
begin_install_site_extension	Install site extension on a web site, or a deployment slot. Description for Install site extension on a web site, or a deployment slot.
begin_install_site_extension_slot	Install site extension on a web site, or a deployment slot. Description for Install site extension on a web site, or a deployment slot.
begin_list_publishing_credentials	Gets the Git/FTP publishing credentials of an app. Description for Gets the Git/FTP publishing credentials of an app.
begin_list_publishing_credentials_slot	Gets the Git/FTP publishing credentials of an app. Description for Gets the Git/FTP publishing credentials of an app.
begin_migrate_my_sql	Migrates a local (in-app) MySql database to a remote MySql database. Description for Migrates a local (in-app) MySql database to a remote MySql database.
begin_migrate_storage	Restores a web app. Description for Restores a web app.
begin_restore	Restores a specific backup to another app (or deployment slot, if specified). Description for Restores a specific backup to another app (or deployment slot, if specified).
begin_restore_from_backup_blob	Restores an app from a backup blob in Azure Storage. Description for Restores an app from a backup blob in Azure Storage.
begin_restore_from_backup_blob_slot	Restores an app from a backup blob in Azure Storage. Description for Restores an app from a backup blob in Azure Storage.
begin_restore_from_deleted_app	Restores a deleted web app to this web app. Description for Restores a deleted web app to this web app.
begin_restore_from_deleted_app_slot	Restores a deleted web app to this web app. Description for Restores a deleted web app to this web app.
begin_restore_slot	Restores a specific backup to another app (or deployment slot, if specified). Description for Restores a specific backup to another app (or deployment slot, if specified).
begin_restore_snapshot	Restores a web app from a snapshot. Description for Restores a web app from a snapshot.
begin_restore_snapshot_slot	Restores a web app from a snapshot. Description for Restores a web app from a snapshot.
begin_start_network_trace	Start capturing network packets for the site. Description for Start capturing network packets for the site.
begin_start_network_trace_slot	Start capturing network packets for the site. Description for Start capturing network packets for the site.
begin_start_web_site_network_trace_operation	Start capturing network packets for the site. Description for Start capturing network packets for the site.
begin_start_web_site_network_trace_operation_slot	Start capturing network packets for the site. Description for Start capturing network packets for the site.
begin_swap_slot	Swaps two deployment slots of an app. Description for Swaps two deployment slots of an app.
begin_swap_slot_with_production	Swaps two deployment slots of an app. Description for Swaps two deployment slots of an app.
create_deployment	Create a deployment for an app, or a deployment slot. Description for Create a deployment for an app, or a deployment slot.
create_deployment_slot	Create a deployment for an app, or a deployment slot. Description for Create a deployment for an app, or a deployment slot.
create_or_update_configuration	Updates the configuration of an app. Description for Updates the configuration of an app.
create_or_update_configuration_slot	Updates the configuration of an app. Description for Updates the configuration of an app.
create_or_update_domain_ownership_identifier	Creates a domain ownership identifier for web app, or updates an existing ownership identifier. Description for Creates a domain ownership identifier for web app, or updates an existing ownership identifier.
create_or_update_domain_ownership_identifier_slot	Creates a domain ownership identifier for web app, or updates an existing ownership identifier. Description for Creates a domain ownership identifier for web app, or updates an existing ownership identifier.
create_or_update_function_secret	Add or update a function secret. Description for Add or update a function secret.
create_or_update_function_secret_slot	Add or update a function secret. Description for Add or update a function secret.
create_or_update_host_name_binding	Creates a hostname binding for an app. Description for Creates a hostname binding for an app.
create_or_update_host_name_binding_slot	Creates a hostname binding for an app. Description for Creates a hostname binding for an app.
create_or_update_host_secret	Add or update a host level secret. Description for Add or update a host level secret.
create_or_update_host_secret_slot	Add or update a host level secret. Description for Add or update a host level secret.
create_or_update_hybrid_connection	Creates a new Hybrid Connection using a Service Bus relay. Description for Creates a new Hybrid Connection using a Service Bus relay.
create_or_update_hybrid_connection_slot	Creates a new Hybrid Connection using a Service Bus relay. Description for Creates a new Hybrid Connection using a Service Bus relay.
create_or_update_public_certificate	Creates a hostname binding for an app. Description for Creates a hostname binding for an app.
create_or_update_public_certificate_slot	Creates a hostname binding for an app. Description for Creates a hostname binding for an app.
create_or_update_relay_service_connection	Creates a new hybrid connection configuration (PUT), or updates an existing one (PATCH). Description for Creates a new hybrid connection configuration (PUT), or updates an existing one (PATCH).
create_or_update_relay_service_connection_slot	Creates a new hybrid connection configuration (PUT), or updates an existing one (PATCH). Description for Creates a new hybrid connection configuration (PUT), or updates an existing one (PATCH).
create_or_update_swift_virtual_network_connection_with_check	Integrates this Web App with a Virtual Network. This requires that 1) "swiftSupported" is true when doing a GET against this resource, and 2) that the target Subnet has already been delegated, and is not in use by another App Service Plan other than the one this App is in. Description for Integrates this Web App with a Virtual Network. This requires that 1) "swiftSupported" is true when doing a GET against this resource, and 2) that the target Subnet has already been delegated, and is not in use by another App Service Plan other than the one this App is in.
create_or_update_swift_virtual_network_connection_with_check_slot	Integrates this Web App with a Virtual Network. This requires that 1) "swiftSupported" is true when doing a GET against this resource, and 2) that the target Subnet has already been delegated, and is not in use by another App Service Plan other than the one this App is in. Description for Integrates this Web App with a Virtual Network. This requires that 1) "swiftSupported" is true when doing a GET against this resource, and 2) that the target Subnet has already been delegated, and is not in use by another App Service Plan other than the one this App is in.
create_or_update_vnet_connection	Adds a Virtual Network connection to an app or slot (PUT) or updates the connection properties (PATCH). Description for Adds a Virtual Network connection to an app or slot (PUT) or updates the connection properties (PATCH).
create_or_update_vnet_connection_gateway	Adds a gateway to a connected Virtual Network (PUT) or updates it (PATCH). Description for Adds a gateway to a connected Virtual Network (PUT) or updates it (PATCH).
create_or_update_vnet_connection_gateway_slot	Adds a gateway to a connected Virtual Network (PUT) or updates it (PATCH). Description for Adds a gateway to a connected Virtual Network (PUT) or updates it (PATCH).
create_or_update_vnet_connection_slot	Adds a Virtual Network connection to an app or slot (PUT) or updates the connection properties (PATCH). Description for Adds a Virtual Network connection to an app or slot (PUT) or updates the connection properties (PATCH).
delete	Deletes a web, mobile, or API app, or one of the deployment slots. Description for Deletes a web, mobile, or API app, or one of the deployment slots.
delete_backup	Deletes a backup of an app by its ID. Description for Deletes a backup of an app by its ID.
delete_backup_configuration	Deletes the backup configuration of an app. Description for Deletes the backup configuration of an app.
delete_backup_configuration_slot	Deletes the backup configuration of an app. Description for Deletes the backup configuration of an app.
delete_backup_slot	Deletes a backup of an app by its ID. Description for Deletes a backup of an app by its ID.
delete_continuous_web_job	Delete a continuous web job by its ID for an app, or a deployment slot. Description for Delete a continuous web job by its ID for an app, or a deployment slot.
delete_continuous_web_job_slot	Delete a continuous web job by its ID for an app, or a deployment slot. Description for Delete a continuous web job by its ID for an app, or a deployment slot.
delete_deployment	Delete a deployment by its ID for an app, or a deployment slot. Description for Delete a deployment by its ID for an app, or a deployment slot.
delete_deployment_slot	Delete a deployment by its ID for an app, or a deployment slot. Description for Delete a deployment by its ID for an app, or a deployment slot.
delete_domain_ownership_identifier	Deletes a domain ownership identifier for a web app. Description for Deletes a domain ownership identifier for a web app.
delete_domain_ownership_identifier_slot	Deletes a domain ownership identifier for a web app. Description for Deletes a domain ownership identifier for a web app.
delete_function	Delete a function for web site, or a deployment slot. Description for Delete a function for web site, or a deployment slot.
delete_function_secret	Delete a function secret. Description for Delete a function secret.
delete_function_secret_slot	Delete a function secret. Description for Delete a function secret.
delete_host_name_binding	Deletes a hostname binding for an app. Description for Deletes a hostname binding for an app.
delete_host_name_binding_slot	Deletes a hostname binding for an app. Description for Deletes a hostname binding for an app.
delete_host_secret	Delete a host level secret. Description for Delete a host level secret.
delete_host_secret_slot	Delete a host level secret. Description for Delete a host level secret.
delete_hybrid_connection	Removes a Hybrid Connection from this site. Description for Removes a Hybrid Connection from this site.
delete_hybrid_connection_slot	Removes a Hybrid Connection from this site. Description for Removes a Hybrid Connection from this site.
delete_instance_function_slot	Delete a function for web site, or a deployment slot. Description for Delete a function for web site, or a deployment slot.
delete_instance_process	Terminate a process by its ID for a web site, or a deployment slot, or specific scaled-out instance in a web site. 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_slot	Terminate a process by its ID for a web site, or a deployment slot, or specific scaled-out instance in a web site. 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_premier_add_on	Delete a premier add-on from an app. Description for Delete a premier add-on from an app.
delete_premier_add_on_slot	Delete a premier add-on from an app. Description for Delete a premier add-on from an app.
delete_process	Terminate a process by its ID for a web site, or a deployment slot, or specific scaled-out instance in a web site. 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_process_slot	Terminate a process by its ID for a web site, or a deployment slot, or specific scaled-out instance in a web site. 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_public_certificate	Deletes a hostname binding for an app. Description for Deletes a hostname binding for an app.
delete_public_certificate_slot	Deletes a hostname binding for an app. Description for Deletes a hostname binding for an app.
delete_relay_service_connection	Deletes a relay service connection by its name. Description for Deletes a relay service connection by its name.
delete_relay_service_connection_slot	Deletes a relay service connection by its name. Description for Deletes a relay service connection by its name.
delete_site_extension	Remove a site extension from a web site, or a deployment slot. Description for Remove a site extension from a web site, or a deployment slot.
delete_site_extension_slot	Remove a site extension from a web site, or a deployment slot. Description for Remove a site extension from a web site, or a deployment slot.
delete_slot	Deletes a web, mobile, or API app, or one of the deployment slots. Description for Deletes a web, mobile, or API app, or one of the deployment slots.
delete_source_control	Deletes the source control configuration of an app. Description for Deletes the source control configuration of an app.
delete_source_control_slot	Deletes the source control configuration of an app. Description for Deletes the source control configuration of an app.
delete_swift_virtual_network	Deletes a Swift Virtual Network connection from an app (or deployment slot). Description for Deletes a Swift Virtual Network connection from an app (or deployment slot).
delete_swift_virtual_network_slot	Deletes a Swift Virtual Network connection from an app (or deployment slot). Description for Deletes a Swift Virtual Network connection from an app (or deployment slot).
delete_triggered_web_job	Delete a triggered web job by its ID for an app, or a deployment slot. Description for Delete a triggered web job by its ID for an app, or a deployment slot.
delete_triggered_web_job_slot	Delete a triggered web job by its ID for an app, or a deployment slot. Description for Delete a triggered web job by its ID for an app, or a deployment slot.
delete_vnet_connection	Deletes a connection from an app (or deployment slot to a named virtual network. Description for Deletes a connection from an app (or deployment slot to a named virtual network.
delete_vnet_connection_slot	Deletes a connection from an app (or deployment slot to a named virtual network. Description for Deletes a connection from an app (or deployment slot to a named virtual network.
discover_backup	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. 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.
discover_backup_slot	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. 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.
generate_new_site_publishing_password	Generates a new publishing password for an app (or deployment slot, if specified). Description for Generates a new publishing password for an app (or deployment slot, if specified).
generate_new_site_publishing_password_slot	Generates a new publishing password for an app (or deployment slot, if specified). Description for Generates a new publishing password for an app (or deployment slot, if specified).
get	Gets the details of a web, mobile, or API app. Description for Gets the details of a web, mobile, or API app.
get_app_setting_key_vault_reference	Gets the config reference and status of an app. Description for Gets the config reference and status of an app.
get_app_setting_key_vault_reference_slot	Gets the config reference and status of an app. Description for Gets the config reference and status of an app.
get_app_settings_key_vault_references	Gets the config reference app settings and status of an app. Description for Gets the config reference app settings and status of an app.
get_app_settings_key_vault_references_slot	Gets the config reference app settings and status of an app. Description for Gets the config reference app settings and status of an app.
get_auth_settings	Gets the Authentication/Authorization settings of an app. Description for Gets the Authentication/Authorization settings of an app.
get_auth_settings_slot	Gets the Authentication/Authorization settings of an app. Description for Gets the Authentication/Authorization settings of an app.
get_auth_settings_v2	Gets site's Authentication / Authorization settings for apps via the V2 format. Description for Gets site's Authentication / Authorization settings for apps via the V2 format.
get_auth_settings_v2_slot	Gets site's Authentication / Authorization settings for apps via the V2 format. Description for Gets site's Authentication / Authorization settings for apps via the V2 format.
get_backup_configuration	Gets the backup configuration of an app. Description for Gets the backup configuration of an app.
get_backup_configuration_slot	Gets the backup configuration of an app. Description for Gets the backup configuration of an app.
get_backup_status	Gets a backup of an app by its ID. Description for Gets a backup of an app by its ID.
get_backup_status_slot	Gets a backup of an app by its ID. Description for Gets a backup of an app by its ID.
get_configuration	Gets the configuration of an app, such as platform version and bitness, default documents, virtual applications, Always On, etc. Description for Gets the configuration of an app, such as platform version and bitness, default documents, virtual applications, Always On, etc.
get_configuration_slot	Gets the configuration of an app, such as platform version and bitness, default documents, virtual applications, Always On, etc. Description for Gets the configuration of an app, such as platform version and bitness, default documents, virtual applications, Always On, etc.
get_configuration_snapshot	Gets a snapshot of the configuration of an app at a previous point in time. Description for Gets a snapshot of the configuration of an app at a previous point in time.
get_configuration_snapshot_slot	Gets a snapshot of the configuration of an app at a previous point in time. Description for Gets a snapshot of the configuration of an app at a previous point in time.
get_container_logs_zip	Gets the ZIP archived docker log files for the given site. Description for Gets the ZIP archived docker log files for the given site.
get_container_logs_zip_slot	Gets the ZIP archived docker log files for the given site. Description for Gets the ZIP archived docker log files for the given site.
get_continuous_web_job	Gets a continuous web job by its ID for an app, or a deployment slot. Description for Gets a continuous web job by its ID for an app, or a deployment slot.
get_continuous_web_job_slot	Gets a continuous web job by its ID for an app, or a deployment slot. Description for Gets a continuous web job by its ID for an app, or a deployment slot.
get_deployment	Get a deployment by its ID for an app, or a deployment slot. Description for Get a deployment by its ID for an app, or a deployment slot.
get_deployment_slot	Get a deployment by its ID for an app, or a deployment slot. Description for Get a deployment by its ID for an app, or a deployment slot.
get_diagnostic_logs_configuration	Gets the logging configuration of an app. Description for Gets the logging configuration of an app.
get_diagnostic_logs_configuration_slot	Gets the logging configuration of an app. Description for Gets the logging configuration of an app.
get_domain_ownership_identifier	Get domain ownership identifier for web app. Description for Get domain ownership identifier for web app.
get_domain_ownership_identifier_slot	Get domain ownership identifier for web app. Description for Get domain ownership identifier for web app.
get_ftp_allowed	Returns whether FTP is allowed on the site or not. Description for Returns whether FTP is allowed on the site or not.
get_ftp_allowed_slot	Returns whether FTP is allowed on the site or not. Description for Returns whether FTP is allowed on the site or not.
get_function	Get function information by its ID for web site, or a deployment slot. Description for Get function information by its ID for web site, or a deployment slot.
get_functions_admin_token	Fetch a short lived token that can be exchanged for a master key. Description for Fetch a short lived token that can be exchanged for a master key.
get_functions_admin_token_slot	Fetch a short lived token that can be exchanged for a master key. Description for Fetch a short lived token that can be exchanged for a master key.
get_host_name_binding	Get the named hostname binding for an app (or deployment slot, if specified). Description for Get the named hostname binding for an app (or deployment slot, if specified).
get_host_name_binding_slot	Get the named hostname binding for an app (or deployment slot, if specified). Description for Get the named hostname binding for an app (or deployment slot, if specified).
get_hybrid_connection	Retrieves a specific Service Bus Hybrid Connection used by this Web App. Description for Retrieves a specific Service Bus Hybrid Connection used by this Web App.
get_hybrid_connection_slot	Retrieves a specific Service Bus Hybrid Connection used by this Web App. Description for Retrieves a specific Service Bus Hybrid Connection used by this Web App.
get_instance_function_slot	Get function information by its ID for web site, or a deployment slot. Description for Get function information by its ID for web site, or a deployment slot.
get_instance_info	Gets all scale-out instances of an app. Description for Gets all scale-out instances of an app.
get_instance_info_slot	Gets all scale-out instances of an app. Description for Gets all scale-out instances of an app.
get_instance_ms_deploy_log	Get the MSDeploy Log for the last MSDeploy operation. Description for Get the MSDeploy Log for the last MSDeploy operation.
get_instance_ms_deploy_log_slot	Get the MSDeploy Log for the last MSDeploy operation. Description for Get the MSDeploy Log for the last MSDeploy operation.
get_instance_ms_deploy_status	Get the status of the last MSDeploy operation. Description for Get the status of the last MSDeploy operation.
get_instance_ms_deploy_status_slot	Get the status of the last MSDeploy operation. Description for Get the status of the last MSDeploy operation.
get_instance_process	Get process information by its ID for a specific scaled-out instance in a web site. Description for Get process information by its ID for a specific scaled-out instance in a web site.
get_instance_process_dump	Get a memory dump of a process by its ID for a specific scaled-out instance in a web site. Description 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_slot	Get a memory dump of a process by its ID for a specific scaled-out instance in a web site. Description for Get a memory dump of a process by its ID for a specific scaled-out instance in a web site.
get_instance_process_module	Get process information by its ID for a specific scaled-out instance in a web site. Description for Get process information by its ID for a specific scaled-out instance in a web site.
get_instance_process_module_slot	Get process information by its ID for a specific scaled-out instance in a web site. Description for Get process information by its ID for a specific scaled-out instance in a web site.
get_instance_process_slot	Get process information by its ID for a specific scaled-out instance in a web site. Description for Get process information by its ID for a specific scaled-out instance in a web site.
get_migrate_my_sql_status	Returns the status of MySql in app migration, if one is active, and whether or not MySql in app is enabled. Description for Returns the status of MySql in app migration, if one is active, and whether or not MySql in app is enabled.
get_migrate_my_sql_status_slot	Returns the status of MySql in app migration, if one is active, and whether or not MySql in app is enabled. Description for Returns the status of MySql in app migration, if one is active, and whether or not MySql in app is enabled.
get_ms_deploy_log	Get the MSDeploy Log for the last MSDeploy operation. Description for Get the MSDeploy Log for the last MSDeploy operation.
get_ms_deploy_log_slot	Get the MSDeploy Log for the last MSDeploy operation. Description for Get the MSDeploy Log for the last MSDeploy operation.
get_ms_deploy_status	Get the status of the last MSDeploy operation. Description for Get the status of the last MSDeploy operation.
get_ms_deploy_status_slot	Get the status of the last MSDeploy operation. Description for Get the status of the last MSDeploy operation.
get_network_trace_operation	Gets a named operation for a network trace capturing (or deployment slot, if specified). Description for Gets a named operation for a network trace capturing (or deployment slot, if specified).
get_network_trace_operation_slot	Gets a named operation for a network trace capturing (or deployment slot, if specified). Description for Gets a named operation for a network trace capturing (or deployment slot, if specified).
get_network_trace_operation_slot_v2	Gets a named operation for a network trace capturing (or deployment slot, if specified). Description for Gets a named operation for a network trace capturing (or deployment slot, if specified).
get_network_trace_operation_v2	Gets a named operation for a network trace capturing (or deployment slot, if specified). Description for Gets a named operation for a network trace capturing (or deployment slot, if specified).
get_network_traces	Gets a named operation for a network trace capturing (or deployment slot, if specified). Description for Gets a named operation for a network trace capturing (or deployment slot, if specified).
get_network_traces_slot	Gets a named operation for a network trace capturing (or deployment slot, if specified). Description for Gets a named operation for a network trace capturing (or deployment slot, if specified).
get_network_traces_slot_v2	Gets a named operation for a network trace capturing (or deployment slot, if specified). Description for Gets a named operation for a network trace capturing (or deployment slot, if specified).
get_network_traces_v2	Gets a named operation for a network trace capturing (or deployment slot, if specified). Description for Gets a named operation for a network trace capturing (or deployment slot, if specified).
get_premier_add_on	Gets a named add-on of an app. Description for Gets a named add-on of an app.
get_premier_add_on_slot	Gets a named add-on of an app. Description for Gets a named add-on of an app.
get_private_access	Gets data around private site access enablement and authorized Virtual Networks that can access the site. Description for Gets data around private site access enablement and authorized Virtual Networks that can access the site.
get_private_access_slot	Gets data around private site access enablement and authorized Virtual Networks that can access the site. Description for Gets data around private site access enablement and authorized Virtual Networks that can access the site.
get_private_endpoint_connection	Gets a private endpoint connection. Description for Gets a private endpoint connection.
get_private_endpoint_connection_list	Gets the list of private endpoint connections associated with a site. Description for Gets the list of private endpoint connections associated with a site.
get_private_endpoint_connection_list_slot	Gets the list of private endpoint connections associated with a site. Description for Gets the list of private endpoint connections associated with a site.
get_private_endpoint_connection_slot	Gets a private endpoint connection. Description for Gets a private endpoint connection.
get_private_link_resources	Gets the private link resources. Description for Gets the private link resources.
get_private_link_resources_slot	Gets the private link resources. Description for Gets the private link resources.
get_process	Get process information by its ID for a specific scaled-out instance in a web site. Description for Get process information by its ID for a specific scaled-out instance in a web site.
get_process_dump	Get a memory dump of a process by its ID for a specific scaled-out instance in a web site. Description for Get a memory dump of a process by its ID for a specific scaled-out instance in a web site.
get_process_dump_slot	Get a memory dump of a process by its ID for a specific scaled-out instance in a web site. Description for Get a memory dump of a process by its ID for a specific scaled-out instance in a web site.
get_process_module	Get process information by its ID for a specific scaled-out instance in a web site. Description for Get process information by its ID for a specific scaled-out instance in a web site.
get_process_module_slot	Get process information by its ID for a specific scaled-out instance in a web site. Description for Get process information by its ID for a specific scaled-out instance in a web site.
get_process_slot	Get process information by its ID for a specific scaled-out instance in a web site. Description for Get process information by its ID for a specific scaled-out instance in a web site.
get_public_certificate	Get the named public certificate for an app (or deployment slot, if specified). Description for Get the named public certificate for an app (or deployment slot, if specified).
get_public_certificate_slot	Get the named public certificate for an app (or deployment slot, if specified). Description for Get the named public certificate for an app (or deployment slot, if specified).
get_relay_service_connection	Gets a hybrid connection configuration by its name. Description for Gets a hybrid connection configuration by its name.
get_relay_service_connection_slot	Gets a hybrid connection configuration by its name. Description for Gets a hybrid connection configuration by its name.
get_scm_allowed	Returns whether Scm basic auth is allowed on the site or not. Description for Returns whether Scm basic auth is allowed on the site or not.
get_scm_allowed_slot	Returns whether Scm basic auth is allowed on the site or not. Description for Returns whether Scm basic auth is allowed on the site or not.
get_site_connection_string_key_vault_reference	Gets the config reference and status of an app. Description for Gets the config reference and status of an app.
get_site_connection_string_key_vault_reference_slot	Gets the config reference and status of an app. Description for Gets the config reference and status of an app.
get_site_connection_string_key_vault_references	Gets the config reference app settings and status of an app. Description for Gets the config reference app settings and status of an app.
get_site_connection_string_key_vault_references_slot	Gets the config reference app settings and status of an app. Description for Gets the config reference app settings and status of an app.
get_site_extension	Get site extension information by its ID for a web site, or a deployment slot. Description for Get site extension information by its ID for a web site, or a deployment slot.
get_site_extension_slot	Get site extension information by its ID for a web site, or a deployment slot. Description for Get site extension information by its ID for a web site, or a deployment slot.
get_site_php_error_log_flag	Gets web app's event logs. Description for Gets web app's event logs.
get_site_php_error_log_flag_slot	Gets web app's event logs. Description for Gets web app's event logs.
get_slot	Gets the details of a web, mobile, or API app. Description for Gets the details of a web, mobile, or API app.
get_source_control	Gets the source control configuration of an app. Description for Gets the source control configuration of an app.
get_source_control_slot	Gets the source control configuration of an app. Description for Gets the source control configuration of an app.
get_swift_virtual_network_connection	Gets a Swift Virtual Network connection. Description for Gets a Swift Virtual Network connection.
get_swift_virtual_network_connection_slot	Gets a Swift Virtual Network connection. Description for Gets a Swift Virtual Network connection.
get_triggered_web_job	Gets a triggered web job by its ID for an app, or a deployment slot. Description for Gets a triggered web job by its ID for an app, or a deployment slot.
get_triggered_web_job_history	Gets a triggered web job's history by its ID for an app, , or a deployment slot. Description for Gets a triggered web job's history by its ID for an app, , or a deployment slot.
get_triggered_web_job_history_slot	Gets a triggered web job's history by its ID for an app, , or a deployment slot. Description for Gets a triggered web job's history by its ID for an app, , or a deployment slot.
get_triggered_web_job_slot	Gets a triggered web job by its ID for an app, or a deployment slot. Description for Gets a triggered web job by its ID for an app, or a deployment slot.
get_vnet_connection	Gets a virtual network the app (or deployment slot) is connected to by name. Description for Gets a virtual network the app (or deployment slot) is connected to by name.
get_vnet_connection_gateway	Gets an app's Virtual Network gateway. Description for Gets an app's Virtual Network gateway.
get_vnet_connection_gateway_slot	Gets an app's Virtual Network gateway. Description for Gets an app's Virtual Network gateway.
get_vnet_connection_slot	Gets a virtual network the app (or deployment slot) is connected to by name. Description for Gets a virtual network the app (or deployment slot) is connected to by name.
get_web_job	Get webjob information for an app, or a deployment slot. Description for Get webjob information for an app, or a deployment slot.
get_web_job_slot	Get webjob information for an app, or a deployment slot. Description for Get webjob information for an app, or a deployment slot.
get_web_site_container_logs	Gets the last lines of docker logs for the given site. Description for Gets the last lines of docker logs for the given site.
get_web_site_container_logs_slot	Gets the last lines of docker logs for the given site. Description for Gets the last lines of docker logs for the given site.
is_cloneable	Shows whether an app can be cloned to another resource group or subscription. Description for Shows whether an app can be cloned to another resource group or subscription.
is_cloneable_slot	Shows whether an app can be cloned to another resource group or subscription. Description for Shows whether an app can be cloned to another resource group or subscription.
list	Get all apps for a subscription. Description for Get all apps for a subscription.
list_application_settings	Gets the application settings of an app. Description for Gets the application settings of an app.
list_application_settings_slot	Gets the application settings of an app. Description for Gets the application settings of an app.
list_azure_storage_accounts	Gets the Azure storage account configurations of an app. Description for Gets the Azure storage account configurations of an app.
list_azure_storage_accounts_slot	Gets the Azure storage account configurations of an app. Description for Gets the Azure storage account configurations of an app.
list_backup_status_secrets	Gets status of a web app backup that may be in progress, including secrets associated with the backup, such as the Azure Storage SAS URL. Also can be used to update the SAS URL for the backup if a new URL is passed in the request body. Description for Gets status of a web app backup that may be in progress, including secrets associated with the backup, such as the Azure Storage SAS URL. Also can be used to update the SAS URL for the backup if a new URL is passed in the request body.
list_backup_status_secrets_slot	Gets status of a web app backup that may be in progress, including secrets associated with the backup, such as the Azure Storage SAS URL. Also can be used to update the SAS URL for the backup if a new URL is passed in the request body. Description for Gets status of a web app backup that may be in progress, including secrets associated with the backup, such as the Azure Storage SAS URL. Also can be used to update the SAS URL for the backup if a new URL is passed in the request body.
list_backups	Gets existing backups of an app. Description for Gets existing backups of an app.
list_backups_slot	Gets existing backups of an app. Description for Gets existing backups of an app.
list_basic_publishing_credentials_policies	Returns whether Scm basic auth is allowed and whether Ftp is allowed for a given site. Description for Returns whether Scm basic auth is allowed and whether Ftp is allowed for a given site.
list_basic_publishing_credentials_policies_slot	Returns whether Scm basic auth is allowed and whether Ftp is allowed for a given site. Description for Returns whether Scm basic auth is allowed and whether Ftp is allowed for a given site.
list_by_resource_group	Gets all web, mobile, and API apps in the specified resource group. Description for Gets all web, mobile, and API apps in the specified resource group.
list_configuration_snapshot_info	Gets a list of web app configuration snapshots identifiers. Each element of the list contains a timestamp and the ID of the snapshot. Description for Gets a list of web app configuration snapshots identifiers. Each element of the list contains a timestamp and the ID of the snapshot.
list_configuration_snapshot_info_slot	Gets a list of web app configuration snapshots identifiers. Each element of the list contains a timestamp and the ID of the snapshot. Description for Gets a list of web app configuration snapshots identifiers. Each element of the list contains a timestamp and the ID of the snapshot.
list_configurations	List the configurations of an app. Description for List the configurations of an app.
list_configurations_slot	List the configurations of an app. Description for List the configurations of an app.
list_connection_strings	Gets the connection strings of an app. Description for Gets the connection strings of an app.
list_connection_strings_slot	Gets the connection strings of an app. Description for Gets the connection strings of an app.
list_continuous_web_jobs	List continuous web jobs for an app, or a deployment slot. Description for List continuous web jobs for an app, or a deployment slot.
list_continuous_web_jobs_slot	List continuous web jobs for an app, or a deployment slot. Description for List continuous web jobs for an app, or a deployment slot.
list_deployment_log	List deployment log for specific deployment for an app, or a deployment slot. Description for List deployment log for specific deployment for an app, or a deployment slot.
list_deployment_log_slot	List deployment log for specific deployment for an app, or a deployment slot. Description for List deployment log for specific deployment for an app, or a deployment slot.
list_deployments	List deployments for an app, or a deployment slot. Description for List deployments for an app, or a deployment slot.
list_deployments_slot	List deployments for an app, or a deployment slot. Description for List deployments for an app, or a deployment slot.
list_domain_ownership_identifiers	Lists ownership identifiers for domain associated with web app. Description for Lists ownership identifiers for domain associated with web app.
list_domain_ownership_identifiers_slot	Lists ownership identifiers for domain associated with web app. Description for Lists ownership identifiers for domain associated with web app.
list_function_keys	Get function keys for a function in a web site, or a deployment slot. Description for Get function keys for a function in a web site, or a deployment slot.
list_function_keys_slot	Get function keys for a function in a web site, or a deployment slot. Description for Get function keys for a function in a web site, or a deployment slot.
list_function_secrets	Get function secrets for a function in a web site, or a deployment slot. Description for Get function secrets for a function in a web site, or a deployment slot.
list_function_secrets_slot	Get function secrets for a function in a web site, or a deployment slot. Description for Get function secrets for a function in a web site, or a deployment slot.
list_functions	List the functions for a web site, or a deployment slot. Description for List the functions for a web site, or a deployment slot.
list_host_keys	Get host secrets for a function app. Description for Get host secrets for a function app.
list_host_keys_slot	Get host secrets for a function app. Description for Get host secrets for a function app.
list_host_name_bindings	Get hostname bindings for an app or a deployment slot. Description for Get hostname bindings for an app or a deployment slot.
list_host_name_bindings_slot	Get hostname bindings for an app or a deployment slot. Description for Get hostname bindings for an app or a deployment slot.
list_hybrid_connections	Retrieves all Service Bus Hybrid Connections used by this Web App. Description for Retrieves all Service Bus Hybrid Connections used by this Web App.
list_hybrid_connections_slot	Retrieves all Service Bus Hybrid Connections used by this Web App. Description for Retrieves all Service Bus Hybrid Connections used by this Web App.
list_instance_functions_slot	List the functions for a web site, or a deployment slot. Description for List the functions for a web site, or a deployment slot.
list_instance_identifiers	Gets all scale-out instances of an app. Description for Gets all scale-out instances of an app.
list_instance_identifiers_slot	Gets all scale-out instances of an app. Description for Gets all scale-out instances of an app.
list_instance_process_modules	List module information for a process by its ID for a specific scaled-out instance in a web site. Description for List module information for a process by its ID for a specific scaled-out instance in a web site.
list_instance_process_modules_slot	List module information for a process by its ID for a specific scaled-out instance in a web site. 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	List the threads in a process by its ID for a specific scaled-out instance in a web site. Description for List the threads in a process by its ID for a specific scaled-out instance in a web site.
list_instance_process_threads_slot	List the threads in a process by its ID for a specific scaled-out instance in a web site. Description for List the threads in a process by its ID for a specific scaled-out instance in a web site.
list_instance_processes	Get list of processes for a web site, or a deployment slot, or for a specific scaled-out instance in a web site. 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_instance_processes_slot	Get list of processes for a web site, or a deployment slot, or for a specific scaled-out instance in a web site. 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_metadata	Gets the metadata of an app. Description for Gets the metadata of an app.
list_metadata_slot	Gets the metadata of an app. Description for Gets the metadata of an app.
list_network_features	Gets all network features used by the app (or deployment slot, if specified). Description for Gets all network features used by the app (or deployment slot, if specified).
list_network_features_slot	Gets all network features used by the app (or deployment slot, if specified). Description for Gets all network features used by the app (or deployment slot, if specified).
list_perf_mon_counters	Gets perfmon counters for web app. Description for Gets perfmon counters for web app.
list_perf_mon_counters_slot	Gets perfmon counters for web app. Description for Gets perfmon counters for web app.
list_premier_add_ons	Gets the premier add-ons of an app. Description for Gets the premier add-ons of an app.
list_premier_add_ons_slot	Gets the premier add-ons of an app. Description for Gets the premier add-ons of an app.
list_process_modules	List module information for a process by its ID for a specific scaled-out instance in a web site. Description for List module information for a process by its ID for a specific scaled-out instance in a web site.
list_process_modules_slot	List module information for a process by its ID for a specific scaled-out instance in a web site. Description for List module information for a process by its ID for a specific scaled-out instance in a web site.
list_process_threads	List the threads in a process by its ID for a specific scaled-out instance in a web site. Description for List the threads in a process by its ID for a specific scaled-out instance in a web site.
list_process_threads_slot	List the threads in a process by its ID for a specific scaled-out instance in a web site. Description for List the threads in a process by its ID for a specific scaled-out instance in a web site.
list_processes	Get list of processes for a web site, or a deployment slot, or for a specific scaled-out instance in a web site. 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_processes_slot	Get list of processes for a web site, or a deployment slot, or for a specific scaled-out instance in a web site. 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_public_certificates	Get public certificates for an app or a deployment slot. Description for Get public certificates for an app or a deployment slot.
list_public_certificates_slot	Get public certificates for an app or a deployment slot. Description for Get public certificates for an app or a deployment slot.
list_publishing_profile_xml_with_secrets	Gets the publishing profile for an app (or deployment slot, if specified). Description for Gets the publishing profile for an app (or deployment slot, if specified).
list_publishing_profile_xml_with_secrets_slot	Gets the publishing profile for an app (or deployment slot, if specified). Description for Gets the publishing profile for an app (or deployment slot, if specified).
list_relay_service_connections	Gets hybrid connections configured for an app (or deployment slot, if specified). Description for Gets hybrid connections configured for an app (or deployment slot, if specified).
list_relay_service_connections_slot	Gets hybrid connections configured for an app (or deployment slot, if specified). Description for Gets hybrid connections configured for an app (or deployment slot, if specified).
list_site_backups	Gets existing backups of an app. Description for Gets existing backups of an app.
list_site_backups_slot	Gets existing backups of an app. Description for Gets existing backups of an app.
list_site_extensions	Get list of siteextensions for a web site, or a deployment slot. Description for Get list of siteextensions for a web site, or a deployment slot.
list_site_extensions_slot	Get list of siteextensions for a web site, or a deployment slot. Description for Get list of siteextensions for a web site, or a deployment slot.
list_site_push_settings	Gets the Push settings associated with web app. Description for Gets the Push settings associated with web app.
list_site_push_settings_slot	Gets the Push settings associated with web app. Description for Gets the Push settings associated with web app.
list_slot_configuration_names	Gets the names of app settings and connection strings that stick to the slot (not swapped). Description for Gets the names of app settings and connection strings that stick to the slot (not swapped).
list_slot_differences_from_production	Get the difference in configuration settings between two web app slots. Description for Get the difference in configuration settings between two web app slots.
list_slot_differences_slot	Get the difference in configuration settings between two web app slots. Description for Get the difference in configuration settings between two web app slots.
list_slots	Gets an app's deployment slots. Description for Gets an app's deployment slots.
list_snapshots	Returns all Snapshots to the user. Description for Returns all Snapshots to the user.
list_snapshots_from_dr_secondary	Returns all Snapshots to the user from DRSecondary endpoint. Description for Returns all Snapshots to the user from DRSecondary endpoint.
list_snapshots_from_dr_secondary_slot	Returns all Snapshots to the user from DRSecondary endpoint. Description for Returns all Snapshots to the user from DRSecondary endpoint.
list_snapshots_slot	Returns all Snapshots to the user. Description for Returns all Snapshots to the user.
list_sync_function_triggers	This is to allow calling via powershell and ARM template. Description for This is to allow calling via powershell and ARM template.
list_sync_function_triggers_slot	This is to allow calling via powershell and ARM template. Description for This is to allow calling via powershell and ARM template.
list_sync_status	This is to allow calling via powershell and ARM template. Description for This is to allow calling via powershell and ARM template.
list_sync_status_slot	This is to allow calling via powershell and ARM template. Description for This is to allow calling via powershell and ARM template.
list_triggered_web_job_history	List a triggered web job's history for an app, or a deployment slot. Description for List a triggered web job's history for an app, or a deployment slot.
list_triggered_web_job_history_slot	List a triggered web job's history for an app, or a deployment slot. Description for List a triggered web job's history for an app, or a deployment slot.
list_triggered_web_jobs	List triggered web jobs for an app, or a deployment slot. Description for List triggered web jobs for an app, or a deployment slot.
list_triggered_web_jobs_slot	List triggered web jobs for an app, or a deployment slot. Description for List triggered web jobs for an app, or a deployment slot.
list_usages	Gets the quota usage information of an app (or deployment slot, if specified). Description for Gets the quota usage information of an app (or deployment slot, if specified).
list_usages_slot	Gets the quota usage information of an app (or deployment slot, if specified). Description for Gets the quota usage information of an app (or deployment slot, if specified).
list_vnet_connections	Gets the virtual networks the app (or deployment slot) is connected to. Description for Gets the virtual networks the app (or deployment slot) is connected to.
list_vnet_connections_slot	Gets the virtual networks the app (or deployment slot) is connected to. Description for Gets the virtual networks the app (or deployment slot) is connected to.
list_web_jobs	List webjobs for an app, or a deployment slot. Description for List webjobs for an app, or a deployment slot.
list_web_jobs_slot	List webjobs for an app, or a deployment slot. Description for List webjobs for an app, or a deployment slot.
put_private_access_vnet	Sets data around private site access enablement and authorized Virtual Networks that can access the site. Description for Sets data around private site access enablement and authorized Virtual Networks that can access the site.
put_private_access_vnet_slot	Sets data around private site access enablement and authorized Virtual Networks that can access the site. Description for Sets data around private site access enablement and authorized Virtual Networks that can access the site.
recover_site_configuration_snapshot	Reverts the configuration of an app to a previous snapshot. Description for Reverts the configuration of an app to a previous snapshot.
recover_site_configuration_snapshot_slot	Reverts the configuration of an app to a previous snapshot. Description for Reverts the configuration of an app to a previous snapshot.
reset_production_slot_config	Resets the configuration settings of the current slot if they were previously modified by calling the API with POST. Description for Resets the configuration settings of the current slot if they were previously modified by calling the API with POST.
reset_slot_configuration_slot	Resets the configuration settings of the current slot if they were previously modified by calling the API with POST. Description for Resets the configuration settings of the current slot if they were previously modified by calling the API with POST.
restart	Restarts an app (or deployment slot, if specified). Description for Restarts an app (or deployment slot, if specified).
restart_slot	Restarts an app (or deployment slot, if specified). Description for Restarts an app (or deployment slot, if specified).
run_triggered_web_job	Run a triggered web job for an app, or a deployment slot. Description for Run a triggered web job for an app, or a deployment slot.
run_triggered_web_job_slot	Run a triggered web job for an app, or a deployment slot. Description for Run a triggered web job for an app, or a deployment slot.
start	Starts an app (or deployment slot, if specified). Description for Starts an app (or deployment slot, if specified).
start_continuous_web_job	Start a continuous web job for an app, or a deployment slot. Description for Start a continuous web job for an app, or a deployment slot.
start_continuous_web_job_slot	Start a continuous web job for an app, or a deployment slot. Description for Start a continuous web job for an app, or a deployment slot.
start_slot	Starts an app (or deployment slot, if specified). Description for Starts an app (or deployment slot, if specified).
start_web_site_network_trace	Start capturing network packets for the site (To be deprecated). Description for Start capturing network packets for the site (To be deprecated).
start_web_site_network_trace_slot	Start capturing network packets for the site (To be deprecated). Description for Start capturing network packets for the site (To be deprecated).
stop	Stops an app (or deployment slot, if specified). Description for Stops an app (or deployment slot, if specified).
stop_continuous_web_job	Stop a continuous web job for an app, or a deployment slot. Description for Stop a continuous web job for an app, or a deployment slot.
stop_continuous_web_job_slot	Stop a continuous web job for an app, or a deployment slot. Description for Stop a continuous web job for an app, or a deployment slot.
stop_network_trace	Stop ongoing capturing network packets for the site. Description for Stop ongoing capturing network packets for the site.
stop_network_trace_slot	Stop ongoing capturing network packets for the site. Description for Stop ongoing capturing network packets for the site.
stop_slot	Stops an app (or deployment slot, if specified). Description for Stops an app (or deployment slot, if specified).
stop_web_site_network_trace	Stop ongoing capturing network packets for the site. Description for Stop ongoing capturing network packets for the site.
stop_web_site_network_trace_slot	Stop ongoing capturing network packets for the site. Description for Stop ongoing capturing network packets for the site.
sync_function_triggers	Syncs function trigger metadata to the management database. Description for Syncs function trigger metadata to the management database.
sync_function_triggers_slot	Syncs function trigger metadata to the management database. Description for Syncs function trigger metadata to the management database.
sync_functions	Syncs function trigger metadata to the management database. Description for Syncs function trigger metadata to the management database.
sync_functions_slot	Syncs function trigger metadata to the management database. Description for Syncs function trigger metadata to the management database.
sync_repository	Sync web app repository. Description for Sync web app repository.
sync_repository_slot	Sync web app repository. Description for Sync web app repository.
update	Creates a new web, mobile, or API app in an existing resource group, or updates an existing app. Description for Creates a new web, mobile, or API app in an existing resource group, or updates an existing app.
update_application_settings	Replaces the application settings of an app. Description for Replaces the application settings of an app.
update_application_settings_slot	Replaces the application settings of an app. Description for Replaces the application settings of an app.
update_auth_settings	Updates the Authentication / Authorization settings associated with web app. Description for Updates the Authentication / Authorization settings associated with web app.
update_auth_settings_slot	Updates the Authentication / Authorization settings associated with web app. Description for Updates the Authentication / Authorization settings associated with web app.
update_auth_settings_v2	Updates site's Authentication / Authorization settings for apps via the V2 format. Description for Updates site's Authentication / Authorization settings for apps via the V2 format.
update_auth_settings_v2_slot	Updates site's Authentication / Authorization settings for apps via the V2 format. Description for Updates site's Authentication / Authorization settings for apps via the V2 format.
update_azure_storage_accounts	Updates the Azure storage account configurations of an app. Description for Updates the Azure storage account configurations of an app.
update_azure_storage_accounts_slot	Updates the Azure storage account configurations of an app. Description for Updates the Azure storage account configurations of an app.
update_backup_configuration	Updates the backup configuration of an app. Description for Updates the backup configuration of an app.
update_backup_configuration_slot	Updates the backup configuration of an app. Description for Updates the backup configuration of an app.
update_configuration	Updates the configuration of an app. Description for Updates the configuration of an app.
update_configuration_slot	Updates the configuration of an app. Description for Updates the configuration of an app.
update_connection_strings	Replaces the connection strings of an app. Description for Replaces the connection strings of an app.
update_connection_strings_slot	Replaces the connection strings of an app. Description for Replaces the connection strings of an app.
update_diagnostic_logs_config	Updates the logging configuration of an app. Description for Updates the logging configuration of an app.
update_diagnostic_logs_config_slot	Updates the logging configuration of an app. Description for Updates the logging configuration of an app.
update_domain_ownership_identifier	Creates a domain ownership identifier for web app, or updates an existing ownership identifier. Description for Creates a domain ownership identifier for web app, or updates an existing ownership identifier.
update_domain_ownership_identifier_slot	Creates a domain ownership identifier for web app, or updates an existing ownership identifier. Description for Creates a domain ownership identifier for web app, or updates an existing ownership identifier.
update_ftp_allowed	Updates whether FTP is allowed on the site or not. Description for Updates whether FTP is allowed on the site or not.
update_ftp_allowed_slot	Updates whether FTP is allowed on the site or not. Description for Updates whether FTP is allowed on the site or not.
update_hybrid_connection	Creates a new Hybrid Connection using a Service Bus relay. Description for Creates a new Hybrid Connection using a Service Bus relay.
update_hybrid_connection_slot	Creates a new Hybrid Connection using a Service Bus relay. Description for Creates a new Hybrid Connection using a Service Bus relay.
update_metadata	Replaces the metadata of an app. Description for Replaces the metadata of an app.
update_metadata_slot	Replaces the metadata of an app. Description for Replaces the metadata of an app.
update_premier_add_on	Updates a named add-on of an app. Description for Updates a named add-on of an app.
update_premier_add_on_slot	Updates a named add-on of an app. Description for Updates a named add-on of an app.
update_relay_service_connection	Creates a new hybrid connection configuration (PUT), or updates an existing one (PATCH). Description for Creates a new hybrid connection configuration (PUT), or updates an existing one (PATCH).
update_relay_service_connection_slot	Creates a new hybrid connection configuration (PUT), or updates an existing one (PATCH). Description for Creates a new hybrid connection configuration (PUT), or updates an existing one (PATCH).
update_scm_allowed	Updates whether user publishing credentials are allowed on the site or not. Description for Updates whether user publishing credentials are allowed on the site or not.
update_scm_allowed_slot	Updates whether user publishing credentials are allowed on the site or not. Description for Updates whether user publishing credentials are allowed on the site or not.
update_site_push_settings	Updates the Push settings associated with web app. Description for Updates the Push settings associated with web app.
update_site_push_settings_slot	Updates the Push settings associated with web app. Description for Updates the Push settings associated with web app.
update_slot	Creates a new web, mobile, or API app in an existing resource group, or updates an existing app. Description for Creates a new web, mobile, or API app in an existing resource group, or updates an existing app.
update_slot_configuration_names	Updates the names of application settings and connection string that remain with the slot during swap operation. Description for Updates the names of application settings and connection string that remain with the slot during swap operation.
update_source_control	Updates the source control configuration of an app. Description for Updates the source control configuration of an app.
update_source_control_slot	Updates the source control configuration of an app. Description for Updates the source control configuration of an app.
update_swift_virtual_network_connection_with_check	Integrates this Web App with a Virtual Network. This requires that 1) "swiftSupported" is true when doing a GET against this resource, and 2) that the target Subnet has already been delegated, and is not in use by another App Service Plan other than the one this App is in. Description for Integrates this Web App with a Virtual Network. This requires that 1) "swiftSupported" is true when doing a GET against this resource, and 2) that the target Subnet has already been delegated, and is not in use by another App Service Plan other than the one this App is in.
update_swift_virtual_network_connection_with_check_slot	Integrates this Web App with a Virtual Network. This requires that 1) "swiftSupported" is true when doing a GET against this resource, and 2) that the target Subnet has already been delegated, and is not in use by another App Service Plan other than the one this App is in. Description for Integrates this Web App with a Virtual Network. This requires that 1) "swiftSupported" is true when doing a GET against this resource, and 2) that the target Subnet has already been delegated, and is not in use by another App Service Plan other than the one this App is in.
update_vnet_connection	Adds a Virtual Network connection to an app or slot (PUT) or updates the connection properties (PATCH). Description for Adds a Virtual Network connection to an app or slot (PUT) or updates the connection properties (PATCH).
update_vnet_connection_gateway	Adds a gateway to a connected Virtual Network (PUT) or updates it (PATCH). Description for Adds a gateway to a connected Virtual Network (PUT) or updates it (PATCH).
update_vnet_connection_gateway_slot	Adds a gateway to a connected Virtual Network (PUT) or updates it (PATCH). Description for Adds a gateway to a connected Virtual Network (PUT) or updates it (PATCH).
update_vnet_connection_slot	Adds a Virtual Network connection to an app or slot (PUT) or updates the connection properties (PATCH). Description for Adds a Virtual Network connection to an app or slot (PUT) or updates the connection properties (PATCH).

add_premier_add_on

Updates a named add-on of an app.

Description for Updates a named add-on of an app.

async add_premier_add_on(resource_group_name: str, name: str, premier_add_on_name: str, premier_add_on: azure.mgmt.web.v2021_01_15.models._models_py3.PremierAddOn, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.PremierAddOn

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

premier_add_on_name

str

Required

Add-on name.

premier_add_on

PremierAddOn

Required

A JSON representation of the edited premier add-on.

cls

callable

A custom type or function that will be passed the direct response

Returns

PremierAddOn, or the result of cls(response)

Return type

PremierAddOn

Exceptions

HttpResponseError

add_premier_add_on_slot

Updates a named add-on of an app.

Description for Updates a named add-on of an app.

async add_premier_add_on_slot(resource_group_name: str, name: str, premier_add_on_name: str, slot: str, premier_add_on: azure.mgmt.web.v2021_01_15.models._models_py3.PremierAddOn, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.PremierAddOn

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

premier_add_on_name

str

Required

Add-on name.

slot

str

Required

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

premier_add_on

PremierAddOn

Required

A JSON representation of the edited premier add-on.

cls

callable

A custom type or function that will be passed the direct response

Returns

PremierAddOn, or the result of cls(response)

Return type

PremierAddOn

Exceptions

HttpResponseError

analyze_custom_hostname

Analyze a custom hostname.

Description for Analyze a custom hostname.

async analyze_custom_hostname(resource_group_name: str, name: str, host_name: Optional[str] = None, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.CustomHostnameAnalysisResult

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of web app.

host_name

str

default value: None

Custom hostname.

cls

callable

A custom type or function that will be passed the direct response

Returns

CustomHostnameAnalysisResult, or the result of cls(response)

Return type

CustomHostnameAnalysisResult

Exceptions

HttpResponseError

analyze_custom_hostname_slot

Analyze a custom hostname.

Description for Analyze a custom hostname.

async analyze_custom_hostname_slot(resource_group_name: str, name: str, slot: str, host_name: Optional[str] = None, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.CustomHostnameAnalysisResult

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of web app.

slot

str

Required

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

host_name

str

default value: None

Custom hostname.

cls

callable

A custom type or function that will be passed the direct response

Returns

CustomHostnameAnalysisResult, or the result of cls(response)

Return type

CustomHostnameAnalysisResult

Exceptions

HttpResponseError

apply_slot_config_to_production

Applies the configuration settings from the target slot onto the current slot.

Description for Applies the configuration settings from the target slot onto the current slot.

async apply_slot_config_to_production(resource_group_name: str, name: str, slot_swap_entity: azure.mgmt.web.v2021_01_15.models._models_py3.CsmSlotEntity, **kwargs: Any) -> None

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

slot_swap_entity

CsmSlotEntity

Required

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

cls

callable

A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Exceptions

HttpResponseError

apply_slot_configuration_slot

Applies the configuration settings from the target slot onto the current slot.

Description for Applies the configuration settings from the target slot onto the current slot.

async apply_slot_configuration_slot(resource_group_name: str, name: str, slot: str, slot_swap_entity: azure.mgmt.web.v2021_01_15.models._models_py3.CsmSlotEntity, **kwargs: Any) -> None

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

slot

str

Required

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

slot_swap_entity

CsmSlotEntity

Required

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

cls

callable

A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Exceptions

HttpResponseError

backup

Creates a backup of an app.

Description for Creates a backup of an app.

async backup(resource_group_name: str, name: str, request: azure.mgmt.web.v2021_01_15.models._models_py3.BackupRequest, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.BackupItem

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

request

BackupRequest

Required

Backup configuration. You can use the JSON response from the POST action as input here.

cls

callable

A custom type or function that will be passed the direct response

Returns

BackupItem, or the result of cls(response)

Return type

BackupItem

Exceptions

HttpResponseError

backup_slot

Creates a backup of an app.

Description for Creates a backup of an app.

async backup_slot(resource_group_name: str, name: str, slot: str, request: azure.mgmt.web.v2021_01_15.models._models_py3.BackupRequest, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.BackupItem

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

slot

str

Required

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

request

BackupRequest

Required

Backup configuration. You can use the JSON response from the POST action as input here.

cls

callable

A custom type or function that will be passed the direct response

Returns

BackupItem, or the result of cls(response)

Return type

BackupItem

Exceptions

HttpResponseError

begin_approve_or_reject_private_endpoint_connection

Approves or rejects a private endpoint connection.

Description for Approves or rejects a private endpoint connection.

async begin_approve_or_reject_private_endpoint_connection(resource_group_name: str, name: str, private_endpoint_connection_name: str, private_endpoint_wrapper: azure.mgmt.web.v2021_01_15.models._models_py3.PrivateLinkConnectionApprovalRequestResource, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[azure.mgmt.web.v2021_01_15.models._models_py3.RemotePrivateEndpointConnectionARMResource]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the site.

private_endpoint_connection_name

str

Required

private_endpoint_wrapper

PrivateLinkConnectionApprovalRequestResource

Required

cls

callable

A custom type or function that will be passed the direct response

continuation_token

str

A continuation token to restart a poller from a saved state.

polling

bool or AsyncPollingMethod

By default, your polling method will be AsyncARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval

int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of AsyncLROPoller that returns either RemotePrivateEndpointConnectionARMResource or the result of cls(response)

Return type

AsyncLROPoller[RemotePrivateEndpointConnectionARMResource]

Exceptions

HttpResponseError

begin_approve_or_reject_private_endpoint_connection_slot

Approves or rejects a private endpoint connection.

Description for Approves or rejects a private endpoint connection.

async begin_approve_or_reject_private_endpoint_connection_slot(resource_group_name: str, name: str, private_endpoint_connection_name: str, slot: str, private_endpoint_wrapper: azure.mgmt.web.v2021_01_15.models._models_py3.PrivateLinkConnectionApprovalRequestResource, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[azure.mgmt.web.v2021_01_15.models._models_py3.RemotePrivateEndpointConnectionARMResource]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the site.

private_endpoint_connection_name

str

Required

slot

str

Required

private_endpoint_wrapper

PrivateLinkConnectionApprovalRequestResource

Required

cls

callable

A custom type or function that will be passed the direct response

continuation_token

str

A continuation token to restart a poller from a saved state.

polling

bool or AsyncPollingMethod

By default, your polling method will be AsyncARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval

int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of AsyncLROPoller that returns either RemotePrivateEndpointConnectionARMResource or the result of cls(response)

Return type

AsyncLROPoller[RemotePrivateEndpointConnectionARMResource]

Exceptions

HttpResponseError

begin_create_function

Create function for web site, or a deployment slot.

Description for Create function for web site, or a deployment slot.

async begin_create_function(resource_group_name: str, name: str, function_name: str, function_envelope: azure.mgmt.web.v2021_01_15.models._models_py3.FunctionEnvelope, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[azure.mgmt.web.v2021_01_15.models._models_py3.FunctionEnvelope]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Site name.

function_name

str

Required

Function name.

function_envelope

FunctionEnvelope

Required

Function details.

cls

callable

A custom type or function that will be passed the direct response

continuation_token

str

A continuation token to restart a poller from a saved state.

polling

bool or AsyncPollingMethod

By default, your polling method will be AsyncARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval

int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of AsyncLROPoller that returns either FunctionEnvelope or the result of cls(response)

Return type

AsyncLROPoller[FunctionEnvelope]

Exceptions

HttpResponseError

begin_create_instance_function_slot

Create function for web site, or a deployment slot.

Description for Create function for web site, or a deployment slot.

async begin_create_instance_function_slot(resource_group_name: str, name: str, function_name: str, slot: str, function_envelope: azure.mgmt.web.v2021_01_15.models._models_py3.FunctionEnvelope, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[azure.mgmt.web.v2021_01_15.models._models_py3.FunctionEnvelope]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Site name.

function_name

str

Required

Function name.

slot

str

Required

Name of the deployment slot.

function_envelope

FunctionEnvelope

Required

Function details.

cls

callable

A custom type or function that will be passed the direct response

continuation_token

str

A continuation token to restart a poller from a saved state.

polling

bool or AsyncPollingMethod

By default, your polling method will be AsyncARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval

int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of AsyncLROPoller that returns either FunctionEnvelope or the result of cls(response)

Return type

AsyncLROPoller[FunctionEnvelope]

Exceptions

HttpResponseError

begin_create_instance_ms_deploy_operation

Invoke the MSDeploy web app extension.

Description for Invoke the MSDeploy web app extension.

async begin_create_instance_ms_deploy_operation(resource_group_name: str, name: str, instance_id: str, ms_deploy: azure.mgmt.web.v2021_01_15.models._models_py3.MSDeploy, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[azure.mgmt.web.v2021_01_15.models._models_py3.MSDeployStatus]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of web app.

instance_id

str

Required

ID of web app instance.

ms_deploy

MSDeploy

Required

Details of MSDeploy operation.

cls

callable

A custom type or function that will be passed the direct response

continuation_token

str

A continuation token to restart a poller from a saved state.

polling

bool or AsyncPollingMethod

By default, your polling method will be AsyncARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval

int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of AsyncLROPoller that returns either MSDeployStatus or the result of cls(response)

Return type

AsyncLROPoller[MSDeployStatus]

Exceptions

HttpResponseError

begin_create_instance_ms_deploy_operation_slot

Invoke the MSDeploy web app extension.

Description for Invoke the MSDeploy web app extension.

async begin_create_instance_ms_deploy_operation_slot(resource_group_name: str, name: str, slot: str, instance_id: str, ms_deploy: azure.mgmt.web.v2021_01_15.models._models_py3.MSDeploy, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[azure.mgmt.web.v2021_01_15.models._models_py3.MSDeployStatus]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of web app.

slot

str

Required

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

instance_id

str

Required

ID of web app instance.

ms_deploy

MSDeploy

Required

Details of MSDeploy operation.

cls

callable

A custom type or function that will be passed the direct response

continuation_token

str

A continuation token to restart a poller from a saved state.

polling

bool or AsyncPollingMethod

By default, your polling method will be AsyncARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval

int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of AsyncLROPoller that returns either MSDeployStatus or the result of cls(response)

Return type

AsyncLROPoller[MSDeployStatus]

Exceptions

HttpResponseError

begin_create_ms_deploy_operation

Invoke the MSDeploy web app extension.

Description for Invoke the MSDeploy web app extension.

async begin_create_ms_deploy_operation(resource_group_name: str, name: str, ms_deploy: azure.mgmt.web.v2021_01_15.models._models_py3.MSDeploy, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[azure.mgmt.web.v2021_01_15.models._models_py3.MSDeployStatus]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of web app.

ms_deploy

MSDeploy

Required

Details of MSDeploy operation.

cls

callable

A custom type or function that will be passed the direct response

continuation_token

str

A continuation token to restart a poller from a saved state.

polling

bool or AsyncPollingMethod

By default, your polling method will be AsyncARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval

int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of AsyncLROPoller that returns either MSDeployStatus or the result of cls(response)

Return type

AsyncLROPoller[MSDeployStatus]

Exceptions

HttpResponseError

begin_create_ms_deploy_operation_slot

Invoke the MSDeploy web app extension.

Description for Invoke the MSDeploy web app extension.

async begin_create_ms_deploy_operation_slot(resource_group_name: str, name: str, slot: str, ms_deploy: azure.mgmt.web.v2021_01_15.models._models_py3.MSDeploy, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[azure.mgmt.web.v2021_01_15.models._models_py3.MSDeployStatus]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of web app.

slot

str

Required

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

ms_deploy

MSDeploy

Required

Details of MSDeploy operation.

cls

callable

A custom type or function that will be passed the direct response

continuation_token

str

A continuation token to restart a poller from a saved state.

polling

bool or AsyncPollingMethod

By default, your polling method will be AsyncARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval

int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of AsyncLROPoller that returns either MSDeployStatus or the result of cls(response)

Return type

AsyncLROPoller[MSDeployStatus]

Exceptions

HttpResponseError

begin_create_or_update

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

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

async begin_create_or_update(resource_group_name: str, name: str, site_envelope: azure.mgmt.web.v2021_01_15.models._models_py3.Site, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[azure.mgmt.web.v2021_01_15.models._models_py3.Site]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

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

site_envelope

Site

Required

A JSON representation of the app properties. See example.

cls

callable

A custom type or function that will be passed the direct response

continuation_token

str

A continuation token to restart a poller from a saved state.

polling

bool or AsyncPollingMethod

By default, your polling method will be AsyncARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval

int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of AsyncLROPoller that returns either Site or the result of cls(response)

Return type

AsyncLROPoller[Site]

Exceptions

HttpResponseError

begin_create_or_update_slot

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

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

async begin_create_or_update_slot(resource_group_name: str, name: str, slot: str, site_envelope: azure.mgmt.web.v2021_01_15.models._models_py3.Site, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[azure.mgmt.web.v2021_01_15.models._models_py3.Site]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

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

slot

str

Required

Name of the deployment slot to create or update. By default, this API attempts to create or modify the production slot.

site_envelope

Site

Required

A JSON representation of the app properties. See example.

cls

callable

A custom type or function that will be passed the direct response

continuation_token

str

A continuation token to restart a poller from a saved state.

polling

bool or AsyncPollingMethod

By default, your polling method will be AsyncARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval

int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of AsyncLROPoller that returns either Site or the result of cls(response)

Return type

AsyncLROPoller[Site]

Exceptions

HttpResponseError

begin_create_or_update_source_control

Updates the source control configuration of an app.

Description for Updates the source control configuration of an app.

async begin_create_or_update_source_control(resource_group_name: str, name: str, site_source_control: azure.mgmt.web.v2021_01_15.models._models_py3.SiteSourceControl, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[azure.mgmt.web.v2021_01_15.models._models_py3.SiteSourceControl]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

site_source_control

SiteSourceControl

Required

JSON representation of a SiteSourceControl object. See example.

cls

callable

A custom type or function that will be passed the direct response

continuation_token

str

A continuation token to restart a poller from a saved state.

polling

bool or AsyncPollingMethod

By default, your polling method will be AsyncARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval

int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of AsyncLROPoller that returns either SiteSourceControl or the result of cls(response)

Return type

AsyncLROPoller[SiteSourceControl]

Exceptions

HttpResponseError

begin_create_or_update_source_control_slot

Updates the source control configuration of an app.

Description for Updates the source control configuration of an app.

async begin_create_or_update_source_control_slot(resource_group_name: str, name: str, slot: str, site_source_control: azure.mgmt.web.v2021_01_15.models._models_py3.SiteSourceControl, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[azure.mgmt.web.v2021_01_15.models._models_py3.SiteSourceControl]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

slot

str

Required

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

site_source_control

SiteSourceControl

Required

JSON representation of a SiteSourceControl object. See example.

cls

callable

A custom type or function that will be passed the direct response

continuation_token

str

A continuation token to restart a poller from a saved state.

polling

bool or AsyncPollingMethod

By default, your polling method will be AsyncARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval

int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of AsyncLROPoller that returns either SiteSourceControl or the result of cls(response)

Return type

AsyncLROPoller[SiteSourceControl]

Exceptions

HttpResponseError

begin_delete_private_endpoint_connection

Deletes a private endpoint connection.

Description for Deletes a private endpoint connection.

async begin_delete_private_endpoint_connection(resource_group_name: str, name: str, private_endpoint_connection_name: str, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[Any]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the site.

private_endpoint_connection_name

str

Required

cls

callable

A custom type or function that will be passed the direct response

continuation_token

str

A continuation token to restart a poller from a saved state.

polling

bool or AsyncPollingMethod

By default, your polling method will be AsyncARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval

int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of AsyncLROPoller that returns either any or the result of cls(response)

Return type

AsyncLROPoller[any]

Exceptions

HttpResponseError

begin_delete_private_endpoint_connection_slot

Deletes a private endpoint connection.

Description for Deletes a private endpoint connection.

async begin_delete_private_endpoint_connection_slot(resource_group_name: str, name: str, private_endpoint_connection_name: str, slot: str, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[Any]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the site.

private_endpoint_connection_name

str

Required

slot

str

Required

cls

callable

A custom type or function that will be passed the direct response

continuation_token

str

A continuation token to restart a poller from a saved state.

polling

bool or AsyncPollingMethod

By default, your polling method will be AsyncARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval

int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of AsyncLROPoller that returns either any or the result of cls(response)

Return type

AsyncLROPoller[any]

Exceptions

HttpResponseError

begin_install_site_extension

Install site extension on a web site, or a deployment slot.

Description for Install site extension on a web site, or a deployment slot.

async begin_install_site_extension(resource_group_name: str, name: str, site_extension_id: str, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[azure.mgmt.web.v2021_01_15.models._models_py3.SiteExtensionInfo]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Site name.

site_extension_id

str

Required

Site extension name.

cls

callable

A custom type or function that will be passed the direct response

continuation_token

str

A continuation token to restart a poller from a saved state.

polling

bool or AsyncPollingMethod

By default, your polling method will be AsyncARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval

int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of AsyncLROPoller that returns either SiteExtensionInfo or the result of cls(response)

Return type

AsyncLROPoller[SiteExtensionInfo]

Exceptions

HttpResponseError

begin_install_site_extension_slot

Install site extension on a web site, or a deployment slot.

Description for Install site extension on a web site, or a deployment slot.

async begin_install_site_extension_slot(resource_group_name: str, name: str, site_extension_id: str, slot: str, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[azure.mgmt.web.v2021_01_15.models._models_py3.SiteExtensionInfo]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Site name.

site_extension_id

str

Required

Site extension name.

slot

str

Required

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

cls

callable

A custom type or function that will be passed the direct response

continuation_token

str

A continuation token to restart a poller from a saved state.

polling

bool or AsyncPollingMethod

By default, your polling method will be AsyncARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval

int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of AsyncLROPoller that returns either SiteExtensionInfo or the result of cls(response)

Return type

AsyncLROPoller[SiteExtensionInfo]

Exceptions

HttpResponseError

begin_list_publishing_credentials

Gets the Git/FTP publishing credentials of an app.

Description for Gets the Git/FTP publishing credentials of an app.

async begin_list_publishing_credentials(resource_group_name: str, name: str, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[azure.mgmt.web.v2021_01_15.models._models_py3.User]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

cls

callable

A custom type or function that will be passed the direct response

continuation_token

str

A continuation token to restart a poller from a saved state.

polling

bool or AsyncPollingMethod

By default, your polling method will be AsyncARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval

int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of AsyncLROPoller that returns either User or the result of cls(response)

Return type

AsyncLROPoller[User]

Exceptions

HttpResponseError

begin_list_publishing_credentials_slot

Gets the Git/FTP publishing credentials of an app.

Description for Gets the Git/FTP publishing credentials of an app.

async begin_list_publishing_credentials_slot(resource_group_name: str, name: str, slot: str, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[azure.mgmt.web.v2021_01_15.models._models_py3.User]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

slot

str

Required

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

cls

callable

A custom type or function that will be passed the direct response

continuation_token

str

A continuation token to restart a poller from a saved state.

polling

bool or AsyncPollingMethod

By default, your polling method will be AsyncARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval

int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of AsyncLROPoller that returns either User or the result of cls(response)

Return type

AsyncLROPoller[User]

Exceptions

HttpResponseError

begin_migrate_my_sql

Migrates a local (in-app) MySql database to a remote MySql database.

Description for Migrates a local (in-app) MySql database to a remote MySql database.

async begin_migrate_my_sql(resource_group_name: str, name: str, migration_request_envelope: azure.mgmt.web.v2021_01_15.models._models_py3.MigrateMySqlRequest, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[azure.mgmt.web.v2021_01_15.models._models_py3.Operation]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of web app.

migration_request_envelope

MigrateMySqlRequest

Required

MySql migration options.

cls

callable

A custom type or function that will be passed the direct response

continuation_token

str

A continuation token to restart a poller from a saved state.

polling

bool or AsyncPollingMethod

By default, your polling method will be AsyncARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval

int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of AsyncLROPoller that returns either Operation or the result of cls(response)

Return type

AsyncLROPoller[Operation]

Exceptions

HttpResponseError

begin_migrate_storage

Restores a web app.

Description for Restores a web app.

async begin_migrate_storage(subscription_name: str, resource_group_name: str, name: str, migration_options: azure.mgmt.web.v2021_01_15.models._models_py3.StorageMigrationOptions, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[azure.mgmt.web.v2021_01_15.models._models_py3.StorageMigrationResponse]

Parameters

subscription_name

str

Required

Azure subscription.

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of web app.

migration_options

StorageMigrationOptions

Required

Migration migrationOptions.

cls

callable

A custom type or function that will be passed the direct response

continuation_token

str

A continuation token to restart a poller from a saved state.

polling

bool or AsyncPollingMethod

By default, your polling method will be AsyncARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval

int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of AsyncLROPoller that returns either StorageMigrationResponse or the result of cls(response)

Return type

AsyncLROPoller[StorageMigrationResponse]

Exceptions

HttpResponseError

begin_restore

Restores a specific backup to another app (or deployment slot, if specified).

Description for Restores a specific backup to another app (or deployment slot, if specified).

async begin_restore(resource_group_name: str, name: str, backup_id: str, request: azure.mgmt.web.v2021_01_15.models._models_py3.RestoreRequest, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[None]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

backup_id

str

Required

ID of the backup.

request

RestoreRequest

Required

Information on restore request .

cls

callable

A custom type or function that will be passed the direct response

continuation_token

str

A continuation token to restart a poller from a saved state.

polling

bool or AsyncPollingMethod

By default, your polling method will be AsyncARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval

int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of AsyncLROPoller that returns either None or the result of cls(response)

Return type

AsyncLROPoller[None]

Exceptions

HttpResponseError

begin_restore_from_backup_blob

Restores an app from a backup blob in Azure Storage.

Description for Restores an app from a backup blob in Azure Storage.

async begin_restore_from_backup_blob(resource_group_name: str, name: str, request: azure.mgmt.web.v2021_01_15.models._models_py3.RestoreRequest, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[None]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

request

RestoreRequest

Required

Information on restore request .

cls

callable

A custom type or function that will be passed the direct response

continuation_token

str

A continuation token to restart a poller from a saved state.

polling

bool or AsyncPollingMethod

By default, your polling method will be AsyncARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval

int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of AsyncLROPoller that returns either None or the result of cls(response)

Return type

AsyncLROPoller[None]

Exceptions

HttpResponseError

begin_restore_from_backup_blob_slot

Restores an app from a backup blob in Azure Storage.

Description for Restores an app from a backup blob in Azure Storage.

async begin_restore_from_backup_blob_slot(resource_group_name: str, name: str, slot: str, request: azure.mgmt.web.v2021_01_15.models._models_py3.RestoreRequest, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[None]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

slot

str

Required

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

request

RestoreRequest

Required

Information on restore request .

cls

callable

A custom type or function that will be passed the direct response

continuation_token

str

A continuation token to restart a poller from a saved state.

polling

bool or AsyncPollingMethod

By default, your polling method will be AsyncARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval

int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of AsyncLROPoller that returns either None or the result of cls(response)

Return type

AsyncLROPoller[None]

Exceptions

HttpResponseError

begin_restore_from_deleted_app

Restores a deleted web app to this web app.

Description for Restores a deleted web app to this web app.

async begin_restore_from_deleted_app(resource_group_name: str, name: str, restore_request: azure.mgmt.web.v2021_01_15.models._models_py3.DeletedAppRestoreRequest, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[None]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of web app.

restore_request

DeletedAppRestoreRequest

Required

Deleted web app restore information.

cls

callable

A custom type or function that will be passed the direct response

continuation_token

str

A continuation token to restart a poller from a saved state.

polling

bool or AsyncPollingMethod

By default, your polling method will be AsyncARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval

int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of AsyncLROPoller that returns either None or the result of cls(response)

Return type

AsyncLROPoller[None]

Exceptions

HttpResponseError

begin_restore_from_deleted_app_slot

Restores a deleted web app to this web app.

Description for Restores a deleted web app to this web app.

async begin_restore_from_deleted_app_slot(resource_group_name: str, name: str, slot: str, restore_request: azure.mgmt.web.v2021_01_15.models._models_py3.DeletedAppRestoreRequest, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[None]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of web app.

slot

str

Required

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

restore_request

DeletedAppRestoreRequest

Required

Deleted web app restore information.

cls

callable

A custom type or function that will be passed the direct response

continuation_token

str

A continuation token to restart a poller from a saved state.

polling

bool or AsyncPollingMethod

By default, your polling method will be AsyncARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval

int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of AsyncLROPoller that returns either None or the result of cls(response)

Return type

AsyncLROPoller[None]

Exceptions

HttpResponseError

begin_restore_slot

Restores a specific backup to another app (or deployment slot, if specified).

Description for Restores a specific backup to another app (or deployment slot, if specified).

async begin_restore_slot(resource_group_name: str, name: str, backup_id: str, slot: str, request: azure.mgmt.web.v2021_01_15.models._models_py3.RestoreRequest, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[None]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

backup_id

str

Required

ID of the backup.

slot

str

Required

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

request

RestoreRequest

Required

Information on restore request .

cls

callable

A custom type or function that will be passed the direct response

continuation_token

str

A continuation token to restart a poller from a saved state.

polling

bool or AsyncPollingMethod

By default, your polling method will be AsyncARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval

int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of AsyncLROPoller that returns either None or the result of cls(response)

Return type

AsyncLROPoller[None]

Exceptions

HttpResponseError

begin_restore_snapshot

Restores a web app from a snapshot.

Description for Restores a web app from a snapshot.

async begin_restore_snapshot(resource_group_name: str, name: str, restore_request: azure.mgmt.web.v2021_01_15.models._models_py3.SnapshotRestoreRequest, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[None]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of web app.

restore_request

SnapshotRestoreRequest

Required

Snapshot restore settings. Snapshot information can be obtained by calling GetDeletedSites or GetSiteSnapshots API.

cls

callable

A custom type or function that will be passed the direct response

continuation_token

str

A continuation token to restart a poller from a saved state.

polling

bool or AsyncPollingMethod

By default, your polling method will be AsyncARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval

int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of AsyncLROPoller that returns either None or the result of cls(response)

Return type

AsyncLROPoller[None]

Exceptions

HttpResponseError

begin_restore_snapshot_slot

Restores a web app from a snapshot.

Description for Restores a web app from a snapshot.

async begin_restore_snapshot_slot(resource_group_name: str, name: str, slot: str, restore_request: azure.mgmt.web.v2021_01_15.models._models_py3.SnapshotRestoreRequest, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[None]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of web app.

slot

str

Required

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

restore_request

SnapshotRestoreRequest

Required

Snapshot restore settings. Snapshot information can be obtained by calling GetDeletedSites or GetSiteSnapshots API.

cls

callable

A custom type or function that will be passed the direct response

continuation_token

str

A continuation token to restart a poller from a saved state.

polling

bool or AsyncPollingMethod

By default, your polling method will be AsyncARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval

int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of AsyncLROPoller that returns either None or the result of cls(response)

Return type

AsyncLROPoller[None]

Exceptions

HttpResponseError

begin_start_network_trace

Start capturing network packets for the site.

Description for Start capturing network packets for the site.

async begin_start_network_trace(resource_group_name: str, name: str, duration_in_seconds: Optional[int] = None, max_frame_length: Optional[int] = None, sas_url: Optional[str] = None, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[List[azure.mgmt.web.v2021_01_15.models._models_py3.NetworkTrace]]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

The name of the web app.

duration_in_seconds

int

default value: None

The duration to keep capturing in seconds.

max_frame_length

int

default value: None

The maximum frame length in bytes (Optional).

sas_url

str

default value: None

The Blob URL to store capture file.

cls

callable

A custom type or function that will be passed the direct response

continuation_token

str

A continuation token to restart a poller from a saved state.

polling

bool or AsyncPollingMethod

By default, your polling method will be AsyncARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval

int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of AsyncLROPoller that returns either list of NetworkTrace or the result of cls(response)

Return type

AsyncLROPoller[list[NetworkTrace]]

Exceptions

HttpResponseError

begin_start_network_trace_slot

Start capturing network packets for the site.

Description for Start capturing network packets for the site.

async begin_start_network_trace_slot(resource_group_name: str, name: str, slot: str, duration_in_seconds: Optional[int] = None, max_frame_length: Optional[int] = None, sas_url: Optional[str] = None, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[List[azure.mgmt.web.v2021_01_15.models._models_py3.NetworkTrace]]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

The name of the web app.

slot

str

Required

The name of the slot for this web app.

duration_in_seconds

int

default value: None

The duration to keep capturing in seconds.

max_frame_length

int

default value: None

The maximum frame length in bytes (Optional).

sas_url

str

default value: None

The Blob URL to store capture file.

cls

callable

A custom type or function that will be passed the direct response

continuation_token

str

A continuation token to restart a poller from a saved state.

polling

bool or AsyncPollingMethod

By default, your polling method will be AsyncARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval

int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of AsyncLROPoller that returns either list of NetworkTrace or the result of cls(response)

Return type

AsyncLROPoller[list[NetworkTrace]]

Exceptions

HttpResponseError

begin_start_web_site_network_trace_operation

Start capturing network packets for the site.

Description for Start capturing network packets for the site.

async begin_start_web_site_network_trace_operation(resource_group_name: str, name: str, duration_in_seconds: Optional[int] = None, max_frame_length: Optional[int] = None, sas_url: Optional[str] = None, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[List[azure.mgmt.web.v2021_01_15.models._models_py3.NetworkTrace]]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

The name of the web app.

duration_in_seconds

int

default value: None

The duration to keep capturing in seconds.

max_frame_length

int

default value: None

The maximum frame length in bytes (Optional).

sas_url

str

default value: None

The Blob URL to store capture file.

cls

callable

A custom type or function that will be passed the direct response

continuation_token

str

A continuation token to restart a poller from a saved state.

polling

bool or AsyncPollingMethod

By default, your polling method will be AsyncARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval

int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of AsyncLROPoller that returns either list of NetworkTrace or the result of cls(response)

Return type

AsyncLROPoller[list[NetworkTrace]]

Exceptions

HttpResponseError

begin_start_web_site_network_trace_operation_slot

Start capturing network packets for the site.

Description for Start capturing network packets for the site.

async begin_start_web_site_network_trace_operation_slot(resource_group_name: str, name: str, slot: str, duration_in_seconds: Optional[int] = None, max_frame_length: Optional[int] = None, sas_url: Optional[str] = None, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[List[azure.mgmt.web.v2021_01_15.models._models_py3.NetworkTrace]]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

The name of the web app.

slot

str

Required

The name of the slot for this web app.

duration_in_seconds

int

default value: None

The duration to keep capturing in seconds.

max_frame_length

int

default value: None

The maximum frame length in bytes (Optional).

sas_url

str

default value: None

The Blob URL to store capture file.

cls

callable

A custom type or function that will be passed the direct response

continuation_token

str

A continuation token to restart a poller from a saved state.

polling

bool or AsyncPollingMethod

By default, your polling method will be AsyncARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval

int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of AsyncLROPoller that returns either list of NetworkTrace or the result of cls(response)

Return type

AsyncLROPoller[list[NetworkTrace]]

Exceptions

HttpResponseError

begin_swap_slot

Swaps two deployment slots of an app.

Description for Swaps two deployment slots of an app.

async begin_swap_slot(resource_group_name: str, name: str, slot: str, slot_swap_entity: azure.mgmt.web.v2021_01_15.models._models_py3.CsmSlotEntity, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[None]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

slot

str

Required

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

slot_swap_entity

CsmSlotEntity

Required

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

cls

callable

A custom type or function that will be passed the direct response

continuation_token

str

A continuation token to restart a poller from a saved state.

polling

bool or AsyncPollingMethod

By default, your polling method will be AsyncARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval

int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of AsyncLROPoller that returns either None or the result of cls(response)

Return type

AsyncLROPoller[None]

Exceptions

HttpResponseError

begin_swap_slot_with_production

Swaps two deployment slots of an app.

Description for Swaps two deployment slots of an app.

async begin_swap_slot_with_production(resource_group_name: str, name: str, slot_swap_entity: azure.mgmt.web.v2021_01_15.models._models_py3.CsmSlotEntity, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[None]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

slot_swap_entity

CsmSlotEntity

Required

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

cls

callable

A custom type or function that will be passed the direct response

continuation_token

str

A continuation token to restart a poller from a saved state.

polling

bool or AsyncPollingMethod

By default, your polling method will be AsyncARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval

int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of AsyncLROPoller that returns either None or the result of cls(response)

Return type

AsyncLROPoller[None]

Exceptions

HttpResponseError

create_deployment

Create a deployment for an app, or a deployment slot.

Description for Create a deployment for an app, or a deployment slot.

async create_deployment(resource_group_name: str, name: str, id: str, deployment: azure.mgmt.web.v2021_01_15.models._models_py3.Deployment, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.Deployment

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

id

str

Required

ID of an existing deployment.

deployment

Deployment

Required

Deployment details.

cls

callable

A custom type or function that will be passed the direct response

Returns

Deployment, or the result of cls(response)

Return type

Deployment

Exceptions

HttpResponseError

create_deployment_slot

Create a deployment for an app, or a deployment slot.

Description for Create a deployment for an app, or a deployment slot.

async create_deployment_slot(resource_group_name: str, name: str, id: str, slot: str, deployment: azure.mgmt.web.v2021_01_15.models._models_py3.Deployment, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.Deployment

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

id

str

Required

ID of an existing deployment.

slot

str

Required

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

deployment

Deployment

Required

Deployment details.

cls

callable

A custom type or function that will be passed the direct response

Returns

Deployment, or the result of cls(response)

Return type

Deployment

Exceptions

HttpResponseError

create_or_update_configuration

Updates the configuration of an app.

Description for Updates the configuration of an app.

async create_or_update_configuration(resource_group_name: str, name: str, site_config: azure.mgmt.web.v2021_01_15.models._models_py3.SiteConfigResource, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.SiteConfigResource

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

site_config

SiteConfigResource

Required

JSON representation of a SiteConfig object. See example.

cls

callable

A custom type or function that will be passed the direct response

Returns

SiteConfigResource, or the result of cls(response)

Return type

SiteConfigResource

Exceptions

HttpResponseError

create_or_update_configuration_slot

Updates the configuration of an app.

Description for Updates the configuration of an app.

async create_or_update_configuration_slot(resource_group_name: str, name: str, slot: str, site_config: azure.mgmt.web.v2021_01_15.models._models_py3.SiteConfigResource, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.SiteConfigResource

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

slot

str

Required

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

site_config

SiteConfigResource

Required

JSON representation of a SiteConfig object. See example.

cls

callable

A custom type or function that will be passed the direct response

Returns

SiteConfigResource, or the result of cls(response)

Return type

SiteConfigResource

Exceptions

HttpResponseError

create_or_update_domain_ownership_identifier

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

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

async create_or_update_domain_ownership_identifier(resource_group_name: str, name: str, domain_ownership_identifier_name: str, domain_ownership_identifier: azure.mgmt.web.v2021_01_15.models._models_py3.Identifier, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.Identifier

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

domain_ownership_identifier_name

str

Required

Name of domain ownership identifier.

domain_ownership_identifier

Identifier

Required

A JSON representation of the domain ownership properties.

cls

callable

A custom type or function that will be passed the direct response

Returns

Identifier, or the result of cls(response)

Return type

Identifier

Exceptions

HttpResponseError

create_or_update_domain_ownership_identifier_slot

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

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

async create_or_update_domain_ownership_identifier_slot(resource_group_name: str, name: str, domain_ownership_identifier_name: str, slot: str, domain_ownership_identifier: azure.mgmt.web.v2021_01_15.models._models_py3.Identifier, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.Identifier

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

domain_ownership_identifier_name

str

Required

Name of domain ownership identifier.

slot

str

Required

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

domain_ownership_identifier

Identifier

Required

A JSON representation of the domain ownership properties.

cls

callable

A custom type or function that will be passed the direct response

Returns

Identifier, or the result of cls(response)

Return type

Identifier

Exceptions

HttpResponseError

create_or_update_function_secret

Add or update a function secret.

Description for Add or update a function secret.

async create_or_update_function_secret(resource_group_name: str, name: str, function_name: str, key_name: str, key: azure.mgmt.web.v2021_01_15.models._models_py3.KeyInfo, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.KeyInfo

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Site name.

function_name

str

Required

The name of the function.

key_name

str

Required

The name of the key.

key

KeyInfo

Required

The key to create or update.

cls

callable

A custom type or function that will be passed the direct response

Returns

KeyInfo, or the result of cls(response)

Return type

KeyInfo

Exceptions

HttpResponseError

create_or_update_function_secret_slot

Add or update a function secret.

Description for Add or update a function secret.

async create_or_update_function_secret_slot(resource_group_name: str, name: str, function_name: str, key_name: str, slot: str, key: azure.mgmt.web.v2021_01_15.models._models_py3.KeyInfo, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.KeyInfo

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Site name.

function_name

str

Required

The name of the function.

key_name

str

Required

The name of the key.

slot

str

Required

Name of the deployment slot.

key

KeyInfo

Required

The key to create or update.

cls

callable

A custom type or function that will be passed the direct response

Returns

KeyInfo, or the result of cls(response)

Return type

KeyInfo

Exceptions

HttpResponseError

create_or_update_host_name_binding

Creates a hostname binding for an app.

Description for Creates a hostname binding for an app.

async create_or_update_host_name_binding(resource_group_name: str, name: str, host_name: str, host_name_binding: azure.mgmt.web.v2021_01_15.models._models_py3.HostNameBinding, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.HostNameBinding

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

host_name

str

Required

Hostname in the hostname binding.

host_name_binding

HostNameBinding

Required

Binding details. This is the JSON representation of a HostNameBinding object.

cls

callable

A custom type or function that will be passed the direct response

Returns

HostNameBinding, or the result of cls(response)

Return type

HostNameBinding

Exceptions

HttpResponseError

create_or_update_host_name_binding_slot

Creates a hostname binding for an app.

Description for Creates a hostname binding for an app.

async create_or_update_host_name_binding_slot(resource_group_name: str, name: str, host_name: str, slot: str, host_name_binding: azure.mgmt.web.v2021_01_15.models._models_py3.HostNameBinding, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.HostNameBinding

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

host_name

str

Required

Hostname in the hostname binding.

slot

str

Required

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

host_name_binding

HostNameBinding

Required

Binding details. This is the JSON representation of a HostNameBinding object.

cls

callable

A custom type or function that will be passed the direct response

Returns

HostNameBinding, or the result of cls(response)

Return type

HostNameBinding

Exceptions

HttpResponseError

create_or_update_host_secret

Add or update a host level secret.

Description for Add or update a host level secret.

async create_or_update_host_secret(resource_group_name: str, name: str, key_type: str, key_name: str, key: azure.mgmt.web.v2021_01_15.models._models_py3.KeyInfo, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.KeyInfo

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Site name.

key_type

str

Required

The type of host key.

key_name

str

Required

The name of the key.

key

KeyInfo

Required

The key to create or update.

cls

callable

A custom type or function that will be passed the direct response

Returns

KeyInfo, or the result of cls(response)

Return type

KeyInfo

Exceptions

HttpResponseError

create_or_update_host_secret_slot

Add or update a host level secret.

Description for Add or update a host level secret.

async create_or_update_host_secret_slot(resource_group_name: str, name: str, key_type: str, key_name: str, slot: str, key: azure.mgmt.web.v2021_01_15.models._models_py3.KeyInfo, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.KeyInfo

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Site name.

key_type

str

Required

The type of host key.

key_name

str

Required

The name of the key.

slot

str

Required

Name of the deployment slot.

key

KeyInfo

Required

The key to create or update.

cls

callable

A custom type or function that will be passed the direct response

Returns

KeyInfo, or the result of cls(response)

Return type

KeyInfo

Exceptions

HttpResponseError

create_or_update_hybrid_connection

Creates a new Hybrid Connection using a Service Bus relay.

Description for Creates a new Hybrid Connection using a Service Bus relay.

async create_or_update_hybrid_connection(resource_group_name: str, name: str, namespace_name: str, relay_name: str, connection_envelope: azure.mgmt.web.v2021_01_15.models._models_py3.HybridConnection, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.HybridConnection

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

The name of the web app.

namespace_name

str

Required

The namespace for this hybrid connection.

relay_name

str

Required

The relay name for this hybrid connection.

connection_envelope

HybridConnection

Required

The details of the hybrid connection.

cls

callable

A custom type or function that will be passed the direct response

Returns

HybridConnection, or the result of cls(response)

Return type

HybridConnection

Exceptions

HttpResponseError

create_or_update_hybrid_connection_slot

Creates a new Hybrid Connection using a Service Bus relay.

Description for Creates a new Hybrid Connection using a Service Bus relay.

async create_or_update_hybrid_connection_slot(resource_group_name: str, name: str, namespace_name: str, relay_name: str, slot: str, connection_envelope: azure.mgmt.web.v2021_01_15.models._models_py3.HybridConnection, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.HybridConnection

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

The name of the web app.

namespace_name

str

Required

The namespace for this hybrid connection.

relay_name

str

Required

The relay name for this hybrid connection.

slot

str

Required

The name of the slot for the web app.

connection_envelope

HybridConnection

Required

The details of the hybrid connection.

cls

callable

A custom type or function that will be passed the direct response

Returns

HybridConnection, or the result of cls(response)

Return type

HybridConnection

Exceptions

HttpResponseError

create_or_update_public_certificate

Creates a hostname binding for an app.

Description for Creates a hostname binding for an app.

async create_or_update_public_certificate(resource_group_name: str, name: str, public_certificate_name: str, public_certificate: azure.mgmt.web.v2021_01_15.models._models_py3.PublicCertificate, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.PublicCertificate

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

public_certificate_name

str

Required

Public certificate name.

public_certificate

PublicCertificate

Required

Public certificate details. This is the JSON representation of a PublicCertificate object.

cls

callable

A custom type or function that will be passed the direct response

Returns

PublicCertificate, or the result of cls(response)

Return type

PublicCertificate

Exceptions

HttpResponseError

create_or_update_public_certificate_slot

Creates a hostname binding for an app.

Description for Creates a hostname binding for an app.

async create_or_update_public_certificate_slot(resource_group_name: str, name: str, public_certificate_name: str, slot: str, public_certificate: azure.mgmt.web.v2021_01_15.models._models_py3.PublicCertificate, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.PublicCertificate

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

public_certificate_name

str

Required

Public certificate name.

slot

str

Required

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

public_certificate

PublicCertificate

Required

Public certificate details. This is the JSON representation of a PublicCertificate object.

cls

callable

A custom type or function that will be passed the direct response

Returns

PublicCertificate, or the result of cls(response)

Return type

PublicCertificate

Exceptions

HttpResponseError

create_or_update_relay_service_connection

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

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

async create_or_update_relay_service_connection(resource_group_name: str, name: str, entity_name: str, connection_envelope: azure.mgmt.web.v2021_01_15.models._models_py3.RelayServiceConnectionEntity, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.RelayServiceConnectionEntity

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

entity_name

str

Required

Name of the hybrid connection configuration.

connection_envelope

RelayServiceConnectionEntity

Required

Details of the hybrid connection configuration.

cls

callable

A custom type or function that will be passed the direct response

Returns

RelayServiceConnectionEntity, or the result of cls(response)

Return type

RelayServiceConnectionEntity

Exceptions

HttpResponseError

create_or_update_relay_service_connection_slot

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

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

async create_or_update_relay_service_connection_slot(resource_group_name: str, name: str, entity_name: str, slot: str, connection_envelope: azure.mgmt.web.v2021_01_15.models._models_py3.RelayServiceConnectionEntity, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.RelayServiceConnectionEntity

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

entity_name

str

Required

Name of the hybrid connection configuration.

slot

str

Required

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

connection_envelope

RelayServiceConnectionEntity

Required

Details of the hybrid connection configuration.

cls

callable

A custom type or function that will be passed the direct response

Returns

RelayServiceConnectionEntity, or the result of cls(response)

Return type

RelayServiceConnectionEntity

Exceptions

HttpResponseError

create_or_update_swift_virtual_network_connection_with_check

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

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

async create_or_update_swift_virtual_network_connection_with_check(resource_group_name: str, name: str, connection_envelope: azure.mgmt.web.v2021_01_15.models._models_py3.SwiftVirtualNetwork, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.SwiftVirtualNetwork

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

connection_envelope

SwiftVirtualNetwork

Required

Properties of the Virtual Network connection. See example.

cls

callable

A custom type or function that will be passed the direct response

Returns

SwiftVirtualNetwork, or the result of cls(response)

Return type

SwiftVirtualNetwork

Exceptions

HttpResponseError

create_or_update_swift_virtual_network_connection_with_check_slot

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

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

async create_or_update_swift_virtual_network_connection_with_check_slot(resource_group_name: str, name: str, slot: str, connection_envelope: azure.mgmt.web.v2021_01_15.models._models_py3.SwiftVirtualNetwork, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.SwiftVirtualNetwork

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

slot

str

Required

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

connection_envelope

SwiftVirtualNetwork

Required

Properties of the Virtual Network connection. See example.

cls

callable

A custom type or function that will be passed the direct response

Returns

SwiftVirtualNetwork, or the result of cls(response)

Return type

SwiftVirtualNetwork

Exceptions

HttpResponseError

create_or_update_vnet_connection

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

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

async create_or_update_vnet_connection(resource_group_name: str, name: str, vnet_name: str, connection_envelope: azure.mgmt.web.v2021_01_15.models._models_py3.VnetInfo, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.VnetInfo

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

vnet_name

str

Required

Name of an existing Virtual Network.

connection_envelope

VnetInfo

Required

Properties of the Virtual Network connection. See example.

cls

callable

A custom type or function that will be passed the direct response

Returns

VnetInfo, or the result of cls(response)

Return type

VnetInfo

Exceptions

HttpResponseError

create_or_update_vnet_connection_gateway

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

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

async create_or_update_vnet_connection_gateway(resource_group_name: str, name: str, vnet_name: str, gateway_name: str, connection_envelope: azure.mgmt.web.v2021_01_15.models._models_py3.VnetGateway, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.VnetGateway

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

vnet_name

str

Required

Name of the Virtual Network.

gateway_name

str

Required

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

connection_envelope

VnetGateway

Required

The properties to update this gateway with.

cls

callable

A custom type or function that will be passed the direct response

Returns

VnetGateway, or the result of cls(response)

Return type

VnetGateway

Exceptions

HttpResponseError

create_or_update_vnet_connection_gateway_slot

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

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

async create_or_update_vnet_connection_gateway_slot(resource_group_name: str, name: str, vnet_name: str, gateway_name: str, slot: str, connection_envelope: azure.mgmt.web.v2021_01_15.models._models_py3.VnetGateway, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.VnetGateway

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

vnet_name

str

Required

Name of the Virtual Network.

gateway_name

str

Required

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

slot

str

Required

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

connection_envelope

VnetGateway

Required

The properties to update this gateway with.

cls

callable

A custom type or function that will be passed the direct response

Returns

VnetGateway, or the result of cls(response)

Return type

VnetGateway

Exceptions

HttpResponseError

create_or_update_vnet_connection_slot

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

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

async create_or_update_vnet_connection_slot(resource_group_name: str, name: str, vnet_name: str, slot: str, connection_envelope: azure.mgmt.web.v2021_01_15.models._models_py3.VnetInfo, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.VnetInfo

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

vnet_name

str

Required

Name of an existing Virtual Network.

slot

str

Required

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

connection_envelope

VnetInfo

Required

Properties of the Virtual Network connection. See example.

cls

callable

A custom type or function that will be passed the direct response

Returns

VnetInfo, or the result of cls(response)

Return type

VnetInfo

Exceptions

HttpResponseError

delete

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

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

async delete(resource_group_name: str, name: str, delete_metrics: Optional[bool] = None, delete_empty_server_farm: Optional[bool] = None, **kwargs: Any) -> None

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app to delete.

delete_metrics

bool

default value: None

If true, web app metrics are also deleted.

delete_empty_server_farm

bool

default value: None

Specify false if you want to keep empty App Service plan. By default, empty App Service plan is deleted.

cls

callable

A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Exceptions

HttpResponseError

delete_backup

Deletes a backup of an app by its ID.

Description for Deletes a backup of an app by its ID.

async delete_backup(resource_group_name: str, name: str, backup_id: str, **kwargs: Any) -> None

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

backup_id

str

Required

ID of the backup.

cls

callable

A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Exceptions

HttpResponseError

delete_backup_configuration

Deletes the backup configuration of an app.

Description for Deletes the backup configuration of an app.

async delete_backup_configuration(resource_group_name: str, name: str, **kwargs: Any) -> None

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

cls

callable

A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Exceptions

HttpResponseError

delete_backup_configuration_slot

Deletes the backup configuration of an app.

Description for Deletes the backup configuration of an app.

async delete_backup_configuration_slot(resource_group_name: str, name: str, slot: str, **kwargs: Any) -> None

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

slot

str

Required

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

cls

callable

A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Exceptions

HttpResponseError

delete_backup_slot

Deletes a backup of an app by its ID.

Description for Deletes a backup of an app by its ID.

async delete_backup_slot(resource_group_name: str, name: str, backup_id: str, slot: str, **kwargs: Any) -> None

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

backup_id

str

Required

ID of the backup.

slot

str

Required

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

cls

callable

A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Exceptions

HttpResponseError

delete_continuous_web_job

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

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

async delete_continuous_web_job(resource_group_name: str, name: str, web_job_name: str, **kwargs: Any) -> None

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Site name.

web_job_name

str

Required

Name of Web Job.

cls

callable

A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Exceptions

HttpResponseError

delete_continuous_web_job_slot

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

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

async delete_continuous_web_job_slot(resource_group_name: str, name: str, web_job_name: str, slot: str, **kwargs: Any) -> None

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Site name.

web_job_name

str

Required

Name of Web Job.

slot

str

Required

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

cls

callable

A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Exceptions

HttpResponseError

delete_deployment

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

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

async delete_deployment(resource_group_name: str, name: str, id: str, **kwargs: Any) -> None

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

id

str

Required

Deployment ID.

cls

callable

A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Exceptions

HttpResponseError

delete_deployment_slot

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

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

async delete_deployment_slot(resource_group_name: str, name: str, id: str, slot: str, **kwargs: Any) -> None

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

id

str

Required

Deployment ID.

slot

str

Required

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

cls

callable

A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Exceptions

HttpResponseError

delete_domain_ownership_identifier

Deletes a domain ownership identifier for a web app.

Description for Deletes a domain ownership identifier for a web app.

async delete_domain_ownership_identifier(resource_group_name: str, name: str, domain_ownership_identifier_name: str, **kwargs: Any) -> None

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

domain_ownership_identifier_name

str

Required

Name of domain ownership identifier.

cls

callable

A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Exceptions

HttpResponseError

delete_domain_ownership_identifier_slot

Deletes a domain ownership identifier for a web app.

Description for Deletes a domain ownership identifier for a web app.

async delete_domain_ownership_identifier_slot(resource_group_name: str, name: str, domain_ownership_identifier_name: str, slot: str, **kwargs: Any) -> None

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

domain_ownership_identifier_name

str

Required

Name of domain ownership identifier.

slot

str

Required

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

cls

callable

A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Exceptions

HttpResponseError

delete_function

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

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

async delete_function(resource_group_name: str, name: str, function_name: str, **kwargs: Any) -> None

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Site name.

function_name

str

Required

Function name.

cls

callable

A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Exceptions

HttpResponseError

delete_function_secret

Delete a function secret.

Description for Delete a function secret.

async delete_function_secret(resource_group_name: str, name: str, function_name: str, key_name: str, **kwargs: Any) -> None

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Site name.

function_name

str

Required

The name of the function.

key_name

str

Required

The name of the key.

cls

callable

A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Exceptions

HttpResponseError

delete_function_secret_slot

Delete a function secret.

Description for Delete a function secret.

async delete_function_secret_slot(resource_group_name: str, name: str, function_name: str, key_name: str, slot: str, **kwargs: Any) -> None

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Site name.

function_name

str

Required

The name of the function.

key_name

str

Required

The name of the key.

slot

str

Required

Name of the deployment slot.

cls

callable

A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Exceptions

HttpResponseError

delete_host_name_binding

Deletes a hostname binding for an app.

Description for Deletes a hostname binding for an app.

async delete_host_name_binding(resource_group_name: str, name: str, host_name: str, **kwargs: Any) -> None

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

host_name

str

Required

Hostname in the hostname binding.

cls

callable

A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Exceptions

HttpResponseError

delete_host_name_binding_slot

Deletes a hostname binding for an app.

Description for Deletes a hostname binding for an app.

async delete_host_name_binding_slot(resource_group_name: str, name: str, slot: str, host_name: str, **kwargs: Any) -> None

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

slot

str

Required

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

host_name

str

Required

Hostname in the hostname binding.

cls

callable

A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Exceptions

HttpResponseError

delete_host_secret

Delete a host level secret.

Description for Delete a host level secret.

async delete_host_secret(resource_group_name: str, name: str, key_type: str, key_name: str, **kwargs: Any) -> None

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Site name.

key_type

str

Required

The type of host key.

key_name

str

Required

The name of the key.

cls

callable

A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Exceptions

HttpResponseError

delete_host_secret_slot

Delete a host level secret.

Description for Delete a host level secret.

async delete_host_secret_slot(resource_group_name: str, name: str, key_type: str, key_name: str, slot: str, **kwargs: Any) -> None

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Site name.

key_type

str

Required

The type of host key.

key_name

str

Required

The name of the key.

slot

str

Required

Name of the deployment slot.

cls

callable

A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Exceptions

HttpResponseError

delete_hybrid_connection

Removes a Hybrid Connection from this site.

Description for Removes a Hybrid Connection from this site.

async delete_hybrid_connection(resource_group_name: str, name: str, namespace_name: str, relay_name: str, **kwargs: Any) -> None

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

The name of the web app.

namespace_name

str

Required

The namespace for this hybrid connection.

relay_name

str

Required

The relay name for this hybrid connection.

cls

callable

A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Exceptions

HttpResponseError

delete_hybrid_connection_slot

Removes a Hybrid Connection from this site.

Description for Removes a Hybrid Connection from this site.

async delete_hybrid_connection_slot(resource_group_name: str, name: str, namespace_name: str, relay_name: str, slot: str, **kwargs: Any) -> None

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

The name of the web app.

namespace_name

str

Required

The namespace for this hybrid connection.

relay_name

str

Required

The relay name for this hybrid connection.

slot

str

Required

The name of the slot for the web app.

cls

callable

A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Exceptions

HttpResponseError

delete_instance_function_slot

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

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

async delete_instance_function_slot(resource_group_name: str, name: str, function_name: str, slot: str, **kwargs: Any) -> None

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Site name.

function_name

str

Required

Function name.

slot

str

Required

Name of the deployment slot.

cls

callable

A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Exceptions

HttpResponseError

delete_instance_process

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

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.

async delete_instance_process(resource_group_name: str, name: str, process_id: str, instance_id: str, **kwargs: Any) -> None

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Site name.

process_id

str

Required

PID.

instance_id

str

Required

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".

cls

callable

A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Exceptions

HttpResponseError

delete_instance_process_slot

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

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.

async delete_instance_process_slot(resource_group_name: str, name: str, process_id: str, slot: str, instance_id: str, **kwargs: Any) -> None

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Site name.

process_id

str

Required

PID.

slot

str

Required

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

instance_id

str

Required

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".

cls

callable

A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Exceptions

HttpResponseError

delete_premier_add_on

Delete a premier add-on from an app.

Description for Delete a premier add-on from an app.

async delete_premier_add_on(resource_group_name: str, name: str, premier_add_on_name: str, **kwargs: Any) -> None

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

premier_add_on_name

str

Required

Add-on name.

cls

callable

A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Exceptions

HttpResponseError

delete_premier_add_on_slot

Delete a premier add-on from an app.

Description for Delete a premier add-on from an app.

async delete_premier_add_on_slot(resource_group_name: str, name: str, premier_add_on_name: str, slot: str, **kwargs: Any) -> None

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

premier_add_on_name

str

Required

Add-on name.

slot

str

Required

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

cls

callable

A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Exceptions

HttpResponseError

delete_process

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

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.

async delete_process(resource_group_name: str, name: str, process_id: str, **kwargs: Any) -> None

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Site name.

process_id

str

Required

PID.

cls

callable

A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Exceptions

HttpResponseError

delete_process_slot

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

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.

async delete_process_slot(resource_group_name: str, name: str, process_id: str, slot: str, **kwargs: Any) -> None

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Site name.

process_id

str

Required

PID.

slot

str

Required

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

cls

callable

A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Exceptions

HttpResponseError

delete_public_certificate

Deletes a hostname binding for an app.

Description for Deletes a hostname binding for an app.

async delete_public_certificate(resource_group_name: str, name: str, public_certificate_name: str, **kwargs: Any) -> None

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

public_certificate_name

str

Required

Public certificate name.

cls

callable

A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Exceptions

HttpResponseError

delete_public_certificate_slot

Deletes a hostname binding for an app.

Description for Deletes a hostname binding for an app.

async delete_public_certificate_slot(resource_group_name: str, name: str, slot: str, public_certificate_name: str, **kwargs: Any) -> None

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

slot

str

Required

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

public_certificate_name

str

Required

Public certificate name.

cls

callable

A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Exceptions

HttpResponseError

delete_relay_service_connection

Deletes a relay service connection by its name.

Description for Deletes a relay service connection by its name.

async delete_relay_service_connection(resource_group_name: str, name: str, entity_name: str, **kwargs: Any) -> None

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

entity_name

str

Required

Name of the hybrid connection configuration.

cls

callable

A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Exceptions

HttpResponseError

delete_relay_service_connection_slot

Deletes a relay service connection by its name.

Description for Deletes a relay service connection by its name.

async delete_relay_service_connection_slot(resource_group_name: str, name: str, entity_name: str, slot: str, **kwargs: Any) -> None

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

entity_name

str

Required

Name of the hybrid connection configuration.

slot

str

Required

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

cls

callable

A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Exceptions

HttpResponseError

delete_site_extension

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

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

async delete_site_extension(resource_group_name: str, name: str, site_extension_id: str, **kwargs: Any) -> None

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Site name.

site_extension_id

str

Required

Site extension name.

cls

callable

A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Exceptions

HttpResponseError

delete_site_extension_slot

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

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

async delete_site_extension_slot(resource_group_name: str, name: str, site_extension_id: str, slot: str, **kwargs: Any) -> None

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Site name.

site_extension_id

str

Required

Site extension name.

slot

str

Required

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

cls

callable

A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Exceptions

HttpResponseError

delete_slot

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

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

async delete_slot(resource_group_name: str, name: str, slot: str, delete_metrics: Optional[bool] = None, delete_empty_server_farm: Optional[bool] = None, **kwargs: Any) -> None

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app to delete.

slot

str

Required

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

delete_metrics

bool

default value: None

If true, web app metrics are also deleted.

delete_empty_server_farm

bool

default value: None

Specify false if you want to keep empty App Service plan. By default, empty App Service plan is deleted.

cls

callable

A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Exceptions

HttpResponseError

delete_source_control

Deletes the source control configuration of an app.

Description for Deletes the source control configuration of an app.

async delete_source_control(resource_group_name: str, name: str, additional_flags: Optional[str] = None, **kwargs: Any) -> None

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

additional_flags

str

default value: None

cls

callable

A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Exceptions

HttpResponseError

delete_source_control_slot

Deletes the source control configuration of an app.

Description for Deletes the source control configuration of an app.

async delete_source_control_slot(resource_group_name: str, name: str, slot: str, additional_flags: Optional[str] = None, **kwargs: Any) -> None

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

slot

str

Required

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

additional_flags

str

default value: None

cls

callable

A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Exceptions

HttpResponseError

delete_swift_virtual_network

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

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

async delete_swift_virtual_network(resource_group_name: str, name: str, **kwargs: Any) -> None

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

cls

callable

A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Exceptions

HttpResponseError

delete_swift_virtual_network_slot

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

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

async delete_swift_virtual_network_slot(resource_group_name: str, name: str, slot: str, **kwargs: Any) -> None

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

slot

str

Required

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

cls

callable

A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Exceptions

HttpResponseError

delete_triggered_web_job

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

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

async delete_triggered_web_job(resource_group_name: str, name: str, web_job_name: str, **kwargs: Any) -> None

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Site name.

web_job_name

str

Required

Name of Web Job.

cls

callable

A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Exceptions

HttpResponseError

delete_triggered_web_job_slot

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

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

async delete_triggered_web_job_slot(resource_group_name: str, name: str, web_job_name: str, slot: str, **kwargs: Any) -> None

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Site name.

web_job_name

str

Required

Name of Web Job.

slot

str

Required

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

cls

callable

A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Exceptions

HttpResponseError

delete_vnet_connection

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

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

async delete_vnet_connection(resource_group_name: str, name: str, vnet_name: str, **kwargs: Any) -> None

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

vnet_name

str

Required

Name of the virtual network.

cls

callable

A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Exceptions

HttpResponseError

delete_vnet_connection_slot

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

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

async delete_vnet_connection_slot(resource_group_name: str, name: str, vnet_name: str, slot: str, **kwargs: Any) -> None

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

vnet_name

str

Required

Name of the virtual network.

slot

str

Required

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

cls

callable

A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Exceptions

HttpResponseError

discover_backup

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.

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.

async discover_backup(resource_group_name: str, name: str, request: azure.mgmt.web.v2021_01_15.models._models_py3.RestoreRequest, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.RestoreRequest

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

request

RestoreRequest

Required

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

cls

callable

A custom type or function that will be passed the direct response

Returns

RestoreRequest, or the result of cls(response)

Return type

RestoreRequest

Exceptions

HttpResponseError

discover_backup_slot

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.

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.

async discover_backup_slot(resource_group_name: str, name: str, slot: str, request: azure.mgmt.web.v2021_01_15.models._models_py3.RestoreRequest, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.RestoreRequest

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

slot

str

Required

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

request

RestoreRequest

Required

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

cls

callable

A custom type or function that will be passed the direct response

Returns

RestoreRequest, or the result of cls(response)

Return type

RestoreRequest

Exceptions

HttpResponseError

generate_new_site_publishing_password

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

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

async generate_new_site_publishing_password(resource_group_name: str, name: str, **kwargs: Any) -> None

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

cls

callable

A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Exceptions

HttpResponseError

generate_new_site_publishing_password_slot

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

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

async generate_new_site_publishing_password_slot(resource_group_name: str, name: str, slot: str, **kwargs: Any) -> None

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

slot

str

Required

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

cls

callable

A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Exceptions

HttpResponseError

get

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

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

async get(resource_group_name: str, name: str, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.Site

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

cls

callable

A custom type or function that will be passed the direct response

Returns

Site, or the result of cls(response)

Return type

Site

Exceptions

HttpResponseError

get_app_setting_key_vault_reference

Gets the config reference and status of an app.

Description for Gets the config reference and status of an app.

async get_app_setting_key_vault_reference(resource_group_name: str, name: str, app_setting_key: str, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.ApiKVReference

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

app_setting_key

str

Required

App Setting key name.

cls

callable

A custom type or function that will be passed the direct response

Returns

ApiKVReference, or the result of cls(response)

Return type

ApiKVReference

Exceptions

HttpResponseError

get_app_setting_key_vault_reference_slot

Gets the config reference and status of an app.

Description for Gets the config reference and status of an app.

async get_app_setting_key_vault_reference_slot(resource_group_name: str, name: str, app_setting_key: str, slot: str, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.ApiKVReference

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

app_setting_key

str

Required

App Setting key name.

slot

str

Required

cls

callable

A custom type or function that will be passed the direct response

Returns

ApiKVReference, or the result of cls(response)

Return type

ApiKVReference

Exceptions

HttpResponseError

get_app_settings_key_vault_references

Gets the config reference app settings and status of an app.

Description for Gets the config reference app settings and status of an app.

get_app_settings_key_vault_references(resource_group_name: str, name: str, **kwargs: Any) -> AsyncIterable[azure.mgmt.web.v2021_01_15.models._models_py3.ApiKVReferenceCollection]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either ApiKVReferenceCollection or the result of cls(response)

Return type

AsyncItemPaged[ApiKVReferenceCollection]

Exceptions

HttpResponseError

get_app_settings_key_vault_references_slot

Gets the config reference app settings and status of an app.

Description for Gets the config reference app settings and status of an app.

get_app_settings_key_vault_references_slot(resource_group_name: str, name: str, slot: str, **kwargs: Any) -> AsyncIterable[azure.mgmt.web.v2021_01_15.models._models_py3.ApiKVReferenceCollection]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

slot

str

Required

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either ApiKVReferenceCollection or the result of cls(response)

Return type

AsyncItemPaged[ApiKVReferenceCollection]

Exceptions

HttpResponseError

get_auth_settings

Gets the Authentication/Authorization settings of an app.

Description for Gets the Authentication/Authorization settings of an app.

async get_auth_settings(resource_group_name: str, name: str, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.SiteAuthSettings

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

cls

callable

A custom type or function that will be passed the direct response

Returns

SiteAuthSettings, or the result of cls(response)

Return type

SiteAuthSettings

Exceptions

HttpResponseError

get_auth_settings_slot

Gets the Authentication/Authorization settings of an app.

Description for Gets the Authentication/Authorization settings of an app.

async get_auth_settings_slot(resource_group_name: str, name: str, slot: str, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.SiteAuthSettings

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

slot

str

Required

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

cls

callable

A custom type or function that will be passed the direct response

Returns

SiteAuthSettings, or the result of cls(response)

Return type

SiteAuthSettings

Exceptions

HttpResponseError

get_auth_settings_v2

Gets site's Authentication / Authorization settings for apps via the V2 format.

Description for Gets site's Authentication / Authorization settings for apps via the V2 format.

async get_auth_settings_v2(resource_group_name: str, name: str, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.SiteAuthSettingsV2

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

cls

callable

A custom type or function that will be passed the direct response

Returns

SiteAuthSettingsV2, or the result of cls(response)

Return type

SiteAuthSettingsV2

Exceptions

HttpResponseError

get_auth_settings_v2_slot

Gets site's Authentication / Authorization settings for apps via the V2 format.

Description for Gets site's Authentication / Authorization settings for apps via the V2 format.

async get_auth_settings_v2_slot(resource_group_name: str, name: str, slot: str, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.SiteAuthSettingsV2

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

slot

str

Required

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

cls

callable

A custom type or function that will be passed the direct response

Returns

SiteAuthSettingsV2, or the result of cls(response)

Return type

SiteAuthSettingsV2

Exceptions

HttpResponseError

get_backup_configuration

Gets the backup configuration of an app.

Description for Gets the backup configuration of an app.

async get_backup_configuration(resource_group_name: str, name: str, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.BackupRequest

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

cls

callable

A custom type or function that will be passed the direct response

Returns

BackupRequest, or the result of cls(response)

Return type

BackupRequest

Exceptions

HttpResponseError

get_backup_configuration_slot

Gets the backup configuration of an app.

Description for Gets the backup configuration of an app.

async get_backup_configuration_slot(resource_group_name: str, name: str, slot: str, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.BackupRequest

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

slot

str

Required

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

cls

callable

A custom type or function that will be passed the direct response

Returns

BackupRequest, or the result of cls(response)

Return type

BackupRequest

Exceptions

HttpResponseError

get_backup_status

Gets a backup of an app by its ID.

Description for Gets a backup of an app by its ID.

async get_backup_status(resource_group_name: str, name: str, backup_id: str, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.BackupItem

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

backup_id

str

Required

ID of the backup.

cls

callable

A custom type or function that will be passed the direct response

Returns

BackupItem, or the result of cls(response)

Return type

BackupItem

Exceptions

HttpResponseError

get_backup_status_slot

Gets a backup of an app by its ID.

Description for Gets a backup of an app by its ID.

async get_backup_status_slot(resource_group_name: str, name: str, backup_id: str, slot: str, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.BackupItem

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

backup_id

str

Required

ID of the backup.

slot

str

Required

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

cls

callable

A custom type or function that will be passed the direct response

Returns

BackupItem, or the result of cls(response)

Return type

BackupItem

Exceptions

HttpResponseError

get_configuration

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

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

async get_configuration(resource_group_name: str, name: str, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.SiteConfigResource

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

cls

callable

A custom type or function that will be passed the direct response

Returns

SiteConfigResource, or the result of cls(response)

Return type

SiteConfigResource

Exceptions

HttpResponseError

get_configuration_slot

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

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

async get_configuration_slot(resource_group_name: str, name: str, slot: str, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.SiteConfigResource

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

slot

str

Required

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

cls

callable

A custom type or function that will be passed the direct response

Returns

SiteConfigResource, or the result of cls(response)

Return type

SiteConfigResource

Exceptions

HttpResponseError

get_configuration_snapshot

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

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

async get_configuration_snapshot(resource_group_name: str, name: str, snapshot_id: str, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.SiteConfigResource

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

snapshot_id

str

Required

The ID of the snapshot to read.

cls

callable

A custom type or function that will be passed the direct response

Returns

SiteConfigResource, or the result of cls(response)

Return type

SiteConfigResource

Exceptions

HttpResponseError

get_configuration_snapshot_slot

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

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

async get_configuration_snapshot_slot(resource_group_name: str, name: str, snapshot_id: str, slot: str, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.SiteConfigResource

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

snapshot_id

str

Required

The ID of the snapshot to read.

slot

str

Required

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

cls

callable

A custom type or function that will be passed the direct response

Returns

SiteConfigResource, or the result of cls(response)

Return type

SiteConfigResource

Exceptions

HttpResponseError

get_container_logs_zip

Gets the ZIP archived docker log files for the given site.

Description for Gets the ZIP archived docker log files for the given site.

async get_container_logs_zip(resource_group_name: str, name: str, **kwargs: Any) -> Optional[IO]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of web app.

cls

callable

A custom type or function that will be passed the direct response

Returns

IO, or the result of cls(response)

Return type

<xref:IO>,

None

Exceptions

HttpResponseError

get_container_logs_zip_slot

Gets the ZIP archived docker log files for the given site.

Description for Gets the ZIP archived docker log files for the given site.

async get_container_logs_zip_slot(resource_group_name: str, name: str, slot: str, **kwargs: Any) -> Optional[IO]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of web app.

slot

str

Required

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

cls

callable

A custom type or function that will be passed the direct response

Returns

IO, or the result of cls(response)

Return type

<xref:IO>,

None

Exceptions

HttpResponseError

get_continuous_web_job

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

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

async get_continuous_web_job(resource_group_name: str, name: str, web_job_name: str, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.ContinuousWebJob

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Site name.

web_job_name

str

Required

Name of Web Job.

cls

callable

A custom type or function that will be passed the direct response

Returns

ContinuousWebJob, or the result of cls(response)

Return type

ContinuousWebJob

Exceptions

HttpResponseError

get_continuous_web_job_slot

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

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

async get_continuous_web_job_slot(resource_group_name: str, name: str, web_job_name: str, slot: str, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.ContinuousWebJob

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Site name.

web_job_name

str

Required

Name of Web Job.

slot

str

Required

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

cls

callable

A custom type or function that will be passed the direct response

Returns

ContinuousWebJob, or the result of cls(response)

Return type

ContinuousWebJob

Exceptions

HttpResponseError

get_deployment

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

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

async get_deployment(resource_group_name: str, name: str, id: str, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.Deployment

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

id

str

Required

Deployment ID.

cls

callable

A custom type or function that will be passed the direct response

Returns

Deployment, or the result of cls(response)

Return type

Deployment

Exceptions

HttpResponseError

get_deployment_slot

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

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

async get_deployment_slot(resource_group_name: str, name: str, id: str, slot: str, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.Deployment

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

id

str

Required

Deployment ID.

slot

str

Required

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

cls

callable

A custom type or function that will be passed the direct response

Returns

Deployment, or the result of cls(response)

Return type

Deployment

Exceptions

HttpResponseError

get_diagnostic_logs_configuration

Gets the logging configuration of an app.

Description for Gets the logging configuration of an app.

async get_diagnostic_logs_configuration(resource_group_name: str, name: str, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.SiteLogsConfig

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

cls

callable

A custom type or function that will be passed the direct response

Returns

SiteLogsConfig, or the result of cls(response)

Return type

SiteLogsConfig

Exceptions

HttpResponseError

get_diagnostic_logs_configuration_slot

Gets the logging configuration of an app.

Description for Gets the logging configuration of an app.

async get_diagnostic_logs_configuration_slot(resource_group_name: str, name: str, slot: str, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.SiteLogsConfig

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

slot

str

Required

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

cls

callable

A custom type or function that will be passed the direct response

Returns

SiteLogsConfig, or the result of cls(response)

Return type

SiteLogsConfig

Exceptions

HttpResponseError

get_domain_ownership_identifier

Get domain ownership identifier for web app.

Description for Get domain ownership identifier for web app.

async get_domain_ownership_identifier(resource_group_name: str, name: str, domain_ownership_identifier_name: str, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.Identifier

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

domain_ownership_identifier_name

str

Required

Name of domain ownership identifier.

cls

callable

A custom type or function that will be passed the direct response

Returns

Identifier, or the result of cls(response)

Return type

Identifier

Exceptions

HttpResponseError

get_domain_ownership_identifier_slot

Get domain ownership identifier for web app.

Description for Get domain ownership identifier for web app.

async get_domain_ownership_identifier_slot(resource_group_name: str, name: str, domain_ownership_identifier_name: str, slot: str, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.Identifier

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

domain_ownership_identifier_name

str

Required

Name of domain ownership identifier.

slot

str

Required

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

cls

callable

A custom type or function that will be passed the direct response

Returns

Identifier, or the result of cls(response)

Return type

Identifier

Exceptions

HttpResponseError

get_ftp_allowed

Returns whether FTP is allowed on the site or not.

Description for Returns whether FTP is allowed on the site or not.

async get_ftp_allowed(resource_group_name: str, name: str, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.CsmPublishingCredentialsPoliciesEntity

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

cls

callable

A custom type or function that will be passed the direct response

Returns

CsmPublishingCredentialsPoliciesEntity, or the result of cls(response)

Return type

CsmPublishingCredentialsPoliciesEntity

Exceptions

HttpResponseError

get_ftp_allowed_slot

Returns whether FTP is allowed on the site or not.

Description for Returns whether FTP is allowed on the site or not.

async get_ftp_allowed_slot(resource_group_name: str, name: str, slot: str, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.CsmPublishingCredentialsPoliciesEntity

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

slot

str

Required

cls

callable

A custom type or function that will be passed the direct response

Returns

CsmPublishingCredentialsPoliciesEntity, or the result of cls(response)

Return type

CsmPublishingCredentialsPoliciesEntity

Exceptions

HttpResponseError

get_function

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

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

async get_function(resource_group_name: str, name: str, function_name: str, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.FunctionEnvelope

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Site name.

function_name

str

Required

Function name.

cls

callable

A custom type or function that will be passed the direct response

Returns

FunctionEnvelope, or the result of cls(response)

Return type

FunctionEnvelope

Exceptions

HttpResponseError

get_functions_admin_token

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

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

async get_functions_admin_token(resource_group_name: str, name: str, **kwargs: Any) -> str

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of web app.

cls

callable

A custom type or function that will be passed the direct response

Returns

str, or the result of cls(response)

Return type

str

Exceptions

HttpResponseError

get_functions_admin_token_slot

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

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

async get_functions_admin_token_slot(resource_group_name: str, name: str, slot: str, **kwargs: Any) -> str

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of web app.

slot

str

Required

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

cls

callable

A custom type or function that will be passed the direct response

Returns

str, or the result of cls(response)

Return type

str

Exceptions

HttpResponseError

get_host_name_binding

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

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

async get_host_name_binding(resource_group_name: str, name: str, host_name: str, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.HostNameBinding

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

host_name

str

Required

Hostname in the hostname binding.

cls

callable

A custom type or function that will be passed the direct response

Returns

HostNameBinding, or the result of cls(response)

Return type

HostNameBinding

Exceptions

HttpResponseError

get_host_name_binding_slot

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

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

async get_host_name_binding_slot(resource_group_name: str, name: str, slot: str, host_name: str, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.HostNameBinding

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

slot

str

Required

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

host_name

str

Required

Hostname in the hostname binding.

cls

callable

A custom type or function that will be passed the direct response

Returns

HostNameBinding, or the result of cls(response)

Return type

HostNameBinding

Exceptions

HttpResponseError

get_hybrid_connection

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

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

async get_hybrid_connection(resource_group_name: str, name: str, namespace_name: str, relay_name: str, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.HybridConnection

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

The name of the web app.

namespace_name

str

Required

The namespace for this hybrid connection.

relay_name

str

Required

The relay name for this hybrid connection.

cls

callable

A custom type or function that will be passed the direct response

Returns

HybridConnection, or the result of cls(response)

Return type

HybridConnection

Exceptions

HttpResponseError

get_hybrid_connection_slot

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

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

async get_hybrid_connection_slot(resource_group_name: str, name: str, namespace_name: str, relay_name: str, slot: str, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.HybridConnection

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

The name of the web app.

namespace_name

str

Required

The namespace for this hybrid connection.

relay_name

str

Required

The relay name for this hybrid connection.

slot

str

Required

The name of the slot for the web app.

cls

callable

A custom type or function that will be passed the direct response

Returns

HybridConnection, or the result of cls(response)

Return type

HybridConnection

Exceptions

HttpResponseError

get_instance_function_slot

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

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

async get_instance_function_slot(resource_group_name: str, name: str, function_name: str, slot: str, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.FunctionEnvelope

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Site name.

function_name

str

Required

Function name.

slot

str

Required

Name of the deployment slot.

cls

callable

A custom type or function that will be passed the direct response

Returns

FunctionEnvelope, or the result of cls(response)

Return type

FunctionEnvelope

Exceptions

HttpResponseError

get_instance_info

Gets all scale-out instances of an app.

Description for Gets all scale-out instances of an app.

async get_instance_info(resource_group_name: str, name: str, instance_id: str, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.WebSiteInstanceStatus

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

instance_id

str

Required

cls

callable

A custom type or function that will be passed the direct response

Returns

WebSiteInstanceStatus, or the result of cls(response)

Return type

WebSiteInstanceStatus

Exceptions

HttpResponseError

get_instance_info_slot

Gets all scale-out instances of an app.

Description for Gets all scale-out instances of an app.

async get_instance_info_slot(resource_group_name: str, name: str, instance_id: str, slot: str, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.WebSiteInstanceStatus

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

instance_id

str

Required

slot

str

Required

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

cls

callable

A custom type or function that will be passed the direct response

Returns

WebSiteInstanceStatus, or the result of cls(response)

Return type

WebSiteInstanceStatus

Exceptions

HttpResponseError

get_instance_ms_deploy_log

Get the MSDeploy Log for the last MSDeploy operation.

Description for Get the MSDeploy Log for the last MSDeploy operation.

async get_instance_ms_deploy_log(resource_group_name: str, name: str, instance_id: str, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.MSDeployLog

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of web app.

instance_id

str

Required

ID of web app instance.

cls

callable

A custom type or function that will be passed the direct response

Returns

MSDeployLog, or the result of cls(response)

Return type

MSDeployLog

Exceptions

HttpResponseError

get_instance_ms_deploy_log_slot

Get the MSDeploy Log for the last MSDeploy operation.

Description for Get the MSDeploy Log for the last MSDeploy operation.

async get_instance_ms_deploy_log_slot(resource_group_name: str, name: str, slot: str, instance_id: str, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.MSDeployLog

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of web app.

slot

str

Required

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

instance_id

str

Required

ID of web app instance.

cls

callable

A custom type or function that will be passed the direct response

Returns

MSDeployLog, or the result of cls(response)

Return type

MSDeployLog

Exceptions

HttpResponseError

get_instance_ms_deploy_status

Get the status of the last MSDeploy operation.

Description for Get the status of the last MSDeploy operation.

async get_instance_ms_deploy_status(resource_group_name: str, name: str, instance_id: str, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.MSDeployStatus

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of web app.

instance_id

str

Required

ID of web app instance.

cls

callable

A custom type or function that will be passed the direct response

Returns

MSDeployStatus, or the result of cls(response)

Return type

MSDeployStatus

Exceptions

HttpResponseError

get_instance_ms_deploy_status_slot

Get the status of the last MSDeploy operation.

Description for Get the status of the last MSDeploy operation.

async get_instance_ms_deploy_status_slot(resource_group_name: str, name: str, slot: str, instance_id: str, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.MSDeployStatus

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of web app.

slot

str

Required

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

instance_id

str

Required

ID of web app instance.

cls

callable

A custom type or function that will be passed the direct response

Returns

MSDeployStatus, or the result of cls(response)

Return type

MSDeployStatus

Exceptions

HttpResponseError

get_instance_process

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

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

async get_instance_process(resource_group_name: str, name: str, process_id: str, instance_id: str, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.ProcessInfo

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Site name.

process_id

str

Required

PID.

instance_id

str

Required

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".

cls

callable

A custom type or function that will be passed the direct response

Returns

ProcessInfo, or the result of cls(response)

Return type

ProcessInfo

Exceptions

HttpResponseError

get_instance_process_dump

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

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

async get_instance_process_dump(resource_group_name: str, name: str, process_id: str, instance_id: str, **kwargs: Any) -> IO

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Site name.

process_id

str

Required

PID.

instance_id

str

Required

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".

cls

callable

A custom type or function that will be passed the direct response

Returns

IO, or the result of cls(response)

Return type

<xref:IO>

Exceptions

HttpResponseError

get_instance_process_dump_slot

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

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

async get_instance_process_dump_slot(resource_group_name: str, name: str, process_id: str, slot: str, instance_id: str, **kwargs: Any) -> IO

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Site name.

process_id

str

Required

PID.

slot

str

Required

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

instance_id

str

Required

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".

cls

callable

A custom type or function that will be passed the direct response

Returns

IO, or the result of cls(response)

Return type

<xref:IO>

Exceptions

HttpResponseError

get_instance_process_module

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

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

async get_instance_process_module(resource_group_name: str, name: str, process_id: str, base_address: str, instance_id: str, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.ProcessModuleInfo

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Site name.

process_id

str

Required

PID.

base_address

str

Required

Module base address.

instance_id

str

Required

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".

cls

callable

A custom type or function that will be passed the direct response

Returns

ProcessModuleInfo, or the result of cls(response)

Return type

ProcessModuleInfo

Exceptions

HttpResponseError

get_instance_process_module_slot

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

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

async get_instance_process_module_slot(resource_group_name: str, name: str, process_id: str, base_address: str, slot: str, instance_id: str, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.ProcessModuleInfo

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Site name.

process_id

str

Required

PID.

base_address

str

Required

Module base address.

slot

str

Required

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

instance_id

str

Required

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".

cls

callable

A custom type or function that will be passed the direct response

Returns

ProcessModuleInfo, or the result of cls(response)

Return type

ProcessModuleInfo

Exceptions

HttpResponseError

get_instance_process_slot

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

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

async get_instance_process_slot(resource_group_name: str, name: str, process_id: str, slot: str, instance_id: str, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.ProcessInfo

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Site name.

process_id

str

Required

PID.

slot

str

Required

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

instance_id

str

Required

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".

cls

callable

A custom type or function that will be passed the direct response

Returns

ProcessInfo, or the result of cls(response)

Return type

ProcessInfo

Exceptions

HttpResponseError

get_migrate_my_sql_status

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

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

async get_migrate_my_sql_status(resource_group_name: str, name: str, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.MigrateMySqlStatus

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of web app.

cls

callable

A custom type or function that will be passed the direct response

Returns

MigrateMySqlStatus, or the result of cls(response)

Return type

MigrateMySqlStatus

Exceptions

HttpResponseError

get_migrate_my_sql_status_slot

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

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

async get_migrate_my_sql_status_slot(resource_group_name: str, name: str, slot: str, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.MigrateMySqlStatus

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of web app.

slot

str

Required

Name of the deployment slot.

cls

callable

A custom type or function that will be passed the direct response

Returns

MigrateMySqlStatus, or the result of cls(response)

Return type

MigrateMySqlStatus

Exceptions

HttpResponseError

get_ms_deploy_log

Get the MSDeploy Log for the last MSDeploy operation.

Description for Get the MSDeploy Log for the last MSDeploy operation.

async get_ms_deploy_log(resource_group_name: str, name: str, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.MSDeployLog

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of web app.

cls

callable

A custom type or function that will be passed the direct response

Returns

MSDeployLog, or the result of cls(response)

Return type

MSDeployLog

Exceptions

HttpResponseError

get_ms_deploy_log_slot

Get the MSDeploy Log for the last MSDeploy operation.

Description for Get the MSDeploy Log for the last MSDeploy operation.

async get_ms_deploy_log_slot(resource_group_name: str, name: str, slot: str, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.MSDeployLog

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of web app.

slot

str

Required

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

cls

callable

A custom type or function that will be passed the direct response

Returns

MSDeployLog, or the result of cls(response)

Return type

MSDeployLog

Exceptions

HttpResponseError

get_ms_deploy_status

Get the status of the last MSDeploy operation.

Description for Get the status of the last MSDeploy operation.

async get_ms_deploy_status(resource_group_name: str, name: str, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.MSDeployStatus

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of web app.

cls

callable

A custom type or function that will be passed the direct response

Returns

MSDeployStatus, or the result of cls(response)

Return type

MSDeployStatus

Exceptions

HttpResponseError

get_ms_deploy_status_slot

Get the status of the last MSDeploy operation.

Description for Get the status of the last MSDeploy operation.

async get_ms_deploy_status_slot(resource_group_name: str, name: str, slot: str, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.MSDeployStatus

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of web app.

slot

str

Required

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

cls

callable

A custom type or function that will be passed the direct response

Returns

MSDeployStatus, or the result of cls(response)

Return type

MSDeployStatus

Exceptions

HttpResponseError

get_network_trace_operation

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

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

async get_network_trace_operation(resource_group_name: str, name: str, operation_id: str, **kwargs: Any) -> List[azure.mgmt.web.v2021_01_15.models._models_py3.NetworkTrace]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

operation_id

str

Required

GUID of the operation.

cls

callable

A custom type or function that will be passed the direct response

Returns

list of NetworkTrace, or the result of cls(response)

Return type

list[NetworkTrace]

Exceptions

HttpResponseError

get_network_trace_operation_slot

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

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

async get_network_trace_operation_slot(resource_group_name: str, name: str, operation_id: str, slot: str, **kwargs: Any) -> List[azure.mgmt.web.v2021_01_15.models._models_py3.NetworkTrace]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

operation_id

str

Required

GUID of the operation.

slot

str

Required

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

cls

callable

A custom type or function that will be passed the direct response

Returns

list of NetworkTrace, or the result of cls(response)

Return type

list[NetworkTrace]

Exceptions

HttpResponseError

get_network_trace_operation_slot_v2

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

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

async get_network_trace_operation_slot_v2(resource_group_name: str, name: str, operation_id: str, slot: str, **kwargs: Any) -> List[azure.mgmt.web.v2021_01_15.models._models_py3.NetworkTrace]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

operation_id

str

Required

GUID of the operation.

slot

str

Required

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

cls

callable

A custom type or function that will be passed the direct response

Returns

list of NetworkTrace, or the result of cls(response)

Return type

list[NetworkTrace]

Exceptions

HttpResponseError

get_network_trace_operation_v2

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

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

async get_network_trace_operation_v2(resource_group_name: str, name: str, operation_id: str, **kwargs: Any) -> List[azure.mgmt.web.v2021_01_15.models._models_py3.NetworkTrace]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

operation_id

str

Required

GUID of the operation.

cls

callable

A custom type or function that will be passed the direct response

Returns

list of NetworkTrace, or the result of cls(response)

Return type

list[NetworkTrace]

Exceptions

HttpResponseError

get_network_traces

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

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

async get_network_traces(resource_group_name: str, name: str, operation_id: str, **kwargs: Any) -> List[azure.mgmt.web.v2021_01_15.models._models_py3.NetworkTrace]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

operation_id

str

Required

GUID of the operation.

cls

callable

A custom type or function that will be passed the direct response

Returns

list of NetworkTrace, or the result of cls(response)

Return type

list[NetworkTrace]

Exceptions

HttpResponseError

get_network_traces_slot

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

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

async get_network_traces_slot(resource_group_name: str, name: str, operation_id: str, slot: str, **kwargs: Any) -> List[azure.mgmt.web.v2021_01_15.models._models_py3.NetworkTrace]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

operation_id

str

Required

GUID of the operation.

slot

str

Required

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

cls

callable

A custom type or function that will be passed the direct response

Returns

list of NetworkTrace, or the result of cls(response)

Return type

list[NetworkTrace]

Exceptions

HttpResponseError

get_network_traces_slot_v2

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

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

async get_network_traces_slot_v2(resource_group_name: str, name: str, operation_id: str, slot: str, **kwargs: Any) -> List[azure.mgmt.web.v2021_01_15.models._models_py3.NetworkTrace]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

operation_id

str

Required

GUID of the operation.

slot

str

Required

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

cls

callable

A custom type or function that will be passed the direct response

Returns

list of NetworkTrace, or the result of cls(response)

Return type

list[NetworkTrace]

Exceptions

HttpResponseError

get_network_traces_v2

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

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

async get_network_traces_v2(resource_group_name: str, name: str, operation_id: str, **kwargs: Any) -> List[azure.mgmt.web.v2021_01_15.models._models_py3.NetworkTrace]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

operation_id

str

Required

GUID of the operation.

cls

callable

A custom type or function that will be passed the direct response

Returns

list of NetworkTrace, or the result of cls(response)

Return type

list[NetworkTrace]

Exceptions

HttpResponseError

get_premier_add_on

Gets a named add-on of an app.

Description for Gets a named add-on of an app.

async get_premier_add_on(resource_group_name: str, name: str, premier_add_on_name: str, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.PremierAddOn

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

premier_add_on_name

str

Required

Add-on name.

cls

callable

A custom type or function that will be passed the direct response

Returns

PremierAddOn, or the result of cls(response)

Return type

PremierAddOn

Exceptions

HttpResponseError

get_premier_add_on_slot

Gets a named add-on of an app.

Description for Gets a named add-on of an app.

async get_premier_add_on_slot(resource_group_name: str, name: str, premier_add_on_name: str, slot: str, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.PremierAddOn

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

premier_add_on_name

str

Required

Add-on name.

slot

str

Required

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

cls

callable

A custom type or function that will be passed the direct response

Returns

PremierAddOn, or the result of cls(response)

Return type

PremierAddOn

Exceptions

HttpResponseError

get_private_access

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

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

async get_private_access(resource_group_name: str, name: str, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.PrivateAccess

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

The name of the web app.

cls

callable

A custom type or function that will be passed the direct response

Returns

PrivateAccess, or the result of cls(response)

Return type

PrivateAccess

Exceptions

HttpResponseError

get_private_access_slot

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

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

async get_private_access_slot(resource_group_name: str, name: str, slot: str, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.PrivateAccess

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

The name of the web app.

slot

str

Required

The name of the slot for the web app.

cls

callable

A custom type or function that will be passed the direct response

Returns

PrivateAccess, or the result of cls(response)

Return type

PrivateAccess

Exceptions

HttpResponseError

get_private_endpoint_connection

Gets a private endpoint connection.

Description for Gets a private endpoint connection.

async get_private_endpoint_connection(resource_group_name: str, name: str, private_endpoint_connection_name: str, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.RemotePrivateEndpointConnectionARMResource

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the site.

private_endpoint_connection_name

str

Required

Name of the private endpoint connection.

cls

callable

A custom type or function that will be passed the direct response

Returns

RemotePrivateEndpointConnectionARMResource, or the result of cls(response)

Return type

RemotePrivateEndpointConnectionARMResource

Exceptions

HttpResponseError

get_private_endpoint_connection_list

Gets the list of private endpoint connections associated with a site.

Description for Gets the list of private endpoint connections associated with a site.

get_private_endpoint_connection_list(resource_group_name: str, name: str, **kwargs: Any) -> AsyncIterable[azure.mgmt.web.v2021_01_15.models._models_py3.PrivateEndpointConnectionCollection]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the site.

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either PrivateEndpointConnectionCollection or the result of cls(response)

Return type

AsyncItemPaged[PrivateEndpointConnectionCollection]

Exceptions

HttpResponseError

get_private_endpoint_connection_list_slot

Gets the list of private endpoint connections associated with a site.

Description for Gets the list of private endpoint connections associated with a site.

get_private_endpoint_connection_list_slot(resource_group_name: str, name: str, slot: str, **kwargs: Any) -> AsyncIterable[azure.mgmt.web.v2021_01_15.models._models_py3.PrivateEndpointConnectionCollection]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the site.

slot

str

Required

Name of the site deployment slot.

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either PrivateEndpointConnectionCollection or the result of cls(response)

Return type

AsyncItemPaged[PrivateEndpointConnectionCollection]

Exceptions

HttpResponseError

get_private_endpoint_connection_slot

Gets a private endpoint connection.

Description for Gets a private endpoint connection.

async get_private_endpoint_connection_slot(resource_group_name: str, name: str, private_endpoint_connection_name: str, slot: str, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.RemotePrivateEndpointConnectionARMResource

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the site.

private_endpoint_connection_name

str

Required

Name of the private endpoint connection.

slot

str

Required

Name of the site deployment slot.

cls

callable

A custom type or function that will be passed the direct response

Returns

RemotePrivateEndpointConnectionARMResource, or the result of cls(response)

Return type

RemotePrivateEndpointConnectionARMResource

Exceptions

HttpResponseError

get_private_link_resources

Gets the private link resources.

Description for Gets the private link resources.

async get_private_link_resources(resource_group_name: str, name: str, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.PrivateLinkResourcesWrapper

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the site.

cls

callable

A custom type or function that will be passed the direct response

Returns

PrivateLinkResourcesWrapper, or the result of cls(response)

Return type

PrivateLinkResourcesWrapper

Exceptions

HttpResponseError

get_private_link_resources_slot

Gets the private link resources.

Description for Gets the private link resources.

async get_private_link_resources_slot(resource_group_name: str, name: str, slot: str, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.PrivateLinkResourcesWrapper

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the site.

slot

str

Required

cls

callable

A custom type or function that will be passed the direct response

Returns

PrivateLinkResourcesWrapper, or the result of cls(response)

Return type

PrivateLinkResourcesWrapper

Exceptions

HttpResponseError

get_process

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

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

async get_process(resource_group_name: str, name: str, process_id: str, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.ProcessInfo

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Site name.

process_id

str

Required

PID.

cls

callable

A custom type or function that will be passed the direct response

Returns

ProcessInfo, or the result of cls(response)

Return type

ProcessInfo

Exceptions

HttpResponseError

get_process_dump

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

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

async get_process_dump(resource_group_name: str, name: str, process_id: str, **kwargs: Any) -> IO

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Site name.

process_id

str

Required

PID.

cls

callable

A custom type or function that will be passed the direct response

Returns

IO, or the result of cls(response)

Return type

<xref:IO>

Exceptions

HttpResponseError

get_process_dump_slot

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

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

async get_process_dump_slot(resource_group_name: str, name: str, process_id: str, slot: str, **kwargs: Any) -> IO

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Site name.

process_id

str

Required

PID.

slot

str

Required

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

cls

callable

A custom type or function that will be passed the direct response

Returns

IO, or the result of cls(response)

Return type

<xref:IO>

Exceptions

HttpResponseError

get_process_module

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

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

async get_process_module(resource_group_name: str, name: str, process_id: str, base_address: str, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.ProcessModuleInfo

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Site name.

process_id

str

Required

PID.

base_address

str

Required

Module base address.

cls

callable

A custom type or function that will be passed the direct response

Returns

ProcessModuleInfo, or the result of cls(response)

Return type

ProcessModuleInfo

Exceptions

HttpResponseError

get_process_module_slot

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

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

async get_process_module_slot(resource_group_name: str, name: str, process_id: str, base_address: str, slot: str, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.ProcessModuleInfo

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Site name.

process_id

str

Required

PID.

base_address

str

Required

Module base address.

slot

str

Required

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

cls

callable

A custom type or function that will be passed the direct response

Returns

ProcessModuleInfo, or the result of cls(response)

Return type

ProcessModuleInfo

Exceptions

HttpResponseError

get_process_slot

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

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

async get_process_slot(resource_group_name: str, name: str, process_id: str, slot: str, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.ProcessInfo

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Site name.

process_id

str

Required

PID.

slot

str

Required

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

cls

callable

A custom type or function that will be passed the direct response

Returns

ProcessInfo, or the result of cls(response)

Return type

ProcessInfo

Exceptions

HttpResponseError

get_public_certificate

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

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

async get_public_certificate(resource_group_name: str, name: str, public_certificate_name: str, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.PublicCertificate

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

public_certificate_name

str

Required

Public certificate name.

cls

callable

A custom type or function that will be passed the direct response

Returns

PublicCertificate, or the result of cls(response)

Return type

PublicCertificate

Exceptions

HttpResponseError

get_public_certificate_slot

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

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

async get_public_certificate_slot(resource_group_name: str, name: str, slot: str, public_certificate_name: str, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.PublicCertificate

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

slot

str

Required

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

public_certificate_name

str

Required

Public certificate name.

cls

callable

A custom type or function that will be passed the direct response

Returns

PublicCertificate, or the result of cls(response)

Return type

PublicCertificate

Exceptions

HttpResponseError

get_relay_service_connection

Gets a hybrid connection configuration by its name.

Description for Gets a hybrid connection configuration by its name.

async get_relay_service_connection(resource_group_name: str, name: str, entity_name: str, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.RelayServiceConnectionEntity

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

entity_name

str

Required

Name of the hybrid connection.

cls

callable

A custom type or function that will be passed the direct response

Returns

RelayServiceConnectionEntity, or the result of cls(response)

Return type

RelayServiceConnectionEntity

Exceptions

HttpResponseError

get_relay_service_connection_slot

Gets a hybrid connection configuration by its name.

Description for Gets a hybrid connection configuration by its name.

async get_relay_service_connection_slot(resource_group_name: str, name: str, entity_name: str, slot: str, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.RelayServiceConnectionEntity

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

entity_name

str

Required

Name of the hybrid connection.

slot

str

Required

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

cls

callable

A custom type or function that will be passed the direct response

Returns

RelayServiceConnectionEntity, or the result of cls(response)

Return type

RelayServiceConnectionEntity

Exceptions

HttpResponseError

get_scm_allowed

Returns whether Scm basic auth is allowed on the site or not.

Description for Returns whether Scm basic auth is allowed on the site or not.

async get_scm_allowed(resource_group_name: str, name: str, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.CsmPublishingCredentialsPoliciesEntity

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

cls

callable

A custom type or function that will be passed the direct response

Returns

CsmPublishingCredentialsPoliciesEntity, or the result of cls(response)

Return type

CsmPublishingCredentialsPoliciesEntity

Exceptions

HttpResponseError

get_scm_allowed_slot

Returns whether Scm basic auth is allowed on the site or not.

Description for Returns whether Scm basic auth is allowed on the site or not.

async get_scm_allowed_slot(resource_group_name: str, name: str, slot: str, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.CsmPublishingCredentialsPoliciesEntity

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

slot

str

Required

cls

callable

A custom type or function that will be passed the direct response

Returns

CsmPublishingCredentialsPoliciesEntity, or the result of cls(response)

Return type

CsmPublishingCredentialsPoliciesEntity

Exceptions

HttpResponseError

get_site_connection_string_key_vault_reference

Gets the config reference and status of an app.

Description for Gets the config reference and status of an app.

async get_site_connection_string_key_vault_reference(resource_group_name: str, name: str, connection_string_key: str, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.ApiKVReference

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

connection_string_key

str

Required

cls

callable

A custom type or function that will be passed the direct response

Returns

ApiKVReference, or the result of cls(response)

Return type

ApiKVReference

Exceptions

HttpResponseError

get_site_connection_string_key_vault_reference_slot

Gets the config reference and status of an app.

Description for Gets the config reference and status of an app.

async get_site_connection_string_key_vault_reference_slot(resource_group_name: str, name: str, connection_string_key: str, slot: str, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.ApiKVReference

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

connection_string_key

str

Required

slot

str

Required

cls

callable

A custom type or function that will be passed the direct response

Returns

ApiKVReference, or the result of cls(response)

Return type

ApiKVReference

Exceptions

HttpResponseError

get_site_connection_string_key_vault_references

Gets the config reference app settings and status of an app.

Description for Gets the config reference app settings and status of an app.

get_site_connection_string_key_vault_references(resource_group_name: str, name: str, **kwargs: Any) -> AsyncIterable[azure.mgmt.web.v2021_01_15.models._models_py3.ApiKVReferenceCollection]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either ApiKVReferenceCollection or the result of cls(response)

Return type

AsyncItemPaged[ApiKVReferenceCollection]

Exceptions

HttpResponseError

get_site_connection_string_key_vault_references_slot

Gets the config reference app settings and status of an app.

Description for Gets the config reference app settings and status of an app.

get_site_connection_string_key_vault_references_slot(resource_group_name: str, name: str, slot: str, **kwargs: Any) -> AsyncIterable[azure.mgmt.web.v2021_01_15.models._models_py3.ApiKVReferenceCollection]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

slot

str

Required

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either ApiKVReferenceCollection or the result of cls(response)

Return type

AsyncItemPaged[ApiKVReferenceCollection]

Exceptions

HttpResponseError

get_site_extension

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

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

async get_site_extension(resource_group_name: str, name: str, site_extension_id: str, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.SiteExtensionInfo

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Site name.

site_extension_id

str

Required

Site extension name.

cls

callable

A custom type or function that will be passed the direct response

Returns

SiteExtensionInfo, or the result of cls(response)

Return type

SiteExtensionInfo

Exceptions

HttpResponseError

get_site_extension_slot

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

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

async get_site_extension_slot(resource_group_name: str, name: str, site_extension_id: str, slot: str, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.SiteExtensionInfo

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Site name.

site_extension_id

str

Required

Site extension name.

slot

str

Required

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

cls

callable

A custom type or function that will be passed the direct response

Returns

SiteExtensionInfo, or the result of cls(response)

Return type

SiteExtensionInfo

Exceptions

HttpResponseError

get_site_php_error_log_flag

Gets web app's event logs.

Description for Gets web app's event logs.

async get_site_php_error_log_flag(resource_group_name: str, name: str, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.SitePhpErrorLogFlag

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of web app.

cls

callable

A custom type or function that will be passed the direct response

Returns

SitePhpErrorLogFlag, or the result of cls(response)

Return type

SitePhpErrorLogFlag

Exceptions

HttpResponseError

get_site_php_error_log_flag_slot

Gets web app's event logs.

Description for Gets web app's event logs.

async get_site_php_error_log_flag_slot(resource_group_name: str, name: str, slot: str, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.SitePhpErrorLogFlag

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of web app.

slot

str

Required

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

cls

callable

A custom type or function that will be passed the direct response

Returns

SitePhpErrorLogFlag, or the result of cls(response)

Return type

SitePhpErrorLogFlag

Exceptions

HttpResponseError

get_slot

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

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

async get_slot(resource_group_name: str, name: str, slot: str, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.Site

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

slot

str

Required

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

cls

callable

A custom type or function that will be passed the direct response

Returns

Site, or the result of cls(response)

Return type

Site

Exceptions

HttpResponseError

get_source_control

Gets the source control configuration of an app.

Description for Gets the source control configuration of an app.

async get_source_control(resource_group_name: str, name: str, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.SiteSourceControl

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

cls

callable

A custom type or function that will be passed the direct response

Returns

SiteSourceControl, or the result of cls(response)

Return type

SiteSourceControl

Exceptions

HttpResponseError

get_source_control_slot

Gets the source control configuration of an app.

Description for Gets the source control configuration of an app.

async get_source_control_slot(resource_group_name: str, name: str, slot: str, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.SiteSourceControl

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

slot

str

Required

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

cls

callable

A custom type or function that will be passed the direct response

Returns

SiteSourceControl, or the result of cls(response)

Return type

SiteSourceControl

Exceptions

HttpResponseError

get_swift_virtual_network_connection

Gets a Swift Virtual Network connection.

Description for Gets a Swift Virtual Network connection.

async get_swift_virtual_network_connection(resource_group_name: str, name: str, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.SwiftVirtualNetwork

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

cls

callable

A custom type or function that will be passed the direct response

Returns

SwiftVirtualNetwork, or the result of cls(response)

Return type

SwiftVirtualNetwork

Exceptions

HttpResponseError

get_swift_virtual_network_connection_slot

Gets a Swift Virtual Network connection.

Description for Gets a Swift Virtual Network connection.

async get_swift_virtual_network_connection_slot(resource_group_name: str, name: str, slot: str, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.SwiftVirtualNetwork

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

slot

str

Required

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

cls

callable

A custom type or function that will be passed the direct response

Returns

SwiftVirtualNetwork, or the result of cls(response)

Return type

SwiftVirtualNetwork

Exceptions

HttpResponseError

get_triggered_web_job

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

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

async get_triggered_web_job(resource_group_name: str, name: str, web_job_name: str, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.TriggeredWebJob

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Site name.

web_job_name

str

Required

Name of Web Job.

cls

callable

A custom type or function that will be passed the direct response

Returns

TriggeredWebJob, or the result of cls(response)

Return type

TriggeredWebJob

Exceptions

HttpResponseError

get_triggered_web_job_history

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

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

async get_triggered_web_job_history(resource_group_name: str, name: str, web_job_name: str, id: str, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.TriggeredJobHistory

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Site name.

web_job_name

str

Required

Name of Web Job.

id

str

Required

History ID.

cls

callable

A custom type or function that will be passed the direct response

Returns

TriggeredJobHistory, or the result of cls(response)

Return type

TriggeredJobHistory

Exceptions

HttpResponseError

get_triggered_web_job_history_slot

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

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

async get_triggered_web_job_history_slot(resource_group_name: str, name: str, web_job_name: str, id: str, slot: str, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.TriggeredJobHistory

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Site name.

web_job_name

str

Required

Name of Web Job.

id

str

Required

History ID.

slot

str

Required

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

cls

callable

A custom type or function that will be passed the direct response

Returns

TriggeredJobHistory, or the result of cls(response)

Return type

TriggeredJobHistory

Exceptions

HttpResponseError

get_triggered_web_job_slot

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

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

async get_triggered_web_job_slot(resource_group_name: str, name: str, web_job_name: str, slot: str, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.TriggeredWebJob

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Site name.

web_job_name

str

Required

Name of Web Job.

slot

str

Required

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

cls

callable

A custom type or function that will be passed the direct response

Returns

TriggeredWebJob, or the result of cls(response)

Return type

TriggeredWebJob

Exceptions

HttpResponseError

get_vnet_connection

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

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

async get_vnet_connection(resource_group_name: str, name: str, vnet_name: str, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.VnetInfo

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

vnet_name

str

Required

Name of the virtual network.

cls

callable

A custom type or function that will be passed the direct response

Returns

VnetInfo, or the result of cls(response)

Return type

VnetInfo

Exceptions

HttpResponseError

get_vnet_connection_gateway

Gets an app's Virtual Network gateway.

Description for Gets an app's Virtual Network gateway.

async get_vnet_connection_gateway(resource_group_name: str, name: str, vnet_name: str, gateway_name: str, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.VnetGateway

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

vnet_name

str

Required

Name of the Virtual Network.

gateway_name

str

Required

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

cls

callable

A custom type or function that will be passed the direct response

Returns

VnetGateway, or the result of cls(response)

Return type

VnetGateway

Exceptions

HttpResponseError

get_vnet_connection_gateway_slot

Gets an app's Virtual Network gateway.

Description for Gets an app's Virtual Network gateway.

async get_vnet_connection_gateway_slot(resource_group_name: str, name: str, vnet_name: str, gateway_name: str, slot: str, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.VnetGateway

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

vnet_name

str

Required

Name of the Virtual Network.

gateway_name

str

Required

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

slot

str

Required

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

cls

callable

A custom type or function that will be passed the direct response

Returns

VnetGateway, or the result of cls(response)

Return type

VnetGateway

Exceptions

HttpResponseError

get_vnet_connection_slot

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

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

async get_vnet_connection_slot(resource_group_name: str, name: str, vnet_name: str, slot: str, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.VnetInfo

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

vnet_name

str

Required

Name of the virtual network.

slot

str

Required

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

cls

callable

A custom type or function that will be passed the direct response

Returns

VnetInfo, or the result of cls(response)

Return type

VnetInfo

Exceptions

HttpResponseError

get_web_job

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

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

async get_web_job(resource_group_name: str, name: str, web_job_name: str, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.WebJob

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Site name.

web_job_name

str

Required

Name of the web job.

cls

callable

A custom type or function that will be passed the direct response

Returns

WebJob, or the result of cls(response)

Return type

WebJob

Exceptions

HttpResponseError

get_web_job_slot

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

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

async get_web_job_slot(resource_group_name: str, name: str, web_job_name: str, slot: str, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.WebJob

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Site name.

web_job_name

str

Required

Name of the web job.

slot

str

Required

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

cls

callable

A custom type or function that will be passed the direct response

Returns

WebJob, or the result of cls(response)

Return type

WebJob

Exceptions

HttpResponseError

get_web_site_container_logs

Gets the last lines of docker logs for the given site.

Description for Gets the last lines of docker logs for the given site.

async get_web_site_container_logs(resource_group_name: str, name: str, **kwargs: Any) -> Optional[IO]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of web app.

cls

callable

A custom type or function that will be passed the direct response

Returns

IO, or the result of cls(response)

Return type

<xref:IO>,

None

Exceptions

HttpResponseError

get_web_site_container_logs_slot

Gets the last lines of docker logs for the given site.

Description for Gets the last lines of docker logs for the given site.

async get_web_site_container_logs_slot(resource_group_name: str, name: str, slot: str, **kwargs: Any) -> Optional[IO]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of web app.

slot

str

Required

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

cls

callable

A custom type or function that will be passed the direct response

Returns

IO, or the result of cls(response)

Return type

<xref:IO>,

None

Exceptions

HttpResponseError

is_cloneable

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

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

async is_cloneable(resource_group_name: str, name: str, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.SiteCloneability

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

cls

callable

A custom type or function that will be passed the direct response

Returns

SiteCloneability, or the result of cls(response)

Return type

SiteCloneability

Exceptions

HttpResponseError

is_cloneable_slot

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

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

async is_cloneable_slot(resource_group_name: str, name: str, slot: str, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.SiteCloneability

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

slot

str

Required

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

cls

callable

A custom type or function that will be passed the direct response

Returns

SiteCloneability, or the result of cls(response)

Return type

SiteCloneability

Exceptions

HttpResponseError

list

Get all apps for a subscription.

Description for Get all apps for a subscription.

list(**kwargs: Any) -> AsyncIterable[azure.mgmt.web.v2021_01_15.models._models_py3.WebAppCollection]

Parameters

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either WebAppCollection or the result of cls(response)

Return type

AsyncItemPaged[WebAppCollection]

Exceptions

HttpResponseError

list_application_settings

Gets the application settings of an app.

Description for Gets the application settings of an app.

async list_application_settings(resource_group_name: str, name: str, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.StringDictionary

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

cls

callable

A custom type or function that will be passed the direct response

Returns

StringDictionary, or the result of cls(response)

Return type

StringDictionary

Exceptions

HttpResponseError

list_application_settings_slot

Gets the application settings of an app.

Description for Gets the application settings of an app.

async list_application_settings_slot(resource_group_name: str, name: str, slot: str, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.StringDictionary

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

slot

str

Required

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

cls

callable

A custom type or function that will be passed the direct response

Returns

StringDictionary, or the result of cls(response)

Return type

StringDictionary

Exceptions

HttpResponseError

list_azure_storage_accounts

Gets the Azure storage account configurations of an app.

Description for Gets the Azure storage account configurations of an app.

async list_azure_storage_accounts(resource_group_name: str, name: str, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.AzureStoragePropertyDictionaryResource

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

cls

callable

A custom type or function that will be passed the direct response

Returns

AzureStoragePropertyDictionaryResource, or the result of cls(response)

Return type

AzureStoragePropertyDictionaryResource

Exceptions

HttpResponseError

list_azure_storage_accounts_slot

Gets the Azure storage account configurations of an app.

Description for Gets the Azure storage account configurations of an app.

async list_azure_storage_accounts_slot(resource_group_name: str, name: str, slot: str, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.AzureStoragePropertyDictionaryResource

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

slot

str

Required

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

cls

callable

A custom type or function that will be passed the direct response

Returns

AzureStoragePropertyDictionaryResource, or the result of cls(response)

Return type

AzureStoragePropertyDictionaryResource

Exceptions

HttpResponseError

list_backup_status_secrets

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

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

async list_backup_status_secrets(resource_group_name: str, name: str, backup_id: str, request: azure.mgmt.web.v2021_01_15.models._models_py3.BackupRequest, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.BackupItem

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of web app.

backup_id

str

Required

ID of backup.

request

BackupRequest

Required

Information on backup request.

cls

callable

A custom type or function that will be passed the direct response

Returns

BackupItem, or the result of cls(response)

Return type

BackupItem

Exceptions

HttpResponseError

list_backup_status_secrets_slot

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

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

async list_backup_status_secrets_slot(resource_group_name: str, name: str, backup_id: str, slot: str, request: azure.mgmt.web.v2021_01_15.models._models_py3.BackupRequest, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.BackupItem

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of web app.

backup_id

str

Required

ID of backup.

slot

str

Required

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

request

BackupRequest

Required

Information on backup request.

cls

callable

A custom type or function that will be passed the direct response

Returns

BackupItem, or the result of cls(response)

Return type

BackupItem

Exceptions

HttpResponseError

list_backups

Gets existing backups of an app.

Description for Gets existing backups of an app.

list_backups(resource_group_name: str, name: str, **kwargs: Any) -> AsyncIterable[azure.mgmt.web.v2021_01_15.models._models_py3.BackupItemCollection]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either BackupItemCollection or the result of cls(response)

Return type

AsyncItemPaged[BackupItemCollection]

Exceptions

HttpResponseError

list_backups_slot

Gets existing backups of an app.

Description for Gets existing backups of an app.

list_backups_slot(resource_group_name: str, name: str, slot: str, **kwargs: Any) -> AsyncIterable[azure.mgmt.web.v2021_01_15.models._models_py3.BackupItemCollection]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

slot

str

Required

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

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either BackupItemCollection or the result of cls(response)

Return type

AsyncItemPaged[BackupItemCollection]

Exceptions

HttpResponseError

list_basic_publishing_credentials_policies

Returns whether Scm basic auth is allowed and whether Ftp is allowed for a given site.

Description for Returns whether Scm basic auth is allowed and whether Ftp is allowed for a given site.

list_basic_publishing_credentials_policies(resource_group_name: str, name: str, **kwargs: Any) -> AsyncIterable[azure.mgmt.web.v2021_01_15.models._models_py3.PublishingCredentialsPoliciesCollection]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either PublishingCredentialsPoliciesCollection or the result of cls(response)

Return type

AsyncItemPaged[PublishingCredentialsPoliciesCollection]

Exceptions

HttpResponseError

list_basic_publishing_credentials_policies_slot

Returns whether Scm basic auth is allowed and whether Ftp is allowed for a given site.

Description for Returns whether Scm basic auth is allowed and whether Ftp is allowed for a given site.

list_basic_publishing_credentials_policies_slot(resource_group_name: str, name: str, slot: str, **kwargs: Any) -> AsyncIterable[azure.mgmt.web.v2021_01_15.models._models_py3.PublishingCredentialsPoliciesCollection]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

slot

str

Required

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either PublishingCredentialsPoliciesCollection or the result of cls(response)

Return type

AsyncItemPaged[PublishingCredentialsPoliciesCollection]

Exceptions

HttpResponseError

list_by_resource_group

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

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

list_by_resource_group(resource_group_name: str, include_slots: Optional[bool] = None, **kwargs: Any) -> AsyncIterable[azure.mgmt.web.v2021_01_15.models._models_py3.WebAppCollection]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

include_slots

bool

default value: None

Specify <strong>true</strong> to include deployment slots in results. The default is false, which only gives you the production slot of all apps.

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either WebAppCollection or the result of cls(response)

Return type

AsyncItemPaged[WebAppCollection]

Exceptions

HttpResponseError

list_configuration_snapshot_info

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

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

list_configuration_snapshot_info(resource_group_name: str, name: str, **kwargs: Any) -> AsyncIterable[azure.mgmt.web.v2021_01_15.models._models_py3.SiteConfigurationSnapshotInfoCollection]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either SiteConfigurationSnapshotInfoCollection or the result of cls(response)

Return type

AsyncItemPaged[SiteConfigurationSnapshotInfoCollection]

Exceptions

HttpResponseError

list_configuration_snapshot_info_slot

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

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

list_configuration_snapshot_info_slot(resource_group_name: str, name: str, slot: str, **kwargs: Any) -> AsyncIterable[azure.mgmt.web.v2021_01_15.models._models_py3.SiteConfigurationSnapshotInfoCollection]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

slot

str

Required

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

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either SiteConfigurationSnapshotInfoCollection or the result of cls(response)

Return type

AsyncItemPaged[SiteConfigurationSnapshotInfoCollection]

Exceptions

HttpResponseError

list_configurations

List the configurations of an app.

Description for List the configurations of an app.

list_configurations(resource_group_name: str, name: str, **kwargs: Any) -> AsyncIterable[azure.mgmt.web.v2021_01_15.models._models_py3.SiteConfigResourceCollection]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either SiteConfigResourceCollection or the result of cls(response)

Return type

AsyncItemPaged[SiteConfigResourceCollection]

Exceptions

HttpResponseError

list_configurations_slot

List the configurations of an app.

Description for List the configurations of an app.

list_configurations_slot(resource_group_name: str, name: str, slot: str, **kwargs: Any) -> AsyncIterable[azure.mgmt.web.v2021_01_15.models._models_py3.SiteConfigResourceCollection]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

slot

str

Required

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

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either SiteConfigResourceCollection or the result of cls(response)

Return type

AsyncItemPaged[SiteConfigResourceCollection]

Exceptions

HttpResponseError

list_connection_strings

Gets the connection strings of an app.

Description for Gets the connection strings of an app.

async list_connection_strings(resource_group_name: str, name: str, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.ConnectionStringDictionary

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

cls

callable

A custom type or function that will be passed the direct response

Returns

ConnectionStringDictionary, or the result of cls(response)

Return type

ConnectionStringDictionary

Exceptions

HttpResponseError

list_connection_strings_slot

Gets the connection strings of an app.

Description for Gets the connection strings of an app.

async list_connection_strings_slot(resource_group_name: str, name: str, slot: str, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.ConnectionStringDictionary

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

slot

str

Required

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

cls

callable

A custom type or function that will be passed the direct response

Returns

ConnectionStringDictionary, or the result of cls(response)

Return type

ConnectionStringDictionary

Exceptions

HttpResponseError

list_continuous_web_jobs

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

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

list_continuous_web_jobs(resource_group_name: str, name: str, **kwargs: Any) -> AsyncIterable[azure.mgmt.web.v2021_01_15.models._models_py3.ContinuousWebJobCollection]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Site name.

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either ContinuousWebJobCollection or the result of cls(response)

Return type

AsyncItemPaged[ContinuousWebJobCollection]

Exceptions

HttpResponseError

list_continuous_web_jobs_slot

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

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

list_continuous_web_jobs_slot(resource_group_name: str, name: str, slot: str, **kwargs: Any) -> AsyncIterable[azure.mgmt.web.v2021_01_15.models._models_py3.ContinuousWebJobCollection]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Site name.

slot

str

Required

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

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either ContinuousWebJobCollection or the result of cls(response)

Return type

AsyncItemPaged[ContinuousWebJobCollection]

Exceptions

HttpResponseError

list_deployment_log

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

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

async list_deployment_log(resource_group_name: str, name: str, id: str, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.Deployment

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

id

str

Required

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

cls

callable

A custom type or function that will be passed the direct response

Returns

Deployment, or the result of cls(response)

Return type

Deployment

Exceptions

HttpResponseError

list_deployment_log_slot

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

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

async list_deployment_log_slot(resource_group_name: str, name: str, id: str, slot: str, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.Deployment

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

id

str

Required

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

slot

str

Required

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

cls

callable

A custom type or function that will be passed the direct response

Returns

Deployment, or the result of cls(response)

Return type

Deployment

Exceptions

HttpResponseError

list_deployments

List deployments for an app, or a deployment slot.

Description for List deployments for an app, or a deployment slot.

list_deployments(resource_group_name: str, name: str, **kwargs: Any) -> AsyncIterable[azure.mgmt.web.v2021_01_15.models._models_py3.DeploymentCollection]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either DeploymentCollection or the result of cls(response)

Return type

AsyncItemPaged[DeploymentCollection]

Exceptions

HttpResponseError

list_deployments_slot

List deployments for an app, or a deployment slot.

Description for List deployments for an app, or a deployment slot.

list_deployments_slot(resource_group_name: str, name: str, slot: str, **kwargs: Any) -> AsyncIterable[azure.mgmt.web.v2021_01_15.models._models_py3.DeploymentCollection]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

slot

str

Required

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

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either DeploymentCollection or the result of cls(response)

Return type

AsyncItemPaged[DeploymentCollection]

Exceptions

HttpResponseError

list_domain_ownership_identifiers

Lists ownership identifiers for domain associated with web app.

Description for Lists ownership identifiers for domain associated with web app.

list_domain_ownership_identifiers(resource_group_name: str, name: str, **kwargs: Any) -> AsyncIterable[azure.mgmt.web.v2021_01_15.models._models_py3.IdentifierCollection]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either IdentifierCollection or the result of cls(response)

Return type

AsyncItemPaged[IdentifierCollection]

Exceptions

HttpResponseError

list_domain_ownership_identifiers_slot

Lists ownership identifiers for domain associated with web app.

Description for Lists ownership identifiers for domain associated with web app.

list_domain_ownership_identifiers_slot(resource_group_name: str, name: str, slot: str, **kwargs: Any) -> AsyncIterable[azure.mgmt.web.v2021_01_15.models._models_py3.IdentifierCollection]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

slot

str

Required

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

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either IdentifierCollection or the result of cls(response)

Return type

AsyncItemPaged[IdentifierCollection]

Exceptions

HttpResponseError

list_function_keys

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

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

async list_function_keys(resource_group_name: str, name: str, function_name: str, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.StringDictionary

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Site name.

function_name

str

Required

Function name.

cls

callable

A custom type or function that will be passed the direct response

Returns

StringDictionary, or the result of cls(response)

Return type

StringDictionary

Exceptions

HttpResponseError

list_function_keys_slot

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

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

async list_function_keys_slot(resource_group_name: str, name: str, function_name: str, slot: str, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.StringDictionary

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Site name.

function_name

str

Required

Function name.

slot

str

Required

Name of the deployment slot.

cls

callable

A custom type or function that will be passed the direct response

Returns

StringDictionary, or the result of cls(response)

Return type

StringDictionary

Exceptions

HttpResponseError

list_function_secrets

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

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

async list_function_secrets(resource_group_name: str, name: str, function_name: str, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.FunctionSecrets

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Site name.

function_name

str

Required

Function name.

cls

callable

A custom type or function that will be passed the direct response

Returns

FunctionSecrets, or the result of cls(response)

Return type

FunctionSecrets

Exceptions

HttpResponseError

list_function_secrets_slot

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

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

async list_function_secrets_slot(resource_group_name: str, name: str, function_name: str, slot: str, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.FunctionSecrets

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Site name.

function_name

str

Required

Function name.

slot

str

Required

Name of the deployment slot.

cls

callable

A custom type or function that will be passed the direct response

Returns

FunctionSecrets, or the result of cls(response)

Return type

FunctionSecrets

Exceptions

HttpResponseError

list_functions

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

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

list_functions(resource_group_name: str, name: str, **kwargs: Any) -> AsyncIterable[azure.mgmt.web.v2021_01_15.models._models_py3.FunctionEnvelopeCollection]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Site name.

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either FunctionEnvelopeCollection or the result of cls(response)

Return type

AsyncItemPaged[FunctionEnvelopeCollection]

Exceptions

HttpResponseError

list_host_keys

Get host secrets for a function app.

Description for Get host secrets for a function app.

async list_host_keys(resource_group_name: str, name: str, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.HostKeys

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Site name.

cls

callable

A custom type or function that will be passed the direct response

Returns

HostKeys, or the result of cls(response)

Return type

HostKeys

Exceptions

HttpResponseError

list_host_keys_slot

Get host secrets for a function app.

Description for Get host secrets for a function app.

async list_host_keys_slot(resource_group_name: str, name: str, slot: str, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.HostKeys

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Site name.

slot

str

Required

Name of the deployment slot.

cls

callable

A custom type or function that will be passed the direct response

Returns

HostKeys, or the result of cls(response)

Return type

HostKeys

Exceptions

HttpResponseError

list_host_name_bindings

Get hostname bindings for an app or a deployment slot.

Description for Get hostname bindings for an app or a deployment slot.

list_host_name_bindings(resource_group_name: str, name: str, **kwargs: Any) -> AsyncIterable[azure.mgmt.web.v2021_01_15.models._models_py3.HostNameBindingCollection]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either HostNameBindingCollection or the result of cls(response)

Return type

AsyncItemPaged[HostNameBindingCollection]

Exceptions

HttpResponseError

list_host_name_bindings_slot

Get hostname bindings for an app or a deployment slot.

Description for Get hostname bindings for an app or a deployment slot.

list_host_name_bindings_slot(resource_group_name: str, name: str, slot: str, **kwargs: Any) -> AsyncIterable[azure.mgmt.web.v2021_01_15.models._models_py3.HostNameBindingCollection]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

slot

str

Required

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

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either HostNameBindingCollection or the result of cls(response)

Return type

AsyncItemPaged[HostNameBindingCollection]

Exceptions

HttpResponseError

list_hybrid_connections

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

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

async list_hybrid_connections(resource_group_name: str, name: str, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.HybridConnection

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

The name of the web app.

cls

callable

A custom type or function that will be passed the direct response

Returns

HybridConnection, or the result of cls(response)

Return type

HybridConnection

Exceptions

HttpResponseError

list_hybrid_connections_slot

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

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

async list_hybrid_connections_slot(resource_group_name: str, name: str, slot: str, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.HybridConnection

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

The name of the web app.

slot

str

Required

The name of the slot for the web app.

cls

callable

A custom type or function that will be passed the direct response

Returns

HybridConnection, or the result of cls(response)

Return type

HybridConnection

Exceptions

HttpResponseError

list_instance_functions_slot

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

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

list_instance_functions_slot(resource_group_name: str, name: str, slot: str, **kwargs: Any) -> AsyncIterable[azure.mgmt.web.v2021_01_15.models._models_py3.FunctionEnvelopeCollection]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Site name.

slot

str

Required

Name of the deployment slot.

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either FunctionEnvelopeCollection or the result of cls(response)

Return type

AsyncItemPaged[FunctionEnvelopeCollection]

Exceptions

HttpResponseError

list_instance_identifiers

Gets all scale-out instances of an app.

Description for Gets all scale-out instances of an app.

list_instance_identifiers(resource_group_name: str, name: str, **kwargs: Any) -> AsyncIterable[azure.mgmt.web.v2021_01_15.models._models_py3.WebAppInstanceStatusCollection]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either WebAppInstanceStatusCollection or the result of cls(response)

Return type

AsyncItemPaged[WebAppInstanceStatusCollection]

Exceptions

HttpResponseError

list_instance_identifiers_slot

Gets all scale-out instances of an app.

Description for Gets all scale-out instances of an app.

list_instance_identifiers_slot(resource_group_name: str, name: str, slot: str, **kwargs: Any) -> AsyncIterable[azure.mgmt.web.v2021_01_15.models._models_py3.WebAppInstanceStatusCollection]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

slot

str

Required

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

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either WebAppInstanceStatusCollection or the result of cls(response)

Return type

AsyncItemPaged[WebAppInstanceStatusCollection]

Exceptions

HttpResponseError

list_instance_process_modules

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

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

list_instance_process_modules(resource_group_name: str, name: str, process_id: str, instance_id: str, **kwargs: Any) -> AsyncIterable[azure.mgmt.web.v2021_01_15.models._models_py3.ProcessModuleInfoCollection]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Site name.

process_id

str

Required

PID.

instance_id

str

Required

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".

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either ProcessModuleInfoCollection or the result of cls(response)

Return type

AsyncItemPaged[ProcessModuleInfoCollection]

Exceptions

HttpResponseError

list_instance_process_modules_slot

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

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

list_instance_process_modules_slot(resource_group_name: str, name: str, process_id: str, slot: str, instance_id: str, **kwargs: Any) -> AsyncIterable[azure.mgmt.web.v2021_01_15.models._models_py3.ProcessModuleInfoCollection]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Site name.

process_id

str

Required

PID.

slot

str

Required

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

instance_id

str

Required

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".

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either ProcessModuleInfoCollection or the result of cls(response)

Return type

AsyncItemPaged[ProcessModuleInfoCollection]

Exceptions

HttpResponseError

list_instance_process_threads

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

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

list_instance_process_threads(resource_group_name: str, name: str, process_id: str, instance_id: str, **kwargs: Any) -> AsyncIterable[azure.mgmt.web.v2021_01_15.models._models_py3.ProcessThreadInfoCollection]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Site name.

process_id

str

Required

PID.

instance_id

str

Required

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".

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either ProcessThreadInfoCollection or the result of cls(response)

Return type

AsyncItemPaged[ProcessThreadInfoCollection]

Exceptions

HttpResponseError

list_instance_process_threads_slot

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

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

list_instance_process_threads_slot(resource_group_name: str, name: str, process_id: str, slot: str, instance_id: str, **kwargs: Any) -> AsyncIterable[azure.mgmt.web.v2021_01_15.models._models_py3.ProcessThreadInfoCollection]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Site name.

process_id

str

Required

PID.

slot

str

Required

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

instance_id

str

Required

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".

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either ProcessThreadInfoCollection or the result of cls(response)

Return type

AsyncItemPaged[ProcessThreadInfoCollection]

Exceptions

HttpResponseError

list_instance_processes

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

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_instance_processes(resource_group_name: str, name: str, instance_id: str, **kwargs: Any) -> AsyncIterable[azure.mgmt.web.v2021_01_15.models._models_py3.ProcessInfoCollection]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Site name.

instance_id

str

Required

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".

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either ProcessInfoCollection or the result of cls(response)

Return type

AsyncItemPaged[ProcessInfoCollection]

Exceptions

HttpResponseError

list_instance_processes_slot

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

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_instance_processes_slot(resource_group_name: str, name: str, slot: str, instance_id: str, **kwargs: Any) -> AsyncIterable[azure.mgmt.web.v2021_01_15.models._models_py3.ProcessInfoCollection]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Site name.

slot

str

Required

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

instance_id

str

Required

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".

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either ProcessInfoCollection or the result of cls(response)

Return type

AsyncItemPaged[ProcessInfoCollection]

Exceptions

HttpResponseError

list_metadata

Gets the metadata of an app.

Description for Gets the metadata of an app.

async list_metadata(resource_group_name: str, name: str, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.StringDictionary

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

cls

callable

A custom type or function that will be passed the direct response

Returns

StringDictionary, or the result of cls(response)

Return type

StringDictionary

Exceptions

HttpResponseError

list_metadata_slot

Gets the metadata of an app.

Description for Gets the metadata of an app.

async list_metadata_slot(resource_group_name: str, name: str, slot: str, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.StringDictionary

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

slot

str

Required

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

cls

callable

A custom type or function that will be passed the direct response

Returns

StringDictionary, or the result of cls(response)

Return type

StringDictionary

Exceptions

HttpResponseError

list_network_features

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

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

async list_network_features(resource_group_name: str, name: str, view: str, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.NetworkFeatures

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

view

str

Required

The type of view. Only "summary" is supported at this time.

cls

callable

A custom type or function that will be passed the direct response

Returns

NetworkFeatures, or the result of cls(response)

Return type

NetworkFeatures

Exceptions

HttpResponseError

list_network_features_slot

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

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

async list_network_features_slot(resource_group_name: str, name: str, view: str, slot: str, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.NetworkFeatures

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

view

str

Required

The type of view. Only "summary" is supported at this time.

slot

str

Required

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

cls

callable

A custom type or function that will be passed the direct response

Returns

NetworkFeatures, or the result of cls(response)

Return type

NetworkFeatures

Exceptions

HttpResponseError

list_perf_mon_counters

Gets perfmon counters for web app.

Description for Gets perfmon counters for web app.

list_perf_mon_counters(resource_group_name: str, name: str, filter: Optional[str] = None, **kwargs: Any) -> AsyncIterable[azure.mgmt.web.v2021_01_15.models._models_py3.PerfMonCounterCollection]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of web app.

filter

str

default value: None

Return only usages/metrics specified in the filter. Filter conforms to odata syntax. Example: $filter=(startTime eq 2014-01-01T00:00:00Z and endTime eq 2014-12-31T23:59:59Z and timeGrain eq duration'[Hour|Minute|Day]'.

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either PerfMonCounterCollection or the result of cls(response)

Return type

AsyncItemPaged[PerfMonCounterCollection]

Exceptions

HttpResponseError

list_perf_mon_counters_slot

Gets perfmon counters for web app.

Description for Gets perfmon counters for web app.

list_perf_mon_counters_slot(resource_group_name: str, name: str, slot: str, filter: Optional[str] = None, **kwargs: Any) -> AsyncIterable[azure.mgmt.web.v2021_01_15.models._models_py3.PerfMonCounterCollection]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of web app.

slot

str

Required

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

filter

str

default value: None

Return only usages/metrics specified in the filter. Filter conforms to odata syntax. Example: $filter=(startTime eq 2014-01-01T00:00:00Z and endTime eq 2014-12-31T23:59:59Z and timeGrain eq duration'[Hour|Minute|Day]'.

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either PerfMonCounterCollection or the result of cls(response)

Return type

AsyncItemPaged[PerfMonCounterCollection]

Exceptions

HttpResponseError

list_premier_add_ons

Gets the premier add-ons of an app.

Description for Gets the premier add-ons of an app.

async list_premier_add_ons(resource_group_name: str, name: str, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.PremierAddOn

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

cls

callable

A custom type or function that will be passed the direct response

Returns

PremierAddOn, or the result of cls(response)

Return type

PremierAddOn

Exceptions

HttpResponseError

list_premier_add_ons_slot

Gets the premier add-ons of an app.

Description for Gets the premier add-ons of an app.

async list_premier_add_ons_slot(resource_group_name: str, name: str, slot: str, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.PremierAddOn

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

slot

str

Required

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

cls

callable

A custom type or function that will be passed the direct response

Returns

PremierAddOn, or the result of cls(response)

Return type

PremierAddOn

Exceptions

HttpResponseError

list_process_modules

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

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

list_process_modules(resource_group_name: str, name: str, process_id: str, **kwargs: Any) -> AsyncIterable[azure.mgmt.web.v2021_01_15.models._models_py3.ProcessModuleInfoCollection]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Site name.

process_id

str

Required

PID.

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either ProcessModuleInfoCollection or the result of cls(response)

Return type

AsyncItemPaged[ProcessModuleInfoCollection]

Exceptions

HttpResponseError

list_process_modules_slot

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

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

list_process_modules_slot(resource_group_name: str, name: str, process_id: str, slot: str, **kwargs: Any) -> AsyncIterable[azure.mgmt.web.v2021_01_15.models._models_py3.ProcessModuleInfoCollection]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Site name.

process_id

str

Required

PID.

slot

str

Required

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

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either ProcessModuleInfoCollection or the result of cls(response)

Return type

AsyncItemPaged[ProcessModuleInfoCollection]

Exceptions

HttpResponseError

list_process_threads

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

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

list_process_threads(resource_group_name: str, name: str, process_id: str, **kwargs: Any) -> AsyncIterable[azure.mgmt.web.v2021_01_15.models._models_py3.ProcessThreadInfoCollection]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Site name.

process_id

str

Required

PID.

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either ProcessThreadInfoCollection or the result of cls(response)

Return type

AsyncItemPaged[ProcessThreadInfoCollection]

Exceptions

HttpResponseError

list_process_threads_slot

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

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

list_process_threads_slot(resource_group_name: str, name: str, process_id: str, slot: str, **kwargs: Any) -> AsyncIterable[azure.mgmt.web.v2021_01_15.models._models_py3.ProcessThreadInfoCollection]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Site name.

process_id

str

Required

PID.

slot

str

Required

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

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either ProcessThreadInfoCollection or the result of cls(response)

Return type

AsyncItemPaged[ProcessThreadInfoCollection]

Exceptions

HttpResponseError

list_processes

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

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_processes(resource_group_name: str, name: str, **kwargs: Any) -> AsyncIterable[azure.mgmt.web.v2021_01_15.models._models_py3.ProcessInfoCollection]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Site name.

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either ProcessInfoCollection or the result of cls(response)

Return type

AsyncItemPaged[ProcessInfoCollection]

Exceptions

HttpResponseError

list_processes_slot

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

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_processes_slot(resource_group_name: str, name: str, slot: str, **kwargs: Any) -> AsyncIterable[azure.mgmt.web.v2021_01_15.models._models_py3.ProcessInfoCollection]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Site name.

slot

str

Required

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

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either ProcessInfoCollection or the result of cls(response)

Return type

AsyncItemPaged[ProcessInfoCollection]

Exceptions

HttpResponseError

list_public_certificates

Get public certificates for an app or a deployment slot.

Description for Get public certificates for an app or a deployment slot.

list_public_certificates(resource_group_name: str, name: str, **kwargs: Any) -> AsyncIterable[azure.mgmt.web.v2021_01_15.models._models_py3.PublicCertificateCollection]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either PublicCertificateCollection or the result of cls(response)

Return type

AsyncItemPaged[PublicCertificateCollection]

Exceptions

HttpResponseError

list_public_certificates_slot

Get public certificates for an app or a deployment slot.

Description for Get public certificates for an app or a deployment slot.

list_public_certificates_slot(resource_group_name: str, name: str, slot: str, **kwargs: Any) -> AsyncIterable[azure.mgmt.web.v2021_01_15.models._models_py3.PublicCertificateCollection]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

slot

str

Required

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

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either PublicCertificateCollection or the result of cls(response)

Return type

AsyncItemPaged[PublicCertificateCollection]

Exceptions

HttpResponseError

list_publishing_profile_xml_with_secrets

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

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

async list_publishing_profile_xml_with_secrets(resource_group_name: str, name: str, publishing_profile_options: azure.mgmt.web.v2021_01_15.models._models_py3.CsmPublishingProfileOptions, **kwargs: Any) -> IO

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

publishing_profile_options

CsmPublishingProfileOptions

Required

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

cls

callable

A custom type or function that will be passed the direct response

Returns

IO, or the result of cls(response)

Return type

<xref:IO>

Exceptions

HttpResponseError

list_publishing_profile_xml_with_secrets_slot

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

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

async list_publishing_profile_xml_with_secrets_slot(resource_group_name: str, name: str, slot: str, publishing_profile_options: azure.mgmt.web.v2021_01_15.models._models_py3.CsmPublishingProfileOptions, **kwargs: Any) -> IO

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

slot

str

Required

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

publishing_profile_options

CsmPublishingProfileOptions

Required

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

cls

callable

A custom type or function that will be passed the direct response

Returns

IO, or the result of cls(response)

Return type

<xref:IO>

Exceptions

HttpResponseError

list_relay_service_connections

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

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

async list_relay_service_connections(resource_group_name: str, name: str, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.RelayServiceConnectionEntity

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

cls

callable

A custom type or function that will be passed the direct response

Returns

RelayServiceConnectionEntity, or the result of cls(response)

Return type

RelayServiceConnectionEntity

Exceptions

HttpResponseError

list_relay_service_connections_slot

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

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

async list_relay_service_connections_slot(resource_group_name: str, name: str, slot: str, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.RelayServiceConnectionEntity

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

slot

str

Required

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

cls

callable

A custom type or function that will be passed the direct response

Returns

RelayServiceConnectionEntity, or the result of cls(response)

Return type

RelayServiceConnectionEntity

Exceptions

HttpResponseError

list_site_backups

Gets existing backups of an app.

Description for Gets existing backups of an app.

list_site_backups(resource_group_name: str, name: str, **kwargs: Any) -> AsyncIterable[azure.mgmt.web.v2021_01_15.models._models_py3.BackupItemCollection]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either BackupItemCollection or the result of cls(response)

Return type

AsyncItemPaged[BackupItemCollection]

Exceptions

HttpResponseError

list_site_backups_slot

Gets existing backups of an app.

Description for Gets existing backups of an app.

list_site_backups_slot(resource_group_name: str, name: str, slot: str, **kwargs: Any) -> AsyncIterable[azure.mgmt.web.v2021_01_15.models._models_py3.BackupItemCollection]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

slot

str

Required

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

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either BackupItemCollection or the result of cls(response)

Return type

AsyncItemPaged[BackupItemCollection]

Exceptions

HttpResponseError

list_site_extensions

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

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

list_site_extensions(resource_group_name: str, name: str, **kwargs: Any) -> AsyncIterable[azure.mgmt.web.v2021_01_15.models._models_py3.SiteExtensionInfoCollection]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Site name.

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either SiteExtensionInfoCollection or the result of cls(response)

Return type

AsyncItemPaged[SiteExtensionInfoCollection]

Exceptions

HttpResponseError

list_site_extensions_slot

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

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

list_site_extensions_slot(resource_group_name: str, name: str, slot: str, **kwargs: Any) -> AsyncIterable[azure.mgmt.web.v2021_01_15.models._models_py3.SiteExtensionInfoCollection]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Site name.

slot

str

Required

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

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either SiteExtensionInfoCollection or the result of cls(response)

Return type

AsyncItemPaged[SiteExtensionInfoCollection]

Exceptions

HttpResponseError

list_site_push_settings

Gets the Push settings associated with web app.

Description for Gets the Push settings associated with web app.

async list_site_push_settings(resource_group_name: str, name: str, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.PushSettings

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of web app.

cls

callable

A custom type or function that will be passed the direct response

Returns

PushSettings, or the result of cls(response)

Return type

PushSettings

Exceptions

HttpResponseError

list_site_push_settings_slot

Gets the Push settings associated with web app.

Description for Gets the Push settings associated with web app.

async list_site_push_settings_slot(resource_group_name: str, name: str, slot: str, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.PushSettings

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of web app.

slot

str

Required

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

cls

callable

A custom type or function that will be passed the direct response

Returns

PushSettings, or the result of cls(response)

Return type

PushSettings

Exceptions

HttpResponseError

list_slot_configuration_names

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

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

async list_slot_configuration_names(resource_group_name: str, name: str, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.SlotConfigNamesResource

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

cls

callable

A custom type or function that will be passed the direct response

Returns

SlotConfigNamesResource, or the result of cls(response)

Return type

SlotConfigNamesResource

Exceptions

HttpResponseError

list_slot_differences_from_production

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

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

list_slot_differences_from_production(resource_group_name: str, name: str, slot_swap_entity: azure.mgmt.web.v2021_01_15.models._models_py3.CsmSlotEntity, **kwargs: Any) -> AsyncIterable[azure.mgmt.web.v2021_01_15.models._models_py3.SlotDifferenceCollection]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

slot_swap_entity

CsmSlotEntity

Required

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

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either SlotDifferenceCollection or the result of cls(response)

Return type

AsyncItemPaged[SlotDifferenceCollection]

Exceptions

HttpResponseError

list_slot_differences_slot

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

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

list_slot_differences_slot(resource_group_name: str, name: str, slot: str, slot_swap_entity: azure.mgmt.web.v2021_01_15.models._models_py3.CsmSlotEntity, **kwargs: Any) -> AsyncIterable[azure.mgmt.web.v2021_01_15.models._models_py3.SlotDifferenceCollection]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

slot

str

Required

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

slot_swap_entity

CsmSlotEntity

Required

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

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either SlotDifferenceCollection or the result of cls(response)

Return type

AsyncItemPaged[SlotDifferenceCollection]

Exceptions

HttpResponseError

list_slots

Gets an app's deployment slots.

Description for Gets an app's deployment slots.

list_slots(resource_group_name: str, name: str, **kwargs: Any) -> AsyncIterable[azure.mgmt.web.v2021_01_15.models._models_py3.WebAppCollection]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either WebAppCollection or the result of cls(response)

Return type

AsyncItemPaged[WebAppCollection]

Exceptions

HttpResponseError

list_snapshots

Returns all Snapshots to the user.

Description for Returns all Snapshots to the user.

list_snapshots(resource_group_name: str, name: str, **kwargs: Any) -> AsyncIterable[azure.mgmt.web.v2021_01_15.models._models_py3.SnapshotCollection]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Website Name.

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either SnapshotCollection or the result of cls(response)

Return type

AsyncItemPaged[SnapshotCollection]

Exceptions

HttpResponseError

list_snapshots_from_dr_secondary

Returns all Snapshots to the user from DRSecondary endpoint.

Description for Returns all Snapshots to the user from DRSecondary endpoint.

list_snapshots_from_dr_secondary(resource_group_name: str, name: str, **kwargs: Any) -> AsyncIterable[azure.mgmt.web.v2021_01_15.models._models_py3.SnapshotCollection]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Website Name.

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either SnapshotCollection or the result of cls(response)

Return type

AsyncItemPaged[SnapshotCollection]

Exceptions

HttpResponseError

list_snapshots_from_dr_secondary_slot

Returns all Snapshots to the user from DRSecondary endpoint.

Description for Returns all Snapshots to the user from DRSecondary endpoint.

list_snapshots_from_dr_secondary_slot(resource_group_name: str, name: str, slot: str, **kwargs: Any) -> AsyncIterable[azure.mgmt.web.v2021_01_15.models._models_py3.SnapshotCollection]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Website Name.

slot

str

Required

Website Slot.

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either SnapshotCollection or the result of cls(response)

Return type

AsyncItemPaged[SnapshotCollection]

Exceptions

HttpResponseError

list_snapshots_slot

Returns all Snapshots to the user.

Description for Returns all Snapshots to the user.

list_snapshots_slot(resource_group_name: str, name: str, slot: str, **kwargs: Any) -> AsyncIterable[azure.mgmt.web.v2021_01_15.models._models_py3.SnapshotCollection]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Website Name.

slot

str

Required

Website Slot.

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either SnapshotCollection or the result of cls(response)

Return type

AsyncItemPaged[SnapshotCollection]

Exceptions

HttpResponseError

list_sync_function_triggers

This is to allow calling via powershell and ARM template.

Description for This is to allow calling via powershell and ARM template.

async list_sync_function_triggers(resource_group_name: str, name: str, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.FunctionSecrets

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

cls

callable

A custom type or function that will be passed the direct response

Returns

FunctionSecrets, or the result of cls(response)

Return type

FunctionSecrets

Exceptions

HttpResponseError

list_sync_function_triggers_slot

This is to allow calling via powershell and ARM template.

Description for This is to allow calling via powershell and ARM template.

async list_sync_function_triggers_slot(resource_group_name: str, name: str, slot: str, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.FunctionSecrets

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

slot

str

Required

Name of the deployment slot.

cls

callable

A custom type or function that will be passed the direct response

Returns

FunctionSecrets, or the result of cls(response)

Return type

FunctionSecrets

Exceptions

HttpResponseError

list_sync_status

This is to allow calling via powershell and ARM template.

Description for This is to allow calling via powershell and ARM template.

async list_sync_status(resource_group_name: str, name: str, **kwargs: Any) -> None

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

cls

callable

A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Exceptions

HttpResponseError

list_sync_status_slot

This is to allow calling via powershell and ARM template.

Description for This is to allow calling via powershell and ARM template.

async list_sync_status_slot(resource_group_name: str, name: str, slot: str, **kwargs: Any) -> None

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

slot

str

Required

Name of the deployment slot.

cls

callable

A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Exceptions

HttpResponseError

list_triggered_web_job_history

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

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

list_triggered_web_job_history(resource_group_name: str, name: str, web_job_name: str, **kwargs: Any) -> AsyncIterable[azure.mgmt.web.v2021_01_15.models._models_py3.TriggeredJobHistoryCollection]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Site name.

web_job_name

str

Required

Name of Web Job.

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either TriggeredJobHistoryCollection or the result of cls(response)

Return type

AsyncItemPaged[TriggeredJobHistoryCollection]

Exceptions

HttpResponseError

list_triggered_web_job_history_slot

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

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

list_triggered_web_job_history_slot(resource_group_name: str, name: str, web_job_name: str, slot: str, **kwargs: Any) -> AsyncIterable[azure.mgmt.web.v2021_01_15.models._models_py3.TriggeredJobHistoryCollection]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Site name.

web_job_name

str

Required

Name of Web Job.

slot

str

Required

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

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either TriggeredJobHistoryCollection or the result of cls(response)

Return type

AsyncItemPaged[TriggeredJobHistoryCollection]

Exceptions

HttpResponseError

list_triggered_web_jobs

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

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

list_triggered_web_jobs(resource_group_name: str, name: str, **kwargs: Any) -> AsyncIterable[azure.mgmt.web.v2021_01_15.models._models_py3.TriggeredWebJobCollection]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Site name.

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either TriggeredWebJobCollection or the result of cls(response)

Return type

AsyncItemPaged[TriggeredWebJobCollection]

Exceptions

HttpResponseError

list_triggered_web_jobs_slot

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

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

list_triggered_web_jobs_slot(resource_group_name: str, name: str, slot: str, **kwargs: Any) -> AsyncIterable[azure.mgmt.web.v2021_01_15.models._models_py3.TriggeredWebJobCollection]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Site name.

slot

str

Required

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

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either TriggeredWebJobCollection or the result of cls(response)

Return type

AsyncItemPaged[TriggeredWebJobCollection]

Exceptions

HttpResponseError

list_usages

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

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

list_usages(resource_group_name: str, name: str, filter: Optional[str] = None, **kwargs: Any) -> AsyncIterable[azure.mgmt.web.v2021_01_15.models._models_py3.CsmUsageQuotaCollection]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

filter

str

default value: None

Return only information specified in the filter (using OData syntax). For example: $filter=(name.value eq 'Metric1' or name.value eq 'Metric2') and startTime eq 2014-01-01T00:00:00Z and endTime eq 2014-12-31T23:59:59Z and timeGrain eq duration'[Hour|Minute|Day]'.

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either CsmUsageQuotaCollection or the result of cls(response)

Return type

AsyncItemPaged[CsmUsageQuotaCollection]

Exceptions

HttpResponseError

list_usages_slot

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

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

list_usages_slot(resource_group_name: str, name: str, slot: str, filter: Optional[str] = None, **kwargs: Any) -> AsyncIterable[azure.mgmt.web.v2021_01_15.models._models_py3.CsmUsageQuotaCollection]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

slot

str

Required

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

filter

str

default value: None

Return only information specified in the filter (using OData syntax). For example: $filter=(name.value eq 'Metric1' or name.value eq 'Metric2') and startTime eq 2014-01-01T00:00:00Z and endTime eq 2014-12-31T23:59:59Z and timeGrain eq duration'[Hour|Minute|Day]'.

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either CsmUsageQuotaCollection or the result of cls(response)

Return type

AsyncItemPaged[CsmUsageQuotaCollection]

Exceptions

HttpResponseError

list_vnet_connections

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

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

async list_vnet_connections(resource_group_name: str, name: str, **kwargs: Any) -> List[azure.mgmt.web.v2021_01_15.models._models_py3.VnetInfo]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

cls

callable

A custom type or function that will be passed the direct response

Returns

list of VnetInfo, or the result of cls(response)

Return type

list[VnetInfo]

Exceptions

HttpResponseError

list_vnet_connections_slot

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

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

async list_vnet_connections_slot(resource_group_name: str, name: str, slot: str, **kwargs: Any) -> List[azure.mgmt.web.v2021_01_15.models._models_py3.VnetInfo]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

slot

str

Required

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

cls

callable

A custom type or function that will be passed the direct response

Returns

list of VnetInfo, or the result of cls(response)

Return type

list[VnetInfo]

Exceptions

HttpResponseError

list_web_jobs

List webjobs for an app, or a deployment slot.

Description for List webjobs for an app, or a deployment slot.

list_web_jobs(resource_group_name: str, name: str, **kwargs: Any) -> AsyncIterable[azure.mgmt.web.v2021_01_15.models._models_py3.WebJobCollection]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Site name.

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either WebJobCollection or the result of cls(response)

Return type

AsyncItemPaged[WebJobCollection]

Exceptions

HttpResponseError

list_web_jobs_slot

List webjobs for an app, or a deployment slot.

Description for List webjobs for an app, or a deployment slot.

list_web_jobs_slot(resource_group_name: str, name: str, slot: str, **kwargs: Any) -> AsyncIterable[azure.mgmt.web.v2021_01_15.models._models_py3.WebJobCollection]

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Site name.

slot

str

Required

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

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either WebJobCollection or the result of cls(response)

Return type

AsyncItemPaged[WebJobCollection]

Exceptions

HttpResponseError

put_private_access_vnet

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

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

async put_private_access_vnet(resource_group_name: str, name: str, access: azure.mgmt.web.v2021_01_15.models._models_py3.PrivateAccess, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.PrivateAccess

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

The name of the web app.

access

PrivateAccess

Required

The information for the private access.

cls

callable

A custom type or function that will be passed the direct response

Returns

PrivateAccess, or the result of cls(response)

Return type

PrivateAccess

Exceptions

HttpResponseError

put_private_access_vnet_slot

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

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

async put_private_access_vnet_slot(resource_group_name: str, name: str, slot: str, access: azure.mgmt.web.v2021_01_15.models._models_py3.PrivateAccess, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.PrivateAccess

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

The name of the web app.

slot

str

Required

The name of the slot for the web app.

access

PrivateAccess

Required

The information for the private access.

cls

callable

A custom type or function that will be passed the direct response

Returns

PrivateAccess, or the result of cls(response)

Return type

PrivateAccess

Exceptions

HttpResponseError

recover_site_configuration_snapshot

Reverts the configuration of an app to a previous snapshot.

Description for Reverts the configuration of an app to a previous snapshot.

async recover_site_configuration_snapshot(resource_group_name: str, name: str, snapshot_id: str, **kwargs: Any) -> None

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

snapshot_id

str

Required

The ID of the snapshot to read.

cls

callable

A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Exceptions

HttpResponseError

recover_site_configuration_snapshot_slot

Reverts the configuration of an app to a previous snapshot.

Description for Reverts the configuration of an app to a previous snapshot.

async recover_site_configuration_snapshot_slot(resource_group_name: str, name: str, snapshot_id: str, slot: str, **kwargs: Any) -> None

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

snapshot_id

str

Required

The ID of the snapshot to read.

slot

str

Required

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

cls

callable

A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Exceptions

HttpResponseError

reset_production_slot_config

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

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

async reset_production_slot_config(resource_group_name: str, name: str, **kwargs: Any) -> None

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

cls

callable

A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Exceptions

HttpResponseError

reset_slot_configuration_slot

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

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

async reset_slot_configuration_slot(resource_group_name: str, name: str, slot: str, **kwargs: Any) -> None

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

slot

str

Required

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

cls

callable

A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Exceptions

HttpResponseError

restart

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

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

async restart(resource_group_name: str, name: str, soft_restart: Optional[bool] = None, synchronous: Optional[bool] = None, **kwargs: Any) -> None

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

soft_restart

bool

default value: None

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

bool

default value: None

Specify true to block until the app is restarted. By default, it is set to false, and the API responds immediately (asynchronous).

cls

callable

A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Exceptions

HttpResponseError

restart_slot

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

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

async restart_slot(resource_group_name: str, name: str, slot: str, soft_restart: Optional[bool] = None, synchronous: Optional[bool] = None, **kwargs: Any) -> None

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

slot

str

Required

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

soft_restart

bool

default value: None

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

bool

default value: None

Specify true to block until the app is restarted. By default, it is set to false, and the API responds immediately (asynchronous).

cls

callable

A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Exceptions

HttpResponseError

run_triggered_web_job

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

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

async run_triggered_web_job(resource_group_name: str, name: str, web_job_name: str, **kwargs: Any) -> None

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Site name.

web_job_name

str

Required

Name of Web Job.

cls

callable

A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Exceptions

HttpResponseError

run_triggered_web_job_slot

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

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

async run_triggered_web_job_slot(resource_group_name: str, name: str, web_job_name: str, slot: str, **kwargs: Any) -> None

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Site name.

web_job_name

str

Required

Name of Web Job.

slot

str

Required

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

cls

callable

A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Exceptions

HttpResponseError

start

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

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

async start(resource_group_name: str, name: str, **kwargs: Any) -> None

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

cls

callable

A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Exceptions

HttpResponseError

start_continuous_web_job

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

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

async start_continuous_web_job(resource_group_name: str, name: str, web_job_name: str, **kwargs: Any) -> None

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Site name.

web_job_name

str

Required

Name of Web Job.

cls

callable

A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Exceptions

HttpResponseError

start_continuous_web_job_slot

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

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

async start_continuous_web_job_slot(resource_group_name: str, name: str, web_job_name: str, slot: str, **kwargs: Any) -> None

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Site name.

web_job_name

str

Required

Name of Web Job.

slot

str

Required

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

cls

callable

A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Exceptions

HttpResponseError

start_slot

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

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

async start_slot(resource_group_name: str, name: str, slot: str, **kwargs: Any) -> None

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

slot

str

Required

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

cls

callable

A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Exceptions

HttpResponseError

start_web_site_network_trace

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

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

async start_web_site_network_trace(resource_group_name: str, name: str, duration_in_seconds: Optional[int] = None, max_frame_length: Optional[int] = None, sas_url: Optional[str] = None, **kwargs: Any) -> str

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

The name of the web app.

duration_in_seconds

int

default value: None

The duration to keep capturing in seconds.

max_frame_length

int

default value: None

The maximum frame length in bytes (Optional).

sas_url

str

default value: None

The Blob URL to store capture file.

cls

callable

A custom type or function that will be passed the direct response

Returns

str, or the result of cls(response)

Return type

str

Exceptions

HttpResponseError

start_web_site_network_trace_slot

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

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

async start_web_site_network_trace_slot(resource_group_name: str, name: str, slot: str, duration_in_seconds: Optional[int] = None, max_frame_length: Optional[int] = None, sas_url: Optional[str] = None, **kwargs: Any) -> str

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

The name of the web app.

slot

str

Required

The name of the slot for this web app.

duration_in_seconds

int

default value: None

The duration to keep capturing in seconds.

max_frame_length

int

default value: None

The maximum frame length in bytes (Optional).

sas_url

str

default value: None

The Blob URL to store capture file.

cls

callable

A custom type or function that will be passed the direct response

Returns

str, or the result of cls(response)

Return type

str

Exceptions

HttpResponseError

stop

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

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

async stop(resource_group_name: str, name: str, **kwargs: Any) -> None

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

cls

callable

A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Exceptions

HttpResponseError

stop_continuous_web_job

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

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

async stop_continuous_web_job(resource_group_name: str, name: str, web_job_name: str, **kwargs: Any) -> None

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Site name.

web_job_name

str

Required

Name of Web Job.

cls

callable

A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Exceptions

HttpResponseError

stop_continuous_web_job_slot

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

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

async stop_continuous_web_job_slot(resource_group_name: str, name: str, web_job_name: str, slot: str, **kwargs: Any) -> None

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Site name.

web_job_name

str

Required

Name of Web Job.

slot

str

Required

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

cls

callable

A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Exceptions

HttpResponseError

stop_network_trace

Stop ongoing capturing network packets for the site.

Description for Stop ongoing capturing network packets for the site.

async stop_network_trace(resource_group_name: str, name: str, **kwargs: Any) -> None

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

The name of the web app.

cls

callable

A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Exceptions

HttpResponseError

stop_network_trace_slot

Stop ongoing capturing network packets for the site.

Description for Stop ongoing capturing network packets for the site.

async stop_network_trace_slot(resource_group_name: str, name: str, slot: str, **kwargs: Any) -> None

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

The name of the web app.

slot

str

Required

The name of the slot for this web app.

cls

callable

A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Exceptions

HttpResponseError

stop_slot

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

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

async stop_slot(resource_group_name: str, name: str, slot: str, **kwargs: Any) -> None

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

slot

str

Required

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

cls

callable

A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Exceptions

HttpResponseError

stop_web_site_network_trace

Stop ongoing capturing network packets for the site.

Description for Stop ongoing capturing network packets for the site.

async stop_web_site_network_trace(resource_group_name: str, name: str, **kwargs: Any) -> None

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

The name of the web app.

cls

callable

A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Exceptions

HttpResponseError

stop_web_site_network_trace_slot

Stop ongoing capturing network packets for the site.

Description for Stop ongoing capturing network packets for the site.

async stop_web_site_network_trace_slot(resource_group_name: str, name: str, slot: str, **kwargs: Any) -> None

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

The name of the web app.

slot

str

Required

The name of the slot for this web app.

cls

callable

A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Exceptions

HttpResponseError

sync_function_triggers

Syncs function trigger metadata to the management database.

Description for Syncs function trigger metadata to the management database.

async sync_function_triggers(resource_group_name: str, name: str, **kwargs: Any) -> None

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

cls

callable

A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Exceptions

HttpResponseError

sync_function_triggers_slot

Syncs function trigger metadata to the management database.

Description for Syncs function trigger metadata to the management database.

async sync_function_triggers_slot(resource_group_name: str, name: str, slot: str, **kwargs: Any) -> None

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

slot

str

Required

Name of the deployment slot.

cls

callable

A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Exceptions

HttpResponseError

sync_functions

Syncs function trigger metadata to the management database.

Description for Syncs function trigger metadata to the management database.

async sync_functions(resource_group_name: str, name: str, **kwargs: Any) -> None

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

cls

callable

A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Exceptions

HttpResponseError

sync_functions_slot

Syncs function trigger metadata to the management database.

Description for Syncs function trigger metadata to the management database.

async sync_functions_slot(resource_group_name: str, name: str, slot: str, **kwargs: Any) -> None

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

slot

str

Required

Name of the deployment slot.

cls

callable

A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Exceptions

HttpResponseError

sync_repository

Sync web app repository.

Description for Sync web app repository.

async sync_repository(resource_group_name: str, name: str, **kwargs: Any) -> None

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of web app.

cls

callable

A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Exceptions

HttpResponseError

sync_repository_slot

Sync web app repository.

Description for Sync web app repository.

async sync_repository_slot(resource_group_name: str, name: str, slot: str, **kwargs: Any) -> None

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of web app.

slot

str

Required

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

cls

callable

A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Exceptions

HttpResponseError

update

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

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

async update(resource_group_name: str, name: str, site_envelope: azure.mgmt.web.v2021_01_15.models._models_py3.SitePatchResource, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.Site

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

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

site_envelope

SitePatchResource

Required

A JSON representation of the app properties. See example.

cls

callable

A custom type or function that will be passed the direct response

Returns

Site, or the result of cls(response)

Return type

Site

Exceptions

HttpResponseError

update_application_settings

Replaces the application settings of an app.

Description for Replaces the application settings of an app.

async update_application_settings(resource_group_name: str, name: str, app_settings: azure.mgmt.web.v2021_01_15.models._models_py3.StringDictionary, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.StringDictionary

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

app_settings

StringDictionary

Required

Application settings of the app.

cls

callable

A custom type or function that will be passed the direct response

Returns

StringDictionary, or the result of cls(response)

Return type

StringDictionary

Exceptions

HttpResponseError

update_application_settings_slot

Replaces the application settings of an app.

Description for Replaces the application settings of an app.

async update_application_settings_slot(resource_group_name: str, name: str, slot: str, app_settings: azure.mgmt.web.v2021_01_15.models._models_py3.StringDictionary, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.StringDictionary

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

slot

str

Required

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

app_settings

StringDictionary

Required

Application settings of the app.

cls

callable

A custom type or function that will be passed the direct response

Returns

StringDictionary, or the result of cls(response)

Return type

StringDictionary

Exceptions

HttpResponseError

update_auth_settings

Updates the Authentication / Authorization settings associated with web app.

Description for Updates the Authentication / Authorization settings associated with web app.

async update_auth_settings(resource_group_name: str, name: str, site_auth_settings: azure.mgmt.web.v2021_01_15.models._models_py3.SiteAuthSettings, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.SiteAuthSettings

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of web app.

site_auth_settings

SiteAuthSettings

Required

Auth settings associated with web app.

cls

callable

A custom type or function that will be passed the direct response

Returns

SiteAuthSettings, or the result of cls(response)

Return type

SiteAuthSettings

Exceptions

HttpResponseError

update_auth_settings_slot

Updates the Authentication / Authorization settings associated with web app.

Description for Updates the Authentication / Authorization settings associated with web app.

async update_auth_settings_slot(resource_group_name: str, name: str, slot: str, site_auth_settings: azure.mgmt.web.v2021_01_15.models._models_py3.SiteAuthSettings, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.SiteAuthSettings

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of web app.

slot

str

Required

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

site_auth_settings

SiteAuthSettings

Required

Auth settings associated with web app.

cls

callable

A custom type or function that will be passed the direct response

Returns

SiteAuthSettings, or the result of cls(response)

Return type

SiteAuthSettings

Exceptions

HttpResponseError

update_auth_settings_v2

Updates site's Authentication / Authorization settings for apps via the V2 format.

Description for Updates site's Authentication / Authorization settings for apps via the V2 format.

async update_auth_settings_v2(resource_group_name: str, name: str, site_auth_settings_v2: azure.mgmt.web.v2021_01_15.models._models_py3.SiteAuthSettingsV2, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.SiteAuthSettingsV2

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of web app.

site_auth_settings_v2

SiteAuthSettingsV2

Required

Auth settings associated with web app.

cls

callable

A custom type or function that will be passed the direct response

Returns

SiteAuthSettingsV2, or the result of cls(response)

Return type

SiteAuthSettingsV2

Exceptions

HttpResponseError

update_auth_settings_v2_slot

Updates site's Authentication / Authorization settings for apps via the V2 format.

Description for Updates site's Authentication / Authorization settings for apps via the V2 format.

async update_auth_settings_v2_slot(resource_group_name: str, name: str, slot: str, site_auth_settings_v2: azure.mgmt.web.v2021_01_15.models._models_py3.SiteAuthSettingsV2, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.SiteAuthSettingsV2

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of web app.

slot

str

Required

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

site_auth_settings_v2

SiteAuthSettingsV2

Required

Auth settings associated with web app.

cls

callable

A custom type or function that will be passed the direct response

Returns

SiteAuthSettingsV2, or the result of cls(response)

Return type

SiteAuthSettingsV2

Exceptions

HttpResponseError

update_azure_storage_accounts

Updates the Azure storage account configurations of an app.

Description for Updates the Azure storage account configurations of an app.

async update_azure_storage_accounts(resource_group_name: str, name: str, azure_storage_accounts: azure.mgmt.web.v2021_01_15.models._models_py3.AzureStoragePropertyDictionaryResource, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.AzureStoragePropertyDictionaryResource

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

azure_storage_accounts

AzureStoragePropertyDictionaryResource

Required

Azure storage accounts of the app.

cls

callable

A custom type or function that will be passed the direct response

Returns

AzureStoragePropertyDictionaryResource, or the result of cls(response)

Return type

AzureStoragePropertyDictionaryResource

Exceptions

HttpResponseError

update_azure_storage_accounts_slot

Updates the Azure storage account configurations of an app.

Description for Updates the Azure storage account configurations of an app.

async update_azure_storage_accounts_slot(resource_group_name: str, name: str, slot: str, azure_storage_accounts: azure.mgmt.web.v2021_01_15.models._models_py3.AzureStoragePropertyDictionaryResource, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.AzureStoragePropertyDictionaryResource

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

slot

str

Required

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

azure_storage_accounts

AzureStoragePropertyDictionaryResource

Required

Azure storage accounts of the app.

cls

callable

A custom type or function that will be passed the direct response

Returns

AzureStoragePropertyDictionaryResource, or the result of cls(response)

Return type

AzureStoragePropertyDictionaryResource

Exceptions

HttpResponseError

update_backup_configuration

Updates the backup configuration of an app.

Description for Updates the backup configuration of an app.

async update_backup_configuration(resource_group_name: str, name: str, request: azure.mgmt.web.v2021_01_15.models._models_py3.BackupRequest, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.BackupRequest

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

request

BackupRequest

Required

Edited backup configuration.

cls

callable

A custom type or function that will be passed the direct response

Returns

BackupRequest, or the result of cls(response)

Return type

BackupRequest

Exceptions

HttpResponseError

update_backup_configuration_slot

Updates the backup configuration of an app.

Description for Updates the backup configuration of an app.

async update_backup_configuration_slot(resource_group_name: str, name: str, slot: str, request: azure.mgmt.web.v2021_01_15.models._models_py3.BackupRequest, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.BackupRequest

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

slot

str

Required

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

request

BackupRequest

Required

Edited backup configuration.

cls

callable

A custom type or function that will be passed the direct response

Returns

BackupRequest, or the result of cls(response)

Return type

BackupRequest

Exceptions

HttpResponseError

update_configuration

Updates the configuration of an app.

Description for Updates the configuration of an app.

async update_configuration(resource_group_name: str, name: str, site_config: azure.mgmt.web.v2021_01_15.models._models_py3.SiteConfigResource, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.SiteConfigResource

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

site_config

SiteConfigResource

Required

JSON representation of a SiteConfig object. See example.

cls

callable

A custom type or function that will be passed the direct response

Returns

SiteConfigResource, or the result of cls(response)

Return type

SiteConfigResource

Exceptions

HttpResponseError

update_configuration_slot

Updates the configuration of an app.

Description for Updates the configuration of an app.

async update_configuration_slot(resource_group_name: str, name: str, slot: str, site_config: azure.mgmt.web.v2021_01_15.models._models_py3.SiteConfigResource, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.SiteConfigResource

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

slot

str

Required

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

site_config

SiteConfigResource

Required

JSON representation of a SiteConfig object. See example.

cls

callable

A custom type or function that will be passed the direct response

Returns

SiteConfigResource, or the result of cls(response)

Return type

SiteConfigResource

Exceptions

HttpResponseError

update_connection_strings

Replaces the connection strings of an app.

Description for Replaces the connection strings of an app.

async update_connection_strings(resource_group_name: str, name: str, connection_strings: azure.mgmt.web.v2021_01_15.models._models_py3.ConnectionStringDictionary, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.ConnectionStringDictionary

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

connection_strings

ConnectionStringDictionary

Required

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

cls

callable

A custom type or function that will be passed the direct response

Returns

ConnectionStringDictionary, or the result of cls(response)

Return type

ConnectionStringDictionary

Exceptions

HttpResponseError

update_connection_strings_slot

Replaces the connection strings of an app.

Description for Replaces the connection strings of an app.

async update_connection_strings_slot(resource_group_name: str, name: str, slot: str, connection_strings: azure.mgmt.web.v2021_01_15.models._models_py3.ConnectionStringDictionary, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.ConnectionStringDictionary

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

slot

str

Required

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

connection_strings

ConnectionStringDictionary

Required

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

cls

callable

A custom type or function that will be passed the direct response

Returns

ConnectionStringDictionary, or the result of cls(response)

Return type

ConnectionStringDictionary

Exceptions

HttpResponseError

update_diagnostic_logs_config

Updates the logging configuration of an app.

Description for Updates the logging configuration of an app.

async update_diagnostic_logs_config(resource_group_name: str, name: str, site_logs_config: azure.mgmt.web.v2021_01_15.models._models_py3.SiteLogsConfig, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.SiteLogsConfig

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

site_logs_config

SiteLogsConfig

Required

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

cls

callable

A custom type or function that will be passed the direct response

Returns

SiteLogsConfig, or the result of cls(response)

Return type

SiteLogsConfig

Exceptions

HttpResponseError

update_diagnostic_logs_config_slot

Updates the logging configuration of an app.

Description for Updates the logging configuration of an app.

async update_diagnostic_logs_config_slot(resource_group_name: str, name: str, slot: str, site_logs_config: azure.mgmt.web.v2021_01_15.models._models_py3.SiteLogsConfig, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.SiteLogsConfig

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

slot

str

Required

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

site_logs_config

SiteLogsConfig

Required

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

cls

callable

A custom type or function that will be passed the direct response

Returns

SiteLogsConfig, or the result of cls(response)

Return type

SiteLogsConfig

Exceptions

HttpResponseError

update_domain_ownership_identifier

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

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

async update_domain_ownership_identifier(resource_group_name: str, name: str, domain_ownership_identifier_name: str, domain_ownership_identifier: azure.mgmt.web.v2021_01_15.models._models_py3.Identifier, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.Identifier

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

domain_ownership_identifier_name

str

Required

Name of domain ownership identifier.

domain_ownership_identifier

Identifier

Required

A JSON representation of the domain ownership properties.

cls

callable

A custom type or function that will be passed the direct response

Returns

Identifier, or the result of cls(response)

Return type

Identifier

Exceptions

HttpResponseError

update_domain_ownership_identifier_slot

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

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

async update_domain_ownership_identifier_slot(resource_group_name: str, name: str, domain_ownership_identifier_name: str, slot: str, domain_ownership_identifier: azure.mgmt.web.v2021_01_15.models._models_py3.Identifier, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.Identifier

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

domain_ownership_identifier_name

str

Required

Name of domain ownership identifier.

slot

str

Required

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

domain_ownership_identifier

Identifier

Required

A JSON representation of the domain ownership properties.

cls

callable

A custom type or function that will be passed the direct response

Returns

Identifier, or the result of cls(response)

Return type

Identifier

Exceptions

HttpResponseError

update_ftp_allowed

Updates whether FTP is allowed on the site or not.

Description for Updates whether FTP is allowed on the site or not.

async update_ftp_allowed(resource_group_name: str, name: str, csm_publishing_access_policies_entity: azure.mgmt.web.v2021_01_15.models._models_py3.CsmPublishingCredentialsPoliciesEntity, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.CsmPublishingCredentialsPoliciesEntity

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

csm_publishing_access_policies_entity

CsmPublishingCredentialsPoliciesEntity

Required

cls

callable

A custom type or function that will be passed the direct response

Returns

CsmPublishingCredentialsPoliciesEntity, or the result of cls(response)

Return type

CsmPublishingCredentialsPoliciesEntity

Exceptions

HttpResponseError

update_ftp_allowed_slot

Updates whether FTP is allowed on the site or not.

Description for Updates whether FTP is allowed on the site or not.

async update_ftp_allowed_slot(resource_group_name: str, name: str, slot: str, csm_publishing_access_policies_entity: azure.mgmt.web.v2021_01_15.models._models_py3.CsmPublishingCredentialsPoliciesEntity, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.CsmPublishingCredentialsPoliciesEntity

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

slot

str

Required

csm_publishing_access_policies_entity

CsmPublishingCredentialsPoliciesEntity

Required

cls

callable

A custom type or function that will be passed the direct response

Returns

CsmPublishingCredentialsPoliciesEntity, or the result of cls(response)

Return type

CsmPublishingCredentialsPoliciesEntity

Exceptions

HttpResponseError

update_hybrid_connection

Creates a new Hybrid Connection using a Service Bus relay.

Description for Creates a new Hybrid Connection using a Service Bus relay.

async update_hybrid_connection(resource_group_name: str, name: str, namespace_name: str, relay_name: str, connection_envelope: azure.mgmt.web.v2021_01_15.models._models_py3.HybridConnection, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.HybridConnection

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

The name of the web app.

namespace_name

str

Required

The namespace for this hybrid connection.

relay_name

str

Required

The relay name for this hybrid connection.

connection_envelope

HybridConnection

Required

The details of the hybrid connection.

cls

callable

A custom type or function that will be passed the direct response

Returns

HybridConnection, or the result of cls(response)

Return type

HybridConnection

Exceptions

HttpResponseError

update_hybrid_connection_slot

Creates a new Hybrid Connection using a Service Bus relay.

Description for Creates a new Hybrid Connection using a Service Bus relay.

async update_hybrid_connection_slot(resource_group_name: str, name: str, namespace_name: str, relay_name: str, slot: str, connection_envelope: azure.mgmt.web.v2021_01_15.models._models_py3.HybridConnection, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.HybridConnection

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

The name of the web app.

namespace_name

str

Required

The namespace for this hybrid connection.

relay_name

str

Required

The relay name for this hybrid connection.

slot

str

Required

The name of the slot for the web app.

connection_envelope

HybridConnection

Required

The details of the hybrid connection.

cls

callable

A custom type or function that will be passed the direct response

Returns

HybridConnection, or the result of cls(response)

Return type

HybridConnection

Exceptions

HttpResponseError

update_metadata

Replaces the metadata of an app.

Description for Replaces the metadata of an app.

async update_metadata(resource_group_name: str, name: str, metadata: azure.mgmt.web.v2021_01_15.models._models_py3.StringDictionary, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.StringDictionary

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

metadata

StringDictionary

Required

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

cls

callable

A custom type or function that will be passed the direct response

Returns

StringDictionary, or the result of cls(response)

Return type

StringDictionary

Exceptions

HttpResponseError

update_metadata_slot

Replaces the metadata of an app.

Description for Replaces the metadata of an app.

async update_metadata_slot(resource_group_name: str, name: str, slot: str, metadata: azure.mgmt.web.v2021_01_15.models._models_py3.StringDictionary, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.StringDictionary

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

slot

str

Required

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

metadata

StringDictionary

Required

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

cls

callable

A custom type or function that will be passed the direct response

Returns

StringDictionary, or the result of cls(response)

Return type

StringDictionary

Exceptions

HttpResponseError

update_premier_add_on

Updates a named add-on of an app.

Description for Updates a named add-on of an app.

async update_premier_add_on(resource_group_name: str, name: str, premier_add_on_name: str, premier_add_on: azure.mgmt.web.v2021_01_15.models._models_py3.PremierAddOnPatchResource, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.PremierAddOn

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

premier_add_on_name

str

Required

Add-on name.

premier_add_on

PremierAddOnPatchResource

Required

A JSON representation of the edited premier add-on.

cls

callable

A custom type or function that will be passed the direct response

Returns

PremierAddOn, or the result of cls(response)

Return type

PremierAddOn

Exceptions

HttpResponseError

update_premier_add_on_slot

Updates a named add-on of an app.

Description for Updates a named add-on of an app.

async update_premier_add_on_slot(resource_group_name: str, name: str, premier_add_on_name: str, slot: str, premier_add_on: azure.mgmt.web.v2021_01_15.models._models_py3.PremierAddOnPatchResource, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.PremierAddOn

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

premier_add_on_name

str

Required

Add-on name.

slot

str

Required

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

premier_add_on

PremierAddOnPatchResource

Required

A JSON representation of the edited premier add-on.

cls

callable

A custom type or function that will be passed the direct response

Returns

PremierAddOn, or the result of cls(response)

Return type

PremierAddOn

Exceptions

HttpResponseError

update_relay_service_connection

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

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

async update_relay_service_connection(resource_group_name: str, name: str, entity_name: str, connection_envelope: azure.mgmt.web.v2021_01_15.models._models_py3.RelayServiceConnectionEntity, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.RelayServiceConnectionEntity

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

entity_name

str

Required

Name of the hybrid connection configuration.

connection_envelope

RelayServiceConnectionEntity

Required

Details of the hybrid connection configuration.

cls

callable

A custom type or function that will be passed the direct response

Returns

RelayServiceConnectionEntity, or the result of cls(response)

Return type

RelayServiceConnectionEntity

Exceptions

HttpResponseError

update_relay_service_connection_slot

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

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

async update_relay_service_connection_slot(resource_group_name: str, name: str, entity_name: str, slot: str, connection_envelope: azure.mgmt.web.v2021_01_15.models._models_py3.RelayServiceConnectionEntity, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.RelayServiceConnectionEntity

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

entity_name

str

Required

Name of the hybrid connection configuration.

slot

str

Required

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

connection_envelope

RelayServiceConnectionEntity

Required

Details of the hybrid connection configuration.

cls

callable

A custom type or function that will be passed the direct response

Returns

RelayServiceConnectionEntity, or the result of cls(response)

Return type

RelayServiceConnectionEntity

Exceptions

HttpResponseError

update_scm_allowed

Updates whether user publishing credentials are allowed on the site or not.

Description for Updates whether user publishing credentials are allowed on the site or not.

async update_scm_allowed(resource_group_name: str, name: str, csm_publishing_access_policies_entity: azure.mgmt.web.v2021_01_15.models._models_py3.CsmPublishingCredentialsPoliciesEntity, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.CsmPublishingCredentialsPoliciesEntity

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

csm_publishing_access_policies_entity

CsmPublishingCredentialsPoliciesEntity

Required

cls

callable

A custom type or function that will be passed the direct response

Returns

CsmPublishingCredentialsPoliciesEntity, or the result of cls(response)

Return type

CsmPublishingCredentialsPoliciesEntity

Exceptions

HttpResponseError

update_scm_allowed_slot

Updates whether user publishing credentials are allowed on the site or not.

Description for Updates whether user publishing credentials are allowed on the site or not.

async update_scm_allowed_slot(resource_group_name: str, name: str, slot: str, csm_publishing_access_policies_entity: azure.mgmt.web.v2021_01_15.models._models_py3.CsmPublishingCredentialsPoliciesEntity, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.CsmPublishingCredentialsPoliciesEntity

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

slot

str

Required

csm_publishing_access_policies_entity

CsmPublishingCredentialsPoliciesEntity

Required

cls

callable

A custom type or function that will be passed the direct response

Returns

CsmPublishingCredentialsPoliciesEntity, or the result of cls(response)

Return type

CsmPublishingCredentialsPoliciesEntity

Exceptions

HttpResponseError

update_site_push_settings

Updates the Push settings associated with web app.

Description for Updates the Push settings associated with web app.

async update_site_push_settings(resource_group_name: str, name: str, push_settings: azure.mgmt.web.v2021_01_15.models._models_py3.PushSettings, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.PushSettings

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of web app.

push_settings

PushSettings

Required

Push settings associated with web app.

cls

callable

A custom type or function that will be passed the direct response

Returns

PushSettings, or the result of cls(response)

Return type

PushSettings

Exceptions

HttpResponseError

update_site_push_settings_slot

Updates the Push settings associated with web app.

Description for Updates the Push settings associated with web app.

async update_site_push_settings_slot(resource_group_name: str, name: str, slot: str, push_settings: azure.mgmt.web.v2021_01_15.models._models_py3.PushSettings, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.PushSettings

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of web app.

slot

str

Required

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

push_settings

PushSettings

Required

Push settings associated with web app.

cls

callable

A custom type or function that will be passed the direct response

Returns

PushSettings, or the result of cls(response)

Return type

PushSettings

Exceptions

HttpResponseError

update_slot

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

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

async update_slot(resource_group_name: str, name: str, slot: str, site_envelope: azure.mgmt.web.v2021_01_15.models._models_py3.SitePatchResource, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.Site

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

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

slot

str

Required

Name of the deployment slot to create or update. By default, this API attempts to create or modify the production slot.

site_envelope

SitePatchResource

Required

A JSON representation of the app properties. See example.

cls

callable

A custom type or function that will be passed the direct response

Returns

Site, or the result of cls(response)

Return type

Site

Exceptions

HttpResponseError

update_slot_configuration_names

Updates the names of application settings and connection string that remain with the slot during swap operation.

Description for Updates the names of application settings and connection string that remain with the slot during swap operation.

async update_slot_configuration_names(resource_group_name: str, name: str, slot_config_names: azure.mgmt.web.v2021_01_15.models._models_py3.SlotConfigNamesResource, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.SlotConfigNamesResource

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

slot_config_names

SlotConfigNamesResource

Required

Names of application settings and connection strings. See example.

cls

callable

A custom type or function that will be passed the direct response

Returns

SlotConfigNamesResource, or the result of cls(response)

Return type

SlotConfigNamesResource

Exceptions

HttpResponseError

update_source_control

Updates the source control configuration of an app.

Description for Updates the source control configuration of an app.

async update_source_control(resource_group_name: str, name: str, site_source_control: azure.mgmt.web.v2021_01_15.models._models_py3.SiteSourceControl, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.SiteSourceControl

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

site_source_control

SiteSourceControl

Required

JSON representation of a SiteSourceControl object. See example.

cls

callable

A custom type or function that will be passed the direct response

Returns

SiteSourceControl, or the result of cls(response)

Return type

SiteSourceControl

Exceptions

HttpResponseError

update_source_control_slot

Updates the source control configuration of an app.

Description for Updates the source control configuration of an app.

async update_source_control_slot(resource_group_name: str, name: str, slot: str, site_source_control: azure.mgmt.web.v2021_01_15.models._models_py3.SiteSourceControl, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.SiteSourceControl

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

slot

str

Required

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

site_source_control

SiteSourceControl

Required

JSON representation of a SiteSourceControl object. See example.

cls

callable

A custom type or function that will be passed the direct response

Returns

SiteSourceControl, or the result of cls(response)

Return type

SiteSourceControl

Exceptions

HttpResponseError

update_swift_virtual_network_connection_with_check

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

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

async update_swift_virtual_network_connection_with_check(resource_group_name: str, name: str, connection_envelope: azure.mgmt.web.v2021_01_15.models._models_py3.SwiftVirtualNetwork, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.SwiftVirtualNetwork

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

connection_envelope

SwiftVirtualNetwork

Required

Properties of the Virtual Network connection. See example.

cls

callable

A custom type or function that will be passed the direct response

Returns

SwiftVirtualNetwork, or the result of cls(response)

Return type

SwiftVirtualNetwork

Exceptions

HttpResponseError

update_swift_virtual_network_connection_with_check_slot

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

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

async update_swift_virtual_network_connection_with_check_slot(resource_group_name: str, name: str, slot: str, connection_envelope: azure.mgmt.web.v2021_01_15.models._models_py3.SwiftVirtualNetwork, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.SwiftVirtualNetwork

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

slot

str

Required

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

connection_envelope

SwiftVirtualNetwork

Required

Properties of the Virtual Network connection. See example.

cls

callable

A custom type or function that will be passed the direct response

Returns

SwiftVirtualNetwork, or the result of cls(response)

Return type

SwiftVirtualNetwork

Exceptions

HttpResponseError

update_vnet_connection

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

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

async update_vnet_connection(resource_group_name: str, name: str, vnet_name: str, connection_envelope: azure.mgmt.web.v2021_01_15.models._models_py3.VnetInfo, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.VnetInfo

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

vnet_name

str

Required

Name of an existing Virtual Network.

connection_envelope

VnetInfo

Required

Properties of the Virtual Network connection. See example.

cls

callable

A custom type or function that will be passed the direct response

Returns

VnetInfo, or the result of cls(response)

Return type

VnetInfo

Exceptions

HttpResponseError

update_vnet_connection_gateway

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

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

async update_vnet_connection_gateway(resource_group_name: str, name: str, vnet_name: str, gateway_name: str, connection_envelope: azure.mgmt.web.v2021_01_15.models._models_py3.VnetGateway, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.VnetGateway

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

vnet_name

str

Required

Name of the Virtual Network.

gateway_name

str

Required

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

connection_envelope

VnetGateway

Required

The properties to update this gateway with.

cls

callable

A custom type or function that will be passed the direct response

Returns

VnetGateway, or the result of cls(response)

Return type

VnetGateway

Exceptions

HttpResponseError

update_vnet_connection_gateway_slot

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

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

async update_vnet_connection_gateway_slot(resource_group_name: str, name: str, vnet_name: str, gateway_name: str, slot: str, connection_envelope: azure.mgmt.web.v2021_01_15.models._models_py3.VnetGateway, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.VnetGateway

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

vnet_name

str

Required

Name of the Virtual Network.

gateway_name

str

Required

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

slot

str

Required

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

connection_envelope

VnetGateway

Required

The properties to update this gateway with.

cls

callable

A custom type or function that will be passed the direct response

Returns

VnetGateway, or the result of cls(response)

Return type

VnetGateway

Exceptions

HttpResponseError

update_vnet_connection_slot

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

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

async update_vnet_connection_slot(resource_group_name: str, name: str, vnet_name: str, slot: str, connection_envelope: azure.mgmt.web.v2021_01_15.models._models_py3.VnetInfo, **kwargs: Any) -> azure.mgmt.web.v2021_01_15.models._models_py3.VnetInfo

Parameters

resource_group_name

str

Required

Name of the resource group to which the resource belongs.

name

str

Required

Name of the app.

vnet_name

str

Required

Name of an existing Virtual Network.

slot

str

Required

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

connection_envelope

VnetInfo

Required

Properties of the Virtual Network connection. See example.

cls

callable

A custom type or function that will be passed the direct response

Returns

VnetInfo, or the result of cls(response)

Return type

VnetInfo

Exceptions

HttpResponseError

Attributes

models

models = <module 'azure.mgmt.web.v2021_01_15.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.9.13\\x64\\lib\\site-packages\\azure\\mgmt\\web\\v2021_01_15\\models\\__init__.py'>