azure.mgmt.web.v2016_08_01.operations module

class azure.mgmt.web.v2016_08_01.operations.WebAppsOperations(client, config, serializer, deserializer)

Bases: object

WebAppsOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

Variables

api_version – API Version. Constant value: “2016-08-01”.

add_premier_add_on(resource_group_name, name, premier_add_on_name, premier_add_on, custom_headers=None, raw=False, **operation_config)

Updates a named add-on of an app.

Updates a named add-on of an app.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• premier_add_on_name (str) – Add-on name.

• premier_add_on (PremierAddOn) – A JSON representation of the edited premier add-on.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

PremierAddOn or ClientRawResponse if raw=true

Return type

PremierAddOn or ClientRawResponse

Raises

CloudError

add_premier_add_on_slot(resource_group_name, name, premier_add_on_name, premier_add_on, slot, custom_headers=None, raw=False, **operation_config)

Updates a named add-on of an app.

Updates a named add-on of an app.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• premier_add_on_name (str) – Add-on name.

• premier_add_on (PremierAddOn) – A JSON representation of the edited premier add-on.

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

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

PremierAddOn or ClientRawResponse if raw=true

Return type

PremierAddOn or ClientRawResponse

Raises

CloudError

analyze_custom_hostname(resource_group_name, name, host_name=None, custom_headers=None, raw=False, **operation_config)

Analyze a custom hostname.

Analyze a custom hostname.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of web app.

• host_name (str) – Custom hostname.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

CustomHostnameAnalysisResult or ClientRawResponse if raw=true

Return type

CustomHostnameAnalysisResult or ClientRawResponse

Raises

CloudError

analyze_custom_hostname_slot(resource_group_name, name, slot, host_name=None, custom_headers=None, raw=False, **operation_config)

Analyze a custom hostname.

Analyze a custom hostname.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of web app.

• slot (str) – Name of web app slot. If not specified then will default to production slot.

• host_name (str) – Custom hostname.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

CustomHostnameAnalysisResult or ClientRawResponse if raw=true

Return type

CustomHostnameAnalysisResult or ClientRawResponse

Raises

CloudError

apply_slot_config_to_production(resource_group_name, name, target_slot, preserve_vnet, custom_headers=None, raw=False, **operation_config)

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

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

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• target_slot (str) – Destination deployment slot during swap operation.

• preserve_vnet (bool) – <code>true</code> to preserve Virtual Network to the slot during swap; otherwise, <code>false</code>.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

apply_slot_configuration_slot(resource_group_name, name, slot, target_slot, preserve_vnet, custom_headers=None, raw=False, **operation_config)

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

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

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• slot (str) – Name of the source slot. If a slot is not specified, the production slot is used as the source slot.

• target_slot (str) – Destination deployment slot during swap operation.

• preserve_vnet (bool) – <code>true</code> to preserve Virtual Network to the slot during swap; otherwise, <code>false</code>.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

backup(resource_group_name, name, request, custom_headers=None, raw=False, **operation_config)

Creates a backup of an app.

Creates a backup of an app.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• request (BackupRequest) – Backup configuration. You can use the JSON response from the POST action as input here.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

BackupItem or ClientRawResponse if raw=true

Return type

BackupItem or ClientRawResponse

Raises

CloudError

backup_slot(resource_group_name, name, request, slot, custom_headers=None, raw=False, **operation_config)

Creates a backup of an app.

Creates a backup of an app.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• request (BackupRequest) – Backup configuration. You can use the JSON response from the POST action as input here.

• slot (str) – Name of the deployment slot. If a slot is not specified, the API will create a backup for the production slot.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

BackupItem or ClientRawResponse if raw=true

Return type

BackupItem or ClientRawResponse

Raises

CloudError

create_deployment(resource_group_name, name, id, deployment, custom_headers=None, raw=False, **operation_config)

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

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

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• id (str) – ID of an existing deployment.

• deployment (Deployment) – Deployment details.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

Deployment or ClientRawResponse if raw=true

Return type

Deployment or ClientRawResponse

Raises

CloudError

create_deployment_slot(resource_group_name, name, id, slot, deployment, custom_headers=None, raw=False, **operation_config)

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

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

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• id (str) – ID of an existing deployment.

• slot (str) – Name of the deployment slot. If a slot is not specified, the API creates a deployment for the production slot.

• deployment (Deployment) – Deployment details.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

Deployment or ClientRawResponse if raw=true

Return type

Deployment or ClientRawResponse

Raises

CloudError

create_function(resource_group_name, name, function_name, function_envelope, custom_headers=None, raw=False, polling=True, **operation_config)

Create function for web site, or a deployment slot.

Create function for web site, or a deployment slot.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Site name.

• function_name (str) – Function name.

• function_envelope (FunctionEnvelope) – Function details.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

• polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns FunctionEnvelope or ClientRawResponse<FunctionEnvelope> if raw==True

Return type

AzureOperationPoller[FunctionEnvelope] or AzureOperationPoller[ClientRawResponse[FunctionEnvelope]]

Raises

CloudError

create_instance_function_slot(resource_group_name, name, function_name, slot, function_envelope, custom_headers=None, raw=False, polling=True, **operation_config)

Create function for web site, or a deployment slot.

Create function for web site, or a deployment slot.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Site name.

• function_name (str) – Function name.

• slot (str) – Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.

• function_envelope (FunctionEnvelope) – Function details.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

• polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns FunctionEnvelope or ClientRawResponse<FunctionEnvelope> if raw==True

Return type

AzureOperationPoller[FunctionEnvelope] or AzureOperationPoller[ClientRawResponse[FunctionEnvelope]]

Raises

CloudError

create_instance_ms_deploy_operation(resource_group_name, name, instance_id, ms_deploy, custom_headers=None, raw=False, polling=True, **operation_config)

Invoke the MSDeploy web app extension.

Invoke the MSDeploy web app extension.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of web app.

• instance_id (str) – ID of web app instance.

• ms_deploy (MSDeploy) – Details of MSDeploy operation

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

• polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns MSDeployStatus or ClientRawResponse<MSDeployStatus> if raw==True

Return type

AzureOperationPoller[MSDeployStatus] or AzureOperationPoller[ClientRawResponse[MSDeployStatus]]

Raises

CloudError

create_instance_ms_deploy_operation_slot(resource_group_name, name, slot, instance_id, ms_deploy, custom_headers=None, raw=False, polling=True, **operation_config)

Invoke the MSDeploy web app extension.

Invoke the MSDeploy web app extension.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of web app.

• slot (str) – Name of web app slot. If not specified then will default to production slot.

• instance_id (str) – ID of web app instance.

• ms_deploy (MSDeploy) – Details of MSDeploy operation

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

• polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns MSDeployStatus or ClientRawResponse<MSDeployStatus> if raw==True

Return type

AzureOperationPoller[MSDeployStatus] or AzureOperationPoller[ClientRawResponse[MSDeployStatus]]

Raises

CloudError

create_ms_deploy_operation(resource_group_name, name, ms_deploy, custom_headers=None, raw=False, polling=True, **operation_config)

Invoke the MSDeploy web app extension.

Invoke the MSDeploy web app extension.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of web app.

• ms_deploy (MSDeploy) – Details of MSDeploy operation

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

• polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns MSDeployStatus or ClientRawResponse<MSDeployStatus> if raw==True

Return type

AzureOperationPoller[MSDeployStatus] or AzureOperationPoller[ClientRawResponse[MSDeployStatus]]

Raises

CloudError

create_ms_deploy_operation_slot(resource_group_name, name, slot, ms_deploy, custom_headers=None, raw=False, polling=True, **operation_config)

Invoke the MSDeploy web app extension.

Invoke the MSDeploy web app extension.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of web app.

• slot (str) – Name of web app slot. If not specified then will default to production slot.

• ms_deploy (MSDeploy) – Details of MSDeploy operation

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

• polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns MSDeployStatus or ClientRawResponse<MSDeployStatus> if raw==True

Return type

AzureOperationPoller[MSDeployStatus] or AzureOperationPoller[ClientRawResponse[MSDeployStatus]]

Raises

CloudError

create_or_update(resource_group_name, name, site_envelope, custom_headers=None, raw=False, polling=True, **operation_config)

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.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Unique name of the app to create or update. To create or update a deployment slot, use the {slot} parameter.

• site_envelope (Site) – A JSON representation of the app properties. See example.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

• polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns Site or ClientRawResponse<Site> if raw==True

Return type

AzureOperationPoller[Site] or AzureOperationPoller[ClientRawResponse[Site]]

Raises

CloudError

create_or_update_configuration(resource_group_name, name, site_config, custom_headers=None, raw=False, **operation_config)

Updates the configuration of an app.

Updates the configuration of an app.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• site_config (SiteConfigResource) – JSON representation of a SiteConfig object. See example.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

SiteConfigResource or ClientRawResponse if raw=true

Return type

SiteConfigResource or ClientRawResponse

Raises

CloudError

create_or_update_configuration_slot(resource_group_name, name, site_config, slot, custom_headers=None, raw=False, **operation_config)

Updates the configuration of an app.

Updates the configuration of an app.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• site_config (SiteConfigResource) – JSON representation of a SiteConfig object. See example.

• slot (str) – Name of the deployment slot. If a slot is not specified, the API will update configuration for the production slot.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

SiteConfigResource or ClientRawResponse if raw=true

Return type

SiteConfigResource or ClientRawResponse

Raises

CloudError

create_or_update_domain_ownership_identifier(resource_group_name, name, domain_ownership_identifier_name, kind=None, identifier_id=None, custom_headers=None, raw=False, **operation_config)

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.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• domain_ownership_identifier_name (str) – Name of domain ownership identifier.

• kind (str) – Kind of resource.

• identifier_id (str) – String representation of the identity.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

Identifier or ClientRawResponse if raw=true

Return type

Identifier or ClientRawResponse

Raises

CloudError

create_or_update_domain_ownership_identifier_slot(resource_group_name, name, domain_ownership_identifier_name, slot, kind=None, identifier_id=None, custom_headers=None, raw=False, **operation_config)

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.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• domain_ownership_identifier_name (str) – Name of domain ownership identifier.

• slot (str) – Name of the deployment slot. If a slot is not specified, the API will delete the binding for the production slot.

• kind (str) – Kind of resource.

• identifier_id (str) – String representation of the identity.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

Identifier or ClientRawResponse if raw=true

Return type

Identifier or ClientRawResponse

Raises

CloudError

create_or_update_host_name_binding(resource_group_name, name, host_name, host_name_binding, custom_headers=None, raw=False, **operation_config)

Creates a hostname binding for an app.

Creates a hostname binding for an app.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• host_name (str) – Hostname in the hostname binding.

• host_name_binding (HostNameBinding) – Binding details. This is the JSON representation of a HostNameBinding object.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

HostNameBinding or ClientRawResponse if raw=true

Return type

HostNameBinding or ClientRawResponse

Raises

CloudError

create_or_update_host_name_binding_slot(resource_group_name, name, host_name, host_name_binding, slot, custom_headers=None, raw=False, **operation_config)

Creates a hostname binding for an app.

Creates a hostname binding for an app.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• host_name (str) – Hostname in the hostname binding.

• host_name_binding (HostNameBinding) – Binding details. This is the JSON representation of a HostNameBinding object.

• slot (str) – Name of the deployment slot. If a slot is not specified, the API will create a binding for the production slot.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

HostNameBinding or ClientRawResponse if raw=true

Return type

HostNameBinding or ClientRawResponse

Raises

CloudError

create_or_update_hybrid_connection(resource_group_name, name, namespace_name, relay_name, connection_envelope, custom_headers=None, raw=False, **operation_config)

Creates a new Hybrid Connection using a Service Bus relay.

Creates a new Hybrid Connection using a Service Bus relay.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – The name of the web app.

• namespace_name (str) – The namespace for this hybrid connection.

• relay_name (str) – The relay name for this hybrid connection.

• connection_envelope (HybridConnection) – The details of the hybrid connection.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

HybridConnection or ClientRawResponse if raw=true

Return type

HybridConnection or ClientRawResponse

Raises

CloudError

create_or_update_hybrid_connection_slot(resource_group_name, name, namespace_name, relay_name, connection_envelope, slot, custom_headers=None, raw=False, **operation_config)

Creates a new Hybrid Connection using a Service Bus relay.

Creates a new Hybrid Connection using a Service Bus relay.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – The name of the web app.

• namespace_name (str) – The namespace for this hybrid connection.

• relay_name (str) – The relay name for this hybrid connection.

• connection_envelope (HybridConnection) – The details of the hybrid connection.

• slot (str) – The name of the slot for the web app.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

HybridConnection or ClientRawResponse if raw=true

Return type

HybridConnection or ClientRawResponse

Raises

CloudError

create_or_update_public_certificate(resource_group_name, name, public_certificate_name, public_certificate, custom_headers=None, raw=False, **operation_config)

Creates a hostname binding for an app.

Creates a hostname binding for an app.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• public_certificate_name (str) – Public certificate name.

• public_certificate (PublicCertificate) – Public certificate details. This is the JSON representation of a PublicCertificate object.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

PublicCertificate or ClientRawResponse if raw=true

Return type

PublicCertificate or ClientRawResponse

Raises

CloudError

create_or_update_public_certificate_slot(resource_group_name, name, public_certificate_name, public_certificate, slot, custom_headers=None, raw=False, **operation_config)

Creates a hostname binding for an app.

Creates a hostname binding for an app.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• public_certificate_name (str) – Public certificate name.

• public_certificate (PublicCertificate) – Public certificate details. This is the JSON representation of a PublicCertificate object.

• slot (str) – Name of the deployment slot. If a slot is not specified, the API will create a binding for the production slot.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

PublicCertificate or ClientRawResponse if raw=true

Return type

PublicCertificate or ClientRawResponse

Raises

CloudError

create_or_update_relay_service_connection(resource_group_name, name, entity_name, connection_envelope, custom_headers=None, raw=False, **operation_config)

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

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• entity_name (str) – Name of the hybrid connection configuration.

• connection_envelope (RelayServiceConnectionEntity) – Details of the hybrid connection configuration.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

RelayServiceConnectionEntity or ClientRawResponse if raw=true

Return type

RelayServiceConnectionEntity or ClientRawResponse

Raises

CloudError

create_or_update_relay_service_connection_slot(resource_group_name, name, entity_name, connection_envelope, slot, custom_headers=None, raw=False, **operation_config)

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

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• entity_name (str) – Name of the hybrid connection configuration.

• connection_envelope (RelayServiceConnectionEntity) – Details of the hybrid connection configuration.

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

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

RelayServiceConnectionEntity or ClientRawResponse if raw=true

Return type

RelayServiceConnectionEntity or ClientRawResponse

Raises

CloudError

create_or_update_slot(resource_group_name, name, site_envelope, slot, skip_dns_registration=None, skip_custom_domain_verification=None, force_dns_registration=None, ttl_in_seconds=None, custom_headers=None, raw=False, polling=True, **operation_config)

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.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Unique name of the app to create or update. To create or update a deployment slot, use the {slot} parameter.

• site_envelope (Site) – A JSON representation of the app properties. See example.

