Recommendations interface

Package:

@azure/arm-advisor

Interface representing a Recommendations.

Methods

generate(RecommendationsGenerateOptionalParams)	Initiates the recommendation generation or computation process for a subscription. This operation is asynchronous. The generated recommendations are stored in a cache in the Advisor service.
get(string, string, RecommendationsGetOptionalParams)	Obtains details of a cached recommendation.
getGenerateStatus(string, RecommendationsGetGenerateStatusOptionalParams)	Retrieves the status of the recommendation computation or generation process. Invoke this API after calling the generation recommendation. The URI of this API is returned in the Location field of the response header.
list(RecommendationsListOptionalParams)	Obtains cached recommendations for a subscription. The recommendations are generated or computed by invoking generateRecommendations.

Method Details

generate(RecommendationsGenerateOptionalParams)

Initiates the recommendation generation or computation process for a subscription. This operation is asynchronous. The generated recommendations are stored in a cache in the Advisor service.

function generate(options?: RecommendationsGenerateOptionalParams): Promise<RecommendationsGenerateHeaders>

Parameters

options

RecommendationsGenerateOptionalParams

The options parameters.

Returns

Promise<RecommendationsGenerateHeaders>

get(string, string, RecommendationsGetOptionalParams)

Obtains details of a cached recommendation.

function get(resourceUri: string, recommendationId: string, options?: RecommendationsGetOptionalParams): Promise<ResourceRecommendationBase>

Parameters

resourceUri

string

The fully qualified Azure Resource Manager identifier of the resource to which the recommendation applies.

recommendationId

string

The recommendation ID.

options

RecommendationsGetOptionalParams

The options parameters.

Returns

Promise<ResourceRecommendationBase>

getGenerateStatus(string, RecommendationsGetGenerateStatusOptionalParams)

Retrieves the status of the recommendation computation or generation process. Invoke this API after calling the generation recommendation. The URI of this API is returned in the Location field of the response header.

function getGenerateStatus(operationId: string, options?: RecommendationsGetGenerateStatusOptionalParams): Promise<void>

Parameters

operationId

string

The operation ID, which can be found from the Location field in the generate recommendation response header.

options

RecommendationsGetGenerateStatusOptionalParams

The options parameters.

Returns

Promise<void>

list(RecommendationsListOptionalParams)

Obtains cached recommendations for a subscription. The recommendations are generated or computed by invoking generateRecommendations.

function list(options?: RecommendationsListOptionalParams): PagedAsyncIterableIterator<ResourceRecommendationBase, ResourceRecommendationBase[], PageSettings>

Parameters

options

RecommendationsListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<ResourceRecommendationBase, ResourceRecommendationBase[], PageSettings>