Microsoft Azure

Azure Automation: Openapi

Automation Client

Developer tools#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Automation Client

Endpoints 172

Operations

  • GETOperations_List/providers/Microsoft.Automation/operationsLists all of the available Automation REST API operations.
  • POSTconvertGraphRunbookContent/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/convertGraphRunbookContentPost operation to serialize or deserialize GraphRunbookContent

Software Update Configuration

  • GETSoftwareUpdateConfigurations_List/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/softwareUpdateConfigurations?$filter=stringGet all software update configurations for the account.
  • GETSoftwareUpdateConfigurations_GetByName/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/softwareUpdateConfigurations/:softwareUpdateConfigurationNameGet a single software update configuration by name.
  • PUTSoftwareUpdateConfigurations_Create/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/softwareUpdateConfigurations/:softwareUpdateConfigurationNameCreate a new software update configuration with the name given in the URI.
  • DELETESoftwareUpdateConfigurations_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/softwareUpdateConfigurations/:softwareUpdateConfigurationNamedelete a specific software update configuration.

AutomationAccount

  • GETLists the Automation Accounts within an Azure subscription./subscriptions/:subscriptionId/providers/Microsoft.Automation/automationAccountsRetrieve a list of accounts within a given subscription.
  • GETAutomationAccount_ListByResourceGroup/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccountsRetrieve a list of accounts within a given resource group.
  • GETAutomationAccount_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountNameGet information about an Automation Account.
  • PUTAutomationAccount_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountNameCreate or update automation account.
  • DELETEAutomationAccount_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountNameDelete an automation account.
  • PATCHAutomationAccount_Update/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountNameUpdate an automation account.

NodeCountInformation

  • GETNodeCountInformation_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/nodecounts/:countTypeRetrieve counts for Dsc Nodes.

PrivateLinkResources

  • GETPrivateLinkResources_Automation/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/privateLinkResourcesGets the private link resources that need to be created for Automation account.

AgentRegistrationInformation

  • GETAgentRegistrationInformation_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/agentRegistrationInformationRetrieve the automation agent registration information.
  • POSTAgentRegistrationInformation_RegenerateKey/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/agentRegistrationInformation/regenerateKeyRegenerate a primary or secondary agent registration key

ListDeletedRunbooks

  • POSTAutomationAccount_ListDeletedRunbooks/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/listDeletedRunbooksRetrieve the deleted runbooks for an automation account.

Statistics

  • GETStatistics_ListByAutomationAccount/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/statistics?$filter=stringRetrieve the statistics for the account.

Usages

  • GETUsages_ListByAutomationAccount/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/usagesRetrieve the usage for the account id.

ListKeys

  • POSTKeys_ListByAutomationAccount/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/listKeysRetrieve the automation keys for an account.

Job

  • GETJob_ListByAutomationAccount/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/jobs?$filter=stringRetrieve a list of jobs.
  • GETJob_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/jobs/:jobNameRetrieve the job identified by job name.
  • PUTJob_Create/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/jobs/:jobNameCreate a job of the runbook.
  • GETJob_GetOutput/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/jobs/:jobName/outputRetrieve the job output identified by job name.
  • POSTJob_Resume/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/jobs/:jobName/resumeResume the job identified by jobName.
  • GETJob_GetRunbookContent/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/jobs/:jobName/runbookContentRetrieve the runbook content of the job identified by job name.
  • POSTJob_Stop/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/jobs/:jobName/stopStop the job identified by jobName.
  • POSTJob_Suspend/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/jobs/:jobName/suspendSuspend the job identified by job name.

LinkedWorkspace

  • GETLinkedWorkspace_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/linkedWorkspaceRetrieve the linked workspace for the account id.

ObjectDataTypes

  • GETObjectDataTypes_ListFieldsByModuleAndType/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/modules/:moduleName/objectDataTypes/:typeName/fieldsRetrieve a list of fields of a given type identified by module name.
  • GETObjectDataTypes_ListFieldsByType/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/objectDataTypes/:typeName/fieldsRetrieve a list of fields of a given type across all accessible modules.

