advisor

package
v6.3.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 2, 2024 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type GetRecommendationsArgs 

type GetRecommendationsArgs struct {
	// Specifies a list of categories in which the Advisor Recommendations will be listed. Possible values are `HighAvailability`, `Security`, `Performance`, `Cost` and `OperationalExcellence`.
	FilterByCategories []string `pulumi:"filterByCategories"`
	// Specifies a list of resource groups about which the Advisor Recommendations will be listed.
	FilterByResourceGroups []string `pulumi:"filterByResourceGroups"`
}

A collection of arguments for invoking getRecommendations.

type GetRecommendationsOutputArgs 

type GetRecommendationsOutputArgs struct {
	// Specifies a list of categories in which the Advisor Recommendations will be listed. Possible values are `HighAvailability`, `Security`, `Performance`, `Cost` and `OperationalExcellence`.
	FilterByCategories pulumi.StringArrayInput `pulumi:"filterByCategories"`
	// Specifies a list of resource groups about which the Advisor Recommendations will be listed.
	FilterByResourceGroups pulumi.StringArrayInput `pulumi:"filterByResourceGroups"`
}

A collection of arguments for invoking getRecommendations.

func (GetRecommendationsOutputArgs) ElementType 

func (GetRecommendationsOutputArgs) ElementType() reflect.Type

type GetRecommendationsRecommendation 

type GetRecommendationsRecommendation struct {
	// The category of the recommendation.
	Category string `pulumi:"category"`
	// The description of the issue or the opportunity identified by the recommendation.
	Description string `pulumi:"description"`
	// The business impact of the recommendation.
	Impact string `pulumi:"impact"`
	// The name of the Advisor Recommendation.
	RecommendationName string `pulumi:"recommendationName"`
	// The recommendation type id of the Advisor Recommendation.
	RecommendationTypeId string `pulumi:"recommendationTypeId"`
	// The name of the identified resource of the Advisor Recommendation.
	ResourceName string `pulumi:"resourceName"`
	// The type of the identified resource of the Advisor Recommendation.
	ResourceType string `pulumi:"resourceType"`
	// A list of Advisor Suppression names of the Advisor Recommendation.
	SuppressionNames []string `pulumi:"suppressionNames"`
	// The most recent time that Advisor checked the validity of the recommendation..
	UpdatedTime string `pulumi:"updatedTime"`
}

type GetRecommendationsRecommendationArgs 

type GetRecommendationsRecommendationArgs struct {
	// The category of the recommendation.
	Category pulumi.StringInput `pulumi:"category"`
	// The description of the issue or the opportunity identified by the recommendation.
	Description pulumi.StringInput `pulumi:"description"`
	// The business impact of the recommendation.
	Impact pulumi.StringInput `pulumi:"impact"`
	// The name of the Advisor Recommendation.
	RecommendationName pulumi.StringInput `pulumi:"recommendationName"`
	// The recommendation type id of the Advisor Recommendation.
	RecommendationTypeId pulumi.StringInput `pulumi:"recommendationTypeId"`
	// The name of the identified resource of the Advisor Recommendation.
	ResourceName pulumi.StringInput `pulumi:"resourceName"`
	// The type of the identified resource of the Advisor Recommendation.
	ResourceType pulumi.StringInput `pulumi:"resourceType"`
	// A list of Advisor Suppression names of the Advisor Recommendation.
	SuppressionNames pulumi.StringArrayInput `pulumi:"suppressionNames"`
	// The most recent time that Advisor checked the validity of the recommendation..
	UpdatedTime pulumi.StringInput `pulumi:"updatedTime"`
}

func (GetRecommendationsRecommendationArgs) ElementType 

func (GetRecommendationsRecommendationArgs) ElementType() reflect.Type

func (GetRecommendationsRecommendationArgs) ToGetRecommendationsRecommendationOutput 

func (i GetRecommendationsRecommendationArgs) ToGetRecommendationsRecommendationOutput() GetRecommendationsRecommendationOutput

func (GetRecommendationsRecommendationArgs) ToGetRecommendationsRecommendationOutputWithContext 

func (i GetRecommendationsRecommendationArgs) ToGetRecommendationsRecommendationOutputWithContext(ctx context.Context) GetRecommendationsRecommendationOutput

type GetRecommendationsRecommendationArray 

type GetRecommendationsRecommendationArray []GetRecommendationsRecommendationInput

func (GetRecommendationsRecommendationArray) ElementType 

func (GetRecommendationsRecommendationArray) ElementType() reflect.Type

