Update-AzApplicationInsights

Reference

Module:: Az.ApplicationInsights

Creates (or updates) an Application Insights component. Note: You cannot specify a different value for InstrumentationKey nor AppId in the Put operation.

Syntax

PowerShell

Update-AzApplicationInsights
      -ResourceGroupName <String>
      -Name <String>
      [-SubscriptionId <String>]
      [-ApplicationType <ApplicationType>]
      [-DisableIPMasking]
      [-DisableLocalAuth]
      [-Etag <String>]
      [-FlowType <FlowType>]
      [-ForceCustomerStorageForProfiler]
      [-HockeyAppId <String>]
      [-ImmediatePurgeDataOn30Day]
      [-IngestionMode <IngestionMode>]
      [-PublicNetworkAccessForIngestion <PublicNetworkAccessType>]
      [-PublicNetworkAccessForQuery <PublicNetworkAccessType>]
      [-RequestSource <RequestSource>]
      [-RetentionInDays <Int32>]
      [-SamplingPercentage <Double>]
      [-Tag <Hashtable>]
      [-WorkspaceResourceId <String>]
      [-DefaultProfile <PSObject>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

Creates (or updates) an Application Insights component. Note: You cannot specify a different value for InstrumentationKey nor AppId in the Put operation.

Examples

Example 1: Update application insights component

PowerShell

Update-AzApplicationInsights -ResourceGroupName "rgName" -Name "aiName" -PublicNetworkAccessForIngestion "Disabled" -PublicNetworkAccessForQuery "Disabled"

update application insights component "aiName" PublicNetworkAccessForIngestion/PublicNetworkAccessForQuery both to "Disabled"

Parameters

-ApplicationType

Type of application being monitored.

Type:	ApplicationType
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 credentials, account, tenant, and subscription used for communication with Azure.

Type:	PSObject
Aliases:	AzureRMContext, AzureCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DisableIPMasking

Disable IP masking.

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

-DisableLocalAuth

Disable Non-AAD based Auth.

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

-Etag

Resource etag

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

-FlowType

Used by the Application Insights system to determine what kind of flow this component was created by. This is to be set to 'Bluefield' when creating/updating a component via the REST API.

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

-ForceCustomerStorageForProfiler

Force users to create their own storage account for profiler and debugger.

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

-HockeyAppId

The unique application ID created when a new application is added to HockeyApp, used for communications with HockeyApp.

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

-ImmediatePurgeDataOn30Day

Purge data immediately after 30 days.

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

-IngestionMode

Indicates the flow of the ingestion.

Type:	IngestionMode
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
Aliases:	ApplicationInsightsComponentName, ComponentName
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-PublicNetworkAccessForIngestion

The network access type for accessing Application Insights ingestion.

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

-PublicNetworkAccessForQuery

The network access type for accessing Application Insights query.

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

-RequestSource

Describes what tool created this Application Insights component. Customers using this API should set this to the default 'rest'.

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

-RetentionInDays

Retention period in days.

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

-SamplingPercentage

Percentage of the data produced by the application being monitored that is being sampled for Application Insights telemetry.

Type:	Double
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
Aliases:	Tags
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

-WorkspaceResourceId

Resource Id of the log analytics workspace which the data will be ingested to. This property is required to create an application with this API version. Applications from older versions will not have this property.

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

Outputs

IApplicationInsightsComponent

Share via