Skip to content

Latest commit

 

History

History
122 lines (88 loc) · 3.24 KB

Get-AzOperationalInsightsSavedSearch.md

File metadata and controls

122 lines (88 loc) · 3.24 KB
external help file Module Name ms.assetid online version schema
Microsoft.Azure.PowerShell.Cmdlets.OperationalInsights.dll-Help.xml
Az.OperationalInsights
FB2C47AD-E103-409E-A23B-BC316FA32E8C
2.0.0

Get-AzOperationalInsightsSavedSearch

SYNOPSIS

Returns all of the saved searches for a specified workspace.

SYNTAX

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

DESCRIPTION

The Get-AzOperationalInsightsSavedSearch 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

Get-AzOperationalInsightsSavedSearch -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

Get-AzOperationalInsightsSavedSearch -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: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer
Parameter Sets: (All)
Aliases: AzContext, AzureRmContext, AzureCredential

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

-ResourceGroupName

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

Type: System.String
Parameter Sets: (All)
Aliases:

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-SavedSearchId

Specifies a saved search ID.

Type: System.String
Parameter Sets: (All)
Aliases:

Required: False
Position: 2
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-WorkspaceName

Specifies a workspace name.

Type: System.String
Parameter Sets: (All)
Aliases: Name

Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

System.String

OUTPUTS

Microsoft.Azure.Commands.OperationalInsights.Models.PSSearchListSavedSearchResponse

Microsoft.Azure.Commands.OperationalInsights.Models.PSSavedSearchValue

NOTES

RELATED LINKS

Azure Operational Insights Cmdlets