Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. resourcegraph
  5. getGraphQuery
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native-v2.resourcegraph.getGraphQuery

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

Get a single graph query by its resourceName. Azure REST API version: 2020-04-01-preview.

Other available API versions: 2018-09-01-preview, 2019-04-01, 2021-03-01, 2022-10-01, 2024-04-01.

Using getGraphQuery

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 getGraphQuery(args: GetGraphQueryArgs, opts?: InvokeOptions): Promise<GetGraphQueryResult>
function getGraphQueryOutput(args: GetGraphQueryOutputArgs, opts?: InvokeOptions): Output<GetGraphQueryResult>
Copy
def get_graph_query(resource_group_name: Optional[str] = None,
                    resource_name: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetGraphQueryResult
def get_graph_query_output(resource_group_name: Optional[pulumi.Input[str]] = None,
                    resource_name: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetGraphQueryResult]
Copy
func LookupGraphQuery(ctx *Context, args *LookupGraphQueryArgs, opts ...InvokeOption) (*LookupGraphQueryResult, error)
func LookupGraphQueryOutput(ctx *Context, args *LookupGraphQueryOutputArgs, opts ...InvokeOption) LookupGraphQueryResultOutput
Copy

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

public static class GetGraphQuery 
{
    public static Task<GetGraphQueryResult> InvokeAsync(GetGraphQueryArgs args, InvokeOptions? opts = null)
    public static Output<GetGraphQueryResult> Invoke(GetGraphQueryInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetGraphQueryResult> getGraphQuery(GetGraphQueryArgs args, InvokeOptions options)
public static Output<GetGraphQueryResult> getGraphQuery(GetGraphQueryArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:resourcegraph:getGraphQuery
  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.
ResourceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Graph Query resource.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
ResourceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Graph Query resource.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group.
resourceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Graph Query resource.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
resourceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Graph Query resource.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group.
resource_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the Graph Query resource.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group.
resourceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Graph Query resource.

getGraphQuery Result

The following output properties are available:

Id string
Azure resource Id
Location string
The location of the resource
Name string
Azure resource name. This is GUID value. The display name should be assigned within properties field.
Query string
KQL query that will be graph.
ResultKind string
Enum indicating a type of graph query.
SystemData Pulumi.AzureNative.ResourceGraph.Outputs.SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
TimeModified string
Date and time in UTC of the last modification that was made to this graph query definition.
Type string
Azure resource type
Description string
The description of a graph query.
Etag string
This will be used to handle Optimistic Concurrency.
Tags Dictionary<string, string>
Resource tags
Id string
Azure resource Id
Location string
The location of the resource
Name string
Azure resource name. This is GUID value. The display name should be assigned within properties field.
Query string
KQL query that will be graph.
ResultKind string
Enum indicating a type of graph query.
SystemData SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
TimeModified string
Date and time in UTC of the last modification that was made to this graph query definition.
Type string
Azure resource type
Description string
The description of a graph query.
Etag string
This will be used to handle Optimistic Concurrency.
Tags map[string]string
Resource tags
id String
Azure resource Id
location String
The location of the resource
name String
Azure resource name. This is GUID value. The display name should be assigned within properties field.
query String
KQL query that will be graph.
resultKind String
Enum indicating a type of graph query.
systemData SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
timeModified String
Date and time in UTC of the last modification that was made to this graph query definition.
type String
Azure resource type
description String
The description of a graph query.
etag String
This will be used to handle Optimistic Concurrency.
tags Map<String,String>
Resource tags
id string
Azure resource Id
location string
The location of the resource
name string
Azure resource name. This is GUID value. The display name should be assigned within properties field.
query string
KQL query that will be graph.
resultKind string
Enum indicating a type of graph query.
systemData SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
timeModified string
Date and time in UTC of the last modification that was made to this graph query definition.
type string
Azure resource type
description string
The description of a graph query.
etag string
This will be used to handle Optimistic Concurrency.
tags {[key: string]: string}
Resource tags
id str
Azure resource Id
location str
The location of the resource
name str
Azure resource name. This is GUID value. The display name should be assigned within properties field.
query str
KQL query that will be graph.
result_kind str
Enum indicating a type of graph query.
system_data SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
time_modified str
Date and time in UTC of the last modification that was made to this graph query definition.
type str
Azure resource type
description str
The description of a graph query.
etag str
This will be used to handle Optimistic Concurrency.
tags Mapping[str, str]
Resource tags
id String
Azure resource Id
location String
The location of the resource
name String
Azure resource name. This is GUID value. The display name should be assigned within properties field.
query String
KQL query that will be graph.
resultKind String
Enum indicating a type of graph query.
systemData Property Map
Metadata pertaining to creation and last modification of the resource.
timeModified String
Date and time in UTC of the last modification that was made to this graph query definition.
type String
Azure resource type
description String
The description of a graph query.
etag String
This will be used to handle Optimistic Concurrency.
tags Map<String>
Resource tags

Supporting Types

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-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native