Software Update Configuration Machine Run

  • GETSoftwareUpdateConfigurationMachineRuns_List/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/softwareUpdateConfigurationMachineRuns?$filter=string&$skip=string&$top=stringReturn list of software update configuration machine runs
  • GETSoftwareUpdateConfigurationMachineRuns_GetById/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/softwareUpdateConfigurationMachineRuns/:softwareUpdateConfigurationMachineRunIdGet a single software update configuration machine run by Id.

Software Update Configuration Run

  • GETSoftwareUpdateConfigurationRuns_List/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/softwareUpdateConfigurationRuns?$filter=string&$skip=string&$top=stringReturn list of software update configuration runs
  • GETSoftwareUpdateConfigurationRuns_GetById/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/softwareUpdateConfigurationRuns/:softwareUpdateConfigurationRunIdGet a single software update configuration Run by Id.

Webhook

  • GETWebhook_ListByAutomationAccount/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/webhooks?$filter=stringRetrieve a list of webhooks.
  • GETWebhook_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/webhooks/:webhookNameRetrieve the webhook identified by webhook name.
  • PUTWebhook_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/webhooks/:webhookNameCreate the webhook identified by webhook name.
  • DELETEWebhook_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/webhooks/:webhookNameDelete the webhook by name.
  • PATCHWebhook_Update/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/webhooks/:webhookNameUpdate the webhook identified by webhook name.
  • POSTWebhook_GenerateUri/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/webhooks/generateUriGenerates a Uri for use in creating a webhook.

DscNode

  • GETDscNode_ListByAutomationAccount/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/nodes?$filter=string&$skip=0&$top=0&$inlinecount=stringRetrieve a list of dsc nodes.
  • GETDscNode_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/nodes/:nodeIdRetrieve the dsc node identified by node id.
  • DELETEDscNode_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/nodes/:nodeIdDelete the dsc node identified by node id.
  • PATCHDscNode_Update/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/nodes/:nodeIdUpdate the dsc node.

NodeReports

  • GETNodeReports_ListByNode/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/nodes/:nodeId/reports?$filter=stringRetrieve the Dsc node report list by node id.
  • GETNodeReports_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/nodes/:nodeId/reports/:reportIdRetrieve the Dsc node report data by node id and report id.
  • GETNodeReports_GetContent/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/nodes/:nodeId/reports/:reportId/contentRetrieve the Dsc node reports by node id and report id.

Certificate

  • GETCertificate_ListByAutomationAccount/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/certificatesRetrieve a list of certificates.
  • GETCertificate_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/certificates/:certificateNameRetrieve the certificate identified by certificate name.
  • PUTCertificate_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/certificates/:certificateNameCreate a certificate.
  • DELETECertificate_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/certificates/:certificateNameDelete the certificate.
  • PATCHCertificate_Update/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/certificates/:certificateNameUpdate a certificate.

Connection

  • GETConnection_ListByAutomationAccount/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/connectionsRetrieve a list of connections.
  • GETConnection_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/connections/:connectionNameRetrieve the connection identified by connection name.
  • PUTConnection_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/connections/:connectionNameCreate or update a connection.
  • DELETEConnection_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/connections/:connectionNameDelete the connection.
  • PATCHConnection_Update/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/connections/:connectionNameUpdate a connection.

ConnectionType

  • GETConnectionType_ListByAutomationAccount/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/connectionTypesRetrieve a list of connection types.
  • GETConnectionType_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/connectionTypes/:connectionTypeNameRetrieve the connection type identified by connection type name.
  • PUTConnectionType_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/connectionTypes/:connectionTypeNameCreate a connection type.
  • DELETEConnectionType_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/connectionTypes/:connectionTypeNameDelete the connection type.

Credential

  • GETCredential_ListByAutomationAccount/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/credentialsRetrieve a list of credentials.
  • GETCredential_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/credentials/:credentialNameRetrieve the credential identified by credential name.
  • PUTCredential_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/credentials/:credentialNameCreate a credential.
  • DELETECredential_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/credentials/:credentialNameDelete the credential.
  • PATCHCredential_Update/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/credentials/:credentialNameUpdate a credential.

