Share via


ApplicationInsightsComponentResource.DeleteApiKeyAsync Method

Definition

Delete an API Key of an Application Insights component.

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