• slot (str) – Name of the deployment slot to create or update. By default, this API attempts to create or modify the production slot.

• skip_dns_registration (bool) – If true web app hostname is not registered with DNS on creation. This parameter is only used for app creation.

• skip_custom_domain_verification (bool) – If true, custom (non *.azurewebsites.net) domains associated with web app are not verified.

• force_dns_registration (bool) – If true, web app hostname is force registered with DNS.

• ttl_in_seconds (str) – Time to live in seconds for web app’s default domain name.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

• polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns Site or ClientRawResponse<Site> if raw==True

Return type

AzureOperationPoller[Site] or AzureOperationPoller[ClientRawResponse[Site]]

Raises

CloudError

create_or_update_source_control(resource_group_name, name, site_source_control, custom_headers=None, raw=False, polling=True, **operation_config)

Updates the source control configuration of an app.

Updates the source control configuration of an app.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• site_source_control (SiteSourceControl) – JSON representation of a SiteSourceControl object. See example.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

• polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns SiteSourceControl or ClientRawResponse<SiteSourceControl> if raw==True

Return type

AzureOperationPoller[SiteSourceControl] or AzureOperationPoller[ClientRawResponse[SiteSourceControl]]

Raises

CloudError

create_or_update_source_control_slot(resource_group_name, name, site_source_control, slot, custom_headers=None, raw=False, polling=True, **operation_config)

Updates the source control configuration of an app.

Updates the source control configuration of an app.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• site_source_control (SiteSourceControl) – JSON representation of a SiteSourceControl object. See example.

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

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

• polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns SiteSourceControl or ClientRawResponse<SiteSourceControl> if raw==True

Return type

AzureOperationPoller[SiteSourceControl] or AzureOperationPoller[ClientRawResponse[SiteSourceControl]]

Raises

CloudError

create_or_update_vnet_connection(resource_group_name, name, vnet_name, connection_envelope, custom_headers=None, raw=False, **operation_config)

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

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• vnet_name (str) – Name of an existing Virtual Network.

• connection_envelope (VnetInfo) – Properties of the Virtual Network connection. See example.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

VnetInfo or ClientRawResponse if raw=true

Return type

VnetInfo or ClientRawResponse

Raises

CloudError

create_or_update_vnet_connection_gateway(resource_group_name, name, vnet_name, gateway_name, connection_envelope, custom_headers=None, raw=False, **operation_config)

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

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• vnet_name (str) – Name of the Virtual Network.

• gateway_name (str) – Name of the gateway. Currently, the only supported string is “primary”.

• connection_envelope (VnetGateway) – The properties to update this gateway with.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

VnetGateway or ClientRawResponse if raw=true

Return type

VnetGateway or ClientRawResponse

Raises

CloudError

create_or_update_vnet_connection_gateway_slot(resource_group_name, name, vnet_name, gateway_name, connection_envelope, slot, custom_headers=None, raw=False, **operation_config)

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

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• vnet_name (str) – Name of the Virtual Network.

• gateway_name (str) – Name of the gateway. Currently, the only supported string is “primary”.

• connection_envelope (VnetGateway) – The properties to update this gateway with.

• slot (str) – 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.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

VnetGateway or ClientRawResponse if raw=true

Return type

VnetGateway or ClientRawResponse

Raises

CloudError

create_or_update_vnet_connection_slot(resource_group_name, name, vnet_name, connection_envelope, slot, custom_headers=None, raw=False, **operation_config)

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

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• vnet_name (str) – Name of an existing Virtual Network.

• connection_envelope (VnetInfo) – Properties of the Virtual Network connection. See example.

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

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

VnetInfo or ClientRawResponse if raw=true

Return type

VnetInfo or ClientRawResponse

Raises

CloudError

delete(resource_group_name, name, delete_metrics=None, delete_empty_server_farm=None, custom_headers=None, raw=False, **operation_config)

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.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app to delete.

• delete_metrics (bool) – If true, web app metrics are also deleted.

• delete_empty_server_farm (bool) – Specify false if you want to keep empty App Service plan. By default, empty App Service plan is deleted.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

delete_backup(resource_group_name, name, backup_id, custom_headers=None, raw=False, **operation_config)

Deletes a backup of an app by its ID.

Deletes a backup of an app by its ID.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• backup_id (str) – ID of the backup.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

delete_backup_configuration(resource_group_name, name, custom_headers=None, raw=False, **operation_config)

Deletes the backup configuration of an app.

Deletes the backup configuration of an app.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

delete_backup_configuration_slot(resource_group_name, name, slot, custom_headers=None, raw=False, **operation_config)

Deletes the backup configuration of an app.

Deletes the backup configuration of an app.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• slot (str) – Name of the deployment slot. If a slot is not specified, the API will delete the backup configuration for the production slot.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

delete_backup_slot(resource_group_name, name, backup_id, slot, custom_headers=None, raw=False, **operation_config)

Deletes a backup of an app by its ID.

Deletes a backup of an app by its ID.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• backup_id (str) – ID of the backup.

• slot (str) – Name of the deployment slot. If a slot is not specified, the API will delete a backup of the production slot.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

delete_continuous_web_job(resource_group_name, name, web_job_name, custom_headers=None, raw=False, **operation_config)

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.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Site name.

• web_job_name (str) – Name of Web Job.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

delete_continuous_web_job_slot(resource_group_name, name, web_job_name, slot, custom_headers=None, raw=False, **operation_config)

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.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Site name.

• web_job_name (str) – Name of Web Job.

• slot (str) – Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

delete_deployment(resource_group_name, name, id, custom_headers=None, raw=False, **operation_config)

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.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• id (str) – Deployment ID.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

delete_deployment_slot(resource_group_name, name, id, slot, custom_headers=None, raw=False, **operation_config)

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.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• id (str) – Deployment ID.

• slot (str) – Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

delete_domain_ownership_identifier(resource_group_name, name, domain_ownership_identifier_name, custom_headers=None, raw=False, **operation_config)

Deletes a domain ownership identifier for a web app.

Deletes a domain ownership identifier for a web app.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• domain_ownership_identifier_name (str) – Name of domain ownership identifier.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

delete_domain_ownership_identifier_slot(resource_group_name, name, domain_ownership_identifier_name, slot, custom_headers=None, raw=False, **operation_config)

Deletes a domain ownership identifier for a web app.

Deletes a domain ownership identifier for a web app.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• domain_ownership_identifier_name (str) – Name of domain ownership identifier.

• slot (str) – Name of the deployment slot. If a slot is not specified, the API will delete the binding for the production slot.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

delete_function(resource_group_name, name, function_name, custom_headers=None, raw=False, **operation_config)

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

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

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Site name.

• function_name (str) – Function name.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

delete_host_name_binding(resource_group_name, name, host_name, custom_headers=None, raw=False, **operation_config)

Deletes a hostname binding for an app.

Deletes a hostname binding for an app.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• host_name (str) – Hostname in the hostname binding.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

delete_host_name_binding_slot(resource_group_name, name, slot, host_name, custom_headers=None, raw=False, **operation_config)

Deletes a hostname binding for an app.

Deletes a hostname binding for an app.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• slot (str) – Name of the deployment slot. If a slot is not specified, the API will delete the binding for the production slot.

• host_name (str) – Hostname in the hostname binding.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

delete_hybrid_connection(resource_group_name, name, namespace_name, relay_name, custom_headers=None, raw=False, **operation_config)

Removes a Hybrid Connection from this site.

Removes a Hybrid Connection from this site.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – The name of the web app.

• namespace_name (str) – The namespace for this hybrid connection.

• relay_name (str) – The relay name for this hybrid connection.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

delete_hybrid_connection_slot(resource_group_name, name, namespace_name, relay_name, slot, custom_headers=None, raw=False, **operation_config)

Removes a Hybrid Connection from this site.

Removes a Hybrid Connection from this site.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – The name of the web app.

• namespace_name (str) – The namespace for this hybrid connection.

• relay_name (str) – The relay name for this hybrid connection.

• slot (str) – The name of the slot for the web app.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

delete_instance_function_slot(resource_group_name, name, function_name, slot, custom_headers=None, raw=False, **operation_config)

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

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

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Site name.

• function_name (str) – Function name.

• slot (str) – Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

delete_instance_process(resource_group_name, name, process_id, instance_id, custom_headers=None, raw=False, **operation_config)

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.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Site name.

• process_id (str) – PID.

• instance_id (str) – 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”.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

delete_instance_process_slot(resource_group_name, name, process_id, slot, instance_id, custom_headers=None, raw=False, **operation_config)

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.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Site name.

• process_id (str) – PID.

• slot (str) – Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.

• instance_id (str) – 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”.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

delete_premier_add_on(resource_group_name, name, premier_add_on_name, custom_headers=None, raw=False, **operation_config)

Delete a premier add-on from an app.

Delete a premier add-on from an app.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• premier_add_on_name (str) – Add-on name.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

delete_premier_add_on_slot(resource_group_name, name, premier_add_on_name, slot, custom_headers=None, raw=False, **operation_config)

Delete a premier add-on from an app.

Delete a premier add-on from an app.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• premier_add_on_name (str) – Add-on name.

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

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

delete_process(resource_group_name, name, process_id, custom_headers=None, raw=False, **operation_config)

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.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Site name.

• process_id (str) – PID.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

delete_process_slot(resource_group_name, name, process_id, slot, custom_headers=None, raw=False, **operation_config)

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.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Site name.

• process_id (str) – PID.

• slot (str) – Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

delete_public_certificate(resource_group_name, name, public_certificate_name, custom_headers=None, raw=False, **operation_config)

Deletes a hostname binding for an app.

Deletes a hostname binding for an app.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• public_certificate_name (str) – Public certificate name.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

delete_public_certificate_slot(resource_group_name, name, slot, public_certificate_name, custom_headers=None, raw=False, **operation_config)

Deletes a hostname binding for an app.

Deletes a hostname binding for an app.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• slot (str) – Name of the deployment slot. If a slot is not specified, the API will delete the binding for the production slot.

• public_certificate_name (str) – Public certificate name.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

delete_relay_service_connection(resource_group_name, name, entity_name, custom_headers=None, raw=False, **operation_config)

Deletes a relay service connection by its name.

Deletes a relay service connection by its name.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• entity_name (str) – Name of the hybrid connection configuration.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

delete_relay_service_connection_slot(resource_group_name, name, entity_name, slot, custom_headers=None, raw=False, **operation_config)

Deletes a relay service connection by its name.

Deletes a relay service connection by its name.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• entity_name (str) – Name of the hybrid connection configuration.

• slot (str) – Name of the deployment slot. If a slot is not specified, the API will delete a hybrid connection for the production slot.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

delete_site_extension(resource_group_name, name, site_extension_id, custom_headers=None, raw=False, **operation_config)

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

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

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Site name.

• site_extension_id (str) – Site extension name.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

delete_site_extension_slot(resource_group_name, name, site_extension_id, slot, custom_headers=None, raw=False, **operation_config)

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

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

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Site name.

• site_extension_id (str) – Site extension name.

• slot (str) – Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

delete_slot(resource_group_name, name, slot, delete_metrics=None, delete_empty_server_farm=None, skip_dns_registration=None, custom_headers=None, raw=False, **operation_config)

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.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app to delete.

• slot (str) – Name of the deployment slot to delete. By default, the API deletes the production slot.

• delete_metrics (bool) – If true, web app metrics are also deleted.

• delete_empty_server_farm (bool) – Specify true if the App Service plan will be empty after app deletion and you want to delete the empty App Service plan. By default, the empty App Service plan is not deleted.

• skip_dns_registration (bool) – If true, DNS registration is skipped.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

delete_source_control(resource_group_name, name, custom_headers=None, raw=False, **operation_config)

Deletes the source control configuration of an app.

Deletes the source control configuration of an app.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

delete_source_control_slot(resource_group_name, name, slot, custom_headers=None, raw=False, **operation_config)

Deletes the source control configuration of an app.

Deletes the source control configuration of an app.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

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

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

delete_triggered_web_job(resource_group_name, name, web_job_name, custom_headers=None, raw=False, **operation_config)

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.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Site name.

• web_job_name (str) – Name of Web Job.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

delete_triggered_web_job_slot(resource_group_name, name, web_job_name, slot, custom_headers=None, raw=False, **operation_config)

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.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Site name.

• web_job_name (str) – Name of Web Job.

• slot (str) – Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

delete_vnet_connection(resource_group_name, name, vnet_name, custom_headers=None, raw=False, **operation_config)

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.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• vnet_name (str) – Name of the virtual network.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

delete_vnet_connection_slot(resource_group_name, name, vnet_name, slot, custom_headers=None, raw=False, **operation_config)

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.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• vnet_name (str) – Name of the virtual network.

• slot (str) – Name of the deployment slot. If a slot is not specified, the API will delete the connection for the production slot.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

discover_restore(resource_group_name, name, request, custom_headers=None, raw=False, **operation_config)

Discovers an existing app backup that can be restored from a blob in Azure storage.

Discovers an existing app backup that can be restored from a blob in Azure storage.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• request (RestoreRequest) – A RestoreRequest object that includes Azure storage URL and blog name for discovery of backup.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

RestoreRequest or ClientRawResponse if raw=true

Return type

RestoreRequest or ClientRawResponse

Raises

CloudError

discover_restore_slot(resource_group_name, name, request, slot, custom_headers=None, raw=False, **operation_config)

Discovers an existing app backup that can be restored from a blob in Azure storage.

Discovers an existing app backup that can be restored from a blob in Azure storage.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• request (RestoreRequest) – A RestoreRequest object that includes Azure storage URL and blog name for discovery of backup.

• slot (str) – Name of the deployment slot. If a slot is not specified, the API will perform discovery for the production slot.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

RestoreRequest or ClientRawResponse if raw=true

Return type

RestoreRequest or ClientRawResponse

Raises

CloudError

generate_new_site_publishing_password(resource_group_name, name, custom_headers=None, raw=False, **operation_config)

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

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

generate_new_site_publishing_password_slot(resource_group_name, name, slot, custom_headers=None, raw=False, **operation_config)

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

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• slot (str) – Name of the deployment slot. If a slot is not specified, the API generate a new publishing password for the production slot.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

get(resource_group_name, name, custom_headers=None, raw=False, **operation_config)

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

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

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

Site or ClientRawResponse if raw=true

Return type

Site or ClientRawResponse

Raises

CloudError

get_auth_settings(resource_group_name, name, custom_headers=None, raw=False, **operation_config)

Gets the Authentication/Authorization settings of an app.

Gets the Authentication/Authorization settings of an app.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

SiteAuthSettings or ClientRawResponse if raw=true

Return type

SiteAuthSettings or ClientRawResponse

Raises

CloudError

get_auth_settings_slot(resource_group_name, name, slot, custom_headers=None, raw=False, **operation_config)

Gets the Authentication/Authorization settings of an app.

Gets the Authentication/Authorization settings of an app.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• slot (str) – Name of the deployment slot. If a slot is not specified, the API will get the settings for the production slot.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

SiteAuthSettings or ClientRawResponse if raw=true

Return type

SiteAuthSettings or ClientRawResponse

