Azure Automation Activity API

openapi: 3.2.0
info:
  title: Microsoft Azure Automation Activity API
  version: '2024-10-23'
  x-typespec-generated:
  - emitter: '@azure-tools/typespec-autorest'
  description: 'Operations tagged Activity 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: Activity
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/modules/{moduleName}/activities
  : get:
      operationId: Activity_ListByModule
      tags:
      - Activity
      description: Retrieve a list of activities in the module identified by module name.
      externalDocs:
        url: http://aka.ms/azureautomationsdk/activityoperations
      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/ActivityListResult'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-examples:
        List activities by a module:
          $ref: ./examples/listActivitiesByModule.json
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Activity list by module
      x-summary-source: derived
    servers:
    - url: https://management.azure.com
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/modules/{moduleName}/activities/{activityName}
  : get:
      operationId: Activity_Get
      tags:
      - Activity
      description: Retrieve the activity in the module identified by module name and activity name.
      externalDocs:
        url: http://aka.ms/azureautomationsdk/activityoperations
      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
      - name: activityName
        in: path
        description: The name of activity.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Activity'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Get Activity in a module:
          $ref: ./examples/getActivityInAModule.json
      summary: Activity get
      x-summary-source: derived
    servers:
    - url: https://management.azure.com
components:
  schemas:
    ActivityListResult:
      type: object
      description: The response model for the list activity operation.
      properties:
        value:
          type: array
          description: The Activity items on this page
          items:
            $ref: '#/components/schemas/Activity'
        nextLink:
          type: string
          format: uri
          description: The link to the next page of items
      required:
      - value
    ActivityOutputType:
      type: object
      description: Definition of the activity output type.
      properties:
        name:
          type: string
          description: Gets or sets the name of the activity output type.
        type:
          type: string
          description: Gets or sets the type of the activity output type.
    ActivityParameterValidationSet:
      type: object
      description: Definition of the activity parameter validation set.
      properties:
        memberValue:
          type: string
          description: Gets or sets the name of the activity parameter validation set member.
    ActivityProperties:
      type: object
      description: Properties of the activity.
      properties:
        definition:
          type: string
          description: Gets or sets the user name of the activity.
        parameterSets:
          type: array
          description: Gets or sets the parameter sets of the activity.
          items:
            $ref: '#/components/schemas/ActivityParameterSet'
          x-ms-identifiers:
          - name
        outputTypes:
          type: array
          description: Gets or sets the output types of the activity.
          items:
            $ref: '#/components/schemas/ActivityOutputType'
          x-ms-identifiers:
          - name
        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.
    ActivityParameter:
      type: object
      description: Definition of the activity parameter.
      properties:
        name:
          type: string
          description: Gets or sets the name of the activity parameter.
        type:
          type: string
          description: Gets or sets the type of the activity parameter.
        isMandatory:
          type: boolean
          description: Gets or sets a Boolean value that indicates true if the parameter is required. If the value is false, the parameter is optional.
        isDynamic:
          type: boolean
          description: Gets or sets a Boolean value that indicates true if the parameter is dynamic.
        position:
          type: integer
          format: int64
          description: Gets or sets the position of the activity parameter.
        valueFromPipeline:
          type: boolean
          description: Gets or sets a Boolean value that indicates true if the parameter can take values from the incoming pipeline objects. This setting is used if the cmdlet must access the complete input object. false indicates that the parameter cannot take values from the complete input object.
        valueFromPipelineByPropertyName:
          type: boolean
          description: Gets or sets a Boolean value that indicates true if the parameter can be filled from a property of the incoming pipeline object that has the same name as this parameter. false indicates that the parameter cannot be filled from the incoming pipeline object property with the same name.
        valueFromRemainingArguments:
          type: boolean
          description: Gets or sets a Boolean value that indicates true if the cmdlet parameter accepts all the remaining command-line arguments that are associated with this parameter in the form of an array. false if the cmdlet parameter does not accept all the remaining argument values.
        description:
          type: string
          description: Gets or sets the description of the activity parameter.
        validationSet:
          type: array
          description: Gets or sets the validation set of activity parameter.
          items:
            $ref: '#/components/schemas/ActivityParameterValidationSet'
          x-ms-identifiers: []
    ActivityParameterSet:
      type: object
      description: Definition of the activity parameter set.
      properties:
        name:
          type: string
          description: Gets or sets the name of the activity parameter set.
        parameters:
          type: array
          description: Gets or sets the parameters of the activity parameter set.
          items:
            $ref: '#/components/schemas/ActivityParameter'
          x-ms-identifiers: []
    Activity:
      type: object
      description: Definition of the activity.
      properties:
        id:
          type: string
          description: Gets or sets the id of the resource.
        name:
          type: string
          description: Gets the name of the activity.
          readOnly: true
        properties:
          $ref: '#/components/schemas/ActivityProperties'
          description: Gets or sets the properties of the activity.
          x-ms-client-flatten: true
  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