@azure/arm-advisor package
Classes
| AdvisorManagementClient |
Interfaces
| ARMErrorResponseBody |
ARM error response body. |
| AdvisorManagementClientOptionalParams |
Optional parameters for the client. |
| AdvisorScoreEntity |
The details of Advisor score for a single category. |
| AdvisorScoreEntityProperties |
The Advisor score data. |
| AdvisorScoresGetOptionalParams |
Optional parameters. |
| AdvisorScoresListOptionalParams |
Optional parameters. |
| AdvisorScoresOperations |
Interface representing a AdvisorScores operations. |
| ArmErrorResponse |
model interface ArmErrorResponse |
| AssessmentResult |
The Advisor assessment result data structure. |
| AssessmentResultProperties |
Assessment result properties. |
| AssessmentTypeResult |
The Advisor assessment type result data structure. |
| AssessmentTypesListOptionalParams |
Optional parameters. |
| AssessmentTypesOperations |
Interface representing a AssessmentTypes operations. |
| AssessmentsDeleteOptionalParams |
Optional parameters. |
| AssessmentsGetOptionalParams |
Optional parameters. |
| AssessmentsListOptionalParams |
Optional parameters. |
| AssessmentsOperations |
Interface representing a Assessments operations. |
| AssessmentsPutOptionalParams |
Optional parameters. |
| ConfigData |
The Advisor configuration data structure. |
| ConfigDataProperties |
Configuration data properties |
| ConfigurationsCreateInResourceGroupOptionalParams |
Optional parameters. |
| ConfigurationsCreateInSubscriptionOptionalParams |
Optional parameters. |
| ConfigurationsListByResourceGroupOptionalParams |
Optional parameters. |
| ConfigurationsListBySubscriptionOptionalParams |
Optional parameters. |
| ConfigurationsOperations |
Interface representing a Configurations operations. |
| DigestConfig |
Advisor Digest configuration entity |
| ErrorAdditionalInfo |
The resource management error additional info. |
| ErrorDetail |
The error detail. |
| ErrorResponse |
Common error response for all Azure Resource Manager APIs to return error details for failed operations. |
| ExtensionResource |
The base extension resource. |
| MetadataEntity |
The metadata entity contract. |
| MetadataEntityProperties |
The metadata entity properties |
| MetadataSupportedValueDetail |
The metadata supported value detail. |
| OperationDisplayInfo |
The operation supported by Advisor. |
| OperationEntity |
The operation supported by Advisor. |
| OperationsListOptionalParams |
Optional parameters. |
| OperationsOperations |
Interface representing a Operations operations. |
| PageSettings |
Options for the byPage method |
| PagedAsyncIterableIterator |
An interface that allows async iterable iteration both to completion and by page. |
| PredictOptionalParams |
Optional parameters. |
| PredictionRequest |
Parameters for predict recommendation. |
| PredictionRequestProperties |
Properties given for the predictor. |
| PredictionResponse |
Response used by predictions. |
| PredictionResponseProperties |
Properties of the prediction |
| ProxyResource |
The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location |
| RecommendationMetadataGetOptionalParams |
Optional parameters. |
| RecommendationMetadataListOptionalParams |
Optional parameters. |
| RecommendationMetadataOperations |
Interface representing a RecommendationMetadata operations. |
| RecommendationPatchPayload |
The recommendation patch payload. |
| RecommendationProperties |
The properties of the recommendation. |
| RecommendationPropertiesResourceWorkload |
The Workload that this Resource belongs to. |
| RecommendationPropertiesReview |
The Review that this Recommendation belongs to. |
| RecommendationRejectBody |
Recommendation reject body. |
| RecommendationStatePropertiesPayload |
Properties for recommendation state patch payload. |
| RecommendationsGenerateOptionalParams |
Optional parameters. |
| RecommendationsGetGenerateStatusOptionalParams |
Optional parameters. |
| RecommendationsGetOptionalParams |
Optional parameters. |
| RecommendationsListByTenantOptionalParams |
Optional parameters. |
| RecommendationsListOptionalParams |
Optional parameters. |
| RecommendationsOperations |
Interface representing a Recommendations operations. |
| RecommendationsUpdateOptionalParams |
Optional parameters. |
| ResiliencyReview |
The Advisor resiliency review data structure. |
| ResiliencyReviewProperties |
Resiliency review properties. |
| ResiliencyReviewsGetOptionalParams |
Optional parameters. |
| ResiliencyReviewsListOptionalParams |
Optional parameters. |
| ResiliencyReviewsOperations |
Interface representing a ResiliencyReviews operations. |
| Resource |
Common fields that are returned in the response for all Azure Resource Manager resources |
| ResourceMetadata |
Recommendation resource metadata |
| ResourceRecommendationBase |
Advisor Recommendation. |
| ScoreEntity |
The details of Advisor Score |
| 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. |
| SuppressionProperties |
The properties of the suppression. |
| SuppressionsCreateOptionalParams |
Optional parameters. |
| SuppressionsDeleteOptionalParams |
Optional parameters. |
| SuppressionsGetOptionalParams |
Optional parameters. |
| SuppressionsListOptionalParams |
Optional parameters. |
| SuppressionsOperations |
Interface representing a Suppressions operations. |
| SystemData |
Metadata pertaining to creation and last modification of the resource. |
| TimeSeriesEntity |
The historic data at different aggregation levels. |
| TrackedRecommendationProperties |
The tracked properties of a Recommendation |
| TriageRecommendation |
Triage recommendation data structure. |
| TriageRecommendationProperties |
Triage recommendation properties. |
| TriageRecommendationsApproveTriageRecommendationOptionalParams |
Optional parameters. |
| TriageRecommendationsGetOptionalParams |
Optional parameters. |
| TriageRecommendationsListOptionalParams |
Optional parameters. |
| TriageRecommendationsOperations |
Interface representing a TriageRecommendations operations. |
| TriageRecommendationsRejectTriageRecommendationOptionalParams |
Optional parameters. |
| TriageRecommendationsResetTriageRecommendationOptionalParams |
Optional parameters. |
| TriageResource |
Triage resource data structure. |
| TriageResourceProperties |
Triage resource properties. |
| TriageResourcesGetOptionalParams |
Optional parameters. |
| TriageResourcesListOptionalParams |
Optional parameters. |
| TriageResourcesOperations |
Interface representing a TriageResources operations. |
| WorkloadResult |
The Workload result data structure. |
| WorkloadsListOptionalParams |
Optional parameters. |
| WorkloadsOperations |
Interface representing a Workloads operations. |
Type Aliases
| Aggregated |
The aggregation level of the score. Known values supported by the serviceweek |
| AzureSupportedClouds |
The supported values for cloud setting as a string literal type |
| Category |
The category of the recommendation. Known values supported by the serviceHighAvailability |
| ConfigurationName |
Type of ConfigurationName |
| ContinuablePage |
An interface that describes a page of results. |
| Control |
The sub-category of the recommendation. Known values supported by the serviceHighAvailability |
| CpuThreshold |
Minimum percentage threshold for Advisor low CPU utilization evaluation. Valid only for subscriptions. Valid values: 5 (default), 10, 15 or 20. Known values supported by the service5 |
| CreatedByType |
The kind of entity that created the resource. Known values supported by the serviceUser: The entity was created by a user. |
| DigestConfigState |
State of digest configuration. Known values supported by the serviceActive |
| Duration |
Minimum duration for Advisor low CPU utilization evaluation. Valid only for subscriptions. Valid values: 7 (default), 14, 21, 30, 60 or 90. Known values supported by the service7 |
| Impact |
The business impact of the recommendation. Known values supported by the serviceHigh |
| PredictionType |
Type of the prediction. Known values supported by the servicePredictiveRightsizing |
| Priority |
The Priority of the Recommendation. Known values supported by the serviceCritical |
| PriorityName |
Recommendation priority name enum. Known values supported by the serviceHigh: High |
| ReasonForRejectionName |
Reason for rejecting recommendation name enum. Known values supported by the serviceNotARisk: Not A Risk |
| RecommendationDismissReason |
The reason for dismissing the Recommendation. Known values supported by the serviceExcessiveCostInvestmentRequired |
| RecommendationStatus |
The state of the Recommendation applicable from v2026-02-01-preview. Known values supported by the serviceNew |
| RecommendationStatusName |
Recommendation status name enum. Known values supported by the serviceApproved: Approved |
| ReviewStatus |
Review status. Known values supported by the serviceNew: The review has been newly created. |
| Risk |
The potential risk of not implementing the recommendation. Known values supported by the serviceError |
| Scenario |
The list of scenarios applicable to this metadata entity. Known values supported by the serviceAlerts |
Enums
| AzureClouds |
An enum to describe Azure Cloud environments. |
| KnownAggregated |
The aggregation level of the score. |
| KnownCategory |
The category of the recommendation. |
| KnownConfigurationName |
Known values of ConfigurationName that the service accepts. |
| KnownControl |
The sub-category of the recommendation. |
| KnownCpuThreshold |
Minimum percentage threshold for Advisor low CPU utilization evaluation. Valid only for subscriptions. Valid values: 5 (default), 10, 15 or 20. |
| KnownCreatedByType |
The kind of entity that created the resource. |
| KnownDigestConfigState |
State of digest configuration. |
| KnownDuration |
Minimum duration for Advisor low CPU utilization evaluation. Valid only for subscriptions. Valid values: 7 (default), 14, 21, 30, 60 or 90. |
| KnownImpact |
The business impact of the recommendation. |
| KnownPredictionType |
Type of the prediction. |
| KnownPriority |
The Priority of the Recommendation. |
| KnownPriorityName |
Recommendation priority name enum. |
| KnownReasonForRejectionName |
Reason for rejecting recommendation name enum. |
| KnownRecommendationDismissReason |
The reason for dismissing the Recommendation. |
| KnownRecommendationStatus |
The state of the Recommendation applicable from v2026-02-01-preview. |
| KnownRecommendationStatusName |
Recommendation status name enum. |
| KnownReviewStatus |
Review status. |
| KnownRisk |
The potential risk of not implementing the recommendation. |
| KnownScenario |
The list of scenarios applicable to this metadata entity. |
| KnownVersions |
The available API versions. |
Functions
| is |
Typeguard for RestError |
Variables
| Rest |
A custom error type for failed pipeline requests. |
Function Details
isRestError(unknown)
Typeguard for RestError
function isRestError(e: unknown): e
Parameters
- e
-
unknown
Something caught by a catch clause.
Returns
e
Variable Details
RestError
A custom error type for failed pipeline requests.
RestError: RestErrorConstructor