Raises

CloudError

get_backup_configuration(resource_group_name, name, custom_headers=None, raw=False, **operation_config)

Gets the backup configuration of an app.

Gets the backup configuration of an app.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

BackupRequest or ClientRawResponse if raw=true

Return type

BackupRequest or ClientRawResponse

Raises

CloudError

get_backup_configuration_slot(resource_group_name, name, slot, custom_headers=None, raw=False, **operation_config)

Gets the backup configuration of an app.

Gets the backup configuration of an app.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• slot (str) – Name of the deployment slot. If a slot is not specified, the API will get the backup configuration for the production slot.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

BackupRequest or ClientRawResponse if raw=true

Return type

BackupRequest or ClientRawResponse

Raises

CloudError

get_backup_status(resource_group_name, name, backup_id, custom_headers=None, raw=False, **operation_config)

Gets a backup of an app by its ID.

Gets a backup of an app by its ID.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• backup_id (str) – ID of the backup.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

BackupItem or ClientRawResponse if raw=true

Return type

BackupItem or ClientRawResponse

Raises

CloudError

get_backup_status_slot(resource_group_name, name, backup_id, slot, custom_headers=None, raw=False, **operation_config)

Gets a backup of an app by its ID.

Gets a backup of an app by its ID.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• backup_id (str) – ID of the backup.

• slot (str) – Name of the deployment slot. If a slot is not specified, the API will get a backup of the production slot.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

BackupItem or ClientRawResponse if raw=true

Return type

BackupItem or ClientRawResponse

Raises

CloudError

get_configuration(resource_group_name, name, custom_headers=None, raw=False, **operation_config)

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.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

SiteConfigResource or ClientRawResponse if raw=true

Return type

SiteConfigResource or ClientRawResponse

Raises

CloudError

get_configuration_slot(resource_group_name, name, slot, custom_headers=None, raw=False, **operation_config)

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.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• slot (str) – Name of the deployment slot. If a slot is not specified, the API will return configuration for the production slot.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

SiteConfigResource or ClientRawResponse if raw=true

Return type

SiteConfigResource or ClientRawResponse

Raises

CloudError

get_configuration_snapshot(resource_group_name, name, snapshot_id, custom_headers=None, raw=False, **operation_config)

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.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• snapshot_id (str) – The ID of the snapshot to read.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

SiteConfigResource or ClientRawResponse if raw=true

Return type

SiteConfigResource or ClientRawResponse

Raises

CloudError

get_configuration_snapshot_slot(resource_group_name, name, snapshot_id, slot, custom_headers=None, raw=False, **operation_config)

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.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• snapshot_id (str) – The ID of the snapshot to read.

• slot (str) – Name of the deployment slot. If a slot is not specified, the API will return configuration for the production slot.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

SiteConfigResource or ClientRawResponse if raw=true

Return type

SiteConfigResource or ClientRawResponse

Raises

CloudError

get_continuous_web_job(resource_group_name, name, web_job_name, custom_headers=None, raw=False, **operation_config)

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.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Site name.

• web_job_name (str) – Name of Web Job.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

ContinuousWebJob or ClientRawResponse if raw=true

Return type

ContinuousWebJob or ClientRawResponse

Raises

CloudError

get_continuous_web_job_slot(resource_group_name, name, web_job_name, slot, custom_headers=None, raw=False, **operation_config)

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.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Site name.

• web_job_name (str) – Name of Web Job.

• slot (str) – Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

ContinuousWebJob or ClientRawResponse if raw=true

Return type

ContinuousWebJob or ClientRawResponse

Raises

CloudError

get_deployment(resource_group_name, name, id, custom_headers=None, raw=False, **operation_config)

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.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• id (str) – Deployment ID.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

Deployment or ClientRawResponse if raw=true

Return type

Deployment or ClientRawResponse

Raises

CloudError

get_deployment_slot(resource_group_name, name, id, slot, custom_headers=None, raw=False, **operation_config)

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.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• id (str) – Deployment ID.

• slot (str) – Name of the deployment slot. If a slot is not specified, the API gets a deployment for the production slot.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

Deployment or ClientRawResponse if raw=true

Return type

Deployment or ClientRawResponse

Raises

CloudError

get_diagnostic_logs_configuration(resource_group_name, name, custom_headers=None, raw=False, **operation_config)

Gets the logging configuration of an app.

Gets the logging configuration of an app.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

SiteLogsConfig or ClientRawResponse if raw=true

Return type

SiteLogsConfig or ClientRawResponse

Raises

CloudError

get_diagnostic_logs_configuration_slot(resource_group_name, name, slot, custom_headers=None, raw=False, **operation_config)

Gets the logging configuration of an app.

Gets the logging configuration of an app.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• slot (str) – Name of the deployment slot. If a slot is not specified, the API will get the logging configuration for the production slot.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

SiteLogsConfig or ClientRawResponse if raw=true

Return type

SiteLogsConfig or ClientRawResponse

Raises

CloudError

get_domain_ownership_identifier(resource_group_name, name, domain_ownership_identifier_name, custom_headers=None, raw=False, **operation_config)

Get domain ownership identifier for web app.

Get domain ownership identifier for web app.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• domain_ownership_identifier_name (str) – Name of domain ownership identifier.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

Identifier or ClientRawResponse if raw=true

Return type

Identifier or ClientRawResponse

Raises

CloudError

get_domain_ownership_identifier_slot(resource_group_name, name, domain_ownership_identifier_name, slot, custom_headers=None, raw=False, **operation_config)

Get domain ownership identifier for web app.

Get domain ownership identifier for web app.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• domain_ownership_identifier_name (str) – Name of domain ownership identifier.

• slot (str) – Name of the deployment slot. If a slot is not specified, the API will delete the binding for the production slot.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

Identifier or ClientRawResponse if raw=true

Return type

Identifier or ClientRawResponse

Raises

CloudError

get_function(resource_group_name, name, function_name, custom_headers=None, raw=False, **operation_config)

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.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Site name.

• function_name (str) – Function name.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

FunctionEnvelope or ClientRawResponse if raw=true

Return type

FunctionEnvelope or ClientRawResponse

Raises

CloudError

get_functions_admin_token(resource_group_name, name, custom_headers=None, raw=False, **operation_config)

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.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of web app.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

str or ClientRawResponse if raw=true

Return type

str or ClientRawResponse

Raises

CloudError

get_functions_admin_token_slot(resource_group_name, name, slot, custom_headers=None, raw=False, **operation_config)

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.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of web app.

• slot (str) – Name of web app slot. If not specified then will default to production slot.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

str or ClientRawResponse if raw=true

Return type

str or ClientRawResponse

Raises

CloudError

get_host_name_binding(resource_group_name, name, host_name, custom_headers=None, raw=False, **operation_config)

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

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• host_name (str) – Hostname in the hostname binding.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

HostNameBinding or ClientRawResponse if raw=true

Return type

HostNameBinding or ClientRawResponse

Raises

CloudError

get_host_name_binding_slot(resource_group_name, name, slot, host_name, custom_headers=None, raw=False, **operation_config)

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

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• slot (str) – Name of the deployment slot. If a slot is not specified, the API the named binding for the production slot.

• host_name (str) – Hostname in the hostname binding.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

HostNameBinding or ClientRawResponse if raw=true

Return type

HostNameBinding or ClientRawResponse

Raises

CloudError

get_hybrid_connection(resource_group_name, name, namespace_name, relay_name, custom_headers=None, raw=False, **operation_config)

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

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

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – The name of the web app.

• namespace_name (str) – The namespace for this hybrid connection.

• relay_name (str) – The relay name for this hybrid connection.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

HybridConnection or ClientRawResponse if raw=true

Return type

HybridConnection or ClientRawResponse

Raises

CloudError

get_hybrid_connection_slot(resource_group_name, name, namespace_name, relay_name, slot, custom_headers=None, raw=False, **operation_config)

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

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

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – The name of the web app.

• namespace_name (str) – The namespace for this hybrid connection.

• relay_name (str) – The relay name for this hybrid connection.

• slot (str) – The name of the slot for the web app.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

HybridConnection or ClientRawResponse if raw=true

Return type

HybridConnection or ClientRawResponse

Raises

CloudError

get_instance_function_slot(resource_group_name, name, function_name, slot, custom_headers=None, raw=False, **operation_config)

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.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Site name.

• function_name (str) – Function name.

• slot (str) – Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

FunctionEnvelope or ClientRawResponse if raw=true

Return type

FunctionEnvelope or ClientRawResponse

Raises

CloudError

get_instance_ms_deploy_log(resource_group_name, name, instance_id, custom_headers=None, raw=False, **operation_config)

Get the MSDeploy Log for the last MSDeploy operation.

Get the MSDeploy Log for the last MSDeploy operation.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of web app.

• instance_id (str) – ID of web app instance.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

MSDeployLog or ClientRawResponse if raw=true

Return type

MSDeployLog or ClientRawResponse

Raises

CloudError

get_instance_ms_deploy_log_slot(resource_group_name, name, slot, instance_id, custom_headers=None, raw=False, **operation_config)

Get the MSDeploy Log for the last MSDeploy operation.

Get the MSDeploy Log for the last MSDeploy operation.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of web app.

• slot (str) – Name of web app slot. If not specified then will default to production slot.

• instance_id (str) – ID of web app instance.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

MSDeployLog or ClientRawResponse if raw=true

Return type

MSDeployLog or ClientRawResponse

Raises

CloudError

get_instance_ms_deploy_status(resource_group_name, name, instance_id, custom_headers=None, raw=False, **operation_config)

Get the status of the last MSDeploy operation.

Get the status of the last MSDeploy operation.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of web app.

• instance_id (str) – ID of web app instance.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

MSDeployStatus or ClientRawResponse if raw=true

Return type

MSDeployStatus or ClientRawResponse

Raises

CloudError

get_instance_ms_deploy_status_slot(resource_group_name, name, slot, instance_id, custom_headers=None, raw=False, **operation_config)

Get the status of the last MSDeploy operation.

Get the status of the last MSDeploy operation.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of web app.

• slot (str) – Name of web app slot. If not specified then will default to production slot.

• instance_id (str) – ID of web app instance.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

MSDeployStatus or ClientRawResponse if raw=true

Return type

MSDeployStatus or ClientRawResponse

Raises

CloudError

get_instance_process(resource_group_name, name, process_id, instance_id, custom_headers=None, raw=False, **operation_config)

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.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Site name.

• process_id (str) – PID.

• instance_id (str) – 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”.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

ProcessInfo or ClientRawResponse if raw=true

Return type

ProcessInfo or ClientRawResponse

Raises

CloudError

get_instance_process_dump(resource_group_name, name, process_id, instance_id, custom_headers=None, raw=False, callback=None, **operation_config)

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.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Site name.

• process_id (str) – PID.

• instance_id (str) – 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”.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• callback (Callable[Bytes, response=None]) – When specified, will be called with each chunk of data that is streamed. The callback should take two arguments, the bytes of the current chunk of data and the response object. If the data is uploading, response will be None.

• operation_config – Operation configuration overrides.

Returns

object or ClientRawResponse if raw=true

Return type

Generator or ClientRawResponse

Raises

CloudError

get_instance_process_dump_slot(resource_group_name, name, process_id, slot, instance_id, custom_headers=None, raw=False, callback=None, **operation_config)

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.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Site name.

• process_id (str) – PID.

• slot (str) – Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.

• instance_id (str) – 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”.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• callback (Callable[Bytes, response=None]) – When specified, will be called with each chunk of data that is streamed. The callback should take two arguments, the bytes of the current chunk of data and the response object. If the data is uploading, response will be None.

• operation_config – Operation configuration overrides.

Returns

object or ClientRawResponse if raw=true

Return type

Generator or ClientRawResponse

Raises

CloudError

get_instance_process_module(resource_group_name, name, process_id, base_address, instance_id, custom_headers=None, raw=False, **operation_config)

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.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Site name.

• process_id (str) – PID.

• base_address (str) – Module base address.

• instance_id (str) – 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”.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

ProcessModuleInfo or ClientRawResponse if raw=true

Return type

ProcessModuleInfo or ClientRawResponse

Raises

CloudError

get_instance_process_module_slot(resource_group_name, name, process_id, base_address, slot, instance_id, custom_headers=None, raw=False, **operation_config)

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.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Site name.

• process_id (str) – PID.

• base_address (str) – Module base address.

• slot (str) – Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.

• instance_id (str) – 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”.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

ProcessModuleInfo or ClientRawResponse if raw=true

Return type

ProcessModuleInfo or ClientRawResponse

Raises

CloudError

get_instance_process_slot(resource_group_name, name, process_id, slot, instance_id, custom_headers=None, raw=False, **operation_config)

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.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Site name.

• process_id (str) – PID.

• slot (str) – Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.

• instance_id (str) – 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”.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

ProcessInfo or ClientRawResponse if raw=true

Return type

ProcessInfo or ClientRawResponse

Raises

CloudError

get_instance_process_thread(resource_group_name, name, process_id, thread_id, instance_id, custom_headers=None, raw=False, **operation_config)

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

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

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Site name.

• process_id (str) – PID.

• thread_id (str) – TID.

• instance_id (str) – 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”.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

ProcessThreadInfo or ClientRawResponse if raw=true

Return type

ProcessThreadInfo or ClientRawResponse

Raises

CloudError

get_instance_process_thread_slot(resource_group_name, name, process_id, thread_id, slot, instance_id, custom_headers=None, raw=False, **operation_config)

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

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

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Site name.

• process_id (str) – PID.

• thread_id (str) – TID.

• slot (str) – Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.

• instance_id (str) – 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”.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

ProcessThreadInfo or ClientRawResponse if raw=true

Return type

ProcessThreadInfo or ClientRawResponse

Raises

CloudError

get_migrate_my_sql_status(resource_group_name, name, custom_headers=None, raw=False, **operation_config)

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.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of web app.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

MigrateMySqlStatus or ClientRawResponse if raw=true

Return type

MigrateMySqlStatus or ClientRawResponse

Raises

CloudError

get_migrate_my_sql_status_slot(resource_group_name, name, slot, custom_headers=None, raw=False, **operation_config)

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.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of web app.

• slot (str) – Name of the deployment slot.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

MigrateMySqlStatus or ClientRawResponse if raw=true

Return type

MigrateMySqlStatus or ClientRawResponse

Raises

CloudError

get_ms_deploy_log(resource_group_name, name, custom_headers=None, raw=False, **operation_config)

Get the MSDeploy Log for the last MSDeploy operation.

Get the MSDeploy Log for the last MSDeploy operation.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of web app.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

MSDeployLog or ClientRawResponse if raw=true

Return type

MSDeployLog or ClientRawResponse

Raises

CloudError

get_ms_deploy_log_slot(resource_group_name, name, slot, custom_headers=None, raw=False, **operation_config)

Get the MSDeploy Log for the last MSDeploy operation.

Get the MSDeploy Log for the last MSDeploy operation.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of web app.

• slot (str) – Name of web app slot. If not specified then will default to production slot.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

MSDeployLog or ClientRawResponse if raw=true

Return type

MSDeployLog or ClientRawResponse

Raises

CloudError

