Create a Plan
Applies To: Windows Azure Pack
Creates a new plan.
Request
Specify the Create Plan request as follows: Replace <ServiceMgmt> with your Service Management API endpoint address:
Method |
Request URI |
HTTP version |
|---|---|---|
POST |
https://<ServiceMgmt>:30004/plans |
HTTP/1.1 |
URI Parameters
None.
Request Headers
The following table describes required and optional request headers.
Request header |
Description |
|---|---|
Authorization: Bearer |
Required. The authorization bearer token. |
x-ms-principal-id |
Required. The principal identifier. |
x-ms-client-request-id |
Optional. The client request identifier. |
x-ms-client-session-id |
Optional. The client session identifier. |
x-ms-principal-liveid |
Optional. The principal Live identifier. |
Request Body
The following table describes the elements of the request body.
Element name |
Description |
|---|---|
Plan |
For more information, see Plan (Administrator object). |
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). 409 (CONFLICT) is returned if the requested plan name already exists.
For information about status codes, see Status and Error Codes (Windows Azure Pack Service Management).
Response Headers
The response for this operation includes standard HTTP headers. All standard headers conform to the HTTP/1.1 protocol specification.
Response Body
The following table describes the key elements of the response body:
Element name |
Description |
|---|---|
Plan |
The new plan. For more information, See Update a Plan. |
Example
The following example shows a Create Plan request.
POST https://<Computer>:30004/plans HTTP/1.1
Authorization: Bearer <Token>
x-ms-client-request-id: e995f8b2-9a85-446e-a680-c424347c2a07-2013-06-28 17:58:52Z
x-ms-client-session-id: d19ca528-d7bf-4a62-9d4d-03adbb4f6c74
x-ms-principal-id: <COMPUTER>\Administrator
Accept-Language: en-US
x-ms-principal-liveid: <COMPUTER>\Administrator
Content-Type: application/json; charset=utf-8
Host: <Computer>:30004
Content-Length: 1132
Expect: 100-continue
{
"Id": "GoldPhihoq8oa",
"DisplayName": "Gold_Plan-1",
"State": 0,
"ConfigState": 0,
"QuotaSyncState": 2,
"LastErrorMessage": null,
"Advertisements": [
{
"LanguageCode": "en-us",
"DisplayName": "Gold_Plan-1",
"Description": null
}
],
"ServiceQuotas": [
{
"ServiceName": "webspaces",
"ServiceInstanceId": "0EA2F3E5-90D1-4CF0-B53D-5A111FF43122",
"ServiceDisplayName": "Web Site Cloud",
"ServiceInstanceDisplayName": null,
"ConfigState": 0,
"QuotaSyncState": 2,
"Settings": [
]
},
{
"ServiceName": "sqlservers",
"ServiceInstanceId": "7BAD5022-79CA-4B53-8177-1ACAEEAFA099",
"ServiceDisplayName": "SQL Servers",
"ServiceInstanceDisplayName": null,
"ConfigState": 0,
"QuotaSyncState": 2,
"Settings": [
]
},
{
"ServiceName": "servicebus",
"ServiceInstanceId": "51680204-CF5D-43DD-B264-4D5CB6076E02",
"ServiceDisplayName": "Service Bus",
"ServiceInstanceDisplayName": null,
"ConfigState": 0,
"QuotaSyncState": 2,
"Settings": [
]
}
],
"SubscriptionCount": 0,
"MaxSubscriptionsPerAccount": 1,
"AddOnReferences": [
{
"AddOnId": "SqlAOwlcnkya2zmcn1xhz",
"AddOnInstanceId": null,
"AcquisitionTime": null
},
{
"AddOnId": "SqlAOtqjctbuhtvmjmkyg",
"AddOnInstanceId": null,
"AcquisitionTime": null
}
],
"AddOns": [
],
"InvitationCode": null,
"Price": null
}
The following code example shows a Create Plan response.
{
"Id": "GoldPhihoq8oa",
"DisplayName": "Gold_Plan-1",
"State": 0,
"ConfigState": 1,
"QuotaSyncState": 0,
"LastErrorMessage": null,
"Advertisements": [
{
"LanguageCode": "en-us",
"DisplayName": "Gold_Plan-1",
"Description": null
}
],
"ServiceQuotas": [
{
"ServiceName": "webspaces",
"ServiceInstanceId": "0EA2F3E5-90D1-4CF0-B53D-5A111FF43122",
"ServiceDisplayName": "Web Site Cloud",
"ServiceInstanceDisplayName": "autotest1",
"ConfigState": 1,
"QuotaSyncState": 0,
"Settings": [
{
"Key": "BytesReceived_Shared_WebSpace_Limited",
"Value": "{\"ComputeMode\":0,\"CustomActionName\":null,\"EnforcementScope\":0,\"ExceededAction\":0,\"Limit\":-1,\"Period\":1440,\"QuotaName\":\"BytesReceived\",\"ResourceName\":\"BytesReceived\",\"SiteMode\":\"Limited\",\"Unit\":1,\"WebPlan\":null}"
}
]
},
{
"ServiceName": "sqlservers",
"ServiceInstanceId": "7BAD5022-79CA-4B53-8177-1ACAEEAFA099",
"ServiceDisplayName": "SQL Servers",
"ServiceInstanceDisplayName": "SQL Servers",
"ConfigState": 1,
"QuotaSyncState": 0,
"Settings": [
{
"Key": "Editions",
"Value": "[{\"displayName\":\"Default\",\"groupName\":\"Default\",\"resourceCount\":\"10\",\"resourceSize\":\"1024\",\"resourceSizeLimit\":\"1024\",\"offerEditionId\":\"062813055853\",\"groupType\":null}]"
}
]
},
{
"ServiceName": "servicebus",
"ServiceInstanceId": "51680204-CF5D-43DD-B264-4D5CB6076E02",
"ServiceDisplayName": "Service Bus Cloud",
"ServiceInstanceDisplayName": "MyServiceBusFarm",
"ConfigState": 1,
"QuotaSyncState": 0,
"Settings": [
]
}
],
"SubscriptionCount": 0,
"MaxSubscriptionsPerAccount": 1,
"AddOnReferences": [
{
"AddOnId": "SqlAOwlcnkya2zmcn1xhz",
"AddOnInstanceId": null,
"AcquisitionTime": null
},
{
"AddOnId": "SqlAOtqjctbuhtvmjmkyg",
"AddOnInstanceId": null,
"AcquisitionTime": null
}
],
"AddOns": [
{
"Id": "SqlAOwlcnkya2zmcn1xhz",
"DisplayName": "SqlAOwlcnkya2",
"State": 0,
"ConfigState": 1,
"QuotaSyncState": 0,
"LastErrorMessage": null,
"Advertisements": [
{
"LanguageCode": "en-us",
"DisplayName": "SqlAOwlcnkya2",
"Description": null
}
],
"ServiceQuotas": [
{
"ServiceName": "sqlservers",
"ServiceInstanceId": "7BAD5022-79CA-4B53-8177-1ACAEEAFA099",
"ServiceDisplayName": "SQL Servers",
"ServiceInstanceDisplayName": "SQL Servers",
"ConfigState": 1,
"QuotaSyncState": 0,
"Settings": [
{
"Key": "Editions",
"Value": "[{\"groupName\":\"Default\",\"resourceCount\":\"2\",\"resourceSize\":\"10\",\"offerEditionId\":\"1367541399669\"}]"
}
]
}
],
"SubscriptionCount": 1,
"AssociatedPlans": [
],
"MaxOccurrencesPerPlan": 1,
"Price": null
},
{
"Id": "SqlAOtqjctbuhtvmjmkyg",
"DisplayName": "SqlAOtqjctbuh",
"State": 0,
"ConfigState": 1,
"QuotaSyncState": 0,
"LastErrorMessage": null,
"Advertisements": [
{
"LanguageCode": "en-us",
"DisplayName": "SqlAOtqjctbuh",
"Description": null
}
],
"ServiceQuotas": [
{
"ServiceName": "sqlservers",
"ServiceInstanceId": "7BAD5022-79CA-4B53-8177-1ACAEEAFA099",
"ServiceDisplayName": "SQL Servers",
"ServiceInstanceDisplayName": "SQL Servers",
"ConfigState": 1,
"QuotaSyncState": 0,
"Settings": [
{
"Key": "Editions",
"Value": "[{\"groupName\":\"Default\",\"resourceCount\":\"2\",\"resourceSize\":\"10\",\"offerEditionId\":\"1367541399669\"}]"
}
]
}
],
"SubscriptionCount": 1,
"AssociatedPlans": [
],
"MaxOccurrencesPerPlan": 1,
"Price": null
}
],
"InvitationCode": null,
"Price": null
}
Remarks
Within Windows Azure Pack, plans must have a unique Plan (Administrator object) object DisplayName value and Plan object Id value. To get a list of the current plans call Retrieve the Available Plans. Use this information to ensure unique DisplayName and Id values when creating a new plan.
Allowable characters for Id are ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789-._~:/?#[]@!$&'()*+,;=