Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. Azure Native
  4. API Docs
  5. applicationinsights
  6. getWorkbookTemplate
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.26.0
published on Thursday, Aug 13, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-azure-native

azure-native.applicationinsights.getWorkbookTemplate

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.26.0
published on Thursday, Aug 13, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-azure-native

    Get a single workbook template by its resourceName.

    Uses Azure REST API version 2020-11-20.

    Other available API versions: 2019-10-17-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native applicationinsights [ApiVersion]. See the version guide for details.

    Using getWorkbookTemplate

    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 getWorkbookTemplate(args: GetWorkbookTemplateArgs, opts?: InvokeOptions): Promise<GetWorkbookTemplateResult>
function getWorkbookTemplateOutput(args: GetWorkbookTemplateOutputArgs, opts?: InvokeOutputOptions): Output<GetWorkbookTemplateResult>
    def get_workbook_template(resource_group_name: Optional[str] = None,
                          resource_name: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetWorkbookTemplateResult
def get_workbook_template_output(resource_group_name: pulumi.Input[Optional[str]] = None,
                          resource_name: pulumi.Input[Optional[str]] = None,
                          opts: Optional[InvokeOutputOptions] = None) -> Output[GetWorkbookTemplateResult]
    func LookupWorkbookTemplate(ctx *Context, args *LookupWorkbookTemplateArgs, opts ...InvokeOption) (*LookupWorkbookTemplateResult, error)
func LookupWorkbookTemplateOutput(ctx *Context, args *LookupWorkbookTemplateOutputArgs, opts ...InvokeOption) LookupWorkbookTemplateResultOutput

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

    public static class GetWorkbookTemplate 
{
    public static Task<GetWorkbookTemplateResult> InvokeAsync(GetWorkbookTemplateArgs args, InvokeOptions? opts = null)
    public static Output<GetWorkbookTemplateResult> Invoke(GetWorkbookTemplateInvokeArgs args, InvokeOptions? opts = null)
    public static Output<GetWorkbookTemplateResult> Invoke(GetWorkbookTemplateInvokeArgs args, InvokeOutputOptions opts)
}
    public static CompletableFuture<GetWorkbookTemplateResult> getWorkbookTemplate(GetWorkbookTemplateArgs args, InvokeOptions options)
public static Output<GetWorkbookTemplateResult> getWorkbookTemplate(GetWorkbookTemplateArgs args, InvokeOptions options)
public static Output<GetWorkbookTemplateResult> getWorkbookTemplate(GetWorkbookTemplateArgs args, InvokeOutputOptions options)

    fn::invoke:
  function: azure-native:applicationinsights:getWorkbookTemplate
  arguments:
    # arguments dictionary
    data "azure-native_applicationinsights_get_workbook_template" "name" {
    # arguments
}

    The following arguments are supported:

    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    ResourceName string
    The name of the Application Insights component resource.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    ResourceName string
    The name of the Application Insights component resource.
    resource_group_name string
    The name of the resource group. The name is case insensitive.
    resource_name string
    The name of the Application Insights component resource.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    resourceName String
    The name of the Application Insights component resource.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    resourceName string
    The name of the Application Insights component resource.
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    resource_name str
    The name of the Application Insights component resource.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    resourceName String
    The name of the Application Insights component resource.

    getWorkbookTemplate Result

    The following output properties are available:

    AzureApiVersion string
    The Azure API version of the resource.
    Galleries List<Pulumi.AzureNative.ApplicationInsights.Outputs.WorkbookTemplateGalleryResponse>
    Workbook galleries supported by the template.
    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
    SystemData Pulumi.AzureNative.ApplicationInsights.Outputs.SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    TemplateData object
    Valid JSON object containing workbook template payload.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    Author string
    Information about the author of the workbook template.
    Localized Dictionary<string, ImmutableArray<Pulumi.AzureNative.ApplicationInsights.Outputs.WorkbookTemplateLocalizedGalleryResponse>>
    Key value pair of localized gallery. Each key is the locale code of languages supported by the Azure portal.
    Priority int
    Priority of the template. Determines which template to open when a workbook gallery is opened in viewer mode.
    Tags Dictionary<string, string>
    Resource tags.
    AzureApiVersion string
    The Azure API version of the resource.
    Galleries []WorkbookTemplateGalleryResponse
    Workbook galleries supported by the template.
    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
    SystemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    TemplateData interface{}
    Valid JSON object containing workbook template payload.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    Author string
    Information about the author of the workbook template.
    Localized map[string][]WorkbookTemplateLocalizedGalleryResponse
    Key value pair of localized gallery. Each key is the locale code of languages supported by the Azure portal.
    Priority int
    Priority of the template. Determines which template to open when a workbook gallery is opened in viewer mode.
    Tags map[string]string
    Resource tags.
    azure_api_version string
    The Azure API version of the resource.
    galleries list(object)
    Workbook galleries supported by the template.
    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
    system_data object
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    template_data any
    Valid JSON object containing workbook template payload.
    type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    author string
    Information about the author of the workbook template.
    localized map(list(object))
    Key value pair of localized gallery. Each key is the locale code of languages supported by the Azure portal.
    priority number
    Priority of the template. Determines which template to open when a workbook gallery is opened in viewer mode.
    tags map(string)
    Resource tags.
    azureApiVersion String
    The Azure API version of the resource.
    galleries List<WorkbookTemplateGalleryResponse>
    Workbook galleries supported by the template.
    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
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    templateData Object
    Valid JSON object containing workbook template payload.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    author String
    Information about the author of the workbook template.
    localized Map<String,List<WorkbookTemplateLocalizedGalleryResponse>>
    Key value pair of localized gallery. Each key is the locale code of languages supported by the Azure portal.
    priority Integer
    Priority of the template. Determines which template to open when a workbook gallery is opened in viewer mode.
    tags Map<String,String>
    Resource tags.
    azureApiVersion string
    The Azure API version of the resource.
    galleries WorkbookTemplateGalleryResponse[]
    Workbook galleries supported by the template.
    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
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    templateData any
    Valid JSON object containing workbook template payload.
    type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    author string
    Information about the author of the workbook template.
    localized {[key: string]: WorkbookTemplateLocalizedGalleryResponse[]}
    Key value pair of localized gallery. Each key is the locale code of languages supported by the Azure portal.
    priority number
    Priority of the template. Determines which template to open when a workbook gallery is opened in viewer mode.
    tags {[key: string]: string}
    Resource tags.
    azure_api_version str
    The Azure API version of the resource.
    galleries Sequence[WorkbookTemplateGalleryResponse]
    Workbook galleries supported by the template.
    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
    system_data SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    template_data Any
    Valid JSON object containing workbook template payload.
    type str
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    author str
    Information about the author of the workbook template.
    localized Mapping[str, Sequence[WorkbookTemplateLocalizedGalleryResponse]]
    Key value pair of localized gallery. Each key is the locale code of languages supported by the Azure portal.
    priority int
    Priority of the template. Determines which template to open when a workbook gallery is opened in viewer mode.
    tags Mapping[str, str]
    Resource tags.
    azureApiVersion String
    The Azure API version of the resource.
    galleries List<Property Map>
    Workbook galleries supported by the template.
    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
    systemData Property Map
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    templateData Any
    Valid JSON object containing workbook template payload.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    author String
    Information about the author of the workbook template.
    localized Map<List<Property Map>>
    Key value pair of localized gallery. Each key is the locale code of languages supported by the Azure portal.
    priority Number
    Priority of the template. Determines which template to open when a workbook gallery is opened in viewer mode.
    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.
    created_at string
    The timestamp of resource creation (UTC).
    created_by string
    The identity that created the resource.
    created_by_type string
    The type of identity that created the resource.
    last_modified_at string
    The timestamp of resource last modification (UTC)
    last_modified_by string
    The identity that last modified the resource.
    last_modified_by_type 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.

    WorkbookTemplateGalleryResponse

    Category string
    Category for the gallery.
    Name string
    Name of the workbook template in the gallery.
    Order int
    Order of the template within the gallery.
    ResourceType string
    Azure resource type supported by the gallery.
    Type string
    Type of workbook supported by the workbook template.
    Category string
    Category for the gallery.
    Name string
    Name of the workbook template in the gallery.
    Order int
    Order of the template within the gallery.
    ResourceType string
    Azure resource type supported by the gallery.
    Type string
    Type of workbook supported by the workbook template.
    category string
    Category for the gallery.
    name string
    Name of the workbook template in the gallery.
    order number
    Order of the template within the gallery.
    resource_type string
    Azure resource type supported by the gallery.
    type string
    Type of workbook supported by the workbook template.
    category String
    Category for the gallery.
    name String
    Name of the workbook template in the gallery.
    order Integer
    Order of the template within the gallery.
    resourceType String
    Azure resource type supported by the gallery.
    type String
    Type of workbook supported by the workbook template.
    category string
    Category for the gallery.
    name string
    Name of the workbook template in the gallery.
    order number
    Order of the template within the gallery.
    resourceType string
    Azure resource type supported by the gallery.
    type string
    Type of workbook supported by the workbook template.
    category str
    Category for the gallery.
    name str
    Name of the workbook template in the gallery.
    order int
    Order of the template within the gallery.
    resource_type str
    Azure resource type supported by the gallery.
    type str
    Type of workbook supported by the workbook template.
    category String
    Category for the gallery.
    name String
    Name of the workbook template in the gallery.
    order Number
    Order of the template within the gallery.
    resourceType String
    Azure resource type supported by the gallery.
    type String
    Type of workbook supported by the workbook template.

    WorkbookTemplateLocalizedGalleryResponse

    Galleries List<Pulumi.AzureNative.ApplicationInsights.Inputs.WorkbookTemplateGalleryResponse>
    Workbook galleries supported by the template.
    TemplateData object
    Valid JSON object containing workbook template payload.
    Galleries []WorkbookTemplateGalleryResponse
    Workbook galleries supported by the template.
    TemplateData interface{}
    Valid JSON object containing workbook template payload.
    galleries list(object)
    Workbook galleries supported by the template.
    template_data any
    Valid JSON object containing workbook template payload.
    galleries List<WorkbookTemplateGalleryResponse>
    Workbook galleries supported by the template.
    templateData Object
    Valid JSON object containing workbook template payload.
    galleries WorkbookTemplateGalleryResponse[]
    Workbook galleries supported by the template.
    templateData any
    Valid JSON object containing workbook template payload.
    galleries Sequence[WorkbookTemplateGalleryResponse]
    Workbook galleries supported by the template.
    template_data Any
    Valid JSON object containing workbook template payload.
    galleries List<Property Map>
    Workbook galleries supported by the template.
    templateData Any
    Valid JSON object containing workbook template payload.

    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.26.0
    published on Thursday, Aug 13, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-azure-native

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial