Azure Native v1.103.0, Jun 2 23

azure-native.operationalinsights.getSavedSearch

Explore with Pulumi AI

Gets the specified saved search for a given workspace. API Version: 2020-08-01.

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>

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]

func LookupSavedSearch(ctx *Context, args *LookupSavedSearchArgs, opts ...InvokeOption) (*LookupSavedSearchResult, error)
func LookupSavedSearchOutput(ctx *Context, args *LookupSavedSearchOutputArgs, opts ...InvokeOption) LookupSavedSearchResultOutput

> 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)
}

public static CompletableFuture<GetSavedSearchResult> getSavedSearch(GetSavedSearchArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: azure-native:operationalinsights:getSavedSearch
  arguments:
    # arguments dictionary

The following arguments are supported:

ResourceGroupName string: The name of the resource group. The name is case insensitive.
SavedSearchId string: The id of the saved search.
WorkspaceName string: The name of the workspace.

ResourceGroupName string: The name of the resource group. The name is case insensitive.
SavedSearchId string: The id of the saved search.
WorkspaceName string: The name of the workspace.

resourceGroupName String: The name of the resource group. The name is case insensitive.
savedSearchId String: The id of the saved search.
workspaceName String: The name of the workspace.

resourceGroupName string: The name of the resource group. The name is case insensitive.
savedSearchId string: The id of the saved search.
workspaceName string: The name of the workspace.

resource_group_name str: The name of the resource group. The name is case insensitive.
saved_search_id str: The id of the saved search.
workspace_name str: The name of the workspace.

resourceGroupName String: The name of the resource group. The name is case insensitive.
savedSearchId String: The id of the saved search.
workspaceName String: The name of the workspace.

getSavedSearch Result

The following output properties are available:

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.

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.

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.

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.

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.

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 string: The tag name.
Value string: The tag value.

Name string: The tag name.
Value string: The tag value.

name String: The tag name.
value String: The tag value.

name string: The tag name.
value string: The tag value.

name str: The tag name.
value str: The tag value.

name String: The tag name.
value String: The tag value.

Package Details

Repository: Azure Native pulumi/pulumi-azure-native
License: Apache-2.0