azure.mgmt.web.v2016_03_01.operations module¶

class azure.mgmt.web.v2016_03_01.operations.CertificatesOperations(client, config, serializer, deserializer)[source]¶

Bases: object

CertificatesOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

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: “2016-03-01”.

create_or_update(resource_group_name, name, certificate_envelope, custom_headers=None, raw=False, **operation_config)[source]¶

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

CloudError

delete(resource_group_name, name, custom_headers=None, raw=False, **operation_config)[source]¶

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.

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

CloudError

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

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

CertificatePaged[Certificate]

Raises

CloudError

list_by_resource_group(resource_group_name, custom_headers=None, raw=False, **operation_config)[source]¶

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

CertificatePaged[Certificate]

Raises

CloudError

update(resource_group_name, name, certificate_envelope, custom_headers=None, raw=False, **operation_config)[source]¶

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

CloudError

models = <module 'azure.mgmt.web.v2016_03_01.models' from '/home/vsts/work/1/s/sdk/appservice/azure-mgmt-web/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/web/v2016_03_01/models/__init__.py'>¶

class azure.mgmt.web.v2016_03_01.operations.DeletedWebAppsOperations(client, config, serializer, deserializer)[source]¶

Bases: object

DeletedWebAppsOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

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: “2016-03-01”.

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

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

DeletedSitePaged[DeletedSite]

Raises

CloudError

models = <module 'azure.mgmt.web.v2016_03_01.models' from '/home/vsts/work/1/s/sdk/appservice/azure-mgmt-web/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/web/v2016_03_01/models/__init__.py'>¶

class azure.mgmt.web.v2016_03_01.operations.DiagnosticsOperations(client, config, serializer, deserializer)[source]¶

Bases: object

DiagnosticsOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

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: “2016-03-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.

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

CloudError

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.

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

CloudError

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.

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

CloudError

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.

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

CloudError

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.

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

CloudError

get_site_analysis(resource_group_name, site_name, diagnostic_category, analysis_name, custom_headers=None, raw=False, **operation_config)[source]¶

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

CloudError

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.

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

CloudError

get_site_detector(resource_group_name, site_name, diagnostic_category, detector_name, custom_headers=None, raw=False, **operation_config)[source]¶

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

DetectorDefinitionPaged[DetectorDefinition]

Raises

CloudError

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.

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

CloudError

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.

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

CloudError

get_site_detector_slot(resource_group_name, site_name, diagnostic_category, detector_name, slot, custom_headers=None, raw=False, **operation_config)[source]¶

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

DetectorDefinitionPaged[DetectorDefinition]

Raises

CloudError

get_site_diagnostic_category(resource_group_name, site_name, diagnostic_category, custom_headers=None, raw=False, **operation_config)[source]¶

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

CloudError

get_site_diagnostic_category_slot(resource_group_name, site_name, diagnostic_category, slot, custom_headers=None, raw=False, **operation_config)[source]¶

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

CloudError

list_hosting_environment_detector_responses(resource_group_name, name, custom_headers=None, raw=False, **operation_config)[source]¶

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

DetectorResponsePaged[DetectorResponse]

Raises

CloudError

list_site_analyses(resource_group_name, site_name, diagnostic_category, custom_headers=None, raw=False, **operation_config)[source]¶

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

AnalysisDefinitionPaged[AnalysisDefinition]

Raises

CloudError

list_site_analyses_slot(resource_group_name, site_name, diagnostic_category, slot, custom_headers=None, raw=False, **operation_config)[source]¶

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

AnalysisDefinitionPaged[AnalysisDefinition]

Raises

CloudError

list_site_detector_responses(resource_group_name, site_name, custom_headers=None, raw=False, **operation_config)[source]¶

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

DetectorResponsePaged[DetectorResponse]

Raises

CloudError

list_site_detector_responses_slot(resource_group_name, site_name, slot, custom_headers=None, raw=False, **operation_config)[source]¶

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

DetectorResponsePaged[DetectorResponse]

Raises

CloudError

list_site_detectors(resource_group_name, site_name, diagnostic_category, custom_headers=None, raw=False, **operation_config)[source]¶

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

DetectorDefinitionPaged[DetectorDefinition]

Raises

CloudError

list_site_detectors_slot(resource_group_name, site_name, diagnostic_category, slot, custom_headers=None, raw=False, **operation_config)[source]¶

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

DetectorDefinitionPaged[DetectorDefinition]

Raises

CloudError

list_site_diagnostic_categories(resource_group_name, site_name, custom_headers=None, raw=False, **operation_config)[source]¶

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

DiagnosticCategoryPaged[DiagnosticCategory]

