Partilhar via


Integração Microsoft.LogicContas/contratos

Definição de recursos do bíceps

O tipo de recurso integrationAccounts/agreements pode ser implantado com operações que visam:

Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.

Formato do recurso

Para criar um recurso Microsoft.Logic/integrationAccounts/agreements, adicione o seguinte Bicep ao seu modelo.

resource symbolicname 'Microsoft.Logic/integrationAccounts/agreements@2019-05-01' = {
  parent: resourceSymbolicName
  location: 'string'
  name: 'string'
  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
              sha2AlgorithmFormat: 'string'
              signingCertificateName: 'string'
            }
            validationSettings: {
              checkCertificateRevocationListOnReceive: bool
              checkCertificateRevocationListOnSend: bool
              checkDuplicateMessage: bool
              compressMessage: bool
              encryptionAlgorithm: 'string'
              encryptMessage: bool
              interchangeDuplicatesValidityDays: int
              overrideMessageProperties: bool
              signingAlgorithm: 'string'
              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
              sha2AlgorithmFormat: 'string'
              signingCertificateName: 'string'
            }
            validationSettings: {
              checkCertificateRevocationListOnReceive: bool
              checkCertificateRevocationListOnSend: bool
              checkDuplicateMessage: bool
              compressMessage: bool
              encryptionAlgorithm: 'string'
              encryptMessage: bool
              interchangeDuplicatesValidityDays: int
              overrideMessageProperties: bool
              signingAlgorithm: 'string'
              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: 'string'
                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: 'string'
                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(Azure.Bicep.Types.Concrete.AnyType)
  }
  tags: {
    {customized property}: 'string'
  }
}

Valores de propriedade

ContratoConteúdo

Designação Descrição Valor
aS2 O conteúdo do contrato AS2. AS2AgreementContent
edifact Conteúdo do acordo EDIFACT. EdifactAgreementConteúdo
x12 O conteúdo do contrato X12. X12AgreementConteúdo

AS2AcknowledgementConnectionSettings

Designação Descrição Valor
ignoreCertificateNameMismatch Indica se a incompatibilidade deve ser ignorada no nome do certificado. bool (obrigatório)
keepHttpConnectionAlive Indica se a conexão deve ser mantida ativa. bool (obrigatório)
suporteHttpStatusCodeContinue Indica se o código de status HTTP 'CONTINUE' deve ser suportado. bool (obrigatório)
unfoldHttpHeaders Indica se os cabeçalhos HTTP devem ser desdobrados. bool (obrigatório)

AS2AgreementContent

Designação Descrição Valor
receberAcordo O AS2 unidirecional recebe acordo. AS2OneWayAgreement (obrigatório)
sendAgreement O contrato de envio unidirecional AS2. AS2OneWayAgreement (obrigatório)

AS2EnvelopeSettings

Designação Descrição Valor
autogenerateFileName O valor que indica se o nome do arquivo deve ser gerado automaticamente. bool (obrigatório)
fileNameTemplate O modelo para nome de arquivo. string (obrigatório)
messageContentType O tipo de conteúdo da mensagem. string (obrigatório)
suspendMessageOnFileNameGenerationError O valor que indica se a mensagem deve ser suspensa no erro de geração de nome de arquivo. bool (obrigatório)
transmitFileNameInMimeHeader O valor que indica se o nome do arquivo deve ser transmitido no cabeçalho mime. bool (obrigatório)

AS2ErrorSettings

Designação Descrição Valor
resendIfMDNNotReceived O valor que indica se a mensagem deve ser reenviada se o MDN não for recebido. bool (obrigatório)
suspendDuplicateMessage O valor que indica se a mensagem duplicada deve ser suspensa. bool (obrigatório)

AS2MdnConfigurações

Designação Descrição Valor
dispositionNotificationTo A notificação de disposição para o valor do cabeçalho. string
mdnText O texto MDN. string
micHashingAlgorithm O algoritmo de assinatura ou hash. «MD5»
'Nenhuma'
'Não especificado'
'SHA1'
'SHA2256'
'SHA2384'
'SHA2512' (obrigatório)
necessidadeMDN O valor que indica se um MDN deve ser enviado ou solicitado. bool (obrigatório)
receiptDeliveryUrl O URL de entrega do recibo. string
sendInboundMDNToMessageBox O valor que indica se a caixa de mensagem deve enviar MDN de entrada para a caixa de mensagem. bool (obrigatório)
sendMDNAsynchronously O valor que indica se o MDN assíncrono deve ser enviado. bool (obrigatório)
signMDN O valor que indica se o MDN precisa ser assinado ou não. bool (obrigatório)
signOutboundMDNIfOptional O valor que indica se o MDN de saída deve ser assinado, se opcional. bool (obrigatório)

AS2MessageConnectionSettings

Designação Descrição Valor
ignoreCertificateNameMismatch O valor que indica se a incompatibilidade deve ser ignorada no nome do certificado. bool (obrigatório)
keepHttpConnectionAlive O valor que indica se a conexão deve ser mantida ativa. bool (obrigatório)
suporteHttpStatusCodeContinue O valor que indica se deve suportar o código de status HTTP 'CONTINUE'. bool (obrigatório)
unfoldHttpHeaders O valor que indica se os cabeçalhos HTTP devem ser desdobrados. bool (obrigatório)

AS2OneWayAcordo

Designação Descrição Valor
protocolSettings As configurações do protocolo AS2. AS2ProtocolSettings (obrigatório)
destinatárioIdentidade de negócios A identidade comercial do destinatário BusinessIdentity (obrigatório)
senderBusinessIdentity A identidade comercial do remetente BusinessIdentity (obrigatório)

AS2ProtocolSettings

Designação Descrição Valor
acknowledgementConnectionSettings As configurações de conexão de confirmação. AS2AcknowledgementConnectionSettings (obrigatório)
envelopeSettings As configurações do envelope. AS2EnvelopeSettings (obrigatório)
errorSettings As configurações de erro. AS2ErrorSettings (obrigatório)
mdnConfigurações As configurações de MDN. AS2MdnSettings (obrigatório)
messageConnectionSettings As configurações de conexão da mensagem. AS2MessageConnectionSettings (obrigatório)
securityConfigurações: As configurações de segurança. AS2SecuritySettings (obrigatório)
validationSettings As configurações de validação. AS2ValidationSettings (obrigatório)

AS2SecuritySettings

Designação Descrição Valor
enableNRRForInboundDecodedMessages O valor que indica se a NRR deve ser habilitada para mensagens decodificadas de entrada. bool (obrigatório)
enableNRRForInboundEncodedMessages O valor que indica se a NRR deve ser habilitada para mensagens codificadas de entrada. bool (obrigatório)
enableNRRForInboundMDN O valor que indica se o NRR deve ser habilitado para MDN de entrada. bool (obrigatório)
enableNRRForOutboundDecodedMessages O valor que indica se a NRR deve ser habilitada para mensagens decodificadas de saída. bool (obrigatório)
enableNRRForOutboundEncodedMessages O valor que indica se a NRR deve ser habilitada para mensagens codificadas de saída. bool (obrigatório)
enableNRRForOutboundMDN O valor que indica se o NRR deve ser habilitado para MDN de saída. bool (obrigatório)
encryptionCertificateName O nome do certificado de criptografia. string
overrideGroupSigningCertificate O valor que indica se um MDN deve ser enviado ou solicitado. bool (obrigatório)
sha2AlgorithmFormat O formato do algoritmo Sha2. Os valores válidos são Sha2, ShaHashSize, ShaHyphenHashSize, Sha2UnderscoreHashSize. string
assinandoCertificateName O nome do certificado de assinatura. string

AS2ValidationSettings

Designação Descrição Valor
checkCertificateRevocationListOnReceive O valor que indica se a lista de revogação de certificados deve ser verificada ao receber. bool (obrigatório)
checkCertificateRevocationListOnSend O valor que indica se a lista de revogação de certificados deve ser verificada no envio. bool (obrigatório)
checkDuplicateMessage O valor que indica se a mensagem duplicada deve ser verificada. bool (obrigatório)
compressMessage O valor que indica se a mensagem deve ser compactada. bool (obrigatório)
encryptionAlgoritmo O algoritmo de encriptação. «AES128»
«AES192»
«AES256»
«DES3»
'Nenhuma'
'Não especificado'
«RC2» (obrigatório)
encriptação Mensagem O valor que indica se a mensagem tem de ser encriptada. bool (obrigatório)
interchangeDuplicatesValidityDays O número de dias para olhar para trás para o intercâmbio duplicado. int (obrigatório)
overrideMessageProperties O valor que indica se as propriedades da mensagem de entrada devem ser substituídas pelas que estão em acordo. bool (obrigatório)
signingAlgorithm O algoritmo de assinatura. 'Inadimplência'
'Não especificado'
'SHA1'
'SHA2256'
'SHA2384'
'SHA2512'
signMensagem O valor que indica se a mensagem deve ser assinada. bool (obrigatório)

Identidade Empresarial

Designação Descrição Valor
Qualificador O qualificador de identidade comercial, por exemplo, as2identity, ZZ, ZZZ, 31, 32 string (obrigatório)
valor O valor da identidade comercial definida pelo usuário. string (obrigatório)

EdifactAcknowledgementSettings

Designação Descrição Valor
reconhecimentoControlNumberLowerBound O limite inferior do número de controle de confirmação. int (obrigatório)
reconhecimentoControlNumberPrefix O prefixo do número de controle de confirmação. string
acknowledgementControlNumberSuffix O sufixo do número de controle de confirmação. string
reconhecimentoControlNumberUpperBound O limite superior do número de controle de confirmação. int (obrigatório)
batchFuncionalAgradecimentos O valor que indica se as confirmações funcionais de lote devem ser feitas. bool (obrigatório)
batchTechnicalAgradecimentos O valor que indica se os agradecimentos técnicos devem ser agrupados. bool (obrigatório)
necessidadeReconhecimento Funcional O valor que indica se o reconhecimento funcional é necessário. bool (obrigatório)
needLoopForValidMessages O valor que indica se um loop é necessário para mensagens válidas. bool (obrigatório)
necessidadeReconhecimento técnico O valor que indica se o reconhecimento técnico é necessário. bool (obrigatório)
rolloverConfirmaçãoControlNumber O valor que indica se o número de controle de confirmação de rolagem deve ser feito. bool (obrigatório)
sendSynchronousReconhecimento O valor que indica se a confirmação síncrona deve ser enviada. bool (obrigatório)

EdifactAgreementContent

Designação Descrição Valor
receberAcordo O acordo de sentido único EDIFACT. EdifactOneWayAgreement (obrigatório)
sendAgreement O acordo de envio unidirecional EDIFACT. EdifactOneWayAgreement (obrigatório)

EdifactDelimiterOverride

Designação Descrição Valor
componentSeparador O separador de componentes. int (obrigatório)
dataElementSeparator O separador de elemento de dados. int (obrigatório)
decimalPointIndicator O indicador de vírgula decimal. 'Vírgula'
'Decimal'
'NotSpecified' (obrigatório)
messageAssociationAssignedCode O código atribuído à associação de mensagens. string
messageId O ID da mensagem. string
messageRelease A liberação da mensagem. string
messageVersion A versão da mensagem. string
releaseIndicator O indicador de lançamento. int (obrigatório)
repetiçãoSeparador O separador de repetição. int (obrigatório)
segmentTerminador O terminador de segmento. int (obrigatório)
segmentTerminatorSufixo O sufixo terminador de segmento. «CR»
'CRLF'
'LF'
'Nenhuma'
'NotSpecified' (obrigatório)
targetNamespace O namespace de destino no qual essas configurações de delimitador devem ser aplicadas. string

EdifactEnvelopeOverride

Designação Descrição Valor
applicationPassword A senha do aplicativo. string
associaçãoAssignedCode A associação atribuiu o código. string
controllingAgencyCode O código da agência controladora. string
funcionalGroupId O id do grupo funcional. string
groupHeaderMessageRelease A liberação da mensagem de cabeçalho do grupo. string
groupHeaderMessageVersion A versão da mensagem do cabeçalho do grupo. string
messageAssociationAssignedCode O código atribuído à associação de mensagens. string
messageId O ID da mensagem no qual as configurações desse envelope devem ser aplicadas. string
messageRelease A versão de liberação de mensagem na qual essas configurações de envelope devem ser aplicadas. string
messageVersion A versão da mensagem na qual as configurações desse envelope devem ser aplicadas. string
receiverApplicationId O ID do aplicativo do recetor. string
receiverApplicationQualifier O qualificador do aplicativo do recetor. string
senderApplicationId A ID do aplicativo remetente. string
senderApplicationQualifier O qualificador do aplicativo remetente. string
targetNamespace O namespace de destino no qual essas configurações de envelope devem ser aplicadas. string

EdifactEnvelopeSettings

Designação Descrição Valor
applicationReferenceId A ID de referência do aplicativo. string
applyDelimiterStringAdvice O valor que indica se o aviso de cadeia de caracteres do delimitador deve ser aplicado. bool (obrigatório)
communicationAgreementId O contrato de comunicação id. string
createGroupingSegments O valor que indica se os segmentos de agrupamento devem ser criados. bool (obrigatório)
enableDefaultGroupHeaders O valor que indica se os cabeçalhos de grupo padrão devem ser habilitados. bool (obrigatório)
funcionalGroupId O id do grupo funcional. string
groupApplicationPassword A senha do aplicativo de grupo. string
groupApplicationReceiverId A ID do recetor do aplicativo de grupo. string
groupApplicationReceiverQualifier O qualificador do recetor do aplicativo de grupo. string
groupApplicationSenderId A ID do remetente do aplicativo de grupo. string
groupApplicationSenderQualifier O qualificador do remetente do aplicativo de grupo. string
groupAssociationAssignedCode A associação de grupo atribuiu o código. string
groupControllingAgencyCode O código da agência controladora do grupo. string
groupControlNumberLowerBound O limite inferior do número de controle de grupo. int (obrigatório)
groupControlNumberPrefix O prefixo do número de controle de grupo. string
groupControlNumberSuffix O sufixo do número de controle do grupo. string
groupControlNumberUpperBound O limite superior do número de controle de grupo. int (obrigatório)
groupMessageRelease A liberação da mensagem de grupo. string
groupMessageVersion A versão da mensagem de grupo. string
interchangeControlNumberLowerBound O limite inferior do número de controle de intercâmbio. int (obrigatório)
interchangeControlNumberPrefix O prefixo do número de controle de intercâmbio. string
interchangeControlNumberSuffix O sufixo do número de controle de intercâmbio. string
interchangeControlNumberUpperBound O limite superior do número de controle de intercâmbio. int (obrigatório)
isTestInterchange O valor que indica se a mensagem é um intercâmbio de teste. bool (obrigatório)
overwriteExistingTransactionSetControlNumber O valor que indica se o número de controle do conjunto de transações existente deve ser substituído. bool (obrigatório)
processandoPriorityCode O código de prioridade de processamento. string
receiverIdentificação Interna A identificação interna do recetor. string
receptorInternalSubIdentification A subidentificação interna do recetor. string
receiverReverseRoutingAddress O endereço de roteamento reverso do recetor. string
recipientReferencePasswordQualifier O qualificador de senha de referência do destinatário. string
recipientReferencePasswordValue O valor da senha de referência do destinatário. string
rolloverGroupControlNumber O valor que indica se o número de controle do grupo deve ser substituído. bool (obrigatório)
rolloverInterchangeControlNumber O valor que indica se o número de controle de intercâmbio deve ser substituído. bool (obrigatório)
rolloverTransactionSetControlNumber O valor que indica se o número de controle do conjunto de transações de rollover deve ser feito. bool (obrigatório)
senderIdentificação Interna A identificação interna do remetente. string
senderInternalSubIdentification A subidentificação interna do remetente. string
senderReverseRoutingAddress O endereço de roteamento reverso do remetente. string
transactionSetControlNumberLowerBound O número de controle do conjunto de transações limite inferior. int (obrigatório)
transactionSetControlNumberPrefix O prefixo do número de controle do conjunto de transações. string
transactionSetControlNumberSuffix O sufixo do número de controle do conjunto de transações. string
transactionSetControlNumberUpperBound O limite superior do número de controle do conjunto de transações. int (obrigatório)

EdifactFramingSettings

Designação Descrição Valor
characterEncoding A codificação de caracteres. string
conjunto de caracteres O caractere de configuração de quadro EDIFACT. 'KECA'
'Não especificado'
'UNOA'
'UNOB'
«UNOC»
'UNOD'
'UNOE'
'SEM OF'
«UNOG»
'UNOH'
«UNOI»
"UNOJ"
'UNOK'
'UNOX'
«UNOY» (obrigatório)
componentSeparador O separador de componentes. int (obrigatório)
dataElementSeparator O separador de elemento de dados. int (obrigatório)
decimalPointIndicator O indicador decimal de configuração do quadro EDIFACT. 'Vírgula'
'Decimal'
'NotSpecified' (obrigatório)
protocolVersion A versão do protocolo. int (obrigatório)
releaseIndicator O indicador de lançamento. int (obrigatório)
repetiçãoSeparador O separador de repetição. int (obrigatório)
segmentTerminador O terminador de segmento. int (obrigatório)
segmentTerminatorSufixo O sufixo do terminador de segmento de configuração de quadro EDIFACT. «CR»
'CRLF'
'LF'
'Nenhuma'
'NotSpecified' (obrigatório)
serviceCodeListDirectoryVersion A versão do diretório da lista de códigos de serviço. string

EdifactMessageFilter

Designação Descrição Valor
messageFilterType O tipo de filtro de mensagem. 'Excluir'
'Incluir'
'NotSpecified' (obrigatório)

EdifactMessageIdentifier

Designação Descrição Valor
messageId O ID da mensagem no qual as configurações desse envelope devem ser aplicadas. string (obrigatório)

EdifactOneWayAgreement

Designação Descrição Valor
protocolSettings As configurações do protocolo EDIFACT. EdifactProtocolSettings (obrigatório)
destinatárioIdentidade de negócios A identidade comercial do destinatário BusinessIdentity (obrigatório)
senderBusinessIdentity A identidade comercial do remetente BusinessIdentity (obrigatório)

EdifactProcessingSettings

Designação Descrição Valor
createEmptyXmlTagsForTrailingSeparators O valor que indica se as marcas xml vazias devem ser criadas para separadores à direita. bool (obrigatório)
máscaraSecurityInfo O valor que indica se as informações de segurança devem ser mascaradas. bool (obrigatório)
preserveInterchange O valor que indica se o intercâmbio deve ser preservado. bool (obrigatório)
suspendInterchangeOnError O valor que indica se o intercâmbio deve ser suspenso em caso de erro. bool (obrigatório)
useDotAsDecimalSeparator O valor que indica se o ponto deve ser usado como separador decimal. bool (obrigatório)

EdifactProtocolSettings

Designação Descrição Valor
acknowledgementSettings As configurações de reconhecimento EDIFACT. EdifactAcknowledgementSettings (obrigatório)
edifactDelimiterSubstitui O delimitador EDIFACT substitui as configurações. EdifactDelimiterOverride[]
envelopeSubstitui O envelope EDIFACT substitui as configurações. EdifactEnvelopeOverride[]
envelopeSettings As configurações do envelope EDIFACT. EdifactEnvelopeSettings (obrigatório)
enquadramentoConfigurações As configurações de enquadramento EDIFACT. EdifactFramingSettings (obrigatório)
messageFilter O filtro de mensagens EDIFACT. EdifactMessageFilter (obrigatório)
messageFilterList A lista de filtros de mensagens EDIFACT. EdifactMessageIdentifier[]
processandoConfigurações As configurações de processamento EDIFACT. EdifactProcessingSettings (obrigatório)
schemaReferências As referências do esquema EDIFACT. EdifactSchemaReference[] (obrigatório)
validaçãoSubstitui As configurações de substituição de validação EDIFACT. EdifactValidationOverride[]
validationSettings As configurações de validação EDIFACT. EdifactValidationSettings (obrigatório)

EdifactSchemaReference

Designação Descrição Valor
associaçãoAssignedCode A associação atribuiu o código. string
messageId O ID da mensagem. string (obrigatório)
messageRelease A versão de lançamento da mensagem. string (obrigatório)
messageVersion A versão da mensagem. string (obrigatório)
schemaName O nome do esquema. string (obrigatório)
senderApplicationId A ID do aplicativo remetente. string
senderApplicationQualifier O qualificador do aplicativo remetente. string

EdifactValidationOverride

Designação Descrição Valor
allowLeadingAndTrailingSpacesAndZeroes O valor que indica se devem ser permitidos espaços à esquerda e à direita e zeros. bool (obrigatório)
enforceCharacterSet O valor que indica se o conjunto de caracteres deve ser validado. bool (obrigatório)
messageId O ID da mensagem no qual as configurações de validação devem ser aplicadas. string (obrigatório)
trailingSeparatorPolicy A política do separador à direita. 'Obrigatório'
'Não permitido'
'Não especificado'
'Opcional' (obrigatório)
trimLeadingAndTrailingSpacesAndZeroes O valor que indica se os espaços à esquerda e à direita devem ser cortados e zeros. bool (obrigatório)
validateEDITypes O valor que indica se os tipos EDI devem ser validados. bool (obrigatório)
validateXSDTypes O valor que indica se os tipos XSD devem ser validados. bool (obrigatório)

EdifactValidationSettings

Designação Descrição Valor
allowLeadingAndTrailingSpacesAndZeroes O valor que indica se devem ser permitidos espaços à esquerda e à direita e zeros. bool (obrigatório)
checkDuplicateGroupControlNumber O valor que indica se o número de controle de grupo duplicado deve ser verificado. bool (obrigatório)
checkDuplicateInterchangeControlNumber O valor que indica se o número de controlo de intercâmbio duplicado deve ser verificado. bool (obrigatório)
checkDuplicateTransactionSetControlNumber O valor que indica se o número de controle do conjunto de transações duplicado deve ser verificado. bool (obrigatório)
interchangeControlNumberValidityDays O período de validade do número de controlo de intercâmbio. int (obrigatório)
trailingSeparatorPolicy A política do separador à direita. 'Obrigatório'
'Não permitido'
'Não especificado'
'Opcional' (obrigatório)
trimLeadingAndTrailingSpacesAndZeroes O valor que indica se os espaços à esquerda e à direita devem ser cortados e zeros. bool (obrigatório)
validateCharacterSet O valor que indica se o conjunto de caracteres deve ser validado na mensagem. bool (obrigatório)
validateEDITypes O valor que indica se os tipos EDI devem ser validados. bool (obrigatório)
validateXSDTypes O valor que indica se os tipos XSD devem ser validados. bool (obrigatório)

IntegrationAccountAgreementProperties

Designação Descrição Valor
tipo de acordo O tipo de contrato. «AS2»
'Edifact'
'Não especificado'
'X12' (obrigatório)
Conteúdo O conteúdo do acordo. Contrato de Conteúdo (obrigatório)
guestIdentity A identidade comercial do parceiro convidado. BusinessIdentity (obrigatório)
guestPartner O parceiro de conta de integração definido como parceiro convidado para este contrato. string (obrigatório)
hostIdentity A identidade comercial do parceiro anfitrião. BusinessIdentity (obrigatório)
hostPartner O parceiro de conta de integração definido como parceiro anfitrião para este contrato. string (obrigatório)
metadados Os metadados. qualquer

Microsoft.Logic/integrationAccounts/agreements

Designação Descrição Valor
Localização A localização do recurso. string
Designação O nome do recurso string (obrigatório)
pai No Bicep, você pode especificar o recurso pai para um recurso filho. Você só precisa adicionar essa propriedade quando o recurso filho é declarado fora do recurso pai.

Para obter mais informações, consulte recurso filho fora do recurso pai.
Nome simbólico para recurso do tipo: integrationAccounts
propriedades As propriedades do contrato de conta de integração. IntegrationAccountAgreementProperties (obrigatório)
Etiquetas Tags de recursos Dicionário de nomes e valores de tags. Consulte Tags em modelos

Tags de Recursos

Designação Descrição Valor

X12AcknowledgementSettings

Designação Descrição Valor
reconhecimentoControlNumberLowerBound O limite inferior do número de controle de confirmação. int (obrigatório)
reconhecimentoControlNumberPrefix O prefixo do número de controle de confirmação. string
acknowledgementControlNumberSuffix O sufixo do número de controle de confirmação. string
reconhecimentoControlNumberUpperBound O limite superior do número de controle de confirmação. int (obrigatório)
batchFuncionalAgradecimentos O valor que indica se as confirmações funcionais de lote devem ser feitas. bool (obrigatório)
batchImplementationAgradecimentos O valor que indica se as confirmações de implementação em lote devem ser feitas. bool (obrigatório)
batchTechnicalAgradecimentos O valor que indica se os agradecimentos técnicos devem ser agrupados. bool (obrigatório)
funcionalAgradecimentoVersão A versão de reconhecimento funcional. string
implementaçãoAgradecimentoVersão A versão de confirmação de implementação. string
necessidadeReconhecimento Funcional O valor que indica se o reconhecimento funcional é necessário. bool (obrigatório)
necessidadeImplementaçãoReconhecimento O valor que indica se o reconhecimento da implementação é necessário. bool (obrigatório)
needLoopForValidMessages O valor que indica se um loop é necessário para mensagens válidas. bool (obrigatório)
necessidadeReconhecimento técnico O valor que indica se o reconhecimento técnico é necessário. bool (obrigatório)
rolloverConfirmaçãoControlNumber O valor que indica se o número de controle de confirmação de rolagem deve ser feito. bool (obrigatório)
sendSynchronousReconhecimento O valor que indica se a confirmação síncrona deve ser enviada. bool (obrigatório)

X12AgreementContent

Designação Descrição Valor
receberAcordo O acordo de recebimento unidirecional X12. X12OneWayAgreement (obrigatório)
sendAgreement O contrato de envio unidirecional X12. X12OneWayAgreement (obrigatório)

X12DelimiterSubstitui

Designação Descrição Valor
componentSeparador O separador de componentes. int (obrigatório)
dataElementSeparator O separador de elemento de dados. int (obrigatório)
messageId O ID da mensagem. string
protocolVersion A versão do protocolo. string
replaceCharacter O caráter de substituição. int (obrigatório)
replaceSeparatorsInPayload O valor que indica se os separadores devem ser substituídos na carga útil. bool (obrigatório)
segmentTerminador O terminador de segmento. int (obrigatório)
segmentTerminatorSufixo O sufixo terminador de segmento. «CR»
'CRLF'
'LF'
'Nenhuma'
'NotSpecified' (obrigatório)
targetNamespace O namespace de destino no qual essas configurações de delimitador devem ser aplicadas. string

X12EnvelopeOverride

Designação Descrição Valor
dateFormat O formato de data. «CCYYMMDD»
'Não especificado'
«AAMMDD» (obrigatório)
functionalIdentifierCode O código identificador funcional. string
headerVersion A versão do cabeçalho. string (obrigatório)
messageId O ID da mensagem no qual as configurações desse envelope devem ser aplicadas. string (obrigatório)
protocolVersion A versão do protocolo na qual essas configurações de envelope devem ser aplicadas. string (obrigatório)
receiverApplicationId O ID do aplicativo do recetor. string (obrigatório)
responsibleAgencyCode O código da agência responsável. string (obrigatório)
senderApplicationId A ID do aplicativo remetente. string (obrigatório)
targetNamespace O namespace de destino no qual essas configurações de envelope devem ser aplicadas. string (obrigatório)
timeFormat O formato de hora. 'HHMM'
'HHMMSS'
'HHMMSSd'
'HHMMSSdd'
'NotSpecified' (obrigatório)

