Azure Automation provides tools to manage your cloud and on-premises infrastructure seamlessly.
Status: Production |
Tier: Premium |
Version: 1.0.0 |
Name |
Summary |
Subscriptions_List ([internal][Optional]string x-ms-api-version) |
List subscriptions |
ResourceGroups_List ([internal][Optional]string x-ms-api-version, string subscriptionId) |
List resource groups |
List Automation accounts |
|
Get job output |
|
Get status of job |
|
Wait for job |
|
List runbooks |
|
Get runbook |
|
Create job |
Name |
Summary |
Name |
Summary |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Summary: List subscriptions
Description: Gets a list of all the subscriptions to which the principal has access.
Syntax:
AzureAutomation.Subscriptions_List ([internal][Optional]string x-ms-api-version)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
x-ms-api-version |
string (API Version) |
|
False |
Returns:
Description: Subscription list operation response.
Summary: List resource groups
Description: Lists all the resource groups within the subscription. Paginates at 1,000 records.
Syntax:
AzureAutomation.ResourceGroups_List ([internal][Optional]string x-ms-api-version, string subscriptionId)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
x-ms-api-version |
string (API Version) |
|
False |
|
subscriptionId |
string (Subscription) |
The unique identifier for the Microsoft Azure subscription. The subscription ID forms part of the ID for every Azure resource. |
True |
Returns:
Description: List of resource groups.
Summary: List Automation accounts
Description: Lists Azure Automation accounts in a resource group.
Syntax:
AzureAutomation.AutomationAccounts_List (string subscriptionId, string resourceGroupName, [internal][Optional]string x-ms-api-version)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
subscriptionId |
string (Subscription) |
The unique identifier for the Microsoft Azure subscription. The subscription ID forms part of the ID for every Azure resource. |
True |
|
resourceGroupName |
string (Resource Group) |
The name of the Azure Resource Group. |
True |
|
x-ms-api-version |
string (API Version) |
|
False |
Returns:
Type:AutomationAccountResponse
Summary: Get job output
Description: Get outputs of an Azure Automation job.
Syntax:
AzureAutomation.GetJobOutput (string subscriptionId, string resourceGroupName, string automationAccount, [internal][Optional]string x-ms-api-version, string jobId)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
subscriptionId |
string (Subscription) |
The unique identifier for the Microsoft Azure subscription. The subscription ID forms part of the ID for every Azure resource. |
True |
|
resourceGroupName |
string (Resource Group) |
The name of the Azure Resource Group. |
True |
|
automationAccount |
string (Automation Account) |
The name of the Azure Automation Account. |
True |
|
x-ms-api-version |
string (API Version) |
|
False |
|
jobId |
string (Job ID) |
GUID for the ID of the run. |
True |
Returns:
Type:string(binary)
Summary: Content
Description: Runbook content from the job
Summary: Get status of job
Description: Get Status of a Job
Syntax:
AzureAutomation.GetStatusOfJob (string subscriptionId, string resourceGroupName, string automationAccount, [internal][Optional]string x-ms-api-version, string jobId)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
subscriptionId |
string (Subscription) |
The unique identifier for the Microsoft Azure subscription. The subscription ID forms part of the ID for every Azure resource. |
True |
|
resourceGroupName |
string (Resource Group) |
The name of the Azure Resource Group. |
True |
|
automationAccount |
string (Automation Account) |
The name of the Azure Automation Account. |
True |
|
x-ms-api-version |
string (API Version) |
|
False |
|
jobId |
string (Job ID) |
GUID for the ID of the run. |
True |
Returns:
Type:CreateJobResponse
Summary: Wait for job
Description: Wait for a running job to complete.
Syntax:
AzureAutomation.WaitJob (string subscriptionId, string resourceGroupName, string automationAccount, [internal][Optional]string x-ms-api-version, string jobId)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
subscriptionId |
string (Subscription) |
The unique identifier for the Microsoft Azure subscription. The subscription ID forms part of the ID for every Azure resource. |
True |
|
resourceGroupName |
string (Resource Group) |
The name of the Azure Resource Group. |
True |
|
automationAccount |
string (Automation Account) |
The name of the Azure Automation Account. |
True |
|
x-ms-api-version |
string (API Version) |
|
False |
|
jobId |
string (Job ID) |
GUID for the ID of the run. |
True |
Returns:
Type:CreateJobResponse
Summary: List runbooks
Description: Lists Azure Automation runbooks in an automation account.
Syntax:
AzureAutomation.Runbooks_List (string subscriptionId, string resourceGroupName, [internal][Optional]string x-ms-api-version, string automationAccount)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
subscriptionId |
string (Subscription) |
The unique identifier for the Microsoft Azure subscription. The subscription ID forms part of the ID for every Azure resource. |
True |
|
resourceGroupName |
string (Resource Group) |
The name of the Azure Resource Group. |
True |
|
x-ms-api-version |
string (API Version) |
|
False |
|
automationAccount |
string (Automation Account) |
The name of the Azure Automation Account. |
True |
Returns:
Type:RunbookListResults
Summary: Get runbook
Description: Get information on an Azure Automation runbook.
Syntax:
AzureAutomation.GetRunbook (string subscriptionId, string resourceGroupName, [internal][Optional]string x-ms-api-version, string automationAccount, string runbookName)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
subscriptionId |
string (Subscription) |
The unique identifier for the Microsoft Azure subscription. The subscription ID forms part of the ID for every Azure resource. |
True |
|
resourceGroupName |
string (Resource Group) |
The name of the Azure Resource Group. |
True |
|
x-ms-api-version |
string (API Version) |
|
False |
|
automationAccount |
string (Automation Account) |
The name of the Azure Automation Account. |
True |
|
runbookName |
string (Runbook Name) |
The name of the Azure Automation runbook. |
True |
Returns:
Type:RunbookListResults
Summary: Create job
Description: Create Job to run on hybrid worker
Syntax:
AzureAutomation.CreateJob (string subscriptionId, string resourceGroupName, string automationAccount, [internal][Optional]string x-ms-api-version, [Optional]string runbookName, CreateJobParameterBody body, [Optional]boolean wait)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
subscriptionId |
string (Subscription) |
The unique identifier for the Microsoft Azure subscription. The subscription ID forms part of the ID for every Azure resource. |
True |
|
resourceGroupName |
string (Resource Group) |
The name of the Azure Resource Group. |
True |
|
automationAccount |
string (Automation Account) |
The name of the Azure Automation Account. |
True |
|
x-ms-api-version |
string (API Version) |
|
False |
|
runbookName |
string (Runbook Name) |
Name of the runbook to run. |
False |
|
body |
|
|
True |
|
wait |
boolean (Wait for Job) |
Wait for the job to finish before completing the action. |
False |
Returns:
Type:CreateJobResponse
Summary:
Description:
Properties:
Name |
Type |
Summary |
value |
array of (ValueItem)
|
value |
Summary:
Description:
Properties:
Name |
Type |
Summary |
name |
string Automation account Name |
Name of the Azure Automation account. |
Summary:
Description:
Properties:
Name |
Type |
Summary |
properties |
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
parameters |
Runbook Parameters |
|
runOn |
string Hybrid Automation Worker Group |
Worker group to run on. |
Summary: Runbook Parameters
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
id |
string Resource ID |
Resource ID of the Job |
properties |
|
properties |
Summary:
Description: properties
Properties:
Name |
Type |
Summary |
jobId |
string Job ID |
GUID for the Job ID. |
provisioningState |
string Provisioning State |
Provisioning state for the job. |
creationTime |
string(date-time) Creation Time |
Creation time for the job. |
endTime |
string(date-time) End Time |
Time the job completed. |
startTime |
string(date-time) Start Time |
Time the job started. |
status |
string Status |
Status of the job. |
statusDetails |
string Status Details |
Details on the status of the job. |
Summary:
Description: Resource group information.
Properties:
Name |
Type |
Summary |
id |
string Id |
The ID of the resource group (e.g. /subscriptions/XXX/resourceGroups/YYY). |
name |
string Name |
The Name of the resource group. |
managedBy |
string Managed By |
Id of the resource that manages this resource group. |
Summary:
Description: List of resource groups.
Properties:
Name |
Type |
Summary |
value |
array of (ResourceGroup)
|
The list of resource groups. |
nextLink |
string Next Link |
The URL to get the next set of results. |
Summary:
Description:
Properties:
Name |
Type |
Summary |
value |
array of (ValueItem)
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
name |
string Runbook Name |
Name of the Automation runbook. |
Summary:
Description: Subscription information.
Properties:
Name |
Type |
Summary |
id |
string Id |
The fully qualified Id. For example, /subscriptions/00000000-0000-0000-0000-000000000000. |
subscriptionId |
string Subscription Id |
The subscription Id. |
tenantId |
string Tenant Id |
The tenant Id. |
displayName |
string Display Name |
The subscription display name. |
state |
string State |
The subscription state. Values: [Enabled, Warned, PastDue, Disabled, Deleted] |
authorizationSource |
string Authorization Source |
The authorization source of the request. Valid values are one or more combinations of Legacy, RoleBased, Bypassed, Direct and Management. For example, 'Legacy, RoleBased'. |
Summary:
Description: Subscription list operation response.
Properties:
Name |
Type |
Summary |
value |
array of (Subscription)
|
The subscriptions. |
nextLink |
string Next Link |
The URL to get the next set of results. |