Automation Account - List By Resource Group

Retrieve a list of accounts within a given resource group.

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

URI Parameters

Name In Required Type Description
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

AutomationAccountListResult

OK

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

List automation accounts by resource group

Sample Request

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

Sample Response

{
  "value": [
    {
      "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myaccount",
      "location": "eastus2",
      "name": "myaccount",
      "type": "Microsoft.Automation/AutomationAccounts",
      "properties": {
        "creationTime": "2016-09-24T00:47:04.227+00:00",
        "lastModifiedTime": "2017-02-09T21:35:16.4+00:00",
        "lastModifiedBy": "myEmailId@microsoft.com",
        "state": "Ok"
      }
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAccount123",
      "location": "eastus2",
      "name": "myAccount123",
      "type": "Microsoft.Automation/AutomationAccounts",
      "properties": {
        "creationTime": "2016-09-29T00:32:32.52+00:00",
        "lastModifiedTime": "2017-02-09T21:35:16.4+00:00",
        "lastModifiedBy": "myEmailId@microsoft.com",
        "state": "Ok"
      }
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAccountasfads",
      "location": "East US 2",
      "name": "myAccountasfads",
      "type": "Microsoft.Automation/AutomationAccounts",
      "properties": {
        "creationTime": "2017-03-24T23:21:03.27+00:00",
        "lastModifiedTime": "2017-03-24T23:21:03.27+00:00",
        "lastModifiedBy": "myEmailId@microsoft.com",
        "state": "Ok"
      }
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount1",
      "location": "East US 2",
      "name": "myAutomationAccount1",
      "type": "Microsoft.Automation/AutomationAccounts",
      "properties": {
        "creationTime": "2017-03-24T23:22:33.26+00:00",
        "lastModifiedTime": "2017-03-24T23:22:33.26+00:00",
        "lastModifiedBy": "myEmailId@microsoft.com",
        "state": "Ok"
      }
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount11",
      "location": "East US 2",
      "name": "myAutomationAccount11",
      "type": "Microsoft.Automation/AutomationAccounts",
      "properties": {
        "creationTime": "2017-03-26T02:10:24.523+00:00",
        "lastModifiedTime": "2017-03-26T02:11:12.027+00:00",
        "lastModifiedBy": "myEmailId@microsoft.com",
        "state": "Ok"
      }
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount2",
      "location": "East US 2",
      "name": "myAutomationAccount2",
      "type": "Microsoft.Automation/AutomationAccounts",
      "properties": {
        "creationTime": "2017-03-24T23:24:20.31+00:00",
        "lastModifiedTime": "2017-03-24T23:24:20.31+00:00",
        "lastModifiedBy": "myEmailId@microsoft.com",
        "state": "Ok"
      }
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount3",
      "location": "East US 2",
      "name": "myAutomationAccount3",
      "type": "Microsoft.Automation/AutomationAccounts",
      "properties": {
        "creationTime": "2017-03-24T23:24:43.967+00:00",
        "lastModifiedTime": "2017-03-24T23:24:43.967+00:00",
        "lastModifiedBy": "myEmailId@microsoft.com",
        "state": "Ok"
      }
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount4",
      "location": "East US 2",
      "name": "myAutomationAccount4",
      "type": "Microsoft.Automation/AutomationAccounts",
      "properties": {
        "creationTime": "2017-03-25T02:04:56.9+00:00",
        "lastModifiedTime": "2017-03-25T02:04:56.9+00:00",
        "lastModifiedBy": "myEmailId@microsoft.com",
        "state": "Ok"
      }
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount6",
      "location": "East US 2",
      "name": "myAutomationAccount6",
      "type": "Microsoft.Automation/AutomationAccounts",
      "properties": {
        "creationTime": "2017-03-25T02:10:44.567+00:00",
        "lastModifiedTime": "2017-03-25T02:10:44.567+00:00",
        "lastModifiedBy": "myEmailId@microsoft.com",
        "state": "Ok"
      }
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount7",
      "location": "East US 2",
      "name": "myAutomationAccount7",
      "type": "Microsoft.Automation/AutomationAccounts",
      "properties": {
        "creationTime": "2017-03-25T02:19:17.943+00:00",
        "lastModifiedTime": "2017-03-25T02:19:17.943+00:00",
        "lastModifiedBy": "myEmailId@microsoft.com",
        "state": "Ok"
      }
    }
  ]
}

Definitions

Name Description
AutomationAccount

Definition of the automation account type.

AutomationAccountListResult

The response model for the list account operation.

AutomationAccountState

Gets status of account.

createdByType

The type of identity that created the resource.

EncryptionKeySourceType

Encryption Key Source

EncryptionProperties

The encryption settings for automation account

ErrorResponse

Error response of an operation failure

Identity

Identity for the resource.

KeyVaultProperties

Settings concerning key vault encryption for a configuration store.

PrivateEndpointConnection

A private endpoint connection

PrivateEndpointProperty

Private endpoint which the connection belongs to.

