@datafire/azure_applicationinsights_componentapikeys_api v5.0.0

@datafire/azure_applicationinsights_componentapikeys_api

Client library for ApplicationInsightsManagementClient

Installation and Usage

npm install --save @datafire/azure_applicationinsights_componentapikeys_api

let azure_applicationinsights_componentapikeys_api = require('@datafire/azure_applicationinsights_componentapikeys_api').create({
  access_token: "",
  refresh_token: "",
  client_id: "",
  client_secret: "",
  redirect_uri: ""
});

.then(data => {
  console.log(data);
});

Description

Azure Application Insights client for API keys of a component.

Actions

APIKeys_Delete

Delete an API Key of an Application Insights component.

azure_applicationinsights_componentapikeys_api.APIKeys_Delete({
  "resourceGroupName": "",
  "api-version": "",
  "subscriptionId": "",
  "resourceName": "",
  "keyId": ""
}, context)

Input

• input object
  • resourceGroupName required string: The name of the resource group. The name is case insensitive.
  • api-version required string: The API version to use for this operation.
  • subscriptionId required string: The ID of the target subscription.
  • resourceName required string: The name of the Application Insights component resource.
  • keyId required string: The API Key ID. This is unique within a Application Insights component.

Output

• output ApplicationInsightsComponentAPIKey

APIKeys_Get

Get the API Key for this key id.

azure_applicationinsights_componentapikeys_api.APIKeys_Get({
  "resourceGroupName": "",
  "api-version": "",
  "subscriptionId": "",
  "resourceName": "",
  "keyId": ""
}, context)

Input

• input object
  • resourceGroupName required string: The name of the resource group. The name is case insensitive.
  • api-version required string: The API version to use for this operation.
  • subscriptionId required string: The ID of the target subscription.
  • resourceName required string: The name of the Application Insights component resource.
  • keyId required string: The API Key ID. This is unique within a Application Insights component.

Output

• output ApplicationInsightsComponentAPIKey

APIKeys_List

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

azure_applicationinsights_componentapikeys_api.APIKeys_List({
  "resourceGroupName": "",
  "api-version": "",
  "subscriptionId": "",
  "resourceName": ""
}, context)

Input

• input object
  • resourceGroupName required string: The name of the resource group. The name is case insensitive.
  • api-version required string: The API version to use for this operation.
  • subscriptionId required string: The ID of the target subscription.
  • resourceName required string: The name of the Application Insights component resource.

Output

• output ApplicationInsightsComponentAPIKeyListResult

APIKeys_Create

Create an API Key of an Application Insights component.

azure_applicationinsights_componentapikeys_api.APIKeys_Create({
  "resourceGroupName": "",
  "api-version": "",
  "subscriptionId": "",
  "resourceName": "",
  "APIKeyProperties": {}
}, context)

Input

• input object
  • resourceGroupName required string: The name of the resource group. The name is case insensitive.
  • api-version required string: The API version to use for this operation.
  • subscriptionId required string: The ID of the target subscription.
  • resourceName required string: The name of the Application Insights component resource.
  • APIKeyProperties required APIKeyRequest

Output

• output ApplicationInsightsComponentAPIKey

Definitions

APIKeyRequest

• APIKeyRequest object: An Application Insights component API Key creation request definition.
  • linkedReadProperties array: The read access rights of this API Key.
    • items string
  • linkedWriteProperties array: The write access rights of this API Key.
    • items string
  • name string: The name of the API Key.

ApplicationInsightsComponentAPIKey

• ApplicationInsightsComponentAPIKey object: Properties that define an API key of an Application Insights Component.
  • apiKey string: The API key value. It will be only return once when the API Key was created.
  • createdDate string: The create date of this API key.
  • id string: The unique ID of the API key inside an Application Insights component. It is auto generated when the API key is created.
  • linkedReadProperties array: The read access rights of this API Key.
    • items string
  • linkedWriteProperties array: The write access rights of this API Key.
    • items string
  • name string: The name of the API key.

ApplicationInsightsComponentAPIKeyListResult

• ApplicationInsightsComponentAPIKeyListResult object: Describes the list of API Keys of an Application Insights Component.
  • value required array: List of API Key definitions.
    • items ApplicationInsightsComponentAPIKey