Azure Automation Webhook API

openapi: 3.2.0
info:
  title: Microsoft Azure Automation Webhook API
  version: '2024-10-23'
  x-typespec-generated:
  - emitter: '@azure-tools/typespec-autorest'
  description: 'Operations tagged Webhook 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: Webhook
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/webhooks
  : get:
      operationId: Webhook_ListByAutomationAccount
      tags:
      - Webhook
      description: Retrieve a list of webhooks.
      externalDocs:
        url: http://aka.ms/azureautomationsdk/webhookoperations
      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/WebhookListResult'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-examples:
        List webhooks by Automation Account:
          $ref: ./examples/listWebhooksByAutomationAccount.json
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Webhook list by automation account
      x-summary-source: derived
    servers:
    - url: https://management.azure.com
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/webhooks/{webhookName}
  : get:
      operationId: Webhook_Get
      tags:
      - Webhook
      description: Retrieve the webhook identified by webhook name.
      externalDocs:
        url: http://aka.ms/azureautomationsdk/webhookoperations
      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: webhookName
        in: path
        description: The webhook name.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Webhook'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Get webhook:
          $ref: ./examples/getWebhook.json
      summary: Webhook get
      x-summary-source: derived
    put:
      operationId: Webhook_CreateOrUpdate
      tags:
      - Webhook
      description: Create the webhook identified by webhook name.
      externalDocs:
        url: http://aka.ms/azureautomationsdk/webhookoperations
      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: webhookName
        in: path
        description: The webhook name.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Resource 'Webhook' update operation succeeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Webhook'
        '201':
          description: Resource 'Webhook' create operation succeeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Webhook'
        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 webhook:
          $ref: ./examples/createOrUpdateWebhook.json
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WebhookCreateOrUpdateParameters'
        description: The create or update parameters for webhook.
        required: true
      summary: Webhook create or update
      x-summary-source: derived
    patch:
      operationId: Webhook_Update
      tags:
      - Webhook
      description: Update the webhook identified by webhook name.
      externalDocs:
        url: http://aka.ms/azureautomationsdk/webhookoperations
      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: webhookName
        in: path
        description: The webhook name.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Webhook'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Update webhook:
          $ref: ./examples/updateWebhook.json
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WebhookUpdateParameters'
        description: The update parameters for webhook.
        required: true
      summary: Webhook update
      x-summary-source: derived
    delete:
      operationId: Webhook_Delete
      tags:
      - Webhook
      description: Delete the webhook by name.
      externalDocs:
        url: http://aka.ms/azureautomationsdk/webhookoperations
      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: webhookName
        in: path
        description: The webhook 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 webhook:
          $ref: ./examples/deleteWebhook.json
      summary: Webhook delete
      x-summary-source: derived
    servers:
    - url: https://management.azure.com
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/webhooks/generateUri
  : post:
      operationId: Webhook_GenerateUri
      tags:
      - Webhook
      description: Generates a Uri for use in creating a webhook.
      externalDocs:
        url: http://aka.ms/azureautomationsdk/webhookoperations
      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:
            text/plain:
              schema:
                type: string
            application/json:
              schema:
                type: string
        default:
          description: An unexpected error response.
          content:
            text/plain:
              schema:
                $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
            application/json:
              schema:
                $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Generate webhook uri:
          $ref: ./examples/webhookGenerateUri.json
      summary: Webhook generate uri
      x-summary-source: derived
    servers:
    - url: https://management.azure.com
components:
  schemas:
    WebhookListResult:
      type: object
      description: The response of a Webhook list operation.
      properties:
        value:
          type: array
          description: The Webhook items on this page
          items:
            $ref: '#/components/schemas/Webhook'
        nextLink:
          type: string
          format: uri
          description: The link to the next page of items
      required:
      - value
    WebhookProperties:
      type: object
      description: Definition of the webhook properties
      properties:
        isEnabled:
          type: boolean
          description: Gets or sets the value of the enabled flag of the webhook.
        uri:
          type: string
          description: Gets or sets the webhook uri.
        expiryTime:
          type: string
          format: date-time
          description: Gets or sets the expiry time.
        lastInvokedTime:
          type:
          - string
          - 'null'
          format: date-time
          description: Gets or sets the last invoked time.
        parameters:
          type: object
          description: Gets or sets the parameters of the job that is created when the webhook calls the runbook it is associated with.
          additionalProperties:
            type: string
        runbook:
          $ref: '#/components/schemas/RunbookAssociationProperty'
          description: Gets or sets the runbook the webhook is associated with.
        runOn:
          type: string
          description: Gets or sets the name of the hybrid worker group the webhook job will run on.
        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.
        lastModifiedBy:
          type: string
          description: Details of the user who last modified the Webhook
        description:
          type: string
          description: Gets or sets the description.
    WebhookCreateOrUpdateProperties:
      type: object
      description: The properties of the create webhook operation.
      properties:
        isEnabled:
          type: boolean
          description: Gets or sets the value of the enabled flag of webhook.
        uri:
          type: string
          description: Gets or sets the uri.
        expiryTime:
          type: string
          format: date-time
          description: Gets or sets the expiry time.
        parameters:
          type: object
          description: Gets or sets the parameters of the job.
          additionalProperties:
            type: string
        runbook:
          $ref: '#/components/schemas/RunbookAssociationProperty'
          description: Gets or sets the runbook.
        runOn:
          type: string
          description: Gets or sets the name of the hybrid worker group the webhook job will run on.
    RunbookAssociationProperty:
      type: object
      description: The runbook property associated with the entity.
      properties:
        name:
          type: string
          description: Gets or sets the name of the runbook.
    WebhookUpdateParameters:
      type: object
      description: The parameters supplied to the update webhook operation.
      properties:
        name:
          type: string
          description: Gets or sets the name of the webhook.
        properties:
          $ref: '#/components/schemas/WebhookUpdateProperties'
          description: Gets or sets the value of the webhook.
          x-ms-client-flatten: true
    Webhook:
      type: object
      description: Definition of the webhook type.
      properties:
        properties:
          $ref: '#/components/schemas/WebhookProperties'
          description: Gets or sets the webhook properties.
          x-ms-client-flatten: true
      allOf:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource
    WebhookUpdateProperties:
      type: object
      description: The properties of the update webhook.
      properties:
        isEnabled:
          type: boolean
          description: Gets or sets the value of the enabled flag of webhook.
        runOn:
          type: string
          description: Gets or sets the name of the hybrid worker group the webhook job will run on.
        parameters:
          type: object
          description: Gets or sets the parameters of the job.
          additionalProperties:
            type: string
        description:
          type: string
          description: Gets or sets the description of the webhook.
    WebhookCreateOrUpdateParameters:
      type: object
      description: The parameters supplied to the create or update webhook operation.
      properties:
        name:
          type: string
          description: Gets or sets the name of the webhook.
        properties:
          $ref: '#/components/schemas/WebhookCreateOrUpdateProperties'
          description: Gets or sets the properties of the webhook.
          x-ms-client-flatten: true
      required:
      - name
      - properties
  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