Azure Automation Watcher API

openapi: 3.2.0
info:
  title: Microsoft Azure Automation Watcher API
  version: '2024-10-23'
  x-typespec-generated:
  - emitter: '@azure-tools/typespec-autorest'
  description: 'Operations tagged Watcher 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: Watcher
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/watchers
  : get:
      operationId: Watcher_ListByAutomationAccount
      tags:
      - Watcher
      description: Retrieve a list of watchers.
      externalDocs:
        url: http://aka.ms/azureautomationsdk/watcheroperations
      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: $filter
        in: query
        description: The filter to apply on the operation.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WatcherListResult'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-examples:
        List watchers by Automation Account:
          $ref: ./examples/listWatchersByAutomationAccount.json
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Watcher list by automation account
      x-summary-source: derived
    servers:
    - url: https://management.azure.com
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/watchers/{watcherName}
  : get:
      operationId: Watcher_Get
      tags:
      - Watcher
      description: Retrieve the watcher identified by watcher name.
      externalDocs:
        url: http://aka.ms/azureautomationsdk/watcheroperations
      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: watcherName
        in: path
        description: The watcher name.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Watcher'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Get watcher:
          $ref: ./examples/getWatcher.json
      summary: Watcher get
      x-summary-source: derived
    put:
      operationId: Watcher_CreateOrUpdate
      tags:
      - Watcher
      description: Create the watcher identified by watcher name.
      externalDocs:
        url: http://aka.ms/azureautomationsdk/watcheroperations
      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: watcherName
        in: path
        description: The watcher name.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Resource 'Watcher' update operation succeeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Watcher'
        '201':
          description: Resource 'Watcher' create operation succeeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Watcher'
        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 watcher:
          $ref: ./examples/createOrUpdateWatcher.json
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Watcher'
        description: The create or update parameters for watcher.
        required: true
      summary: Watcher create or update
      x-summary-source: derived
    patch:
      operationId: Watcher_Update
      tags:
      - Watcher
      description: Update the watcher identified by watcher name.
      externalDocs:
        url: http://aka.ms/azureautomationsdk/watcheroperations
      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: watcherName
        in: path
        description: The watcher name.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Watcher'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Update watcher:
          $ref: ./examples/updateWatcher.json
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WatcherUpdateParameters'
        description: The update parameters for watcher.
        required: true
      summary: Watcher update
      x-summary-source: derived
    delete:
      operationId: Watcher_Delete
      tags:
      - Watcher
      description: Delete the watcher by name.
      externalDocs:
        url: http://aka.ms/azureautomationsdk/watcheroperations
      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: watcherName
        in: path
        description: The watcher 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 watcher:
          $ref: ./examples/deleteWatcher.json
      summary: Watcher delete
      x-summary-source: derived
    servers:
    - url: https://management.azure.com
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/watchers/{watcherName}/start
  : post:
      operationId: Watcher_Start
      tags:
      - Watcher
      description: Resume the watcher identified by watcher name.
      externalDocs:
        url: http://aka.ms/azureautomationsdk/watcheroperations
      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: watcherName
        in: path
        description: The watcher name.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The request has succeeded.
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Start Watcher:
          $ref: ./examples/startWatcher.json
      summary: Watcher start
      x-summary-source: derived
    servers:
    - url: https://management.azure.com
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/watchers/{watcherName}/stop
  : post:
      operationId: Watcher_Stop
      tags:
      - Watcher
      description: Resume the watcher identified by watcher name.
      externalDocs:
        url: http://aka.ms/azureautomationsdk/watcheroperations
      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: watcherName
        in: path
        description: The watcher name.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The request has succeeded.
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Start Watcher:
          $ref: ./examples/stopWatcher.json
      summary: Watcher stop
      x-summary-source: derived
    servers:
    - url: https://management.azure.com
components:
  schemas:
    WatcherUpdateParameters:
      type: object
      properties:
        properties:
          $ref: '#/components/schemas/WatcherUpdateProperties'
          description: Gets or sets the watcher update properties.
          x-ms-client-flatten: true
        name:
          type: string
          description: Gets or sets the name of the resource.
    Watcher:
      type: object
      description: Definition of the watcher type.
      properties:
        properties:
          $ref: '#/components/schemas/WatcherProperties'
          description: Gets or sets the watcher properties.
          x-ms-client-flatten: true
        etag:
          type: string
          description: Gets or sets the etag of the resource.
        tags:
          type: object
          description: Resource tags.
          additionalProperties:
            type: string
          x-ms-mutability:
          - read
          - update
          - create
        location:
          type: string
          description: The geo-location where the resource lives
          x-ms-mutability:
          - read
          - create
      allOf:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource
    WatcherProperties:
      type: object
      description: Definition of the watcher properties
      properties:
        executionFrequencyInSeconds:
          type: integer
          format: int64
          description: Gets or sets the frequency at which the watcher is invoked.
        scriptName:
          type: string
          description: Gets or sets the name of the script the watcher is attached to, i.e. the name of an existing runbook.
        scriptParameters:
          type: object
          description: Gets or sets the parameters of the script.
          additionalProperties:
            type: string
        scriptRunOn:
          type: string
          description: Gets or sets the name of the hybrid worker group the watcher will run on.
        status:
          type: string
          description: Gets the current status of the watcher.
          readOnly: true
        creationTime:
          type: string
          format: date-time
          description: Gets or sets the creation time.
          readOnly: true
        lastModifiedTime:
          type: string
          format: date-time
          description: Gets or sets the last modified time.
          readOnly: true
        lastModifiedBy:
          type: string
          description: Details of the user who last modified the watcher.
          readOnly: true
        description:
          type: string
          description: Gets or sets the description.
    WatcherListResult:
      type: object
      description: The response of a Watcher list operation.
      properties:
        value:
          type: array
          description: The Watcher items on this page
          items:
            $ref: '#/components/schemas/Watcher'
        nextLink:
          type: string
          format: uri
          description: The link to the next page of items
      required:
      - value
    WatcherUpdateProperties:
      type: object
      description: The properties of the update watcher operation.
      properties:
        executionFrequencyInSeconds:
          type: integer
          format: int64
          description: Gets or sets the frequency at which the watcher is invoked.
  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