azure.mgmt.web.operations module

class azure.mgmt.web.operations.AppServiceCertificateOrdersOperations(client, config, serializer, deserializer)[source]

Bases: object

AppServiceCertificateOrdersOperations operations.

Parameters:
  • client – Client for service requests.
  • config – Configuration of service client.
  • serializer – An object model serializer.
  • deserializer – An objec model deserializer.
Variables:

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

create_or_update(resource_group_name, certificate_order_name, certificate_distinguished_name, custom_headers=None, raw=False, **operation_config)[source]

Create or update a certificate purchase order.

Create or update a certificate purchase order.

Parameters:
  • resource_group_name (str) – Name of the resource group to which the resource belongs.
  • certificate_order_name (str) – Name of the certificate order.
  • certificate_distinguished_name (AppServiceCertificateOrder) – Distinguished name to to use for the certificate order.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
Return type:

AzureOperationPoller instance that returns AppServiceCertificateOrder

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

create_or_update_certificate(resource_group_name, certificate_order_name, name, key_vault_certificate, custom_headers=None, raw=False, **operation_config)[source]

Creates or updates a certificate and associates with key vault secret.

Creates or updates a certificate and associates with key vault secret.

Parameters:
  • resource_group_name (str) – Name of the resource group to which the resource belongs.
  • certificate_order_name (str) – Name of the certificate order.
  • name (str) – Name of the certificate.
  • key_vault_certificate (AppServiceCertificateResource) – Key vault certificate resource Id.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
Return type:

AzureOperationPoller instance that returns AppServiceCertificateResource

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

delete(resource_group_name, certificate_order_name, custom_headers=None, raw=False, **operation_config)[source]

Delete an existing certificate order.

Delete an existing certificate order.

Parameters:
  • resource_group_name (str) – Name of the resource group to which the resource belongs.
  • certificate_order_name (str) – Name of the certificate order.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

None

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

delete_certificate(resource_group_name, certificate_order_name, name, custom_headers=None, raw=False, **operation_config)[source]

Delete the certificate associated with a certificate order.

Delete the certificate associated with a certificate order.

Parameters:
  • resource_group_name (str) – Name of the resource group to which the resource belongs.
  • certificate_order_name (str) – Name of the certificate order.
  • name (str) – Name of the certificate.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

None

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

get(resource_group_name, certificate_order_name, custom_headers=None, raw=False, **operation_config)[source]

Get a certificate order.

Get a certificate order.

Parameters:
  • resource_group_name (str) – Name of the resource group to which the resource belongs.
  • certificate_order_name (str) – Name of the certificate order..
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

AppServiceCertificateOrder

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

get_certificate(resource_group_name, certificate_order_name, name, custom_headers=None, raw=False, **operation_config)[source]

Get the certificate associated with a certificate order.

Get the certificate associated with a certificate order.

Parameters:
  • resource_group_name (str) – Name of the resource group to which the resource belongs.
  • certificate_order_name (str) – Name of the certificate order.
  • name (str) – Name of the certificate.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

AppServiceCertificateResource

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

list(custom_headers=None, raw=False, **operation_config)[source]

List all certificate orders in a subscription.

List all certificate orders in a subscription.

Parameters:
Return type:

AppServiceCertificateOrderPaged

Raises:

CloudError

list_by_resource_group(resource_group_name, custom_headers=None, raw=False, **operation_config)[source]

Get certificate orders in a resource group.

Get certificate orders in a resource group.

Parameters:
  • resource_group_name (str) – Name of the resource group to which the resource belongs.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

AppServiceCertificateOrderPaged

Raises:

CloudError

list_certificates(resource_group_name, certificate_order_name, custom_headers=None, raw=False, **operation_config)[source]

List all certificates associated with a certificate order.

List all certificates associated with a certificate order.

Parameters:
  • resource_group_name (str) – Name of the resource group to which the resource belongs.
  • certificate_order_name (str) – Name of the certificate order.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

AppServiceCertificateResourcePaged

Raises:

CloudError

reissue(resource_group_name, certificate_order_name, reissue_certificate_order_request, custom_headers=None, raw=False, **operation_config)[source]

Reissue an existing certificate order.

Reissue an existing certificate order.

Parameters:
  • resource_group_name (str) – Name of the resource group to which the resource belongs.
  • certificate_order_name (str) – Name of the certificate order.
  • reissue_certificate_order_request (ReissueCertificateOrderRequest) – Parameters for the reissue.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

None

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

renew(resource_group_name, certificate_order_name, renew_certificate_order_request, custom_headers=None, raw=False, **operation_config)[source]

Renew an existing certificate order.

Renew an existing certificate order.

Parameters:
  • resource_group_name (str) – Name of the resource group to which the resource belongs.
  • certificate_order_name (str) – Name of the certificate order.
  • renew_certificate_order_request (RenewCertificateOrderRequest) – Renew parameters
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

None

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

resend_email(resource_group_name, certificate_order_name, custom_headers=None, raw=False, **operation_config)[source]

Resend certificate email.

Resend certificate email.

Parameters:
  • resource_group_name (str) – Name of the resource group to which the resource belongs.
  • certificate_order_name (str) – Name of the certificate order.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

None

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

resend_request_emails(resource_group_name, certificate_order_name, name=None, custom_headers=None, raw=False, **operation_config)[source]

Verify domain ownership for this certificate order.

Verify domain ownership for this certificate order.

Parameters:
  • resource_group_name (str) – Name of the resource group to which the resource belongs.
  • certificate_order_name (str) – Name of the certificate order.
  • name (str) – Name of the object.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

None

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

retrieve_certificate_actions(resource_group_name, name, custom_headers=None, raw=False, **operation_config)[source]

Retrieve the list of certificate actions.

Retrieve the list of certificate actions.

Parameters:
  • resource_group_name (str) – Name of the resource group to which the resource belongs.
  • name (str) – Name of the certificate order.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

list of CertificateOrderAction

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

retrieve_certificate_email_history(resource_group_name, name, custom_headers=None, raw=False, **operation_config)[source]

Retrieve email history.

Retrieve email history.

Parameters:
  • resource_group_name (str) – Name of the resource group to which the resource belongs.
  • name (str) – Name of the certificate order.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

list of CertificateEmail

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

retrieve_site_seal(resource_group_name, certificate_order_name, light_theme=None, locale=None, custom_headers=None, raw=False, **operation_config)[source]

Verify domain ownership for this certificate order.

Verify domain ownership for this certificate order.

Parameters:
  • resource_group_name (str) – Name of the resource group to which the resource belongs.
  • certificate_order_name (str) – Name of the certificate order.
  • light_theme (bool) – Theme
  • locale (str) – Locale
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

SiteSeal

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

validate_purchase_information(app_service_certificate_order, custom_headers=None, raw=False, **operation_config)[source]

Validate information for a certificate order.

Validate information for a certificate order.

Parameters:
Return type:

None

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

verify_domain_ownership(resource_group_name, certificate_order_name, custom_headers=None, raw=False, **operation_config)[source]

Verify domain ownership for this certificate order.

Verify domain ownership for this certificate order.

Parameters:
  • resource_group_name (str) – Name of the resource group to which the resource belongs.
  • certificate_order_name (str) – Name of the certificate order.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

None

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

class azure.mgmt.web.operations.AppServiceEnvironmentsOperations(client, config, serializer, deserializer)[source]

Bases: object

AppServiceEnvironmentsOperations operations.

Parameters:
  • client – Client for service requests.
  • config – Configuration of service client.
  • serializer – An object model serializer.
  • deserializer – An objec model deserializer.
Variables:

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

create_or_update(resource_group_name, name, hosting_environment_envelope, custom_headers=None, raw=False, **operation_config)[source]

Create or update an App Service Environment.

Create or update an App Service Environment.

Parameters:
  • resource_group_name (str) – Name of the resource group to which the resource belongs.
  • name (str) – Name of the App Service Environment.
  • hosting_environment_envelope (AppServiceEnvironmentResource) – Configuration details of the App Service Environment.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
Return type:

AzureOperationPoller instance that returns AppServiceEnvironmentResource

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

create_or_update_multi_role_pool(resource_group_name, name, multi_role_pool_envelope, custom_headers=None, raw=False, **operation_config)[source]

Create or update a multi-role pool.

Create or update a multi-role pool.

Parameters:
  • resource_group_name (str) – Name of the resource group to which the resource belongs.
  • name (str) – Name of the App Service Environment.
  • multi_role_pool_envelope (WorkerPoolResource) – Properties of the multi-role pool.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
Return type:

AzureOperationPoller instance that returns WorkerPoolResource

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

create_or_update_worker_pool(resource_group_name, name, worker_pool_name, worker_pool_envelope, custom_headers=None, raw=False, **operation_config)[source]

Create or update a worker pool.

Create or update a worker pool.

Parameters:
  • resource_group_name (str) – Name of the resource group to which the resource belongs.
  • name (str) – Name of the App Service Environment.
  • worker_pool_name (str) – Name of the worker pool.
  • worker_pool_envelope (WorkerPoolResource) – Properties of the worker pool.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
Return type:

AzureOperationPoller instance that returns WorkerPoolResource

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

delete(resource_group_name, name, force_delete=None, custom_headers=None, raw=False, **operation_config)[source]

Delete an App Service Environment.

Delete an App Service Environment.

Parameters:
  • resource_group_name (str) – Name of the resource group to which the resource belongs.
  • name (str) – Name of the App Service Environment.
  • force_delete (bool) – Specify <code>true</code> to force the deletion even if the App Service Environment contains resources. The default is <code>false</code>.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
Return type:

AzureOperationPoller instance that returns None

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

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

