PUT SessionMachineCatalogs({id})

Updates a session machine catalog.

Request Information

Parameters

Name	Description	Additional information
id	ID of the session machine catalog to update.	Type: String
changeId	See Optimistic Concurrency.	Type: String

Request body type

UpdateSessionMachineCatalogModel

Request body formats

application/json, text/json

Sample:

{
  "Name": "catalog 1",
  "Description": "my session machine catalog",
  "SecureIcaRequired": true,
  "LoadBalancingSettings": {
    "MaxUsers": 250,
    "IncludeCpuMemory": true
  },
  "AutoProvisioningSettings": {
    "NamingConvention": "SRV_####",
    "NamingConventionType": "Numerical"
  },
  "NetScalerGatewayAccessMode": "Both",
  "AacFiltersRequired": true,
  "AacFilters": [
    "filter1"
  ],
  "Tags": [
    "tag"
  ],
  "CustomProperties": [
    {
      "Name": "myProperty",
      "Value": "myValue"
    }
  ]
}

Response Information

The updated session machine catalog.

Response type

SessionMachineCatalogModel

Response body formats

application/json, text/json

Sample:

{
  "Href": "[api:SessionMachineCatalogs(628fa898-0c36-4024-8fe4-d7e9a9bfbcfa)]",
  "Id": "628fa898-0c36-4024-8fe4-d7e9a9bfbcfa",
  "ChangeId": "14",
  "Version": 3,
  "Architecture": "x64",
  "CPUs": 2,
  "MemoryMB": 4096,
  "OSName": "Windows Server 2008 R2",
  "OSVersion": "Service Pack 1",
  "Capabilities": "CAP1",
  "HasMetadata": true,
  "HasMetadataAtLatestVersion": true,
  "Name": "catalog 1",
  "ShortName": "catalog1",
  "Description": "my session machine catalog",
  "AutoProvision": true,
  "AllocationType": "Static",
  "DeleteState": "NotDeleted",
  "VersionUpdateState": "VersionUpdateInProgress",
  "TerminateSessionsBy": "2013-12-05T16:12:40.0577923-05:00",
  "AutomaticUpdateProcessType": "AlwaysEnabled",
  "UpdateProcessIsAutomatic": true,
  "NumDesiredMachines": 15,
  "NumUnallocatedMachines": 1,
  "NumAllocatedMachines": 10,
  "NumDrainingMachines": 3,
  "NumDeliveryGroupsAwaitingDeliverySites": 2,
  "NumMachinesAwaitingUpdate": 5,
  "HealthSummary": {
    "ActiveCount": 0,
    "ErrorCount": 0,
    "WarningCount": 0,
    "InfoCount": 1,
    "Messages": [
      {
        "Text": "Attempting to reach desired capacity",
        "IsError": false,
        "IsWarning": false,
        "IsInfo": false,
        "IsActive": true,
        "Type": "Allocation"
      }
    ]
  },
  "MachineType": "SingleUserVda",
  "LoadBalancingSettings": {
    "MaxUsers": 250,
    "IncludeCpuMemory": true
  },
  "AutoProvisioningSettings": {
    "RequirePrivateComputeResource": false,
    "ResetOnReboot": false,
    "PVDiskSizeGB": 10,
    "PVDiskLetter": "V",
    "NamingConvention": "SRV_####",
    "NamingConventionType": "Numerical",
    "VCpus": 2,
    "MemoryMB": 4096,
    "Template": "win8_base_os"
  },
  "SecureIcaRequired": true,
  "NetScalerGatewayAccessMode": "Both",
  "AacFiltersRequired": true,
  "AacFilters": [
    "filter1"
  ],
  "Tags": [
    "tag"
  ],
  "CustomProperties": [
    {
      "Name": "myProperty",
      "Value": "myValue"
    }
  ],
  "IsCatalogUpdatable": true,
  "ProductType": "XenDesktop71"
}