< Back
Get-AzureRmOperationalInsightsSavedSearch
Post
NAME Get-AzureRmOperationalInsightsSavedSearch
SYNOPSIS
Returns all of the saved searches for a specified workspace.
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.
PARAMETERS
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ResourceGroupName <String>
Specifies the name of an Azure resource group that contains a workspace.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-SavedSearchId <String>
Specifies a saved search ID.
Required? false
Position? 2
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-WorkspaceName <String>
Specifies a workspace name.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
None
This cmdlet does not accept any input.
OUTPUTS
Microsoft.Azure.Commands.OperationalInsights.Models.PSSearchListSavedSearchResponse
Microsoft.Azure.Commands.OperationalInsights.Models.PSSearchGetSavedSearchResponse
NOTES
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.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... avedsearch
Azure Operational Insights Cmdlets
SYNOPSIS
Returns all of the saved searches for a specified workspace.
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.
PARAMETERS
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ResourceGroupName <String>
Specifies the name of an Azure resource group that contains a workspace.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-SavedSearchId <String>
Specifies a saved search ID.
Required? false
Position? 2
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-WorkspaceName <String>
Specifies a workspace name.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
None
This cmdlet does not accept any input.
OUTPUTS
Microsoft.Azure.Commands.OperationalInsights.Models.PSSearchListSavedSearchResponse
Microsoft.Azure.Commands.OperationalInsights.Models.PSSearchGetSavedSearchResponse
NOTES
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.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... avedsearch
Azure Operational Insights Cmdlets