savedSearch.go

// *** WARNING: this file was generated by the Pulumi Terraform Bridge (tfgen) Tool. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***

package loganalytics

import (
	"context"
	"reflect"

	"github.com/pkg/errors"
	"github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

// Manages a Log Analytics (formally Operational Insights) Saved Search.
//
// ## Example Usage
//
// ```go
// package main
//
// import (
// 	"github.com/pulumi/pulumi-azure/sdk/v3/go/azure/core"
// 	"github.com/pulumi/pulumi-azure/sdk/v3/go/azure/loganalytics"
// 	"github.com/pulumi/pulumi-azure/sdk/v3/go/azure/operationalinsights"
// 	"github.com/pulumi/pulumi/sdk/v2/go/pulumi"
// )
//
// func main() {
// 	pulumi.Run(func(ctx *pulumi.Context) error {
// 		exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
// 			Location: pulumi.String("West Europe"),
// 		})
// 		if err != nil {
// 			return err
// 		}
// 		_, err = operationalinsights.NewAnalyticsWorkspace(ctx, "exampleAnalyticsWorkspace", &operationalinsights.AnalyticsWorkspaceArgs{
// 			Location:          exampleResourceGroup.Location,
// 			ResourceGroupName: exampleResourceGroup.Name,
// 			Sku:               pulumi.String("PerGB2018"),
// 			RetentionInDays:   pulumi.Int(30),
// 		})
// 		if err != nil {
// 			return err
// 		}
// 		_, err = loganalytics.NewSavedSearch(ctx, "exampleSavedSearch", &loganalytics.SavedSearchArgs{
// 			LogAnalyticsWorkspaceId: pulumi.Any(azurerm_log_analytics_workspace.Test.Id),
// 			Category:                pulumi.String("exampleCategory"),
// 			DisplayName:             pulumi.String("exampleDisplayName"),
// 			Query:                   pulumi.String("exampleQuery"),
// 		})
// 		if err != nil {
// 			return err
// 		}
// 		return nil
// 	})
// }
// ```
//
// ## Import
//
// Log Analytics Saved Searches can be imported using the `resource id`, e.g.
//
// ```sh
//  $ pulumi import azure:loganalytics/savedSearch:SavedSearch search1 /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/Microsoft.OperationalInsights/workspaces/workspace1/savedSearches/search1
// ```
type SavedSearch struct {
	pulumi.CustomResourceState

	// The category that the Saved Search will be listed under. Changing this forces a new resource to be created.
	Category pulumi.StringOutput `pulumi:"category"`
	// The name that Saved Search will be displayed as. Changing this forces a new resource to be created.
	DisplayName pulumi.StringOutput `pulumi:"displayName"`
	// The function alias if the query serves as a function. Changing this forces a new resource to be created.
	FunctionAlias pulumi.StringPtrOutput `pulumi:"functionAlias"`
	// The function parameters if the query serves as a function. Changing this forces a new resource to be created.
	FunctionParameters pulumi.StringArrayOutput `pulumi:"functionParameters"`
	// Specifies the ID of the Log Analytics Workspace that the Saved Search will be associated with. Changing this forces a new resource to be created.
	LogAnalyticsWorkspaceId pulumi.StringOutput `pulumi:"logAnalyticsWorkspaceId"`
	// Specifies the name of the Log Analytics Saved Search. Changing this forces a new resource to be created.
	Name pulumi.StringOutput `pulumi:"name"`
	// The query expression for the saved search. Changing this forces a new resource to be created.
	Query pulumi.StringOutput `pulumi:"query"`
	// A mapping of tags which should be assigned to the Logs Analytics Saved Search.
	Tags pulumi.StringMapOutput `pulumi:"tags"`
}

// NewSavedSearch registers a new resource with the given unique name, arguments, and options.
func NewSavedSearch(ctx *pulumi.Context,
	name string, args *SavedSearchArgs, opts ...pulumi.ResourceOption) (*SavedSearch, error) {
	if args == nil {
		return nil, errors.New("missing one or more required arguments")
	}

	if args.Category == nil {
		return nil, errors.New("invalid value for required argument 'Category'")
	}
	if args.DisplayName == nil {
		return nil, errors.New("invalid value for required argument 'DisplayName'")
	}
	if args.LogAnalyticsWorkspaceId == nil {
		return nil, errors.New("invalid value for required argument 'LogAnalyticsWorkspaceId'")
	}
	if args.Query == nil {
		return nil, errors.New("invalid value for required argument 'Query'")
	}
	var resource SavedSearch
	err := ctx.RegisterResource("azure:loganalytics/savedSearch:SavedSearch", name, args, &resource, opts...)
	if err != nil {
		return nil, err
	}
	return &resource, nil
}

// GetSavedSearch gets an existing SavedSearch 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 GetSavedSearch(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *SavedSearchState, opts ...pulumi.ResourceOption) (*SavedSearch, error) {
	var resource SavedSearch
	err := ctx.ReadResource("azure:loganalytics/savedSearch:SavedSearch", name, id, state, &resource, opts...)
	if err != nil {
		return nil, err
	}
	return &resource, nil
}

