Azure Automation Module API

openapi: 3.2.0
info:
  title: Microsoft Azure Automation Module API
  version: '2024-10-23'
  x-typespec-generated:
  - emitter: '@azure-tools/typespec-autorest'
  description: 'Operations tagged Module 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: Module
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/modules
  : get:
      operationId: Module_ListByAutomationAccount
      tags:
      - Module
      description: Retrieve a list of modules.
      externalDocs:
        url: http://aka.ms/azureautomationsdk/moduleoperations
      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/ModuleListResult'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-examples:
        List modules by automation account:
          $ref: ./examples/listModulesByAutomationAccount.json
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Module list by automation account
      x-summary-source: derived
    servers:
    - url: https://management.azure.com
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/modules/{moduleName}
  : get:
      operationId: Module_Get
      tags:
      - Module
      description: Retrieve the module identified by module name.
      externalDocs:
        url: http://aka.ms/azureautomationsdk/moduleoperations
      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: moduleName
        in: path
        description: The module name.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Module'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Get a module:
          $ref: ./examples/getModule.json
      summary: Module get
      x-summary-source: derived
    put:
      operationId: Module_CreateOrUpdate
      tags:
      - Module
      description: Create or Update the module identified by module name.
      externalDocs:
        url: http://aka.ms/azureautomationsdk/moduleoperations
      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: moduleName
        in: path
        description: The module name.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Resource 'Module' update operation succeeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Module'
        '201':
          description: Resource 'Module' create operation succeeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Module'
        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 a module:
          $ref: ./examples/createOrUpdateModule.json
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ModuleCreateOrUpdateParameters'
        description: The create or update parameters for module.
        required: true
      summary: Module create or update
      x-summary-source: derived
    patch:
      operationId: Module_Update
      tags:
      - Module
      description: Update the module identified by module name.
      externalDocs:
        url: http://aka.ms/azureautomationsdk/moduleoperations
      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: moduleName
        in: path
        description: The module name.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Module'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Update a module:
          $ref: ./examples/updateModule.json
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ModuleUpdateParameters'
        description: The update parameters for module.
        required: true
      summary: Module update
      x-summary-source: derived
    delete:
      operationId: Module_Delete
      tags:
      - Module
      description: Delete the module by name.
      externalDocs:
        url: http://aka.ms/azureautomationsdk/moduleoperations
      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: moduleName
        in: path
        description: The module name.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Resource deleted successfully.
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Delete a module:
          $ref: ./examples/deleteModule.json
      summary: Module delete
      x-summary-source: derived
    servers:
    - url: https://management.azure.com
