Usages - List By Automation Account

Reference

Service:: Automation

API Version:: 2023-11-01

Retrieve the usage for the account id.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/usages?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\._]+$`
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	UsageListResult	OK
Other Status Codes	ErrorResponse	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

Get usages of an automation account

Sample Request

HTTP

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount11/usages?api-version=2023-11-01

Sample Response

Status code:: 200

{
  "value": [
    {
      "name": {
        "value": "AccountUsage",
        "localizedValue": "AccountUsage"
      },
      "unit": "Minute",
      "currentValue": 0,
      "limit": 500,
      "throttleStatus": "NotThrottled"
    },
    {
      "name": {
        "value": "SubscriptionUsage",
        "localizedValue": "SubscriptionUsage"
      },
      "unit": "Minute",
      "currentValue": 429,
      "limit": 500,
      "throttleStatus": "NotThrottled"
    },
    {
      "name": {
        "value": "DscSubscriptionUsage",
        "localizedValue": "DscSubscriptionUsage"
      },
      "unit": "Count",
      "currentValue": 8,
      "limit": 5,
      "throttleStatus": "ThrottledAtSubscriptionLevel"
    }
  ]
}

Definitions

Name	Description
ErrorResponse	Error response of an operation failure
Usage	Definition of Usage.
UsageCounterName	Definition of usage counter name.
UsageListResult	The response model for the get usage operation.

ErrorResponse

Error response of an operation failure

Name	Type	Description
code	string	Error code
message	string	Error message indicating why the operation failed.

Usage

Definition of Usage.

Name	Type	Description
currentValue	number	Gets or sets the current usage value.
id	string	Gets or sets the id of the resource.
limit	integer	Gets or sets max limit. -1 for unlimited
name	UsageCounterName	Gets or sets the usage counter name.
throttleStatus	string	Gets or sets the throttle status.
unit	string	Gets or sets the usage unit name.

UsageCounterName

Definition of usage counter name.

Name	Type	Description
localizedValue	string	Gets or sets the localized usage counter name.
value	string	Gets or sets the usage counter name.

UsageListResult

The response model for the get usage operation.

Name	Type	Description
value	Usage[]	Gets or sets usage.

Share via