Azure Automation Runtime Environment API

The RuntimeEnvironment API from Azure Automation — 2 operation(s) for runtimeenvironment.

Documentation GitHub OpenAPI

Operations 5

GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/runtimeEnvironments Runtime environments list by automation account #

PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/runtimeEnvironments/{runtimeEnvironmentName} Runtime environments create #

PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/runtimeEnvironments/{runtimeEnvironmentName} Runtime environments update #

DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/runtimeEnvironments/{runtimeEnvironmentName} Runtime environments delete #

Documentation

📖

Documentation

https://learn.microsoft.com/en-us/rest/api/automation/

Specifications

⚙

OpenAPI

https://artifacts.apis.io/microsoft-azure-automation/openapi/microsoft-azure-automation-runtimeenvironment-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/microsoft-azure-automation:microsoft-azure-automation-runtimeenvironment-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Microsoft Azure Automation Runtime Environment API
  version: '2024-10-23'
  x-typespec-generated:
  - emitter: '@azure-tools/typespec-autorest'
  description: 'Operations tagged RuntimeEnvironment across 2 of this provider''s published API definitions: microsoft-azure-automation-openapi.json, microsoft-azure-automation-management-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://management.azure.com
security:
- azure_auth:
  - user_impersonation
tags:
- name: RuntimeEnvironment
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/runtimeEnvironments
  : get:
      operationId: RuntimeEnvironments_ListByAutomationAccount
      tags:
      - RuntimeEnvironment
      description: Retrieve a list of RuntimeEnvironments.
      externalDocs:
        url: http://aka.ms/azureautomationsdk/runbookoperations
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - name: automationAccountName
        in: path
        description: The name of the automation account.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RuntimeEnvironmentListResult'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-examples:
        List runbooks by automation account:
          $ref: ./examples/runtimeEnvironment/listRuntimeEnvironmentsByAutomationAccount.json
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Runtime environments list by automation account
      x-summary-source: derived
    servers:
    - url: https://management.azure.com
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/runtimeEnvironments/{runtimeEnvironmentName}
  : get:
      operationId: RuntimeEnvironments_Get
      tags:
      - RuntimeEnvironment
      description: Get information about the Runtime Environment
      externalDocs:
        url: http://aka.ms/azureautomationsdk/runtimeEnvironmentOperations
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - name: automationAccountName
        in: path
        description: The name of the automation account.
        required: true
        schema:
          type: string
      - name: runtimeEnvironmentName
        in: path
        description: The name of the Runtime Environment.
        required: true
        schema:
          type: string
          pattern: ^[a-zA-Z][a-zA-Z-_0-9]*$
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RuntimeEnvironment'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Get automation account:
          $ref: ./examples/runtimeEnvironment/getRuntimeEnvironment.json
      summary: Runtime environments get
      x-summary-source: derived
    put:
      operationId: RuntimeEnvironments_Create
      tags:
      - RuntimeEnvironment
      description: Create or update Runtime Environment
      externalDocs:
        url: http://aka.ms/azureautomationsdk/runtimeEnvironmentOperations
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - name: automationAccountName
        in: path
        description: The name of the automation account.
        required: true
        schema:
          type: string
      - name: runtimeEnvironmentName
        in: path
        description: The name of the Runtime Environment.
        required: true
        schema:
          type: string
          pattern: ^[a-zA-Z][a-zA-Z-_0-9]*$
      responses:
        '200':
          description: Resource 'RuntimeEnvironment' update operation succeeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RuntimeEnvironment'
        '201':
          description: Resource 'RuntimeEnvironment' create operation succeeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RuntimeEnvironment'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Create or update automation account:
          $ref: ./examples/runtimeEnvironment/createRuntimeEnvironment.json
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RuntimeEnvironment'
        description: Parameters supplied to the create  the runtime environment.
        required: true
      summary: Runtime environments create
      x-summary-source: derived
    patch:
      operationId: RuntimeEnvironments_Update
      tags:
      - RuntimeEnvironment
      description: Update an Runtime Environment.
      externalDocs:
        url: http://aka.ms/azureautomationsdk/automationaccountoperations
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - name: automationAccountName
        in: path
        description: The name of the automation account.
        required: true
        schema:
          type: string
      - name: runtimeEnvironmentName
        in: path
        description: The name of the Runtime Environment.
        required: true
        schema:
          type: string
          pattern: ^[a-zA-Z][a-zA-Z-_0-9]*$
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RuntimeEnvironment'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Update an automation account:
          $ref: ./examples/runtimeEnvironment/updateRuntimeEnvironment.json
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RuntimeEnvironmentUpdateParameters'
        description: Parameters supplied to the Runtime Environment
        required: true
      summary: Runtime environments update
      x-summary-source: derived
    delete:
      operationId: RuntimeEnvironments_Delete
      tags:
      - RuntimeEnvironment
      description: Delete the Runtime Environment.
      externalDocs:
        url: http://aka.ms/azureautomationsdk/runtimeEnvironmentOperations
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - name: automationAccountName
        in: path
        description: The name of the automation account.
        required: true
        schema:
          type: string
      - name: runtimeEnvironmentName
        in: path
        description: The name of the Runtime Environment.
        required: true
        schema:
          type: string
          pattern: ^[a-zA-Z][a-zA-Z-_0-9]*$
      responses:
        '200':
          description: Resource deleted successfully.
        '204':
          description: Resource does not exist.
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Delete Runtime Environment:
          $ref: ./examples/runtimeEnvironment/deleteRuntimeEnvironment.json
      summary: Runtime environments delete
      x-summary-source: derived
    servers:
    - url: https://management.azure.com
