azure.mgmt.web package¶
Module contents¶
-
class
azure.mgmt.web.
WebSiteManagementClient
(credentials, subscription_id, base_url=None)[source]¶ Bases:
object
WebSite Management Client
Variables: - config (WebSiteManagementClientConfiguration) – Configuration for client.
- app_service_certificate_orders (azure.mgmt.web.operations.AppServiceCertificateOrdersOperations) – AppServiceCertificateOrders operations
- certificate_registration_provider (azure.mgmt.web.operations.CertificateRegistrationProviderOperations) – CertificateRegistrationProvider operations
- domains (azure.mgmt.web.operations.DomainsOperations) – Domains operations
- top_level_domains (azure.mgmt.web.operations.TopLevelDomainsOperations) – TopLevelDomains operations
- domain_registration_provider (azure.mgmt.web.operations.DomainRegistrationProviderOperations) – DomainRegistrationProvider operations
- certificates (azure.mgmt.web.operations.CertificatesOperations) – Certificates operations
- deleted_web_apps (azure.mgmt.web.operations.DeletedWebAppsOperations) – DeletedWebApps operations
- diagnostics (azure.mgmt.web.operations.DiagnosticsOperations) – Diagnostics operations
- provider (azure.mgmt.web.operations.ProviderOperations) – Provider operations
- recommendations (azure.mgmt.web.operations.RecommendationsOperations) – Recommendations operations
- web_apps (azure.mgmt.web.operations.WebAppsOperations) – WebApps operations
- app_service_environments (azure.mgmt.web.operations.AppServiceEnvironmentsOperations) – AppServiceEnvironments operations
- app_service_plans (azure.mgmt.web.operations.AppServicePlansOperations) – AppServicePlans operations
Parameters: - credentials (
A msrestazure Credentials object
) – Credentials needed for the client to connect to Azure. - subscription_id (str) – Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
- base_url (str) – Service URL
-
check_name_availability
(name, type, is_fqdn=None, custom_headers=None, raw=False, **operation_config)[source]¶ Check if a resource name is available.
Check if a resource name is available.
Parameters: - name (str) – Resource name to verify.
- type (str or CheckNameResourceTypes) – Resource type used for verification. Possible values include: ‘Site’, ‘Slot’, ‘HostingEnvironment’, ‘PublishingUser’, ‘Microsoft.Web/sites’, ‘Microsoft.Web/sites/slots’, ‘Microsoft.Web/hostingEnvironments’, ‘Microsoft.Web/publishingUsers’
- is_fqdn (bool) – Is fully qualified domain name.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: ResourceNameAvailability or ClientRawResponse if raw=true
Return type: ResourceNameAvailability or ClientRawResponse
Raises: CloudError
-
get_publishing_user
(custom_headers=None, raw=False, **operation_config)[source]¶ Gets publishing user.
Gets publishing user.
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: User or ClientRawResponse if raw=true
Return type: User or ClientRawResponse
Raises: CloudError
-
get_source_control
(source_control_type, custom_headers=None, raw=False, **operation_config)[source]¶ Gets source control token.
Gets source control token.
Parameters: - source_control_type (str) – Type of source control
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: SourceControl or ClientRawResponse if raw=true
Return type: SourceControl or ClientRawResponse
Raises: CloudError
-
get_subscription_deployment_locations
(custom_headers=None, raw=False, **operation_config)[source]¶ Gets list of available geo regions plus ministamps.
Gets list of available geo regions plus ministamps.
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: DeploymentLocations or ClientRawResponse if raw=true
Return type: DeploymentLocations or ClientRawResponse
Raises: CloudError
-
list_geo_regions
(sku=None, linux_workers_enabled=None, custom_headers=None, raw=False, **operation_config)[source]¶ Get a list of available geographical regions.
Get a list of available geographical regions.
Parameters: - sku (str or SkuName) – Name of SKU used to filter the regions. Possible values include: ‘Free’, ‘Shared’, ‘Basic’, ‘Standard’, ‘Premium’, ‘PremiumV2’, ‘Dynamic’, ‘Isolated’
- linux_workers_enabled (bool) – Specify <code>true</code> if you want to filter to only regions that support Linux workers.
- custom_headers (dict) – 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 GeoRegion
Return type: Raises: CloudError
-
list_premier_add_on_offers
(custom_headers=None, raw=False, **operation_config)[source]¶ List all premier add-on offers.
List all premier add-on offers.
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 PremierAddOnOffer
Return type: Raises: CloudError
-
list_site_identifiers_assigned_to_host_name
(name=None, custom_headers=None, raw=False, **operation_config)[source]¶ List all apps that are assigned to a hostname.
List all apps that are assigned to a hostname.
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: An iterator like instance of Identifier
Return type: Raises: CloudError
-
list_skus
(custom_headers=None, raw=False, **operation_config)[source]¶ List all SKUs.
List all SKUs.
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: SkuInfos or ClientRawResponse if raw=true
Return type: SkuInfos or ClientRawResponse
Raises: CloudError
-
list_source_controls
(custom_headers=None, raw=False, **operation_config)[source]¶ Gets the source controls available for Azure websites.
Gets the source controls available for Azure websites.
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 SourceControl
Return type: Raises: CloudError
-
move
(resource_group_name, target_resource_group=None, resources=None, custom_headers=None, raw=False, **operation_config)[source]¶ Move resources between resource groups.
Move resources between resource groups.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- target_resource_group (str) –
- resources (list[str]) –
- custom_headers (dict) – 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_publishing_user
(user_details, custom_headers=None, raw=False, **operation_config)[source]¶ Updates publishing user.
Updates publishing user.
Parameters: - user_details (User) – Details of publishing user
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: User or ClientRawResponse if raw=true
Return type: User or ClientRawResponse
Raises: CloudError
-
update_source_control
(source_control_type, request_message, custom_headers=None, raw=False, **operation_config)[source]¶ Updates source control token.
Updates source control token.
Parameters: - source_control_type (str) – Type of source control
- request_message (SourceControl) – Source control token 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: SourceControl or ClientRawResponse if raw=true
Return type: SourceControl or ClientRawResponse
Raises: CloudError
-
validate
(resource_group_name, validate_request, custom_headers=None, raw=False, **operation_config)[source]¶ Validate if a resource can be created.
Validate if a resource can be created.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- validate_request (ValidateRequest) – Request with the resources to validate.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: ValidateResponse or ClientRawResponse if raw=true
Return type: ValidateResponse or ClientRawResponse
Raises: CloudError
-
validate_move
(resource_group_name, target_resource_group=None, resources=None, custom_headers=None, raw=False, **operation_config)[source]¶ Validate whether a resource can be moved.
Validate whether a resource can be moved.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- target_resource_group (str) –
- resources (list[str]) –
- custom_headers (dict) – 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_hosting_environment_vnet
(parameters, custom_headers=None, raw=False, **operation_config)[source]¶ Verifies if this VNET is compatible with an App Service Environment by analyzing the Network Security Group rules.
Verifies if this VNET is compatible with an App Service Environment by analyzing the Network Security Group rules.
Parameters: - parameters (VnetParameters) – VNET 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: VnetValidationFailureDetails or ClientRawResponse if raw=true
Return type: VnetValidationFailureDetails or ClientRawResponse
Raises: CloudError