Get the properties of an App Service Environment.

Get the properties of an App Service Environment.

Parameters:
  • resource_group_name (str) – Name of the resource group to which the resource belongs.
  • name (str) – Name of the App Service Environment.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

AppServiceEnvironmentResource

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

get_diagnostics_item(resource_group_name, name, diagnostics_name, custom_headers=None, raw=False, **operation_config)[source]

Get a diagnostics item for an App Service Environment.

Get a diagnostics item for an App Service Environment.

Parameters:
  • resource_group_name (str) – Name of the resource group to which the resource belongs.
  • name (str) – Name of the App Service Environment.
  • diagnostics_name (str) – Name of the diagnostics item.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

HostingEnvironmentDiagnostics

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

get_multi_role_pool(resource_group_name, name, custom_headers=None, raw=False, **operation_config)[source]

Get properties of a multi-role pool.

Get properties of a multi-role pool.

Parameters:
  • resource_group_name (str) – Name of the resource group to which the resource belongs.
  • name (str) – Name of the App Service Environment.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

WorkerPoolResource

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

get_worker_pool(resource_group_name, name, worker_pool_name, custom_headers=None, raw=False, **operation_config)[source]

Get properties of a worker pool.

Get properties of a worker pool.

Parameters:
  • resource_group_name (str) – Name of the resource group to which the resource belongs.
  • name (str) – Name of the App Service Environment.
  • worker_pool_name (str) – Name of the worker pool.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

WorkerPoolResource

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

list(custom_headers=None, raw=False, **operation_config)[source]

Get all App Service Environments for a subscription.

Get all App Service Environments for a subscription.

Parameters:
Return type:

AppServiceEnvironmentPaged

Raises:

CloudError

list_app_service_plans(resource_group_name, name, custom_headers=None, raw=False, **operation_config)[source]

Get all App Service plans in an App Service Environment.

Get all App Service plans in an App Service Environment.

Parameters:
  • resource_group_name (str) – Name of the resource group to which the resource belongs.
  • name (str) – Name of the App Service Environment.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

AppServicePlanPaged

Raises:

CloudError

list_by_resource_group(resource_group_name, custom_headers=None, raw=False, **operation_config)[source]

Get all App Service Environments in a resource group.

Get all App Service Environments in a resource group.

Parameters:
  • resource_group_name (str) – Name of the resource group to which the resource belongs.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

AppServiceEnvironmentPaged

Raises:

CloudError

list_capacities(resource_group_name, name, custom_headers=None, raw=False, **operation_config)[source]

Get the used, available, and total worker capacity an App Service Environment.

Get the used, available, and total worker capacity an App Service Environment.

Parameters:
  • resource_group_name (str) – Name of the resource group to which the resource belongs.
  • name (str) – Name of the App Service Environment.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

StampCapacityPaged

Raises:

CloudError

list_diagnostics(resource_group_name, name, custom_headers=None, raw=False, **operation_config)[source]

Get diagnostic information for an App Service Environment.

Get diagnostic information for an App Service Environment.

Parameters:
  • resource_group_name (str) – Name of the resource group to which the resource belongs.
  • name (str) – Name of the App Service Environment.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

list of HostingEnvironmentDiagnostics

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

list_metric_definitions(resource_group_name, name, custom_headers=None, raw=False, **operation_config)[source]

Get global metric definitions of an App Service Environment.

Get global metric definitions of an App Service Environment.

Parameters:
  • resource_group_name (str) – Name of the resource group to which the resource belongs.
  • name (str) – Name of the App Service Environment.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

MetricDefinition

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

list_metrics(resource_group_name, name, details=None, filter=None, custom_headers=None, raw=False, **operation_config)[source]

Get global metrics of an App Service Environment.

Get global metrics of an App Service Environment.

Parameters:
  • resource_group_name (str) – Name of the resource group to which the resource belongs.
  • name (str) – Name of the App Service Environment.
  • details (bool) – Specify <code>true</code> to include instance details. The default is <code>false</code>.
  • filter (str) – Return only usages/metrics specified in the filter. Filter conforms to odata syntax. 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_configOperation configuration overrides.
Return type:

ResourceMetricPaged

Raises:

CloudError

list_multi_role_metric_definitions(resource_group_name, name, custom_headers=None, raw=False, **operation_config)[source]

Get metric definitions for a multi-role pool of an App Service Environment.

Get metric definitions for a multi-role pool of an App Service Environment.

Parameters:
  • resource_group_name (str) – Name of the resource group to which the resource belongs.
  • name (str) – Name of the App Service Environment.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

ResourceMetricDefinitionPaged

Raises:

CloudError

list_multi_role_metrics(resource_group_name, name, start_time=None, end_time=None, time_grain=None, details=None, filter=None, custom_headers=None, raw=False, **operation_config)[source]

Get metrics for a multi-role pool of an App Service Environment.

Get metrics for a multi-role pool of an App Service Environment.

Parameters:
  • resource_group_name (str) – Name of the resource group to which the resource belongs.
  • name (str) – Name of the App Service Environment.
  • start_time (str) – Beginning time of the metrics query.
  • end_time (str) – End time of the metrics query.
  • time_grain (str) – Time granularity of the metrics query.
  • details (bool) – Specify <code>true</code> to include instance details. The default is <code>false</code>.
  • filter (str) – Return only usages/metrics specified in the filter. Filter conforms to odata syntax. 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_configOperation configuration overrides.
Return type:

ResourceMetricPaged

Raises:

CloudError

list_multi_role_pool_instance_metric_definitions(resource_group_name, name, instance, custom_headers=None, raw=False, **operation_config)[source]

Get metric definitions for a specific instance of a multi-role pool of an App Service Environment.

Get metric definitions for a specific instance of a multi-role pool of an App Service Environment.

Parameters:
  • resource_group_name (str) – Name of the resource group to which the resource belongs.
  • name (str) – Name of the App Service Environment.
  • instance (str) – Name of the instance in the multi-role pool.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

ResourceMetricDefinitionPaged

Raises:

CloudError

list_multi_role_pool_instance_metrics(resource_group_name, name, instance, details=None, custom_headers=None, raw=False, **operation_config)[source]

Get metrics for a specific instance of a multi-role pool of an App Service Environment.

Get metrics for a specific instance of a multi-role pool of an App Service Environment.

Parameters:
  • resource_group_name (str) – Name of the resource group to which the resource belongs.
  • name (str) – Name of the App Service Environment.
  • instance (str) – Name of the instance in the multi-role pool.
  • details (bool) – Specify <code>true</code> to include instance details. The default is <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_configOperation configuration overrides.
Return type:

ResourceMetricPaged

Raises:

CloudError

list_multi_role_pool_skus(resource_group_name, name, custom_headers=None, raw=False, **operation_config)[source]

Get available SKUs for scaling a multi-role pool.

Get available SKUs for scaling a multi-role pool.

Parameters:
  • resource_group_name (str) – Name of the resource group to which the resource belongs.
  • name (str) – Name of the App Service Environment.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

SkuInfoPaged

Raises:

CloudError

list_multi_role_pools(resource_group_name, name, custom_headers=None, raw=False, **operation_config)[source]

Get all multi-role pools.

Get all multi-role pools.

Parameters:
  • resource_group_name (str) – Name of the resource group to which the resource belongs.
  • name (str) – Name of the App Service Environment.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

WorkerPoolResourcePaged

Raises:

CloudError

list_multi_role_usages(resource_group_name, name, custom_headers=None, raw=False, **operation_config)[source]

Get usage metrics for a multi-role pool of an App Service Environment.

Get usage metrics for a multi-role pool of an App Service Environment.

Parameters:
  • resource_group_name (str) – Name of the resource group to which the resource belongs.
  • name (str) – Name of the App Service Environment.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

UsagePaged

Raises:

CloudError

list_operations(resource_group_name, name, custom_headers=None, raw=False, **operation_config)[source]

List all currently running operations on the App Service Environment.

List all currently running operations on the App Service Environment.

Parameters:
  • resource_group_name (str) – Name of the resource group to which the resource belongs.
  • name (str) – Name of the App Service Environment.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

list of Operation

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

list_usages(resource_group_name, name, filter=None, custom_headers=None, raw=False, **operation_config)[source]

Get global usage metrics of an App Service Environment.

Get global usage metrics of an App Service Environment.

Parameters:
  • resource_group_name (str) – Name of the resource group to which the resource belongs.
  • name (str) – Name of the App Service Environment.
  • filter (str) – Return only usages/metrics specified in the filter. Filter conforms to odata syntax. 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_configOperation configuration overrides.
Return type:

CsmUsageQuotaPaged

Raises:

CloudError

list_vips(resource_group_name, name, custom_headers=None, raw=False, **operation_config)[source]

Get IP addresses assigned to an App Service Environment.

Get IP addresses assigned to an App Service Environment.

Parameters:
  • resource_group_name (str) – Name of the resource group to which the resource belongs.
  • name (str) – Name of the App Service Environment.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

AddressResponse

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

list_web_apps(resource_group_name, name, properties_to_include=None, custom_headers=None, raw=False, **operation_config)[source]

Get all apps in an App Service Environment.

Get all apps in an App Service Environment.

Parameters:
  • resource_group_name (str) – Name of the resource group to which the resource belongs.
  • name (str) – Name of the App Service Environment.
  • properties_to_include (str) – Comma separated list of app properties to include.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

SitePaged

Raises:

CloudError

list_web_worker_metric_definitions(resource_group_name, name, worker_pool_name, custom_headers=None, raw=False, **operation_config)[source]

Get metric definitions for a worker pool of an App Service Environment.

Get metric definitions for a worker pool of an App Service Environment.

