ApplicationInsightsComponentResource.GetApiKeyAsync Method

Definition

Get the API Key for this key id.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/components/{resourceName}/APIKeys/{keyId}
  • Operation Id: APIKeys_Get
  • Default Api Version: 2015-05-01
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.ApplicationInsights.Models.ApplicationInsightsComponentApiKey>> GetApiKeyAsync (string keyId, System.Threading.CancellationToken cancellationToken = default);
abstract member GetApiKeyAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.ApplicationInsights.Models.ApplicationInsightsComponentApiKey>>
override this.GetApiKeyAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.ApplicationInsights.Models.ApplicationInsightsComponentApiKey>>
Public Overridable Function GetApiKeyAsync (keyId As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of ApplicationInsightsComponentApiKey))

Parameters

keyId
String

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

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Task<Response<Azure.ResourceManager.ApplicationInsights.Models.ApplicationInsightsComponentApiKey>>

Exceptions

keyId is an empty string, and was expected to be non-empty.

keyId is null.

Applies to