work_item_configurations

Creates, updates, deletes, gets or lists a work_item_configurations resource.

Overview

Name	work_item_configurations
Type	Resource
Id	azure.application_insights.work_item_configurations

Fields

The following fields are returned by SELECT queries:

list

successful operation

Name	Datatype	Description
ConfigDisplayName	string	Configuration friendly name
ConfigProperties	string	Serialized JSON object for detailed properties
ConnectorId	string	Connector identifier where work item is created
Id	string	Unique Id for work item
IsDefault	boolean	Boolean value indicating whether configuration is default

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	resourceGroupName, subscriptionId, resourceName		Gets the list work item configurations that exist for the application
create	insert	resourceGroupName, subscriptionId, resourceName		Create a work item configuration for an Application Insights component.
delete	delete	resourceGroupName, subscriptionId, resourceName, workItemConfigId		Delete a work item 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
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.
workItemConfigId	string	The unique work item configuration Id. This can be either friendly name of connector as defined in connector configuration

SELECT examples

list

Gets the list work item configurations that exist for the application

SELECT
ConfigDisplayName,
ConfigProperties,
ConnectorId,
Id,
IsDefault
FROM azure.application_insights.work_item_configurations
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND resourceName = '{{ resourceName }}' -- required
;

INSERT examples

create

Create a work item configuration for an Application Insights component.

INSERT INTO azure.application_insights.work_item_configurations (
data__ConnectorId,
data__ConnectorDataConfiguration,
data__ValidateOnly,
data__WorkItemProperties,
resourceGroupName,
subscriptionId,
resourceName
)
SELECT 
'{{ ConnectorId }}',
'{{ ConnectorDataConfiguration }}',
{{ ValidateOnly }},
'{{ WorkItemProperties }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ resourceName }}'
RETURNING
ConfigDisplayName,
ConfigProperties,
ConnectorId,
Id,
IsDefault
;

Manifest

# Description fields are for documentation purposes
- name: work_item_configurations
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the work_item_configurations resource.
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the work_item_configurations resource.
    - name: resourceName
      value: string
      description: Required parameter for the work_item_configurations resource.
    - name: ConnectorId
      value: string
      description: |
        Unique connector id
    - name: ConnectorDataConfiguration
      value: string
      description: |
        Serialized JSON object for detailed properties
    - name: ValidateOnly
      value: boolean
      description: |
        Boolean indicating validate only
    - name: WorkItemProperties
      value: object
      description: |
        Custom work item properties

DELETE examples

delete

Delete a work item configuration of an Application Insights component.

DELETE FROM azure.application_insights.work_item_configurations
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
AND resourceName = '{{ resourceName }}' --required
AND workItemConfigId = '{{ workItemConfigId }}' --required
;