Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. operationalinsights
  5. getQuery
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.0.1 published on Monday, Apr 7, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.operationalinsights.getQuery

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.0.1 published on Monday, Apr 7, 2025 by Pulumi
pulumi/pulumi-azure-native

Gets a specific Log Analytics Query defined within a Log Analytics QueryPack.

Uses Azure REST API version 2023-09-01.

Other available API versions: 2019-09-01, 2019-09-01-preview, 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 getQuery

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 getQuery(args: GetQueryArgs, opts?: InvokeOptions): Promise<GetQueryResult>
function getQueryOutput(args: GetQueryOutputArgs, opts?: InvokeOptions): Output<GetQueryResult>
Copy
def get_query(id: Optional[str] = None,
              query_pack_name: Optional[str] = None,
              resource_group_name: Optional[str] = None,
              opts: Optional[InvokeOptions] = None) -> GetQueryResult
def get_query_output(id: Optional[pulumi.Input[str]] = None,
              query_pack_name: Optional[pulumi.Input[str]] = None,
              resource_group_name: Optional[pulumi.Input[str]] = None,
              opts: Optional[InvokeOptions] = None) -> Output[GetQueryResult]
Copy
func LookupQuery(ctx *Context, args *LookupQueryArgs, opts ...InvokeOption) (*LookupQueryResult, error)
func LookupQueryOutput(ctx *Context, args *LookupQueryOutputArgs, opts ...InvokeOption) LookupQueryResultOutput
Copy

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

