azure.mgmt.web package

Module contents

class azure.mgmt.web.WebSiteManagementClient(credentials, subscription_id, base_url=None)[source]

Bases: object

Composite Swagger for WebSite Management Client

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

ResourceNameAvailability

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

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

Gets publishing user.

Gets publishing user.

Parameters:
Return type:

User

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

list_geo_regions(sku=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’, ‘Dynamic’
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

GeoRegionPaged

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

PremierAddOnOfferPaged

Raises:

CloudError

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

List all SKUs.

List all SKUs.

Parameters:
Return type:

SkuInfos

Return type:

ClientRawResponse if raw=true

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

SourceControlPaged

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

None

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

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

User

Return type:

ClientRawResponse if raw=true

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

SourceControl

Return type:

ClientRawResponse if raw=true

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

ValidateResponse

Return type:

ClientRawResponse if raw=true

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

None

Return type:

ClientRawResponse if raw=true

Raises:

CloudError