Microsoft.Logic integrationAccounts/agreements template reference
Template format
To create a Microsoft.Logic/integrationAccounts/agreements resource, add the following JSON to the resources section of your template.
{
"name": "string",
"type": "Microsoft.Logic/integrationAccounts/agreements",
"apiVersion": "2019-05-01",
"location": "string",
"tags": {},
"properties": {
"metadata": {},
"agreementType": "string",
"hostPartner": "string",
"guestPartner": "string",
"hostIdentity": {
"qualifier": "string",
"value": "string"
},
"guestIdentity": {
"qualifier": "string",
"value": "string"
},
"content": {
"aS2": {
"receiveAgreement": {
"senderBusinessIdentity": {
"qualifier": "string",
"value": "string"
},
"receiverBusinessIdentity": {
"qualifier": "string",
"value": "string"
},
"protocolSettings": {
"messageConnectionSettings": {
"ignoreCertificateNameMismatch": "boolean",
"supportHttpStatusCodeContinue": "boolean",
"keepHttpConnectionAlive": "boolean",
"unfoldHttpHeaders": "boolean"
},
"acknowledgementConnectionSettings": {
"ignoreCertificateNameMismatch": "boolean",
"supportHttpStatusCodeContinue": "boolean",
"keepHttpConnectionAlive": "boolean",
"unfoldHttpHeaders": "boolean"
},
"mdnSettings": {
"needMDN": "boolean",
"signMDN": "boolean",
"sendMDNAsynchronously": "boolean",
"receiptDeliveryUrl": "string",
"dispositionNotificationTo": "string",
"signOutboundMDNIfOptional": "boolean",
"mdnText": "string",
"sendInboundMDNToMessageBox": "boolean",
"micHashingAlgorithm": "string"
},
"securitySettings": {
"overrideGroupSigningCertificate": "boolean",
"signingCertificateName": "string",
"encryptionCertificateName": "string",
"enableNRRForInboundEncodedMessages": "boolean",
"enableNRRForInboundDecodedMessages": "boolean",
"enableNRRForOutboundMDN": "boolean",
"enableNRRForOutboundEncodedMessages": "boolean",
"enableNRRForOutboundDecodedMessages": "boolean",
"enableNRRForInboundMDN": "boolean",
"sha2AlgorithmFormat": "string"
},
"validationSettings": {
"overrideMessageProperties": "boolean",
"encryptMessage": "boolean",
"signMessage": "boolean",
"compressMessage": "boolean",
"checkDuplicateMessage": "boolean",
"interchangeDuplicatesValidityDays": "integer",
"checkCertificateRevocationListOnSend": "boolean",
"checkCertificateRevocationListOnReceive": "boolean",
"encryptionAlgorithm": "string",
"signingAlgorithm": "string"
},
"envelopeSettings": {
"messageContentType": "string",
"transmitFileNameInMimeHeader": "boolean",
"fileNameTemplate": "string",
"suspendMessageOnFileNameGenerationError": "boolean",
"autogenerateFileName": "boolean"
},
"errorSettings": {
"suspendDuplicateMessage": "boolean",
"resendIfMDNNotReceived": "boolean"
}
}
},
"sendAgreement": {
"senderBusinessIdentity": {
"qualifier": "string",
"value": "string"
},
"receiverBusinessIdentity": {
"qualifier": "string",
"value": "string"
},
"protocolSettings": {
"messageConnectionSettings": {
"ignoreCertificateNameMismatch": "boolean",
"supportHttpStatusCodeContinue": "boolean",
"keepHttpConnectionAlive": "boolean",
"unfoldHttpHeaders": "boolean"
},
"acknowledgementConnectionSettings": {
"ignoreCertificateNameMismatch": "boolean",
"supportHttpStatusCodeContinue": "boolean",
"keepHttpConnectionAlive": "boolean",
"unfoldHttpHeaders": "boolean"
},
"mdnSettings": {
"needMDN": "boolean",
"signMDN": "boolean",
"sendMDNAsynchronously": "boolean",
"receiptDeliveryUrl": "string",
"dispositionNotificationTo": "string",
"signOutboundMDNIfOptional": "boolean",
"mdnText": "string",
"sendInboundMDNToMessageBox": "boolean",
"micHashingAlgorithm": "string"
},
"securitySettings": {
"overrideGroupSigningCertificate": "boolean",
"signingCertificateName": "string",
"encryptionCertificateName": "string",
"enableNRRForInboundEncodedMessages": "boolean",
"enableNRRForInboundDecodedMessages": "boolean",
"enableNRRForOutboundMDN": "boolean",
"enableNRRForOutboundEncodedMessages": "boolean",
"enableNRRForOutboundDecodedMessages": "boolean",
"enableNRRForInboundMDN": "boolean",
"sha2AlgorithmFormat": "string"
},
"validationSettings": {
"overrideMessageProperties": "boolean",
"encryptMessage": "boolean",
"signMessage": "boolean",
"compressMessage": "boolean",
"checkDuplicateMessage": "boolean",
"interchangeDuplicatesValidityDays": "integer",
"checkCertificateRevocationListOnSend": "boolean",
"checkCertificateRevocationListOnReceive": "boolean",
"encryptionAlgorithm": "string",
"signingAlgorithm": "string"
},
"envelopeSettings": {
"messageContentType": "string",
"transmitFileNameInMimeHeader": "boolean",
"fileNameTemplate": "string",
"suspendMessageOnFileNameGenerationError": "boolean",
"autogenerateFileName": "boolean"
},
"errorSettings": {
"suspendDuplicateMessage": "boolean",
"resendIfMDNNotReceived": "boolean"
}
}
}
},
"x12": {
"receiveAgreement": {
"senderBusinessIdentity": {
"qualifier": "string",
"value": "string"
},
"receiverBusinessIdentity": {
"qualifier": "string",
"value": "string"
},
"protocolSettings": {
"validationSettings": {
"validateCharacterSet": "boolean",
"checkDuplicateInterchangeControlNumber": "boolean",
"interchangeControlNumberValidityDays": "integer",
"checkDuplicateGroupControlNumber": "boolean",
"checkDuplicateTransactionSetControlNumber": "boolean",
"validateEDITypes": "boolean",
"validateXSDTypes": "boolean",
"allowLeadingAndTrailingSpacesAndZeroes": "boolean",
"trimLeadingAndTrailingSpacesAndZeroes": "boolean",
"trailingSeparatorPolicy": "string"
},
"framingSettings": {
"dataElementSeparator": "integer",
"componentSeparator": "integer",
"replaceSeparatorsInPayload": "boolean",
"replaceCharacter": "integer",
"segmentTerminator": "integer",
"characterSet": "string",
"segmentTerminatorSuffix": "string"
},
"envelopeSettings": {
"controlStandardsId": "integer",
"useControlStandardsIdAsRepetitionCharacter": "boolean",
"senderApplicationId": "string",
"receiverApplicationId": "string",
"controlVersionNumber": "string",
"interchangeControlNumberLowerBound": "integer",
"interchangeControlNumberUpperBound": "integer",
"rolloverInterchangeControlNumber": "boolean",
"enableDefaultGroupHeaders": "boolean",
"functionalGroupId": "string",
"groupControlNumberLowerBound": "integer",
"groupControlNumberUpperBound": "integer",
"rolloverGroupControlNumber": "boolean",
"groupHeaderAgencyCode": "string",
"groupHeaderVersion": "string",
"transactionSetControlNumberLowerBound": "integer",
"transactionSetControlNumberUpperBound": "integer",
"rolloverTransactionSetControlNumber": "boolean",
"transactionSetControlNumberPrefix": "string",
"transactionSetControlNumberSuffix": "string",
"overwriteExistingTransactionSetControlNumber": "boolean",
"groupHeaderDateFormat": "string",
"groupHeaderTimeFormat": "string",
"usageIndicator": "string"
},
"acknowledgementSettings": {
"needTechnicalAcknowledgement": "boolean",
"batchTechnicalAcknowledgements": "boolean",
"needFunctionalAcknowledgement": "boolean",
"functionalAcknowledgementVersion": "string",
"batchFunctionalAcknowledgements": "boolean",
"needImplementationAcknowledgement": "boolean",
"implementationAcknowledgementVersion": "string",
"batchImplementationAcknowledgements": "boolean",
"needLoopForValidMessages": "boolean",
"sendSynchronousAcknowledgement": "boolean",
"acknowledgementControlNumberPrefix": "string",
"acknowledgementControlNumberSuffix": "string",
"acknowledgementControlNumberLowerBound": "integer",
"acknowledgementControlNumberUpperBound": "integer",
"rolloverAcknowledgementControlNumber": "boolean"
},
"messageFilter": {
"messageFilterType": "string"
},
"securitySettings": {
"authorizationQualifier": "string",
"authorizationValue": "string",
"securityQualifier": "string",
"passwordValue": "string"
},
"processingSettings": {
"maskSecurityInfo": "boolean",
"convertImpliedDecimal": "boolean",
"preserveInterchange": "boolean",
"suspendInterchangeOnError": "boolean",
"createEmptyXmlTagsForTrailingSeparators": "boolean",
"useDotAsDecimalSeparator": "boolean"
},
"envelopeOverrides": [
{
"targetNamespace": "string",
"protocolVersion": "string",
"messageId": "string",
"responsibleAgencyCode": "string",
"headerVersion": "string",
"senderApplicationId": "string",
"receiverApplicationId": "string",
"functionalIdentifierCode": "string",
"dateFormat": "string",
"timeFormat": "string"
}
],
"validationOverrides": [
{
"messageId": "string",
"validateEDITypes": "boolean",
"validateXSDTypes": "boolean",
"allowLeadingAndTrailingSpacesAndZeroes": "boolean",
"validateCharacterSet": "boolean",
"trimLeadingAndTrailingSpacesAndZeroes": "boolean",
"trailingSeparatorPolicy": "string"
}
],
"messageFilterList": [
{
"messageId": "string"
}
],
"schemaReferences": [
{
"messageId": "string",
"senderApplicationId": "string",
"schemaVersion": "string",
"schemaName": "string"
}
],
"x12DelimiterOverrides": [
{
"protocolVersion": "string",
"messageId": "string",
"dataElementSeparator": "integer",
"componentSeparator": "integer",
"segmentTerminator": "integer",
"segmentTerminatorSuffix": "string",
"replaceCharacter": "integer",
"replaceSeparatorsInPayload": "boolean",
"targetNamespace": "string"
}
]
}
},
"sendAgreement": {
"senderBusinessIdentity": {
"qualifier": "string",
"value": "string"
},
"receiverBusinessIdentity": {
"qualifier": "string",
"value": "string"
},
"protocolSettings": {
"validationSettings": {
"validateCharacterSet": "boolean",
"checkDuplicateInterchangeControlNumber": "boolean",
"interchangeControlNumberValidityDays": "integer",
"checkDuplicateGroupControlNumber": "boolean",
"checkDuplicateTransactionSetControlNumber": "boolean",
"validateEDITypes": "boolean",
"validateXSDTypes": "boolean",
"allowLeadingAndTrailingSpacesAndZeroes": "boolean",
"trimLeadingAndTrailingSpacesAndZeroes": "boolean",
"trailingSeparatorPolicy": "string"
},
"framingSettings": {
"dataElementSeparator": "integer",
"componentSeparator": "integer",
"replaceSeparatorsInPayload": "boolean",
"replaceCharacter": "integer",
"segmentTerminator": "integer",
"characterSet": "string",
"segmentTerminatorSuffix": "string"
},
"envelopeSettings": {
"controlStandardsId": "integer",
"useControlStandardsIdAsRepetitionCharacter": "boolean",
"senderApplicationId": "string",
"receiverApplicationId": "string",
"controlVersionNumber": "string",
"interchangeControlNumberLowerBound": "integer",
"interchangeControlNumberUpperBound": "integer",
"rolloverInterchangeControlNumber": "boolean",
"enableDefaultGroupHeaders": "boolean",
"functionalGroupId": "string",
"groupControlNumberLowerBound": "integer",
"groupControlNumberUpperBound": "integer",
"rolloverGroupControlNumber": "boolean",
"groupHeaderAgencyCode": "string",
"groupHeaderVersion": "string",
"transactionSetControlNumberLowerBound": "integer",
"transactionSetControlNumberUpperBound": "integer",
"rolloverTransactionSetControlNumber": "boolean",
"transactionSetControlNumberPrefix": "string",
"transactionSetControlNumberSuffix": "string",
"overwriteExistingTransactionSetControlNumber": "boolean",
"groupHeaderDateFormat": "string",
"groupHeaderTimeFormat": "string",
"usageIndicator": "string"
},
"acknowledgementSettings": {
"needTechnicalAcknowledgement": "boolean",
"batchTechnicalAcknowledgements": "boolean",
"needFunctionalAcknowledgement": "boolean",
"functionalAcknowledgementVersion": "string",
"batchFunctionalAcknowledgements": "boolean",
"needImplementationAcknowledgement": "boolean",
"implementationAcknowledgementVersion": "string",
"batchImplementationAcknowledgements": "boolean",
"needLoopForValidMessages": "boolean",
"sendSynchronousAcknowledgement": "boolean",
"acknowledgementControlNumberPrefix": "string",
"acknowledgementControlNumberSuffix": "string",
"acknowledgementControlNumberLowerBound": "integer",
"acknowledgementControlNumberUpperBound": "integer",
"rolloverAcknowledgementControlNumber": "boolean"
},
"messageFilter": {
"messageFilterType": "string"
},
"securitySettings": {
"authorizationQualifier": "string",
"authorizationValue": "string",
"securityQualifier": "string",
"passwordValue": "string"
},
"processingSettings": {
"maskSecurityInfo": "boolean",
"convertImpliedDecimal": "boolean",
"preserveInterchange": "boolean",
"suspendInterchangeOnError": "boolean",
"createEmptyXmlTagsForTrailingSeparators": "boolean",
"useDotAsDecimalSeparator": "boolean"
},
"envelopeOverrides": [
{
"targetNamespace": "string",
"protocolVersion": "string",
"messageId": "string",
"responsibleAgencyCode": "string",
"headerVersion": "string",
"senderApplicationId": "string",
"receiverApplicationId": "string",
"functionalIdentifierCode": "string",
"dateFormat": "string",
"timeFormat": "string"
}
],
"validationOverrides": [
{
"messageId": "string",
"validateEDITypes": "boolean",
"validateXSDTypes": "boolean",
"allowLeadingAndTrailingSpacesAndZeroes": "boolean",
"validateCharacterSet": "boolean",
"trimLeadingAndTrailingSpacesAndZeroes": "boolean",
"trailingSeparatorPolicy": "string"
}
],
"messageFilterList": [
{
"messageId": "string"
}
],
"schemaReferences": [
{
"messageId": "string",
"senderApplicationId": "string",
"schemaVersion": "string",
"schemaName": "string"
}
],
"x12DelimiterOverrides": [
{
"protocolVersion": "string",
"messageId": "string",
"dataElementSeparator": "integer",
"componentSeparator": "integer",
"segmentTerminator": "integer",
"segmentTerminatorSuffix": "string",
"replaceCharacter": "integer",
"replaceSeparatorsInPayload": "boolean",
"targetNamespace": "string"
}
]
}
}
},
"edifact": {
"receiveAgreement": {
"senderBusinessIdentity": {
"qualifier": "string",
"value": "string"
},
"receiverBusinessIdentity": {
"qualifier": "string",
"value": "string"
},
"protocolSettings": {
"validationSettings": {
"validateCharacterSet": "boolean",
"checkDuplicateInterchangeControlNumber": "boolean",
"interchangeControlNumberValidityDays": "integer",
"checkDuplicateGroupControlNumber": "boolean",
"checkDuplicateTransactionSetControlNumber": "boolean",
"validateEDITypes": "boolean",
"validateXSDTypes": "boolean",
"allowLeadingAndTrailingSpacesAndZeroes": "boolean",
"trimLeadingAndTrailingSpacesAndZeroes": "boolean",
"trailingSeparatorPolicy": "string"
},
"framingSettings": {
"serviceCodeListDirectoryVersion": "string",
"characterEncoding": "string",
"protocolVersion": "integer",
"dataElementSeparator": "integer",
"componentSeparator": "integer",
"segmentTerminator": "integer",
"releaseIndicator": "integer",
"repetitionSeparator": "integer",
"characterSet": "string",
"decimalPointIndicator": "string",
"segmentTerminatorSuffix": "string"
},
"envelopeSettings": {
"groupAssociationAssignedCode": "string",
"communicationAgreementId": "string",
"applyDelimiterStringAdvice": "boolean",
"createGroupingSegments": "boolean",
"enableDefaultGroupHeaders": "boolean",
"recipientReferencePasswordValue": "string",
"recipientReferencePasswordQualifier": "string",
"applicationReferenceId": "string",
"processingPriorityCode": "string",
"interchangeControlNumberLowerBound": "integer",
"interchangeControlNumberUpperBound": "integer",
"rolloverInterchangeControlNumber": "boolean",
"interchangeControlNumberPrefix": "string",
"interchangeControlNumberSuffix": "string",
"senderReverseRoutingAddress": "string",
"receiverReverseRoutingAddress": "string",
"functionalGroupId": "string",
"groupControllingAgencyCode": "string",
"groupMessageVersion": "string",
"groupMessageRelease": "string",
"groupControlNumberLowerBound": "integer",
"groupControlNumberUpperBound": "integer",
"rolloverGroupControlNumber": "boolean",
"groupControlNumberPrefix": "string",
"groupControlNumberSuffix": "string",
"groupApplicationReceiverQualifier": "string",
"groupApplicationReceiverId": "string",
"groupApplicationSenderQualifier": "string",
"groupApplicationSenderId": "string",
"groupApplicationPassword": "string",
"overwriteExistingTransactionSetControlNumber": "boolean",
"transactionSetControlNumberPrefix": "string",
"transactionSetControlNumberSuffix": "string",
"transactionSetControlNumberLowerBound": "integer",
"transactionSetControlNumberUpperBound": "integer",
"rolloverTransactionSetControlNumber": "boolean",
"isTestInterchange": "boolean",
"senderInternalIdentification": "string",
"senderInternalSubIdentification": "string",
"receiverInternalIdentification": "string",
"receiverInternalSubIdentification": "string"
},
"acknowledgementSettings": {
"needTechnicalAcknowledgement": "boolean",
"batchTechnicalAcknowledgements": "boolean",
"needFunctionalAcknowledgement": "boolean",
"batchFunctionalAcknowledgements": "boolean",
"needLoopForValidMessages": "boolean",
"sendSynchronousAcknowledgement": "boolean",
"acknowledgementControlNumberPrefix": "string",
"acknowledgementControlNumberSuffix": "string",
"acknowledgementControlNumberLowerBound": "integer",
"acknowledgementControlNumberUpperBound": "integer",
"rolloverAcknowledgementControlNumber": "boolean"
},
"messageFilter": {
"messageFilterType": "string"
},
"processingSettings": {
"maskSecurityInfo": "boolean",
"preserveInterchange": "boolean",
"suspendInterchangeOnError": "boolean",
"createEmptyXmlTagsForTrailingSeparators": "boolean",
"useDotAsDecimalSeparator": "boolean"
},
"envelopeOverrides": [
{
"messageId": "string",
"messageVersion": "string",
"messageRelease": "string",
"messageAssociationAssignedCode": "string",
"targetNamespace": "string",
"functionalGroupId": "string",
"senderApplicationQualifier": "string",
"senderApplicationId": "string",
"receiverApplicationQualifier": "string",
"receiverApplicationId": "string",
"controllingAgencyCode": "string",
"groupHeaderMessageVersion": "string",
"groupHeaderMessageRelease": "string",
"associationAssignedCode": "string",
"applicationPassword": "string"
}
],
"messageFilterList": [
{
"messageId": "string"
}
],
"schemaReferences": [
{
"messageId": "string",
"messageVersion": "string",
"messageRelease": "string",
"senderApplicationId": "string",
"senderApplicationQualifier": "string",
"associationAssignedCode": "string",
"schemaName": "string"
}
],
"validationOverrides": [
{
"messageId": "string",
"enforceCharacterSet": "boolean",
"validateEDITypes": "boolean",
"validateXSDTypes": "boolean",
"allowLeadingAndTrailingSpacesAndZeroes": "boolean",
"trailingSeparatorPolicy": "string",
"trimLeadingAndTrailingSpacesAndZeroes": "boolean"
}
],
"edifactDelimiterOverrides": [
{
"messageId": "string",
"messageVersion": "string",
"messageRelease": "string",
"dataElementSeparator": "integer",
"componentSeparator": "integer",
"segmentTerminator": "integer",
"repetitionSeparator": "integer",
"segmentTerminatorSuffix": "string",
"decimalPointIndicator": "string",
"releaseIndicator": "integer",
"messageAssociationAssignedCode": "string",
"targetNamespace": "string"
}
]
}
},
"sendAgreement": {
"senderBusinessIdentity": {
"qualifier": "string",
"value": "string"
},
"receiverBusinessIdentity": {
"qualifier": "string",
"value": "string"
},
"protocolSettings": {
"validationSettings": {
"validateCharacterSet": "boolean",
"checkDuplicateInterchangeControlNumber": "boolean",
"interchangeControlNumberValidityDays": "integer",
"checkDuplicateGroupControlNumber": "boolean",
"checkDuplicateTransactionSetControlNumber": "boolean",
"validateEDITypes": "boolean",
"validateXSDTypes": "boolean",
"allowLeadingAndTrailingSpacesAndZeroes": "boolean",
"trimLeadingAndTrailingSpacesAndZeroes": "boolean",
"trailingSeparatorPolicy": "string"
},
"framingSettings": {
"serviceCodeListDirectoryVersion": "string",
"characterEncoding": "string",
"protocolVersion": "integer",
"dataElementSeparator": "integer",
"componentSeparator": "integer",
"segmentTerminator": "integer",
"releaseIndicator": "integer",
"repetitionSeparator": "integer",
"characterSet": "string",
"decimalPointIndicator": "string",
"segmentTerminatorSuffix": "string"
},
"envelopeSettings": {
"groupAssociationAssignedCode": "string",
"communicationAgreementId": "string",
"applyDelimiterStringAdvice": "boolean",
"createGroupingSegments": "boolean",
"enableDefaultGroupHeaders": "boolean",
"recipientReferencePasswordValue": "string",
"recipientReferencePasswordQualifier": "string",
"applicationReferenceId": "string",
"processingPriorityCode": "string",
"interchangeControlNumberLowerBound": "integer",
"interchangeControlNumberUpperBound": "integer",
"rolloverInterchangeControlNumber": "boolean",
"interchangeControlNumberPrefix": "string",
"interchangeControlNumberSuffix": "string",
"senderReverseRoutingAddress": "string",
"receiverReverseRoutingAddress": "string",
"functionalGroupId": "string",
"groupControllingAgencyCode": "string",
"groupMessageVersion": "string",
"groupMessageRelease": "string",
"groupControlNumberLowerBound": "integer",
"groupControlNumberUpperBound": "integer",
"rolloverGroupControlNumber": "boolean",
"groupControlNumberPrefix": "string",
"groupControlNumberSuffix": "string",
"groupApplicationReceiverQualifier": "string",
"groupApplicationReceiverId": "string",
"groupApplicationSenderQualifier": "string",
"groupApplicationSenderId": "string",
"groupApplicationPassword": "string",
"overwriteExistingTransactionSetControlNumber": "boolean",
"transactionSetControlNumberPrefix": "string",
"transactionSetControlNumberSuffix": "string",
"transactionSetControlNumberLowerBound": "integer",
"transactionSetControlNumberUpperBound": "integer",
"rolloverTransactionSetControlNumber": "boolean",
"isTestInterchange": "boolean",
"senderInternalIdentification": "string",
"senderInternalSubIdentification": "string",
"receiverInternalIdentification": "string",
"receiverInternalSubIdentification": "string"
},
"acknowledgementSettings": {
"needTechnicalAcknowledgement": "boolean",
"batchTechnicalAcknowledgements": "boolean",
"needFunctionalAcknowledgement": "boolean",
"batchFunctionalAcknowledgements": "boolean",
"needLoopForValidMessages": "boolean",
"sendSynchronousAcknowledgement": "boolean",
"acknowledgementControlNumberPrefix": "string",
"acknowledgementControlNumberSuffix": "string",
"acknowledgementControlNumberLowerBound": "integer",
"acknowledgementControlNumberUpperBound": "integer",
"rolloverAcknowledgementControlNumber": "boolean"
},
"messageFilter": {
"messageFilterType": "string"
},
"processingSettings": {
"maskSecurityInfo": "boolean",
"preserveInterchange": "boolean",
"suspendInterchangeOnError": "boolean",
"createEmptyXmlTagsForTrailingSeparators": "boolean",
"useDotAsDecimalSeparator": "boolean"
},
"envelopeOverrides": [
{
"messageId": "string",
"messageVersion": "string",
"messageRelease": "string",
"messageAssociationAssignedCode": "string",
"targetNamespace": "string",
"functionalGroupId": "string",
"senderApplicationQualifier": "string",
"senderApplicationId": "string",
"receiverApplicationQualifier": "string",
"receiverApplicationId": "string",
"controllingAgencyCode": "string",
"groupHeaderMessageVersion": "string",
"groupHeaderMessageRelease": "string",
"associationAssignedCode": "string",
"applicationPassword": "string"
}
],
"messageFilterList": [
{
"messageId": "string"
}
],
"schemaReferences": [
{
"messageId": "string",
"messageVersion": "string",
"messageRelease": "string",
"senderApplicationId": "string",
"senderApplicationQualifier": "string",
"associationAssignedCode": "string",
"schemaName": "string"
}
],
"validationOverrides": [
{
"messageId": "string",
"enforceCharacterSet": "boolean",
"validateEDITypes": "boolean",
"validateXSDTypes": "boolean",
"allowLeadingAndTrailingSpacesAndZeroes": "boolean",
"trailingSeparatorPolicy": "string",
"trimLeadingAndTrailingSpacesAndZeroes": "boolean"
}
],
"edifactDelimiterOverrides": [
{
"messageId": "string",
"messageVersion": "string",
"messageRelease": "string",
"dataElementSeparator": "integer",
"componentSeparator": "integer",
"segmentTerminator": "integer",
"repetitionSeparator": "integer",
"segmentTerminatorSuffix": "string",
"decimalPointIndicator": "string",
"releaseIndicator": "integer",
"messageAssociationAssignedCode": "string",
"targetNamespace": "string"
}
]
}
}
}
}
}
}
Property values
The following tables describe the values you need to set in the schema.
Microsoft.Logic/integrationAccounts/agreements object
Note
In Bicep, type and apiVersion are specified in the first line of the resource declaration. Use the format <type>@<apiVersion>. Don't set those properties in the resource body.
| Name | Type | Required | Value |
|---|---|---|---|
| name | string | Yes | The integration account agreement name. |
| type | enum | Yes | For JSON -agreements -or- Microsoft.Logic/integrationAccounts/agreements See Set name and type for child resources. |
| apiVersion | enum | Yes | For JSON - 2019-05-01 |
| location | string | No | The resource location. |
| tags | object | No | The resource tags. |
| properties | object | Yes | The integration account agreement properties. - IntegrationAccountAgreementProperties object |
IntegrationAccountAgreementProperties object
| Name | Type | Required | Value |
|---|---|---|---|
| metadata | object | No | The metadata. |
| agreementType | enum | Yes | The agreement type. - NotSpecified, AS2, X12, Edifact |
| hostPartner | string | Yes | The integration account partner that is set as host partner for this agreement. |
| guestPartner | string | Yes | The integration account partner that is set as guest partner for this agreement. |
| hostIdentity | object | Yes | The business identity of the host partner. - BusinessIdentity object |
| guestIdentity | object | Yes | The business identity of the guest partner. - BusinessIdentity object |
| content | object | Yes | The agreement content. - AgreementContent object |
BusinessIdentity object
| Name | Type | Required | Value |
|---|---|---|---|
| qualifier | string | Yes | The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 |
| value | string | Yes | The user defined business identity value. |
AgreementContent object
| Name | Type | Required | Value |
|---|---|---|---|
| aS2 | object | No | The AS2 agreement content. - AS2AgreementContent object |
| x12 | object | No | The X12 agreement content. - X12AgreementContent object |
| edifact | object | No | The EDIFACT agreement content. - EdifactAgreementContent object |
AS2AgreementContent object
| Name | Type | Required | Value |
|---|---|---|---|
| receiveAgreement | object | Yes | The AS2 one-way receive agreement. - AS2OneWayAgreement object |
| sendAgreement | object | Yes | The AS2 one-way send agreement. - AS2OneWayAgreement object |
X12AgreementContent object
| Name | Type | Required | Value |
|---|---|---|---|
| receiveAgreement | object | Yes | The X12 one-way receive agreement. - X12OneWayAgreement object |
| sendAgreement | object | Yes | The X12 one-way send agreement. - X12OneWayAgreement object |
EdifactAgreementContent object
| Name | Type | Required | Value |
|---|---|---|---|
| receiveAgreement | object | Yes | The EDIFACT one-way receive agreement. - EdifactOneWayAgreement object |
| sendAgreement | object | Yes | The EDIFACT one-way send agreement. - EdifactOneWayAgreement object |
AS2OneWayAgreement object
| Name | Type | Required | Value |
|---|---|---|---|
| senderBusinessIdentity | object | Yes | The sender business identity - BusinessIdentity object |
| receiverBusinessIdentity | object | Yes | The receiver business identity - BusinessIdentity object |
| protocolSettings | object | Yes | The AS2 protocol settings. - AS2ProtocolSettings object |
X12OneWayAgreement object
| Name | Type | Required | Value |
|---|---|---|---|
| senderBusinessIdentity | object | Yes | The sender business identity - BusinessIdentity object |
| receiverBusinessIdentity | object | Yes | The receiver business identity - BusinessIdentity object |
| protocolSettings | object | Yes | The X12 protocol settings. - X12ProtocolSettings object |
EdifactOneWayAgreement object
| Name | Type | Required | Value |
|---|---|---|---|
| senderBusinessIdentity | object | Yes | The sender business identity - BusinessIdentity object |
| receiverBusinessIdentity | object | Yes | The receiver business identity - BusinessIdentity object |
| protocolSettings | object | Yes | The EDIFACT protocol settings. - EdifactProtocolSettings object |
AS2ProtocolSettings object
| Name | Type | Required | Value |
|---|---|---|---|
| messageConnectionSettings | object | Yes | The message connection settings. - AS2MessageConnectionSettings object |
| acknowledgementConnectionSettings | object | Yes | The acknowledgement connection settings. - AS2AcknowledgementConnectionSettings object |
| mdnSettings | object | Yes | The MDN settings. - AS2MdnSettings object |
| securitySettings | object | Yes | The security settings. - AS2SecuritySettings object |
| validationSettings | object | Yes | The validation settings. - AS2ValidationSettings object |
| envelopeSettings | object | Yes | The envelope settings. - AS2EnvelopeSettings object |
| errorSettings | object | Yes | The error settings. - AS2ErrorSettings object |
X12ProtocolSettings object
| Name | Type | Required | Value |
|---|---|---|---|
| validationSettings | object | Yes | The X12 validation settings. - X12ValidationSettings object |
| framingSettings | object | Yes | The X12 framing settings. - X12FramingSettings object |
| envelopeSettings | object | Yes | The X12 envelope settings. - X12EnvelopeSettings object |
| acknowledgementSettings | object | Yes | The X12 acknowledgment settings. - X12AcknowledgementSettings object |
| messageFilter | object | Yes | The X12 message filter. - X12MessageFilter object |
| securitySettings | object | Yes | The X12 security settings. - X12SecuritySettings object |
| processingSettings | object | Yes | The X12 processing settings. - X12ProcessingSettings object |
| envelopeOverrides | array | No | The X12 envelope override settings. - X12EnvelopeOverride object |
| validationOverrides | array | No | The X12 validation override settings. - X12ValidationOverride object |
| messageFilterList | array | No | The X12 message filter list. - X12MessageIdentifier object |
| schemaReferences | array | Yes | The X12 schema references. - X12SchemaReference object |
| x12DelimiterOverrides | array | No | The X12 delimiter override settings. - X12DelimiterOverrides object |
EdifactProtocolSettings object
| Name | Type | Required | Value |
|---|---|---|---|
| validationSettings | object | Yes | The EDIFACT validation settings. - EdifactValidationSettings object |
| framingSettings | object | Yes | The EDIFACT framing settings. - EdifactFramingSettings object |
| envelopeSettings | object | Yes | The EDIFACT envelope settings. - EdifactEnvelopeSettings object |
| acknowledgementSettings | object | Yes | The EDIFACT acknowledgement settings. - EdifactAcknowledgementSettings object |
| messageFilter | object | Yes | The EDIFACT message filter. - EdifactMessageFilter object |
| processingSettings | object | Yes | The EDIFACT processing Settings. - EdifactProcessingSettings object |
| envelopeOverrides | array | No | The EDIFACT envelope override settings. - EdifactEnvelopeOverride object |
| messageFilterList | array | No | The EDIFACT message filter list. - EdifactMessageIdentifier object |
| schemaReferences | array | Yes | The EDIFACT schema references. - EdifactSchemaReference object |
| validationOverrides | array | No | The EDIFACT validation override settings. - EdifactValidationOverride object |
| edifactDelimiterOverrides | array | No | The EDIFACT delimiter override settings. - EdifactDelimiterOverride object |
AS2MessageConnectionSettings object
| Name | Type | Required | Value |
|---|---|---|---|
| ignoreCertificateNameMismatch | boolean | Yes | The value indicating whether to ignore mismatch in certificate name. |
| supportHttpStatusCodeContinue | boolean | Yes | The value indicating whether to support HTTP status code 'CONTINUE'. |
| keepHttpConnectionAlive | boolean | Yes | The value indicating whether to keep the connection alive. |
| unfoldHttpHeaders | boolean | Yes | The value indicating whether to unfold the HTTP headers. |
AS2AcknowledgementConnectionSettings object
| Name | Type | Required | Value |
|---|---|---|---|
| ignoreCertificateNameMismatch | boolean | Yes | Indicates whether to ignore mismatch in certificate name. |
| supportHttpStatusCodeContinue | boolean | Yes | Indicates whether to support HTTP status code 'CONTINUE'. |
| keepHttpConnectionAlive | boolean | Yes | Indicates whether to keep the connection alive. |
| unfoldHttpHeaders | boolean | Yes | Indicates whether to unfold the HTTP headers. |
AS2MdnSettings object
| Name | Type | Required | Value |
|---|---|---|---|
| needMDN | boolean | Yes | The value indicating whether to send or request a MDN. |
| signMDN | boolean | Yes | The value indicating whether the MDN needs to be signed or not. |
| sendMDNAsynchronously | boolean | Yes | The value indicating whether to send the asynchronous MDN. |
| receiptDeliveryUrl | string | No | The receipt delivery URL. |
| dispositionNotificationTo | string | No | The disposition notification to header value. |
| signOutboundMDNIfOptional | boolean | Yes | The value indicating whether to sign the outbound MDN if optional. |
| mdnText | string | No | The MDN text. |
| sendInboundMDNToMessageBox | boolean | Yes | The value indicating whether to send inbound MDN to message box. |
| micHashingAlgorithm | enum | Yes | The signing or hashing algorithm. - NotSpecified, None, MD5, SHA1, SHA2256, SHA2384, SHA2512 |
AS2SecuritySettings object
| Name | Type | Required | Value |
|---|---|---|---|
| overrideGroupSigningCertificate | boolean | Yes | The value indicating whether to send or request a MDN. |
| signingCertificateName | string | No | The name of the signing certificate. |
| encryptionCertificateName | string | No | The name of the encryption certificate. |
| enableNRRForInboundEncodedMessages | boolean | Yes | The value indicating whether to enable NRR for inbound encoded messages. |
| enableNRRForInboundDecodedMessages | boolean | Yes | The value indicating whether to enable NRR for inbound decoded messages. |
| enableNRRForOutboundMDN | boolean | Yes | The value indicating whether to enable NRR for outbound MDN. |
| enableNRRForOutboundEncodedMessages | boolean | Yes | The value indicating whether to enable NRR for outbound encoded messages. |
| enableNRRForOutboundDecodedMessages | boolean | Yes | The value indicating whether to enable NRR for outbound decoded messages. |
| enableNRRForInboundMDN | boolean | Yes | The value indicating whether to enable NRR for inbound MDN. |
| sha2AlgorithmFormat | string | No | The Sha2 algorithm format. Valid values are Sha2, ShaHashSize, ShaHyphenHashSize, Sha2UnderscoreHashSize. |
AS2ValidationSettings object
| Name | Type | Required | Value |
|---|---|---|---|
| overrideMessageProperties | boolean | Yes | The value indicating whether to override incoming message properties with those in agreement. |
| encryptMessage | boolean | Yes | The value indicating whether the message has to be encrypted. |
| signMessage | boolean | Yes | The value indicating whether the message has to be signed. |
| compressMessage | boolean | Yes | The value indicating whether the message has to be compressed. |
| checkDuplicateMessage | boolean | Yes | The value indicating whether to check for duplicate message. |
| interchangeDuplicatesValidityDays | integer | Yes | The number of days to look back for duplicate interchange. |
| checkCertificateRevocationListOnSend | boolean | Yes | The value indicating whether to check for certificate revocation list on send. |
| checkCertificateRevocationListOnReceive | boolean | Yes | The value indicating whether to check for certificate revocation list on receive. |
| encryptionAlgorithm | enum | Yes | The encryption algorithm. - NotSpecified, None, DES3, RC2, AES128, AES192, AES256 |
| signingAlgorithm | enum | No | The signing algorithm. - NotSpecified, Default, SHA1, SHA2256, SHA2384, SHA2512 |
AS2EnvelopeSettings object
| Name | Type | Required | Value |
|---|---|---|---|
| messageContentType | string | Yes | The message content type. |
| transmitFileNameInMimeHeader | boolean | Yes | The value indicating whether to transmit file name in mime header. |
| fileNameTemplate | string | Yes | The template for file name. |
| suspendMessageOnFileNameGenerationError | boolean | Yes | The value indicating whether to suspend message on file name generation error. |
| autogenerateFileName | boolean | Yes | The value indicating whether to auto generate file name. |
AS2ErrorSettings object
| Name | Type | Required | Value |
|---|---|---|---|
| suspendDuplicateMessage | boolean | Yes | The value indicating whether to suspend duplicate message. |
| resendIfMDNNotReceived | boolean | Yes | The value indicating whether to resend message If MDN is not received. |
X12ValidationSettings object
| Name | Type | Required | Value |
|---|---|---|---|
| validateCharacterSet | boolean | Yes | The value indicating whether to validate character set in the message. |
| checkDuplicateInterchangeControlNumber | boolean | Yes | The value indicating whether to check for duplicate interchange control number. |
| interchangeControlNumberValidityDays | integer | Yes | The validity period of interchange control number. |
| checkDuplicateGroupControlNumber | boolean | Yes | The value indicating whether to check for duplicate group control number. |
| checkDuplicateTransactionSetControlNumber | boolean | Yes | The value indicating whether to check for duplicate transaction set control number. |
| validateEDITypes | boolean | Yes | The value indicating whether to Whether to validate EDI types. |
| validateXSDTypes | boolean | Yes | The value indicating whether to Whether to validate XSD types. |
| allowLeadingAndTrailingSpacesAndZeroes | boolean | Yes | The value indicating whether to allow leading and trailing spaces and zeroes. |
| trimLeadingAndTrailingSpacesAndZeroes | boolean | Yes | The value indicating whether to trim leading and trailing spaces and zeroes. |
| trailingSeparatorPolicy | enum | Yes | The trailing separator policy. - NotSpecified, NotAllowed, Optional, Mandatory |
X12FramingSettings object
| Name | Type | Required | Value |
|---|---|---|---|
| dataElementSeparator | integer | Yes | The data element separator. |
| componentSeparator | integer | Yes | The component separator. |
| replaceSeparatorsInPayload | boolean | Yes | The value indicating whether to replace separators in payload. |
| replaceCharacter | integer | Yes | The replacement character. |
| segmentTerminator | integer | Yes | The segment terminator. |
| characterSet | enum | Yes | The X12 character set. - NotSpecified, Basic, Extended, UTF8 |
| segmentTerminatorSuffix | enum | Yes | The segment terminator suffix. - NotSpecified, None, CR, LF, CRLF |
X12EnvelopeSettings object
| Name | Type | Required | Value |
|---|---|---|---|
| controlStandardsId | integer | Yes | The controls standards id. |
| useControlStandardsIdAsRepetitionCharacter | boolean | Yes | The value indicating whether to use control standards id as repetition character. |
| senderApplicationId | string | Yes | The sender application id. |
| receiverApplicationId | string | Yes | The receiver application id. |
| controlVersionNumber | string | Yes | The control version number. |
| interchangeControlNumberLowerBound | integer | Yes | The interchange control number lower bound. |
| interchangeControlNumberUpperBound | integer | Yes | The interchange control number upper bound. |
| rolloverInterchangeControlNumber | boolean | Yes | The value indicating whether to rollover interchange control number. |
| enableDefaultGroupHeaders | boolean | Yes | The value indicating whether to enable default group headers. |
| functionalGroupId | string | No | The functional group id. |
| groupControlNumberLowerBound | integer | Yes | The group control number lower bound. |
| groupControlNumberUpperBound | integer | Yes | The group control number upper bound. |
| rolloverGroupControlNumber | boolean | Yes | The value indicating whether to rollover group control number. |
| groupHeaderAgencyCode | string | Yes | The group header agency code. |
| groupHeaderVersion | string | Yes | The group header version. |
| transactionSetControlNumberLowerBound | integer | Yes | The transaction set control number lower bound. |
| transactionSetControlNumberUpperBound | integer | Yes | The transaction set control number upper bound. |
| rolloverTransactionSetControlNumber | boolean | Yes | The value indicating whether to rollover transaction set control number. |
| transactionSetControlNumberPrefix | string | No | The transaction set control number prefix. |
| transactionSetControlNumberSuffix | string | No | The transaction set control number suffix. |
| overwriteExistingTransactionSetControlNumber | boolean | Yes | The value indicating whether to overwrite existing transaction set control number. |
| groupHeaderDateFormat | enum | Yes | The group header date format. - NotSpecified, CCYYMMDD, YYMMDD |
| groupHeaderTimeFormat | enum | Yes | The group header time format. - NotSpecified, HHMM, HHMMSS, HHMMSSdd, HHMMSSd |
| usageIndicator | enum | Yes | The usage indicator. - NotSpecified, Test, Information, Production |
X12AcknowledgementSettings object
| Name | Type | Required | Value |
|---|---|---|---|
| needTechnicalAcknowledgement | boolean | Yes | The value indicating whether technical acknowledgement is needed. |
| batchTechnicalAcknowledgements | boolean | Yes | The value indicating whether to batch the technical acknowledgements. |
| needFunctionalAcknowledgement | boolean | Yes | The value indicating whether functional acknowledgement is needed. |
| functionalAcknowledgementVersion | string | No | The functional acknowledgement version. |
| batchFunctionalAcknowledgements | boolean | Yes | The value indicating whether to batch functional acknowledgements. |
| needImplementationAcknowledgement | boolean | Yes | The value indicating whether implementation acknowledgement is needed. |
| implementationAcknowledgementVersion | string | No | The implementation acknowledgement version. |
| batchImplementationAcknowledgements | boolean | Yes | The value indicating whether to batch implementation acknowledgements. |
| needLoopForValidMessages | boolean | Yes | The value indicating whether a loop is needed for valid messages. |
| sendSynchronousAcknowledgement | boolean | Yes | The value indicating whether to send synchronous acknowledgement. |
| acknowledgementControlNumberPrefix | string | No | The acknowledgement control number prefix. |
| acknowledgementControlNumberSuffix | string | No | The acknowledgement control number suffix. |
| acknowledgementControlNumberLowerBound | integer | Yes | The acknowledgement control number lower bound. |
| acknowledgementControlNumberUpperBound | integer | Yes | The acknowledgement control number upper bound. |
| rolloverAcknowledgementControlNumber | boolean | Yes | The value indicating whether to rollover acknowledgement control number. |
X12MessageFilter object
| Name | Type | Required | Value |
|---|---|---|---|
| messageFilterType | enum | Yes | The message filter type. - NotSpecified, Include, Exclude |
X12SecuritySettings object
| Name | Type | Required | Value |
|---|---|---|---|
| authorizationQualifier | string | Yes | The authorization qualifier. |
| authorizationValue | string | No | The authorization value. |
| securityQualifier | string | Yes | The security qualifier. |
| passwordValue | string | No | The password value. |
X12ProcessingSettings object
| Name | Type | Required | Value |
|---|---|---|---|
| maskSecurityInfo | boolean | Yes | The value indicating whether to mask security information. |
| convertImpliedDecimal | boolean | Yes | The value indicating whether to convert numerical type to implied decimal. |
| preserveInterchange | boolean | Yes | The value indicating whether to preserve interchange. |
| suspendInterchangeOnError | boolean | Yes | The value indicating whether to suspend interchange on error. |
| createEmptyXmlTagsForTrailingSeparators | boolean | Yes | The value indicating whether to create empty xml tags for trailing separators. |
| useDotAsDecimalSeparator | boolean | Yes | The value indicating whether to use dot as decimal separator. |
X12EnvelopeOverride object
| Name | Type | Required | Value |
|---|---|---|---|
| targetNamespace | string | Yes | The target namespace on which this envelope settings has to be applied. |
| protocolVersion | string | Yes | The protocol version on which this envelope settings has to be applied. |
| messageId | string | Yes | The message id on which this envelope settings has to be applied. |
| responsibleAgencyCode | string | Yes | The responsible agency code. |
| headerVersion | string | Yes | The header version. |
| senderApplicationId | string | Yes | The sender application id. |
| receiverApplicationId | string | Yes | The receiver application id. |
| functionalIdentifierCode | string | No | The functional identifier code. |
| dateFormat | enum | Yes | The date format. - NotSpecified, CCYYMMDD, YYMMDD |
| timeFormat | enum | Yes | The time format. - NotSpecified, HHMM, HHMMSS, HHMMSSdd, HHMMSSd |
X12ValidationOverride object
| Name | Type | Required | Value |
|---|---|---|---|
| messageId | string | Yes | The message id on which the validation settings has to be applied. |
| validateEDITypes | boolean | Yes | The value indicating whether to validate EDI types. |
| validateXSDTypes | boolean | Yes | The value indicating whether to validate XSD types. |
| allowLeadingAndTrailingSpacesAndZeroes | boolean | Yes | The value indicating whether to allow leading and trailing spaces and zeroes. |
| validateCharacterSet | boolean | Yes | The value indicating whether to validate character Set. |
| trimLeadingAndTrailingSpacesAndZeroes | boolean | Yes | The value indicating whether to trim leading and trailing spaces and zeroes. |
| trailingSeparatorPolicy | enum | Yes | The trailing separator policy. - NotSpecified, NotAllowed, Optional, Mandatory |
X12MessageIdentifier object
| Name | Type | Required | Value |
|---|---|---|---|
| messageId | string | Yes | The message id. |
X12SchemaReference object
| Name | Type | Required | Value |
|---|---|---|---|
| messageId | string | Yes | The message id. |
| senderApplicationId | string | No | The sender application id. |
| schemaVersion | string | Yes | The schema version. |
| schemaName | string | Yes | The schema name. |
X12DelimiterOverrides object
| Name | Type | Required | Value |
|---|---|---|---|
| protocolVersion | string | No | The protocol version. |
| messageId | string | No | The message id. |
| dataElementSeparator | integer | Yes | The data element separator. |
| componentSeparator | integer | Yes | The component separator. |
| segmentTerminator | integer | Yes | The segment terminator. |
| segmentTerminatorSuffix | enum | Yes | The segment terminator suffix. - NotSpecified, None, CR, LF, CRLF |
| replaceCharacter | integer | Yes | The replacement character. |
| replaceSeparatorsInPayload | boolean | Yes | The value indicating whether to replace separators in payload. |
| targetNamespace | string | No | The target namespace on which this delimiter settings has to be applied. |
EdifactValidationSettings object
| Name | Type | Required | Value |
|---|---|---|---|
| validateCharacterSet | boolean | Yes | The value indicating whether to validate character set in the message. |
| checkDuplicateInterchangeControlNumber | boolean | Yes | The value indicating whether to check for duplicate interchange control number. |
| interchangeControlNumberValidityDays | integer | Yes | The validity period of interchange control number. |
| checkDuplicateGroupControlNumber | boolean | Yes | The value indicating whether to check for duplicate group control number. |
| checkDuplicateTransactionSetControlNumber | boolean | Yes | The value indicating whether to check for duplicate transaction set control number. |
| validateEDITypes | boolean | Yes | The value indicating whether to Whether to validate EDI types. |
| validateXSDTypes | boolean | Yes | The value indicating whether to Whether to validate XSD types. |
| allowLeadingAndTrailingSpacesAndZeroes | boolean | Yes | The value indicating whether to allow leading and trailing spaces and zeroes. |
| trimLeadingAndTrailingSpacesAndZeroes | boolean | Yes | The value indicating whether to trim leading and trailing spaces and zeroes. |
| trailingSeparatorPolicy | enum | Yes | The trailing separator policy. - NotSpecified, NotAllowed, Optional, Mandatory |
EdifactFramingSettings object
| Name | Type | Required | Value |
|---|---|---|---|
| serviceCodeListDirectoryVersion | string | No | The service code list directory version. |
| characterEncoding | string | No | The character encoding. |
| protocolVersion | integer | Yes | The protocol version. |
| dataElementSeparator | integer | Yes | The data element separator. |
| componentSeparator | integer | Yes | The component separator. |
| segmentTerminator | integer | Yes | The segment terminator. |
| releaseIndicator | integer | Yes | The release indicator. |
| repetitionSeparator | integer | Yes | The repetition separator. |
| characterSet | enum | Yes | The EDIFACT frame setting characterSet. - NotSpecified, UNOB, UNOA, UNOC, UNOD, UNOE, UNOF, UNOG, UNOH, UNOI, UNOJ, UNOK, UNOX, UNOY, KECA |
| decimalPointIndicator | enum | Yes | The EDIFACT frame setting decimal indicator. - NotSpecified, Comma, Decimal |
| segmentTerminatorSuffix | enum | Yes | The EDIFACT frame setting segment terminator suffix. - NotSpecified, None, CR, LF, CRLF |
EdifactEnvelopeSettings object
| Name | Type | Required | Value |
|---|---|---|---|
| groupAssociationAssignedCode | string | No | The group association assigned code. |
| communicationAgreementId | string | No | The communication agreement id. |
| applyDelimiterStringAdvice | boolean | Yes | The value indicating whether to apply delimiter string advice. |
| createGroupingSegments | boolean | Yes | The value indicating whether to create grouping segments. |
| enableDefaultGroupHeaders | boolean | Yes | The value indicating whether to enable default group headers. |
| recipientReferencePasswordValue | string | No | The recipient reference password value. |
| recipientReferencePasswordQualifier | string | No | The recipient reference password qualifier. |
| applicationReferenceId | string | No | The application reference id. |
| processingPriorityCode | string | No | The processing priority code. |
| interchangeControlNumberLowerBound | integer | Yes | The interchange control number lower bound. |
| interchangeControlNumberUpperBound | integer | Yes | The interchange control number upper bound. |
| rolloverInterchangeControlNumber | boolean | Yes | The value indicating whether to rollover interchange control number. |
| interchangeControlNumberPrefix | string | No | The interchange control number prefix. |
| interchangeControlNumberSuffix | string | No | The interchange control number suffix. |
| senderReverseRoutingAddress | string | No | The sender reverse routing address. |
| receiverReverseRoutingAddress | string | No | The receiver reverse routing address. |
| functionalGroupId | string | No | The functional group id. |
| groupControllingAgencyCode | string | No | The group controlling agency code. |
| groupMessageVersion | string | No | The group message version. |
| groupMessageRelease | string | No | The group message release. |
| groupControlNumberLowerBound | integer | Yes | The group control number lower bound. |
| groupControlNumberUpperBound | integer | Yes | The group control number upper bound. |
| rolloverGroupControlNumber | boolean | Yes | The value indicating whether to rollover group control number. |
| groupControlNumberPrefix | string | No | The group control number prefix. |
| groupControlNumberSuffix | string | No | The group control number suffix. |
| groupApplicationReceiverQualifier | string | No | The group application receiver qualifier. |
| groupApplicationReceiverId | string | No | The group application receiver id. |
| groupApplicationSenderQualifier | string | No | The group application sender qualifier. |
| groupApplicationSenderId | string | No | The group application sender id. |
| groupApplicationPassword | string | No | The group application password. |
| overwriteExistingTransactionSetControlNumber | boolean | Yes | The value indicating whether to overwrite existing transaction set control number. |
| transactionSetControlNumberPrefix | string | No | The transaction set control number prefix. |
| transactionSetControlNumberSuffix | string | No | The transaction set control number suffix. |
| transactionSetControlNumberLowerBound | integer | Yes | The transaction set control number lower bound. |
| transactionSetControlNumberUpperBound | integer | Yes | The transaction set control number upper bound. |
| rolloverTransactionSetControlNumber | boolean | Yes | The value indicating whether to rollover transaction set control number. |
| isTestInterchange | boolean | Yes | The value indicating whether the message is a test interchange. |
| senderInternalIdentification | string | No | The sender internal identification. |
| senderInternalSubIdentification | string | No | The sender internal sub identification. |
| receiverInternalIdentification | string | No | The receiver internal identification. |
| receiverInternalSubIdentification | string | No | The receiver internal sub identification. |
EdifactAcknowledgementSettings object
| Name | Type | Required | Value |
|---|---|---|---|
| needTechnicalAcknowledgement | boolean | Yes | The value indicating whether technical acknowledgement is needed. |
| batchTechnicalAcknowledgements | boolean | Yes | The value indicating whether to batch the technical acknowledgements. |
| needFunctionalAcknowledgement | boolean | Yes | The value indicating whether functional acknowledgement is needed. |
| batchFunctionalAcknowledgements | boolean | Yes | The value indicating whether to batch functional acknowledgements. |
| needLoopForValidMessages | boolean | Yes | The value indicating whether a loop is needed for valid messages. |
| sendSynchronousAcknowledgement | boolean | Yes | The value indicating whether to send synchronous acknowledgement. |
| acknowledgementControlNumberPrefix | string | No | The acknowledgement control number prefix. |
| acknowledgementControlNumberSuffix | string | No | The acknowledgement control number suffix. |
| acknowledgementControlNumberLowerBound | integer | Yes | The acknowledgement control number lower bound. |
| acknowledgementControlNumberUpperBound | integer | Yes | The acknowledgement control number upper bound. |
| rolloverAcknowledgementControlNumber | boolean | Yes | The value indicating whether to rollover acknowledgement control number. |
EdifactMessageFilter object
| Name | Type | Required | Value |
|---|---|---|---|
| messageFilterType | enum | Yes | The message filter type. - NotSpecified, Include, Exclude |
EdifactProcessingSettings object
| Name | Type | Required | Value |
|---|---|---|---|
| maskSecurityInfo | boolean | Yes | The value indicating whether to mask security information. |
| preserveInterchange | boolean | Yes | The value indicating whether to preserve interchange. |
| suspendInterchangeOnError | boolean | Yes | The value indicating whether to suspend interchange on error. |
| createEmptyXmlTagsForTrailingSeparators | boolean | Yes | The value indicating whether to create empty xml tags for trailing separators. |
| useDotAsDecimalSeparator | boolean | Yes | The value indicating whether to use dot as decimal separator. |
EdifactEnvelopeOverride object
| Name | Type | Required | Value |
|---|---|---|---|
| messageId | string | No | The message id on which this envelope settings has to be applied. |
| messageVersion | string | No | The message version on which this envelope settings has to be applied. |
| messageRelease | string | No | The message release version on which this envelope settings has to be applied. |
| messageAssociationAssignedCode | string | No | The message association assigned code. |
| targetNamespace | string | No | The target namespace on which this envelope settings has to be applied. |
| functionalGroupId | string | No | The functional group id. |
| senderApplicationQualifier | string | No | The sender application qualifier. |
| senderApplicationId | string | No | The sender application id. |
| receiverApplicationQualifier | string | No | The receiver application qualifier. |
| receiverApplicationId | string | No | The receiver application id. |
| controllingAgencyCode | string | No | The controlling agency code. |
| groupHeaderMessageVersion | string | No | The group header message version. |
| groupHeaderMessageRelease | string | No | The group header message release. |
| associationAssignedCode | string | No | The association assigned code. |
| applicationPassword | string | No | The application password. |
EdifactMessageIdentifier object
| Name | Type | Required | Value |
|---|---|---|---|
| messageId | string | Yes | The message id on which this envelope settings has to be applied. |
EdifactSchemaReference object
| Name | Type | Required | Value |
|---|---|---|---|
| messageId | string | Yes | The message id. |
| messageVersion | string | Yes | The message version. |
| messageRelease | string | Yes | The message release version. |
| senderApplicationId | string | No | The sender application id. |
| senderApplicationQualifier | string | No | The sender application qualifier. |
| associationAssignedCode | string | No | The association assigned code. |
| schemaName | string | Yes | The schema name. |
EdifactValidationOverride object
| Name | Type | Required | Value |
|---|---|---|---|
| messageId | string | Yes | The message id on which the validation settings has to be applied. |
| enforceCharacterSet | boolean | Yes | The value indicating whether to validate character Set. |
| validateEDITypes | boolean | Yes | The value indicating whether to validate EDI types. |
| validateXSDTypes | boolean | Yes | The value indicating whether to validate XSD types. |
| allowLeadingAndTrailingSpacesAndZeroes | boolean | Yes | The value indicating whether to allow leading and trailing spaces and zeroes. |
| trailingSeparatorPolicy | enum | Yes | The trailing separator policy. - NotSpecified, NotAllowed, Optional, Mandatory |
| trimLeadingAndTrailingSpacesAndZeroes | boolean | Yes | The value indicating whether to trim leading and trailing spaces and zeroes. |
EdifactDelimiterOverride object
| Name | Type | Required | Value |
|---|---|---|---|
| messageId | string | No | The message id. |
| messageVersion | string | No | The message version. |
| messageRelease | string | No | The message release. |
| dataElementSeparator | integer | Yes | The data element separator. |
| componentSeparator | integer | Yes | The component separator. |
| segmentTerminator | integer | Yes | The segment terminator. |
| repetitionSeparator | integer | Yes | The repetition separator. |
| segmentTerminatorSuffix | enum | Yes | The segment terminator suffix. - NotSpecified, None, CR, LF, CRLF |
| decimalPointIndicator | enum | Yes | The decimal point indicator. - NotSpecified, Comma, Decimal |
| releaseIndicator | integer | Yes | The release indicator. |
| messageAssociationAssignedCode | string | No | The message association assigned code. |
| targetNamespace | string | No | The target namespace on which this delimiter settings has to be applied. |
Quickstart templates
The following quickstart templates deploy this resource type.
| Template | Description |
|---|---|
Azure Logic Apps - AS2 Send Receive |
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. |