Update a resource

To update a resource with this command, you must specify all of the existing data for the resource.

Request

PUT https://{hostname}:{port}
  /cli/resource/update?{parameters}
Table 1. Request parameters
Parameter Type Required Description
resource string true Path or ID of the resource
This command takes a JSON request string or file. Use the following template for the request:
{
  "agent": "Name or ID of an agent to use for automation 
  (Optional)",
  "agentPool": "Name or ID of an agent pool to use for 
  automation (Optional)",
  "description": "Description",
  "impersonationForce": "Specify true to prevent children 
  or steps from specifying their own impersonation settings 
  (Optional)",
  "impersonationGroup": "Group for default impersonation 
  (Optional)",
  "impersonationPassword": "Password for default 
  impersonation (Optional)",
  "impersonationUseSudo": "Specify true to use the sudo 
  command for impersonation (Optional)",
  "impersonationUser": "User name for default 
  impersonation (Optional)",
  "name": "Name for the new resource; leave blank to 
  inherit the name from an agent, pool, or role",
  "parent": "ID or path to parent resource; leave blank to 
  create a root resource (Optional)",
  "role": "Name or ID of a resource role to associate with 
  the agent; if this resource is for a component, specify 
  the component name (Optional)",
  "roleProperties": {"Property name": "Property value 
  (Optional)"}
}

Example JSON request

{
  "name": "New resource name",
  "description": "An updated resource",
}

Related CLI command: updateResource.


Feedback