// Input properties used for looking up and filtering SavedSearch resources.
type savedSearchState struct {
	// The category that the Saved Search will be listed under. Changing this forces a new resource to be created.
	Category *string `pulumi:"category"`
	// The name that Saved Search will be displayed as. Changing this forces a new resource to be created.
	DisplayName *string `pulumi:"displayName"`
	// The function alias if the query serves as a function. Changing this forces a new resource to be created.
	FunctionAlias *string `pulumi:"functionAlias"`
	// The function parameters if the query serves as a function. Changing this forces a new resource to be created.
	FunctionParameters []string `pulumi:"functionParameters"`
	// Specifies the ID of the Log Analytics Workspace that the Saved Search will be associated with. Changing this forces a new resource to be created.
	LogAnalyticsWorkspaceId *string `pulumi:"logAnalyticsWorkspaceId"`
	// Specifies the name of the Log Analytics Saved Search. Changing this forces a new resource to be created.
	Name *string `pulumi:"name"`
	// The query expression for the saved search. Changing this forces a new resource to be created.
	Query *string `pulumi:"query"`
	// A mapping of tags which should be assigned to the Logs Analytics Saved Search.
	Tags map[string]string `pulumi:"tags"`
}

type SavedSearchState struct {
	// The category that the Saved Search will be listed under. Changing this forces a new resource to be created.
	Category pulumi.StringPtrInput
	// The name that Saved Search will be displayed as. Changing this forces a new resource to be created.
	DisplayName pulumi.StringPtrInput
	// The function alias if the query serves as a function. Changing this forces a new resource to be created.
	FunctionAlias pulumi.StringPtrInput
	// The function parameters if the query serves as a function. Changing this forces a new resource to be created.
	FunctionParameters pulumi.StringArrayInput
	// Specifies the ID of the Log Analytics Workspace that the Saved Search will be associated with. Changing this forces a new resource to be created.
	LogAnalyticsWorkspaceId pulumi.StringPtrInput
	// Specifies the name of the Log Analytics Saved Search. Changing this forces a new resource to be created.
	Name pulumi.StringPtrInput
	// The query expression for the saved search. Changing this forces a new resource to be created.
	Query pulumi.StringPtrInput
	// A mapping of tags which should be assigned to the Logs Analytics Saved Search.
	Tags pulumi.StringMapInput
}

func (SavedSearchState) ElementType() reflect.Type {
	return reflect.TypeOf((*savedSearchState)(nil)).Elem()
}

type savedSearchArgs struct {
	// The category that the Saved Search will be listed under. Changing this forces a new resource to be created.
	Category string `pulumi:"category"`
	// The name that Saved Search will be displayed as. Changing this forces a new resource to be created.
	DisplayName string `pulumi:"displayName"`
	// The function alias if the query serves as a function. Changing this forces a new resource to be created.
	FunctionAlias *string `pulumi:"functionAlias"`
	// The function parameters if the query serves as a function. Changing this forces a new resource to be created.
	FunctionParameters []string `pulumi:"functionParameters"`
	// Specifies the ID of the Log Analytics Workspace that the Saved Search will be associated with. Changing this forces a new resource to be created.
	LogAnalyticsWorkspaceId string `pulumi:"logAnalyticsWorkspaceId"`
	// Specifies the name of the Log Analytics Saved Search. Changing this forces a new resource to be created.
	Name *string `pulumi:"name"`
	// The query expression for the saved search. Changing this forces a new resource to be created.
	Query string `pulumi:"query"`
	// A mapping of tags which should be assigned to the Logs Analytics Saved Search.
	Tags map[string]string `pulumi:"tags"`
}