PrivateLinkServiceConnectionStateProperty

Connection State of the Private Endpoint Connection.

ResourceIdentityType

The identity type.

Sku

The account SKU.

SkuNameEnum

Gets or sets the SKU name of the account.

systemData

Metadata pertaining to creation and last modification of the resource.

UserAssignedIdentitiesProperties

AutomationAccount

Definition of the automation account type.

Name Type Description
etag

string

Gets or sets the etag of the resource.

id

string

Fully qualified resource Id for the resource

identity

Identity

Identity for the resource.

location

string

The Azure Region where the resource lives

name

string

The name of the resource

properties.automationHybridServiceUrl

string

URL of automation hybrid service which is used for hybrid worker on-boarding.

properties.creationTime

string

Gets the creation time.

properties.description

string

Gets or sets the description.

properties.disableLocalAuth

boolean

Indicates whether requests using non-AAD authentication are blocked

properties.encryption

EncryptionProperties

Encryption properties for the automation account

properties.lastModifiedBy

string

Gets or sets the last modified by.

properties.lastModifiedTime

string

Gets the last modified time.

properties.privateEndpointConnections

PrivateEndpointConnection[]

List of Automation operations supported by the Automation resource provider.

properties.publicNetworkAccess

boolean

Indicates whether traffic on the non-ARM endpoint (Webhook/Agent) is allowed from the public internet

properties.sku

Sku

Gets or sets the SKU of account.

properties.state

AutomationAccountState

Gets status of account.

systemData

systemData

Resource system metadata.

tags

object

Resource tags.

type

string

The type of the resource.

AutomationAccountListResult

The response model for the list account operation.

Name Type Description
nextLink

string

Gets or sets the next link.

value

AutomationAccount[]

Gets or sets list of accounts.

AutomationAccountState

Gets status of account.

Name Type Description
Ok

string

Suspended

string

Unavailable

string

createdByType

The type of identity that created the resource.

Name Type Description
Application

string

Key

string

ManagedIdentity

string

User

string

EncryptionKeySourceType

Encryption Key Source

Name Type Description
Microsoft.Automation

string

Microsoft.Keyvault

string

EncryptionProperties

The encryption settings for automation account

Name Type Description
identity

Identity

User identity used for CMK.

keySource

EncryptionKeySourceType

Encryption Key Source

keyVaultProperties

KeyVaultProperties

Key vault properties.

ErrorResponse

Error response of an operation failure

Name Type Description
code

string

Error code

message

string

Error message indicating why the operation failed.

Identity

Identity for the resource.

Name Type Description
principalId

string

The principal ID of resource identity.

tenantId

string

The tenant ID of resource.

type

ResourceIdentityType

The identity type.

userAssignedIdentities

<string,  UserAssignedIdentitiesProperties>

The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

KeyVaultProperties

Settings concerning key vault encryption for a configuration store.

Name Type Description
keyName

string

The name of key used to encrypt data.

keyVersion

string

The key version of the key used to encrypt data.

keyvaultUri

string

The URI of the key vault key used to encrypt data.

PrivateEndpointConnection

A private endpoint connection

Name Type Description
id

string

Fully qualified resource Id for the resource

name

string

The name of the resource

properties.groupIds

string[]

Gets the groupIds.

properties.privateEndpoint

PrivateEndpointProperty

Private endpoint which the connection belongs to.

properties.privateLinkServiceConnectionState

PrivateLinkServiceConnectionStateProperty

Connection State of the Private Endpoint Connection.

type

string

The type of the resource.

PrivateEndpointProperty

Private endpoint which the connection belongs to.

Name Type Description
id

string

Resource id of the private endpoint.

PrivateLinkServiceConnectionStateProperty

Connection State of the Private Endpoint Connection.

Name Type Description
actionsRequired

string

Any action that is required beyond basic workflow (approve/ reject/ disconnect)

description

string

The private link service connection description.

status

string

The private link service connection status.

ResourceIdentityType

The identity type.

Name Type Description
None

string

SystemAssigned

string

SystemAssigned, UserAssigned

string

UserAssigned

string

Sku

The account SKU.

Name Type Description
capacity

integer

Gets or sets the SKU capacity.

family

string

Gets or sets the SKU family.

name

SkuNameEnum

Gets or sets the SKU name of the account.

SkuNameEnum

Gets or sets the SKU name of the account.

Name Type Description
Basic

string

Free

string

systemData

Metadata pertaining to creation and last modification of the resource.

Name Type Description
createdAt

string

The timestamp of resource creation (UTC).

createdBy

string

The identity that created the resource.

createdByType

createdByType

The type of identity that created the resource.

lastModifiedAt

string

The timestamp of resource last modification (UTC)

lastModifiedBy

string

The identity that last modified the resource.

lastModifiedByType

createdByType

The type of identity that last modified the resource.

UserAssignedIdentitiesProperties

Name Type Description
clientId

string

The client id of user assigned identity.

principalId

string

The principal id of user assigned identity.