DiagnosticsOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

WebSiteManagementClient's

<xref:diagnostics> attribute.

Inheritance
builtins.object
DiagnosticsOperations

Constructor

DiagnosticsOperations(*args, **kwargs)

Methods

execute_site_analysis

Execute Analysis.

Execute Analysis.

execute_site_analysis_slot

Execute Analysis.

Execute Analysis.

execute_site_detector

Execute Detector.

Execute Detector.

execute_site_detector_slot

Execute Detector.

Execute Detector.

get_hosting_environment_detector_response

Get Hosting Environment Detector Response.

Get Hosting Environment Detector Response.

get_site_analysis

Get Site Analysis.

Get Site Analysis.

get_site_analysis_slot

Get Site Analysis.

Get Site Analysis.

get_site_detector

Get Detector.

Get Detector.

get_site_detector_response

Get site detector response.

Get site detector response.

get_site_detector_response_slot

Get site detector response.

Get site detector response.

get_site_detector_slot

Get Detector.

Get Detector.

get_site_diagnostic_category

Get Diagnostics Category.

Get Diagnostics Category.

get_site_diagnostic_category_slot

Get Diagnostics Category.

Get Diagnostics Category.

list_hosting_environment_detector_responses

List Hosting Environment Detector Responses.

List Hosting Environment Detector Responses.

list_site_analyses

Get Site Analyses.

Get Site Analyses.

list_site_analyses_slot

Get Site Analyses.

Get Site Analyses.

list_site_detector_responses

List Site Detector Responses.

List Site Detector Responses.

list_site_detector_responses_slot

List Site Detector Responses.

List Site Detector Responses.

list_site_detectors

Get Detectors.

Get Detectors.

list_site_detectors_slot

Get Detectors.

Get Detectors.

list_site_diagnostic_categories

Get Diagnostics Categories.

Get Diagnostics Categories.

list_site_diagnostic_categories_slot

Get Diagnostics Categories.

Get Diagnostics Categories.

execute_site_analysis

Execute Analysis.

Execute Analysis.

execute_site_analysis(resource_group_name: str, site_name: str, diagnostic_category: str, analysis_name: str, start_time: datetime | None = None, end_time: datetime | None = None, time_grain: str | None = None, **kwargs: Any) -> DiagnosticAnalysis

Parameters

Name Description
resource_group_name
Required
str

Name of the resource group to which the resource belongs. Required.

site_name
Required
str

Site Name. Required.

diagnostic_category
Required
str

Category Name. Required.

analysis_name
Required
str

Analysis Resource Name. Required.

start_time
Required

Start Time. Default value is None.

end_time
Required

End Time. Default value is None.

time_grain
Required
str

Time Grain. Default value is None.

Returns

Type Description

DiagnosticAnalysis or the result of cls(response)

Exceptions

Type Description

execute_site_analysis_slot

Execute Analysis.

Execute Analysis.

execute_site_analysis_slot(resource_group_name: str, site_name: str, diagnostic_category: str, analysis_name: str, slot: str, start_time: datetime | None = None, end_time: datetime | None = None, time_grain: str | None = None, **kwargs: Any) -> DiagnosticAnalysis

Parameters

Name Description
resource_group_name
Required
str

Name of the resource group to which the resource belongs. Required.

site_name
Required
str

Site Name. Required.

diagnostic_category
Required
str

Category Name. Required.

analysis_name
Required
str

Analysis Resource Name. Required.

slot
Required
str

Slot Name. Required.

start_time
Required

Start Time. Default value is None.

end_time
Required

End Time. Default value is None.

time_grain
Required
str

Time Grain. Default value is None.

Returns

Type Description

DiagnosticAnalysis or the result of cls(response)

Exceptions

Type Description

execute_site_detector

Execute Detector.

Execute Detector.

execute_site_detector(resource_group_name: str, site_name: str, detector_name: str, diagnostic_category: str, start_time: datetime | None = None, end_time: datetime | None = None, time_grain: str | None = None, **kwargs: Any) -> DiagnosticDetectorResponse