DscConfiguration

  • GETDscConfiguration_ListByAutomationAccount/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/configurations?$filter=string&$skip=0&$top=0&$inlinecount=stringRetrieve a list of configurations.
  • GETDscConfiguration_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/configurations/:configurationNameRetrieve the configuration identified by configuration name.
  • PUTDscConfiguration_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/configurations/:configurationNameCreate the configuration identified by configuration name.
  • DELETEDscConfiguration_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/configurations/:configurationNameDelete the dsc configuration identified by configuration name.
  • PATCHDscConfiguration_Update/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/configurations/:configurationNameCreate the configuration identified by configuration name.
  • GETDscConfiguration_GetContent/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/configurations/:configurationName/contentRetrieve the configuration script identified by configuration name.

DscNodeConfiguration

  • GETDscNodeConfiguration_ListByAutomationAccount/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/nodeConfigurations?$filter=string&$skip=0&$top=0&$inlinecount=stringRetrieve a list of dsc node configurations.
  • GETDscNodeConfiguration_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/nodeConfigurations/:nodeConfigurationNameRetrieve the Dsc node configurations by node configuration.
  • PUTDscNodeConfiguration_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/nodeConfigurations/:nodeConfigurationNameCreate the node configuration identified by node configuration name.
  • DELETEDscNodeConfiguration_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/nodeConfigurations/:nodeConfigurationNameDelete the Dsc node configurations by node configuration.

HybridRunbookWorker

  • GETHybridRunbookWorkers_ListByHybridRunbookWorkerGroup/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/hybridRunbookWorkerGroups/:hybridRunbookWorkerGroupName/hybridRunbookWorkers?$filter=stringRetrieve a list of hybrid runbook workers.
  • GETHybridRunbookWorkers_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/hybridRunbookWorkerGroups/:hybridRunbookWorkerGroupName/hybridRunbookWorkers/:hybridRunbookWorkerIdRetrieve a hybrid runbook worker.
  • PUTHybridRunbookWorkers_Create/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/hybridRunbookWorkerGroups/:hybridRunbookWorkerGroupName/hybridRunbookWorkers/:hybridRunbookWorkerIdCreate a hybrid runbook worker.
  • DELETEHybridRunbookWorkers_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/hybridRunbookWorkerGroups/:hybridRunbookWorkerGroupName/hybridRunbookWorkers/:hybridRunbookWorkerIdDelete a hybrid runbook worker.
  • PATCHHybridRunbookWorkers_Patch/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/hybridRunbookWorkerGroups/:hybridRunbookWorkerGroupName/hybridRunbookWorkers/:hybridRunbookWorkerIdUpdate a hybrid runbook worker.
  • POSTHybridRunbookWorkers_Move/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/hybridRunbookWorkerGroups/:hybridRunbookWorkerGroupName/hybridRunbookWorkers/:hybridRunbookWorkerId/moveMove a hybrid worker to a different group.

HybridRunbookWorkerGroup

  • GETHybridRunbookWorkerGroup_ListByAutomationAccount/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/hybridRunbookWorkerGroups?$filter=stringRetrieve a list of hybrid runbook worker groups.
  • GETHybridRunbookWorkerGroup_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/hybridRunbookWorkerGroups/:hybridRunbookWorkerGroupNameRetrieve a hybrid runbook worker group.
  • PUTHybridRunbookWorkerGroup_Create/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/hybridRunbookWorkerGroups/:hybridRunbookWorkerGroupNameCreate a hybrid runbook worker group.
  • PATCHHybridRunbookWorkerGroup_Update/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/hybridRunbookWorkerGroups/:hybridRunbookWorkerGroupNameUpdate a hybrid runbook worker group.

ListAllHybridRunbookWorkerGroupInAutomationAccount

  • DELETEHybridRunbookWorkerGroup_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/hybridRunbookWorkerGroups/:hybridRunbookWorkerGroupNameDelete a hybrid runbook worker group.

