Feedback Edit

Remove-AzApplicationInsightsApiKey

  • Reference
Module:
Az.ApplicationInsights

Delete an API Key of an Application Insights component.

Syntax

Remove-AzApplicationInsightsApiKey
      -ApiKeyId <String>
      -Name <String>
      -ResourceGroupName <String>
      [-SubscriptionId <String>]
      [-DefaultProfile <PSObject>]
      [-Confirm]
      [-WhatIf]
      [<CommonParameters>]
Remove-AzApplicationInsightsApiKey
      -InputObject <IApplicationInsightsIdentity>
      [-DefaultProfile <PSObject>]
      [-Confirm]
      [-WhatIf]
      [<CommonParameters>]

Description

Delete an API Key of an Application Insights component.

Examples

Example 1: Remove an application insights api key for an application insights resource

Remove-AzApplicationInsightsApiKey -ResourceGroupName "testGroup" -Name "test" -ApiKeyId dd173f38-4fd1-4c75-8af5-99c29aa0f867 -PassThru

Remove an application insights api key for an application insights resource

Parameters

-ApiKeyId

The API Key ID. This is unique within a Application Insights component.

Type:String
Position:Named
Default value:None
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
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
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
Accept pipeline input:True
Accept wildcard characters:False
-Name

The name of the Application Insights component resource.

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

Inputs

IApplicationInsightsIdentity

Outputs

IApplicationInsightsComponentApiKey

Notes

ALIASES

COMPLEX PARAMETER PROPERTIES

To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables.

INPUTOBJECT <IApplicationInsightsIdentity>: Identity Parameter

  • [AnnotationId <String>]: The unique annotation ID. This is unique within a Application Insights component.
  • [ComponentName <String>]: The name of the Application Insights component resource.
  • [ExportId <String>]: The Continuous Export configuration ID. This is unique within a Application Insights component.
  • [Id <String>]: Resource identity path
  • [KeyId <String>]: The API Key ID. This is unique within a Application Insights component.
  • [PurgeId <String>]: In a purge status request, this is the Id of the operation the status of which is returned.
  • [ResourceGroupName <String>]: The name of the resource group. The name is case insensitive.
  • [ResourceName <String>]: The name of the Application Insights component resource.
  • [StorageType <StorageType?>]: The type of the Application Insights component data source for the linked storage account.
  • [SubscriptionId <String>]: The ID of the target subscription.
  • [WebTestName <String>]: The name of the Application Insights WebTest resource.