1. Packages
  2. Azure Native
  3. API Docs
  4. operationalinsights
  5. getSavedSearch
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi

azure-native.operationalinsights.getSavedSearch

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi

Gets the specified saved search for a given workspace.

Uses Azure REST API version 2023-09-01.

Other available API versions: 2020-03-01-preview, 2020-08-01, 2025-02-01. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native operationalinsights [ApiVersion]. See the version guide for details.

Using getSavedSearch

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getSavedSearch(args: GetSavedSearchArgs, opts?: InvokeOptions): Promise<GetSavedSearchResult>
function getSavedSearchOutput(args: GetSavedSearchOutputArgs, opts?: InvokeOptions): Output<GetSavedSearchResult>
Copy
def get_saved_search(resource_group_name: Optional[str] = None,
                     saved_search_id: Optional[str] = None,
                     workspace_name: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetSavedSearchResult
def get_saved_search_output(resource_group_name: Optional[pulumi.Input[str]] = None,
                     saved_search_id: Optional[pulumi.Input[str]] = None,
                     workspace_name: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetSavedSearchResult]
Copy
func LookupSavedSearch(ctx *Context, args *LookupSavedSearchArgs, opts ...InvokeOption) (*LookupSavedSearchResult, error)
func LookupSavedSearchOutput(ctx *Context, args *LookupSavedSearchOutputArgs, opts ...InvokeOption) LookupSavedSearchResultOutput
Copy

> Note: This function is named LookupSavedSearch in the Go SDK.

public static class GetSavedSearch 
{
    public static Task<GetSavedSearchResult> InvokeAsync(GetSavedSearchArgs args, InvokeOptions? opts = null)
    public static Output<GetSavedSearchResult> Invoke(GetSavedSearchInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetSavedSearchResult> getSavedSearch(GetSavedSearchArgs args, InvokeOptions options)
public static Output<GetSavedSearchResult> getSavedSearch(GetSavedSearchArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:operationalinsights:getSavedSearch
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
SavedSearchId
This property is required.
Changes to this property will trigger replacement.
string
The id of the saved search.
WorkspaceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the workspace.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
SavedSearchId
This property is required.
Changes to this property will trigger replacement.
string
The id of the saved search.
WorkspaceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the workspace.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
savedSearchId
This property is required.
Changes to this property will trigger replacement.
String
The id of the saved search.
workspaceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the workspace.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
savedSearchId
This property is required.
Changes to this property will trigger replacement.
string
The id of the saved search.
workspaceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the workspace.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
saved_search_id
This property is required.
Changes to this property will trigger replacement.
str
The id of the saved search.
workspace_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the workspace.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
savedSearchId
This property is required.
Changes to this property will trigger replacement.
String
The id of the saved search.
workspaceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the workspace.

getSavedSearch Result

The following output properties are available:

AzureApiVersion string
The Azure API version of the resource.
Category string
The category of the saved search. This helps the user to find a saved search faster.
DisplayName string
Saved search display name.
Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Name string
The name of the resource
Query string
The query expression for the saved search.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Etag string
The ETag of the saved search. To override an existing saved search, use "*" or specify the current Etag
FunctionAlias string
The function alias if query serves as a function.
FunctionParameters string
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://docs.microsoft.com/en-us/azure/kusto/query/functions/user-defined-functions.
Tags List<Pulumi.AzureNative.OperationalInsights.Outputs.TagResponse>
The tags attached to the saved search.
Version double
The version number of the query language. The current version is 2 and is the default.
AzureApiVersion string
The Azure API version of the resource.
Category string
The category of the saved search. This helps the user to find a saved search faster.
DisplayName string
Saved search display name.
Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Name string
The name of the resource
Query string
The query expression for the saved search.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Etag string
The ETag of the saved search. To override an existing saved search, use "*" or specify the current Etag
FunctionAlias string
The function alias if query serves as a function.
FunctionParameters string
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://docs.microsoft.com/en-us/azure/kusto/query/functions/user-defined-functions.
Tags []TagResponse
The tags attached to the saved search.
Version float64
The version number of the query language. The current version is 2 and is the default.
azureApiVersion String
The Azure API version of the resource.
category String
The category of the saved search. This helps the user to find a saved search faster.
displayName String
Saved search display name.
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name String
The name of the resource
query String
The query expression for the saved search.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
etag String
The ETag of the saved search. To override an existing saved search, use "*" or specify the current Etag
functionAlias String
The function alias if query serves as a function.
functionParameters String
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://docs.microsoft.com/en-us/azure/kusto/query/functions/user-defined-functions.
tags List<TagResponse>
The tags attached to the saved search.
version Double
The version number of the query language. The current version is 2 and is the default.
azureApiVersion string
The Azure API version of the resource.
category string
The category of the saved search. This helps the user to find a saved search faster.
displayName string
Saved search display name.
id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name string
The name of the resource
query string
The query expression for the saved search.
type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
etag string
The ETag of the saved search. To override an existing saved search, use "*" or specify the current Etag
functionAlias string
The function alias if query serves as a function.
functionParameters string
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://docs.microsoft.com/en-us/azure/kusto/query/functions/user-defined-functions.
tags TagResponse[]
The tags attached to the saved search.
version number
The version number of the query language. The current version is 2 and is the default.
azure_api_version str
The Azure API version of the resource.
category str
The category of the saved search. This helps the user to find a saved search faster.
display_name str
Saved search display name.
id str
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name str
The name of the resource
query str
The query expression for the saved search.
type str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
etag str
The ETag of the saved search. To override an existing saved search, use "*" or specify the current Etag
function_alias str
The function alias if query serves as a function.
function_parameters str
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://docs.microsoft.com/en-us/azure/kusto/query/functions/user-defined-functions.
tags Sequence[TagResponse]
The tags attached to the saved search.
version float
The version number of the query language. The current version is 2 and is the default.
azureApiVersion String
The Azure API version of the resource.
category String
The category of the saved search. This helps the user to find a saved search faster.
displayName String
Saved search display name.
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name String
The name of the resource
query String
The query expression for the saved search.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
etag String
The ETag of the saved search. To override an existing saved search, use "*" or specify the current Etag
functionAlias String
The function alias if query serves as a function.
functionParameters String
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://docs.microsoft.com/en-us/azure/kusto/query/functions/user-defined-functions.
tags List<Property Map>
The tags attached to the saved search.
version Number
The version number of the query language. The current version is 2 and is the default.

Supporting Types

TagResponse

Name This property is required. string
The tag name.
Value This property is required. string
The tag value.
Name This property is required. string
The tag name.
Value This property is required. string
The tag value.
name This property is required. String
The tag name.
value This property is required. String
The tag value.
name This property is required. string
The tag name.
value This property is required. string
The tag value.
name This property is required. str
The tag name.
value This property is required. str
The tag value.
name This property is required. String
The tag name.
value This property is required. String
The tag value.

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi