APIKeys class
Class representing a APIKeys.
Constructors
| APIKeys(Application |
Create a APIKeys. |
Methods
Constructor Details
APIKeys(ApplicationInsightsManagementClientContext)
Create a APIKeys.
new APIKeys(client: ApplicationInsightsManagementClientContext)Parameters
Reference to the service client.
Method Details
create(string, string, APIKeyRequest, RequestOptionsBase)
Create an API Key of an Application Insights component.
function create(resourceGroupName: string, resourceName: string, aPIKeyProperties: APIKeyRequest, options?: RequestOptionsBase): Promise<APIKeysCreateResponse>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
- RequestOptionsBase
The optional parameters
Returns
Promise<APIKeysCreateResponse>
Promise<Models.APIKeysCreateResponse>
create(string, string, APIKeyRequest, RequestOptionsBase, ServiceCallback<ApplicationInsightsComponentAPIKey>)
function create(resourceGroupName: string, resourceName: string, aPIKeyProperties: APIKeyRequest, options: RequestOptionsBase, callback: ServiceCallback<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
- RequestOptionsBase
The optional parameters
The callback
create(string, string, APIKeyRequest, ServiceCallback<ApplicationInsightsComponentAPIKey>)
function create(resourceGroupName: string, resourceName: string, aPIKeyProperties: APIKeyRequest, callback: ServiceCallback<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.
The callback
deleteMethod(string, string, string, RequestOptionsBase)
Delete an API Key of an Application Insights component.
function deleteMethod(resourceGroupName: string, resourceName: string, keyId: string, options?: RequestOptionsBase): Promise<APIKeysDeleteMethodResponse>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
- RequestOptionsBase
The optional parameters
Returns
Promise<APIKeysDeleteMethodResponse>
Promise<Models.APIKeysDeleteMethodResponse>
deleteMethod(string, string, string, RequestOptionsBase, ServiceCallback<ApplicationInsightsComponentAPIKey>)
function deleteMethod(resourceGroupName: string, resourceName: string, keyId: string, options: RequestOptionsBase, callback: ServiceCallback<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
- RequestOptionsBase
The optional parameters
The callback
deleteMethod(string, string, string, ServiceCallback<ApplicationInsightsComponentAPIKey>)
function deleteMethod(resourceGroupName: string, resourceName: string, keyId: string, callback: ServiceCallback<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.
The callback
get(string, string, string, RequestOptionsBase)
Get the API Key for this key id.
function get(resourceGroupName: string, resourceName: string, keyId: string, options?: RequestOptionsBase): Promise<APIKeysGetResponse>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
- RequestOptionsBase
The optional parameters
Returns
Promise<APIKeysGetResponse>
Promise<Models.APIKeysGetResponse>
get(string, string, string, RequestOptionsBase, ServiceCallback<ApplicationInsightsComponentAPIKey>)
function get(resourceGroupName: string, resourceName: string, keyId: string, options: RequestOptionsBase, callback: ServiceCallback<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
- RequestOptionsBase
The optional parameters
The callback
get(string, string, string, ServiceCallback<ApplicationInsightsComponentAPIKey>)
function get(resourceGroupName: string, resourceName: string, keyId: string, callback: ServiceCallback<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.
The callback
list(string, string, RequestOptionsBase)
Gets a list of API keys of an Application Insights component.
function list(resourceGroupName: string, resourceName: string, options?: RequestOptionsBase): Promise<APIKeysListResponse>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
- RequestOptionsBase
The optional parameters
Returns
Promise<APIKeysListResponse>
Promise<Models.APIKeysListResponse>
list(string, string, RequestOptionsBase, ServiceCallback<ApplicationInsightsComponentAPIKeyListResult>)
function list(resourceGroupName: string, resourceName: string, options: RequestOptionsBase, callback: ServiceCallback<ApplicationInsightsComponentAPIKeyListResult>)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
- RequestOptionsBase
The optional parameters
The callback
list(string, string, ServiceCallback<ApplicationInsightsComponentAPIKeyListResult>)
function list(resourceGroupName: string, resourceName: string, callback: ServiceCallback<ApplicationInsightsComponentAPIKeyListResult>)Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- resourceName
-
string
The name of the Application Insights component resource.
The callback