X12EnvelopeSettings

Designação Descrição Valor
controlStandardsId Os padrões de controle id. int (obrigatório)
controlVersionNumber O número da versão de controle. string (obrigatório)
enableDefaultGroupHeaders O valor que indica se os cabeçalhos de grupo padrão devem ser habilitados. bool (obrigatório)
funcionalGroupId O id do grupo funcional. string
groupControlNumberLowerBound O limite inferior do número de controle de grupo. int (obrigatório)
groupControlNumberUpperBound O limite superior do número de controle de grupo. int (obrigatório)
groupHeaderAgencyCode O código da agência de cabeçalho do grupo. string (obrigatório)
groupHeaderDateFormat O formato de data do cabeçalho do grupo. «CCYYMMDD»
'Não especificado'
«AAMMDD» (obrigatório)
groupHeaderTimeFormat O formato de hora do cabeçalho do grupo. 'HHMM'
'HHMMSS'
'HHMMSSd'
'HHMMSSdd'
'NotSpecified' (obrigatório)
groupHeaderVersion A versão do cabeçalho do grupo. string (obrigatório)
interchangeControlNumberLowerBound O limite inferior do número de controle de intercâmbio. int (obrigatório)
interchangeControlNumberUpperBound O limite superior do número de controle de intercâmbio. int (obrigatório)
overwriteExistingTransactionSetControlNumber O valor que indica se o número de controle do conjunto de transações existente deve ser substituído. bool (obrigatório)
receiverApplicationId O ID do aplicativo do recetor. string (obrigatório)
rolloverGroupControlNumber O valor que indica se o número de controle do grupo deve ser substituído. bool (obrigatório)
rolloverInterchangeControlNumber O valor que indica se o número de controle de intercâmbio deve ser substituído. bool (obrigatório)
rolloverTransactionSetControlNumber O valor que indica se o número de controle do conjunto de transações de rollover deve ser feito. bool (obrigatório)
senderApplicationId A ID do aplicativo remetente. string (obrigatório)
transactionSetControlNumberLowerBound O número de controle do conjunto de transações limite inferior. int (obrigatório)
transactionSetControlNumberPrefix O prefixo do número de controle do conjunto de transações. string
transactionSetControlNumberSuffix O sufixo do número de controle do conjunto de transações. string
transactionSetControlNumberUpperBound O limite superior do número de controle do conjunto de transações. int (obrigatório)
usageIndicator O indicador de utilização. 'Informação'
'Não especificado'
'Produção'
'Teste' (obrigatório)
useControlStandardsIdAsRepetitionCharacter O valor que indica se os padrões de controle devem ser usados como caractere de repetição. bool (obrigatório)

X12FramingSettings

Designação Descrição Valor
conjunto de caracteres O conjunto de caracteres X12. 'Básico'
'Prorrogado'
'Não especificado'
'UTF8' (obrigatório)
componentSeparador O separador de componentes. int (obrigatório)
dataElementSeparator O separador de elemento de dados. int (obrigatório)
replaceCharacter O caráter de substituição. int (obrigatório)
replaceSeparatorsInPayload O valor que indica se os separadores devem ser substituídos na carga útil. bool (obrigatório)
segmentTerminador O terminador de segmento. int (obrigatório)
segmentTerminatorSufixo O sufixo terminador de segmento. «CR»
'CRLF'
'LF'
'Nenhuma'
'NotSpecified' (obrigatório)

X12MessageFilter

Designação Descrição Valor
messageFilterType O tipo de filtro de mensagem. 'Excluir'
'Incluir'
'NotSpecified' (obrigatório)

X12MessageIdentifier

Designação Descrição Valor
messageId O ID da mensagem. string (obrigatório)

X12OneWayAcordo

Designação Descrição Valor
protocolSettings As configurações do protocolo X12. X12ProtocolSettings (obrigatório)
destinatárioIdentidade de negócios A identidade comercial do destinatário BusinessIdentity (obrigatório)
senderBusinessIdentity A identidade comercial do remetente BusinessIdentity (obrigatório)

X12ProcessingSettings

Designação Descrição Valor
convertImpliedDecimal O valor que indica se o tipo numérico deve ser convertido em decimal implícito. bool (obrigatório)
createEmptyXmlTagsForTrailingSeparators O valor que indica se as marcas xml vazias devem ser criadas para separadores à direita. bool (obrigatório)
máscaraSecurityInfo O valor que indica se as informações de segurança devem ser mascaradas. bool (obrigatório)
preserveInterchange O valor que indica se o intercâmbio deve ser preservado. bool (obrigatório)
suspendInterchangeOnError O valor que indica se o intercâmbio deve ser suspenso em caso de erro. bool (obrigatório)
useDotAsDecimalSeparator O valor que indica se o ponto deve ser usado como separador decimal. bool (obrigatório)

X12ProtocolSettings

Designação Descrição Valor
acknowledgementSettings As configurações de confirmação do X12. X12AcknowledgementSettings (obrigatório)
envelopeSubstitui O envelope X12 substitui as configurações. X12EnvelopeOverride[]
envelopeSettings As configurações do envelope X12. X12EnvelopeSettings (obrigatório)
enquadramentoConfigurações As configurações de enquadramento X12. X12FramingSettings (obrigatório)
messageFilter O filtro de mensagens X12. X12MessageFilter (obrigatório)
messageFilterList A lista de filtros de mensagens X12. X12MessageIdentifier[]
processandoConfigurações As configurações de processamento do X12. X12ProcessingSettings (obrigatório)
schemaReferências As referências do esquema X12. X12SchemaReference[] (obrigatório)
securityConfigurações: As configurações de segurança do X12. X12SecuritySettings (obrigatório)
validaçãoSubstitui As configurações de substituição de validação X12. X12ValidationOverride[]
validationSettings As configurações de validação do X12. X12ValidationSettings (obrigatório)
x12DelimiterSubstitui O delimitador X12 substitui as configurações. X12DelimiterSubstitui[]

X12SchemaReference

Designação Descrição Valor
messageId O ID da mensagem. string (obrigatório)
schemaName O nome do esquema. string (obrigatório)
schemaVersion A versão do esquema. string (obrigatório)
senderApplicationId A ID do aplicativo remetente. string

X12SecuritySettings

Designação Descrição Valor
authorizationQualificador O qualificador de autorização. string (obrigatório)
authorizationValue O valor da autorização. string
passwordValue O valor da senha. string
securityQualificador O qualificador de segurança. string (obrigatório)

X12ValidationOverride

Designação Descrição Valor
allowLeadingAndTrailingSpacesAndZeroes O valor que indica se devem ser permitidos espaços à esquerda e à direita e zeros. bool (obrigatório)
messageId O ID da mensagem no qual as configurações de validação devem ser aplicadas. string (obrigatório)
trailingSeparatorPolicy A política do separador à direita. 'Obrigatório'
'Não permitido'
'Não especificado'
'Opcional' (obrigatório)
trimLeadingAndTrailingSpacesAndZeroes O valor que indica se os espaços à esquerda e à direita devem ser cortados e zeros. bool (obrigatório)
validateCharacterSet O valor que indica se o conjunto de caracteres deve ser validado. bool (obrigatório)
validateEDITypes O valor que indica se os tipos EDI devem ser validados. bool (obrigatório)
validateXSDTypes O valor que indica se os tipos XSD devem ser validados. bool (obrigatório)

X12ValidationSettings

Designação Descrição Valor
allowLeadingAndTrailingSpacesAndZeroes O valor que indica se devem ser permitidos espaços à esquerda e à direita e zeros. bool (obrigatório)
checkDuplicateGroupControlNumber O valor que indica se o número de controle de grupo duplicado deve ser verificado. bool (obrigatório)
checkDuplicateInterchangeControlNumber O valor que indica se o número de controlo de intercâmbio duplicado deve ser verificado. bool (obrigatório)
checkDuplicateTransactionSetControlNumber O valor que indica se o número de controle do conjunto de transações duplicado deve ser verificado. bool (obrigatório)
interchangeControlNumberValidityDays O período de validade do número de controlo de intercâmbio. int (obrigatório)
trailingSeparatorPolicy A política do separador à direita. 'Obrigatório'
'Não permitido'
'Não especificado'
'Opcional' (obrigatório)
trimLeadingAndTrailingSpacesAndZeroes O valor que indica se os espaços à esquerda e à direita devem ser cortados e zeros. bool (obrigatório)
validateCharacterSet O valor que indica se o conjunto de caracteres deve ser validado na mensagem. bool (obrigatório)
validateEDITypes O valor que indica se os tipos EDI devem ser validados. bool (obrigatório)
validateXSDTypes O valor que indica se os tipos XSD devem ser validados. bool (obrigatório)

Exemplos de início rápido

Os exemplos de início rápido a seguir implantam esse tipo de recurso.

Arquivo Bicep Descrição
Aplicativos Lógicos do Azure - AS2 Send Receive Cria contas de integração para dois parceiros, Contoso e Fabrikam, incluindo os artefatos para parceiros e contratos. O modelo também cria aplicativos lógicos entre a Fabrikam Sales e a Contoso para demonstrar o AS2 Send Receive síncrono. O modelo também cria aplicativos lógicos entre a Fabrikam Finance e a Contoso, que demonstram o AS2 Send Receive assíncrono.

Definição de recurso de modelo ARM

O tipo de recurso integrationAccounts/agreements pode ser implantado com operações que visam:

Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.

Formato do recurso

Para criar um recurso Microsoft.Logic/integrationAccounts/agreements, adicione o seguinte JSON ao seu modelo.

{
  "type": "Microsoft.Logic/integrationAccounts/agreements",
  "apiVersion": "2019-05-01",
  "name": "string",
  "location": "string",
  "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",
              "sha2AlgorithmFormat": "string",
              "signingCertificateName": "string"
            },
            "validationSettings": {
              "checkCertificateRevocationListOnReceive": "bool",
              "checkCertificateRevocationListOnSend": "bool",
              "checkDuplicateMessage": "bool",
              "compressMessage": "bool",
              "encryptionAlgorithm": "string",
              "encryptMessage": "bool",
              "interchangeDuplicatesValidityDays": "int",
              "overrideMessageProperties": "bool",
              "signingAlgorithm": "string",
              "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",
              "sha2AlgorithmFormat": "string",
              "signingCertificateName": "string"
            },
            "validationSettings": {
              "checkCertificateRevocationListOnReceive": "bool",
              "checkCertificateRevocationListOnSend": "bool",
              "checkDuplicateMessage": "bool",
              "compressMessage": "bool",
              "encryptionAlgorithm": "string",
              "encryptMessage": "bool",
              "interchangeDuplicatesValidityDays": "int",
              "overrideMessageProperties": "bool",
              "signingAlgorithm": "string",
              "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": "string",
                "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": "string",
                "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": {}
  },
  "tags": {
    "{customized property}": "string"
  }
}

Valores de propriedade

ContratoConteúdo

Designação Descrição Valor
aS2 O conteúdo do contrato AS2. AS2AgreementContent
edifact Conteúdo do acordo EDIFACT. EdifactAgreementConteúdo
x12 O conteúdo do contrato X12. X12AgreementConteúdo

AS2AcknowledgementConnectionSettings

Designação Descrição Valor
ignoreCertificateNameMismatch Indica se a incompatibilidade deve ser ignorada no nome do certificado. bool (obrigatório)
keepHttpConnectionAlive Indica se a conexão deve ser mantida ativa. bool (obrigatório)
suporteHttpStatusCodeContinue Indica se o código de status HTTP 'CONTINUE' deve ser suportado. bool (obrigatório)
unfoldHttpHeaders Indica se os cabeçalhos HTTP devem ser desdobrados. bool (obrigatório)

AS2AgreementContent

Designação Descrição Valor
receberAcordo O AS2 unidirecional recebe acordo. AS2OneWayAgreement (obrigatório)
sendAgreement O contrato de envio unidirecional AS2. AS2OneWayAgreement (obrigatório)

AS2EnvelopeSettings

Designação Descrição Valor
autogenerateFileName O valor que indica se o nome do arquivo deve ser gerado automaticamente. bool (obrigatório)
fileNameTemplate O modelo para nome de arquivo. string (obrigatório)
messageContentType O tipo de conteúdo da mensagem. string (obrigatório)
suspendMessageOnFileNameGenerationError O valor que indica se a mensagem deve ser suspensa no erro de geração de nome de arquivo. bool (obrigatório)
transmitFileNameInMimeHeader O valor que indica se o nome do arquivo deve ser transmitido no cabeçalho mime. bool (obrigatório)

AS2ErrorSettings

Designação Descrição Valor
resendIfMDNNotReceived O valor que indica se a mensagem deve ser reenviada se o MDN não for recebido. bool (obrigatório)
suspendDuplicateMessage O valor que indica se a mensagem duplicada deve ser suspensa. bool (obrigatório)

AS2MdnConfigurações

Designação Descrição Valor
dispositionNotificationTo A notificação de disposição para o valor do cabeçalho. string
mdnText O texto MDN. string
micHashingAlgorithm O algoritmo de assinatura ou hash. «MD5»
'Nenhuma'
'Não especificado'
'SHA1'
'SHA2256'
'SHA2384'
'SHA2512' (obrigatório)
necessidadeMDN O valor que indica se um MDN deve ser enviado ou solicitado. bool (obrigatório)
receiptDeliveryUrl O URL de entrega do recibo. string
sendInboundMDNToMessageBox O valor que indica se a caixa de mensagem deve enviar MDN de entrada para a caixa de mensagem. bool (obrigatório)
sendMDNAsynchronously O valor que indica se o MDN assíncrono deve ser enviado. bool (obrigatório)
signMDN O valor que indica se o MDN precisa ser assinado ou não. bool (obrigatório)
signOutboundMDNIfOptional O valor que indica se o MDN de saída deve ser assinado, se opcional. bool (obrigatório)

