Microsoft.Logic integrationAccounts/agreements 2015-08-01-preview

The integrationAccounts/agreements resource type can be deployed to: Resource groups.

To learn about resource group deployments, see Bicep or ARM template.

Template format

To create a Microsoft.Logic/integrationAccounts/agreements resource, add the following Bicep or JSON to your template.

resource symbolicname 'Microsoft.Logic/integrationAccounts/agreements@2015-08-01-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  properties: {
    agreementType: 'string'
    content: {
      AS2: {
        receiveAgreement: {
          protocolSettings: {
            acknowledgementConnectionSettings: {
              ignoreCertificateNameMismatch: bool
              keepHttpConnectionAlive: bool
              supportHttpStatusCodeContinue: bool
              unfoldHttpHeaders: bool
            }
            envelopeSettings: {
              AutogenerateFileName: bool
              fileNameTemplate: 'string'
              messageContentType: 'string'
              SuspendMessageOnFileNameGenerationError: bool
              transmitFileNameInMimeHeader: bool
            }
            errorSettings: {
              ResendIfMdnNotReceived: bool
              SuspendDuplicateMessage: bool
            }
            mdnSettings: {
              dispositionNotificationTo: 'string'
              mdnText: 'string'
              micHashingAlgorithm: 'string'
              needMdn: bool
              receiptDeliveryUrl: 'string'
              sendInboundMdnToMessageBox: bool
              sendMdnAsynchronously: bool
              signMdn: bool
              signOutboundMdnIfOptional: bool
            }
            messageConnectionSettings: {
              ignoreCertificateNameMismatch: bool
              keepHttpConnectionAlive: bool
              supportHttpStatusCodeContinue: bool
              unfoldHttpHeaders: bool
            }
            securitySettings: {
              enableNrrForInboundDecodedMessages: bool
              enableNrrForInboundEncodedMessages: bool
              enableNrrForInboundMdn: bool
              enableNrrForOutboundDecodedMessages: bool
              enableNrrForOutboundEncodedMessages: bool
              enableNrrForOutboundMdn: bool
              encryptionCertificateName: 'string'
              overrideGroupSigningCertificate: bool
              signingCertificateName: 'string'
            }
            validationSettings: {
              checkCertificateRevocationListOnReceive: bool
              checkCertificateRevocationListOnSend: bool
              checkDuplicateMessage: bool
              compressMessage: bool
              encryptionAlgorithm: 'string'
              encryptMessage: bool
              interchangeDuplicatesValidityDays: int
              overrideMessageProperties: bool
              signMessage: bool
            }
          }
          receiverBusinessIdentity: {
            Qualifier: 'string'
            Value: 'string'
          }
          senderBusinessIdentity: {
            Qualifier: 'string'
            Value: 'string'
          }
        }
        sendAgreement: {
          protocolSettings: {
            acknowledgementConnectionSettings: {
              ignoreCertificateNameMismatch: bool
              keepHttpConnectionAlive: bool
              supportHttpStatusCodeContinue: bool
              unfoldHttpHeaders: bool
            }
            envelopeSettings: {
              AutogenerateFileName: bool
              fileNameTemplate: 'string'
              messageContentType: 'string'
              SuspendMessageOnFileNameGenerationError: bool
              transmitFileNameInMimeHeader: bool
            }
            errorSettings: {
              ResendIfMdnNotReceived: bool
              SuspendDuplicateMessage: bool
            }
            mdnSettings: {
              dispositionNotificationTo: 'string'
              mdnText: 'string'
              micHashingAlgorithm: 'string'
              needMdn: bool
              receiptDeliveryUrl: 'string'
              sendInboundMdnToMessageBox: bool
              sendMdnAsynchronously: bool
              signMdn: bool
              signOutboundMdnIfOptional: bool
            }
            messageConnectionSettings: {
              ignoreCertificateNameMismatch: bool
              keepHttpConnectionAlive: bool
              supportHttpStatusCodeContinue: bool
              unfoldHttpHeaders: bool
            }
            securitySettings: {
              enableNrrForInboundDecodedMessages: bool
              enableNrrForInboundEncodedMessages: bool
              enableNrrForInboundMdn: bool
              enableNrrForOutboundDecodedMessages: bool
              enableNrrForOutboundEncodedMessages: bool
              enableNrrForOutboundMdn: bool
              encryptionCertificateName: 'string'
              overrideGroupSigningCertificate: bool
              signingCertificateName: 'string'
            }
            validationSettings: {
              checkCertificateRevocationListOnReceive: bool
              checkCertificateRevocationListOnSend: bool
              checkDuplicateMessage: bool
              compressMessage: bool
              encryptionAlgorithm: 'string'
              encryptMessage: bool
              interchangeDuplicatesValidityDays: int
              overrideMessageProperties: bool
              signMessage: bool
            }
          }
          receiverBusinessIdentity: {
            Qualifier: 'string'
            Value: 'string'
          }
          senderBusinessIdentity: {
            Qualifier: 'string'
            Value: 'string'
          }
        }
      }
      Edifact: {
        receiveAgreement: {
          protocolSettings: {
            acknowledgementSettings: {
              acknowledgementControlNumberLowerBound: int
              acknowledgementControlNumberPrefix: 'string'
              acknowledgementControlNumberSuffix: 'string'
              acknowledgementControlNumberUpperBound: int
              batchFunctionalAcknowledgements: bool
              batchTechnicalAcknowledgements: bool
              needFunctionalAcknowledgement: bool
              needLoopForValidMessages: bool
              needTechnicalAcknowledgement: bool
              rolloverAcknowledgementControlNumber: bool
              sendSynchronousAcknowledgement: bool
            }
            edifactDelimiterOverrides: [
              {
                componentSeparator: int
                dataElementSeparator: int
                decimalPointIndicator: 'string'
                messageAssociationAssignedCode: 'string'
                messageId: 'string'
                messageRelease: 'string'
                messageVersion: 'string'
                releaseIndicator: int
                repetitionSeparator: int
                segmentTerminator: int
                segmentTerminatorSuffix: 'string'
                targetNamespace: 'string'
              }
            ]
            envelopeOverrides: [
              {
                applicationPassword: 'string'
                associationAssignedCode: 'string'
                controllingAgencyCode: 'string'
                functionalGroupId: 'string'
                groupHeaderMessageRelease: 'string'
                groupHeaderMessageVersion: 'string'
                messageAssociationAssignedCode: 'string'
                messageId: 'string'
                messageRelease: 'string'
                messageVersion: 'string'
                receiverApplicationId: 'string'
                receiverApplicationQualifier: 'string'
                senderApplicationId: 'string'
                senderApplicationQualifier: 'string'
                targetNamespace: 'string'
              }
            ]
            envelopeSettings: {
              applicationReferenceId: 'string'
              applyDelimiterStringAdvice: bool
              communicationAgreementId: 'string'
              createGroupingSegments: bool
              enableDefaultGroupHeaders: bool
              functionalGroupId: 'string'
              groupApplicationPassword: 'string'
              groupApplicationReceiverId: 'string'
              groupApplicationReceiverQualifier: 'string'
              groupApplicationSenderId: 'string'
              groupApplicationSenderQualifier: 'string'
              groupAssociationAssignedCode: 'string'
              groupControllingAgencyCode: 'string'
              groupControlNumberLowerBound: int
              groupControlNumberPrefix: 'string'
              groupControlNumberSuffix: 'string'
              groupControlNumberUpperBound: int
              groupMessageRelease: 'string'
              groupMessageVersion: 'string'
              interchangeControlNumberLowerBound: int
              interchangeControlNumberPrefix: 'string'
              interchangeControlNumberSuffix: 'string'
              interchangeControlNumberUpperBound: int
              isTestInterchange: bool
              overwriteExistingTransactionSetControlNumber: bool
              processingPriorityCode: 'string'
              receiverInternalIdentification: 'string'
              receiverInternalSubIdentification: 'string'
              receiverReverseRoutingAddress: 'string'
              recipientReferencePasswordQualifier: 'string'
              recipientReferencePasswordValue: 'string'
              rolloverGroupControlNumber: bool
              rolloverInterchangeControlNumber: bool
              rolloverTransactionSetControlNumber: bool
              senderInternalIdentification: 'string'
              senderInternalSubIdentification: 'string'
              senderReverseRoutingAddress: 'string'
              transactionSetControlNumberLowerBound: int
              transactionSetControlNumberPrefix: 'string'
              transactionSetControlNumberSuffix: 'string'
              transactionSetControlNumberUpperBound: int
            }
            framingSettings: {
              characterEncoding: 'string'
              characterSet: 'string'
              componentSeparator: int
              dataElementSeparator: int
              decimalPointIndicator: 'string'
              protocolVersion: int
              releaseIndicator: int
              repetitionSeparator: int
              segmentTerminator: int
              segmentTerminatorSuffix: 'string'
              serviceCodeListDirectoryVersion: 'string'
            }
            messageFilter: {
              messageFilterType: 'string'
            }
            messageFilterList: [
              {
                messageId: 'string'
              }
            ]
            processingSettings: {
              createEmptyXmlTagsForTrailingSeparators: bool
              maskSecurityInfo: bool
              preserveInterchange: bool
              suspendInterchangeOnError: bool
              useDotAsDecimalSeparator: bool
            }
            schemaReferences: [
              {
                associationAssignedCode: 'string'
                messageId: 'string'
                messageRelease: 'string'
                messageVersion: 'string'
                schemaName: 'string'
                senderApplicationId: 'string'
                senderApplicationQualifier: 'string'
              }
            ]
            validationOverrides: [
              {
                allowLeadingAndTrailingSpacesAndZeroes: bool
                enforceCharacterSet: bool
                messageId: 'string'
                trailingSeparatorPolicy: 'string'
                trimLeadingAndTrailingSpacesAndZeroes: bool
                validateEDITypes: bool
                validateXSDTypes: bool
              }
            ]
            validationSettings: {
              allowLeadingAndTrailingSpacesAndZeroes: bool
              checkDuplicateGroupControlNumber: bool
              checkDuplicateInterchangeControlNumber: bool
              checkDuplicateTransactionSetControlNumber: bool
              interchangeControlNumberValidityDays: int
              trailingSeparatorPolicy: 'string'
              trimLeadingAndTrailingSpacesAndZeroes: bool
              validateCharacterSet: bool
              validateEDITypes: bool
              validateXSDTypes: bool
            }
          }
          receiverBusinessIdentity: {
            Qualifier: 'string'
            Value: 'string'
          }
          senderBusinessIdentity: {
            Qualifier: 'string'
            Value: 'string'
          }
        }
        sendAgreement: {
          protocolSettings: {
            acknowledgementSettings: {
              acknowledgementControlNumberLowerBound: int
              acknowledgementControlNumberPrefix: 'string'
              acknowledgementControlNumberSuffix: 'string'
              acknowledgementControlNumberUpperBound: int
              batchFunctionalAcknowledgements: bool
              batchTechnicalAcknowledgements: bool
              needFunctionalAcknowledgement: bool
              needLoopForValidMessages: bool
              needTechnicalAcknowledgement: bool
              rolloverAcknowledgementControlNumber: bool
              sendSynchronousAcknowledgement: bool
            }
            edifactDelimiterOverrides: [
              {
                componentSeparator: int
                dataElementSeparator: int
                decimalPointIndicator: 'string'
                messageAssociationAssignedCode: 'string'
                messageId: 'string'
                messageRelease: 'string'
                messageVersion: 'string'
                releaseIndicator: int
                repetitionSeparator: int
                segmentTerminator: int
                segmentTerminatorSuffix: 'string'
                targetNamespace: 'string'
              }
            ]
            envelopeOverrides: [
              {
                applicationPassword: 'string'
                associationAssignedCode: 'string'
                controllingAgencyCode: 'string'
                functionalGroupId: 'string'
                groupHeaderMessageRelease: 'string'
                groupHeaderMessageVersion: 'string'
                messageAssociationAssignedCode: 'string'
                messageId: 'string'
                messageRelease: 'string'
                messageVersion: 'string'
                receiverApplicationId: 'string'
                receiverApplicationQualifier: 'string'
                senderApplicationId: 'string'
                senderApplicationQualifier: 'string'
                targetNamespace: 'string'
              }
            ]
            envelopeSettings: {
              applicationReferenceId: 'string'
              applyDelimiterStringAdvice: bool
              communicationAgreementId: 'string'
              createGroupingSegments: bool
              enableDefaultGroupHeaders: bool
              functionalGroupId: 'string'
              groupApplicationPassword: 'string'
              groupApplicationReceiverId: 'string'
              groupApplicationReceiverQualifier: 'string'
              groupApplicationSenderId: 'string'
              groupApplicationSenderQualifier: 'string'
              groupAssociationAssignedCode: 'string'
              groupControllingAgencyCode: 'string'
              groupControlNumberLowerBound: int
              groupControlNumberPrefix: 'string'
              groupControlNumberSuffix: 'string'
              groupControlNumberUpperBound: int
              groupMessageRelease: 'string'
              groupMessageVersion: 'string'
              interchangeControlNumberLowerBound: int
              interchangeControlNumberPrefix: 'string'
              interchangeControlNumberSuffix: 'string'
              interchangeControlNumberUpperBound: int
              isTestInterchange: bool
              overwriteExistingTransactionSetControlNumber: bool
              processingPriorityCode: 'string'
              receiverInternalIdentification: 'string'
              receiverInternalSubIdentification: 'string'
              receiverReverseRoutingAddress: 'string'
              recipientReferencePasswordQualifier: 'string'
              recipientReferencePasswordValue: 'string'
              rolloverGroupControlNumber: bool
              rolloverInterchangeControlNumber: bool
              rolloverTransactionSetControlNumber: bool
              senderInternalIdentification: 'string'
              senderInternalSubIdentification: 'string'
              senderReverseRoutingAddress: 'string'
              transactionSetControlNumberLowerBound: int
              transactionSetControlNumberPrefix: 'string'
              transactionSetControlNumberSuffix: 'string'
              transactionSetControlNumberUpperBound: int
            }
            framingSettings: {
              characterEncoding: 'string'
              characterSet: 'string'
              componentSeparator: int
              dataElementSeparator: int
              decimalPointIndicator: 'string'
              protocolVersion: int
              releaseIndicator: int
              repetitionSeparator: int
              segmentTerminator: int
              segmentTerminatorSuffix: 'string'
              serviceCodeListDirectoryVersion: 'string'
            }
            messageFilter: {
              messageFilterType: 'string'
            }
            messageFilterList: [
              {
                messageId: 'string'
              }
            ]
            processingSettings: {
              createEmptyXmlTagsForTrailingSeparators: bool
              maskSecurityInfo: bool
              preserveInterchange: bool
              suspendInterchangeOnError: bool
              useDotAsDecimalSeparator: bool
            }
            schemaReferences: [
              {
                associationAssignedCode: 'string'
                messageId: 'string'
                messageRelease: 'string'
                messageVersion: 'string'
                schemaName: 'string'
                senderApplicationId: 'string'
                senderApplicationQualifier: 'string'
              }
            ]
            validationOverrides: [
              {
                allowLeadingAndTrailingSpacesAndZeroes: bool
                enforceCharacterSet: bool
                messageId: 'string'
                trailingSeparatorPolicy: 'string'
                trimLeadingAndTrailingSpacesAndZeroes: bool
                validateEDITypes: bool
                validateXSDTypes: bool
              }
            ]
            validationSettings: {
              allowLeadingAndTrailingSpacesAndZeroes: bool
              checkDuplicateGroupControlNumber: bool
              checkDuplicateInterchangeControlNumber: bool
              checkDuplicateTransactionSetControlNumber: bool
              interchangeControlNumberValidityDays: int
              trailingSeparatorPolicy: 'string'
              trimLeadingAndTrailingSpacesAndZeroes: bool
              validateCharacterSet: bool
              validateEDITypes: bool
              validateXSDTypes: bool
            }
          }
          receiverBusinessIdentity: {
            Qualifier: 'string'
            Value: 'string'
          }
          senderBusinessIdentity: {
            Qualifier: 'string'
            Value: 'string'
          }
        }
      }
      X12: {
        receiveAgreement: {
          protocolSettings: {
            acknowledgementSettings: {
              acknowledgementControlNumberLowerBound: int
              acknowledgementControlNumberPrefix: 'string'
              acknowledgementControlNumberSuffix: 'string'
              acknowledgementControlNumberUpperBound: int
              batchFunctionalAcknowledgements: bool
              batchImplementationAcknowledgements: bool
              batchTechnicalAcknowledgements: bool
              functionalAcknowledgementVersion: 'string'
              implementationAcknowledgementVersion: 'string'
              needFunctionalAcknowledgement: bool
              needImplementationAcknowledgement: bool
              needLoopForValidMessages: bool
              needTechnicalAcknowledgement: bool
              rolloverAcknowledgementControlNumber: bool
              sendSynchronousAcknowledgement: bool
            }
            envelopeOverrides: [
              {
                dateFormat: 'string'
                functionalIdentifierCode: 'string'
                headerVersion: 'string'
                messageId: 'string'
                protocolVersion: 'string'
                receiverApplicationId: 'string'
                responsibleAgencyCode: int
                senderApplicationId: 'string'
                targetNamespace: 'string'
                timeFormat: 'string'
              }
            ]
            envelopeSettings: {
              controlStandardsId: int
              controlVersionNumber: 'string'
              enableDefaultGroupHeaders: bool
              functionalGroupId: 'string'
              groupControlNumberLowerBound: int
              groupControlNumberUpperBound: int
              groupHeaderAgencyCode: 'string'
              groupHeaderDateFormat: 'string'
              groupHeaderTimeFormat: 'string'
              groupHeaderVersion: 'string'
              interchangeControlNumberLowerBound: int
              interchangeControlNumberUpperBound: int
              overwriteExistingTransactionSetControlNumber: bool
              receiverApplicationId: 'string'
              rolloverGroupControlNumber: bool
              rolloverInterchangeControlNumber: bool
              rolloverTransactionSetControlNumber: bool
              senderApplicationId: 'string'
              transactionSetControlNumberLowerBound: int
              transactionSetControlNumberPrefix: 'string'
              transactionSetControlNumberSuffix: 'string'
              transactionSetControlNumberUpperBound: int
              usageIndicator: 'string'
              useControlStandardsIdAsRepetitionCharacter: bool
            }
            framingSettings: {
              characterSet: 'string'
              componentSeparator: int
              dataElementSeparator: int
              replaceCharacter: int
              replaceSeparatorsInPayload: bool
              segmentTerminator: int
              segmentTerminatorSuffix: 'string'
            }
            messageFilter: {
              messageFilterType: 'string'
            }
            messageFilterList: [
              {
                messageId: 'string'
              }
            ]
            processingSettings: {
              convertImpliedDecimal: bool
              createEmptyXmlTagsForTrailingSeparators: bool
              maskSecurityInfo: bool
              preserveInterchange: bool
              suspendInterchangeOnError: bool
              useDotAsDecimalSeparator: bool
            }
            schemaReferences: [
              {
                messageId: 'string'
                schemaName: 'string'
                schemaVersion: 'string'
                senderApplicationId: 'string'
              }
            ]
            securitySettings: {
              authorizationQualifier: 'string'
              authorizationValue: 'string'
              passwordValue: 'string'
              securityQualifier: 'string'
            }
            validationOverrides: [
              {
                allowLeadingAndTrailingSpacesAndZeroes: bool
                messageId: 'string'
                trailingSeparatorPolicy: 'string'
                trimLeadingAndTrailingSpacesAndZeroes: bool
                validateCharacterSet: bool
                validateEDITypes: bool
                validateXSDTypes: bool
              }
            ]
            validationSettings: {
              allowLeadingAndTrailingSpacesAndZeroes: bool
              checkDuplicateGroupControlNumber: bool
              checkDuplicateInterchangeControlNumber: bool
              checkDuplicateTransactionSetControlNumber: bool
              interchangeControlNumberValidityDays: int
              trailingSeparatorPolicy: 'string'
              trimLeadingAndTrailingSpacesAndZeroes: bool
              validateCharacterSet: bool
              validateEDITypes: bool
              validateXSDTypes: bool
            }
            x12DelimiterOverrides: [
              {
                componentSeparator: int
                dataElementSeparator: int
                messageId: 'string'
                protocolVersion: 'string'
                replaceCharacter: int
                replaceSeparatorsInPayload: bool
                segmentTerminator: int
                segmentTerminatorSuffix: 'string'
                targetNamespace: 'string'
              }
            ]
          }
          receiverBusinessIdentity: {
            Qualifier: 'string'
            Value: 'string'
          }
          senderBusinessIdentity: {
            Qualifier: 'string'
            Value: 'string'
          }
        }
        sendAgreement: {
          protocolSettings: {
            acknowledgementSettings: {
              acknowledgementControlNumberLowerBound: int
              acknowledgementControlNumberPrefix: 'string'
              acknowledgementControlNumberSuffix: 'string'
              acknowledgementControlNumberUpperBound: int
              batchFunctionalAcknowledgements: bool
              batchImplementationAcknowledgements: bool
              batchTechnicalAcknowledgements: bool
              functionalAcknowledgementVersion: 'string'
              implementationAcknowledgementVersion: 'string'
              needFunctionalAcknowledgement: bool
              needImplementationAcknowledgement: bool
              needLoopForValidMessages: bool
              needTechnicalAcknowledgement: bool
              rolloverAcknowledgementControlNumber: bool
              sendSynchronousAcknowledgement: bool
            }
            envelopeOverrides: [
              {
                dateFormat: 'string'
                functionalIdentifierCode: 'string'
                headerVersion: 'string'
                messageId: 'string'
                protocolVersion: 'string'
                receiverApplicationId: 'string'
                responsibleAgencyCode: int
                senderApplicationId: 'string'
                targetNamespace: 'string'
                timeFormat: 'string'
              }
            ]
            envelopeSettings: {
              controlStandardsId: int
              controlVersionNumber: 'string'
              enableDefaultGroupHeaders: bool
              functionalGroupId: 'string'
              groupControlNumberLowerBound: int
              groupControlNumberUpperBound: int
              groupHeaderAgencyCode: 'string'
              groupHeaderDateFormat: 'string'
              groupHeaderTimeFormat: 'string'
              groupHeaderVersion: 'string'
              interchangeControlNumberLowerBound: int
              interchangeControlNumberUpperBound: int
              overwriteExistingTransactionSetControlNumber: bool
              receiverApplicationId: 'string'
              rolloverGroupControlNumber: bool
              rolloverInterchangeControlNumber: bool
              rolloverTransactionSetControlNumber: bool
              senderApplicationId: 'string'
              transactionSetControlNumberLowerBound: int
              transactionSetControlNumberPrefix: 'string'
              transactionSetControlNumberSuffix: 'string'
              transactionSetControlNumberUpperBound: int
              usageIndicator: 'string'
              useControlStandardsIdAsRepetitionCharacter: bool
            }
            framingSettings: {
              characterSet: 'string'
              componentSeparator: int
              dataElementSeparator: int
              replaceCharacter: int
              replaceSeparatorsInPayload: bool
              segmentTerminator: int
              segmentTerminatorSuffix: 'string'
            }
            messageFilter: {
              messageFilterType: 'string'
            }
            messageFilterList: [
              {
                messageId: 'string'
              }
            ]
            processingSettings: {
              convertImpliedDecimal: bool
              createEmptyXmlTagsForTrailingSeparators: bool
              maskSecurityInfo: bool
              preserveInterchange: bool
              suspendInterchangeOnError: bool
              useDotAsDecimalSeparator: bool
            }
            schemaReferences: [
              {
                messageId: 'string'
                schemaName: 'string'
                schemaVersion: 'string'
                senderApplicationId: 'string'
              }
            ]
            securitySettings: {
              authorizationQualifier: 'string'
              authorizationValue: 'string'
              passwordValue: 'string'
              securityQualifier: 'string'
            }
            validationOverrides: [
              {
                allowLeadingAndTrailingSpacesAndZeroes: bool
                messageId: 'string'
                trailingSeparatorPolicy: 'string'
                trimLeadingAndTrailingSpacesAndZeroes: bool
                validateCharacterSet: bool
                validateEDITypes: bool
                validateXSDTypes: bool
              }
            ]
            validationSettings: {
              allowLeadingAndTrailingSpacesAndZeroes: bool
              checkDuplicateGroupControlNumber: bool
              checkDuplicateInterchangeControlNumber: bool
              checkDuplicateTransactionSetControlNumber: bool
              interchangeControlNumberValidityDays: int
              trailingSeparatorPolicy: 'string'
              trimLeadingAndTrailingSpacesAndZeroes: bool
              validateCharacterSet: bool
              validateEDITypes: bool
              validateXSDTypes: bool
            }
            x12DelimiterOverrides: [
              {
                componentSeparator: int
                dataElementSeparator: int
                messageId: 'string'
                protocolVersion: 'string'
                replaceCharacter: int
                replaceSeparatorsInPayload: bool
                segmentTerminator: int
                segmentTerminatorSuffix: 'string'
                targetNamespace: 'string'
              }
            ]
          }
          receiverBusinessIdentity: {
            Qualifier: 'string'
            Value: 'string'
          }
          senderBusinessIdentity: {
            Qualifier: 'string'
            Value: 'string'
          }
        }
      }
    }
    guestIdentity: {
      Qualifier: 'string'
      Value: 'string'
    }
    guestPartner: 'string'
    hostIdentity: {
      Qualifier: 'string'
      Value: 'string'
    }
    hostPartner: 'string'
    metadata: any()
  }
}

