< Back
Get-AzureRmApplicationInsightsApiKey
Post
NAME Get-AzureRmApplicationInsightsApiKey
SYNOPSIS
Get application insights api keys for an application insights resource
SYNTAX
Get-AzureRmApplicationInsightsApiKey [-ApplicationInsightsComponent] <PSApplicationInsightsComponent> [[-ApiKeyId] <String>] [-DefaultProfile
<IAzureContextContainer>] [<CommonParameters>]
Get-AzureRmApplicationInsightsApiKey [-ResourceGroupName] <String> [-Name] <String> [[-ApiKeyId] <String>] [-DefaultProfile
<IAzureContextContainer>] [<CommonParameters>]
Get-AzureRmApplicationInsightsApiKey [-ResourceId] <String> [[-ApiKeyId] <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
DESCRIPTION
Get application insights api keys for an application insights resource
PARAMETERS
-ApiKeyId <String>
Application Insights Api Key Id.
Required? false
Position? 2
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ApplicationInsightsComponent <PSApplicationInsightsComponent>
Application Insights Component Object.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Name <String>
Application Insights Component Name.
Required? true
Position? 1
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ResourceGroupName <String>
Resource Group Name.
Required? true
Position? 0
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ResourceId <String>
Application Insights Component Resource Id.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
System.String
OUTPUTS
Microsoft.Azure.Commands.ApplicationInsights.Models.PSApiKey
NOTES
Example 1 Get Api Keys for an application insights resource
PS C:\\> Get-AzureRmApplicationInsightsApiKey -ResourceGroupName "testGroup" -Name "test"
Id Description Permissions CreatedDate ApiKey
-- ----------- ----------- ----------- ------
7c4c61dc-b392-4aa4-992f-ee92b84e5dee test1 ReadTelemetry Wed, 18 Oct 2017 23:36:40 GMT
63657030-dea6-4c52-82f4-6f5128cb92cb test2 {ReadTelemetry, WriteAnnotations} Wed, 18 Oct 2017 21:46:41 GMT
82549f39-f3ae-492e-8f94-f7aada75fa57 test3 ReadTelemetry Wed, 18 Oct 2017 22:30:23 GMT
Get application insights api keys for resource "test" in resource group "testGroup".
Example 2 Get specific API key for an application insights resource
PS C:\\> Get-AzureRmApplicationInsightsApiKey -ResourceGroupName "testGroup" -Name "test" -ApiKeyId
7c4c61dc-b392-4aa4-992f-ee92b84e5dee
ApiKey :
CreatedDate : Wed, 18 Oct 2017 23:36:40 GMT
Id : 7c4c61dc-b392-4aa4-992f-ee92b84e5dee
Permissions : {ReadTelemetry}
Description : test1
Get specific application insights api key that id is "dd173f38-4fd1-4c75-8af5-9 9c29aa0f867" for resource "test" in resource group "testGroup".
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... ghtsapikey
SYNOPSIS
Get application insights api keys for an application insights resource
SYNTAX
Get-AzureRmApplicationInsightsApiKey [-ApplicationInsightsComponent] <PSApplicationInsightsComponent> [[-ApiKeyId] <String>] [-DefaultProfile
<IAzureContextContainer>] [<CommonParameters>]
Get-AzureRmApplicationInsightsApiKey [-ResourceGroupName] <String> [-Name] <String> [[-ApiKeyId] <String>] [-DefaultProfile
<IAzureContextContainer>] [<CommonParameters>]
Get-AzureRmApplicationInsightsApiKey [-ResourceId] <String> [[-ApiKeyId] <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
DESCRIPTION
Get application insights api keys for an application insights resource
PARAMETERS
-ApiKeyId <String>
Application Insights Api Key Id.
Required? false
Position? 2
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ApplicationInsightsComponent <PSApplicationInsightsComponent>
Application Insights Component Object.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Name <String>
Application Insights Component Name.
Required? true
Position? 1
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ResourceGroupName <String>
Resource Group Name.
Required? true
Position? 0
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ResourceId <String>
Application Insights Component Resource Id.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
System.String
OUTPUTS
Microsoft.Azure.Commands.ApplicationInsights.Models.PSApiKey
NOTES
Example 1 Get Api Keys for an application insights resource
PS C:\\> Get-AzureRmApplicationInsightsApiKey -ResourceGroupName "testGroup" -Name "test"
Id Description Permissions CreatedDate ApiKey
-- ----------- ----------- ----------- ------
7c4c61dc-b392-4aa4-992f-ee92b84e5dee test1 ReadTelemetry Wed, 18 Oct 2017 23:36:40 GMT
63657030-dea6-4c52-82f4-6f5128cb92cb test2 {ReadTelemetry, WriteAnnotations} Wed, 18 Oct 2017 21:46:41 GMT
82549f39-f3ae-492e-8f94-f7aada75fa57 test3 ReadTelemetry Wed, 18 Oct 2017 22:30:23 GMT
Get application insights api keys for resource "test" in resource group "testGroup".
Example 2 Get specific API key for an application insights resource
PS C:\\> Get-AzureRmApplicationInsightsApiKey -ResourceGroupName "testGroup" -Name "test" -ApiKeyId
7c4c61dc-b392-4aa4-992f-ee92b84e5dee
ApiKey :
CreatedDate : Wed, 18 Oct 2017 23:36:40 GMT
Id : 7c4c61dc-b392-4aa4-992f-ee92b84e5dee
Permissions : {ReadTelemetry}
Description : test1
Get specific application insights api key that id is "dd173f38-4fd1-4c75-8af5-9 9c29aa0f867" for resource "test" in resource group "testGroup".
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... ghtsapikey