AS2MessageConnectionSettings

Designação Descrição Valor
ignoreCertificateNameMismatch O valor que indica se a incompatibilidade deve ser ignorada no nome do certificado. bool (obrigatório)
keepHttpConnectionAlive O valor que indica se a conexão deve ser mantida ativa. bool (obrigatório)
suporteHttpStatusCodeContinue O valor que indica se deve suportar o código de status HTTP 'CONTINUE'. bool (obrigatório)
unfoldHttpHeaders O valor que indica se os cabeçalhos HTTP devem ser desdobrados. bool (obrigatório)

AS2OneWayAcordo

Designação Descrição Valor
protocolSettings As configurações do protocolo AS2. AS2ProtocolSettings (obrigatório)
destinatárioIdentidade de negócios A identidade comercial do destinatário BusinessIdentity (obrigatório)
senderBusinessIdentity A identidade comercial do remetente BusinessIdentity (obrigatório)

AS2ProtocolSettings

Designação Descrição Valor
acknowledgementConnectionSettings As configurações de conexão de confirmação. AS2AcknowledgementConnectionSettings (obrigatório)
envelopeSettings As configurações do envelope. AS2EnvelopeSettings (obrigatório)
errorSettings As configurações de erro. AS2ErrorSettings (obrigatório)
mdnConfigurações As configurações de MDN. AS2MdnSettings (obrigatório)
messageConnectionSettings As configurações de conexão da mensagem. AS2MessageConnectionSettings (obrigatório)
securityConfigurações: As configurações de segurança. AS2SecuritySettings (obrigatório)
validationSettings As configurações de validação. AS2ValidationSettings (obrigatório)

AS2SecuritySettings

Designação Descrição Valor
enableNRRForInboundDecodedMessages O valor que indica se a NRR deve ser habilitada para mensagens decodificadas de entrada. bool (obrigatório)
enableNRRForInboundEncodedMessages O valor que indica se a NRR deve ser habilitada para mensagens codificadas de entrada. bool (obrigatório)
enableNRRForInboundMDN O valor que indica se o NRR deve ser habilitado para MDN de entrada. bool (obrigatório)
enableNRRForOutboundDecodedMessages O valor que indica se a NRR deve ser habilitada para mensagens decodificadas de saída. bool (obrigatório)
enableNRRForOutboundEncodedMessages O valor que indica se a NRR deve ser habilitada para mensagens codificadas de saída. bool (obrigatório)
enableNRRForOutboundMDN O valor que indica se o NRR deve ser habilitado para MDN de saída. bool (obrigatório)
encryptionCertificateName O nome do certificado de criptografia. string
overrideGroupSigningCertificate O valor que indica se um MDN deve ser enviado ou solicitado. bool (obrigatório)
sha2AlgorithmFormat O formato do algoritmo Sha2. Os valores válidos são Sha2, ShaHashSize, ShaHyphenHashSize, Sha2UnderscoreHashSize. string
assinandoCertificateName O nome do certificado de assinatura. string

AS2ValidationSettings

Designação Descrição Valor
checkCertificateRevocationListOnReceive O valor que indica se a lista de revogação de certificados deve ser verificada ao receber. bool (obrigatório)
checkCertificateRevocationListOnSend O valor que indica se a lista de revogação de certificados deve ser verificada no envio. bool (obrigatório)
checkDuplicateMessage O valor que indica se a mensagem duplicada deve ser verificada. bool (obrigatório)
compressMessage O valor que indica se a mensagem deve ser compactada. bool (obrigatório)
encryptionAlgoritmo O algoritmo de encriptação. «AES128»
«AES192»
«AES256»
«DES3»
'Nenhuma'
'Não especificado'
«RC2» (obrigatório)
encriptação Mensagem O valor que indica se a mensagem tem de ser encriptada. bool (obrigatório)
interchangeDuplicatesValidityDays O número de dias para olhar para trás para o intercâmbio duplicado. int (obrigatório)
overrideMessageProperties O valor que indica se as propriedades da mensagem de entrada devem ser substituídas pelas que estão em acordo. bool (obrigatório)
signingAlgorithm O algoritmo de assinatura. 'Inadimplência'
'Não especificado'
'SHA1'
'SHA2256'
'SHA2384'
'SHA2512'
signMensagem O valor que indica se a mensagem deve ser assinada. bool (obrigatório)

Identidade Empresarial

Designação Descrição Valor
Qualificador O qualificador de identidade comercial, por exemplo, as2identity, ZZ, ZZZ, 31, 32 string (obrigatório)
valor O valor da identidade comercial definida pelo usuário. string (obrigatório)

EdifactAcknowledgementSettings

Designação Descrição Valor
reconhecimentoControlNumberLowerBound O limite inferior do número de controle de confirmação. int (obrigatório)
reconhecimentoControlNumberPrefix O prefixo do número de controle de confirmação. string
acknowledgementControlNumberSuffix O sufixo do número de controle de confirmação. string
reconhecimentoControlNumberUpperBound O limite superior do número de controle de confirmação. int (obrigatório)
batchFuncionalAgradecimentos O valor que indica se as confirmações funcionais de lote devem ser feitas. bool (obrigatório)
batchTechnicalAgradecimentos O valor que indica se os agradecimentos técnicos devem ser agrupados. bool (obrigatório)
necessidadeReconhecimento Funcional O valor que indica se o reconhecimento funcional é necessário. bool (obrigatório)
needLoopForValidMessages O valor que indica se um loop é necessário para mensagens válidas. bool (obrigatório)
necessidadeReconhecimento técnico O valor que indica se o reconhecimento técnico é necessário. bool (obrigatório)
rolloverConfirmaçãoControlNumber O valor que indica se o número de controle de confirmação de rolagem deve ser feito. bool (obrigatório)
sendSynchronousReconhecimento O valor que indica se a confirmação síncrona deve ser enviada. bool (obrigatório)

EdifactAgreementContent

Designação Descrição Valor
receberAcordo O acordo de sentido único EDIFACT. EdifactOneWayAgreement (obrigatório)
sendAgreement O acordo de envio unidirecional EDIFACT. EdifactOneWayAgreement (obrigatório)

EdifactDelimiterOverride

Designação Descrição Valor
componentSeparador O separador de componentes. int (obrigatório)
dataElementSeparator O separador de elemento de dados. int (obrigatório)
decimalPointIndicator O indicador de vírgula decimal. 'Vírgula'
'Decimal'
'NotSpecified' (obrigatório)
messageAssociationAssignedCode O código atribuído à associação de mensagens. string
messageId O ID da mensagem. string
messageRelease A liberação da mensagem. string
messageVersion A versão da mensagem. string
releaseIndicator O indicador de lançamento. int (obrigatório)
repetiçãoSeparador O separador de repetição. int (obrigatório)
segmentTerminador O terminador de segmento. int (obrigatório)
segmentTerminatorSufixo O sufixo terminador de segmento. «CR»
'CRLF'
'LF'
'Nenhuma'
'NotSpecified' (obrigatório)
targetNamespace O namespace de destino no qual essas configurações de delimitador devem ser aplicadas. string

EdifactEnvelopeOverride

Designação Descrição Valor
applicationPassword A senha do aplicativo. string
associaçãoAssignedCode A associação atribuiu o código. string
controllingAgencyCode O código da agência controladora. string
funcionalGroupId O id do grupo funcional. string
groupHeaderMessageRelease A liberação da mensagem de cabeçalho do grupo. string
groupHeaderMessageVersion A versão da mensagem do cabeçalho do grupo. string
messageAssociationAssignedCode O código atribuído à associação de mensagens. string
messageId O ID da mensagem no qual as configurações desse envelope devem ser aplicadas. string
messageRelease A versão de liberação de mensagem na qual essas configurações de envelope devem ser aplicadas. string
messageVersion A versão da mensagem na qual as configurações desse envelope devem ser aplicadas. string
receiverApplicationId O ID do aplicativo do recetor. string
receiverApplicationQualifier O qualificador do aplicativo do recetor. string
senderApplicationId A ID do aplicativo remetente. string
senderApplicationQualifier O qualificador do aplicativo remetente. string
targetNamespace O namespace de destino no qual essas configurações de envelope devem ser aplicadas. string

EdifactEnvelopeSettings

Designação Descrição Valor
applicationReferenceId A ID de referência do aplicativo. string
applyDelimiterStringAdvice O valor que indica se o aviso de cadeia de caracteres do delimitador deve ser aplicado. bool (obrigatório)
communicationAgreementId O contrato de comunicação id. string
createGroupingSegments O valor que indica se os segmentos de agrupamento devem ser criados. bool (obrigatório)
enableDefaultGroupHeaders O valor que indica se os cabeçalhos de grupo padrão devem ser habilitados. bool (obrigatório)
funcionalGroupId O id do grupo funcional. string
groupApplicationPassword A senha do aplicativo de grupo. string
groupApplicationReceiverId A ID do recetor do aplicativo de grupo. string
groupApplicationReceiverQualifier O qualificador do recetor do aplicativo de grupo. string
groupApplicationSenderId A ID do remetente do aplicativo de grupo. string
groupApplicationSenderQualifier O qualificador do remetente do aplicativo de grupo. string
groupAssociationAssignedCode A associação de grupo atribuiu o código. string
groupControllingAgencyCode O código da agência controladora do grupo. string
groupControlNumberLowerBound O limite inferior do número de controle de grupo. int (obrigatório)
groupControlNumberPrefix O prefixo do número de controle de grupo. string
groupControlNumberSuffix O sufixo do número de controle do grupo. string
groupControlNumberUpperBound O limite superior do número de controle de grupo. int (obrigatório)
groupMessageRelease A liberação da mensagem de grupo. string
groupMessageVersion A versão da mensagem de grupo. string
interchangeControlNumberLowerBound O limite inferior do número de controle de intercâmbio. int (obrigatório)
interchangeControlNumberPrefix O prefixo do número de controle de intercâmbio. string
interchangeControlNumberSuffix O sufixo do número de controle de intercâmbio. string
interchangeControlNumberUpperBound O limite superior do número de controle de intercâmbio. int (obrigatório)
isTestInterchange O valor que indica se a mensagem é um intercâmbio de teste. bool (obrigatório)
overwriteExistingTransactionSetControlNumber O valor que indica se o número de controle do conjunto de transações existente deve ser substituído. bool (obrigatório)
processandoPriorityCode O código de prioridade de processamento. string
receiverIdentificação Interna A identificação interna do recetor. string
receptorInternalSubIdentification A subidentificação interna do recetor. string
receiverReverseRoutingAddress O endereço de roteamento reverso do recetor. string
recipientReferencePasswordQualifier O qualificador de senha de referência do destinatário. string
recipientReferencePasswordValue O valor da senha de referência do destinatário. string
rolloverGroupControlNumber O valor que indica se o número de controle do grupo deve ser substituído. bool (obrigatório)
rolloverInterchangeControlNumber O valor que indica se o número de controle de intercâmbio deve ser substituído. bool (obrigatório)
rolloverTransactionSetControlNumber O valor que indica se o número de controle do conjunto de transações de rollover deve ser feito. bool (obrigatório)
senderIdentificação Interna A identificação interna do remetente. string
senderInternalSubIdentification A subidentificação interna do remetente. string
senderReverseRoutingAddress O endereço de roteamento reverso do remetente. string
transactionSetControlNumberLowerBound O número de controle do conjunto de transações limite inferior. int (obrigatório)
transactionSetControlNumberPrefix O prefixo do número de controle do conjunto de transações. string
transactionSetControlNumberSuffix O sufixo do número de controle do conjunto de transações. string
transactionSetControlNumberUpperBound O limite superior do número de controle do conjunto de transações. int (obrigatório)

EdifactFramingSettings

Designação Descrição Valor
characterEncoding A codificação de caracteres. string
conjunto de caracteres O caractere de configuração de quadro EDIFACT. 'KECA'
'Não especificado'
'UNOA'
'UNOB'
«UNOC»
'UNOD'
'UNOE'
'SEM OF'
«UNOG»
'UNOH'
«UNOI»
"UNOJ"
'UNOK'
'UNOX'
«UNOY» (obrigatório)
componentSeparador O separador de componentes. int (obrigatório)
dataElementSeparator O separador de elemento de dados. int (obrigatório)
decimalPointIndicator O indicador decimal de configuração do quadro EDIFACT. 'Vírgula'
'Decimal'
'NotSpecified' (obrigatório)
protocolVersion A versão do protocolo. int (obrigatório)
releaseIndicator O indicador de lançamento. int (obrigatório)
repetiçãoSeparador O separador de repetição. int (obrigatório)
segmentTerminador O terminador de segmento. int (obrigatório)
segmentTerminatorSufixo O sufixo do terminador de segmento de configuração de quadro EDIFACT. «CR»
'CRLF'
'LF'
'Nenhuma'
'NotSpecified' (obrigatório)
serviceCodeListDirectoryVersion A versão do diretório da lista de códigos de serviço. string

EdifactMessageFilter

Designação Descrição Valor
messageFilterType O tipo de filtro de mensagem. 'Excluir'
'Incluir'
'NotSpecified' (obrigatório)

EdifactMessageIdentifier

Designação Descrição Valor
messageId O ID da mensagem no qual as configurações desse envelope devem ser aplicadas. string (obrigatório)

EdifactOneWayAgreement

