export_configurations

Creates, updates, deletes, gets or lists an export_configurations resource.

Overview

Name	export_configurations
Type	Resource
Id	azure.application_insights.export_configurations

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
ApplicationName	string	The name of the Application Insights component.
ContainerName	string	The name of the destination storage container.
DestinationAccountId	string	The name of destination account.
DestinationStorageLocationId	string	The destination account location ID.
DestinationStorageSubscriptionId	string	The destination storage account subscription ID.
DestinationType	string	The destination type.
ExportId	string	The unique ID of the export configuration inside an Application Insights component. It is auto generated when the Continuous Export configuration is created.
ExportStatus	string	This indicates current Continuous Export configuration status. The possible values are 'Preparing', 'Success', 'Failure'.
InstrumentationKey	string	The instrumentation key of the Application Insights component.
IsUserEnabled	string	This will be 'true' if the Continuous Export configuration is enabled, otherwise it will be 'false'.
LastGapTime	string	The last time the Continuous Export configuration started failing.
LastSuccessTime	string	The last time data was successfully delivered to the destination storage container for this Continuous Export configuration.
LastUserUpdate	string	Last time the Continuous Export configuration was updated.
NotificationQueueEnabled	string	Deprecated.
PermanentErrorReason	string	This is the reason the Continuous Export configuration started failing. It can be 'AzureStorageNotFound' or 'AzureStorageAccessDenied'.
RecordTypes	string	This comma separated list of document types that will be exported. The possible values include 'Requests', 'Event', 'Exceptions', 'Metrics', 'PageViews', 'PageViewPerformance', 'Rdd', 'PerformanceCounters', 'Availability', 'Messages'.
ResourceGroup	string	The resource group of the Application Insights component.
StorageName	string	The name of the destination storage account.
SubscriptionId	string	The subscription of the Application Insights component.

list

Name	Datatype	Description
ApplicationName	string	The name of the Application Insights component.
ContainerName	string	The name of the destination storage container.
DestinationAccountId	string	The name of destination account.
DestinationStorageLocationId	string	The destination account location ID.
DestinationStorageSubscriptionId	string	The destination storage account subscription ID.
DestinationType	string	The destination type.
ExportId	string	The unique ID of the export configuration inside an Application Insights component. It is auto generated when the Continuous Export configuration is created.
ExportStatus	string	This indicates current Continuous Export configuration status. The possible values are 'Preparing', 'Success', 'Failure'.
InstrumentationKey	string	The instrumentation key of the Application Insights component.
IsUserEnabled	string	This will be 'true' if the Continuous Export configuration is enabled, otherwise it will be 'false'.
LastGapTime	string	The last time the Continuous Export configuration started failing.
LastSuccessTime	string	The last time data was successfully delivered to the destination storage container for this Continuous Export configuration.
LastUserUpdate	string	Last time the Continuous Export configuration was updated.
NotificationQueueEnabled	string	Deprecated.
PermanentErrorReason	string	This is the reason the Continuous Export configuration started failing. It can be 'AzureStorageNotFound' or 'AzureStorageAccessDenied'.
RecordTypes	string	This comma separated list of document types that will be exported. The possible values include 'Requests', 'Event', 'Exceptions', 'Metrics', 'PageViews', 'PageViewPerformance', 'Rdd', 'PerformanceCounters', 'Availability', 'Messages'.
ResourceGroup	string	The resource group of the Application Insights component.
StorageName	string	The name of the destination storage account.
SubscriptionId	string	The subscription of the Application Insights component.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, resource_name, export_id, subscription_id		Get the Continuous Export configuration for this export id.
list	select	resource_group_name, resource_name, subscription_id		Gets a list of Continuous Export configuration of an Application Insights component.
create	insert	resource_group_name, resource_name, subscription_id		Create a Continuous Export configuration of an Application Insights component.
update	update	resource_group_name, resource_name, export_id, subscription_id		Update the Continuous Export configuration for this export id.
delete	delete	resource_group_name, resource_name, export_id, subscription_id		Delete a Continuous Export configuration of an Application Insights component.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
export_id	string	The Continuous Export configuration ID. This is unique within a Application Insights component. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
resource_name	string	The name of the Application Insights component resource. Required.
subscription_id	string

SELECT examples

get

Get the Continuous Export configuration for this export id.

SELECT
ApplicationName,
ContainerName,
DestinationAccountId,
DestinationStorageLocationId,
DestinationStorageSubscriptionId,
DestinationType,
ExportId,
ExportStatus,
InstrumentationKey,
IsUserEnabled,
LastGapTime,
LastSuccessTime,
LastUserUpdate,
NotificationQueueEnabled,
PermanentErrorReason,
RecordTypes,
ResourceGroup,
StorageName,
SubscriptionId
FROM azure.application_insights.export_configurations
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND resource_name = '{{ resource_name }}' -- required
AND export_id = '{{ export_id }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Gets a list of Continuous Export configuration of an Application Insights component.

SELECT
ApplicationName,
ContainerName,
DestinationAccountId,
DestinationStorageLocationId,
DestinationStorageSubscriptionId,
DestinationType,
ExportId,
ExportStatus,
InstrumentationKey,
IsUserEnabled,
LastGapTime,
LastSuccessTime,
LastUserUpdate,
NotificationQueueEnabled,
PermanentErrorReason,
RecordTypes,
ResourceGroup,
StorageName,
SubscriptionId
FROM azure.application_insights.export_configurations
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND resource_name = '{{ resource_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

Create a Continuous Export configuration of an Application Insights component.

INSERT INTO azure.application_insights.export_configurations (
RecordTypes,
DestinationType,
DestinationAddress,
IsEnabled,
NotificationQueueEnabled,
NotificationQueueUri,
DestinationStorageSubscriptionId,
DestinationStorageLocationId,
DestinationAccountId,
resource_group_name,
resource_name,
subscription_id
)
SELECT 
'{{ RecordTypes }}',
'{{ DestinationType }}',
'{{ DestinationAddress }}',
'{{ IsEnabled }}',
'{{ NotificationQueueEnabled }}',
'{{ NotificationQueueUri }}',
'{{ DestinationStorageSubscriptionId }}',
'{{ DestinationStorageLocationId }}',
'{{ DestinationAccountId }}',
'{{ resource_group_name }}',
'{{ resource_name }}',
'{{ subscription_id }}'
RETURNING
ApplicationName,
ContainerName,
DestinationAccountId,
DestinationStorageLocationId,
DestinationStorageSubscriptionId,
DestinationType,
ExportId,
ExportStatus,
InstrumentationKey,
IsUserEnabled,
LastGapTime,
LastSuccessTime,
LastUserUpdate,
NotificationQueueEnabled,
PermanentErrorReason,
RecordTypes,
ResourceGroup,
StorageName,
SubscriptionId
;

Manifest

# Description fields are for documentation purposes
- name: export_configurations
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the export_configurations resource.
  - name: resource_name
    value: "{{ resource_name }}"
    description: Required parameter for the export_configurations resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the export_configurations resource.
  - name: RecordTypes
    value: "{{ RecordTypes }}"
    description: |
      The document types to be exported, as comma separated values. Allowed values include 'Requests', 'Event', 'Exceptions', 'Metrics', 'PageViews', 'PageViewPerformance', 'Rdd', 'PerformanceCounters', 'Availability', 'Messages'.
  - name: DestinationType
    value: "{{ DestinationType }}"
    description: |
      The Continuous Export destination type. This has to be 'Blob'.
  - name: DestinationAddress
    value: "{{ DestinationAddress }}"
    description: |
      The SAS URL for the destination storage container. It must grant write permission.
  - name: IsEnabled
    value: "{{ IsEnabled }}"
    description: |
      Set to 'true' to create a Continuous Export configuration as enabled, otherwise set it to 'false'.
  - name: NotificationQueueEnabled
    value: "{{ NotificationQueueEnabled }}"
    description: |
      Deprecated.
  - name: NotificationQueueUri
    value: "{{ NotificationQueueUri }}"
    description: |
      Deprecated.
  - name: DestinationStorageSubscriptionId
    value: "{{ DestinationStorageSubscriptionId }}"
    description: |
      The subscription ID of the destination storage container.
  - name: DestinationStorageLocationId
    value: "{{ DestinationStorageLocationId }}"
    description: |
      The location ID of the destination storage container.
  - name: DestinationAccountId
    value: "{{ DestinationAccountId }}"
    description: |
      The name of destination storage account.

UPDATE examples

update

Update the Continuous Export configuration for this export id.

UPDATE azure.application_insights.export_configurations
SET 
RecordTypes = '{{ RecordTypes }}',
DestinationType = '{{ DestinationType }}',
DestinationAddress = '{{ DestinationAddress }}',
IsEnabled = '{{ IsEnabled }}',
NotificationQueueEnabled = '{{ NotificationQueueEnabled }}',
NotificationQueueUri = '{{ NotificationQueueUri }}',
DestinationStorageSubscriptionId = '{{ DestinationStorageSubscriptionId }}',
DestinationStorageLocationId = '{{ DestinationStorageLocationId }}',
DestinationAccountId = '{{ DestinationAccountId }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND resource_name = '{{ resource_name }}' --required
AND export_id = '{{ export_id }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
ApplicationName,
ContainerName,
DestinationAccountId,
DestinationStorageLocationId,
DestinationStorageSubscriptionId,
DestinationType,
ExportId,
ExportStatus,
InstrumentationKey,
IsUserEnabled,
LastGapTime,
LastSuccessTime,
LastUserUpdate,
NotificationQueueEnabled,
PermanentErrorReason,
RecordTypes,
ResourceGroup,
StorageName,
SubscriptionId;

DELETE examples

delete

Delete a Continuous Export configuration of an Application Insights component.

DELETE FROM azure.application_insights.export_configurations
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND resource_name = '{{ resource_name }}' --required
AND export_id = '{{ export_id }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;