Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Classic
  3. API Docs
  4. advisor
  5. getRecommendations

We recommend using Azure Native.

Azure v6.10.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-azure

azure.advisor.getRecommendations

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure v6.10.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-azure

    Use this data source to access information about an existing Advisor Recommendations.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = azure.advisor.getRecommendations({
    filterByCategories: [
        "security",
        "cost",
    ],
    filterByResourceGroups: ["example-resgroups"],
});
export const recommendations = example.then(example => example.recommendations);

    import pulumi
import pulumi_azure as azure

example = azure.advisor.get_recommendations(filter_by_categories=[
        "security",
        "cost",
    ],
    filter_by_resource_groups=["example-resgroups"])
pulumi.export("recommendations", example.recommendations)

    package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/advisor"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := advisor.GetRecommendations(ctx, &advisor.GetRecommendationsArgs{
			FilterByCategories: []string{
				"security",
				"cost",
			},
			FilterByResourceGroups: []string{
				"example-resgroups",
			},
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("recommendations", example.Recommendations)
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;

return await Deployment.RunAsync(() => 
{
    var example = Azure.Advisor.GetRecommendations.Invoke(new()
    {
        FilterByCategories = new[]
        {
            "security",
            "cost",
        },
        FilterByResourceGroups = new[]
        {
            "example-resgroups",
        },
    });

    return new Dictionary<string, object?>
    {
        ["recommendations"] = example.Apply(getRecommendationsResult => getRecommendationsResult.Recommendations),
    };
});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.advisor.AdvisorFunctions;
import com.pulumi.azure.advisor.inputs.GetRecommendationsArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var example = AdvisorFunctions.getRecommendations(GetRecommendationsArgs.builder()
            .filterByCategories(            
                "security",
                "cost")
            .filterByResourceGroups("example-resgroups")
            .build());

        ctx.export("recommendations", example.applyValue(getRecommendationsResult -> getRecommendationsResult.recommendations()));
    }
}

    variables:
  example:
    fn::invoke:
      Function: azure:advisor:getRecommendations
      Arguments:
        filterByCategories:
          - security
          - cost
        filterByResourceGroups:
          - example-resgroups