Property values

integrationAccounts/agreements

Name Description Value
type The resource type

For Bicep, set this value in the resource declaration.
'Microsoft.Logic/integrationAccounts/agreements'
apiVersion The resource api version

For Bicep, set this value in the resource declaration.
'2015-08-01-preview'
name The resource name

See how to set names and types for child resources in Bicep or JSON ARM templates.
string (required)
location The resource location. string
tags The resource tags. Dictionary of tag names and values. See Tags in templates
properties IntegrationAccountAgreementProperties

IntegrationAccountAgreementProperties

Name Description Value
agreementType 'AS2'
'Edifact'
'NotSpecified'
'X12'
content AgreementContent
guestIdentity BusinessIdentity
guestPartner The guest partner. string
hostIdentity BusinessIdentity
hostPartner The host partner. string
metadata Any object For Bicep, you can use the any() function.

AgreementContent

Name Description Value
AS2 AS2AgreementContent
Edifact EdifactAgreementContent
X12 X12AgreementContent

AS2AgreementContent

Name Description Value
receiveAgreement AS2OneWayAgreement
sendAgreement AS2OneWayAgreement

AS2OneWayAgreement

Name Description Value
protocolSettings AS2ProtocolSettings
receiverBusinessIdentity BusinessIdentity
senderBusinessIdentity BusinessIdentity

