@azure/arm-appinsights package

Classes

ApplicationInsightsManagementClient

Interfaces

APIKeyRequest	An Application Insights component API Key creation request definition.
APIKeysCreateOptionalParams	Optional parameters.
APIKeysDeleteOptionalParams	Optional parameters.
APIKeysGetOptionalParams	Optional parameters.
APIKeysListOptionalParams	Optional parameters.
APIKeysOperations	Interface representing a APIKeys operations.
AnalyticsItemsDeleteOptionalParams	Optional parameters.
AnalyticsItemsGetOptionalParams	Optional parameters.
AnalyticsItemsListOptionalParams	Optional parameters.
AnalyticsItemsOperations	Interface representing a AnalyticsItems operations.
AnalyticsItemsPutOptionalParams	Optional parameters.
Annotation	Annotation associated with an application insights resource.
AnnotationError	Error associated with trying to create annotation with Id that already exist
AnnotationsCreateOptionalParams	Optional parameters.
AnnotationsDeleteOptionalParams	Optional parameters.
AnnotationsGetOptionalParams	Optional parameters.
AnnotationsListOptionalParams	Optional parameters.
AnnotationsOperations	Interface representing a Annotations operations.
ApplicationInsightsComponent	An Application Insights component definition.
ApplicationInsightsComponentAPIKey	Properties that define an API key of an Application Insights Component.
ApplicationInsightsComponentAnalyticsItem	Properties that define an Analytics item that is associated to an Application Insights component.
ApplicationInsightsComponentAnalyticsItemProperties	A set of properties that can be defined in the context of a specific item type. Each type may have its own properties.
ApplicationInsightsComponentAvailableFeatures	An Application Insights component available features.
ApplicationInsightsComponentBillingFeatures	An Application Insights component billing features
ApplicationInsightsComponentDataVolumeCap	An Application Insights component daily data volume cap
ApplicationInsightsComponentExportConfiguration	Properties that define a Continuous Export configuration.
ApplicationInsightsComponentExportRequest	An Application Insights component Continuous Export configuration request definition.
ApplicationInsightsComponentFavorite	Properties that define a favorite that is associated to an Application Insights component.
ApplicationInsightsComponentFeature	An Application Insights component daily data volume cap status
ApplicationInsightsComponentFeatureCapabilities	An Application Insights component feature capabilities
ApplicationInsightsComponentFeatureCapability	An Application Insights component feature capability
ApplicationInsightsComponentProactiveDetectionConfiguration	Properties that define a ProactiveDetection configuration.
ApplicationInsightsComponentProactiveDetectionConfigurationRuleDefinitions	Static definitions of the ProactiveDetection configuration rule (same values for all components).
ApplicationInsightsComponentProperties	Properties that define an Application Insights component resource.
ApplicationInsightsComponentQuotaStatus	An Application Insights component daily data volume cap status
ApplicationInsightsComponentWebTestLocation	Properties that define a web test location available to an Application Insights Component.
ApplicationInsightsManagementClientOptionalParams	Optional parameters for the client.
ComponentAvailableFeaturesGetOptionalParams	Optional parameters.
ComponentAvailableFeaturesOperations	Interface representing a ComponentAvailableFeatures operations.
ComponentCurrentBillingFeaturesGetOptionalParams	Optional parameters.
ComponentCurrentBillingFeaturesOperations	Interface representing a ComponentCurrentBillingFeatures operations.
ComponentCurrentBillingFeaturesUpdateOptionalParams	Optional parameters.
ComponentFeatureCapabilitiesGetOptionalParams	Optional parameters.
ComponentFeatureCapabilitiesOperations	Interface representing a ComponentFeatureCapabilities operations.
ComponentLinkedStorageAccounts	An Application Insights component linked storage accounts
ComponentLinkedStorageAccountsCreateAndUpdateOptionalParams	Optional parameters.
ComponentLinkedStorageAccountsDeleteOptionalParams	Optional parameters.
ComponentLinkedStorageAccountsGetOptionalParams	Optional parameters.
ComponentLinkedStorageAccountsOperations	Interface representing a ComponentLinkedStorageAccounts operations.
ComponentLinkedStorageAccountsPatch	An Application Insights component linked storage accounts patch
ComponentLinkedStorageAccountsUpdateOptionalParams	Optional parameters.
ComponentPurgeBody	Describes the body of a purge request for an App Insights component
ComponentPurgeBodyFilters	User-defined filters to return data which will be purged from the table.
ComponentPurgeResponse	Response containing operationId for a specific purge action.
ComponentPurgeStatusResponse	Response containing status for a specific purge operation.
ComponentQuotaStatusGetOptionalParams	Optional parameters.
ComponentQuotaStatusOperations	Interface representing a ComponentQuotaStatus operations.
ComponentsCreateOrUpdateOptionalParams	Optional parameters.
ComponentsDeleteOptionalParams	Optional parameters.
ComponentsGetOptionalParams	Optional parameters.
ComponentsGetPurgeStatusOptionalParams	Optional parameters.
ComponentsListByResourceGroupOptionalParams	Optional parameters.
ComponentsListOptionalParams	Optional parameters.
ComponentsOperations	Interface representing a Components operations.
ComponentsPurgeOptionalParams	Optional parameters.
ComponentsResource	An azure resource object
ComponentsUpdateTagsOptionalParams	Optional parameters.
DeletedWorkbook	A workbook definition.
DeletedWorkbookError	Error response.
DeletedWorkbookErrorDefinition	Error definition.
DeletedWorkbookInnerErrorTrace	Error details
DeletedWorkbookProperties	Properties that contain a workbook.
DeletedWorkbookResource	An azure resource object
DeletedWorkbooksListBySubscriptionOptionalParams	Optional parameters.
DeletedWorkbooksOperations	Interface representing a DeletedWorkbooks operations.
ErrorFieldContract	Error Field contract.
ErrorResponse	Error response indicates Insights service is not able to process the incoming request. The reason is provided in the error message.
ErrorResponseComponents	model interface ErrorResponseComponents
ErrorResponseComponentsError	Error response indicates Insights service is not able to process the incoming request. The reason is provided in the error message.
ErrorResponseLinkedStorage	model interface ErrorResponseLinkedStorage
ErrorResponseLinkedStorageError	Error response indicates Insights service is not able to process the incoming request. The reason is provided in the error message.
ExportConfigurationsCreateOptionalParams	Optional parameters.
ExportConfigurationsDeleteOptionalParams	Optional parameters.
ExportConfigurationsGetOptionalParams	Optional parameters.
ExportConfigurationsListOptionalParams	Optional parameters.
ExportConfigurationsOperations	Interface representing a ExportConfigurations operations.
ExportConfigurationsUpdateOptionalParams	Optional parameters.
FavoritesAddOptionalParams	Optional parameters.
FavoritesDeleteOptionalParams	Optional parameters.
FavoritesGetOptionalParams	Optional parameters.
FavoritesListOptionalParams	Optional parameters.
FavoritesOperations	Interface representing a Favorites operations.
FavoritesUpdateOptionalParams	Optional parameters.
HeaderField	A header to add to the WebTest.
InnerError	Inner error
LinkedStorageAccountsProperties	An Application Insights component linked storage account
LiveTokenGetOptionalParams	Optional parameters.
LiveTokenOperations	Interface representing a LiveToken operations.
LiveTokenResponse	The response to a live token query.
ManagedServiceIdentity	Managed service identity (system assigned and/or user assigned identities)
Operation	Azure Workbooks REST API operation
OperationDisplay	The object that represents the operation.
OperationsListOptionalParams	Optional parameters.
OperationsOperations	Interface representing a Operations operations.
PageSettings	Options for the byPage method
PagedAsyncIterableIterator	An interface that allows async iterable iteration both to completion and by page.
PrivateLinkScopedResource	The private link scope resource reference.
ProactiveDetectionConfigurationsGetOptionalParams	Optional parameters.
ProactiveDetectionConfigurationsListOptionalParams	Optional parameters.
ProactiveDetectionConfigurationsOperations	Interface representing a ProactiveDetectionConfigurations operations.
ProactiveDetectionConfigurationsUpdateOptionalParams	Optional parameters.
ProxyResource	The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location
Resource	Common fields that are returned in the response for all Azure Resource Manager resources
SystemData	Metadata pertaining to creation and last modification of the resource.
TagsResource	A container holding only the Tags for a resource, allowing the user to update the tags on a WebTest instance.
TrackedResource	The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'
UserAssignedIdentity	User assigned identity properties
WebTest	An Application Insights WebTest definition.
WebTestGeolocation	Geo-physical location to run a WebTest from. You must specify one or more locations for the test to run from.
WebTestLocationsListOptionalParams	Optional parameters.
WebTestLocationsOperations	Interface representing a WebTestLocations operations.
WebTestProperties	Metadata describing a web test for an Azure resource.
WebTestPropertiesConfiguration	An XML configuration specification for a WebTest.
WebTestPropertiesRequest	The collection of request properties
WebTestPropertiesValidationRules	The collection of validation rule properties
WebTestPropertiesValidationRulesContentValidation	The collection of content validation properties
WebTestsCreateOrUpdateOptionalParams	Optional parameters.
WebTestsDeleteOptionalParams	Optional parameters.
WebTestsGetOptionalParams	Optional parameters.
WebTestsListByComponentOptionalParams	Optional parameters.
WebTestsListByResourceGroupOptionalParams	Optional parameters.
WebTestsListOptionalParams	Optional parameters.
WebTestsOperations	Interface representing a WebTests operations.
WebTestsUpdateTagsOptionalParams	Optional parameters.
WebtestsResource	An azure resource object
WorkItemConfiguration	Work item configuration associated with an application insights resource.
WorkItemConfigurationError	Error associated with trying to get work item configuration or configurations
WorkItemConfigurationsCreateOptionalParams	Optional parameters.
WorkItemConfigurationsDeleteOptionalParams	Optional parameters.
WorkItemConfigurationsGetDefaultOptionalParams	Optional parameters.
WorkItemConfigurationsGetItemOptionalParams	Optional parameters.
WorkItemConfigurationsListOptionalParams	Optional parameters.
WorkItemConfigurationsOperations	Interface representing a WorkItemConfigurations operations.
WorkItemConfigurationsUpdateItemOptionalParams	Optional parameters.
WorkItemCreateConfiguration	Work item configuration creation payload
Workbook	A workbook definition.
WorkbookError	Error response.
WorkbookErrorDefinition	Error definition.
WorkbookInnerErrorTrace	Error details
WorkbookProperties	Properties that contain a workbook.
WorkbookPropertiesUpdateParameters	Properties that contain a workbook for PATCH operation.
WorkbookResourceIdentity	Identity used for BYOS
WorkbookTemplate	An Application Insights workbook template definition.
WorkbookTemplateError	Error message that will indicate why the operation failed.
WorkbookTemplateErrorBody	Error message body that will indicate why the operation failed.
WorkbookTemplateErrorFieldContract	Error Field contract.
WorkbookTemplateGallery	Gallery information for a workbook template.
WorkbookTemplateLocalizedGallery	Localized template data and gallery information.
WorkbookTemplateProperties	Properties that contain a workbook template.
WorkbookTemplateUpdateParameters	The parameters that can be provided when updating workbook template.
WorkbookTemplatesCreateOrUpdateOptionalParams	Optional parameters.
WorkbookTemplatesDeleteOptionalParams	Optional parameters.
WorkbookTemplatesGetOptionalParams	Optional parameters.
WorkbookTemplatesListByResourceGroupOptionalParams	Optional parameters.
WorkbookTemplatesOperations	Interface representing a WorkbookTemplates operations.
WorkbookTemplatesUpdateOptionalParams	Optional parameters.
WorkbookUpdateParameters	The parameters that can be provided when updating workbook properties properties.
WorkbooksCreateOrUpdateOptionalParams	Optional parameters.
WorkbooksDeleteOptionalParams	Optional parameters.
WorkbooksGetOptionalParams	Optional parameters.
WorkbooksListByResourceGroupOptionalParams	Optional parameters.
WorkbooksListBySubscriptionOptionalParams	Optional parameters.
WorkbooksListRevisionsListOptionalParams	Optional parameters.
WorkbooksOperations	Interface representing a Workbooks operations.
WorkbooksRevisionGetOptionalParams	Optional parameters.
WorkbooksUpdateOptionalParams	Optional parameters.