JobStream

  • GETJobStream_ListByJob/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/jobs/:jobName/streams?$filter=stringRetrieve a list of jobs streams identified by job name.
  • GETJobStream_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/jobs/:jobName/streams/:jobStreamIdRetrieve the job stream identified by job stream id.

JobSchedule

  • GETJobSchedule_ListByAutomationAccount/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/jobSchedules?$filter=stringRetrieve a list of job schedules.
  • GETJobSchedule_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/jobSchedules/:jobScheduleIdRetrieve the job schedule identified by job schedule name.
  • PUTJobSchedule_Create/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/jobSchedules/:jobScheduleIdCreate a job schedule.
  • DELETEJobSchedule_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/jobSchedules/:jobScheduleIdDelete the job schedule identified by job schedule name.

Module

  • GETModule_ListByAutomationAccount/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/modulesRetrieve a list of modules.
  • GETModule_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/modules/:moduleNameRetrieve the module identified by module name.
  • PUTModule_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/modules/:moduleNameCreate or Update the module identified by module name.
  • DELETEModule_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/modules/:moduleNameDelete the module by name.
  • PATCHModule_Update/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/modules/:moduleNameUpdate the module identified by module name.

Activity

  • GETActivity_ListByModule/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/modules/:moduleName/activitiesRetrieve a list of activities in the module identified by module name.
  • GETActivity_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/modules/:moduleName/activities/:activityNameRetrieve the activity in the module identified by module name and activity name.

TypeFields

  • GETFields_ListByType/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/modules/:moduleName/types/:typeName/fieldsRetrieve a list of fields of a given type identified by module name.

Python2Package

  • GETPython2Package_ListByAutomationAccount/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/python2PackagesRetrieve a list of python 2 packages.
  • GETPython2Package_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/python2Packages/:packageNameRetrieve the python 2 package identified by package name.
  • PUTPython2Package_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/python2Packages/:packageNameCreate or Update the python 2 package identified by package name.
  • DELETEPython2Package_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/python2Packages/:packageNameDelete the python 2 package by name.
  • PATCHPython2Package_Update/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/python2Packages/:packageNameUpdate the python 2 package identified by package name.

Python3Package

  • GETPython3Package_ListByAutomationAccount/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/python3PackagesRetrieve a list of python 3 packages.
  • GETPython3Package_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/python3Packages/:packageNameRetrieve the python 3 package identified by package name.
  • PUTPython3Package_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/python3Packages/:packageNameCreate or Update the python 3 package identified by package name.
  • DELETEPython3Package_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/python3Packages/:packageNameDelete the python 3 package by name.
  • PATCHPython3Package_Update/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/python3Packages/:packageNameUpdate the python 3 package identified by package name.

Package

  • GETPackage_ListByRuntimeEnvironment/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/runtimeEnvironments/:runtimeEnvironmentName/packagesRetrieve the a list of Packages
  • GETPackage_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/runtimeEnvironments/:runtimeEnvironmentName/packages/:packageNameRetrieve the Package identified by Package name.
  • PUTPackage_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/runtimeEnvironments/:runtimeEnvironmentName/packages/:packageNameCreate or update the package identified by package name.
  • DELETEPackage_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/runtimeEnvironments/:runtimeEnvironmentName/packages/:packageNameDelete the package by name.
  • PATCHPackage_Update/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/runtimeEnvironments/:runtimeEnvironmentName/packages/:packageNameUpdate the Package identified by Package name.

RuntimeEnvironment

  • GETRuntimeEnvironments_ListByAutomationAccount/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/runtimeEnvironmentsRetrieve a list of RuntimeEnvironments.
  • GETRuntimeEnvironments_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/runtimeEnvironments/:runtimeEnvironmentNameGet information about the Runtime Environment
  • PUTRuntimeEnvironments_Create/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/runtimeEnvironments/:runtimeEnvironmentNameCreate or update Runtime Environment
  • DELETERuntimeEnvironments_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/runtimeEnvironments/:runtimeEnvironmentNameDelete the Runtime Environment.
  • PATCHRuntimeEnvironments_Update/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/runtimeEnvironments/:runtimeEnvironmentNameUpdate an Runtime Environment.