AS2ProtocolSettings

Name Description Value
acknowledgementConnectionSettings AS2AcknowledgementConnectionSettings
envelopeSettings AS2EnvelopeSettings
errorSettings AS2ErrorSettings
mdnSettings AS2MdnSettings
messageConnectionSettings AS2MessageConnectionSettings
securitySettings AS2SecuritySettings
validationSettings AS2ValidationSettings

AS2AcknowledgementConnectionSettings

Name Description Value
ignoreCertificateNameMismatch The value indicating whether to ignore mismatch in certificate name. bool
keepHttpConnectionAlive The value indicating whether to keep the connection alive. bool
supportHttpStatusCodeContinue The value indicating whether to support HTTP status code 'CONTINUE'. bool
unfoldHttpHeaders The value indicating whether to unfold the HTTP headers. bool

AS2EnvelopeSettings

Name Description Value
AutogenerateFileName The value indicating whether to auto generate file name. bool
fileNameTemplate The template for file name. string
messageContentType The message content type. string
SuspendMessageOnFileNameGenerationError The value indicating whether to suspend message on file name generation error. bool
transmitFileNameInMimeHeader The value indicating whether to transmit file name in mime header. bool

AS2ErrorSettings

Name Description Value
ResendIfMdnNotReceived The value indicating whether to resend message If MDN is not received. bool
SuspendDuplicateMessage The value indicating whether to suspend duplicate message. bool

