Get-AzApplicationInsightsWorkbookTemplate
Get a single workbook template by its resourceName.
Syntax
Get-AzApplicationInsightsWorkbookTemplate
-Name <String>
-ResourceGroupName <String>
[-SubscriptionId <String[]>]
[-DefaultProfile <PSObject>]
[<CommonParameters>] Get-AzApplicationInsightsWorkbookTemplate
-InputObject <IApplicationInsightsIdentity>
[-DefaultProfile <PSObject>]
[<CommonParameters>] Description
Get a single workbook template by its resourceName.
Examples
Example 1: Get a single workbook template by its resourceName
Get-AzApplicationInsightsWorkbookTemplate -ResourceGroupName resourceGroup -Name workbooktemplate-pwsh01
ResourceGroupName Name Location
----------------- ---- --------
appinsights-hkrs2v-test workbooktemplate-pwsh01 westuThis command gets a single workbook template by its resourceName.
Example 2: Get a single workbook template by pipeline
$gallery = New-AzApplicationInsightsWorkbookTemplateGalleryObject -Category "Failures" -Name "Simple Template" -Type 'tsg' -ResourceType "microsoft.insights/components" -Order 100
$data = @{
"version"= "Notebook/1.0";
"items"= @(
@{
"type"= 1;
"content"= @{
"json"= "## New workbook\n---\n\nWelcome to your new workbook. This area will display text formatted as markdown.\n\n\nWe've included a basic analytics query to get you started. Use the `Edit` button below each section to configure it or add more sections."
};
"name"= "text - 2"
},
@{
"type"= 3;
"content"= @{
"version"= "KqlItem/1.0";
"query"= "union withsource=TableName *\n| summarize Count=count() by TableName\n| render barchart";
"size"= 1;
"exportToExcelOptions"= "visible";
"queryType"= 0;
"resourceType"= "microsoft.operationalinsights/workspaces"
};
"name"= "query - 2"
}
);
"styleSettings"= @{};
"$schema"= "https://github.com/Microsoft/Application-Insights-Workbooks/blob/master/schema/workbook.json"
}
New-AzApplicationInsightsWorkbookTemplate -ResourceGroupName resourceGroup -Name 'workbooktemplate-pwsh01' -Location 'westus2' -Gallery $gallery -TemplateData $data -Priority 1 | Get-AzApplicationInsightsWorkbookTemplate
ResourceGroupName Name Location
----------------- ---- --------
appinsights-hkrs2v-test workbooktemplate-pwsh01 westus2This command gets a single workbook template by pipeline.
Parameters
-DefaultProfile
The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.
| Type: | PSObject |
| Aliases: | AzureRMContext, AzureCredential |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-InputObject
Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.
| Type: | IApplicationInsightsIdentity |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Name
The name of the Application Insights component resource.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ResourceGroupName
The name of the resource group. The name is case insensitive.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SubscriptionId
The ID of the target subscription.
| Type: | String[] |
| Position: | Named |
| Default value: | (Get-AzContext).Subscription.Id |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
