1. Packages
  2. Azure Native
  3. API Docs
  4. discovery
  5. getTool
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Viewing docs for Azure Native v3.16.0
published on Friday, Mar 20, 2026 by Pulumi
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.
Viewing docs for Azure Native v3.16.0
published on Friday, Mar 20, 2026 by Pulumi

    Get a Tool

    Uses Azure REST API version 2026-02-01-preview.

    Using getTool

    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 getTool(args: GetToolArgs, opts?: InvokeOptions): Promise<GetToolResult>
    function getToolOutput(args: GetToolOutputArgs, opts?: InvokeOptions): Output<GetToolResult>
    def get_tool(resource_group_name: Optional[str] = None,
                 tool_name: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetToolResult
    def get_tool_output(resource_group_name: Optional[pulumi.Input[str]] = None,
                 tool_name: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetToolResult]
    func LookupTool(ctx *Context, args *LookupToolArgs, opts ...InvokeOption) (*LookupToolResult, error)
    func LookupToolOutput(ctx *Context, args *LookupToolOutputArgs, opts ...InvokeOption) LookupToolResultOutput

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

    public static class GetTool 
    {
        public static Task<GetToolResult> InvokeAsync(GetToolArgs args, InvokeOptions? opts = null)
        public static Output<GetToolResult> Invoke(GetToolInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetToolResult> getTool(GetToolArgs args, InvokeOptions options)
    public static Output<GetToolResult> getTool(GetToolArgs args, InvokeOptions options)
    
    fn::invoke:
      function: azure-native:discovery:getTool
      arguments:
        # arguments dictionary

    The following arguments are supported:

    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    ToolName string
    The name of the Tool
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    ToolName string
    The name of the Tool
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    toolName String
    The name of the Tool
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    toolName string
    The name of the Tool
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    tool_name str
    The name of the Tool
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    toolName String
    The name of the Tool

    getTool Result

    The following output properties are available:

    AzureApiVersion string
    The Azure API version of the resource.
    Id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    Location string
    The geo-location where the resource lives
    Name string
    The name of the resource
    Properties Pulumi.AzureNative.Discovery.Outputs.ToolPropertiesResponse
    The resource-specific properties for this resource.
    SystemData Pulumi.AzureNative.Discovery.Outputs.SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    Tags Dictionary<string, string>
    Resource tags.
    AzureApiVersion string
    The Azure API version of the resource.
    Id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    Location string
    The geo-location where the resource lives
    Name string
    The name of the resource
    Properties ToolPropertiesResponse
    The resource-specific properties for this resource.
    SystemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    Tags map[string]string
    Resource tags.
    azureApiVersion String
    The Azure API version of the resource.
    id String
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    location String
    The geo-location where the resource lives
    name String
    The name of the resource
    properties ToolPropertiesResponse
    The resource-specific properties for this resource.
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    tags Map<String,String>
    Resource tags.
    azureApiVersion string
    The Azure API version of the resource.
    id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    location string
    The geo-location where the resource lives
    name string
    The name of the resource
    properties ToolPropertiesResponse
    The resource-specific properties for this resource.
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    tags {[key: string]: string}
    Resource tags.
    azure_api_version str
    The Azure API version of the resource.
    id str
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    location str
    The geo-location where the resource lives
    name str
    The name of the resource
    properties ToolPropertiesResponse
    The resource-specific properties for this resource.
    system_data SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type str
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    tags Mapping[str, str]
    Resource tags.
    azureApiVersion String
    The Azure API version of the resource.
    id String
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    location String
    The geo-location where the resource lives
    name String
    The name of the resource
    properties Property Map
    The resource-specific properties for this resource.
    systemData Property Map
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    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.

    ToolPropertiesResponse

    DefinitionContent object
    The JSON content for defining a resource
    ProvisioningState string
    The status of the last operation.
    Version string
    The version of a resource definition
    EnvironmentVariables Dictionary<string, string>
    Environment variables to make available
    DefinitionContent interface{}
    The JSON content for defining a resource
    ProvisioningState string
    The status of the last operation.
    Version string
    The version of a resource definition
    EnvironmentVariables map[string]string
    Environment variables to make available
    definitionContent Object
    The JSON content for defining a resource
    provisioningState String
    The status of the last operation.
    version String
    The version of a resource definition
    environmentVariables Map<String,String>
    Environment variables to make available
    definitionContent any
    The JSON content for defining a resource
    provisioningState string
    The status of the last operation.
    version string
    The version of a resource definition
    environmentVariables {[key: string]: string}
    Environment variables to make available
    definition_content Any
    The JSON content for defining a resource
    provisioning_state str
    The status of the last operation.
    version str
    The version of a resource definition
    environment_variables Mapping[str, str]
    Environment variables to make available
    definitionContent Any
    The JSON content for defining a resource
    provisioningState String
    The status of the last operation.
    version String
    The version of a resource definition
    environmentVariables Map<String>
    Environment variables to make available

    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.
    Viewing docs for Azure Native v3.16.0
    published on Friday, Mar 20, 2026 by Pulumi
      Try Pulumi Cloud free. Your team will thank you.