PrivateEndpointConnections

  • GETPrivateEndpointConnections_ListByAutomationAccount/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/privateEndpointConnectionsList all private endpoint connections on a Automation account.
  • GETPrivateEndpointConnections_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/privateEndpointConnections/:privateEndpointConnectionNameGets a private endpoint connection.
  • PUTPrivateEndpointConnections_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/privateEndpointConnections/:privateEndpointConnectionNameApprove or reject a private endpoint connection with a given name.
  • DELETEPrivateEndpointConnections_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/privateEndpointConnections/:privateEndpointConnectionNameDeletes a private endpoint connection with a given name.

Runbook

  • GETRunbook_ListByAutomationAccount/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/runbooksRetrieve a list of runbooks.
  • GETRunbook_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/runbooks/:runbookNameRetrieve the runbook identified by runbook name.
  • PUTRunbook_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/runbooks/:runbookNameCreate the runbook identified by runbook name.
  • DELETERunbook_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/runbooks/:runbookNameDelete the runbook by name.
  • PATCHRunbook_Update/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/runbooks/:runbookNameUpdate the runbook identified by runbook name.
  • GETRunbook_GetContent/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/runbooks/:runbookName/contentRetrieve the content of runbook identified by runbook name.
  • POSTRunbook_Publish/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/runbooks/:runbookName/publishPublish runbook draft.

RunbookDraft

  • GETRunbookDraft_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/runbooks/:runbookName/draftRetrieve the runbook draft identified by runbook name.
  • GETRunbookDraft_GetContent/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/runbooks/:runbookName/draft/contentRetrieve the content of runbook draft identified by runbook name.
  • PUTRunbookDraft_ReplaceContent/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/runbooks/:runbookName/draft/contentReplaces the runbook draft content.
  • POSTRunbookDraft_UndoEdit/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/runbooks/:runbookName/draft/undoEditUndo draft edit to last known published state identified by runbook name.

TestJobStream

  • GETTestJobStreams_ListByTestJob/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/runbooks/:runbookName/draft/testJob/streams?$filter=stringRetrieve a list of test job streams identified by runbook name.
  • GETTestJobStreams_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/runbooks/:runbookName/draft/testJob/streams/:jobStreamIdRetrieve a test job stream of the test job identified by runbook name and stream id.

TestJob

  • GETTestJob_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/runbooks/:runbookName/draft/testJobRetrieve the test job for the specified runbook.
  • PUTTestJob_Create/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/runbooks/:runbookName/draft/testJobCreate a test job of the runbook.
  • POSTTestJob_Resume/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/runbooks/:runbookName/draft/testJob/resumeResume the test job.
  • POSTTestJob_Stop/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/runbooks/:runbookName/draft/testJob/stopStop the test job.
  • POSTTestJob_Suspend/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/runbooks/:runbookName/draft/testJob/suspendSuspend the test job.

Schedule

  • GETSchedule_ListByAutomationAccount/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/schedulesRetrieve a list of schedules.
  • GETSchedule_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/schedules/:scheduleNameRetrieve the schedule identified by schedule name.
  • PUTSchedule_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/schedules/:scheduleNameCreate a schedule.
  • DELETESchedule_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/schedules/:scheduleNameDelete the schedule identified by schedule name.
  • PATCHSchedule_Update/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/schedules/:scheduleNameUpdate the schedule identified by schedule name.

SourceControl

  • GETSourceControl_ListByAutomationAccount/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/sourceControls?$filter=stringRetrieve a list of source controls.
  • GETSourceControl_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/sourceControls/:sourceControlNameRetrieve the source control identified by source control name.
  • PUTSourceControl_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/sourceControls/:sourceControlNameCreate a source control.
  • DELETESourceControl_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/sourceControls/:sourceControlNameDelete the source control.
  • PATCHSourceControl_Update/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/sourceControls/:sourceControlNameUpdate a source control.

