integration_account_agreements

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

Overview

Name	integration_account_agreements
Type	Resource
Id	azure.logic_apps.integration_account_agreements

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 agreement properties.
tags	object	The resource tags.
type	string	Gets the resource type.

list

Name	Datatype	Description
id	string	The resource id.
name	string	Gets the resource name.
location	string	The resource location.
properties	object	The integration account agreement properties.
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, agreementName	api-version	Gets an integration account agreement.
list	select	subscriptionId, resourceGroupName, integrationAccountName	api-version, $top, $filter	Gets a list of integration account agreements.
create_or_update	insert	subscriptionId, resourceGroupName, integrationAccountName, agreementName, data__properties	api-version	Creates or updates an integration account agreement.
delete	delete	subscriptionId, resourceGroupName, integrationAccountName, agreementName	api-version	Deletes an integration account agreement.

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
agreementName	string	The integration account agreement name.
integrationAccountName	string	The integration account name.
resourceGroupName	string	The resource group name.
subscriptionId	string	The subscription id.
$filter	string	The filter to apply on the operation. Options for filters include: AgreementType.
$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 agreement.

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

list

Gets a list of integration account agreements.

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

INSERT examples

create_or_update

Creates or updates an integration account agreement.

INSERT INTO azure.logic_apps.integration_account_agreements (
data__properties,
data__location,
data__tags,
subscriptionId,
resourceGroupName,
integrationAccountName,
agreementName,
api-version
)
SELECT 
'{{ properties }}' /* required */,
'{{ location }}',
'{{ tags }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ integrationAccountName }}',
'{{ agreementName }}',
'{{ api-version }}'
RETURNING
id,
name,
location,
properties,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: integration_account_agreements
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the integration_account_agreements resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the integration_account_agreements resource.
    - name: integrationAccountName
      value: string
      description: Required parameter for the integration_account_agreements resource.
    - name: agreementName
      value: string
      description: Required parameter for the integration_account_agreements resource.
    - name: properties
      value: object
      description: |
        The integration account agreement properties.
    - 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.

DELETE examples

delete

Deletes an integration account agreement.

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