Share via

WebSiteManagementClient Class

  • Reference

WebSite Management Client.

This ready contains multiple API versions, to help you deal with all of the Azure clouds (Azure Stack, Azure Government, Azure China, etc.). By default, it uses the latest API version available on public Azure. For production, you should stick to a particular api-version and/or profile. The profile sets a mapping between an operation group and its API version. The api-version parameter sets the default API version if the operation group is not described in the profile.

Inheritance
azure.mgmt.web._operations_mixin.WebSiteManagementClientOperationsMixin
WebSiteManagementClient
MultiApiClientMixin
WebSiteManagementClient
azure.mgmt.web._web_site_management_client._SDKClient
WebSiteManagementClient

Constructor

WebSiteManagementClient(credential: TokenCredential, subscription_id: str, api_version: str | None = None, base_url: str = 'https://management.azure.com', profile: KnownProfiles = KnownProfiles.default, **kwargs: Any)

Parameters

Name Description
credential
Required
TokenCredential

Credential needed for the client to connect to Azure. Required.
subscription_id
Required
str

Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). Required.
api_version
str

API version to use if no profile is provided, or if missing in profile.

Default value: None
base_url
str

Service URL

Default value: https://management.azure.com
profile
KnownProfiles

A profile definition, from KnownProfiles to dict.

Default value: KnownProfiles.default

Keyword-Only Parameters

Name Description
polling_interval
int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Methods

close
models

Module depends on the API version:

close 

close()

models

Module depends on the API version:

models(api_version='2023-12-01')

Parameters

Name Description
api_version
Default value: 2023-12-01

Attributes

app_service_certificate_orders

Instance depends on the API version:

app_service_environments

Instance depends on the API version:

app_service_plans

Instance depends on the API version:

billing_meters

Instance depends on the API version:

certificate_orders_diagnostics

Instance depends on the API version:

certificate_registration_provider

Instance depends on the API version:

certificates

Instance depends on the API version:

container_apps

Instance depends on the API version:

container_apps_revisions

Instance depends on the API version:

deleted_web_apps

Instance depends on the API version:

diagnostics

Instance depends on the API version:

domain_registration_provider

Instance depends on the API version:

domains

Instance depends on the API version:

get_usages_in_location

Instance depends on the API version:

global_operations

Instance depends on the API version:

kube_environments

Instance depends on the API version:

provider

Instance depends on the API version:

recommendations

Instance depends on the API version:

resource_health_metadata

Instance depends on the API version:

static_sites

Instance depends on the API version:

top_level_domains

Instance depends on the API version:

web_apps

Instance depends on the API version:

workflow_run_action_repetitions

Instance depends on the API version:

workflow_run_action_repetitions_request_histories

Instance depends on the API version:

workflow_run_action_scope_repetitions

Instance depends on the API version:

workflow_run_actions

Instance depends on the API version:

workflow_runs

Instance depends on the API version:

workflow_trigger_histories

Instance depends on the API version:

workflow_triggers

Instance depends on the API version:

workflow_versions

Instance depends on the API version:

workflows

Instance depends on the API version:

DEFAULT_API_VERSION 

DEFAULT_API_VERSION = '2023-12-01'

LATEST_PROFILE 

LATEST_PROFILE = azure.mgmt.web.WebSiteManagementClient latest