get_ms_deploy_status(resource_group_name, name, custom_headers=None, raw=False, **operation_config)

Get the status of the last MSDeploy operation.

Get the status of the last MSDeploy operation.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of web app.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

MSDeployStatus or ClientRawResponse if raw=true

Return type

MSDeployStatus or ClientRawResponse

Raises

CloudError

get_ms_deploy_status_slot(resource_group_name, name, slot, custom_headers=None, raw=False, **operation_config)

Get the status of the last MSDeploy operation.

Get the status of the last MSDeploy operation.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of web app.

• slot (str) – Name of web app slot. If not specified then will default to production slot.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

MSDeployStatus or ClientRawResponse if raw=true

Return type

MSDeployStatus or ClientRawResponse

Raises

CloudError

get_premier_add_on(resource_group_name, name, premier_add_on_name, custom_headers=None, raw=False, **operation_config)

Gets a named add-on of an app.

Gets a named add-on of an app.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• premier_add_on_name (str) – Add-on name.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

PremierAddOn or ClientRawResponse if raw=true

Return type

PremierAddOn or ClientRawResponse

Raises

CloudError

get_premier_add_on_slot(resource_group_name, name, premier_add_on_name, slot, custom_headers=None, raw=False, **operation_config)

Gets a named add-on of an app.

Gets a named add-on of an app.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• premier_add_on_name (str) – Add-on name.

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

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

PremierAddOn or ClientRawResponse if raw=true

Return type

PremierAddOn or ClientRawResponse

Raises

CloudError

get_process(resource_group_name, name, process_id, custom_headers=None, raw=False, **operation_config)

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.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Site name.

• process_id (str) – PID.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

ProcessInfo or ClientRawResponse if raw=true

Return type

ProcessInfo or ClientRawResponse

Raises

CloudError

get_process_dump(resource_group_name, name, process_id, custom_headers=None, raw=False, callback=None, **operation_config)

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.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Site name.

• process_id (str) – PID.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• callback (Callable[Bytes, response=None]) – When specified, will be called with each chunk of data that is streamed. The callback should take two arguments, the bytes of the current chunk of data and the response object. If the data is uploading, response will be None.

• operation_config – Operation configuration overrides.

Returns

object or ClientRawResponse if raw=true

Return type

Generator or ClientRawResponse

Raises

CloudError

get_process_dump_slot(resource_group_name, name, process_id, slot, custom_headers=None, raw=False, callback=None, **operation_config)

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.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Site name.

• process_id (str) – PID.

• slot (str) – Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• callback (Callable[Bytes, response=None]) – When specified, will be called with each chunk of data that is streamed. The callback should take two arguments, the bytes of the current chunk of data and the response object. If the data is uploading, response will be None.

• operation_config – Operation configuration overrides.

Returns

object or ClientRawResponse if raw=true

Return type

Generator or ClientRawResponse

Raises

CloudError

get_process_module(resource_group_name, name, process_id, base_address, custom_headers=None, raw=False, **operation_config)

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.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Site name.

• process_id (str) – PID.

• base_address (str) – Module base address.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

ProcessModuleInfo or ClientRawResponse if raw=true

Return type

ProcessModuleInfo or ClientRawResponse

Raises

CloudError

get_process_module_slot(resource_group_name, name, process_id, base_address, slot, custom_headers=None, raw=False, **operation_config)

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.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Site name.

• process_id (str) – PID.

• base_address (str) – Module base address.

• slot (str) – Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

ProcessModuleInfo or ClientRawResponse if raw=true

Return type

ProcessModuleInfo or ClientRawResponse

Raises

CloudError

get_process_slot(resource_group_name, name, process_id, slot, custom_headers=None, raw=False, **operation_config)

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.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Site name.

• process_id (str) – PID.

• slot (str) – Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

ProcessInfo or ClientRawResponse if raw=true

Return type

ProcessInfo or ClientRawResponse

Raises

CloudError

get_process_thread(resource_group_name, name, process_id, thread_id, custom_headers=None, raw=False, **operation_config)

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

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

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Site name.

• process_id (str) – PID.

• thread_id (str) – TID.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

ProcessThreadInfo or ClientRawResponse if raw=true

Return type

ProcessThreadInfo or ClientRawResponse

Raises

CloudError

get_process_thread_slot(resource_group_name, name, process_id, thread_id, slot, custom_headers=None, raw=False, **operation_config)

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

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

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Site name.

• process_id (str) – PID.

• thread_id (str) – TID.

• slot (str) – Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

ProcessThreadInfo or ClientRawResponse if raw=true

Return type

ProcessThreadInfo or ClientRawResponse

Raises

CloudError

get_public_certificate(resource_group_name, name, public_certificate_name, custom_headers=None, raw=False, **operation_config)

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

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• public_certificate_name (str) – Public certificate name.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

PublicCertificate or ClientRawResponse if raw=true

Return type

PublicCertificate or ClientRawResponse

Raises

CloudError

get_public_certificate_slot(resource_group_name, name, slot, public_certificate_name, custom_headers=None, raw=False, **operation_config)

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

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• slot (str) – Name of the deployment slot. If a slot is not specified, the API the named binding for the production slot.

• public_certificate_name (str) – Public certificate name.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

PublicCertificate or ClientRawResponse if raw=true

Return type

PublicCertificate or ClientRawResponse

Raises

CloudError

get_relay_service_connection(resource_group_name, name, entity_name, custom_headers=None, raw=False, **operation_config)

Gets a hybrid connection configuration by its name.

Gets a hybrid connection configuration by its name.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• entity_name (str) – Name of the hybrid connection.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

RelayServiceConnectionEntity or ClientRawResponse if raw=true

Return type

RelayServiceConnectionEntity or ClientRawResponse

Raises

CloudError

get_relay_service_connection_slot(resource_group_name, name, entity_name, slot, custom_headers=None, raw=False, **operation_config)

Gets a hybrid connection configuration by its name.

Gets a hybrid connection configuration by its name.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• entity_name (str) – Name of the hybrid connection.

• slot (str) – Name of the deployment slot. If a slot is not specified, the API will get a hybrid connection for the production slot.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

RelayServiceConnectionEntity or ClientRawResponse if raw=true

Return type

RelayServiceConnectionEntity or ClientRawResponse

Raises

CloudError

get_site_extension(resource_group_name, name, site_extension_id, custom_headers=None, raw=False, **operation_config)

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.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Site name.

• site_extension_id (str) – Site extension name.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

SiteExtensionInfo or ClientRawResponse if raw=true

Return type

SiteExtensionInfo or ClientRawResponse

Raises

CloudError

get_site_extension_slot(resource_group_name, name, site_extension_id, slot, custom_headers=None, raw=False, **operation_config)

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.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Site name.

• site_extension_id (str) – Site extension name.

• slot (str) – Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

SiteExtensionInfo or ClientRawResponse if raw=true

Return type

SiteExtensionInfo or ClientRawResponse

Raises

CloudError

get_site_php_error_log_flag(resource_group_name, name, custom_headers=None, raw=False, **operation_config)

Gets web app’s event logs.

Gets web app’s event logs.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of web app.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

SitePhpErrorLogFlag or ClientRawResponse if raw=true

Return type

SitePhpErrorLogFlag or ClientRawResponse

Raises

CloudError

get_site_php_error_log_flag_slot(resource_group_name, name, slot, custom_headers=None, raw=False, **operation_config)

Gets web app’s event logs.

Gets web app’s event logs.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of web app.

• slot (str) – Name of web app slot. If not specified then will default to production slot.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

SitePhpErrorLogFlag or ClientRawResponse if raw=true

Return type

SitePhpErrorLogFlag or ClientRawResponse

Raises

CloudError

get_slot(resource_group_name, name, slot, custom_headers=None, raw=False, **operation_config)

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

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

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• slot (str) – Name of the deployment slot. By default, this API returns the production slot.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

Site or ClientRawResponse if raw=true

Return type

Site or ClientRawResponse

Raises

CloudError

get_source_control(resource_group_name, name, custom_headers=None, raw=False, **operation_config)

Gets the source control configuration of an app.

Gets the source control configuration of an app.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

SiteSourceControl or ClientRawResponse if raw=true

Return type

SiteSourceControl or ClientRawResponse

Raises

CloudError

get_source_control_slot(resource_group_name, name, slot, custom_headers=None, raw=False, **operation_config)

Gets the source control configuration of an app.

Gets the source control configuration of an app.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• slot (str) – Name of the deployment slot. If a slot is not specified, the API will get the source control configuration for the production slot.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

SiteSourceControl or ClientRawResponse if raw=true

Return type

SiteSourceControl or ClientRawResponse

Raises

CloudError

get_triggered_web_job(resource_group_name, name, web_job_name, custom_headers=None, raw=False, **operation_config)

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.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Site name.

• web_job_name (str) – Name of Web Job.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

TriggeredWebJob or ClientRawResponse if raw=true

Return type

TriggeredWebJob or ClientRawResponse

Raises

CloudError

get_triggered_web_job_history(resource_group_name, name, web_job_name, id, custom_headers=None, raw=False, **operation_config)

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.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Site name.

• web_job_name (str) – Name of Web Job.

• id (str) – History ID.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

TriggeredJobHistory or ClientRawResponse if raw=true

Return type

TriggeredJobHistory or ClientRawResponse

Raises

CloudError

get_triggered_web_job_history_slot(resource_group_name, name, web_job_name, id, slot, custom_headers=None, raw=False, **operation_config)

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.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Site name.

• web_job_name (str) – Name of Web Job.

• id (str) – History ID.

• slot (str) – Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

TriggeredJobHistory or ClientRawResponse if raw=true

Return type

TriggeredJobHistory or ClientRawResponse

Raises

CloudError

get_triggered_web_job_slot(resource_group_name, name, web_job_name, slot, custom_headers=None, raw=False, **operation_config)

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.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Site name.

• web_job_name (str) – Name of Web Job.

• slot (str) – Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

TriggeredWebJob or ClientRawResponse if raw=true

Return type

TriggeredWebJob or ClientRawResponse

Raises

CloudError

get_vnet_connection(resource_group_name, name, vnet_name, custom_headers=None, raw=False, **operation_config)

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.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• vnet_name (str) – Name of the virtual network.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

VnetInfo or ClientRawResponse if raw=true

Return type

VnetInfo or ClientRawResponse

Raises

CloudError

get_vnet_connection_gateway(resource_group_name, name, vnet_name, gateway_name, custom_headers=None, raw=False, **operation_config)

Gets an app’s Virtual Network gateway.

Gets an app’s Virtual Network gateway.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• vnet_name (str) – Name of the Virtual Network.

• gateway_name (str) – Name of the gateway. Currently, the only supported string is “primary”.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

VnetGateway or ClientRawResponse if raw=true

Return type

VnetGateway or ClientRawResponse

Raises

CloudError

get_vnet_connection_gateway_slot(resource_group_name, name, vnet_name, gateway_name, slot, custom_headers=None, raw=False, **operation_config)

Gets an app’s Virtual Network gateway.

Gets an app’s Virtual Network gateway.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• vnet_name (str) – Name of the Virtual Network.

• gateway_name (str) – Name of the gateway. Currently, the only supported string is “primary”.

• slot (str) – Name of the deployment slot. If a slot is not specified, the API will get a gateway for the production slot’s Virtual Network.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

VnetGateway or ClientRawResponse if raw=true

Return type

VnetGateway or ClientRawResponse

Raises

CloudError

get_vnet_connection_slot(resource_group_name, name, vnet_name, slot, custom_headers=None, raw=False, **operation_config)

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.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• vnet_name (str) – Name of the virtual network.

• slot (str) – Name of the deployment slot. If a slot is not specified, the API will get the named virtual network for the production slot.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

VnetInfo or ClientRawResponse if raw=true

Return type

VnetInfo or ClientRawResponse

Raises

CloudError

get_web_job(resource_group_name, name, web_job_name, custom_headers=None, raw=False, **operation_config)

Get webjob information for an app, or a deployment slot.

Get webjob information for an app, or a deployment slot.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Site name.

• web_job_name (str) – Name of the web job.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

WebJob or ClientRawResponse if raw=true

Return type

WebJob or ClientRawResponse

Raises

CloudError

get_web_job_slot(resource_group_name, name, web_job_name, slot, custom_headers=None, raw=False, **operation_config)

Get webjob information for an app, or a deployment slot.

Get webjob information for an app, or a deployment slot.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Site name.

• web_job_name (str) – Name of the web job.

• slot (str) – Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

WebJob or ClientRawResponse if raw=true

Return type

WebJob or ClientRawResponse

Raises

CloudError

get_web_site_container_logs(resource_group_name, name, custom_headers=None, raw=False, callback=None, **operation_config)

Gets the last lines of docker logs for the given site.

Gets the last lines of docker logs for the given site.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of web app.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• callback (Callable[Bytes, response=None]) – When specified, will be called with each chunk of data that is streamed. The callback should take two arguments, the bytes of the current chunk of data and the response object. If the data is uploading, response will be None.

• operation_config – Operation configuration overrides.

Returns

object or ClientRawResponse if raw=true

Return type

Generator or ClientRawResponse

Raises

CloudError

get_web_site_container_logs_slot(resource_group_name, name, slot, custom_headers=None, raw=False, callback=None, **operation_config)

Gets the last lines of docker logs for the given site.

Gets the last lines of docker logs for the given site.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of web app.

• slot (str) – Name of web app slot. If not specified then will default to production slot.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• callback (Callable[Bytes, response=None]) – When specified, will be called with each chunk of data that is streamed. The callback should take two arguments, the bytes of the current chunk of data and the response object. If the data is uploading, response will be None.

• operation_config – Operation configuration overrides.

Returns

object or ClientRawResponse if raw=true

Return type

Generator or ClientRawResponse

Raises

CloudError

get_web_site_container_logs_zip(resource_group_name, name, custom_headers=None, raw=False, callback=None, **operation_config)

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

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

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of web app.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• callback (Callable[Bytes, response=None]) – When specified, will be called with each chunk of data that is streamed. The callback should take two arguments, the bytes of the current chunk of data and the response object. If the data is uploading, response will be None.

• operation_config – Operation configuration overrides.

Returns

object or ClientRawResponse if raw=true

Return type

Generator or ClientRawResponse

Raises

CloudError

get_web_site_container_logs_zip_slot(resource_group_name, name, slot, custom_headers=None, raw=False, callback=None, **operation_config)

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

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

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of web app.

• slot (str) – Name of web app slot. If not specified then will default to production slot.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• callback (Callable[Bytes, response=None]) – When specified, will be called with each chunk of data that is streamed. The callback should take two arguments, the bytes of the current chunk of data and the response object. If the data is uploading, response will be None.

• operation_config – Operation configuration overrides.

Returns

object or ClientRawResponse if raw=true

Return type

Generator or ClientRawResponse

Raises

CloudError

install_site_extension(resource_group_name, name, site_extension_id, custom_headers=None, raw=False, polling=True, **operation_config)

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

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

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Site name.

• site_extension_id (str) – Site extension name.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

• polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns SiteExtensionInfo or ClientRawResponse<SiteExtensionInfo> if raw==True

Return type