Parameters

Name Description
resource_group_name
Required
str

Name of the resource group to which the resource belongs. Required.

site_name
Required
str

Site Name. Required.

detector_name
Required
str

Detector Resource Name. Required.

diagnostic_category
Required
str

Category Name. Required.

start_time
Required

Start Time. Default value is None.

end_time
Required

End Time. Default value is None.

time_grain
Required
str

Time Grain. Default value is None.

Returns

Type Description

DiagnosticDetectorResponse or the result of cls(response)

Exceptions

Type Description

execute_site_detector_slot

Execute Detector.

Execute Detector.

execute_site_detector_slot(resource_group_name: str, site_name: str, detector_name: str, diagnostic_category: str, slot: str, start_time: datetime | None = None, end_time: datetime | None = None, time_grain: str | None = None, **kwargs: Any) -> DiagnosticDetectorResponse

Parameters

Name Description
resource_group_name
Required
str

Name of the resource group to which the resource belongs. Required.

site_name
Required
str

Site Name. Required.

detector_name
Required
str

Detector Resource Name. Required.

diagnostic_category
Required
str

Category Name. Required.

slot
Required
str

Slot Name. Required.

start_time
Required

Start Time. Default value is None.

end_time
Required

End Time. Default value is None.

time_grain
Required
str

Time Grain. Default value is None.

Returns

Type Description

DiagnosticDetectorResponse or the result of cls(response)

Exceptions

Type Description

get_hosting_environment_detector_response

Get Hosting Environment Detector Response.

Get Hosting Environment Detector Response.

get_hosting_environment_detector_response(resource_group_name: str, name: str, detector_name: str, start_time: datetime | None = None, end_time: datetime | None = None, time_grain: str | None = None, **kwargs: Any) -> DetectorResponse

Parameters

Name Description
resource_group_name
Required
str

Name of the resource group to which the resource belongs. Required.

name
Required
str

App Service Environment Name. Required.

detector_name
Required
str

Detector Resource Name. Required.

start_time
Required

Start Time. Default value is None.

end_time
Required

End Time. Default value is None.

time_grain
Required
str

Time Grain. Default value is None.

Returns

Type Description

DetectorResponse or the result of cls(response)

Exceptions

Type Description

get_site_analysis

Get Site Analysis.

Get Site Analysis.

get_site_analysis(resource_group_name: str, site_name: str, diagnostic_category: str, analysis_name: str, **kwargs: Any) -> AnalysisDefinition

Parameters

Name Description
resource_group_name
Required
str

Name of the resource group to which the resource belongs. Required.

site_name
Required
str

Site Name. Required.

diagnostic_category
Required
str

Diagnostic Category. Required.

analysis_name
Required
str

Analysis Name. Required.

Returns

Type Description

AnalysisDefinition or the result of cls(response)

Exceptions

Type Description

get_site_analysis_slot

Get Site Analysis.

Get Site Analysis.

get_site_analysis_slot(resource_group_name: str, site_name: str, diagnostic_category: str, analysis_name: str, slot: str, **kwargs: Any) -> AnalysisDefinition

Parameters

Name Description
resource_group_name
Required
str

Name of the resource group to which the resource belongs. Required.

site_name
Required
str

Site Name. Required.

diagnostic_category
Required
str

Diagnostic Category. Required.

analysis_name
Required
str

Analysis Name. Required.

slot
Required
str

Slot - optional. Required.

Returns

Type Description

AnalysisDefinition or the result of cls(response)

Exceptions

Type Description

get_site_detector

Get Detector.

Get Detector.

get_site_detector(resource_group_name: str, site_name: str, diagnostic_category: str, detector_name: str, **kwargs: Any) -> DetectorDefinition

Parameters

Name Description
resource_group_name
Required
str

Name of the resource group to which the resource belongs. Required.

site_name
Required
str

Site Name. Required.

diagnostic_category
Required
str

Diagnostic Category. Required.

detector_name
Required
str

Detector Name. Required.

