integration_accounts

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

Overview

Name	integration_accounts
Type	Resource
Id	azure.logic.integration_accounts

Fields

The following fields are returned by SELECT queries:

list_key_vault_keys

Name	Datatype	Description
attributes	object	The key attributes.
kid	string	The key id.

get

Name	Datatype	Description
id	string	The resource id.
name	string	Gets the resource name.
integrationServiceEnvironment	object	The integration service environment.
location	string	The resource location.
sku	object	The sku.
state	string	The workflow state. Known values are: "NotSpecified", "Completed", "Enabled", "Disabled", "Deleted", and "Suspended".
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.
integrationServiceEnvironment	object	The integration service environment.
location	string	The resource location.
sku	object	The sku.
state	string	The workflow state. Known values are: "NotSpecified", "Completed", "Enabled", "Disabled", "Deleted", and "Suspended".
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.
integrationServiceEnvironment	object	The integration service environment.
location	string	The resource location.
sku	object	The sku.
state	string	The workflow state. Known values are: "NotSpecified", "Completed", "Enabled", "Disabled", "Deleted", and "Suspended".
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
list_key_vault_keys	select	resource_group_name, integration_account_name, subscription_id		Gets the integration account's Key Vault keys.
get	select	resource_group_name, integration_account_name, subscription_id		Gets an integration account.
list_by_resource_group	select	resource_group_name, subscription_id	$top	Gets a list of integration accounts by resource group.
list_by_subscription	select	subscription_id	$top	Gets a list of integration accounts by subscription.
create_or_update	insert	resource_group_name, integration_account_name, subscription_id		Creates or updates an integration account.
update	update	resource_group_name, integration_account_name, subscription_id		Updates an integration account.
create_or_update	replace	resource_group_name, integration_account_name, subscription_id		Creates or updates an integration account.
delete	delete	resource_group_name, integration_account_name, subscription_id		Deletes an integration account.
list_callback_url	exec	resource_group_name, integration_account_name, subscription_id		Gets the integration account callback URL.
log_tracking_events	exec	resource_group_name, integration_account_name, subscription_id, sourceType, events		Logs the integration account's tracking events.
regenerate_access_key	exec	resource_group_name, integration_account_name, subscription_id		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
integration_account_name	string	The integration account name. Required.
resource_group_name	string	The resource group name. Required.
subscription_id	string
$top	integer	The number of items to be included in the result. Default value is None.

SELECT examples

list_key_vault_keys

Gets the integration account's Key Vault keys.

SELECT
attributes,
kid
FROM azure.logic.integration_accounts
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND integration_account_name = '{{ integration_account_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

get

Gets an integration account.

SELECT
id,
name,
integrationServiceEnvironment,
location,
sku,
state,
tags,
type
FROM azure.logic.integration_accounts
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND integration_account_name = '{{ integration_account_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

Gets a list of integration accounts by resource group.

SELECT
id,
name,
integrationServiceEnvironment,
location,
sku,
state,
tags,
type
FROM azure.logic.integration_accounts
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $top = '{{ $top }}'
;

list_by_subscription

Gets a list of integration accounts by subscription.

SELECT
id,
name,
integrationServiceEnvironment,
location,
sku,
state,
tags,
type
FROM azure.logic.integration_accounts
WHERE subscription_id = '{{ subscription_id }}' -- required
AND $top = '{{ $top }}'
;

INSERT examples

create_or_update

Creates or updates an integration account.

INSERT INTO azure.logic.integration_accounts (
location,
tags,
sku,
properties,
resource_group_name,
integration_account_name,
subscription_id
)
SELECT 
'{{ location }}',
'{{ tags }}',
'{{ sku }}',
'{{ properties }}',
'{{ resource_group_name }}',
'{{ integration_account_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
sku,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: integration_accounts
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the integration_accounts resource.
  - name: integration_account_name
    value: "{{ integration_account_name }}"
    description: Required parameter for the integration_accounts resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the integration_accounts resource.
  - name: location
    value: "{{ location }}"
    description: |
      The resource location.
  - name: tags
    value: "{{ tags }}"
    description: |
      The resource tags.
  - name: sku
    description: |
      The sku.
    value:
      name: "{{ name }}"
  - name: properties
    value:
      integrationServiceEnvironment:
        id: "{{ id }}"
        name: "{{ name }}"
        type: "{{ type }}"
      state: "{{ state }}"

UPDATE examples

update

Updates an integration account.

UPDATE azure.logic.integration_accounts
SET 
location = '{{ location }}',
tags = '{{ tags }}',
sku = '{{ sku }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND integration_account_name = '{{ integration_account_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
location,
properties,
sku,
tags,
type;

REPLACE examples

create_or_update

Creates or updates an integration account.

REPLACE azure.logic.integration_accounts
SET 
location = '{{ location }}',
tags = '{{ tags }}',
sku = '{{ sku }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND integration_account_name = '{{ integration_account_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
location,
properties,
sku,
tags,
type;

DELETE examples

delete

Deletes an integration account.

DELETE FROM azure.logic.integration_accounts
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND integration_account_name = '{{ integration_account_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

list_callback_url

Gets the integration account callback URL.

EXEC azure.logic.integration_accounts.list_callback_url 
@resource_group_name='{{ resource_group_name }}' --required, 
@integration_account_name='{{ integration_account_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"notAfter": "{{ notAfter }}", 
"keyType": "{{ keyType }}"
}'
;

log_tracking_events

Logs the integration account's tracking events.

EXEC azure.logic.integration_accounts.log_tracking_events 
@resource_group_name='{{ resource_group_name }}' --required, 
@integration_account_name='{{ integration_account_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"sourceType": "{{ sourceType }}", 
"trackEventsOptions": "{{ trackEventsOptions }}", 
"events": "{{ events }}"
}'
;

regenerate_access_key

Regenerates the integration account access key.

EXEC azure.logic.integration_accounts.regenerate_access_key 
@resource_group_name='{{ resource_group_name }}' --required, 
@integration_account_name='{{ integration_account_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"keyType": "{{ keyType }}"
}'
;