Share via


Create Subscription

 

Creates a new subscription. Once created, the resource manifest for this subscription is immutable. Repeating the create call, after a subscription with same name (under the same topic and service namespace) has been created successfully, results in a 409 Conflict error message.

Request

Method

Request URI

HTTP Version

PUT

https://{serviceNamespace}.servicebus.windows.net/{topic path}/Subscriptions/{subscription name}

HTTP/1.1

Request Headers

The following table describes required and optional request headers.

Request Header

Description

Authorization

Specifies a WRAPv0.9.7.2 token containing a SimpleWebToken acquired from ACS. Set to WRAP access_token=”{swt}”.

Content-Type

Set to application/atom+xml;type=entry;charset=utf-8.

Request Body

Subscription description: see Subscription Description.

Response

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

Response Codes

Note

If you create a subscription with a name containing special or encoded characters (for example, "test?Name=value&", which gets encoded to "test%3FName%3Dvalue%26", a (401) Unauthorized exception is generated.

Code

Description

201

Subscription created.

400

Invalid request body.

401

Authorization failure.

403

Quota exceeded; subscription not created.

409

The specified subscription already exists (or the specified path is already occupied).

500

Internal error.

For information about status codes, see Status and Error Codes.

Response Headers

None.

Response Body

The subscription description is returned. Some description properties might contain default values if they were missing from the PUT request.

See Also

Subscriptions
Delete Subscription
Get Subscription
List Subscriptions
Subscription Description
Example: Creating a Subscription