integration_account_agreements

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

Overview

Name	integration_account_agreements
Type	Resource
Id	azure.logic.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.
agreementType	string	The agreement type. Required. Known values are: "NotSpecified", "AS2", "X12", and "Edifact".
changedTime	string (date-time)	The changed time.
content	object	The agreement content. Required.
createdTime	string (date-time)	The created time.
guestIdentity	object	The business identity of the guest partner. Required.
guestPartner	string	The integration account partner that is set as guest partner for this agreement. Required.
hostIdentity	object	The business identity of the host partner. Required.
hostPartner	string	The integration account partner that is set as host partner for this agreement. Required.
location	string	The resource location.
metadata	object	The metadata.
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.
agreementType	string	The agreement type. Required. Known values are: "NotSpecified", "AS2", "X12", and "Edifact".
changedTime	string (date-time)	The changed time.
content	object	The agreement content. Required.
createdTime	string (date-time)	The created time.
guestIdentity	object	The business identity of the guest partner. Required.
guestPartner	string	The integration account partner that is set as guest partner for this agreement. Required.
hostIdentity	object	The business identity of the host partner. Required.
hostPartner	string	The integration account partner that is set as host partner for this agreement. Required.
location	string	The resource location.
metadata	object	The metadata.
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	resource_group_name, integration_account_name, agreement_name, subscription_id		Gets an integration account agreement.
list	select	resource_group_name, integration_account_name, subscription_id	$top, $filter	Gets a list of integration account agreements.
create_or_update	insert	resource_group_name, integration_account_name, agreement_name, subscription_id, properties		Creates or updates an integration account agreement.
create_or_update	replace	resource_group_name, integration_account_name, agreement_name, subscription_id, properties		Creates or updates an integration account agreement.
delete	delete	resource_group_name, integration_account_name, agreement_name, subscription_id		Deletes an integration account agreement.
list_content_callback_url	exec	resource_group_name, integration_account_name, agreement_name, subscription_id		Get the content callback url.

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
agreement_name	string	The integration account agreement name. Required.
integration_account_name	string	The integration account name. Required.
resource_group_name	string	The resource group name. Required.
subscription_id	string
$filter	string	The filter to apply on the operation. Options for filters include: AgreementType. Default value is None.
$top	integer	The number of items to be included in the result. Default value is None.

SELECT examples

get

Gets an integration account agreement.

SELECT
id,
name,
agreementType,
changedTime,
content,
createdTime,
guestIdentity,
guestPartner,
hostIdentity,
hostPartner,
location,
metadata,
tags,
type
FROM azure.logic.integration_account_agreements
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND integration_account_name = '{{ integration_account_name }}' -- required
AND agreement_name = '{{ agreement_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Gets a list of integration account agreements.

SELECT
id,
name,
agreementType,
changedTime,
content,
createdTime,
guestIdentity,
guestPartner,
hostIdentity,
hostPartner,
location,
metadata,
tags,
type
FROM azure.logic.integration_account_agreements
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND integration_account_name = '{{ integration_account_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $top = '{{ $top }}'
AND $filter = '{{ $filter }}'
;

INSERT examples

create_or_update

Creates or updates an integration account agreement.

