Create Session

Creates a new service-oriented architecture (SOA) session with the specified configuration information.

Request

You can specify the Create Session request as follows.

For sessions that are managed by the Azure HPC Scheduler, the head node name should have a format of Windows_Azure_service_name.cloudapp.net.

To get the name to use for the HPC cluster, use the Get Clusters operation.

URI Parameters

You can specify the following additional parameters on the request URI.

Request Headers

The following table describes required and optional request headers.

Request Body

The request body is an object represented as text in JSON that specifies configuration information for the session, if you specified a value of application/json; charset=utf-8 for the CONTENT-TYPE request header.

The format for this JSON text is {"property_1_name" : property_1_value, "property_2_name" : property_2_value...}.

The request body has the following XML format, if you specified a value of application/xml; charset=utf-8 for the CONTENT-TYPE request header. You must arrange the elements that are inside the WebSessionStartInfo element in alphabetical order.

<WebSessionStartInfo xmlns="http://hpc.microsoft.com/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
    <property_1_name>property_1_value</property_1_name>
    <property_2_name>property_2_value</property_2_name>
    ...
</WebSessionStartInfo>

For a list of properties that you can specify, see WebSessionStartInfo Fields. The following properties are required to create a session:

• ServiceName

• Username

• Password

• MaxMessageSize

• Runtime

Response

The response includes an HTTP status code, a set of response headers, and a response body.

Status Code

A successful operation returns status code 201 (Created).

If the request includes neither the api-version URI parameter nor the api-version header, the operation returns status code 400 (Bad Request).

For more information about status codes, see HttpStatusCode.

The error response will be contained in a descriptive XML response (Note: Values will vary based on the error):

<HpcWebServiceFault xmlns="https://schemas.microsoft.com/HPCS2008R2/common" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <Code>267386880</Code>
  <Message>Error message text.</Message>
  <Values i:nil="true" xmlns:a="http://schemas.datacontract.org/2004/07/System.Collections.Generic"/>
</HpcWebServiceFault>

Response Headers

The response for this operation includes the following standard HTTP headers:

• Transfer-Encoding

• Content-Type

• Date

• Pack

All standard headers conform to the HTTP/1.1 protocol specification.

Response Body

The response body is an object specified as JSON text if the value of the Accept request header was application/json. This text has the following format: {"BrokerNode":node_name,"Id":session_identifier,"IsDurable":[true|false],"MaxMessageSize":size,"ServiceOperationTimeout":duration,"ServiceVersion":version}

The response body is formatted as XML if the value of the Accept request header was application/xml. This text has the following format:

<WebSessionInfo xmlns="http://hpc.microsoft.com/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
    <BrokerNode>node_name</BrokerNode>
    <Id>session_identifier</Id>
    <IsDurable>[true|false]</IsDurable>
    <MaxMessageSize>size</MaxMessageSize>
    <ServiceOperationTimeout>duration</ServiceOperationTimeout>
    <ServiceVersion xmlns:a="http://schemas.datacontract.org/2004/07/System"/>version</ServiceVersion>
</WebSessionInfo>

The following table describes each of the items in the response string.

Remarks

This operation is supported only for creating sessions that are managed by the Azure HPC Scheduler.

Requirements