Returns

Type Description

DetectorDefinition or the result of cls(response)

Exceptions

Type Description

get_site_detector_response

Get site detector response.

Get site detector response.

get_site_detector_response(resource_group_name: str, site_name: str, detector_name: str, start_time: datetime | None = None, end_time: datetime | None = None, time_grain: str | None = None, **kwargs: Any) -> DetectorResponse

Parameters

Name Description
resource_group_name
Required
str

Name of the resource group to which the resource belongs. Required.

site_name
Required
str

Site Name. Required.

detector_name
Required
str

Detector Resource Name. Required.

start_time
Required

Start Time. Default value is None.

end_time
Required

End Time. Default value is None.

time_grain
Required
str

Time Grain. Default value is None.

Returns

Type Description

DetectorResponse or the result of cls(response)

Exceptions

Type Description

get_site_detector_response_slot

Get site detector response.

Get site detector response.

get_site_detector_response_slot(resource_group_name: str, site_name: str, detector_name: str, slot: str, start_time: datetime | None = None, end_time: datetime | None = None, time_grain: str | None = None, **kwargs: Any) -> DetectorResponse

Parameters

Name Description
resource_group_name
Required
str

Name of the resource group to which the resource belongs. Required.

site_name
Required
str

Site Name. Required.

detector_name
Required
str

Detector Resource Name. Required.

slot
Required
str

Slot Name. Required.

start_time
Required

Start Time. Default value is None.

end_time
Required

End Time. Default value is None.

time_grain
Required
str

Time Grain. Default value is None.

Returns

Type Description

DetectorResponse or the result of cls(response)

Exceptions

Type Description

get_site_detector_slot

Get Detector.

Get Detector.

get_site_detector_slot(resource_group_name: str, site_name: str, diagnostic_category: str, detector_name: str, slot: str, **kwargs: Any) -> DetectorDefinition

Parameters

Name Description
resource_group_name
Required
str

Name of the resource group to which the resource belongs. Required.

site_name
Required
str

Site Name. Required.

diagnostic_category
Required
str

Diagnostic Category. Required.

detector_name
Required
str

Detector Name. Required.

slot
Required
str

Slot Name. Required.

Returns

Type Description

DetectorDefinition or the result of cls(response)

Exceptions

Type Description

get_site_diagnostic_category

Get Diagnostics Category.

Get Diagnostics Category.

get_site_diagnostic_category(resource_group_name: str, site_name: str, diagnostic_category: str, **kwargs: Any) -> DiagnosticCategory

Parameters

Name Description
resource_group_name
Required
str

Name of the resource group to which the resource belongs. Required.

site_name
Required
str

Site Name. Required.

diagnostic_category
Required
str

Diagnostic Category. Required.

Returns

Type Description

DiagnosticCategory or the result of cls(response)

Exceptions

Type Description

get_site_diagnostic_category_slot

Get Diagnostics Category.

Get Diagnostics Category.

get_site_diagnostic_category_slot(resource_group_name: str, site_name: str, diagnostic_category: str, slot: str, **kwargs: Any) -> DiagnosticCategory

Parameters

Name Description
resource_group_name
Required
str

Name of the resource group to which the resource belongs. Required.

site_name
Required
str

Site Name. Required.

diagnostic_category
Required
str

Diagnostic Category. Required.

slot
Required
str

Slot Name. Required.

Returns

Type Description

DiagnosticCategory or the result of cls(response)

Exceptions

Type Description

list_hosting_environment_detector_responses

List Hosting Environment Detector Responses.

List Hosting Environment Detector Responses.

list_hosting_environment_detector_responses(resource_group_name: str, name: str, **kwargs: Any) -> Iterable[DetectorResponse]

Parameters

Name Description
resource_group_name
Required
str

Name of the resource group to which the resource belongs. Required.

name
Required
str

Site Name. Required.

Returns

Type Description

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

Exceptions

Type Description

list_site_analyses

Get Site Analyses.

Get Site Analyses.

