The IntegrationAccountAgreements API from Azure Logic Apps — 3 operation(s) for integrationaccountagreements.
swagger: '2.0'
info:
description: REST API for Azure Logic Apps.
title: LogicManagementClient IntegrationAccountAgreements API
version: '2.0'
x-apisguru-categories:
- cloud
x-logo:
url: https://api.apis.guru/v2/cache/logo/https_assets.onestore.ms_cdnfiles_onestorerolling-1606-01000_shell_v3_images_logo_microsoft.png
x-origin:
- format: swagger
url: https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/logic/resource-manager/Microsoft.Logic/stable/2019-05-01/logic.json
x-preferred: true
x-providerName: azure.com
x-serviceName: logic
x-tags:
- Azure
- Microsoft
host: management.azure.com
schemes:
- https
consumes:
- application/json
produces:
- application/json
security:
- azure_auth:
- user_impersonation
tags:
- name: IntegrationAccountAgreements
paths:
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/agreements
: get:
description: Gets a list of integration account agreements.
operationId: IntegrationAccountAgreements_List
parameters:
- $ref: '#/parameters/subscriptionId'
- description: The resource group name.
in: path
name: resourceGroupName
required: true
type: string
example: my-resource-group
- description: The integration account name.
in: path
name: integrationAccountName
required: true
type: string
example: example-value
- $ref: '#/parameters/api-version'
- description: The number of items to be included in the result.
format: int32
in: query
name: $top
required: false
type: integer
example: example-value
- description: 'The filter to apply on the operation. Options for filters include: AgreementType.'
in: query
name: $filter
required: false
type: string
example: example-value
responses:
'200':
description: OK
schema:
$ref: '#/definitions/IntegrationAccountAgreementListResult'
default:
description: Error response describing why the operation failed.
schema:
$ref: '#/definitions/ErrorResponse'
tags:
- IntegrationAccountAgreements
x-ms-examples:
Get agreements by integration account name:
parameters:
api-version: '2019-05-01'
integrationAccountName: testIntegrationAccount
resourceGroupName: testResourceGroup
subscriptionId: 34adfa4f-cedf-4dc0-ba29-b6d1a69ab345
responses:
'200':
body:
value:
- id: /subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testResourceGroup/providers/Microsoft.Logic/integrationAccounts/<IntegrationAccountName>/agreements/<IntegrationAccountAgreementName>
name: <IntegrationAccountAgreementName>
properties:
agreementType: X12
changedTime: '2017-03-06T22:00:54.1520445Z'
content:
x12:
receiveAgreement:
protocolSettings:
acknowledgementSettings:
acknowledgementControlNumberLowerBound: 1
acknowledgementControlNumberUpperBound: 999999999
batchFunctionalAcknowledgements: true
batchImplementationAcknowledgements: false
batchTechnicalAcknowledgements: true
needFunctionalAcknowledgement: false
needImplementationAcknowledgement: false
needLoopForValidMessages: false
needTechnicalAcknowledgement: false
rolloverAcknowledgementControlNumber: true
sendSynchronousAcknowledgement: true
envelopeSettings:
controlStandardsId: 85
controlVersionNumber: '00401'
enableDefaultGroupHeaders: true
groupControlNumberLowerBound: 1
groupControlNumberUpperBound: 999999999
groupHeaderAgencyCode: T
groupHeaderDateFormat: CCYYMMDD
groupHeaderTimeFormat: HHMM
groupHeaderVersion: '00401'
interchangeControlNumberLowerBound: 1
interchangeControlNumberUpperBound: 999999999
overwriteExistingTransactionSetControlNumber: true
receiverApplicationId: RECEIVE-APP
rolloverGroupControlNumber: true
rolloverInterchangeControlNumber: true
rolloverTransactionSetControlNumber: true
senderApplicationId: BTS-SENDER
transactionSetControlNumberLowerBound: 1
transactionSetControlNumberUpperBound: 999999999
usageIndicator: Test
useControlStandardsIdAsRepetitionCharacter: false
framingSettings:
characterSet: UTF8
componentSeparator: 58
dataElementSeparator: 42
replaceCharacter: 36
replaceSeparatorsInPayload: false
segmentTerminator: 126
segmentTerminatorSuffix: None
messageFilter:
messageFilterType: Exclude
processingSettings:
convertImpliedDecimal: true
createEmptyXmlTagsForTrailingSeparators: true
maskSecurityInfo: true
preserveInterchange: true
suspendInterchangeOnError: true
useDotAsDecimalSeparator: true
schemaReferences: []
securitySettings:
authorizationQualifier: '00'
securityQualifier: '00'
validationSettings:
allowLeadingAndTrailingSpacesAndZeroes: false
checkDuplicateGroupControlNumber: false
checkDuplicateInterchangeControlNumber: false
checkDuplicateTransactionSetControlNumber: false
interchangeControlNumberValidityDays: 30
trailingSeparatorPolicy: NotAllowed
trimLeadingAndTrailingSpacesAndZeroes: false
validateCharacterSet: true
validateEDITypes: true
validateXSDTypes: false
receiverBusinessIdentity:
qualifier: ZZ
value: ZZ
senderBusinessIdentity:
qualifier: AA
value: AA
sendAgreement:
protocolSettings:
acknowledgementSettings:
acknowledgementControlNumberLowerBound: 1
acknowledgementControlNumberUpperBound: 999999999
batchFunctionalAcknowledgements: true
batchImplementationAcknowledgements: false
batchTechnicalAcknowledgements: true
needFunctionalAcknowledgement: false
needImplementationAcknowledgement: false
needLoopForValidMessages: false
needTechnicalAcknowledgement: false
rolloverAcknowledgementControlNumber: true
sendSynchronousAcknowledgement: true
envelopeSettings:
controlStandardsId: 100
controlVersionNumber: '0.0'
enableDefaultGroupHeaders: true
functionalGroupId: '1'
groupControlNumberLowerBound: 1
groupControlNumberUpperBound: 999999999
groupHeaderAgencyCode: T
groupHeaderDateFormat: CCYYMMDD
groupHeaderTimeFormat: HHMM
groupHeaderVersion: '0.0'
interchangeControlNumberLowerBound: 1
interchangeControlNumberUpperBound: 999999999
overwriteExistingTransactionSetControlNumber: true
receiverApplicationId: '100'
rolloverGroupControlNumber: true
rolloverInterchangeControlNumber: true
rolloverTransactionSetControlNumber: true
senderApplicationId: '100'
transactionSetControlNumberLowerBound: 1
transactionSetControlNumberPrefix: ''
transactionSetControlNumberSuffix: ''
transactionSetControlNumberUpperBound: 999999999
usageIndicator: Information
useControlStandardsIdAsRepetitionCharacter: true
framingSettings:
characterSet: UTF8
componentSeparator: 58
dataElementSeparator: 42
replaceCharacter: 36
replaceSeparatorsInPayload: false
segmentTerminator: 126
segmentTerminatorSuffix: None
messageFilter:
messageFilterType: Exclude
processingSettings:
convertImpliedDecimal: true
createEmptyXmlTagsForTrailingSeparators: true
maskSecurityInfo: true
preserveInterchange: true
suspendInterchangeOnError: true
useDotAsDecimalSeparator: true
schemaReferences: []
securitySettings:
authorizationQualifier: '00'
securityQualifier: '00'
validationSettings:
allowLeadingAndTrailingSpacesAndZeroes: false
checkDuplicateGroupControlNumber: false
checkDuplicateInterchangeControlNumber: false
checkDuplicateTransactionSetControlNumber: false
interchangeControlNumberValidityDays: 30
trailingSeparatorPolicy: NotAllowed
trimLeadingAndTrailingSpacesAndZeroes: false
validateCharacterSet: true
validateEDITypes: true
validateXSDTypes: false
receiverBusinessIdentity:
qualifier: AA
value: AA
senderBusinessIdentity:
qualifier: ZZ
value: ZZ
createdTime: '2017-03-06T22:00:54.1516558Z'
guestIdentity:
qualifier: AA
value: AA
guestPartner: GuestPartner
hostIdentity:
qualifier: ZZ
value: ZZ
hostPartner: HostPartner
metadata: {}
type: Microsoft.Logic/integrationAccounts/agreements
- id: /subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testResourceGroup/providers/Microsoft.Logic/integrationAccounts/<IntegrationAccountName>/agreements/<IntegrationAccountAgreementName>
name: <IntegrationAccountAgreementName>
properties:
agreementType: AS2
changedTime: '2017-03-06T22:00:53.4140804Z'
content:
aS2:
receiveAgreement:
protocolSettings:
acknowledgementConnectionSettings:
ignoreCertificateNameMismatch: true
keepHttpConnectionAlive: true
supportHttpStatusCodeContinue: true
unfoldHttpHeaders: true
envelopeSettings:
autogenerateFileName: true
fileNameTemplate: Test
messageContentType: text/plain
suspendMessageOnFileNameGenerationError: true
transmitFileNameInMimeHeader: true
errorSettings:
resendIfMDNNotReceived: true
suspendDuplicateMessage: true
mdnSettings:
dispositionNotificationTo: http://tempuri.org
mdnText: Sample
micHashingAlgorithm: None
needMDN: true
receiptDeliveryUrl: http://tempuri.org
sendInboundMdnToMessageBox: true
sendMDNAsynchronously: true
signMDN: true
signOutboundMdnIfOptional: true
messageConnectionSettings:
ignoreCertificateNameMismatch: true
keepHttpConnectionAlive: true
supportHttpStatusCodeContinue: true
unfoldHttpHeaders: true
securitySettings:
enableNRRForInboundDecodedMessages: true
enableNRRForInboundEncodedMessages: true
enableNRRForInboundMDN: true
enableNRRForOutboundDecodedMessages: true
enableNRRForOutboundEncodedMessages: true
enableNRRForOutboundMDN: true
overrideGroupSigningCertificate: false
validationSettings:
checkCertificateRevocationListOnReceive: true
checkCertificateRevocationListOnSend: true
checkDuplicateMessage: true
compressMessage: true
encryptMessage: false
encryptionAlgorithm: AES128
interchangeDuplicatesValidityDays: 100
overrideMessageProperties: true
signMessage: false
receiverBusinessIdentity:
qualifier: ZZ
value: ZZ
senderBusinessIdentity:
qualifier: AA
value: AA
sendAgreement:
protocolSettings:
acknowledgementConnectionSettings:
ignoreCertificateNameMismatch: true
keepHttpConnectionAlive: true
supportHttpStatusCodeContinue: true
unfoldHttpHeaders: true
envelopeSettings:
autogenerateFileName: true
fileNameTemplate: Test
messageContentType: text/plain
suspendMessageOnFileNameGenerationError: true
transmitFileNameInMimeHeader: true
errorSettings:
resendIfMDNNotReceived: true
suspendDuplicateMessage: true
mdnSettings:
dispositionNotificationTo: http://tempuri.org
mdnText: Sample
micHashingAlgorithm: None
needMDN: true
receiptDeliveryUrl: http://tempuri.org
sendInboundMdnToMessageBox: true
sendMDNAsynchronously: true
signMDN: true
signOutboundMdnIfOptional: true
messageConnectionSettings:
ignoreCertificateNameMismatch: true
keepHttpConnectionAlive: true
supportHttpStatusCodeContinue: true
unfoldHttpHeaders: true
securitySettings:
enableNRRForInboundDecodedMessages: true
enableNRRForInboundEncodedMessages: true
enableNRRForInboundMDN: true
enableNRRForOutboundDecodedMessages: true
enableNRRForOutboundEncodedMessages: true
enableNRRForOutboundMDN: true
overrideGroupSigningCertificate: false
validationSettings:
checkCertificateRevocationListOnReceive: true
checkCertificateRevocationListOnSend: true
checkDuplicateMessage: true
compressMessage: true
encryptMessage: false
encryptionAlgorithm: AES128
interchangeDuplicatesValidityDays: 100
overrideMessageProperties: true
signMessage: false
receiverBusinessIdentity:
qualifier: AA
value: AA
senderBusinessIdentity:
qualifier: ZZ
value: ZZ
createdTime: '2017-03-06T22:00:53.4134038Z'
guestIdentity:
qualifier: AA
value: AA
guestPartner: GuestPartner
hostIdentity:
qualifier: ZZ
value: ZZ
hostPartner: HostPartner
metadata: {}
type: Microsoft.Logic/integrationAccounts/agreements
- id: /subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testResourceGroup/providers/Microsoft.Logic/integrationAccounts/<IntegrationAccountName>/agreements/<IntegrationAccountAgreementName>
name: <IntegrationAccountAgreementName>
properties:
agreementType: Edifact
changedTime: '2017-03-06T22:00:53.8212345Z'
content:
edifact:
receiveAgreement:
protocolSettings:
acknowledgementSettings:
acknowledgementControlNumberLowerBound: 1
acknowledgementControlNumberPrefix: ''
acknowledgementControlNumberSuffix: ''
acknowledgementControlNumberUpperBound: 99999999
batchFunctionalAcknowledgements: true
batchTechnicalAcknowledgements: true
needFunctionalAcknowledgement: false
needLoopForValidMessages: false
needTechnicalAcknowledgement: true
rolloverAcknowledgementControlNumber: true
sendSynchronousAcknowledgement: true
envelopeSettings:
applicationReferenceId: '0'
applyDelimiterStringAdvice: true
communicationAgreementId: '0'
createGroupingSegments: true
enableDefaultGroupHeaders: true
functionalGroupId: '0'
groupApplicationPassword: '0'
groupApplicationReceiverId: '0'
groupApplicationReceiverQualifier: ZZZ
groupApplicationSenderId: AAA
groupApplicationSenderQualifier: ZZZ
groupAssociationAssignedCode: '0'
groupControlNumberLowerBound: 1
groupControlNumberPrefix: CU
groupControlNumberSuffix: NUM
groupControlNumberUpperBound: 99999999
groupControllingAgencyCode: '0'
groupMessageRelease: '0.0'
groupMessageVersion: '0.0'
interchangeControlNumberLowerBound: 1
interchangeControlNumberPrefix: CU
interchangeControlNumberSuffix: NUM
interchangeControlNumberUpperBound: 99999999
isTestInterchange: true
overwriteExistingTransactionSetControlNumber: true
processingPriorityCode: '0'
receiverInternalIdentification: '0'
receiverInternalSubIdentification: '0'
recipientReferencePasswordQualifier: ZZ
recipientReferencePasswordValue: AA
rolloverGroupControlNumber: true
rolloverInterchangeControlNumber: true
rolloverTransactionSetControlNumber: true
senderInternalIdentification: AA
senderInternalSubIdentification: AA
transactionSetControlNumberLowerBound: 1
transactionSetControlNumberPrefix: ''
transactionSetControlNumberSuffix: ''
transactionSetControlNumberUpperBound: 99999999
framingSettings:
characterEncoding: UTF
characterSet: UNOC
componentSeparator: 58
dataElementSeparator: 53
decimalPointIndicator: Comma
protocolVersion: 4
releaseIndicator: 63
repetitionSeparator: 42
segmentTerminator: 39
segmentTerminatorSuffix: None
messageFilter:
messageFilterType: Exclude
processingSettings:
createEmptyXmlTagsForTrailingSeparators: true
maskSecurityInfo: true
preserveInterchange: true
suspendInterchangeOnError: true
useDotAsDecimalSeparator: true
schemaReferences: []
validationSettings:
allowLeadingAndTrailingSpacesAndZeroes: true
checkDuplicateGroupControlNumber: true
checkDuplicateInterchangeControlNumber: true
checkDuplicateTransactionSetControlNumber: true
interchangeControlNumberValidityDays: 30
trailingSeparatorPolicy: Optional
trimLeadingAndTrailingSpacesAndZeroes: true
validateCharacterSet: true
validateEDITypes: true
validateXSDTypes: true
receiverBusinessIdentity:
qualifier: ZZ
value: ZZ
senderBusinessIdentity:
qualifier: AA
value: AA
sendAgreement:
protocolSettings:
acknowledgementSettings:
acknowledgementControlNumberLowerBound: 1
acknowledgementControlNumberPrefix: CN
acknowledgementControlNumberSuffix: NUM
acknowledgementControlNumberUpperBound: 999999999
batchFunctionalAcknowledgements: true
batchTechnicalAcknowledgements: true
needFunctionalAcknowledgement: true
needLoopForValidMessages: true
needTechnicalAcknowledgement: true
rolloverAcknowledgementControlNumber: true
sendSynchronousAcknowledgement: true
envelopeSettings:
applicationReferenceId: '0'
applyDelimiterStringAdvice: true
communicationAgreementId: '0'
createGroupingSegments: true
enableDefaultGroupHeaders: true
functionalGroupId: '0'
groupApplicationPassword: '0'
groupApplicationReceiverId: '0'
groupApplicationReceiverQualifier: ZZ
groupApplicationSenderId: AA
groupApplicationSenderQualifier: ZZ
groupAssociationAssignedCode: '0'
groupControlNumberLowerBound: 1
groupControlNumberPrefix: ''
groupControlNumberSuffix: ''
groupControlNumberUpperBound: 999999999
groupControllingAgencyCode: '0'
groupMessageRelease: '0.0'
groupMessageVersion: '0.0'
interchangeControlNumberLowerBound: 1
interchangeControlNumberPrefix: CU
interchangeControlNumberSuffix: NUM
interchangeControlNumberUpperBound: 999999999
isTestInterchange: true
overwriteExistingTransactionSetControlNumber: true
processingPriorityCode: '0'
receiverInternalIdentification: '0'
receiverInternalSubIdentification: '0'
recipientReferencePasswordQualifier: ZZ
recipientReferencePasswordValue: AA
rolloverGroupControlNumber: true
rolloverInterchangeControlNumber: true
rolloverTransactionSetControlNumber: true
senderInternalIdentification: AA
senderInternalSubIdentification: AA
transactionSetControlNumberLowerBound: 1
transactionSetControlNumberPrefix: ''
transactionSetControlNumberSuffix: ''
transactionSetControlNumberUpperBound: 999999999
framingSettings:
characterEncoding: UTF
characterSet: UNOC
componentSeparator: 58
dataElementSeparator: 53
decimalPointIndicator: Comma
protocolVersion: 4
releaseIndicator: 63
repetitionSeparator: 42
segmentTerminator: 39
segmentTerminatorSuffix: None
messageFilter:
messageFilterType: Exclude
processingSettings:
createEmptyXmlTagsForTrailingSeparators: true
maskSecurityInfo: true
preserveInterchange: true
suspendInterchangeOnError: true
useDotAsDecimalSeparator: true
schemaReferences: []
validationSettings:
allowLeadingAndTrailingSpacesAndZeroes: true
checkDuplicateGroupControlNumber: true
checkDuplicateInterchangeControlNumber: true
checkDuplicateTransactionSetControlNumber: true
interchangeControlNumberValidityDays: 30
trailingSeparatorPolicy: Optional
trimLeadingAndTrailingSpacesAndZeroes: true
validateCharacterSet: true
validateEDITypes: true
validateXSDTypes: true
receiverBusinessIdentity:
qualifier: ZZ
value: ZZ
senderBusinessIdentity:
qualifier: AA
value: AA
createdTime: '2017-03-06T22:00:53.8205121Z'
guestIdentity:
qualifier: AA
value: AA
guestPartner: GuestPartner
hostIdentity:
qualifier: ZZ
value: ZZ
hostPartner: HostPartner
metadata: {}
type: Microsoft.Logic/integrationAccounts/agreements
x-ms-odata: '#/definitions/IntegrationAccountAgreementFilter'
x-ms-pageable:
nextLinkName: nextLink
summary: Azure Logic Apps Integration Account Agreements_ List
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/agreements/{agreementName}
: delete:
description: Deletes an integration account agreement.
operationId: IntegrationAccountAgreements_Delete
parameters:
- $ref: '#/parameters/subscriptionId'
- description: The resource group name.
in: path
name: resourceGroupName
required: true
typ
# --- truncated at 32 KB (126 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/azure-logic-apps/refs/heads/main/openapi/azure-logic-apps-integrationaccountagreements-api-openapi.yml