outputs:
  recommendations: ${example.recommendations}

    Using getRecommendations

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getRecommendations(args: GetRecommendationsArgs, opts?: InvokeOptions): Promise<GetRecommendationsResult>
function getRecommendationsOutput(args: GetRecommendationsOutputArgs, opts?: InvokeOptions): Output<GetRecommendationsResult>
    def get_recommendations(filter_by_categories: Optional[Sequence[str]] = None,
                        filter_by_resource_groups: Optional[Sequence[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> GetRecommendationsResult
def get_recommendations_output(filter_by_categories: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                        filter_by_resource_groups: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetRecommendationsResult]
    func GetRecommendations(ctx *Context, args *GetRecommendationsArgs, opts ...InvokeOption) (*GetRecommendationsResult, error)
func GetRecommendationsOutput(ctx *Context, args *GetRecommendationsOutputArgs, opts ...InvokeOption) GetRecommendationsResultOutput

    > Note: This function is named GetRecommendations in the Go SDK.

    public static class GetRecommendations 
{
    public static Task<GetRecommendationsResult> InvokeAsync(GetRecommendationsArgs args, InvokeOptions? opts = null)
    public static Output<GetRecommendationsResult> Invoke(GetRecommendationsInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetRecommendationsResult> getRecommendations(GetRecommendationsArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: azure:advisor/getRecommendations:getRecommendations
  arguments:
    # arguments dictionary

    The following arguments are supported:

    FilterByCategories List<string>
    Specifies a list of categories in which the Advisor Recommendations will be listed. Possible values are HighAvailability, Security, Performance, Cost and OperationalExcellence.
    FilterByResourceGroups List<string>
    Specifies a list of resource groups about which the Advisor Recommendations will be listed.
    FilterByCategories []string
    Specifies a list of categories in which the Advisor Recommendations will be listed. Possible values are HighAvailability, Security, Performance, Cost and OperationalExcellence.
    FilterByResourceGroups []string
    Specifies a list of resource groups about which the Advisor Recommendations will be listed.
    filterByCategories List<String>
    Specifies a list of categories in which the Advisor Recommendations will be listed. Possible values are HighAvailability, Security, Performance, Cost and OperationalExcellence.
    filterByResourceGroups List<String>
    Specifies a list of resource groups about which the Advisor Recommendations will be listed.
    filterByCategories string[]
    Specifies a list of categories in which the Advisor Recommendations will be listed. Possible values are HighAvailability, Security, Performance, Cost and OperationalExcellence.
    filterByResourceGroups string[]
    Specifies a list of resource groups about which the Advisor Recommendations will be listed.
    filter_by_categories Sequence[str]
    Specifies a list of categories in which the Advisor Recommendations will be listed. Possible values are HighAvailability, Security, Performance, Cost and OperationalExcellence.
    filter_by_resource_groups Sequence[str]
    Specifies a list of resource groups about which the Advisor Recommendations will be listed.
    filterByCategories List<String>
    Specifies a list of categories in which the Advisor Recommendations will be listed. Possible values are HighAvailability, Security, Performance, Cost and OperationalExcellence.
    filterByResourceGroups List<String>
    Specifies a list of resource groups about which the Advisor Recommendations will be listed.

    getRecommendations Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    Recommendations List<GetRecommendationsRecommendation>
    One or more recommendations blocks as defined below.
    FilterByCategories List<string>
    FilterByResourceGroups List<string>
    Id string
    The provider-assigned unique ID for this managed resource.
    Recommendations []GetRecommendationsRecommendation
    One or more recommendations blocks as defined below.
    FilterByCategories []string
    FilterByResourceGroups []string
    id String
    The provider-assigned unique ID for this managed resource.
    recommendations List<GetRecommendationsRecommendation>
    One or more recommendations blocks as defined below.
    filterByCategories List<String>
    filterByResourceGroups List<String>
    id string
    The provider-assigned unique ID for this managed resource.
    recommendations GetRecommendationsRecommendation[]
    One or more recommendations blocks as defined below.
    filterByCategories string[]
    filterByResourceGroups string[]
    id str
    The provider-assigned unique ID for this managed resource.
    recommendations Sequence[GetRecommendationsRecommendation]
    One or more recommendations blocks as defined below.
    filter_by_categories Sequence[str]
    filter_by_resource_groups Sequence[str]
    id String
    The provider-assigned unique ID for this managed resource.
    recommendations List<Property Map>
    One or more recommendations blocks as defined below.
    filterByCategories List<String>
    filterByResourceGroups List<String>

    Supporting Types

    GetRecommendationsRecommendation

    Category string
    The category of the recommendation.
    Description string
    The description of the issue or the opportunity identified by the recommendation.
    Impact string
    The business impact of the recommendation.
    RecommendationName string
    The name of the Advisor Recommendation.
    RecommendationTypeId string
    The recommendation type id of the Advisor Recommendation.
    ResourceName string
    The name of the identified resource of the Advisor Recommendation.
    ResourceType string
    The type of the identified resource of the Advisor Recommendation.
    SuppressionNames List<string>
    A list of Advisor Suppression names of the Advisor Recommendation.
    UpdatedTime string
    The most recent time that Advisor checked the validity of the recommendation..
    Category string
    The category of the recommendation.
    Description string
    The description of the issue or the opportunity identified by the recommendation.
    Impact string
    The business impact of the recommendation.
    RecommendationName string
    The name of the Advisor Recommendation.
    RecommendationTypeId string
    The recommendation type id of the Advisor Recommendation.
    ResourceName string
    The name of the identified resource of the Advisor Recommendation.
    ResourceType string
    The type of the identified resource of the Advisor Recommendation.
    SuppressionNames []string
    A list of Advisor Suppression names of the Advisor Recommendation.
    UpdatedTime string
    The most recent time that Advisor checked the validity of the recommendation..
    category String
    The category of the recommendation.
    description String
    The description of the issue or the opportunity identified by the recommendation.
    impact String
    The business impact of the recommendation.
    recommendationName String
    The name of the Advisor Recommendation.
    recommendationTypeId String
    The recommendation type id of the Advisor Recommendation.
    resourceName String
    The name of the identified resource of the Advisor Recommendation.
    resourceType String
    The type of the identified resource of the Advisor Recommendation.
    suppressionNames List<String>
    A list of Advisor Suppression names of the Advisor Recommendation.
    updatedTime String
    The most recent time that Advisor checked the validity of the recommendation..
    category string
    The category of the recommendation.
    description string
    The description of the issue or the opportunity identified by the recommendation.
    impact string
    The business impact of the recommendation.
    recommendationName string
    The name of the Advisor Recommendation.
    recommendationTypeId string
    The recommendation type id of the Advisor Recommendation.
    resourceName string
    The name of the identified resource of the Advisor Recommendation.
    resourceType string
    The type of the identified resource of the Advisor Recommendation.
    suppressionNames string[]
    A list of Advisor Suppression names of the Advisor Recommendation.
    updatedTime string
    The most recent time that Advisor checked the validity of the recommendation..
    category str
    The category of the recommendation.
    description str
    The description of the issue or the opportunity identified by the recommendation.
    impact str
    The business impact of the recommendation.
    recommendation_name str
    The name of the Advisor Recommendation.
    recommendation_type_id str
    The recommendation type id of the Advisor Recommendation.
    resource_name str
    The name of the identified resource of the Advisor Recommendation.
    resource_type str
    The type of the identified resource of the Advisor Recommendation.
    suppression_names Sequence[str]
    A list of Advisor Suppression names of the Advisor Recommendation.
    updated_time str
    The most recent time that Advisor checked the validity of the recommendation..
    category String
    The category of the recommendation.
    description String
    The description of the issue or the opportunity identified by the recommendation.
    impact String
    The business impact of the recommendation.
    recommendationName String
    The name of the Advisor Recommendation.
    recommendationTypeId String
    The recommendation type id of the Advisor Recommendation.
    resourceName String
    The name of the identified resource of the Advisor Recommendation.
    resourceType String
    The type of the identified resource of the Advisor Recommendation.
    suppressionNames List<String>
    A list of Advisor Suppression names of the Advisor Recommendation.
    updatedTime String
    The most recent time that Advisor checked the validity of the recommendation..

    Package Details

    Repository
    Azure Classic pulumi/pulumi-azure
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the azurerm Terraform Provider.
    azure logo

    We recommend using Azure Native.

    Azure v6.10.0 published on Tuesday, Nov 19, 2024 by Pulumi
    pulumi/pulumi-azure