AzureOperationPoller[SiteExtensionInfo] or AzureOperationPoller[ClientRawResponse[SiteExtensionInfo]]

Raises

CloudError

install_site_extension_slot(resource_group_name, name, site_extension_id, slot, custom_headers=None, raw=False, polling=True, **operation_config)

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

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

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Site name.

• site_extension_id (str) – Site extension name.

• slot (str) – Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

• polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns SiteExtensionInfo or ClientRawResponse<SiteExtensionInfo> if raw==True

Return type

AzureOperationPoller[SiteExtensionInfo] or AzureOperationPoller[ClientRawResponse[SiteExtensionInfo]]

Raises

CloudError

is_cloneable(resource_group_name, name, custom_headers=None, raw=False, **operation_config)

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.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

SiteCloneability or ClientRawResponse if raw=true

Return type

SiteCloneability or ClientRawResponse

Raises

CloudError

is_cloneable_slot(resource_group_name, name, slot, custom_headers=None, raw=False, **operation_config)

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.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• slot (str) – Name of the deployment slot. By default, this API returns information on the production slot.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

SiteCloneability or ClientRawResponse if raw=true

Return type

SiteCloneability or ClientRawResponse

Raises

CloudError

list(custom_headers=None, raw=False, **operation_config)

Get all apps for a subscription.

Get all apps for a subscription.

Parameters

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

An iterator like instance of Site

Return type

SitePaged[Site]

Raises

CloudError

list_application_settings(resource_group_name, name, custom_headers=None, raw=False, **operation_config)

Gets the application settings of an app.

Gets the application settings of an app.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

StringDictionary or ClientRawResponse if raw=true

Return type

StringDictionary or ClientRawResponse

Raises

CloudError

list_application_settings_slot(resource_group_name, name, slot, custom_headers=None, raw=False, **operation_config)

Gets the application settings of an app.

Gets the application settings of an app.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• slot (str) – Name of the deployment slot. If a slot is not specified, the API will get the application settings for the production slot.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

StringDictionary or ClientRawResponse if raw=true

Return type

StringDictionary or ClientRawResponse

Raises

CloudError

list_backup_status_secrets(resource_group_name, name, backup_id, request, custom_headers=None, raw=False, **operation_config)

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.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of web app.

• backup_id (str) – ID of backup.

• request (BackupRequest) – Information on backup request.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

BackupItem or ClientRawResponse if raw=true

Return type

BackupItem or ClientRawResponse

Raises

CloudError

list_backup_status_secrets_slot(resource_group_name, name, backup_id, request, slot, custom_headers=None, raw=False, **operation_config)

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.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of web app.

• backup_id (str) – ID of backup.

• request (BackupRequest) – Information on backup request.

• slot (str) – Name of web app slot. If not specified then will default to production slot.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

BackupItem or ClientRawResponse if raw=true

Return type

BackupItem or ClientRawResponse

Raises

CloudError

list_backups(resource_group_name, name, custom_headers=None, raw=False, **operation_config)

Gets existing backups of an app.

Gets existing backups of an app.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

An iterator like instance of BackupItem

Return type

BackupItemPaged[BackupItem]

Raises

CloudError

list_backups_slot(resource_group_name, name, slot, custom_headers=None, raw=False, **operation_config)

Gets existing backups of an app.

Gets existing backups of an app.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• slot (str) – Name of the deployment slot. If a slot is not specified, the API will get backups of the production slot.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

An iterator like instance of BackupItem

Return type

BackupItemPaged[BackupItem]

Raises

CloudError

list_by_resource_group(resource_group_name, include_slots=None, custom_headers=None, raw=False, **operation_config)

Gets all web, mobile, and API apps in the specified resource group.

Gets all web, mobile, and API apps in the specified resource group.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• include_slots (bool) – Specify <strong>true</strong> to include deployment slots in results. The default is false, which only gives you the production slot of all apps.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

An iterator like instance of Site

Return type

SitePaged[Site]

Raises

CloudError

list_configuration_snapshot_info(resource_group_name, name, custom_headers=None, raw=False, **operation_config)

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.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

An iterator like instance of SiteConfigurationSnapshotInfo

Return type

SiteConfigurationSnapshotInfoPaged[SiteConfigurationSnapshotInfo]

Raises

CloudError

list_configuration_snapshot_info_slot(resource_group_name, name, slot, custom_headers=None, raw=False, **operation_config)

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.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• slot (str) – Name of the deployment slot. If a slot is not specified, the API will return configuration for the production slot.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

An iterator like instance of SiteConfigurationSnapshotInfo

Return type

SiteConfigurationSnapshotInfoPaged[SiteConfigurationSnapshotInfo]

Raises

CloudError

list_configurations(resource_group_name, name, custom_headers=None, raw=False, **operation_config)

List the configurations of an app.

List the configurations of an app.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

An iterator like instance of SiteConfigResource

Return type

SiteConfigResourcePaged[SiteConfigResource]

Raises

CloudError

list_configurations_slot(resource_group_name, name, slot, custom_headers=None, raw=False, **operation_config)

List the configurations of an app.

List the configurations of an app.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• slot (str) – Name of the deployment slot. If a slot is not specified, the API will return configuration for the production slot.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

An iterator like instance of SiteConfigResource

Return type

SiteConfigResourcePaged[SiteConfigResource]

Raises

CloudError

list_connection_strings(resource_group_name, name, custom_headers=None, raw=False, **operation_config)

Gets the connection strings of an app.

Gets the connection strings of an app.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

ConnectionStringDictionary or ClientRawResponse if raw=true

Return type

ConnectionStringDictionary or ClientRawResponse

Raises

CloudError

list_connection_strings_slot(resource_group_name, name, slot, custom_headers=None, raw=False, **operation_config)

Gets the connection strings of an app.

Gets the connection strings of an app.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• slot (str) – Name of the deployment slot. If a slot is not specified, the API will get the connection settings for the production slot.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

ConnectionStringDictionary or ClientRawResponse if raw=true

Return type

ConnectionStringDictionary or ClientRawResponse

Raises

CloudError

list_continuous_web_jobs(resource_group_name, name, custom_headers=None, raw=False, **operation_config)

List continuous web jobs for an app, or a deployment slot.

List continuous web jobs for an app, or a deployment slot.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Site name.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

An iterator like instance of ContinuousWebJob

Return type

ContinuousWebJobPaged[ContinuousWebJob]

Raises

CloudError

list_continuous_web_jobs_slot(resource_group_name, name, slot, custom_headers=None, raw=False, **operation_config)

List continuous web jobs for an app, or a deployment slot.

List continuous web jobs for an app, or a deployment slot.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Site name.

• slot (str) – Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

An iterator like instance of ContinuousWebJob

Return type

ContinuousWebJobPaged[ContinuousWebJob]

Raises

CloudError

list_deployment_log(resource_group_name, name, id, custom_headers=None, raw=False, **operation_config)

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.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• id (str) – The ID of a specific deployment. This is the value of the name property in the JSON response from “GET /api/sites/{siteName}/deployments”.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

Deployment or ClientRawResponse if raw=true

Return type

Deployment or ClientRawResponse

Raises

CloudError

list_deployment_log_slot(resource_group_name, name, id, slot, custom_headers=None, raw=False, **operation_config)

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.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• id (str) – The ID of a specific deployment. This is the value of the name property in the JSON response from “GET /api/sites/{siteName}/deployments”.

• slot (str) – Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

Deployment or ClientRawResponse if raw=true

Return type

Deployment or ClientRawResponse

Raises

CloudError

list_deployments(resource_group_name, name, custom_headers=None, raw=False, **operation_config)

List deployments for an app, or a deployment slot.

List deployments for an app, or a deployment slot.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

An iterator like instance of Deployment

Return type

DeploymentPaged[Deployment]

Raises

CloudError

list_deployments_slot(resource_group_name, name, slot, custom_headers=None, raw=False, **operation_config)

List deployments for an app, or a deployment slot.

List deployments for an app, or a deployment slot.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• slot (str) – Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

An iterator like instance of Deployment

Return type

DeploymentPaged[Deployment]

Raises

CloudError

list_domain_ownership_identifiers(resource_group_name, name, custom_headers=None, raw=False, **operation_config)

Lists ownership identifiers for domain associated with web app.

Lists ownership identifiers for domain associated with web app.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

An iterator like instance of Identifier

Return type

IdentifierPaged[Identifier]

Raises

CloudError

list_domain_ownership_identifiers_slot(resource_group_name, name, slot, custom_headers=None, raw=False, **operation_config)

Lists ownership identifiers for domain associated with web app.

Lists ownership identifiers for domain associated with web app.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• slot (str) – Name of the deployment slot. If a slot is not specified, the API will delete the binding for the production slot.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

An iterator like instance of Identifier

Return type

IdentifierPaged[Identifier]

Raises

CloudError

list_function_secrets(resource_group_name, name, function_name, custom_headers=None, raw=False, **operation_config)

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.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Site name.

• function_name (str) – Function name.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

FunctionSecrets or ClientRawResponse if raw=true

Return type

FunctionSecrets or ClientRawResponse

Raises

CloudError

list_function_secrets_slot(resource_group_name, name, function_name, slot, custom_headers=None, raw=False, **operation_config)

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.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Site name.

• function_name (str) – Function name.

• slot (str) – Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

FunctionSecrets or ClientRawResponse if raw=true

Return type

FunctionSecrets or ClientRawResponse

Raises

CloudError

list_functions(resource_group_name, name, custom_headers=None, raw=False, **operation_config)

List the functions for a web site, or a deployment slot.

List the functions for a web site, or a deployment slot.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Site name.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

An iterator like instance of FunctionEnvelope

Return type

FunctionEnvelopePaged[FunctionEnvelope]

Raises

CloudError

list_host_name_bindings(resource_group_name, name, custom_headers=None, raw=False, **operation_config)

Get hostname bindings for an app or a deployment slot.

Get hostname bindings for an app or a deployment slot.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

An iterator like instance of HostNameBinding

Return type

HostNameBindingPaged[HostNameBinding]

Raises

CloudError

list_host_name_bindings_slot(resource_group_name, name, slot, custom_headers=None, raw=False, **operation_config)

Get hostname bindings for an app or a deployment slot.

Get hostname bindings for an app or a deployment slot.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• slot (str) – Name of the deployment slot. If a slot is not specified, the API gets hostname bindings for the production slot.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

An iterator like instance of HostNameBinding

Return type

HostNameBindingPaged[HostNameBinding]

Raises

CloudError

list_hybrid_connection_keys(resource_group_name, name, namespace_name, relay_name, custom_headers=None, raw=False, **operation_config)

Gets the send key name and value for a Hybrid Connection.

Gets the send key name and value for a Hybrid Connection.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – The name of the web app.

• namespace_name (str) – The namespace for this hybrid connection.

• relay_name (str) – The relay name for this hybrid connection.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

HybridConnectionKey or ClientRawResponse if raw=true

Return type

HybridConnectionKey or ClientRawResponse

Raises

CloudError

list_hybrid_connection_keys_slot(resource_group_name, name, namespace_name, relay_name, slot, custom_headers=None, raw=False, **operation_config)

Gets the send key name and value for a Hybrid Connection.

Gets the send key name and value for a Hybrid Connection.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – The name of the web app.

• namespace_name (str) – The namespace for this hybrid connection.

• relay_name (str) – The relay name for this hybrid connection.

• slot (str) – The name of the slot for the web app.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

HybridConnectionKey or ClientRawResponse if raw=true

Return type

HybridConnectionKey or ClientRawResponse

Raises

CloudError

list_hybrid_connections(resource_group_name, name, custom_headers=None, raw=False, **operation_config)

Retrieves all Service Bus Hybrid Connections used by this Web App.

Retrieves all Service Bus Hybrid Connections used by this Web App.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – The name of the web app.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

HybridConnection or ClientRawResponse if raw=true

Return type

HybridConnection or ClientRawResponse

Raises

CloudError

list_hybrid_connections_slot(resource_group_name, name, slot, custom_headers=None, raw=False, **operation_config)

Retrieves all Service Bus Hybrid Connections used by this Web App.

Retrieves all Service Bus Hybrid Connections used by this Web App.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – The name of the web app.

• slot (str) – The name of the slot for the web app.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

HybridConnection or ClientRawResponse if raw=true

Return type

HybridConnection or ClientRawResponse

Raises

CloudError

list_instance_functions_slot(resource_group_name, name, slot, custom_headers=None, raw=False, **operation_config)

List the functions for a web site, or a deployment slot.

List the functions for a web site, or a deployment slot.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Site name.

• slot (str) – Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

An iterator like instance of FunctionEnvelope

Return type

FunctionEnvelopePaged[FunctionEnvelope]

Raises

CloudError

list_instance_identifiers(resource_group_name, name, custom_headers=None, raw=False, **operation_config)

Gets all scale-out instances of an app.

Gets all scale-out instances of an app.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

An iterator like instance of SiteInstance

Return type

SiteInstancePaged[SiteInstance]

Raises

CloudError

list_instance_identifiers_slot(resource_group_name, name, slot, custom_headers=None, raw=False, **operation_config)

Gets all scale-out instances of an app.

Gets all scale-out instances of an app.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• slot (str) – Name of the deployment slot. If a slot is not specified, the API gets the production slot instances.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

An iterator like instance of SiteInstance

Return type

SiteInstancePaged[SiteInstance]

Raises

CloudError

list_instance_process_modules(resource_group_name, name, process_id, instance_id, custom_headers=None, raw=False, **operation_config)

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.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Site name.

• process_id (str) – PID.

• instance_id (str) – 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”.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

An iterator like instance of ProcessModuleInfo

Return type

ProcessModuleInfoPaged[ProcessModuleInfo]

Raises

CloudError

list_instance_process_modules_slot(resource_group_name, name, process_id, slot, instance_id, custom_headers=None, raw=False, **operation_config)

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.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Site name.

• process_id (str) – PID.

• slot (str) – Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.

• instance_id (str) – 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”.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

An iterator like instance of ProcessModuleInfo

Return type

ProcessModuleInfoPaged[ProcessModuleInfo]

Raises

CloudError

list_instance_process_threads(resource_group_name, name, process_id, instance_id, custom_headers=None, raw=False, **operation_config)

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.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Site name.

• process_id (str) – PID.

• instance_id (str) – 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”.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

An iterator like instance of ProcessThreadInfo

Return type

ProcessThreadInfoPaged[ProcessThreadInfo]

Raises

CloudError

list_instance_process_threads_slot(resource_group_name, name, process_id, slot, instance_id, custom_headers=None, raw=False, **operation_config)

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.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Site name.

• process_id (str) – PID.

• slot (str) – Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.

• instance_id (str) – 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”.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

An iterator like instance of ProcessThreadInfo

Return type

ProcessThreadInfoPaged[ProcessThreadInfo]

Raises

CloudError

list_instance_processes(resource_group_name, name, instance_id, custom_headers=None, raw=False, **operation_config)

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.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Site name.

• instance_id (str) – 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”.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

An iterator like instance of ProcessInfo

Return type

ProcessInfoPaged[ProcessInfo]

Raises

CloudError

