ComponentsOperations interface
Interface representing a Components operations.
Properties
| create |
Creates (or updates) an Application Insights component. Note: You cannot specify a different value for InstrumentationKey nor AppId in the Put operation. |
| delete | Deletes an Application Insights component. |
| get | Returns an Application Insights component. |
| get |
Get status for an ongoing purge operation. |
| list | Gets a list of all Application Insights components within a subscription. |
| list |
Gets a list of Application Insights components within a resource group. |
| purge | 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. Note: this operation is intended for Classic resources, for workspace-based Application Insights resource please run purge operation (directly on the workspace)(https://docs.microsoft.com/en-us/rest/api/loganalytics/workspace-purge/purge) , scoped to specific resource id. |
| update |
Updates an existing component's tags. To update other fields use the CreateOrUpdate method. |
Property Details
createOrUpdate
Creates (or updates) an Application Insights component. Note: You cannot specify a different value for InstrumentationKey nor AppId in the Put operation.
createOrUpdate: (resourceGroupName: string, resourceName: string, insightProperties: ApplicationInsightsComponent, options?: ComponentsCreateOrUpdateOptionalParams) => Promise<ApplicationInsightsComponent>
Property Value
(resourceGroupName: string, resourceName: string, insightProperties: ApplicationInsightsComponent, options?: ComponentsCreateOrUpdateOptionalParams) => Promise<ApplicationInsightsComponent>
delete
Deletes an Application Insights component.
delete: (resourceGroupName: string, resourceName: string, options?: ComponentsDeleteOptionalParams) => Promise<void>
Property Value
(resourceGroupName: string, resourceName: string, options?: ComponentsDeleteOptionalParams) => Promise<void>
get
Returns an Application Insights component.
get: (resourceGroupName: string, resourceName: string, options?: ComponentsGetOptionalParams) => Promise<ApplicationInsightsComponent>
Property Value
(resourceGroupName: string, resourceName: string, options?: ComponentsGetOptionalParams) => Promise<ApplicationInsightsComponent>
getPurgeStatus
Get status for an ongoing purge operation.
getPurgeStatus: (resourceGroupName: string, resourceName: string, purgeId: string, options?: ComponentsGetPurgeStatusOptionalParams) => Promise<ComponentPurgeStatusResponse>
Property Value
(resourceGroupName: string, resourceName: string, purgeId: string, options?: ComponentsGetPurgeStatusOptionalParams) => Promise<ComponentPurgeStatusResponse>
list
Gets a list of all Application Insights components within a subscription.
list: (options?: ComponentsListOptionalParams) => PagedAsyncIterableIterator<ApplicationInsightsComponent, ApplicationInsightsComponent[], PageSettings>
Property Value
(options?: ComponentsListOptionalParams) => PagedAsyncIterableIterator<ApplicationInsightsComponent, ApplicationInsightsComponent[], PageSettings>
listByResourceGroup
Gets a list of Application Insights components within a resource group.
listByResourceGroup: (resourceGroupName: string, options?: ComponentsListByResourceGroupOptionalParams) => PagedAsyncIterableIterator<ApplicationInsightsComponent, ApplicationInsightsComponent[], PageSettings>
Property Value
(resourceGroupName: string, options?: ComponentsListByResourceGroupOptionalParams) => PagedAsyncIterableIterator<ApplicationInsightsComponent, ApplicationInsightsComponent[], PageSettings>
purge
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. Note: this operation is intended for Classic resources, for workspace-based Application Insights resource please run purge operation (directly on the workspace)(https://docs.microsoft.com/en-us/rest/api/loganalytics/workspace-purge/purge) , scoped to specific resource id.
purge: (resourceGroupName: string, resourceName: string, body: ComponentPurgeBody, options?: ComponentsPurgeOptionalParams) => Promise<ComponentPurgeResponse>
Property Value
(resourceGroupName: string, resourceName: string, body: ComponentPurgeBody, options?: ComponentsPurgeOptionalParams) => Promise<ComponentPurgeResponse>
updateTags
Updates an existing component's tags. To update other fields use the CreateOrUpdate method.
updateTags: (resourceGroupName: string, resourceName: string, componentTags: TagsResource, options?: ComponentsUpdateTagsOptionalParams) => Promise<ApplicationInsightsComponent>
Property Value
(resourceGroupName: string, resourceName: string, componentTags: TagsResource, options?: ComponentsUpdateTagsOptionalParams) => Promise<ApplicationInsightsComponent>