Raises

CloudError

list_site_diagnostic_categories_slot(resource_group_name, site_name, slot, custom_headers=None, raw=False, **operation_config)[source]¶

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

DiagnosticCategoryPaged[DiagnosticCategory]

Raises

CloudError

models = <module 'azure.mgmt.web.v2016_03_01.models' from '/home/vsts/work/1/s/sdk/appservice/azure-mgmt-web/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/web/v2016_03_01/models/__init__.py'>¶

class azure.mgmt.web.v2016_03_01.operations.ProviderOperations(client, config, serializer, deserializer)[source]¶

Bases: object

ProviderOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

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: “2016-03-01”.

get_available_stacks(os_type_selected=None, custom_headers=None, raw=False, **operation_config)[source]¶

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

ApplicationStackPaged[ApplicationStack]

Raises

CloudError

get_available_stacks_on_prem(os_type_selected=None, custom_headers=None, raw=False, **operation_config)[source]¶

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

ApplicationStackPaged[ApplicationStack]

Raises

CloudError

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.

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

CsmOperationDescriptionPaged[CsmOperationDescription]

Raises

CloudError

models = <module 'azure.mgmt.web.v2016_03_01.models' from '/home/vsts/work/1/s/sdk/appservice/azure-mgmt-web/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/web/v2016_03_01/models/__init__.py'>¶

class azure.mgmt.web.v2016_03_01.operations.RecommendationsOperations(client, config, serializer, deserializer)[source]¶

Bases: object

RecommendationsOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

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: “2016-03-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.

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.

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.

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.

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 recommendation 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

CloudError

list(featured=None, filter=None, custom_headers=None, raw=False, **operation_config)[source]¶

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=channels 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

RecommendationPaged[Recommendation]

Raises

CloudError

list_history_for_web_app(resource_group_name, site_name, filter=None, custom_headers=None, raw=False, **operation_config)[source]¶

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.
filter (str) – Filter is specified by using OData syntax. Example: $filter=channels 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

RecommendationPaged[Recommendation]

Raises

CloudError

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.

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=channels 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

RecommendationPaged[Recommendation]

Raises

CloudError

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

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.

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.v2016_03_01.models' from '/home/vsts/work/1/s/sdk/appservice/azure-mgmt-web/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/web/v2016_03_01/models/__init__.py'>¶

class azure.mgmt.web.v2016_03_01.operations.ResourceHealthMetadataOperations(client, config, serializer, deserializer)[source]¶

Bases: object

ResourceHealthMetadataOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

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: “2016-03-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.

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

DefaultErrorResponseException

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.

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

DefaultErrorResponseException

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

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

ResourceHealthMetadataPaged[ResourceHealthMetadata]

Raises

DefaultErrorResponseException

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.

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

ResourceHealthMetadataPaged[ResourceHealthMetadata]

Raises

DefaultErrorResponseException

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.

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

ResourceHealthMetadataPaged[ResourceHealthMetadata]

Raises

DefaultErrorResponseException

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.

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

ResourceHealthMetadataPaged[ResourceHealthMetadata]

Raises

DefaultErrorResponseException

models = <module 'azure.mgmt.web.v2016_03_01.models' from '/home/vsts/work/1/s/sdk/appservice/azure-mgmt-web/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/web/v2016_03_01/models/__init__.py'>¶

class azure.mgmt.web.v2016_03_01.operations.BillingMetersOperations(client, config, serializer, deserializer)[source]¶

Bases: object

BillingMetersOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

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: “2016-03-01”.

list(billing_location=None, custom_headers=None, raw=False, **operation_config)[source]¶

Gets a list of meters for a given location.

Parameters

billing_location (str) – Azure Location of billable resource
custom_headers (dict) – 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 BillingMeter

Return type

BillingMeterPaged[BillingMeter]

Raises

CloudError

models = <module 'azure.mgmt.web.v2016_03_01.models' from '/home/vsts/work/1/s/sdk/appservice/azure-mgmt-web/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/web/v2016_03_01/models/__init__.py'>¶

class azure.mgmt.web.v2016_03_01.operations.WebSiteManagementClientOperationsMixin[source]¶

Bases: object

check_name_availability(name, type, is_fqdn=None, custom_headers=None, raw=False, **operation_config)[source]¶

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.

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.

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.

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.

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

GeoRegionPaged[GeoRegion]

Raises

CloudError

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

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

PremierAddOnOfferPaged[PremierAddOnOffer]

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.

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

IdentifierPaged[Identifier]

Raises

CloudError

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

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.

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

SourceControlPaged[SourceControl]

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.

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.

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.

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.

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.

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.

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