// The set of arguments for constructing a SavedSearch resource.
type SavedSearchArgs struct {
	// The category that the Saved Search will be listed under. Changing this forces a new resource to be created.
	Category pulumi.StringInput
	// The name that Saved Search will be displayed as. Changing this forces a new resource to be created.
	DisplayName pulumi.StringInput
	// The function alias if the query serves as a function. Changing this forces a new resource to be created.
	FunctionAlias pulumi.StringPtrInput
	// The function parameters if the query serves as a function. Changing this forces a new resource to be created.
	FunctionParameters pulumi.StringArrayInput
	// Specifies the ID of the Log Analytics Workspace that the Saved Search will be associated with. Changing this forces a new resource to be created.
	LogAnalyticsWorkspaceId pulumi.StringInput
	// Specifies the name of the Log Analytics Saved Search. Changing this forces a new resource to be created.
	Name pulumi.StringPtrInput
	// The query expression for the saved search. Changing this forces a new resource to be created.
	Query pulumi.StringInput
	// A mapping of tags which should be assigned to the Logs Analytics Saved Search.
	Tags pulumi.StringMapInput
}

func (SavedSearchArgs) ElementType() reflect.Type {
	return reflect.TypeOf((*savedSearchArgs)(nil)).Elem()
}

type SavedSearchInput interface {
	pulumi.Input

	ToSavedSearchOutput() SavedSearchOutput
	ToSavedSearchOutputWithContext(ctx context.Context) SavedSearchOutput
}

func (*SavedSearch) ElementType() reflect.Type {
	return reflect.TypeOf((*SavedSearch)(nil))
}

func (i *SavedSearch) ToSavedSearchOutput() SavedSearchOutput {
	return i.ToSavedSearchOutputWithContext(context.Background())
}

func (i *SavedSearch) ToSavedSearchOutputWithContext(ctx context.Context) SavedSearchOutput {
	return pulumi.ToOutputWithContext(ctx, i).(SavedSearchOutput)
}

func (i *SavedSearch) ToSavedSearchPtrOutput() SavedSearchPtrOutput {
	return i.ToSavedSearchPtrOutputWithContext(context.Background())
}

func (i *SavedSearch) ToSavedSearchPtrOutputWithContext(ctx context.Context) SavedSearchPtrOutput {
	return pulumi.ToOutputWithContext(ctx, i).(SavedSearchPtrOutput)
}

type SavedSearchPtrInput interface {
	pulumi.Input

	ToSavedSearchPtrOutput() SavedSearchPtrOutput
	ToSavedSearchPtrOutputWithContext(ctx context.Context) SavedSearchPtrOutput
}

type savedSearchPtrType SavedSearchArgs

func (*savedSearchPtrType) ElementType() reflect.Type {
	return reflect.TypeOf((**SavedSearch)(nil))
}

func (i *savedSearchPtrType) ToSavedSearchPtrOutput() SavedSearchPtrOutput {
	return i.ToSavedSearchPtrOutputWithContext(context.Background())
}

func (i *savedSearchPtrType) ToSavedSearchPtrOutputWithContext(ctx context.Context) SavedSearchPtrOutput {
	return pulumi.ToOutputWithContext(ctx, i).(SavedSearchPtrOutput)
}

// SavedSearchArrayInput is an input type that accepts SavedSearchArray and SavedSearchArrayOutput values.
// You can construct a concrete instance of `SavedSearchArrayInput` via:
//
//          SavedSearchArray{ SavedSearchArgs{...} }
type SavedSearchArrayInput interface {
	pulumi.Input

	ToSavedSearchArrayOutput() SavedSearchArrayOutput
	ToSavedSearchArrayOutputWithContext(context.Context) SavedSearchArrayOutput
}

type SavedSearchArray []SavedSearchInput

func (SavedSearchArray) ElementType() reflect.Type {
	return reflect.TypeOf(([]*SavedSearch)(nil))
}

func (i SavedSearchArray) ToSavedSearchArrayOutput() SavedSearchArrayOutput {
	return i.ToSavedSearchArrayOutputWithContext(context.Background())
}

func (i SavedSearchArray) ToSavedSearchArrayOutputWithContext(ctx context.Context) SavedSearchArrayOutput {
	return pulumi.ToOutputWithContext(ctx, i).(SavedSearchArrayOutput)
}

