CertificateReference

Article
06/12/2017

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:

What are logic apps
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

A CertificateReference entity refers to a certificate in the artifact store and is used for configuring AS2 agreements.

CertificateReference Entity Properties
Create a CertificateReference
List CertificateReferences
Update a CertificateReference
Delete a CertificateReference
Link Other Entities with CertificateReference
Delete Link between Other Entities and CertificateReference

CertificateReference Entity Properties

Property	Type	Description
ID	Int	Specifies a unique ID for the certificate reference. This value is auto-generated.
Thumbprint	String	Required. Specifies the unique thumbprint of the certificate. This must not be more than 128 characters.
AS2ProtocolSettingsForEncryption	DataServiceCollection<AS2ProtocolSettings>	A navigation property that references the AS2 protocol settings for encryption.
AS2ProtocolSettingsForSigning	DataServiceCollection<AS2ProtocolSettings>	A navigation property that references the AS2 protocol settings for signing.
BusinessProfile	BusinessProfile	Required. A navigation property that references the business profile with which the certificate must be associated.
BusinessProfileId	Int	Specifies the ID of the business profile.
HasPrivateKey	Bool	Specifies whether the certificate has a private key
Version	Byte[]	This value is auto-generated and is for internal use only.

Considerations

You must add a certificate reference until you upload the certificate using the artifact store API for uploading the certificate.

Create a CertificateReference

You can create a certificate reference using a POST HTTP request.

Method	Request URI	HTTP Version
POST	https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/CertificateReferences	HTTP/1.1

Sample Request

The following request message shows how to create a certificate reference and link it to a business profile entity.

POST https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/CertificateReferences 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.CertificateReference" scheme="https://schemas.microsoft.com/ado/2007/08/dataservices/scheme" />
  <link rel="https://schemas.microsoft.com/ado/2007/08/dataservices/related/BusinessProfile" type="application/atom+xml;type=entry" title="BusinessProfile" href="https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/BusinessProfiles(1)" />
  <id />
  <title />
  <updated>2013-02-13T20:46:45Z</updated>
  <author>
    <name />
  </author>
  <content type="application/xml">
    <m:properties>
      <d:BusinessProfileId m:type="Edm.Int32">0</d:BusinessProfileId>
      <d:HasPrivateKey m:type="Edm.Boolean">false</d:HasPrivateKey>
      <d:Id m:type="Edm.Int32">0</d:Id>
      <d:Thumbprint m:null="true" />
      <d:Version m:type="Edm.Binary">AA==</d:Version>
    </m:properties>
  </content>
</entry>

List CertificateReferences

You can list the certificate references using a GET HTTP request.

Method	Request URI	HTTP Version
GET	https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/CertificateReferences This returns all the certificate reference entities	HTTP/1.1
GET	https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/CertificateReferences(id) This returns information about the certificate reference with the specified ID.	HTTP/1.1

GET

https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/CertificateReferences

This returns all the certificate reference entities

HTTP/1.1

GET

https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/CertificateReferences(id)

This returns information about the certificate reference with the specified ID.

HTTP/1.1

Sample Request

Retrieve all the certificate references

GET https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/CertificateReferences 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 certificate reference

GET https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/CertificateReferences(1) 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 a CertificateReference

You can update a certificate reference using a MERGE HTTP request.

Method	Request URI	HTTP Version
MERGE	https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/CertificateReferences(id)	HTTP/1.1

Sample Request

MERGE https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/CertificateReferences(1) 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
If-Match: W/"X'0000000000000FDB'"
Host: integration.zurich.test.dnsdemo1.com:5446
Content-Length: 888
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/CertificateReferences(1)</id>
  <category term="Microsoft.ApplicationServer.Integration.PartnerManagement.CertificateReference" scheme="https://schemas.microsoft.com/ado/2007/08/dataservices/scheme" />
  <title />
  <updated>2013-02-13T21:41:09Z</updated>
  <author>
    <name />
  </author>
  <content type="application/xml">
    <m:properties>
      <d:BusinessProfileId m:type="Edm.Int32">1</d:BusinessProfileId>
      <d:HasPrivateKey m:type="Edm.Boolean">true</d:HasPrivateKey>
      <d:Id m:type="Edm.Int32">1</d:Id>
      <d:Thumbprint m:null="true" />
      <d:Version m:type="Edm.Binary">AAAAAAAAD9s=</d:Version>
    </m:properties>
  </content>
</entry>

Delete a CertificateReference

You can delete a certificate reference using a DELETE HTTP request.

Method	Request URI	HTTP Version
DELETE	https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/CertificateReferences(id)	HTTP/1.1

Sample Request

DELETE https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/CertificateReferences(1) 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

Link Other Entities with CertificateReference

In Create a CertificateReference we see how to create a link between a certificate reference and a business profile while creating the certificate reference. In this section, we see how to create a link in the opposite direction, that is, from a business profile to a certificate reference. To create the link, the URI of the certificate reference must be included in the request body. You can use a similar request message to create links from other entities to a certificate reference.

Method	Request URI	HTTP Version
POST	https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/BusinessProfiles(id)/$links/CertificateReferences BusinessProfiles(id) denotes the ID of the business profile that links to the certificate reference.	HTTP/1.1

POST

https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/BusinessProfiles(id)/$links/CertificateReferences

BusinessProfiles(id) denotes the ID of the business profile that links to the certificate reference.

HTTP/1.1

Sample Request

POST https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/BusinessProfiles(1)/$links/CertificateReferences 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/xml
Host: integration.zurich.test.dnsdemo1.com:5446
Content-Length: 220
Expect: 100-continue

<?xml version="1.0" encoding="utf-8"?>
<uri xmlns="https://schemas.microsoft.com/ado/2007/08/dataservices/metadata">https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/CertificateReferences(1)</uri>

Delete Link between Other Entities and CertificateReference

You can delete a link between other entities and a certificate reference using a DELETE HTTP method. This section shows how to delete links between a business profile and a certificate reference. You can use similar requests to delete links from other entities to a certificate reference.

Method	Request URI	HTTP Version
DELETE	https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/BusinessProfiles(id)/$links/CertificateReferences(id)	HTTP/1.1

Sample Request

DELETE https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/BusinessProfiles(1)/$links/CertificateReferences(1) HTTP/1.1
Accept-Charset: UTF-8
DataServiceVersion: 1.0;NetFx
MaxDataServiceVersion: 3.0;NetFx
x-ms-version: 1.0
Accept: application/atom+xml,application/xml
Authorization: WRAP access_token="<token>"
Content-Type: application/xml
Host: integration.zurich.test.dnsdemo1.com:5446
Expect: 100-continue

CertificateReference

CertificateReference Entity Properties

Considerations

Create a CertificateReference

Sample Request

List CertificateReferences

Sample Request

Update a CertificateReference

Sample Request

Delete a CertificateReference

Sample Request

Link Other Entities with CertificateReference

Sample Request

Delete Link between Other Entities and CertificateReference

Sample Request

See Also

Additional resources