APIKeys interface

Package:

@azure/arm-appinsights

Interface representing a APIKeys.

Methods

create(string, string, APIKeyRequest, APIKeysCreateOptionalParams)	Create an API Key of an Application Insights component.
delete(string, string, string, APIKeysDeleteOptionalParams)	Delete an API Key of an Application Insights component.
get(string, string, string, APIKeysGetOptionalParams)	Get the API Key for this key id.
list(string, string, APIKeysListOptionalParams)	Gets a list of API keys of an Application Insights component.

Method Details

create(string, string, APIKeyRequest, APIKeysCreateOptionalParams)

Create an API Key of an Application Insights component.

function create(resourceGroupName: string, resourceName: string, aPIKeyProperties: APIKeyRequest, options?: APIKeysCreateOptionalParams): Promise<ApplicationInsightsComponentAPIKey>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

resourceName

string

The name of the Application Insights component resource.

aPIKeyProperties

APIKeyRequest

Properties that need to be specified to create an API key of a Application Insights component.

options

APIKeysCreateOptionalParams

The options parameters.

Returns

Promise<ApplicationInsightsComponentAPIKey>

delete(string, string, string, APIKeysDeleteOptionalParams)

Delete an API Key of an Application Insights component.

function delete(resourceGroupName: string, resourceName: string, keyId: string, options?: APIKeysDeleteOptionalParams): Promise<ApplicationInsightsComponentAPIKey>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

resourceName

string

The name of the Application Insights component resource.

keyId

string

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

options

APIKeysDeleteOptionalParams

The options parameters.

Returns

Promise<ApplicationInsightsComponentAPIKey>

get(string, string, string, APIKeysGetOptionalParams)

Get the API Key for this key id.

function get(resourceGroupName: string, resourceName: string, keyId: string, options?: APIKeysGetOptionalParams): Promise<ApplicationInsightsComponentAPIKey>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

resourceName

string

The name of the Application Insights component resource.

keyId

string

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

options

APIKeysGetOptionalParams

The options parameters.

Returns

Promise<ApplicationInsightsComponentAPIKey>

list(string, string, APIKeysListOptionalParams)

Gets a list of API keys of an Application Insights component.

function list(resourceGroupName: string, resourceName: string, options?: APIKeysListOptionalParams): PagedAsyncIterableIterator<ApplicationInsightsComponentAPIKey, ApplicationInsightsComponentAPIKey[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

resourceName

string

The name of the Application Insights component resource.

options

APIKeysListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<ApplicationInsightsComponentAPIKey, ApplicationInsightsComponentAPIKey[], PageSettings>