Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Components

Package version

Class representing a Components.

Hierarchy

  • Components

Index

Constructors

Methods

Constructors

constructor

Methods

createOrUpdate

  • Creates (or updates) an Application Insights component. Note: You cannot specify a different value for InstrumentationKey nor AppId in the Put operation.

    Parameters

    • resourceGroupName: string

      The name of the resource group.

    • resourceName: string

      The name of the Application Insights component resource.

    • insightProperties: ApplicationInsightsComponent

      Properties that need to be specified to create an Application Insights component.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.ComponentsCreateOrUpdateResponse>

    Promise<Models.ComponentsCreateOrUpdateResponse>

  • Parameters

    • resourceGroupName: string

      The name of the resource group.

    • 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: msRest.ServiceCallback<ApplicationInsightsComponent>

      The callback

    Returns void

  • Parameters

    • resourceGroupName: string

      The name of the resource group.

    • 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: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<ApplicationInsightsComponent>

      The callback

    Returns void

deleteMethod

  • deleteMethod(resourceGroupName: string, resourceName: string, options?: msRest.RequestOptionsBase): Promise<msRest.RestResponse>
  • deleteMethod(resourceGroupName: string, resourceName: string, callback: msRest.ServiceCallback<void>): void
  • deleteMethod(resourceGroupName: string, resourceName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<void>): void

  • Deletes an Application Insights component.

    Parameters

    • resourceGroupName: string

      The name of the resource group.

    • resourceName: string

      The name of the Application Insights component resource.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<msRest.RestResponse>

    Promise<msRest.RestResponse>

  • Parameters

    • resourceGroupName: string

      The name of the resource group.

    • resourceName: string

      The name of the Application Insights component resource.

    • callback: msRest.ServiceCallback<void>

      The callback

    Returns void

  • Parameters

    • resourceGroupName: string

      The name of the resource group.

    • resourceName: string

      The name of the Application Insights component resource.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<void>

      The callback

    Returns void

get

  • get(resourceGroupName: string, resourceName: string, options?: msRest.RequestOptionsBase): Promise<Models.ComponentsGetResponse>
  • get(resourceGroupName: string, resourceName: string, callback: msRest.ServiceCallback<ApplicationInsightsComponent>): void
  • get(resourceGroupName: string, resourceName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<ApplicationInsightsComponent>): void

  • Returns an Application Insights component.

    Parameters

    • resourceGroupName: string

      The name of the resource group.

    • resourceName: string

      The name of the Application Insights component resource.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.ComponentsGetResponse>

    Promise<Models.ComponentsGetResponse>

  • Parameters

    • resourceGroupName: string

      The name of the resource group.

    • resourceName: string

      The name of the Application Insights component resource.

    • callback: msRest.ServiceCallback<ApplicationInsightsComponent>

      The callback

    Returns void

  • Parameters

    • resourceGroupName: string

      The name of the resource group.

    • resourceName: string

      The name of the Application Insights component resource.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<ApplicationInsightsComponent>

      The callback

    Returns void

getPurgeStatus

  • getPurgeStatus(resourceGroupName: string, resourceName: string, purgeId: string, options?: msRest.RequestOptionsBase): Promise<Models.ComponentsGetPurgeStatusResponse>
  • getPurgeStatus(resourceGroupName: string, resourceName: string, purgeId: string, callback: msRest.ServiceCallback<ComponentPurgeStatusResponse>): void
  • getPurgeStatus(resourceGroupName: string, resourceName: string, purgeId: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<ComponentPurgeStatusResponse>): void

  • Get status for an ongoing purge operation.

    Parameters

    • resourceGroupName: string

      The name of the resource group.

    • 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.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.ComponentsGetPurgeStatusResponse>

    Promise<Models.ComponentsGetPurgeStatusResponse>

  • Parameters

    • resourceGroupName: string

      The name of the resource group.

    • 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: msRest.ServiceCallback<ComponentPurgeStatusResponse>

      The callback

    Returns void

  • Parameters

    • resourceGroupName: string

      The name of the resource group.

    • 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: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<ComponentPurgeStatusResponse>

      The callback

    Returns void

