Get Cloud Service
Updated: January 4, 2016
This section provides information about the request operation to get all BizTalk Services created within a specified cloud service under a subscription.
This section provides information about the request operation to get all BizTalk Services within a specified cloud service.
Method | Request URI | HTTP Version |
|---|---|---|
GET | https://management.core.windows.net/{subscription-id}/cloudservices/{cloud-service-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. |
GET https://management.core.windows.net/<subscription-id>/cloudservices/mycloudservice1/ HTTP/1.1 Content-Type: application/xml; charset=utf-8 x-ms-version: 2013-04-26
The response includes an HTTP status code, a set of response headers, and a response body.
A successful operation returns status code 200 (OK).
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. |
<CloudService xmlns="http://schemas.microsoft.com/windowsazure">
<GeoLocation>North US</GeoLocation>
<Resources>
<Resource>
<ResourceProviderNamespace>biztalkservices</ResourceProviderNamespace>
<Type>biztalk</Type>
<ETag>2EE99699-505D-4CAC-8BAB-1BA2A6571B14</ETag>
<SchemaVersion>1.0</SchemaVersion>
<Name>mybiztalkservice</Name>
<Plan></Plan>
<IntrinsicSettings>
<ServiceSettings>
<CustomDomainUrl>example.com</CustomDomainUrl>
<ServiceVersion>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>
<MonitoringStoreConnectionString>BlobEndpoint=blobendpoint;QueueEndpoint=queueendpoint;TableEndpoint=tableendpoint;
AccountName=accountname;AccountKey=accountkey;DefaultEndpointsProtocol=https
</MonitoringStoreConnectionString>
<ArchivingStoreConnectionString>BlobEndpoint=blobendpoint;QueueEndpoint=queueendpoint;TableEndpoint=tableendpoint;
AccountName=accountname;AccountKey=accountkey;DefaultEndpointsProtocol=https
</ArchivingStoreConnectionString>
<ServiceAcsParameters>
<Namespace>acssample</Namespace>
<ManagementUserName>user</ManagementUserName>
<ManagementPassword>password=</ManagementPassword>
</ServiceAcsParameters>
</ServiceSettings>
</IntrinsicSettings>
<OutputItems>
<OutputItem>
<Name>B2BPortalUrl</Name>
<Value>https://mybiztalkservice.biztalk.windows.net/</Value>
</OutputItem>
<OutputItem>
<Name>CreationDate</Name>
<Value>2013-02-22</Value>
</OutputItem>
<OutputItem>
<Name>ServiceDomainUrl</Name>
<Value>mybiztalkservice.biztalk.windows.net</Value>
</OutputItem>
<OutputItem>
<Name>BridgeEndpointUrl</Name>
<Value>https://mybiztalkservice.biztalk.windows.net/</Value>
</OutputItem>
<OutputItem>
<Name>ServiceCertificateExpiryTime</Name>
<Value>2013-02-22 23:09:90.89</Value>
</OutputItem>
<OutputItem>
<Name>ServiceCertificateSubjectName</Name>
<Value>CN = ABCD</Value>
</OutputItem>
<OutputItem>
<Name>ServiceCertificateThumbprint</Name>
<Value>ABCDE1234ABCDE1234ABCD1234</Value>
</OutputItem>
<OutputItem>
<Name>VirtualIP</Name>
<Value>value</Value>
</OutputItem>
</OutputItems>
<State>Started</State>
<SubState>Active</SubState>
</Resource>
</Resources>
</CloudService>
If there is an error response, the format of the response body is the same as shown at Service Management Status and Error Codes.
The following table describes the key elements in the response body.
Element Name | Description |
|---|---|
GeoLocation | Specifies the location of the data center where the service is hosted. |
ResourceProviderNameSpace | Specifies the namespace for the resource provider for BizTalk Services. |
Type | Specifies the cloud service type. |
ETag | Specifies the Etag associated with the cloud service. |
SchemaVersion | Specifies the schema version of the intrinsic settings used to set up the BizTalk Services service. |
Plan | - |
IntrinsicSettings (Settings used to provision or configure BizTalk Services) | |
CustomDomainUrl | This represents a custom endpoint for message processing. |
ServiceVersion | Represents the major and minor version of the BizTalk Service. |
Edition | Represents the edition of BizTalk Services such as Basic, Standard, Developer, or Premium. See BizTalk Services: Developer, Basic, Standard and Premium Editions Chart for details about each edition. |
UnitCount | Represents the number of units that BizTalk Services is deployed with. |
ServiceCertificate/Data | Represents the BizTalk Services certificate (.pfx format) in a serialized form. |
ServiceCertificate/Password | Represents the BizTalk Services certificate private key password. |
TrackingStoreConnectionString | Represents a Microsoft Azure SQL Database connection string which BizTalk Services uses to write tracking records to. |
ArchivingStoreConnectionString | Represents the Azure storage connection string which BizTalk Services uses to write archiving records to (if the edition supports). |
MonitoringStoreConnectionString | Represents the Azure storage connection string which BizTalk Services uses to write monitoring records to. |
ServiceAcsParameters/Namespace | Represents the ACS namespace with which BizTalk Services is configured as the relying party. |
ServiceAcsParameters/ManagementUserName | Represents the management user of the specified ACS namespace. |
ServiceAcsParameters/ManagementPassword | Represents the password of the management user of the specified ACS namespace. |
OutputItems (returns various values for the BizTalk Services) | |
B2BPortalUrl | Returns the URL through which BizTalk Services Portal can be accessed |
CreationDate | Returns the date on which BizTalk Services was created |
ServiceDomainUrl | Returns the URL that represents the DNS name of the BizTalk Service |
BridgeEndpointUrl | Returns the URL through which EAI functionality can be accessed. |
ServiceCertificateExpiryTime | Returns the expiry date/time of the BizTalk Services certificate. |
ServiceCertificateSubjectName | Returns the subject name of the BizTalk Services certificate. |
ServiceCertificateThumbprint | Returns the thumbprint of the BizTalk Services certificate. |
VirtualIP | Returns the IP address of the BizTalk Services. |
UsageMeters (returns the usage of bridges deployed within the service subscription) | |
UsageMeter/Name | Represents a unique name to identify the usage data for a unit for which the usage is provided. For example, BridgeUsage. |
UsageMeter/Used | Represents the number of units used. |
UsageMeter/Included | Represents the maximum number of units available. |
UsageMeter/Unit | Represents the entity (such as bridge), for which the usage is provided. |
State | Represents the state of the service. |
SubState | Represents the sub-state of the service. |
All intrinsic settings are returned as NULL for the Free edition, other than ServiceVersion, Edition, and UnitCount. Similarly all elements under OutputItems are returned as Not Available, except for CreationDate.