WebSiteManagementClientOperationsMixin Class

  • Reference
Inheritance
azure.mgmt.web.v2020_09_01.aio._vendor.WebSiteManagementClientMixinABC
WebSiteManagementClientOperationsMixin

Constructor

WebSiteManagementClientOperationsMixin()

Methods

check_name_availability

Check if a resource name is available.

Check if a resource name is available.
get_publishing_user

Gets publishing user.

Gets publishing user.
get_source_control

Gets source control token.

Gets source control token.
get_subscription_deployment_locations

Gets list of available geo regions plus ministamps.

Gets list of available geo regions plus ministamps.
list_billing_meters

Gets a list of meters for a given location.

Gets a list of meters for a given location.
list_geo_regions

Get a list of available geographical regions.

Get a list of available geographical regions.
list_premier_add_on_offers

List all premier add-on offers.

List all premier add-on offers.
list_site_identifiers_assigned_to_host_name

List all apps that are assigned to a hostname.

List all apps that are assigned to a hostname.
list_skus

List all SKUs.

List all SKUs.
list_source_controls

Gets the source controls available for Azure websites.

Gets the source controls available for Azure websites.
move

Move resources between resource groups.

Move resources between resource groups.
update_publishing_user

Updates publishing user.

Updates publishing user.
update_source_control

Updates source control token.

Updates source control token.
validate

Validate if a resource can be created.

Validate if a resource can be created.
validate_move

Validate whether a resource can be moved.

Validate whether a resource can be moved.
verify_hosting_environment_vnet

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.

check_name_availability

Check if a resource name is available.

Check if a resource name is available.

async check_name_availability(name: str, type: str | CheckNameResourceTypes, is_fqdn: bool | None = None, **kwargs: Any) -> ResourceNameAvailability

Parameters

Name Description
name
Required
str

Resource name to verify. Required.
type
Required
str or CheckNameResourceTypes

Resource type used for verification. Known values are: "Site", "Slot", "HostingEnvironment", "PublishingUser", "Microsoft.Web/sites", "Microsoft.Web/sites/slots", "Microsoft.Web/hostingEnvironments", and "Microsoft.Web/publishingUsers". Required.
is_fqdn
Required
bool

Is fully qualified domain name. Default value is None.

Returns

Type Description
ResourceNameAvailability

ResourceNameAvailability or the result of cls(response)

Exceptions

Type Description
HttpResponseError

get_publishing_user

Gets publishing user.

Gets publishing user.

async get_publishing_user(**kwargs: Any) -> User

Returns

Type Description
User

User or the result of cls(response)

Exceptions

Type Description
HttpResponseError

get_source_control

Gets source control token.

Gets source control token.

async get_source_control(source_control_type: str, **kwargs: Any) -> SourceControl

Parameters

Name Description
source_control_type
Required
str

Type of source control. Required.

Returns

Type Description
SourceControl

SourceControl or the result of cls(response)

Exceptions

Type Description
HttpResponseError

get_subscription_deployment_locations

Gets list of available geo regions plus ministamps.

Gets list of available geo regions plus ministamps.

async get_subscription_deployment_locations(**kwargs: Any) -> DeploymentLocations

Returns

Type Description
DeploymentLocations

DeploymentLocations or the result of cls(response)

Exceptions

Type Description
HttpResponseError

list_billing_meters

Gets a list of meters for a given location.

Gets a list of meters for a given location.

list_billing_meters(billing_location: str | None = None, os_type: str | None = None, **kwargs: Any) -> AsyncIterable[BillingMeter]

Parameters

Name Description
billing_location
Required
str

Azure Location of billable resource. Default value is None.
os_type
Required
str

App Service OS type meters used for. Default value is None.

Returns

Type Description
AsyncItemPaged[BillingMeter]

An iterator like instance of either BillingMeter or the result of cls(response)

Exceptions

Type Description
HttpResponseError

list_geo_regions

Get a list of available geographical regions.

Get a list of available geographical regions.

list_geo_regions(sku: str | SkuName | None = None, linux_workers_enabled: bool | None = None, xenon_workers_enabled: bool | None = None, linux_dynamic_workers_enabled: bool | None = None, **kwargs: Any) -> AsyncIterable[GeoRegion]

Parameters

Name Description
sku
Required
str or SkuName

Name of SKU used to filter the regions. Known values are: "Free", "Shared", "Basic", "Standard", "Premium", "Dynamic", "Isolated", "PremiumV2", "ElasticPremium", and "ElasticIsolated". Default value is None.
linux_workers_enabled
Required
bool

Specify <code>true</code> if you want to filter to only regions that support Linux workers. Default value is None.
xenon_workers_enabled
Required
bool

Specify <code>true</code> if you want to filter to only regions that support Xenon workers. Default value is None.
linux_dynamic_workers_enabled
Required
bool

Specify <code>true</code> if you want to filter to only regions that support Linux Consumption Workers. Default value is None.

Returns

Type Description
AsyncItemPaged[GeoRegion]

An iterator like instance of either GeoRegion or the result of cls(response)

