BusinessProfile
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
A BusinessProfile entity represents a business profile attached to a trading partner.
BusinessProfile Entity Properties
Create a Business Profile
List Business Profiles
Update a Business Profile
Delete a Business Profile
Link Partners with Business Profiles
Delete Link between Partners and BusinessProfiles
BusinessProfile Entity Properties
Property |
Type |
Description |
|---|---|---|
Name |
String |
Required. Specifies a unique name for the profile. The profile name must not exceed 256 characters. |
ID |
Int |
Specifies a unique ID for the profile. This value is auto-generated. |
Description |
String |
Specifies a descriptive text for the profile. The text must not exceed 512 characters. |
Partner |
Partner |
Required. A navigation property that references the Partner entity to which the business profile belongs. |
BusinessIdentities |
DataServiceCollection<BusinessIdentity> |
A navigation property that references the identities associated with a business profile. |
CertificateReferences |
DataServiceCollection<CertificateReference> |
A navigation property that references the certificates associated with a business profile |
Contacts |
DataServiceCollection<Contact> |
A navigation property that references the contact details associated with the business profile |
CustomSettings |
DataServiceCollection<CustomSetting> |
A navigation property that references the custom information about a business profile. |
ProtocolSettings |
DataServiceCollection<ProtocolSettings> |
A navigation property that references the protocol settings for a business profile. |
AgreementsAsA |
DataServiceCollection<Agreement> |
A navigation property that references the send-side agreement. |
AgreementsAsB |
DataServiceCollection<Agreement> |
A navigation property that references the receive-side agreement. |
Version |
Byte[] |
This value is auto-generated and is for internal use only. |
Create a Business Profile
You can create a business profile using a POST HTTP request.
Method |
Request URI |
HTTP Version |
|---|---|---|
POST |
https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/BusinessProfiles |
HTTP/1.1 |
Note
You cannot create a business profile without linking it to a partner. In the following sample request, a business profile is linked to a partner using the <link> element of the request body.
Sample Request
POST https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/BusinessProfiles HTTP/1.1
Content-Type: application/json; odata=verbose
Accept: text/html, application/xhtml+xml, */*
Host: integration.zurich.test.dnsdemo1.com:5446
DataServiceVersion: 1.0;NetFx
MaxDataServiceVersion: 3.0;NetFx
x-ms-version: 1.0
Connection: Keep-Alive
Authorization: WRAP access_token = "<token>"
Content-Length: 58
<?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.BusinessProfile" scheme="https://schemas.microsoft.com/ado/2007/08/dataservices/scheme" />
<link rel="https://schemas.microsoft.com/ado/2007/08/dataservices/related/Partner" type="application/atom+xml;type=entry" title="Partner" href="https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/Partners(id)" />
<id />
<title />
<updated>2013-01-28T20:57:26Z</updated>
<author>
<name />
</author>
<content type="application/xml">
<m:properties>
<d:Name>MyProfile</d:Name>
</m:properties>
</content>
</entry>
List Business Profiles
You can list business profiles using a GET HTTP request.
Method |
Request URI |
HTTP Version |
|---|---|---|
GET |
https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/BusinessProfiles This returns all the business profiles |
HTTP/1.1 |
GET |
https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/BusinessProfiles(id) This returns information about the business profile with the specified ID. |
HTTP/1.1 |
Sample Request
Retrieve all the profiles
GET https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/BusinessProfiles 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>"
Host: integration.zurich.test.dnsdemo1.com:5446
Retrieve information about a specific profile
GET https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/BusinessProfiles(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>"
Host: integration.zurich.test.dnsdemo1.com:5446
Update a Business Profile
You can update a business profile using a MERGE HTTP request.
Method |
Request URI |
HTTP Version |
|---|---|---|
MERGE |
https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/BusinessProfiles(id) |
HTTP/1.1 |
Sample Request
MERGE https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/BusinessProfiles(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/atom+xml
If-Match: W/"X'0000000000000FBB'"
Host: integration.zurich.test.dnsdemo1.com:5446
Content-Length: 804
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/BusinessProfiles(1)</id>
<category term="Microsoft.ApplicationServer.Integration.PartnerManagement.BusinessProfile" scheme="https://schemas.microsoft.com/ado/2007/08/dataservices/scheme" />
<title />
<updated>2013-01-28T23:48:46Z</updated>
<author>
<name />
</author>
<content type="application/xml">
<m:properties>
<d:Name>NewProfile123</d:Name>
</m:properties>
</content>
</entry>
Delete a Business Profile
You can delete a business profile using a DELETE HTTP request.
Method |
Request URI |
HTTP Version |
|---|---|---|
DELETE |
https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/BusinessProfiles(id) |
HTTP/1.1 |
Sample Request
DELETE https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/BusinessProfiles(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>"
If-Match: W/"X'0000000000000FD9'"
Host: integration.zurich.test.dnsdemo1.com:5446
Content-Length: 0
Link Partners with Business Profiles
In Create a Business Profile section, we saw how to create a link between a business profile and a partner while creating a business profile. In this section, we see how to create a link in the opposite direction, that is, from a partner to a business profile. To create the link, the URI of the business profile must be included in the request body.
Method |
Request URI |
HTTP Version |
|---|---|---|
POST |
https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/Partners(id)/$links/BusinessProfiles Partner(id) denotes the ID of the partner that links to the business profile |
HTTP/1.1 |
Sample Request
POST https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/Partners(1)/$links/BusinessProfiles 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
Content-Length: 216
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/BusinessProfiles(1)</uri>
Delete Link between Partners and BusinessProfiles
You can delete a link between partner and business profile by using the HTTP DELETE method.
Method |
Request URI |
HTTP Version |
|---|---|---|
DELETE |
https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/Partners(id)/$links/BusinessProfiles(id) |
HTTP/1.1 |
Sample Request
DELETE https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/Partners(1)/$links/BusinessProfiles(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
Content-Length: 216
Expect: 100-continue