list

listByResourceGroup

  • listByResourceGroup(resourceGroupName: string, options?: msRest.RequestOptionsBase): Promise<Models.ComponentsListByResourceGroupResponse>
  • listByResourceGroup(resourceGroupName: string, callback: msRest.ServiceCallback<ApplicationInsightsComponentListResult>): void
  • listByResourceGroup(resourceGroupName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<ApplicationInsightsComponentListResult>): void

  • Gets a list of Application Insights components within a resource group.

    Parameters

    • resourceGroupName: string

      The name of the resource group.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.ComponentsListByResourceGroupResponse>

    Promise<Models.ComponentsListByResourceGroupResponse>

  • Parameters

    Returns void

  • Parameters

    • resourceGroupName: string

      The name of the resource group.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<ApplicationInsightsComponentListResult>

      The callback

    Returns void

listByResourceGroupNext

  • listByResourceGroupNext(nextPageLink: string, options?: msRest.RequestOptionsBase): Promise<Models.ComponentsListByResourceGroupNextResponse>
  • listByResourceGroupNext(nextPageLink: string, callback: msRest.ServiceCallback<ApplicationInsightsComponentListResult>): void
  • listByResourceGroupNext(nextPageLink: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<ApplicationInsightsComponentListResult>): void

  • Gets a list of Application Insights components within a resource group.

    Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.ComponentsListByResourceGroupNextResponse>

    Promise<Models.ComponentsListByResourceGroupNextResponse>

  • Parameters

    Returns void

  • Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<ApplicationInsightsComponentListResult>

      The callback

    Returns void

listNext

  • Gets a list of all Application Insights components within a subscription.

    Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.ComponentsListNextResponse>

    Promise<Models.ComponentsListNextResponse>

  • Parameters

    Returns void

  • Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<ApplicationInsightsComponentListResult>

      The callback

    Returns void

purge

  • Purges data in an Application Insights component by a set of user-defined filters.

    Parameters

    • resourceGroupName: string

      The name of the resource group.

    • 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

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.ComponentsPurgeResponse>

    Promise<Models.ComponentsPurgeResponse>

  • Parameters

    • resourceGroupName: string

      The name of the resource group.

    • 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: msRest.ServiceCallback<ComponentPurgeResponse>

      The callback

    Returns void

  • Parameters

    • resourceGroupName: string

      The name of the resource group.

    • 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: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<ComponentPurgeResponse>

      The callback

    Returns void

updateTags

  • updateTags(resourceGroupName: string, resourceName: string, componentTags: TagsResource, options?: msRest.RequestOptionsBase): Promise<Models.ComponentsUpdateTagsResponse>
  • updateTags(resourceGroupName: string, resourceName: string, componentTags: TagsResource, callback: msRest.ServiceCallback<ApplicationInsightsComponent>): void
  • updateTags(resourceGroupName: string, resourceName: string, componentTags: TagsResource, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<ApplicationInsightsComponent>): void

  • Updates an existing component's tags. To update other fields use the CreateOrUpdate method.

    Parameters

    • resourceGroupName: string

      The name of the resource group.

    • resourceName: string

      The name of the Application Insights component resource.

    • componentTags: TagsResource

      Updated tag information to set into the component instance.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.ComponentsUpdateTagsResponse>

    Promise<Models.ComponentsUpdateTagsResponse>

  • Parameters

    • resourceGroupName: string

      The name of the resource group.

    • resourceName: string

      The name of the Application Insights component resource.

    • componentTags: TagsResource

      Updated tag information to set into the component instance.

    • callback: msRest.ServiceCallback<ApplicationInsightsComponent>

      The callback

    Returns void

  • Parameters

    • resourceGroupName: string

      The name of the resource group.

    • resourceName: string

      The name of the Application Insights component resource.

    • componentTags: TagsResource

      Updated tag information to set into the component instance.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<ApplicationInsightsComponent>

      The callback

    Returns void

Generated using TypeDoc