Azure Automation Automation Account API

openapi: 3.2.0
info:
  title: Microsoft Azure Automation Automation Account API
  version: '2024-10-23'
  x-typespec-generated:
  - emitter: '@azure-tools/typespec-autorest'
  description: 'Operations tagged AutomationAccount 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: AutomationAccount
paths:
  /subscriptions/{subscriptionId}/providers/Microsoft.Automation/automationAccounts:
    get:
      operationId: AutomationAccount_List
      tags:
      - AutomationAccount
      summary: Lists the Automation Accounts within an Azure subscription
      description: Retrieve a list of accounts within a given subscription.
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AutomationAccountListResult'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-examples:
        List automation accounts by resource group:
          $ref: ./examples/listAutomationAccountsBySubscription.json
      x-ms-pageable:
        nextLinkName: nextLink
    servers:
    - url: https://management.azure.com
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts:
    get:
      operationId: AutomationAccount_ListByResourceGroup
      tags:
      - AutomationAccount
      description: Retrieve a list of accounts within a given resource group.
      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
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AutomationAccountListResult'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-examples:
        List automation accounts by resource group:
          $ref: ./examples/listAutomationAccountsByResourceGroup.json
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Automation account list by resource group
      x-summary-source: derived
    servers:
    - url: https://management.azure.com
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}
  : get:
      operationId: AutomationAccount_Get
      tags:
      - AutomationAccount
      description: Get information about an Automation Account.
      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
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AutomationAccount'
        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/getAutomationAccount.json
      summary: Automation account get
      x-summary-source: derived
    put:
      operationId: AutomationAccount_CreateOrUpdate
      tags:
      - AutomationAccount
      description: Create or update automation account.
      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
      responses:
        '200':
          description: Resource 'AutomationAccount' update operation succeeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AutomationAccount'
        '201':
          description: Resource 'AutomationAccount' create operation succeeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AutomationAccount'
        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/createOrUpdateAutomationAccount.json
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AutomationAccountCreateOrUpdateParameters'
        description: Parameters supplied to the create or update automation account.
        required: true
      summary: Automation account create or update
      x-summary-source: derived
    patch:
      operationId: AutomationAccount_Update
      tags:
      - AutomationAccount
      description: Update an automation account.
      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
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AutomationAccount'
        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/updateAutomationAccount.json
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AutomationAccountUpdateParameters'
        description: Parameters supplied to the update automation account.
        required: true
      summary: Automation account update
      x-summary-source: derived
    delete:
      operationId: AutomationAccount_Delete
      tags:
      - AutomationAccount
      description: Delete an automation account.
      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
      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 automation account:
          $ref: ./examples/deleteAutomationAccount.json
      summary: Automation account delete
      x-summary-source: derived
    servers:
    - url: https://management.azure.com
