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 object model deserializer.
Variables: api_version – API Version. Constant value: “2018-02-01”.
-
create_or_update
(resource_group_name, certificate_order_name, certificate_distinguished_name, custom_headers=None, raw=False, polling=True, **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) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
- polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
Returns: An instance of LROPoller that returns AppServiceCertificateOrder or ClientRawResponse<AppServiceCertificateOrder> if raw==True
Return type: AzureOperationPoller[AppServiceCertificateOrder] or AzureOperationPoller[ClientRawResponse[AppServiceCertificateOrder]]
Raises:
-
create_or_update_certificate
(resource_group_name, certificate_order_name, name, key_vault_certificate, custom_headers=None, raw=False, polling=True, **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) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
- polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
Returns: An instance of LROPoller that returns AppServiceCertificateResource or ClientRawResponse<AppServiceCertificateResource> if raw==True
Return type: AzureOperationPoller[AppServiceCertificateResource] or AzureOperationPoller[ClientRawResponse[AppServiceCertificateResource]]
Raises:
-
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_config – Operation configuration overrides.
Returns: None or ClientRawResponse if raw=true
Return type: None or ClientRawResponse
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_config – Operation configuration overrides.
Returns: None or ClientRawResponse if raw=true
Return type: None or ClientRawResponse
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_config – Operation configuration overrides.
Returns: AppServiceCertificateOrder or ClientRawResponse if raw=true
Return type: AppServiceCertificateOrder or ClientRawResponse
Raises:
-
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_config – Operation configuration overrides.
Returns: AppServiceCertificateResource or ClientRawResponse if raw=true
Return type: AppServiceCertificateResource or ClientRawResponse
Raises:
-
list
(custom_headers=None, raw=False, **operation_config)[source]¶ List all certificate orders in a subscription.
List all certificate orders in a subscription.
Parameters: - custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: An iterator like instance of AppServiceCertificateOrder
Return type: Raises:
-
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_config – Operation configuration overrides.
Returns: An iterator like instance of AppServiceCertificateOrder
Return type: Raises:
-
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_config – Operation configuration overrides.
Returns: An iterator like instance of AppServiceCertificateResource
Return type: AppServiceCertificateResourcePaged[AppServiceCertificateResource]
Raises:
-
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_config – Operation configuration overrides.
Returns: None or ClientRawResponse if raw=true
Return type: None or ClientRawResponse
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_config – Operation configuration overrides.
Returns: None or ClientRawResponse if raw=true
Return type: None or ClientRawResponse
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_config – Operation configuration overrides.
Returns: None or ClientRawResponse if raw=true
Return type: None or ClientRawResponse
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_config – Operation configuration overrides.
Returns: None or ClientRawResponse if raw=true
Return type: None or ClientRawResponse
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_config – Operation configuration overrides.
Returns: list or ClientRawResponse if raw=true
Return type: list[CertificateOrderAction] or ClientRawResponse
Raises:
-
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_config – Operation configuration overrides.
Returns: list or ClientRawResponse if raw=true
Return type: list[CertificateEmail] or ClientRawResponse
Raises:
-
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) – If <code>true</code> use the light color theme for site seal; otherwise, use the default color theme.
- locale (str) – Locale of site seal.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: SiteSeal or ClientRawResponse if raw=true
Return type: SiteSeal or ClientRawResponse
Raises:
-
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 (AppServiceCertificateOrderPatchResource) – 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
- operation_config – Operation configuration overrides.
Returns: AppServiceCertificateOrder or ClientRawResponse if raw=true
Return type: AppServiceCertificateOrder or ClientRawResponse
Raises:
-
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 (AppServiceCertificatePatchResource) – 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
- operation_config – Operation configuration overrides.
Returns: AppServiceCertificateResource or ClientRawResponse if raw=true
Return type: AppServiceCertificateResource or ClientRawResponse
Raises:
-
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: - app_service_certificate_order (AppServiceCertificateOrder) – Information for a certificate order.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: None or ClientRawResponse if raw=true
Return type: None or ClientRawResponse
Raises: CloudError
-
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_config – Operation configuration overrides.
Returns: None or ClientRawResponse if raw=true
Return type: None or ClientRawResponse
Raises: CloudError
-
models
= <module 'azure.mgmt.web.models' from '/usr/lib/python3/dist-packages/azure/mgmt/web/models/__init__.py'>¶
-
class
azure.mgmt.web.operations.
CertificateRegistrationProviderOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
CertificateRegistrationProviderOperations operations.
Parameters: - client – Client for service requests.
- config – Configuration of service client.
- serializer – An object model serializer.
- deserializer – An object model deserializer.
Variables: api_version – API Version. Constant value: “2018-02-01”.
-
list_operations
(custom_headers=None, raw=False, **operation_config)[source]¶ Implements Csm operations Api to exposes the list of available Csm Apis under the resource provider.
Implements Csm operations Api to exposes the list of available Csm Apis under the resource provider.
Parameters: - custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: An iterator like instance of CsmOperationDescription
Return type: Raises:
-
models
= <module 'azure.mgmt.web.models' from '/usr/lib/python3/dist-packages/azure/mgmt/web/models/__init__.py'>¶
-
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 object model deserializer.
Variables: api_version – API Version. Constant value: “2018-02-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_config – Operation configuration overrides.
Returns: DomainAvailablilityCheckResult or ClientRawResponse if raw=true
Return type: DomainAvailablilityCheckResult or ClientRawResponse
Raises:
-
create_or_update
(resource_group_name, domain_name, domain, custom_headers=None, raw=False, polling=True, **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) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
- polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
Returns: An instance of LROPoller that returns Domain or ClientRawResponse<Domain> if raw==True
Return type: AzureOperationPoller[Domain] or AzureOperationPoller[ClientRawResponse[Domain]]
Raises:
-
create_or_update_ownership_identifier
(resource_group_name, domain_name, name, kind=None, ownership_id=None, 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.
- kind (str) – Kind of resource.
- ownership_id (str) – Ownership Id.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: DomainOwnershipIdentifier or ClientRawResponse if raw=true
Return type: DomainOwnershipIdentifier or ClientRawResponse
Raises:
-
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_config – Operation configuration overrides.
Returns: None or ClientRawResponse if raw=true
Return type: None or ClientRawResponse
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_config – Operation configuration overrides.
Returns: None or ClientRawResponse if raw=true
Return type: None or ClientRawResponse
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_config – Operation configuration overrides.
Returns: Domain or ClientRawResponse if raw=true
Return type: Domain or ClientRawResponse
Raises:
-
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: - custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: DomainControlCenterSsoRequest or ClientRawResponse if raw=true
Return type: DomainControlCenterSsoRequest or ClientRawResponse
Raises:
-
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_config – Operation configuration overrides.
Returns: DomainOwnershipIdentifier or ClientRawResponse if raw=true
Return type: DomainOwnershipIdentifier or ClientRawResponse
Raises:
-
list
(custom_headers=None, raw=False, **operation_config)[source]¶ Get all domains in a subscription.
Get all domains in a subscription.
Parameters: - custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: An iterator like instance of Domain
Return type: Raises:
-
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_config – Operation configuration overrides.
Returns: An iterator like instance of Domain
Return type: Raises:
-
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_config – Operation configuration overrides.
Returns: An iterator like instance of DomainOwnershipIdentifier
Return type: Raises:
-
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_config – Operation configuration overrides.
Returns: An iterator like instance of NameIdentifier
Return type: Raises:
-
renew
(resource_group_name, domain_name, custom_headers=None, raw=False, **operation_config)[source]¶ Renew a domain.
Renew 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_config – Operation configuration overrides.
Returns: None or ClientRawResponse if raw=true
Return type: None or ClientRawResponse
Raises: CloudError
-
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 (DomainPatchResource) – Domain registration information.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: Domain or ClientRawResponse if raw=true
Return type: Domain or ClientRawResponse
Raises:
-
update_ownership_identifier
(resource_group_name, domain_name, name, kind=None, ownership_id=None, 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.
- kind (str) – Kind of resource.
- ownership_id (str) – Ownership Id.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: DomainOwnershipIdentifier or ClientRawResponse if raw=true
Return type: DomainOwnershipIdentifier or ClientRawResponse
Raises:
-
models
= <module 'azure.mgmt.web.models' from '/usr/lib/python3/dist-packages/azure/mgmt/web/models/__init__.py'>¶
-
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 object model deserializer.
Variables: api_version – API Version. Constant value: “2018-02-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_config – Operation configuration overrides.
Returns: TopLevelDomain or ClientRawResponse if raw=true
Return type: TopLevelDomain or ClientRawResponse
Raises:
-
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: - custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: An iterator like instance of TopLevelDomain
Return type: Raises:
-
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_config – Operation configuration overrides.
Returns: An iterator like instance of TldLegalAgreement
Return type: Raises:
-
models
= <module 'azure.mgmt.web.models' from '/usr/lib/python3/dist-packages/azure/mgmt/web/models/__init__.py'>¶
-
class
azure.mgmt.web.operations.
DomainRegistrationProviderOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
DomainRegistrationProviderOperations operations.
Parameters: - client – Client for service requests.
- config – Configuration of service client.
- serializer – An object model serializer.
- deserializer – An object model deserializer.
Variables: api_version – API Version. Constant value: “2018-02-01”.
-
list_operations
(custom_headers=None, raw=False, **operation_config)[source]¶ Implements Csm operations Api to exposes the list of available Csm Apis under the resource provider.
Implements Csm operations Api to exposes the list of available Csm Apis under the resource provider.
Parameters: - custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: An iterator like instance of CsmOperationDescription
Return type: Raises:
-
models
= <module 'azure.mgmt.web.models' from '/usr/lib/python3/dist-packages/azure/mgmt/web/models/__init__.py'>¶
-
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 object model deserializer.
Variables: api_version – API Version. Constant value: “2018-02-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_config – Operation configuration overrides.
Returns: Certificate or ClientRawResponse if raw=true
Return type: Certificate or ClientRawResponse
Raises:
-
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_config – Operation configuration overrides.
Returns: None or ClientRawResponse if raw=true
Return type: None or ClientRawResponse
Raises: CloudError
-
get
(resource_group_name, name, custom_headers=None, raw=False, **operation_config)[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_config – Operation configuration overrides.
Returns: Certificate or ClientRawResponse if raw=true
Return type: Certificate or ClientRawResponse
Raises:
-
list
(custom_headers=None, raw=False, **operation_config)[source]¶ Get all certificates for a subscription.
Get all certificates for a subscription.
Parameters: - custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: An iterator like instance of Certificate
Return type: Raises:
-
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_config – Operation configuration overrides.
Returns: An iterator like instance of Certificate
Return type: Raises:
-
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 (CertificatePatchResource) – 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_config – Operation configuration overrides.
Returns: Certificate or ClientRawResponse if raw=true
Return type: Certificate or ClientRawResponse
Raises:
-
models
= <module 'azure.mgmt.web.models' from '/usr/lib/python3/dist-packages/azure/mgmt/web/models/__init__.py'>¶
-
class
azure.mgmt.web.operations.
DeletedWebAppsOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
DeletedWebAppsOperations operations.
Parameters: - client – Client for service requests.
- config – Configuration of service client.
- serializer – An object model serializer.
- deserializer – An object model deserializer.
Variables: api_version – API Version. Constant value: “2018-02-01”.
-
list
(custom_headers=None, raw=False, **operation_config)[source]¶ Get all deleted apps for a subscription.
Get all deleted apps for a subscription.
Parameters: - custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: An iterator like instance of DeletedSite
Return type: Raises:
-
models
= <module 'azure.mgmt.web.models' from '/usr/lib/python3/dist-packages/azure/mgmt/web/models/__init__.py'>¶
-
class
azure.mgmt.web.operations.
DiagnosticsOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
DiagnosticsOperations operations.
Parameters: - client – Client for service requests.
- config – Configuration of service client.
- serializer – An object model serializer.
- deserializer – An object model deserializer.
Variables: api_version – API Version. Constant value: “2018-02-01”.
-
execute_site_analysis
(resource_group_name, site_name, diagnostic_category, analysis_name, start_time=None, end_time=None, time_grain=None, custom_headers=None, raw=False, **operation_config)[source]¶ Execute Analysis.
Execute Analysis.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- site_name (str) – Site Name
- diagnostic_category (str) – Category Name
- analysis_name (str) – Analysis Resource Name
- start_time (datetime) – Start Time
- end_time (datetime) – End Time
- time_grain (str) – Time Grain
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: DiagnosticAnalysis or ClientRawResponse if raw=true
Return type: DiagnosticAnalysis or ClientRawResponse
Raises:
-
execute_site_analysis_slot
(resource_group_name, site_name, diagnostic_category, analysis_name, slot, start_time=None, end_time=None, time_grain=None, custom_headers=None, raw=False, **operation_config)[source]¶ Execute Analysis.
Execute Analysis.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- site_name (str) – Site Name
- diagnostic_category (str) – Category Name
- analysis_name (str) – Analysis Resource Name
- slot (str) – Slot Name
- start_time (datetime) – Start Time
- end_time (datetime) – End Time
- time_grain (str) – Time Grain
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: DiagnosticAnalysis or ClientRawResponse if raw=true
Return type: DiagnosticAnalysis or ClientRawResponse
Raises:
-
execute_site_detector
(resource_group_name, site_name, detector_name, diagnostic_category, start_time=None, end_time=None, time_grain=None, custom_headers=None, raw=False, **operation_config)[source]¶ Execute Detector.
Execute Detector.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- site_name (str) – Site Name
- detector_name (str) – Detector Resource Name
- diagnostic_category (str) – Category Name
- start_time (datetime) – Start Time
- end_time (datetime) – End Time
- time_grain (str) – Time Grain
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: DiagnosticDetectorResponse or ClientRawResponse if raw=true
Return type: DiagnosticDetectorResponse or ClientRawResponse
Raises:
-
execute_site_detector_slot
(resource_group_name, site_name, detector_name, diagnostic_category, slot, start_time=None, end_time=None, time_grain=None, custom_headers=None, raw=False, **operation_config)[source]¶ Execute Detector.
Execute Detector.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- site_name (str) – Site Name
- detector_name (str) – Detector Resource Name
- diagnostic_category (str) – Category Name
- slot (str) – Slot Name
- start_time (datetime) – Start Time
- end_time (datetime) – End Time
- time_grain (str) – Time Grain
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: DiagnosticDetectorResponse or ClientRawResponse if raw=true
Return type: DiagnosticDetectorResponse or ClientRawResponse
Raises:
-
get_hosting_environment_detector_response
(resource_group_name, name, detector_name, start_time=None, end_time=None, time_grain=None, custom_headers=None, raw=False, **operation_config)[source]¶ Get Hosting Environment Detector Response.
Get Hosting Environment Detector Response.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – App Service Environment Name
- detector_name (str) – Detector Resource Name
- start_time (datetime) – Start Time
- end_time (datetime) – End Time
- time_grain (str) – Time Grain
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: DetectorResponse or ClientRawResponse if raw=true
Return type: DetectorResponse or ClientRawResponse
Raises:
-
get_site_analysis
(resource_group_name, site_name, diagnostic_category, analysis_name, custom_headers=None, raw=False, **operation_config)[source]¶ Get Site Analysis.
Get Site Analysis.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- site_name (str) – Site Name
- diagnostic_category (str) – Diagnostic Category
- analysis_name (str) – Analysis Name
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: DiagnosticAnalysis or ClientRawResponse if raw=true
Return type: DiagnosticAnalysis or ClientRawResponse
Raises:
-
get_site_analysis_slot
(resource_group_name, site_name, diagnostic_category, analysis_name, slot, custom_headers=None, raw=False, **operation_config)[source]¶ Get Site Analysis.
Get Site Analysis.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- site_name (str) – Site Name
- diagnostic_category (str) – Diagnostic Category
- analysis_name (str) – Analysis Name
- slot (str) – Slot - optional
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: DiagnosticAnalysis or ClientRawResponse if raw=true
Return type: DiagnosticAnalysis or ClientRawResponse
Raises:
-
get_site_detector
(resource_group_name, site_name, diagnostic_category, detector_name, custom_headers=None, raw=False, **operation_config)[source]¶ Get Detector.
Get Detector.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- site_name (str) – Site Name
- diagnostic_category (str) – Diagnostic Category
- detector_name (str) – Detector Name
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: An iterator like instance of DetectorDefinition
Return type: Raises:
-
get_site_detector_response
(resource_group_name, site_name, detector_name, start_time=None, end_time=None, time_grain=None, custom_headers=None, raw=False, **operation_config)[source]¶ Get site detector response.
Get site detector response.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- site_name (str) – Site Name
- detector_name (str) – Detector Resource Name
- start_time (datetime) – Start Time
- end_time (datetime) – End Time
- time_grain (str) – Time Grain
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: DetectorResponse or ClientRawResponse if raw=true
Return type: DetectorResponse or ClientRawResponse
Raises:
-
get_site_detector_response_slot
(resource_group_name, site_name, detector_name, slot, start_time=None, end_time=None, time_grain=None, custom_headers=None, raw=False, **operation_config)[source]¶ Get site detector response.
Get site detector response.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- site_name (str) – Site Name
- detector_name (str) – Detector Resource Name
- slot (str) – Slot Name
- start_time (datetime) – Start Time
- end_time (datetime) – End Time
- time_grain (str) – Time Grain
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: DetectorResponse or ClientRawResponse if raw=true
Return type: DetectorResponse or ClientRawResponse
Raises:
-
get_site_detector_slot
(resource_group_name, site_name, diagnostic_category, detector_name, slot, custom_headers=None, raw=False, **operation_config)[source]¶ Get Detector.
Get Detector.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- site_name (str) – Site Name
- diagnostic_category (str) – Diagnostic Category
- detector_name (str) – Detector Name
- slot (str) – Slot Name
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: An iterator like instance of DetectorDefinition
Return type: Raises:
-
get_site_diagnostic_category
(resource_group_name, site_name, diagnostic_category, custom_headers=None, raw=False, **operation_config)[source]¶ Get Diagnostics Category.
Get Diagnostics Category.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- site_name (str) – Site Name
- diagnostic_category (str) – Diagnostic Category
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: DiagnosticCategory or ClientRawResponse if raw=true
Return type: DiagnosticCategory or ClientRawResponse
Raises:
-
get_site_diagnostic_category_slot
(resource_group_name, site_name, diagnostic_category, slot, custom_headers=None, raw=False, **operation_config)[source]¶ Get Diagnostics Category.
Get Diagnostics Category.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- site_name (str) – Site Name
- diagnostic_category (str) – Diagnostic Category
- slot (str) – Slot Name
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: DiagnosticCategory or ClientRawResponse if raw=true
Return type: DiagnosticCategory or ClientRawResponse
Raises:
-
list_hosting_environment_detector_responses
(resource_group_name, name, custom_headers=None, raw=False, **operation_config)[source]¶ List Hosting Environment Detector Responses.
List Hosting Environment Detector Responses.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Site Name
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: An iterator like instance of DetectorResponse
Return type: Raises:
-
list_site_analyses
(resource_group_name, site_name, diagnostic_category, custom_headers=None, raw=False, **operation_config)[source]¶ Get Site Analyses.
Get Site Analyses.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- site_name (str) – Site Name
- diagnostic_category (str) – Diagnostic Category
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: An iterator like instance of AnalysisDefinition
Return type: Raises:
-
list_site_analyses_slot
(resource_group_name, site_name, diagnostic_category, slot, custom_headers=None, raw=False, **operation_config)[source]¶ Get Site Analyses.
Get Site Analyses.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- site_name (str) – Site Name
- diagnostic_category (str) – Diagnostic Category
- slot (str) – Slot Name
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: An iterator like instance of AnalysisDefinition
Return type: Raises:
-
list_site_detector_responses
(resource_group_name, site_name, custom_headers=None, raw=False, **operation_config)[source]¶ List Site Detector Responses.
List Site Detector Responses.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- site_name (str) – Site Name
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: An iterator like instance of DetectorResponse
Return type: Raises:
-
list_site_detector_responses_slot
(resource_group_name, site_name, slot, custom_headers=None, raw=False, **operation_config)[source]¶ List Site Detector Responses.
List Site Detector Responses.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- site_name (str) – Site Name
- slot (str) – Slot Name
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: An iterator like instance of DetectorResponse
Return type: Raises:
-
list_site_detectors
(resource_group_name, site_name, diagnostic_category, custom_headers=None, raw=False, **operation_config)[source]¶ Get Detectors.
Get Detectors.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- site_name (str) – Site Name
- diagnostic_category (str) – Diagnostic Category
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: An iterator like instance of DetectorDefinition
Return type: Raises:
-
list_site_detectors_slot
(resource_group_name, site_name, diagnostic_category, slot, custom_headers=None, raw=False, **operation_config)[source]¶ Get Detectors.
Get Detectors.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- site_name (str) – Site Name
- diagnostic_category (str) – Diagnostic Category
- slot (str) – Slot Name
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: An iterator like instance of DetectorDefinition
Return type: Raises:
-
list_site_diagnostic_categories
(resource_group_name, site_name, custom_headers=None, raw=False, **operation_config)[source]¶ Get Diagnostics Categories.
Get Diagnostics Categories.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- site_name (str) – Site Name
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: An iterator like instance of DiagnosticCategory
Return type: Raises:
-
list_site_diagnostic_categories_slot
(resource_group_name, site_name, slot, custom_headers=None, raw=False, **operation_config)[source]¶ Get Diagnostics Categories.
Get Diagnostics Categories.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- site_name (str) – Site Name
- slot (str) – Slot Name
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: An iterator like instance of DiagnosticCategory
Return type: Raises:
-
models
= <module 'azure.mgmt.web.models' from '/usr/lib/python3/dist-packages/azure/mgmt/web/models/__init__.py'>¶
-
class
azure.mgmt.web.operations.
ProviderOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
ProviderOperations operations.
Parameters: - client – Client for service requests.
- config – Configuration of service client.
- serializer – An object model serializer.
- deserializer – An object model deserializer.
Variables: api_version – API Version. Constant value: “2018-02-01”.
-
get_available_stacks
(os_type_selected=None, custom_headers=None, raw=False, **operation_config)[source]¶ Get available application frameworks and their versions.
Get available application frameworks and their versions.
Parameters: - os_type_selected (str) – Possible values include: ‘Windows’, ‘Linux’
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: An iterator like instance of ApplicationStack
Return type: Raises:
-
get_available_stacks_on_prem
(os_type_selected=None, custom_headers=None, raw=False, **operation_config)[source]¶ Get available application frameworks and their versions.
Get available application frameworks and their versions.
Parameters: - os_type_selected (str) – Possible values include: ‘Windows’, ‘Linux’
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: An iterator like instance of ApplicationStack
Return type: Raises:
-
list_operations
(custom_headers=None, raw=False, **operation_config)[source]¶ Gets all available operations for the Microsoft.Web resource provider. Also exposes resource metric definitions.
Gets all available operations for the Microsoft.Web resource provider. Also exposes resource metric definitions.
Parameters: - custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: An iterator like instance of CsmOperationDescription
Return type: Raises:
-
models
= <module 'azure.mgmt.web.models' from '/usr/lib/python3/dist-packages/azure/mgmt/web/models/__init__.py'>¶
-
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 object model deserializer.
Variables: api_version – API Version. Constant value: “2018-02-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_config – Operation configuration overrides.
Returns: None or ClientRawResponse if raw=true
Return type: None or ClientRawResponse
Raises: CloudError
-
disable_recommendation_for_site
(resource_group_name, site_name, name, custom_headers=None, raw=False, **operation_config)[source]¶ Disables the specific rule for a web site permanently.
Disables the specific rule for a web site permanently.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- site_name (str) – Site name
- name (str) – Rule name
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: None or ClientRawResponse if raw=true
Return type: None or ClientRawResponse
Raises: CloudError
-
disable_recommendation_for_subscription
(name, custom_headers=None, raw=False, **operation_config)[source]¶ Disables the specified rule so it will not apply to a subscription in the future.
Disables the specified rule so it will not apply to a subscription in the future.
Parameters: - name (str) – Rule name
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: None or ClientRawResponse if raw=true
Return type: None or ClientRawResponse
Raises: CloudError
-
get_rule_details_by_web_app
(resource_group_name, site_name, name, update_seen=None, recommendation_id=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.
- recommendation_id (str) – The GUID of the recommedation object if you query an expired one. You don’t need to specify it to query an active entry.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: RecommendationRule or ClientRawResponse if raw=true
Return type: RecommendationRule or ClientRawResponse
Raises:
-
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=channel 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_config – Operation configuration overrides.
Returns: An iterator like instance of Recommendation
Return type: Raises:
-
list_history_for_web_app
(resource_group_name, site_name, expired_only=None, 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.
- expired_only (bool) – Specify <code>false</code> to return all recommendations. The default is <code>true</code>, which returns only expired recommendations.
- filter (str) – Filter is specified by using OData syntax. Example: $filter=channel 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_config – Operation configuration overrides.
Returns: An iterator like instance of Recommendation
Return type: Raises:
-
list_recommended_rules_for_web_app
(resource_group_name, site_name, featured=None, filter=None, custom_headers=None, raw=False, **operation_config)[source]¶ 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=channel 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_config – Operation configuration overrides.
Returns: An iterator like instance of Recommendation
Return type: Raises:
-
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: - custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: None or ClientRawResponse if raw=true
Return type: None or ClientRawResponse
Raises: CloudError
-
reset_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_config – Operation configuration overrides.
Returns: None or ClientRawResponse if raw=true
Return type: None or ClientRawResponse
Raises: CloudError
-
models
= <module 'azure.mgmt.web.models' from '/usr/lib/python3/dist-packages/azure/mgmt/web/models/__init__.py'>¶
-
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 object model deserializer.
Variables: api_version – API Version. Constant value: “2018-02-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_config – Operation configuration overrides.
Returns: PremierAddOn or ClientRawResponse if raw=true
Return type: PremierAddOn or ClientRawResponse
Raises:
-
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_config – Operation configuration overrides.
Returns: PremierAddOn or ClientRawResponse if raw=true
Return type: PremierAddOn or ClientRawResponse
Raises:
-
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_config – Operation configuration overrides.
Returns: CustomHostnameAnalysisResult or ClientRawResponse if raw=true
Return type: CustomHostnameAnalysisResult or ClientRawResponse
Raises:
-
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_config – Operation configuration overrides.
Returns: CustomHostnameAnalysisResult or ClientRawResponse if raw=true
Return type: CustomHostnameAnalysisResult or ClientRawResponse
Raises:
-
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_config – Operation configuration overrides.
Returns: None or ClientRawResponse if raw=true
Return type: None or ClientRawResponse
Raises: CloudError
-
apply_slot_configuration_slot
(resource_group_name, name, slot, target_slot, preserve_vnet, custom_headers=None, raw=False, **operation_config)[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_config – Operation configuration overrides.
Returns: None or ClientRawResponse if raw=true
Return type: None or ClientRawResponse
Raises: CloudError
-
backup
(resource_group_name, name, request, custom_headers=None, raw=False, **operation_config)[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_config – Operation configuration overrides.
Returns: BackupItem or ClientRawResponse if raw=true
Return type: BackupItem or ClientRawResponse
Raises:
-
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_config – Operation configuration overrides.
Returns: BackupItem or ClientRawResponse if raw=true
Return type: BackupItem or ClientRawResponse
Raises:
-
create_deployment
(resource_group_name, name, id, deployment, custom_headers=None, raw=False, **operation_config)[source]¶ Create a deployment for an app, or a deployment slot.
Create a deployment for an app, or a deployment slot.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Name of the app.
- id (str) – ID of an existing deployment.
- deployment (Deployment) – Deployment details.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: Deployment or ClientRawResponse if raw=true
Return type: Deployment or ClientRawResponse
Raises:
-
create_deployment_slot
(resource_group_name, name, id, slot, deployment, custom_headers=None, raw=False, **operation_config)[source]¶ Create a deployment for an app, or a deployment slot.
Create a deployment for an app, or a deployment slot.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Name of the app.
- id (str) – ID of an existing deployment.
- slot (str) – Name of the deployment slot. If a slot is not specified, the API creates a deployment for the production slot.
- deployment (Deployment) – Deployment details.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: Deployment or ClientRawResponse if raw=true
Return type: Deployment or ClientRawResponse
Raises:
-
create_function
(resource_group_name, name, function_name, function_envelope, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Create function for web site, or a deployment slot.
Create function for web site, or a deployment slot.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Site name.
- function_name (str) – Function name.
- function_envelope (FunctionEnvelope) – Function details.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
- polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
Returns: An instance of LROPoller that returns FunctionEnvelope or ClientRawResponse<FunctionEnvelope> if raw==True
Return type: AzureOperationPoller[FunctionEnvelope] or AzureOperationPoller[ClientRawResponse[FunctionEnvelope]]
Raises:
-
create_instance_function_slot
(resource_group_name, name, function_name, slot, function_envelope, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Create function for web site, or a deployment slot.
Create function for web site, or a deployment slot.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Site name.
- function_name (str) – Function name.
- slot (str) – Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.
- function_envelope (FunctionEnvelope) – Function details.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
- polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
Returns: An instance of LROPoller that returns FunctionEnvelope or ClientRawResponse<FunctionEnvelope> if raw==True
Return type: AzureOperationPoller[FunctionEnvelope] or AzureOperationPoller[ClientRawResponse[FunctionEnvelope]]
Raises:
-
create_instance_ms_deploy_operation
(resource_group_name, name, instance_id, ms_deploy, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Invoke the MSDeploy web app extension.
Invoke the MSDeploy web app extension.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Name of web app.
- instance_id (str) – ID of web app instance.
- ms_deploy (MSDeploy) – Details of MSDeploy operation
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
- polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
Returns: An instance of LROPoller that returns MSDeployStatus or ClientRawResponse<MSDeployStatus> if raw==True
Return type: AzureOperationPoller[MSDeployStatus] or AzureOperationPoller[ClientRawResponse[MSDeployStatus]]
Raises: CloudError
-
create_instance_ms_deploy_operation_slot
(resource_group_name, name, slot, instance_id, ms_deploy, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Invoke the MSDeploy web app extension.
Invoke the MSDeploy web app extension.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Name of web app.
- slot (str) – Name of web app slot. If not specified then will default to production slot.
- instance_id (str) – ID of web app instance.
- ms_deploy (MSDeploy) – Details of MSDeploy operation
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
- polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
Returns: An instance of LROPoller that returns MSDeployStatus or ClientRawResponse<MSDeployStatus> if raw==True
Return type: AzureOperationPoller[MSDeployStatus] or AzureOperationPoller[ClientRawResponse[MSDeployStatus]]
Raises: CloudError
-
create_ms_deploy_operation
(resource_group_name, name, ms_deploy, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Invoke the MSDeploy web app extension.
Invoke the MSDeploy web app extension.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Name of web app.
- ms_deploy (MSDeploy) – Details of MSDeploy operation
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
- polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
Returns: An instance of LROPoller that returns MSDeployStatus or ClientRawResponse<MSDeployStatus> if raw==True
Return type: AzureOperationPoller[MSDeployStatus] or AzureOperationPoller[ClientRawResponse[MSDeployStatus]]
Raises: CloudError
-
create_ms_deploy_operation_slot
(resource_group_name, name, slot, ms_deploy, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Invoke the MSDeploy web app extension.
Invoke the MSDeploy web app extension.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Name of web app.
- slot (str) – Name of web app slot. If not specified then will default to production slot.
- ms_deploy (MSDeploy) – Details of MSDeploy operation
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
- polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
Returns: An instance of LROPoller that returns MSDeployStatus or ClientRawResponse<MSDeployStatus> if raw==True
Return type: AzureOperationPoller[MSDeployStatus] or AzureOperationPoller[ClientRawResponse[MSDeployStatus]]
Raises: CloudError
-
create_or_update
(resource_group_name, name, site_envelope, custom_headers=None, raw=False, polling=True, **operation_config)[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.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
- polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
Returns: An instance of LROPoller that returns Site or ClientRawResponse<Site> if raw==True
Return type: AzureOperationPoller[Site] or AzureOperationPoller[ClientRawResponse[Site]]
Raises:
-
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_config – Operation configuration overrides.
Returns: SiteConfigResource or ClientRawResponse if raw=true
Return type: SiteConfigResource or ClientRawResponse
Raises:
-
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_config – Operation configuration overrides.
Returns: SiteConfigResource or ClientRawResponse if raw=true
Return type: SiteConfigResource or ClientRawResponse
Raises:
-
create_or_update_domain_ownership_identifier
(resource_group_name, name, domain_ownership_identifier_name, kind=None, identifier_id=None, custom_headers=None, raw=False, **operation_config)[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.
- kind (str) – Kind of resource.
- identifier_id (str) – String representation of the identity.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: Identifier or ClientRawResponse if raw=true
Return type: Identifier or ClientRawResponse
Raises:
-
create_or_update_domain_ownership_identifier_slot
(resource_group_name, name, domain_ownership_identifier_name, slot, kind=None, identifier_id=None, custom_headers=None, raw=False, **operation_config)[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.
- slot (str) – Name of the deployment slot. If a slot is not specified, the API will delete the binding for the production slot.
- kind (str) – Kind of resource.
- identifier_id (str) – String representation of the identity.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: Identifier or ClientRawResponse if raw=true
Return type: Identifier or ClientRawResponse
Raises:
-
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_config – Operation configuration overrides.
Returns: HostNameBinding or ClientRawResponse if raw=true
Return type: HostNameBinding or ClientRawResponse
Raises:
-
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_config – Operation configuration overrides.
Returns: HostNameBinding or ClientRawResponse if raw=true
Return type: HostNameBinding or ClientRawResponse
Raises:
-
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_config – Operation configuration overrides.
Returns: HybridConnection or ClientRawResponse if raw=true
Return type: HybridConnection or ClientRawResponse
Raises:
-
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_config – Operation configuration overrides.
Returns: HybridConnection or ClientRawResponse if raw=true
Return type: HybridConnection or ClientRawResponse
Raises:
-
create_or_update_public_certificate
(resource_group_name, name, public_certificate_name, public_certificate, 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.
- public_certificate_name (str) – Public certificate name.
- public_certificate (PublicCertificate) – Public certificate details. This is the JSON representation of a PublicCertificate object.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: PublicCertificate or ClientRawResponse if raw=true
Return type: PublicCertificate or ClientRawResponse
Raises:
-
create_or_update_public_certificate_slot
(resource_group_name, name, public_certificate_name, public_certificate, 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.
- public_certificate_name (str) – Public certificate name.
- public_certificate (PublicCertificate) – Public certificate details. This is the JSON representation of a PublicCertificate object.
- slot (str) – Name of the deployment slot. If a slot is not specified, the API will create a binding for the production slot.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: PublicCertificate or ClientRawResponse if raw=true
Return type: PublicCertificate or ClientRawResponse
Raises:
-
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_config – Operation configuration overrides.
Returns: RelayServiceConnectionEntity or ClientRawResponse if raw=true
Return type: RelayServiceConnectionEntity or ClientRawResponse
Raises:
-
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_config – Operation configuration overrides.
Returns: RelayServiceConnectionEntity or ClientRawResponse if raw=true
Return type: RelayServiceConnectionEntity or ClientRawResponse
Raises:
-
create_or_update_slot
(resource_group_name, name, site_envelope, slot, custom_headers=None, raw=False, polling=True, **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.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
- polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
Returns: An instance of LROPoller that returns Site or ClientRawResponse<Site> if raw==True
Return type: AzureOperationPoller[Site] or AzureOperationPoller[ClientRawResponse[Site]]
Raises:
-
create_or_update_source_control
(resource_group_name, name, site_source_control, custom_headers=None, raw=False, polling=True, **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) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
- polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
Returns: An instance of LROPoller that returns SiteSourceControl or ClientRawResponse<SiteSourceControl> if raw==True
Return type: AzureOperationPoller[SiteSourceControl] or AzureOperationPoller[ClientRawResponse[SiteSourceControl]]
Raises:
-
create_or_update_source_control_slot
(resource_group_name, name, site_source_control, slot, custom_headers=None, raw=False, polling=True, **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) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
- polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
Returns: An instance of LROPoller that returns SiteSourceControl or ClientRawResponse<SiteSourceControl> if raw==True
Return type: AzureOperationPoller[SiteSourceControl] or AzureOperationPoller[ClientRawResponse[SiteSourceControl]]
Raises:
-
create_or_update_swift_virtual_network_connection
(resource_group_name, name, connection_envelope, custom_headers=None, raw=False, **operation_config)[source]¶ Integrates this Web App with a Virtual Network. This requires that 1) “swiftSupported” is true when doing a GET against this resource, and 2) that the target Subnet has already been delegated, and is not in use by another App Service Plan other than the one this App is in.
Integrates this Web App with a Virtual Network. This requires that 1) “swiftSupported” is true when doing a GET against this resource, and 2) that the target Subnet has already been delegated, and is not in use by another App Service Plan other than the one this App is in.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Name of the app.
- connection_envelope (SwiftVirtualNetwork) – Properties of the Virtual Network connection. See example.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: SwiftVirtualNetwork or ClientRawResponse if raw=true
Return type: SwiftVirtualNetwork or ClientRawResponse
Raises:
-
create_or_update_swift_virtual_network_connection_slot
(resource_group_name, name, connection_envelope, slot, custom_headers=None, raw=False, **operation_config)[source]¶ Integrates this Web App with a Virtual Network. This requires that 1) “swiftSupported” is true when doing a GET against this resource, and 2) that the target Subnet has already been delegated, and is not in use by another App Service Plan other than the one this App is in.
Integrates this Web App with a Virtual Network. This requires that 1) “swiftSupported” is true when doing a GET against this resource, and 2) that the target Subnet has already been delegated, and is not in use by another App Service Plan other than the one this App is in.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Name of the app.
- connection_envelope (SwiftVirtualNetwork) – Properties of the Virtual Network connection. See example.
- slot (str) – Name of the deployment slot. If a slot is not specified, the API will add or update connections for the production slot.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: SwiftVirtualNetwork or ClientRawResponse if raw=true
Return type: SwiftVirtualNetwork or ClientRawResponse
Raises:
-
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_config – Operation configuration overrides.
Returns: VnetInfo or ClientRawResponse if raw=true
Return type: VnetInfo or ClientRawResponse
Raises:
-
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_config – Operation configuration overrides.
Returns: VnetGateway or ClientRawResponse if raw=true
Return type: VnetGateway or ClientRawResponse
Raises:
-
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_config – Operation configuration overrides.
Returns: VnetGateway or ClientRawResponse if raw=true
Return type: VnetGateway or ClientRawResponse
Raises:
-
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_config – Operation configuration overrides.
Returns: VnetInfo or ClientRawResponse if raw=true
Return type: VnetInfo or ClientRawResponse
Raises:
-
delete
(resource_group_name, name, delete_metrics=None, delete_empty_server_farm=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.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: None or ClientRawResponse if raw=true
Return type: None or ClientRawResponse
Raises: CloudError
-
delete_backup
(resource_group_name, name, backup_id, custom_headers=None, raw=False, **operation_config)[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_config – Operation configuration overrides.
Returns: None or ClientRawResponse if raw=true
Return type: None or ClientRawResponse
Raises: CloudError
-
delete_backup_configuration
(resource_group_name, name, custom_headers=None, raw=False, **operation_config)[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_config – Operation configuration overrides.
Returns: None or ClientRawResponse if raw=true
Return type: None or ClientRawResponse
Raises: CloudError
-
delete_backup_configuration_slot
(resource_group_name, name, slot, custom_headers=None, raw=False, **operation_config)[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_config – Operation configuration overrides.
Returns: None or ClientRawResponse if raw=true
Return type: None or ClientRawResponse
Raises: CloudError
-
delete_backup_slot
(resource_group_name, name, backup_id, slot, custom_headers=None, raw=False, **operation_config)[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_config – Operation configuration overrides.
Returns: None or ClientRawResponse if raw=true
Return type: None or ClientRawResponse
Raises: CloudError
-
delete_continuous_web_job
(resource_group_name, name, web_job_name, custom_headers=None, raw=False, **operation_config)[source]¶ Delete a continuous web job by its ID for an app, or a deployment slot.
Delete a continuous web job by its ID for an app, or a deployment slot.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Site name.
- web_job_name (str) – Name of Web Job.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: None or ClientRawResponse if raw=true
Return type: None or ClientRawResponse
Raises: CloudError
-
delete_continuous_web_job_slot
(resource_group_name, name, web_job_name, slot, custom_headers=None, raw=False, **operation_config)[source]¶ Delete a continuous web job by its ID for an app, or a deployment slot.
Delete a continuous web job by its ID for an app, or a deployment slot.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Site name.
- web_job_name (str) – Name of Web Job.
- slot (str) – Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: None or ClientRawResponse if raw=true
Return type: None or ClientRawResponse
Raises: CloudError
-
delete_deployment
(resource_group_name, name, id, custom_headers=None, raw=False, **operation_config)[source]¶ Delete a deployment by its ID for an app, or a deployment slot.
Delete a deployment by its ID for an app, or a deployment slot.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Name of the app.
- id (str) – Deployment ID.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: None or ClientRawResponse if raw=true
Return type: None or ClientRawResponse
Raises: CloudError
-
delete_deployment_slot
(resource_group_name, name, id, slot, custom_headers=None, raw=False, **operation_config)[source]¶ Delete a deployment by its ID for an app, or a deployment slot.
Delete a deployment by its ID for an app, or a deployment slot.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Name of the app.
- id (str) – Deployment ID.
- slot (str) – Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: None or ClientRawResponse if raw=true
Return type: None or ClientRawResponse
Raises: CloudError
-
delete_domain_ownership_identifier
(resource_group_name, name, domain_ownership_identifier_name, custom_headers=None, raw=False, **operation_config)[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_config – Operation configuration overrides.
Returns: None or ClientRawResponse if raw=true
Return type: None or ClientRawResponse
Raises: CloudError
-
delete_domain_ownership_identifier_slot
(resource_group_name, name, domain_ownership_identifier_name, slot, custom_headers=None, raw=False, **operation_config)[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_config – Operation configuration overrides.
Returns: None or ClientRawResponse if raw=true
Return type: None or ClientRawResponse
Raises: CloudError
-
delete_function
(resource_group_name, name, function_name, custom_headers=None, raw=False, **operation_config)[source]¶ Delete a function for web site, or a deployment slot.
Delete a function for web site, or a deployment slot.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Site name.
- function_name (str) – Function name.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: None or ClientRawResponse if raw=true
Return type: None or ClientRawResponse
Raises: CloudError
-
delete_host_name_binding
(resource_group_name, name, host_name, custom_headers=None, raw=False, **operation_config)[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_config – Operation configuration overrides.
Returns: None or ClientRawResponse if raw=true
Return type: None or ClientRawResponse
Raises: CloudError
-
delete_host_name_binding_slot
(resource_group_name, name, slot, host_name, custom_headers=None, raw=False, **operation_config)[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_config – Operation configuration overrides.
Returns: None or ClientRawResponse if raw=true
Return type: None or ClientRawResponse
Raises: CloudError
-
delete_hybrid_connection
(resource_group_name, name, namespace_name, relay_name, custom_headers=None, raw=False, **operation_config)[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_config – Operation configuration overrides.
Returns: None or ClientRawResponse if raw=true
Return type: None or ClientRawResponse
Raises: CloudError
-
delete_hybrid_connection_slot
(resource_group_name, name, namespace_name, relay_name, slot, custom_headers=None, raw=False, **operation_config)[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_config – Operation configuration overrides.
Returns: None or ClientRawResponse if raw=true
Return type: None or ClientRawResponse
Raises: CloudError
-
delete_instance_function_slot
(resource_group_name, name, function_name, slot, custom_headers=None, raw=False, **operation_config)[source]¶ Delete a function for web site, or a deployment slot.
Delete a function for web site, or a deployment slot.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Site name.
- function_name (str) – Function name.
- slot (str) – Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: None or ClientRawResponse if raw=true
Return type: None or ClientRawResponse
Raises: CloudError
-
delete_instance_process
(resource_group_name, name, process_id, instance_id, custom_headers=None, raw=False, **operation_config)[source]¶ Terminate a process by its ID for a web site, or a deployment slot, or specific scaled-out instance in a web site.
Terminate a process by its ID for a web site, or a deployment slot, or specific scaled-out instance in a web site.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Site name.
- process_id (str) – PID.
- instance_id (str) – ID of a specific scaled-out instance. This is the value of the name property in the JSON response from “GET api/sites/{siteName}/instances”.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: None or ClientRawResponse if raw=true
Return type: None or ClientRawResponse
Raises: CloudError
-
delete_instance_process_slot
(resource_group_name, name, process_id, slot, instance_id, custom_headers=None, raw=False, **operation_config)[source]¶ Terminate a process by its ID for a web site, or a deployment slot, or specific scaled-out instance in a web site.
Terminate a process by its ID for a web site, or a deployment slot, or specific scaled-out instance in a web site.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Site name.
- process_id (str) – PID.
- slot (str) – Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.
- instance_id (str) – ID of a specific scaled-out instance. This is the value of the name property in the JSON response from “GET api/sites/{siteName}/instances”.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: None or ClientRawResponse if raw=true
Return type: None or ClientRawResponse
Raises: CloudError
-
delete_premier_add_on
(resource_group_name, name, premier_add_on_name, custom_headers=None, raw=False, **operation_config)[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_config – Operation configuration overrides.
Returns: None or ClientRawResponse if raw=true
Return type: None or ClientRawResponse
Raises: CloudError
-
delete_premier_add_on_slot
(resource_group_name, name, premier_add_on_name, slot, custom_headers=None, raw=False, **operation_config)[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_config – Operation configuration overrides.
Returns: None or ClientRawResponse if raw=true
Return type: None or ClientRawResponse
Raises: CloudError
-
delete_process
(resource_group_name, name, process_id, custom_headers=None, raw=False, **operation_config)[source]¶ Terminate a process by its ID for a web site, or a deployment slot, or specific scaled-out instance in a web site.
Terminate a process by its ID for a web site, or a deployment slot, or specific scaled-out instance in a web site.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Site name.
- process_id (str) – PID.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: None or ClientRawResponse if raw=true
Return type: None or ClientRawResponse
Raises: CloudError
-
delete_process_slot
(resource_group_name, name, process_id, slot, custom_headers=None, raw=False, **operation_config)[source]¶ Terminate a process by its ID for a web site, or a deployment slot, or specific scaled-out instance in a web site.
Terminate a process by its ID for a web site, or a deployment slot, or specific scaled-out instance in a web site.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Site name.
- process_id (str) – PID.
- slot (str) – Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: None or ClientRawResponse if raw=true
Return type: None or ClientRawResponse
Raises: CloudError
-
delete_public_certificate
(resource_group_name, name, public_certificate_name, custom_headers=None, raw=False, **operation_config)[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.
- public_certificate_name (str) – Public certificate name.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: None or ClientRawResponse if raw=true
Return type: None or ClientRawResponse
Raises: CloudError
-
delete_public_certificate_slot
(resource_group_name, name, slot, public_certificate_name, custom_headers=None, raw=False, **operation_config)[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.
- public_certificate_name (str) – Public certificate name.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: None or ClientRawResponse if raw=true
Return type: None or ClientRawResponse
Raises: CloudError
-
delete_relay_service_connection
(resource_group_name, name, entity_name, custom_headers=None, raw=False, **operation_config)[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_config – Operation configuration overrides.
Returns: None or ClientRawResponse if raw=true
Return type: None or ClientRawResponse
Raises: CloudError
-
delete_relay_service_connection_slot
(resource_group_name, name, entity_name, slot, custom_headers=None, raw=False, **operation_config)[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_config – Operation configuration overrides.
Returns: None or ClientRawResponse if raw=true
Return type: None or ClientRawResponse
Raises: CloudError
-
delete_site_extension
(resource_group_name, name, site_extension_id, custom_headers=None, raw=False, **operation_config)[source]¶ Remove a site extension from a web site, or a deployment slot.
Remove a site extension from a web site, or a deployment slot.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Site name.
- site_extension_id (str) – Site extension name.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: None or ClientRawResponse if raw=true
Return type: None or ClientRawResponse
Raises: CloudError
-
delete_site_extension_slot
(resource_group_name, name, site_extension_id, slot, custom_headers=None, raw=False, **operation_config)[source]¶ Remove a site extension from a web site, or a deployment slot.
Remove a site extension from a web site, or a deployment slot.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Site name.
- site_extension_id (str) – Site extension name.
- slot (str) – Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: None or ClientRawResponse if raw=true
Return type: None or ClientRawResponse
Raises: CloudError
-
delete_slot
(resource_group_name, name, slot, delete_metrics=None, delete_empty_server_farm=None, 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.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: None or ClientRawResponse if raw=true
Return type: None or ClientRawResponse
Raises: CloudError
-
delete_source_control
(resource_group_name, name, custom_headers=None, raw=False, **operation_config)[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_config – Operation configuration overrides.
Returns: None or ClientRawResponse if raw=true
Return type: None or ClientRawResponse
Raises: CloudError
-
delete_source_control_slot
(resource_group_name, name, slot, custom_headers=None, raw=False, **operation_config)[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_config – Operation configuration overrides.
Returns: None or ClientRawResponse if raw=true
Return type: None or ClientRawResponse
Raises: CloudError
-
delete_swift_virtual_network
(resource_group_name, name, custom_headers=None, raw=False, **operation_config)[source]¶ Deletes a Swift Virtual Network connection from an app (or deployment slot).
Deletes a Swift Virtual Network connection from an app (or deployment slot).
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Name of the app.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: None or ClientRawResponse if raw=true
Return type: None or ClientRawResponse
Raises: CloudError
-
delete_swift_virtual_network_slot
(resource_group_name, name, slot, custom_headers=None, raw=False, **operation_config)[source]¶ Deletes a Swift Virtual Network connection from an app (or deployment slot).
Deletes a Swift Virtual Network connection from an app (or 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 will delete the connection for the production slot.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: None or ClientRawResponse if raw=true
Return type: None or ClientRawResponse
Raises: CloudError
-
delete_triggered_web_job
(resource_group_name, name, web_job_name, custom_headers=None, raw=False, **operation_config)[source]¶ Delete a triggered web job by its ID for an app, or a deployment slot.
Delete a triggered web job by its ID for an app, or a deployment slot.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Site name.
- web_job_name (str) – Name of Web Job.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: None or ClientRawResponse if raw=true
Return type: None or ClientRawResponse
Raises: CloudError
-
delete_triggered_web_job_slot
(resource_group_name, name, web_job_name, slot, custom_headers=None, raw=False, **operation_config)[source]¶ Delete a triggered web job by its ID for an app, or a deployment slot.
Delete a triggered web job by its ID for an app, or a deployment slot.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Site name.
- web_job_name (str) – Name of Web Job.
- slot (str) – Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: None or ClientRawResponse if raw=true
Return type: None or ClientRawResponse
Raises: CloudError
-
delete_vnet_connection
(resource_group_name, name, vnet_name, custom_headers=None, raw=False, **operation_config)[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_config – Operation configuration overrides.
Returns: None or ClientRawResponse if raw=true
Return type: None or ClientRawResponse
Raises: CloudError
-
delete_vnet_connection_slot
(resource_group_name, name, vnet_name, slot, custom_headers=None, raw=False, **operation_config)[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_config – Operation configuration overrides.
Returns: None or ClientRawResponse if raw=true
Return type: None or ClientRawResponse
Raises: CloudError
-
discover_backup
(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. Use this to get information about the databases stored in a backup.
Discovers an existing app backup that can be restored from a blob in Azure storage. Use this to get information about the databases stored in a backup.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Name of the app.
- request (RestoreRequest) – A RestoreRequest object that includes Azure storage URL and blog name for discovery of backup.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: RestoreRequest or ClientRawResponse if raw=true
Return type: RestoreRequest or ClientRawResponse
Raises:
-
discover_backup_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. Use this to get information about the databases stored in a backup.
Discovers an existing app backup that can be restored from a blob in Azure storage. Use this to get information about the databases stored in a backup.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Name of the app.
- request (RestoreRequest) – A RestoreRequest object that includes Azure storage URL and blog name for discovery of backup.
- slot (str) – Name of the deployment slot. If a slot is not specified, the API will perform discovery for the production slot.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: RestoreRequest or ClientRawResponse if raw=true
Return type: RestoreRequest or ClientRawResponse
Raises:
-
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_config – Operation configuration overrides.
Returns: None or ClientRawResponse if raw=true
Return type: None or ClientRawResponse
Raises: CloudError
-
generate_new_site_publishing_password_slot
(resource_group_name, name, slot, custom_headers=None, raw=False, **operation_config)[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_config – Operation configuration overrides.
Returns: None or ClientRawResponse if raw=true
Return type: None or ClientRawResponse
Raises: CloudError
-
get
(resource_group_name, name, custom_headers=None, raw=False, **operation_config)[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_config – Operation configuration overrides.
Returns: Site or ClientRawResponse if raw=true
Return type: Site or ClientRawResponse
Raises: CloudError
-
get_auth_settings
(resource_group_name, name, custom_headers=None, raw=False, **operation_config)[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_config – Operation configuration overrides.
Returns: SiteAuthSettings or ClientRawResponse if raw=true
Return type: SiteAuthSettings or ClientRawResponse
Raises:
-
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_config – Operation configuration overrides.
Returns: SiteAuthSettings or ClientRawResponse if raw=true
Return type: SiteAuthSettings or ClientRawResponse
Raises:
-
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_config – Operation configuration overrides.
Returns: BackupRequest or ClientRawResponse if raw=true
Return type: BackupRequest or ClientRawResponse
Raises:
-
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_config – Operation configuration overrides.
Returns: BackupRequest or ClientRawResponse if raw=true
Return type: BackupRequest or ClientRawResponse
Raises:
-
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_config – Operation configuration overrides.
Returns: BackupItem or ClientRawResponse if raw=true
Return type: BackupItem or ClientRawResponse
Raises:
-
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_config – Operation configuration overrides.
Returns: BackupItem or ClientRawResponse if raw=true
Return type: BackupItem or ClientRawResponse
Raises:
-
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_config – Operation configuration overrides.
Returns: SiteConfigResource or ClientRawResponse if raw=true
Return type: SiteConfigResource or ClientRawResponse
Raises:
-
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_config – Operation configuration overrides.
Returns: SiteConfigResource or ClientRawResponse if raw=true
Return type: SiteConfigResource or ClientRawResponse
Raises:
-
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_config – Operation configuration overrides.
Returns: SiteConfigResource or ClientRawResponse if raw=true
Return type: SiteConfigResource or ClientRawResponse
Raises:
-
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_config – Operation configuration overrides.
Returns: SiteConfigResource or ClientRawResponse if raw=true
Return type: SiteConfigResource or ClientRawResponse
Raises:
-
get_container_logs_zip
(resource_group_name, name, custom_headers=None, raw=False, callback=None, **operation_config)[source]¶ Gets the ZIP archived docker log files for the given site.
Gets the ZIP archived docker log files for the given site.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Name of web app.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- callback (Callable[Bytes, response=None]) – When specified, will be called with each chunk of data that is streamed. The callback should take two arguments, the bytes of the current chunk of data and the response object. If the data is uploading, response will be None.
- operation_config – Operation configuration overrides.
Returns: object or ClientRawResponse if raw=true
Return type: Generator or ClientRawResponse
Raises: CloudError
-
get_container_logs_zip_slot
(resource_group_name, name, slot, custom_headers=None, raw=False, callback=None, **operation_config)[source]¶ Gets the ZIP archived docker log files for the given site.
Gets the ZIP archived docker log files for the given site.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Name of web app.
- slot (str) – Name of web app slot. If not specified then will default to production slot.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- callback (Callable[Bytes, response=None]) – When specified, will be called with each chunk of data that is streamed. The callback should take two arguments, the bytes of the current chunk of data and the response object. If the data is uploading, response will be None.
- operation_config – Operation configuration overrides.
Returns: object or ClientRawResponse if raw=true
Return type: Generator or ClientRawResponse
Raises: CloudError
-
get_continuous_web_job
(resource_group_name, name, web_job_name, custom_headers=None, raw=False, **operation_config)[source]¶ Gets a continuous web job by its ID for an app, or a deployment slot.
Gets a continuous web job by its ID for an app, or a deployment slot.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Site name.
- web_job_name (str) – Name of Web Job.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: ContinuousWebJob or ClientRawResponse if raw=true
Return type: ContinuousWebJob or ClientRawResponse
Raises: CloudError
-
get_continuous_web_job_slot
(resource_group_name, name, web_job_name, slot, custom_headers=None, raw=False, **operation_config)[source]¶ Gets a continuous web job by its ID for an app, or a deployment slot.
Gets a continuous web job by its ID for an app, or a deployment slot.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Site name.
- web_job_name (str) – Name of Web Job.
- slot (str) – Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: ContinuousWebJob or ClientRawResponse if raw=true
Return type: ContinuousWebJob or ClientRawResponse
Raises: CloudError
-
get_deployment
(resource_group_name, name, id, custom_headers=None, raw=False, **operation_config)[source]¶ Get a deployment by its ID for an app, or a deployment slot.
Get a deployment by its ID for an app, or a deployment slot.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Name of the app.
- id (str) – Deployment ID.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: Deployment or ClientRawResponse if raw=true
Return type: Deployment or ClientRawResponse
Raises:
-
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, or a deployment slot.
Get a deployment by its ID for an app, or a deployment slot.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Name of the app.
- id (str) – Deployment ID.
- slot (str) – Name of the deployment slot. If a slot is not specified, the API gets a deployment for the production slot.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: Deployment or ClientRawResponse if raw=true
Return type: Deployment or ClientRawResponse
Raises:
-
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_config – Operation configuration overrides.
Returns: SiteLogsConfig or ClientRawResponse if raw=true
Return type: SiteLogsConfig or ClientRawResponse
Raises:
-
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_config – Operation configuration overrides.
Returns: SiteLogsConfig or ClientRawResponse if raw=true
Return type: SiteLogsConfig or ClientRawResponse
Raises:
-
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_config – Operation configuration overrides.
Returns: Identifier or ClientRawResponse if raw=true
Return type: Identifier or ClientRawResponse
Raises:
-
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_config – Operation configuration overrides.
Returns: Identifier or ClientRawResponse if raw=true
Return type: Identifier or ClientRawResponse
Raises:
-
get_function
(resource_group_name, name, function_name, custom_headers=None, raw=False, **operation_config)[source]¶ Get function information by its ID for web site, or a deployment slot.
Get function information by its ID for web site, or a deployment slot.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Site name.
- function_name (str) – Function name.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: FunctionEnvelope or ClientRawResponse if raw=true
Return type: FunctionEnvelope or ClientRawResponse
Raises: CloudError
-
get_functions_admin_token
(resource_group_name, name, custom_headers=None, raw=False, **operation_config)[source]¶ Fetch a short lived token that can be exchanged for a master key.
Fetch a short lived token that can be exchanged for a master key.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Name of web app.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: str or ClientRawResponse if raw=true
Return type: str or ClientRawResponse
Raises:
-
get_functions_admin_token_slot
(resource_group_name, name, slot, custom_headers=None, raw=False, **operation_config)[source]¶ Fetch a short lived token that can be exchanged for a master key.
Fetch a short lived token that can be exchanged for a master key.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Name of web app.
- slot (str) – Name of web app slot. If not specified then will default to production slot.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: str or ClientRawResponse if raw=true
Return type: str or ClientRawResponse
Raises:
-
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_config – Operation configuration overrides.
Returns: HostNameBinding or ClientRawResponse if raw=true
Return type: HostNameBinding or ClientRawResponse
Raises:
-
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_config – Operation configuration overrides.
Returns: HostNameBinding or ClientRawResponse if raw=true
Return type: HostNameBinding or ClientRawResponse
Raises:
-
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_config – Operation configuration overrides.
Returns: HybridConnection or ClientRawResponse if raw=true
Return type: HybridConnection or ClientRawResponse
Raises:
-
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_config – Operation configuration overrides.
Returns: HybridConnection or ClientRawResponse if raw=true
Return type: HybridConnection or ClientRawResponse
Raises:
-
get_instance_function_slot
(resource_group_name, name, function_name, slot, custom_headers=None, raw=False, **operation_config)[source]¶ Get function information by its ID for web site, or a deployment slot.
Get function information by its ID for web site, or a deployment slot.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Site name.
- function_name (str) – Function name.
- slot (str) – Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: FunctionEnvelope or ClientRawResponse if raw=true
Return type: FunctionEnvelope or ClientRawResponse
Raises: CloudError
-
get_instance_ms_deploy_log
(resource_group_name, name, instance_id, custom_headers=None, raw=False, **operation_config)[source]¶ Get the MSDeploy Log for the last MSDeploy operation.
Get the MSDeploy Log for the last MSDeploy operation.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Name of web app.
- instance_id (str) – ID of web app instance.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: MSDeployLog or ClientRawResponse if raw=true
Return type: MSDeployLog or ClientRawResponse
Raises: CloudError
-
get_instance_ms_deploy_log_slot
(resource_group_name, name, slot, instance_id, custom_headers=None, raw=False, **operation_config)[source]¶ Get the MSDeploy Log for the last MSDeploy operation.
Get the MSDeploy Log for the last MSDeploy operation.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Name of web app.
- slot (str) – Name of web app slot. If not specified then will default to production slot.
- instance_id (str) – ID of web app instance.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: MSDeployLog or ClientRawResponse if raw=true
Return type: MSDeployLog or ClientRawResponse
Raises: CloudError
-
get_instance_ms_deploy_status
(resource_group_name, name, instance_id, custom_headers=None, raw=False, **operation_config)[source]¶ Get the status of the last MSDeploy operation.
Get the status of the last MSDeploy operation.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Name of web app.
- instance_id (str) – ID of web app instance.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: MSDeployStatus or ClientRawResponse if raw=true
Return type: MSDeployStatus or ClientRawResponse
Raises:
-
get_instance_ms_deploy_status_slot
(resource_group_name, name, slot, instance_id, custom_headers=None, raw=False, **operation_config)[source]¶ Get the status of the last MSDeploy operation.
Get the status of the last MSDeploy operation.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Name of web app.
- slot (str) – Name of web app slot. If not specified then will default to production slot.
- instance_id (str) – ID of web app instance.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: MSDeployStatus or ClientRawResponse if raw=true
Return type: MSDeployStatus or ClientRawResponse
Raises:
-
get_instance_process
(resource_group_name, name, process_id, instance_id, custom_headers=None, raw=False, **operation_config)[source]¶ Get process information by its ID for a specific scaled-out instance in a web site.
Get process information by its ID for a specific scaled-out instance in a web site.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Site name.
- process_id (str) – PID.
- instance_id (str) – ID of a specific scaled-out instance. This is the value of the name property in the JSON response from “GET api/sites/{siteName}/instances”.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: ProcessInfo or ClientRawResponse if raw=true
Return type: ProcessInfo or ClientRawResponse
Raises: CloudError
-
get_instance_process_dump
(resource_group_name, name, process_id, instance_id, custom_headers=None, raw=False, callback=None, **operation_config)[source]¶ Get a memory dump of a process by its ID for a specific scaled-out instance in a web site.
Get a memory dump of a process by its ID for a specific scaled-out instance in a web site.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Site name.
- process_id (str) – PID.
- instance_id (str) – ID of a specific scaled-out instance. This is the value of the name property in the JSON response from “GET api/sites/{siteName}/instances”.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- callback (Callable[Bytes, response=None]) – When specified, will be called with each chunk of data that is streamed. The callback should take two arguments, the bytes of the current chunk of data and the response object. If the data is uploading, response will be None.
- operation_config – Operation configuration overrides.
Returns: object or ClientRawResponse if raw=true
Return type: Generator or ClientRawResponse
Raises: CloudError
-
get_instance_process_dump_slot
(resource_group_name, name, process_id, slot, instance_id, custom_headers=None, raw=False, callback=None, **operation_config)[source]¶ Get a memory dump of a process by its ID for a specific scaled-out instance in a web site.
Get a memory dump of a process by its ID for a specific scaled-out instance in a web site.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Site name.
- process_id (str) – PID.
- slot (str) – Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.
- instance_id (str) – ID of a specific scaled-out instance. This is the value of the name property in the JSON response from “GET api/sites/{siteName}/instances”.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- callback (Callable[Bytes, response=None]) – When specified, will be called with each chunk of data that is streamed. The callback should take two arguments, the bytes of the current chunk of data and the response object. If the data is uploading, response will be None.
- operation_config – Operation configuration overrides.
Returns: object or ClientRawResponse if raw=true
Return type: Generator or ClientRawResponse
Raises: CloudError
-
get_instance_process_module
(resource_group_name, name, process_id, base_address, instance_id, custom_headers=None, raw=False, **operation_config)[source]¶ Get process information by its ID for a specific scaled-out instance in a web site.
Get process information by its ID for a specific scaled-out instance in a web site.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Site name.
- process_id (str) – PID.
- base_address (str) – Module base address.
- instance_id (str) – ID of a specific scaled-out instance. This is the value of the name property in the JSON response from “GET api/sites/{siteName}/instances”.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: ProcessModuleInfo or ClientRawResponse if raw=true
Return type: ProcessModuleInfo or ClientRawResponse
Raises: CloudError
-
get_instance_process_module_slot
(resource_group_name, name, process_id, base_address, slot, instance_id, custom_headers=None, raw=False, **operation_config)[source]¶ Get process information by its ID for a specific scaled-out instance in a web site.
Get process information by its ID for a specific scaled-out instance in a web site.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Site name.
- process_id (str) – PID.
- base_address (str) – Module base address.
- slot (str) – Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.
- instance_id (str) – ID of a specific scaled-out instance. This is the value of the name property in the JSON response from “GET api/sites/{siteName}/instances”.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: ProcessModuleInfo or ClientRawResponse if raw=true
Return type: ProcessModuleInfo or ClientRawResponse
Raises: CloudError
-
get_instance_process_slot
(resource_group_name, name, process_id, slot, instance_id, custom_headers=None, raw=False, **operation_config)[source]¶ Get process information by its ID for a specific scaled-out instance in a web site.
Get process information by its ID for a specific scaled-out instance in a web site.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Site name.
- process_id (str) – PID.
- slot (str) – Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.
- instance_id (str) – ID of a specific scaled-out instance. This is the value of the name property in the JSON response from “GET api/sites/{siteName}/instances”.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: ProcessInfo or ClientRawResponse if raw=true
Return type: ProcessInfo or ClientRawResponse
Raises: CloudError
-
get_instance_process_thread
(resource_group_name, name, process_id, thread_id, instance_id, custom_headers=None, raw=False, **operation_config)[source]¶ Get thread information by Thread ID for a specific process, in a specific scaled-out instance in a web site.
Get thread information by Thread ID for a specific process, in a specific scaled-out instance in a web site.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Site name.
- process_id (str) – PID.
- thread_id (str) – TID.
- instance_id (str) – ID of a specific scaled-out instance. This is the value of the name property in the JSON response from “GET api/sites/{siteName}/instances”.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: ProcessThreadInfo or ClientRawResponse if raw=true
Return type: ProcessThreadInfo or ClientRawResponse
Raises: CloudError
-
get_instance_process_thread_slot
(resource_group_name, name, process_id, thread_id, slot, instance_id, custom_headers=None, raw=False, **operation_config)[source]¶ Get thread information by Thread ID for a specific process, in a specific scaled-out instance in a web site.
Get thread information by Thread ID for a specific process, in a specific scaled-out instance in a web site.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Site name.
- process_id (str) – PID.
- thread_id (str) – TID.
- slot (str) – Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.
- instance_id (str) – ID of a specific scaled-out instance. This is the value of the name property in the JSON response from “GET api/sites/{siteName}/instances”.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: ProcessThreadInfo or ClientRawResponse if raw=true
Return type: ProcessThreadInfo or ClientRawResponse
Raises: CloudError
-
get_migrate_my_sql_status
(resource_group_name, name, custom_headers=None, raw=False, **operation_config)[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_config – Operation configuration overrides.
Returns: MigrateMySqlStatus or ClientRawResponse if raw=true
Return type: MigrateMySqlStatus or ClientRawResponse
Raises:
-
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_config – Operation configuration overrides.
Returns: MigrateMySqlStatus or ClientRawResponse if raw=true
Return type: MigrateMySqlStatus or ClientRawResponse
Raises:
-
get_ms_deploy_log
(resource_group_name, name, custom_headers=None, raw=False, **operation_config)[source]¶ Get the MSDeploy Log for the last MSDeploy operation.
Get the MSDeploy Log for the last MSDeploy operation.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Name of web app.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: MSDeployLog or ClientRawResponse if raw=true
Return type: MSDeployLog or ClientRawResponse
Raises: CloudError
-
get_ms_deploy_log_slot
(resource_group_name, name, slot, custom_headers=None, raw=False, **operation_config)[source]¶ Get the MSDeploy Log for the last MSDeploy operation.
Get the MSDeploy Log for the last MSDeploy operation.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Name of web app.
- slot (str) – Name of web app slot. If not specified then will default to production slot.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: MSDeployLog or ClientRawResponse if raw=true
Return type: MSDeployLog or ClientRawResponse
Raises: CloudError
-
get_ms_deploy_status
(resource_group_name, name, custom_headers=None, raw=False, **operation_config)[source]¶ Get the status of the last MSDeploy operation.
Get the status of the last MSDeploy operation.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Name of web app.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: MSDeployStatus or ClientRawResponse if raw=true
Return type: MSDeployStatus or ClientRawResponse
Raises:
-
get_ms_deploy_status_slot
(resource_group_name, name, slot, custom_headers=None, raw=False, **operation_config)[source]¶ Get the status of the last MSDeploy operation.
Get the status of the last MSDeploy operation.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Name of web app.
- slot (str) – Name of web app slot. If not specified then will default to production slot.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: MSDeployStatus or ClientRawResponse if raw=true
Return type: MSDeployStatus or ClientRawResponse
Raises:
-
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_config – Operation configuration overrides.
Returns: PremierAddOn or ClientRawResponse if raw=true
Return type: PremierAddOn or ClientRawResponse
Raises:
-
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_config – Operation configuration overrides.
Returns: PremierAddOn or ClientRawResponse if raw=true
Return type: PremierAddOn or ClientRawResponse
Raises:
-
get_private_access
(resource_group_name, name, custom_headers=None, raw=False, **operation_config)[source]¶ Gets data around private site access enablement and authorized Virtual Networks that can access the site.
Gets data around private site access enablement and authorized Virtual Networks that can access the site.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – The name of the web app.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: PrivateAccess or ClientRawResponse if raw=true
Return type: PrivateAccess or ClientRawResponse
Raises:
-
get_private_access_slot
(resource_group_name, name, slot, custom_headers=None, raw=False, **operation_config)[source]¶ Gets data around private site access enablement and authorized Virtual Networks that can access the site.
Gets data around private site access enablement and authorized Virtual Networks that can access the site.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – The name of the web app.
- slot (str) – The name of the slot for the web app.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: PrivateAccess or ClientRawResponse if raw=true
Return type: PrivateAccess or ClientRawResponse
Raises:
-
get_process
(resource_group_name, name, process_id, custom_headers=None, raw=False, **operation_config)[source]¶ Get process information by its ID for a specific scaled-out instance in a web site.
Get process information by its ID for a specific scaled-out instance in a web site.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Site name.
- process_id (str) – PID.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: ProcessInfo or ClientRawResponse if raw=true
Return type: ProcessInfo or ClientRawResponse
Raises: CloudError
-
get_process_dump
(resource_group_name, name, process_id, custom_headers=None, raw=False, callback=None, **operation_config)[source]¶ Get a memory dump of a process by its ID for a specific scaled-out instance in a web site.
Get a memory dump of a process by its ID for a specific scaled-out instance in a web site.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Site name.
- process_id (str) – PID.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- callback (Callable[Bytes, response=None]) – When specified, will be called with each chunk of data that is streamed. The callback should take two arguments, the bytes of the current chunk of data and the response object. If the data is uploading, response will be None.
- operation_config – Operation configuration overrides.
Returns: object or ClientRawResponse if raw=true
Return type: Generator or ClientRawResponse
Raises: CloudError
-
get_process_dump_slot
(resource_group_name, name, process_id, slot, custom_headers=None, raw=False, callback=None, **operation_config)[source]¶ Get a memory dump of a process by its ID for a specific scaled-out instance in a web site.
Get a memory dump of a process by its ID for a specific scaled-out instance in a web site.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Site name.
- process_id (str) – PID.
- slot (str) – Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- callback (Callable[Bytes, response=None]) – When specified, will be called with each chunk of data that is streamed. The callback should take two arguments, the bytes of the current chunk of data and the response object. If the data is uploading, response will be None.
- operation_config – Operation configuration overrides.
Returns: object or ClientRawResponse if raw=true
Return type: Generator or ClientRawResponse
Raises: CloudError
-
get_process_module
(resource_group_name, name, process_id, base_address, custom_headers=None, raw=False, **operation_config)[source]¶ Get process information by its ID for a specific scaled-out instance in a web site.
Get process information by its ID for a specific scaled-out instance in a web site.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Site name.
- process_id (str) – PID.
- base_address (str) – Module base address.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: ProcessModuleInfo or ClientRawResponse if raw=true
Return type: ProcessModuleInfo or ClientRawResponse
Raises: CloudError
-
get_process_module_slot
(resource_group_name, name, process_id, base_address, slot, custom_headers=None, raw=False, **operation_config)[source]¶ Get process information by its ID for a specific scaled-out instance in a web site.
Get process information by its ID for a specific scaled-out instance in a web site.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Site name.
- process_id (str) – PID.
- base_address (str) – Module base address.
- slot (str) – Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: ProcessModuleInfo or ClientRawResponse if raw=true
Return type: ProcessModuleInfo or ClientRawResponse
Raises: CloudError
-
get_process_slot
(resource_group_name, name, process_id, slot, custom_headers=None, raw=False, **operation_config)[source]¶ Get process information by its ID for a specific scaled-out instance in a web site.
Get process information by its ID for a specific scaled-out instance in a web site.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Site name.
- process_id (str) – PID.
- slot (str) – Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: ProcessInfo or ClientRawResponse if raw=true
Return type: ProcessInfo or ClientRawResponse
Raises: CloudError
-
get_process_thread
(resource_group_name, name, process_id, thread_id, custom_headers=None, raw=False, **operation_config)[source]¶ Get thread information by Thread ID for a specific process, in a specific scaled-out instance in a web site.
Get thread information by Thread ID for a specific process, in a specific scaled-out instance in a web site.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Site name.
- process_id (str) – PID.
- thread_id (str) – TID.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: ProcessThreadInfo or ClientRawResponse if raw=true
Return type: ProcessThreadInfo or ClientRawResponse
Raises: CloudError
-
get_process_thread_slot
(resource_group_name, name, process_id, thread_id, slot, custom_headers=None, raw=False, **operation_config)[source]¶ Get thread information by Thread ID for a specific process, in a specific scaled-out instance in a web site.
Get thread information by Thread ID for a specific process, in a specific scaled-out instance in a web site.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Site name.
- process_id (str) – PID.
- thread_id (str) – TID.
- slot (str) – Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: ProcessThreadInfo or ClientRawResponse if raw=true
Return type: ProcessThreadInfo or ClientRawResponse
Raises: CloudError
-
get_public_certificate
(resource_group_name, name, public_certificate_name, custom_headers=None, raw=False, **operation_config)[source]¶ Get the named public certificate for an app (or deployment slot, if specified).
Get the named public certificate for an app (or deployment slot, if specified).
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Name of the app.
- public_certificate_name (str) – Public certificate name.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: PublicCertificate or ClientRawResponse if raw=true
Return type: PublicCertificate or ClientRawResponse
Raises:
-
get_public_certificate_slot
(resource_group_name, name, slot, public_certificate_name, custom_headers=None, raw=False, **operation_config)[source]¶ Get the named public certificate for an app (or deployment slot, if specified).
Get the named public certificate for an app (or deployment slot, if specified).
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Name of the app.
- slot (str) – Name of the deployment slot. If a slot is not specified, the API the named binding for the production slot.
- public_certificate_name (str) – Public certificate name.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: PublicCertificate or ClientRawResponse if raw=true
Return type: PublicCertificate or ClientRawResponse
Raises:
-
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_config – Operation configuration overrides.
Returns: RelayServiceConnectionEntity or ClientRawResponse if raw=true
Return type: RelayServiceConnectionEntity or ClientRawResponse
Raises:
-
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_config – Operation configuration overrides.
Returns: RelayServiceConnectionEntity or ClientRawResponse if raw=true
Return type: RelayServiceConnectionEntity or ClientRawResponse
Raises:
-
get_site_extension
(resource_group_name, name, site_extension_id, custom_headers=None, raw=False, **operation_config)[source]¶ Get site extension information by its ID for a web site, or a deployment slot.
Get site extension information by its ID for a web site, or a deployment slot.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Site name.
- site_extension_id (str) – Site extension name.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: SiteExtensionInfo or ClientRawResponse if raw=true
Return type: SiteExtensionInfo or ClientRawResponse
Raises: CloudError
-
get_site_extension_slot
(resource_group_name, name, site_extension_id, slot, custom_headers=None, raw=False, **operation_config)[source]¶ Get site extension information by its ID for a web site, or a deployment slot.
Get site extension information by its ID for a web site, or a deployment slot.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Site name.
- site_extension_id (str) – Site extension name.
- slot (str) – Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: SiteExtensionInfo or ClientRawResponse if raw=true
Return type: SiteExtensionInfo or ClientRawResponse
Raises: CloudError
-
get_site_php_error_log_flag
(resource_group_name, name, custom_headers=None, raw=False, **operation_config)[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_config – Operation configuration overrides.
Returns: SitePhpErrorLogFlag or ClientRawResponse if raw=true
Return type: SitePhpErrorLogFlag or ClientRawResponse
Raises:
-
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_config – Operation configuration overrides.
Returns: SitePhpErrorLogFlag or ClientRawResponse if raw=true
Return type: SitePhpErrorLogFlag or ClientRawResponse
Raises:
-
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_config – Operation configuration overrides.
Returns: Site or ClientRawResponse if raw=true
Return type: Site or ClientRawResponse
Raises: CloudError
-
get_source_control
(resource_group_name, name, custom_headers=None, raw=False, **operation_config)[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_config – Operation configuration overrides.
Returns: SiteSourceControl or ClientRawResponse if raw=true
Return type: SiteSourceControl or ClientRawResponse
Raises:
-
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_config – Operation configuration overrides.
Returns: SiteSourceControl or ClientRawResponse if raw=true
Return type: SiteSourceControl or ClientRawResponse
Raises:
-
get_swift_virtual_network_connection
(resource_group_name, name, custom_headers=None, raw=False, **operation_config)[source]¶ Gets a Swift Virtual Network connection.
Gets a Swift Virtual Network connection.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Name of the app.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: SwiftVirtualNetwork or ClientRawResponse if raw=true
Return type: SwiftVirtualNetwork or ClientRawResponse
Raises:
-
get_swift_virtual_network_connection_slot
(resource_group_name, name, slot, custom_headers=None, raw=False, **operation_config)[source]¶ Gets a Swift Virtual Network connection.
Gets a Swift Virtual Network connection.
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 a gateway for the production slot’s Virtual Network.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: SwiftVirtualNetwork or ClientRawResponse if raw=true
Return type: SwiftVirtualNetwork or ClientRawResponse
Raises:
-
get_triggered_web_job
(resource_group_name, name, web_job_name, custom_headers=None, raw=False, **operation_config)[source]¶ Gets a triggered web job by its ID for an app, or a deployment slot.
Gets a triggered web job by its ID for an app, or a deployment slot.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Site name.
- web_job_name (str) – Name of Web Job.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: TriggeredWebJob or ClientRawResponse if raw=true
Return type: TriggeredWebJob or ClientRawResponse
Raises: CloudError
-
get_triggered_web_job_history
(resource_group_name, name, web_job_name, id, custom_headers=None, raw=False, **operation_config)[source]¶ Gets a triggered web job’s history by its ID for an app, , or a deployment slot.
Gets a triggered web job’s history by its ID for an app, , or a deployment slot.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Site name.
- web_job_name (str) – Name of Web Job.
- id (str) – History ID.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: TriggeredJobHistory or ClientRawResponse if raw=true
Return type: TriggeredJobHistory or ClientRawResponse
Raises: CloudError
-
get_triggered_web_job_history_slot
(resource_group_name, name, web_job_name, id, slot, custom_headers=None, raw=False, **operation_config)[source]¶ Gets a triggered web job’s history by its ID for an app, , or a deployment slot.
Gets a triggered web job’s history by its ID for an app, , or a deployment slot.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Site name.
- web_job_name (str) – Name of Web Job.
- id (str) – History ID.
- slot (str) – Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: TriggeredJobHistory or ClientRawResponse if raw=true
Return type: TriggeredJobHistory or ClientRawResponse
Raises: CloudError
-
get_triggered_web_job_slot
(resource_group_name, name, web_job_name, slot, custom_headers=None, raw=False, **operation_config)[source]¶ Gets a triggered web job by its ID for an app, or a deployment slot.
Gets a triggered web job by its ID for an app, or a deployment slot.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Site name.
- web_job_name (str) – Name of Web Job.
- slot (str) – Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: TriggeredWebJob or ClientRawResponse if raw=true
Return type: TriggeredWebJob or ClientRawResponse
Raises: CloudError
-
get_vnet_connection
(resource_group_name, name, vnet_name, custom_headers=None, raw=False, **operation_config)[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_config – Operation configuration overrides.
Returns: VnetInfo or ClientRawResponse if raw=true
Return type: VnetInfo or ClientRawResponse
Raises:
-
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_config – Operation configuration overrides.
Returns: VnetGateway or ClientRawResponse if raw=true
Return type: VnetGateway or ClientRawResponse
Raises: CloudError
-
get_vnet_connection_gateway_slot
(resource_group_name, name, vnet_name, gateway_name, slot, custom_headers=None, raw=False, **operation_config)[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_config – Operation configuration overrides.
Returns: VnetGateway or ClientRawResponse if raw=true
Return type: VnetGateway or ClientRawResponse
Raises: CloudError
-
get_vnet_connection_slot
(resource_group_name, name, vnet_name, slot, custom_headers=None, raw=False, **operation_config)[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_config – Operation configuration overrides.
Returns: VnetInfo or ClientRawResponse if raw=true
Return type: VnetInfo or ClientRawResponse
Raises:
-
get_web_job
(resource_group_name, name, web_job_name, custom_headers=None, raw=False, **operation_config)[source]¶ Get webjob information for an app, or a deployment slot.
Get webjob information for an app, or a deployment slot.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Site name.
- web_job_name (str) – Name of the web job.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: WebJob or ClientRawResponse if raw=true
Return type: WebJob or ClientRawResponse
Raises:
-
get_web_job_slot
(resource_group_name, name, web_job_name, slot, custom_headers=None, raw=False, **operation_config)[source]¶ Get webjob information for an app, or a deployment slot.
Get webjob information for an app, or a deployment slot.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Site name.
- web_job_name (str) – Name of the web job.
- slot (str) – Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: WebJob or ClientRawResponse if raw=true
Return type: WebJob or ClientRawResponse
Raises:
-
get_web_site_container_logs
(resource_group_name, name, custom_headers=None, raw=False, callback=None, **operation_config)[source]¶ Gets the last lines of docker logs for the given site.
Gets the last lines of docker logs for the given site.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Name of web app.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- callback (Callable[Bytes, response=None]) – When specified, will be called with each chunk of data that is streamed. The callback should take two arguments, the bytes of the current chunk of data and the response object. If the data is uploading, response will be None.
- operation_config – Operation configuration overrides.
Returns: object or ClientRawResponse if raw=true
Return type: Generator or ClientRawResponse
Raises: CloudError
-
get_web_site_container_logs_slot
(resource_group_name, name, slot, custom_headers=None, raw=False, callback=None, **operation_config)[source]¶ Gets the last lines of docker logs for the given site.
Gets the last lines of docker logs for the given site.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Name of web app.
- slot (str) – Name of web app slot. If not specified then will default to production slot.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- callback (Callable[Bytes, response=None]) – When specified, will be called with each chunk of data that is streamed. The callback should take two arguments, the bytes of the current chunk of data and the response object. If the data is uploading, response will be None.
- operation_config – Operation configuration overrides.
Returns: object or ClientRawResponse if raw=true
Return type: Generator or ClientRawResponse
Raises: CloudError
-
install_site_extension
(resource_group_name, name, site_extension_id, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Install site extension on a web site, or a deployment slot.
Install site extension on a web site, or a deployment slot.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Site name.
- site_extension_id (str) – Site extension name.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
- polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
Returns: An instance of LROPoller that returns SiteExtensionInfo or ClientRawResponse<SiteExtensionInfo> if raw==True
Return type: AzureOperationPoller[SiteExtensionInfo] or AzureOperationPoller[ClientRawResponse[SiteExtensionInfo]]
Raises: CloudError
-
install_site_extension_slot
(resource_group_name, name, site_extension_id, slot, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Install site extension on a web site, or a deployment slot.
Install site extension on a web site, or a deployment slot.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Site name.
- site_extension_id (str) – Site extension name.
- slot (str) – Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
- polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
Returns: An instance of LROPoller that returns SiteExtensionInfo or ClientRawResponse<SiteExtensionInfo> if raw==True
Return type: AzureOperationPoller[SiteExtensionInfo] or AzureOperationPoller[ClientRawResponse[SiteExtensionInfo]]
Raises: CloudError
-
is_cloneable
(resource_group_name, name, custom_headers=None, raw=False, **operation_config)[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_config – Operation configuration overrides.
Returns: SiteCloneability or ClientRawResponse if raw=true
Return type: SiteCloneability or ClientRawResponse
Raises:
-
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_config – Operation configuration overrides.
Returns: SiteCloneability or ClientRawResponse if raw=true
Return type: SiteCloneability or ClientRawResponse
Raises:
-
list
(custom_headers=None, raw=False, **operation_config)[source]¶ Get all apps for a subscription.
Get all apps for a subscription.
Parameters: - custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: An iterator like instance of Site
Return type: Raises:
-
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_config – Operation configuration overrides.
Returns: StringDictionary or ClientRawResponse if raw=true
Return type: StringDictionary or ClientRawResponse
Raises:
-
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_config – Operation configuration overrides.
Returns: StringDictionary or ClientRawResponse if raw=true
Return type: StringDictionary or ClientRawResponse
Raises:
-
list_azure_storage_accounts
(resource_group_name, name, custom_headers=None, raw=False, **operation_config)[source]¶ Gets the Azure storage account configurations of an app.
Gets the Azure storage account configurations of an app.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Name of the app.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: AzureStoragePropertyDictionaryResource or ClientRawResponse if raw=true
Return type: AzureStoragePropertyDictionaryResource or ClientRawResponse
Raises:
-
list_azure_storage_accounts_slot
(resource_group_name, name, slot, custom_headers=None, raw=False, **operation_config)[source]¶ Gets the Azure storage account configurations of an app.
Gets the Azure storage account 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 update the Azure storage account configurations for the production slot.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: AzureStoragePropertyDictionaryResource or ClientRawResponse if raw=true
Return type: AzureStoragePropertyDictionaryResource or ClientRawResponse
Raises:
-
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_config – Operation configuration overrides.
Returns: BackupItem or ClientRawResponse if raw=true
Return type: BackupItem or ClientRawResponse
Raises:
-
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_config – Operation configuration overrides.
Returns: BackupItem or ClientRawResponse if raw=true
Return type: BackupItem or ClientRawResponse
Raises:
-
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_config – Operation configuration overrides.
Returns: An iterator like instance of BackupItem
Return type: Raises:
-
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_config – Operation configuration overrides.
Returns: An iterator like instance of BackupItem
Return type: Raises:
-
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_config – Operation configuration overrides.
Returns: An iterator like instance of Site
Return type: Raises:
-
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_config – Operation configuration overrides.
Returns: An iterator like instance of SiteConfigurationSnapshotInfo
Return type: SiteConfigurationSnapshotInfoPaged[SiteConfigurationSnapshotInfo]
Raises:
-
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_config – Operation configuration overrides.
Returns: An iterator like instance of SiteConfigurationSnapshotInfo
Return type: SiteConfigurationSnapshotInfoPaged[SiteConfigurationSnapshotInfo]
Raises:
-
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_config – Operation configuration overrides.
Returns: An iterator like instance of SiteConfigResource
Return type: Raises:
-
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_config – Operation configuration overrides.
Returns: An iterator like instance of SiteConfigResource
Return type: Raises:
-
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_config – Operation configuration overrides.
Returns: ConnectionStringDictionary or ClientRawResponse if raw=true
Return type: ConnectionStringDictionary or ClientRawResponse
Raises:
-
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_config – Operation configuration overrides.
Returns: ConnectionStringDictionary or ClientRawResponse if raw=true
Return type: ConnectionStringDictionary or ClientRawResponse
Raises:
-
list_continuous_web_jobs
(resource_group_name, name, custom_headers=None, raw=False, **operation_config)[source]¶ List continuous web jobs for an app, or a deployment slot.
List continuous web jobs for an app, or a deployment slot.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Site name.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: An iterator like instance of ContinuousWebJob
Return type: Raises:
-
list_continuous_web_jobs_slot
(resource_group_name, name, slot, custom_headers=None, raw=False, **operation_config)[source]¶ List continuous web jobs for an app, or a deployment slot.
List continuous web jobs for an app, or a deployment slot.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Site name.
- slot (str) – Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: An iterator like instance of ContinuousWebJob
Return type: Raises:
-
list_deployment_log
(resource_group_name, name, id, custom_headers=None, raw=False, **operation_config)[source]¶ List deployment log for specific deployment for an app, or a deployment slot.
List deployment log for specific deployment for an app, or a deployment slot.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Name of the app.
- id (str) – The ID of a specific deployment. This is the value of the name property in the JSON response from “GET /api/sites/{siteName}/deployments”.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: Deployment or ClientRawResponse if raw=true
Return type: Deployment or ClientRawResponse
Raises:
-
list_deployment_log_slot
(resource_group_name, name, id, slot, custom_headers=None, raw=False, **operation_config)[source]¶ List deployment log for specific deployment for an app, or a deployment slot.
List deployment log for specific deployment for an app, or a deployment slot.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Name of the app.
- id (str) – The ID of a specific deployment. This is the value of the name property in the JSON response from “GET /api/sites/{siteName}/deployments”.
- slot (str) – Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: Deployment or ClientRawResponse if raw=true
Return type: Deployment or ClientRawResponse
Raises:
-
list_deployments
(resource_group_name, name, custom_headers=None, raw=False, **operation_config)[source]¶ List deployments for an app, or a deployment slot.
List deployments for an app, or a deployment slot.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Name of the app.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: An iterator like instance of Deployment
Return type: Raises:
-
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.
List deployments for an app, or a deployment slot.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Name of the app.
- slot (str) – Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: An iterator like instance of Deployment
Return type: Raises:
-
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_config – Operation configuration overrides.
Returns: An iterator like instance of Identifier
Return type: Raises:
-
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_config – Operation configuration overrides.
Returns: An iterator like instance of Identifier
Return type: Raises:
-
list_function_secrets
(resource_group_name, name, function_name, custom_headers=None, raw=False, **operation_config)[source]¶ Get function secrets for a function in a web site, or a deployment slot.
Get function secrets for a function in a web site, or a deployment slot.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Site name.
- function_name (str) – Function name.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: FunctionSecrets or ClientRawResponse if raw=true
Return type: FunctionSecrets or ClientRawResponse
Raises:
-
list_function_secrets_slot
(resource_group_name, name, function_name, slot, custom_headers=None, raw=False, **operation_config)[source]¶ Get function secrets for a function in a web site, or a deployment slot.
Get function secrets for a function in a web site, or a deployment slot.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Site name.
- function_name (str) – Function name.
- slot (str) – Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: FunctionSecrets or ClientRawResponse if raw=true
Return type: FunctionSecrets or ClientRawResponse
Raises:
-
list_functions
(resource_group_name, name, custom_headers=None, raw=False, **operation_config)[source]¶ List the functions for a web site, or a deployment slot.
List the functions for a web site, or a deployment slot.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Site name.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: An iterator like instance of FunctionEnvelope
Return type: 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_config – Operation configuration overrides.
Returns: An iterator like instance of HostNameBinding
Return type: Raises:
-
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_config – Operation configuration overrides.
Returns: An iterator like instance of HostNameBinding
Return type: Raises:
-
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_config – Operation configuration overrides.
Returns: HybridConnectionKey or ClientRawResponse if raw=true
Return type: HybridConnectionKey or ClientRawResponse
Raises:
-
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_config – Operation configuration overrides.
Returns: HybridConnectionKey or ClientRawResponse if raw=true
Return type: HybridConnectionKey or ClientRawResponse
Raises:
-
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_config – Operation configuration overrides.
Returns: HybridConnection or ClientRawResponse if raw=true
Return type: HybridConnection or ClientRawResponse
Raises:
-
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_config – Operation configuration overrides.
Returns: HybridConnection or ClientRawResponse if raw=true
Return type: HybridConnection or ClientRawResponse
Raises:
-
list_instance_functions_slot
(resource_group_name, name, slot, custom_headers=None, raw=False, **operation_config)[source]¶ List the functions for a web site, or a deployment slot.
List the functions for a web site, or a deployment slot.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Site name.
- slot (str) – Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: An iterator like instance of FunctionEnvelope
Return type: 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_config – Operation configuration overrides.
Returns: An iterator like instance of SiteInstance
Return type: Raises:
-
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_config – Operation configuration overrides.
Returns: An iterator like instance of SiteInstance
Return type: Raises:
-
list_instance_process_modules
(resource_group_name, name, process_id, instance_id, custom_headers=None, raw=False, **operation_config)[source]¶ List module information for a process by its ID for a specific scaled-out instance in a web site.
List module information for a process by its ID for a specific scaled-out instance in a web site.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Site name.
- process_id (str) – PID.
- instance_id (str) – ID of a specific scaled-out instance. This is the value of the name property in the JSON response from “GET api/sites/{siteName}/instances”.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: An iterator like instance of ProcessModuleInfo
Return type: Raises: CloudError
-
list_instance_process_modules_slot
(resource_group_name, name, process_id, slot, instance_id, custom_headers=None, raw=False, **operation_config)[source]¶ List module information for a process by its ID for a specific scaled-out instance in a web site.
List module information for a process by its ID for a specific scaled-out instance in a web site.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Site name.
- process_id (str) – PID.
- slot (str) – Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.
- instance_id (str) – ID of a specific scaled-out instance. This is the value of the name property in the JSON response from “GET api/sites/{siteName}/instances”.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: An iterator like instance of ProcessModuleInfo
Return type: Raises: CloudError
-
list_instance_process_threads
(resource_group_name, name, process_id, instance_id, custom_headers=None, raw=False, **operation_config)[source]¶ List the threads in a process by its ID for a specific scaled-out instance in a web site.
List the threads in a process by its ID for a specific scaled-out instance in a web site.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Site name.
- process_id (str) – PID.
- instance_id (str) – ID of a specific scaled-out instance. This is the value of the name property in the JSON response from “GET api/sites/{siteName}/instances”.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: An iterator like instance of ProcessThreadInfo
Return type: Raises: CloudError
-
list_instance_process_threads_slot
(resource_group_name, name, process_id, slot, instance_id, custom_headers=None, raw=False, **operation_config)[source]¶ List the threads in a process by its ID for a specific scaled-out instance in a web site.
List the threads in a process by its ID for a specific scaled-out instance in a web site.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Site name.
- process_id (str) – PID.
- slot (str) – Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.
- instance_id (str) – ID of a specific scaled-out instance. This is the value of the name property in the JSON response from “GET api/sites/{siteName}/instances”.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: An iterator like instance of ProcessThreadInfo
Return type: Raises: CloudError
-
list_instance_processes
(resource_group_name, name, instance_id, custom_headers=None, raw=False, **operation_config)[source]¶ Get list of processes for a web site, or a deployment slot, or for a specific scaled-out instance in a web site.
Get list of processes for a web site, or a deployment slot, or for a specific scaled-out instance in a web site.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Site name.
- instance_id (str) – ID of a specific scaled-out instance. This is the value of the name property in the JSON response from “GET api/sites/{siteName}/instances”.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: An iterator like instance of ProcessInfo
Return type: Raises: CloudError
-
list_instance_processes_slot
(resource_group_name, name, slot, instance_id, custom_headers=None, raw=False, **operation_config)[source]¶ Get list of processes for a web site, or a deployment slot, or for a specific scaled-out instance in a web site.
Get list of processes for a web site, or a deployment slot, or for a specific scaled-out instance in a web site.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Site name.
- slot (str) – Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.
- instance_id (str) – ID of a specific scaled-out instance. This is the value of the name property in the JSON response from “GET api/sites/{siteName}/instances”.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: An iterator like instance of ProcessInfo
Return type: 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_config – Operation configuration overrides.
Returns: StringDictionary or ClientRawResponse if raw=true
Return type: StringDictionary or ClientRawResponse
Raises:
-
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_config – Operation configuration overrides.
Returns: StringDictionary or ClientRawResponse if raw=true
Return type: StringDictionary or ClientRawResponse
Raises:
-
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_config – Operation configuration overrides.
Returns: An iterator like instance of ResourceMetricDefinition
Return type: Raises:
-
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_config – Operation configuration overrides.
Returns: An iterator like instance of ResourceMetricDefinition
Return type: Raises:
-
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_config – Operation configuration overrides.
Returns: An iterator like instance of ResourceMetric
Return type: Raises:
-
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_config – Operation configuration overrides.
Returns: An iterator like instance of ResourceMetric
Return type: Raises:
-
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_config – Operation configuration overrides.
Returns: NetworkFeatures or ClientRawResponse if raw=true
Return type: NetworkFeatures or ClientRawResponse
Raises: CloudError
-
list_network_features_slot
(resource_group_name, name, view, slot, custom_headers=None, raw=False, **operation_config)[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_config – Operation configuration overrides.
Returns: NetworkFeatures or ClientRawResponse if raw=true
Return type: NetworkFeatures or ClientRawResponse
Raises: CloudError
-
list_perf_mon_counters
(resource_group_name, name, filter=None, custom_headers=None, raw=False, **operation_config)[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_config – Operation configuration overrides.
Returns: An iterator like instance of PerfMonResponse
Return type: Raises:
-
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.
- filter (str) – Return only usages/metrics specified in the filter. Filter conforms to odata syntax. Example: $filter=(startTime eq 2014-01-01T00:00:00Z and endTime eq 2014-12-31T23:59:59Z and timeGrain eq duration’[Hour|Minute|Day]’.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: An iterator like instance of PerfMonResponse
Return type: Raises:
-
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_config – Operation configuration overrides.
Returns: PremierAddOn or ClientRawResponse if raw=true
Return type: PremierAddOn or ClientRawResponse
Raises:
-
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_config – Operation configuration overrides.
Returns: PremierAddOn or ClientRawResponse if raw=true
Return type: PremierAddOn or ClientRawResponse
Raises:
-
list_process_modules
(resource_group_name, name, process_id, custom_headers=None, raw=False, **operation_config)[source]¶ List module information for a process by its ID for a specific scaled-out instance in a web site.
List module information for a process by its ID for a specific scaled-out instance in a web site.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Site name.
- process_id (str) – PID.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: An iterator like instance of ProcessModuleInfo
Return type: Raises: CloudError
-
list_process_modules_slot
(resource_group_name, name, process_id, slot, custom_headers=None, raw=False, **operation_config)[source]¶ List module information for a process by its ID for a specific scaled-out instance in a web site.
List module information for a process by its ID for a specific scaled-out instance in a web site.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Site name.
- process_id (str) – PID.
- slot (str) – Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: An iterator like instance of ProcessModuleInfo
Return type: Raises: CloudError
-
list_process_threads
(resource_group_name, name, process_id, custom_headers=None, raw=False, **operation_config)[source]¶ List the threads in a process by its ID for a specific scaled-out instance in a web site.
List the threads in a process by its ID for a specific scaled-out instance in a web site.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Site name.
- process_id (str) – PID.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: An iterator like instance of ProcessThreadInfo
Return type: Raises: CloudError
-
list_process_threads_slot
(resource_group_name, name, process_id, slot, custom_headers=None, raw=False, **operation_config)[source]¶ List the threads in a process by its ID for a specific scaled-out instance in a web site.
List the threads in a process by its ID for a specific scaled-out instance in a web site.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Site name.
- process_id (str) – PID.
- slot (str) – Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: An iterator like instance of ProcessThreadInfo
Return type: Raises: CloudError
-
list_processes
(resource_group_name, name, custom_headers=None, raw=False, **operation_config)[source]¶ Get list of processes for a web site, or a deployment slot, or for a specific scaled-out instance in a web site.
Get list of processes for a web site, or a deployment slot, or for a specific scaled-out instance in a web site.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Site name.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: An iterator like instance of ProcessInfo
Return type: Raises: CloudError
-
list_processes_slot
(resource_group_name, name, slot, custom_headers=None, raw=False, **operation_config)[source]¶ Get list of processes for a web site, or a deployment slot, or for a specific scaled-out instance in a web site.
Get list of processes for a web site, or a deployment slot, or for a specific scaled-out instance in a web site.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Site name.
- slot (str) – Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: An iterator like instance of ProcessInfo
Return type: Raises: CloudError
-
list_public_certificates
(resource_group_name, name, custom_headers=None, raw=False, **operation_config)[source]¶ Get public certificates for an app or a deployment slot.
Get public certificates for an app or a deployment slot.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Name of the app.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: An iterator like instance of PublicCertificate
Return type: Raises:
-
list_public_certificates_slot
(resource_group_name, name, slot, custom_headers=None, raw=False, **operation_config)[source]¶ Get public certificates for an app or a deployment slot.
Get public certificates for an app or a deployment slot.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Name of the app.
- slot (str) – Name of the deployment slot. If a slot is not specified, the API gets hostname bindings for the production slot.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: An iterator like instance of PublicCertificate
Return type: Raises:
-
list_publishing_credentials
(resource_group_name, name, custom_headers=None, raw=False, polling=True, **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) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
- polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
Returns: An instance of LROPoller that returns User or ClientRawResponse<User> if raw==True
Return type: AzureOperationPoller[User] or AzureOperationPoller[ClientRawResponse[User]]
Raises:
-
list_publishing_credentials_slot
(resource_group_name, name, slot, custom_headers=None, raw=False, polling=True, **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) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
- polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
Returns: An instance of LROPoller that returns User or ClientRawResponse<User> if raw==True
Return type: AzureOperationPoller[User] or AzureOperationPoller[ClientRawResponse[User]]
Raises:
-
list_publishing_profile_xml_with_secrets
(resource_group_name, name, format=None, include_disaster_recovery_endpoints=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’
- include_disaster_recovery_endpoints (bool) – Include the DisasterRecover endpoint if true
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- callback (Callable[Bytes, response=None]) – When specified, will be called with each chunk of data that is streamed. The callback should take two arguments, the bytes of the current chunk of data and the response object. If the data is uploading, response will be None.
- operation_config – Operation configuration overrides.
Returns: object or ClientRawResponse if raw=true
Return type: Generator or ClientRawResponse
Raises:
-
list_publishing_profile_xml_with_secrets_slot
(resource_group_name, name, slot, format=None, include_disaster_recovery_endpoints=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’
- include_disaster_recovery_endpoints (bool) – Include the DisasterRecover endpoint if true
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- callback (Callable[Bytes, response=None]) – When specified, will be called with each chunk of data that is streamed. The callback should take two arguments, the bytes of the current chunk of data and the response object. If the data is uploading, response will be None.
- operation_config – Operation configuration overrides.
Returns: object or ClientRawResponse if raw=true
Return type: Generator or ClientRawResponse
Raises:
-
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_config – Operation configuration overrides.
Returns: RelayServiceConnectionEntity or ClientRawResponse if raw=true
Return type: RelayServiceConnectionEntity or ClientRawResponse
Raises:
-
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_config – Operation configuration overrides.
Returns: RelayServiceConnectionEntity or ClientRawResponse if raw=true
Return type: RelayServiceConnectionEntity or ClientRawResponse
Raises:
-
list_site_extensions
(resource_group_name, name, custom_headers=None, raw=False, **operation_config)[source]¶ Get list of siteextensions for a web site, or a deployment slot.
Get list of siteextensions for a web site, or a deployment slot.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Site name.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: An iterator like instance of SiteExtensionInfo
Return type: Raises: CloudError
-
list_site_extensions_slot
(resource_group_name, name, slot, custom_headers=None, raw=False, **operation_config)[source]¶ Get list of siteextensions for a web site, or a deployment slot.
Get list of siteextensions for a web site, or a deployment slot.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Site name.
- slot (str) – Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: An iterator like instance of SiteExtensionInfo
Return type: 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_config – Operation configuration overrides.
Returns: PushSettings or ClientRawResponse if raw=true
Return type: PushSettings or ClientRawResponse
Raises:
-
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_config – Operation configuration overrides.
Returns: PushSettings or ClientRawResponse if raw=true
Return type: PushSettings or ClientRawResponse
Raises:
-
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_config – Operation configuration overrides.
Returns: SlotConfigNamesResource or ClientRawResponse if raw=true
Return type: SlotConfigNamesResource or ClientRawResponse
Raises:
-
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_config – Operation configuration overrides.
Returns: An iterator like instance of SlotDifference
Return type: Raises:
-
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_config – Operation configuration overrides.
Returns: An iterator like instance of SlotDifference
Return type: Raises:
-
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_config – Operation configuration overrides.
Returns: An iterator like instance of Site
Return type: Raises:
-
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_config – Operation configuration overrides.
Returns: An iterator like instance of Snapshot
Return type: Raises:
-
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_config – Operation configuration overrides.
Returns: An iterator like instance of Snapshot
Return type: Raises:
-
list_sync_function_triggers
(resource_group_name, name, custom_headers=None, raw=False, **operation_config)[source]¶ This is to allow calling via powershell and ARM template.
This is to allow calling via powershell and ARM template.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Name of the app.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: FunctionSecrets or ClientRawResponse if raw=true
Return type: FunctionSecrets or ClientRawResponse
Raises:
-
list_sync_function_triggers_slot
(resource_group_name, name, slot, custom_headers=None, raw=False, **operation_config)[source]¶ This is to allow calling via powershell and ARM template.
This is to allow calling via powershell and ARM template.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Name of the app.
- slot (str) – Name of the deployment slot. If a slot is not specified, the API will restore a backup of the production slot.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: FunctionSecrets or ClientRawResponse if raw=true
Return type: FunctionSecrets or ClientRawResponse
Raises:
-
list_triggered_web_job_history
(resource_group_name, name, web_job_name, custom_headers=None, raw=False, **operation_config)[source]¶ List a triggered web job’s history for an app, or a deployment slot.
List a triggered web job’s history for an app, or a deployment slot.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Site name.
- web_job_name (str) – Name of Web Job.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: An iterator like instance of TriggeredJobHistory
Return type: Raises: CloudError
-
list_triggered_web_job_history_slot
(resource_group_name, name, web_job_name, slot, custom_headers=None, raw=False, **operation_config)[source]¶ List a triggered web job’s history for an app, or a deployment slot.
List a triggered web job’s history for an app, or a deployment slot.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Site name.
- web_job_name (str) – Name of Web Job.
- slot (str) – Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: An iterator like instance of TriggeredJobHistory
Return type: Raises: CloudError
-
list_triggered_web_jobs
(resource_group_name, name, custom_headers=None, raw=False, **operation_config)[source]¶ List triggered web jobs for an app, or a deployment slot.
List triggered web jobs for an app, or a deployment slot.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Site name.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: An iterator like instance of TriggeredWebJob
Return type: Raises:
-
list_triggered_web_jobs_slot
(resource_group_name, name, slot, custom_headers=None, raw=False, **operation_config)[source]¶ List triggered web jobs for an app, or a deployment slot.
List triggered web jobs for an app, or a deployment slot.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Site name.
- slot (str) – Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: An iterator like instance of TriggeredWebJob
Return type: Raises:
-
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_config – Operation configuration overrides.
Returns: An iterator like instance of CsmUsageQuota
Return type: Raises:
-
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_config – Operation configuration overrides.
Returns: An iterator like instance of CsmUsageQuota
Return type: Raises:
-
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_config – Operation configuration overrides.
Returns: list or ClientRawResponse if raw=true
Return type: list[VnetInfo] or ClientRawResponse
Raises:
-
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_config – Operation configuration overrides.
Returns: list or ClientRawResponse if raw=true
Return type: list[VnetInfo] or ClientRawResponse
Raises:
-
list_web_jobs
(resource_group_name, name, custom_headers=None, raw=False, **operation_config)[source]¶ List webjobs for an app, or a deployment slot.
List webjobs for an app, or a deployment slot.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Site name.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: An iterator like instance of WebJob
Return type: Raises:
-
list_web_jobs_slot
(resource_group_name, name, slot, custom_headers=None, raw=False, **operation_config)[source]¶ List webjobs for an app, or a deployment slot.
List webjobs for an app, or a deployment slot.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Site name.
- slot (str) – Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: An iterator like instance of WebJob
Return type: Raises:
-
migrate_my_sql
(resource_group_name, name, migration_request_envelope, custom_headers=None, raw=False, polling=True, **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) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
- polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
Returns: An instance of LROPoller that returns Operation or ClientRawResponse<Operation> if raw==True
Return type: AzureOperationPoller[Operation] or AzureOperationPoller[ClientRawResponse[Operation]]
Raises:
-
migrate_storage
(subscription_name, resource_group_name, name, migration_options, custom_headers=None, raw=False, polling=True, **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) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
- polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
Returns: An instance of LROPoller that returns StorageMigrationResponse or ClientRawResponse<StorageMigrationResponse> if raw==True
Return type: AzureOperationPoller[StorageMigrationResponse] or AzureOperationPoller[ClientRawResponse[StorageMigrationResponse]]
Raises:
-
put_private_access_vnet
(resource_group_name, name, access, custom_headers=None, raw=False, **operation_config)[source]¶ Sets data around private site access enablement and authorized Virtual Networks that can access the site.
Sets data around private site access enablement and authorized Virtual Networks that can access the site.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – The name of the web app.
- access (PrivateAccess) – The information for the private access
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: PrivateAccess or ClientRawResponse if raw=true
Return type: PrivateAccess or ClientRawResponse
Raises:
-
put_private_access_vnet_slot
(resource_group_name, name, access, slot, custom_headers=None, raw=False, **operation_config)[source]¶ Sets data around private site access enablement and authorized Virtual Networks that can access the site.
Sets data around private site access enablement and authorized Virtual Networks that can access the site.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – The name of the web app.
- access (PrivateAccess) – The information for the private access
- slot (str) – The name of the slot for the web app.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: PrivateAccess or ClientRawResponse if raw=true
Return type: PrivateAccess or ClientRawResponse
Raises:
-
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_config – Operation configuration overrides.
Returns: None or ClientRawResponse if raw=true
Return type: None or ClientRawResponse
Raises: CloudError
-
recover_site_configuration_snapshot_slot
(resource_group_name, name, snapshot_id, slot, custom_headers=None, raw=False, **operation_config)[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_config – Operation configuration overrides.
Returns: None or ClientRawResponse if raw=true
Return type: None or ClientRawResponse
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_config – Operation configuration overrides.
Returns: None or ClientRawResponse if raw=true
Return type: None or ClientRawResponse
Raises: CloudError
-
reset_slot_configuration_slot
(resource_group_name, name, slot, custom_headers=None, raw=False, **operation_config)[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_config – Operation configuration overrides.
Returns: None or ClientRawResponse if raw=true
Return type: None or ClientRawResponse
Raises: CloudError
-
restart
(resource_group_name, name, soft_restart=None, synchronous=None, custom_headers=None, raw=False, **operation_config)[source]¶ Restarts an app (or deployment slot, if specified).
Restarts an app (or deployment slot, if specified).
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Name of the app.
- soft_restart (bool) – Specify true to apply the configuration settings and restarts the app only if necessary. By default, the API always restarts and reprovisions the app.
- synchronous (bool) – Specify true to block until the app is restarted. By default, it is set to false, and the API responds immediately (asynchronous).
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: None or ClientRawResponse if raw=true
Return type: None or ClientRawResponse
Raises: CloudError
-
restart_slot
(resource_group_name, name, slot, soft_restart=None, synchronous=None, custom_headers=None, raw=False, **operation_config)[source]¶ Restarts an app (or deployment slot, if specified).
Restarts an app (or deployment slot, if specified).
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Name of the app.
- slot (str) – Name of the deployment slot. If a slot is not specified, the API will restart the production slot.
- soft_restart (bool) – Specify true to apply the configuration settings and restarts the app only if necessary. By default, the API always restarts and reprovisions the app.
- synchronous (bool) – Specify true to block until the app is restarted. By default, it is set to false, and the API responds immediately (asynchronous).
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: None or ClientRawResponse if raw=true
Return type: None or ClientRawResponse
Raises: CloudError
-
restore
(resource_group_name, name, backup_id, request, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Restores a specific backup to another app (or deployment slot, if specified).
Restores a specific backup to another app (or deployment slot, if specified).
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Name of the app.
- backup_id (str) – ID of the backup.
- request (RestoreRequest) – Information on restore request .
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
- polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
Returns: An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True
Return type: AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]
Raises: CloudError
-
restore_from_backup_blob
(resource_group_name, name, request, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Restores an app from a backup blob in Azure Storage.
Restores an app from a backup 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) – Information on restore request .
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
- polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
Returns: An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True
Return type: AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]
Raises: CloudError
-
restore_from_backup_blob_slot
(resource_group_name, name, request, slot, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Restores an app from a backup blob in Azure Storage.
Restores an app from a backup 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) – Information on restore request .
- slot (str) – Name of the deployment slot. If a slot is not specified, the API will restore a backup of the production slot.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
- polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
Returns: An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True
Return type: AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]
Raises: CloudError
-
restore_from_deleted_app
(resource_group_name, name, restore_request, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Restores a deleted web app to this web app.
Restores a deleted web app to this web app.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Name of web app.
- restore_request (DeletedAppRestoreRequest) – Deleted web app restore information.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
- polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
Returns: An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True
Return type: AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]
Raises: CloudError
-
restore_from_deleted_app_slot
(resource_group_name, name, restore_request, slot, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Restores a deleted web app to this web app.
Restores a deleted web app to this web app.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Name of web app.
- restore_request (DeletedAppRestoreRequest) – Deleted web app restore information.
- slot (str) – Name of web app slot. If not specified then will default to production slot.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
- polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
Returns: An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True
Return type: AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]
Raises: CloudError
-
restore_slot
(resource_group_name, name, backup_id, request, slot, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Restores a specific backup to another app (or deployment slot, if specified).
Restores a specific backup to another app (or deployment slot, if specified).
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Name of the app.
- backup_id (str) – ID of the backup.
- request (RestoreRequest) – Information on restore request .
- slot (str) – Name of the deployment slot. If a slot is not specified, the API will restore a backup of the production slot.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
- polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
Returns: An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True
Return type: AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]
Raises: CloudError
-
restore_snapshot
(resource_group_name, name, restore_request, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Restores a web app from a snapshot.
Restores a web app from a snapshot.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Name of web app.
- restore_request (SnapshotRestoreRequest) – Snapshot restore settings. Snapshot information can be obtained by calling GetDeletedSites or GetSiteSnapshots API.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
- polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
Returns: An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True
Return type: AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]
Raises: CloudError
-
restore_snapshot_slot
(resource_group_name, name, restore_request, slot, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Restores a web app from a snapshot.
Restores a web app from a snapshot.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Name of web app.
- restore_request (SnapshotRestoreRequest) – Snapshot restore settings. Snapshot information can be obtained by calling GetDeletedSites or GetSiteSnapshots API.
- slot (str) – Name of web app slot. If not specified then will default to production slot.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
- polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
Returns: An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True
Return type: AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]
Raises: CloudError
-
run_triggered_web_job
(resource_group_name, name, web_job_name, custom_headers=None, raw=False, **operation_config)[source]¶ Run a triggered web job for an app, or a deployment slot.
Run a triggered web job for an app, or a deployment slot.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Site name.
- web_job_name (str) – Name of Web Job.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: None or ClientRawResponse if raw=true
Return type: None or ClientRawResponse
Raises: CloudError
-
run_triggered_web_job_slot
(resource_group_name, name, web_job_name, slot, custom_headers=None, raw=False, **operation_config)[source]¶ Run a triggered web job for an app, or a deployment slot.
Run a triggered web job for an app, or a deployment slot.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Site name.
- web_job_name (str) – Name of Web Job.
- slot (str) – Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: None or ClientRawResponse if raw=true
Return type: None or ClientRawResponse
Raises: CloudError
-
start
(resource_group_name, name, custom_headers=None, raw=False, **operation_config)[source]¶ Starts an app (or deployment slot, if specified).
Starts an app (or deployment slot, if specified).
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Name of the app.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: None or ClientRawResponse if raw=true
Return type: None or ClientRawResponse
Raises: CloudError
-
start_continuous_web_job
(resource_group_name, name, web_job_name, custom_headers=None, raw=False, **operation_config)[source]¶ Start a continuous web job for an app, or a deployment slot.
Start a continuous web job for an app, or a deployment slot.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Site name.
- web_job_name (str) – Name of Web Job.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: None or ClientRawResponse if raw=true
Return type: None or ClientRawResponse
Raises: CloudError
-
start_continuous_web_job_slot
(resource_group_name, name, web_job_name, slot, custom_headers=None, raw=False, **operation_config)[source]¶ Start a continuous web job for an app, or a deployment slot.
Start a continuous web job for an app, or a deployment slot.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Site name.
- web_job_name (str) – Name of Web Job.
- slot (str) – Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: None or ClientRawResponse if raw=true
Return type: None or ClientRawResponse
Raises: CloudError
-
start_slot
(resource_group_name, name, slot, custom_headers=None, raw=False, **operation_config)[source]¶ Starts an app (or deployment slot, if specified).
Starts an app (or deployment slot, if specified).
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Name of the app.
- slot (str) – Name of the deployment slot. If a slot is not specified, the API will start the production slot.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: None or ClientRawResponse if raw=true
Return type: None or ClientRawResponse
Raises: CloudError
-
start_web_site_network_trace
(resource_group_name, name, duration_in_seconds=None, max_frame_length=None, sas_url=None, custom_headers=None, raw=False, **operation_config)[source]¶ Start capturing network packets for the site.
Start capturing network packets for the site.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – The name of the web app.
- duration_in_seconds (int) – The duration to keep capturing in seconds.
- max_frame_length (int) – The maximum frame length in bytes (Optional).
- sas_url (str) – The Blob URL to store capture file.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: str or ClientRawResponse if raw=true
Return type: str or ClientRawResponse
Raises:
-
start_web_site_network_trace_slot
(resource_group_name, name, slot, duration_in_seconds=None, max_frame_length=None, sas_url=None, custom_headers=None, raw=False, **operation_config)[source]¶ Start capturing network packets for the site.
Start capturing network packets for the site.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – The name of the web app.
- slot (str) – The name of the slot for this web app.
- duration_in_seconds (int) – The duration to keep capturing in seconds.
- max_frame_length (int) – The maximum frame length in bytes (Optional).
- sas_url (str) – The Blob URL to store capture file.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: str or ClientRawResponse if raw=true
Return type: str or ClientRawResponse
Raises:
-
stop
(resource_group_name, name, custom_headers=None, raw=False, **operation_config)[source]¶ Stops an app (or deployment slot, if specified).
Stops an app (or deployment slot, if specified).
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Name of the app.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: None or ClientRawResponse if raw=true
Return type: None or ClientRawResponse
Raises: CloudError
-
stop_continuous_web_job
(resource_group_name, name, web_job_name, custom_headers=None, raw=False, **operation_config)[source]¶ Stop a continuous web job for an app, or a deployment slot.
Stop a continuous web job for an app, or a deployment slot.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Site name.
- web_job_name (str) – Name of Web Job.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: None or ClientRawResponse if raw=true
Return type: None or ClientRawResponse
Raises: CloudError
-
stop_continuous_web_job_slot
(resource_group_name, name, web_job_name, slot, custom_headers=None, raw=False, **operation_config)[source]¶ Stop a continuous web job for an app, or a deployment slot.
Stop a continuous web job for an app, or a deployment slot.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Site name.
- web_job_name (str) – Name of Web Job.
- slot (str) – Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: None or ClientRawResponse if raw=true
Return type: None or ClientRawResponse
Raises: CloudError
-
stop_slot
(resource_group_name, name, slot, custom_headers=None, raw=False, **operation_config)[source]¶ Stops an app (or deployment slot, if specified).
Stops an app (or deployment slot, if specified).
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Name of the app.
- slot (str) – Name of the deployment slot. If a slot is not specified, the API will stop the production slot.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: None or ClientRawResponse if raw=true
Return type: None or ClientRawResponse
Raises: CloudError
-
stop_web_site_network_trace
(resource_group_name, name, custom_headers=None, raw=False, **operation_config)[source]¶ Stop ongoing capturing network packets for the site.
Stop ongoing capturing network packets for the site.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – The name of the web app.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: str or ClientRawResponse if raw=true
Return type: str or ClientRawResponse
Raises:
-
stop_web_site_network_trace_slot
(resource_group_name, name, slot, custom_headers=None, raw=False, **operation_config)[source]¶ Stop ongoing capturing network packets for the site.
Stop ongoing capturing network packets for the site.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – The name of the web app.
- slot (str) – The name of the slot for this web app.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: str or ClientRawResponse if raw=true
Return type: str or ClientRawResponse
Raises:
-
swap_slot_slot
(resource_group_name, name, slot, target_slot, preserve_vnet, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Swaps two deployment slots of an app.
Swaps two deployment slots of an app.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Name of the app.
- slot (str) – Name of the source slot. If a slot is not specified, the production slot is used as the source slot.
- target_slot (str) – Destination deployment slot during swap operation.
- preserve_vnet (bool) – <code>true</code> to preserve Virtual Network to the slot during swap; otherwise, <code>false</code>.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
- polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
Returns: An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True
Return type: AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]
Raises: CloudError
-
swap_slot_with_production
(resource_group_name, name, target_slot, preserve_vnet, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Swaps two deployment slots of an app.
Swaps two deployment slots of an app.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Name of the app.
- target_slot (str) – Destination deployment slot during swap operation.
- preserve_vnet (bool) – <code>true</code> to preserve Virtual Network to the slot during swap; otherwise, <code>false</code>.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
- polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
Returns: An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True
Return type: AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]
Raises: CloudError
-
sync_function_triggers
(resource_group_name, name, custom_headers=None, raw=False, **operation_config)[source]¶ Syncs function trigger metadata to the scale controller.
Syncs function trigger metadata to the scale controller.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Name of the app.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: None or ClientRawResponse if raw=true
Return type: None or ClientRawResponse
Raises: CloudError
-
sync_function_triggers_slot
(resource_group_name, name, slot, custom_headers=None, raw=False, **operation_config)[source]¶ Syncs function trigger metadata to the scale controller.
Syncs function trigger metadata to the scale controller.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Name of the app.
- slot (str) – Name of the deployment slot. If a slot is not specified, the API will restore a backup of the production slot.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: None or ClientRawResponse if raw=true
Return type: None or ClientRawResponse
Raises: CloudError
-
sync_repository
(resource_group_name, name, custom_headers=None, raw=False, **operation_config)[source]¶ Sync web app repository.
Sync web app repository.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Name of web app.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: None or ClientRawResponse if raw=true
Return type: None or ClientRawResponse
Raises: CloudError
-
sync_repository_slot
(resource_group_name, name, slot, custom_headers=None, raw=False, **operation_config)[source]¶ Sync web app repository.
Sync web app repository.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Name of web app.
- slot (str) – Name of web app slot. If not specified then will default to production slot.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: None or ClientRawResponse if raw=true
Return type: None or ClientRawResponse
Raises: CloudError
-
update
(resource_group_name, name, site_envelope, custom_headers=None, raw=False, **operation_config)[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 (SitePatchResource) – A JSON representation of the app properties. See example.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: Site or ClientRawResponse if raw=true
Return type: Site or ClientRawResponse
Raises:
-
update_application_settings
(resource_group_name, name, kind=None, properties=None, custom_headers=None, raw=False, **operation_config)[source]¶ Replaces the application settings of an app.
Replaces the application settings of an app.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Name of the app.
- kind (str) – Kind of resource.
- properties (dict[str, str]) – Settings.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: StringDictionary or ClientRawResponse if raw=true
Return type: StringDictionary or ClientRawResponse
Raises:
-
update_application_settings_slot
(resource_group_name, name, slot, kind=None, properties=None, custom_headers=None, raw=False, **operation_config)[source]¶ Replaces the application settings of an app.
Replaces the application settings of an app.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Name of the app.
- slot (str) – Name of the deployment slot. If a slot is not specified, the API will update the application settings for the production slot.
- kind (str) – Kind of resource.
- properties (dict[str, str]) – Settings.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: StringDictionary or ClientRawResponse if raw=true
Return type: StringDictionary or ClientRawResponse
Raises:
-
update_auth_settings
(resource_group_name, name, site_auth_settings, custom_headers=None, raw=False, **operation_config)[source]¶ Updates the Authentication / Authorization settings associated with web app.
Updates the Authentication / Authorization settings associated with web app.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Name of web app.
- site_auth_settings (SiteAuthSettings) – Auth settings associated with web app.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: SiteAuthSettings or ClientRawResponse if raw=true
Return type: SiteAuthSettings or ClientRawResponse
Raises:
-
update_auth_settings_slot
(resource_group_name, name, site_auth_settings, slot, custom_headers=None, raw=False, **operation_config)[source]¶ Updates the Authentication / Authorization settings associated with web app.
Updates the Authentication / Authorization settings associated with web app.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Name of web app.
- site_auth_settings (SiteAuthSettings) – Auth settings associated with web app.
- slot (str) – Name of web app slot. If not specified then will default to production slot.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: SiteAuthSettings or ClientRawResponse if raw=true
Return type: SiteAuthSettings or ClientRawResponse
Raises:
-
update_azure_storage_accounts
(resource_group_name, name, kind=None, properties=None, custom_headers=None, raw=False, **operation_config)[source]¶ Updates the Azure storage account configurations of an app.
Updates the Azure storage account 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.
- kind (str) – Kind of resource.
- properties (dict[str, AzureStorageInfoValue]) – Azure storage accounts.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: AzureStoragePropertyDictionaryResource or ClientRawResponse if raw=true
Return type: AzureStoragePropertyDictionaryResource or ClientRawResponse
Raises:
-
update_azure_storage_accounts_slot
(resource_group_name, name, slot, kind=None, properties=None, custom_headers=None, raw=False, **operation_config)[source]¶ Updates the Azure storage account configurations of an app.
Updates the Azure storage account 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 update the Azure storage account configurations for the production slot.
- kind (str) – Kind of resource.
- properties (dict[str, AzureStorageInfoValue]) – Azure storage accounts.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: AzureStoragePropertyDictionaryResource or ClientRawResponse if raw=true
Return type: AzureStoragePropertyDictionaryResource or ClientRawResponse
Raises:
-
update_backup_configuration
(resource_group_name, name, request, custom_headers=None, raw=False, **operation_config)[source]¶ Updates the backup configuration of an app.
Updates the backup configuration of an app.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Name of the app.
- request (BackupRequest) – Edited backup configuration.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: BackupRequest or ClientRawResponse if raw=true
Return type: BackupRequest or ClientRawResponse
Raises:
-
update_backup_configuration_slot
(resource_group_name, name, request, slot, custom_headers=None, raw=False, **operation_config)[source]¶ Updates the backup configuration of an app.
Updates the backup configuration of an app.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Name of the app.
- request (BackupRequest) – Edited backup configuration.
- slot (str) – Name of the deployment slot. If a slot is not specified, the API will update the backup configuration for the production slot.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: BackupRequest or ClientRawResponse if raw=true
Return type: BackupRequest or ClientRawResponse
Raises:
-
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_config – Operation configuration overrides.
Returns: SiteConfigResource or ClientRawResponse if raw=true
Return type: SiteConfigResource or ClientRawResponse
Raises:
-
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_config – Operation configuration overrides.
Returns: SiteConfigResource or ClientRawResponse if raw=true
Return type: SiteConfigResource or ClientRawResponse
Raises:
-
update_connection_strings
(resource_group_name, name, kind=None, properties=None, custom_headers=None, raw=False, **operation_config)[source]¶ Replaces the connection strings of an app.
Replaces the connection strings of an app.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Name of the app.
- kind (str) – Kind of resource.
- properties (dict[str, ConnStringValueTypePair]) – Connection strings.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: ConnectionStringDictionary or ClientRawResponse if raw=true
Return type: ConnectionStringDictionary or ClientRawResponse
Raises:
-
update_connection_strings_slot
(resource_group_name, name, slot, kind=None, properties=None, custom_headers=None, raw=False, **operation_config)[source]¶ Replaces the connection strings of an app.
Replaces the connection strings of an app.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Name of the app.
- slot (str) – Name of the deployment slot. If a slot is not specified, the API will update the connection settings for the production slot.
- kind (str) – Kind of resource.
- properties (dict[str, ConnStringValueTypePair]) – Connection strings.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: ConnectionStringDictionary or ClientRawResponse if raw=true
Return type: ConnectionStringDictionary or ClientRawResponse
Raises:
-
update_diagnostic_logs_config
(resource_group_name, name, site_logs_config, custom_headers=None, raw=False, **operation_config)[source]¶ Updates the logging configuration of an app.
Updates the logging configuration of an app.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Name of the app.
- site_logs_config (SiteLogsConfig) – A SiteLogsConfig JSON object that contains the logging configuration to change in the “properties” property.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: SiteLogsConfig or ClientRawResponse if raw=true
Return type: SiteLogsConfig or ClientRawResponse
Raises:
-
update_diagnostic_logs_config_slot
(resource_group_name, name, site_logs_config, slot, custom_headers=None, raw=False, **operation_config)[source]¶ Updates the logging configuration of an app.
Updates the logging configuration of an app.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Name of the app.
- site_logs_config (SiteLogsConfig) – A SiteLogsConfig JSON object that contains the logging configuration to change in the “properties” property.
- slot (str) – Name of the deployment slot. If a slot is not specified, the API will update the logging configuration for the production slot.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: SiteLogsConfig or ClientRawResponse if raw=true
Return type: SiteLogsConfig or ClientRawResponse
Raises:
-
update_domain_ownership_identifier
(resource_group_name, name, domain_ownership_identifier_name, kind=None, identifier_id=None, 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.
- kind (str) – Kind of resource.
- identifier_id (str) – String representation of the identity.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: Identifier or ClientRawResponse if raw=true
Return type: Identifier or ClientRawResponse
Raises:
-
update_domain_ownership_identifier_slot
(resource_group_name, name, domain_ownership_identifier_name, slot, kind=None, identifier_id=None, custom_headers=None, raw=False, **operation_config)[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.
- slot (str) – Name of the deployment slot. If a slot is not specified, the API will delete the binding for the production slot.
- kind (str) – Kind of resource.
- identifier_id (str) – String representation of the identity.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: Identifier or ClientRawResponse if raw=true
Return type: Identifier or ClientRawResponse
Raises:
-
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_config – Operation configuration overrides.
Returns: HybridConnection or ClientRawResponse if raw=true
Return type: HybridConnection or ClientRawResponse
Raises:
-
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_config – Operation configuration overrides.
Returns: HybridConnection or ClientRawResponse if raw=true
Return type: HybridConnection or ClientRawResponse
Raises:
-
update_metadata
(resource_group_name, name, kind=None, properties=None, custom_headers=None, raw=False, **operation_config)[source]¶ Replaces the metadata of an app.
Replaces the metadata of an app.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Name of the app.
- kind (str) – Kind of resource.
- properties (dict[str, str]) – Settings.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: StringDictionary or ClientRawResponse if raw=true
Return type: StringDictionary or ClientRawResponse
Raises:
-
update_metadata_slot
(resource_group_name, name, slot, kind=None, properties=None, custom_headers=None, raw=False, **operation_config)[source]¶ Replaces the metadata of an app.
Replaces the metadata of an app.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Name of the app.
- slot (str) – Name of the deployment slot. If a slot is not specified, the API will update the metadata for the production slot.
- kind (str) – Kind of resource.
- properties (dict[str, str]) – Settings.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: StringDictionary or ClientRawResponse if raw=true
Return type: StringDictionary or ClientRawResponse
Raises:
-
update_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 (PremierAddOnPatchResource) – A JSON representation of the edited premier add-on.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: PremierAddOn or ClientRawResponse if raw=true
Return type: PremierAddOn or ClientRawResponse
Raises:
-
update_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 (PremierAddOnPatchResource) – A JSON representation of the edited premier add-on.
- slot (str) – Name of the deployment slot. If a slot is not specified, the API will update the named add-on for the production slot.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: PremierAddOn or ClientRawResponse if raw=true
Return type: PremierAddOn or ClientRawResponse
Raises:
-
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_config – Operation configuration overrides.
Returns: RelayServiceConnectionEntity or ClientRawResponse if raw=true
Return type: RelayServiceConnectionEntity or ClientRawResponse
Raises:
-
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_config – Operation configuration overrides.
Returns: RelayServiceConnectionEntity or ClientRawResponse if raw=true
Return type: RelayServiceConnectionEntity or ClientRawResponse
Raises:
-
update_site_push_settings
(resource_group_name, name, push_settings, custom_headers=None, raw=False, **operation_config)[source]¶ Updates the Push settings associated with web app.
Updates the Push settings associated with web app.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Name of web app.
- push_settings (PushSettings) – Push settings associated with web app.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: PushSettings or ClientRawResponse if raw=true
Return type: PushSettings or ClientRawResponse
Raises:
-
update_site_push_settings_slot
(resource_group_name, name, push_settings, slot, custom_headers=None, raw=False, **operation_config)[source]¶ Updates the Push settings associated with web app.
Updates the Push settings associated with web app.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Name of web app.
- push_settings (PushSettings) – Push settings associated with web app.
- slot (str) – Name of web app slot. If not specified then will default to production slot.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: PushSettings or ClientRawResponse if raw=true
Return type: PushSettings or ClientRawResponse
Raises:
-
update_slot
(resource_group_name, name, site_envelope, slot, 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 (SitePatchResource) – A JSON representation of the app properties. See example.
- slot (str) – Name of the deployment slot to create or update. By default, this API attempts to create or modify the production slot.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: Site or ClientRawResponse if raw=true
Return type: Site or ClientRawResponse
Raises:
-
update_slot_configuration_names
(resource_group_name, name, slot_config_names, custom_headers=None, raw=False, **operation_config)[source]¶ Updates the names of application settings and connection string that remain with the slot during swap operation.
Updates the names of application settings and connection string that remain with the slot during swap operation.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Name of the app.
- slot_config_names (SlotConfigNamesResource) – Names of application settings and connection strings. See example.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: SlotConfigNamesResource or ClientRawResponse if raw=true
Return type: SlotConfigNamesResource or ClientRawResponse
Raises:
-
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
- operation_config – Operation configuration overrides.
Returns: SiteSourceControl or ClientRawResponse if raw=true
Return type: SiteSourceControl or ClientRawResponse
Raises:
-
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
- operation_config – Operation configuration overrides.
Returns: SiteSourceControl or ClientRawResponse if raw=true
Return type: SiteSourceControl or ClientRawResponse
Raises:
-
update_swift_virtual_network_connection
(resource_group_name, name, connection_envelope, custom_headers=None, raw=False, **operation_config)[source]¶ Integrates this Web App with a Virtual Network. This requires that 1) “swiftSupported” is true when doing a GET against this resource, and 2) that the target Subnet has already been delegated, and is not in use by another App Service Plan other than the one this App is in.
Integrates this Web App with a Virtual Network. This requires that 1) “swiftSupported” is true when doing a GET against this resource, and 2) that the target Subnet has already been delegated, and is not in use by another App Service Plan other than the one this App is in.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Name of the app.
- connection_envelope (SwiftVirtualNetwork) – Properties of the Virtual Network connection. See example.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: SwiftVirtualNetwork or ClientRawResponse if raw=true
Return type: SwiftVirtualNetwork or ClientRawResponse
Raises:
-
update_swift_virtual_network_connection_slot
(resource_group_name, name, connection_envelope, slot, custom_headers=None, raw=False, **operation_config)[source]¶ Integrates this Web App with a Virtual Network. This requires that 1) “swiftSupported” is true when doing a GET against this resource, and 2) that the target Subnet has already been delegated, and is not in use by another App Service Plan other than the one this App is in.
Integrates this Web App with a Virtual Network. This requires that 1) “swiftSupported” is true when doing a GET against this resource, and 2) that the target Subnet has already been delegated, and is not in use by another App Service Plan other than the one this App is in.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Name of the app.
- connection_envelope (SwiftVirtualNetwork) – Properties of the Virtual Network connection. See example.
- slot (str) – Name of the deployment slot. If a slot is not specified, the API will add or update connections for the production slot.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: SwiftVirtualNetwork or ClientRawResponse if raw=true
Return type: SwiftVirtualNetwork or ClientRawResponse
Raises:
-
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_config – Operation configuration overrides.
Returns: VnetInfo or ClientRawResponse if raw=true
Return type: VnetInfo or ClientRawResponse
Raises:
-
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_config – Operation configuration overrides.
Returns: VnetGateway or ClientRawResponse if raw=true
Return type: VnetGateway or ClientRawResponse
Raises:
-
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_config – Operation configuration overrides.
Returns: VnetGateway or ClientRawResponse if raw=true
Return type: VnetGateway or ClientRawResponse
Raises:
-
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_config – Operation configuration overrides.
Returns: VnetInfo or ClientRawResponse if raw=true
Return type: VnetInfo or ClientRawResponse
Raises:
-
models
= <module 'azure.mgmt.web.models' from '/usr/lib/python3/dist-packages/azure/mgmt/web/models/__init__.py'>¶
-
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 object model deserializer.
Variables: api_version – API Version. Constant value: “2018-02-01”.
-
change_vnet
(resource_group_name, name, id=None, subnet=None, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Move an App Service Environment to a different VNET.
Move an App Service Environment to a different VNET.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Name of the App Service Environment.
- id (str) – Resource id of the Virtual Network.
- subnet (str) – Subnet within the Virtual Network.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
- polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
Returns: An instance of LROPoller that returns WebAppCollection or ClientRawResponse<WebAppCollection> if raw==True
Return type: AzureOperationPoller[WebAppCollection] or AzureOperationPoller[ClientRawResponse[WebAppCollection]]
Raises:
-
create_or_update
(resource_group_name, name, hosting_environment_envelope, custom_headers=None, raw=False, polling=True, **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) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
- polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
Returns: An instance of LROPoller that returns AppServiceEnvironmentResource or ClientRawResponse<AppServiceEnvironmentResource> if raw==True
Return type: AzureOperationPoller[AppServiceEnvironmentResource] or AzureOperationPoller[ClientRawResponse[AppServiceEnvironmentResource]]
Raises: CloudError
-
create_or_update_multi_role_pool
(resource_group_name, name, multi_role_pool_envelope, custom_headers=None, raw=False, polling=True, **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) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
- polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
Returns: An instance of LROPoller that returns WorkerPoolResource or ClientRawResponse<WorkerPoolResource> if raw==True
Return type: AzureOperationPoller[WorkerPoolResource] or AzureOperationPoller[ClientRawResponse[WorkerPoolResource]]
Raises: CloudError
-
create_or_update_worker_pool
(resource_group_name, name, worker_pool_name, worker_pool_envelope, custom_headers=None, raw=False, polling=True, **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) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
- polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
Returns: An instance of LROPoller that returns WorkerPoolResource or ClientRawResponse<WorkerPoolResource> if raw==True
Return type: AzureOperationPoller[WorkerPoolResource] or AzureOperationPoller[ClientRawResponse[WorkerPoolResource]]
Raises: CloudError
-
delete
(resource_group_name, name, force_delete=None, custom_headers=None, raw=False, polling=True, **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) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
- polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
Returns: An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True
Return type: AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]
Raises: CloudError
-
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_config – Operation configuration overrides.
Returns: AppServiceEnvironmentResource or ClientRawResponse if raw=true
Return type: AppServiceEnvironmentResource or ClientRawResponse
Raises:
-
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_config – Operation configuration overrides.
Returns: HostingEnvironmentDiagnostics or ClientRawResponse if raw=true
Return type: HostingEnvironmentDiagnostics or ClientRawResponse
Raises:
-
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_config – Operation configuration overrides.
Returns: WorkerPoolResource or ClientRawResponse if raw=true
Return type: WorkerPoolResource or ClientRawResponse
Raises:
-
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_config – Operation configuration overrides.
Returns: WorkerPoolResource or ClientRawResponse if raw=true
Return type: WorkerPoolResource or ClientRawResponse
Raises:
-
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: - custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: An iterator like instance of AppServiceEnvironmentResource
Return type: AppServiceEnvironmentResourcePaged[AppServiceEnvironmentResource]
Raises:
-
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_config – Operation configuration overrides.
Returns: An iterator like instance of AppServicePlan
Return type: Raises:
-
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_config – Operation configuration overrides.
Returns: An iterator like instance of AppServiceEnvironmentResource
Return type: AppServiceEnvironmentResourcePaged[AppServiceEnvironmentResource]
Raises:
-
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_config – Operation configuration overrides.
Returns: An iterator like instance of StampCapacity
Return type: Raises:
-
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_config – Operation configuration overrides.
Returns: list or ClientRawResponse if raw=true
Return type: list[HostingEnvironmentDiagnostics] or ClientRawResponse
Raises:
-
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_config – Operation configuration overrides.
Returns: MetricDefinition or ClientRawResponse if raw=true
Return type: MetricDefinition or ClientRawResponse
Raises:
-
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_config – Operation configuration overrides.
Returns: An iterator like instance of ResourceMetric
Return type: Raises:
-
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_config – Operation configuration overrides.
Returns: An iterator like instance of ResourceMetricDefinition
Return type: Raises:
-
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_config – Operation configuration overrides.
Returns: An iterator like instance of ResourceMetric
Return type: Raises:
-
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_config – Operation configuration overrides.
Returns: An iterator like instance of ResourceMetricDefinition
Return type: Raises:
-
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_config – Operation configuration overrides.
Returns: An iterator like instance of ResourceMetric
Return type: Raises:
-
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_config – Operation configuration overrides.
Returns: An iterator like instance of SkuInfo
Return type: Raises:
-
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_config – Operation configuration overrides.
Returns: An iterator like instance of WorkerPoolResource
Return type: Raises:
-
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_config – Operation configuration overrides.
Returns: An iterator like instance of Usage
Return type: Raises:
-
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_config – Operation configuration overrides.
Returns: list or ClientRawResponse if raw=true
Return type: list[Operation] or ClientRawResponse
Raises:
-
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_config – Operation configuration overrides.
Returns: An iterator like instance of CsmUsageQuota
Return type: Raises:
-
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_config – Operation configuration overrides.
Returns: AddressResponse or ClientRawResponse if raw=true
Return type: AddressResponse or ClientRawResponse
Raises:
-
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_config – Operation configuration overrides.
Returns: An iterator like instance of Site
Return type: Raises:
-
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_config – Operation configuration overrides.
Returns: An iterator like instance of ResourceMetricDefinition
Return type: Raises:
-
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_config – Operation configuration overrides.
Returns: An iterator like instance of ResourceMetric
Return type: Raises:
-
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_config – Operation configuration overrides.
Returns: An iterator like instance of Usage
Return type: Raises:
-
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_config – Operation configuration overrides.
Returns: An iterator like instance of ResourceMetricDefinition
Return type: Raises:
-
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_config – Operation configuration overrides.
Returns: An iterator like instance of ResourceMetric
Return type: Raises:
-
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_config – Operation configuration overrides.
Returns: An iterator like instance of SkuInfo
Return type: Raises:
-
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_config – Operation configuration overrides.
Returns: An iterator like instance of WorkerPoolResource
Return type: Raises:
-
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_config – Operation configuration overrides.
Returns: None or ClientRawResponse if raw=true
Return type: None or ClientRawResponse
Raises: CloudError
-
resume
(resource_group_name, name, custom_headers=None, raw=False, polling=True, **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) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
- polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
Returns: An instance of LROPoller that returns WebAppCollection or ClientRawResponse<WebAppCollection> if raw==True
Return type: AzureOperationPoller[WebAppCollection] or AzureOperationPoller[ClientRawResponse[WebAppCollection]]
Raises:
-
suspend
(resource_group_name, name, custom_headers=None, raw=False, polling=True, **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) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
- polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
Returns: An instance of LROPoller that returns WebAppCollection or ClientRawResponse<WebAppCollection> if raw==True
Return type: AzureOperationPoller[WebAppCollection] or AzureOperationPoller[ClientRawResponse[WebAppCollection]]
Raises:
-
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 (AppServiceEnvironmentPatchResource) – 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
- operation_config – Operation configuration overrides.
Returns: AppServiceEnvironmentResource or ClientRawResponse if raw=true
Return type: AppServiceEnvironmentResource or ClientRawResponse
Raises: CloudError
-
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
- operation_config – Operation configuration overrides.
Returns: WorkerPoolResource or ClientRawResponse if raw=true
Return type: WorkerPoolResource or ClientRawResponse
Raises: CloudError
-
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
- operation_config – Operation configuration overrides.
Returns: WorkerPoolResource or ClientRawResponse if raw=true
Return type: WorkerPoolResource or ClientRawResponse
Raises: CloudError
-
models
= <module 'azure.mgmt.web.models' from '/usr/lib/python3/dist-packages/azure/mgmt/web/models/__init__.py'>¶
-
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 object model deserializer.
Variables: api_version – API Version. Constant value: “2018-02-01”.
-
create_or_update
(resource_group_name, name, app_service_plan, custom_headers=None, raw=False, polling=True, **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) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
- polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
Returns: An instance of LROPoller that returns AppServicePlan or ClientRawResponse<AppServicePlan> if raw==True
Return type: AzureOperationPoller[AppServicePlan] or AzureOperationPoller[ClientRawResponse[AppServicePlan]]
Raises:
-
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_config – Operation configuration overrides.
Returns: VnetRoute or ClientRawResponse if raw=true
Return type: VnetRoute or ClientRawResponse
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_config – Operation configuration overrides.
Returns: None or ClientRawResponse if raw=true
Return type: None or ClientRawResponse
Raises: CloudError
-
delete_hybrid_connection
(resource_group_name, name, namespace_name, relay_name, custom_headers=None, raw=False, **operation_config)[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_config – Operation configuration overrides.
Returns: None or ClientRawResponse if raw=true
Return type: None or ClientRawResponse
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_config – Operation configuration overrides.
Returns: None or ClientRawResponse if raw=true
Return type: None or ClientRawResponse
Raises: CloudError
-
get
(resource_group_name, name, custom_headers=None, raw=False, **operation_config)[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_config – Operation configuration overrides.
Returns: AppServicePlan or ClientRawResponse if raw=true
Return type: AppServicePlan or ClientRawResponse
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_config – Operation configuration overrides.
Returns: HybridConnection or ClientRawResponse if raw=true
Return type: HybridConnection or ClientRawResponse
Raises:
-
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_config – Operation configuration overrides.
Returns: HybridConnectionLimits or ClientRawResponse if raw=true
Return type: HybridConnectionLimits or ClientRawResponse
Raises:
-
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_config – Operation configuration overrides.
Returns: list or ClientRawResponse if raw=true
Return type: list[VnetRoute] or ClientRawResponse
Raises: CloudError
-
get_server_farm_skus
(resource_group_name, name, custom_headers=None, raw=False, **operation_config)[source]¶ Gets all selectable sku’s for a given App Service Plan.
Gets all selectable sku’s for a given App Service Plan.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Name of 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_config – Operation configuration overrides.
Returns: object or ClientRawResponse if raw=true
Return type: object or ClientRawResponse
Raises:
-
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_config – Operation configuration overrides.
Returns: VnetInfo or ClientRawResponse if raw=true
Return type: VnetInfo or ClientRawResponse
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_config – Operation configuration overrides.
Returns: VnetGateway or ClientRawResponse if raw=true
Return type: VnetGateway or ClientRawResponse
Raises:
-
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_config – Operation configuration overrides.
Returns: An iterator like instance of AppServicePlan
Return type: Raises:
-
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_config – Operation configuration overrides.
Returns: An iterator like instance of AppServicePlan
Return type: Raises:
-
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_config – Operation configuration overrides.
Returns: list or ClientRawResponse if raw=true
Return type: list[Capability] or ClientRawResponse
Raises:
-
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_config – Operation configuration overrides.
Returns: HybridConnectionKey or ClientRawResponse if raw=true
Return type: HybridConnectionKey or ClientRawResponse
Raises:
-
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_config – Operation configuration overrides.
Returns: An iterator like instance of HybridConnection
Return type: Raises:
-
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_config – Operation configuration overrides.
Returns: An iterator like instance of ResourceMetricDefinition
Return type: Raises:
-
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_config – Operation configuration overrides.
Returns: An iterator like instance of ResourceMetric
Return type: Raises:
-
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_config – Operation configuration overrides.
Returns: list or ClientRawResponse if raw=true
Return type: list[VnetRoute] or ClientRawResponse
Raises:
-
list_usages
(resource_group_name, name, filter=None, custom_headers=None, raw=False, **operation_config)[source]¶ Gets server farm usage information.
Gets server farm usage information.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Name of App Service Plan
- 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’).
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: An iterator like instance of CsmUsageQuota
Return type: Raises:
-
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_config – Operation configuration overrides.
Returns: list or ClientRawResponse if raw=true
Return type: list[VnetInfo] or ClientRawResponse
Raises:
-
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_config – Operation configuration overrides.
Returns: An iterator like instance of Site
Return type: Raises:
-
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_config – Operation configuration overrides.
Returns: An iterator like instance of str
Return type: StrPaged[str]
Raises:
-
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_config – Operation configuration overrides.
Returns: None or ClientRawResponse if raw=true
Return type: None or ClientRawResponse
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_config – Operation configuration overrides.
Returns: None or ClientRawResponse if raw=true
Return type: None or ClientRawResponse
Raises: CloudError
-
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 (AppServicePlanPatchResource) – 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
- operation_config – Operation configuration overrides.
Returns: AppServicePlan or ClientRawResponse if raw=true
Return type: AppServicePlan or ClientRawResponse
Raises:
-
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_config – Operation configuration overrides.
Returns: VnetGateway or ClientRawResponse if raw=true
Return type: VnetGateway or ClientRawResponse
Raises:
-
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_config – Operation configuration overrides.
Returns: VnetRoute or ClientRawResponse if raw=true
Return type: VnetRoute or ClientRawResponse
Raises: CloudError
-
models
= <module 'azure.mgmt.web.models' from '/usr/lib/python3/dist-packages/azure/mgmt/web/models/__init__.py'>¶
-
class
azure.mgmt.web.operations.
ResourceHealthMetadataOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
ResourceHealthMetadataOperations operations.
Parameters: - client – Client for service requests.
- config – Configuration of service client.
- serializer – An object model serializer.
- deserializer – An object model deserializer.
Variables: api_version – API Version. Constant value: “2018-02-01”.
-
get_by_site
(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_config – Operation configuration overrides.
Returns: ResourceHealthMetadata or ClientRawResponse if raw=true
Return type: ResourceHealthMetadata or ClientRawResponse
Raises:
-
get_by_site_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_config – Operation configuration overrides.
Returns: ResourceHealthMetadata or ClientRawResponse if raw=true
Return type: ResourceHealthMetadata or ClientRawResponse
Raises:
-
list
(custom_headers=None, raw=False, **operation_config)[source]¶ List all ResourceHealthMetadata for all sites in the subscription.
List all ResourceHealthMetadata for all sites in the subscription.
Parameters: - custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: An iterator like instance of ResourceHealthMetadata
Return type: Raises:
-
list_by_resource_group
(resource_group_name, custom_headers=None, raw=False, **operation_config)[source]¶ List all ResourceHealthMetadata for all sites in the resource group in the subscription.
List all ResourceHealthMetadata for all sites in the resource group in the subscription.
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_config – Operation configuration overrides.
Returns: An iterator like instance of ResourceHealthMetadata
Return type: Raises:
-
list_by_site
(resource_group_name, name, custom_headers=None, raw=False, **operation_config)[source]¶ Gets the category of ResourceHealthMetadata to use for the given site as a collection.
Gets the category of ResourceHealthMetadata to use for the given site as a collection.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Name of web app.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: An iterator like instance of ResourceHealthMetadata
Return type: Raises:
-
list_by_site_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 as a collection.
Gets the category of ResourceHealthMetadata to use for the given site as a collection.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- name (str) – Name of web app.
- slot (str) – Name of web app slot. If not specified then will default to production slot.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: An iterator like instance of ResourceHealthMetadata
Return type: Raises:
-
models
= <module 'azure.mgmt.web.models' from '/usr/lib/python3/dist-packages/azure/mgmt/web/models/__init__.py'>¶