Exceptions

Type Description
HttpResponseError

list_premier_add_on_offers

List all premier add-on offers.

List all premier add-on offers.

list_premier_add_on_offers(**kwargs: Any) -> AsyncIterable[PremierAddOnOffer]

Returns

Type Description
AsyncItemPaged[PremierAddOnOffer]

An iterator like instance of either PremierAddOnOffer or the result of cls(response)

Exceptions

Type Description
HttpResponseError

list_site_identifiers_assigned_to_host_name

List all apps that are assigned to a hostname.

List all apps that are assigned to a hostname.

list_site_identifiers_assigned_to_host_name(name_identifier: _models.NameIdentifier, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncIterable['_models.Identifier']

Parameters

Name Description
name_identifier
Required
NameIdentifier or IO[bytes]

Hostname information. Is either a NameIdentifier type or a IO[bytes] type. Required.

Returns

Type Description
AsyncItemPaged[Identifier]

An iterator like instance of either Identifier or the result of cls(response)

Exceptions

Type Description
HttpResponseError

list_skus

List all SKUs.

List all SKUs.

async list_skus(**kwargs: Any) -> SkuInfos

Returns

Type Description
SkuInfos

SkuInfos or the result of cls(response)

Exceptions

Type Description
HttpResponseError

list_source_controls

Gets the source controls available for Azure websites.

Gets the source controls available for Azure websites.

list_source_controls(**kwargs: Any) -> AsyncIterable[SourceControl]

Returns

Type Description
AsyncItemPaged[SourceControl]

An iterator like instance of either SourceControl or the result of cls(response)

Exceptions

Type Description
HttpResponseError

move

Move resources between resource groups.

Move resources between resource groups.

async move(resource_group_name: str, move_resource_envelope: _models.CsmMoveResourceEnvelope, *, content_type: str = 'application/json', **kwargs: Any) -> None

Parameters

Name Description
resource_group_name
Required
str

Name of the resource group to which the resource belongs. Required.
move_resource_envelope
Required
CsmMoveResourceEnvelope or IO[bytes]

Object that represents the resource to move. Is either a CsmMoveResourceEnvelope type or a IO[bytes] type. Required.

Returns

Type Description
None

None or the result of cls(response)

Exceptions

Type Description
HttpResponseError

update_publishing_user

Updates publishing user.

Updates publishing user.

async update_publishing_user(user_details: _models.User, *, content_type: str = 'application/json', **kwargs: Any) -> _models.User

Parameters

Name Description
user_details
Required
User or IO[bytes]

Details of publishing user. Is either a User type or a IO[bytes] type. Required.

Returns

Type Description
User

User or the result of cls(response)

Exceptions

Type Description
HttpResponseError

update_source_control

Updates source control token.

Updates source control token.

async update_source_control(source_control_type: str, request_message: _models.SourceControl, *, content_type: str = 'application/json', **kwargs: Any) -> _models.SourceControl

Parameters

Name Description
source_control_type
Required
str

Type of source control. Required.
request_message
Required
SourceControl or IO[bytes]

Source control token information. Is either a SourceControl type or a IO[bytes] type. Required.

Returns

Type Description
SourceControl

SourceControl or the result of cls(response)

Exceptions

Type Description
HttpResponseError

validate

Validate if a resource can be created.

Validate if a resource can be created.

async validate(resource_group_name: str, validate_request: _models.ValidateRequest, *, content_type: str = 'application/json', **kwargs: Any) -> _models.ValidateResponse

Parameters

Name Description
resource_group_name
Required
str

Name of the resource group to which the resource belongs. Required.
validate_request
Required
ValidateRequest or IO[bytes]

Request with the resources to validate. Is either a ValidateRequest type or a IO[bytes] type. Required.

Returns

Type Description
ValidateResponse

ValidateResponse or the result of cls(response)

Exceptions

Type Description
HttpResponseError

validate_move

Validate whether a resource can be moved.

Validate whether a resource can be moved.

async validate_move(resource_group_name: str, move_resource_envelope: _models.CsmMoveResourceEnvelope, *, content_type: str = 'application/json', **kwargs: Any) -> None

Parameters

Name Description
resource_group_name
Required
str

Name of the resource group to which the resource belongs. Required.
move_resource_envelope
Required
CsmMoveResourceEnvelope or IO[bytes]

Object that represents the resource to move. Is either a CsmMoveResourceEnvelope type or a IO[bytes] type. Required.

Returns

Type Description
None

None or the result of cls(response)

Exceptions

Type Description
HttpResponseError

verify_hosting_environment_vnet

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.

async verify_hosting_environment_vnet(parameters: _models.VnetParameters, *, content_type: str = 'application/json', **kwargs: Any) -> _models.VnetValidationFailureDetails

Parameters

Name Description
parameters
Required
VnetParameters or IO[bytes]

VNET information. Is either a VnetParameters type or a IO[bytes] type. Required.

Returns

Type Description
VnetValidationFailureDetails

VnetValidationFailureDetails or the result of cls(response)

Exceptions

Type Description
HttpResponseError