Edit

Share via

Get-AzureRmOperationalInsightsSavedSearch

  • Reference
Module:
AzureRM.OperationalInsights

Returns all of the saved searches for a specified workspace.

Warning

The AzureRM PowerShell module has been officially deprecated as of February 29, 2024. Users are advised to migrate from AzureRM to the Az PowerShell module to ensure continued support and updates.

Although the AzureRM module may still function, it's no longer maintained or supported, placing any continued use at the user's discretion and risk. Please refer to our migration resources for guidance on transitioning to the Az module.

Syntax

Get-AzureRmOperationalInsightsSavedSearch
   [-ResourceGroupName] <String>
   [-WorkspaceName] <String>
   [[-SavedSearchId] <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

The Get-AzureRmOperationalInsightsSavedSearch cmdlet returns all of the saved searches for a specified workspace within the resource group specified if you do not specify a saved search ID. If you do specify a saved search ID, then the saved search corresponding to that ID is returned.

Examples

Example 1: Get all saved searches for a workspace

PS C:\>Get-AzureRmOperationalInsightsSavedSearch -ResourceGroupName "ContosoResourceGroup" -WorkspaceName "ContosoWorkspace"

This command gets all of the saved resources associated with a workspace.

Example 2: Get a specific saved search by ID

PS C:\>Get-AzureRmOperationalInsightsSavedSearch -ResourceGroupName "ContosoResourceGroup" -WorkspaceName "ContosoWorkspace" -SavedSearchId "ContosoSavedSearchId"

This command gets a specific saved search by its ID.

Parameters

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with azure

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

-ResourceGroupName

Specifies the name of an Azure resource group that contains a workspace.

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

-SavedSearchId

Specifies a saved search ID.

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

-WorkspaceName

Specifies a workspace name.

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

Inputs

String

Outputs

PSSearchListSavedSearchResponse

PSSearchGetSavedSearchResponse