components:
  schemas:
    RuntimeEnvironmentUpdateParameters:
      type: object
      description: The parameters supplied to the update automation account operation.
      properties:
        properties:
          $ref: '#/components/schemas/RuntimeEnvironmentUpdateProperties'
          description: Gets or sets Runtime update properties.
          x-ms-client-flatten: true
        systemData:
          $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/systemData
          description: Metadata pertaining to creation and last modification of the resource.
    RuntimeEnvironmentUpdateProperties:
      type: object
      description: Gets or sets Runtime update properties.
      properties:
        defaultPackages:
          type: object
          description: List of Default packages for Environment
          additionalProperties:
            type: string
    RuntimeEnvironmentProperties:
      type: object
      description: Runtime Environment properties.
      properties:
        runtime:
          $ref: '#/components/schemas/RuntimeProperties'
          description: Runtime properties.
          x-ms-client-flatten: true
        defaultPackages:
          type: object
          description: List of Default packages for Environment
          additionalProperties:
            type: string
        description:
          type: string
          description: Gets or sets the description.
    RuntimeProperties:
      type: object
      description: Runtime properties.
      properties:
        language:
          type: string
          description: Language of Runtime Environment
        version:
          type: string
          description: Version of Language
    RuntimeEnvironment:
      type: object
      description: Definition of the Runtime Environment type.
      properties:
        properties:
          $ref: '#/components/schemas/RuntimeEnvironmentProperties'
          description: Gets or sets the Runtime Environment properties.
          x-ms-client-flatten: true
      allOf:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource
    RuntimeEnvironmentListResult:
      type: object
      description: The response of a RuntimeEnvironment list operation.
      properties:
        value:
          type: array
          description: The RuntimeEnvironment items on this page
          items:
            $ref: '#/components/schemas/RuntimeEnvironment'
        nextLink:
          type: string
          format: uri
          description: The link to the next page of items
      required:
      - value
  securitySchemes:
    azure_auth:
      type: oauth2
      flows:
        implicit:
          scopes:
            user_impersonation: impersonate your user account
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
      description: Azure Active Directory OAuth2 Flow.
x-refined-from:
- microsoft-azure-automation-openapi.json
- microsoft-azure-automation-management-openapi.yml