func (GetRecommendationsRecommendationArray) ToGetRecommendationsRecommendationArrayOutput 

func (i GetRecommendationsRecommendationArray) ToGetRecommendationsRecommendationArrayOutput() GetRecommendationsRecommendationArrayOutput

func (GetRecommendationsRecommendationArray) ToGetRecommendationsRecommendationArrayOutputWithContext 

func (i GetRecommendationsRecommendationArray) ToGetRecommendationsRecommendationArrayOutputWithContext(ctx context.Context) GetRecommendationsRecommendationArrayOutput

type GetRecommendationsRecommendationArrayInput 

type GetRecommendationsRecommendationArrayInput interface {
	pulumi.Input

	ToGetRecommendationsRecommendationArrayOutput() GetRecommendationsRecommendationArrayOutput
	ToGetRecommendationsRecommendationArrayOutputWithContext(context.Context) GetRecommendationsRecommendationArrayOutput
}

GetRecommendationsRecommendationArrayInput is an input type that accepts GetRecommendationsRecommendationArray and GetRecommendationsRecommendationArrayOutput values. You can construct a concrete instance of `GetRecommendationsRecommendationArrayInput` via: 

GetRecommendationsRecommendationArray{ GetRecommendationsRecommendationArgs{...} }

type GetRecommendationsRecommendationArrayOutput 

type GetRecommendationsRecommendationArrayOutput struct{ *pulumi.OutputState }

func (GetRecommendationsRecommendationArrayOutput) ElementType 

func (GetRecommendationsRecommendationArrayOutput) ElementType() reflect.Type

func (GetRecommendationsRecommendationArrayOutput) Index 

func (o GetRecommendationsRecommendationArrayOutput) Index(i pulumi.IntInput) GetRecommendationsRecommendationOutput

func (GetRecommendationsRecommendationArrayOutput) ToGetRecommendationsRecommendationArrayOutput 

func (o GetRecommendationsRecommendationArrayOutput) ToGetRecommendationsRecommendationArrayOutput() GetRecommendationsRecommendationArrayOutput

func (GetRecommendationsRecommendationArrayOutput) ToGetRecommendationsRecommendationArrayOutputWithContext 

func (o GetRecommendationsRecommendationArrayOutput) ToGetRecommendationsRecommendationArrayOutputWithContext(ctx context.Context) GetRecommendationsRecommendationArrayOutput

type GetRecommendationsRecommendationInput 

type GetRecommendationsRecommendationInput interface {
	pulumi.Input

	ToGetRecommendationsRecommendationOutput() GetRecommendationsRecommendationOutput
	ToGetRecommendationsRecommendationOutputWithContext(context.Context) GetRecommendationsRecommendationOutput
}

GetRecommendationsRecommendationInput is an input type that accepts GetRecommendationsRecommendationArgs and GetRecommendationsRecommendationOutput values. You can construct a concrete instance of `GetRecommendationsRecommendationInput` via: 

GetRecommendationsRecommendationArgs{...}

type GetRecommendationsRecommendationOutput 

type GetRecommendationsRecommendationOutput struct{ *pulumi.OutputState }

func (GetRecommendationsRecommendationOutput) Category 

func (o GetRecommendationsRecommendationOutput) Category() pulumi.StringOutput

The category of the recommendation.

func (GetRecommendationsRecommendationOutput) Description 

func (o GetRecommendationsRecommendationOutput) Description() pulumi.StringOutput

The description of the issue or the opportunity identified by the recommendation.

func (GetRecommendationsRecommendationOutput) ElementType 

func (GetRecommendationsRecommendationOutput) ElementType() reflect.Type

func (GetRecommendationsRecommendationOutput) Impact 

func (o GetRecommendationsRecommendationOutput) Impact() pulumi.StringOutput

The business impact of the recommendation.

func (GetRecommendationsRecommendationOutput) RecommendationName 

func (o GetRecommendationsRecommendationOutput) RecommendationName() pulumi.StringOutput

The name of the Advisor Recommendation.

func (GetRecommendationsRecommendationOutput) RecommendationTypeId 

func (o GetRecommendationsRecommendationOutput) RecommendationTypeId() pulumi.StringOutput

The recommendation type id of the Advisor Recommendation.

func (GetRecommendationsRecommendationOutput) ResourceName 

func (o GetRecommendationsRecommendationOutput) ResourceName() pulumi.StringOutput

The name of the identified resource of the Advisor Recommendation.

func (GetRecommendationsRecommendationOutput) ResourceType 

func (o GetRecommendationsRecommendationOutput) ResourceType() pulumi.StringOutput