Designação Descrição Valor
protocolSettings As configurações do protocolo EDIFACT. EdifactProtocolSettings (obrigatório)
destinatárioIdentidade de negócios A identidade comercial do destinatário BusinessIdentity (obrigatório)
senderBusinessIdentity A identidade comercial do remetente BusinessIdentity (obrigatório)

EdifactProcessingSettings

Designação Descrição Valor
createEmptyXmlTagsForTrailingSeparators O valor que indica se as marcas xml vazias devem ser criadas para separadores à direita. bool (obrigatório)
máscaraSecurityInfo O valor que indica se as informações de segurança devem ser mascaradas. bool (obrigatório)
preserveInterchange O valor que indica se o intercâmbio deve ser preservado. bool (obrigatório)
suspendInterchangeOnError O valor que indica se o intercâmbio deve ser suspenso em caso de erro. bool (obrigatório)
useDotAsDecimalSeparator O valor que indica se o ponto deve ser usado como separador decimal. bool (obrigatório)

EdifactProtocolSettings

Designação Descrição Valor
acknowledgementSettings As configurações de reconhecimento EDIFACT. EdifactAcknowledgementSettings (obrigatório)
edifactDelimiterSubstitui O delimitador EDIFACT substitui as configurações. EdifactDelimiterOverride[]
envelopeSubstitui O envelope EDIFACT substitui as configurações. EdifactEnvelopeOverride[]
envelopeSettings As configurações do envelope EDIFACT. EdifactEnvelopeSettings (obrigatório)
enquadramentoConfigurações As configurações de enquadramento EDIFACT. EdifactFramingSettings (obrigatório)
messageFilter O filtro de mensagens EDIFACT. EdifactMessageFilter (obrigatório)
messageFilterList A lista de filtros de mensagens EDIFACT. EdifactMessageIdentifier[]
processandoConfigurações As configurações de processamento EDIFACT. EdifactProcessingSettings (obrigatório)
schemaReferências As referências do esquema EDIFACT. EdifactSchemaReference[] (obrigatório)
validaçãoSubstitui As configurações de substituição de validação EDIFACT. EdifactValidationOverride[]
validationSettings As configurações de validação EDIFACT. EdifactValidationSettings (obrigatório)

EdifactSchemaReference

Designação Descrição Valor
associaçãoAssignedCode A associação atribuiu o código. string
messageId O ID da mensagem. string (obrigatório)
messageRelease A versão de lançamento da mensagem. string (obrigatório)
messageVersion A versão da mensagem. string (obrigatório)
schemaName O nome do esquema. string (obrigatório)
senderApplicationId A ID do aplicativo remetente. string
senderApplicationQualifier O qualificador do aplicativo remetente. string

EdifactValidationOverride

Designação Descrição Valor
allowLeadingAndTrailingSpacesAndZeroes O valor que indica se devem ser permitidos espaços à esquerda e à direita e zeros. bool (obrigatório)
enforceCharacterSet O valor que indica se o conjunto de caracteres deve ser validado. bool (obrigatório)
messageId O ID da mensagem no qual as configurações de validação devem ser aplicadas. string (obrigatório)
trailingSeparatorPolicy A política do separador à direita. 'Obrigatório'
'Não permitido'
'Não especificado'
'Opcional' (obrigatório)
trimLeadingAndTrailingSpacesAndZeroes O valor que indica se os espaços à esquerda e à direita devem ser cortados e zeros. bool (obrigatório)
validateEDITypes O valor que indica se os tipos EDI devem ser validados. bool (obrigatório)
validateXSDTypes O valor que indica se os tipos XSD devem ser validados. bool (obrigatório)

EdifactValidationSettings

Designação Descrição Valor
allowLeadingAndTrailingSpacesAndZeroes O valor que indica se devem ser permitidos espaços à esquerda e à direita e zeros. bool (obrigatório)
checkDuplicateGroupControlNumber O valor que indica se o número de controle de grupo duplicado deve ser verificado. bool (obrigatório)
checkDuplicateInterchangeControlNumber O valor que indica se o número de controlo de intercâmbio duplicado deve ser verificado. bool (obrigatório)
checkDuplicateTransactionSetControlNumber O valor que indica se o número de controle do conjunto de transações duplicado deve ser verificado. bool (obrigatório)
interchangeControlNumberValidityDays O período de validade do número de controlo de intercâmbio. int (obrigatório)
trailingSeparatorPolicy A política do separador à direita. 'Obrigatório'
'Não permitido'
'Não especificado'
'Opcional' (obrigatório)
trimLeadingAndTrailingSpacesAndZeroes O valor que indica se os espaços à esquerda e à direita devem ser cortados e zeros. bool (obrigatório)
validateCharacterSet O valor que indica se o conjunto de caracteres deve ser validado na mensagem. bool (obrigatório)
validateEDITypes O valor que indica se os tipos EDI devem ser validados. bool (obrigatório)
validateXSDTypes O valor que indica se os tipos XSD devem ser validados. bool (obrigatório)

IntegrationAccountAgreementProperties

Designação Descrição Valor
tipo de acordo O tipo de contrato. «AS2»
'Edifact'
'Não especificado'
'X12' (obrigatório)
Conteúdo O conteúdo do acordo. Contrato de Conteúdo (obrigatório)
guestIdentity A identidade comercial do parceiro convidado. BusinessIdentity (obrigatório)
guestPartner O parceiro de conta de integração definido como parceiro convidado para este contrato. string (obrigatório)
hostIdentity A identidade comercial do parceiro anfitrião. BusinessIdentity (obrigatório)
hostPartner O parceiro de conta de integração definido como parceiro anfitrião para este contrato. string (obrigatório)
metadados Os metadados. qualquer

Microsoft.Logic/integrationAccounts/agreements

Designação Descrição Valor
apiVersion A versão api '2019-05-01'
Localização A localização do recurso. string
Designação O nome do recurso string (obrigatório)
propriedades As propriedades do contrato de conta de integração. IntegrationAccountAgreementProperties (obrigatório)
Etiquetas Tags de recursos Dicionário de nomes e valores de tags. Consulte Tags em modelos
tipo O tipo de recurso 'Microsoft.Logic/integrationAccounts/agreements'

Tags de Recursos

Designação Descrição Valor

X12AcknowledgementSettings

Designação Descrição Valor
reconhecimentoControlNumberLowerBound O limite inferior do número de controle de confirmação. int (obrigatório)
reconhecimentoControlNumberPrefix O prefixo do número de controle de confirmação. string
acknowledgementControlNumberSuffix O sufixo do número de controle de confirmação. string
reconhecimentoControlNumberUpperBound O limite superior do número de controle de confirmação. int (obrigatório)
batchFuncionalAgradecimentos O valor que indica se as confirmações funcionais de lote devem ser feitas. bool (obrigatório)
batchImplementationAgradecimentos O valor que indica se as confirmações de implementação em lote devem ser feitas. bool (obrigatório)
batchTechnicalAgradecimentos O valor que indica se os agradecimentos técnicos devem ser agrupados. bool (obrigatório)
funcionalAgradecimentoVersão A versão de reconhecimento funcional. string
implementaçãoAgradecimentoVersão A versão de confirmação de implementação. string
necessidadeReconhecimento Funcional O valor que indica se o reconhecimento funcional é necessário. bool (obrigatório)
necessidadeImplementaçãoReconhecimento O valor que indica se o reconhecimento da implementação é necessário. bool (obrigatório)
needLoopForValidMessages O valor que indica se um loop é necessário para mensagens válidas. bool (obrigatório)
necessidadeReconhecimento técnico O valor que indica se o reconhecimento técnico é necessário. bool (obrigatório)
rolloverConfirmaçãoControlNumber O valor que indica se o número de controle de confirmação de rolagem deve ser feito. bool (obrigatório)
sendSynchronousReconhecimento O valor que indica se a confirmação síncrona deve ser enviada. bool (obrigatório)

X12AgreementContent

Designação Descrição Valor
receberAcordo O acordo de recebimento unidirecional X12. X12OneWayAgreement (obrigatório)
sendAgreement O contrato de envio unidirecional X12. X12OneWayAgreement (obrigatório)

X12DelimiterSubstitui

Designação Descrição Valor
componentSeparador O separador de componentes. int (obrigatório)
dataElementSeparator O separador de elemento de dados. int (obrigatório)
messageId O ID da mensagem. string
protocolVersion A versão do protocolo. string
replaceCharacter O caráter de substituição. int (obrigatório)
replaceSeparatorsInPayload O valor que indica se os separadores devem ser substituídos na carga útil. bool (obrigatório)
segmentTerminador O terminador de segmento. int (obrigatório)
segmentTerminatorSufixo O sufixo terminador de segmento. «CR»
'CRLF'
'LF'
'Nenhuma'
'NotSpecified' (obrigatório)
targetNamespace O namespace de destino no qual essas configurações de delimitador devem ser aplicadas. string

X12EnvelopeOverride

Designação Descrição Valor
dateFormat O formato de data. «CCYYMMDD»
'Não especificado'
«AAMMDD» (obrigatório)
functionalIdentifierCode O código identificador funcional. string
headerVersion A versão do cabeçalho. string (obrigatório)
messageId O ID da mensagem no qual as configurações desse envelope devem ser aplicadas. string (obrigatório)
protocolVersion A versão do protocolo na qual essas configurações de envelope devem ser aplicadas. string (obrigatório)
receiverApplicationId O ID do aplicativo do recetor. string (obrigatório)
responsibleAgencyCode O código da agência responsável. string (obrigatório)
senderApplicationId A ID do aplicativo remetente. string (obrigatório)
targetNamespace O namespace de destino no qual essas configurações de envelope devem ser aplicadas. string (obrigatório)
timeFormat O formato de hora. 'HHMM'
'HHMMSS'
'HHMMSSd'
'HHMMSSdd'
'NotSpecified' (obrigatório)

X12EnvelopeSettings

Designação Descrição Valor
controlStandardsId Os padrões de controle id. int (obrigatório)
controlVersionNumber O número da versão de controle. string (obrigatório)
enableDefaultGroupHeaders O valor que indica se os cabeçalhos de grupo padrão devem ser habilitados. bool (obrigatório)
funcionalGroupId O id do grupo funcional. string
groupControlNumberLowerBound O limite inferior do número de controle de grupo. int (obrigatório)
groupControlNumberUpperBound O limite superior do número de controle de grupo. int (obrigatório)
groupHeaderAgencyCode O código da agência de cabeçalho do grupo. string (obrigatório)
groupHeaderDateFormat O formato de data do cabeçalho do grupo. «CCYYMMDD»
'Não especificado'
«AAMMDD» (obrigatório)
groupHeaderTimeFormat O formato de hora do cabeçalho do grupo. 'HHMM'
'HHMMSS'
'HHMMSSd'
'HHMMSSdd'
'NotSpecified' (obrigatório)
groupHeaderVersion A versão do cabeçalho do grupo. string (obrigatório)
interchangeControlNumberLowerBound O limite inferior do número de controle de intercâmbio. int (obrigatório)
interchangeControlNumberUpperBound O limite superior do número de controle de intercâmbio. int (obrigatório)
overwriteExistingTransactionSetControlNumber O valor que indica se o número de controle do conjunto de transações existente deve ser substituído. bool (obrigatório)
receiverApplicationId O ID do aplicativo do recetor. string (obrigatório)
rolloverGroupControlNumber O valor que indica se o número de controle do grupo deve ser substituído. bool (obrigatório)
rolloverInterchangeControlNumber O valor que indica se o número de controle de intercâmbio deve ser substituído. bool (obrigatório)
rolloverTransactionSetControlNumber O valor que indica se o número de controle do conjunto de transações de rollover deve ser feito. bool (obrigatório)
senderApplicationId A ID do aplicativo remetente. string (obrigatório)
transactionSetControlNumberLowerBound O número de controle do conjunto de transações limite inferior. int (obrigatório)
transactionSetControlNumberPrefix O prefixo do número de controle do conjunto de transações. string
transactionSetControlNumberSuffix O sufixo do número de controle do conjunto de transações. string
transactionSetControlNumberUpperBound O limite superior do número de controle do conjunto de transações. int (obrigatório)
usageIndicator O indicador de utilização. 'Informação'
'Não especificado'
'Produção'
'Teste' (obrigatório)
useControlStandardsIdAsRepetitionCharacter O valor que indica se os padrões de controle devem ser usados como caractere de repetição. bool (obrigatório)

X12FramingSettings

Designação Descrição Valor
conjunto de caracteres O conjunto de caracteres X12. 'Básico'
'Prorrogado'
'Não especificado'
'UTF8' (obrigatório)
componentSeparador O separador de componentes. int (obrigatório)
dataElementSeparator O separador de elemento de dados. int (obrigatório)
replaceCharacter O caráter de substituição. int (obrigatório)
replaceSeparatorsInPayload O valor que indica se os separadores devem ser substituídos na carga útil. bool (obrigatório)
segmentTerminador O terminador de segmento. int (obrigatório)
segmentTerminatorSufixo O sufixo terminador de segmento. «CR»
'CRLF'
'LF'
'Nenhuma'
'NotSpecified' (obrigatório)

X12MessageFilter

Designação Descrição Valor
messageFilterType O tipo de filtro de mensagem. 'Excluir'
'Incluir'
'NotSpecified' (obrigatório)

X12MessageIdentifier

Designação Descrição Valor
messageId O ID da mensagem. string (obrigatório)

X12OneWayAcordo

Designação Descrição Valor
protocolSettings As configurações do protocolo X12. X12ProtocolSettings (obrigatório)
destinatárioIdentidade de negócios A identidade comercial do destinatário BusinessIdentity (obrigatório)
senderBusinessIdentity A identidade comercial do remetente BusinessIdentity (obrigatório)

X12ProcessingSettings

