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:

get_item

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.

list

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
get_item	select	resource_group_name, resource_name, work_item_config_id, subscription_id		Gets specified work item configuration for an Application Insights component.
list	select	resource_group_name, resource_name, subscription_id		Gets the list work item configurations that exist for the application.
create	insert	resource_group_name, resource_name, subscription_id		Create a work item configuration for an Application Insights component.
delete	delete	resource_group_name, resource_name, work_item_config_id, subscription_id		Delete a work item configuration of an Application Insights component.
get_default	exec	resource_group_name, resource_name, subscription_id		Gets default work item configurations that exist for the application.
update_item	exec	resource_group_name, resource_name, work_item_config_id, subscription_id		Update a work item configuration for 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
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
work_item_config_id	string	The unique work item configuration Id. This can be either friendly name of connector as defined in connector configuration. Required.

SELECT examples

get_item

Gets specified work item configuration for an Application Insights component.

SELECT
ConfigDisplayName,
ConfigProperties,
ConnectorId,
Id,
IsDefault
FROM azure.application_insights.work_item_configurations
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND resource_name = '{{ resource_name }}' -- required
AND work_item_config_id = '{{ work_item_config_id }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

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 resource_group_name = '{{ resource_group_name }}' -- required
AND resource_name = '{{ resource_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

Create a work item configuration for an Application Insights component.

INSERT INTO azure.application_insights.work_item_configurations (
ConnectorId,
ConnectorDataConfiguration,
ValidateOnly,
WorkItemProperties,
resource_group_name,
resource_name,
subscription_id
)
SELECT 
'{{ ConnectorId }}',
'{{ ConnectorDataConfiguration }}',
{{ ValidateOnly }},
'{{ WorkItemProperties }}',
'{{ resource_group_name }}',
'{{ resource_name }}',
'{{ subscription_id }}'
RETURNING
ConfigDisplayName,
ConfigProperties,
ConnectorId,
Id,
IsDefault
;

Manifest

# Description fields are for documentation purposes
- name: work_item_configurations
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the work_item_configurations resource.
  - name: resource_name
    value: "{{ resource_name }}"
    description: Required parameter for the work_item_configurations resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the work_item_configurations resource.
  - name: ConnectorId
    value: "{{ ConnectorId }}"
    description: |
      Unique connector id.
  - name: ConnectorDataConfiguration
    value: "{{ ConnectorDataConfiguration }}"
    description: |
      Serialized JSON object for detailed properties.
  - name: ValidateOnly
    value: {{ ValidateOnly }}
    description: |
      Boolean indicating validate only.
  - name: WorkItemProperties
    value: "{{ WorkItemProperties }}"
    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 resource_group_name = '{{ resource_group_name }}' --required
AND resource_name = '{{ resource_name }}' --required
AND work_item_config_id = '{{ work_item_config_id }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

get_default

Gets default work item configurations that exist for the application.

EXEC azure.application_insights.work_item_configurations.get_default 
@resource_group_name='{{ resource_group_name }}' --required, 
@resource_name='{{ resource_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

update_item

Update a work item configuration for an Application Insights component.

EXEC azure.application_insights.work_item_configurations.update_item 
@resource_group_name='{{ resource_group_name }}' --required, 
@resource_name='{{ resource_name }}' --required, 
@work_item_config_id='{{ work_item_config_id }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"ConnectorId": "{{ ConnectorId }}", 
"ConnectorDataConfiguration": "{{ ConnectorDataConfiguration }}", 
"ValidateOnly": {{ ValidateOnly }}, 
"WorkItemProperties": "{{ WorkItemProperties }}"
}'
;