The type of the identified resource of the Advisor Recommendation.

func (GetRecommendationsRecommendationOutput) SuppressionNames 

func (o GetRecommendationsRecommendationOutput) SuppressionNames() pulumi.StringArrayOutput

A list of Advisor Suppression names of the Advisor Recommendation.

func (GetRecommendationsRecommendationOutput) ToGetRecommendationsRecommendationOutput 

func (o GetRecommendationsRecommendationOutput) ToGetRecommendationsRecommendationOutput() GetRecommendationsRecommendationOutput

func (GetRecommendationsRecommendationOutput) ToGetRecommendationsRecommendationOutputWithContext 

func (o GetRecommendationsRecommendationOutput) ToGetRecommendationsRecommendationOutputWithContext(ctx context.Context) GetRecommendationsRecommendationOutput

func (GetRecommendationsRecommendationOutput) UpdatedTime 

func (o GetRecommendationsRecommendationOutput) UpdatedTime() pulumi.StringOutput

The most recent time that Advisor checked the validity of the recommendation..

type GetRecommendationsResult 

type GetRecommendationsResult struct {
	FilterByCategories     []string `pulumi:"filterByCategories"`
	FilterByResourceGroups []string `pulumi:"filterByResourceGroups"`
	// The provider-assigned unique ID for this managed resource.
	Id string `pulumi:"id"`
	// One or more `recommendations` blocks as defined below.
	Recommendations []GetRecommendationsRecommendation `pulumi:"recommendations"`
}

A collection of values returned by getRecommendations.

func GetRecommendations 

func GetRecommendations(ctx *pulumi.Context, args *GetRecommendationsArgs, opts ...pulumi.InvokeOption) (*GetRecommendationsResult, error)

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

## Example Usage

```go 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
	})
}

```

type GetRecommendationsResultOutput 

type GetRecommendationsResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getRecommendations.

func GetRecommendationsOutput 

func GetRecommendationsOutput(ctx *pulumi.Context, args GetRecommendationsOutputArgs, opts ...pulumi.InvokeOption) GetRecommendationsResultOutput

func (GetRecommendationsResultOutput) ElementType 

func (GetRecommendationsResultOutput) ElementType() reflect.Type

func (GetRecommendationsResultOutput) FilterByCategories 

func (o GetRecommendationsResultOutput) FilterByCategories() pulumi.StringArrayOutput

func (GetRecommendationsResultOutput) FilterByResourceGroups 

func (o GetRecommendationsResultOutput) FilterByResourceGroups() pulumi.StringArrayOutput

func (GetRecommendationsResultOutput) Id 

func (o GetRecommendationsResultOutput) Id() pulumi.StringOutput

The provider-assigned unique ID for this managed resource.

func (GetRecommendationsResultOutput) Recommendations 

func (o GetRecommendationsResultOutput) Recommendations() GetRecommendationsRecommendationArrayOutput

One or more `recommendations` blocks as defined below.

func (GetRecommendationsResultOutput) ToGetRecommendationsResultOutput 

func (o GetRecommendationsResultOutput) ToGetRecommendationsResultOutput() GetRecommendationsResultOutput

func (GetRecommendationsResultOutput) ToGetRecommendationsResultOutputWithContext 

func (o GetRecommendationsResultOutput) ToGetRecommendationsResultOutputWithContext(ctx context.Context) GetRecommendationsResultOutput

type Suppression added in v6.3.0 

type Suppression struct {
	pulumi.CustomResourceState

	// The Name which should be used for this Advisor suppression. Changing this forces a new Advisor suppression to be created.
	Name pulumi.StringOutput `pulumi:"name"`
	// The ID of the Advisor recommendation to suppress. Changing this forces a new Advisor suppression to be created.
	RecommendationId pulumi.StringOutput `pulumi:"recommendationId"`
	// The ID of the Resource to suppress the Advisor recommendation for. Changing this forces a new Advisor suppression to be created.
	ResourceId pulumi.StringOutput `pulumi:"resourceId"`
	// The GUID of the suppression.
	SuppressionId pulumi.StringOutput `pulumi:"suppressionId"`
	// A optional time to live value. If omitted, the suppression will not expire. Changing this forces a new Advisor suppression to be created.
	Ttl pulumi.StringPtrOutput `pulumi:"ttl"`
}

Specifies a suppression for an Azure Advisor recommendation.

## Example Usage