list_instance_processes_slot(resource_group_name, name, slot, instance_id, custom_headers=None, raw=False, **operation_config)

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.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Site name.

• slot (str) – Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.

• instance_id (str) – 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”.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

An iterator like instance of ProcessInfo

Return type

ProcessInfoPaged[ProcessInfo]

Raises

CloudError

list_metadata(resource_group_name, name, custom_headers=None, raw=False, **operation_config)

Gets the metadata of an app.

Gets the metadata of an app.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

StringDictionary or ClientRawResponse if raw=true

Return type

StringDictionary or ClientRawResponse

Raises

CloudError

list_metadata_slot(resource_group_name, name, slot, custom_headers=None, raw=False, **operation_config)

Gets the metadata of an app.

Gets the metadata of an app.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• slot (str) – Name of the deployment slot. If a slot is not specified, the API will get the metadata for the production slot.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

StringDictionary or ClientRawResponse if raw=true

Return type

StringDictionary or ClientRawResponse

Raises

CloudError

list_metric_definitions(resource_group_name, name, custom_headers=None, raw=False, **operation_config)

Gets all metric definitions of an app (or deployment slot, if specified).

Gets all metric definitions of an app (or deployment slot, if specified).

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

An iterator like instance of ResourceMetricDefinition

Return type

ResourceMetricDefinitionPaged[ResourceMetricDefinition]

Raises

CloudError

list_metric_definitions_slot(resource_group_name, name, slot, custom_headers=None, raw=False, **operation_config)

Gets all metric definitions of an app (or deployment slot, if specified).

Gets all metric definitions of an app (or deployment slot, if specified).

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• slot (str) – Name of the deployment slot. If a slot is not specified, the API will get metric definitions of the production slot.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

An iterator like instance of ResourceMetricDefinition

Return type

ResourceMetricDefinitionPaged[ResourceMetricDefinition]

Raises

CloudError

list_metrics(resource_group_name, name, details=None, filter=None, custom_headers=None, raw=False, **operation_config)

Gets performance metrics of an app (or deployment slot, if specified).

Gets performance metrics of an app (or deployment slot, if specified).

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• details (bool) – Specify “true” to include metric details in the response. It is “false” by default.

• filter (str) – Return only metrics 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]’.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

An iterator like instance of ResourceMetric

Return type

ResourceMetricPaged[ResourceMetric]

Raises

CloudError

list_metrics_slot(resource_group_name, name, slot, details=None, filter=None, custom_headers=None, raw=False, **operation_config)

Gets performance metrics of an app (or deployment slot, if specified).

Gets performance metrics of an app (or deployment slot, if specified).

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• slot (str) – Name of the deployment slot. If a slot is not specified, the API will get metrics of the production slot.

• details (bool) – Specify “true” to include metric details in the response. It is “false” by default.

• filter (str) – Return only metrics 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]’.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

An iterator like instance of ResourceMetric

Return type

ResourceMetricPaged[ResourceMetric]

Raises

CloudError

list_network_features(resource_group_name, name, view, custom_headers=None, raw=False, **operation_config)

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

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• view (str) – The type of view. This can either be “summary” or “detailed”.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

NetworkFeatures or ClientRawResponse if raw=true

Return type

NetworkFeatures or ClientRawResponse

Raises

CloudError

list_network_features_slot(resource_group_name, name, view, slot, custom_headers=None, raw=False, **operation_config)

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

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• view (str) – The type of view. This can either be “summary” or “detailed”.

• slot (str) – Name of the deployment slot. If a slot is not specified, the API will get network features for the production slot.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

NetworkFeatures or ClientRawResponse if raw=true

Return type

NetworkFeatures or ClientRawResponse

Raises

CloudError

list_perf_mon_counters(resource_group_name, name, filter=None, custom_headers=None, raw=False, **operation_config)

Gets perfmon counters for web app.

Gets perfmon counters for web app.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of web app.

• filter (str) – 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]’.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

An iterator like instance of PerfMonResponse

Return type

PerfMonResponsePaged[PerfMonResponse]

Raises

CloudError

list_perf_mon_counters_slot(resource_group_name, name, slot, filter=None, custom_headers=None, raw=False, **operation_config)

Gets perfmon counters for web app.

Gets perfmon counters for web app.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of web app.

• slot (str) – Name of web app slot. If not specified then will default to production slot.

• filter (str) – 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]’.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

An iterator like instance of PerfMonResponse

Return type

PerfMonResponsePaged[PerfMonResponse]

Raises

CloudError

list_premier_add_ons(resource_group_name, name, custom_headers=None, raw=False, **operation_config)

Gets the premier add-ons of an app.

Gets the premier add-ons of an app.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

PremierAddOn or ClientRawResponse if raw=true

Return type

PremierAddOn or ClientRawResponse

Raises

CloudError

list_premier_add_ons_slot(resource_group_name, name, slot, custom_headers=None, raw=False, **operation_config)

Gets the premier add-ons of an app.

Gets the premier add-ons of an app.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• slot (str) – Name of the deployment slot. If a slot is not specified, the API will get the premier add-ons for the production slot.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

PremierAddOn or ClientRawResponse if raw=true

Return type

PremierAddOn or ClientRawResponse

Raises

CloudError

list_process_modules(resource_group_name, name, process_id, custom_headers=None, raw=False, **operation_config)

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.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Site name.

• process_id (str) – PID.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

An iterator like instance of ProcessModuleInfo

Return type

ProcessModuleInfoPaged[ProcessModuleInfo]

Raises

CloudError

list_process_modules_slot(resource_group_name, name, process_id, slot, custom_headers=None, raw=False, **operation_config)

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.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Site name.

• process_id (str) – PID.

• slot (str) – Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

An iterator like instance of ProcessModuleInfo

Return type

ProcessModuleInfoPaged[ProcessModuleInfo]

Raises

CloudError

list_process_threads(resource_group_name, name, process_id, custom_headers=None, raw=False, **operation_config)

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.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Site name.

• process_id (str) – PID.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

An iterator like instance of ProcessThreadInfo

Return type

ProcessThreadInfoPaged[ProcessThreadInfo]

Raises

CloudError

list_process_threads_slot(resource_group_name, name, process_id, slot, custom_headers=None, raw=False, **operation_config)

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.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Site name.

• process_id (str) – PID.

• slot (str) – Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

An iterator like instance of ProcessThreadInfo

Return type

ProcessThreadInfoPaged[ProcessThreadInfo]

Raises

CloudError

list_processes(resource_group_name, name, custom_headers=None, raw=False, **operation_config)

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.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Site name.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

An iterator like instance of ProcessInfo

Return type

ProcessInfoPaged[ProcessInfo]

Raises

CloudError

list_processes_slot(resource_group_name, name, slot, custom_headers=None, raw=False, **operation_config)

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.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Site name.

• slot (str) – Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

An iterator like instance of ProcessInfo

Return type

ProcessInfoPaged[ProcessInfo]

Raises

CloudError

list_public_certificates(resource_group_name, name, custom_headers=None, raw=False, **operation_config)

Get public certificates for an app or a deployment slot.

Get public certificates for an app or a deployment slot.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

An iterator like instance of PublicCertificate

Return type

PublicCertificatePaged[PublicCertificate]

Raises

CloudError

list_public_certificates_slot(resource_group_name, name, slot, custom_headers=None, raw=False, **operation_config)

Get public certificates for an app or a deployment slot.

Get public certificates for an app or a deployment slot.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• slot (str) – Name of the deployment slot. If a slot is not specified, the API gets hostname bindings for the production slot.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

An iterator like instance of PublicCertificate

Return type

PublicCertificatePaged[PublicCertificate]

Raises

CloudError

list_publishing_credentials(resource_group_name, name, custom_headers=None, raw=False, polling=True, **operation_config)

Gets the Git/FTP publishing credentials of an app.

Gets the Git/FTP publishing credentials of an app.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

• polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns User or ClientRawResponse<User> if raw==True

Return type

AzureOperationPoller[User] or AzureOperationPoller[ClientRawResponse[User]]

Raises

CloudError

list_publishing_credentials_slot(resource_group_name, name, slot, custom_headers=None, raw=False, polling=True, **operation_config)

Gets the Git/FTP publishing credentials of an app.

Gets the Git/FTP publishing credentials of an app.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• slot (str) – Name of the deployment slot. If a slot is not specified, the API will get the publishing credentials for the production slot.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

• polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns User or ClientRawResponse<User> if raw==True

Return type

AzureOperationPoller[User] or AzureOperationPoller[ClientRawResponse[User]]

Raises

CloudError

list_publishing_profile_xml_with_secrets(resource_group_name, name, format=None, custom_headers=None, raw=False, callback=None, **operation_config)

Gets the publishing profile for an app (or deployment slot, if specified).

Gets the publishing profile for an app (or deployment slot, if specified).

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• format (str or PublishingProfileFormat) – Name of the format. Valid values are: FileZilla3 WebDeploy – default Ftp. Possible values include: ‘FileZilla3’, ‘WebDeploy’, ‘Ftp’

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• callback (Callable[Bytes, response=None]) – When specified, will be called with each chunk of data that is streamed. The callback should take two arguments, the bytes of the current chunk of data and the response object. If the data is uploading, response will be None.

• operation_config – Operation configuration overrides.

Returns

object or ClientRawResponse if raw=true

Return type

Generator or ClientRawResponse

Raises

CloudError

list_publishing_profile_xml_with_secrets_slot(resource_group_name, name, slot, format=None, custom_headers=None, raw=False, callback=None, **operation_config)

Gets the publishing profile for an app (or deployment slot, if specified).

Gets the publishing profile for an app (or deployment slot, if specified).

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• slot (str) – Name of the deployment slot. If a slot is not specified, the API will get the publishing profile for the production slot.

• format (str or PublishingProfileFormat) – Name of the format. Valid values are: FileZilla3 WebDeploy – default Ftp. Possible values include: ‘FileZilla3’, ‘WebDeploy’, ‘Ftp’

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• callback (Callable[Bytes, response=None]) – When specified, will be called with each chunk of data that is streamed. The callback should take two arguments, the bytes of the current chunk of data and the response object. If the data is uploading, response will be None.

• operation_config – Operation configuration overrides.

Returns

object or ClientRawResponse if raw=true

Return type

Generator or ClientRawResponse

Raises

CloudError

list_relay_service_connections(resource_group_name, name, custom_headers=None, raw=False, **operation_config)

Gets hybrid connections configured for an app (or deployment slot, if specified).

Gets hybrid connections configured for an app (or deployment slot, if specified).

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

RelayServiceConnectionEntity or ClientRawResponse if raw=true

Return type

RelayServiceConnectionEntity or ClientRawResponse

Raises

CloudError

list_relay_service_connections_slot(resource_group_name, name, slot, custom_headers=None, raw=False, **operation_config)

Gets hybrid connections configured for an app (or deployment slot, if specified).

Gets hybrid connections configured for an app (or deployment slot, if specified).

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• slot (str) – Name of the deployment slot. If a slot is not specified, the API will get hybrid connections for the production slot.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

RelayServiceConnectionEntity or ClientRawResponse if raw=true

Return type

RelayServiceConnectionEntity or ClientRawResponse

Raises

CloudError

list_site_extensions(resource_group_name, name, custom_headers=None, raw=False, **operation_config)

Get list of site extensions for a web site, or a deployment slot.

Get list of site extensions for a web site, or a deployment slot.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Site name.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

An iterator like instance of SiteExtensionInfo

Return type

SiteExtensionInfoPaged[SiteExtensionInfo]

Raises

CloudError

list_site_extensions_slot(resource_group_name, name, slot, custom_headers=None, raw=False, **operation_config)

Get list of site extensions for a web site, or a deployment slot.

Get list of site extensions for a web site, or a deployment slot.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Site name.

• slot (str) – Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

An iterator like instance of SiteExtensionInfo

Return type

SiteExtensionInfoPaged[SiteExtensionInfo]

Raises

CloudError

list_site_push_settings(resource_group_name, name, custom_headers=None, raw=False, **operation_config)

Gets the Push settings associated with web app.

Gets the Push settings associated with web app.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of web app.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

PushSettings or ClientRawResponse if raw=true

Return type

PushSettings or ClientRawResponse

Raises

CloudError

list_site_push_settings_slot(resource_group_name, name, slot, custom_headers=None, raw=False, **operation_config)

Gets the Push settings associated with web app.

Gets the Push settings associated with web app.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of web app.

• slot (str) – Name of web app slot. If not specified then will default to production slot.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

PushSettings or ClientRawResponse if raw=true

Return type

PushSettings or ClientRawResponse

Raises

CloudError

list_slot_configuration_names(resource_group_name, name, custom_headers=None, raw=False, **operation_config)

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

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

SlotConfigNamesResource or ClientRawResponse if raw=true

Return type

SlotConfigNamesResource or ClientRawResponse

Raises

CloudError

list_slot_differences_from_production(resource_group_name, name, target_slot, preserve_vnet, custom_headers=None, raw=False, **operation_config)

Get the difference in configuration settings between two web app slots.

Get the difference in configuration settings between two web app slots.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• target_slot (str) – Destination deployment slot during swap operation.

• preserve_vnet (bool) – <code>true</code> to preserve Virtual Network to the slot during swap; otherwise, <code>false</code>.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

An iterator like instance of SlotDifference

Return type

SlotDifferencePaged[SlotDifference]

Raises

CloudError

list_slot_differences_slot(resource_group_name, name, slot, target_slot, preserve_vnet, custom_headers=None, raw=False, **operation_config)

Get the difference in configuration settings between two web app slots.

Get the difference in configuration settings between two web app slots.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• slot (str) – Name of the source slot. If a slot is not specified, the production slot is used as the source slot.

• target_slot (str) – Destination deployment slot during swap operation.

• preserve_vnet (bool) – <code>true</code> to preserve Virtual Network to the slot during swap; otherwise, <code>false</code>.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

An iterator like instance of SlotDifference

Return type

SlotDifferencePaged[SlotDifference]

Raises

CloudError

list_slots(resource_group_name, name, custom_headers=None, raw=False, **operation_config)

Gets an app’s deployment slots.

Gets an app’s deployment slots.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

An iterator like instance of Site

Return type

SitePaged[Site]

Raises

CloudError

list_snapshots(resource_group_name, name, custom_headers=None, raw=False, **operation_config)

Returns all Snapshots to the user.

Returns all Snapshots to the user.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Website Name.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

An iterator like instance of Snapshot

Return type

SnapshotPaged[Snapshot]

Raises

CloudError

list_snapshots_slot(resource_group_name, name, slot, custom_headers=None, raw=False, **operation_config)

Returns all Snapshots to the user.

Returns all Snapshots to the user.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Website Name.

• slot (str) – Website Slot.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

An iterator like instance of Snapshot

Return type

SnapshotPaged[Snapshot]

Raises

CloudError

list_sync_function_triggers(resource_group_name, name, custom_headers=None, raw=False, **operation_config)

This is to allow calling via powershell and ARM template.

This is to allow calling via powershell and ARM template.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

FunctionSecrets or ClientRawResponse if raw=true

Return type

FunctionSecrets or ClientRawResponse

Raises

CloudError