Parameters:
  • resource_group_name (str) – Name of the resource group to which the resource belongs.
  • name (str) – Name of the App Service Environment.
  • worker_pool_name (str) – Name of the worker pool.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

ResourceMetricDefinitionPaged

Raises:

CloudError

list_web_worker_metrics(resource_group_name, name, worker_pool_name, details=None, filter=None, custom_headers=None, raw=False, **operation_config)[source]

Get metrics for a worker pool of a AppServiceEnvironment (App Service Environment).

Get metrics for a worker pool of a AppServiceEnvironment (App Service Environment).

Parameters:
  • resource_group_name (str) – Name of the resource group to which the resource belongs.
  • name (str) – Name of the App Service Environment.
  • worker_pool_name (str) – Name of worker pool
  • details (bool) – Specify <code>true</code> to include instance details. The default is <code>false</code>.
  • filter (str) – Return only usages/metrics specified in the filter. Filter conforms to odata syntax. 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_configOperation configuration overrides.
Return type:

ResourceMetricPaged

Raises:

CloudError

list_web_worker_usages(resource_group_name, name, worker_pool_name, custom_headers=None, raw=False, **operation_config)[source]

Get usage metrics for a worker pool of an App Service Environment.

Get usage metrics for a worker pool of an App Service Environment.

Parameters:
  • resource_group_name (str) – Name of the resource group to which the resource belongs.
  • name (str) – Name of the App Service Environment.
  • worker_pool_name (str) – Name of the worker pool.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

UsagePaged

Raises:

CloudError

list_worker_pool_instance_metric_definitions(resource_group_name, name, worker_pool_name, instance, custom_headers=None, raw=False, **operation_config)[source]

Get metric definitions for a specific instance of a worker pool of an App Service Environment.

Get metric definitions for a specific instance of a worker pool of an App Service Environment.

Parameters:
  • resource_group_name (str) – Name of the resource group to which the resource belongs.
  • name (str) – Name of the App Service Environment.
  • worker_pool_name (str) – Name of the worker pool.
  • instance (str) – Name of the instance in the worker pool.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

ResourceMetricDefinitionPaged

Raises:

CloudError

list_worker_pool_instance_metrics(resource_group_name, name, worker_pool_name, instance, details=None, filter=None, custom_headers=None, raw=False, **operation_config)[source]

Get metrics for a specific instance of a worker pool of an App Service Environment.

Get metrics for a specific instance of a worker pool of an App Service Environment.

Parameters:
  • resource_group_name (str) – Name of the resource group to which the resource belongs.
  • name (str) – Name of the App Service Environment.
  • worker_pool_name (str) – Name of the worker pool.
  • instance (str) – Name of the instance in the worker pool.
  • details (bool) – Specify <code>true</code> to include instance details. The default is <code>false</code>.
  • filter (str) – Return only usages/metrics specified in the filter. Filter conforms to odata syntax. 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_configOperation configuration overrides.
Return type:

ResourceMetricPaged

Raises:

CloudError

list_worker_pool_skus(resource_group_name, name, worker_pool_name, custom_headers=None, raw=False, **operation_config)[source]

Get available SKUs for scaling a worker pool.

Get available SKUs for scaling a worker pool.

Parameters:
  • resource_group_name (str) – Name of the resource group to which the resource belongs.
  • name (str) – Name of the App Service Environment.
  • worker_pool_name (str) – Name of the worker pool.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

SkuInfoPaged

Raises:

CloudError

list_worker_pools(resource_group_name, name, custom_headers=None, raw=False, **operation_config)[source]

Get all worker pools of an App Service Environment.

Get all worker pools of an App Service Environment.

Parameters:
  • resource_group_name (str) – Name of the resource group to which the resource belongs.
  • name (str) – Name of the App Service Environment.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

WorkerPoolResourcePaged

Raises:

CloudError

reboot(resource_group_name, name, custom_headers=None, raw=False, **operation_config)[source]

Reboot all machines in an App Service Environment.

Reboot all machines in an App Service Environment.

Parameters:
  • resource_group_name (str) – Name of the resource group to which the resource belongs.
  • name (str) – Name of the App Service Environment.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

None

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

resume(resource_group_name, name, custom_headers=None, raw=False, **operation_config)[source]

Resume an App Service Environment.

Resume an App Service Environment.

Parameters:
  • resource_group_name (str) – Name of the resource group to which the resource belongs.
  • name (str) – Name of the App Service Environment.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

SitePaged

Raises:

CloudError

suspend(resource_group_name, name, custom_headers=None, raw=False, **operation_config)[source]

Suspend an App Service Environment.

Suspend an App Service Environment.

Parameters:
  • resource_group_name (str) – Name of the resource group to which the resource belongs.
  • name (str) – Name of the App Service Environment.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

SitePaged

Raises:

CloudError

class azure.mgmt.web.operations.AppServicePlansOperations(client, config, serializer, deserializer)[source]

Bases: object

AppServicePlansOperations operations.

Parameters:
  • client – Client for service requests.
  • config – Configuration of service client.
  • serializer – An object model serializer.
  • deserializer – An objec model deserializer.
Variables:

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

create_or_update(resource_group_name, name, app_service_plan, custom_headers=None, raw=False, **operation_config)[source]

Creates or updates an App Service Plan.

Creates or updates an App Service Plan.

Parameters:
  • resource_group_name (str) – Name of the resource group to which the resource belongs.
  • name (str) – Name of the App Service plan.
  • app_service_plan (AppServicePlan) – Details of the App Service plan.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
Return type:

AzureOperationPoller instance that returns AppServicePlan

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

create_or_update_vnet_route(resource_group_name, name, vnet_name, route_name, route, custom_headers=None, raw=False, **operation_config)[source]

Create or update a Virtual Network route in an App Service plan.

Create or update a Virtual Network route in an App Service plan.

Parameters:
  • resource_group_name (str) – Name of the resource group to which the resource belongs.
  • name (str) – Name of the App Service plan.
  • vnet_name (str) – Name of the Virtual Network.
  • route_name (str) – Name of the Virtual Network route.
  • route (VnetRoute) – Definition of the Virtual Network route.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

VnetRoute

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

delete(resource_group_name, name, custom_headers=None, raw=False, **operation_config)[source]

Delete an App Service plan.

Delete an App Service plan.

Parameters:
  • resource_group_name (str) – Name of the resource group to which the resource belongs.
  • name (str) – Name of the App Service plan.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

None

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

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

Delete a Hybrid Connection in use in an App Service plan.

Delete a Hybrid Connection in use in an App Service plan.

Parameters:
  • resource_group_name (str) – Name of the resource group to which the resource belongs.
  • name (str) – Name of the App Service plan.
  • namespace_name (str) – Name of the Service Bus namespace.
  • relay_name (str) – Name of the Service Bus relay.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

None

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

delete_vnet_route(resource_group_name, name, vnet_name, route_name, custom_headers=None, raw=False, **operation_config)[source]

Delete a Virtual Network route in an App Service plan.

Delete a Virtual Network route in an App Service plan.

Parameters:
  • resource_group_name (str) – Name of the resource group to which the resource belongs.
  • name (str) – Name of the App Service plan.
  • vnet_name (str) – Name of the Virtual Network.
  • route_name (str) – Name of the Virtual Network route.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

None

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

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

Get an App Service plan.

Get an App Service plan.

Parameters:
  • resource_group_name (str) – Name of the resource group to which the resource belongs.
  • name (str) – Name of the App Service plan.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

AppServicePlan

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

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

Retrieve a Hybrid Connection in use in an App Service plan.

Retrieve a Hybrid Connection in use in an App Service plan.

Parameters:
  • resource_group_name (str) – Name of the resource group to which the resource belongs.
  • name (str) – Name of the App Service plan.
  • namespace_name (str) – Name of the Service Bus namespace.
  • relay_name (str) – Name of the Service Bus relay.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

HybridConnection

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

get_hybrid_connection_plan_limit(resource_group_name, name, custom_headers=None, raw=False, **operation_config)[source]

Get the maximum number of Hybrid Connections allowed in an App Service plan.

Get the maximum number of Hybrid Connections allowed in an App Service plan.

Parameters:
  • resource_group_name (str) – Name of the resource group to which the resource belongs.
  • name (str) – Name of the App Service plan.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

HybridConnectionLimits

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

get_route_for_vnet(resource_group_name, name, vnet_name, route_name, custom_headers=None, raw=False, **operation_config)[source]

Get a Virtual Network route in an App Service plan.

Get a Virtual Network route in an App Service plan.

Parameters:
  • resource_group_name (str) – Name of the resource group to which the resource belongs.
  • name (str) – Name of the App Service plan.
  • vnet_name (str) – Name of the Virtual Network.
  • route_name (str) – Name of the Virtual Network route.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

list of VnetRoute

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

get_vnet_from_server_farm(resource_group_name, name, vnet_name, custom_headers=None, raw=False, **operation_config)[source]

Get a Virtual Network associated with an App Service plan.

Get a Virtual Network associated with an App Service plan.

Parameters:
  • resource_group_name (str) – Name of the resource group to which the resource belongs.
  • name (str) – Name of the App Service plan.
  • 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_configOperation configuration overrides.
Return type:

VnetInfo

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

get_vnet_gateway(resource_group_name, name, vnet_name, gateway_name, custom_headers=None, raw=False, **operation_config)[source]

Get a Virtual Network gateway.

Get a Virtual Network gateway.

Parameters:
  • resource_group_name (str) – Name of the resource group to which the resource belongs.
  • name (str) – Name of the App Service plan.
  • vnet_name (str) – Name of the Virtual Network.
  • gateway_name (str) – Name of the gateway. Only the ‘primary’ gateway is supported.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

