Edit

Share via

Get-AzApplicationInsightsApiKey

  • Reference
Module:
Az.ApplicationInsights

Get the API Key for this key id.

Syntax

PowerShell 
Get-AzApplicationInsightsApiKey
   -Name <String>
   -ResourceGroupName <String>
   [-SubscriptionId <String[]>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]
PowerShell 
Get-AzApplicationInsightsApiKey
   -ApiKeyId <String>
   -Name <String>
   -ResourceGroupName <String>
   [-SubscriptionId <String[]>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]
PowerShell 
Get-AzApplicationInsightsApiKey
   -InputObject <IApplicationInsightsIdentity>
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Description

Get the API Key for this key id.

Examples

Example 1: Get Api Keys for an application insights resource

PowerShell 
Get-AzApplicationInsightsApiKey -ResourceGroupName "testGroup" -Name "test"

Get Api Keys for an application insights resource

Example 2: Get specific API key for an application insights resource

PowerShell 
Get-AzApplicationInsightsApiKey -ResourceGroupName "testGroup" -Name "test" -ApiKeyId 00001111-aaaa-2222-bbbb-3333cccc4444

Get specific 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
Required:True
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

-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
Aliases:ApplicationInsightsComponentName, ComponentName
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

Inputs

Outputs