Type Aliases

ApplicationType	Type of application being monitored. KnownApplicationType can be used interchangeably with ApplicationType, this enum contains the known values that the service supports. Known values supported by the service web: web other: other
AzureSupportedClouds	The supported values for cloud setting as a string literal type
CategoryType	Type of CategoryType
ContinuablePage	An interface that describes a page of results.
CreatedByType	The kind of entity that created the resource. KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports. Known values supported by the service User: The entity was created by a user. Application: The entity was created by an application. ManagedIdentity: The entity was created by a managed identity. Key: The entity was created by a key.
FavoriteSourceType	Type of FavoriteSourceType
FavoriteType	Enum indicating if this favorite definition is owned by a specific user or is shared between all users with access to the Application Insights component.
FlowType	Used by the Application Insights system to determine what kind of flow this component was created by. This is to be set to 'Bluefield' when creating/updating a component via the REST API. KnownFlowType can be used interchangeably with FlowType, this enum contains the known values that the service supports. Known values supported by the service Bluefield: Bluefield
IngestionMode	Indicates the flow of the ingestion. KnownIngestionMode can be used interchangeably with IngestionMode, this enum contains the known values that the service supports. Known values supported by the service ApplicationInsights: ApplicationInsights ApplicationInsightsWithDiagnosticSettings: ApplicationInsightsWithDiagnosticSettings LogAnalytics: LogAnalytics
ItemScope	Enum indicating if this item definition is owned by a specific user or is shared between all users with access to the Application Insights component. KnownItemScope can be used interchangeably with ItemScope, this enum contains the known values that the service supports. Known values supported by the service shared: shared user: user
ItemScopePath	Type of ItemScopePath
ItemType	Enum indicating the type of the Analytics item. KnownItemType can be used interchangeably with ItemType, this enum contains the known values that the service supports. Known values supported by the service none: none query: query recent: recent function: function
ItemTypeParameter	Type of ItemTypeParameter
ManagedServiceIdentityType	Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). KnownManagedServiceIdentityType can be used interchangeably with ManagedServiceIdentityType, this enum contains the known values that the service supports. Known values supported by the service None: No managed identity. SystemAssigned: System assigned managed identity. UserAssigned: User assigned managed identity. SystemAssigned,UserAssigned: System and user assigned managed identity.
PublicNetworkAccessType	The network access type for operating on the Application Insights Component. By default it is Enabled KnownPublicNetworkAccessType can be used interchangeably with PublicNetworkAccessType, this enum contains the known values that the service supports. Known values supported by the service Enabled: Enables connectivity to Application Insights through public DNS. Disabled: Disables public connectivity to Application Insights through public DNS.
PurgeState	Status of the operation represented by the requested Id. KnownPurgeState can be used interchangeably with PurgeState, this enum contains the known values that the service supports. Known values supported by the service pending: pending completed: completed
RequestSource	Describes what tool created this Application Insights component. Customers using this API should set this to the default 'rest'. KnownRequestSource can be used interchangeably with RequestSource, this enum contains the known values that the service supports. Known values supported by the service rest: rest
StorageType	Type of StorageType
WebTestKind	The kind of WebTest that this web test watches. Choices are ping, multistep and standard.
WorkbookSharedTypeKind	The kind of workbook. Only valid value is shared. KnownWorkbookSharedTypeKind can be used interchangeably with WorkbookSharedTypeKind, this enum contains the known values that the service supports. Known values supported by the service shared: shared
WorkbookUpdateSharedTypeKind	The kind of workbook. Only valid value is shared. KnownWorkbookUpdateSharedTypeKind can be used interchangeably with WorkbookUpdateSharedTypeKind, this enum contains the known values that the service supports. Known values supported by the service shared: shared