Designação Descrição Valor
convertImpliedDecimal O valor que indica se o tipo numérico deve ser convertido em decimal implícito. bool (obrigatório)
createEmptyXmlTagsForTrailingSeparators O valor que indica se as marcas xml vazias devem ser criadas para separadores à direita. bool (obrigatório)
máscaraSecurityInfo O valor que indica se as informações de segurança devem ser mascaradas. bool (obrigatório)
preserveInterchange O valor que indica se o intercâmbio deve ser preservado. bool (obrigatório)
suspendInterchangeOnError O valor que indica se o intercâmbio deve ser suspenso em caso de erro. bool (obrigatório)
useDotAsDecimalSeparator O valor que indica se o ponto deve ser usado como separador decimal. bool (obrigatório)

X12ProtocolSettings

Designação Descrição Valor
acknowledgementSettings As configurações de confirmação do X12. X12AcknowledgementSettings (obrigatório)
envelopeSubstitui O envelope X12 substitui as configurações. X12EnvelopeOverride[]
envelopeSettings As configurações do envelope X12. X12EnvelopeSettings (obrigatório)
enquadramentoConfigurações As configurações de enquadramento X12. X12FramingSettings (obrigatório)
messageFilter O filtro de mensagens X12. X12MessageFilter (obrigatório)
messageFilterList A lista de filtros de mensagens X12. X12MessageIdentifier[]
processandoConfigurações As configurações de processamento do X12. X12ProcessingSettings (obrigatório)
schemaReferências As referências do esquema X12. X12SchemaReference[] (obrigatório)
securityConfigurações: As configurações de segurança do X12. X12SecuritySettings (obrigatório)
validaçãoSubstitui As configurações de substituição de validação X12. X12ValidationOverride[]
validationSettings As configurações de validação do X12. X12ValidationSettings (obrigatório)
x12DelimiterSubstitui O delimitador X12 substitui as configurações. X12DelimiterSubstitui[]

X12SchemaReference

Designação Descrição Valor
messageId O ID da mensagem. string (obrigatório)
schemaName O nome do esquema. string (obrigatório)
schemaVersion A versão do esquema. string (obrigatório)
senderApplicationId A ID do aplicativo remetente. string

X12SecuritySettings

Designação Descrição Valor
authorizationQualificador O qualificador de autorização. string (obrigatório)
authorizationValue O valor da autorização. string
passwordValue O valor da senha. string
securityQualificador O qualificador de segurança. string (obrigatório)

X12ValidationOverride

Designação Descrição Valor
allowLeadingAndTrailingSpacesAndZeroes O valor que indica se devem ser permitidos espaços à esquerda e à direita e zeros. bool (obrigatório)
messageId O ID da mensagem no qual as configurações de validação devem ser aplicadas. string (obrigatório)
trailingSeparatorPolicy A política do separador à direita. 'Obrigatório'
'Não permitido'
'Não especificado'
'Opcional' (obrigatório)
trimLeadingAndTrailingSpacesAndZeroes O valor que indica se os espaços à esquerda e à direita devem ser cortados e zeros. bool (obrigatório)
validateCharacterSet O valor que indica se o conjunto de caracteres deve ser validado. bool (obrigatório)
validateEDITypes O valor que indica se os tipos EDI devem ser validados. bool (obrigatório)
validateXSDTypes O valor que indica se os tipos XSD devem ser validados. bool (obrigatório)

X12ValidationSettings

Designação Descrição Valor
allowLeadingAndTrailingSpacesAndZeroes O valor que indica se devem ser permitidos espaços à esquerda e à direita e zeros. bool (obrigatório)
checkDuplicateGroupControlNumber O valor que indica se o número de controle de grupo duplicado deve ser verificado. bool (obrigatório)
checkDuplicateInterchangeControlNumber O valor que indica se o número de controlo de intercâmbio duplicado deve ser verificado. bool (obrigatório)
checkDuplicateTransactionSetControlNumber O valor que indica se o número de controle do conjunto de transações duplicado deve ser verificado. bool (obrigatório)
interchangeControlNumberValidityDays O período de validade do número de controlo de intercâmbio. int (obrigatório)
trailingSeparatorPolicy A política do separador à direita. 'Obrigatório'
'Não permitido'
'Não especificado'
'Opcional' (obrigatório)
trimLeadingAndTrailingSpacesAndZeroes O valor que indica se os espaços à esquerda e à direita devem ser cortados e zeros. bool (obrigatório)
validateCharacterSet O valor que indica se o conjunto de caracteres deve ser validado na mensagem. bool (obrigatório)
validateEDITypes O valor que indica se os tipos EDI devem ser validados. bool (obrigatório)
validateXSDTypes O valor que indica se os tipos XSD devem ser validados. bool (obrigatório)

Modelos de início rápido

Os modelos de início rápido a seguir implantam esse tipo de recurso.

Modelo Descrição
Aplicativos Lógicos do Azure - AS2 Send Receive

Implantar no Azure
Cria contas de integração para dois parceiros, Contoso e Fabrikam, incluindo os artefatos para parceiros e contratos. O modelo também cria aplicativos lógicos entre a Fabrikam Sales e a Contoso para demonstrar o AS2 Send Receive síncrono. O modelo também cria aplicativos lógicos entre a Fabrikam Finance e a Contoso, que demonstram o AS2 Send Receive assíncrono.

Definição de recursos Terraform (provedor AzAPI)

O tipo de recurso integrationAccounts/agreements pode ser implantado com operações que visam:

  • Grupos de recursos

Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.

Formato do recurso

Para criar um recurso Microsoft.Logic/integrationAccounts/agreements, adicione o seguinte Terraform ao seu modelo.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Logic/integrationAccounts/agreements@2019-05-01"
  name = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    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
                sha2AlgorithmFormat = "string"
                signingCertificateName = "string"
              }
              validationSettings = {
                checkCertificateRevocationListOnReceive = bool
                checkCertificateRevocationListOnSend = bool
                checkDuplicateMessage = bool
                compressMessage = bool
                encryptionAlgorithm = "string"
                encryptMessage = bool
                interchangeDuplicatesValidityDays = int
                overrideMessageProperties = bool
                signingAlgorithm = "string"
                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
                sha2AlgorithmFormat = "string"
                signingCertificateName = "string"
              }
              validationSettings = {
                checkCertificateRevocationListOnReceive = bool
                checkCertificateRevocationListOnSend = bool
                checkDuplicateMessage = bool
                compressMessage = bool
                encryptionAlgorithm = "string"
                encryptMessage = bool
                interchangeDuplicatesValidityDays = int
                overrideMessageProperties = bool
                signingAlgorithm = "string"
                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 = "string"
                  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 = "string"
                  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 = ?
    }
  })
}

Valores de propriedade

ContratoConteúdo

Designação Descrição Valor
aS2 O conteúdo do contrato AS2. AS2AgreementContent
edifact Conteúdo do acordo EDIFACT. EdifactAgreementConteúdo
x12 O conteúdo do contrato X12. X12AgreementConteúdo

AS2AcknowledgementConnectionSettings

Designação Descrição Valor
ignoreCertificateNameMismatch Indica se a incompatibilidade deve ser ignorada no nome do certificado. bool (obrigatório)
keepHttpConnectionAlive Indica se a conexão deve ser mantida ativa. bool (obrigatório)
suporteHttpStatusCodeContinue Indica se o código de status HTTP 'CONTINUE' deve ser suportado. bool (obrigatório)
unfoldHttpHeaders Indica se os cabeçalhos HTTP devem ser desdobrados. bool (obrigatório)

AS2AgreementContent

Designação Descrição Valor
receberAcordo O AS2 unidirecional recebe acordo. AS2OneWayAgreement (obrigatório)
sendAgreement O contrato de envio unidirecional AS2. AS2OneWayAgreement (obrigatório)

AS2EnvelopeSettings

Designação Descrição Valor
autogenerateFileName O valor que indica se o nome do arquivo deve ser gerado automaticamente. bool (obrigatório)
fileNameTemplate O modelo para nome de arquivo. string (obrigatório)
messageContentType O tipo de conteúdo da mensagem. string (obrigatório)
suspendMessageOnFileNameGenerationError O valor que indica se a mensagem deve ser suspensa no erro de geração de nome de arquivo. bool (obrigatório)
transmitFileNameInMimeHeader O valor que indica se o nome do arquivo deve ser transmitido no cabeçalho mime. bool (obrigatório)

AS2ErrorSettings

Designação Descrição Valor
resendIfMDNNotReceived O valor que indica se a mensagem deve ser reenviada se o MDN não for recebido. bool (obrigatório)
suspendDuplicateMessage O valor que indica se a mensagem duplicada deve ser suspensa. bool (obrigatório)

AS2MdnConfigurações

Designação Descrição Valor
dispositionNotificationTo A notificação de disposição para o valor do cabeçalho. string
mdnText O texto MDN. string
micHashingAlgorithm O algoritmo de assinatura ou hash. «MD5»
'Nenhuma'
'Não especificado'
'SHA1'
'SHA2256'
'SHA2384'
'SHA2512' (obrigatório)
necessidadeMDN O valor que indica se um MDN deve ser enviado ou solicitado. bool (obrigatório)
receiptDeliveryUrl O URL de entrega do recibo. string
sendInboundMDNToMessageBox O valor que indica se a caixa de mensagem deve enviar MDN de entrada para a caixa de mensagem. bool (obrigatório)
sendMDNAsynchronously O valor que indica se o MDN assíncrono deve ser enviado. bool (obrigatório)
signMDN O valor que indica se o MDN precisa ser assinado ou não. bool (obrigatório)
signOutboundMDNIfOptional O valor que indica se o MDN de saída deve ser assinado, se opcional. bool (obrigatório)

AS2MessageConnectionSettings

Designação Descrição Valor
ignoreCertificateNameMismatch O valor que indica se a incompatibilidade deve ser ignorada no nome do certificado. bool (obrigatório)
keepHttpConnectionAlive O valor que indica se a conexão deve ser mantida ativa. bool (obrigatório)
suporteHttpStatusCodeContinue O valor que indica se deve suportar o código de status HTTP 'CONTINUE'. bool (obrigatório)
unfoldHttpHeaders O valor que indica se os cabeçalhos HTTP devem ser desdobrados. bool (obrigatório)

AS2OneWayAcordo

Designação Descrição Valor
protocolSettings As configurações do protocolo AS2. AS2ProtocolSettings (obrigatório)
destinatárioIdentidade de negócios A identidade comercial do destinatário BusinessIdentity (obrigatório)
senderBusinessIdentity A identidade comercial do remetente BusinessIdentity (obrigatório)

AS2ProtocolSettings

Designação Descrição Valor
acknowledgementConnectionSettings As configurações de conexão de confirmação. AS2AcknowledgementConnectionSettings (obrigatório)
envelopeSettings As configurações do envelope. AS2EnvelopeSettings (obrigatório)
errorSettings As configurações de erro. AS2ErrorSettings (obrigatório)
mdnConfigurações As configurações de MDN. AS2MdnSettings (obrigatório)
messageConnectionSettings As configurações de conexão da mensagem. AS2MessageConnectionSettings (obrigatório)
securityConfigurações: As configurações de segurança. AS2SecuritySettings (obrigatório)
validationSettings As configurações de validação. AS2ValidationSettings (obrigatório)

AS2SecuritySettings

Designação Descrição Valor
enableNRRForInboundDecodedMessages O valor que indica se a NRR deve ser habilitada para mensagens decodificadas de entrada. bool (obrigatório)
enableNRRForInboundEncodedMessages O valor que indica se a NRR deve ser habilitada para mensagens codificadas de entrada. bool (obrigatório)
enableNRRForInboundMDN O valor que indica se o NRR deve ser habilitado para MDN de entrada. bool (obrigatório)
enableNRRForOutboundDecodedMessages O valor que indica se a NRR deve ser habilitada para mensagens decodificadas de saída. bool (obrigatório)
enableNRRForOutboundEncodedMessages O valor que indica se a NRR deve ser habilitada para mensagens codificadas de saída. bool (obrigatório)
enableNRRForOutboundMDN O valor que indica se o NRR deve ser habilitado para MDN de saída. bool (obrigatório)
encryptionCertificateName O nome do certificado de criptografia. string
overrideGroupSigningCertificate O valor que indica se um MDN deve ser enviado ou solicitado. bool (obrigatório)
sha2AlgorithmFormat O formato do algoritmo Sha2. Os valores válidos são Sha2, ShaHashSize, ShaHyphenHashSize, Sha2UnderscoreHashSize. string
assinandoCertificateName O nome do certificado de assinatura. string

AS2ValidationSettings

Designação Descrição Valor
checkCertificateRevocationListOnReceive O valor que indica se a lista de revogação de certificados deve ser verificada ao receber. bool (obrigatório)
checkCertificateRevocationListOnSend O valor que indica se a lista de revogação de certificados deve ser verificada no envio. bool (obrigatório)
checkDuplicateMessage O valor que indica se a mensagem duplicada deve ser verificada. bool (obrigatório)
compressMessage O valor que indica se a mensagem deve ser compactada. bool (obrigatório)
encryptionAlgoritmo O algoritmo de encriptação. «AES128»
«AES192»
«AES256»
«DES3»
'Nenhuma'
'Não especificado'
«RC2» (obrigatório)
encriptação Mensagem O valor que indica se a mensagem tem de ser encriptada. bool (obrigatório)
interchangeDuplicatesValidityDays O número de dias para olhar para trás para o intercâmbio duplicado. int (obrigatório)
overrideMessageProperties O valor que indica se as propriedades da mensagem de entrada devem ser substituídas pelas que estão em acordo. bool (obrigatório)
signingAlgorithm O algoritmo de assinatura. 'Inadimplência'
'Não especificado'
'SHA1'
'SHA2256'
'SHA2384'
'SHA2512'
signMensagem O valor que indica se a mensagem deve ser assinada. bool (obrigatório)