VnetGateway

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

list(detailed=None, custom_headers=None, raw=False, **operation_config)[source]

Get all App Service plans for a subcription.

Get all App Service plans for a subcription.

Parameters:
  • detailed (bool) – Specify <code>true</code> to return all App Service plan properties. The default is <code>false</code>, which returns a subset of the properties. Retrieval of all properties may increase the API latency.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

AppServicePlanPaged

Raises:

CloudError

list_by_resource_group(resource_group_name, custom_headers=None, raw=False, **operation_config)[source]

Get all App Service plans in a resource group.

Get all App Service plans in a resource group.

Parameters:
  • resource_group_name (str) – Name of the resource group to which the resource belongs.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

AppServicePlanPaged

Raises:

CloudError

list_capabilities(resource_group_name, name, custom_headers=None, raw=False, **operation_config)[source]

List all capabilities of an App Service plan.

List all capabilities of an App Service plan.

Parameters:
  • resource_group_name (str) – Name of the resource group to which the resource belongs.
  • name (str) – Name of the App Service plan.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

list of Capability

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

list_hybrid_connection_keys(resource_group_name, name, namespace_name, relay_name, custom_headers=None, raw=False, **operation_config)[source]

Get the send key name and value of a Hybrid Connection.

Get the send key name and value of a Hybrid Connection.

Parameters:
  • resource_group_name (str) – Name of the resource group to which the resource belongs.
  • name (str) – Name of the App Service plan.
  • namespace_name (str) – The name of the Service Bus namespace.
  • relay_name (str) – The name of the Service Bus relay.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

HybridConnectionKey

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

list_hybrid_connections(resource_group_name, name, custom_headers=None, raw=False, **operation_config)[source]

Retrieve all Hybrid Connections in use in an App Service plan.

Retrieve all Hybrid Connections in use in an App Service plan.

Parameters:
  • resource_group_name (str) – Name of the resource group to which the resource belongs.
  • name (str) – Name of the App Service plan.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

HybridConnectionPaged

Raises:

CloudError

list_metric_defintions(resource_group_name, name, custom_headers=None, raw=False, **operation_config)[source]

Get metrics that can be queried for an App Service plan, and their definitions.

Get metrics that can be queried for an App Service plan, and their definitions.

Parameters:
  • resource_group_name (str) – Name of the resource group to which the resource belongs.
  • name (str) – Name of the App Service plan.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

ResourceMetricDefinitionPaged

Raises:

CloudError

list_metrics(resource_group_name, name, details=None, filter=None, custom_headers=None, raw=False, **operation_config)[source]

Get metrics for an App Serice plan.

Get metrics for an App Serice plan.

Parameters:
  • resource_group_name (str) – Name of the resource group to which the resource belongs.
  • name (str) – Name of the App Service plan.
  • details (bool) – Specify <code>true</code> to include instance details. The default is <code>false</code>.
  • filter (str) – Return only usages/metrics specified in the filter. Filter conforms to odata syntax. 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_configOperation configuration overrides.
Return type:

ResourceMetricPaged

Raises:

CloudError

list_routes_for_vnet(resource_group_name, name, vnet_name, custom_headers=None, raw=False, **operation_config)[source]

Get all routes that are associated with a Virtual Network in an App Service plan.

Get all routes that are associated with a Virtual Network in an App Service plan.

Parameters:
  • resource_group_name (str) – Name of the resource group to which the resource belongs.
  • name (str) – Name of the App Service plan.
  • 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_configOperation configuration overrides.
Return type:

list of VnetRoute

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

list_vnets(resource_group_name, name, custom_headers=None, raw=False, **operation_config)[source]

Get all Virtual Networks associated with an App Service plan.

Get all Virtual Networks associated with an App Service plan.

Parameters:
  • resource_group_name (str) – Name of the resource group to which the resource belongs.
  • name (str) – Name of the App Service plan.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

list of VnetInfo

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

list_web_apps(resource_group_name, name, skip_token=None, filter=None, top=None, custom_headers=None, raw=False, **operation_config)[source]

Get all apps associated with an App Service plan.

Get all apps associated with an App Service plan.

Parameters:
  • resource_group_name (str) – Name of the resource group to which the resource belongs.
  • name (str) – Name of the App Service plan.
  • skip_token (str) – Skip to a web app in the list of webapps associated with app service plan. If specified, the resulting list will contain web apps starting from (including) the skipToken. Otherwise, the resulting list contains web apps from the start of the list
  • filter (str) – Supported filter: $filter=state eq running. Returns only web apps that are currently running
  • top (str) – List page size. If specified, results are paged.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

SitePaged

Raises:

CloudError

list_web_apps_by_hybrid_connection(resource_group_name, name, namespace_name, relay_name, custom_headers=None, raw=False, **operation_config)[source]

Get all apps that use a Hybrid Connection in an App Service Plan.

Get all apps that use a Hybrid Connection in an App Service Plan.

Parameters:
  • resource_group_name (str) – Name of the resource group to which the resource belongs.
  • name (str) – Name of the App Service plan.
  • namespace_name (str) – Name of the Hybrid Connection namespace.
  • relay_name (str) – Name of the Hybrid Connection relay.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

StrPaged

Raises:

CloudError

reboot_worker(resource_group_name, name, worker_name, custom_headers=None, raw=False, **operation_config)[source]

Reboot a worker machine in an App Service plan.

Reboot a worker machine in an App Service plan.

Parameters:
  • resource_group_name (str) – Name of the resource group to which the resource belongs.
  • name (str) – Name of the App Service plan.
  • worker_name (str) – Name of worker machine, which typically starts with RD.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

None

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

restart_web_apps(resource_group_name, name, soft_restart=None, custom_headers=None, raw=False, **operation_config)[source]

Restart all apps in an App Service plan.

Restart all apps in an App Service plan.

Parameters:
  • resource_group_name (str) – Name of the resource group to which the resource belongs.
  • name (str) – Name of the App Service plan.
  • soft_restart (bool) – Specify <code>true</code> to performa a soft restart, applies the configuration settings and restarts the apps if necessary. The default is <code>false</code>, which always restarts and reprovisions the apps
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

None

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

update_vnet_gateway(resource_group_name, name, vnet_name, gateway_name, connection_envelope, custom_headers=None, raw=False, **operation_config)[source]

Update a Virtual Network gateway.

Update a Virtual Network gateway.

Parameters:
  • resource_group_name (str) – Name of the resource group to which the resource belongs.
  • name (str) – Name of the App Service plan.
  • vnet_name (str) – Name of the Virtual Network.
  • gateway_name (str) – Name of the gateway. Only the ‘primary’ gateway is supported.
  • connection_envelope (VnetGateway) – Definition of the gateway.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

VnetGateway

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

update_vnet_route(resource_group_name, name, vnet_name, route_name, route, custom_headers=None, raw=False, **operation_config)[source]

Create or update a Virtual Network route in an App Service plan.

Create or update a Virtual Network route in an App Service plan.

Parameters:
  • resource_group_name (str) – Name of the resource group to which the resource belongs.
  • name (str) – Name of the App Service plan.
  • vnet_name (str) – Name of the Virtual Network.
  • route_name (str) – Name of the Virtual Network route.
  • route (VnetRoute) – Definition of the Virtual Network route.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

VnetRoute

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

class azure.mgmt.web.operations.CertificatesOperations(client, config, serializer, deserializer)[source]

Bases: object

CertificatesOperations operations.

Parameters:
  • client – Client for service requests.
  • config – Configuration of service client.
  • serializer – An object model serializer.
  • deserializer – An objec model deserializer.
Variables:

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

create_or_update(resource_group_name, name, certificate_envelope, custom_headers=None, raw=False, **operation_config)[source]

Create or update a certificate.

Create or update a certificate.

Parameters:
  • resource_group_name (str) – Name of the resource group to which the resource belongs.
  • name (str) – Name of the certificate.
  • certificate_envelope (Certificate) – Details of certificate, if it exists already.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

Certificate

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

delete(resource_group_name, name, custom_headers=None, raw=False, **operation_config)[source]

Delete a certificate.

Delete a certificate.

Parameters:
  • resource_group_name (str) – Name of the resource group to which the resource belongs.
  • name (str) – Name of the certificate.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

None

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

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

Get a certificate.

Get a certificate.

Parameters:
  • resource_group_name (str) – Name of the resource group to which the resource belongs.
  • name (str) – Name of the certificate.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

Certificate

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

list(custom_headers=None, raw=False, **operation_config)[source]

Get all certificates for a subscription.

Get all certificates for a subscription.

Parameters:
Return type:

CertificatePaged

Raises:

CloudError

list_by_resource_group(resource_group_name, custom_headers=None, raw=False, **operation_config)[source]

Get all certificates in a resource group.

Get all certificates in a resource group.

Parameters:
  • resource_group_name (str) – Name of the resource group to which the resource belongs.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

CertificatePaged

Raises:

CloudError

update(resource_group_name, name, certificate_envelope, custom_headers=None, raw=False, **operation_config)[source]

Create or update a certificate.

Create or update a certificate.

Parameters:
  • resource_group_name (str) – Name of the resource group to which the resource belongs.
  • name (str) – Name of the certificate.
  • certificate_envelope (Certificate) – Details of certificate, if it exists already.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

Certificate

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

class azure.mgmt.web.operations.DomainsOperations(client, config, serializer, deserializer)[source]

Bases: object

DomainsOperations operations.

Parameters:
  • client – Client for service requests.
  • config – Configuration of service client.
  • serializer – An object model serializer.
  • deserializer – An objec model deserializer.
Variables:

api_version – API Version. Constant value: “2015-04-01”.