AS2MdnSettings

Name Description Value
dispositionNotificationTo The disposition notification to header value. string
mdnText The MDN text. string
micHashingAlgorithm 'None'
'NotSpecified'
'SHA2256'
'SHA2384'
'SHA2512'
needMdn The value indicating whether to send or request a MDN. bool
receiptDeliveryUrl The receipt delivery URL. string
sendInboundMdnToMessageBox The value indicating whether to send inbound MDN to message box. bool
sendMdnAsynchronously The value indicating whether to send the asynchronous MDN. bool
signMdn The value indicating whether the MDN needs to be signed or not. bool
signOutboundMdnIfOptional The value indicating whether to sign the outbound MDN if optional. bool

AS2MessageConnectionSettings

Name Description Value
ignoreCertificateNameMismatch The value indicating whether to ignore mismatch in certificate name. bool
keepHttpConnectionAlive The value indicating whether to keep the connection alive. bool
supportHttpStatusCodeContinue The value indicating whether to support HTTP status code 'CONTINUE'. bool
unfoldHttpHeaders The value indicating whether to unfold the HTTP headers. bool

AS2SecuritySettings

Name Description Value
enableNrrForInboundDecodedMessages The value indicating whether to enable NRR for inbound decoded messages. bool
enableNrrForInboundEncodedMessages The value indicating whether to enable NRR for inbound encoded messages. bool
enableNrrForInboundMdn The value indicating whether to enable NRR for inbound MDN. bool
enableNrrForOutboundDecodedMessages The value indicating whether to enable NRR for outbound decoded messages. bool
enableNrrForOutboundEncodedMessages The value indicating whether to enable NRR for outbound encoded messages. bool
enableNrrForOutboundMdn The value indicating whether to enable NRR for outbound MDN. bool
encryptionCertificateName The name of the encryption certificate. string
overrideGroupSigningCertificate The value indicating whether to send or request a MDN. bool
signingCertificateName The name of the signing certificate. string