// SavedSearchMapInput is an input type that accepts SavedSearchMap and SavedSearchMapOutput values.
// You can construct a concrete instance of `SavedSearchMapInput` via:
//
//          SavedSearchMap{ "key": SavedSearchArgs{...} }
type SavedSearchMapInput interface {
	pulumi.Input

	ToSavedSearchMapOutput() SavedSearchMapOutput
	ToSavedSearchMapOutputWithContext(context.Context) SavedSearchMapOutput
}

type SavedSearchMap map[string]SavedSearchInput

func (SavedSearchMap) ElementType() reflect.Type {
	return reflect.TypeOf((map[string]*SavedSearch)(nil))
}

func (i SavedSearchMap) ToSavedSearchMapOutput() SavedSearchMapOutput {
	return i.ToSavedSearchMapOutputWithContext(context.Background())
}

func (i SavedSearchMap) ToSavedSearchMapOutputWithContext(ctx context.Context) SavedSearchMapOutput {
	return pulumi.ToOutputWithContext(ctx, i).(SavedSearchMapOutput)
}

type SavedSearchOutput struct {
	*pulumi.OutputState
}

func (SavedSearchOutput) ElementType() reflect.Type {
	return reflect.TypeOf((*SavedSearch)(nil))
}

func (o SavedSearchOutput) ToSavedSearchOutput() SavedSearchOutput {
	return o
}

func (o SavedSearchOutput) ToSavedSearchOutputWithContext(ctx context.Context) SavedSearchOutput {
	return o
}

func (o SavedSearchOutput) ToSavedSearchPtrOutput() SavedSearchPtrOutput {
	return o.ToSavedSearchPtrOutputWithContext(context.Background())
}

func (o SavedSearchOutput) ToSavedSearchPtrOutputWithContext(ctx context.Context) SavedSearchPtrOutput {
	return o.ApplyT(func(v SavedSearch) *SavedSearch {
		return &v
	}).(SavedSearchPtrOutput)
}

type SavedSearchPtrOutput struct {
	*pulumi.OutputState
}

func (SavedSearchPtrOutput) ElementType() reflect.Type {
	return reflect.TypeOf((**SavedSearch)(nil))
}

func (o SavedSearchPtrOutput) ToSavedSearchPtrOutput() SavedSearchPtrOutput {
	return o
}

func (o SavedSearchPtrOutput) ToSavedSearchPtrOutputWithContext(ctx context.Context) SavedSearchPtrOutput {
	return o
}

type SavedSearchArrayOutput struct{ *pulumi.OutputState }

func (SavedSearchArrayOutput) ElementType() reflect.Type {
	return reflect.TypeOf((*[]SavedSearch)(nil))
}

func (o SavedSearchArrayOutput) ToSavedSearchArrayOutput() SavedSearchArrayOutput {
	return o
}

func (o SavedSearchArrayOutput) ToSavedSearchArrayOutputWithContext(ctx context.Context) SavedSearchArrayOutput {
	return o
}

func (o SavedSearchArrayOutput) Index(i pulumi.IntInput) SavedSearchOutput {
	return pulumi.All(o, i).ApplyT(func(vs []interface{}) SavedSearch {
		return vs[0].([]SavedSearch)[vs[1].(int)]
	}).(SavedSearchOutput)
}

type SavedSearchMapOutput struct{ *pulumi.OutputState }

func (SavedSearchMapOutput) ElementType() reflect.Type {
	return reflect.TypeOf((*map[string]SavedSearch)(nil))
}

func (o SavedSearchMapOutput) ToSavedSearchMapOutput() SavedSearchMapOutput {
	return o
}

func (o SavedSearchMapOutput) ToSavedSearchMapOutputWithContext(ctx context.Context) SavedSearchMapOutput {
	return o
}

func (o SavedSearchMapOutput) MapIndex(k pulumi.StringInput) SavedSearchOutput {
	return pulumi.All(o, k).ApplyT(func(vs []interface{}) SavedSearch {
		return vs[0].(map[string]SavedSearch)[vs[1].(string)]
	}).(SavedSearchOutput)
}

func init() {
	pulumi.RegisterOutputType(SavedSearchOutput{})
	pulumi.RegisterOutputType(SavedSearchPtrOutput{})
	pulumi.RegisterOutputType(SavedSearchArrayOutput{})
	pulumi.RegisterOutputType(SavedSearchMapOutput{})
}