```go package main

import ( 

"fmt"

"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/advisor"
"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		current, err := core.GetClientConfig(ctx, nil, nil)
		if err != nil {
			return err
		}
		_, err = advisor.GetRecommendations(ctx, nil, nil)
		if err != nil {
			return err
		}
		_, err = advisor.NewSuppression(ctx, "example", &advisor.SuppressionArgs{
			Name:             pulumi.String("HardcodedSuppressionName"),
			RecommendationId: pulumi.Any(test.Recommendations[0].RecommendationName),
			ResourceId:       pulumi.Sprintf("/subscriptions/%v", current.SubscriptionId),
			Ttl:              pulumi.String("01:00:00:00"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

## Import

Advisor suppressions can be imported using the `resource id`, e.g.

```sh $ pulumi import azure:advisor/suppression:Suppression example /subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Advisor/recommendations/00000000-0000-0000-0000-000000000000/suppressions/name ```

func GetSuppression added in v6.3.0 

func GetSuppression(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *SuppressionState, opts ...pulumi.ResourceOption) (*Suppression, error)

GetSuppression gets an existing Suppression resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewSuppression added in v6.3.0 

func NewSuppression(ctx *pulumi.Context,
	name string, args *SuppressionArgs, opts ...pulumi.ResourceOption) (*Suppression, error)

NewSuppression registers a new resource with the given unique name, arguments, and options.

func (*Suppression) ElementType added in v6.3.0 

func (*Suppression) ElementType() reflect.Type

func (*Suppression) ToSuppressionOutput added in v6.3.0 

func (i *Suppression) ToSuppressionOutput() SuppressionOutput

func (*Suppression) ToSuppressionOutputWithContext added in v6.3.0 

func (i *Suppression) ToSuppressionOutputWithContext(ctx context.Context) SuppressionOutput

type SuppressionArgs added in v6.3.0 

type SuppressionArgs struct {
	// The Name which should be used for this Advisor suppression. Changing this forces a new Advisor suppression to be created.
	Name pulumi.StringPtrInput
	// The ID of the Advisor recommendation to suppress. Changing this forces a new Advisor suppression to be created.
	RecommendationId pulumi.StringInput
	// The ID of the Resource to suppress the Advisor recommendation for. Changing this forces a new Advisor suppression to be created.
	ResourceId pulumi.StringInput
	// A optional time to live value. If omitted, the suppression will not expire. Changing this forces a new Advisor suppression to be created.
	Ttl pulumi.StringPtrInput
}

The set of arguments for constructing a Suppression resource.

func (SuppressionArgs) ElementType added in v6.3.0 

func (SuppressionArgs) ElementType() reflect.Type

type SuppressionArray added in v6.3.0 

type SuppressionArray []SuppressionInput

func (SuppressionArray) ElementType added in v6.3.0 

func (SuppressionArray) ElementType() reflect.Type

func (SuppressionArray) ToSuppressionArrayOutput added in v6.3.0 

func (i SuppressionArray) ToSuppressionArrayOutput() SuppressionArrayOutput

func (SuppressionArray) ToSuppressionArrayOutputWithContext added in v6.3.0 

func (i SuppressionArray) ToSuppressionArrayOutputWithContext(ctx context.Context) SuppressionArrayOutput

type SuppressionArrayInput added in v6.3.0 

type SuppressionArrayInput interface {
	pulumi.Input

	ToSuppressionArrayOutput() SuppressionArrayOutput
	ToSuppressionArrayOutputWithContext(context.Context) SuppressionArrayOutput
}

SuppressionArrayInput is an input type that accepts SuppressionArray and SuppressionArrayOutput values. You can construct a concrete instance of `SuppressionArrayInput` via: 

SuppressionArray{ SuppressionArgs{...} }

type SuppressionArrayOutput added in v6.3.0 

type SuppressionArrayOutput struct{ *pulumi.OutputState }

func (SuppressionArrayOutput) ElementType added in v6.3.0 

func (SuppressionArrayOutput) ElementType() reflect.Type

func (SuppressionArrayOutput) Index added in v6.3.0 

func (o SuppressionArrayOutput) Index(i pulumi.IntInput) SuppressionOutput

func (SuppressionArrayOutput) ToSuppressionArrayOutput added in v6.3.0 

func (o SuppressionArrayOutput) ToSuppressionArrayOutput() SuppressionArrayOutput

func (SuppressionArrayOutput) ToSuppressionArrayOutputWithContext added in v6.3.0 

func (o SuppressionArrayOutput) ToSuppressionArrayOutputWithContext(ctx context.Context) SuppressionArrayOutput

type SuppressionInput added in v6.3.0 

type SuppressionInput interface {
	pulumi.Input

	ToSuppressionOutput() SuppressionOutput
	ToSuppressionOutputWithContext(ctx context.Context) SuppressionOutput
}

type SuppressionMap added in v6.3.0 

type SuppressionMap map[string]SuppressionInput

func (SuppressionMap) ElementType added in v6.3.0 

func (SuppressionMap) ElementType() reflect.Type

func (SuppressionMap) ToSuppressionMapOutput added in v6.3.0 

func (i SuppressionMap) ToSuppressionMapOutput() SuppressionMapOutput

func (SuppressionMap) ToSuppressionMapOutputWithContext added in v6.3.0 

func (i SuppressionMap) ToSuppressionMapOutputWithContext(ctx context.Context) SuppressionMapOutput

type SuppressionMapInput added in v6.3.0 

type SuppressionMapInput interface {
	pulumi.Input

	ToSuppressionMapOutput() SuppressionMapOutput
	ToSuppressionMapOutputWithContext(context.Context) SuppressionMapOutput
}

SuppressionMapInput is an input type that accepts SuppressionMap and SuppressionMapOutput values. You can construct a concrete instance of `SuppressionMapInput` via: 

SuppressionMap{ "key": SuppressionArgs{...} }

type SuppressionMapOutput added in v6.3.0 

type SuppressionMapOutput struct{ *pulumi.OutputState }

func (SuppressionMapOutput) ElementType added in v6.3.0 

func (SuppressionMapOutput) ElementType() reflect.Type

func (SuppressionMapOutput) MapIndex added in v6.3.0 

func (o SuppressionMapOutput) MapIndex(k pulumi.StringInput) SuppressionOutput

func (SuppressionMapOutput) ToSuppressionMapOutput added in v6.3.0 

func (o SuppressionMapOutput) ToSuppressionMapOutput() SuppressionMapOutput

func (SuppressionMapOutput) ToSuppressionMapOutputWithContext added in v6.3.0 

func (o SuppressionMapOutput) ToSuppressionMapOutputWithContext(ctx context.Context) SuppressionMapOutput

type SuppressionOutput added in v6.3.0 

type SuppressionOutput struct{ *pulumi.OutputState }

func (SuppressionOutput) ElementType added in v6.3.0 

func (SuppressionOutput) ElementType() reflect.Type

func (SuppressionOutput) Name added in v6.3.0 

func (o SuppressionOutput) Name() pulumi.StringOutput

The Name which should be used for this Advisor suppression. Changing this forces a new Advisor suppression to be created.

func (SuppressionOutput) RecommendationId added in v6.3.0 

func (o SuppressionOutput) RecommendationId() pulumi.StringOutput

The ID of the Advisor recommendation to suppress. Changing this forces a new Advisor suppression to be created.

func (SuppressionOutput) ResourceId added in v6.3.0 

func (o SuppressionOutput) ResourceId() pulumi.StringOutput

The ID of the Resource to suppress the Advisor recommendation for. Changing this forces a new Advisor suppression to be created.

func (SuppressionOutput) SuppressionId added in v6.3.0 

func (o SuppressionOutput) SuppressionId() pulumi.StringOutput

The GUID of the suppression.

func (SuppressionOutput) ToSuppressionOutput added in v6.3.0 

func (o SuppressionOutput) ToSuppressionOutput() SuppressionOutput

func (SuppressionOutput) ToSuppressionOutputWithContext added in v6.3.0 

func (o SuppressionOutput) ToSuppressionOutputWithContext(ctx context.Context) SuppressionOutput

func (SuppressionOutput) Ttl added in v6.3.0 

func (o SuppressionOutput) Ttl() pulumi.StringPtrOutput

A optional time to live value. If omitted, the suppression will not expire. Changing this forces a new Advisor suppression to be created.

type SuppressionState added in v6.3.0 

type SuppressionState struct {
	// The Name which should be used for this Advisor suppression. Changing this forces a new Advisor suppression to be created.
	Name pulumi.StringPtrInput
	// The ID of the Advisor recommendation to suppress. Changing this forces a new Advisor suppression to be created.
	RecommendationId pulumi.StringPtrInput
	// The ID of the Resource to suppress the Advisor recommendation for. Changing this forces a new Advisor suppression to be created.
	ResourceId pulumi.StringPtrInput
	// The GUID of the suppression.
	SuppressionId pulumi.StringPtrInput
	// A optional time to live value. If omitted, the suppression will not expire. Changing this forces a new Advisor suppression to be created.
	Ttl pulumi.StringPtrInput
}

func (SuppressionState) ElementType added in v6.3.0 

func (SuppressionState) ElementType() reflect.Type

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.