AS2ValidationSettings

Name Description Value
checkCertificateRevocationListOnReceive The value indicating whether to check for certificate revocation list on receive. bool
checkCertificateRevocationListOnSend The value indicating whether to check for certificate revocation list on send. bool
checkDuplicateMessage The value indicating whether to check for duplicate message. bool
compressMessage The value indicating whether the message has to be compressed. bool
encryptionAlgorithm 'AES128'
'AES192'
'AES256'
'DES3'
'None'
'NotSpecified'
'RC2'
encryptMessage The value indicating whether the message has to be encrypted. bool
interchangeDuplicatesValidityDays The number of days to look back for duplicate interchange. int
overrideMessageProperties The value indicating whether to override incoming message properties with those in agreement. bool
signMessage The value indicating whether the message has to be signed. bool

BusinessIdentity

Name Description Value
Qualifier The business identity qualifier. string
Value The business identity value. string

EdifactAgreementContent

Name Description Value
receiveAgreement EdifactOneWayAgreement
sendAgreement EdifactOneWayAgreement

EdifactOneWayAgreement

Name Description Value
protocolSettings EdifactProtocolSettings
receiverBusinessIdentity BusinessIdentity
senderBusinessIdentity BusinessIdentity

EdifactProtocolSettings

Name Description Value
acknowledgementSettings EdifactAcknowledgementSettings
edifactDelimiterOverrides The EDIFACT delimiter override settings. EdifactDelimiterOverride[]
envelopeOverrides The EDIFACT envelope override settings. EdifactEnvelopeOverride[]
envelopeSettings EdifactEnvelopeSettings
framingSettings EdifactFramingSettings
messageFilter EdifactMessageFilter
messageFilterList The EDIFACT message filter list. EdifactMessageIdentifier[]
processingSettings EdifactProcessingSettings
schemaReferences The EDIFACT schema references. EdifactSchemaReference[]
validationOverrides The EDIFACT validation override settings. EdifactValidationOverride[]
validationSettings EdifactValidationSettings