list_sync_function_triggers_slot(resource_group_name, name, slot, custom_headers=None, raw=False, **operation_config)

This is to allow calling via powershell and ARM template.

This is to allow calling via powershell and ARM template.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• slot (str) – Name of the deployment slot. If a slot is not specified, the API will restore a backup of the production slot.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

FunctionSecrets or ClientRawResponse if raw=true

Return type

FunctionSecrets or ClientRawResponse

Raises

CloudError

list_triggered_web_job_history(resource_group_name, name, web_job_name, custom_headers=None, raw=False, **operation_config)

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.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Site name.

• web_job_name (str) – Name of Web Job.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

An iterator like instance of TriggeredJobHistory

Return type

TriggeredJobHistoryPaged[TriggeredJobHistory]

Raises

CloudError

list_triggered_web_job_history_slot(resource_group_name, name, web_job_name, slot, custom_headers=None, raw=False, **operation_config)

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.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Site name.

• web_job_name (str) – Name of Web Job.

• slot (str) – Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

An iterator like instance of TriggeredJobHistory

Return type

TriggeredJobHistoryPaged[TriggeredJobHistory]

Raises

CloudError

list_triggered_web_jobs(resource_group_name, name, custom_headers=None, raw=False, **operation_config)

List triggered web jobs for an app, or a deployment slot.

List triggered web jobs for an app, or a deployment slot.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Site name.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

An iterator like instance of TriggeredWebJob

Return type

TriggeredWebJobPaged[TriggeredWebJob]

Raises

CloudError

list_triggered_web_jobs_slot(resource_group_name, name, slot, custom_headers=None, raw=False, **operation_config)

List triggered web jobs for an app, or a deployment slot.

List triggered web jobs for an app, or a deployment slot.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Site name.

• slot (str) – Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

An iterator like instance of TriggeredWebJob

Return type

TriggeredWebJobPaged[TriggeredWebJob]

Raises

CloudError

list_usages(resource_group_name, name, filter=None, custom_headers=None, raw=False, **operation_config)

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

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• filter (str) – 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]’.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

An iterator like instance of CsmUsageQuota

Return type

CsmUsageQuotaPaged[CsmUsageQuota]

Raises

CloudError

list_usages_slot(resource_group_name, name, slot, filter=None, custom_headers=None, raw=False, **operation_config)

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

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• slot (str) – Name of the deployment slot. If a slot is not specified, the API will get quota information of the production slot.

• filter (str) – 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]’.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

An iterator like instance of CsmUsageQuota

Return type

CsmUsageQuotaPaged[CsmUsageQuota]

Raises

CloudError

list_vnet_connections(resource_group_name, name, custom_headers=None, raw=False, **operation_config)

Gets the virtual networks the app (or deployment slot) is connected to.

Gets the virtual networks the app (or deployment slot) is connected to.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

list or ClientRawResponse if raw=true

Return type

list[VnetInfo] or ClientRawResponse

Raises

CloudError

list_vnet_connections_slot(resource_group_name, name, slot, custom_headers=None, raw=False, **operation_config)

Gets the virtual networks the app (or deployment slot) is connected to.

Gets the virtual networks the app (or deployment slot) is connected to.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• slot (str) – Name of the deployment slot. If a slot is not specified, the API will get virtual network connections for the production slot.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

list or ClientRawResponse if raw=true

Return type

list[VnetInfo] or ClientRawResponse

Raises

CloudError

list_web_jobs(resource_group_name, name, custom_headers=None, raw=False, **operation_config)

List webjobs for an app, or a deployment slot.

List webjobs for an app, or a deployment slot.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Site name.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

An iterator like instance of WebJob

Return type

WebJobPaged[WebJob]

Raises

CloudError

list_web_jobs_slot(resource_group_name, name, slot, custom_headers=None, raw=False, **operation_config)

List webjobs for an app, or a deployment slot.

List webjobs for an app, or a deployment slot.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Site name.

• slot (str) – Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

An iterator like instance of WebJob

Return type

WebJobPaged[WebJob]

Raises

CloudError

migrate_my_sql(resource_group_name, name, migration_request_envelope, custom_headers=None, raw=False, polling=True, **operation_config)

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

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

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of web app.

• migration_request_envelope (MigrateMySqlRequest) – MySql migration options.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

• polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns Operation or ClientRawResponse<Operation> if raw==True

Return type

AzureOperationPoller[Operation] or AzureOperationPoller[ClientRawResponse[Operation]]

Raises

CloudError

migrate_storage(subscription_name, resource_group_name, name, migration_options, custom_headers=None, raw=False, polling=True, **operation_config)

Restores a web app.

Restores a web app.

Parameters

• subscription_name (str) – Azure subscription.

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of web app.

• migration_options (StorageMigrationOptions) – Migration migrationOptions.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

• polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns StorageMigrationResponse or ClientRawResponse<StorageMigrationResponse> if raw==True

Return type

AzureOperationPoller[StorageMigrationResponse] or AzureOperationPoller[ClientRawResponse[StorageMigrationResponse]]

Raises

CloudError

recover(resource_group_name, name, recovery_entity, custom_headers=None, raw=False, polling=True, **operation_config)

Recovers a web app to a previous snapshot.

Recovers a web app to a previous snapshot.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of web app.

• recovery_entity (SnapshotRecoveryRequest) – Snapshot data used for web app recovery. Snapshot information can be obtained by calling GetDeletedSites or GetSiteSnapshots API.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

• polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

recover_site_configuration_snapshot(resource_group_name, name, snapshot_id, custom_headers=None, raw=False, **operation_config)

Reverts the configuration of an app to a previous snapshot.

Reverts the configuration of an app to a previous snapshot.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• snapshot_id (str) – The ID of the snapshot to read.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

recover_site_configuration_snapshot_slot(resource_group_name, name, snapshot_id, slot, custom_headers=None, raw=False, **operation_config)

Reverts the configuration of an app to a previous snapshot.

Reverts the configuration of an app to a previous snapshot.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• snapshot_id (str) – The ID of the snapshot to read.

• slot (str) – Name of the deployment slot. If a slot is not specified, the API will return configuration for the production slot.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

recover_slot(resource_group_name, name, recovery_entity, slot, custom_headers=None, raw=False, polling=True, **operation_config)

Recovers a web app to a previous snapshot.

Recovers a web app to a previous snapshot.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of web app.

• recovery_entity (SnapshotRecoveryRequest) – Snapshot data used for web app recovery. Snapshot information can be obtained by calling GetDeletedSites or GetSiteSnapshots API.

• slot (str) – Name of web app slot. If not specified then will default to production slot.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

• polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

