Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. insights
  5. getWorkbookTemplate
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.89.1 published on Sunday, Mar 2, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.insights.getWorkbookTemplate

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.89.1 published on Sunday, Mar 2, 2025 by Pulumi
pulumi/pulumi-azure-native

    Get a single workbook template by its resourceName. Azure REST API version: 2020-11-20.

    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?: InvokeOptions): 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: Optional[pulumi.Input[str]] = None,
                          resource_name: Optional[pulumi.Input[str]] = None,
                          opts: Optional[InvokeOptions] = 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 CompletableFuture<GetWorkbookTemplateResult> getWorkbookTemplate(GetWorkbookTemplateArgs args, InvokeOptions options)
public static Output<GetWorkbookTemplateResult> getWorkbookTemplate(GetWorkbookTemplateArgs args, InvokeOptions options)

    fn::invoke:
  function: azure-native:insights:getWorkbookTemplate
  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 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.
    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:

    Galleries List<Pulumi.AzureNative.Insights.Outputs.WorkbookTemplateGalleryResponse>
    Workbook galleries supported by the template.
    Id string
    Azure resource Id
    Location string
    Resource location
    Name string
    Azure resource name.
    TemplateData object
    Valid JSON object containing workbook template payload.
    Type string
    Azure resource type
    Author string
    Information about the author of the workbook template.
    Localized Dictionary<string, ImmutableArray<Pulumi.AzureNative.Insights.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
    Galleries []WorkbookTemplateGalleryResponse
    Workbook galleries supported by the template.
    Id string
    Azure resource Id
    Location string
    Resource location
    Name string
    Azure resource name.
    TemplateData interface{}
    Valid JSON object containing workbook template payload.
    Type string
    Azure resource type
    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
    galleries List<WorkbookTemplateGalleryResponse>
    Workbook galleries supported by the template.
    id String
    Azure resource Id
    location String
    Resource location
    name String
    Azure resource name.
    templateData Object
    Valid JSON object containing workbook template payload.
    type String
    Azure resource type
    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
    galleries WorkbookTemplateGalleryResponse[]
    Workbook galleries supported by the template.
    id string
    Azure resource Id
    location string
    Resource location
    name string
    Azure resource name.
    templateData any
    Valid JSON object containing workbook template payload.
    type string
    Azure resource type
    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
    galleries Sequence[WorkbookTemplateGalleryResponse]
    Workbook galleries supported by the template.
    id str
    Azure resource Id
    location str
    Resource location
    name str
    Azure resource name.
    template_data Any
    Valid JSON object containing workbook template payload.
    type str
    Azure resource type
    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
    galleries List<Property Map>
    Workbook galleries supported by the template.
    id String
    Azure resource Id
    location String
    Resource location
    name String
    Azure resource name.
    templateData Any
    Valid JSON object containing workbook template payload.
    type String
    Azure resource type
    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

    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 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.Insights.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<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 v1 docs if using the v1 version of this package.
    Azure Native v2.89.1 published on Sunday, Mar 2, 2025 by Pulumi
    pulumi/pulumi-azure-native