Share via

Runbook - Delete

  • Reference
Service:
Automation
API Version:
2023-11-01

Delete the runbook by name.

DELETE https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/runbooks/{runbookName}?api-version=2023-11-01

URI Parameters

Name In Required Type Description
automationAccountName
 path True

string

The name of the automation account.
resourceGroupName
 path True

string

Name of an Azure Resource group.

Regex pattern: ^[-\w\._]+$
runbookName
 path True

string

The runbook name.

Regex pattern: ^[a-zA-Z][a-zA-Z-_0-9]*$
subscriptionId
 path True

string

Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
api-version
 query True

string

Client Api Version.

Responses

Name Type Description
200 OK

OK
204 No Content

No Content
Other Status Codes

ErrorResponse

Automation error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account

Examples

Delete a runbook

Sample request

DELETE https://management.azure.com/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/ContoseAutomationAccount/runbooks/Get-AzureVMTutorial?api-version=2023-11-01

Sample response

Status code:
200
Status code:
204

Definitions

ErrorResponse

Error response of an operation failure

Name Type Description
code

string

Error code
message

string

Error message indicating why the operation failed.