EdifactAcknowledgementSettings

Name Description Value
acknowledgementControlNumberLowerBound The acknowledgement control number lower bound. int
acknowledgementControlNumberPrefix The acknowledgement control number prefix. string
acknowledgementControlNumberSuffix The acknowledgement control number suffix. string
acknowledgementControlNumberUpperBound The acknowledgement control number upper bound. int
batchFunctionalAcknowledgements The value indicating whether to batch functional acknowledgements. bool
batchTechnicalAcknowledgements The value indicating whether to batch the technical acknowledgements. bool
needFunctionalAcknowledgement The value indicating whether functional acknowledgement is needed. bool
needLoopForValidMessages The value indicating whether a loop is needed for valid messages. bool
needTechnicalAcknowledgement The value indicating whether technical acknowledgement is needed. bool
rolloverAcknowledgementControlNumber The value indicating whether to rollover acknowledgement control number. bool
sendSynchronousAcknowledgement The value indicating whether to send synchronous acknowledgement. bool

EdifactDelimiterOverride

Name Description Value
componentSeparator The component separator. int
dataElementSeparator The data element separator. int
decimalPointIndicator 'Comma'
'Decimal'
'NotSpecified'
messageAssociationAssignedCode The message association assigned code. string
messageId The message id. string
messageRelease The message release version. string
messageVersion The message version. string
releaseIndicator The release indicator. int
repetitionSeparator The repetition separator. int
segmentTerminator The segment terminator. int
segmentTerminatorSuffix 'CR'
'CRLF'
'LF'
'None'
'NotSpecified'
targetNamespace The target namespace on which this delimiter settings has to be applied. string

EdifactEnvelopeOverride

Name Description Value
applicationPassword The application password. string
associationAssignedCode The association assigned code. string
controllingAgencyCode The controlling agency code. string
functionalGroupId The functional group id. string
groupHeaderMessageRelease The group header message release. string
groupHeaderMessageVersion The group header message version. string
messageAssociationAssignedCode The message association assigned code. string
messageId The message id on which this envelope settings has to be applied. string
messageRelease The message release version on which this envelope settings has to be applied. string
messageVersion The message version on which this envelope settings has to be applied. string
receiverApplicationId The receiver application id. string
receiverApplicationQualifier The receiver application qualifier. string
senderApplicationId The sender application id. string
senderApplicationQualifier The sender application qualifier. string
targetNamespace The target namespace on which this envelope settings has to be applied. string

EdifactEnvelopeSettings

Name Description Value
applicationReferenceId The application reference id. string
applyDelimiterStringAdvice The value indicating whether to apply delimiter string advice. bool
communicationAgreementId The communication agreement id. string
createGroupingSegments The value indicating whether to create grouping segments. bool
enableDefaultGroupHeaders The value indicating whether to enable default group headers. bool
functionalGroupId The functional group id. string
groupApplicationPassword The group application password. string
groupApplicationReceiverId The group application receiver id. string
groupApplicationReceiverQualifier The group application receiver qualifier. string
groupApplicationSenderId The group application sender id. string
groupApplicationSenderQualifier The group application sender qualifier. string
groupAssociationAssignedCode The group association assigned code. string
groupControllingAgencyCode The group controlling agency code. string
groupControlNumberLowerBound The group control number lower bound. int
groupControlNumberPrefix The group control number prefix. string
groupControlNumberSuffix The group control number suffix. string
groupControlNumberUpperBound The group control number upper bound. int
groupMessageRelease The group message release. string
groupMessageVersion The group message version. string
interchangeControlNumberLowerBound The interchange control number lower bound. int
interchangeControlNumberPrefix The interchange control number prefix. string
interchangeControlNumberSuffix The interchange control number suffix. string
interchangeControlNumberUpperBound The interchange control number upper bound. int
isTestInterchange The value indicating whether the message is a test interchange. bool
overwriteExistingTransactionSetControlNumber The value indicating whether to overwrite existing transaction set control number. bool
processingPriorityCode The processing priority code. string
receiverInternalIdentification The receiver internal identification. string
receiverInternalSubIdentification The receiver internal sub identification. string
receiverReverseRoutingAddress The receiver reverse routing address. string
recipientReferencePasswordQualifier The recipient reference password qualifier. string
recipientReferencePasswordValue The recipient reference password value. string
rolloverGroupControlNumber The value indicating whether to rollover group control number. bool
rolloverInterchangeControlNumber The value indicating whether to rollover interchange control number. bool
rolloverTransactionSetControlNumber The value indicating whether to rollover transaction set control number. bool
senderInternalIdentification The sender internal identification. string
senderInternalSubIdentification The sender internal sub identification. string
senderReverseRoutingAddress The sender reverse routing address. string
transactionSetControlNumberLowerBound The transaction set control number lower bound. int
transactionSetControlNumberPrefix The transaction set control number prefix. string
transactionSetControlNumberSuffix The transaction set control number suffix. string
transactionSetControlNumberUpperBound The transaction set control number upper bound. int