list_site_analyses(resource_group_name: str, site_name: str, diagnostic_category: str, **kwargs: Any) -> Iterable[AnalysisDefinition]

Parameters

Name Description
resource_group_name
Required
str

Name of the resource group to which the resource belongs. Required.

site_name
Required
str

Site Name. Required.

diagnostic_category
Required
str

Diagnostic Category. Required.

Returns

Type Description

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

Exceptions

Type Description

list_site_analyses_slot

Get Site Analyses.

Get Site Analyses.

list_site_analyses_slot(resource_group_name: str, site_name: str, diagnostic_category: str, slot: str, **kwargs: Any) -> Iterable[AnalysisDefinition]

Parameters

Name Description
resource_group_name
Required
str

Name of the resource group to which the resource belongs. Required.

site_name
Required
str

Site Name. Required.

diagnostic_category
Required
str

Diagnostic Category. Required.

slot
Required
str

Slot Name. Required.

Returns

Type Description

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

Exceptions

Type Description

list_site_detector_responses

List Site Detector Responses.

List Site Detector Responses.

list_site_detector_responses(resource_group_name: str, site_name: str, **kwargs: Any) -> Iterable[DetectorResponse]

Parameters

Name Description
resource_group_name
Required
str

Name of the resource group to which the resource belongs. Required.

site_name
Required
str

Site Name. Required.

Returns

Type Description

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

Exceptions

Type Description

list_site_detector_responses_slot

List Site Detector Responses.

List Site Detector Responses.

list_site_detector_responses_slot(resource_group_name: str, site_name: str, slot: str, **kwargs: Any) -> Iterable[DetectorResponse]

Parameters

Name Description
resource_group_name
Required
str

Name of the resource group to which the resource belongs. Required.

site_name
Required
str

Site Name. Required.

slot
Required
str

Slot Name. Required.

Returns

Type Description

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

Exceptions

Type Description

list_site_detectors

Get Detectors.

Get Detectors.

list_site_detectors(resource_group_name: str, site_name: str, diagnostic_category: str, **kwargs: Any) -> Iterable[DetectorDefinition]

Parameters

Name Description
resource_group_name
Required
str

Name of the resource group to which the resource belongs. Required.

site_name
Required
str

Site Name. Required.

diagnostic_category
Required
str

Diagnostic Category. Required.

Returns

Type Description

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

Exceptions

Type Description

list_site_detectors_slot

Get Detectors.

Get Detectors.

list_site_detectors_slot(resource_group_name: str, site_name: str, diagnostic_category: str, slot: str, **kwargs: Any) -> Iterable[DetectorDefinition]

Parameters

Name Description
resource_group_name
Required
str

Name of the resource group to which the resource belongs. Required.

site_name
Required
str

Site Name. Required.

diagnostic_category
Required
str

Diagnostic Category. Required.

slot
Required
str

Slot Name. Required.

Returns

Type Description

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

Exceptions

Type Description

list_site_diagnostic_categories

Get Diagnostics Categories.

Get Diagnostics Categories.

list_site_diagnostic_categories(resource_group_name: str, site_name: str, **kwargs: Any) -> Iterable[DiagnosticCategory]

Parameters

Name Description
resource_group_name
Required
str

Name of the resource group to which the resource belongs. Required.

site_name
Required
str

Site Name. Required.

Returns

Type Description

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

Exceptions

Type Description

list_site_diagnostic_categories_slot

Get Diagnostics Categories.

Get Diagnostics Categories.

list_site_diagnostic_categories_slot(resource_group_name: str, site_name: str, slot: str, **kwargs: Any) -> Iterable[DiagnosticCategory]

Parameters

Name Description
resource_group_name
Required
str

Name of the resource group to which the resource belongs. Required.

site_name
Required
str

Site Name. Required.

slot
Required
str

Slot Name. Required.

Returns

Type Description

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

Exceptions

Type Description

Attributes

models

models = <module 'azure.mgmt.web.v2020_09_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\web\\v2020_09_01\\models\\__init__.py'>