AS2ProtocolSettings
Important
Microsoft Azure BizTalk Services (MABS) is being retired, and replaced with Azure Logic Apps. If you currently use MABS, then Move from BizTalk Services to Logic Appsprovides some guidance on moving your integration solutions to Logic Apps.
If you're brand new to Logic Apps, then we suggest getting started here:
-
Create your first logic app, or quickly get started using a pre-built template
-
View all the available connectors you can use in your logic apps
An AS2ProtocolSettings entity inherits the ProtocolSettings entity and provides the AS2 protocol information.
AS2ProtocolSettings Entity Properties
Create an AS2ProtocolSettings
List AS2 Protocol Settings
Update an AS2 Protocol Setting
Delete an AS2 Protocol Setting
AS2ProtocolSettings Entity Properties
Property |
Type |
Description |
---|---|---|
AckHttpExpect100Continue |
Bool |
Specifies that the posted data is not included in the initial HTTP request, and waits for the server to request the content. |
AckIgnoreCertificateNameMismatch |
Bool |
Required. Specifies whether the SSL connection is accepted even if the server name does not match the server name that the SSL certificate was generated for. |
AckKeepHttpConnectionAlive |
Bool |
Specifies that an HTTP connection is kept alive even after a request and response cycle is completed. |
AckUnfoldHttpHeaders |
Bool |
Specifies whether the HTTP content-type header is unfolded into a single line. |
AutogenerateFileName |
Bool |
Specifies whether the bridge generates a filename |
CheckCertificateRevocationListOnReceive |
Bool |
Specifies whether the certificate to be used in decrypting a received message is included in the Certificate Revocation List. |
CheckCertificateRevocationListOnSend |
Bool |
Specifies whether the certificate to be used in signing an outgoing message is included in the Certificate Revocation List. |
CheckDuplicateInterchangeControlNumber |
Bool |
Specifies whether the bridge checks for duplicate interchange control numbers in the received message. |
DispositionNotificationTo |
String |
Specifies whether the party sending the MDN, signs the MDN, if the generation of MDN is enabled by the Disposition-Notification-To header of the AS2 message. |
EnableNRRForInboundDecodedMessages |
Bool |
Required. Specifies whether inbound decoded AS2 messages are stored in the non-repudiation database. |
EnableNRRForInboundEncodedMessages |
Bool |
Required. Specifies whether inbound encoded AS2 messages are stored in the non-repudiation database. |
EnableNRRForInboundMDN |
Bool |
Specifies whether the inbound MDN is stored in the non-repudiation database. |
EnableNRRForOutboundDecodedMessages |
Bool |
Required. Specifies whether outbound decoded AS2 messages are stored in the non-repudiation database. |
EnableNRRForOutboundEncodedMessages |
Bool |
Required. Specifies whether outbound encoded AS2 messages are stored in the non-repudiation database. |
EnableNRRForOutboundMDN |
Bool |
Specifies whether the outbound MDN is stored in the non-repudiation database. |
EncryptionAlgorithm |
Short |
Required. Specifies the encryption algorithm. The valid values are:
|
EncryptionCertificateId |
Int |
Specifies the encryption certificate ID. |
EncryptionCertificateThumbprint |
String |
Specifies the thumbprint of the certificate used for encryption. This value must not exceed 128 characters. |
FileNameTemplate |
String |
Specifies a string value for filename. |
HttpExpect100Continue |
Bool |
Specifies that the posted data is not included in the initial HTTP request, and waits for the server to request the content. |
HttpRetryTimeoutTicks |
Long |
- |
IgnoreCertificateNameMismatch |
Bool |
Required. Specifies whether the SSL connection is accepted even if the server name does not match the server name that the SSL certificate was generated for. |
InterchangeDuplicatesValidity |
Short |
- |
KeepHttpConnectionAlive |
Bool |
Specifies that an HTTP connection is kept alive even after a request and response cycle is completed. |
MaximumHttpRetryAttempts |
Int |
Specifies the maximum amount of time to attempt retries using HTTP. |
MaxResendAttempts |
Int |
Specifies the maximum number of resend attempts to be made |
MicHashingAlgorithm |
Short |
Required. Specifies the MIC algorithm. |
MDNText |
String |
Specifies a text that the sending partner adds to the MDN messages (under the Content-Description field). |
MessageCompressed |
Bool |
Required. Specifies whether the AS2 message is compressed. |
MessageContentType |
String |
Required. Specifies the default content-type of the message. |
MessageEncrypted |
Bool |
Required. Specifies whether the AS2 message is encrypted. |
MessageSigned |
Bool |
Required. Specifies whether the AS2 message is signed. |
MinimumHttpRetryTicks |
Long |
Specifies the minimum amount of time to attempt retries using HTTP. |
SendMDNAsynchronously |
Bool |
Required. Specifies whether an MDN is sent asynchronously. |
NeedMdn |
Bool |
Required. Specifies whether a trading partner must generate an MDN in response to an AS2 message. |
SignMdn |
Bool |
Required. Specifies whether the MDN must be signed using SHA1 or MD5. |
OverrideMessageProperties |
Bool |
Required. Specifies whether the message properties are overridden. |
ProtocolName |
String |
Specifies the protocol name. The valid value is as2. |
ReceiptDeliverUrl |
String |
Specifies the URL at which the receiving party must send the MDN. This must not be more than 256 characters. |
SigningCertificateId |
Int |
Specifies the ID of the signing certificate. |
SigningCertificateThumbprint |
String |
Specifies the thumbprint of the certificate used for signing. This value must not be greater than 128 characters. |
SignOutboundMdnIfOptional |
Bool |
Required. |
SuspendDuplicateMessage |
Bool |
Required. Specifies whether a duplicate AS2 message is suspended. |
SuspendMessageOnFileNameGenerationError |
Bool |
Required. |
TransmitFileNameInMimeHeader |
Bool |
Required. Specifies whether a file name is sent as part of a MIME header of an outbound AS2 message. |
UnfoldHttpHeaders |
Bool |
Required. Specifies whether the HTTP content-type header is unfolded into a single line. |
Version |
Byte[] |
This value is auto-generated and is for internal use only. |
Create an AS2ProtocolSettings
You can create an AS2 protocol settings entity using a POST HTTP request.
Method |
Request URI |
HTTP Version |
---|---|---|
POST |
https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/ProtocolSettings |
HTTP/1.1 |
Sample Request
POST https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/ProtocolSettings HTTP/1.1
Accept-Charset: UTF-8
DataServiceVersion: 1.0;NetFx
MaxDataServiceVersion: 3.0;NetFx
Accept: application/atom+xml,application/xml
Authorization: WRAP access_token="<token>"
x-ms-version: 1.0
Content-Type: application/atom+xml
Host: integration.zurich.test.dnsdemo1.com:5446
Expect: 100-continue
<?xml version="1.0" encoding="utf-8"?>
<entry xmlns="https://www.w3.org/2005/Atom" xmlns:d="https://schemas.microsoft.com/ado/2007/08/dataservices" xmlns:m="https://schemas.microsoft.com/ado/2007/08/dataservices/metadata">
<category term="Microsoft.ApplicationServer.Integration.PartnerManagement.AS2ProtocolSettings" scheme="https://schemas.microsoft.com/ado/2007/08/dataservices/scheme" />
<id />
<title />
<updated>2013-02-13T18:46:57Z</updated>
<author>
<name />
</author>
<content type="application/xml">
<m:properties>
...
[ Property names with their values ]
...
</m:properties>
</content>
</entry>
List AS2 Protocol Settings
You can list the AS2 protocol settings using a GET HTTP request.
Method |
Request URI |
HTTP Version |
---|---|---|
GET |
https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/ProtocolSettings/Microsoft.ApplicationServer.Integration.PartnerManagement.AS2ProtocolSettings This returns all the protocol settings entities |
HTTP/1.1 |
GET |
https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/ProtocolSettings(id)/Microsoft.ApplicationServer.Integration.PartnerManagement.AS2ProtocolSettings This returns information about the protocol setting with the specified ID. |
HTTP/1.1 |
Sample Request
Retrieve all the protocol settings
GET https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/ProtocolSettings/Microsoft.ApplicationServer.Integration.PartnerManagement.AS2ProtocolSettings HTTP/1.1
Accept-Charset: UTF-8
DataServiceVersion: 1.0;NetFx
MaxDataServiceVersion: 3.0;NetFx
Accept: application/atom+xml,application/xml
Authorization: WRAP access_token="<token>"
x-ms-version: 1.0
Host: integration.zurich.test.dnsdemo1.com:5446
Retrieve information about a specific protocol setting
GET https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/ProtocolSettings(1)/Microsoft.ApplicationServer.Integration.PartnerManagement.AS2ProtocolSettings HTTP/1.1
Accept-Charset: UTF-8
DataServiceVersion: 1.0;NetFx
MaxDataServiceVersion: 3.0;NetFx
Accept: application/atom+xml,application/xml
Authorization: WRAP access_token="<token>"
x-ms-version: 1.0
Host: integration.zurich.test.dnsdemo1.com:5446
Update an AS2 Protocol Setting
You can update an AS2 protocol setting using a MERGE HTTP request.
Method |
Request URI |
HTTP Version |
---|---|---|
MERGE |
https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/ProtocolSettings(id)/ Microsoft.ApplicationServer.Integration.PartnerManagement.AS2ProtocolSettings |
HTTP/1.1 |
Sample Request
MERGE https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/ProtocolSettings(1)/Microsoft.ApplicationServer.Integration.PartnerManagement.AS2ProtocolSettings HTTP/1.1
Accept-Charset: UTF-8
DataServiceVersion: 1.0;NetFx
MaxDataServiceVersion: 3.0;NetFx
Accept: application/atom+xml,application/xml
Authorization: WRAP access_token="<token>"
x-ms-version: 1.0
Content-Type: application/atom+xml
Host: integration.zurich.test.dnsdemo1.com:5446
Content-Length: 4724
Expect: 100-continue
<?xml version="1.0" encoding="utf-8"?>
<entry xmlns="https://www.w3.org/2005/Atom" xmlns:d="https://schemas.microsoft.com/ado/2007/08/dataservices" xmlns:m="https://schemas.microsoft.com/ado/2007/08/dataservices/metadata">
<id>https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/ProtocolSettings(1)</id>
<category term="Microsoft.ApplicationServer.Integration.PartnerManagement.AS2ProtocolSettings" scheme="https://schemas.microsoft.com/ado/2007/08/dataservices/scheme" />
<title />
<updated>2013-02-13T19:05:16Z</updated>
<author>
<name />
</author>
<content type="application/xml">
<m:properties>
...
[ Updated Properties with their values ]
...
</m:properties>
</content>
</entry>
Delete an AS2 Protocol Setting
You can delete an AS2 protocol setting using a DELETE HTTP request.
Method |
Request URI |
HTTP Version |
---|---|---|
DELETE |
https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/ProtocolSettings(id)/Microsoft.ApplicationServer.Integration.PartnerManagement.AS2ProtocolSettings |
HTTP/1.1 |
Sample Request
DELETE https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/ProtocolSettings(1)/Microsoft.ApplicationServer.Integration.PartnerManagement.AS2ProtocolSettings HTTP/1.1
Accept-Charset: UTF-8
DataServiceVersion: 1.0;NetFx
MaxDataServiceVersion: 3.0;NetFx
Accept: application/atom+xml,application/xml
Authorization: WRAP access_token="<token>"
x-ms-version: 1.0
Host: integration.zurich.test.dnsdemo1.com:5446
Content-Length: 0