components:
  schemas:
    UserAssignedIdentitiesProperties:
      type: object
      properties:
        principalId:
          type: string
          description: The principal id of user assigned identity.
          readOnly: true
        clientId:
          type: string
          description: The client id of user assigned identity.
          readOnly: true
    AutomationAccountCreateOrUpdateProperties:
      type: object
      description: The parameters supplied to the create or update account properties.
      properties:
        sku:
          $ref: '#/components/schemas/Sku'
          description: Gets or sets account SKU.
        encryption:
          $ref: '#/components/schemas/EncryptionProperties'
          description: Set the encryption properties for the automation account
        publicNetworkAccess:
          type: boolean
          description: Indicates whether traffic on the non-ARM endpoint (Webhook/Agent) is allowed from the public internet
        disableLocalAuth:
          type: boolean
          description: Indicates whether requests using non-AAD authentication are blocked
    PrivateLinkServiceConnectionStateProperty:
      type: object
      description: Connection State of the Private Endpoint Connection.
      properties:
        status:
          type: string
          description: The private link service connection status.
        description:
          type: string
          description: The private link service connection description.
        actionsRequired:
          type: string
          description: Any action that is required beyond basic workflow (approve/ reject/ disconnect)
          readOnly: true
    PrivateEndpointConnectionProperties:
      type: object
      description: Properties of a private endpoint connection.
      properties:
        privateEndpoint:
          $ref: '#/components/schemas/PrivateEndpointProperty'
          description: Private endpoint which the connection belongs to.
        groupIds:
          type: array
          description: Gets the groupIds.
          items:
            type: string
        privateLinkServiceConnectionState:
          $ref: '#/components/schemas/PrivateLinkServiceConnectionStateProperty'
          description: Connection State of the Private Endpoint Connection.
    EncryptionKeySourceType:
      type: string
      description: Encryption Key Source
      enum:
      - Microsoft.Automation
      - Microsoft.Keyvault
      x-ms-enum:
        name: EncryptionKeySourceType
        modelAsString: false
        values:
        - name: Microsoft.Automation
          value: Microsoft.Automation
          description: Microsoft.Automation
        - name: Microsoft.Keyvault
          value: Microsoft.Keyvault
          description: Microsoft.Keyvault
    AutomationAccountState:
      type: string
      description: Gets status of account.
      enum:
      - Ok
      - Unavailable
      - Suspended
      x-ms-enum:
        name: AutomationAccountState
        modelAsString: true
        values:
        - name: Ok
          value: Ok
          description: Ok
        - name: Unavailable
          value: Unavailable
          description: Unavailable
        - name: Suspended
          value: Suspended
          description: Suspended
    SkuNameEnum:
      type: string
      description: Gets or sets the SKU name of the account.
      enum:
      - Free
      - Basic
      x-ms-enum:
        name: SkuNameEnum
        modelAsString: true
        values:
        - name: Free
          value: Free
          description: Free
        - name: Basic
          value: Basic
          description: Basic
    ResourceIdentityType:
      type: string
      description: The identity type.
      enum:
      - SystemAssigned
      - UserAssigned
      - SystemAssigned, UserAssigned
      - None
      x-ms-enum:
        name: ResourceIdentityType
        modelAsString: false
        values:
        - name: SystemAssigned
          value: SystemAssigned
          description: SystemAssigned
        - name: UserAssigned
          value: UserAssigned
          description: UserAssigned
        - name: SystemAssigned, UserAssigned
          value: SystemAssigned, UserAssigned
          description: SystemAssigned, UserAssigned
        - name: None
          value: None
          description: None
    KeyVaultProperties:
      type: object
      description: Settings concerning key vault encryption for a configuration store.
      properties:
        keyvaultUri:
          type: string
          description: The URI of the key vault key used to encrypt data.
        keyName:
          type: string
          description: The name of key used to encrypt data.
        keyVersion:
          type: string
          description: The key version of the key used to encrypt data.
    AutomationAccountProperties:
      type: object
      description: Definition of the account property.
      properties:
        sku:
          $ref: '#/components/schemas/Sku'
          description: Gets or sets the SKU of account.
        lastModifiedBy:
          type: string
          description: Gets or sets the last modified by.
        state:
          $ref: '#/components/schemas/AutomationAccountState'
          description: Gets status of account.
          readOnly: true
        creationTime:
          type: string
          format: date-time
          description: Gets the creation time.
          readOnly: true
        lastModifiedTime:
          type: string
          format: date-time
          description: Gets the last modified time.
          readOnly: true
        description:
          type: string
          description: Gets or sets the description.
        encryption:
          $ref: '#/components/schemas/EncryptionProperties'
          description: Encryption properties for the automation account
        privateEndpointConnections:
          type: array
          description: List of Automation operations supported by the Automation resource provider.
          items:
            $ref: '#/components/schemas/PrivateEndpointConnection'
        publicNetworkAccess:
          type: boolean
          description: Indicates whether traffic on the non-ARM endpoint (Webhook/Agent) is allowed from the public internet
        disableLocalAuth:
          type: boolean
          description: Indicates whether requests using non-AAD authentication are blocked
        automationHybridServiceUrl:
          type: string
          description: URL of automation hybrid service which is used for hybrid worker on-boarding.
    PrivateEndpointProperty:
      type: object
      description: Private endpoint which the connection belongs to.
      properties:
        id:
          type: string
          description: Resource id of the private endpoint.
    Sku:
      type: object
      description: The account SKU.
      properties:
        name:
          $ref: '#/components/schemas/SkuNameEnum'
          description: Gets or sets the SKU name of the account.
        family:
          type: string
          description: Gets or sets the SKU family.
        capacity:
          type: integer
          format: int32
          description: Gets or sets the SKU capacity.
      required:
      - name
    PrivateEndpointConnection:
      type: object
      description: A private endpoint connection
      properties:
        properties:
          $ref: '#/components/schemas/PrivateEndpointConnectionProperties'
          description: Resource properties.
          x-ms-client-flatten: true
      allOf:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource
    Identity:
      type: object
      description: Identity for the resource.
      properties:
        principalId:
          type: string
          description: The principal ID of resource identity. The value must be an UUID.
          readOnly: true
        tenantId:
          type: string
          description: The tenant ID of resource.
          readOnly: true
        type:
          $ref: '#/components/schemas/ResourceIdentityType'
          description: The identity type.
        userAssignedIdentities:
          type: object
          description: '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}''.'
          additionalProperties:
            $ref: '#/components/schemas/UserAssignedIdentitiesProperties'
    EncryptionProperties:
      type: object
      description: The encryption settings for automation account
      properties:
        keyVaultProperties:
          $ref: '#/components/schemas/KeyVaultProperties'
          description: Key vault properties.
        keySource:
          $ref: '#/components/schemas/EncryptionKeySourceType'
          description: Encryption Key Source
        identity:
          $ref: '#/components/schemas/EncryptionPropertiesIdentity'
          description: User identity used for CMK.
    AutomationAccountCreateOrUpdateParameters:
      type: object
      description: The parameters supplied to the create or update automation account operation.
      properties:
        properties:
          $ref: '#/components/schemas/AutomationAccountCreateOrUpdateProperties'
          description: Gets or sets account create or update properties.
          x-ms-client-flatten: true
        name:
          type: string
          description: Gets or sets name of the resource.
        location:
          type: string
          description: Gets or sets the location of the resource.
        identity:
          $ref: '#/components/schemas/Identity'
          description: Sets the identity property for automation account
        tags:
          type: object
          description: Gets or sets the tags attached to the resource.
          additionalProperties:
            type: string
    AutomationAccount:
      type: object
      description: Definition of the automation account type.
      properties:
        properties:
          $ref: '#/components/schemas/AutomationAccountProperties'
          description: Gets or sets the automation account properties.
          x-ms-client-flatten: true
        etag:
          type: string
          description: Gets or sets the etag of the resource.
        identity:
          $ref: '#/components/schemas/Identity'
          description: Identity for the resource.
      allOf:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource
    AutomationAccountListResult:
      type: object
      description: The response of a AutomationAccount list operation.
      properties:
        value:
          type: array
          description: The AutomationAccount items on this page
          items:
            $ref: '#/components/schemas/AutomationAccount'
        nextLink:
          type: string
          format: uri
          description: The link to the next page of items
      required:
      - value
    AutomationAccountUpdateParameters:
      type: object
      description: The parameters supplied to the update automation account operation.
      properties:
        properties:
          $ref: '#/components/schemas/AutomationAccountUpdateProperties'
          description: Gets or sets account update properties.
          x-ms-client-flatten: true
        name:
          type: string
          description: Gets or sets the name of the resource.
        location:
          type: string
          description: Gets or sets the location of the resource.
        identity:
          $ref: '#/components/schemas/Identity'
          description: Sets the identity property for automation account
        tags:
          type: object
          description: Gets or sets the tags attached to the resource.
          additionalProperties:
            type: string
    EncryptionPropertiesIdentity:
      type: object
      description: User identity used for CMK.
      properties:
        userAssignedIdentity:
          description: 'The user identity used for CMK. It will be an ARM resource id in the form: ''/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}''.'
    AutomationAccountUpdateProperties:
      type: object
      description: The parameters supplied to the update account properties.
      properties:
        sku:
          $ref: '#/components/schemas/Sku'
          description: Gets or sets account SKU.
        encryption:
          $ref: '#/components/schemas/EncryptionProperties'
          description: Set the encryption properties for the automation account
        publicNetworkAccess:
          type: boolean
          description: Indicates whether traffic on the non-ARM endpoint (Webhook/Agent) is allowed from the public internet
        disableLocalAuth:
          type: boolean
          description: Indicates whether requests using non-AAD authentication are blocked
  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