Azure Automation Package API

openapi: 3.2.0
info:
  title: Microsoft Azure Automation Package API
  version: '2024-10-23'
  x-typespec-generated:
  - emitter: '@azure-tools/typespec-autorest'
  description: 'Operations tagged Package 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: Package
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/runtimeEnvironments/{runtimeEnvironmentName}/packages
  : get:
      operationId: Package_ListByRuntimeEnvironment
      tags:
      - Package
      description: Retrieve the a list of Packages
      externalDocs:
        url: http://aka.ms/azureautomationsdk/packageoperations
      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/PackageListResult'
        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 package:
          $ref: ./examples/package/listPackagesByRuntimeEnvironment.json
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Package list by runtime environment
      x-summary-source: derived
    servers:
    - url: https://management.azure.com
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/runtimeEnvironments/{runtimeEnvironmentName}/packages/{packageName}
  : get:
      operationId: Package_Get
      tags:
      - Package
      description: Retrieve the Package identified by Package name.
      externalDocs:
        url: http://aka.ms/azureautomationsdk/packageoperations
      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]*$
      - name: packageName
        in: path
        description: The Package name.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Package'
        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 package:
          $ref: ./examples/package/getPackage.json
      summary: Package get
      x-summary-source: derived
    put:
      operationId: Package_CreateOrUpdate
      tags:
      - Package
      description: Create or update the package identified by package name.
      externalDocs:
        url: http://aka.ms/azureautomationsdk/packageoperations
      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]*$
      - name: packageName
        in: path
        description: The Package name.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Resource 'Package' update operation succeeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Package'
        '201':
          description: Resource 'Package' create operation succeeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Package'
        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 package:
          $ref: ./examples/package/createOrUpdatePackage.json
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PackageCreateOrUpdateParameters'
        description: The create or update parameters for Package.
        required: true
      summary: Package create or update
      x-summary-source: derived
    patch:
      operationId: Package_Update
      tags:
      - Package
      description: Update the Package identified by Package name.
      externalDocs:
        url: http://aka.ms/azureautomationsdk/packageoperations
      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]*$
      - name: packageName
        in: path
        description: The Package name.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Package'
        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 package:
          $ref: ./examples/package/updatePackage.json
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PackageUpdateParameters'
        description: The update parameters for Package.
        required: true
      summary: Package update
      x-summary-source: derived
    delete:
      operationId: Package_Delete
      tags:
      - Package
      description: Delete the package by name.
      externalDocs:
        url: http://aka.ms/azureautomationsdk/packageoperations
      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]*$
      - name: packageName
        in: path
        description: The Package name.
        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 a package:
          $ref: ./examples/package/deletePackage.json
      summary: Package delete
      x-summary-source: derived
    servers:
    - url: https://management.azure.com
components:
  schemas:
    PackageProvisioningState:
      type: string
      description: Gets or sets the provisioning state of the Package.
      enum:
      - Created
      - Creating
      - StartingImportModuleRunbook
      - RunningImportModuleRunbook
      - ContentRetrieved
      - ContentDownloaded
      - ContentValidated
      - ConnectionTypeImported
      - ContentStored
      - ModuleDataStored
      - ActivitiesStored
      - ModuleImportRunbookComplete
      - Succeeded
      - Failed
      - Canceled
      - Updating
      x-ms-enum:
        name: PackageProvisioningState
        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
    PackageUpdateParameters:
      type: object
      description: The parameters supplied to the update package operation.
      properties:
        properties:
          $ref: '#/components/schemas/PackageUpdateProperties'
          description: Gets or sets the package update properties.
          x-ms-client-flatten: true
        allOf:
          $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource
          description: The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'
    PackageCreateOrUpdateParameters:
      type: object
      description: The parameters supplied to the create or update package operation.
      properties:
        properties:
          $ref: '#/components/schemas/PackageCreateOrUpdateProperties'
          description: Gets or sets the package create properties.
          x-ms-client-flatten: true
        allOf:
          $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource
          description: The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'
      required:
      - properties
    PackageCreateOrUpdateProperties:
      type: object
      description: The parameters supplied to the create or update package properties.
      properties:
        contentLink:
          $ref: '#/components/schemas/ContentLink'
          description: Gets or sets the package content link.
      required:
      - contentLink
    PackageErrorInfo:
      type: object
      description: Definition of the package error info type.
      properties:
        code:
          type: string
          description: Package import error code.
        message:
          type: string
          description: Package import error message.
    PackageProperties:
      type: object
      description: Definition of the package property type.
      properties:
        default:
          type: boolean
          description: Gets or sets the isGlobal flag of the package.
        version:
          type: string
          description: Gets or sets the version of the Package.
        sizeInBytes:
          type: integer
          format: int64
          description: Gets or sets the size in bytes of the Package.
        provisioningState:
          $ref: '#/components/schemas/PackageProvisioningState'
          description: Gets or sets the provisioning state of the Package.
          readOnly: true
        contentLink:
          $ref: '#/components/schemas/ContentLink'
          description: Gets or sets the contentLink of the Package.
        error:
          $ref: '#/components/schemas/PackageErrorInfo'
          description: Gets or sets the error info of the Package.
        allOf:
          $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/systemData
          description: Metadata pertaining to creation and last modification of the resource.
    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.
    Package:
      type: object
      description: Definition of the Package type.
      properties:
        properties:
          $ref: '#/components/schemas/PackageProperties'
          description: Gets or sets the Package properties.
          x-ms-client-flatten: true
      allOf:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource
    PackageListResult:
      type: object
      description: The response of a Package list operation.
      properties:
        value:
          type: array
          description: The Package items on this page
          items:
            $ref: '#/components/schemas/Package'
        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
    PackageUpdateProperties:
      type: object
      description: The parameters supplied to the update properties.
      properties:
        contentLink:
          $ref: '#/components/schemas/ContentLink'
          description: Gets or sets the package content link.
  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