CoreService

<back to all web services

UnAssignPatchingWindowComputeNodes

Patching - CRUD

Unassign ComputeNodes from a PatchingWindow. Starts a workflow for the unassignment and returns a Job to track progress

Requires Authentication
Requires the role:TenantReader
The following routes are available for this service:
DELETE/api/patching/windows/{Id}/unassignUnassign ComputeNodes from a PatchingWindow
DELETE/patching/windows/{Id}/unassignUnassign ComputeNodes from a PatchingWindow
"use strict";
/** @typedef {'None'|'ConfigItem'|'Tenant'|'Collection'|'Resource'|'ComputeNode'|'VirtualMachine'|'PhysicalMachine'|'Disk'|'Subnet'|'IPAddress'|'Job'|'JobEvent'|'FreezePeriod'|'ResourceGroup'|'Deployment'|'ResourceGroupTemplate'|'DeploymentTemplate'|'ResourceProvider'|'GenericResource'|'Role'|'Permission'|'User'|'PatchingWindow'|'Update'|'ReportDefinition'|'TimeSeries'|'DataPoint'|'Action'|'ActionAssignment'|'UserNote'} */
export var ObjectTypes;
(function (ObjectTypes) {
    ObjectTypes["None"] = "None"
    ObjectTypes["ConfigItem"] = "ConfigItem"
    ObjectTypes["Tenant"] = "Tenant"
    ObjectTypes["Collection"] = "Collection"
    ObjectTypes["Resource"] = "Resource"
    ObjectTypes["ComputeNode"] = "ComputeNode"
    ObjectTypes["VirtualMachine"] = "VirtualMachine"
    ObjectTypes["PhysicalMachine"] = "PhysicalMachine"
    ObjectTypes["Disk"] = "Disk"
    ObjectTypes["Subnet"] = "Subnet"
    ObjectTypes["IPAddress"] = "IPAddress"
    ObjectTypes["Job"] = "Job"
    ObjectTypes["JobEvent"] = "JobEvent"
    ObjectTypes["FreezePeriod"] = "FreezePeriod"
    ObjectTypes["ResourceGroup"] = "ResourceGroup"
    ObjectTypes["Deployment"] = "Deployment"
    ObjectTypes["ResourceGroupTemplate"] = "ResourceGroupTemplate"
    ObjectTypes["DeploymentTemplate"] = "DeploymentTemplate"
    ObjectTypes["ResourceProvider"] = "ResourceProvider"
    ObjectTypes["GenericResource"] = "GenericResource"
    ObjectTypes["Role"] = "Role"
    ObjectTypes["Permission"] = "Permission"
    ObjectTypes["User"] = "User"
    ObjectTypes["PatchingWindow"] = "PatchingWindow"
    ObjectTypes["Update"] = "Update"
    ObjectTypes["ReportDefinition"] = "ReportDefinition"
    ObjectTypes["TimeSeries"] = "TimeSeries"
    ObjectTypes["DataPoint"] = "DataPoint"
    ObjectTypes["Action"] = "Action"
    ObjectTypes["ActionAssignment"] = "ActionAssignment"
    ObjectTypes["UserNote"] = "UserNote"
})(ObjectTypes || (ObjectTypes = {}));
/** @typedef {'Create'|'Update'|'Delete'|'Start'|'Stop'|'Restart'|'Backup'|'Restore'|'Patch'|'Action'} */
export var JobTypes;
(function (JobTypes) {
    JobTypes["Create"] = "Create"
    JobTypes["Update"] = "Update"
    JobTypes["Delete"] = "Delete"
    JobTypes["Start"] = "Start"
    JobTypes["Stop"] = "Stop"
    JobTypes["Restart"] = "Restart"
    JobTypes["Backup"] = "Backup"
    JobTypes["Restore"] = "Restore"
    JobTypes["Patch"] = "Patch"
    JobTypes["Action"] = "Action"
})(JobTypes || (JobTypes = {}));
/** @typedef {'Pending'|'Starting'|'Running'|'Suspended'|'Stopping'|'Completed'|'Failed'} */
export var JobStates;
(function (JobStates) {
    JobStates["Pending"] = "Pending"
    JobStates["Starting"] = "Starting"
    JobStates["Running"] = "Running"
    JobStates["Suspended"] = "Suspended"
    JobStates["Stopping"] = "Stopping"
    JobStates["Completed"] = "Completed"
    JobStates["Failed"] = "Failed"
})(JobStates || (JobStates = {}));
export class JobDto {
    /** @param {{id?:string,tenantId?:string,name?:string,objectType?:ObjectTypes,message?:string,selfLink?:string,configItemId?:string,configItemType?:ObjectTypes,jobType?:JobTypes,state?:JobStates,startTime?:string,endTime?:string,duration?:number,workflowId?:string,schedulerId?:string,progress?:number,config?:{ [index:string]: Object; },created?:string,createUser?:string,createUserId?:string,createUserEmail?:string,modified?:string,modifyUser?:string,modifyUserId?:string,isDeleted?:boolean,deleted?:string,deleteUser?:string,deleteUserId?:string,sendNotifications?:boolean,isRunning?:boolean,needsAttention?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description The id of the job */
    id;
    /**
     * @type {string}
     * @description The id of the tenant */
    tenantId;
    /**
     * @type {string}
     * @description The name of the job */
    name;
    /** @type {ObjectTypes} */
    objectType;
    /**
     * @type {?string}
     * @description An additional message */
    message;
    /**
     * @type {string}
     * @description Api link pointing to this object */
    selfLink;
    /**
     * @type {?string}
     * @description The id of the configitem the job belongs to */
    configItemId;
    /**
     * @type {?ObjectTypes}
     * @description The type of the configitem the job belongs to */
    configItemType;
    /**
     * @type {JobTypes}
     * @description The job type */
    jobType;
    /**
     * @type {JobStates}
     * @description The current state of the job */
    state;
    /**
     * @type {string}
     * @description The timestamp, when the job got started */
    startTime;
    /**
     * @type {?string}
     * @description The timestamp, when the job has finished */
    endTime;
    /**
     * @type {number}
     * @description The duration (in seconds) of the job */
    duration;
    /**
     * @type {?string}
     * @description The id of the related workflow */
    workflowId;
    /**
     * @type {?string}
     * @description The id of the related scheduled task */
    schedulerId;
    /**
     * @type {number}
     * @description The jobs progress in percent (0...100) */
    progress;
    /**
     * @type {{ [index:string]: Object; }}
     * @description Contains various infos about the job */
    config = {};
    /**
     * @type {string}
     * @description The time the job was created */
    created;
    /**
     * @type {string}
     * @description The user the job was created with */
    createUser;
    /**
     * @type {string}
     * @description The user id the job was created with */
    createUserId;
    /**
     * @type {string}
     * @description The user email the job was created with */
    createUserEmail;
    /**
     * @type {string}
     * @description The time the job was last modified */
    modified;
    /**
     * @type {string}
     * @description The user the job was modified with */
    modifyUser;
    /**
     * @type {string}
     * @description The user id the job was modified with */
    modifyUserId;
    /**
     * @type {boolean}
     * @description True if the job is deleted */
    isDeleted;
    /**
     * @type {?string}
     * @description The time the job was deleted */
    deleted;
    /**
     * @type {?string}
     * @description The user the job was deleted with */
    deleteUser;
    /**
     * @type {?string}
     * @description The user id the job was deleted with */
    deleteUserId;
    /**
     * @type {boolean}
     * @description Will be evaluated by event endpoints */
    sendNotifications;
    /**
     * @type {boolean}
     * @description True if it is in any of the 'running' states */
    isRunning;
    /**
     * @type {boolean}
     * @description Jobs with failed JobEvents are marked with NeedsAttention */
    needsAttention;
}
export class UnAssignPatchingWindowComputeNodes {
    /** @param {{id?:string,computeNodeIds?:string[],tenantName?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description The id of the pachting window */
    id;
    /**
     * @type {string[]}
     * @description List of one or more ComputeNodes */
    computeNodeIds = [];
    /** @type {string} */
    tenantName;
}

JavaScript UnAssignPatchingWindowComputeNodes DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

DELETE /api/patching/windows/{Id}/unassign HTTP/1.1 
Host: core.starburst.svc 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"id":"00000000-0000-0000-0000-000000000000","tenantId":"00000000-0000-0000-0000-000000000000","name":"String","objectType":"Job","message":"String","selfLink":"String","configItemId":"00000000-0000-0000-0000-000000000000","configItemType":"None","jobType":"Create","state":"Pending","startTime":"0001-01-01T00:00:00.0000000Z","endTime":"0001-01-01T00:00:00.0000000Z","duration":0,"workflowId":"String","schedulerId":"String","progress":0,"config":{"String":{}},"created":"0001-01-01T00:00:00.0000000Z","createUser":"String","createUserId":"String","createUserEmail":"String","modified":"0001-01-01T00:00:00.0000000Z","modifyUser":"String","modifyUserId":"String","isDeleted":false,"deleted":"0001-01-01T00:00:00.0000000Z","deleteUser":"String","deleteUserId":"String","sendNotifications":false,"isRunning":false,"needsAttention":false}