INSERT INTO azure.logic.integration_account_agreements (
location,
tags,
properties,
resource_group_name,
integration_account_name,
agreement_name,
subscription_id
)
SELECT 
'{{ location }}',
'{{ tags }}',
'{{ properties }}' /* required */,
'{{ resource_group_name }}',
'{{ integration_account_name }}',
'{{ agreement_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: integration_account_agreements
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the integration_account_agreements resource.
  - name: integration_account_name
    value: "{{ integration_account_name }}"
    description: Required parameter for the integration_account_agreements resource.
  - name: agreement_name
    value: "{{ agreement_name }}"
    description: Required parameter for the integration_account_agreements resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the integration_account_agreements resource.
  - name: location
    value: "{{ location }}"
    description: |
      The resource location.
  - name: tags
    value: "{{ tags }}"
    description: |
      The resource tags.
  - name: properties
    value:
      metadata: "{{ metadata }}"
      agreementType: "{{ agreementType }}"
      hostPartner: "{{ hostPartner }}"
      guestPartner: "{{ guestPartner }}"
      hostIdentity:
        qualifier: "{{ qualifier }}"
        value: "{{ value }}"
      guestIdentity:
        qualifier: "{{ qualifier }}"
        value: "{{ value }}"
      content:
        aS2:
          receiveAgreement:
            senderBusinessIdentity:
              qualifier: "{{ qualifier }}"
              value: "{{ value }}"
            receiverBusinessIdentity:
              qualifier: "{{ qualifier }}"
              value: "{{ value }}"
            protocolSettings:
              messageConnectionSettings: "{{ messageConnectionSettings }}"
              acknowledgementConnectionSettings: "{{ acknowledgementConnectionSettings }}"
              mdnSettings: "{{ mdnSettings }}"
              securitySettings: "{{ securitySettings }}"
              validationSettings: "{{ validationSettings }}"
              envelopeSettings: "{{ envelopeSettings }}"
              errorSettings: "{{ errorSettings }}"
          sendAgreement:
            senderBusinessIdentity:
              qualifier: "{{ qualifier }}"
              value: "{{ value }}"
            receiverBusinessIdentity:
              qualifier: "{{ qualifier }}"
              value: "{{ value }}"
            protocolSettings:
              messageConnectionSettings: "{{ messageConnectionSettings }}"
              acknowledgementConnectionSettings: "{{ acknowledgementConnectionSettings }}"
              mdnSettings: "{{ mdnSettings }}"
              securitySettings: "{{ securitySettings }}"
              validationSettings: "{{ validationSettings }}"
              envelopeSettings: "{{ envelopeSettings }}"
              errorSettings: "{{ errorSettings }}"
        x12:
          receiveAgreement:
            senderBusinessIdentity:
              qualifier: "{{ qualifier }}"
              value: "{{ value }}"
            receiverBusinessIdentity:
              qualifier: "{{ qualifier }}"
              value: "{{ value }}"
            protocolSettings:
              validationSettings: "{{ validationSettings }}"
              framingSettings: "{{ framingSettings }}"
              envelopeSettings: "{{ envelopeSettings }}"
              acknowledgementSettings: "{{ acknowledgementSettings }}"
              messageFilter: "{{ messageFilter }}"
              securitySettings: "{{ securitySettings }}"
              processingSettings: "{{ processingSettings }}"
              envelopeOverrides: "{{ envelopeOverrides }}"
              validationOverrides: "{{ validationOverrides }}"
              messageFilterList: "{{ messageFilterList }}"
              schemaReferences: "{{ schemaReferences }}"
              x12DelimiterOverrides: "{{ x12DelimiterOverrides }}"
          sendAgreement:
            senderBusinessIdentity:
              qualifier: "{{ qualifier }}"
              value: "{{ value }}"
            receiverBusinessIdentity:
              qualifier: "{{ qualifier }}"
              value: "{{ value }}"
            protocolSettings:
              validationSettings: "{{ validationSettings }}"
              framingSettings: "{{ framingSettings }}"
              envelopeSettings: "{{ envelopeSettings }}"
              acknowledgementSettings: "{{ acknowledgementSettings }}"
              messageFilter: "{{ messageFilter }}"
              securitySettings: "{{ securitySettings }}"
              processingSettings: "{{ processingSettings }}"
              envelopeOverrides: "{{ envelopeOverrides }}"
              validationOverrides: "{{ validationOverrides }}"
              messageFilterList: "{{ messageFilterList }}"
              schemaReferences: "{{ schemaReferences }}"
              x12DelimiterOverrides: "{{ x12DelimiterOverrides }}"
        edifact:
          receiveAgreement:
            senderBusinessIdentity:
              qualifier: "{{ qualifier }}"
              value: "{{ value }}"
            receiverBusinessIdentity:
              qualifier: "{{ qualifier }}"
              value: "{{ value }}"
            protocolSettings:
              validationSettings: "{{ validationSettings }}"
              framingSettings: "{{ framingSettings }}"
              envelopeSettings: "{{ envelopeSettings }}"
              acknowledgementSettings: "{{ acknowledgementSettings }}"
              messageFilter: "{{ messageFilter }}"
              processingSettings: "{{ processingSettings }}"
              envelopeOverrides: "{{ envelopeOverrides }}"
              messageFilterList: "{{ messageFilterList }}"
              schemaReferences: "{{ schemaReferences }}"
              validationOverrides: "{{ validationOverrides }}"
              edifactDelimiterOverrides: "{{ edifactDelimiterOverrides }}"
          sendAgreement:
            senderBusinessIdentity:
              qualifier: "{{ qualifier }}"
              value: "{{ value }}"
            receiverBusinessIdentity:
              qualifier: "{{ qualifier }}"
              value: "{{ value }}"
            protocolSettings:
              validationSettings: "{{ validationSettings }}"
              framingSettings: "{{ framingSettings }}"
              envelopeSettings: "{{ envelopeSettings }}"
              acknowledgementSettings: "{{ acknowledgementSettings }}"
              messageFilter: "{{ messageFilter }}"
              processingSettings: "{{ processingSettings }}"
              envelopeOverrides: "{{ envelopeOverrides }}"
              messageFilterList: "{{ messageFilterList }}"
              schemaReferences: "{{ schemaReferences }}"
              validationOverrides: "{{ validationOverrides }}"
              edifactDelimiterOverrides: "{{ edifactDelimiterOverrides }}"

REPLACE examples

create_or_update

Creates or updates an integration account agreement.

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

DELETE examples

delete

Deletes an integration account agreement.

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

Lifecycle Methods

list_content_callback_url

Get the content callback url.

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