check_availability(name=None, custom_headers=None, raw=False, **operation_config)[source]

Check if a domain is available for registration.

Check if a domain is available for registration.

Parameters:
  • name (str) – Name of the object.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

DomainAvailablilityCheckResult

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

create_or_update(resource_group_name, domain_name, domain, custom_headers=None, raw=False, **operation_config)[source]

Creates or updates a domain.

Creates or updates a domain.

Parameters:
  • resource_group_name (str) – Name of the resource group to which the resource belongs.
  • domain_name (str) – Name of the domain.
  • domain (Domain) – Domain registration information.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
Return type:

AzureOperationPoller instance that returns Domain

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

create_or_update_ownership_identifier(resource_group_name, domain_name, name, domain_ownership_identifier, custom_headers=None, raw=False, **operation_config)[source]

Creates an ownership identifier for a domain or updates identifier details for an existing identifer.

Creates an ownership identifier for a domain or updates identifier details for an existing identifer.

Parameters:
  • resource_group_name (str) – Name of the resource group to which the resource belongs.
  • domain_name (str) – Name of domain.
  • name (str) – Name of identifier.
  • domain_ownership_identifier (DomainOwnershipIdentifier) – A JSON representation of the domain ownership properties.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

DomainOwnershipIdentifier

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

delete(resource_group_name, domain_name, force_hard_delete_domain=None, custom_headers=None, raw=False, **operation_config)[source]

Delete a domain.

Delete a domain.

Parameters:
  • resource_group_name (str) – Name of the resource group to which the resource belongs.
  • domain_name (str) – Name of the domain.
  • force_hard_delete_domain (bool) – Specify <code>true</code> to delete the domain immediately. The default is <code>false</code> which deletes the domain after 24 hours.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

None

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

delete_ownership_identifier(resource_group_name, domain_name, name, custom_headers=None, raw=False, **operation_config)[source]

Delete ownership identifier for domain.

Delete ownership identifier for domain.

Parameters:
  • resource_group_name (str) – Name of the resource group to which the resource belongs.
  • domain_name (str) – Name of domain.
  • name (str) – Name of identifier.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

None

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

get(resource_group_name, domain_name, custom_headers=None, raw=False, **operation_config)[source]

Get a domain.

Get a domain.

Parameters:
  • resource_group_name (str) – Name of the resource group to which the resource belongs.
  • domain_name (str) – Name of the domain.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

Domain

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

get_control_center_sso_request(custom_headers=None, raw=False, **operation_config)[source]

Generate a single sign-on request for the domain management portal.

Generate a single sign-on request for the domain management portal.

Parameters:
Return type:

DomainControlCenterSsoRequest

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

get_ownership_identifier(resource_group_name, domain_name, name, custom_headers=None, raw=False, **operation_config)[source]

Get ownership identifier for domain.

Get ownership identifier for domain.

Parameters:
  • resource_group_name (str) – Name of the resource group to which the resource belongs.
  • domain_name (str) – Name of domain.
  • name (str) – Name of identifier.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

DomainOwnershipIdentifier

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

list(custom_headers=None, raw=False, **operation_config)[source]

Get all domains in a subscription.

Get all domains in a subscription.

Parameters:
Return type:

DomainPaged

Raises:

CloudError

list_by_resource_group(resource_group_name, custom_headers=None, raw=False, **operation_config)[source]

Get all domains in a resource group.

Get all domains in a resource group.

Parameters:
  • resource_group_name (str) – Name of the resource group to which the resource belongs.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

DomainPaged

Raises:

CloudError

list_ownership_identifiers(resource_group_name, domain_name, custom_headers=None, raw=False, **operation_config)[source]

Lists domain ownership identifiers.

Lists domain ownership identifiers.

Parameters:
  • resource_group_name (str) – Name of the resource group to which the resource belongs.
  • domain_name (str) – Name of domain.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

DomainOwnershipIdentifierPaged

Raises:

CloudError

list_recommendations(keywords=None, max_domain_recommendations=None, custom_headers=None, raw=False, **operation_config)[source]

Get domain name recommendations based on keywords.

Get domain name recommendations based on keywords.

Parameters:
  • keywords (str) – Keywords to be used for generating domain recommendations.
  • max_domain_recommendations (int) – Maximum number of recommendations.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

NameIdentifierPaged

Raises:

CloudError

update_ownership_identifier(resource_group_name, domain_name, name, domain_ownership_identifier, custom_headers=None, raw=False, **operation_config)[source]

Creates an ownership identifier for a domain or updates identifier details for an existing identifer.

Creates an ownership identifier for a domain or updates identifier details for an existing identifer.

Parameters:
  • resource_group_name (str) – Name of the resource group to which the resource belongs.
  • domain_name (str) – Name of domain.
  • name (str) – Name of identifier.
  • domain_ownership_identifier (DomainOwnershipIdentifier) – A JSON representation of the domain ownership properties.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

DomainOwnershipIdentifier

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

class azure.mgmt.web.operations.RecommendationsOperations(client, config, serializer, deserializer)[source]

Bases: object

RecommendationsOperations operations.

Parameters:
  • client – Client for service requests.
  • config – Configuration of service client.
  • serializer – An object model serializer.
  • deserializer – An objec model deserializer.
Variables:

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

disable_all_for_web_app(resource_group_name, site_name, custom_headers=None, raw=False, **operation_config)[source]

Disable all recommendations for an app.

Disable all recommendations for an app.

Parameters:
  • resource_group_name (str) – Name of the resource group to which the resource belongs.
  • site_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_configOperation configuration overrides.
Return type:

None

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

get_rule_details_by_web_app(resource_group_name, site_name, name, update_seen=None, custom_headers=None, raw=False, **operation_config)[source]

Get a recommendation rule for an app.

Get a recommendation rule for an app.

Parameters:
  • resource_group_name (str) – Name of the resource group to which the resource belongs.
  • site_name (str) – Name of the app.
  • name (str) – Name of the recommendation.
  • update_seen (bool) – Specify <code>true</code> to update the last-seen timestamp of the recommendation object.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

RecommendationRule

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

list(featured=None, filter=None, custom_headers=None, raw=False, **operation_config)[source]

List all recommendations for a subscription.

List all recommendations for a subscription.

Parameters:
  • featured (bool) – Specify <code>true</code> to return only the most critical recommendations. The default is <code>false</code>, which returns all recommendations.
  • filter (str) – Filter is specified by using OData syntax. Example: $filter=channels eq ‘Api’ or channel eq ‘Notification’ and startTime eq ‘2014-01-01T00:00:00Z’ and endTime eq ‘2014-12-31T23:59:59Z’ and timeGrain eq duration’[PT1H|PT1M|P1D]
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

list of Recommendation

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

list_history_for_web_app(resource_group_name, site_name, filter=None, custom_headers=None, raw=False, **operation_config)[source]

Get past recommendations for an app, optionally specified by the time range.

Get past recommendations for an app, optionally specified by the time range.

Parameters:
  • resource_group_name (str) – Name of the resource group to which the resource belongs.
  • site_name (str) – Name of the app.
  • filter (str) – Filter is specified by using OData syntax. Example: $filter=channels eq ‘Api’ or channel eq ‘Notification’ and startTime eq ‘2014-01-01T00:00:00Z’ and endTime eq ‘2014-12-31T23:59:59Z’ and timeGrain eq duration’[PT1H|PT1M|P1D]
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

list of Recommendation

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

Get all recommendations for an app.

Get all recommendations for an app.

Parameters:
  • resource_group_name (str) – Name of the resource group to which the resource belongs.
  • site_name (str) – Name of the app.
  • featured (bool) – Specify <code>true</code> to return only the most critical recommendations. The default is <code>false</code>, which returns all recommendations.
  • filter (str) – Return only channels specified in the filter. Filter is specified by using OData syntax. Example: $filter=channels eq ‘Api’ or channel eq ‘Notification’
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

list of Recommendation

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

reset_all_filters(custom_headers=None, raw=False, **operation_config)[source]

Reset all recommendation opt-out settings for a subscription.

Reset all recommendation opt-out settings for a subscription.

Parameters:
Return type:

None

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

reset_all_filters_for_web_app(resource_group_name, site_name, custom_headers=None, raw=False, **operation_config)[source]

Reset all recommendation opt-out settings for an app.

Reset all recommendation opt-out settings for an app.

Parameters:
  • resource_group_name (str) – Name of the resource group to which the resource belongs.
  • site_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_configOperation configuration overrides.
Return type:

None

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

class azure.mgmt.web.operations.TopLevelDomainsOperations(client, config, serializer, deserializer)[source]

Bases: object

TopLevelDomainsOperations operations.

Parameters:
  • client – Client for service requests.
  • config – Configuration of service client.
  • serializer – An object model serializer.
  • deserializer – An objec model deserializer.
Variables:

api_version – API Version. Constant value: “2015-04-01”.

get(name, custom_headers=None, raw=False, **operation_config)[source]

Get details of a top-level domain.

Get details of a top-level domain.

Parameters:
  • name (str) – Name of the top-level domain.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

TopLevelDomain

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

list(custom_headers=None, raw=False, **operation_config)[source]

Get all top-level domains supported for registration.

Get all top-level domains supported for registration.

Parameters:
Return type:

TopLevelDomainPaged

Raises:

CloudError

list_agreements(name, include_privacy=None, for_transfer=None, custom_headers=None, raw=False, **operation_config)[source]

Gets all legal agreements that user needs to accept before purchasing a domain.

Gets all legal agreements that user needs to accept before purchasing a domain.

