WebAppsOperations Class
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
<xref:web_apps> attribute.
- Inheritance
-
builtins.objectWebAppsOperations
Constructor
WebAppsOperations(*args, **kwargs)
Methods
add_premier_add_on |
Updates a named add-on of an app. Updates a named add-on of an app. |
add_premier_add_on_slot |
Updates a named add-on of an app. Updates a named add-on of an app. |
analyze_custom_hostname |
Analyze a custom hostname. Analyze a custom hostname. |
analyze_custom_hostname_slot |
Analyze a custom hostname. Analyze a custom hostname. |
apply_slot_config_to_production |
Applies the configuration settings from the target slot onto the current slot. 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. Applies the configuration settings from the target slot onto the current slot. |
backup |
Creates a backup of an app. Creates a backup of an app. |
backup_slot |
Creates a backup of an app. Creates a backup of an app. |
begin_approve_or_reject_private_endpoint_connection |
Approves or rejects a private endpoint connection. Approves or rejects a private endpoint connection. |
begin_approve_or_reject_private_endpoint_connection_slot |
Approves or rejects a private endpoint connection. Approves or rejects a private endpoint connection. |
begin_create_function |
Create function for web site, or a deployment slot. Create function for web site, or a deployment slot. |
begin_create_instance_function_slot |
Create function for web site, or a deployment slot. Create function for web site, or a deployment slot. |
begin_create_instance_ms_deploy_operation |
Invoke the MSDeploy web app extension. Invoke the MSDeploy web app extension. |
begin_create_instance_ms_deploy_operation_slot |
Invoke the MSDeploy web app extension. Invoke the MSDeploy web app extension. |
begin_create_ms_deploy_operation |
Invoke the MSDeploy web app extension. Invoke the MSDeploy web app extension. |
begin_create_ms_deploy_operation_slot |
Invoke the MSDeploy web app extension. 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. 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. 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. Updates the source control configuration of an app. |
begin_create_or_update_source_control_slot |
Updates the source control configuration of an app. Updates the source control configuration of an app. |
begin_delete_private_endpoint_connection |
Deletes a private endpoint connection. Deletes a private endpoint connection. |
begin_delete_private_endpoint_connection_slot |
Deletes a private endpoint connection. Deletes a private endpoint connection. |
begin_install_site_extension |
Install site extension on a web site, or a deployment slot. 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. Install site extension on a web site, or a deployment slot. |
begin_list_publishing_credentials |
Gets the Git/FTP publishing credentials of an app. Gets the Git/FTP publishing credentials of an app. |
begin_list_publishing_credentials_slot |
Gets the Git/FTP publishing credentials of an app. 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. Migrates a local (in-app) MySql database to a remote MySql database. |
begin_migrate_storage |
Restores a web app. Restores a web app. |
begin_restore |
Restores a specific backup to another app (or deployment slot, if specified). 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. 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. Restores an app from a backup blob in Azure Storage. |
begin_restore_from_deleted_app |
Restores a deleted web app to this web app. Restores a deleted web app to this web app. |
begin_restore_from_deleted_app_slot |
Restores a deleted web app to this web app. Restores a deleted web app to this web app. |
begin_restore_slot |
Restores a specific backup to another app (or deployment slot, if specified). Restores a specific backup to another app (or deployment slot, if specified). |
begin_restore_snapshot |
Restores a web app from a snapshot. Restores a web app from a snapshot. |
begin_restore_snapshot_slot |
Restores a web app from a snapshot. Restores a web app from a snapshot. |
begin_start_network_trace |
Start capturing network packets for the site. Start capturing network packets for the site. |
begin_start_network_trace_slot |
Start capturing network packets for the site. Start capturing network packets for the site. |
begin_start_web_site_network_trace_operation |
Start capturing network packets for the site. Start capturing network packets for the site. |
begin_start_web_site_network_trace_operation_slot |
Start capturing network packets for the site. Start capturing network packets for the site. |
begin_swap_slot |
Swaps two deployment slots of an app. Swaps two deployment slots of an app. |
begin_swap_slot_with_production |
Swaps two deployment slots of an app. Swaps two deployment slots of an app. |
create_deployment |
Create a deployment for an app, or a deployment slot. Create a deployment for an app, or a deployment slot. |
create_deployment_slot |
Create a deployment for an app, or a deployment slot. Create a deployment for an app, or a deployment slot. |
create_or_update_configuration |
Updates the configuration of an app. Updates the configuration of an app. |
create_or_update_configuration_slot |
Updates the configuration of an app. 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. 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. 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. Add or update a function secret. |
create_or_update_function_secret_slot |
Add or update a function secret. Add or update a function secret. |
create_or_update_host_name_binding |
Creates a hostname binding for an app. Creates a hostname binding for an app. |
create_or_update_host_name_binding_slot |
Creates a hostname binding for an app. Creates a hostname binding for an app. |
create_or_update_host_secret |
Add or update a host level secret. Add or update a host level secret. |
create_or_update_host_secret_slot |
Add or update a host level secret. Add or update a host level secret. |
create_or_update_hybrid_connection |
Creates a new Hybrid Connection using a Service Bus relay. 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. Creates a new Hybrid Connection using a Service Bus relay. |
create_or_update_public_certificate |
Creates a hostname binding for an app. Creates a hostname binding for an app. |
create_or_update_public_certificate_slot |
Creates a hostname binding for an app. 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). 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). 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. 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). 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). 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). 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). 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. Deletes a web, mobile, or API app, or one of the deployment slots. |
delete_backup |
Deletes a backup of an app by its ID. Deletes a backup of an app by its ID. |
delete_backup_configuration |
Deletes the backup configuration of an app. Deletes the backup configuration of an app. |
delete_backup_configuration_slot |
Deletes the backup configuration of an app. Deletes the backup configuration of an app. |
delete_backup_slot |
Deletes a backup of an app by its ID. 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. 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. 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. 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. 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. Deletes a domain ownership identifier for a web app. |
delete_domain_ownership_identifier_slot |
Deletes a domain ownership identifier for a web app. Deletes a domain ownership identifier for a web app. |
delete_function |
Delete a function for web site, or a deployment slot. Delete a function for web site, or a deployment slot. |
delete_function_secret |
Delete a function secret. Delete a function secret. |
delete_function_secret_slot |
Delete a function secret. Delete a function secret. |
delete_host_name_binding |
Deletes a hostname binding for an app. Deletes a hostname binding for an app. |
delete_host_name_binding_slot |
Deletes a hostname binding for an app. Deletes a hostname binding for an app. |
delete_host_secret |
Delete a host level secret. Delete a host level secret. |
delete_host_secret_slot |
Delete a host level secret. Delete a host level secret. |
delete_hybrid_connection |
Removes a Hybrid Connection from this site. Removes a Hybrid Connection from this site. |
delete_hybrid_connection_slot |
Removes a Hybrid Connection from this site. Removes a Hybrid Connection from this site. |
delete_instance_function_slot |
Delete a function for web site, or a deployment slot. 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. 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. 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. Delete a premier add-on from an app. |
delete_premier_add_on_slot |
Delete a premier add-on from an app. 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. 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. 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. Deletes a hostname binding for an app. |
delete_public_certificate_slot |
Deletes a hostname binding for an app. Deletes a hostname binding for an app. |
delete_relay_service_connection |
Deletes a relay service connection by its name. Deletes a relay service connection by its name. |
delete_relay_service_connection_slot |
Deletes a relay service connection by its name. Deletes a relay service connection by its name. |
delete_site_extension |
Remove a site extension from a web site, or a deployment slot. 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. 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. Deletes a web, mobile, or API app, or one of the deployment slots. |
delete_source_control |
Deletes the source control configuration of an app. Deletes the source control configuration of an app. |
delete_source_control_slot |
Deletes the source control configuration of an app. Deletes the source control configuration of an app. |
delete_swift_virtual_network |
Deletes a Swift Virtual Network connection from an app (or deployment slot). 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). 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. 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. 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. 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. 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. 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. 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). 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). Generates a new publishing password for an app (or deployment slot, if specified). |
get |
Gets the details of a web, mobile, or API app. 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. 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. 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. 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. Gets the config reference app settings and status of an app. |
get_auth_settings |
Gets the Authentication/Authorization settings of an app. Gets the Authentication/Authorization settings of an app. |
get_auth_settings_slot |
Gets the Authentication/Authorization settings of an app. Gets the Authentication/Authorization settings of an app. |
get_auth_settings_v2 |
Gets site's Authentication / Authorization settings for apps via the V2 format. 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. Gets site's Authentication / Authorization settings for apps via the V2 format. |
get_backup_configuration |
Gets the backup configuration of an app. Gets the backup configuration of an app. |
get_backup_configuration_slot |
Gets the backup configuration of an app. Gets the backup configuration of an app. |
get_backup_status |
Gets a backup of an app by its ID. Gets a backup of an app by its ID. |
get_backup_status_slot |
Gets a backup of an app by its ID. Gets a backup of an app by its ID. |
get_basic_publishing_credentials_policies |
Returns whether Scm basic auth is allowed and whether Ftp is allowed for a given site. Returns whether Scm basic auth is allowed and whether Ftp is allowed for a given site. |
get_basic_publishing_credentials_policies_slot |
Returns whether Scm basic auth is allowed and whether Ftp is allowed for a given site. Returns whether Scm basic auth is allowed and whether Ftp is allowed for a given site. |
get_configuration |
Gets the configuration of an app, such as platform version and bitness, default documents, virtual applications, Always On, etc. 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. 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. 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. 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. 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. 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. 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. 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. 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. Get a deployment by its ID for an app, or a deployment slot. |
get_diagnostic_logs_configuration |
Gets the logging configuration of an app. Gets the logging configuration of an app. |
get_diagnostic_logs_configuration_slot |
Gets the logging configuration of an app. Gets the logging configuration of an app. |
get_domain_ownership_identifier |
Get domain ownership identifier for web app. Get domain ownership identifier for web app. |
get_domain_ownership_identifier_slot |
Get domain ownership identifier for web app. Get domain ownership identifier for web app. |
get_ftp_allowed |
Returns whether FTP is allowed on the site or not. Returns whether FTP is allowed on the site or not. |
get_ftp_allowed_slot |
Returns whether FTP is allowed on the site or not. 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. 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. 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. 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). 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). 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. 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. 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. Get function information by its ID for web site, or a deployment slot. |
get_instance_info |
Gets all scale-out instances of an app. Gets all scale-out instances of an app. |
get_instance_info_slot |
Gets all scale-out instances of an app. Gets all scale-out instances of an app. |
get_instance_ms_deploy_log |
Get the MSDeploy Log for the last MSDeploy operation. Get the MSDeploy Log for the last MSDeploy operation. |
get_instance_ms_deploy_log_slot |
Get the MSDeploy Log for the last MSDeploy operation. Get the MSDeploy Log for the last MSDeploy operation. |
get_instance_ms_deploy_status |
Get the status of the last MSDeploy operation. Get the status of the last MSDeploy operation. |
get_instance_ms_deploy_status_slot |
Get the status of the last MSDeploy operation. 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. 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. 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. 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. 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. 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. 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. 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. 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. Get the MSDeploy Log for the last MSDeploy operation. |
get_ms_deploy_log_slot |
Get the MSDeploy Log for the last MSDeploy operation. Get the MSDeploy Log for the last MSDeploy operation. |
get_ms_deploy_status |
Get the status of the last MSDeploy operation. Get the status of the last MSDeploy operation. |
get_ms_deploy_status_slot |
Get the status of the last MSDeploy operation. 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). 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). 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). 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). 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). 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). 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). 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). 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. Gets a named add-on of an app. |
get_premier_add_on_slot |
Gets a named add-on of an app. 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. 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. 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. Gets a private endpoint connection. |
get_private_endpoint_connection_list |
Gets the list of private endpoint connections associated with a site. 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. Gets the list of private endpoint connections associated with a site. |
get_private_endpoint_connection_slot |
Gets a private endpoint connection. Gets a private endpoint connection. |
get_private_link_resources |
Gets the private link resources. Gets the private link resources. |
get_private_link_resources_slot |
Gets the private link resources. Gets the private link resources. |
get_process |
Get process information by its ID for a specific scaled-out instance in a web site. 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. 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. 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. 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. 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. 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). 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). 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. Gets a hybrid connection configuration by its name. |
get_relay_service_connection_slot |
Gets a hybrid connection configuration by its name. Gets a hybrid connection configuration by its name. |
get_scm_allowed |
Returns whether Scm basic auth is allowed on the site or not. 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. 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. 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. 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. 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. 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. 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. 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. Gets web app's event logs. |
get_site_php_error_log_flag_slot |
Gets web app's event logs. Gets web app's event logs. |
get_slot |
Gets the details of a web, mobile, or API app. Gets the details of a web, mobile, or API app. |
get_source_control |
Gets the source control configuration of an app. Gets the source control configuration of an app. |
get_source_control_slot |
Gets the source control configuration of an app. Gets the source control configuration of an app. |
get_swift_virtual_network_connection |
Gets a Swift Virtual Network connection. Gets a Swift Virtual Network connection. |
get_swift_virtual_network_connection_slot |
Gets a Swift Virtual Network connection. 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. 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. 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. 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. 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. 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. Gets an app's Virtual Network gateway. |
get_vnet_connection_gateway_slot |
Gets an app's Virtual Network gateway. 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. 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. Get webjob information for an app, or a deployment slot. |
get_web_job_slot |
Get webjob information for an app, or a deployment slot. 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. 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. 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. 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. Shows whether an app can be cloned to another resource group or subscription. |
list |
Get all apps for a subscription. Get all apps for a subscription. |
list_application_settings |
Gets the application settings of an app. Gets the application settings of an app. |
list_application_settings_slot |
Gets the application settings of an app. Gets the application settings of an app. |
list_azure_storage_accounts |
Gets the Azure storage account configurations of an app. Gets the Azure storage account configurations of an app. |
list_azure_storage_accounts_slot |
Gets the Azure storage account configurations of an app. 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. 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. 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. Gets existing backups of an app. |
list_backups_slot |
Gets existing backups of an app. Gets existing backups of an app. |
list_by_resource_group |
Gets all web, mobile, and API apps in the specified resource group. 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. 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. 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. List the configurations of an app. |
list_configurations_slot |
List the configurations of an app. List the configurations of an app. |
list_connection_strings |
Gets the connection strings of an app. Gets the connection strings of an app. |
list_connection_strings_slot |
Gets the connection strings of an app. Gets the connection strings of an app. |
list_continuous_web_jobs |
List continuous web jobs for an app, or a deployment slot. 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. 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. 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. List deployment log for specific deployment for an app, or a deployment slot. |
list_deployments |
List deployments for an app, or a deployment slot. List deployments for an app, or a deployment slot. |
list_deployments_slot |
List deployments for an app, or a deployment slot. List deployments for an app, or a deployment slot. |
list_domain_ownership_identifiers |
Lists ownership identifiers for domain associated with web app. Lists ownership identifiers for domain associated with web app. |
list_domain_ownership_identifiers_slot |
Lists ownership identifiers for domain associated with web app. 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. 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. 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. 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. 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. List the functions for a web site, or a deployment slot. |
list_host_keys |
Get host secrets for a function app. Get host secrets for a function app. |
list_host_keys_slot |
Get host secrets for a function app. Get host secrets for a function app. |
list_host_name_bindings |
Get hostname bindings for an app or a deployment slot. 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. Get hostname bindings for an app or a deployment slot. |
list_hybrid_connections |
Retrieves all Service Bus Hybrid Connections used by this Web App. 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. 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. List the functions for a web site, or a deployment slot. |
list_instance_identifiers |
Gets all scale-out instances of an app. Gets all scale-out instances of an app. |
list_instance_identifiers_slot |
Gets all scale-out instances of an app. 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. 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. 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. 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. 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. 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. 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. Gets the metadata of an app. |
list_metadata_slot |
Gets the metadata of an app. Gets the metadata of an app. |
list_network_features |
Gets all network features used by the app (or deployment slot, if specified). 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). Gets all network features used by the app (or deployment slot, if specified). |
list_perf_mon_counters |
Gets perfmon counters for web app. Gets perfmon counters for web app. |
list_perf_mon_counters_slot |
Gets perfmon counters for web app. Gets perfmon counters for web app. |
list_premier_add_ons |
Gets the premier add-ons of an app. Gets the premier add-ons of an app. |
list_premier_add_ons_slot |
Gets the premier add-ons of an app. 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. 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. 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. 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. 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. 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. 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. Get public certificates for an app or a deployment slot. |
list_public_certificates_slot |
Get public certificates for an app or a deployment slot. 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). 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). 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). 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). Gets hybrid connections configured for an app (or deployment slot, if specified). |
list_site_backups |
Gets existing backups of an app. Gets existing backups of an app. |
list_site_backups_slot |
Gets existing backups of an app. Gets existing backups of an app. |
list_site_extensions |
Get list of siteextensions for a web site, or a deployment slot. 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. Get list of siteextensions for a web site, or a deployment slot. |
list_site_push_settings |
Gets the Push settings associated with web app. Gets the Push settings associated with web app. |
list_site_push_settings_slot |
Gets the Push settings associated with web app. 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). 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. 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. Get the difference in configuration settings between two web app slots. |
list_slots |
Gets an app's deployment slots. Gets an app's deployment slots. |
list_snapshots |
Returns all Snapshots to the user. Returns all Snapshots to the user. |
list_snapshots_from_dr_secondary |
Returns all Snapshots to the user from DRSecondary endpoint. Returns all Snapshots to the user from DRSecondary endpoint. |
list_snapshots_from_dr_secondary_slot |
Returns all Snapshots to the user from DRSecondary endpoint. Returns all Snapshots to the user from DRSecondary endpoint. |
list_snapshots_slot |
Returns all Snapshots to the user. Returns all Snapshots to the user. |
list_sync_function_triggers |
This is to allow calling via powershell and ARM template. 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. This is to allow calling via powershell and ARM template. |
list_sync_status |
This is to allow calling via powershell and ARM template. This is to allow calling via powershell and ARM template. |
list_sync_status_slot |
This is to allow calling via powershell and ARM template. 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. 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. 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. 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. 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). 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). 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. 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. Gets the virtual networks the app (or deployment slot) is connected to. |
list_web_jobs |
List webjobs for an app, or a deployment slot. List webjobs for an app, or a deployment slot. |
list_web_jobs_slot |
List webjobs for an app, or a deployment slot. 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. 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. 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. 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. 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. 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. 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). Restarts an app (or deployment slot, if specified). |
restart_slot |
Restarts an app (or deployment slot, if specified). Restarts an app (or deployment slot, if specified). |
run_triggered_web_job |
Run a triggered web job for an app, or a deployment slot. 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. Run a triggered web job for an app, or a deployment slot. |
start |
Starts an app (or deployment slot, if specified). Starts an app (or deployment slot, if specified). |
start_continuous_web_job |
Start a continuous web job for an app, or a deployment slot. 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. Start a continuous web job for an app, or a deployment slot. |
start_slot |
Starts an app (or deployment slot, if specified). Starts an app (or deployment slot, if specified). |
start_web_site_network_trace |
Start capturing network packets for the site (To be deprecated). 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). Start capturing network packets for the site (To be deprecated). |
stop |
Stops an app (or deployment slot, if specified). Stops an app (or deployment slot, if specified). |
stop_continuous_web_job |
Stop a continuous web job for an app, or a deployment slot. 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. Stop a continuous web job for an app, or a deployment slot. |
stop_network_trace |
Stop ongoing capturing network packets for the site. Stop ongoing capturing network packets for the site. |
stop_network_trace_slot |
Stop ongoing capturing network packets for the site. Stop ongoing capturing network packets for the site. |
stop_slot |
Stops an app (or deployment slot, if specified). Stops an app (or deployment slot, if specified). |
stop_web_site_network_trace |
Stop ongoing capturing network packets for the site. Stop ongoing capturing network packets for the site. |
stop_web_site_network_trace_slot |
Stop ongoing capturing network packets for the site. Stop ongoing capturing network packets for the site. |
sync_function_triggers |
Syncs function trigger metadata to the management database. Syncs function trigger metadata to the management database. |
sync_function_triggers_slot |
Syncs function trigger metadata to the management database. Syncs function trigger metadata to the management database. |
sync_functions |
Syncs function trigger metadata to the management database. Syncs function trigger metadata to the management database. |
sync_functions_slot |
Syncs function trigger metadata to the management database. Syncs function trigger metadata to the management database. |
sync_repository |
Sync web app repository. Sync web app repository. |
sync_repository_slot |
Sync web app repository. Sync web app repository. |
update |
Creates a new web, mobile, or API app in an existing resource group, or updates an existing app. 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. Replaces the application settings of an app. |
update_application_settings_slot |
Replaces the application settings of an app. Replaces the application settings of an app. |
update_auth_settings |
Updates the Authentication / Authorization settings associated with web app. Updates the Authentication / Authorization settings associated with web app. |
update_auth_settings_slot |
Updates the Authentication / Authorization settings associated with web app. 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. 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. 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. Updates the Azure storage account configurations of an app. |
update_azure_storage_accounts_slot |
Updates the Azure storage account configurations of an app. Updates the Azure storage account configurations of an app. |
update_backup_configuration |
Updates the backup configuration of an app. Updates the backup configuration of an app. |
update_backup_configuration_slot |
Updates the backup configuration of an app. Updates the backup configuration of an app. |
update_configuration |
Updates the configuration of an app. Updates the configuration of an app. |
update_configuration_slot |
Updates the configuration of an app. Updates the configuration of an app. |
update_connection_strings |
Replaces the connection strings of an app. Replaces the connection strings of an app. |
update_connection_strings_slot |
Replaces the connection strings of an app. Replaces the connection strings of an app. |
update_diagnostic_logs_config |
Updates the logging configuration of an app. Updates the logging configuration of an app. |
update_diagnostic_logs_config_slot |
Updates the logging configuration of an app. 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. 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. 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. Updates whether FTP is allowed on the site or not. |
update_ftp_allowed_slot |
Updates whether FTP is allowed on the site or not. Updates whether FTP is allowed on the site or not. |
update_hybrid_connection |
Creates a new Hybrid Connection using a Service Bus relay. Creates a new Hybrid Connection using a Service Bus relay. |
update_hybrid_connection_slot |
Creates a new Hybrid Connection using a Service Bus relay. Creates a new Hybrid Connection using a Service Bus relay. |
update_metadata |
Replaces the metadata of an app. Replaces the metadata of an app. |
update_metadata_slot |
Replaces the metadata of an app. Replaces the metadata of an app. |
update_premier_add_on |
Updates a named add-on of an app. Updates a named add-on of an app. |
update_premier_add_on_slot |
Updates a named add-on of an app. 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). 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). 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. 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. Updates whether user publishing credentials are allowed on the site or not. |
update_site_push_settings |
Updates the Push settings associated with web app. Updates the Push settings associated with web app. |
update_site_push_settings_slot |
Updates the Push settings associated with web app. 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. 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. 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. Updates the source control configuration of an app. |
update_source_control_slot |
Updates the source control configuration of an app. Updates the source control configuration of an app. |
update_vnet_connection |
Adds a Virtual Network connection to an app or slot (PUT) or updates the connection properties (PATCH). 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). 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). 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). 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.
Updates a named add-on of an app.
add_premier_add_on(resource_group_name: str, name: str, premier_add_on_name: str, premier_add_on: _models.PremierAddOn, *, content_type: str = 'application/json', **kwargs: Any) -> _models.PremierAddOn
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
premier_add_on_name
Required
|
Add-on name. Required. |
premier_add_on
Required
|
A JSON representation of the edited premier add-on. Is either a PremierAddOn type or a IO[bytes] type. Required. |
Returns
Type | Description |
---|---|
PremierAddOn or the result of cls(response) |
Exceptions
Type | Description |
---|---|
add_premier_add_on_slot
Updates a named add-on of an app.
Updates a named add-on of an app.
add_premier_add_on_slot(resource_group_name: str, name: str, premier_add_on_name: str, slot: str, premier_add_on: _models.PremierAddOn, *, content_type: str = 'application/json', **kwargs: Any) -> _models.PremierAddOn
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
premier_add_on_name
Required
|
Add-on name. Required. |
slot
Required
|
Name of the deployment slot. If a slot is not specified, the API will update the named add-on for the production slot. Required. |
premier_add_on
Required
|
A JSON representation of the edited premier add-on. Is either a PremierAddOn type or a IO[bytes] type. Required. |
Returns
Type | Description |
---|---|
PremierAddOn or the result of cls(response) |
Exceptions
Type | Description |
---|---|
analyze_custom_hostname
Analyze a custom hostname.
Analyze a custom hostname.
analyze_custom_hostname(resource_group_name: str, name: str, host_name: str | None = None, **kwargs: Any) -> CustomHostnameAnalysisResult
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of web app. Required. |
host_name
Required
|
Custom hostname. Default value is None. |
Returns
Type | Description |
---|---|
CustomHostnameAnalysisResult or the result of cls(response) |
Exceptions
Type | Description |
---|---|
analyze_custom_hostname_slot
Analyze a custom hostname.
Analyze a custom hostname.
analyze_custom_hostname_slot(resource_group_name: str, name: str, slot: str, host_name: str | None = None, **kwargs: Any) -> CustomHostnameAnalysisResult
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of web app. Required. |
slot
Required
|
Name of web app slot. If not specified then will default to production slot. Required. |
host_name
Required
|
Custom hostname. Default value is None. |
Returns
Type | Description |
---|---|
CustomHostnameAnalysisResult or the result of cls(response) |
Exceptions
Type | Description |
---|---|
apply_slot_config_to_production
Applies the configuration settings from the target slot onto the current slot.
Applies the configuration settings from the target slot onto the current slot.
apply_slot_config_to_production(resource_group_name: str, name: str, slot_swap_entity: _models.CsmSlotEntity, *, content_type: str = 'application/json', **kwargs: Any) -> None
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
slot_swap_entity
Required
|
JSON object that contains the target slot name. See example. Is either a CsmSlotEntity type or a IO[bytes] type. Required. |
Returns
Type | Description |
---|---|
None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
apply_slot_configuration_slot
Applies the configuration settings from the target slot onto the current slot.
Applies the configuration settings from the target slot onto the current slot.
apply_slot_configuration_slot(resource_group_name: str, name: str, slot: str, slot_swap_entity: _models.CsmSlotEntity, *, content_type: str = 'application/json', **kwargs: Any) -> None
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
slot
Required
|
Name of the source slot. If a slot is not specified, the production slot is used as the source slot. Required. |
slot_swap_entity
Required
|
JSON object that contains the target slot name. See example. Is either a CsmSlotEntity type or a IO[bytes] type. Required. |
Returns
Type | Description |
---|---|
None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
backup
Creates a backup of an app.
Creates a backup of an app.
backup(resource_group_name: str, name: str, request: _models.BackupRequest, *, content_type: str = 'application/json', **kwargs: Any) -> _models.BackupItem
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
request
Required
|
Backup configuration. You can use the JSON response from the POST action as input here. Is either a BackupRequest type or a IO[bytes] type. Required. |
Returns
Type | Description |
---|---|
BackupItem or the result of cls(response) |
Exceptions
Type | Description |
---|---|
backup_slot
Creates a backup of an app.
Creates a backup of an app.
backup_slot(resource_group_name: str, name: str, slot: str, request: _models.BackupRequest, *, content_type: str = 'application/json', **kwargs: Any) -> _models.BackupItem
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
slot
Required
|
Name of the deployment slot. If a slot is not specified, the API will create a backup for the production slot. Required. |
request
Required
|
Backup configuration. You can use the JSON response from the POST action as input here. Is either a BackupRequest type or a IO[bytes] type. Required. |
Returns
Type | Description |
---|---|
BackupItem or the result of cls(response) |
Exceptions
Type | Description |
---|---|
begin_approve_or_reject_private_endpoint_connection
Approves or rejects a private endpoint connection.
Approves or rejects a private endpoint connection.
begin_approve_or_reject_private_endpoint_connection(resource_group_name: str, name: str, private_endpoint_connection_name: str, private_endpoint_wrapper: _models.RemotePrivateEndpointConnectionARMResource, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.RemotePrivateEndpointConnectionARMResource]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the site. Required. |
private_endpoint_connection_name
Required
|
Required. |
private_endpoint_wrapper
Required
|
Is either a RemotePrivateEndpointConnectionARMResource type or a IO[bytes] type. Required. |
Returns
Type | Description |
---|---|
An instance of LROPoller that returns either RemotePrivateEndpointConnectionARMResource or the result of cls(response) |
Exceptions
Type | Description |
---|---|
begin_approve_or_reject_private_endpoint_connection_slot
Approves or rejects a private endpoint connection.
Approves or rejects a private endpoint connection.
begin_approve_or_reject_private_endpoint_connection_slot(resource_group_name: str, name: str, private_endpoint_connection_name: str, slot: str, private_endpoint_wrapper: _models.RemotePrivateEndpointConnectionARMResource, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.RemotePrivateEndpointConnectionARMResource]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the site. Required. |
private_endpoint_connection_name
Required
|
Required. |
slot
Required
|
Required. |
private_endpoint_wrapper
Required
|
Is either a RemotePrivateEndpointConnectionARMResource type or a IO[bytes] type. Required. |
Returns
Type | Description |
---|---|
An instance of LROPoller that returns either RemotePrivateEndpointConnectionARMResource or the result of cls(response) |
Exceptions
Type | Description |
---|---|
begin_create_function
Create function for web site, or a deployment slot.
Create function for web site, or a deployment slot.
begin_create_function(resource_group_name: str, name: str, function_name: str, function_envelope: _models.FunctionEnvelope, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.FunctionEnvelope]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Site name. Required. |
function_name
Required
|
Function name. Required. |
function_envelope
Required
|
Function details. Is either a FunctionEnvelope type or a IO[bytes] type. Required. |
Returns
Type | Description |
---|---|
An instance of LROPoller that returns either FunctionEnvelope or the result of cls(response) |
Exceptions
Type | Description |
---|---|
begin_create_instance_function_slot
Create function for web site, or a deployment slot.
Create function for web site, or a deployment slot.
begin_create_instance_function_slot(resource_group_name: str, name: str, function_name: str, slot: str, function_envelope: _models.FunctionEnvelope, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.FunctionEnvelope]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Site name. Required. |
function_name
Required
|
Function name. Required. |
slot
Required
|
Name of the deployment slot. Required. |
function_envelope
Required
|
Function details. Is either a FunctionEnvelope type or a IO[bytes] type. Required. |
Returns
Type | Description |
---|---|
An instance of LROPoller that returns either FunctionEnvelope or the result of cls(response) |
Exceptions
Type | Description |
---|---|
begin_create_instance_ms_deploy_operation
Invoke the MSDeploy web app extension.
Invoke the MSDeploy web app extension.
begin_create_instance_ms_deploy_operation(resource_group_name: str, name: str, instance_id: str, ms_deploy: _models.MSDeploy, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.MSDeployStatus]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of web app. Required. |
instance_id
Required
|
ID of web app instance. Required. |
ms_deploy
Required
|
Details of MSDeploy operation. Is either a MSDeploy type or a IO[bytes] type. Required. |
Returns
Type | Description |
---|---|
An instance of LROPoller that returns either MSDeployStatus or the result of cls(response) |
Exceptions
Type | Description |
---|---|
begin_create_instance_ms_deploy_operation_slot
Invoke the MSDeploy web app extension.
Invoke the MSDeploy web app extension.
begin_create_instance_ms_deploy_operation_slot(resource_group_name: str, name: str, slot: str, instance_id: str, ms_deploy: _models.MSDeploy, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.MSDeployStatus]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of web app. Required. |
slot
Required
|
Name of web app slot. If not specified then will default to production slot. Required. |
instance_id
Required
|
ID of web app instance. Required. |
ms_deploy
Required
|
Details of MSDeploy operation. Is either a MSDeploy type or a IO[bytes] type. Required. |
Returns
Type | Description |
---|---|
An instance of LROPoller that returns either MSDeployStatus or the result of cls(response) |
Exceptions
Type | Description |
---|---|
begin_create_ms_deploy_operation
Invoke the MSDeploy web app extension.
Invoke the MSDeploy web app extension.
begin_create_ms_deploy_operation(resource_group_name: str, name: str, ms_deploy: _models.MSDeploy, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.MSDeployStatus]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of web app. Required. |
ms_deploy
Required
|
Details of MSDeploy operation. Is either a MSDeploy type or a IO[bytes] type. Required. |
Returns
Type | Description |
---|---|
An instance of LROPoller that returns either MSDeployStatus or the result of cls(response) |
Exceptions
Type | Description |
---|---|
begin_create_ms_deploy_operation_slot
Invoke the MSDeploy web app extension.
Invoke the MSDeploy web app extension.
begin_create_ms_deploy_operation_slot(resource_group_name: str, name: str, slot: str, ms_deploy: _models.MSDeploy, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.MSDeployStatus]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of web app. Required. |
slot
Required
|
Name of web app slot. If not specified then will default to production slot. Required. |
ms_deploy
Required
|
Details of MSDeploy operation. Is either a MSDeploy type or a IO[bytes] type. Required. |
Returns
Type | Description |
---|---|
An instance of LROPoller that returns either MSDeployStatus or the result of cls(response) |
Exceptions
Type | Description |
---|---|
begin_create_or_update
Creates a new web, mobile, or API app in an existing resource group, or updates an existing app.
Creates a new web, mobile, or API app in an existing resource group, or updates an existing app.
begin_create_or_update(resource_group_name: str, name: str, site_envelope: _models.Site, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.Site]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Unique name of the app to create or update. To create or update a deployment slot, use the {slot} parameter. Required. |
site_envelope
Required
|
A JSON representation of the app properties. See example. Is either a Site type or a IO[bytes] type. Required. |
Returns
Type | Description |
---|---|
An instance of LROPoller that returns either Site or the result of cls(response) |
Exceptions
Type | Description |
---|---|
begin_create_or_update_slot
Creates a new web, mobile, or API app in an existing resource group, or updates an existing app.
Creates a new web, mobile, or API app in an existing resource group, or updates an existing app.
begin_create_or_update_slot(resource_group_name: str, name: str, slot: str, site_envelope: _models.Site, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.Site]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Unique name of the app to create or update. To create or update a deployment slot, use the {slot} parameter. Required. |
slot
Required
|
Name of the deployment slot to create or update. The name 'production' is reserved. Required. |
site_envelope
Required
|
A JSON representation of the app properties. See example. Is either a Site type or a IO[bytes] type. Required. |
Returns
Type | Description |
---|---|
An instance of LROPoller that returns either Site or the result of cls(response) |
Exceptions
Type | Description |
---|---|
begin_create_or_update_source_control
Updates the source control configuration of an app.
Updates the source control configuration of an app.
begin_create_or_update_source_control(resource_group_name: str, name: str, site_source_control: _models.SiteSourceControl, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.SiteSourceControl]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
site_source_control
Required
|
JSON representation of a SiteSourceControl object. See example. Is either a SiteSourceControl type or a IO[bytes] type. Required. |
Returns
Type | Description |
---|---|
An instance of LROPoller that returns either SiteSourceControl or the result of cls(response) |
Exceptions
Type | Description |
---|---|
begin_create_or_update_source_control_slot
Updates the source control configuration of an app.
Updates the source control configuration of an app.
begin_create_or_update_source_control_slot(resource_group_name: str, name: str, slot: str, site_source_control: _models.SiteSourceControl, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.SiteSourceControl]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
slot
Required
|
Name of the deployment slot. If a slot is not specified, the API will update the source control configuration for the production slot. Required. |
site_source_control
Required
|
JSON representation of a SiteSourceControl object. See example. Is either a SiteSourceControl type or a IO[bytes] type. Required. |
Returns
Type | Description |
---|---|
An instance of LROPoller that returns either SiteSourceControl or the result of cls(response) |
Exceptions
Type | Description |
---|---|
begin_delete_private_endpoint_connection
Deletes a private endpoint connection.
Deletes a private endpoint connection.
begin_delete_private_endpoint_connection(resource_group_name: str, name: str, private_endpoint_connection_name: str, **kwargs: Any) -> LROPoller[MutableMapping[str, Any]]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the site. Required. |
private_endpoint_connection_name
Required
|
Required. |
Returns
Type | Description |
---|---|
LROPoller[<xref:JSON>]
|
An instance of LROPoller that returns either JSON or the result of cls(response) |
Exceptions
Type | Description |
---|---|
begin_delete_private_endpoint_connection_slot
Deletes a private endpoint connection.
Deletes a private endpoint connection.
begin_delete_private_endpoint_connection_slot(resource_group_name: str, name: str, private_endpoint_connection_name: str, slot: str, **kwargs: Any) -> LROPoller[MutableMapping[str, Any]]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the site. Required. |
private_endpoint_connection_name
Required
|
Required. |
slot
Required
|
Required. |
Returns
Type | Description |
---|---|
LROPoller[<xref:JSON>]
|
An instance of LROPoller that returns either JSON or the result of cls(response) |
Exceptions
Type | Description |
---|---|
begin_install_site_extension
Install site extension on a web site, or a deployment slot.
Install site extension on a web site, or a deployment slot.
begin_install_site_extension(resource_group_name: str, name: str, site_extension_id: str, **kwargs: Any) -> LROPoller[SiteExtensionInfo]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Site name. Required. |
site_extension_id
Required
|
Site extension name. Required. |
Returns
Type | Description |
---|---|
An instance of LROPoller that returns either SiteExtensionInfo or the result of cls(response) |
Exceptions
Type | Description |
---|---|
begin_install_site_extension_slot
Install site extension on a web site, or a deployment slot.
Install site extension on a web site, or a deployment slot.
begin_install_site_extension_slot(resource_group_name: str, name: str, site_extension_id: str, slot: str, **kwargs: Any) -> LROPoller[SiteExtensionInfo]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Site name. Required. |
site_extension_id
Required
|
Site extension name. Required. |
slot
Required
|
Name of the deployment slot. If a slot is not specified, the API uses the production slot. Required. |
Returns
Type | Description |
---|---|
An instance of LROPoller that returns either SiteExtensionInfo or the result of cls(response) |
Exceptions
Type | Description |
---|---|
begin_list_publishing_credentials
Gets the Git/FTP publishing credentials of an app.
Gets the Git/FTP publishing credentials of an app.
begin_list_publishing_credentials(resource_group_name: str, name: str, **kwargs: Any) -> LROPoller[User]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
Returns
Type | Description |
---|---|
An instance of LROPoller that returns either User or the result of cls(response) |
Exceptions
Type | Description |
---|---|
begin_list_publishing_credentials_slot
Gets the Git/FTP publishing credentials of an app.
Gets the Git/FTP publishing credentials of an app.
begin_list_publishing_credentials_slot(resource_group_name: str, name: str, slot: str, **kwargs: Any) -> LROPoller[User]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
slot
Required
|
Name of the deployment slot. If a slot is not specified, the API will get the publishing credentials for the production slot. Required. |
Returns
Type | Description |
---|---|
An instance of LROPoller that returns either User or the result of cls(response) |
Exceptions
Type | Description |
---|---|
begin_migrate_my_sql
Migrates a local (in-app) MySql database to a remote MySql database.
Migrates a local (in-app) MySql database to a remote MySql database.
begin_migrate_my_sql(resource_group_name: str, name: str, migration_request_envelope: _models.MigrateMySqlRequest, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.Operation]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of web app. Required. |
migration_request_envelope
Required
|
MySql migration options. Is either a MigrateMySqlRequest type or a IO[bytes] type. Required. |
Returns
Type | Description |
---|---|
An instance of LROPoller that returns either Operation or the result of cls(response) |
Exceptions
Type | Description |
---|---|
begin_migrate_storage
Restores a web app.
Restores a web app.
begin_migrate_storage(subscription_name: str, resource_group_name: str, name: str, migration_options: _models.StorageMigrationOptions, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.StorageMigrationResponse]
Parameters
Name | Description |
---|---|
subscription_name
Required
|
Azure subscription. Required. |
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of web app. Required. |
migration_options
Required
|
Migration migrationOptions. Is either a StorageMigrationOptions type or a IO[bytes] type. Required. |
Returns
Type | Description |
---|---|
An instance of LROPoller that returns either StorageMigrationResponse or the result of cls(response) |
Exceptions
Type | Description |
---|---|
begin_restore
Restores a specific backup to another app (or deployment slot, if specified).
Restores a specific backup to another app (or deployment slot, if specified).
begin_restore(resource_group_name: str, name: str, backup_id: str, request: _models.RestoreRequest, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[None]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
backup_id
Required
|
ID of the backup. Required. |
request
Required
|
Information on restore request . Is either a RestoreRequest type or a IO[bytes] type. Required. |
Returns
Type | Description |
---|---|
An instance of LROPoller that returns either None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
begin_restore_from_backup_blob
Restores an app from a backup blob in Azure Storage.
Restores an app from a backup blob in Azure Storage.
begin_restore_from_backup_blob(resource_group_name: str, name: str, request: _models.RestoreRequest, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[None]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
request
Required
|
Information on restore request . Is either a RestoreRequest type or a IO[bytes] type. Required. |
Returns
Type | Description |
---|---|
An instance of LROPoller that returns either None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
begin_restore_from_backup_blob_slot
Restores an app from a backup blob in Azure Storage.
Restores an app from a backup blob in Azure Storage.
begin_restore_from_backup_blob_slot(resource_group_name: str, name: str, slot: str, request: _models.RestoreRequest, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[None]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
slot
Required
|
Name of the deployment slot. If a slot is not specified, the API will restore a backup of the production slot. Required. |
request
Required
|
Information on restore request . Is either a RestoreRequest type or a IO[bytes] type. Required. |
Returns
Type | Description |
---|---|
An instance of LROPoller that returns either None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
begin_restore_from_deleted_app
Restores a deleted web app to this web app.
Restores a deleted web app to this web app.
begin_restore_from_deleted_app(resource_group_name: str, name: str, restore_request: _models.DeletedAppRestoreRequest, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[None]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of web app. Required. |
restore_request
Required
|
Deleted web app restore information. Is either a DeletedAppRestoreRequest type or a IO[bytes] type. Required. |
Returns
Type | Description |
---|---|
An instance of LROPoller that returns either None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
begin_restore_from_deleted_app_slot
Restores a deleted web app to this web app.
Restores a deleted web app to this web app.
begin_restore_from_deleted_app_slot(resource_group_name: str, name: str, slot: str, restore_request: _models.DeletedAppRestoreRequest, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[None]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of web app. Required. |
slot
Required
|
Name of web app slot. If not specified then will default to production slot. Required. |
restore_request
Required
|
Deleted web app restore information. Is either a DeletedAppRestoreRequest type or a IO[bytes] type. Required. |
Returns
Type | Description |
---|---|
An instance of LROPoller that returns either None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
begin_restore_slot
Restores a specific backup to another app (or deployment slot, if specified).
Restores a specific backup to another app (or deployment slot, if specified).
begin_restore_slot(resource_group_name: str, name: str, backup_id: str, slot: str, request: _models.RestoreRequest, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[None]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
backup_id
Required
|
ID of the backup. Required. |
slot
Required
|
Name of the deployment slot. If a slot is not specified, the API will restore a backup of the production slot. Required. |
request
Required
|
Information on restore request . Is either a RestoreRequest type or a IO[bytes] type. Required. |
Returns
Type | Description |
---|---|
An instance of LROPoller that returns either None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
begin_restore_snapshot
Restores a web app from a snapshot.
Restores a web app from a snapshot.
begin_restore_snapshot(resource_group_name: str, name: str, restore_request: _models.SnapshotRestoreRequest, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[None]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of web app. Required. |
restore_request
Required
|
Snapshot restore settings. Snapshot information can be obtained by calling GetDeletedSites or GetSiteSnapshots API. Is either a SnapshotRestoreRequest type or a IO[bytes] type. Required. |
Returns
Type | Description |
---|---|
An instance of LROPoller that returns either None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
begin_restore_snapshot_slot
Restores a web app from a snapshot.
Restores a web app from a snapshot.
begin_restore_snapshot_slot(resource_group_name: str, name: str, slot: str, restore_request: _models.SnapshotRestoreRequest, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[None]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of web app. Required. |
slot
Required
|
Name of web app slot. If not specified then will default to production slot. Required. |
restore_request
Required
|
Snapshot restore settings. Snapshot information can be obtained by calling GetDeletedSites or GetSiteSnapshots API. Is either a SnapshotRestoreRequest type or a IO[bytes] type. Required. |
Returns
Type | Description |
---|---|
An instance of LROPoller that returns either None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
begin_start_network_trace
Start capturing network packets for the site.
Start capturing network packets for the site.
begin_start_network_trace(resource_group_name: str, name: str, duration_in_seconds: int | None = None, max_frame_length: int | None = None, sas_url: str | None = None, **kwargs: Any) -> LROPoller[List[NetworkTrace]]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
The name of the web app. Required. |
duration_in_seconds
Required
|
The duration to keep capturing in seconds. Default value is None. |
max_frame_length
Required
|
The maximum frame length in bytes (Optional). Default value is None. |
sas_url
Required
|
The Blob URL to store capture file. Default value is None. |
Returns
Type | Description |
---|---|
An instance of LROPoller that returns either list of NetworkTrace or the result of cls(response) |
Exceptions
Type | Description |
---|---|
begin_start_network_trace_slot
Start capturing network packets for the site.
Start capturing network packets for the site.
begin_start_network_trace_slot(resource_group_name: str, name: str, slot: str, duration_in_seconds: int | None = None, max_frame_length: int | None = None, sas_url: str | None = None, **kwargs: Any) -> LROPoller[List[NetworkTrace]]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
The name of the web app. Required. |
slot
Required
|
The name of the slot for this web app. Required. |
duration_in_seconds
Required
|
The duration to keep capturing in seconds. Default value is None. |
max_frame_length
Required
|
The maximum frame length in bytes (Optional). Default value is None. |
sas_url
Required
|
The Blob URL to store capture file. Default value is None. |
Returns
Type | Description |
---|---|
An instance of LROPoller that returns either list of NetworkTrace or the result of cls(response) |
Exceptions
Type | Description |
---|---|
begin_start_web_site_network_trace_operation
Start capturing network packets for the site.
Start capturing network packets for the site.
begin_start_web_site_network_trace_operation(resource_group_name: str, name: str, duration_in_seconds: int | None = None, max_frame_length: int | None = None, sas_url: str | None = None, **kwargs: Any) -> LROPoller[List[NetworkTrace]]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
The name of the web app. Required. |
duration_in_seconds
Required
|
The duration to keep capturing in seconds. Default value is None. |
max_frame_length
Required
|
The maximum frame length in bytes (Optional). Default value is None. |
sas_url
Required
|
The Blob URL to store capture file. Default value is None. |
Returns
Type | Description |
---|---|
An instance of LROPoller that returns either list of NetworkTrace or the result of cls(response) |
Exceptions
Type | Description |
---|---|
begin_start_web_site_network_trace_operation_slot
Start capturing network packets for the site.
Start capturing network packets for the site.
begin_start_web_site_network_trace_operation_slot(resource_group_name: str, name: str, slot: str, duration_in_seconds: int | None = None, max_frame_length: int | None = None, sas_url: str | None = None, **kwargs: Any) -> LROPoller[List[NetworkTrace]]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
The name of the web app. Required. |
slot
Required
|
The name of the slot for this web app. Required. |
duration_in_seconds
Required
|
The duration to keep capturing in seconds. Default value is None. |
max_frame_length
Required
|
The maximum frame length in bytes (Optional). Default value is None. |
sas_url
Required
|
The Blob URL to store capture file. Default value is None. |
Returns
Type | Description |
---|---|
An instance of LROPoller that returns either list of NetworkTrace or the result of cls(response) |
Exceptions
Type | Description |
---|---|
begin_swap_slot
Swaps two deployment slots of an app.
Swaps two deployment slots of an app.
begin_swap_slot(resource_group_name: str, name: str, slot: str, slot_swap_entity: _models.CsmSlotEntity, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[None]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
slot
Required
|
Name of the source slot. If a slot is not specified, the production slot is used as the source slot. Required. |
slot_swap_entity
Required
|
JSON object that contains the target slot name. See example. Is either a CsmSlotEntity type or a IO[bytes] type. Required. |
Returns
Type | Description |
---|---|
An instance of LROPoller that returns either None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
begin_swap_slot_with_production
Swaps two deployment slots of an app.
Swaps two deployment slots of an app.
begin_swap_slot_with_production(resource_group_name: str, name: str, slot_swap_entity: _models.CsmSlotEntity, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[None]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
slot_swap_entity
Required
|
JSON object that contains the target slot name. See example. Is either a CsmSlotEntity type or a IO[bytes] type. Required. |
Returns
Type | Description |
---|---|
An instance of LROPoller that returns either None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
create_deployment
Create a deployment for an app, or a deployment slot.
Create a deployment for an app, or a deployment slot.
create_deployment(resource_group_name: str, name: str, id: str, deployment: _models.Deployment, *, content_type: str = 'application/json', **kwargs: Any) -> _models.Deployment
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
id
Required
|
ID of an existing deployment. Required. |
deployment
Required
|
Deployment details. Is either a Deployment type or a IO[bytes] type. Required. |
Returns
Type | Description |
---|---|
Deployment or the result of cls(response) |
Exceptions
Type | Description |
---|---|
create_deployment_slot
Create a deployment for an app, or a deployment slot.
Create a deployment for an app, or a deployment slot.
create_deployment_slot(resource_group_name: str, name: str, id: str, slot: str, deployment: _models.Deployment, *, content_type: str = 'application/json', **kwargs: Any) -> _models.Deployment
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
id
Required
|
ID of an existing deployment. Required. |
slot
Required
|
Name of the deployment slot. If a slot is not specified, the API creates a deployment for the production slot. Required. |
deployment
Required
|
Deployment details. Is either a Deployment type or a IO[bytes] type. Required. |
Returns
Type | Description |
---|---|
Deployment or the result of cls(response) |
Exceptions
Type | Description |
---|---|
create_or_update_configuration
Updates the configuration of an app.
Updates the configuration of an app.
create_or_update_configuration(resource_group_name: str, name: str, site_config: _models.SiteConfigResource, *, content_type: str = 'application/json', **kwargs: Any) -> _models.SiteConfigResource
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
site_config
Required
|
JSON representation of a SiteConfig object. See example. Is either a SiteConfigResource type or a IO[bytes] type. Required. |
Returns
Type | Description |
---|---|
SiteConfigResource or the result of cls(response) |
Exceptions
Type | Description |
---|---|
create_or_update_configuration_slot
Updates the configuration of an app.
Updates the configuration of an app.
create_or_update_configuration_slot(resource_group_name: str, name: str, slot: str, site_config: _models.SiteConfigResource, *, content_type: str = 'application/json', **kwargs: Any) -> _models.SiteConfigResource
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
slot
Required
|
Name of the deployment slot. If a slot is not specified, the API will update configuration for the production slot. Required. |
site_config
Required
|
JSON representation of a SiteConfig object. See example. Is either a SiteConfigResource type or a IO[bytes] type. Required. |
Returns
Type | Description |
---|---|
SiteConfigResource or the result of cls(response) |
Exceptions
Type | Description |
---|---|
create_or_update_domain_ownership_identifier
Creates a domain ownership identifier for web app, or updates an existing ownership identifier.
Creates a domain ownership identifier for web app, or updates an existing ownership identifier.
create_or_update_domain_ownership_identifier(resource_group_name: str, name: str, domain_ownership_identifier_name: str, domain_ownership_identifier: _models.Identifier, *, content_type: str = 'application/json', **kwargs: Any) -> _models.Identifier
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
domain_ownership_identifier_name
Required
|
Name of domain ownership identifier. Required. |
domain_ownership_identifier
Required
|
A JSON representation of the domain ownership properties. Is either a Identifier type or a IO[bytes] type. Required. |
Returns
Type | Description |
---|---|
Identifier or the result of cls(response) |
Exceptions
Type | Description |
---|---|
create_or_update_domain_ownership_identifier_slot
Creates a domain ownership identifier for web app, or updates an existing ownership identifier.
Creates a domain ownership identifier for web app, or updates an existing ownership identifier.
create_or_update_domain_ownership_identifier_slot(resource_group_name: str, name: str, domain_ownership_identifier_name: str, slot: str, domain_ownership_identifier: _models.Identifier, *, content_type: str = 'application/json', **kwargs: Any) -> _models.Identifier
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
domain_ownership_identifier_name
Required
|
Name of domain ownership identifier. Required. |
slot
Required
|
Name of the deployment slot. If a slot is not specified, the API will delete the binding for the production slot. Required. |
domain_ownership_identifier
Required
|
A JSON representation of the domain ownership properties. Is either a Identifier type or a IO[bytes] type. Required. |
Returns
Type | Description |
---|---|
Identifier or the result of cls(response) |
Exceptions
Type | Description |
---|---|
create_or_update_function_secret
Add or update a function secret.
Add or update a function secret.
create_or_update_function_secret(resource_group_name: str, name: str, function_name: str, key_name: str, key: _models.KeyInfo, *, content_type: str = 'application/json', **kwargs: Any) -> _models.KeyInfo
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Site name. Required. |
function_name
Required
|
The name of the function. Required. |
key_name
Required
|
The name of the key. Required. |
key
Required
|
The key to create or update. Is either a KeyInfo type or a IO[bytes] type. Required. |
Returns
Type | Description |
---|---|
KeyInfo or the result of cls(response) |
Exceptions
Type | Description |
---|---|
create_or_update_function_secret_slot
Add or update a function secret.
Add or update a function secret.
create_or_update_function_secret_slot(resource_group_name: str, name: str, function_name: str, key_name: str, slot: str, key: _models.KeyInfo, *, content_type: str = 'application/json', **kwargs: Any) -> _models.KeyInfo
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Site name. Required. |
function_name
Required
|
The name of the function. Required. |
key_name
Required
|
The name of the key. Required. |
slot
Required
|
Name of the deployment slot. Required. |
key
Required
|
The key to create or update. Is either a KeyInfo type or a IO[bytes] type. Required. |
Returns
Type | Description |
---|---|
KeyInfo or the result of cls(response) |
Exceptions
Type | Description |
---|---|
create_or_update_host_name_binding
Creates a hostname binding for an app.
Creates a hostname binding for an app.
create_or_update_host_name_binding(resource_group_name: str, name: str, host_name: str, host_name_binding: _models.HostNameBinding, *, content_type: str = 'application/json', **kwargs: Any) -> _models.HostNameBinding
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
host_name
Required
|
Hostname in the hostname binding. Required. |
host_name_binding
Required
|
Binding details. This is the JSON representation of a HostNameBinding object. Is either a HostNameBinding type or a IO[bytes] type. Required. |
Returns
Type | Description |
---|---|
HostNameBinding or the result of cls(response) |
Exceptions
Type | Description |
---|---|
create_or_update_host_name_binding_slot
Creates a hostname binding for an app.
Creates a hostname binding for an app.
create_or_update_host_name_binding_slot(resource_group_name: str, name: str, host_name: str, slot: str, host_name_binding: _models.HostNameBinding, *, content_type: str = 'application/json', **kwargs: Any) -> _models.HostNameBinding
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
host_name
Required
|
Hostname in the hostname binding. Required. |
slot
Required
|
Name of the deployment slot. If a slot is not specified, the API will create a binding for the production slot. Required. |
host_name_binding
Required
|
Binding details. This is the JSON representation of a HostNameBinding object. Is either a HostNameBinding type or a IO[bytes] type. Required. |
Returns
Type | Description |
---|---|
HostNameBinding or the result of cls(response) |
Exceptions
Type | Description |
---|---|
create_or_update_host_secret
Add or update a host level secret.
Add or update a host level secret.
create_or_update_host_secret(resource_group_name: str, name: str, key_type: str, key_name: str, key: _models.KeyInfo, *, content_type: str = 'application/json', **kwargs: Any) -> _models.KeyInfo
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Site name. Required. |
key_type
Required
|
The type of host key. Required. |
key_name
Required
|
The name of the key. Required. |
key
Required
|
The key to create or update. Is either a KeyInfo type or a IO[bytes] type. Required. |
Returns
Type | Description |
---|---|
KeyInfo or the result of cls(response) |
Exceptions
Type | Description |
---|---|
create_or_update_host_secret_slot
Add or update a host level secret.
Add or update a host level secret.
create_or_update_host_secret_slot(resource_group_name: str, name: str, key_type: str, key_name: str, slot: str, key: _models.KeyInfo, *, content_type: str = 'application/json', **kwargs: Any) -> _models.KeyInfo
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Site name. Required. |
key_type
Required
|
The type of host key. Required. |
key_name
Required
|
The name of the key. Required. |
slot
Required
|
Name of the deployment slot. Required. |
key
Required
|
The key to create or update. Is either a KeyInfo type or a IO[bytes] type. Required. |
Returns
Type | Description |
---|---|
KeyInfo or the result of cls(response) |
Exceptions
Type | Description |
---|---|
create_or_update_hybrid_connection
Creates a new Hybrid Connection using a Service Bus relay.
Creates a new Hybrid Connection using a Service Bus relay.
create_or_update_hybrid_connection(resource_group_name: str, name: str, namespace_name: str, relay_name: str, connection_envelope: _models.HybridConnection, *, content_type: str = 'application/json', **kwargs: Any) -> _models.HybridConnection
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
The name of the web app. Required. |
namespace_name
Required
|
The namespace for this hybrid connection. Required. |
relay_name
Required
|
The relay name for this hybrid connection. Required. |
connection_envelope
Required
|
The details of the hybrid connection. Is either a HybridConnection type or a IO[bytes] type. Required. |
Returns
Type | Description |
---|---|
HybridConnection or the result of cls(response) |
Exceptions
Type | Description |
---|---|
create_or_update_hybrid_connection_slot
Creates a new Hybrid Connection using a Service Bus relay.
Creates a new Hybrid Connection using a Service Bus relay.
create_or_update_hybrid_connection_slot(resource_group_name: str, name: str, namespace_name: str, relay_name: str, slot: str, connection_envelope: _models.HybridConnection, *, content_type: str = 'application/json', **kwargs: Any) -> _models.HybridConnection
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
The name of the web app. Required. |
namespace_name
Required
|
The namespace for this hybrid connection. Required. |
relay_name
Required
|
The relay name for this hybrid connection. Required. |
slot
Required
|
The name of the slot for the web app. Required. |
connection_envelope
Required
|
The details of the hybrid connection. Is either a HybridConnection type or a IO[bytes] type. Required. |
Returns
Type | Description |
---|---|
HybridConnection or the result of cls(response) |
Exceptions
Type | Description |
---|---|
create_or_update_public_certificate
Creates a hostname binding for an app.
Creates a hostname binding for an app.
create_or_update_public_certificate(resource_group_name: str, name: str, public_certificate_name: str, public_certificate: _models.PublicCertificate, *, content_type: str = 'application/json', **kwargs: Any) -> _models.PublicCertificate
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
public_certificate_name
Required
|
Public certificate name. Required. |
public_certificate
Required
|
Public certificate details. This is the JSON representation of a PublicCertificate object. Is either a PublicCertificate type or a IO[bytes] type. Required. |
Returns
Type | Description |
---|---|
PublicCertificate or the result of cls(response) |
Exceptions
Type | Description |
---|---|
create_or_update_public_certificate_slot
Creates a hostname binding for an app.
Creates a hostname binding for an app.
create_or_update_public_certificate_slot(resource_group_name: str, name: str, public_certificate_name: str, slot: str, public_certificate: _models.PublicCertificate, *, content_type: str = 'application/json', **kwargs: Any) -> _models.PublicCertificate
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
public_certificate_name
Required
|
Public certificate name. Required. |
slot
Required
|
Name of the deployment slot. If a slot is not specified, the API will create a binding for the production slot. Required. |
public_certificate
Required
|
Public certificate details. This is the JSON representation of a PublicCertificate object. Is either a PublicCertificate type or a IO[bytes] type. Required. |
Returns
Type | Description |
---|---|
PublicCertificate or the result of cls(response) |
Exceptions
Type | Description |
---|---|
create_or_update_relay_service_connection
Creates a new hybrid connection configuration (PUT), or updates an existing one (PATCH).
Creates a new hybrid connection configuration (PUT), or updates an existing one (PATCH).
create_or_update_relay_service_connection(resource_group_name: str, name: str, entity_name: str, connection_envelope: _models.RelayServiceConnectionEntity, *, content_type: str = 'application/json', **kwargs: Any) -> _models.RelayServiceConnectionEntity
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
entity_name
Required
|
Name of the hybrid connection configuration. Required. |
connection_envelope
Required
|
Details of the hybrid connection configuration. Is either a RelayServiceConnectionEntity type or a IO[bytes] type. Required. |
Returns
Type | Description |
---|---|
RelayServiceConnectionEntity or the result of cls(response) |
Exceptions
Type | Description |
---|---|
create_or_update_relay_service_connection_slot
Creates a new hybrid connection configuration (PUT), or updates an existing one (PATCH).
Creates a new hybrid connection configuration (PUT), or updates an existing one (PATCH).
create_or_update_relay_service_connection_slot(resource_group_name: str, name: str, entity_name: str, slot: str, connection_envelope: _models.RelayServiceConnectionEntity, *, content_type: str = 'application/json', **kwargs: Any) -> _models.RelayServiceConnectionEntity
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
entity_name
Required
|
Name of the hybrid connection configuration. Required. |
slot
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. Required. |
connection_envelope
Required
|
Details of the hybrid connection configuration. Is either a RelayServiceConnectionEntity type or a IO[bytes] type. Required. |
Returns
Type | Description |
---|---|
RelayServiceConnectionEntity or the result of cls(response) |
Exceptions
Type | Description |
---|---|
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.
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(resource_group_name: str, name: str, connection_envelope: _models.SwiftVirtualNetwork, *, content_type: str = 'application/json', **kwargs: Any) -> _models.SwiftVirtualNetwork
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
connection_envelope
Required
|
Properties of the Virtual Network connection. See example. Is either a SwiftVirtualNetwork type or a IO[bytes] type. Required. |
Returns
Type | Description |
---|---|
SwiftVirtualNetwork or the result of cls(response) |
Exceptions
Type | Description |
---|---|
create_or_update_vnet_connection
Adds a Virtual Network connection to an app or slot (PUT) or updates the connection properties (PATCH).
Adds a Virtual Network connection to an app or slot (PUT) or updates the connection properties (PATCH).
create_or_update_vnet_connection(resource_group_name: str, name: str, vnet_name: str, connection_envelope: _models.VnetInfo, *, content_type: str = 'application/json', **kwargs: Any) -> _models.VnetInfo
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
vnet_name
Required
|
Name of an existing Virtual Network. Required. |
connection_envelope
Required
|
Properties of the Virtual Network connection. See example. Is either a VnetInfo type or a IO[bytes] type. Required. |
Returns
Type | Description |
---|---|
VnetInfo or the result of cls(response) |
Exceptions
Type | Description |
---|---|
create_or_update_vnet_connection_gateway
Adds a gateway to a connected Virtual Network (PUT) or updates it (PATCH).
Adds a gateway to a connected Virtual Network (PUT) or updates it (PATCH).
create_or_update_vnet_connection_gateway(resource_group_name: str, name: str, vnet_name: str, gateway_name: str, connection_envelope: _models.VnetGateway, *, content_type: str = 'application/json', **kwargs: Any) -> _models.VnetGateway
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
vnet_name
Required
|
Name of the Virtual Network. Required. |
gateway_name
Required
|
Name of the gateway. Currently, the only supported string is "primary". Required. |
connection_envelope
Required
|
The properties to update this gateway with. Is either a VnetGateway type or a IO[bytes] type. Required. |
Returns
Type | Description |
---|---|
VnetGateway or the result of cls(response) |
Exceptions
Type | Description |
---|---|
create_or_update_vnet_connection_gateway_slot
Adds a gateway to a connected Virtual Network (PUT) or updates it (PATCH).
Adds a gateway to a connected Virtual Network (PUT) or updates it (PATCH).
create_or_update_vnet_connection_gateway_slot(resource_group_name: str, name: str, vnet_name: str, gateway_name: str, slot: str, connection_envelope: _models.VnetGateway, *, content_type: str = 'application/json', **kwargs: Any) -> _models.VnetGateway
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
vnet_name
Required
|
Name of the Virtual Network. Required. |
gateway_name
Required
|
Name of the gateway. Currently, the only supported string is "primary". Required. |
slot
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. Required. |
connection_envelope
Required
|
The properties to update this gateway with. Is either a VnetGateway type or a IO[bytes] type. Required. |
Returns
Type | Description |
---|---|
VnetGateway or the result of cls(response) |
Exceptions
Type | Description |
---|---|
create_or_update_vnet_connection_slot
Adds a Virtual Network connection to an app or slot (PUT) or updates the connection properties (PATCH).
Adds a Virtual Network connection to an app or slot (PUT) or updates the connection properties (PATCH).
create_or_update_vnet_connection_slot(resource_group_name: str, name: str, vnet_name: str, slot: str, connection_envelope: _models.VnetInfo, *, content_type: str = 'application/json', **kwargs: Any) -> _models.VnetInfo
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
vnet_name
Required
|
Name of an existing Virtual Network. Required. |
slot
Required
|
Name of the deployment slot. If a slot is not specified, the API will add or update connections for the production slot. Required. |
connection_envelope
Required
|
Properties of the Virtual Network connection. See example. Is either a VnetInfo type or a IO[bytes] type. Required. |
Returns
Type | Description |
---|---|
VnetInfo or the result of cls(response) |
Exceptions
Type | Description |
---|---|
delete
Deletes a web, mobile, or API app, or one of the deployment slots.
Deletes a web, mobile, or API app, or one of the deployment slots.
delete(resource_group_name: str, name: str, delete_metrics: bool | None = None, delete_empty_server_farm: bool | None = None, **kwargs: Any) -> None
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app to delete. Required. |
delete_metrics
Required
|
If true, web app metrics are also deleted. Default value is None. |
delete_empty_server_farm
Required
|
Specify false if you want to keep empty App Service plan. By default, empty App Service plan is deleted. Default value is None. |
Returns
Type | Description |
---|---|
None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
delete_backup
Deletes a backup of an app by its ID.
Deletes a backup of an app by its ID.
delete_backup(resource_group_name: str, name: str, backup_id: str, **kwargs: Any) -> None
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
backup_id
Required
|
ID of the backup. Required. |
Returns
Type | Description |
---|---|
None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
delete_backup_configuration
Deletes the backup configuration of an app.
Deletes the backup configuration of an app.
delete_backup_configuration(resource_group_name: str, name: str, **kwargs: Any) -> None
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
Returns
Type | Description |
---|---|
None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
delete_backup_configuration_slot
Deletes the backup configuration of an app.
Deletes the backup configuration of an app.
delete_backup_configuration_slot(resource_group_name: str, name: str, slot: str, **kwargs: Any) -> None
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
slot
Required
|
Name of the deployment slot. If a slot is not specified, the API will delete the backup configuration for the production slot. Required. |
Returns
Type | Description |
---|---|
None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
delete_backup_slot
Deletes a backup of an app by its ID.
Deletes a backup of an app by its ID.
delete_backup_slot(resource_group_name: str, name: str, backup_id: str, slot: str, **kwargs: Any) -> None
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
backup_id
Required
|
ID of the backup. Required. |
slot
Required
|
Name of the deployment slot. If a slot is not specified, the API will delete a backup of the production slot. Required. |
Returns
Type | Description |
---|---|
None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
delete_continuous_web_job
Delete a continuous web job by its ID for an app, or a deployment slot.
Delete a continuous web job by its ID for an app, or a deployment slot.
delete_continuous_web_job(resource_group_name: str, name: str, web_job_name: str, **kwargs: Any) -> None
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Site name. Required. |
web_job_name
Required
|
Name of Web Job. Required. |
Returns
Type | Description |
---|---|
None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
delete_continuous_web_job_slot
Delete a continuous web job by its ID for an app, or a deployment slot.
Delete a continuous web job by its ID for an app, or a deployment slot.
delete_continuous_web_job_slot(resource_group_name: str, name: str, web_job_name: str, slot: str, **kwargs: Any) -> None
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Site name. Required. |
web_job_name
Required
|
Name of Web Job. Required. |
slot
Required
|
Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot. Required. |
Returns
Type | Description |
---|---|
None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
delete_deployment
Delete a deployment by its ID for an app, or a deployment slot.
Delete a deployment by its ID for an app, or a deployment slot.
delete_deployment(resource_group_name: str, name: str, id: str, **kwargs: Any) -> None
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
id
Required
|
Deployment ID. Required. |
Returns
Type | Description |
---|---|
None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
delete_deployment_slot
Delete a deployment by its ID for an app, or a deployment slot.
Delete a deployment by its ID for an app, or a deployment slot.
delete_deployment_slot(resource_group_name: str, name: str, id: str, slot: str, **kwargs: Any) -> None
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
id
Required
|
Deployment ID. Required. |
slot
Required
|
Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot. Required. |
Returns
Type | Description |
---|---|
None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
delete_domain_ownership_identifier
Deletes a domain ownership identifier for a web app.
Deletes a domain ownership identifier for a web app.
delete_domain_ownership_identifier(resource_group_name: str, name: str, domain_ownership_identifier_name: str, **kwargs: Any) -> None
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
domain_ownership_identifier_name
Required
|
Name of domain ownership identifier. Required. |
Returns
Type | Description |
---|---|
None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
delete_domain_ownership_identifier_slot
Deletes a domain ownership identifier for a web app.
Deletes a domain ownership identifier for a web app.
delete_domain_ownership_identifier_slot(resource_group_name: str, name: str, domain_ownership_identifier_name: str, slot: str, **kwargs: Any) -> None
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
domain_ownership_identifier_name
Required
|
Name of domain ownership identifier. Required. |
slot
Required
|
Name of the deployment slot. If a slot is not specified, the API will delete the binding for the production slot. Required. |
Returns
Type | Description |
---|---|
None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
delete_function
Delete a function for web site, or a deployment slot.
Delete a function for web site, or a deployment slot.
delete_function(resource_group_name: str, name: str, function_name: str, **kwargs: Any) -> None
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Site name. Required. |
function_name
Required
|
Function name. Required. |
Returns
Type | Description |
---|---|
None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
delete_function_secret
Delete a function secret.
Delete a function secret.
delete_function_secret(resource_group_name: str, name: str, function_name: str, key_name: str, **kwargs: Any) -> None
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Site name. Required. |
function_name
Required
|
The name of the function. Required. |
key_name
Required
|
The name of the key. Required. |
Returns
Type | Description |
---|---|
None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
delete_function_secret_slot
Delete a function secret.
Delete a function secret.
delete_function_secret_slot(resource_group_name: str, name: str, function_name: str, key_name: str, slot: str, **kwargs: Any) -> None
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Site name. Required. |
function_name
Required
|
The name of the function. Required. |
key_name
Required
|
The name of the key. Required. |
slot
Required
|
Name of the deployment slot. Required. |
Returns
Type | Description |
---|---|
None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
delete_host_name_binding
Deletes a hostname binding for an app.
Deletes a hostname binding for an app.
delete_host_name_binding(resource_group_name: str, name: str, host_name: str, **kwargs: Any) -> None
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
host_name
Required
|
Hostname in the hostname binding. Required. |
Returns
Type | Description |
---|---|
None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
delete_host_name_binding_slot
Deletes a hostname binding for an app.
Deletes a hostname binding for an app.
delete_host_name_binding_slot(resource_group_name: str, name: str, slot: str, host_name: str, **kwargs: Any) -> None
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
slot
Required
|
Name of the deployment slot. If a slot is not specified, the API will delete the binding for the production slot. Required. |
host_name
Required
|
Hostname in the hostname binding. Required. |
Returns
Type | Description |
---|---|
None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
delete_host_secret
Delete a host level secret.
Delete a host level secret.
delete_host_secret(resource_group_name: str, name: str, key_type: str, key_name: str, **kwargs: Any) -> None
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Site name. Required. |
key_type
Required
|
The type of host key. Required. |
key_name
Required
|
The name of the key. Required. |
Returns
Type | Description |
---|---|
None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
delete_host_secret_slot
Delete a host level secret.
Delete a host level secret.
delete_host_secret_slot(resource_group_name: str, name: str, key_type: str, key_name: str, slot: str, **kwargs: Any) -> None
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Site name. Required. |
key_type
Required
|
The type of host key. Required. |
key_name
Required
|
The name of the key. Required. |
slot
Required
|
Name of the deployment slot. Required. |
Returns
Type | Description |
---|---|
None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
delete_hybrid_connection
Removes a Hybrid Connection from this site.
Removes a Hybrid Connection from this site.
delete_hybrid_connection(resource_group_name: str, name: str, namespace_name: str, relay_name: str, **kwargs: Any) -> None
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
The name of the web app. Required. |
namespace_name
Required
|
The namespace for this hybrid connection. Required. |
relay_name
Required
|
The relay name for this hybrid connection. Required. |
Returns
Type | Description |
---|---|
None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
delete_hybrid_connection_slot
Removes a Hybrid Connection from this site.
Removes a Hybrid Connection from this site.
delete_hybrid_connection_slot(resource_group_name: str, name: str, namespace_name: str, relay_name: str, slot: str, **kwargs: Any) -> None
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
The name of the web app. Required. |
namespace_name
Required
|
The namespace for this hybrid connection. Required. |
relay_name
Required
|
The relay name for this hybrid connection. Required. |
slot
Required
|
The name of the slot for the web app. Required. |
Returns
Type | Description |
---|---|
None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
delete_instance_function_slot
Delete a function for web site, or a deployment slot.
Delete a function for web site, or a deployment slot.
delete_instance_function_slot(resource_group_name: str, name: str, function_name: str, slot: str, **kwargs: Any) -> None
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Site name. Required. |
function_name
Required
|
Function name. Required. |
slot
Required
|
Name of the deployment slot. Required. |
Returns
Type | Description |
---|---|
None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
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.
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(resource_group_name: str, name: str, process_id: str, instance_id: str, **kwargs: Any) -> None
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Site name. Required. |
process_id
Required
|
PID. Required. |
instance_id
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". Required. |
Returns
Type | Description |
---|---|
None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
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.
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(resource_group_name: str, name: str, process_id: str, slot: str, instance_id: str, **kwargs: Any) -> None
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Site name. Required. |
process_id
Required
|
PID. Required. |
slot
Required
|
Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot. Required. |
instance_id
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". Required. |
Returns
Type | Description |
---|---|
None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
delete_premier_add_on
Delete a premier add-on from an app.
Delete a premier add-on from an app.
delete_premier_add_on(resource_group_name: str, name: str, premier_add_on_name: str, **kwargs: Any) -> None
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
premier_add_on_name
Required
|
Add-on name. Required. |
Returns
Type | Description |
---|---|
None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
delete_premier_add_on_slot
Delete a premier add-on from an app.
Delete a premier add-on from an app.
delete_premier_add_on_slot(resource_group_name: str, name: str, premier_add_on_name: str, slot: str, **kwargs: Any) -> None
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
premier_add_on_name
Required
|
Add-on name. Required. |
slot
Required
|
Name of the deployment slot. If a slot is not specified, the API will delete the named add-on for the production slot. Required. |
Returns
Type | Description |
---|---|
None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
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.
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(resource_group_name: str, name: str, process_id: str, **kwargs: Any) -> None
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Site name. Required. |
process_id
Required
|
PID. Required. |
Returns
Type | Description |
---|---|
None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
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.
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(resource_group_name: str, name: str, process_id: str, slot: str, **kwargs: Any) -> None
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Site name. Required. |
process_id
Required
|
PID. Required. |
slot
Required
|
Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot. Required. |
Returns
Type | Description |
---|---|
None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
delete_public_certificate
Deletes a hostname binding for an app.
Deletes a hostname binding for an app.
delete_public_certificate(resource_group_name: str, name: str, public_certificate_name: str, **kwargs: Any) -> None
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
public_certificate_name
Required
|
Public certificate name. Required. |
Returns
Type | Description |
---|---|
None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
delete_public_certificate_slot
Deletes a hostname binding for an app.
Deletes a hostname binding for an app.
delete_public_certificate_slot(resource_group_name: str, name: str, slot: str, public_certificate_name: str, **kwargs: Any) -> None
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
slot
Required
|
Name of the deployment slot. If a slot is not specified, the API will delete the binding for the production slot. Required. |
public_certificate_name
Required
|
Public certificate name. Required. |
Returns
Type | Description |
---|---|
None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
delete_relay_service_connection
Deletes a relay service connection by its name.
Deletes a relay service connection by its name.
delete_relay_service_connection(resource_group_name: str, name: str, entity_name: str, **kwargs: Any) -> None
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
entity_name
Required
|
Name of the hybrid connection configuration. Required. |
Returns
Type | Description |
---|---|
None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
delete_relay_service_connection_slot
Deletes a relay service connection by its name.
Deletes a relay service connection by its name.
delete_relay_service_connection_slot(resource_group_name: str, name: str, entity_name: str, slot: str, **kwargs: Any) -> None
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
entity_name
Required
|
Name of the hybrid connection configuration. Required. |
slot
Required
|
Name of the deployment slot. If a slot is not specified, the API will delete a hybrid connection for the production slot. Required. |
Returns
Type | Description |
---|---|
None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
delete_site_extension
Remove a site extension from a web site, or a deployment slot.
Remove a site extension from a web site, or a deployment slot.
delete_site_extension(resource_group_name: str, name: str, site_extension_id: str, **kwargs: Any) -> None
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Site name. Required. |
site_extension_id
Required
|
Site extension name. Required. |
Returns
Type | Description |
---|---|
None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
delete_site_extension_slot
Remove a site extension from a web site, or a deployment slot.
Remove a site extension from a web site, or a deployment slot.
delete_site_extension_slot(resource_group_name: str, name: str, site_extension_id: str, slot: str, **kwargs: Any) -> None
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Site name. Required. |
site_extension_id
Required
|
Site extension name. Required. |
slot
Required
|
Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot. Required. |
Returns
Type | Description |
---|---|
None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
delete_slot
Deletes a web, mobile, or API app, or one of the deployment slots.
Deletes a web, mobile, or API app, or one of the deployment slots.
delete_slot(resource_group_name: str, name: str, slot: str, delete_metrics: bool | None = None, delete_empty_server_farm: bool | None = None, **kwargs: Any) -> None
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app to delete. Required. |
slot
Required
|
Name of the deployment slot to delete. By default, the API deletes the production slot. Required. |
delete_metrics
Required
|
If true, web app metrics are also deleted. Default value is None. |
delete_empty_server_farm
Required
|
Specify false if you want to keep empty App Service plan. By default, empty App Service plan is deleted. Default value is None. |
Returns
Type | Description |
---|---|
None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
delete_source_control
Deletes the source control configuration of an app.
Deletes the source control configuration of an app.
delete_source_control(resource_group_name: str, name: str, additional_flags: str | None = None, **kwargs: Any) -> None
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
additional_flags
Required
|
Default value is None. |
Returns
Type | Description |
---|---|
None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
delete_source_control_slot
Deletes the source control configuration of an app.
Deletes the source control configuration of an app.
delete_source_control_slot(resource_group_name: str, name: str, slot: str, additional_flags: str | None = None, **kwargs: Any) -> None
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
slot
Required
|
Name of the deployment slot. If a slot is not specified, the API will delete the source control configuration for the production slot. Required. |
additional_flags
Required
|
Default value is None. |
Returns
Type | Description |
---|---|
None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
delete_swift_virtual_network
Deletes a Swift Virtual Network connection from an app (or deployment slot).
Deletes a Swift Virtual Network connection from an app (or deployment slot).
delete_swift_virtual_network(resource_group_name: str, name: str, **kwargs: Any) -> None
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
Returns
Type | Description |
---|---|
None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
delete_swift_virtual_network_slot
Deletes a Swift Virtual Network connection from an app (or deployment slot).
Deletes a Swift Virtual Network connection from an app (or deployment slot).
delete_swift_virtual_network_slot(resource_group_name: str, name: str, slot: str, **kwargs: Any) -> None
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
slot
Required
|
Name of the deployment slot. If a slot is not specified, the API will delete the connection for the production slot. Required. |
Returns
Type | Description |
---|---|
None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
delete_triggered_web_job
Delete a triggered web job by its ID for an app, or a deployment slot.
Delete a triggered web job by its ID for an app, or a deployment slot.
delete_triggered_web_job(resource_group_name: str, name: str, web_job_name: str, **kwargs: Any) -> None
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Site name. Required. |
web_job_name
Required
|
Name of Web Job. Required. |
Returns
Type | Description |
---|---|
None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
delete_triggered_web_job_slot
Delete a triggered web job by its ID for an app, or a deployment slot.
Delete a triggered web job by its ID for an app, or a deployment slot.
delete_triggered_web_job_slot(resource_group_name: str, name: str, web_job_name: str, slot: str, **kwargs: Any) -> None
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Site name. Required. |
web_job_name
Required
|
Name of Web Job. Required. |
slot
Required
|
Name of the deployment slot. If a slot is not specified, the API deletes web job for the production slot. Required. |
Returns
Type | Description |
---|---|
None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
delete_vnet_connection
Deletes a connection from an app (or deployment slot to a named virtual network.
Deletes a connection from an app (or deployment slot to a named virtual network.
delete_vnet_connection(resource_group_name: str, name: str, vnet_name: str, **kwargs: Any) -> None
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
vnet_name
Required
|
Name of the virtual network. Required. |
Returns
Type | Description |
---|---|
None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
delete_vnet_connection_slot
Deletes a connection from an app (or deployment slot to a named virtual network.
Deletes a connection from an app (or deployment slot to a named virtual network.
delete_vnet_connection_slot(resource_group_name: str, name: str, vnet_name: str, slot: str, **kwargs: Any) -> None
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
vnet_name
Required
|
Name of the virtual network. Required. |
slot
Required
|
Name of the deployment slot. If a slot is not specified, the API will delete the connection for the production slot. Required. |
Returns
Type | Description |
---|---|
None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
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.
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(resource_group_name: str, name: str, request: _models.RestoreRequest, *, content_type: str = 'application/json', **kwargs: Any) -> _models.RestoreRequest
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
request
Required
|
A RestoreRequest object that includes Azure storage URL and blog name for discovery of backup. Is either a RestoreRequest type or a IO[bytes] type. Required. |
Returns
Type | Description |
---|---|
RestoreRequest or the result of cls(response) |
Exceptions
Type | Description |
---|---|
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.
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(resource_group_name: str, name: str, slot: str, request: _models.RestoreRequest, *, content_type: str = 'application/json', **kwargs: Any) -> _models.RestoreRequest
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
slot
Required
|
Name of the deployment slot. If a slot is not specified, the API will perform discovery for the production slot. Required. |
request
Required
|
A RestoreRequest object that includes Azure storage URL and blog name for discovery of backup. Is either a RestoreRequest type or a IO[bytes] type. Required. |
Returns
Type | Description |
---|---|
RestoreRequest or the result of cls(response) |
Exceptions
Type | Description |
---|---|
generate_new_site_publishing_password
Generates a new publishing password for an app (or deployment slot, if specified).
Generates a new publishing password for an app (or deployment slot, if specified).
generate_new_site_publishing_password(resource_group_name: str, name: str, **kwargs: Any) -> None
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
Returns
Type | Description |
---|---|
None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
generate_new_site_publishing_password_slot
Generates a new publishing password for an app (or deployment slot, if specified).
Generates a new publishing password for an app (or deployment slot, if specified).
generate_new_site_publishing_password_slot(resource_group_name: str, name: str, slot: str, **kwargs: Any) -> None
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
slot
Required
|
Name of the deployment slot. If a slot is not specified, the API generate a new publishing password for the production slot. Required. |
Returns
Type | Description |
---|---|
None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
get
Gets the details of a web, mobile, or API app.
Gets the details of a web, mobile, or API app.
get(resource_group_name: str, name: str, **kwargs: Any) -> Site | None
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
Returns
Type | Description |
---|---|
Site,
|
Site or None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
get_app_setting_key_vault_reference
Gets the config reference and status of an app.
Gets the config reference and status of an app.
get_app_setting_key_vault_reference(resource_group_name: str, name: str, app_setting_key: str, **kwargs: Any) -> ApiKVReference
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
app_setting_key
Required
|
App Setting key name. Required. |
Returns
Type | Description |
---|---|
ApiKVReference or the result of cls(response) |
Exceptions
Type | Description |
---|---|
get_app_setting_key_vault_reference_slot
Gets the config reference and status of an app.
Gets the config reference and status of an app.
get_app_setting_key_vault_reference_slot(resource_group_name: str, name: str, app_setting_key: str, slot: str, **kwargs: Any) -> ApiKVReference
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
app_setting_key
Required
|
App Setting key name. Required. |
slot
Required
|
Required. |
Returns
Type | Description |
---|---|
ApiKVReference or the result of cls(response) |
Exceptions
Type | Description |
---|---|
get_app_settings_key_vault_references
Gets the config reference app settings and status of an app.
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) -> Iterable[ApiKVReference]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
Returns
Type | Description |
---|---|
An iterator like instance of either ApiKVReference or the result of cls(response) |
Exceptions
Type | Description |
---|---|
get_app_settings_key_vault_references_slot
Gets the config reference app settings and status of an app.
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) -> Iterable[ApiKVReference]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
slot
Required
|
Required. |
Returns
Type | Description |
---|---|
An iterator like instance of either ApiKVReference or the result of cls(response) |
Exceptions
Type | Description |
---|---|
get_auth_settings
Gets the Authentication/Authorization settings of an app.
Gets the Authentication/Authorization settings of an app.
get_auth_settings(resource_group_name: str, name: str, **kwargs: Any) -> SiteAuthSettings
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
Returns
Type | Description |
---|---|
SiteAuthSettings or the result of cls(response) |
Exceptions
Type | Description |
---|---|
get_auth_settings_slot
Gets the Authentication/Authorization settings of an app.
Gets the Authentication/Authorization settings of an app.
get_auth_settings_slot(resource_group_name: str, name: str, slot: str, **kwargs: Any) -> SiteAuthSettings
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
slot
Required
|
Name of the deployment slot. If a slot is not specified, the API will get the settings for the production slot. Required. |
Returns
Type | Description |
---|---|
SiteAuthSettings or the result of cls(response) |
Exceptions
Type | Description |
---|---|
get_auth_settings_v2
Gets site's Authentication / Authorization settings for apps via the V2 format.
Gets site's Authentication / Authorization settings for apps via the V2 format.
get_auth_settings_v2(resource_group_name: str, name: str, **kwargs: Any) -> SiteAuthSettingsV2
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
Returns
Type | Description |
---|---|
SiteAuthSettingsV2 or the result of cls(response) |
Exceptions
Type | Description |
---|---|
get_auth_settings_v2_slot
Gets site's Authentication / Authorization settings for apps via the V2 format.
Gets site's Authentication / Authorization settings for apps via the V2 format.
get_auth_settings_v2_slot(resource_group_name: str, name: str, slot: str, **kwargs: Any) -> SiteAuthSettingsV2
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
slot
Required
|
Name of the deployment slot. If a slot is not specified, the API will get the settings for the production slot. Required. |
Returns
Type | Description |
---|---|
SiteAuthSettingsV2 or the result of cls(response) |
Exceptions
Type | Description |
---|---|
get_backup_configuration
Gets the backup configuration of an app.
Gets the backup configuration of an app.
get_backup_configuration(resource_group_name: str, name: str, **kwargs: Any) -> BackupRequest
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
Returns
Type | Description |
---|---|
BackupRequest or the result of cls(response) |
Exceptions
Type | Description |
---|---|
get_backup_configuration_slot
Gets the backup configuration of an app.
Gets the backup configuration of an app.
get_backup_configuration_slot(resource_group_name: str, name: str, slot: str, **kwargs: Any) -> BackupRequest
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
slot
Required
|
Name of the deployment slot. If a slot is not specified, the API will get the backup configuration for the production slot. Required. |
Returns
Type | Description |
---|---|
BackupRequest or the result of cls(response) |
Exceptions
Type | Description |
---|---|
get_backup_status
Gets a backup of an app by its ID.
Gets a backup of an app by its ID.
get_backup_status(resource_group_name: str, name: str, backup_id: str, **kwargs: Any) -> BackupItem
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
backup_id
Required
|
ID of the backup. Required. |
Returns
Type | Description |
---|---|
BackupItem or the result of cls(response) |
Exceptions
Type | Description |
---|---|
get_backup_status_slot
Gets a backup of an app by its ID.
Gets a backup of an app by its ID.
get_backup_status_slot(resource_group_name: str, name: str, backup_id: str, slot: str, **kwargs: Any) -> BackupItem
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
backup_id
Required
|
ID of the backup. Required. |
slot
Required
|
Name of the deployment slot. If a slot is not specified, the API will get a backup of the production slot. Required. |
Returns
Type | Description |
---|---|
BackupItem or the result of cls(response) |
Exceptions
Type | Description |
---|---|
get_basic_publishing_credentials_policies
Returns whether Scm basic auth is allowed and whether Ftp is allowed for a given site.
Returns whether Scm basic auth is allowed and whether Ftp is allowed for a given site.
get_basic_publishing_credentials_policies(resource_group_name: str, name: str, **kwargs: Any) -> CsmPublishingCredentialsPoliciesCollection
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
Returns
Type | Description |
---|---|
CsmPublishingCredentialsPoliciesCollection or the result of cls(response) |
Exceptions
Type | Description |
---|---|
get_basic_publishing_credentials_policies_slot
Returns whether Scm basic auth is allowed and whether Ftp is allowed for a given site.
Returns whether Scm basic auth is allowed and whether Ftp is allowed for a given site.
get_basic_publishing_credentials_policies_slot(resource_group_name: str, name: str, slot: str, **kwargs: Any) -> CsmPublishingCredentialsPoliciesCollection
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
slot
Required
|
Required. |
Returns
Type | Description |
---|---|
CsmPublishingCredentialsPoliciesCollection or the result of cls(response) |
Exceptions
Type | Description |
---|---|
get_configuration
Gets the configuration of an app, such as platform version and bitness, default documents, virtual applications, Always On, etc.
Gets the configuration of an app, such as platform version and bitness, default documents, virtual applications, Always On, etc.
get_configuration(resource_group_name: str, name: str, **kwargs: Any) -> SiteConfigResource
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
Returns
Type | Description |
---|---|
SiteConfigResource or the result of cls(response) |
Exceptions
Type | Description |
---|---|
get_configuration_slot
Gets the configuration of an app, such as platform version and bitness, default documents, virtual applications, Always On, etc.
Gets the configuration of an app, such as platform version and bitness, default documents, virtual applications, Always On, etc.
get_configuration_slot(resource_group_name: str, name: str, slot: str, **kwargs: Any) -> SiteConfigResource
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
slot
Required
|
Name of the deployment slot. If a slot is not specified, the API will return configuration for the production slot. Required. |
Returns
Type | Description |
---|---|
SiteConfigResource or the result of cls(response) |
Exceptions
Type | Description |
---|---|
get_configuration_snapshot
Gets a snapshot of the configuration of an app at a previous point in time.
Gets a snapshot of the configuration of an app at a previous point in time.
get_configuration_snapshot(resource_group_name: str, name: str, snapshot_id: str, **kwargs: Any) -> SiteConfigResource
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
snapshot_id
Required
|
The ID of the snapshot to read. Required. |
Returns
Type | Description |
---|---|
SiteConfigResource or the result of cls(response) |
Exceptions
Type | Description |
---|---|
get_configuration_snapshot_slot
Gets a snapshot of the configuration of an app at a previous point in time.
Gets a snapshot of the configuration of an app at a previous point in time.
get_configuration_snapshot_slot(resource_group_name: str, name: str, snapshot_id: str, slot: str, **kwargs: Any) -> SiteConfigResource
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
snapshot_id
Required
|
The ID of the snapshot to read. Required. |
slot
Required
|
Name of the deployment slot. If a slot is not specified, the API will return configuration for the production slot. Required. |
Returns
Type | Description |
---|---|
SiteConfigResource or the result of cls(response) |
Exceptions
Type | Description |
---|---|
get_container_logs_zip
Gets the ZIP archived docker log files for the given site.
Gets the ZIP archived docker log files for the given site.
get_container_logs_zip(resource_group_name: str, name: str, **kwargs: Any) -> Iterator[bytes] | None
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of web app. Required. |
Returns
Type | Description |
---|---|
Iterator[bytes] or None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
get_container_logs_zip_slot
Gets the ZIP archived docker log files for the given site.
Gets the ZIP archived docker log files for the given site.
get_container_logs_zip_slot(resource_group_name: str, name: str, slot: str, **kwargs: Any) -> Iterator[bytes] | None
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of web app. Required. |
slot
Required
|
Name of web app slot. If not specified then will default to production slot. Required. |
Returns
Type | Description |
---|---|
Iterator[bytes] or None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
get_continuous_web_job
Gets a continuous web job by its ID for an app, or a deployment slot.
Gets a continuous web job by its ID for an app, or a deployment slot.
get_continuous_web_job(resource_group_name: str, name: str, web_job_name: str, **kwargs: Any) -> ContinuousWebJob | None
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Site name. Required. |
web_job_name
Required
|
Name of Web Job. Required. |
Returns
Type | Description |
---|---|
ContinuousWebJob or None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
get_continuous_web_job_slot
Gets a continuous web job by its ID for an app, or a deployment slot.
Gets a continuous web job by its ID for an app, or a deployment slot.
get_continuous_web_job_slot(resource_group_name: str, name: str, web_job_name: str, slot: str, **kwargs: Any) -> ContinuousWebJob | None
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Site name. Required. |
web_job_name
Required
|
Name of Web Job. Required. |
slot
Required
|
Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot. Required. |
Returns
Type | Description |
---|---|
ContinuousWebJob or None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
get_deployment
Get a deployment by its ID for an app, or a deployment slot.
Get a deployment by its ID for an app, or a deployment slot.
get_deployment(resource_group_name: str, name: str, id: str, **kwargs: Any) -> Deployment
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
id
Required
|
Deployment ID. Required. |
Returns
Type | Description |
---|---|
Deployment or the result of cls(response) |
Exceptions
Type | Description |
---|---|
get_deployment_slot
Get a deployment by its ID for an app, or a deployment slot.
Get a deployment by its ID for an app, or a deployment slot.
get_deployment_slot(resource_group_name: str, name: str, id: str, slot: str, **kwargs: Any) -> Deployment
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
id
Required
|
Deployment ID. Required. |
slot
Required
|
Name of the deployment slot. If a slot is not specified, the API gets a deployment for the production slot. Required. |
Returns
Type | Description |
---|---|
Deployment or the result of cls(response) |
Exceptions
Type | Description |
---|---|
get_diagnostic_logs_configuration
Gets the logging configuration of an app.
Gets the logging configuration of an app.
get_diagnostic_logs_configuration(resource_group_name: str, name: str, **kwargs: Any) -> SiteLogsConfig
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
Returns
Type | Description |
---|---|
SiteLogsConfig or the result of cls(response) |
Exceptions
Type | Description |
---|---|
get_diagnostic_logs_configuration_slot
Gets the logging configuration of an app.
Gets the logging configuration of an app.
get_diagnostic_logs_configuration_slot(resource_group_name: str, name: str, slot: str, **kwargs: Any) -> SiteLogsConfig
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
slot
Required
|
Name of the deployment slot. If a slot is not specified, the API will get the logging configuration for the production slot. Required. |
Returns
Type | Description |
---|---|
SiteLogsConfig or the result of cls(response) |
Exceptions
Type | Description |
---|---|
get_domain_ownership_identifier
Get domain ownership identifier for web app.
Get domain ownership identifier for web app.
get_domain_ownership_identifier(resource_group_name: str, name: str, domain_ownership_identifier_name: str, **kwargs: Any) -> Identifier
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
domain_ownership_identifier_name
Required
|
Name of domain ownership identifier. Required. |
Returns
Type | Description |
---|---|
Identifier or the result of cls(response) |
Exceptions
Type | Description |
---|---|
get_domain_ownership_identifier_slot
Get domain ownership identifier for web app.
Get domain ownership identifier for web app.
get_domain_ownership_identifier_slot(resource_group_name: str, name: str, domain_ownership_identifier_name: str, slot: str, **kwargs: Any) -> Identifier
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
domain_ownership_identifier_name
Required
|
Name of domain ownership identifier. Required. |
slot
Required
|
Name of the deployment slot. If a slot is not specified, the API will delete the binding for the production slot. Required. |
Returns
Type | Description |
---|---|
Identifier or the result of cls(response) |
Exceptions
Type | Description |
---|---|
get_ftp_allowed
Returns whether FTP is allowed on the site or not.
Returns whether FTP is allowed on the site or not.
get_ftp_allowed(resource_group_name: str, name: str, **kwargs: Any) -> CsmPublishingCredentialsPoliciesEntity
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
Returns
Type | Description |
---|---|
CsmPublishingCredentialsPoliciesEntity or the result of cls(response) |
Exceptions
Type | Description |
---|---|
get_ftp_allowed_slot
Returns whether FTP is allowed on the site or not.
Returns whether FTP is allowed on the site or not.
get_ftp_allowed_slot(resource_group_name: str, name: str, slot: str, **kwargs: Any) -> CsmPublishingCredentialsPoliciesEntity
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
slot
Required
|
Required. |
Returns
Type | Description |
---|---|
CsmPublishingCredentialsPoliciesEntity or the result of cls(response) |
Exceptions
Type | Description |
---|---|
get_function
Get function information by its ID for web site, or a deployment slot.
Get function information by its ID for web site, or a deployment slot.
get_function(resource_group_name: str, name: str, function_name: str, **kwargs: Any) -> FunctionEnvelope | None
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Site name. Required. |
function_name
Required
|
Function name. Required. |
Returns
Type | Description |
---|---|
FunctionEnvelope or None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
get_functions_admin_token
Fetch a short lived token that can be exchanged for a master key.
Fetch a short lived token that can be exchanged for a master key.
get_functions_admin_token(resource_group_name: str, name: str, **kwargs: Any) -> str
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of web app. Required. |
Returns
Type | Description |
---|---|
str or the result of cls(response) |
Exceptions
Type | Description |
---|---|
get_functions_admin_token_slot
Fetch a short lived token that can be exchanged for a master key.
Fetch a short lived token that can be exchanged for a master key.
get_functions_admin_token_slot(resource_group_name: str, name: str, slot: str, **kwargs: Any) -> str
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of web app. Required. |
slot
Required
|
Name of web app slot. If not specified then will default to production slot. Required. |
Returns
Type | Description |
---|---|
str or the result of cls(response) |
Exceptions
Type | Description |
---|---|
get_host_name_binding
Get the named hostname binding for an app (or deployment slot, if specified).
Get the named hostname binding for an app (or deployment slot, if specified).
get_host_name_binding(resource_group_name: str, name: str, host_name: str, **kwargs: Any) -> HostNameBinding
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
host_name
Required
|
Hostname in the hostname binding. Required. |
Returns
Type | Description |
---|---|
HostNameBinding or the result of cls(response) |
Exceptions
Type | Description |
---|---|
get_host_name_binding_slot
Get the named hostname binding for an app (or deployment slot, if specified).
Get the named hostname binding for an app (or deployment slot, if specified).
get_host_name_binding_slot(resource_group_name: str, name: str, slot: str, host_name: str, **kwargs: Any) -> HostNameBinding
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
slot
Required
|
Name of the deployment slot. If a slot is not specified, the API the named binding for the production slot. Required. |
host_name
Required
|
Hostname in the hostname binding. Required. |
Returns
Type | Description |
---|---|
HostNameBinding or the result of cls(response) |
Exceptions
Type | Description |
---|---|
get_hybrid_connection
Retrieves a specific Service Bus Hybrid Connection used by this Web App.
Retrieves a specific Service Bus Hybrid Connection used by this Web App.
get_hybrid_connection(resource_group_name: str, name: str, namespace_name: str, relay_name: str, **kwargs: Any) -> HybridConnection
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
The name of the web app. Required. |
namespace_name
Required
|
The namespace for this hybrid connection. Required. |
relay_name
Required
|
The relay name for this hybrid connection. Required. |
Returns
Type | Description |
---|---|
HybridConnection or the result of cls(response) |
Exceptions
Type | Description |
---|---|
get_hybrid_connection_slot
Retrieves a specific Service Bus Hybrid Connection used by this Web App.
Retrieves a specific Service Bus Hybrid Connection used by this Web App.
get_hybrid_connection_slot(resource_group_name: str, name: str, namespace_name: str, relay_name: str, slot: str, **kwargs: Any) -> HybridConnection
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
The name of the web app. Required. |
namespace_name
Required
|
The namespace for this hybrid connection. Required. |
relay_name
Required
|
The relay name for this hybrid connection. Required. |
slot
Required
|
The name of the slot for the web app. Required. |
Returns
Type | Description |
---|---|
HybridConnection or the result of cls(response) |
Exceptions
Type | Description |
---|---|
get_instance_function_slot
Get function information by its ID for web site, or a deployment slot.
Get function information by its ID for web site, or a deployment slot.
get_instance_function_slot(resource_group_name: str, name: str, function_name: str, slot: str, **kwargs: Any) -> FunctionEnvelope | None
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Site name. Required. |
function_name
Required
|
Function name. Required. |
slot
Required
|
Name of the deployment slot. Required. |
Returns
Type | Description |
---|---|
FunctionEnvelope or None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
get_instance_info
Gets all scale-out instances of an app.
Gets all scale-out instances of an app.
get_instance_info(resource_group_name: str, name: str, instance_id: str, **kwargs: Any) -> WebSiteInstanceStatus
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
instance_id
Required
|
Required. |
Returns
Type | Description |
---|---|
WebSiteInstanceStatus or the result of cls(response) |
Exceptions
Type | Description |
---|---|
get_instance_info_slot
Gets all scale-out instances of an app.
Gets all scale-out instances of an app.
get_instance_info_slot(resource_group_name: str, name: str, instance_id: str, slot: str, **kwargs: Any) -> WebSiteInstanceStatus
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
instance_id
Required
|
Required. |
slot
Required
|
Name of the deployment slot. If a slot is not specified, the API gets the production slot instances. Required. |
Returns
Type | Description |
---|---|
WebSiteInstanceStatus or the result of cls(response) |
Exceptions
Type | Description |
---|---|
get_instance_ms_deploy_log
Get the MSDeploy Log for the last MSDeploy operation.
Get the MSDeploy Log for the last MSDeploy operation.
get_instance_ms_deploy_log(resource_group_name: str, name: str, instance_id: str, **kwargs: Any) -> MSDeployLog | None
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of web app. Required. |
instance_id
Required
|
ID of web app instance. Required. |
Returns
Type | Description |
---|---|
MSDeployLog or None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
get_instance_ms_deploy_log_slot
Get the MSDeploy Log for the last MSDeploy operation.
Get the MSDeploy Log for the last MSDeploy operation.
get_instance_ms_deploy_log_slot(resource_group_name: str, name: str, slot: str, instance_id: str, **kwargs: Any) -> MSDeployLog | None
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of web app. Required. |
slot
Required
|
Name of web app slot. If not specified then will default to production slot. Required. |
instance_id
Required
|
ID of web app instance. Required. |
Returns
Type | Description |
---|---|
MSDeployLog or None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
get_instance_ms_deploy_status
Get the status of the last MSDeploy operation.
Get the status of the last MSDeploy operation.
get_instance_ms_deploy_status(resource_group_name: str, name: str, instance_id: str, **kwargs: Any) -> MSDeployStatus
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of web app. Required. |
instance_id
Required
|
ID of web app instance. Required. |
Returns
Type | Description |
---|---|
MSDeployStatus or the result of cls(response) |
Exceptions
Type | Description |
---|---|
get_instance_ms_deploy_status_slot
Get the status of the last MSDeploy operation.
Get the status of the last MSDeploy operation.
get_instance_ms_deploy_status_slot(resource_group_name: str, name: str, slot: str, instance_id: str, **kwargs: Any) -> MSDeployStatus
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of web app. Required. |
slot
Required
|
Name of web app slot. If not specified then will default to production slot. Required. |
instance_id
Required
|
ID of web app instance. Required. |
Returns
Type | Description |
---|---|
MSDeployStatus or the result of cls(response) |
Exceptions
Type | Description |
---|---|
get_instance_process
Get process information by its ID for a specific scaled-out instance in a web site.
Get process information by its ID for a specific scaled-out instance in a web site.
get_instance_process(resource_group_name: str, name: str, process_id: str, instance_id: str, **kwargs: Any) -> ProcessInfo | None
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Site name. Required. |
process_id
Required
|
PID. Required. |
instance_id
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". Required. |
Returns
Type | Description |
---|---|
ProcessInfo or None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
get_instance_process_dump
Get a memory dump of a process by its ID for a specific scaled-out instance in a web site.
Get a memory dump of a process by its ID for a specific scaled-out instance in a web site.
get_instance_process_dump(resource_group_name: str, name: str, process_id: str, instance_id: str, **kwargs: Any) -> Iterator[bytes] | None
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Site name. Required. |
process_id
Required
|
PID. Required. |
instance_id
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". Required. |
Returns
Type | Description |
---|---|
Iterator[bytes] or None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
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.
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(resource_group_name: str, name: str, process_id: str, slot: str, instance_id: str, **kwargs: Any) -> Iterator[bytes] | None
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Site name. Required. |
process_id
Required
|
PID. Required. |
slot
Required
|
Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot. Required. |
instance_id
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". Required. |
Returns
Type | Description |
---|---|
Iterator[bytes] or None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
get_instance_process_module
Get process information by its ID for a specific scaled-out instance in a web site.
Get process information by its ID for a specific scaled-out instance in a web site.
get_instance_process_module(resource_group_name: str, name: str, process_id: str, base_address: str, instance_id: str, **kwargs: Any) -> ProcessModuleInfo | None
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Site name. Required. |
process_id
Required
|
PID. Required. |
base_address
Required
|
Module base address. Required. |
instance_id
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". Required. |
Returns
Type | Description |
---|---|
ProcessModuleInfo or None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
get_instance_process_module_slot
Get process information by its ID for a specific scaled-out instance in a web site.
Get process information by its ID for a specific scaled-out instance in a web site.
get_instance_process_module_slot(resource_group_name: str, name: str, process_id: str, base_address: str, slot: str, instance_id: str, **kwargs: Any) -> ProcessModuleInfo | None
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Site name. Required. |
process_id
Required
|
PID. Required. |
base_address
Required
|
Module base address. Required. |
slot
Required
|
Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot. Required. |
instance_id
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". Required. |
Returns
Type | Description |
---|---|
ProcessModuleInfo or None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
get_instance_process_slot
Get process information by its ID for a specific scaled-out instance in a web site.
Get process information by its ID for a specific scaled-out instance in a web site.
get_instance_process_slot(resource_group_name: str, name: str, process_id: str, slot: str, instance_id: str, **kwargs: Any) -> ProcessInfo | None
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Site name. Required. |
process_id
Required
|
PID. Required. |
slot
Required
|
Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot. Required. |
instance_id
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". Required. |
Returns
Type | Description |
---|---|
ProcessInfo or None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
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.
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(resource_group_name: str, name: str, **kwargs: Any) -> MigrateMySqlStatus
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of web app. Required. |
Returns
Type | Description |
---|---|
MigrateMySqlStatus or the result of cls(response) |
Exceptions
Type | Description |
---|---|
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.
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(resource_group_name: str, name: str, slot: str, **kwargs: Any) -> MigrateMySqlStatus
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of web app. Required. |
slot
Required
|
Name of the deployment slot. Required. |
Returns
Type | Description |
---|---|
MigrateMySqlStatus or the result of cls(response) |
Exceptions
Type | Description |
---|---|
get_ms_deploy_log
Get the MSDeploy Log for the last MSDeploy operation.
Get the MSDeploy Log for the last MSDeploy operation.
get_ms_deploy_log(resource_group_name: str, name: str, **kwargs: Any) -> MSDeployLog | None
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of web app. Required. |
Returns
Type | Description |
---|---|
MSDeployLog or None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
get_ms_deploy_log_slot
Get the MSDeploy Log for the last MSDeploy operation.
Get the MSDeploy Log for the last MSDeploy operation.
get_ms_deploy_log_slot(resource_group_name: str, name: str, slot: str, **kwargs: Any) -> MSDeployLog | None
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of web app. Required. |
slot
Required
|
Name of web app slot. If not specified then will default to production slot. Required. |
Returns
Type | Description |
---|---|
MSDeployLog or None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
get_ms_deploy_status
Get the status of the last MSDeploy operation.
Get the status of the last MSDeploy operation.
get_ms_deploy_status(resource_group_name: str, name: str, **kwargs: Any) -> MSDeployStatus
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of web app. Required. |
Returns
Type | Description |
---|---|
MSDeployStatus or the result of cls(response) |
Exceptions
Type | Description |
---|---|
get_ms_deploy_status_slot
Get the status of the last MSDeploy operation.
Get the status of the last MSDeploy operation.
get_ms_deploy_status_slot(resource_group_name: str, name: str, slot: str, **kwargs: Any) -> MSDeployStatus
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of web app. Required. |
slot
Required
|
Name of web app slot. If not specified then will default to production slot. Required. |
Returns
Type | Description |
---|---|
MSDeployStatus or the result of cls(response) |
Exceptions
Type | Description |
---|---|
get_network_trace_operation
Gets a named operation for a network trace capturing (or deployment slot, if specified).
Gets a named operation for a network trace capturing (or deployment slot, if specified).
get_network_trace_operation(resource_group_name: str, name: str, operation_id: str, **kwargs: Any) -> List[NetworkTrace]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
operation_id
Required
|
GUID of the operation. Required. |
Returns
Type | Description |
---|---|
list of NetworkTrace or the result of cls(response) |
Exceptions
Type | Description |
---|---|
get_network_trace_operation_slot
Gets a named operation for a network trace capturing (or deployment slot, if specified).
Gets a named operation for a network trace capturing (or deployment slot, if specified).
get_network_trace_operation_slot(resource_group_name: str, name: str, operation_id: str, slot: str, **kwargs: Any) -> List[NetworkTrace]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
operation_id
Required
|
GUID of the operation. Required. |
slot
Required
|
Name of the deployment slot. If a slot is not specified, the API will get an operation for the production slot. Required. |
Returns
Type | Description |
---|---|
list of NetworkTrace or the result of cls(response) |
Exceptions
Type | Description |
---|---|
get_network_trace_operation_slot_v2
Gets a named operation for a network trace capturing (or deployment slot, if specified).
Gets a named operation for a network trace capturing (or deployment slot, if specified).
get_network_trace_operation_slot_v2(resource_group_name: str, name: str, operation_id: str, slot: str, **kwargs: Any) -> List[NetworkTrace]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
operation_id
Required
|
GUID of the operation. Required. |
slot
Required
|
Name of the deployment slot. If a slot is not specified, the API will get an operation for the production slot. Required. |
Returns
Type | Description |
---|---|
list of NetworkTrace or the result of cls(response) |
Exceptions
Type | Description |
---|---|
get_network_trace_operation_v2
Gets a named operation for a network trace capturing (or deployment slot, if specified).
Gets a named operation for a network trace capturing (or deployment slot, if specified).
get_network_trace_operation_v2(resource_group_name: str, name: str, operation_id: str, **kwargs: Any) -> List[NetworkTrace]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
operation_id
Required
|
GUID of the operation. Required. |
Returns
Type | Description |
---|---|
list of NetworkTrace or the result of cls(response) |
Exceptions
Type | Description |
---|---|
get_network_traces
Gets a named operation for a network trace capturing (or deployment slot, if specified).
Gets a named operation for a network trace capturing (or deployment slot, if specified).
get_network_traces(resource_group_name: str, name: str, operation_id: str, **kwargs: Any) -> List[NetworkTrace]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
operation_id
Required
|
GUID of the operation. Required. |
Returns
Type | Description |
---|---|
list of NetworkTrace or the result of cls(response) |
Exceptions
Type | Description |
---|---|
get_network_traces_slot
Gets a named operation for a network trace capturing (or deployment slot, if specified).
Gets a named operation for a network trace capturing (or deployment slot, if specified).
get_network_traces_slot(resource_group_name: str, name: str, operation_id: str, slot: str, **kwargs: Any) -> List[NetworkTrace]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
operation_id
Required
|
GUID of the operation. Required. |
slot
Required
|
Name of the deployment slot. If a slot is not specified, the API will get an operation for the production slot. Required. |
Returns
Type | Description |
---|---|
list of NetworkTrace or the result of cls(response) |
Exceptions
Type | Description |
---|---|
get_network_traces_slot_v2
Gets a named operation for a network trace capturing (or deployment slot, if specified).
Gets a named operation for a network trace capturing (or deployment slot, if specified).
get_network_traces_slot_v2(resource_group_name: str, name: str, operation_id: str, slot: str, **kwargs: Any) -> List[NetworkTrace]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
operation_id
Required
|
GUID of the operation. Required. |
slot
Required
|
Name of the deployment slot. If a slot is not specified, the API will get an operation for the production slot. Required. |
Returns
Type | Description |
---|---|
list of NetworkTrace or the result of cls(response) |
Exceptions
Type | Description |
---|---|
get_network_traces_v2
Gets a named operation for a network trace capturing (or deployment slot, if specified).
Gets a named operation for a network trace capturing (or deployment slot, if specified).
get_network_traces_v2(resource_group_name: str, name: str, operation_id: str, **kwargs: Any) -> List[NetworkTrace]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
operation_id
Required
|
GUID of the operation. Required. |
Returns
Type | Description |
---|---|
list of NetworkTrace or the result of cls(response) |
Exceptions
Type | Description |
---|---|
get_premier_add_on
Gets a named add-on of an app.
Gets a named add-on of an app.
get_premier_add_on(resource_group_name: str, name: str, premier_add_on_name: str, **kwargs: Any) -> PremierAddOn
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
premier_add_on_name
Required
|
Add-on name. Required. |
Returns
Type | Description |
---|---|
PremierAddOn or the result of cls(response) |
Exceptions
Type | Description |
---|---|
get_premier_add_on_slot
Gets a named add-on of an app.
Gets a named add-on of an app.
get_premier_add_on_slot(resource_group_name: str, name: str, premier_add_on_name: str, slot: str, **kwargs: Any) -> PremierAddOn
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
premier_add_on_name
Required
|
Add-on name. Required. |
slot
Required
|
Name of the deployment slot. If a slot is not specified, the API will get the named add-on for the production slot. Required. |
Returns
Type | Description |
---|---|
PremierAddOn or the result of cls(response) |
Exceptions
Type | Description |
---|---|
get_private_access
Gets data around private site access enablement and authorized Virtual Networks that can access the site.
Gets data around private site access enablement and authorized Virtual Networks that can access the site.
get_private_access(resource_group_name: str, name: str, **kwargs: Any) -> PrivateAccess
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
The name of the web app. Required. |
Returns
Type | Description |
---|---|
PrivateAccess or the result of cls(response) |
Exceptions
Type | Description |
---|---|
get_private_access_slot
Gets data around private site access enablement and authorized Virtual Networks that can access the site.
Gets data around private site access enablement and authorized Virtual Networks that can access the site.
get_private_access_slot(resource_group_name: str, name: str, slot: str, **kwargs: Any) -> PrivateAccess
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
The name of the web app. Required. |
slot
Required
|
The name of the slot for the web app. Required. |
Returns
Type | Description |
---|---|
PrivateAccess or the result of cls(response) |
Exceptions
Type | Description |
---|---|
get_private_endpoint_connection
Gets a private endpoint connection.
Gets a private endpoint connection.
get_private_endpoint_connection(resource_group_name: str, name: str, private_endpoint_connection_name: str, **kwargs: Any) -> RemotePrivateEndpointConnectionARMResource
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the site. Required. |
private_endpoint_connection_name
Required
|
Name of the private endpoint connection. Required. |
Returns
Type | Description |
---|---|
RemotePrivateEndpointConnectionARMResource or the result of cls(response) |
Exceptions
Type | Description |
---|---|
get_private_endpoint_connection_list
Gets the list of private endpoint connections associated with a site.
Gets the list of private endpoint connections associated with a site.
get_private_endpoint_connection_list(resource_group_name: str, name: str, **kwargs: Any) -> Iterable[RemotePrivateEndpointConnectionARMResource]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the site. Required. |
Returns
Type | Description |
---|---|
An iterator like instance of either RemotePrivateEndpointConnectionARMResource or the result of cls(response) |
Exceptions
Type | Description |
---|---|
get_private_endpoint_connection_list_slot
Gets the list of private endpoint connections associated with a site.
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) -> Iterable[RemotePrivateEndpointConnectionARMResource]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the site. Required. |
slot
Required
|
Name of the site deployment slot. Required. |
Returns
Type | Description |
---|---|
An iterator like instance of either RemotePrivateEndpointConnectionARMResource or the result of cls(response) |
Exceptions
Type | Description |
---|---|
get_private_endpoint_connection_slot
Gets a private endpoint connection.
Gets a private endpoint connection.
get_private_endpoint_connection_slot(resource_group_name: str, name: str, private_endpoint_connection_name: str, slot: str, **kwargs: Any) -> RemotePrivateEndpointConnectionARMResource
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the site. Required. |
private_endpoint_connection_name
Required
|
Name of the private endpoint connection. Required. |
slot
Required
|
Name of the site deployment slot. Required. |
Returns
Type | Description |
---|---|
RemotePrivateEndpointConnectionARMResource or the result of cls(response) |
Exceptions
Type | Description |
---|---|
get_private_link_resources
Gets the private link resources.
Gets the private link resources.
get_private_link_resources(resource_group_name: str, name: str, **kwargs: Any) -> PrivateLinkResourcesWrapper
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the site. Required. |
Returns
Type | Description |
---|---|
PrivateLinkResourcesWrapper or the result of cls(response) |
Exceptions
Type | Description |
---|---|
get_private_link_resources_slot
Gets the private link resources.
Gets the private link resources.
get_private_link_resources_slot(resource_group_name: str, name: str, slot: str, **kwargs: Any) -> PrivateLinkResourcesWrapper
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the site. Required. |
slot
Required
|
Required. |
Returns
Type | Description |
---|---|
PrivateLinkResourcesWrapper or the result of cls(response) |
Exceptions
Type | Description |
---|---|
get_process
Get process information by its ID for a specific scaled-out instance in a web site.
Get process information by its ID for a specific scaled-out instance in a web site.
get_process(resource_group_name: str, name: str, process_id: str, **kwargs: Any) -> ProcessInfo | None
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Site name. Required. |
process_id
Required
|
PID. Required. |
Returns
Type | Description |
---|---|
ProcessInfo or None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
get_process_dump
Get a memory dump of a process by its ID for a specific scaled-out instance in a web site.
Get a memory dump of a process by its ID for a specific scaled-out instance in a web site.
get_process_dump(resource_group_name: str, name: str, process_id: str, **kwargs: Any) -> Iterator[bytes] | None
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Site name. Required. |
process_id
Required
|
PID. Required. |
Returns
Type | Description |
---|---|
Iterator[bytes] or None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
get_process_dump_slot
Get a memory dump of a process by its ID for a specific scaled-out instance in a web site.
Get a memory dump of a process by its ID for a specific scaled-out instance in a web site.
get_process_dump_slot(resource_group_name: str, name: str, process_id: str, slot: str, **kwargs: Any) -> Iterator[bytes] | None
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Site name. Required. |
process_id
Required
|
PID. Required. |
slot
Required
|
Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot. Required. |
Returns
Type | Description |
---|---|
Iterator[bytes] or None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
get_process_module
Get process information by its ID for a specific scaled-out instance in a web site.
Get process information by its ID for a specific scaled-out instance in a web site.
get_process_module(resource_group_name: str, name: str, process_id: str, base_address: str, **kwargs: Any) -> ProcessModuleInfo | None
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Site name. Required. |
process_id
Required
|
PID. Required. |
base_address
Required
|
Module base address. Required. |
Returns
Type | Description |
---|---|
ProcessModuleInfo or None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
get_process_module_slot
Get process information by its ID for a specific scaled-out instance in a web site.
Get process information by its ID for a specific scaled-out instance in a web site.
get_process_module_slot(resource_group_name: str, name: str, process_id: str, base_address: str, slot: str, **kwargs: Any) -> ProcessModuleInfo | None
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Site name. Required. |
process_id
Required
|
PID. Required. |
base_address
Required
|
Module base address. Required. |
slot
Required
|
Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot. Required. |
Returns
Type | Description |
---|---|
ProcessModuleInfo or None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
get_process_slot
Get process information by its ID for a specific scaled-out instance in a web site.
Get process information by its ID for a specific scaled-out instance in a web site.
get_process_slot(resource_group_name: str, name: str, process_id: str, slot: str, **kwargs: Any) -> ProcessInfo | None
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Site name. Required. |
process_id
Required
|
PID. Required. |
slot
Required
|
Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot. Required. |
Returns
Type | Description |
---|---|
ProcessInfo or None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
get_public_certificate
Get the named public certificate for an app (or deployment slot, if specified).
Get the named public certificate for an app (or deployment slot, if specified).
get_public_certificate(resource_group_name: str, name: str, public_certificate_name: str, **kwargs: Any) -> PublicCertificate
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
public_certificate_name
Required
|
Public certificate name. Required. |
Returns
Type | Description |
---|---|
PublicCertificate or the result of cls(response) |
Exceptions
Type | Description |
---|---|
get_public_certificate_slot
Get the named public certificate for an app (or deployment slot, if specified).
Get the named public certificate for an app (or deployment slot, if specified).
get_public_certificate_slot(resource_group_name: str, name: str, slot: str, public_certificate_name: str, **kwargs: Any) -> PublicCertificate
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
slot
Required
|
Name of the deployment slot. If a slot is not specified, the API the named binding for the production slot. Required. |
public_certificate_name
Required
|
Public certificate name. Required. |
Returns
Type | Description |
---|---|
PublicCertificate or the result of cls(response) |
Exceptions
Type | Description |
---|---|
get_relay_service_connection
Gets a hybrid connection configuration by its name.
Gets a hybrid connection configuration by its name.
get_relay_service_connection(resource_group_name: str, name: str, entity_name: str, **kwargs: Any) -> RelayServiceConnectionEntity
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
entity_name
Required
|
Name of the hybrid connection. Required. |
Returns
Type | Description |
---|---|
RelayServiceConnectionEntity or the result of cls(response) |
Exceptions
Type | Description |
---|---|
get_relay_service_connection_slot
Gets a hybrid connection configuration by its name.
Gets a hybrid connection configuration by its name.
get_relay_service_connection_slot(resource_group_name: str, name: str, entity_name: str, slot: str, **kwargs: Any) -> RelayServiceConnectionEntity
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
entity_name
Required
|
Name of the hybrid connection. Required. |
slot
Required
|
Name of the deployment slot. If a slot is not specified, the API will get a hybrid connection for the production slot. Required. |
Returns
Type | Description |
---|---|
RelayServiceConnectionEntity or the result of cls(response) |
Exceptions
Type | Description |
---|---|
get_scm_allowed
Returns whether Scm basic auth is allowed on the site or not.
Returns whether Scm basic auth is allowed on the site or not.
get_scm_allowed(resource_group_name: str, name: str, **kwargs: Any) -> CsmPublishingCredentialsPoliciesEntity
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
Returns
Type | Description |
---|---|
CsmPublishingCredentialsPoliciesEntity or the result of cls(response) |
Exceptions
Type | Description |
---|---|
get_scm_allowed_slot
Returns whether Scm basic auth is allowed on the site or not.
Returns whether Scm basic auth is allowed on the site or not.
get_scm_allowed_slot(resource_group_name: str, name: str, slot: str, **kwargs: Any) -> CsmPublishingCredentialsPoliciesEntity
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
slot
Required
|
Required. |
Returns
Type | Description |
---|---|
CsmPublishingCredentialsPoliciesEntity or the result of cls(response) |
Exceptions
Type | Description |
---|---|
get_site_connection_string_key_vault_reference
Gets the config reference and status of an app.
Gets the config reference and status of an app.
get_site_connection_string_key_vault_reference(resource_group_name: str, name: str, connection_string_key: str, **kwargs: Any) -> ApiKVReference
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
connection_string_key
Required
|
Required. |
Returns
Type | Description |
---|---|
ApiKVReference or the result of cls(response) |
Exceptions
Type | Description |
---|---|
get_site_connection_string_key_vault_reference_slot
Gets the config reference and status of an app.
Gets the config reference and status of an app.
get_site_connection_string_key_vault_reference_slot(resource_group_name: str, name: str, connection_string_key: str, slot: str, **kwargs: Any) -> ApiKVReference
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
connection_string_key
Required
|
Required. |
slot
Required
|
Required. |
Returns
Type | Description |
---|---|
ApiKVReference or the result of cls(response) |
Exceptions
Type | Description |
---|---|
get_site_connection_string_key_vault_references
Gets the config reference app settings and status of an app.
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) -> Iterable[ApiKVReference]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
Returns
Type | Description |
---|---|
An iterator like instance of either ApiKVReference or the result of cls(response) |
Exceptions
Type | Description |
---|---|
get_site_connection_string_key_vault_references_slot
Gets the config reference app settings and status of an app.
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) -> Iterable[ApiKVReference]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
slot
Required
|
Required. |
Returns
Type | Description |
---|---|
An iterator like instance of either ApiKVReference or the result of cls(response) |
Exceptions
Type | Description |
---|---|
get_site_extension
Get site extension information by its ID for a web site, or a deployment slot.
Get site extension information by its ID for a web site, or a deployment slot.
get_site_extension(resource_group_name: str, name: str, site_extension_id: str, **kwargs: Any) -> SiteExtensionInfo | None
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Site name. Required. |
site_extension_id
Required
|
Site extension name. Required. |
Returns
Type | Description |
---|---|
SiteExtensionInfo or None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
get_site_extension_slot
Get site extension information by its ID for a web site, or a deployment slot.
Get site extension information by its ID for a web site, or a deployment slot.
get_site_extension_slot(resource_group_name: str, name: str, site_extension_id: str, slot: str, **kwargs: Any) -> SiteExtensionInfo | None
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Site name. Required. |
site_extension_id
Required
|
Site extension name. Required. |
slot
Required
|
Name of the deployment slot. If a slot is not specified, the API uses the production slot. Required. |
Returns
Type | Description |
---|---|
SiteExtensionInfo or None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
get_site_php_error_log_flag
Gets web app's event logs.
Gets web app's event logs.
get_site_php_error_log_flag(resource_group_name: str, name: str, **kwargs: Any) -> SitePhpErrorLogFlag
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of web app. Required. |
Returns
Type | Description |
---|---|
SitePhpErrorLogFlag or the result of cls(response) |
Exceptions
Type | Description |
---|---|
get_site_php_error_log_flag_slot
Gets web app's event logs.
Gets web app's event logs.
get_site_php_error_log_flag_slot(resource_group_name: str, name: str, slot: str, **kwargs: Any) -> SitePhpErrorLogFlag
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of web app. Required. |
slot
Required
|
Name of web app slot. If not specified then will default to production slot. Required. |
Returns
Type | Description |
---|---|
SitePhpErrorLogFlag or the result of cls(response) |
Exceptions
Type | Description |
---|---|
get_slot
Gets the details of a web, mobile, or API app.
Gets the details of a web, mobile, or API app.
get_slot(resource_group_name: str, name: str, slot: str, **kwargs: Any) -> Site | None
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
slot
Required
|
Name of the deployment slot. By default, this API returns the production slot. Required. |
Returns
Type | Description |
---|---|
Site,
|
Site or None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
get_source_control
Gets the source control configuration of an app.
Gets the source control configuration of an app.
get_source_control(resource_group_name: str, name: str, **kwargs: Any) -> SiteSourceControl
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
Returns
Type | Description |
---|---|
SiteSourceControl or the result of cls(response) |
Exceptions
Type | Description |
---|---|
get_source_control_slot
Gets the source control configuration of an app.
Gets the source control configuration of an app.
get_source_control_slot(resource_group_name: str, name: str, slot: str, **kwargs: Any) -> SiteSourceControl
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
slot
Required
|
Name of the deployment slot. If a slot is not specified, the API will get the source control configuration for the production slot. Required. |
Returns
Type | Description |
---|---|
SiteSourceControl or the result of cls(response) |
Exceptions
Type | Description |
---|---|
get_swift_virtual_network_connection
Gets a Swift Virtual Network connection.
Gets a Swift Virtual Network connection.
get_swift_virtual_network_connection(resource_group_name: str, name: str, **kwargs: Any) -> SwiftVirtualNetwork
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
Returns
Type | Description |
---|---|
SwiftVirtualNetwork or the result of cls(response) |
Exceptions
Type | Description |
---|---|
get_swift_virtual_network_connection_slot
Gets a Swift Virtual Network connection.
Gets a Swift Virtual Network connection.
get_swift_virtual_network_connection_slot(resource_group_name: str, name: str, slot: str, **kwargs: Any) -> SwiftVirtualNetwork
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
slot
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. Required. |
Returns
Type | Description |
---|---|
SwiftVirtualNetwork or the result of cls(response) |
Exceptions
Type | Description |
---|---|
get_triggered_web_job
Gets a triggered web job by its ID for an app, or a deployment slot.
Gets a triggered web job by its ID for an app, or a deployment slot.
get_triggered_web_job(resource_group_name: str, name: str, web_job_name: str, **kwargs: Any) -> TriggeredWebJob | None
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Site name. Required. |
web_job_name
Required
|
Name of Web Job. Required. |
Returns
Type | Description |
---|---|
TriggeredWebJob or None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
get_triggered_web_job_history
Gets a triggered web job's history by its ID for an app, , or a deployment slot.
Gets a triggered web job's history by its ID for an app, , or a deployment slot.
get_triggered_web_job_history(resource_group_name: str, name: str, web_job_name: str, id: str, **kwargs: Any) -> TriggeredJobHistory | None
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Site name. Required. |
web_job_name
Required
|
Name of Web Job. Required. |
id
Required
|
History ID. Required. |
Returns
Type | Description |
---|---|
TriggeredJobHistory or None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
get_triggered_web_job_history_slot
Gets a triggered web job's history by its ID for an app, , or a deployment slot.
Gets a triggered web job's history by its ID for an app, , or a deployment slot.
get_triggered_web_job_history_slot(resource_group_name: str, name: str, web_job_name: str, id: str, slot: str, **kwargs: Any) -> TriggeredJobHistory | None
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Site name. Required. |
web_job_name
Required
|
Name of Web Job. Required. |
id
Required
|
History ID. Required. |
slot
Required
|
Name of the deployment slot. If a slot is not specified, the API uses the production slot. Required. |
Returns
Type | Description |
---|---|
TriggeredJobHistory or None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
get_triggered_web_job_slot
Gets a triggered web job by its ID for an app, or a deployment slot.
Gets a triggered web job by its ID for an app, or a deployment slot.
get_triggered_web_job_slot(resource_group_name: str, name: str, web_job_name: str, slot: str, **kwargs: Any) -> TriggeredWebJob | None
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Site name. Required. |
web_job_name
Required
|
Name of Web Job. Required. |
slot
Required
|
Name of the deployment slot. If a slot is not specified, the API uses the production slot. Required. |
Returns
Type | Description |
---|---|
TriggeredWebJob or None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
get_vnet_connection
Gets a virtual network the app (or deployment slot) is connected to by name.
Gets a virtual network the app (or deployment slot) is connected to by name.
get_vnet_connection(resource_group_name: str, name: str, vnet_name: str, **kwargs: Any) -> VnetInfo
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
vnet_name
Required
|
Name of the virtual network. Required. |
Returns
Type | Description |
---|---|
VnetInfo or the result of cls(response) |
Exceptions
Type | Description |
---|---|
get_vnet_connection_gateway
Gets an app's Virtual Network gateway.
Gets an app's Virtual Network gateway.
get_vnet_connection_gateway(resource_group_name: str, name: str, vnet_name: str, gateway_name: str, **kwargs: Any) -> VnetGateway | None
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
vnet_name
Required
|
Name of the Virtual Network. Required. |
gateway_name
Required
|
Name of the gateway. Currently, the only supported string is "primary". Required. |
Returns
Type | Description |
---|---|
VnetGateway or None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
get_vnet_connection_gateway_slot
Gets an app's Virtual Network gateway.
Gets an app's Virtual Network gateway.
get_vnet_connection_gateway_slot(resource_group_name: str, name: str, vnet_name: str, gateway_name: str, slot: str, **kwargs: Any) -> VnetGateway | None
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
vnet_name
Required
|
Name of the Virtual Network. Required. |
gateway_name
Required
|
Name of the gateway. Currently, the only supported string is "primary". Required. |
slot
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. Required. |
Returns
Type | Description |
---|---|
VnetGateway or None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
get_vnet_connection_slot
Gets a virtual network the app (or deployment slot) is connected to by name.
Gets a virtual network the app (or deployment slot) is connected to by name.
get_vnet_connection_slot(resource_group_name: str, name: str, vnet_name: str, slot: str, **kwargs: Any) -> VnetInfo
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
vnet_name
Required
|
Name of the virtual network. Required. |
slot
Required
|
Name of the deployment slot. If a slot is not specified, the API will get the named virtual network for the production slot. Required. |
Returns
Type | Description |
---|---|
VnetInfo or the result of cls(response) |
Exceptions
Type | Description |
---|---|
get_web_job
Get webjob information for an app, or a deployment slot.
Get webjob information for an app, or a deployment slot.
get_web_job(resource_group_name: str, name: str, web_job_name: str, **kwargs: Any) -> WebJob
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Site name. Required. |
web_job_name
Required
|
Name of the web job. Required. |
Returns
Type | Description |
---|---|
WebJob or the result of cls(response) |
Exceptions
Type | Description |
---|---|
get_web_job_slot
Get webjob information for an app, or a deployment slot.
Get webjob information for an app, or a deployment slot.
get_web_job_slot(resource_group_name: str, name: str, web_job_name: str, slot: str, **kwargs: Any) -> WebJob
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Site name. Required. |
web_job_name
Required
|
Name of the web job. Required. |
slot
Required
|
Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot. Required. |
Returns
Type | Description |
---|---|
WebJob or the result of cls(response) |
Exceptions
Type | Description |
---|---|
get_web_site_container_logs
Gets the last lines of docker logs for the given site.
Gets the last lines of docker logs for the given site.
get_web_site_container_logs(resource_group_name: str, name: str, **kwargs: Any) -> Iterator[bytes] | None
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of web app. Required. |
Returns
Type | Description |
---|---|
Iterator[bytes] or None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
get_web_site_container_logs_slot
Gets the last lines of docker logs for the given site.
Gets the last lines of docker logs for the given site.
get_web_site_container_logs_slot(resource_group_name: str, name: str, slot: str, **kwargs: Any) -> Iterator[bytes] | None
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of web app. Required. |
slot
Required
|
Name of web app slot. If not specified then will default to production slot. Required. |
Returns
Type | Description |
---|---|
Iterator[bytes] or None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
is_cloneable
Shows whether an app can be cloned to another resource group or subscription.
Shows whether an app can be cloned to another resource group or subscription.
is_cloneable(resource_group_name: str, name: str, **kwargs: Any) -> SiteCloneability
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
Returns
Type | Description |
---|---|
SiteCloneability or the result of cls(response) |
Exceptions
Type | Description |
---|---|
is_cloneable_slot
Shows whether an app can be cloned to another resource group or subscription.
Shows whether an app can be cloned to another resource group or subscription.
is_cloneable_slot(resource_group_name: str, name: str, slot: str, **kwargs: Any) -> SiteCloneability
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
slot
Required
|
Name of the deployment slot. By default, this API returns information on the production slot. Required. |
Returns
Type | Description |
---|---|
SiteCloneability or the result of cls(response) |
Exceptions
Type | Description |
---|---|
list
Get all apps for a subscription.
Get all apps for a subscription.
list(**kwargs: Any) -> Iterable[Site]
Returns
Type | Description |
---|---|
An iterator like instance of either Site or the result of cls(response) |
Exceptions
Type | Description |
---|---|
list_application_settings
Gets the application settings of an app.
Gets the application settings of an app.
list_application_settings(resource_group_name: str, name: str, **kwargs: Any) -> StringDictionary
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
Returns
Type | Description |
---|---|
StringDictionary or the result of cls(response) |
Exceptions
Type | Description |
---|---|
list_application_settings_slot
Gets the application settings of an app.
Gets the application settings of an app.
list_application_settings_slot(resource_group_name: str, name: str, slot: str, **kwargs: Any) -> StringDictionary
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
slot
Required
|
Name of the deployment slot. If a slot is not specified, the API will get the application settings for the production slot. Required. |
Returns
Type | Description |
---|---|
StringDictionary or the result of cls(response) |
Exceptions
Type | Description |
---|---|
list_azure_storage_accounts
Gets the Azure storage account configurations of an app.
Gets the Azure storage account configurations of an app.
list_azure_storage_accounts(resource_group_name: str, name: str, **kwargs: Any) -> AzureStoragePropertyDictionaryResource
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
Returns
Type | Description |
---|---|
AzureStoragePropertyDictionaryResource or the result of cls(response) |
Exceptions
Type | Description |
---|---|
list_azure_storage_accounts_slot
Gets the Azure storage account configurations of an app.
Gets the Azure storage account configurations of an app.
list_azure_storage_accounts_slot(resource_group_name: str, name: str, slot: str, **kwargs: Any) -> AzureStoragePropertyDictionaryResource
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
slot
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. Required. |
Returns
Type | Description |
---|---|
AzureStoragePropertyDictionaryResource or the result of cls(response) |
Exceptions
Type | Description |
---|---|
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.
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(resource_group_name: str, name: str, backup_id: str, request: _models.BackupRequest, *, content_type: str = 'application/json', **kwargs: Any) -> _models.BackupItem
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of web app. Required. |
backup_id
Required
|
ID of backup. Required. |
request
Required
|
Information on backup request. Is either a BackupRequest type or a IO[bytes] type. Required. |
Returns
Type | Description |
---|---|
BackupItem or the result of cls(response) |
Exceptions
Type | Description |
---|---|
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.
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(resource_group_name: str, name: str, backup_id: str, slot: str, request: _models.BackupRequest, *, content_type: str = 'application/json', **kwargs: Any) -> _models.BackupItem
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of web app. Required. |
backup_id
Required
|
ID of backup. Required. |
slot
Required
|
Name of web app slot. If not specified then will default to production slot. Required. |
request
Required
|
Information on backup request. Is either a BackupRequest type or a IO[bytes] type. Required. |
Returns
Type | Description |
---|---|
BackupItem or the result of cls(response) |
Exceptions
Type | Description |
---|---|
list_backups
Gets existing backups of an app.
Gets existing backups of an app.
list_backups(resource_group_name: str, name: str, **kwargs: Any) -> Iterable[BackupItem]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
Returns
Type | Description |
---|---|
An iterator like instance of either BackupItem or the result of cls(response) |
Exceptions
Type | Description |
---|---|
list_backups_slot
Gets existing backups of an app.
Gets existing backups of an app.
list_backups_slot(resource_group_name: str, name: str, slot: str, **kwargs: Any) -> Iterable[BackupItem]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
slot
Required
|
Name of the deployment slot. If a slot is not specified, the API will get backups of the production slot. Required. |
Returns
Type | Description |
---|---|
An iterator like instance of either BackupItem or the result of cls(response) |
Exceptions
Type | Description |
---|---|
list_by_resource_group
Gets all web, mobile, and API apps in the specified resource group.
Gets all web, mobile, and API apps in the specified resource group.
list_by_resource_group(resource_group_name: str, include_slots: bool | None = None, **kwargs: Any) -> Iterable[Site]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
include_slots
Required
|
Specify |
Returns
Type | Description |
---|---|
An iterator like instance of either Site or the result of cls(response) |
Exceptions
Type | Description |
---|---|
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.
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) -> Iterable[SiteConfigurationSnapshotInfo]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
Returns
Type | Description |
---|---|
An iterator like instance of either SiteConfigurationSnapshotInfo or the result of cls(response) |
Exceptions
Type | Description |
---|---|
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.
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) -> Iterable[SiteConfigurationSnapshotInfo]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
slot
Required
|
Name of the deployment slot. If a slot is not specified, the API will return configuration for the production slot. Required. |
Returns
Type | Description |
---|---|
An iterator like instance of either SiteConfigurationSnapshotInfo or the result of cls(response) |
Exceptions
Type | Description |
---|---|
list_configurations
List the configurations of an app.
List the configurations of an app.
list_configurations(resource_group_name: str, name: str, **kwargs: Any) -> Iterable[SiteConfigResource]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
Returns
Type | Description |
---|---|
An iterator like instance of either SiteConfigResource or the result of cls(response) |
Exceptions
Type | Description |
---|---|
list_configurations_slot
List the configurations of an app.
List the configurations of an app.
list_configurations_slot(resource_group_name: str, name: str, slot: str, **kwargs: Any) -> Iterable[SiteConfigResource]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
slot
Required
|
Name of the deployment slot. If a slot is not specified, the API will return configuration for the production slot. Required. |
Returns
Type | Description |
---|---|
An iterator like instance of either SiteConfigResource or the result of cls(response) |
Exceptions
Type | Description |
---|---|
list_connection_strings
Gets the connection strings of an app.
Gets the connection strings of an app.
list_connection_strings(resource_group_name: str, name: str, **kwargs: Any) -> ConnectionStringDictionary
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
Returns
Type | Description |
---|---|
ConnectionStringDictionary or the result of cls(response) |
Exceptions
Type | Description |
---|---|
list_connection_strings_slot
Gets the connection strings of an app.
Gets the connection strings of an app.
list_connection_strings_slot(resource_group_name: str, name: str, slot: str, **kwargs: Any) -> ConnectionStringDictionary
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
slot
Required
|
Name of the deployment slot. If a slot is not specified, the API will get the connection settings for the production slot. Required. |
Returns
Type | Description |
---|---|
ConnectionStringDictionary or the result of cls(response) |
Exceptions
Type | Description |
---|---|
list_continuous_web_jobs
List continuous web jobs for an app, or a deployment slot.
List continuous web jobs for an app, or a deployment slot.
list_continuous_web_jobs(resource_group_name: str, name: str, **kwargs: Any) -> Iterable[ContinuousWebJob]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Site name. Required. |
Returns
Type | Description |
---|---|
An iterator like instance of either ContinuousWebJob or the result of cls(response) |
Exceptions
Type | Description |
---|---|
list_continuous_web_jobs_slot
List continuous web jobs for an app, or a deployment slot.
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) -> Iterable[ContinuousWebJob]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Site name. Required. |
slot
Required
|
Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot. Required. |
Returns
Type | Description |
---|---|
An iterator like instance of either ContinuousWebJob or the result of cls(response) |
Exceptions
Type | Description |
---|---|
list_deployment_log
List deployment log for specific deployment for an app, or a deployment slot.
List deployment log for specific deployment for an app, or a deployment slot.
list_deployment_log(resource_group_name: str, name: str, id: str, **kwargs: Any) -> Deployment
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
id
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". Required. |
Returns
Type | Description |
---|---|
Deployment or the result of cls(response) |
Exceptions
Type | Description |
---|---|
list_deployment_log_slot
List deployment log for specific deployment for an app, or a deployment slot.
List deployment log for specific deployment for an app, or a deployment slot.
list_deployment_log_slot(resource_group_name: str, name: str, id: str, slot: str, **kwargs: Any) -> Deployment
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
id
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". Required. |
slot
Required
|
Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot. Required. |
Returns
Type | Description |
---|---|
Deployment or the result of cls(response) |
Exceptions
Type | Description |
---|---|
list_deployments
List deployments for an app, or a deployment slot.
List deployments for an app, or a deployment slot.
list_deployments(resource_group_name: str, name: str, **kwargs: Any) -> Iterable[Deployment]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
Returns
Type | Description |
---|---|
An iterator like instance of either Deployment or the result of cls(response) |
Exceptions
Type | Description |
---|---|
list_deployments_slot
List deployments for an app, or a deployment slot.
List deployments for an app, or a deployment slot.
list_deployments_slot(resource_group_name: str, name: str, slot: str, **kwargs: Any) -> Iterable[Deployment]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
slot
Required
|
Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot. Required. |
Returns
Type | Description |
---|---|
An iterator like instance of either Deployment or the result of cls(response) |
Exceptions
Type | Description |
---|---|
list_domain_ownership_identifiers
Lists ownership identifiers for domain associated with web app.
Lists ownership identifiers for domain associated with web app.
list_domain_ownership_identifiers(resource_group_name: str, name: str, **kwargs: Any) -> Iterable[Identifier]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
Returns
Type | Description |
---|---|
An iterator like instance of either Identifier or the result of cls(response) |
Exceptions
Type | Description |
---|---|
list_domain_ownership_identifiers_slot
Lists ownership identifiers for domain associated with web app.
Lists ownership identifiers for domain associated with web app.
list_domain_ownership_identifiers_slot(resource_group_name: str, name: str, slot: str, **kwargs: Any) -> Iterable[Identifier]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
slot
Required
|
Name of the deployment slot. If a slot is not specified, the API will delete the binding for the production slot. Required. |
Returns
Type | Description |
---|---|
An iterator like instance of either Identifier or the result of cls(response) |
Exceptions
Type | Description |
---|---|
list_function_keys
Get function keys for a function in a web site, or a deployment slot.
Get function keys for a function in a web site, or a deployment slot.
list_function_keys(resource_group_name: str, name: str, function_name: str, **kwargs: Any) -> StringDictionary
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Site name. Required. |
function_name
Required
|
Function name. Required. |
Returns
Type | Description |
---|---|
StringDictionary or the result of cls(response) |
Exceptions
Type | Description |
---|---|
list_function_keys_slot
Get function keys for a function in a web site, or a deployment slot.
Get function keys for a function in a web site, or a deployment slot.
list_function_keys_slot(resource_group_name: str, name: str, function_name: str, slot: str, **kwargs: Any) -> StringDictionary
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Site name. Required. |
function_name
Required
|
Function name. Required. |
slot
Required
|
Name of the deployment slot. Required. |
Returns
Type | Description |
---|---|
StringDictionary or the result of cls(response) |
Exceptions
Type | Description |
---|---|
list_function_secrets
Get function secrets for a function in a web site, or a deployment slot.
Get function secrets for a function in a web site, or a deployment slot.
list_function_secrets(resource_group_name: str, name: str, function_name: str, **kwargs: Any) -> FunctionSecrets
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Site name. Required. |
function_name
Required
|
Function name. Required. |
Returns
Type | Description |
---|---|
FunctionSecrets or the result of cls(response) |
Exceptions
Type | Description |
---|---|
list_function_secrets_slot
Get function secrets for a function in a web site, or a deployment slot.
Get function secrets for a function in a web site, or a deployment slot.
list_function_secrets_slot(resource_group_name: str, name: str, function_name: str, slot: str, **kwargs: Any) -> FunctionSecrets
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Site name. Required. |
function_name
Required
|
Function name. Required. |
slot
Required
|
Name of the deployment slot. Required. |
Returns
Type | Description |
---|---|
FunctionSecrets or the result of cls(response) |
Exceptions
Type | Description |
---|---|
list_functions
List the functions for a web site, or a deployment slot.
List the functions for a web site, or a deployment slot.
list_functions(resource_group_name: str, name: str, **kwargs: Any) -> Iterable[FunctionEnvelope]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Site name. Required. |
Returns
Type | Description |
---|---|
An iterator like instance of either FunctionEnvelope or the result of cls(response) |
Exceptions
Type | Description |
---|---|
list_host_keys
Get host secrets for a function app.
Get host secrets for a function app.
list_host_keys(resource_group_name: str, name: str, **kwargs: Any) -> HostKeys
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Site name. Required. |
Returns
Type | Description |
---|---|
HostKeys or the result of cls(response) |
Exceptions
Type | Description |
---|---|
list_host_keys_slot
Get host secrets for a function app.
Get host secrets for a function app.
list_host_keys_slot(resource_group_name: str, name: str, slot: str, **kwargs: Any) -> HostKeys
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Site name. Required. |
slot
Required
|
Name of the deployment slot. Required. |
Returns
Type | Description |
---|---|
HostKeys or the result of cls(response) |
Exceptions
Type | Description |
---|---|
list_host_name_bindings
Get hostname bindings for an app or a deployment slot.
Get hostname bindings for an app or a deployment slot.
list_host_name_bindings(resource_group_name: str, name: str, **kwargs: Any) -> Iterable[HostNameBinding]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
Returns
Type | Description |
---|---|
An iterator like instance of either HostNameBinding or the result of cls(response) |
Exceptions
Type | Description |
---|---|
list_host_name_bindings_slot
Get hostname bindings for an app or a deployment slot.
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) -> Iterable[HostNameBinding]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
slot
Required
|
Name of the deployment slot. If a slot is not specified, the API gets hostname bindings for the production slot. Required. |
Returns
Type | Description |
---|---|
An iterator like instance of either HostNameBinding or the result of cls(response) |
Exceptions
Type | Description |
---|---|
list_hybrid_connections
Retrieves all Service Bus Hybrid Connections used by this Web App.
Retrieves all Service Bus Hybrid Connections used by this Web App.
list_hybrid_connections(resource_group_name: str, name: str, **kwargs: Any) -> HybridConnection
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
The name of the web app. Required. |
Returns
Type | Description |
---|---|
HybridConnection or the result of cls(response) |
Exceptions
Type | Description |
---|---|
list_hybrid_connections_slot
Retrieves all Service Bus Hybrid Connections used by this Web App.
Retrieves all Service Bus Hybrid Connections used by this Web App.
list_hybrid_connections_slot(resource_group_name: str, name: str, slot: str, **kwargs: Any) -> HybridConnection
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
The name of the web app. Required. |
slot
Required
|
The name of the slot for the web app. Required. |
Returns
Type | Description |
---|---|
HybridConnection or the result of cls(response) |
Exceptions
Type | Description |
---|---|
list_instance_functions_slot
List the functions for a web site, or a deployment slot.
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) -> Iterable[FunctionEnvelope]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Site name. Required. |
slot
Required
|
Name of the deployment slot. Required. |
Returns
Type | Description |
---|---|
An iterator like instance of either FunctionEnvelope or the result of cls(response) |
Exceptions
Type | Description |
---|---|
list_instance_identifiers
Gets all scale-out instances of an app.
Gets all scale-out instances of an app.
list_instance_identifiers(resource_group_name: str, name: str, **kwargs: Any) -> Iterable[WebSiteInstanceStatus]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
Returns
Type | Description |
---|---|
An iterator like instance of either WebSiteInstanceStatus or the result of cls(response) |
Exceptions
Type | Description |
---|---|
list_instance_identifiers_slot
Gets all scale-out instances of an app.
Gets all scale-out instances of an app.
list_instance_identifiers_slot(resource_group_name: str, name: str, slot: str, **kwargs: Any) -> Iterable[WebSiteInstanceStatus]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
slot
Required
|
Name of the deployment slot. If a slot is not specified, the API gets the production slot instances. Required. |
Returns
Type | Description |
---|---|
An iterator like instance of either WebSiteInstanceStatus or the result of cls(response) |
Exceptions
Type | Description |
---|---|
list_instance_process_modules
List module information for a process by its ID for a specific scaled-out instance in a web site.
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) -> Iterable[ProcessModuleInfo]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Site name. Required. |
process_id
Required
|
PID. Required. |
instance_id
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". Required. |
Returns
Type | Description |
---|---|
An iterator like instance of either ProcessModuleInfo or the result of cls(response) |
Exceptions
Type | Description |
---|---|
list_instance_process_modules_slot
List module information for a process by its ID for a specific scaled-out instance in a web site.
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) -> Iterable[ProcessModuleInfo]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Site name. Required. |
process_id
Required
|
PID. Required. |
slot
Required
|
Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot. Required. |
instance_id
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". Required. |
Returns
Type | Description |
---|---|
An iterator like instance of either ProcessModuleInfo or the result of cls(response) |
Exceptions
Type | Description |
---|---|
list_instance_process_threads
List the threads in a process by its ID for a specific scaled-out instance in a web site.
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) -> Iterable[ProcessThreadInfo]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Site name. Required. |
process_id
Required
|
PID. Required. |
instance_id
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". Required. |
Returns
Type | Description |
---|---|
An iterator like instance of either ProcessThreadInfo or the result of cls(response) |
Exceptions
Type | Description |
---|---|
list_instance_process_threads_slot
List the threads in a process by its ID for a specific scaled-out instance in a web site.
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) -> Iterable[ProcessThreadInfo]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Site name. Required. |
process_id
Required
|
PID. Required. |
slot
Required
|
Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot. Required. |
instance_id
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". Required. |
Returns
Type | Description |
---|---|
An iterator like instance of either ProcessThreadInfo or the result of cls(response) |
Exceptions
Type | Description |
---|---|
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.
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) -> Iterable[ProcessInfo]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Site name. Required. |
instance_id
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". Required. |
Returns
Type | Description |
---|---|
An iterator like instance of either ProcessInfo or the result of cls(response) |
Exceptions
Type | Description |
---|---|
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.
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) -> Iterable[ProcessInfo]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Site name. Required. |
slot
Required
|
Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot. Required. |
instance_id
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". Required. |
Returns
Type | Description |
---|---|
An iterator like instance of either ProcessInfo or the result of cls(response) |
Exceptions
Type | Description |
---|---|
list_metadata
Gets the metadata of an app.
Gets the metadata of an app.
list_metadata(resource_group_name: str, name: str, **kwargs: Any) -> StringDictionary
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
Returns
Type | Description |
---|---|
StringDictionary or the result of cls(response) |
Exceptions
Type | Description |
---|---|
list_metadata_slot
Gets the metadata of an app.
Gets the metadata of an app.
list_metadata_slot(resource_group_name: str, name: str, slot: str, **kwargs: Any) -> StringDictionary
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
slot
Required
|
Name of the deployment slot. If a slot is not specified, the API will get the metadata for the production slot. Required. |
Returns
Type | Description |
---|---|
StringDictionary or the result of cls(response) |
Exceptions
Type | Description |
---|---|
list_network_features
Gets all network features used by the app (or deployment slot, if specified).
Gets all network features used by the app (or deployment slot, if specified).
list_network_features(resource_group_name: str, name: str, view: str, **kwargs: Any) -> NetworkFeatures | None
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
view
Required
|
The type of view. Only "summary" is supported at this time. Required. |
Returns
Type | Description |
---|---|
NetworkFeatures or None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
list_network_features_slot
Gets all network features used by the app (or deployment slot, if specified).
Gets all network features used by the app (or deployment slot, if specified).
list_network_features_slot(resource_group_name: str, name: str, view: str, slot: str, **kwargs: Any) -> NetworkFeatures | None
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
view
Required
|
The type of view. Only "summary" is supported at this time. Required. |
slot
Required
|
Name of the deployment slot. If a slot is not specified, the API will get network features for the production slot. Required. |
Returns
Type | Description |
---|---|
NetworkFeatures or None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
list_perf_mon_counters
Gets perfmon counters for web app.
Gets perfmon counters for web app.
list_perf_mon_counters(resource_group_name: str, name: str, filter: str | None = None, **kwargs: Any) -> Iterable[PerfMonResponse]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of web app. Required. |
filter
Required
|
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]'. Default value is None. |
Returns
Type | Description |
---|---|
An iterator like instance of either PerfMonResponse or the result of cls(response) |
Exceptions
Type | Description |
---|---|
list_perf_mon_counters_slot
Gets perfmon counters for web app.
Gets perfmon counters for web app.
list_perf_mon_counters_slot(resource_group_name: str, name: str, slot: str, filter: str | None = None, **kwargs: Any) -> Iterable[PerfMonResponse]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of web app. Required. |
slot
Required
|
Name of web app slot. If not specified then will default to production slot. Required. |
filter
Required
|
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]'. Default value is None. |
Returns
Type | Description |
---|---|
An iterator like instance of either PerfMonResponse or the result of cls(response) |
Exceptions
Type | Description |
---|---|
list_premier_add_ons
Gets the premier add-ons of an app.
Gets the premier add-ons of an app.
list_premier_add_ons(resource_group_name: str, name: str, **kwargs: Any) -> PremierAddOn
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
Returns
Type | Description |
---|---|
PremierAddOn or the result of cls(response) |
Exceptions
Type | Description |
---|---|
list_premier_add_ons_slot
Gets the premier add-ons of an app.
Gets the premier add-ons of an app.
list_premier_add_ons_slot(resource_group_name: str, name: str, slot: str, **kwargs: Any) -> PremierAddOn
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
slot
Required
|
Name of the deployment slot. If a slot is not specified, the API will get the premier add-ons for the production slot. Required. |
Returns
Type | Description |
---|---|
PremierAddOn or the result of cls(response) |
Exceptions
Type | Description |
---|---|
list_process_modules
List module information for a process by its ID for a specific scaled-out instance in a web site.
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) -> Iterable[ProcessModuleInfo]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Site name. Required. |
process_id
Required
|
PID. Required. |
Returns
Type | Description |
---|---|
An iterator like instance of either ProcessModuleInfo or the result of cls(response) |
Exceptions
Type | Description |
---|---|
list_process_modules_slot
List module information for a process by its ID for a specific scaled-out instance in a web site.
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) -> Iterable[ProcessModuleInfo]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Site name. Required. |
process_id
Required
|
PID. Required. |
slot
Required
|
Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot. Required. |
Returns
Type | Description |
---|---|
An iterator like instance of either ProcessModuleInfo or the result of cls(response) |
Exceptions
Type | Description |
---|---|
list_process_threads
List the threads in a process by its ID for a specific scaled-out instance in a web site.
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) -> Iterable[ProcessThreadInfo]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Site name. Required. |
process_id
Required
|
PID. Required. |
Returns
Type | Description |
---|---|
An iterator like instance of either ProcessThreadInfo or the result of cls(response) |
Exceptions
Type | Description |
---|---|
list_process_threads_slot
List the threads in a process by its ID for a specific scaled-out instance in a web site.
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) -> Iterable[ProcessThreadInfo]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Site name. Required. |
process_id
Required
|
PID. Required. |
slot
Required
|
Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot. Required. |
Returns
Type | Description |
---|---|
An iterator like instance of either ProcessThreadInfo or the result of cls(response) |
Exceptions
Type | Description |
---|---|
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.
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) -> Iterable[ProcessInfo]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Site name. Required. |
Returns
Type | Description |
---|---|
An iterator like instance of either ProcessInfo or the result of cls(response) |
Exceptions
Type | Description |
---|---|
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.
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) -> Iterable[ProcessInfo]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Site name. Required. |
slot
Required
|
Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot. Required. |
Returns
Type | Description |
---|---|
An iterator like instance of either ProcessInfo or the result of cls(response) |
Exceptions
Type | Description |
---|---|
list_public_certificates
Get public certificates for an app or a deployment slot.
Get public certificates for an app or a deployment slot.
list_public_certificates(resource_group_name: str, name: str, **kwargs: Any) -> Iterable[PublicCertificate]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
Returns
Type | Description |
---|---|
An iterator like instance of either PublicCertificate or the result of cls(response) |
Exceptions
Type | Description |
---|---|
list_public_certificates_slot
Get public certificates for an app or a deployment slot.
Get public certificates for an app or a deployment slot.
list_public_certificates_slot(resource_group_name: str, name: str, slot: str, **kwargs: Any) -> Iterable[PublicCertificate]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
slot
Required
|
Name of the deployment slot. If a slot is not specified, the API gets hostname bindings for the production slot. Required. |
Returns
Type | Description |
---|---|
An iterator like instance of either PublicCertificate or the result of cls(response) |
Exceptions
Type | Description |
---|---|
list_publishing_profile_xml_with_secrets
Gets the publishing profile for an app (or deployment slot, if specified).
Gets the publishing profile for an app (or deployment slot, if specified).
list_publishing_profile_xml_with_secrets(resource_group_name: str, name: str, publishing_profile_options: _models.CsmPublishingProfileOptions, *, content_type: str = 'application/json', **kwargs: Any) -> Iterator[bytes]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
publishing_profile_options
Required
|
Specifies publishingProfileOptions for publishing profile. For example, use {"format": "FileZilla3"} to get a FileZilla publishing profile. Is either a CsmPublishingProfileOptions type or a IO[bytes] type. Required. |
Returns
Type | Description |
---|---|
Iterator[bytes] or the result of cls(response) |
Exceptions
Type | Description |
---|---|
list_publishing_profile_xml_with_secrets_slot
Gets the publishing profile for an app (or deployment slot, if specified).
Gets the publishing profile for an app (or deployment slot, if specified).
list_publishing_profile_xml_with_secrets_slot(resource_group_name: str, name: str, slot: str, publishing_profile_options: _models.CsmPublishingProfileOptions, *, content_type: str = 'application/json', **kwargs: Any) -> Iterator[bytes]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
slot
Required
|
Name of the deployment slot. If a slot is not specified, the API will get the publishing profile for the production slot. Required. |
publishing_profile_options
Required
|
Specifies publishingProfileOptions for publishing profile. For example, use {"format": "FileZilla3"} to get a FileZilla publishing profile. Is either a CsmPublishingProfileOptions type or a IO[bytes] type. Required. |
Returns
Type | Description |
---|---|
Iterator[bytes] or the result of cls(response) |
Exceptions
Type | Description |
---|---|
list_relay_service_connections
Gets hybrid connections configured for an app (or deployment slot, if specified).
Gets hybrid connections configured for an app (or deployment slot, if specified).
list_relay_service_connections(resource_group_name: str, name: str, **kwargs: Any) -> RelayServiceConnectionEntity
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
Returns
Type | Description |
---|---|
RelayServiceConnectionEntity or the result of cls(response) |
Exceptions
Type | Description |
---|---|
list_relay_service_connections_slot
Gets hybrid connections configured for an app (or deployment slot, if specified).
Gets hybrid connections configured for an app (or deployment slot, if specified).
list_relay_service_connections_slot(resource_group_name: str, name: str, slot: str, **kwargs: Any) -> RelayServiceConnectionEntity
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
slot
Required
|
Name of the deployment slot. If a slot is not specified, the API will get hybrid connections for the production slot. Required. |
Returns
Type | Description |
---|---|
RelayServiceConnectionEntity or the result of cls(response) |
Exceptions
Type | Description |
---|---|
list_site_backups
Gets existing backups of an app.
Gets existing backups of an app.
list_site_backups(resource_group_name: str, name: str, **kwargs: Any) -> Iterable[BackupItem]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
Returns
Type | Description |
---|---|
An iterator like instance of either BackupItem or the result of cls(response) |
Exceptions
Type | Description |
---|---|
list_site_backups_slot
Gets existing backups of an app.
Gets existing backups of an app.
list_site_backups_slot(resource_group_name: str, name: str, slot: str, **kwargs: Any) -> Iterable[BackupItem]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
slot
Required
|
Name of the deployment slot. If a slot is not specified, the API will get backups of the production slot. Required. |
Returns
Type | Description |
---|---|
An iterator like instance of either BackupItem or the result of cls(response) |
Exceptions
Type | Description |
---|---|
list_site_extensions
Get list of siteextensions for a web site, or a deployment slot.
Get list of siteextensions for a web site, or a deployment slot.
list_site_extensions(resource_group_name: str, name: str, **kwargs: Any) -> Iterable[SiteExtensionInfo]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Site name. Required. |
Returns
Type | Description |
---|---|
An iterator like instance of either SiteExtensionInfo or the result of cls(response) |
Exceptions
Type | Description |
---|---|
list_site_extensions_slot
Get list of siteextensions for a web site, or a deployment slot.
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) -> Iterable[SiteExtensionInfo]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Site name. Required. |
slot
Required
|
Name of the deployment slot. If a slot is not specified, the API uses the production slot. Required. |
Returns
Type | Description |
---|---|
An iterator like instance of either SiteExtensionInfo or the result of cls(response) |
Exceptions
Type | Description |
---|---|
list_site_push_settings
Gets the Push settings associated with web app.
Gets the Push settings associated with web app.
list_site_push_settings(resource_group_name: str, name: str, **kwargs: Any) -> PushSettings
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of web app. Required. |
Returns
Type | Description |
---|---|
PushSettings or the result of cls(response) |
Exceptions
Type | Description |
---|---|
list_site_push_settings_slot
Gets the Push settings associated with web app.
Gets the Push settings associated with web app.
list_site_push_settings_slot(resource_group_name: str, name: str, slot: str, **kwargs: Any) -> PushSettings
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of web app. Required. |
slot
Required
|
Name of web app slot. If not specified then will default to production slot. Required. |
Returns
Type | Description |
---|---|
PushSettings or the result of cls(response) |
Exceptions
Type | Description |
---|---|
list_slot_configuration_names
Gets the names of app settings and connection strings that stick to the slot (not swapped).
Gets the names of app settings and connection strings that stick to the slot (not swapped).
list_slot_configuration_names(resource_group_name: str, name: str, **kwargs: Any) -> SlotConfigNamesResource
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
Returns
Type | Description |
---|---|
SlotConfigNamesResource or the result of cls(response) |
Exceptions
Type | Description |
---|---|
list_slot_differences_from_production
Get the difference in configuration settings between two web app slots.
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: _models.CsmSlotEntity, *, content_type: str = 'application/json', **kwargs: Any) -> Iterable['_models.SlotDifference']
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
slot_swap_entity
Required
|
JSON object that contains the target slot name. See example. Is either a CsmSlotEntity type or a IO[bytes] type. Required. |
Returns
Type | Description |
---|---|
An iterator like instance of either SlotDifference or the result of cls(response) |
Exceptions
Type | Description |
---|---|
list_slot_differences_slot
Get the difference in configuration settings between two web app slots.
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: _models.CsmSlotEntity, *, content_type: str = 'application/json', **kwargs: Any) -> Iterable['_models.SlotDifference']
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
slot
Required
|
Name of the source slot. If a slot is not specified, the production slot is used as the source slot. Required. |
slot_swap_entity
Required
|
JSON object that contains the target slot name. See example. Is either a CsmSlotEntity type or a IO[bytes] type. Required. |
Returns
Type | Description |
---|---|
An iterator like instance of either SlotDifference or the result of cls(response) |
Exceptions
Type | Description |
---|---|
list_slots
Gets an app's deployment slots.
Gets an app's deployment slots.
list_slots(resource_group_name: str, name: str, **kwargs: Any) -> Iterable[Site]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
Returns
Type | Description |
---|---|
An iterator like instance of either Site or the result of cls(response) |
Exceptions
Type | Description |
---|---|
list_snapshots
Returns all Snapshots to the user.
Returns all Snapshots to the user.
list_snapshots(resource_group_name: str, name: str, **kwargs: Any) -> Iterable[Snapshot]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Website Name. Required. |
Returns
Type | Description |
---|---|
An iterator like instance of either Snapshot or the result of cls(response) |
Exceptions
Type | Description |
---|---|
list_snapshots_from_dr_secondary
Returns all Snapshots to the user from DRSecondary endpoint.
Returns all Snapshots to the user from DRSecondary endpoint.
list_snapshots_from_dr_secondary(resource_group_name: str, name: str, **kwargs: Any) -> Iterable[Snapshot]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Website Name. Required. |
Returns
Type | Description |
---|---|
An iterator like instance of either Snapshot or the result of cls(response) |
Exceptions
Type | Description |
---|---|
list_snapshots_from_dr_secondary_slot
Returns all Snapshots to the user from DRSecondary endpoint.
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) -> Iterable[Snapshot]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Website Name. Required. |
slot
Required
|
Website Slot. Required. |
Returns
Type | Description |
---|---|
An iterator like instance of either Snapshot or the result of cls(response) |
Exceptions
Type | Description |
---|---|
list_snapshots_slot
Returns all Snapshots to the user.
Returns all Snapshots to the user.
list_snapshots_slot(resource_group_name: str, name: str, slot: str, **kwargs: Any) -> Iterable[Snapshot]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Website Name. Required. |
slot
Required
|
Website Slot. Required. |
Returns
Type | Description |
---|---|
An iterator like instance of either Snapshot or the result of cls(response) |
Exceptions
Type | Description |
---|---|
list_sync_function_triggers
This is to allow calling via powershell and ARM template.
This is to allow calling via powershell and ARM template.
list_sync_function_triggers(resource_group_name: str, name: str, **kwargs: Any) -> FunctionSecrets
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
Returns
Type | Description |
---|---|
FunctionSecrets or the result of cls(response) |
Exceptions
Type | Description |
---|---|
list_sync_function_triggers_slot
This is to allow calling via powershell and ARM template.
This is to allow calling via powershell and ARM template.
list_sync_function_triggers_slot(resource_group_name: str, name: str, slot: str, **kwargs: Any) -> FunctionSecrets
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
slot
Required
|
Name of the deployment slot. Required. |
Returns
Type | Description |
---|---|
FunctionSecrets or the result of cls(response) |
Exceptions
Type | Description |
---|---|
list_sync_status
This is to allow calling via powershell and ARM template.
This is to allow calling via powershell and ARM template.
list_sync_status(resource_group_name: str, name: str, **kwargs: Any) -> None
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
Returns
Type | Description |
---|---|
None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
list_sync_status_slot
This is to allow calling via powershell and ARM template.
This is to allow calling via powershell and ARM template.
list_sync_status_slot(resource_group_name: str, name: str, slot: str, **kwargs: Any) -> None
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
slot
Required
|
Name of the deployment slot. Required. |
Returns
Type | Description |
---|---|
None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
list_triggered_web_job_history
List a triggered web job's history for an app, or a deployment slot.
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) -> Iterable[TriggeredJobHistory]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Site name. Required. |
web_job_name
Required
|
Name of Web Job. Required. |
Returns
Type | Description |
---|---|
An iterator like instance of either TriggeredJobHistory or the result of cls(response) |
Exceptions
Type | Description |
---|---|
list_triggered_web_job_history_slot
List a triggered web job's history for an app, or a deployment slot.
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) -> Iterable[TriggeredJobHistory]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Site name. Required. |
web_job_name
Required
|
Name of Web Job. Required. |
slot
Required
|
Name of the deployment slot. If a slot is not specified, the API uses the production slot. Required. |
Returns
Type | Description |
---|---|
An iterator like instance of either TriggeredJobHistory or the result of cls(response) |
Exceptions
Type | Description |
---|---|
list_triggered_web_jobs
List triggered web jobs for an app, or a deployment slot.
List triggered web jobs for an app, or a deployment slot.
list_triggered_web_jobs(resource_group_name: str, name: str, **kwargs: Any) -> Iterable[TriggeredWebJob]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Site name. Required. |
Returns
Type | Description |
---|---|
An iterator like instance of either TriggeredWebJob or the result of cls(response) |
Exceptions
Type | Description |
---|---|
list_triggered_web_jobs_slot
List triggered web jobs for an app, or a deployment slot.
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) -> Iterable[TriggeredWebJob]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Site name. Required. |
slot
Required
|
Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot. Required. |
Returns
Type | Description |
---|---|
An iterator like instance of either TriggeredWebJob or the result of cls(response) |
Exceptions
Type | Description |
---|---|
list_usages
Gets the quota usage information of an app (or deployment slot, if specified).
Gets the quota usage information of an app (or deployment slot, if specified).
list_usages(resource_group_name: str, name: str, filter: str | None = None, **kwargs: Any) -> Iterable[CsmUsageQuota]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
filter
Required
|
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]'. Default value is None. |
Returns
Type | Description |
---|---|
An iterator like instance of either CsmUsageQuota or the result of cls(response) |
Exceptions
Type | Description |
---|---|
list_usages_slot
Gets the quota usage information of an app (or deployment slot, if specified).
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: str | None = None, **kwargs: Any) -> Iterable[CsmUsageQuota]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
slot
Required
|
Name of the deployment slot. If a slot is not specified, the API will get quota information of the production slot. Required. |
filter
Required
|
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]'. Default value is None. |
Returns
Type | Description |
---|---|
An iterator like instance of either CsmUsageQuota or the result of cls(response) |
Exceptions
Type | Description |
---|---|
list_vnet_connections
Gets the virtual networks the app (or deployment slot) is connected to.
Gets the virtual networks the app (or deployment slot) is connected to.
list_vnet_connections(resource_group_name: str, name: str, **kwargs: Any) -> List[VnetInfo]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
Returns
Type | Description |
---|---|
list of VnetInfo or the result of cls(response) |
Exceptions
Type | Description |
---|---|
list_vnet_connections_slot
Gets the virtual networks the app (or deployment slot) is connected to.
Gets the virtual networks the app (or deployment slot) is connected to.
list_vnet_connections_slot(resource_group_name: str, name: str, slot: str, **kwargs: Any) -> List[VnetInfo]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
slot
Required
|
Name of the deployment slot. If a slot is not specified, the API will get virtual network connections for the production slot. Required. |
Returns
Type | Description |
---|---|
list of VnetInfo or the result of cls(response) |
Exceptions
Type | Description |
---|---|
list_web_jobs
List webjobs for an app, or a deployment slot.
List webjobs for an app, or a deployment slot.
list_web_jobs(resource_group_name: str, name: str, **kwargs: Any) -> Iterable[WebJob]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Site name. Required. |
Returns
Type | Description |
---|---|
An iterator like instance of either WebJob or the result of cls(response) |
Exceptions
Type | Description |
---|---|
list_web_jobs_slot
List webjobs for an app, or a deployment slot.
List webjobs for an app, or a deployment slot.
list_web_jobs_slot(resource_group_name: str, name: str, slot: str, **kwargs: Any) -> Iterable[WebJob]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Site name. Required. |
slot
Required
|
Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot. Required. |
Returns
Type | Description |
---|---|
An iterator like instance of either WebJob or the result of cls(response) |
Exceptions
Type | Description |
---|---|
put_private_access_vnet
Sets data around private site access enablement and authorized Virtual Networks that can access the site.
Sets data around private site access enablement and authorized Virtual Networks that can access the site.
put_private_access_vnet(resource_group_name: str, name: str, access: _models.PrivateAccess, *, content_type: str = 'application/json', **kwargs: Any) -> _models.PrivateAccess
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
The name of the web app. Required. |
access
Required
|
The information for the private access. Is either a PrivateAccess type or a IO[bytes] type. Required. |
Returns
Type | Description |
---|---|
PrivateAccess or the result of cls(response) |
Exceptions
Type | Description |
---|---|
put_private_access_vnet_slot
Sets data around private site access enablement and authorized Virtual Networks that can access the site.
Sets data around private site access enablement and authorized Virtual Networks that can access the site.
put_private_access_vnet_slot(resource_group_name: str, name: str, slot: str, access: _models.PrivateAccess, *, content_type: str = 'application/json', **kwargs: Any) -> _models.PrivateAccess
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
The name of the web app. Required. |
slot
Required
|
The name of the slot for the web app. Required. |
access
Required
|
The information for the private access. Is either a PrivateAccess type or a IO[bytes] type. Required. |
Returns
Type | Description |
---|---|
PrivateAccess or the result of cls(response) |
Exceptions
Type | Description |
---|---|
recover_site_configuration_snapshot
Reverts the configuration of an app to a previous snapshot.
Reverts the configuration of an app to a previous snapshot.
recover_site_configuration_snapshot(resource_group_name: str, name: str, snapshot_id: str, **kwargs: Any) -> None
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
snapshot_id
Required
|
The ID of the snapshot to read. Required. |
Returns
Type | Description |
---|---|
None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
recover_site_configuration_snapshot_slot
Reverts the configuration of an app to a previous snapshot.
Reverts the configuration of an app to a previous snapshot.
recover_site_configuration_snapshot_slot(resource_group_name: str, name: str, snapshot_id: str, slot: str, **kwargs: Any) -> None
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
snapshot_id
Required
|
The ID of the snapshot to read. Required. |
slot
Required
|
Name of the deployment slot. If a slot is not specified, the API will return configuration for the production slot. Required. |
Returns
Type | Description |
---|---|
None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
reset_production_slot_config
Resets the configuration settings of the current slot if they were previously modified by calling the API with POST.
Resets the configuration settings of the current slot if they were previously modified by calling the API with POST.
reset_production_slot_config(resource_group_name: str, name: str, **kwargs: Any) -> None
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
Returns
Type | Description |
---|---|
None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
reset_slot_configuration_slot
Resets the configuration settings of the current slot if they were previously modified by calling the API with POST.
Resets the configuration settings of the current slot if they were previously modified by calling the API with POST.
reset_slot_configuration_slot(resource_group_name: str, name: str, slot: str, **kwargs: Any) -> None
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
slot
Required
|
Name of the deployment slot. If a slot is not specified, the API resets configuration settings for the production slot. Required. |
Returns
Type | Description |
---|---|
None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
restart
Restarts an app (or deployment slot, if specified).
Restarts an app (or deployment slot, if specified).
restart(resource_group_name: str, name: str, soft_restart: bool | None = None, synchronous: bool | None = None, **kwargs: Any) -> None
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
soft_restart
Required
|
Specify true to apply the configuration settings and restarts the app only if necessary. By default, the API always restarts and reprovisions the app. Default value is None. |
synchronous
Required
|
Specify true to block until the app is restarted. By default, it is set to false, and the API responds immediately (asynchronous). Default value is None. |
Returns
Type | Description |
---|---|
None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
restart_slot
Restarts an app (or deployment slot, if specified).
Restarts an app (or deployment slot, if specified).
restart_slot(resource_group_name: str, name: str, slot: str, soft_restart: bool | None = None, synchronous: bool | None = None, **kwargs: Any) -> None
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
slot
Required
|
Name of the deployment slot. If a slot is not specified, the API will restart the production slot. Required. |
soft_restart
Required
|
Specify true to apply the configuration settings and restarts the app only if necessary. By default, the API always restarts and reprovisions the app. Default value is None. |
synchronous
Required
|
Specify true to block until the app is restarted. By default, it is set to false, and the API responds immediately (asynchronous). Default value is None. |
Returns
Type | Description |
---|---|
None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
run_triggered_web_job
Run a triggered web job for an app, or a deployment slot.
Run a triggered web job for an app, or a deployment slot.
run_triggered_web_job(resource_group_name: str, name: str, web_job_name: str, **kwargs: Any) -> None
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Site name. Required. |
web_job_name
Required
|
Name of Web Job. Required. |
Returns
Type | Description |
---|---|
None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
run_triggered_web_job_slot
Run a triggered web job for an app, or a deployment slot.
Run a triggered web job for an app, or a deployment slot.
run_triggered_web_job_slot(resource_group_name: str, name: str, web_job_name: str, slot: str, **kwargs: Any) -> None
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Site name. Required. |
web_job_name
Required
|
Name of Web Job. Required. |
slot
Required
|
Name of the deployment slot. If a slot is not specified, the API uses the production slot. Required. |
Returns
Type | Description |
---|---|
None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
start
Starts an app (or deployment slot, if specified).
Starts an app (or deployment slot, if specified).
start(resource_group_name: str, name: str, **kwargs: Any) -> None
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
Returns
Type | Description |
---|---|
None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
start_continuous_web_job
Start a continuous web job for an app, or a deployment slot.
Start a continuous web job for an app, or a deployment slot.
start_continuous_web_job(resource_group_name: str, name: str, web_job_name: str, **kwargs: Any) -> None
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Site name. Required. |
web_job_name
Required
|
Name of Web Job. Required. |
Returns
Type | Description |
---|---|
None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
start_continuous_web_job_slot
Start a continuous web job for an app, or a deployment slot.
Start a continuous web job for an app, or a deployment slot.
start_continuous_web_job_slot(resource_group_name: str, name: str, web_job_name: str, slot: str, **kwargs: Any) -> None
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Site name. Required. |
web_job_name
Required
|
Name of Web Job. Required. |
slot
Required
|
Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot. Required. |
Returns
Type | Description |
---|---|
None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
start_slot
Starts an app (or deployment slot, if specified).
Starts an app (or deployment slot, if specified).
start_slot(resource_group_name: str, name: str, slot: str, **kwargs: Any) -> None
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
slot
Required
|
Name of the deployment slot. If a slot is not specified, the API will start the production slot. Required. |
Returns
Type | Description |
---|---|
None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
start_web_site_network_trace
Start capturing network packets for the site (To be deprecated).
Start capturing network packets for the site (To be deprecated).
start_web_site_network_trace(resource_group_name: str, name: str, duration_in_seconds: int | None = None, max_frame_length: int | None = None, sas_url: str | None = None, **kwargs: Any) -> str
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
The name of the web app. Required. |
duration_in_seconds
Required
|
The duration to keep capturing in seconds. Default value is None. |
max_frame_length
Required
|
The maximum frame length in bytes (Optional). Default value is None. |
sas_url
Required
|
The Blob URL to store capture file. Default value is None. |
Returns
Type | Description |
---|---|
str or the result of cls(response) |
Exceptions
Type | Description |
---|---|
start_web_site_network_trace_slot
Start capturing network packets for the site (To be deprecated).
Start capturing network packets for the site (To be deprecated).
start_web_site_network_trace_slot(resource_group_name: str, name: str, slot: str, duration_in_seconds: int | None = None, max_frame_length: int | None = None, sas_url: str | None = None, **kwargs: Any) -> str
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
The name of the web app. Required. |
slot
Required
|
The name of the slot for this web app. Required. |
duration_in_seconds
Required
|
The duration to keep capturing in seconds. Default value is None. |
max_frame_length
Required
|
The maximum frame length in bytes (Optional). Default value is None. |
sas_url
Required
|
The Blob URL to store capture file. Default value is None. |
Returns
Type | Description |
---|---|
str or the result of cls(response) |
Exceptions
Type | Description |
---|---|
stop
Stops an app (or deployment slot, if specified).
Stops an app (or deployment slot, if specified).
stop(resource_group_name: str, name: str, **kwargs: Any) -> None
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
Returns
Type | Description |
---|---|
None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
stop_continuous_web_job
Stop a continuous web job for an app, or a deployment slot.
Stop a continuous web job for an app, or a deployment slot.
stop_continuous_web_job(resource_group_name: str, name: str, web_job_name: str, **kwargs: Any) -> None
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Site name. Required. |
web_job_name
Required
|
Name of Web Job. Required. |
Returns
Type | Description |
---|---|
None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
stop_continuous_web_job_slot
Stop a continuous web job for an app, or a deployment slot.
Stop a continuous web job for an app, or a deployment slot.
stop_continuous_web_job_slot(resource_group_name: str, name: str, web_job_name: str, slot: str, **kwargs: Any) -> None
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Site name. Required. |
web_job_name
Required
|
Name of Web Job. Required. |
slot
Required
|
Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot. Required. |
Returns
Type | Description |
---|---|
None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
stop_network_trace
Stop ongoing capturing network packets for the site.
Stop ongoing capturing network packets for the site.
stop_network_trace(resource_group_name: str, name: str, **kwargs: Any) -> None
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
The name of the web app. Required. |
Returns
Type | Description |
---|---|
None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
stop_network_trace_slot
Stop ongoing capturing network packets for the site.
Stop ongoing capturing network packets for the site.
stop_network_trace_slot(resource_group_name: str, name: str, slot: str, **kwargs: Any) -> None
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
The name of the web app. Required. |
slot
Required
|
The name of the slot for this web app. Required. |
Returns
Type | Description |
---|---|
None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
stop_slot
Stops an app (or deployment slot, if specified).
Stops an app (or deployment slot, if specified).
stop_slot(resource_group_name: str, name: str, slot: str, **kwargs: Any) -> None
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
slot
Required
|
Name of the deployment slot. If a slot is not specified, the API will stop the production slot. Required. |
Returns
Type | Description |
---|---|
None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
stop_web_site_network_trace
Stop ongoing capturing network packets for the site.
Stop ongoing capturing network packets for the site.
stop_web_site_network_trace(resource_group_name: str, name: str, **kwargs: Any) -> None
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
The name of the web app. Required. |
Returns
Type | Description |
---|---|
None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
stop_web_site_network_trace_slot
Stop ongoing capturing network packets for the site.
Stop ongoing capturing network packets for the site.
stop_web_site_network_trace_slot(resource_group_name: str, name: str, slot: str, **kwargs: Any) -> None
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
The name of the web app. Required. |
slot
Required
|
The name of the slot for this web app. Required. |
Returns
Type | Description |
---|---|
None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
sync_function_triggers
Syncs function trigger metadata to the management database.
Syncs function trigger metadata to the management database.
sync_function_triggers(resource_group_name: str, name: str, **kwargs: Any) -> None
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
Returns
Type | Description |
---|---|
None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
sync_function_triggers_slot
Syncs function trigger metadata to the management database.
Syncs function trigger metadata to the management database.
sync_function_triggers_slot(resource_group_name: str, name: str, slot: str, **kwargs: Any) -> None
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
slot
Required
|
Name of the deployment slot. Required. |
Returns
Type | Description |
---|---|
None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
sync_functions
Syncs function trigger metadata to the management database.
Syncs function trigger metadata to the management database.
sync_functions(resource_group_name: str, name: str, **kwargs: Any) -> None
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
Returns
Type | Description |
---|---|
None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
sync_functions_slot
Syncs function trigger metadata to the management database.
Syncs function trigger metadata to the management database.
sync_functions_slot(resource_group_name: str, name: str, slot: str, **kwargs: Any) -> None
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
slot
Required
|
Name of the deployment slot. Required. |
Returns
Type | Description |
---|---|
None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
sync_repository
Sync web app repository.
Sync web app repository.
sync_repository(resource_group_name: str, name: str, **kwargs: Any) -> None
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of web app. Required. |
Returns
Type | Description |
---|---|
None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
sync_repository_slot
Sync web app repository.
Sync web app repository.
sync_repository_slot(resource_group_name: str, name: str, slot: str, **kwargs: Any) -> None
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of web app. Required. |
slot
Required
|
Name of web app slot. If not specified then will default to production slot. Required. |
Returns
Type | Description |
---|---|
None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
update
Creates a new web, mobile, or API app in an existing resource group, or updates an existing app.
Creates a new web, mobile, or API app in an existing resource group, or updates an existing app.
update(resource_group_name: str, name: str, site_envelope: _models.SitePatchResource, *, content_type: str = 'application/json', **kwargs: Any) -> _models.Site
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Unique name of the app to create or update. To create or update a deployment slot, use the {slot} parameter. Required. |
site_envelope
Required
|
A JSON representation of the app properties. See example. Is either a SitePatchResource type or a IO[bytes] type. Required. |
Returns
Type | Description |
---|---|
Site or the result of cls(response) |
Exceptions
Type | Description |
---|---|
update_application_settings
Replaces the application settings of an app.
Replaces the application settings of an app.
update_application_settings(resource_group_name: str, name: str, app_settings: _models.StringDictionary, *, content_type: str = 'application/json', **kwargs: Any) -> _models.StringDictionary
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
app_settings
Required
|
Application settings of the app. Is either a StringDictionary type or a IO[bytes] type. Required. |
Returns
Type | Description |
---|---|
StringDictionary or the result of cls(response) |
Exceptions
Type | Description |
---|---|
update_application_settings_slot
Replaces the application settings of an app.
Replaces the application settings of an app.
update_application_settings_slot(resource_group_name: str, name: str, slot: str, app_settings: _models.StringDictionary, *, content_type: str = 'application/json', **kwargs: Any) -> _models.StringDictionary
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
slot
Required
|
Name of the deployment slot. If a slot is not specified, the API will update the application settings for the production slot. Required. |
app_settings
Required
|
Application settings of the app. Is either a StringDictionary type or a IO[bytes] type. Required. |
Returns
Type | Description |
---|---|
StringDictionary or the result of cls(response) |
Exceptions
Type | Description |
---|---|
update_auth_settings
Updates the Authentication / Authorization settings associated with web app.
Updates the Authentication / Authorization settings associated with web app.
update_auth_settings(resource_group_name: str, name: str, site_auth_settings: _models.SiteAuthSettings, *, content_type: str = 'application/json', **kwargs: Any) -> _models.SiteAuthSettings
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of web app. Required. |
site_auth_settings
Required
|
Auth settings associated with web app. Is either a SiteAuthSettings type or a IO[bytes] type. Required. |
Returns
Type | Description |
---|---|
SiteAuthSettings or the result of cls(response) |
Exceptions
Type | Description |
---|---|
update_auth_settings_slot
Updates the Authentication / Authorization settings associated with web app.
Updates the Authentication / Authorization settings associated with web app.
update_auth_settings_slot(resource_group_name: str, name: str, slot: str, site_auth_settings: _models.SiteAuthSettings, *, content_type: str = 'application/json', **kwargs: Any) -> _models.SiteAuthSettings
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of web app. Required. |
slot
Required
|
Name of web app slot. If not specified then will default to production slot. Required. |
site_auth_settings
Required
|
Auth settings associated with web app. Is either a SiteAuthSettings type or a IO[bytes] type. Required. |
Returns
Type | Description |
---|---|
SiteAuthSettings or the result of cls(response) |
Exceptions
Type | Description |
---|---|
update_auth_settings_v2
Updates site's Authentication / Authorization settings for apps via the V2 format.
Updates site's Authentication / Authorization settings for apps via the V2 format.
update_auth_settings_v2(resource_group_name: str, name: str, site_auth_settings_v2: _models.SiteAuthSettingsV2, *, content_type: str = 'application/json', **kwargs: Any) -> _models.SiteAuthSettingsV2
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of web app. Required. |
site_auth_settings_v2
Required
|
Auth settings associated with web app. Is either a SiteAuthSettingsV2 type or a IO[bytes] type. Required. |
Returns
Type | Description |
---|---|
SiteAuthSettingsV2 or the result of cls(response) |
Exceptions
Type | Description |
---|---|
update_auth_settings_v2_slot
Updates site's Authentication / Authorization settings for apps via the V2 format.
Updates site's Authentication / Authorization settings for apps via the V2 format.
update_auth_settings_v2_slot(resource_group_name: str, name: str, slot: str, site_auth_settings_v2: _models.SiteAuthSettingsV2, *, content_type: str = 'application/json', **kwargs: Any) -> _models.SiteAuthSettingsV2
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of web app. Required. |
slot
Required
|
Name of web app slot. If not specified then will default to production slot. Required. |
site_auth_settings_v2
Required
|
Auth settings associated with web app. Is either a SiteAuthSettingsV2 type or a IO[bytes] type. Required. |
Returns
Type | Description |
---|---|
SiteAuthSettingsV2 or the result of cls(response) |
Exceptions
Type | Description |
---|---|
update_azure_storage_accounts
Updates the Azure storage account configurations of an app.
Updates the Azure storage account configurations of an app.
update_azure_storage_accounts(resource_group_name: str, name: str, azure_storage_accounts: _models.AzureStoragePropertyDictionaryResource, *, content_type: str = 'application/json', **kwargs: Any) -> _models.AzureStoragePropertyDictionaryResource
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
azure_storage_accounts
Required
|
Azure storage accounts of the app. Is either a AzureStoragePropertyDictionaryResource type or a IO[bytes] type. Required. |
Returns
Type | Description |
---|---|
AzureStoragePropertyDictionaryResource or the result of cls(response) |
Exceptions
Type | Description |
---|---|
update_azure_storage_accounts_slot
Updates the Azure storage account configurations of an app.
Updates the Azure storage account configurations of an app.
update_azure_storage_accounts_slot(resource_group_name: str, name: str, slot: str, azure_storage_accounts: _models.AzureStoragePropertyDictionaryResource, *, content_type: str = 'application/json', **kwargs: Any) -> _models.AzureStoragePropertyDictionaryResource
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
slot
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. Required. |
azure_storage_accounts
Required
|
Azure storage accounts of the app. Is either a AzureStoragePropertyDictionaryResource type or a IO[bytes] type. Required. |
Returns
Type | Description |
---|---|
AzureStoragePropertyDictionaryResource or the result of cls(response) |
Exceptions
Type | Description |
---|---|
update_backup_configuration
Updates the backup configuration of an app.
Updates the backup configuration of an app.
update_backup_configuration(resource_group_name: str, name: str, request: _models.BackupRequest, *, content_type: str = 'application/json', **kwargs: Any) -> _models.BackupRequest
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
request
Required
|
Edited backup configuration. Is either a BackupRequest type or a IO[bytes] type. Required. |
Returns
Type | Description |
---|---|
BackupRequest or the result of cls(response) |
Exceptions
Type | Description |
---|---|
update_backup_configuration_slot
Updates the backup configuration of an app.
Updates the backup configuration of an app.
update_backup_configuration_slot(resource_group_name: str, name: str, slot: str, request: _models.BackupRequest, *, content_type: str = 'application/json', **kwargs: Any) -> _models.BackupRequest
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
slot
Required
|
Name of the deployment slot. If a slot is not specified, the API will update the backup configuration for the production slot. Required. |
request
Required
|
Edited backup configuration. Is either a BackupRequest type or a IO[bytes] type. Required. |
Returns
Type | Description |
---|---|
BackupRequest or the result of cls(response) |
Exceptions
Type | Description |
---|---|
update_configuration
Updates the configuration of an app.
Updates the configuration of an app.
update_configuration(resource_group_name: str, name: str, site_config: _models.SiteConfigResource, *, content_type: str = 'application/json', **kwargs: Any) -> _models.SiteConfigResource
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
site_config
Required
|
JSON representation of a SiteConfig object. See example. Is either a SiteConfigResource type or a IO[bytes] type. Required. |
Returns
Type | Description |
---|---|
SiteConfigResource or the result of cls(response) |
Exceptions
Type | Description |
---|---|
update_configuration_slot
Updates the configuration of an app.
Updates the configuration of an app.
update_configuration_slot(resource_group_name: str, name: str, slot: str, site_config: _models.SiteConfigResource, *, content_type: str = 'application/json', **kwargs: Any) -> _models.SiteConfigResource
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
slot
Required
|
Name of the deployment slot. If a slot is not specified, the API will update configuration for the production slot. Required. |
site_config
Required
|
JSON representation of a SiteConfig object. See example. Is either a SiteConfigResource type or a IO[bytes] type. Required. |
Returns
Type | Description |
---|---|
SiteConfigResource or the result of cls(response) |
Exceptions
Type | Description |
---|---|
update_connection_strings
Replaces the connection strings of an app.
Replaces the connection strings of an app.
update_connection_strings(resource_group_name: str, name: str, connection_strings: _models.ConnectionStringDictionary, *, content_type: str = 'application/json', **kwargs: Any) -> _models.ConnectionStringDictionary
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
connection_strings
Required
|
Connection strings of the app or deployment slot. See example. Is either a ConnectionStringDictionary type or a IO[bytes] type. Required. |
Returns
Type | Description |
---|---|
ConnectionStringDictionary or the result of cls(response) |
Exceptions
Type | Description |
---|---|
update_connection_strings_slot
Replaces the connection strings of an app.
Replaces the connection strings of an app.
update_connection_strings_slot(resource_group_name: str, name: str, slot: str, connection_strings: _models.ConnectionStringDictionary, *, content_type: str = 'application/json', **kwargs: Any) -> _models.ConnectionStringDictionary
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
slot
Required
|
Name of the deployment slot. If a slot is not specified, the API will update the connection settings for the production slot. Required. |
connection_strings
Required
|
Connection strings of the app or deployment slot. See example. Is either a ConnectionStringDictionary type or a IO[bytes] type. Required. |
Returns
Type | Description |
---|---|
ConnectionStringDictionary or the result of cls(response) |
Exceptions
Type | Description |
---|---|
update_diagnostic_logs_config
Updates the logging configuration of an app.
Updates the logging configuration of an app.
update_diagnostic_logs_config(resource_group_name: str, name: str, site_logs_config: _models.SiteLogsConfig, *, content_type: str = 'application/json', **kwargs: Any) -> _models.SiteLogsConfig
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
site_logs_config
Required
|
A SiteLogsConfig JSON object that contains the logging configuration to change in the "properties" property. Is either a SiteLogsConfig type or a IO[bytes] type. Required. |
Returns
Type | Description |
---|---|
SiteLogsConfig or the result of cls(response) |
Exceptions
Type | Description |
---|---|
update_diagnostic_logs_config_slot
Updates the logging configuration of an app.
Updates the logging configuration of an app.
update_diagnostic_logs_config_slot(resource_group_name: str, name: str, slot: str, site_logs_config: _models.SiteLogsConfig, *, content_type: str = 'application/json', **kwargs: Any) -> _models.SiteLogsConfig
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
slot
Required
|
Name of the deployment slot. If a slot is not specified, the API will update the logging configuration for the production slot. Required. |
site_logs_config
Required
|
A SiteLogsConfig JSON object that contains the logging configuration to change in the "properties" property. Is either a SiteLogsConfig type or a IO[bytes] type. Required. |
Returns
Type | Description |
---|---|
SiteLogsConfig or the result of cls(response) |
Exceptions
Type | Description |
---|---|
update_domain_ownership_identifier
Creates a domain ownership identifier for web app, or updates an existing ownership identifier.
Creates a domain ownership identifier for web app, or updates an existing ownership identifier.
update_domain_ownership_identifier(resource_group_name: str, name: str, domain_ownership_identifier_name: str, domain_ownership_identifier: _models.Identifier, *, content_type: str = 'application/json', **kwargs: Any) -> _models.Identifier
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
domain_ownership_identifier_name
Required
|
Name of domain ownership identifier. Required. |
domain_ownership_identifier
Required
|
A JSON representation of the domain ownership properties. Is either a Identifier type or a IO[bytes] type. Required. |
Returns
Type | Description |
---|---|
Identifier or the result of cls(response) |
Exceptions
Type | Description |
---|---|
update_domain_ownership_identifier_slot
Creates a domain ownership identifier for web app, or updates an existing ownership identifier.
Creates a domain ownership identifier for web app, or updates an existing ownership identifier.
update_domain_ownership_identifier_slot(resource_group_name: str, name: str, domain_ownership_identifier_name: str, slot: str, domain_ownership_identifier: _models.Identifier, *, content_type: str = 'application/json', **kwargs: Any) -> _models.Identifier
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
domain_ownership_identifier_name
Required
|
Name of domain ownership identifier. Required. |
slot
Required
|
Name of the deployment slot. If a slot is not specified, the API will delete the binding for the production slot. Required. |
domain_ownership_identifier
Required
|
A JSON representation of the domain ownership properties. Is either a Identifier type or a IO[bytes] type. Required. |
Returns
Type | Description |
---|---|
Identifier or the result of cls(response) |
Exceptions
Type | Description |
---|---|
update_ftp_allowed
Updates whether FTP is allowed on the site or not.
Updates whether FTP is allowed on the site or not.
update_ftp_allowed(resource_group_name: str, name: str, csm_publishing_access_policies_entity: _models.CsmPublishingCredentialsPoliciesEntity, *, content_type: str = 'application/json', **kwargs: Any) -> _models.CsmPublishingCredentialsPoliciesEntity
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
csm_publishing_access_policies_entity
Required
|
Is either a CsmPublishingCredentialsPoliciesEntity type or a IO[bytes] type. Required. |
Returns
Type | Description |
---|---|
CsmPublishingCredentialsPoliciesEntity or the result of cls(response) |
Exceptions
Type | Description |
---|---|
update_ftp_allowed_slot
Updates whether FTP is allowed on the site or not.
Updates whether FTP is allowed on the site or not.
update_ftp_allowed_slot(resource_group_name: str, name: str, slot: str, csm_publishing_access_policies_entity: _models.CsmPublishingCredentialsPoliciesEntity, *, content_type: str = 'application/json', **kwargs: Any) -> _models.CsmPublishingCredentialsPoliciesEntity
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
slot
Required
|
Required. |
csm_publishing_access_policies_entity
Required
|
Is either a CsmPublishingCredentialsPoliciesEntity type or a IO[bytes] type. Required. |
Returns
Type | Description |
---|---|
CsmPublishingCredentialsPoliciesEntity or the result of cls(response) |
Exceptions
Type | Description |
---|---|
update_hybrid_connection
Creates a new Hybrid Connection using a Service Bus relay.
Creates a new Hybrid Connection using a Service Bus relay.
update_hybrid_connection(resource_group_name: str, name: str, namespace_name: str, relay_name: str, connection_envelope: _models.HybridConnection, *, content_type: str = 'application/json', **kwargs: Any) -> _models.HybridConnection
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
The name of the web app. Required. |
namespace_name
Required
|
The namespace for this hybrid connection. Required. |
relay_name
Required
|
The relay name for this hybrid connection. Required. |
connection_envelope
Required
|
The details of the hybrid connection. Is either a HybridConnection type or a IO[bytes] type. Required. |
Returns
Type | Description |
---|---|
HybridConnection or the result of cls(response) |
Exceptions
Type | Description |
---|---|
update_hybrid_connection_slot
Creates a new Hybrid Connection using a Service Bus relay.
Creates a new Hybrid Connection using a Service Bus relay.
update_hybrid_connection_slot(resource_group_name: str, name: str, namespace_name: str, relay_name: str, slot: str, connection_envelope: _models.HybridConnection, *, content_type: str = 'application/json', **kwargs: Any) -> _models.HybridConnection
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
The name of the web app. Required. |
namespace_name
Required
|
The namespace for this hybrid connection. Required. |
relay_name
Required
|
The relay name for this hybrid connection. Required. |
slot
Required
|
The name of the slot for the web app. Required. |
connection_envelope
Required
|
The details of the hybrid connection. Is either a HybridConnection type or a IO[bytes] type. Required. |
Returns
Type | Description |
---|---|
HybridConnection or the result of cls(response) |
Exceptions
Type | Description |
---|---|
update_metadata
Replaces the metadata of an app.
Replaces the metadata of an app.
update_metadata(resource_group_name: str, name: str, metadata: _models.StringDictionary, *, content_type: str = 'application/json', **kwargs: Any) -> _models.StringDictionary
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
metadata
Required
|
Edited metadata of the app or deployment slot. See example. Is either a StringDictionary type or a IO[bytes] type. Required. |
Returns
Type | Description |
---|---|
StringDictionary or the result of cls(response) |
Exceptions
Type | Description |
---|---|
update_metadata_slot
Replaces the metadata of an app.
Replaces the metadata of an app.
update_metadata_slot(resource_group_name: str, name: str, slot: str, metadata: _models.StringDictionary, *, content_type: str = 'application/json', **kwargs: Any) -> _models.StringDictionary
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
slot
Required
|
Name of the deployment slot. If a slot is not specified, the API will update the metadata for the production slot. Required. |
metadata
Required
|
Edited metadata of the app or deployment slot. See example. Is either a StringDictionary type or a IO[bytes] type. Required. |
Returns
Type | Description |
---|---|
StringDictionary or the result of cls(response) |
Exceptions
Type | Description |
---|---|
update_premier_add_on
Updates a named add-on of an app.
Updates a named add-on of an app.
update_premier_add_on(resource_group_name: str, name: str, premier_add_on_name: str, premier_add_on: _models.PremierAddOnPatchResource, *, content_type: str = 'application/json', **kwargs: Any) -> _models.PremierAddOn
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
premier_add_on_name
Required
|
Add-on name. Required. |
premier_add_on
Required
|
A JSON representation of the edited premier add-on. Is either a PremierAddOnPatchResource type or a IO[bytes] type. Required. |
Returns
Type | Description |
---|---|
PremierAddOn or the result of cls(response) |
Exceptions
Type | Description |
---|---|
update_premier_add_on_slot
Updates a named add-on of an app.
Updates a named add-on of an app.
update_premier_add_on_slot(resource_group_name: str, name: str, premier_add_on_name: str, slot: str, premier_add_on: _models.PremierAddOnPatchResource, *, content_type: str = 'application/json', **kwargs: Any) -> _models.PremierAddOn
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
premier_add_on_name
Required
|
Add-on name. Required. |
slot
Required
|
Name of the deployment slot. If a slot is not specified, the API will update the named add-on for the production slot. Required. |
premier_add_on
Required
|
A JSON representation of the edited premier add-on. Is either a PremierAddOnPatchResource type or a IO[bytes] type. Required. |
Returns
Type | Description |
---|---|
PremierAddOn or the result of cls(response) |
Exceptions
Type | Description |
---|---|
update_relay_service_connection
Creates a new hybrid connection configuration (PUT), or updates an existing one (PATCH).
Creates a new hybrid connection configuration (PUT), or updates an existing one (PATCH).
update_relay_service_connection(resource_group_name: str, name: str, entity_name: str, connection_envelope: _models.RelayServiceConnectionEntity, *, content_type: str = 'application/json', **kwargs: Any) -> _models.RelayServiceConnectionEntity
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
entity_name
Required
|
Name of the hybrid connection configuration. Required. |
connection_envelope
Required
|
Details of the hybrid connection configuration. Is either a RelayServiceConnectionEntity type or a IO[bytes] type. Required. |
Returns
Type | Description |
---|---|
RelayServiceConnectionEntity or the result of cls(response) |
Exceptions
Type | Description |
---|---|
update_relay_service_connection_slot
Creates a new hybrid connection configuration (PUT), or updates an existing one (PATCH).
Creates a new hybrid connection configuration (PUT), or updates an existing one (PATCH).
update_relay_service_connection_slot(resource_group_name: str, name: str, entity_name: str, slot: str, connection_envelope: _models.RelayServiceConnectionEntity, *, content_type: str = 'application/json', **kwargs: Any) -> _models.RelayServiceConnectionEntity
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
entity_name
Required
|
Name of the hybrid connection configuration. Required. |
slot
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. Required. |
connection_envelope
Required
|
Details of the hybrid connection configuration. Is either a RelayServiceConnectionEntity type or a IO[bytes] type. Required. |
Returns
Type | Description |
---|---|
RelayServiceConnectionEntity or the result of cls(response) |
Exceptions
Type | Description |
---|---|
update_scm_allowed
Updates whether user publishing credentials are allowed on the site or not.
Updates whether user publishing credentials are allowed on the site or not.
update_scm_allowed(resource_group_name: str, name: str, csm_publishing_access_policies_entity: _models.CsmPublishingCredentialsPoliciesEntity, *, content_type: str = 'application/json', **kwargs: Any) -> _models.CsmPublishingCredentialsPoliciesEntity
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
csm_publishing_access_policies_entity
Required
|
Is either a CsmPublishingCredentialsPoliciesEntity type or a IO[bytes] type. Required. |
Returns
Type | Description |
---|---|
CsmPublishingCredentialsPoliciesEntity or the result of cls(response) |
Exceptions
Type | Description |
---|---|
update_scm_allowed_slot
Updates whether user publishing credentials are allowed on the site or not.
Updates whether user publishing credentials are allowed on the site or not.
update_scm_allowed_slot(resource_group_name: str, name: str, slot: str, csm_publishing_access_policies_entity: _models.CsmPublishingCredentialsPoliciesEntity, *, content_type: str = 'application/json', **kwargs: Any) -> _models.CsmPublishingCredentialsPoliciesEntity
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
slot
Required
|
Required. |
csm_publishing_access_policies_entity
Required
|
Is either a CsmPublishingCredentialsPoliciesEntity type or a IO[bytes] type. Required. |
Returns
Type | Description |
---|---|
CsmPublishingCredentialsPoliciesEntity or the result of cls(response) |
Exceptions
Type | Description |
---|---|
update_site_push_settings
Updates the Push settings associated with web app.
Updates the Push settings associated with web app.
update_site_push_settings(resource_group_name: str, name: str, push_settings: _models.PushSettings, *, content_type: str = 'application/json', **kwargs: Any) -> _models.PushSettings
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of web app. Required. |
push_settings
Required
|
Push settings associated with web app. Is either a PushSettings type or a IO[bytes] type. Required. |
Returns
Type | Description |
---|---|
PushSettings or the result of cls(response) |
Exceptions
Type | Description |
---|---|
update_site_push_settings_slot
Updates the Push settings associated with web app.
Updates the Push settings associated with web app.
update_site_push_settings_slot(resource_group_name: str, name: str, slot: str, push_settings: _models.PushSettings, *, content_type: str = 'application/json', **kwargs: Any) -> _models.PushSettings
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of web app. Required. |
slot
Required
|
Name of web app slot. If not specified then will default to production slot. Required. |
push_settings
Required
|
Push settings associated with web app. Is either a PushSettings type or a IO[bytes] type. Required. |
Returns
Type | Description |
---|---|
PushSettings or the result of cls(response) |
Exceptions
Type | Description |
---|---|
update_slot
Creates a new web, mobile, or API app in an existing resource group, or updates an existing app.
Creates a new web, mobile, or API app in an existing resource group, or updates an existing app.
update_slot(resource_group_name: str, name: str, slot: str, site_envelope: _models.SitePatchResource, *, content_type: str = 'application/json', **kwargs: Any) -> _models.Site
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Unique name of the app to create or update. To create or update a deployment slot, use the {slot} parameter. Required. |
slot
Required
|
Name of the deployment slot to create or update. The name 'production' is reserved. Required. |
site_envelope
Required
|
A JSON representation of the app properties. See example. Is either a SitePatchResource type or a IO[bytes] type. Required. |
Returns
Type | Description |
---|---|
Site or the result of cls(response) |
Exceptions
Type | Description |
---|---|
update_slot_configuration_names
Updates the names of application settings and connection string that remain with the slot during swap operation.
Updates the names of application settings and connection string that remain with the slot during swap operation.
update_slot_configuration_names(resource_group_name: str, name: str, slot_config_names: _models.SlotConfigNamesResource, *, content_type: str = 'application/json', **kwargs: Any) -> _models.SlotConfigNamesResource
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
slot_config_names
Required
|
Names of application settings and connection strings. See example. Is either a SlotConfigNamesResource type or a IO[bytes] type. Required. |
Returns
Type | Description |
---|---|
SlotConfigNamesResource or the result of cls(response) |
Exceptions
Type | Description |
---|---|
update_source_control
Updates the source control configuration of an app.
Updates the source control configuration of an app.
update_source_control(resource_group_name: str, name: str, site_source_control: _models.SiteSourceControl, *, content_type: str = 'application/json', **kwargs: Any) -> _models.SiteSourceControl
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
site_source_control
Required
|
JSON representation of a SiteSourceControl object. See example. Is either a SiteSourceControl type or a IO[bytes] type. Required. |
Returns
Type | Description |
---|---|
SiteSourceControl or the result of cls(response) |
Exceptions
Type | Description |
---|---|
update_source_control_slot
Updates the source control configuration of an app.
Updates the source control configuration of an app.
update_source_control_slot(resource_group_name: str, name: str, slot: str, site_source_control: _models.SiteSourceControl, *, content_type: str = 'application/json', **kwargs: Any) -> _models.SiteSourceControl
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
slot
Required
|
Name of the deployment slot. If a slot is not specified, the API will update the source control configuration for the production slot. Required. |
site_source_control
Required
|
JSON representation of a SiteSourceControl object. See example. Is either a SiteSourceControl type or a IO[bytes] type. Required. |
Returns
Type | Description |
---|---|
SiteSourceControl or the result of cls(response) |
Exceptions
Type | Description |
---|---|
update_vnet_connection
Adds a Virtual Network connection to an app or slot (PUT) or updates the connection properties (PATCH).
Adds a Virtual Network connection to an app or slot (PUT) or updates the connection properties (PATCH).
update_vnet_connection(resource_group_name: str, name: str, vnet_name: str, connection_envelope: _models.VnetInfo, *, content_type: str = 'application/json', **kwargs: Any) -> _models.VnetInfo
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
vnet_name
Required
|
Name of an existing Virtual Network. Required. |
connection_envelope
Required
|
Properties of the Virtual Network connection. See example. Is either a VnetInfo type or a IO[bytes] type. Required. |
Returns
Type | Description |
---|---|
VnetInfo or the result of cls(response) |
Exceptions
Type | Description |
---|---|
update_vnet_connection_gateway
Adds a gateway to a connected Virtual Network (PUT) or updates it (PATCH).
Adds a gateway to a connected Virtual Network (PUT) or updates it (PATCH).
update_vnet_connection_gateway(resource_group_name: str, name: str, vnet_name: str, gateway_name: str, connection_envelope: _models.VnetGateway, *, content_type: str = 'application/json', **kwargs: Any) -> _models.VnetGateway
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
vnet_name
Required
|
Name of the Virtual Network. Required. |
gateway_name
Required
|
Name of the gateway. Currently, the only supported string is "primary". Required. |
connection_envelope
Required
|
The properties to update this gateway with. Is either a VnetGateway type or a IO[bytes] type. Required. |
Returns
Type | Description |
---|---|
VnetGateway or the result of cls(response) |
Exceptions
Type | Description |
---|---|
update_vnet_connection_gateway_slot
Adds a gateway to a connected Virtual Network (PUT) or updates it (PATCH).
Adds a gateway to a connected Virtual Network (PUT) or updates it (PATCH).
update_vnet_connection_gateway_slot(resource_group_name: str, name: str, vnet_name: str, gateway_name: str, slot: str, connection_envelope: _models.VnetGateway, *, content_type: str = 'application/json', **kwargs: Any) -> _models.VnetGateway
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
vnet_name
Required
|
Name of the Virtual Network. Required. |
gateway_name
Required
|
Name of the gateway. Currently, the only supported string is "primary". Required. |
slot
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. Required. |
connection_envelope
Required
|
The properties to update this gateway with. Is either a VnetGateway type or a IO[bytes] type. Required. |
Returns
Type | Description |
---|---|
VnetGateway or the result of cls(response) |
Exceptions
Type | Description |
---|---|
update_vnet_connection_slot
Adds a Virtual Network connection to an app or slot (PUT) or updates the connection properties (PATCH).
Adds a Virtual Network connection to an app or slot (PUT) or updates the connection properties (PATCH).
update_vnet_connection_slot(resource_group_name: str, name: str, vnet_name: str, slot: str, connection_envelope: _models.VnetInfo, *, content_type: str = 'application/json', **kwargs: Any) -> _models.VnetInfo
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
name
Required
|
Name of the app. Required. |
vnet_name
Required
|
Name of an existing Virtual Network. Required. |
slot
Required
|
Name of the deployment slot. If a slot is not specified, the API will add or update connections for the production slot. Required. |
connection_envelope
Required
|
Properties of the Virtual Network connection. See example. Is either a VnetInfo type or a IO[bytes] type. Required. |
Returns
Type | Description |
---|---|
VnetInfo or the result of cls(response) |
Exceptions
Type | Description |
---|---|
Attributes
models
models = <module 'azure.mgmt.web.v2021_01_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\web\\v2021_01_01\\models\\__init__.py'>
Azure SDK for Python