SourceControlSyncJob

  • GETSourceControlSyncJob_ListByAutomationAccount/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/sourceControls/:sourceControlName/sourceControlSyncJobs?$filter=stringRetrieve a list of source control sync jobs.
  • GETSourceControlSyncJob_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/sourceControls/:sourceControlName/sourceControlSyncJobs/:sourceControlSyncJobIdRetrieve the source control sync job identified by job id.
  • PUTSourceControlSyncJob_Create/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/sourceControls/:sourceControlName/sourceControlSyncJobs/:sourceControlSyncJobIdCreates the sync job for a source control.

SourceControlSyncJobStreams

  • GETSourceControlSyncJobStreams_ListBySyncJob/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/sourceControls/:sourceControlName/sourceControlSyncJobs/:sourceControlSyncJobId/streams?$filter=stringRetrieve a list of sync job streams identified by sync job id.
  • GETSourceControlSyncJobStreams_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/sourceControls/:sourceControlName/sourceControlSyncJobs/:sourceControlSyncJobId/streams/:streamIdRetrieve a sync job stream identified by stream id.

Variable

  • GETVariable_ListByAutomationAccount/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/variablesRetrieve a list of variables.
  • GETVariable_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/variables/:variableNameRetrieve the variable identified by variable name.
  • PUTVariable_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/variables/:variableNameCreate a variable.
  • DELETEVariable_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/variables/:variableNameDelete the variable.
  • PATCHVariable_Update/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/variables/:variableNameUpdate a variable.

Watcher

  • GETWatcher_ListByAutomationAccount/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/watchers?$filter=stringRetrieve a list of watchers.
  • GETWatcher_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/watchers/:watcherNameRetrieve the watcher identified by watcher name.
  • PUTWatcher_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/watchers/:watcherNameCreate the watcher identified by watcher name.
  • DELETEWatcher_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/watchers/:watcherNameDelete the watcher by name.
  • PATCHWatcher_Update/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/watchers/:watcherNameUpdate the watcher identified by watcher name.
  • POSTWatcher_Start/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/watchers/:watcherName/startResume the watcher identified by watcher name.
  • POSTWatcher_Stop/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/watchers/:watcherName/stopResume the watcher identified by watcher name.

DeletedAutomationAccounts

  • GETdeletedAutomationAccounts_ListBySubscription/subscriptions/:subscriptionId/providers/Microsoft.Automation/deletedAutomationAccountsRetrieve deleted automation account.

API details

Base URL
https://management.azure.com
Authentication
OAuth 2.0 (implicit flow) with 1 scope
Operations
172 operations on 102 pathsGET 86PUT 27DELETE 24PATCH 19POST 16
Main resources
Job 8Runbook 7Watcher 7AutomationAccount 6DscConfiguration 6HybridRunbookWorker 6Webhook 6Certificate 5Connection 5Credential 5
Response formats
application/json
Description format
Swagger 2.0, API version 2024-10-23

How to test the Azure Automation: Openapi in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Azure Automation: Openapi collection, without the publisher's secrets.
  3. Add your credentialsThis API uses OAuth 2.0 (implicit flow) with 1 scope. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Operations_List” (GET /providers/Microsoft.Automation/operations), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Azure Automation: Openapi?

Automation Client It is listed under Developer tools and has 172 endpoints.

Who publishes the Azure Automation: Openapi?

It is listed from Microsoft Azure's public API description (an OpenAPI document), not published by Microsoft Azure on Swastik Codes. Anyone who controls azure.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Azure Automation: Openapi?

Requests go to https://management.azure.com. Endpoint paths are added to this base URL.

How do I authenticate with the Azure Automation: Openapi?

With OAuth 2.0 (implicit flow) with 1 scope.

How many endpoints does the Azure Automation: Openapi have?

172 operations on 102 paths (86 GET, 27 PUT, 24 DELETE, 19 PATCH, 16 POST). The largest groups are Job, Runbook, Watcher, AutomationAccount.

Is forking the Azure Automation: Openapi free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.