New-AzOperationalInsightsSavedSearch

Reference

Module:: Az.OperationalInsights

Creates a new saved search with the specified parameters.

Syntax

New-AzOperationalInsightsSavedSearch
   [-ResourceGroupName] <String>
   [-WorkspaceName] <String>
   [-SavedSearchId] <String>
   [-DisplayName] <String>
   [-Category] <String>
   [-Query] <String>
   [[-Tag] <Hashtable>]
   [[-Version] <Int64>]
   [[-FunctionAlias] <String>]
   [[-FunctionParameter] <String>]
   [-Force]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The New-AzOperationalInsightsSavedSearch cmdlet creates a new saved search with the specified parameters for the workspace.

Examples

Example 1: Create a new saved search

New-AzOperationalInsightsSavedSearch -ResourceGroupName "ContosoResourceGroup" -WorkspaceName "ContosoWorkspace" -SavedSearchId "ContosoSavedSearchId" -DisplayName "ContosoSavedSearchDisplayName" -Category "ContosoSavedSearchCategory" -Query "*" -Version 1 -Force

This command creates a new saved search.

Parameters

-Category

The saved search category.

Type:	String
Position:	4
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with Azure.

Type:	IAzureContextContainer
Aliases:	AzContext, AzureRmContext, AzureCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DisplayName

The saved search display name.

Type:	String
Position:	3
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-Force

Don't ask for confirmation.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-FunctionAlias

The function alias if query serves as a function.

Type:	String
Position:	8
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-FunctionParameter

The optional function parameters if query serves as a function. Value should be in the following format: 'param-name1:type1 = default_value1, param-name2:type2 = default_value2'. For more examples and proper syntax please refer to https://learn.microsoft.com/en-us/azure/kusto/query/functions/user-defined-functions.

Type:	String
Aliases:	FunctionParameters
Position:	9
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Query

The saved search query.

Type:	String
Position:	5
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-ResourceGroupName

The resource group name.

Type:	String
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-SavedSearchId

The saved search id.

Type:	String
Position:	2
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-Tag

The saved search tags.

Type:	Hashtable
Position:	6
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-Version

The saved search version.

Type:	Int64
Position:	7
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-WorkspaceName

The workspace name.

Type:	String
Aliases:	Name
Position:	1
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

Inputs

String

Hashtable

Int64

Outputs

PSSavedSearchValue

Share via