DeleteCascadeModel

Details about how a potential delete of one object will cascade to cause deletions of other, related objects.

Properties

NameDescription Additional information
Href

See Hypermedia.

Type: String

RelatedActions

See Hypermedia.

Type: Array of RelationModel

Id

ID of the object being deleted.

Type: String

Name

Name of the object being deleted.

Type: String

ChangeId

Change ID of the object being deleted. See Optimistic Concurrency.

Type: String

Icons

Icons related to the delete operation. Each icon reference will have its RelatedTo property set to the ID of the Offering or Subscription which the icon is related to.

Note that the icons themselves are not deleted from App Orchestration.

Type: Array of ReferenceModel

DeliverySites

Delivery sites which will be deleted.

Type: Array of ReferenceModel

DeliveryControllers

Delivery controllers which will be deleted.

Type: Array of ReferenceModel

Subscriptions

Subscriptions which will be deleted. Note that each subscription will have a related icon which can be obtained by looking in the Icons property for an item that is RelatedTo the subscription's ID.

Type: Array of ReferenceModel

Offerings

Offerings which will be deleted. Note that each offering will have a related icon which can be obtained by looking in the Icons property for an item that is RelatedTo the offering's ID.

Type: Array of ReferenceModel

DeliveryGroups

Delivery groups which will be deleted.

Type: Array of ReferenceModel

SessionMachines

Session machines which will be deleted.

Type: Array of ReferenceModel

MachineDetails

Details of all machines (session machines, delivery controllers, and StoreFront servers) which will be deleted.

Type: Array of ReferenceModel

Tenants

Tenants which will be deleted.

Type: Array of ReferenceModel

LocationUserGroups

Location user groups which will be deleted from App Orchestration. (The user groups will remain in Active Directory.)

Each item in the list will be the SAM name of the location user group being deleted (i.e. "DOMAIN\user").

Type: Array of String

Users

Users and user groups which will be deleted from App Orchestration. (The users and user groups will remain in Active Directory.)

Each item in the list will have these properties:

  • Id: The user or user group SID; i.e. "S-1-5-...".
  • Name: The user or user group SAM name; i.e. "DOMAIN\user".

Type: Array of ReferenceModel

StoreFrontServerGroups

StoreFront server groups which will be deleted.

Type: Array of ReferenceModel

StoreFrontServers

StoreFront servers which will be deleted.

Type: Array of ReferenceModel

ComputeResources

Compute resources which will be deleted.

Type: Array of ReferenceModel

Sample

application/json

Sample:
{
  "Id": "IdOfObjectBeingDeleted",
  "Name": "NameOfObjectBeingDeleted",
  "ChangeId": "10",
  "Icons": [
    {
      "Href": "[api:Icons(00000000-0000-0000-0000-000000000002)]",
      "RelatedTo": "2f08f456-7ec8-4edc-866d-25037776ef4f",
      "Id": "00000000-0000-0000-0000-000000000002"
    }
  ],
  "DeliverySites": [
    {
      "Href": "[api:DeliverySites(0ef3e68d-bb8e-4b69-9c30-ae3fac533996)]",
      "Name": "site1",
      "Id": "0ef3e68d-bb8e-4b69-9c30-ae3fac533996"
    }
  ],
  "DeliveryControllers": [
    {
      "Href": "[api:DeliveryControllers(34c04635-50fc-4506-99fc-da1b459fbefa)]",
      "Name": "controller1",
      "Id": "34c04635-50fc-4506-99fc-da1b459fbefa"
    }
  ],
  "Subscriptions": [
    {
      "Href": "[api:Subscriptions(df13665a-533d-451a-a43a-d1faf29af13b)]",
      "Name": "Tenant 1 subscription to Application",
      "Id": "df13665a-533d-451a-a43a-d1faf29af13b"
    }
  ],
  "Offerings": [
    {
      "Href": "[api:Offerings(2f08f456-7ec8-4edc-866d-25037776ef4f)]",
      "Name": "Application",
      "Id": "2f08f456-7ec8-4edc-866d-25037776ef4f"
    }
  ],
  "DeliveryGroups": [
    {
      "Href": "[api:DeliveryGroups(c004375e-a96d-4368-96ba-c80702d7e80f)]",
      "Name": "dg1",
      "Id": "c004375e-a96d-4368-96ba-c80702d7e80f"
    }
  ],
  "SessionMachines": [
    {
      "Href": "[api:SessionMachines(77b50020-4252-453c-815b-ce9b9412d543)]",
      "Name": "machine1",
      "Id": "77b50020-4252-453c-815b-ce9b9412d543"
    }
  ],
  "MachineDetails": [
    {
      "Href": "[api:MachineDetails(bff69e21-c280-488b-ad9e-74b674ffb7c9)]",
      "Name": "machine1",
      "Id": "bff69e21-c280-488b-ad9e-74b674ffb7c9"
    }
  ],
  "Tenants": [
    {
      "Href": "[api:Tenants(91ade655-feb5-47d3-9585-a5827ad50132)]",
      "Name": "Tenant 1",
      "Id": "91ade655-feb5-47d3-9585-a5827ad50132"
    }
  ],
  "LocationUserGroups": [
    "DOMAIN\\lug1"
  ],
  "Users": [
    {
      "Name": "DOMAIN\\joe",
      "Id": "S-1-5-21-1180699209-877415012-3182924384-1004"
    }
  ],
  "StoreFrontServerGroups": [
    {
      "Href": "[api:StoreFrontServerGroups(590b3e81-5528-40cf-b13d-690ee2477c5a)]",
      "Name": "servergroup1",
      "Id": "590b3e81-5528-40cf-b13d-690ee2477c5a"
    }
  ],
  "StoreFrontServers": [
    {
      "Href": "[api:StoreFrontServers(c1b9add5-480e-42c8-844c-de9b9e62a5a5)]",
      "Name": "server1",
      "Id": "c1b9add5-480e-42c8-844c-de9b9e62a5a5"
    }
  ],
  "ComputeResources": [
    {
      "Href": "[api:ComputeResources(ab32f043-4682-4953-8dea-a0489b839f80)]",
      "Name": "SCVMM",
      "Id": "ab32f043-4682-4953-8dea-a0489b839f80"
    }
  ]
}