integration_accounts

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

Overview

Name	integration_accounts
Type	Resource
Id	azure.logic_apps.integration_accounts

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	The resource id.
name	string	Gets the resource name.
location	string	The resource location.
properties	object	The integration account properties.
sku	object	The sku.
tags	object	The resource tags.
type	string	Gets the resource type.

list_by_resource_group

Name	Datatype	Description
id	string	The resource id.
name	string	Gets the resource name.
location	string	The resource location.
properties	object	The integration account properties.
sku	object	The sku.
tags	object	The resource tags.
type	string	Gets the resource type.

list_by_subscription

Name	Datatype	Description
id	string	The resource id.
name	string	Gets the resource name.
location	string	The resource location.
properties	object	The integration account properties.
sku	object	The sku.
tags	object	The resource tags.
type	string	Gets the resource type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, integrationAccountName	api-version	Gets an integration account.
list_by_resource_group	select	subscriptionId, resourceGroupName	api-version, $top	Gets a list of integration accounts by resource group.
list_by_subscription	select	subscriptionId	api-version, $top	Gets a list of integration accounts by subscription.
create_or_update	insert	subscriptionId, resourceGroupName, integrationAccountName	api-version	Creates or updates an integration account.
update	update	subscriptionId, resourceGroupName, integrationAccountName	api-version	Updates an integration account.
delete	delete	subscriptionId, resourceGroupName, integrationAccountName	api-version	Deletes an integration account.
log_tracking_events	exec	subscriptionId, resourceGroupName, integrationAccountName, sourceType, events	api-version	Logs the integration account's tracking events.
regenerate_access_key	exec	subscriptionId, resourceGroupName, integrationAccountName	api-version	Regenerates the integration account access key.

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
integrationAccountName	string	The integration account name.
resourceGroupName	string	The resource group name.
subscriptionId	string	The subscription id.
$top	integer (int32)	The number of items to be included in the result.
api-version	string	The API version.

SELECT examples

get

Gets an integration account.

SELECT
id,
name,
location,
properties,
sku,
tags,
type
FROM azure.logic_apps.integration_accounts
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND integrationAccountName = '{{ integrationAccountName }}' -- required
AND api-version = '{{ api-version }}'
;

list_by_resource_group

Gets a list of integration accounts by resource group.

SELECT
id,
name,
location,
properties,
sku,
tags,
type
FROM azure.logic_apps.integration_accounts
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND api-version = '{{ api-version }}'
AND $top = '{{ $top }}'
;

list_by_subscription

Gets a list of integration accounts by subscription.

SELECT
id,
name,
location,
properties,
sku,
tags,
type
FROM azure.logic_apps.integration_accounts
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND api-version = '{{ api-version }}'
AND $top = '{{ $top }}'
;

INSERT examples

create_or_update

Creates or updates an integration account.

INSERT INTO azure.logic_apps.integration_accounts (
data__properties,
data__sku,
data__location,
data__tags,
subscriptionId,
resourceGroupName,
integrationAccountName,
api-version
)
SELECT 
'{{ properties }}',
'{{ sku }}',
'{{ location }}',
'{{ tags }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ integrationAccountName }}',
'{{ api-version }}'
RETURNING
id,
name,
location,
properties,
sku,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: integration_accounts
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the integration_accounts resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the integration_accounts resource.
    - name: integrationAccountName
      value: string
      description: Required parameter for the integration_accounts resource.
    - name: properties
      value: object
      description: |
        The integration account properties.
    - name: sku
      value: object
      description: |
        The sku.
    - name: location
      value: string
      description: |
        The resource location.
    - name: tags
      value: object
      description: |
        The resource tags.
    - name: api-version
      value: string
      description: The API version.

UPDATE examples

update

Updates an integration account.

UPDATE azure.logic_apps.integration_accounts
SET 
data__properties = '{{ properties }}',
data__sku = '{{ sku }}',
data__location = '{{ location }}',
data__tags = '{{ tags }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND integrationAccountName = '{{ integrationAccountName }}' --required
AND api-version = '{{ api-version}}'
RETURNING
id,
name,
location,
properties,
sku,
tags,
type;

DELETE examples

delete

Deletes an integration account.

DELETE FROM azure.logic_apps.integration_accounts
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND integrationAccountName = '{{ integrationAccountName }}' --required
AND api-version = '{{ api-version }}'
;

Lifecycle Methods

log_tracking_events

Logs the integration account's tracking events.

EXEC azure.logic_apps.integration_accounts.log_tracking_events 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@integrationAccountName='{{ integrationAccountName }}' --required, 
@api-version='{{ api-version }}' 
@@json=
'{
"sourceType": "{{ sourceType }}", 
"trackEventsOptions": "{{ trackEventsOptions }}", 
"events": "{{ events }}"
}'
;

regenerate_access_key

Regenerates the integration account access key.

EXEC azure.logic_apps.integration_accounts.regenerate_access_key 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@integrationAccountName='{{ integrationAccountName }}' --required, 
@api-version='{{ api-version }}' 
@@json=
'{
"keyType": "{{ keyType }}"
}'
;