EdifactFramingSettings

Name Description Value
characterEncoding The character encoding. string
characterSet 'KECA'
'NotSpecified'
'UNOA'
'UNOB'
'UNOC'
'UNOD'
'UNOE'
'UNOF'
'UNOG'
'UNOH'
'UNOI'
'UNOJ'
'UNOK'
'UNOX'
'UNOY'
componentSeparator The component separator. int
dataElementSeparator The data element separator. int
decimalPointIndicator 'Comma'
'Decimal'
'NotSpecified'
protocolVersion The protocol version. int
releaseIndicator The release indicator. int
repetitionSeparator The repetition separator. int
segmentTerminator The segment terminator. int
segmentTerminatorSuffix 'CR'
'CRLF'
'LF'
'None'
'NotSpecified'
serviceCodeListDirectoryVersion The service code list directory version. string

EdifactMessageFilter

Name Description Value
messageFilterType 'Exclude'
'Include'
'NotSpecified'

EdifactMessageIdentifier

Name Description Value
messageId The message id on which this envelope settings has to be applied. string

EdifactProcessingSettings

Name Description Value
createEmptyXmlTagsForTrailingSeparators The value indicating whether to create empty xml tags for trailing separators. bool
maskSecurityInfo The value indicating whether to mask security information. bool
preserveInterchange The value indicating whether to preserve interchange. bool
suspendInterchangeOnError The value indicating whether to suspend interchange on error. bool
useDotAsDecimalSeparator The value indicating whether to use dot as decimal separator. bool

EdifactSchemaReference

Name Description Value
associationAssignedCode The association assigned code. string
messageId The message id. string
messageRelease The message release version. string
messageVersion The message version. string
schemaName The schema name. string
senderApplicationId The sender application id. string
senderApplicationQualifier The sender application qualifier. string

EdifactValidationOverride

Name Description Value
allowLeadingAndTrailingSpacesAndZeroes The value indicating whether to allow leading and trailing spaces and zeroes. bool
enforceCharacterSet The value indicating whether to validate character Set. bool
messageId The message id on which the validation settings has to be applied. string
trailingSeparatorPolicy 'Mandatory'
'NotAllowed'
'NotSpecified'
'Optional'
trimLeadingAndTrailingSpacesAndZeroes The value indicating whether to trim leading and trailing spaces and zeroes. bool
validateEDITypes The value indicating whether to validate EDI types. bool
validateXSDTypes The value indicating whether to validate XSD types. bool

EdifactValidationSettings

Name Description Value
allowLeadingAndTrailingSpacesAndZeroes The value indicating whether to allow leading and trailing spaces and zeroes. bool
checkDuplicateGroupControlNumber The value indicating whether to check for duplicate group control number. bool
checkDuplicateInterchangeControlNumber The value indicating whether to check for duplicate interchange control number. bool
checkDuplicateTransactionSetControlNumber The value indicating whether to check for duplicate transaction set control number. bool
interchangeControlNumberValidityDays The validity period of interchange control number. int
trailingSeparatorPolicy 'Mandatory'
'NotAllowed'
'NotSpecified'
'Optional'
trimLeadingAndTrailingSpacesAndZeroes The value indicating whether to trim leading and trailing spaces and zeroes. bool
validateCharacterSet The value indicating whether to validate character set in the message. bool
validateEDITypes The value indicating whether to Whether to validate EDI types. bool
validateXSDTypes The value indicating whether to Whether to validate XSD types. bool

X12AgreementContent

Name Description Value
receiveAgreement X12OneWayAgreement
sendAgreement X12OneWayAgreement

X12OneWayAgreement

Name Description Value
protocolSettings X12ProtocolSettings
receiverBusinessIdentity BusinessIdentity
senderBusinessIdentity BusinessIdentity

X12ProtocolSettings

Name Description Value
acknowledgementSettings X12AcknowledgementSettings
envelopeOverrides The X12 envelope override settings. X12EnvelopeOverride[]
envelopeSettings X12EnvelopeSettings
framingSettings X12FramingSettings
messageFilter X12MessageFilter
messageFilterList The X12 message filter list. X12MessageIdentifier[]
processingSettings X12ProcessingSettings
schemaReferences The X12 schema references. X12SchemaReference[]
securitySettings X12SecuritySettings
validationOverrides The X12 validation override settings. X12ValidationOverride[]
validationSettings X12ValidationSettings
x12DelimiterOverrides The X12 delimiter override settings. X12DelimiterOverrides[]

X12AcknowledgementSettings

Name Description Value
acknowledgementControlNumberLowerBound The acknowledgement control number lower bound. int
acknowledgementControlNumberPrefix The acknowledgement control number prefix. string
acknowledgementControlNumberSuffix The acknowledgement control number suffix. string
acknowledgementControlNumberUpperBound The acknowledgement control number upper bound. int
batchFunctionalAcknowledgements The value indicating whether to batch functional acknowledgements. bool
batchImplementationAcknowledgements The value indicating whether to batch implementation acknowledgements. bool
batchTechnicalAcknowledgements The value indicating whether to batch the technical acknowledgements. bool
functionalAcknowledgementVersion The functional acknowledgement version. string
implementationAcknowledgementVersion The implementation acknowledgement version. string
needFunctionalAcknowledgement The value indicating whether functional acknowledgement is needed. bool
needImplementationAcknowledgement The value indicating whether implementation acknowledgement is needed. bool
needLoopForValidMessages The value indicating whether a loop is needed for valid messages. bool
needTechnicalAcknowledgement The value indicating whether technical acknowledgement is needed. bool
rolloverAcknowledgementControlNumber The value indicating whether to rollover acknowledgement control number. bool
sendSynchronousAcknowledgement The value indicating whether to send synchronous acknowledgement. bool

X12EnvelopeOverride