Parameters:
  • name (str) – Name of the top-level domain.
  • include_privacy (bool) – If <code>true</code>, then the list of agreements will include agreements for domain privacy as well; otherwise, <code>false</code>.
  • for_transfer (bool) – If <code>true</code>, then the list of agreements will include agreements for domain transfer as well; 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_configOperation configuration overrides.
Return type:

TldLegalAgreementPaged

Raises:

CloudError

class azure.mgmt.web.operations.WebAppsOperations(client, config, serializer, deserializer)[source]

Bases: object

WebAppsOperations operations.

Parameters:
  • client – Client for service requests.
  • config – Configuration of service client.
  • serializer – An object model serializer.
  • deserializer – An objec 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)[source]

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_configOperation configuration overrides.
Return type:

PremierAddOn

Return type:

ClientRawResponse if raw=true

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)[source]

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_configOperation configuration overrides.
Return type:

PremierAddOn

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

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

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_configOperation configuration overrides.
Return type:

CustomHostnameAnalysisResult

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

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

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_configOperation configuration overrides.
Return type:

CustomHostnameAnalysisResult

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

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

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_configOperation configuration overrides.
Return type:

None

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

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

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_configOperation configuration overrides.
Return type:

None

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

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

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_configOperation configuration overrides.
Return type:

BackupItem

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

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

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_configOperation configuration overrides.
Return type:

BackupItem

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

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

Create a deployment for an app, a specific deployment slot, and/or a specific scaled-out instance.

Create a deployment for an app, a specific deployment slot, and/or a specific scaled-out instance.

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_configOperation configuration overrides.
Return type:

Deployment

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

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

Create a deployment for an app, a specific deployment slot, and/or a specific scaled-out instance.

Create a deployment for an app, a specific deployment slot, and/or a specific scaled-out instance.

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_configOperation configuration overrides.
Return type:

Deployment

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

create_instance_deployment(resource_group_name, name, id, instance_id, deployment, custom_headers=None, raw=False, **operation_config)[source]

Create a deployment for an app, a specific deployment slot, and/or a specific scaled-out instance.

Create a deployment for an app, a specific deployment slot, and/or a specific scaled-out instance.

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.
  • 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”
  • 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_configOperation configuration overrides.
Return type:

Deployment

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

create_instance_deployment_slot(resource_group_name, name, id, slot, instance_id, deployment, custom_headers=None, raw=False, **operation_config)[source]

Create a deployment for an app, a specific deployment slot, and/or a specific scaled-out instance.

Create a deployment for an app, a specific deployment slot, and/or a specific scaled-out instance.

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.
  • 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”
  • 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_configOperation configuration overrides.
Return type:

Deployment

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

create_or_update(resource_group_name, name, site_envelope, skip_dns_registration=None, skip_custom_domain_verification=None, force_dns_registration=None, ttl_in_seconds=None, custom_headers=None, raw=False, **operation_config)[source]

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.
  • 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
Return type:

AzureOperationPoller instance that returns Site

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

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

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_configOperation configuration overrides.
Return type:

SiteConfigResource

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

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

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_configOperation configuration overrides.
Return type:

SiteConfigResource

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

create_or_update_domain_ownership_identifier(resource_group_name, name, domain_ownership_identifier_name, domain_ownership_identifier, custom_headers=None, raw=False, **operation_config)[source]

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.
  • domain_ownership_identifier (Identifier) – A JSON representation of the domain ownership properties.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

Identifier

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

create_or_update_domain_ownership_identifier_slot(resource_group_name, name, domain_ownership_identifier_name, domain_ownership_identifier, slot, custom_headers=None, raw=False, **operation_config)[source]

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.
  • domain_ownership_identifier (Identifier) – A JSON representation of the domain ownership properties.
  • 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_configOperation configuration overrides.
Return type:

Identifier

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

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

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_configOperation configuration overrides.
Return type:

HostNameBinding

Return type:

ClientRawResponse if raw=true

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)[source]

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_configOperation configuration overrides.
Return type:

HostNameBinding

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

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

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_configOperation configuration overrides.
Return type:

HybridConnection

Return type:

ClientRawResponse if raw=true

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)[source]

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_configOperation configuration overrides.
Return type:

HybridConnection

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

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

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_configOperation configuration overrides.
Return type:

RelayServiceConnectionEntity

Return type:

ClientRawResponse if raw=true

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)[source]

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_configOperation configuration overrides.
Return type:

RelayServiceConnectionEntity

Return type:

ClientRawResponse if raw=true

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, **operation_config)[source]

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) – returns the direct response alongside the deserialized response
Return type:

AzureOperationPoller instance that returns Site

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

create_or_update_source_control(resource_group_name, name, site_source_control, custom_headers=None, raw=False, **operation_config)[source]

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
Return type:

AzureOperationPoller instance that returns SiteSourceControl

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

create_or_update_source_control_slot(resource_group_name, name, site_source_control, slot, custom_headers=None, raw=False, **operation_config)[source]

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
Return type:

AzureOperationPoller instance that returns SiteSourceControl

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

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

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_configOperation configuration overrides.
Return type:

VnetInfo

Return type:

ClientRawResponse if raw=true

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)[source]

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_configOperation configuration overrides.
Return type:

VnetGateway

Return type:

ClientRawResponse if raw=true

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)[source]

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_configOperation configuration overrides.
Return type:

VnetGateway

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

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

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_configOperation configuration overrides.
Return type:

VnetInfo

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

delete(resource_group_name, name, delete_metrics=None, delete_empty_server_farm=None, skip_dns_registration=None, custom_headers=None, raw=False, **operation_config)[source]

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 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_configOperation configuration overrides.
Return type:

None

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

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

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_configOperation configuration overrides.
Return type:

None

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

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

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_configOperation configuration overrides.
Return type:

None

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

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

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_configOperation configuration overrides.
Return type:

None

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

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

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_configOperation configuration overrides.
Return type:

None

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

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

Delete a deployment by its ID for an app, a specific deployment slot, and/or a specific scaled-out instance.

Delete a deployment by its ID for an app, a specific deployment slot, and/or a specific scaled-out instance.

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_configOperation configuration overrides.
Return type:

None

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

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

Delete a deployment by its ID for an app, a specific deployment slot, and/or a specific scaled-out instance.

Delete a deployment by its ID for an app, a specific deployment slot, and/or a specific scaled-out instance.

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_configOperation configuration overrides.
Return type:

None

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

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

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_configOperation configuration overrides.
Return type:

None

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

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

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_configOperation configuration overrides.
Return type:

None

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

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

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_configOperation configuration overrides.
Return type:

None

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

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

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_configOperation configuration overrides.
Return type:

None

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

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

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_configOperation configuration overrides.
Return type:

None

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

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

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_configOperation configuration overrides.
Return type:

None

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

delete_instance_deployment(resource_group_name, name, id, instance_id, custom_headers=None, raw=False, **operation_config)[source]

Delete a deployment by its ID for an app, a specific deployment slot, and/or a specific scaled-out instance.

Delete a deployment by its ID for an app, a specific deployment slot, and/or a specific scaled-out instance.

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.
  • 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_configOperation configuration overrides.
Return type:

None

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

delete_instance_deployment_slot(resource_group_name, name, id, slot, instance_id, custom_headers=None, raw=False, **operation_config)[source]

Delete a deployment by its ID for an app, a specific deployment slot, and/or a specific scaled-out instance.

Delete a deployment by its ID for an app, a specific deployment slot, and/or a specific scaled-out instance.

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.
  • 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_configOperation configuration overrides.
Return type:

None

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

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

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_configOperation configuration overrides.
Return type:

None

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

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

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_configOperation configuration overrides.
Return type:

None

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

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

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_configOperation configuration overrides.
Return type:

None

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

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

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_configOperation configuration overrides.
Return type:

None

Return type:

ClientRawResponse if raw=true

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)[source]

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_configOperation configuration overrides.
Return type:

None

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

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

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_configOperation configuration overrides.
Return type:

None

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

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

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_configOperation configuration overrides.
Return type:

None

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

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

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_configOperation configuration overrides.
Return type:

None

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

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

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_configOperation configuration overrides.
Return type:

None

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

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

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_configOperation configuration overrides.
Return type:

RestoreRequest

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

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

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_configOperation configuration overrides.
Return type:

RestoreRequest

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

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

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_configOperation configuration overrides.
Return type:

None

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

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

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_configOperation configuration overrides.
Return type:

None

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

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

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_configOperation configuration overrides.
Return type:

Site

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

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

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_configOperation configuration overrides.
Return type:

SiteAuthSettings

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

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

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_configOperation configuration overrides.
Return type:

SiteAuthSettings

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

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

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_configOperation configuration overrides.
Return type:

BackupRequest

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

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

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_configOperation configuration overrides.
Return type:

BackupRequest

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

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

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_configOperation configuration overrides.
Return type:

BackupItem

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

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

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_configOperation configuration overrides.
Return type:

BackupItem

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

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

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_configOperation configuration overrides.
Return type:

SiteConfigResource

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

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

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_configOperation configuration overrides.
Return type:

SiteConfigResource

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

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

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_configOperation configuration overrides.
Return type:

SiteConfigResource

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

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

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_configOperation configuration overrides.
Return type:

SiteConfigResource

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

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

Get a deployment by its ID for an app, a specific deployment slot, and/or a specific scaled-out instance.

Get a deployment by its ID for an app, a specific deployment slot, and/or a specific scaled-out instance.

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_configOperation configuration overrides.
Return type:

Deployment

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

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

Get a deployment by its ID for an app, a specific deployment slot, and/or a specific scaled-out instance.

Get a deployment by its ID for an app, a specific deployment slot, and/or a specific scaled-out instance.

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_configOperation configuration overrides.
Return type:

Deployment

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

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

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_configOperation configuration overrides.
Return type:

SiteLogsConfig

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

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

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_configOperation configuration overrides.
Return type:

SiteLogsConfig

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

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

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_configOperation configuration overrides.
Return type:

Identifier

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

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

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_configOperation configuration overrides.
Return type:

Identifier

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

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

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_configOperation configuration overrides.
Return type:

HostNameBinding

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

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

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_configOperation configuration overrides.
Return type:

HostNameBinding

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

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

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_configOperation configuration overrides.
Return type:

HybridConnection

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

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

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_configOperation configuration overrides.
Return type:

HybridConnection

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

get_instance_deployment(resource_group_name, name, id, instance_id, custom_headers=None, raw=False, **operation_config)[source]

Get a deployment by its ID for an app, a specific deployment slot, and/or a specific scaled-out instance.

Get a deployment by its ID for an app, a specific deployment slot, and/or a specific scaled-out instance.

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.
  • 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_configOperation configuration overrides.
Return type:

Deployment

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

get_instance_deployment_slot(resource_group_name, name, id, slot, instance_id, custom_headers=None, raw=False, **operation_config)[source]

Get a deployment by its ID for an app, a specific deployment slot, and/or a specific scaled-out instance.

Get a deployment by its ID for an app, a specific deployment slot, and/or a specific scaled-out instance.

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.
  • 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_configOperation configuration overrides.
Return type:

Deployment

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

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

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_configOperation configuration overrides.
Return type:

MigrateMySqlStatus

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

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

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_configOperation configuration overrides.
Return type:

MigrateMySqlStatus

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

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

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_configOperation configuration overrides.
Return type:

PremierAddOn

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

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

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_configOperation configuration overrides.
Return type:

PremierAddOn

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

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

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_configOperation configuration overrides.
Return type:

RelayServiceConnectionEntity

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

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

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_configOperation configuration overrides.
Return type:

RelayServiceConnectionEntity

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

get_resource_health_metadata(resource_group_name, name, custom_headers=None, raw=False, **operation_config)[source]

Gets the category of ResourceHealthMetadata to use for the given site.

Gets the category of ResourceHealthMetadata to use 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
  • operation_configOperation configuration overrides.
Return type:

ResourceHealthMetadata

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

get_resource_health_metadata_slot(resource_group_name, name, slot, custom_headers=None, raw=False, **operation_config)[source]

Gets the category of ResourceHealthMetadata to use for the given site.

Gets the category of ResourceHealthMetadata to use 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
  • operation_configOperation configuration overrides.
Return type:

ResourceHealthMetadata

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

get_site_php_error_log_flag(resource_group_name, name, custom_headers=None, raw=False, **operation_config)[source]

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_configOperation configuration overrides.
Return type:

SitePhpErrorLogFlag

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

get_site_php_error_log_flag_slot(resource_group_name, name, slot, custom_headers=None, raw=False, **operation_config)[source]

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_configOperation configuration overrides.
Return type:

SitePhpErrorLogFlag

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

get_slot(resource_group_name, name, slot, custom_headers=None, raw=False, **operation_config)[source]

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_configOperation configuration overrides.
Return type:

Site

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

get_source_control(resource_group_name, name, custom_headers=None, raw=False, **operation_config)[source]

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_configOperation configuration overrides.
Return type:

SiteSourceControl

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

get_source_control_slot(resource_group_name, name, slot, custom_headers=None, raw=False, **operation_config)[source]

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_configOperation configuration overrides.
Return type:

SiteSourceControl

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

get_vnet_connection(resource_group_name, name, vnet_name, custom_headers=None, raw=False, **operation_config)[source]

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_configOperation configuration overrides.
Return type:

VnetInfo

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

get_vnet_connection_gateway(resource_group_name, name, vnet_name, gateway_name, custom_headers=None, raw=False, **operation_config)[source]

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_configOperation configuration overrides.
Return type:

VnetGateway

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

get_vnet_connection_gateway_slot(resource_group_name, name, vnet_name, gateway_name, slot, custom_headers=None, raw=False, **operation_config)[source]

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_configOperation configuration overrides.
Return type:

VnetGateway

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

get_vnet_connection_slot(resource_group_name, name, vnet_name, slot, custom_headers=None, raw=False, **operation_config)[source]

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_configOperation configuration overrides.
Return type:

VnetInfo

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

is_cloneable(resource_group_name, name, custom_headers=None, raw=False, **operation_config)[source]

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_configOperation configuration overrides.
Return type:

SiteCloneability

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

is_cloneable_slot(resource_group_name, name, slot, custom_headers=None, raw=False, **operation_config)[source]

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_configOperation configuration overrides.
Return type:

SiteCloneability

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

list(custom_headers=None, raw=False, **operation_config)[source]

Get all apps for a subscription.

Get all apps for a subscription.

Parameters:
Return type:

SitePaged

Raises:

CloudError

list_application_settings(resource_group_name, name, custom_headers=None, raw=False, **operation_config)[source]

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_configOperation configuration overrides.
Return type:

StringDictionary

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

list_application_settings_slot(resource_group_name, name, slot, custom_headers=None, raw=False, **operation_config)[source]

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_configOperation configuration overrides.
Return type:

StringDictionary

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

list_backup_status_secrets(resource_group_name, name, backup_id, request, custom_headers=None, raw=False, **operation_config)[source]

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_configOperation configuration overrides.
Return type:

BackupItem

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

list_backup_status_secrets_slot(resource_group_name, name, backup_id, request, slot, custom_headers=None, raw=False, **operation_config)[source]

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_configOperation configuration overrides.
Return type:

BackupItem

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

list_backups(resource_group_name, name, custom_headers=None, raw=False, **operation_config)[source]

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_configOperation configuration overrides.
Return type:

BackupItemPaged

Raises:

CloudError

list_backups_slot(resource_group_name, name, slot, custom_headers=None, raw=False, **operation_config)[source]

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_configOperation configuration overrides.
Return type:

BackupItemPaged

Raises:

CloudError

list_by_resource_group(resource_group_name, include_slots=None, custom_headers=None, raw=False, **operation_config)[source]

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_configOperation configuration overrides.
Return type:

SitePaged

Raises:

CloudError

list_configuration_snapshot_info(resource_group_name, name, custom_headers=None, raw=False, **operation_config)[source]

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_configOperation configuration overrides.
Return type:

list of SiteConfigurationSnapshotInfo

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

list_configuration_snapshot_info_slot(resource_group_name, name, slot, custom_headers=None, raw=False, **operation_config)[source]

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_configOperation configuration overrides.
Return type:

list of SiteConfigurationSnapshotInfo

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

list_configurations(resource_group_name, name, custom_headers=None, raw=False, **operation_config)[source]

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_configOperation configuration overrides.
Return type:

SiteConfigResourcePaged

Raises:

CloudError

list_configurations_slot(resource_group_name, name, slot, custom_headers=None, raw=False, **operation_config)[source]

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_configOperation configuration overrides.
Return type:

SiteConfigResourcePaged

Raises:

CloudError

list_connection_strings(resource_group_name, name, custom_headers=None, raw=False, **operation_config)[source]

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_configOperation configuration overrides.
Return type:

ConnectionStringDictionary

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

list_connection_strings_slot(resource_group_name, name, slot, custom_headers=None, raw=False, **operation_config)[source]

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_configOperation configuration overrides.
Return type:

ConnectionStringDictionary

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

list_deployments(resource_group_name, name, custom_headers=None, raw=False, **operation_config)[source]

List deployments for an app, or a deployment slot, or for an instance of a scaled-out app.

List deployments for an app, or a deployment slot, or for an instance of a scaled-out 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_configOperation configuration overrides.
Return type:

DeploymentPaged

Raises:

CloudError

list_deployments_slot(resource_group_name, name, slot, custom_headers=None, raw=False, **operation_config)[source]

List deployments for an app, or a deployment slot, or for an instance of a scaled-out app.

List deployments for an app, or a deployment slot, or for an instance of a scaled-out 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 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_configOperation configuration overrides.
Return type:

DeploymentPaged

Raises:

CloudError

list_domain_ownership_identifiers(resource_group_name, name, custom_headers=None, raw=False, **operation_config)[source]

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_configOperation configuration overrides.
Return type:

IdentifierPaged

Raises:

CloudError

list_domain_ownership_identifiers_slot(resource_group_name, name, slot, custom_headers=None, raw=False, **operation_config)[source]

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_configOperation configuration overrides.
Return type:

IdentifierPaged

Raises:

CloudError

list_host_name_bindings(resource_group_name, name, custom_headers=None, raw=False, **operation_config)[source]

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_configOperation configuration overrides.
Return type:

HostNameBindingPaged

Raises:

CloudError

list_host_name_bindings_slot(resource_group_name, name, slot, custom_headers=None, raw=False, **operation_config)[source]

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_configOperation configuration overrides.
Return type:

HostNameBindingPaged

Raises:

CloudError

list_hybrid_connection_keys(resource_group_name, name, namespace_name, relay_name, custom_headers=None, raw=False, **operation_config)[source]

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_configOperation configuration overrides.
Return type:

HybridConnectionKey

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

list_hybrid_connection_keys_slot(resource_group_name, name, namespace_name, relay_name, slot, custom_headers=None, raw=False, **operation_config)[source]

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_configOperation configuration overrides.
Return type:

HybridConnectionKey

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

list_hybrid_connections(resource_group_name, name, custom_headers=None, raw=False, **operation_config)[source]

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_configOperation configuration overrides.
Return type:

HybridConnection

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

list_hybrid_connections_slot(resource_group_name, name, slot, custom_headers=None, raw=False, **operation_config)[source]

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_configOperation configuration overrides.
Return type:

