Components class
Class representing a Components.
Constructors
| Components(Application |
Create a Components. |
Methods
Constructor Details
Components(ApplicationInsightsManagementClientContext)
Create a Components.
new Components(client: ApplicationInsightsManagementClientContext)Parameters
Reference to the service client.
Method Details
createOrUpdate(string, string, ApplicationInsightsComponent, RequestOptionsBase)
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?: RequestOptionsBase): Promise<ComponentsCreateOrUpdateResponse>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.
- options
- RequestOptionsBase
The optional parameters
Returns
Promise<ComponentsCreateOrUpdateResponse>
Promise<Models.ComponentsCreateOrUpdateResponse>
createOrUpdate(string, string, ApplicationInsightsComponent, RequestOptionsBase, ServiceCallback<ApplicationInsightsComponent>)
function createOrUpdate(resourceGroupName: string, resourceName: string, insightProperties: ApplicationInsightsComponent, options: RequestOptionsBase, callback: ServiceCallback<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.
- options
- RequestOptionsBase
The optional parameters
- callback
The callback
createOrUpdate(string, string, ApplicationInsightsComponent, ServiceCallback<ApplicationInsightsComponent>)
function createOrUpdate(resourceGroupName: string, resourceName: string, insightProperties: ApplicationInsightsComponent, callback: ServiceCallback<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.
- callback
The callback
deleteMethod(string, string, RequestOptionsBase)
Deletes an Application Insights component.
function deleteMethod(resourceGroupName: string, resourceName: string, options?: RequestOptionsBase): Promise<RestResponse>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<RestResponse>
Promise<msRest.RestResponse>
deleteMethod(string, string, RequestOptionsBase, ServiceCallback<void>)
function deleteMethod(resourceGroupName: string, resourceName: string, options: RequestOptionsBase, callback: ServiceCallback<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
- RequestOptionsBase
The optional parameters
- callback
-
ServiceCallback<void>
The callback
deleteMethod(string, string, ServiceCallback<void>)
function deleteMethod(resourceGroupName: string, resourceName: string, callback: ServiceCallback<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.
- callback
-
ServiceCallback<void>
The callback
get(string, string, RequestOptionsBase)
Returns an Application Insights component.
function get(resourceGroupName: string, resourceName: string, options?: RequestOptionsBase): Promise<ComponentsGetResponse>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<ComponentsGetResponse>
Promise<Models.ComponentsGetResponse>
get(string, string, RequestOptionsBase, ServiceCallback<ApplicationInsightsComponent>)
function get(resourceGroupName: string, resourceName: string, options: RequestOptionsBase, callback: ServiceCallback<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
- RequestOptionsBase
The optional parameters
- callback
The callback
get(string, string, ServiceCallback<ApplicationInsightsComponent>)
function get(resourceGroupName: string, resourceName: string, callback: ServiceCallback<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.
- callback
The callback
getPurgeStatus(string, string, string, RequestOptionsBase)
Get status for an ongoing purge operation.
function getPurgeStatus(resourceGroupName: string, resourceName: string, purgeId: string, options?: RequestOptionsBase): Promise<ComponentsGetPurgeStatusResponse>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.
- options
- RequestOptionsBase
The optional parameters
Returns
Promise<ComponentsGetPurgeStatusResponse>
Promise<Models.ComponentsGetPurgeStatusResponse>
getPurgeStatus(string, string, string, RequestOptionsBase, ServiceCallback<ComponentPurgeStatusResponse>)
function getPurgeStatus(resourceGroupName: string, resourceName: string, purgeId: string, options: RequestOptionsBase, callback: ServiceCallback<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.
- options
- RequestOptionsBase
The optional parameters
- callback
The callback
getPurgeStatus(string, string, string, ServiceCallback<ComponentPurgeStatusResponse>)
function getPurgeStatus(resourceGroupName: string, resourceName: string, purgeId: string, callback: ServiceCallback<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.
- callback
The callback
list(RequestOptionsBase)
Gets a list of all Application Insights components within a subscription.
function list(options?: RequestOptionsBase): Promise<ComponentsListResponse>Parameters
- options
- RequestOptionsBase
The optional parameters
Returns
Promise<ComponentsListResponse>
Promise<Models.ComponentsListResponse>
list(RequestOptionsBase, ServiceCallback<ApplicationInsightsComponentListResult>)
function list(options: RequestOptionsBase, callback: ServiceCallback<ApplicationInsightsComponentListResult>)Parameters
- options
- RequestOptionsBase
The optional parameters
The callback
list(ServiceCallback<ApplicationInsightsComponentListResult>)
function list(callback: ServiceCallback<ApplicationInsightsComponentListResult>)Parameters
The callback
listByResourceGroup(string, RequestOptionsBase)
Gets a list of Application Insights components within a resource group.
function listByResourceGroup(resourceGroupName: string, options?: RequestOptionsBase): Promise<ComponentsListByResourceGroupResponse>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- options
- RequestOptionsBase
The optional parameters
Returns
Promise<Models.ComponentsListByResourceGroupResponse>
listByResourceGroup(string, RequestOptionsBase, ServiceCallback<ApplicationInsightsComponentListResult>)
function listByResourceGroup(resourceGroupName: string, options: RequestOptionsBase, callback: ServiceCallback<ApplicationInsightsComponentListResult>)Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- options
- RequestOptionsBase
The optional parameters
The callback
listByResourceGroup(string, ServiceCallback<ApplicationInsightsComponentListResult>)
function listByResourceGroup(resourceGroupName: string, callback: ServiceCallback<ApplicationInsightsComponentListResult>)Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
The callback
listByResourceGroupNext(string, RequestOptionsBase)
Gets a list of Application Insights components within a resource group.
function listByResourceGroupNext(nextPageLink: string, options?: RequestOptionsBase): Promise<ComponentsListByResourceGroupNextResponse>Parameters
- nextPageLink
-
string
The NextLink from the previous successful call to List operation.
- options
- RequestOptionsBase
The optional parameters
Returns
Promise<Models.ComponentsListByResourceGroupNextResponse>
listByResourceGroupNext(string, RequestOptionsBase, ServiceCallback<ApplicationInsightsComponentListResult>)
function listByResourceGroupNext(nextPageLink: string, options: RequestOptionsBase, callback: ServiceCallback<ApplicationInsightsComponentListResult>)Parameters
- nextPageLink
-
string
The NextLink from the previous successful call to List operation.
- options
- RequestOptionsBase
The optional parameters
The callback
listByResourceGroupNext(string, ServiceCallback<ApplicationInsightsComponentListResult>)
function listByResourceGroupNext(nextPageLink: string, callback: ServiceCallback<ApplicationInsightsComponentListResult>)Parameters
- nextPageLink
-
string
The NextLink from the previous successful call to List operation.
The callback
listNext(string, RequestOptionsBase)
Gets a list of all Application Insights components within a subscription.
function listNext(nextPageLink: string, options?: RequestOptionsBase): Promise<ComponentsListNextResponse>Parameters
- nextPageLink
-
string
The NextLink from the previous successful call to List operation.
- options
- RequestOptionsBase
The optional parameters
Returns
Promise<ComponentsListNextResponse>
Promise<Models.ComponentsListNextResponse>
listNext(string, RequestOptionsBase, ServiceCallback<ApplicationInsightsComponentListResult>)
function listNext(nextPageLink: string, options: RequestOptionsBase, callback: ServiceCallback<ApplicationInsightsComponentListResult>)Parameters
- nextPageLink
-
string
The NextLink from the previous successful call to List operation.
- options
- RequestOptionsBase
The optional parameters
The callback
listNext(string, ServiceCallback<ApplicationInsightsComponentListResult>)
function listNext(nextPageLink: string, callback: ServiceCallback<ApplicationInsightsComponentListResult>)Parameters
- nextPageLink
-
string
The NextLink from the previous successful call to List operation.
The callback
purge(string, string, ComponentPurgeBody, RequestOptionsBase)
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?: RequestOptionsBase): Promise<ComponentsPurgeResponse>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
- RequestOptionsBase
The optional parameters
Returns
Promise<ComponentsPurgeResponse>
Promise<Models.ComponentsPurgeResponse>
purge(string, string, ComponentPurgeBody, RequestOptionsBase, ServiceCallback<ComponentPurgeResponse>)
function purge(resourceGroupName: string, resourceName: string, body: ComponentPurgeBody, options: RequestOptionsBase, callback: ServiceCallback<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
- RequestOptionsBase
The optional parameters
- callback
The callback
purge(string, string, ComponentPurgeBody, ServiceCallback<ComponentPurgeResponse>)
function purge(resourceGroupName: string, resourceName: string, body: ComponentPurgeBody, callback: ServiceCallback<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
- callback
The callback
updateTags(string, string, TagsResource, RequestOptionsBase)
Updates an existing component's tags. To update other fields use the CreateOrUpdate method.
function updateTags(resourceGroupName: string, resourceName: string, componentTags: TagsResource, options?: RequestOptionsBase): Promise<ComponentsUpdateTagsResponse>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.
- options
- RequestOptionsBase
The optional parameters
Returns
Promise<ComponentsUpdateTagsResponse>
Promise<Models.ComponentsUpdateTagsResponse>
updateTags(string, string, TagsResource, RequestOptionsBase, ServiceCallback<ApplicationInsightsComponent>)
function updateTags(resourceGroupName: string, resourceName: string, componentTags: TagsResource, options: RequestOptionsBase, callback: ServiceCallback<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.
- options
- RequestOptionsBase
The optional parameters
- callback
The callback
updateTags(string, string, TagsResource, ServiceCallback<ApplicationInsightsComponent>)
function updateTags(resourceGroupName: string, resourceName: string, componentTags: TagsResource, callback: ServiceCallback<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.
- callback
The callback