@azure/arm-advisor package

Classes

AdvisorManagementClient

Interfaces

ARMErrorResponseBody

ARM error response body.

AdvisorManagementClientOptionalParams

Optional parameters.

ArmErrorResponse
ConfigData

The Advisor configuration data structure.

ConfigurationListResult

The list of Advisor configurations.

Configurations

Interface representing a Configurations.

ConfigurationsCreateInResourceGroupOptionalParams

Optional parameters.

ConfigurationsCreateInSubscriptionOptionalParams

Optional parameters.

ConfigurationsListByResourceGroupOptionalParams

Optional parameters.

ConfigurationsListBySubscriptionNextOptionalParams

Optional parameters.

ConfigurationsListBySubscriptionOptionalParams

Optional parameters.

DigestConfig

Advisor Digest configuration entity

MetadataEntity

The metadata entity contract.

MetadataEntityListResult

The list of metadata entities

MetadataSupportedValueDetail

The metadata supported value detail.

OperationDisplayInfo

The operation supported by Advisor.

OperationEntity

The operation supported by Advisor.

OperationEntityListResult

The list of Advisor operations.

Operations

Interface representing a Operations.

OperationsListNextOptionalParams

Optional parameters.

OperationsListOptionalParams

Optional parameters.

RecommendationMetadata

Interface representing a RecommendationMetadata.

RecommendationMetadataGetOptionalParams

Optional parameters.

RecommendationMetadataListNextOptionalParams

Optional parameters.

RecommendationMetadataListOptionalParams

Optional parameters.

Recommendations

Interface representing a Recommendations.

RecommendationsGenerateHeaders

Defines headers for Recommendations_generate operation.

RecommendationsGenerateOptionalParams

Optional parameters.

RecommendationsGetGenerateStatusOptionalParams

Optional parameters.

RecommendationsGetOptionalParams

Optional parameters.

RecommendationsListNextOptionalParams

Optional parameters.

RecommendationsListOptionalParams

Optional parameters.

Resource

An Azure resource.

ResourceMetadata

Recommendation resource metadata

ResourceRecommendationBase

Advisor Recommendation.

ResourceRecommendationBaseListResult

The list of Advisor recommendations.

ShortDescription

A summary of the recommendation.

SuppressionContract

The details of the snoozed or dismissed rule; for example, the duration, name, and GUID associated with the rule.

SuppressionContractListResult

The list of Advisor suppressions.

Suppressions

Interface representing a Suppressions.

SuppressionsCreateOptionalParams

Optional parameters.

SuppressionsDeleteOptionalParams

Optional parameters.

SuppressionsGetOptionalParams

Optional parameters.

SuppressionsListNextOptionalParams

Optional parameters.

SuppressionsListOptionalParams

Optional parameters.

Type Aliases

Category

Defines values for Category.
KnownCategory can be used interchangeably with Category, this enum contains the known values that the service supports.

Known values supported by the service

HighAvailability
Security
Performance
Cost
OperationalExcellence

ConfigurationName

Defines values for ConfigurationName.
KnownConfigurationName can be used interchangeably with ConfigurationName, this enum contains the known values that the service supports.

Known values supported by the service

default

ConfigurationsCreateInResourceGroupResponse

Contains response data for the createInResourceGroup operation.

ConfigurationsCreateInSubscriptionResponse

Contains response data for the createInSubscription operation.

ConfigurationsListByResourceGroupResponse

Contains response data for the listByResourceGroup operation.

ConfigurationsListBySubscriptionNextResponse

Contains response data for the listBySubscriptionNext operation.

ConfigurationsListBySubscriptionResponse

Contains response data for the listBySubscription operation.

CpuThreshold

Defines values for CpuThreshold.
KnownCpuThreshold can be used interchangeably with CpuThreshold, this enum contains the known values that the service supports.

Known values supported by the service

5
10
15
20

DigestConfigState

Defines values for DigestConfigState.
KnownDigestConfigState can be used interchangeably with DigestConfigState, this enum contains the known values that the service supports.

Known values supported by the service

Active
Disabled

Impact

Defines values for Impact.
KnownImpact can be used interchangeably with Impact, this enum contains the known values that the service supports.

Known values supported by the service

High
Medium
Low

OperationsListNextResponse

Contains response data for the listNext operation.

OperationsListResponse

Contains response data for the list operation.

RecommendationMetadataGetResponse

Contains response data for the get operation.

RecommendationMetadataListNextResponse

Contains response data for the listNext operation.

RecommendationMetadataListResponse

Contains response data for the list operation.

RecommendationsGenerateResponse

Contains response data for the generate operation.

RecommendationsGetResponse

Contains response data for the get operation.

RecommendationsListNextResponse

Contains response data for the listNext operation.

RecommendationsListResponse

Contains response data for the list operation.

Risk

Defines values for Risk.
KnownRisk can be used interchangeably with Risk, this enum contains the known values that the service supports.

Known values supported by the service

Error
Warning
None

Scenario

Defines values for Scenario.
KnownScenario can be used interchangeably with Scenario, this enum contains the known values that the service supports.

Known values supported by the service

Alerts

SuppressionsCreateResponse

Contains response data for the create operation.

SuppressionsGetResponse

Contains response data for the get operation.

SuppressionsListNextResponse

Contains response data for the listNext operation.

SuppressionsListResponse

Contains response data for the list operation.

Enums

KnownCategory

Known values of Category that the service accepts.

KnownConfigurationName

Known values of ConfigurationName that the service accepts.

KnownCpuThreshold

Known values of CpuThreshold that the service accepts.

KnownDigestConfigState

Known values of DigestConfigState that the service accepts.

KnownImpact

Known values of Impact that the service accepts.

KnownRisk

Known values of Risk that the service accepts.

KnownScenario

Known values of Scenario that the service accepts.

Functions

getContinuationToken(unknown)

Given the last .value produced by the byPage iterator, returns a continuation token that can be used to begin paging from that point later.

Function Details

getContinuationToken(unknown)

Given the last .value produced by the byPage iterator, returns a continuation token that can be used to begin paging from that point later.

function getContinuationToken(page: unknown): string | undefined

Parameters

page

unknown

An object from accessing value on the IteratorResult from a byPage iterator.

Returns

string | undefined

The continuation token that can be passed into byPage() during future calls.