Update-AzApplicationInsightsWorkbook

Reference

Module:: Az.ApplicationInsights

Updates a workbook that has already been added.

Syntax

Update-AzApplicationInsightsWorkbook
      -Name <String>
      -ResourceGroupName <String>
      [-SubscriptionId <String>]
      [-LinkedSourceId <String>]
      [-Category <String>]
      [-Description <String>]
      [-DisplayName <String>]
      [-Revision <String>]
      [-SerializedData <String>]
      [-SourceTag <String[]>]
      [-Tag <Hashtable>]
      [-DefaultProfile <PSObject>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-AzApplicationInsightsWorkbook
      -InputObject <IApplicationInsightsIdentity>
      [-LinkedSourceId <String>]
      [-Category <String>]
      [-Description <String>]
      [-DisplayName <String>]
      [-Revision <String>]
      [-SerializedData <String>]
      [-SourceTag <String[]>]
      [-Tag <Hashtable>]
      [-DefaultProfile <PSObject>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

Updates a workbook that has already been added.

Examples

Example 1: Updates a workbook that has already been added

Update-AzApplicationInsightsWorkbook -ResourceGroupName appinsights-hkrs2v-test -Name cc18e5e4-9558-4be1-b333-20b28aaca021 -DisplayName "workbook-portal"

ResourceGroupName       Name                                 DisplayName     Location Kind   Category
-----------------       ----                                 -----------     -------- ----   --------
appinsights-hkrs2v-test cc18e5e4-9558-4be1-b333-20b28aaca021 workbook-portal eastus   shared workbook

Updates a workbook that has already been added

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

Get-AzApplicationInsightsWorkbook -ResourceGroupName appinsights-hkrs2v-test -Name cc18e5e4-9558-4be1-b333-20b28aaca021 | Update-AzApplicationInsightsWorkbook -Tag @{'k1'='v1'}

ResourceGroupName       Name                                 DisplayName     Location Kind   Category
-----------------       ----                                 -----------     -------- ----   --------
appinsights-hkrs2v-test cc18e5e4-9558-4be1-b333-20b28aaca021 workbook-portal eastus   shared workbook

Updates a workbook that has already been added by pipeline.

Parameters

-Category

Workbook category, as defined by the user at creation time.

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

-Description

The description of the workbook.

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

-DisplayName

The user-defined name (display name) of the workbook.

Type:	String
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

-LinkedSourceId

Azure Resource Id that will fetch all linked workbooks.

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

-Name

The name of the 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

-Revision

The unique revision id for this workbook definition

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

-SerializedData

Configuration of this particular workbook. Configuration data is a string containing valid JSON

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

-SourceTag

A list of 0 or more tags that are associated with this workbook definition

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

-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

IWorkbook

Share via