public static class GetQuery 
{
    public static Task<GetQueryResult> InvokeAsync(GetQueryArgs args, InvokeOptions? opts = null)
    public static Output<GetQueryResult> Invoke(GetQueryInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetQueryResult> getQuery(GetQueryArgs args, InvokeOptions options)
public static Output<GetQueryResult> getQuery(GetQueryArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:operationalinsights:getQuery
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Id
This property is required.
Changes to this property will trigger replacement.
string
The id of a specific query defined in the Log Analytics QueryPack
QueryPackName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Log Analytics QueryPack resource.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
Id
This property is required.
Changes to this property will trigger replacement.
string
The id of a specific query defined in the Log Analytics QueryPack
QueryPackName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Log Analytics QueryPack resource.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
id
This property is required.
Changes to this property will trigger replacement.
String
The id of a specific query defined in the Log Analytics QueryPack
queryPackName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Log Analytics QueryPack resource.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
id
This property is required.
Changes to this property will trigger replacement.
string
The id of a specific query defined in the Log Analytics QueryPack
queryPackName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Log Analytics QueryPack resource.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
id
This property is required.
Changes to this property will trigger replacement.
str
The id of a specific query defined in the Log Analytics QueryPack
query_pack_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the Log Analytics QueryPack resource.
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.
id
This property is required.
Changes to this property will trigger replacement.
String
The id of a specific query defined in the Log Analytics QueryPack
queryPackName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Log Analytics QueryPack resource.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.

getQuery Result

The following output properties are available:

Author string
Object Id of user creating the query.
AzureApiVersion string
The Azure API version of the resource.
Body string
Body of the query.
DisplayName string
Unique display name for your query within the Query Pack.
Id string
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
Name string
The name of the resource
Properties object
Additional properties that can be set for the query.
SystemData Pulumi.AzureNative.OperationalInsights.Outputs.SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
TimeCreated string
Creation Date for the Log Analytics Query, in ISO 8601 format.
TimeModified string
Last modified date of the Log Analytics Query, in ISO 8601 format.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Description string
Description of the query.
Related Pulumi.AzureNative.OperationalInsights.Outputs.LogAnalyticsQueryPackQueryPropertiesResponseRelated
The related metadata items for the function.
Tags Dictionary<string, ImmutableArray<string>>
Tags associated with the query.
Author string
Object Id of user creating the query.
AzureApiVersion string
The Azure API version of the resource.
Body string
Body of the query.
DisplayName string
Unique display name for your query within the Query Pack.
Id string
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
Name string
The name of the resource
Properties interface{}
Additional properties that can be set for the query.
SystemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
TimeCreated string
Creation Date for the Log Analytics Query, in ISO 8601 format.
TimeModified string
Last modified date of the Log Analytics Query, in ISO 8601 format.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Description string
Description of the query.
Related LogAnalyticsQueryPackQueryPropertiesResponseRelated
The related metadata items for the function.
Tags map[string][]string
Tags associated with the query.
author String
Object Id of user creating the query.
azureApiVersion String
The Azure API version of the resource.
body String
Body of the query.
displayName String
Unique display name for your query within the Query Pack.
id String
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name String
The name of the resource
properties Object
Additional properties that can be set for the query.
systemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
timeCreated String
Creation Date for the Log Analytics Query, in ISO 8601 format.
timeModified String
Last modified date of the Log Analytics Query, in ISO 8601 format.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
description String
Description of the query.
related LogAnalyticsQueryPackQueryPropertiesResponseRelated
The related metadata items for the function.
tags Map<String,List<String>>
Tags associated with the query.
author string
Object Id of user creating the query.
azureApiVersion string
The Azure API version of the resource.
body string
Body of the query.
displayName string
Unique display name for your query within the Query Pack.
id string
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name string
The name of the resource
properties any
Additional properties that can be set for the query.
systemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
timeCreated string
Creation Date for the Log Analytics Query, in ISO 8601 format.
timeModified string
Last modified date of the Log Analytics Query, in ISO 8601 format.
type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
description string
Description of the query.
related LogAnalyticsQueryPackQueryPropertiesResponseRelated
The related metadata items for the function.
tags {[key: string]: string[]}
Tags associated with the query.
author str
Object Id of user creating the query.
azure_api_version str
The Azure API version of the resource.
body str
Body of the query.
display_name str
Unique display name for your query within the Query Pack.
id str
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name str
The name of the resource
properties Any
Additional properties that can be set for the query.
system_data SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
time_created str
Creation Date for the Log Analytics Query, in ISO 8601 format.
time_modified str
Last modified date of the Log Analytics Query, in ISO 8601 format.
type str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
description str
Description of the query.
related LogAnalyticsQueryPackQueryPropertiesResponseRelated
The related metadata items for the function.
tags Mapping[str, Sequence[str]]
Tags associated with the query.
author String
Object Id of user creating the query.
azureApiVersion String
The Azure API version of the resource.
body String
Body of the query.
displayName String
Unique display name for your query within the Query Pack.
id String
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name String
The name of the resource
properties Any
Additional properties that can be set for the query.
systemData Property Map
Azure Resource Manager metadata containing createdBy and modifiedBy information.
timeCreated String
Creation Date for the Log Analytics Query, in ISO 8601 format.
timeModified String
Last modified date of the Log Analytics Query, in ISO 8601 format.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
description String
Description of the query.
related Property Map
The related metadata items for the function.
tags Map<List<String>>
Tags associated with the query.

Supporting Types

LogAnalyticsQueryPackQueryPropertiesResponseRelated

Categories List<string>
The related categories for the function.
ResourceTypes List<string>
The related resource types for the function.
Solutions List<string>
The related Log Analytics solutions for the function.
Categories []string
The related categories for the function.
ResourceTypes []string
The related resource types for the function.
Solutions []string
The related Log Analytics solutions for the function.
categories List<String>
The related categories for the function.
resourceTypes List<String>
The related resource types for the function.
solutions List<String>
The related Log Analytics solutions for the function.
categories string[]
The related categories for the function.
resourceTypes string[]
The related resource types for the function.
solutions string[]
The related Log Analytics solutions for the function.
categories Sequence[str]
The related categories for the function.
resource_types Sequence[str]
The related resource types for the function.
solutions Sequence[str]
The related Log Analytics solutions for the function.
categories List<String>
The related categories for the function.
resourceTypes List<String>
The related resource types for the function.
solutions List<String>
The related Log Analytics solutions for the function.

SystemDataResponse

CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.
createdAt string
The timestamp of resource creation (UTC).
createdBy string
The identity that created the resource.
createdByType string
The type of identity that created the resource.
lastModifiedAt string
The timestamp of resource last modification (UTC)
lastModifiedBy string
The identity that last modified the resource.
lastModifiedByType string
The type of identity that last modified the resource.
created_at str
The timestamp of resource creation (UTC).
created_by str
The identity that created the resource.
created_by_type str
The type of identity that created the resource.
last_modified_at str
The timestamp of resource last modification (UTC)
last_modified_by str
The identity that last modified the resource.
last_modified_by_type str
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.

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.0.1 published on Monday, Apr 7, 2025 by Pulumi
pulumi/pulumi-azure-native