azure-native.operationalinsights.getSavedSearch
Explore with Pulumi AI
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>
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)
public static Output<GetSavedSearchResult> getSavedSearch(GetSavedSearchArgs args, InvokeOptions options)
fn::invoke:
function: azure-native:operationalinsights:getSavedSearch
arguments:
# arguments dictionary
The following arguments are supported:
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Saved
Search stringId - The id of the saved search.
- Workspace
Name string - The name of the workspace.
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Saved
Search stringId - The id of the saved search.
- Workspace
Name string - The name of the workspace.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- saved
Search StringId - The id of the saved search.
- workspace
Name String - The name of the workspace.
- resource
Group stringName - The name of the resource group. The name is case insensitive.
- saved
Search stringId - The id of the saved search.
- workspace
Name string - The name of the workspace.
- resource_
group_ strname - The name of the resource group. The name is case insensitive.
- saved_
search_ strid - The id of the saved search.
- workspace_
name str - The name of the workspace.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- saved
Search StringId - The id of the saved search.
- workspace
Name String - The name of the workspace.
getSavedSearch Result
The following output properties are available:
- Azure
Api stringVersion - 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.
- Display
Name 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
- Function
Alias string - The function alias if query serves as a function.
- Function
Parameters 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.
- List<Pulumi.
Azure Native. Operational Insights. Outputs. Tag Response> - 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.
- Azure
Api stringVersion - 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.
- Display
Name 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
- Function
Alias string - The function alias if query serves as a function.
- Function
Parameters 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.
- []Tag
Response - 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.
- azure
Api StringVersion - 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.
- display
Name 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
- function
Alias String - The function alias if query serves as a function.
- function
Parameters 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.
- List<Tag
Response> - 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.
- azure
Api stringVersion - 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.
- display
Name 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
- function
Alias string - The function alias if query serves as a function.
- function
Parameters 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.
- Tag
Response[] - 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_ strversion - 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.
- Sequence[Tag
Response] - 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.
- azure
Api StringVersion - 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.
- display
Name 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
- function
Alias String - The function alias if query serves as a function.
- function
Parameters 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.
- 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
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0