reset_production_slot_config(resource_group_name, name, custom_headers=None, raw=False, **operation_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.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

reset_slot_configuration_slot(resource_group_name, name, slot, custom_headers=None, raw=False, **operation_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.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• slot (str) – Name of the deployment slot. If a slot is not specified, the API resets configuration settings for the production slot.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

restart(resource_group_name, name, soft_restart=None, synchronous=None, custom_headers=None, raw=False, **operation_config)

Restarts an app (or deployment slot, if specified).

Restarts an app (or deployment slot, if specified).

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• soft_restart (bool) – Specify true to apply the configuration settings and restarts the app only if necessary. By default, the API always restarts and reprovisions the app.

• synchronous (bool) – Specify true to block until the app is restarted. By default, it is set to false, and the API responds immediately (asynchronous).

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

restart_slot(resource_group_name, name, slot, soft_restart=None, synchronous=None, custom_headers=None, raw=False, **operation_config)

Restarts an app (or deployment slot, if specified).

Restarts an app (or deployment slot, if specified).

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• slot (str) – Name of the deployment slot. If a slot is not specified, the API will restart the production slot.

• soft_restart (bool) – Specify true to apply the configuration settings and restarts the app only if necessary. By default, the API always restarts and reprovisions the app.

• synchronous (bool) – Specify true to block until the app is restarted. By default, it is set to false, and the API responds immediately (asynchronous).

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

restore(resource_group_name, name, backup_id, request, custom_headers=None, raw=False, polling=True, **operation_config)

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

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

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• backup_id (str) – ID of the backup.

• request (RestoreRequest) – Information on restore request .

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

• polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns RestoreResponse or ClientRawResponse<RestoreResponse> if raw==True

Return type

AzureOperationPoller[RestoreResponse] or AzureOperationPoller[ClientRawResponse[RestoreResponse]]

Raises

CloudError

restore_slot(resource_group_name, name, backup_id, request, slot, custom_headers=None, raw=False, polling=True, **operation_config)

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

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

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• backup_id (str) – ID of the backup.

• request (RestoreRequest) – Information on restore request .

• slot (str) – Name of the deployment slot. If a slot is not specified, the API will restore a backup of the production slot.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

• polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns RestoreResponse or ClientRawResponse<RestoreResponse> if raw==True

Return type

AzureOperationPoller[RestoreResponse] or AzureOperationPoller[ClientRawResponse[RestoreResponse]]

Raises

CloudError

run_triggered_web_job(resource_group_name, name, web_job_name, custom_headers=None, raw=False, **operation_config)

Run a triggered web job for an app, or a deployment slot.

Run a triggered web job for an app, or a deployment slot.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Site name.

• web_job_name (str) – Name of Web Job.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

run_triggered_web_job_slot(resource_group_name, name, web_job_name, slot, custom_headers=None, raw=False, **operation_config)

Run a triggered web job for an app, or a deployment slot.

Run a triggered web job for an app, or a deployment slot.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Site name.

• web_job_name (str) – Name of Web Job.

• slot (str) – Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

start(resource_group_name, name, custom_headers=None, raw=False, **operation_config)

Starts an app (or deployment slot, if specified).

Starts an app (or deployment slot, if specified).

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

start_continuous_web_job(resource_group_name, name, web_job_name, custom_headers=None, raw=False, **operation_config)

Start a continuous web job for an app, or a deployment slot.

Start a continuous web job for an app, or a deployment slot.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Site name.

• web_job_name (str) – Name of Web Job.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

start_continuous_web_job_slot(resource_group_name, name, web_job_name, slot, custom_headers=None, raw=False, **operation_config)

Start a continuous web job for an app, or a deployment slot.

Start a continuous web job for an app, or a deployment slot.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Site name.

• web_job_name (str) – Name of Web Job.

• slot (str) – Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

start_slot(resource_group_name, name, slot, custom_headers=None, raw=False, **operation_config)

Starts an app (or deployment slot, if specified).

Starts an app (or deployment slot, if specified).

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• slot (str) – Name of the deployment slot. If a slot is not specified, the API will start the production slot.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

start_web_site_network_trace(resource_group_name, name, duration_in_seconds=None, max_frame_length=None, sas_url=None, custom_headers=None, raw=False, **operation_config)

Start capturing network packets for the site.

Start capturing network packets for the site.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – The name of the web app.

• duration_in_seconds (int) – The duration to keep capturing in seconds.

• max_frame_length (int) – The maximum frame length in bytes (Optional).

• sas_url (str) – The Blob URL to store capture file.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

str or ClientRawResponse if raw=true

Return type

str or ClientRawResponse

Raises

CloudError

start_web_site_network_trace_slot(resource_group_name, name, slot, duration_in_seconds=None, max_frame_length=None, sas_url=None, custom_headers=None, raw=False, **operation_config)

Start capturing network packets for the site.

Start capturing network packets for the site.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – The name of the web app.

• slot (str) – The name of the slot for this web app.

• duration_in_seconds (int) – The duration to keep capturing in seconds.

• max_frame_length (int) – The maximum frame length in bytes (Optional).

• sas_url (str) – The Blob URL to store capture file.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

str or ClientRawResponse if raw=true

Return type

str or ClientRawResponse

Raises

CloudError

stop(resource_group_name, name, custom_headers=None, raw=False, **operation_config)

Stops an app (or deployment slot, if specified).

Stops an app (or deployment slot, if specified).

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

stop_continuous_web_job(resource_group_name, name, web_job_name, custom_headers=None, raw=False, **operation_config)

Stop a continuous web job for an app, or a deployment slot.

Stop a continuous web job for an app, or a deployment slot.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Site name.

• web_job_name (str) – Name of Web Job.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

stop_continuous_web_job_slot(resource_group_name, name, web_job_name, slot, custom_headers=None, raw=False, **operation_config)

Stop a continuous web job for an app, or a deployment slot.

Stop a continuous web job for an app, or a deployment slot.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Site name.

• web_job_name (str) – Name of Web Job.

• slot (str) – Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

stop_slot(resource_group_name, name, slot, custom_headers=None, raw=False, **operation_config)

Stops an app (or deployment slot, if specified).

Stops an app (or deployment slot, if specified).

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• slot (str) – Name of the deployment slot. If a slot is not specified, the API will stop the production slot.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

stop_web_site_network_trace(resource_group_name, name, custom_headers=None, raw=False, **operation_config)

Stop ongoing capturing network packets for the site.

Stop ongoing capturing network packets for the site.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – The name of the web app.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

str or ClientRawResponse if raw=true

Return type

str or ClientRawResponse

Raises

CloudError

stop_web_site_network_trace_slot(resource_group_name, name, slot, custom_headers=None, raw=False, **operation_config)

Stop ongoing capturing network packets for the site.

Stop ongoing capturing network packets for the site.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – The name of the web app.

• slot (str) – The name of the slot for this web app.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

str or ClientRawResponse if raw=true

Return type

str or ClientRawResponse

Raises

CloudError

swap_slot_slot(resource_group_name, name, slot, target_slot, preserve_vnet, custom_headers=None, raw=False, polling=True, **operation_config)

Swaps two deployment slots of an app.

Swaps two deployment slots of an app.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• slot (str) – Name of the source slot. If a slot is not specified, the production slot is used as the source slot.

• target_slot (str) – Destination deployment slot during swap operation.

• preserve_vnet (bool) – <code>true</code> to preserve Virtual Network to the slot during swap; otherwise, <code>false</code>.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

• polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

swap_slot_with_production(resource_group_name, name, target_slot, preserve_vnet, custom_headers=None, raw=False, polling=True, **operation_config)

Swaps two deployment slots of an app.

Swaps two deployment slots of an app.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• target_slot (str) – Destination deployment slot during swap operation.

• preserve_vnet (bool) – <code>true</code> to preserve Virtual Network to the slot during swap; otherwise, <code>false</code>.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

• polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

sync_function_triggers(resource_group_name, name, custom_headers=None, raw=False, **operation_config)

Syncs function trigger metadata to the scale controller.

Syncs function trigger metadata to the scale controller.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

sync_function_triggers_slot(resource_group_name, name, slot, custom_headers=None, raw=False, **operation_config)

Syncs function trigger metadata to the scale controller.

Syncs function trigger metadata to the scale controller.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• slot (str) – Name of the deployment slot. If a slot is not specified, the API will restore a backup of the production slot.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

sync_repository(resource_group_name, name, custom_headers=None, raw=False, **operation_config)

Sync web app repository.

Sync web app repository.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of web app.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

sync_repository_slot(resource_group_name, name, slot, custom_headers=None, raw=False, **operation_config)

Sync web app repository.

Sync web app repository.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of web app.

• slot (str) – Name of web app slot. If not specified then will default to production slot.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

update(resource_group_name, name, site_envelope, custom_headers=None, raw=False, **operation_config)

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.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Unique name of the app to create or update. To create or update a deployment slot, use the {slot} parameter.

• site_envelope (SitePatchResource) – A JSON representation of the app properties. See example.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

Site or ClientRawResponse if raw=true

Return type

Site or ClientRawResponse

Raises

CloudError

update_application_settings(resource_group_name, name, kind=None, properties=None, custom_headers=None, raw=False, **operation_config)

Replaces the application settings of an app.

Replaces the application settings of an app.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• kind (str) – Kind of resource.

• properties (dict[str, str]) – Settings.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

StringDictionary or ClientRawResponse if raw=true

Return type

StringDictionary or ClientRawResponse

Raises

CloudError

update_application_settings_slot(resource_group_name, name, slot, kind=None, properties=None, custom_headers=None, raw=False, **operation_config)

Replaces the application settings of an app.

Replaces the application settings of an app.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• slot (str) – Name of the deployment slot. If a slot is not specified, the API will update the application settings for the production slot.

• kind (str) – Kind of resource.

• properties (dict[str, str]) – Settings.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

StringDictionary or ClientRawResponse if raw=true

Return type

StringDictionary or ClientRawResponse

Raises

CloudError

update_auth_settings(resource_group_name, name, site_auth_settings, custom_headers=None, raw=False, **operation_config)

Updates the Authentication / Authorization settings associated with web app.

Updates the Authentication / Authorization settings associated with web app.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of web app.

• site_auth_settings (SiteAuthSettings) – Auth settings associated with web app.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

SiteAuthSettings or ClientRawResponse if raw=true

Return type

SiteAuthSettings or ClientRawResponse

Raises

CloudError

update_auth_settings_slot(resource_group_name, name, site_auth_settings, slot, custom_headers=None, raw=False, **operation_config)

Updates the Authentication / Authorization settings associated with web app.

Updates the Authentication / Authorization settings associated with web app.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of web app.

• site_auth_settings (SiteAuthSettings) – Auth settings associated with web app.

• slot (str) – Name of web app slot. If not specified then will default to production slot.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

SiteAuthSettings or ClientRawResponse if raw=true

Return type

SiteAuthSettings or ClientRawResponse

Raises

CloudError

update_backup_configuration(resource_group_name, name, request, custom_headers=None, raw=False, **operation_config)

Updates the backup configuration of an app.

Updates the backup configuration of an app.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• request (BackupRequest) – Edited backup configuration.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

BackupRequest or ClientRawResponse if raw=true

Return type

BackupRequest or ClientRawResponse

Raises

CloudError

update_backup_configuration_slot(resource_group_name, name, request, slot, custom_headers=None, raw=False, **operation_config)

Updates the backup configuration of an app.

Updates the backup configuration of an app.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• request (BackupRequest) – Edited backup configuration.

• slot (str) – Name of the deployment slot. If a slot is not specified, the API will update the backup configuration for the production slot.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

BackupRequest or ClientRawResponse if raw=true

Return type

BackupRequest or ClientRawResponse

Raises

CloudError

update_configuration(resource_group_name, name, site_config, custom_headers=None, raw=False, **operation_config)

Updates the configuration of an app.

Updates the configuration of an app.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• site_config (SiteConfigResource) – JSON representation of a SiteConfig object. See example.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

SiteConfigResource or ClientRawResponse if raw=true

Return type

SiteConfigResource or ClientRawResponse

Raises

CloudError

update_configuration_slot(resource_group_name, name, site_config, slot, custom_headers=None, raw=False, **operation_config)

Updates the configuration of an app.

Updates the configuration of an app.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• site_config (SiteConfigResource) – JSON representation of a SiteConfig object. See example.

• slot (str) – Name of the deployment slot. If a slot is not specified, the API will update configuration for the production slot.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

SiteConfigResource or ClientRawResponse if raw=true

Return type

SiteConfigResource or ClientRawResponse

Raises

CloudError

update_connection_strings(resource_group_name, name, kind=None, properties=None, custom_headers=None, raw=False, **operation_config)

Replaces the connection strings of an app.

Replaces the connection strings of an app.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• kind (str) – Kind of resource.

• properties (dict[str, ConnStringValueTypePair]) – Connection strings.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

ConnectionStringDictionary or ClientRawResponse if raw=true

Return type

ConnectionStringDictionary or ClientRawResponse

Raises

CloudError

update_connection_strings_slot(resource_group_name, name, slot, kind=None, properties=None, custom_headers=None, raw=False, **operation_config)

Replaces the connection strings of an app.

Replaces the connection strings of an app.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• slot (str) – Name of the deployment slot. If a slot is not specified, the API will update the connection settings for the production slot.

• kind (str) – Kind of resource.

• properties (dict[str, ConnStringValueTypePair]) – Connection strings.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

ConnectionStringDictionary or ClientRawResponse if raw=true

Return type

ConnectionStringDictionary or ClientRawResponse

Raises

CloudError

update_diagnostic_logs_config(resource_group_name, name, site_logs_config, custom_headers=None, raw=False, **operation_config)

Updates the logging configuration of an app.

Updates the logging configuration of an app.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• site_logs_config (SiteLogsConfig) – A SiteLogsConfig JSON object that contains the logging configuration to change in the “properties” property.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

SiteLogsConfig or ClientRawResponse if raw=true

Return type

SiteLogsConfig or ClientRawResponse

Raises

CloudError

update_diagnostic_logs_config_slot(resource_group_name, name, site_logs_config, slot, custom_headers=None, raw=False, **operation_config)

Updates the logging configuration of an app.

Updates the logging configuration of an app.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• site_logs_config (SiteLogsConfig) – A SiteLogsConfig JSON object that contains the logging configuration to change in the “properties” property.

• slot (str) – Name of the deployment slot. If a slot is not specified, the API will update the logging configuration for the production slot.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

SiteLogsConfig or ClientRawResponse if raw=true

Return type

SiteLogsConfig or ClientRawResponse

Raises

CloudError

update_domain_ownership_identifier(resource_group_name, name, domain_ownership_identifier_name, kind=None, identifier_id=None, custom_headers=None, raw=False, **operation_config)

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.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• domain_ownership_identifier_name (str) – Name of domain ownership identifier.

• kind (str) – Kind of resource.

• identifier_id (str) – String representation of the identity.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

Identifier or ClientRawResponse if raw=true

Return type

Identifier or ClientRawResponse

Raises

CloudError

update_domain_ownership_identifier_slot(resource_group_name, name, domain_ownership_identifier_name, slot, kind=None, identifier_id=None, custom_headers=None, raw=False, **operation_config)

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.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• domain_ownership_identifier_name (str) – Name of domain ownership identifier.

• slot (str) – Name of the deployment slot. If a slot is not specified, the API will delete the binding for the production slot.

• kind (str) – Kind of resource.

• identifier_id (str) – String representation of the identity.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

Identifier or ClientRawResponse if raw=true

Return type

Identifier or ClientRawResponse

Raises

CloudError

update_hybrid_connection(resource_group_name, name, namespace_name, relay_name, connection_envelope, custom_headers=None, raw=False, **operation_config)

Creates a new Hybrid Connection using a Service Bus relay.

Creates a new Hybrid Connection using a Service Bus relay.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – The name of the web app.

• namespace_name (str) – The namespace for this hybrid connection.

• relay_name (str) – The relay name for this hybrid connection.

• connection_envelope (HybridConnection) – The details of the hybrid connection.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

HybridConnection or ClientRawResponse if raw=true

Return type

HybridConnection or ClientRawResponse

Raises

CloudError

update_hybrid_connection_slot(resource_group_name, name, namespace_name, relay_name, connection_envelope, slot, custom_headers=None, raw=False, **operation_config)

Creates a new Hybrid Connection using a Service Bus relay.

Creates a new Hybrid Connection using a Service Bus relay.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – The name of the web app.

• namespace_name (str) – The namespace for this hybrid connection.

• relay_name (str) – The relay name for this hybrid connection.

• connection_envelope (HybridConnection) – The details of the hybrid connection.

• slot (str) – The name of the slot for the web app.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

HybridConnection or ClientRawResponse if raw=true

Return type

HybridConnection or ClientRawResponse

Raises

CloudError

update_metadata(resource_group_name, name, kind=None, properties=None, custom_headers=None, raw=False, **operation_config)

Replaces the metadata of an app.

Replaces the metadata of an app.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• kind (str) – Kind of resource.

• properties (dict[str, str]) – Settings.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

StringDictionary or ClientRawResponse if raw=true

Return type

StringDictionary or ClientRawResponse

Raises

CloudError

update_metadata_slot(resource_group_name, name, slot, kind=None, properties=None, custom_headers=None, raw=False, **operation_config)

Replaces the metadata of an app.

Replaces the metadata of an app.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• slot (str) – Name of the deployment slot. If a slot is not specified, the API will update the metadata for the production slot.

• kind (str) – Kind of resource.

• properties (dict[str, str]) – Settings.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

StringDictionary or ClientRawResponse if raw=true

Return type

StringDictionary or ClientRawResponse

Raises

CloudError

update_relay_service_connection(resource_group_name, name, entity_name, connection_envelope, custom_headers=None, raw=False, **operation_config)

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

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• entity_name (str) – Name of the hybrid connection configuration.

• connection_envelope (RelayServiceConnectionEntity) – Details of the hybrid connection configuration.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

RelayServiceConnectionEntity or ClientRawResponse if raw=true

Return type

RelayServiceConnectionEntity or ClientRawResponse

Raises

CloudError

update_relay_service_connection_slot(resource_group_name, name, entity_name, connection_envelope, slot, custom_headers=None, raw=False, **operation_config)

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

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• entity_name (str) – Name of the hybrid connection configuration.

• connection_envelope (RelayServiceConnectionEntity) – Details of the hybrid connection configuration.

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

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

RelayServiceConnectionEntity or ClientRawResponse if raw=true

Return type

RelayServiceConnectionEntity or ClientRawResponse

Raises

CloudError

update_site_push_settings(resource_group_name, name, push_settings, custom_headers=None, raw=False, **operation_config)

Updates the Push settings associated with web app.

Updates the Push settings associated with web app.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of web app.

• push_settings (PushSettings) – Push settings associated with web app.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

PushSettings or ClientRawResponse if raw=true

Return type

PushSettings or ClientRawResponse

Raises

CloudError

update_site_push_settings_slot(resource_group_name, name, push_settings, slot, custom_headers=None, raw=False, **operation_config)

Updates the Push settings associated with web app.

Updates the Push settings associated with web app.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of web app.

• push_settings (PushSettings) – Push settings associated with web app.

• slot (str) – Name of web app slot. If not specified then will default to production slot.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

PushSettings or ClientRawResponse if raw=true

Return type

PushSettings or ClientRawResponse

Raises

CloudError

update_slot(resource_group_name, name, site_envelope, slot, skip_dns_registration=None, skip_custom_domain_verification=None, force_dns_registration=None, ttl_in_seconds=None, custom_headers=None, raw=False, **operation_config)

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.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Unique name of the app to create or update. To create or update a deployment slot, use the {slot} parameter.

• site_envelope (SitePatchResource) – A JSON representation of the app properties. See example.

• slot (str) – Name of the deployment slot to create or update. By default, this API attempts to create or modify the production slot.

• skip_dns_registration (bool) – If true web app hostname is not registered with DNS on creation. This parameter is only used for app creation.

• skip_custom_domain_verification (bool) – If true, custom (non *.azurewebsites.net) domains associated with web app are not verified.

• force_dns_registration (bool) – If true, web app hostname is force registered with DNS.

• ttl_in_seconds (str) – Time to live in seconds for web app’s default domain name.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

Site or ClientRawResponse if raw=true

Return type

Site or ClientRawResponse

Raises

CloudError

update_slot_configuration_names(resource_group_name, name, slot_config_names, custom_headers=None, raw=False, **operation_config)

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.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• slot_config_names (SlotConfigNamesResource) – Names of application settings and connection strings. See example.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

SlotConfigNamesResource or ClientRawResponse if raw=true

Return type

SlotConfigNamesResource or ClientRawResponse

Raises

CloudError

update_source_control(resource_group_name, name, site_source_control, custom_headers=None, raw=False, **operation_config)

Updates the source control configuration of an app.

Updates the source control configuration of an app.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• site_source_control (SiteSourceControl) – JSON representation of a SiteSourceControl object. See example.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

SiteSourceControl or ClientRawResponse if raw=true

Return type

SiteSourceControl or ClientRawResponse

Raises

CloudError

update_source_control_slot(resource_group_name, name, site_source_control, slot, custom_headers=None, raw=False, **operation_config)

Updates the source control configuration of an app.

Updates the source control configuration of an app.

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• site_source_control (SiteSourceControl) – JSON representation of a SiteSourceControl object. See example.

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

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

SiteSourceControl or ClientRawResponse if raw=true

Return type

SiteSourceControl or ClientRawResponse

Raises

CloudError

update_vnet_connection(resource_group_name, name, vnet_name, connection_envelope, custom_headers=None, raw=False, **operation_config)

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

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• vnet_name (str) – Name of an existing Virtual Network.

• connection_envelope (VnetInfo) – Properties of the Virtual Network connection. See example.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

VnetInfo or ClientRawResponse if raw=true

Return type

VnetInfo or ClientRawResponse

Raises

CloudError

update_vnet_connection_gateway(resource_group_name, name, vnet_name, gateway_name, connection_envelope, custom_headers=None, raw=False, **operation_config)

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

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• vnet_name (str) – Name of the Virtual Network.

• gateway_name (str) – Name of the gateway. Currently, the only supported string is “primary”.

• connection_envelope (VnetGateway) – The properties to update this gateway with.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

VnetGateway or ClientRawResponse if raw=true

Return type

VnetGateway or ClientRawResponse

Raises

CloudError

update_vnet_connection_gateway_slot(resource_group_name, name, vnet_name, gateway_name, connection_envelope, slot, custom_headers=None, raw=False, **operation_config)

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

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• vnet_name (str) – Name of the Virtual Network.

• gateway_name (str) – Name of the gateway. Currently, the only supported string is “primary”.

• connection_envelope (VnetGateway) – The properties to update this gateway with.

• slot (str) – 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.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

VnetGateway or ClientRawResponse if raw=true

Return type

VnetGateway or ClientRawResponse

Raises

CloudError

update_vnet_connection_slot(resource_group_name, name, vnet_name, connection_envelope, slot, custom_headers=None, raw=False, **operation_config)

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

Parameters

• resource_group_name (str) – Name of the resource group to which the resource belongs.

• name (str) – Name of the app.

• vnet_name (str) – Name of an existing Virtual Network.

• connection_envelope (VnetInfo) – Properties of the Virtual Network connection. See example.

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

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

VnetInfo or ClientRawResponse if raw=true

Return type

VnetInfo or ClientRawResponse

Raises

CloudError

models = <module 'azure.mgmt.web.v2016_08_01.models' from '/home/vsts/work/1/s/sdk/appservice/azure-mgmt-web/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/web/v2016_08_01/models/__init__.py'>