Name Description Value
dateFormat 'CCYYMMDD'
'NotSpecified'
'YYMMDD'
functionalIdentifierCode The functional identifier code. string
headerVersion The header version. string
messageId The message id on which this envelope settings has to be applied. string
protocolVersion The protocol version on which this envelope settings has to be applied. string
receiverApplicationId The receiver application id. string
responsibleAgencyCode The responsible agency code. int
senderApplicationId The sender application id. string
targetNamespace The target namespace on which this envelope settings has to be applied. string
timeFormat 'HHMM'
'HHMMSS'
'HHMMSSd'
'HHMMSSdd'
'NotSpecified'

X12EnvelopeSettings

Name Description Value
controlStandardsId The controls standards id. int
controlVersionNumber The control version number. string
enableDefaultGroupHeaders The value indicating whether to enable default group headers. bool
functionalGroupId The functional group id. string
groupControlNumberLowerBound The group control number lower bound. int
groupControlNumberUpperBound The group control number upper bound. int
groupHeaderAgencyCode The group header agency code. string
groupHeaderDateFormat 'CCYYMMDD'
'NotSpecified'
'YYMMDD'
groupHeaderTimeFormat 'HHMM'
'HHMMSS'
'HHMMSSd'
'HHMMSSdd'
'NotSpecified'
groupHeaderVersion The group header version. string
interchangeControlNumberLowerBound The interchange control number lower bound. int
interchangeControlNumberUpperBound The interchange control number upper bound. int
overwriteExistingTransactionSetControlNumber The value indicating whether to overwrite existing transaction set control number. bool
receiverApplicationId The receiver application id. string
rolloverGroupControlNumber The value indicating whether to rollover group control number. bool
rolloverInterchangeControlNumber The value indicating whether to rollover interchange control number. bool
rolloverTransactionSetControlNumber The value indicating whether to rollover transaction set control number. bool
senderApplicationId The sender application id. string
transactionSetControlNumberLowerBound The transaction set control number lower bound. int
transactionSetControlNumberPrefix The transaction set control number prefix. string
transactionSetControlNumberSuffix The transaction set control number suffix. string
transactionSetControlNumberUpperBound The transaction set control number upper bound. int
usageIndicator 'Information'
'NotSpecified'
'Production'
'Test'
useControlStandardsIdAsRepetitionCharacter The value indicating whether to use control standards id as repetition character. bool

X12FramingSettings

Name Description Value
characterSet 'Basic'
'Extended'
'NotSpecified'
'UTF8'
componentSeparator The component separator. int
dataElementSeparator The data element separator. int
replaceCharacter The replacement character. int
replaceSeparatorsInPayload The value indicating whether to replace separators in payload. bool
segmentTerminator The segment terminator. int
segmentTerminatorSuffix 'CR'
'CRLF'
'LF'
'None'
'NotSpecified'

X12MessageFilter

Name Description Value
messageFilterType 'Exclude'
'Include'
'NotSpecified'

X12MessageIdentifier

Name Description Value
messageId The message id. string

X12ProcessingSettings

Name Description Value
convertImpliedDecimal The value indicating whether to convert numerical type to implied decimal. bool
createEmptyXmlTagsForTrailingSeparators The value indicating whether to create empty xml tags for trailing separators. bool
maskSecurityInfo The value indicating whether to mask security information. bool
preserveInterchange The value indicating whether to preserve interchange. bool
suspendInterchangeOnError The value indicating whether to suspend interchange on error. bool
useDotAsDecimalSeparator The value indicating whether to use dot as decimal separator. bool

X12SchemaReference

Name Description Value
messageId The message id. string
schemaName The schema name. string
schemaVersion The schema version. string
senderApplicationId The sender application id. string

X12SecuritySettings

Name Description Value
authorizationQualifier The authorization qualifier. string
authorizationValue The authorization value. string
passwordValue The password value. string
securityQualifier The security qualifier. string

X12ValidationOverride

Name Description Value
allowLeadingAndTrailingSpacesAndZeroes The value indicating whether to allow leading and trailing spaces and zeroes. bool
messageId The message id on which the validation settings has to be applied. string
trailingSeparatorPolicy 'Mandatory'
'NotAllowed'
'NotSpecified'
'Optional'
trimLeadingAndTrailingSpacesAndZeroes The value indicating whether to trim leading and trailing spaces and zeroes. bool
validateCharacterSet The value indicating whether to validate character Set. bool
validateEDITypes The value indicating whether to validate EDI types. bool
validateXSDTypes The value indicating whether to validate XSD types. bool

X12ValidationSettings

Name Description Value
allowLeadingAndTrailingSpacesAndZeroes The value indicating whether to allow leading and trailing spaces and zeroes. bool
checkDuplicateGroupControlNumber The value indicating whether to check for duplicate group control number. bool
checkDuplicateInterchangeControlNumber The value indicating whether to check for duplicate interchange control number. bool
checkDuplicateTransactionSetControlNumber The value indicating whether to check for duplicate transaction set control number. bool
interchangeControlNumberValidityDays The validity period of interchange control number. int
trailingSeparatorPolicy 'Mandatory'
'NotAllowed'
'NotSpecified'
'Optional'
trimLeadingAndTrailingSpacesAndZeroes The value indicating whether to trim leading and trailing spaces and zeroes. bool
validateCharacterSet The value indicating whether to validate character set in the message. bool
validateEDITypes The value indicating whether to Whether to validate EDI types. bool
validateXSDTypes The value indicating whether to Whether to validate XSD types. bool

X12DelimiterOverrides

Name Description Value
componentSeparator The component separator. int
dataElementSeparator The data element separator. int
messageId The message id. string
protocolVersion The protocol version. string
replaceCharacter The replacement character. int
replaceSeparatorsInPayload The value indicating whether to replace separators in payload. bool
segmentTerminator The segment terminator. int
segmentTerminatorSuffix 'CR'
'CRLF'
'LF'
'None'
'NotSpecified'
targetNamespace The target namespace on which this delimiter settings has to be applied. string

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Azure Logic Apps - AS2 Send Receive

Deploy to Azure
Creates integration accounts for two partners, Contoso and Fabrikam, including the artifacts for partners and agreements. The template also creates logic apps between Fabrikam Sales and Contoso to demonstrate synchronous AS2 Send Receive. The template also creates logic apps between Fabrikam Finance and Contoso, which demonstrate asynchronous AS2 Send Receive.