HybridConnection

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

list_instance_deployments(resource_group_name, name, instance_id, custom_headers=None, raw=False, **operation_config)[source]

List deployments for an app, or a deployment slot, or for an instance of a scaled-out app.

List deployments for an app, or a deployment slot, or for an instance of a scaled-out app.

Parameters:
  • resource_group_name (str) – Name of the resource group to which the resource belongs.
  • name (str) – Name of the app.
  • instance_id (str) – The 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_configOperation configuration overrides.
Return type:

DeploymentPaged

Raises:

CloudError

list_instance_deployments_slot(resource_group_name, name, slot, instance_id, custom_headers=None, raw=False, **operation_config)[source]

List deployments for an app, or a deployment slot, or for an instance of a scaled-out app.

List deployments for an app, or a deployment slot, or for an instance of a scaled-out 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 returns deployments for the production slot.
  • instance_id (str) – The 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_configOperation configuration overrides.
Return type:

DeploymentPaged

Raises:

CloudError

list_instance_identifiers(resource_group_name, name, custom_headers=None, raw=False, **operation_config)[source]

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_configOperation configuration overrides.
Return type:

SiteInstancePaged

Raises:

CloudError

list_instance_identifiers_slot(resource_group_name, name, slot, custom_headers=None, raw=False, **operation_config)[source]

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_configOperation configuration overrides.
Return type:

SiteInstancePaged

Raises:

CloudError

list_metadata(resource_group_name, name, custom_headers=None, raw=False, **operation_config)[source]

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_configOperation configuration overrides.
Return type:

StringDictionary

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

list_metadata_slot(resource_group_name, name, slot, custom_headers=None, raw=False, **operation_config)[source]

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_configOperation configuration overrides.
Return type:

StringDictionary

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

list_metric_definitions(resource_group_name, name, custom_headers=None, raw=False, **operation_config)[source]

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_configOperation configuration overrides.
Return type:

ResourceMetricDefinitionPaged

Raises:

CloudError

list_metric_definitions_slot(resource_group_name, name, slot, custom_headers=None, raw=False, **operation_config)[source]

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_configOperation configuration overrides.
Return type:

ResourceMetricDefinitionPaged

Raises:

CloudError

list_metrics(resource_group_name, name, details=None, filter=None, custom_headers=None, raw=False, **operation_config)[source]

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_configOperation configuration overrides.
Return type:

ResourceMetricPaged

Raises:

CloudError

list_metrics_slot(resource_group_name, name, slot, details=None, filter=None, custom_headers=None, raw=False, **operation_config)[source]

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_configOperation configuration overrides.
Return type:

ResourceMetricPaged

Raises:

CloudError

list_network_features(resource_group_name, name, view, custom_headers=None, raw=False, **operation_config)[source]

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_configOperation configuration overrides.
Return type:

NetworkFeatures

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

list_network_features_slot(resource_group_name, name, view, slot, custom_headers=None, raw=False, **operation_config)[source]

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_configOperation configuration overrides.
Return type:

NetworkFeatures

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

list_perf_mon_counters(resource_group_name, name, filter=None, custom_headers=None, raw=False, **operation_config)[source]

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_configOperation configuration overrides.
Return type:

PerfMonResponsePaged

Raises:

CloudError

list_perf_mon_counters_slot(resource_group_name, name, slot, filter=None, custom_headers=None, raw=False, **operation_config)[source]

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. **** CURRENTLY UNUSED *
  • 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_configOperation configuration overrides.
Return type:

PerfMonResponsePaged

Raises:

CloudError

list_premier_add_ons(resource_group_name, name, custom_headers=None, raw=False, **operation_config)[source]

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_configOperation configuration overrides.
Return type:

PremierAddOn

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

list_premier_add_ons_slot(resource_group_name, name, slot, custom_headers=None, raw=False, **operation_config)[source]

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_configOperation configuration overrides.
Return type:

PremierAddOn

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

list_publishing_credentials(resource_group_name, name, custom_headers=None, raw=False, **operation_config)[source]

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) – returns the direct response alongside the deserialized response
Return type:

AzureOperationPoller instance that returns User

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

list_publishing_credentials_slot(resource_group_name, name, slot, custom_headers=None, raw=False, **operation_config)[source]

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) – returns the direct response alongside the deserialized response
Return type:

AzureOperationPoller instance that returns User

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

list_publishing_profile_xml_with_secrets(resource_group_name, name, format=None, custom_headers=None, raw=False, callback=None, **operation_config)[source]

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_configOperation configuration overrides.
Return type:

Generator

Return type:

ClientRawResponse if raw=true

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)[source]

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_configOperation configuration overrides.
Return type:

Generator

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

list_relay_service_connections(resource_group_name, name, custom_headers=None, raw=False, **operation_config)[source]

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_configOperation configuration overrides.
Return type:

RelayServiceConnectionEntity

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

list_relay_service_connections_slot(resource_group_name, name, slot, custom_headers=None, raw=False, **operation_config)[source]

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_configOperation configuration overrides.
Return type:

RelayServiceConnectionEntity

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

list_site_push_settings(resource_group_name, name, custom_headers=None, raw=False, **operation_config)[source]

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_configOperation configuration overrides.
Return type:

PushSettings

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

list_site_push_settings_slot(resource_group_name, name, slot, custom_headers=None, raw=False, **operation_config)[source]

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_configOperation configuration overrides.
Return type:

PushSettings

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

list_slot_configuration_names(resource_group_name, name, custom_headers=None, raw=False, **operation_config)[source]

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_configOperation configuration overrides.
Return type:

SlotConfigNamesResource

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

list_slot_differences_from_production(resource_group_name, name, target_slot, preserve_vnet, custom_headers=None, raw=False, **operation_config)[source]

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_configOperation configuration overrides.
Return type:

SlotDifferencePaged

Raises:

CloudError

list_slot_differences_slot(resource_group_name, name, slot, target_slot, preserve_vnet, custom_headers=None, raw=False, **operation_config)[source]

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_configOperation configuration overrides.
Return type:

SlotDifferencePaged

Raises:

CloudError

list_slots(resource_group_name, name, custom_headers=None, raw=False, **operation_config)[source]

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_configOperation configuration overrides.
Return type:

SitePaged

Raises:

CloudError

list_snapshots(resource_group_name, name, custom_headers=None, raw=False, **operation_config)[source]

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_configOperation configuration overrides.
Return type:

SnapshotPaged

Raises:

CloudError

list_snapshots_slot(resource_group_name, name, slot, custom_headers=None, raw=False, **operation_config)[source]

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_configOperation configuration overrides.
Return type:

SnapshotPaged

Raises:

CloudError

list_usages(resource_group_name, name, filter=None, custom_headers=None, raw=False, **operation_config)[source]

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_configOperation configuration overrides.
Return type:

CsmUsageQuotaPaged

Raises:

CloudError

list_usages_slot(resource_group_name, name, slot, filter=None, custom_headers=None, raw=False, **operation_config)[source]

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_configOperation configuration overrides.
Return type:

CsmUsageQuotaPaged

Raises:

CloudError

list_vnet_connections(resource_group_name, name, custom_headers=None, raw=False, **operation_config)[source]

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_configOperation configuration overrides.
Return type:

list of VnetInfo

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

list_vnet_connections_slot(resource_group_name, name, slot, custom_headers=None, raw=False, **operation_config)[source]

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_configOperation configuration overrides.
Return type:

list of VnetInfo

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

migrate_my_sql(resource_group_name, name, migration_request_envelope, custom_headers=None, raw=False, **operation_config)[source]

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) – returns the direct response alongside the deserialized response
Return type:

AzureOperationPoller instance that returns Operation

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

migrate_storage(subscription_name, resource_group_name, name, migration_options, custom_headers=None, raw=False, **operation_config)[source]

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) – returns the direct response alongside the deserialized response
Return type:

AzureOperationPoller instance that returns StorageMigrationResponse

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

recover(resource_group_name, name, recovery_entity, custom_headers=None, raw=False, **operation_config)[source]

Recovers a deleted web app.

Recovers a deleted web app.

Parameters:
  • resource_group_name (str) – Name of the resource group to which the resource belongs.
  • name (str) – Name of web app
  • recovery_entity (CsmSiteRecoveryEntity) – 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) – returns the direct response alongside the deserialized response
Return type:

AzureOperationPoller instance that returns RecoverResponse

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

recover_site_configuration_snapshot(resource_group_name, name, snapshot_id, custom_headers=None, raw=False, **operation_config)[source]

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_configOperation configuration overrides.
Return type:

None

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

recover_site_configuration_snapshot_slot(resource_group_name, name, snapshot_id, slot, custom_headers=None, raw=False, **operation_config)[source]

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_configOperation configuration overrides.
Return type:

None

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

recover_slot(resource_group_name, name, recovery_entity, slot, custom_headers=None, raw=False, **operation_config)[source]

Recovers a deleted web app.

Recovers a deleted web app.

Parameters:
  • resource_group_name (str) – Name of the resource group to which the resource belongs.
  • name (str) – Name of web app
  • recovery_entity (CsmSiteRecoveryEntity) – 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) – returns the direct response alongside the deserialized response
Return type:

AzureOperationPoller instance that returns RecoverResponse

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

reset_production_slot_config(resource_group_name, name, custom_headers=None, raw=False, **operation_config)[source]

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_configOperation configuration overrides.
Return type:

None

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

reset_slot_configuration_slot(resource_group_name, name, slot, custom_headers=None, raw=False, **operation_config)[source]

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_configOperation configuration overrides.
Return type:

None

Return type:

ClientRawResponse if raw=true

Raises: