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
- list
The Continuous Export configuration for this export id.
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. |
A list containing 0 or more Continuous Export configuration definitions of an Application Insights component.
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 | resourceGroupName , subscriptionId , resourceName , exportId | Get the Continuous Export configuration for this export id. | |
list | select | resourceGroupName , subscriptionId , resourceName | Gets a list of Continuous Export configuration of an Application Insights component. | |
create | insert | resourceGroupName , subscriptionId , resourceName | Create a Continuous Export configuration of an Application Insights component. | |
update | replace | resourceGroupName , subscriptionId , resourceName , exportId | Update the Continuous Export configuration for this export id. | |
delete | delete | resourceGroupName , subscriptionId , resourceName , exportId | 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 |
---|---|---|
exportId | string | The Continuous Export configuration ID. This is unique within a Application Insights component. |
resourceGroupName | string | The name of the resource group. The name is case insensitive. |
resourceName | string | The name of the Application Insights component resource. |
subscriptionId | string (uuid) | The ID of the target subscription. The value must be an UUID. |
SELECT
examples
- get
- list
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 resourceGroupName = '{{ resourceGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND resourceName = '{{ resourceName }}' -- required
AND exportId = '{{ exportId }}' -- required
;
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 resourceGroupName = '{{ resourceGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND resourceName = '{{ resourceName }}' -- required
;
INSERT
examples
- create
- Manifest
Create a Continuous Export configuration of an Application Insights component.
INSERT INTO azure.application_insights.export_configurations (
data__RecordTypes,
data__DestinationType,
data__DestinationAddress,
data__IsEnabled,
data__NotificationQueueEnabled,
data__NotificationQueueUri,
data__DestinationStorageSubscriptionId,
data__DestinationStorageLocationId,
data__DestinationAccountId,
resourceGroupName,
subscriptionId,
resourceName
)
SELECT
'{{ RecordTypes }}',
'{{ DestinationType }}',
'{{ DestinationAddress }}',
'{{ IsEnabled }}',
'{{ NotificationQueueEnabled }}',
'{{ NotificationQueueUri }}',
'{{ DestinationStorageSubscriptionId }}',
'{{ DestinationStorageLocationId }}',
'{{ DestinationAccountId }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ resourceName }}'
RETURNING
ApplicationName,
ContainerName,
DestinationAccountId,
DestinationStorageLocationId,
DestinationStorageSubscriptionId,
DestinationType,
ExportId,
ExportStatus,
InstrumentationKey,
IsUserEnabled,
LastGapTime,
LastSuccessTime,
LastUserUpdate,
NotificationQueueEnabled,
PermanentErrorReason,
RecordTypes,
ResourceGroup,
StorageName,
SubscriptionId
;
# Description fields are for documentation purposes
- name: export_configurations
props:
- name: resourceGroupName
value: string
description: Required parameter for the export_configurations resource.
- name: subscriptionId
value: string (uuid)
description: Required parameter for the export_configurations resource.
- name: resourceName
value: string
description: Required parameter for the export_configurations resource.
- name: RecordTypes
value: string
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: string
description: |
The Continuous Export destination type. This has to be 'Blob'.
- name: DestinationAddress
value: string
description: |
The SAS URL for the destination storage container. It must grant write permission.
- name: IsEnabled
value: string
description: |
Set to 'true' to create a Continuous Export configuration as enabled, otherwise set it to 'false'.
- name: NotificationQueueEnabled
value: string
description: |
Deprecated
- name: NotificationQueueUri
value: string
description: |
Deprecated
- name: DestinationStorageSubscriptionId
value: string
description: |
The subscription ID of the destination storage container.
- name: DestinationStorageLocationId
value: string
description: |
The location ID of the destination storage container.
- name: DestinationAccountId
value: string
description: |
The name of destination storage account.
REPLACE
examples
- update
Update the Continuous Export configuration for this export id.
REPLACE azure.application_insights.export_configurations
SET
data__RecordTypes = '{{ RecordTypes }}',
data__DestinationType = '{{ DestinationType }}',
data__DestinationAddress = '{{ DestinationAddress }}',
data__IsEnabled = '{{ IsEnabled }}',
data__NotificationQueueEnabled = '{{ NotificationQueueEnabled }}',
data__NotificationQueueUri = '{{ NotificationQueueUri }}',
data__DestinationStorageSubscriptionId = '{{ DestinationStorageSubscriptionId }}',
data__DestinationStorageLocationId = '{{ DestinationStorageLocationId }}',
data__DestinationAccountId = '{{ DestinationAccountId }}'
WHERE
resourceGroupName = '{{ resourceGroupName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
AND resourceName = '{{ resourceName }}' --required
AND exportId = '{{ exportId }}' --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 resourceGroupName = '{{ resourceGroupName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
AND resourceName = '{{ resourceName }}' --required
AND exportId = '{{ exportId }}' --required
;