1. Packages
  2. Azure Native
  3. API Docs
  4. resourcegraph
  5. getGraphQuery
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.3.0 published on Monday, Apr 28, 2025 by Pulumi

azure-native.resourcegraph.getGraphQuery

Explore with Pulumi AI

azure-native logo
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.3.0 published on Monday, Apr 28, 2025 by Pulumi

    Get a single graph query by its resourceName.

    Uses Azure REST API version 2024-04-01.

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

    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>
    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]
    func LookupGraphQuery(ctx *Context, args *LookupGraphQueryArgs, opts ...InvokeOption) (*LookupGraphQueryResult, error)
    func LookupGraphQueryOutput(ctx *Context, args *LookupGraphQueryOutputArgs, opts ...InvokeOption) LookupGraphQueryResultOutput

    > 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)
    }
    public static CompletableFuture<GetGraphQueryResult> getGraphQuery(GetGraphQueryArgs args, InvokeOptions options)
    public static Output<GetGraphQueryResult> getGraphQuery(GetGraphQueryArgs args, InvokeOptions options)
    
    fn::invoke:
      function: azure-native:resourcegraph:getGraphQuery
      arguments:
        # arguments dictionary

    The following arguments are supported:

    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    ResourceName string
    The name of the Graph Query resource.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    ResourceName string
    The name of the Graph Query resource.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    resourceName String
    The name of the Graph Query resource.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    resourceName string
    The name of the Graph Query resource.
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    resource_name str
    The name of the Graph Query resource.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    resourceName String
    The name of the Graph Query resource.

    getGraphQuery Result

    The following output properties are available:

    AzureApiVersion string
    The Azure API version of the resource.
    Id string
    Azure resource Id
    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
    The system metadata relating to this 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. If not present, it will always overwrite the existing resource without checking conflict.
    Location string
    The location of the resource
    Tags Dictionary<string, string>
    Resource tags
    AzureApiVersion string
    The Azure API version of the resource.
    Id string
    Azure resource Id
    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
    The system metadata relating to this 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. If not present, it will always overwrite the existing resource without checking conflict.
    Location string
    The location of the resource
    Tags map[string]string
    Resource tags
    azureApiVersion String
    The Azure API version of the resource.
    id String
    Azure resource Id
    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
    The system metadata relating to this 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. If not present, it will always overwrite the existing resource without checking conflict.
    location String
    The location of the resource
    tags Map<String,String>
    Resource tags
    azureApiVersion string
    The Azure API version of the resource.
    id string
    Azure resource Id
    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
    The system metadata relating to this 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. If not present, it will always overwrite the existing resource without checking conflict.
    location string
    The location of the resource
    tags {[key: string]: string}
    Resource tags
    azure_api_version str
    The Azure API version of the resource.
    id str
    Azure resource Id
    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
    The system metadata relating to this 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. If not present, it will always overwrite the existing resource without checking conflict.
    location str
    The location of the resource
    tags Mapping[str, str]
    Resource tags
    azureApiVersion String
    The Azure API version of the resource.
    id String
    Azure resource Id
    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
    The system metadata relating to this 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. If not present, it will always overwrite the existing resource without checking conflict.
    location String
    The location of the resource
    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 pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    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.3.0 published on Monday, Apr 28, 2025 by Pulumi