components:
  schemas:
    ModuleProvisioningState:
      type: string
      description: Gets or sets the provisioning state of the module.
      enum:
      - Created
      - Creating
      - StartingImportModuleRunbook
      - RunningImportModuleRunbook
      - ContentRetrieved
      - ContentDownloaded
      - ContentValidated
      - ConnectionTypeImported
      - ContentStored
      - ModuleDataStored
      - ActivitiesStored
      - ModuleImportRunbookComplete
      - Succeeded
      - Failed
      - Canceled
      - Updating
      x-ms-enum:
        name: ModuleProvisioningState
        modelAsString: true
        values:
        - name: Created
          value: Created
          description: Created
        - name: Creating
          value: Creating
          description: Creating
        - name: StartingImportModuleRunbook
          value: StartingImportModuleRunbook
          description: StartingImportModuleRunbook
        - name: RunningImportModuleRunbook
          value: RunningImportModuleRunbook
          description: RunningImportModuleRunbook
        - name: ContentRetrieved
          value: ContentRetrieved
          description: ContentRetrieved
        - name: ContentDownloaded
          value: ContentDownloaded
          description: ContentDownloaded
        - name: ContentValidated
          value: ContentValidated
          description: ContentValidated
        - name: ConnectionTypeImported
          value: ConnectionTypeImported
          description: ConnectionTypeImported
        - name: ContentStored
          value: ContentStored
          description: ContentStored
        - name: ModuleDataStored
          value: ModuleDataStored
          description: ModuleDataStored
        - name: ActivitiesStored
          value: ActivitiesStored
          description: ActivitiesStored
        - name: ModuleImportRunbookComplete
          value: ModuleImportRunbookComplete
          description: ModuleImportRunbookComplete
        - name: Succeeded
          value: Succeeded
          description: Succeeded
        - name: Failed
          value: Failed
          description: Failed
        - name: Canceled
          value: Canceled
          description: Canceled
        - name: Updating
          value: Updating
          description: Updating
    ModuleCreateOrUpdateParameters:
      type: object
      description: The parameters supplied to the create or update module operation.
      properties:
        properties:
          $ref: '#/components/schemas/ModuleCreateOrUpdateProperties'
          description: Gets or sets the module create 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.
        tags:
          type: object
          description: Gets or sets the tags attached to the resource.
          additionalProperties:
            type: string
      required:
      - properties
    ModuleUpdateProperties:
      type: object
      description: The parameters supplied to the update properties.
      properties:
        contentLink:
          $ref: '#/components/schemas/ContentLink'
          description: Gets or sets the module content link.
    ModuleListResult:
      type: object
      description: The response of a Module list operation.
      properties:
        value:
          type: array
          description: The Module items on this page
          items:
            $ref: '#/components/schemas/Module'
        nextLink:
          type: string
          format: uri
          description: The link to the next page of items
      required:
      - value
    ContentHash:
      type: object
      description: Definition of the runbook property type.
      properties:
        algorithm:
          type: string
          description: Gets or sets the content hash algorithm used to hash the content.
        value:
          type: string
          description: Gets or sets expected hash value of the content.
      required:
      - algorithm
      - value
    Module:
      type: object
      description: Definition of the module type.
      properties:
        properties:
          $ref: '#/components/schemas/ModuleProperties'
          description: Gets or sets the module properties.
          x-ms-client-flatten: true
        etag:
          type: string
          description: Gets or sets the etag of the resource.
      allOf:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource
    ContentLink:
      type: object
      description: Definition of the content link.
      properties:
        uri:
          type: string
          description: Gets or sets the uri of content.
        contentHash:
          $ref: '#/components/schemas/ContentHash'
          description: Gets or sets the hash.
        version:
          type: string
          description: Gets or sets the version of the content.
    ModuleCreateOrUpdateProperties:
      type: object
      description: The parameters supplied to the create or update module properties.
      properties:
        contentLink:
          $ref: '#/components/schemas/ContentLink'
          description: Gets or sets the module content link.
      required:
      - contentLink
    ModuleProperties:
      type: object
      description: Definition of the module property type.
      properties:
        isGlobal:
          type: boolean
          description: Gets or sets the isGlobal flag of the module.
        version:
          type: string
          description: Gets or sets the version of the module.
        sizeInBytes:
          type: integer
          format: int64
          description: Gets or sets the size in bytes of the module.
        activityCount:
          type: integer
          format: int32
          description: Gets or sets the activity count of the module.
        provisioningState:
          $ref: '#/components/schemas/ModuleProvisioningState'
          description: Gets or sets the provisioning state of the module.
        contentLink:
          $ref: '#/components/schemas/ContentLink'
          description: Gets or sets the contentLink of the module.
        error:
          $ref: '#/components/schemas/ModuleErrorInfo'
          description: Gets or sets the error info of the module.
        creationTime:
          type: string
          format: date-time
          description: Gets or sets the creation time.
        lastModifiedTime:
          type: string
          format: date-time
          description: Gets or sets the last modified time.
        description:
          type: string
          description: Gets or sets the description.
        isComposite:
          type: boolean
          description: Gets or sets type of module, if its composite or not.
    ModuleErrorInfo:
      type: object
      description: Definition of the module error info type.
      properties:
        code:
          type: string
          description: Gets or sets the error code.
        message:
          type: string
          description: Gets or sets the error message.
    ModuleUpdateParameters:
      type: object
      description: The parameters supplied to the update module operation.
      properties:
        properties:
          $ref: '#/components/schemas/ModuleUpdateProperties'
          description: Gets or sets the module update properties.
          x-ms-client-flatten: true
        name:
          type: string
          description: Gets or sets name of the resource.
          readOnly: true
        location:
          type: string
          description: Gets or sets the location of the resource.
          readOnly: true
        tags:
          type: object
          description: Gets or sets the tags attached to the resource.
          additionalProperties:
            type: string
  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