Share via

Runtime Environments - List By Automation Account

Service:
Automation
API Version:
2024-10-23

Retrieve a list of RuntimeEnvironments.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/runtimeEnvironments?api-version=2024-10-23

URI Parameters

Name In Required Type Description
automationAccountName
 path True

string

The name of the automation account.
resourceGroupName
 path True

string

minLength: 1
maxLength: 90
pattern: ^[-\w\._]+$

Name of an Azure Resource group.
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

RuntimeEnvironmentListResult

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 runbooks by automation account

Sample request

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/ContoseAutomationAccount/runtimeEnvironments?api-version=2024-10-23

Sample response

Status code:
200 
{
  "value": [
    {
      "name": "myRuntimeEnvironmentName",
      "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount9/runtimeEnvironments/myRuntimeEnvironmentName",
      "type": "Microsoft.Automation/automationAccounts/runtimeEnvironments",
      "location": "East US 2",
      "tags": {},
      "systemData": {
        "createdAt": "2023-07-05T07:32:41.4389914+00:00",
        "lastModifiedAt": "2023-07-05T07:33:07.5597465+00:00"
      },
      "properties": {
        "runtime": {
          "language": "PowerShell",
          "version": "5.1"
        },
        "defaultPackages": {
          "Az": "8.3.0"
        },
        "description": "Description of the Runtime Environment"
      }
    },
    {
      "name": "myRuntimeEnvironmentName2",
      "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount9/runtimeEnvironments/myRuntimeEnvironmentName2",
      "type": "Microsoft.Automation/automationAccounts/runtimeEnvironments",
      "location": "East US 2",
      "tags": {},
      "systemData": {
        "createdAt": "2023-07-05T07:32:41.4389914+00:00",
        "lastModifiedAt": "2023-07-05T07:33:07.5597465+00:00"
      },
      "properties": {
        "runtime": {
          "language": "PowerShell",
          "version": "7.1"
        },
        "defaultPackages": {
          "Az": "8.3.0"
        },
        "description": "Description of the Runtime Environment"
      }
    },
    {
      "name": "myRuntimeEnvironmentName3",
      "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount9/runtimeEnvironments/myRuntimeEnvironmentName3",
      "type": "Microsoft.Automation/automationAccounts/runtimeEnvironments",
      "location": "East US 2",
      "tags": {},
      "systemData": {
        "createdAt": "2023-07-05T07:32:41.4389914+00:00",
        "lastModifiedAt": "2023-07-05T07:33:07.5597465+00:00"
      },
      "properties": {
        "runtime": {
          "language": "PowerShell",
          "version": "7.2"
        },
        "defaultPackages": {
          "Az": "8.3.0"
        },
        "description": "Description of the Runtime Environment"
      }
    }
  ]
}

Definitions

Name Description
createdByType

The type of identity that created the resource.
ErrorResponse

Error response of an operation failure
RuntimeEnvironment

Definition of the Runtime Environment type.
RuntimeEnvironmentListResult

List of all the Runtime Environments of automation account.
systemData

Metadata pertaining to creation and last modification of the resource.

createdByType

Enumeration

The type of identity that created the resource.

Value Description
User
Application
ManagedIdentity
Key

ErrorResponse

Object

Error response of an operation failure

Name Type Description
code

string

Error code
message

string

Error message indicating why the operation failed.

RuntimeEnvironment

Object

Definition of the Runtime Environment type.

Name Type Description
id

string (arm-id)

Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location

string

The geo-location where the resource lives
name

string

The name of the resource
properties.defaultPackages

object

List of Default packages for Environment
properties.description

string

Gets or sets the description.
properties.runtime.language

string

Language of Runtime Environment
properties.runtime.version

string

Version of Language
systemData

systemData

Resource system metadata.
tags

object

Resource tags.
type

string

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

RuntimeEnvironmentListResult

Object

List of all the Runtime Environments of automation account.

Name Type Description
nextLink

string

Gets or sets the next link.
value

RuntimeEnvironment[]

list of RuntimeEnvironment.

systemData

Object

Metadata pertaining to creation and last modification of the resource.

Name Type Description
createdAt

string (date-time)

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 (date-time)

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.