Identidade Empresarial

Designação Descrição Valor
Qualificador O qualificador de identidade comercial, por exemplo, as2identity, ZZ, ZZZ, 31, 32 string (obrigatório)
valor O valor da identidade comercial definida pelo usuário. string (obrigatório)

EdifactAcknowledgementSettings

Designação Descrição Valor
reconhecimentoControlNumberLowerBound O limite inferior do número de controle de confirmação. int (obrigatório)
reconhecimentoControlNumberPrefix O prefixo do número de controle de confirmação. string
acknowledgementControlNumberSuffix O sufixo do número de controle de confirmação. string
reconhecimentoControlNumberUpperBound O limite superior do número de controle de confirmação. int (obrigatório)
batchFuncionalAgradecimentos O valor que indica se as confirmações funcionais de lote devem ser feitas. bool (obrigatório)
batchTechnicalAgradecimentos O valor que indica se os agradecimentos técnicos devem ser agrupados. bool (obrigatório)
necessidadeReconhecimento Funcional O valor que indica se o reconhecimento funcional é necessário. bool (obrigatório)
needLoopForValidMessages O valor que indica se um loop é necessário para mensagens válidas. bool (obrigatório)
necessidadeReconhecimento técnico O valor que indica se o reconhecimento técnico é necessário. bool (obrigatório)
rolloverConfirmaçãoControlNumber O valor que indica se o número de controle de confirmação de rolagem deve ser feito. bool (obrigatório)
sendSynchronousReconhecimento O valor que indica se a confirmação síncrona deve ser enviada. bool (obrigatório)

EdifactAgreementContent

Designação Descrição Valor
receberAcordo O acordo de sentido único EDIFACT. EdifactOneWayAgreement (obrigatório)
sendAgreement O acordo de envio unidirecional EDIFACT. EdifactOneWayAgreement (obrigatório)

EdifactDelimiterOverride

Designação Descrição Valor
componentSeparador O separador de componentes. int (obrigatório)
dataElementSeparator O separador de elemento de dados. int (obrigatório)
decimalPointIndicator O indicador de vírgula decimal. 'Vírgula'
'Decimal'
'NotSpecified' (obrigatório)
messageAssociationAssignedCode O código atribuído à associação de mensagens. string
messageId O ID da mensagem. string
messageRelease A liberação da mensagem. string
messageVersion A versão da mensagem. string
releaseIndicator O indicador de lançamento. int (obrigatório)
repetiçãoSeparador O separador de repetição. int (obrigatório)
segmentTerminador O terminador de segmento. int (obrigatório)
segmentTerminatorSufixo O sufixo terminador de segmento. «CR»
'CRLF'
'LF'
'Nenhuma'
'NotSpecified' (obrigatório)
targetNamespace O namespace de destino no qual essas configurações de delimitador devem ser aplicadas. string

EdifactEnvelopeOverride

Designação Descrição Valor
applicationPassword A senha do aplicativo. string
associaçãoAssignedCode A associação atribuiu o código. string
controllingAgencyCode O código da agência controladora. string
funcionalGroupId O id do grupo funcional. string
groupHeaderMessageRelease A liberação da mensagem de cabeçalho do grupo. string
groupHeaderMessageVersion A versão da mensagem do cabeçalho do grupo. string
messageAssociationAssignedCode O código atribuído à associação de mensagens. string
messageId O ID da mensagem no qual as configurações desse envelope devem ser aplicadas. string
messageRelease A versão de liberação de mensagem na qual essas configurações de envelope devem ser aplicadas. string
messageVersion A versão da mensagem na qual as configurações desse envelope devem ser aplicadas. string
receiverApplicationId O ID do aplicativo do recetor. string
receiverApplicationQualifier O qualificador do aplicativo do recetor. string
senderApplicationId A ID do aplicativo remetente. string
senderApplicationQualifier O qualificador do aplicativo remetente. string
targetNamespace O namespace de destino no qual essas configurações de envelope devem ser aplicadas. string

EdifactEnvelopeSettings

Designação Descrição Valor
applicationReferenceId A ID de referência do aplicativo. string
applyDelimiterStringAdvice O valor que indica se o aviso de cadeia de caracteres do delimitador deve ser aplicado. bool (obrigatório)
communicationAgreementId O contrato de comunicação id. string
createGroupingSegments O valor que indica se os segmentos de agrupamento devem ser criados. bool (obrigatório)
enableDefaultGroupHeaders O valor que indica se os cabeçalhos de grupo padrão devem ser habilitados. bool (obrigatório)
funcionalGroupId O id do grupo funcional. string
groupApplicationPassword A senha do aplicativo de grupo. string
groupApplicationReceiverId A ID do recetor do aplicativo de grupo. string
groupApplicationReceiverQualifier O qualificador do recetor do aplicativo de grupo. string
groupApplicationSenderId A ID do remetente do aplicativo de grupo. string
groupApplicationSenderQualifier O qualificador do remetente do aplicativo de grupo. string
groupAssociationAssignedCode A associação de grupo atribuiu o código. string
groupControllingAgencyCode O código da agência controladora do grupo. string
groupControlNumberLowerBound O limite inferior do número de controle de grupo. int (obrigatório)
groupControlNumberPrefix O prefixo do número de controle de grupo. string
groupControlNumberSuffix O sufixo do número de controle do grupo. string
groupControlNumberUpperBound O limite superior do número de controle de grupo. int (obrigatório)
groupMessageRelease A liberação da mensagem de grupo. string
groupMessageVersion A versão da mensagem de grupo. string
interchangeControlNumberLowerBound O limite inferior do número de controle de intercâmbio. int (obrigatório)
interchangeControlNumberPrefix O prefixo do número de controle de intercâmbio. string
interchangeControlNumberSuffix O sufixo do número de controle de intercâmbio. string
interchangeControlNumberUpperBound O limite superior do número de controle de intercâmbio. int (obrigatório)
isTestInterchange O valor que indica se a mensagem é um intercâmbio de teste. bool (obrigatório)
overwriteExistingTransactionSetControlNumber O valor que indica se o número de controle do conjunto de transações existente deve ser substituído. bool (obrigatório)
processandoPriorityCode O código de prioridade de processamento. string
receiverIdentificação Interna A identificação interna do recetor. string
receptorInternalSubIdentification A subidentificação interna do recetor. string
receiverReverseRoutingAddress O endereço de roteamento reverso do recetor. string
recipientReferencePasswordQualifier O qualificador de senha de referência do destinatário. string
recipientReferencePasswordValue O valor da senha de referência do destinatário. string
rolloverGroupControlNumber O valor que indica se o número de controle do grupo deve ser substituído. bool (obrigatório)
rolloverInterchangeControlNumber O valor que indica se o número de controle de intercâmbio deve ser substituído. bool (obrigatório)
rolloverTransactionSetControlNumber O valor que indica se o número de controle do conjunto de transações de rollover deve ser feito. bool (obrigatório)
senderIdentificação Interna A identificação interna do remetente. string
senderInternalSubIdentification A subidentificação interna do remetente. string
senderReverseRoutingAddress O endereço de roteamento reverso do remetente. string
transactionSetControlNumberLowerBound O número de controle do conjunto de transações limite inferior. int (obrigatório)
transactionSetControlNumberPrefix O prefixo do número de controle do conjunto de transações. string
transactionSetControlNumberSuffix O sufixo do número de controle do conjunto de transações. string
transactionSetControlNumberUpperBound O limite superior do número de controle do conjunto de transações. int (obrigatório)

EdifactFramingSettings

Designação Descrição Valor
characterEncoding A codificação de caracteres. string
conjunto de caracteres O caractere de configuração de quadro EDIFACT. 'KECA'
'Não especificado'
'UNOA'
'UNOB'
«UNOC»
'UNOD'
'UNOE'
'SEM OF'
«UNOG»
'UNOH'
«UNOI»
"UNOJ"
'UNOK'
'UNOX'
«UNOY» (obrigatório)
componentSeparador O separador de componentes. int (obrigatório)
dataElementSeparator O separador de elemento de dados. int (obrigatório)
decimalPointIndicator O indicador decimal de configuração do quadro EDIFACT. 'Vírgula'
'Decimal'
'NotSpecified' (obrigatório)
protocolVersion A versão do protocolo. int (obrigatório)
releaseIndicator O indicador de lançamento. int (obrigatório)
repetiçãoSeparador O separador de repetição. int (obrigatório)
segmentTerminador O terminador de segmento. int (obrigatório)
segmentTerminatorSufixo O sufixo do terminador de segmento de configuração de quadro EDIFACT. «CR»
'CRLF'
'LF'
'Nenhuma'
'NotSpecified' (obrigatório)
serviceCodeListDirectoryVersion A versão do diretório da lista de códigos de serviço. string

EdifactMessageFilter

Designação Descrição Valor
messageFilterType O tipo de filtro de mensagem. 'Excluir'
'Incluir'
'NotSpecified' (obrigatório)

EdifactMessageIdentifier

Designação Descrição Valor
messageId O ID da mensagem no qual as configurações desse envelope devem ser aplicadas. string (obrigatório)

EdifactOneWayAgreement

Designação Descrição Valor
protocolSettings As configurações do protocolo EDIFACT. EdifactProtocolSettings (obrigatório)
destinatárioIdentidade de negócios A identidade comercial do destinatário BusinessIdentity (obrigatório)
senderBusinessIdentity A identidade comercial do remetente BusinessIdentity (obrigatório)

EdifactProcessingSettings

Designação Descrição Valor
createEmptyXmlTagsForTrailingSeparators O valor que indica se as marcas xml vazias devem ser criadas para separadores à direita. bool (obrigatório)
máscaraSecurityInfo O valor que indica se as informações de segurança devem ser mascaradas. bool (obrigatório)
preserveInterchange O valor que indica se o intercâmbio deve ser preservado. bool (obrigatório)
suspendInterchangeOnError O valor que indica se o intercâmbio deve ser suspenso em caso de erro. bool (obrigatório)
useDotAsDecimalSeparator O valor que indica se o ponto deve ser usado como separador decimal. bool (obrigatório)

EdifactProtocolSettings

Designação Descrição Valor
acknowledgementSettings As configurações de reconhecimento EDIFACT. EdifactAcknowledgementSettings (obrigatório)
edifactDelimiterSubstitui O delimitador EDIFACT substitui as configurações. EdifactDelimiterOverride[]
envelopeSubstitui O envelope EDIFACT substitui as configurações. EdifactEnvelopeOverride[]
envelopeSettings As configurações do envelope EDIFACT. EdifactEnvelopeSettings (obrigatório)
enquadramentoConfigurações As configurações de enquadramento EDIFACT. EdifactFramingSettings (obrigatório)
messageFilter O filtro de mensagens EDIFACT. EdifactMessageFilter (obrigatório)
messageFilterList A lista de filtros de mensagens EDIFACT. EdifactMessageIdentifier[]
processandoConfigurações As configurações de processamento EDIFACT. EdifactProcessingSettings (obrigatório)
schemaReferências As referências do esquema EDIFACT. EdifactSchemaReference[] (obrigatório)
validaçãoSubstitui As configurações de substituição de validação EDIFACT. EdifactValidationOverride[]
validationSettings As configurações de validação EDIFACT. EdifactValidationSettings (obrigatório)

EdifactSchemaReference

Designação Descrição Valor
associaçãoAssignedCode A associação atribuiu o código. string
messageId O ID da mensagem. string (obrigatório)
messageRelease A versão de lançamento da mensagem. string (obrigatório)
messageVersion A versão da mensagem. string (obrigatório)
schemaName O nome do esquema. string (obrigatório)
senderApplicationId A ID do aplicativo remetente. string
senderApplicationQualifier O qualificador do aplicativo remetente. string

EdifactValidationOverride

Designação Descrição Valor
allowLeadingAndTrailingSpacesAndZeroes O valor que indica se devem ser permitidos espaços à esquerda e à direita e zeros. bool (obrigatório)
enforceCharacterSet O valor que indica se o conjunto de caracteres deve ser validado. bool (obrigatório)
messageId O ID da mensagem no qual as configurações de validação devem ser aplicadas. string (obrigatório)
trailingSeparatorPolicy A política do separador à direita. 'Obrigatório'
'Não permitido'
'Não especificado'
'Opcional' (obrigatório)
trimLeadingAndTrailingSpacesAndZeroes O valor que indica se os espaços à esquerda e à direita devem ser cortados e zeros. bool (obrigatório)
validateEDITypes O valor que indica se os tipos EDI devem ser validados. bool (obrigatório)
validateXSDTypes O valor que indica se os tipos XSD devem ser validados. bool (obrigatório)

EdifactValidationSettings

Designação Descrição Valor
allowLeadingAndTrailingSpacesAndZeroes O valor que indica se devem ser permitidos espaços à esquerda e à direita e zeros. bool (obrigatório)
checkDuplicateGroupControlNumber O valor que indica se o número de controle de grupo duplicado deve ser verificado. bool (obrigatório)
checkDuplicateInterchangeControlNumber O valor que indica se o número de controlo de intercâmbio duplicado deve ser verificado. bool (obrigatório)
checkDuplicateTransactionSetControlNumber O valor que indica se o número de controle do conjunto de transações duplicado deve ser verificado. bool (obrigatório)
interchangeControlNumberValidityDays O período de validade do número de controlo de intercâmbio. int (obrigatório)
trailingSeparatorPolicy A política do separador à direita. 'Obrigatório'
'Não permitido'
'Não especificado'
'Opcional' (obrigatório)
trimLeadingAndTrailingSpacesAndZeroes O valor que indica se os espaços à esquerda e à direita devem ser cortados e zeros. bool (obrigatório)
validateCharacterSet O valor que indica se o conjunto de caracteres deve ser validado na mensagem. bool (obrigatório)
validateEDITypes O valor que indica se os tipos EDI devem ser validados. bool (obrigatório)
validateXSDTypes O valor que indica se os tipos XSD devem ser validados. bool (obrigatório)

