Components interface
Interface representing a Components.
Methods
| create |
Creates (or updates) an Application Insights component. Note: You cannot specify a different value for InstrumentationKey nor AppId in the Put operation. |
| delete(string, string, Components |
Deletes an Application Insights component. |
| get(string, string, Components |
Returns an Application Insights component. |
| get |
Get status for an ongoing purge operation. |
| list(Components |
Gets a list of all Application Insights components within a subscription. |
| list |
Gets a list of Application Insights components within a resource group. |
| purge(string, string, Component |
Purges data in an Application Insights component by a set of user-defined filters. In order to manage system resources, purge requests are throttled at 50 requests per hour. You should batch the execution of purge requests by sending a single command whose predicate includes all user identities that require purging. Use the in operator to specify multiple identities. You should run the query prior to using for a purge request to verify that the results are expected. |
| update |
Updates an existing component's tags. To update other fields use the CreateOrUpdate method. |
Method Details
createOrUpdate(string, string, ApplicationInsightsComponent, ComponentsCreateOrUpdateOptionalParams)
Creates (or updates) an Application Insights component. Note: You cannot specify a different value for InstrumentationKey nor AppId in the Put operation.
function createOrUpdate(resourceGroupName: string, resourceName: string, insightProperties: ApplicationInsightsComponent, options?: ComponentsCreateOrUpdateOptionalParams): Promise<ApplicationInsightsComponent>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- resourceName
-
string
The name of the Application Insights component resource.
- insightProperties
- ApplicationInsightsComponent
Properties that need to be specified to create an Application Insights component.
The options parameters.
Returns
Promise<ApplicationInsightsComponent>
delete(string, string, ComponentsDeleteOptionalParams)
Deletes an Application Insights component.
function delete(resourceGroupName: string, resourceName: string, options?: ComponentsDeleteOptionalParams): Promise<void>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
- ComponentsDeleteOptionalParams
The options parameters.
Returns
Promise<void>
get(string, string, ComponentsGetOptionalParams)
Returns an Application Insights component.
function get(resourceGroupName: string, resourceName: string, options?: ComponentsGetOptionalParams): Promise<ApplicationInsightsComponent>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
- ComponentsGetOptionalParams
The options parameters.
Returns
Promise<ApplicationInsightsComponent>
getPurgeStatus(string, string, string, ComponentsGetPurgeStatusOptionalParams)
Get status for an ongoing purge operation.
function getPurgeStatus(resourceGroupName: string, resourceName: string, purgeId: string, options?: ComponentsGetPurgeStatusOptionalParams): Promise<ComponentPurgeStatusResponse>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- resourceName
-
string
The name of the Application Insights component resource.
- purgeId
-
string
In a purge status request, this is the Id of the operation the status of which is returned.
The options parameters.
Returns
Promise<ComponentPurgeStatusResponse>
list(ComponentsListOptionalParams)
Gets a list of all Application Insights components within a subscription.
function list(options?: ComponentsListOptionalParams): PagedAsyncIterableIterator<ApplicationInsightsComponent, ApplicationInsightsComponent[], PageSettings>Parameters
- options
- ComponentsListOptionalParams
The options parameters.
Returns
listByResourceGroup(string, ComponentsListByResourceGroupOptionalParams)
Gets a list of Application Insights components within a resource group.
function listByResourceGroup(resourceGroupName: string, options?: ComponentsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<ApplicationInsightsComponent, ApplicationInsightsComponent[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
The options parameters.
Returns
purge(string, string, ComponentPurgeBody, ComponentsPurgeOptionalParams)
Purges data in an Application Insights component by a set of user-defined filters.
In order to manage system resources, purge requests are throttled at 50 requests per hour. You should batch the execution of purge requests by sending a single command whose predicate includes all user identities that require purging. Use the in operator to specify multiple identities. You should run the query prior to using for a purge request to verify that the results are expected.
function purge(resourceGroupName: string, resourceName: string, body: ComponentPurgeBody, options?: ComponentsPurgeOptionalParams): Promise<ComponentPurgeResponse>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- resourceName
-
string
The name of the Application Insights component resource.
- body
- ComponentPurgeBody
Describes the body of a request to purge data in a single table of an Application Insights component
- options
- ComponentsPurgeOptionalParams
The options parameters.
Returns
Promise<ComponentPurgeResponse>
updateTags(string, string, TagsResource, ComponentsUpdateTagsOptionalParams)
Updates an existing component's tags. To update other fields use the CreateOrUpdate method.
function updateTags(resourceGroupName: string, resourceName: string, componentTags: TagsResource, options?: ComponentsUpdateTagsOptionalParams): Promise<ApplicationInsightsComponent>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- resourceName
-
string
The name of the Application Insights component resource.
- componentTags
- TagsResource
Updated tag information to set into the component instance.
The options parameters.
Returns
Promise<ApplicationInsightsComponent>
Azure SDK for JavaScript