5.0.0 • Published 5 years ago

@datafire/azure_web_diagnostics v5.0.0

Weekly downloads
1
License
MIT
Repository
github
Last release
5 years ago

@datafire/azure_web_diagnostics

Client library for Diagnostics API Client

Installation and Usage

npm install --save @datafire/azure_web_diagnostics
let azure_web_diagnostics = require('@datafire/azure_web_diagnostics').create({
  access_token: "",
  refresh_token: "",
  client_id: "",
  client_secret: "",
  redirect_uri: ""
});

.then(data => {
  console.log(data);
});

Description

Actions

Diagnostics_ListHostingEnvironmentDetectorResponses

List Hosting Environment Detector Responses

azure_web_diagnostics.Diagnostics_ListHostingEnvironmentDetectorResponses({
  "resourceGroupName": "",
  "name": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Input

  • input object
    • resourceGroupName required string: Name of the resource group to which the resource belongs.
    • name required string: Site Name
    • subscriptionId required string: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
    • api-version required string: API Version

Output

Diagnostics_GetHostingEnvironmentDetectorResponse

Get Hosting Environment Detector Response

azure_web_diagnostics.Diagnostics_GetHostingEnvironmentDetectorResponse({
  "resourceGroupName": "",
  "name": "",
  "detectorName": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Input

  • input object
    • resourceGroupName required string: Name of the resource group to which the resource belongs.
    • name required string: App Service Environment Name
    • detectorName required string: Detector Resource Name
    • startTime string: Start Time
    • endTime string: End Time
    • timeGrain string: Time Grain
    • subscriptionId required string: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
    • api-version required string: API Version

Output

Diagnostics_ListSiteDetectorResponses

List Site Detector Responses

azure_web_diagnostics.Diagnostics_ListSiteDetectorResponses({
  "resourceGroupName": "",
  "siteName": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Input

  • input object
    • resourceGroupName required string: Name of the resource group to which the resource belongs.
    • siteName required string: Site Name
    • subscriptionId required string: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
    • api-version required string: API Version

Output

Diagnostics_GetSiteDetectorResponse

Get site detector response

azure_web_diagnostics.Diagnostics_GetSiteDetectorResponse({
  "resourceGroupName": "",
  "siteName": "",
  "detectorName": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Input

  • input object
    • resourceGroupName required string: Name of the resource group to which the resource belongs.
    • siteName required string: Site Name
    • detectorName required string: Detector Resource Name
    • startTime string: Start Time
    • endTime string: End Time
    • timeGrain string: Time Grain
    • subscriptionId required string: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
    • api-version required string: API Version

Output

Diagnostics_ListSiteDiagnosticCategories

Get Diagnostics Categories

azure_web_diagnostics.Diagnostics_ListSiteDiagnosticCategories({
  "resourceGroupName": "",
  "siteName": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Input

  • input object
    • resourceGroupName required string: Name of the resource group to which the resource belongs.
    • siteName required string: Site Name
    • subscriptionId required string: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
    • api-version required string: API Version

Output

Diagnostics_GetSiteDiagnosticCategory

Get Diagnostics Category

azure_web_diagnostics.Diagnostics_GetSiteDiagnosticCategory({
  "resourceGroupName": "",
  "siteName": "",
  "diagnosticCategory": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Input

  • input object
    • resourceGroupName required string: Name of the resource group to which the resource belongs.
    • siteName required string: Site Name
    • diagnosticCategory required string: Diagnostic Category
    • subscriptionId required string: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
    • api-version required string: API Version

Output

Diagnostics_ListSiteAnalyses

Get Site Analyses

azure_web_diagnostics.Diagnostics_ListSiteAnalyses({
  "resourceGroupName": "",
  "siteName": "",
  "diagnosticCategory": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Input

  • input object
    • resourceGroupName required string: Name of the resource group to which the resource belongs.
    • siteName required string: Site Name
    • diagnosticCategory required string: Diagnostic Category
    • subscriptionId required string: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
    • api-version required string: API Version

Output

Diagnostics_GetSiteAnalysis

Get Site Analysis

azure_web_diagnostics.Diagnostics_GetSiteAnalysis({
  "resourceGroupName": "",
  "siteName": "",
  "diagnosticCategory": "",
  "analysisName": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Input

  • input object
    • resourceGroupName required string: Name of the resource group to which the resource belongs.
    • siteName required string: Site Name
    • diagnosticCategory required string: Diagnostic Category
    • analysisName required string: Analysis Name
    • subscriptionId required string: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
    • api-version required string: API Version

Output

Diagnostics_ExecuteSiteAnalysis

Execute Analysis

azure_web_diagnostics.Diagnostics_ExecuteSiteAnalysis({
  "resourceGroupName": "",
  "siteName": "",
  "diagnosticCategory": "",
  "analysisName": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Input

  • input object
    • resourceGroupName required string: Name of the resource group to which the resource belongs.
    • siteName required string: Site Name
    • diagnosticCategory required string: Category Name
    • analysisName required string: Analysis Resource Name
    • startTime string: Start Time
    • endTime string: End Time
    • timeGrain string: Time Grain
    • subscriptionId required string: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
    • api-version required string: API Version

Output

Diagnostics_ListSiteDetectors

Get Detectors

azure_web_diagnostics.Diagnostics_ListSiteDetectors({
  "resourceGroupName": "",
  "siteName": "",
  "diagnosticCategory": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Input

  • input object
    • resourceGroupName required string: Name of the resource group to which the resource belongs.
    • siteName required string: Site Name
    • diagnosticCategory required string: Diagnostic Category
    • subscriptionId required string: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
    • api-version required string: API Version

Output

Diagnostics_GetSiteDetector

Get Detector

azure_web_diagnostics.Diagnostics_GetSiteDetector({
  "resourceGroupName": "",
  "siteName": "",
  "diagnosticCategory": "",
  "detectorName": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Input

  • input object
    • resourceGroupName required string: Name of the resource group to which the resource belongs.
    • siteName required string: Site Name
    • diagnosticCategory required string: Diagnostic Category
    • detectorName required string: Detector Name
    • subscriptionId required string: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
    • api-version required string: API Version

Output

Diagnostics_ExecuteSiteDetector

Execute Detector

azure_web_diagnostics.Diagnostics_ExecuteSiteDetector({
  "resourceGroupName": "",
  "siteName": "",
  "detectorName": "",
  "diagnosticCategory": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Input

  • input object
    • resourceGroupName required string: Name of the resource group to which the resource belongs.
    • siteName required string: Site Name
    • detectorName required string: Detector Resource Name
    • diagnosticCategory required string: Category Name
    • startTime string: Start Time
    • endTime string: End Time
    • timeGrain string: Time Grain
    • subscriptionId required string: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
    • api-version required string: API Version

Output

Diagnostics_ListSiteDetectorResponsesSlot

List Site Detector Responses

azure_web_diagnostics.Diagnostics_ListSiteDetectorResponsesSlot({
  "resourceGroupName": "",
  "siteName": "",
  "slot": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Input

  • input object
    • resourceGroupName required string: Name of the resource group to which the resource belongs.
    • siteName required string: Site Name
    • slot required string: Slot Name
    • subscriptionId required string: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
    • api-version required string: API Version

Output

Diagnostics_GetSiteDetectorResponseSlot

Get site detector response

azure_web_diagnostics.Diagnostics_GetSiteDetectorResponseSlot({
  "resourceGroupName": "",
  "siteName": "",
  "detectorName": "",
  "slot": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Input

  • input object
    • resourceGroupName required string: Name of the resource group to which the resource belongs.
    • siteName required string: Site Name
    • detectorName required string: Detector Resource Name
    • slot required string: Slot Name
    • startTime string: Start Time
    • endTime string: End Time
    • timeGrain string: Time Grain
    • subscriptionId required string: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
    • api-version required string: API Version

Output

Diagnostics_ListSiteDiagnosticCategoriesSlot

Get Diagnostics Categories

azure_web_diagnostics.Diagnostics_ListSiteDiagnosticCategoriesSlot({
  "resourceGroupName": "",
  "siteName": "",
  "slot": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Input

  • input object
    • resourceGroupName required string: Name of the resource group to which the resource belongs.
    • siteName required string: Site Name
    • slot required string: Slot Name
    • subscriptionId required string: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
    • api-version required string: API Version

Output

Diagnostics_GetSiteDiagnosticCategorySlot

Get Diagnostics Category

azure_web_diagnostics.Diagnostics_GetSiteDiagnosticCategorySlot({
  "resourceGroupName": "",
  "siteName": "",
  "diagnosticCategory": "",
  "slot": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Input

  • input object
    • resourceGroupName required string: Name of the resource group to which the resource belongs.
    • siteName required string: Site Name
    • diagnosticCategory required string: Diagnostic Category
    • slot required string: Slot Name
    • subscriptionId required string: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
    • api-version required string: API Version

Output

Diagnostics_ListSiteAnalysesSlot

Get Site Analyses

azure_web_diagnostics.Diagnostics_ListSiteAnalysesSlot({
  "resourceGroupName": "",
  "siteName": "",
  "diagnosticCategory": "",
  "slot": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Input

  • input object
    • resourceGroupName required string: Name of the resource group to which the resource belongs.
    • siteName required string: Site Name
    • diagnosticCategory required string: Diagnostic Category
    • slot required string: Slot Name
    • subscriptionId required string: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
    • api-version required string: API Version

Output

Diagnostics_GetSiteAnalysisSlot

Get Site Analysis

azure_web_diagnostics.Diagnostics_GetSiteAnalysisSlot({
  "resourceGroupName": "",
  "siteName": "",
  "diagnosticCategory": "",
  "analysisName": "",
  "slot": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Input

  • input object
    • resourceGroupName required string: Name of the resource group to which the resource belongs.
    • siteName required string: Site Name
    • diagnosticCategory required string: Diagnostic Category
    • analysisName required string: Analysis Name
    • slot required string: Slot - optional
    • subscriptionId required string: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
    • api-version required string: API Version

Output

Diagnostics_ExecuteSiteAnalysisSlot

Execute Analysis

azure_web_diagnostics.Diagnostics_ExecuteSiteAnalysisSlot({
  "resourceGroupName": "",
  "siteName": "",
  "diagnosticCategory": "",
  "analysisName": "",
  "slot": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Input

  • input object
    • resourceGroupName required string: Name of the resource group to which the resource belongs.
    • siteName required string: Site Name
    • diagnosticCategory required string: Category Name
    • analysisName required string: Analysis Resource Name
    • slot required string: Slot Name
    • startTime string: Start Time
    • endTime string: End Time
    • timeGrain string: Time Grain
    • subscriptionId required string: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
    • api-version required string: API Version

Output

Diagnostics_ListSiteDetectorsSlot

Get Detectors

azure_web_diagnostics.Diagnostics_ListSiteDetectorsSlot({
  "resourceGroupName": "",
  "siteName": "",
  "diagnosticCategory": "",
  "slot": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Input

  • input object
    • resourceGroupName required string: Name of the resource group to which the resource belongs.
    • siteName required string: Site Name
    • diagnosticCategory required string: Diagnostic Category
    • slot required string: Slot Name
    • subscriptionId required string: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
    • api-version required string: API Version

Output

Diagnostics_GetSiteDetectorSlot

Get Detector

azure_web_diagnostics.Diagnostics_GetSiteDetectorSlot({
  "resourceGroupName": "",
  "siteName": "",
  "diagnosticCategory": "",
  "detectorName": "",
  "slot": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Input

  • input object
    • resourceGroupName required string: Name of the resource group to which the resource belongs.
    • siteName required string: Site Name
    • diagnosticCategory required string: Diagnostic Category
    • detectorName required string: Detector Name
    • slot required string: Slot Name
    • subscriptionId required string: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
    • api-version required string: API Version

Output

Diagnostics_ExecuteSiteDetectorSlot

Execute Detector

azure_web_diagnostics.Diagnostics_ExecuteSiteDetectorSlot({
  "resourceGroupName": "",
  "siteName": "",
  "detectorName": "",
  "diagnosticCategory": "",
  "slot": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Input

  • input object
    • resourceGroupName required string: Name of the resource group to which the resource belongs.
    • siteName required string: Site Name
    • detectorName required string: Detector Resource Name
    • diagnosticCategory required string: Category Name
    • slot required string: Slot Name
    • startTime string: Start Time
    • endTime string: End Time
    • timeGrain string: Time Grain
    • subscriptionId required string: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
    • api-version required string: API Version

Output

Definitions

AbnormalTimePeriod

  • AbnormalTimePeriod object: Class representing Abnormal Time Period identified in diagnosis
    • endTime string: End time of the downtime
    • events array: List of Possible Cause of downtime
    • solutions array: List of proposed solutions
    • startTime string: Start time of the downtime

AnalysisData

  • AnalysisData object: Class Representing Detector Evidence used for analysis
    • data array: Additional Source Data
      • items array
        • items object: Name value pair.
          • name string: Pair name.
          • value string: Pair value.
    • detectorDefinition DetectorDefinition
    • detectorMetaData ResponseMetaData
    • metrics array: Source Metrics
    • source string: Name of the Detector

AnalysisDefinition

  • AnalysisDefinition object: Definition of Analysis
    • properties object: AnalysisDefinition resource specific properties
      • description string: Description of the Analysis
    • id string: Resource Id.
    • kind string: Kind of resource.
    • name string: Resource Name.
    • type string: Resource type.

DataSource

  • DataSource object: Class representing data source used by the detectors
    • dataSourceUri array: Datasource Uri Links
      • items object: Name value pair.
        • name string: Pair name.
        • value string: Pair value.
    • instructions array: Instructions if any for the data source
      • items string

DataTableResponseColumn

  • DataTableResponseColumn object: Column definition
    • columnName string: Name of the column
    • columnType string: Column Type
    • dataType string: Data type which looks like 'String' or 'Int32'.

DataTableResponseObject

  • DataTableResponseObject object: Data Table which defines columns and raw row values
    • columns array: List of columns with data types
    • rows array: Raw row values
      • items array
        • items string
    • tableName string: Name of the table

DetectorAbnormalTimePeriod

  • DetectorAbnormalTimePeriod object: Class representing Abnormal Time Period detected.
    • endTime string: End time of the correlated event
    • message string: Message describing the event
    • metaData array: Downtime metadata
      • items array
        • items object: Name value pair.
          • name string: Pair name.
          • value string: Pair value.
    • priority number: Represents the rank of the Detector
    • solutions array: List of proposed solutions
    • source string: Represents the name of the Detector
    • startTime string: Start time of the correlated event
    • type string (values: ServiceIncident, AppDeployment, AppCrash, RuntimeIssueDetected, AseDeployment, UserIssue, PlatformIssue, Other): Represents the type of the Detector

DetectorDefinition

  • DetectorDefinition object: Class representing detector definition
    • properties object: DetectorDefinition resource specific properties
      • description string: Description of the detector
      • displayName string: Display name of the detector
      • isEnabled boolean: Flag representing whether detector is enabled or not.
      • rank number: Detector Rank
    • id string: Resource Id.
    • kind string: Kind of resource.
    • name string: Resource Name.
    • type string: Resource type.

DetectorInfo

  • DetectorInfo object: Definition of Detector
    • category string: Support Category
    • description string: Short description of the detector and its purpose
    • subCategory string: Support Sub Category
    • supportTopicId string: Support Topic Id

DetectorResponse

  • DetectorResponse object: Class representing Response from Detector
    • properties object: DetectorResponse resource specific properties
    • id string: Resource Id.
    • kind string: Kind of resource.
    • name string: Resource Name.
    • type string: Resource type.

DetectorResponseCollection

  • DetectorResponseCollection object: Collection of detector responses
    • nextLink string: Link to next page of resources.
    • value required array: Collection of resources.

DiagnosticAnalysis

  • DiagnosticAnalysis object: Class representing a diagnostic analysis done on an application
    • properties object: DiagnosticAnalysis resource specific properties
      • abnormalTimePeriods array: List of time periods.
      • endTime string: End time of the period
      • nonCorrelatedDetectors array: Data by each detector for detectors that did not corelate
      • payload array: Data by each detector
      • startTime string: Start time of the period
    • id string: Resource Id.
    • kind string: Kind of resource.
    • name string: Resource Name.
    • type string: Resource type.

DiagnosticAnalysisCollection

  • DiagnosticAnalysisCollection object: Collection of Diagnostic Analyses
    • nextLink string: Link to next page of resources.
    • value required array: Collection of resources.

DiagnosticCategory

  • DiagnosticCategory object: Class representing detector definition
    • properties object: DiagnosticCategory resource specific properties
      • description string: Description of the diagnostic category
    • id string: Resource Id.
    • kind string: Kind of resource.
    • name string: Resource Name.
    • type string: Resource type.

DiagnosticCategoryCollection

  • DiagnosticCategoryCollection object: Collection of Diagnostic Categories
    • nextLink string: Link to next page of resources.
    • value required array: Collection of resources.

DiagnosticData

DiagnosticDetectorCollection

  • DiagnosticDetectorCollection object: Collection of Diagnostic Detectors
    • nextLink string: Link to next page of resources.
    • value required array: Collection of resources.

DiagnosticDetectorResponse

  • DiagnosticDetectorResponse object: Class representing Response from Diagnostic Detectors
    • properties object: DiagnosticDetectorResponse resource specific properties
      • abnormalTimePeriods array: List of Correlated events found by the detector
      • data array: Additional Data that detector wants to send.
        • items array
          • items object: Name value pair.
            • name string: Pair name.
            • value string: Pair value.
      • detectorDefinition DetectorDefinition
      • endTime string: End time of the period
      • issueDetected boolean: Flag representing Issue was detected.
      • metrics array: Metrics provided by the detector
      • responseMetaData ResponseMetaData
      • startTime string: Start time of the period
    • id string: Resource Id.
    • kind string: Kind of resource.
    • name string: Resource Name.
    • type string: Resource type.

DiagnosticMetricSample

  • DiagnosticMetricSample object: Class representing Diagnostic Metric
    • isAggregated boolean: Whether the values are aggregates across all workers or not
    • maximum number: Maximum of the metric sampled during the time period
    • minimum number: Minimum of the metric sampled during the time period
    • roleInstance string: Role Instance. Null if this counter is not per instance
    • timestamp string: Time at which metric is measured
    • total number: Total value of the metric. If multiple measurements are made this will have sum of all.

DiagnosticMetricSet

  • DiagnosticMetricSet object: Class representing Diagnostic Metric information
    • endTime string: End time of the period
    • name string: Name of the metric
    • startTime string: Start time of the period
    • timeGrain string: Presented time grain. Supported grains at the moment are PT1M, PT1H, P1D
    • unit string: Metric's unit
    • values array: Collection of metric values for the selected period based on the {Microsoft.Web.Hosting.Administration.DiagnosticMetricSet.TimeGrain}

Rendering

  • Rendering object: Instructions for rendering the data
    • description string: Description of the data that will help it be interpreted
    • title string: Title of data
    • type string (values: NoGraph, Table, TimeSeries, TimeSeriesPerInstance): Rendering Type

ResponseMetaData

Solution

  • Solution object: Class Representing Solution for problems detected.
    • data array: Solution Data.
      • items array
        • items object: Name value pair.
          • name string: Pair name.
          • value string: Pair value.
    • description string: Description of the solution
    • displayName string: Display Name of the solution
    • id number: Solution Id.
    • metadata array: Solution Metadata.
      • items array
        • items object: Name value pair.
          • name string: Pair name.
          • value string: Pair value.
    • order number: Order of the solution.
    • type string (values: QuickSolution, DeepInvestigation, BestPractices): Type of Solution
datafire
@infinitebrahmanuniverse/nolb-_datafire_az@everything-registry/sub-chunk-221
5.0.0

5 years ago

4.0.0

7 years ago

3.0.0

7 years ago