Azure Site Recovery Replication Alert Settings API

openapi: 3.2.0
info:
  title: Microsoft Azure Site Recovery Replication Alert Settings API
  version: '2026-11-01'
  x-typespec-generated:
  - emitter: '@azure-tools/typespec-autorest'
  description: 'Operations tagged ReplicationAlertSettings across 2 of this provider''s published API definitions: microsoft-azure-site-recovery-service-2026-11-01.json, microsoft-azure-site-recovery-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: ReplicationAlertSettings
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationAlertSettings
  : get:
      operationId: ReplicationAlertSettings_List
      tags:
      - ReplicationAlertSettings
      summary: Gets the list of configured email notification(alert) configurations
      description: Gets the list of email notification(alert) configurations for the vault.
      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: resourceName
        in: path
        description: The name of the Vault
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlertCollection'
      x-ms-examples:
        Gets the list of configured email notification(alert) configurations.:
          $ref: ./examples/ReplicationAlertSettings_List.json
      x-ms-pageable:
        nextLinkName: nextLink
    servers:
    - url: https://management.azure.com
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationAlertSettings/{alertSettingName}
  : get:
      operationId: ReplicationAlertSettings_Get
      tags:
      - ReplicationAlertSettings
      summary: Gets an email notification(alert) configuration
      description: Gets the details of the specified email notification(alert) configuration.
      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: resourceName
        in: path
        description: The name of the Vault
        required: true
        schema:
          type: string
      - name: alertSettingName
        in: path
        description: The name of the email notification configuration.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Alert'
      x-ms-examples:
        Gets an email notification(alert) configuration.:
          $ref: ./examples/ReplicationAlertSettings_Get.json
    put:
      operationId: ReplicationAlertSettings_Create
      tags:
      - ReplicationAlertSettings
      summary: Configures email notifications for this vault
      description: Create or update an email notification(alert) configuration.
      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: resourceName
        in: path
        description: The name of the Vault
        required: true
        schema:
          type: string
      - name: alertSettingName
        in: path
        description: The name of the email notification configuration.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Resource 'Alert' update operation succeeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Alert'
      x-ms-examples:
        Configures email notifications for this vault.:
          $ref: ./examples/ReplicationAlertSettings_Create.json
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConfigureAlertRequest'
        description: The input to configure the email notification(alert).
        required: true
    servers:
    - url: https://management.azure.com
components:
  schemas:
    AlertCollection:
      type: object
      description: Collection of alerts.
      properties:
        value:
          type: array
          description: The Alert items on this page
          items:
            $ref: '#/components/schemas/Alert'
        nextLink:
          type: string
          format: uri
          description: The link to the next page of items
      required:
      - value
    ConfigureAlertRequestProperties:
      type: object
      description: Properties of a configure alert request.
      properties:
        sendToOwners:
          type: string
          description: A value indicating whether to send email to subscription administrator.
        customEmailAddresses:
          type: array
          description: The custom email address for sending emails.
          items:
            type: string
        locale:
          type: string
          description: The locale for the email notification.
    AlertProperties:
      type: object
      description: The properties of an alert.
      properties:
        sendToOwners:
          type: string
          description: A value indicating whether to send email to subscription administrator.
        customEmailAddresses:
          type: array
          description: The custom email address for sending emails.
          items:
            type: string
        locale:
          type: string
          description: The locale for the email notification.
    ConfigureAlertRequest:
      type: object
      description: Request to configure alerts for the system.
      properties:
        properties:
          $ref: '#/components/schemas/ConfigureAlertRequestProperties'
          description: The properties of a configure alert request.
    Alert:
      type: object
      description: Implements the Alert class.
      properties:
        properties:
          $ref: '#/components/schemas/AlertProperties'
          description: Alert related data.
        location:
          type: string
          description: Resource Location
      allOf:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource
  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-site-recovery-service-2026-11-01.json
- microsoft-azure-site-recovery-openapi.yml