Edit

Update-AzApplicationInsightsWorkbookTemplate

  • Reference
Module:
Az.ApplicationInsights

Updates a workbook template that has already been added.

Syntax

Update-AzApplicationInsightsWorkbookTemplate
      -Name <String>
      -ResourceGroupName <String>
      [-SubscriptionId <String>]
      [-Author <String>]
      [-Gallery <IWorkbookTemplateGallery[]>]
      [-Localized <Hashtable>]
      [-Priority <Int32>]
      [-Tag <Hashtable>]
      [-TemplateData <Hashtable>]
      [-DefaultProfile <PSObject>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-AzApplicationInsightsWorkbookTemplate
      -InputObject <IApplicationInsightsIdentity>
      [-Author <String>]
      [-Gallery <IWorkbookTemplateGallery[]>]
      [-Localized <Hashtable>]
      [-Priority <Int32>]
      [-Tag <Hashtable>]
      [-TemplateData <Hashtable>]
      [-DefaultProfile <PSObject>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

Updates a workbook template that has already been added.

Examples

Example 1: Updates a workbook template that has already been added

Update-AzApplicationInsightsWorkbookTemplate -ResourceGroupName resourceGroup -Name workbooktemplate-pwsh01 -Tag @{'k1'='v1'}

ResourceGroupName       Name                    Location
-----------------       ----                    --------
appinsights-hkrs2v-test workbooktemplate-pwsh01 westus2

Updates a workbook template that has already been added.

Example 2: Updates a workbook template that has already been added by pipeline

Get-AzApplicationInsightsWorkbookTemplate -ResourceGroupName resourceGroup -Name workbooktemplate-pwsh01  | Update-AzApplicationInsightsWorkbookTemplate -Tag @{'k1'='v1'}

ResourceGroupName       Name                    Location
-----------------       ----                    --------
appinsights-hkrs2v-test workbooktemplate-pwsh01 westus2

Updates a workbook template that has already been added by pipeline.

Parameters

-Author

Information about the author of the workbook template.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-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

-Gallery

Workbook galleries supported by the template. To construct, see NOTES section for GALLERY properties and create a hash table.

Type:IWorkbookTemplateGallery[]
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

-Localized

Key value pair of localized gallery. Each key is the locale code of languages supported by the Azure portal.

Type:Hashtable
Position:Named
Default value:None
Required:False
Accept pipeline input:False
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

-Priority

Priority of the template. Determines which template to open when a workbook gallery is opened in viewer mode.

Type:Int32
Position:Named
Default value:None
Required:False
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

-Tag

Resource tags

Type:Hashtable
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-TemplateData

Valid JSON object containing workbook template payload.

Type:Hashtable
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

IApplicationInsightsIdentity

Outputs

IWorkbookTemplate