IntegrationAccountAgreementProperties

Designação Descrição Valor
tipo de acordo O tipo de contrato. «AS2»
'Edifact'
'Não especificado'
'X12' (obrigatório)
Conteúdo O conteúdo do acordo. Contrato de Conteúdo (obrigatório)
guestIdentity A identidade comercial do parceiro convidado. BusinessIdentity (obrigatório)
guestPartner O parceiro de conta de integração definido como parceiro convidado para este contrato. string (obrigatório)
hostIdentity A identidade comercial do parceiro anfitrião. BusinessIdentity (obrigatório)
hostPartner O parceiro de conta de integração definido como parceiro anfitrião para este contrato. string (obrigatório)
metadados Os metadados. qualquer

Microsoft.Logic/integrationAccounts/agreements

Designação Descrição Valor
Localização A localização do recurso. string
Designação O nome do recurso string (obrigatório)
parent_id A ID do recurso que é o pai para este recurso. ID do recurso do tipo: integrationAccounts
propriedades As propriedades do contrato de conta de integração. IntegrationAccountAgreementProperties (obrigatório)
Etiquetas Tags de recursos Dicionário de nomes e valores de tags.
tipo O tipo de recurso "Microsoft.Logic/integrationAccounts/agreements@2019-05-01"

Tags de Recursos

Designação Descrição Valor

X12AcknowledgementSettings

Designação Descrição Valor
reconhecimentoControlNumberLowerBound O limite inferior do número de controle de confirmação. int (obrigatório)
reconhecimentoControlNumberPrefix O prefixo do número de controle de confirmação. string
acknowledgementControlNumberSuffix O sufixo do número de controle de confirmação. string
reconhecimentoControlNumberUpperBound O limite superior do número de controle de confirmação. int (obrigatório)
batchFuncionalAgradecimentos O valor que indica se as confirmações funcionais de lote devem ser feitas. bool (obrigatório)
batchImplementationAgradecimentos O valor que indica se as confirmações de implementação em lote devem ser feitas. bool (obrigatório)
batchTechnicalAgradecimentos O valor que indica se os agradecimentos técnicos devem ser agrupados. bool (obrigatório)
funcionalAgradecimentoVersão A versão de reconhecimento funcional. string
implementaçãoAgradecimentoVersão A versão de confirmação de implementação. string
necessidadeReconhecimento Funcional O valor que indica se o reconhecimento funcional é necessário. bool (obrigatório)
necessidadeImplementaçãoReconhecimento O valor que indica se o reconhecimento da implementação é necessário. bool (obrigatório)
needLoopForValidMessages O valor que indica se um loop é necessário para mensagens válidas. bool (obrigatório)
necessidadeReconhecimento técnico O valor que indica se o reconhecimento técnico é necessário. bool (obrigatório)
rolloverConfirmaçãoControlNumber O valor que indica se o número de controle de confirmação de rolagem deve ser feito. bool (obrigatório)
sendSynchronousReconhecimento O valor que indica se a confirmação síncrona deve ser enviada. bool (obrigatório)

X12AgreementContent

Designação Descrição Valor
receberAcordo O acordo de recebimento unidirecional X12. X12OneWayAgreement (obrigatório)
sendAgreement O contrato de envio unidirecional X12. X12OneWayAgreement (obrigatório)

X12DelimiterSubstitui

Designação Descrição Valor
componentSeparador O separador de componentes. int (obrigatório)
dataElementSeparator O separador de elemento de dados. int (obrigatório)
messageId O ID da mensagem. string
protocolVersion A versão do protocolo. string
replaceCharacter O caráter de substituição. int (obrigatório)
replaceSeparatorsInPayload O valor que indica se os separadores devem ser substituídos na carga útil. bool (obrigatório)
segmentTerminador O terminador de segmento. int (obrigatório)
segmentTerminatorSufixo O sufixo terminador de segmento. «CR»
'CRLF'
'LF'
'Nenhuma'
'NotSpecified' (obrigatório)
targetNamespace O namespace de destino no qual essas configurações de delimitador devem ser aplicadas. string

X12EnvelopeOverride

Designação Descrição Valor
dateFormat O formato de data. «CCYYMMDD»
'Não especificado'
«AAMMDD» (obrigatório)
functionalIdentifierCode O código identificador funcional. string
headerVersion A versão do cabeçalho. string (obrigatório)
messageId O ID da mensagem no qual as configurações desse envelope devem ser aplicadas. string (obrigatório)
protocolVersion A versão do protocolo na qual essas configurações de envelope devem ser aplicadas. string (obrigatório)
receiverApplicationId O ID do aplicativo do recetor. string (obrigatório)
responsibleAgencyCode O código da agência responsável. string (obrigatório)
senderApplicationId A ID do aplicativo remetente. string (obrigatório)
targetNamespace O namespace de destino no qual essas configurações de envelope devem ser aplicadas. string (obrigatório)
timeFormat O formato de hora. 'HHMM'
'HHMMSS'
'HHMMSSd'
'HHMMSSdd'
'NotSpecified' (obrigatório)

X12EnvelopeSettings

Designação Descrição Valor
controlStandardsId Os padrões de controle id. int (obrigatório)
controlVersionNumber O número da versão de controle. string (obrigatório)
enableDefaultGroupHeaders O valor que indica se os cabeçalhos de grupo padrão devem ser habilitados. bool (obrigatório)
funcionalGroupId O id do grupo funcional. string
groupControlNumberLowerBound O limite inferior do número de controle de grupo. int (obrigatório)
groupControlNumberUpperBound O limite superior do número de controle de grupo. int (obrigatório)
groupHeaderAgencyCode O código da agência de cabeçalho do grupo. string (obrigatório)
groupHeaderDateFormat O formato de data do cabeçalho do grupo. «CCYYMMDD»
'Não especificado'
«AAMMDD» (obrigatório)
groupHeaderTimeFormat O formato de hora do cabeçalho do grupo. 'HHMM'
'HHMMSS'
'HHMMSSd'
'HHMMSSdd'
'NotSpecified' (obrigatório)
groupHeaderVersion A versão do cabeçalho do grupo. string (obrigatório)
interchangeControlNumberLowerBound O limite inferior do número de controle de intercâmbio. int (obrigatório)
interchangeControlNumberUpperBound O limite superior do número de controle de intercâmbio. int (obrigatório)
overwriteExistingTransactionSetControlNumber O valor que indica se o número de controle do conjunto de transações existente deve ser substituído. bool (obrigatório)
receiverApplicationId O ID do aplicativo do recetor. string (obrigatório)
rolloverGroupControlNumber O valor que indica se o número de controle do grupo deve ser substituído. bool (obrigatório)
rolloverInterchangeControlNumber O valor que indica se o número de controle de intercâmbio deve ser substituído. bool (obrigatório)
rolloverTransactionSetControlNumber O valor que indica se o número de controle do conjunto de transações de rollover deve ser feito. bool (obrigatório)
senderApplicationId A ID do aplicativo remetente. string (obrigatório)
transactionSetControlNumberLowerBound O número de controle do conjunto de transações limite inferior. int (obrigatório)
transactionSetControlNumberPrefix O prefixo do número de controle do conjunto de transações. string
transactionSetControlNumberSuffix O sufixo do número de controle do conjunto de transações. string
transactionSetControlNumberUpperBound O limite superior do número de controle do conjunto de transações. int (obrigatório)
usageIndicator O indicador de utilização. 'Informação'
'Não especificado'
'Produção'
'Teste' (obrigatório)
useControlStandardsIdAsRepetitionCharacter O valor que indica se os padrões de controle devem ser usados como caractere de repetição. bool (obrigatório)

X12FramingSettings

Designação Descrição Valor
conjunto de caracteres O conjunto de caracteres X12. 'Básico'
'Prorrogado'
'Não especificado'
'UTF8' (obrigatório)
componentSeparador O separador de componentes. int (obrigatório)
dataElementSeparator O separador de elemento de dados. int (obrigatório)
replaceCharacter O caráter de substituição. int (obrigatório)
replaceSeparatorsInPayload O valor que indica se os separadores devem ser substituídos na carga útil. bool (obrigatório)
segmentTerminador O terminador de segmento. int (obrigatório)
segmentTerminatorSufixo O sufixo terminador de segmento. «CR»
'CRLF'
'LF'
'Nenhuma'
'NotSpecified' (obrigatório)

X12MessageFilter

Designação Descrição Valor
messageFilterType O tipo de filtro de mensagem. 'Excluir'
'Incluir'
'NotSpecified' (obrigatório)

X12MessageIdentifier

Designação Descrição Valor
messageId O ID da mensagem. string (obrigatório)

X12OneWayAcordo

Designação Descrição Valor
protocolSettings As configurações do protocolo X12. X12ProtocolSettings (obrigatório)
destinatárioIdentidade de negócios A identidade comercial do destinatário BusinessIdentity (obrigatório)
senderBusinessIdentity A identidade comercial do remetente BusinessIdentity (obrigatório)

X12ProcessingSettings

Designação Descrição Valor
convertImpliedDecimal O valor que indica se o tipo numérico deve ser convertido em decimal implícito. bool (obrigatório)
createEmptyXmlTagsForTrailingSeparators O valor que indica se as marcas xml vazias devem ser criadas para separadores à direita. bool (obrigatório)
máscaraSecurityInfo O valor que indica se as informações de segurança devem ser mascaradas. bool (obrigatório)
preserveInterchange O valor que indica se o intercâmbio deve ser preservado. bool (obrigatório)
suspendInterchangeOnError O valor que indica se o intercâmbio deve ser suspenso em caso de erro. bool (obrigatório)
useDotAsDecimalSeparator O valor que indica se o ponto deve ser usado como separador decimal. bool (obrigatório)

X12ProtocolSettings

Designação Descrição Valor
acknowledgementSettings As configurações de confirmação do X12. X12AcknowledgementSettings (obrigatório)
envelopeSubstitui O envelope X12 substitui as configurações. X12EnvelopeOverride[]
envelopeSettings As configurações do envelope X12. X12EnvelopeSettings (obrigatório)
enquadramentoConfigurações As configurações de enquadramento X12. X12FramingSettings (obrigatório)
messageFilter O filtro de mensagens X12. X12MessageFilter (obrigatório)
messageFilterList A lista de filtros de mensagens X12. X12MessageIdentifier[]
processandoConfigurações As configurações de processamento do X12. X12ProcessingSettings (obrigatório)
schemaReferências As referências do esquema X12. X12SchemaReference[] (obrigatório)
securityConfigurações: As configurações de segurança do X12. X12SecuritySettings (obrigatório)
validaçãoSubstitui As configurações de substituição de validação X12. X12ValidationOverride[]
validationSettings As configurações de validação do X12. X12ValidationSettings (obrigatório)
x12DelimiterSubstitui O delimitador X12 substitui as configurações. X12DelimiterSubstitui[]

X12SchemaReference

Designação Descrição Valor
messageId O ID da mensagem. string (obrigatório)
schemaName O nome do esquema. string (obrigatório)
schemaVersion A versão do esquema. string (obrigatório)
senderApplicationId A ID do aplicativo remetente. string

X12SecuritySettings

Designação Descrição Valor
authorizationQualificador O qualificador de autorização. string (obrigatório)
authorizationValue O valor da autorização. string
passwordValue O valor da senha. string
securityQualificador O qualificador de segurança. string (obrigatório)

X12ValidationOverride

Designação Descrição Valor
allowLeadingAndTrailingSpacesAndZeroes O valor que indica se devem ser permitidos espaços à esquerda e à direita e zeros. bool (obrigatório)
messageId O ID da mensagem no qual as configurações de validação devem ser aplicadas. string (obrigatório)
trailingSeparatorPolicy A política do separador à direita. 'Obrigatório'
'Não permitido'
'Não especificado'
'Opcional' (obrigatório)
trimLeadingAndTrailingSpacesAndZeroes O valor que indica se os espaços à esquerda e à direita devem ser cortados e zeros. bool (obrigatório)
validateCharacterSet O valor que indica se o conjunto de caracteres deve ser validado. bool (obrigatório)
validateEDITypes O valor que indica se os tipos EDI devem ser validados. bool (obrigatório)
validateXSDTypes O valor que indica se os tipos XSD devem ser validados. bool (obrigatório)

X12ValidationSettings

Designação Descrição Valor
allowLeadingAndTrailingSpacesAndZeroes O valor que indica se devem ser permitidos espaços à esquerda e à direita e zeros. bool (obrigatório)
checkDuplicateGroupControlNumber O valor que indica se o número de controle de grupo duplicado deve ser verificado. bool (obrigatório)
checkDuplicateInterchangeControlNumber O valor que indica se o número de controlo de intercâmbio duplicado deve ser verificado. bool (obrigatório)
checkDuplicateTransactionSetControlNumber O valor que indica se o número de controle do conjunto de transações duplicado deve ser verificado. bool (obrigatório)
interchangeControlNumberValidityDays O período de validade do número de controlo de intercâmbio. int (obrigatório)
trailingSeparatorPolicy A política do separador à direita. 'Obrigatório'
'Não permitido'
'Não especificado'
'Opcional' (obrigatório)
trimLeadingAndTrailingSpacesAndZeroes O valor que indica se os espaços à esquerda e à direita devem ser cortados e zeros. bool (obrigatório)
validateCharacterSet O valor que indica se o conjunto de caracteres deve ser validado na mensagem. bool (obrigatório)
validateEDITypes O valor que indica se os tipos EDI devem ser validados. bool (obrigatório)
validateXSDTypes O valor que indica se os tipos XSD devem ser validados. bool (obrigatório)