Delete (DELETE) Runbooks
Delete using the HTTP DELETE operation.
Code Examples
Request
Method | Request URI | HTTP Version |
---|---|---|
DELETE |
HTTPS://<HOST>:<PORT>/00000000-0000-0000-0000-000000000000/Runbooks(guid'<GUID>') |
HTTP/1.1 |
Request URI Parameters
URI Parameter | Description |
---|---|
GUID |
Required. The unique identifier value (RunbookID) for a Runbook entity. |
Request URI Example
Example URI |
---|
DELETE https://sma-server:9090/00000000-0000-0000-0000-000000000000/Runbooks(guid'83357133-17ba-4165-bdbc-16d35dd4e2cd') HTTP/1.1 |
Request Headers
For more information about the common request headers used by this operation, see Standard Service Management Automation POST/GET/PUT/DELETE Headers.
Request Body
The DELETE operation has no request body.
Response
Response Codes
Response Code | Description |
---|---|
HTTP/1.1 204 No Content |
Request fulfilled. |
Response Headers
For more information about the common response headers used by this operation, see Standard Service Management Automation POST/GET/PUT/DELETE Headers.
Response Body
The DELETE operation has no response body.
Code Examples
The following example deletes a specific Runbook, identified by the RunbookID (a unique guid value).
namespace CodeSample.Microsoft.SystemCenter.SMA
{
public class SMASamples
{
public static void Main()
{
// Replace this with the name of your SMA web service endpoint.
string serviceEndPoint = "https://sma-server:9090/00000000-0000-0000-0000-000000000000";
// Setup the connection to SMA
OrchestratorApi SMAService = new OrchestratorApi(new Uri(serviceEndPoint));
// Set credentials to the default or to a specific user.
((DataServiceContext)SMAService).Credentials = CredentialCache.DefaultCredentials;
//((DataServiceContext)SMAService).Credentials = new NetworkCredential("user", "pwd", "domain");
try
{
// Identify a specific runbook instance to search for.
var runbookID = new Guid("83357133-17ba-4165-bdbc-16d35dd4e2cd");
// Query for the specific runbook instance identified by RunbookID.
var runbook = SMAService.Runbooks.Where(r => r.RunbookID == runbookID).FirstOrDefault();
// Delete the runbook object.
// Note: This action is queued up until the SaveChanges action is called.
SMAService.DeleteObject(runbook);
// Save all pending actions (client -> server communication initiated).
SMAService.SaveChanges();
}
catch (Exception ex)
{
throw new ApplicationException("An error occurred during execution.", ex);
}
}
}
}