Create or Update a BizTalk Service
Updated: January 4, 2016
This topic provides information on how to create/update new BizTalk Services in a specified subscription and cloud service.
This section provides information about the request operation to create or update a BizTalk Services deployment.
Method | Request URI | HTTP Version |
|---|---|---|
PUT | https://management.core.windows.net/{subscription-id}/cloudservices/{cloud-service-name}/resources/biztalkservices/biztalk/{resource-name} where,
| HTTP/1.1 |
Header | Description |
|---|---|
Content-Type | Required. Set this to application/xml. |
x-ms-version | Required. Specifies the version of the operation to use for this request. The value of this header must be set to 2012-08-01 or later. |
x-ms-client-request-id | Optional. Specifies an ID to identify the request. This can be useful in troubleshooting client issues end-to-end and is passed to the BizTalk Services resource provider. |
If-Match | Optional for the create operation but required for an update operation. If an Etag value is passed for this header for an update operation, Azure matches the value with the Etag for the resource. |
PUT https://management.core.windows.net/<subscription-id>/cloudservices/mycloudservice1/resources/biztalkservices/biztalk/mybiztalkservice HTTP/1.1
Content-Type: application/xml; charset=utf-8
x-ms-version: 2013-04-26
If-Match: <Etag>
<Resource xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<SchemaVersion>1.0</SchemaVersion>
<Plan></Plan>
<IntrinsicSettings>
<ServiceSettings>
<CustomDomainUrl>example.com</CustomDomainUrl>
<ServiceVersion>1.1.0</ServiceVersion>
<Edition>premium</Edition>
<UnitCount>1</UnitCount>
<ServiceCertificate>
<Data>{certificate-in-serialized-form}</Data>
<Password>{password}</Password>
</ServiceCertificate>
<TrackingStoreConnectionString>Data Source=tcp:databaseservername.database.windows.net;Initial Catalog=databasename;Integrated Security=False;User ID=user1@databaseservername;Password=mypassword;Asynchronous Processing=True;Encrypt=True;TrustServerCertificate=False</TrackingStoreConnectionString>
<ArchivingStoreConnectionString>BlobEndpoint=blobendpoint;QueueEndpoint=queueendpoint;TableEndpoint=tableendpoint;AccountName=accountname;AccountKey=accountkey;DefaultEndpointsProtocol=https</ArchivingStoreConnectionString>
<MonitoringStoreConnectionString>BlobEndpoint=blobendpoint;QueueEndpoint=queueendpoint;TableEndpoint=tableendpoint;AccountName=accountname;AccountKey=accountkey;DefaultEndpointsProtocol=https</MonitoringStoreConnectionString>
<ServiceAcsParameters>
<Namespace>acssample</Namespace>
<ManagementUserName>user</ManagementUserName>
<ManagementPassword>password</ManagementPassword>
</ServiceAcsParameters>
</ServiceSettings>
</IntrinsicSettings>
</Resource>
The following table describes the key elements in the request body.
Important |
|---|
For a BizTalk Services Free edition, only the elements ServiceVersion, Edition, and UnitCount are required. |
Element Name | Description |
|---|---|
SchemaVersion | Schema version of the intrinsic settings. Set this to 1.0. |
Plan | Required. Leave this element empty. |
IntrinsicSettings (Settings used to provision or configure BizTalk Services) | |
CustomDomainUrl | Optional. This represents a custom endpoint for message processing and should not be more than 256 characters in length. If no value is provided, this is set to <BizTalkServiceName>.biztalk.windows.net. |
ServiceVersion | Required. Represents the major and minor version of the BizTalk Service. Set this to 1.1.0. |
Edition | Required. Represents the edition of BizTalk Services. Set this to Basic, Standard, Developer, Premium, or Free. These values are case-sensitive. |
UnitCount | Required. Represents the number of units that BizTalk Services is deployed with. See BizTalk Services: Developer, Basic, Standard and Premium Editions Chart for details about each edition. |
ServiceCertificate/Data | Optional. Represents the BizTalk Services certificate (.pfx format) in a serialized form. |
ServiceCertificate/Password | Optional. Represents the BizTalk Services certificate private key password. |
TrackingStoreConnectionString | Required. Represents a Microsoft Azure SQL Database connection string which BizTalk Services uses to write tracking records to. The specified database should already exist and must be in the same region as the BizTalk Services resource. |
MonitoringStoreConnectionString | Required. Represents the Azure storage connection string which BizTalk Services uses to write monitoring records to. The specified storage account should already exist and must be in the same region as the BizTalk Services resource. |
ArchivingStoreConnectionString | Optional. Represents the Azure storage connection string which BizTalk Services uses to write archiving records to (if the edition supports). The specified storage account should already exist and must be in the same region as the BizTalk Services resource. |
ServiceAcsParameters/Namespace | Optional. Represents the ACS namespace with which BizTalk Services is configured as the relying party. The specified ACS namespace must be in the same region as the BizTalk Services. |
ServiceAcsParameters/ManagementUserName | Optional. Represents the management user of the specified ACS namespace. |
ServiceAcsParameters/ManagementPassword | Optional. Represents the password of the management user of the specified ACS namespace. |
The response includes an HTTP status code, a set of response headers, and a response body.
A successful operation returns status code 202 (ACCEPTED).
For information about status codes, see Service Management Status and Error Codes.
Header | Description |
|---|---|
Content-Type | Specifies the content type. |
x-ms-request-id | A value that uniquely identifies a request made against the application service. |
ETag | On successful mutations to the resource, Service Manager returns a unique increasing ETag to identify the revision on the resource |
None.
If there is an error response, the format of the response body is the same as shown at Service Management Status and Error Codes.
This section lists the error codes that you might encounter while performing create or update operations for BizTalk Services.
Error Code | Error String | Description |
|---|---|---|
CustomDomainInvalid | Custom Domain URL validation failed. Custom Domain URL is expected to be less than or equal to 256 characters in length. | The custom domain URL validation failed because the value specified did not meet the criteria. |
ServiceVersionUnsupported | Specified service version is not supported. | - |
ServiceVersionFormatUnsupported | Specified service version is not in the right format | Specified version is not in the right format. The right format should be similar to 1.1.1, 1.2.1, 1.1.2, or 2.1.1 |
EditionUnsupported | Specified edition is not supported. | A valid edition name is not specified. For more information about the editions, see BizTalk Services: Developer, Basic, Standard and Premium Editions Chart. |
UnitCountNotAllowed | The specified unit count is not allowed for the BizTalk Services edition. | The specified unit count is not a positive integer or does not fall within the minimum/maximum range for the specified edition. For more information, see BizTalk Services: Developer, Basic, Standard and Premium Editions Chart. |
InvalidServiceCertificateDetails | The service certificate specified does not meet the requirements. Either the certificate data does not represent a well formed .pfx or the password specified is not correct for the specified certificate. | - |
InvalidTrackingStore | The tracking store specified is invalid. Please make sure that the tracking store exists and that the connection string provided is correct. Also, please ensure that Asynchronous Processing flag is set to true. | - |
InvalidArchivingStore | The archiving store specified is invalid. Please make sure that the store exists and that the connection string provided is correct. | - |
InvalidMonitoringStore | The monitoring/archiving store specified is invalid. Please make sure that the store exists and that the connection string provided is correct. | - |
InvalidServiceAcsNamespace | Could not connect to the ACS account with the specified credentials. Please make sure that the specified credentials and the namespace are valid. | - |
UpdateSettingsNotAllowed | Update failed. One or more of the service settings specified are not allowed in Update. Please refer to the product documentation on the allowed values and updatable settings. | You could encounter this error when you try to update any of the following:
|