Enums

AzureClouds	An enum to describe Azure Cloud environments.
KnownApplicationType	Type of application being monitored.
KnownCategoryType	Known values of CategoryType that the service accepts.
KnownCreatedByType	The kind of entity that created the resource.
KnownFavoriteSourceType	Known values of FavoriteSourceType that the service accepts.
KnownFlowType	Used by the Application Insights system to determine what kind of flow this component was created by. This is to be set to 'Bluefield' when creating/updating a component via the REST API.
KnownIngestionMode	Indicates the flow of the ingestion.
KnownItemScope	Enum indicating if this item definition is owned by a specific user or is shared between all users with access to the Application Insights component.
KnownItemScopePath	Known values of ItemScopePath that the service accepts.
KnownItemType	Enum indicating the type of the Analytics item.
KnownItemTypeParameter	Known values of ItemTypeParameter that the service accepts.
KnownManagedServiceIdentityType	Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
KnownPublicNetworkAccessType	The network access type for operating on the Application Insights Component. By default it is Enabled
KnownPurgeState	Status of the operation represented by the requested Id.
KnownRequestSource	Describes what tool created this Application Insights component. Customers using this API should set this to the default 'rest'.
KnownStorageType	Known values of StorageType that the service accepts.
KnownWorkbookSharedTypeKind	The kind of workbook. Only valid value is shared.
KnownWorkbookUpdateSharedTypeKind	The kind of workbook. Only valid value is shared.

Functions

isRestError(unknown)

Typeguard for RestError

Variables

RestError

A custom error type for failed pipeline requests.

Function Details

isRestError(unknown)

Typeguard for RestError

function isRestError(e: unknown): e

Parameters

e

unknown

Something caught by a catch clause.

Returns

e

Variable Details

RestError

A custom error type for failed pipeline requests.

RestError: RestErrorConstructor

Type

RestErrorConstructor