SubscriptionModel

A subscription represents an association from a single tenant's users to a single offering.

Properties

Name	Description	Additional information
Href	See Hypermedia.	Type: String
RelatedActions	See Hypermedia.	Type: Array of RelationModel
Id	ID of the subscription.	Type: String
ChangeId	See Optimistic Concurrency.	Type: String
Name	Name.	Type: String
Description	Description.	Type: String
Tags	See Tags and Custom Properties.	Type: Array of String
CustomProperties	See Tags and Custom Properties.	Type: Array of CustomPropertyModel
DeleteState	See Deleting Objects.	Type: ObjectDeleteState
IsolationMode	Isolation mode of the offering which the subscription is associated with.	Type: IsolationModeState
Icon	Icon associated with the subscription.	Type: ReferenceModel
Offering	Offering associated with the subscription.	Type: ReferenceModel
Tenant	Tenant associated with the subscription.	Type: ReferenceModel
Groups	List of user groups associated with the subscription.	Type: Array of UserGroupModel
HealthSummary	Summary of health messages associated with the subscription.	Type: HealthSummaryModel

Sample

application/json

Sample:

{
  "Href": "[api:Subscriptions(df13665a-533d-451a-a43a-d1faf29af13b)]",
  "Id": "df13665a-533d-451a-a43a-d1faf29af13b",
  "ChangeId": "9",
  "Name": "tenant1 subscription to Application",
  "Description": "my subscription",
  "Tags": [
    "tag"
  ],
  "CustomProperties": [
    {
      "Name": "myProperty",
      "Value": "myValue"
    }
  ],
  "DeleteState": "NotDeleted",
  "IsolationMode": "PrivateDeliveryGroup",
  "Icon": {
    "Href": "[api:Icons(00000000-0000-0000-0000-000000000002)]",
    "RelatedTo": "2f08f456-7ec8-4edc-866d-25037776ef4f",
    "Id": "00000000-0000-0000-0000-000000000002"
  },
  "Offering": {
    "Href": "[api:Offerings(2f08f456-7ec8-4edc-866d-25037776ef4f)]",
    "Name": "Application",
    "Id": "2f08f456-7ec8-4edc-866d-25037776ef4f"
  },
  "Tenant": {
    "Href": "[api:Tenants(91ade655-feb5-47d3-9585-a5827ad50132)]",
    "Name": "Tenant 1",
    "Id": "91ade655-feb5-47d3-9585-a5827ad50132"
  },
  "Groups": [
    {
      "Name": "DOMAIN\\group",
      "Sid": "S-1-5-21-1180699209-877415012-3182924384-1004",
      "PrimaryDeliveryGroup": {
        "Href": "[api:DeliveryGroups(c004375e-a96d-4368-96ba-c80702d7e80f)]",
        "Name": "dg1",
        "Id": "c004375e-a96d-4368-96ba-c80702d7e80f"
      }
    }
  ],
  "HealthSummary": {
    "InfoCount": 1,
    "Messages": [
      {
        "Text": "Attempting to reach desired capacity",
        "IsActive": true,
        "Type": "Allocation"
      }
    ]
  }
}