Microsoft Azure Alerts API

swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Alerts API
schemes:
- https
tags:
- name: Alerts
paths:
  /providers/Microsoft.ADHybridHealthService/services/{serviceName}/alerts:
    get:
      tags:
      - Alerts
      description: Gets the alerts for a given service.
      x-ms-examples:
        services_listAlerts:
          $ref: ./examples/Alerts.json
      operationId: microsoftAzureServicesListalerts
      parameters:
      - name: serviceName
        in: path
        description: The name of the service.
        required: true
        type: string
      - name: $filter
        in: query
        description: The alert property filter to apply.
        required: false
        type: string
      - name: state
        in: query
        description: The alert state to query for.
        required: false
        type: string
      - name: from
        in: query
        description: The start date to query for.
        required: false
        type: string
        format: date-time
      - name: to
        in: query
        description: The end date till when to query for.
        required: false
        type: string
        format: date-time
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: The list of alerts.
          schema:
            $ref: '#/definitions/Alerts'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Providers Microsoft Adhybridhealthservice Services Servicename Alerts
  /providers/Microsoft.ADHybridHealthService/services/{serviceName}/servicemembers/{serviceMemberId}/alerts:
    get:
      tags:
      - Alerts
      description: Gets the details of an alert for a given service and server combination.
      x-ms-examples:
        serviceMembers_listAlerts:
          $ref: ./examples/Server_Alerts.json
      operationId: microsoftAzureServicemembersListalerts
      parameters:
      - name: serviceMemberId
        in: path
        description: The server Id for which the alert details needs to be queried.
        required: true
        type: string
        format: uuid
      - name: serviceName
        in: path
        description: The name of the service.
        required: true
        type: string
      - name: $filter
        in: query
        description: The alert property filter to apply.
        required: false
        type: string
      - name: state
        in: query
        description: The alert state to query for.
        required: false
        type: string
      - name: from
        in: query
        description: The start date to query for.
        required: false
        type: string
        format: date-time
      - name: to
        in: query
        description: The end date till when to query for.
        required: false
        type: string
        format: date-time
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: The list of alerts.
          schema:
            $ref: '#/definitions/Alerts'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Providers Microsoft Adhybridhealthservice Services Servicename Servicemembers Servicememberid Alerts
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/alerts
  : get:
      tags:
      - Alerts
      description: Gets all the alerts for a Data Box Edge/Data Box Gateway device.
      operationId: microsoftAzureAlertsListbydataboxedgedevice
      parameters:
      - name: deviceName
        in: path
        description: The device name.
        required: true
        type: string
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/apiVersionParameter_2'
      responses:
        '200':
          description: The collection of alerts.
          schema:
            $ref: '#/definitions/AlertList'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        AlertGetAllInDevice:
          $ref: ./examples/AlertGetAllInDevice.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Databoxedge Databoxedgedevices Devicename Alerts
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/alerts/{name}
  : get:
      tags:
      - Alerts
      summary: Microsoft Azure Gets An Alert By Name
      operationId: microsoftAzureAlertsGet
      parameters:
      - name: deviceName
        in: path
        description: The device name.
        required: true
        type: string
      - name: name
        in: path
        description: The alert name.
        required: true
        type: string
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/apiVersionParameter_2'
      responses:
        '200':
          description: The alert details.
          schema:
            $ref: '#/definitions/Alert_2'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-examples:
        AlertGet:
          $ref: ./examples/AlertGet.json
      description: Needs a more full description created.
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/alerts
  : get:
      tags:
      - Alerts
      description: Retrieves all the alerts in a manager.
      operationId: microsoftAzureAlertsListbymanager
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/subscriptionIdParameter_2'
      - $ref: '#/parameters/resourceGroupNameParameter_2'
      - $ref: '#/parameters/managerNameParameter'
      - $ref: '#/parameters/apiVersionParameter_3'
      - name: $filter
        in: query
        description: OData Filter options
        required: false
        type: string
      responses:
        '200':
          description: The collection of alerts.
          schema:
            $ref: '#/definitions/AlertList_2'
      deprecated: false
      x-ms-odata: '#/definitions/AlertFilter'
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        AlertsListByManager:
          $ref: ./examples/AlertsListByManager.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storsimple Managers Managername Alerts
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/clearAlerts
  : post:
      tags:
      - Alerts
      description: Clear the alerts.
      operationId: microsoftAzureAlertsClear
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - name: parameters
        in: body
        description: The clear alert request.
        required: true
        schema:
          $ref: '#/definitions/ClearAlertRequest'
      - $ref: '#/parameters/subscriptionIdParameter_2'
      - $ref: '#/parameters/resourceGroupNameParameter_2'
      - $ref: '#/parameters/managerNameParameter'
      - $ref: '#/parameters/apiVersionParameter_3'
      responses:
        '204':
          description: Successfully cleared the alerts.
      deprecated: false
      x-ms-examples:
        AlertsClear:
          $ref: ./examples/AlertsClear.json
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storsimple Managers Managername Clearalerts
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/sendTestAlertEmail
  : post:
      tags:
      - Alerts
      description: Sends a test alert email.
      operationId: microsoftAzureAlertsSendtestemail
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/deviceNameParameter'
      - name: parameters
        in: body
        description: The send test alert email request.
        required: true
        schema:
          $ref: '#/definitions/SendTestAlertEmailRequest'
      - $ref: '#/parameters/subscriptionIdParameter_2'
      - $ref: '#/parameters/resourceGroupNameParameter_2'
      - $ref: '#/parameters/managerNameParameter'
      - $ref: '#/parameters/apiVersionParameter_3'
      responses:
        '204':
          description: Successfully sent the test email.
      deprecated: false
      x-ms-examples:
        AlertsSendTestEmail:
          $ref: ./examples/AlertsSendTestEmail.json
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storsimple Managers Managername Devices Devicename Sendtestalertemail
definitions:
  AlertList_2:
    description: The collection of alerts.
    required:
    - value
    type: object
    properties:
      value:
        description: The value.
        type: array
        items:
          $ref: '#/definitions/Alert_3'
      nextLink:
        description: The URI of the next page of alerts.
        type: string
  Alerts:
    description: The list of alerts for a service.
    type: object
    properties:
      value:
        description: The value returned by the operation.
        type: array
        items:
          $ref: '#/definitions/Alert'
      nextLink:
        description: The link used to get the next page of operations.
        type: string
      totalCount:
        description: The total count of alert elements.
        type: integer
      continuationToken:
        description: The continuation token for paginated calls.
        type: string
  AlertList:
    description: Collection of alerts.
    type: object
    properties:
      value:
        description: The value.
        uniqueItems: false
        type: array
        items:
          $ref: '#/definitions/Alert_2'
        readOnly: true
        x-ms-identifiers: []
      nextLink:
        description: Link to the next set of results.
        type: string
        readOnly: true
  HelpLink:
    description: The help link which contains more information related to an alert.
    type: object
    properties:
      title:
        description: The title for the link.
        type: string
      url:
        description: The url for the help document.
        type: string
  CloudErrorBody:
    description: An error response from the service.
    type: object
    properties:
      code:
        description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
        type: string
      message:
        description: A message describing the error, intended to be suitable for display in a user interface.
        type: string
      details:
        description: A list of additional details about the error.
        type: array
        items:
          $ref: '#/definitions/CloudErrorBody'
        x-ms-identifiers: []
    x-ms-external: true
  BaseModel:
    description: Represents the base class for all other ARM object models
    type: object
    properties:
      id:
        description: The path ID that uniquely identifies the object.
        type: string
        readOnly: true
      name:
        description: The name of the object.
        type: string
        readOnly: true
      type:
        description: The hierarchical type of the object.
        type: string
        readOnly: true
      kind:
        description: The Kind of the object. Currently only Series8000 is supported
        enum:
        - Series8000
        type: string
        x-ms-enum:
          name: Kind
          modelAsString: false
  Item:
    description: The key value pair for properties.
    type: object
    properties:
      key:
        description: The key for the property.
        type: string
      value:
        description: The value for the key.
        type: string
  Alert:
    description: ' The alert details indicating an issue with service or server.'
    type: object
    properties:
      alertId:
        description: The alert Id.
        type: string
        format: uuid
      level:
        description: The alert level which indicates the severity of the alert.
        type: string
        enum:
        - Warning
        - Error
        - PreWarning
        x-ms-enum:
          name: Level
          modelAsString: true
      state:
        description: The alert state which can be either active or resolved with multiple resolution types.
        type: string
        enum:
        - Active
        - ResolvedByPositiveResult
        - ResolvedManually
        - ResolvedByTimer
        - ResolvedByStateChange
        x-ms-enum:
          name: State
          modelAsString: true
      shortName:
        description: The alert short name.
        type: string
      displayName:
        description: The display name for the alert.
        type: string
      description:
        description: The alert description.
        type: string
      remediation:
        description: The alert remediation.
        type: string
      relatedLinks:
        description: The help links to get more information related to the alert.
        type: array
        items:
          $ref: '#/definitions/HelpLink'
      scope:
        description: The scope of the alert. Indicates if it is a service or a server related alert.
        type: string
      additionalInformation:
        description: Additional information related to the alert.
        type: array
        items:
          $ref: '#/definitions/AdditionalInformation'
      createdDate:
        description: The date and time,in UTC,when the alert was created.
        type: string
        format: date-time
      resolvedDate:
        description: The date and time, in UTC, when the alert was resolved.
        type: string
        format: date-time
      lastUpdated:
        description: The date and time, in UTC, when the alert was last updated.
        type: string
        format: date-time
      monitorRoleType:
        description: The monitoring role type for which the alert was raised.
        type: string
      activeAlertProperties:
        description: The active alert properties.
        type: array
        items:
          $ref: '#/definitions/Item'
      resolvedAlertProperties:
        description: The resolved alert properties.
        type: array
        items:
          $ref: '#/definitions/Item'
      tenantId:
        description: The tenant Id.
        type: string
        format: uuid
      serviceId:
        description: The service Id.
        type: string
        format: uuid
      serviceMemberId:
        description: The server Id.
        type: string
        format: uuid
  Alert_3:
    description: The alert.
    required:
    - properties
    type: object
    allOf:
    - $ref: '#/definitions/BaseModel'
    properties:
      properties:
        $ref: '#/definitions/AlertProperties_2'
        description: The properties of the alert.
        x-ms-client-flatten: true
  ARMBaseModel:
    description: Represents the base class for all object models.
    type: object
    properties:
      id:
        description: The path ID that uniquely identifies the object.
        type: string
        readOnly: true
      name:
        description: The object name.
        type: string
        readOnly: true
      type:
        description: The hierarchical type of the object.
        type: string
        readOnly: true
    x-ms-azure-resource: true
  AlertProperties:
    description: Properties of alert.
    type: object
    properties:
      title:
        description: Alert title.
        type: string
        readOnly: true
      alertType:
        description: Alert type.
        type: string
        readOnly: true
      appearedAtDateTime:
        format: date-time
        description: UTC time when the alert appeared.
        type: string
        readOnly: true
      recommendation:
        description: Alert recommendation.
        type: string
        readOnly: true
      severity:
        description: Severity of the alert.
        enum:
        - Informational
        - Warning
        - Critical
        type: string
        readOnly: true
        x-ms-enum:
          name: AlertSeverity
          modelAsString: true
      errorDetails:
        $ref: '#/definitions/AlertErrorDetails'
        description: Error details of the alert.
        readOnly: true
      detailedInformation:
        description: Alert details.
        type: object
        additionalProperties:
          type: string
        readOnly: true
  AdditionalInformation:
    description: The additional information for a property.
    type: object
    properties:
      titleName:
        description: The title name for the property.
        type: string
      titleValue:
        description: The title value for the property.
        type: string
      properties:
        description: The list of properties which are included in the additional information.
        type: object
        items:
          $ref: '#/definitions/Item'
      hasProperties:
        description: Indicates if properties are present or not.
        type: boolean
  SendTestAlertEmailRequest:
    description: The request for sending test alert email
    required:
    - emailList
    type: object
    properties:
      emailList:
        description: The list of email IDs to send the test alert email
        type: array
        items:
          type: string
  AlertProperties_2:
    description: The properties of alert
    required:
    - title
    - scope
    - alertType
    - appearedAtTime
    - appearedAtSourceTime
    - source
    - severity
    - status
    type: object
    properties:
      title:
        description: The title of the alert
        type: string
      scope:
        description: The scope of the alert
        enum:
        - Resource
        - Device
        type: string
        x-ms-enum:
          name: AlertScope
          modelAsString: false
      alertType:
        description: The type of the alert
        type: string
      appearedAtTime:
        format: date-time
        description: The UTC time at which the alert was raised
        type: string
      appearedAtSourceTime:
        format: date-time
        description: The source time at which the alert was raised
        type: string
      clearedAtTime:
        format: date-time
        description: The UTC time at which the alert was cleared
        type: string
      clearedAtSourceTime:
        format: date-time
        description: The source time at which the alert was cleared
        type: string
      source:
        $ref: '#/definitions/AlertSource'
        description: The source at which the alert was raised
      recommendation:
        description: The recommended action for the issue raised in the alert
        type: string
      resolutionReason:
        description: The reason for resolving the alert
        type: string
      severity:
        description: The severity of the alert
        enum:
        - Informational
        - Warning
        - Critical
        type: string
        x-ms-enum:
          name: AlertSeverity
          modelAsString: false
      status:
        description: The current status of the alert
        enum:
        - Active
        - Cleared
        type: string
        x-ms-enum:
          name: AlertStatus
          modelAsString: false
      errorDetails:
        $ref: '#/definitions/AlertErrorDetails_2'
        description: The details of the error for which the alert was raised
      detailedInformation:
        description: More details about the alert
        type: object
        additionalProperties:
          type: string
  AlertErrorDetails_2:
    description: The details of the error for which the alert was raised
    type: object
    properties:
      errorCode:
        description: The error code
        type: string
      errorMessage:
        description: The error message
        type: string
      occurences:
        format: int32
        description: The number of occurrences
        type: integer
  CloudError:
    description: An error response from the service.
    type: object
    properties:
      error:
        $ref: '#/definitions/CloudErrorBody'
        description: The error details.
    x-ms-external: true
  Alert_2:
    description: Alert on the data box edge/gateway device.
    type: object
    allOf:
    - $ref: '#/definitions/ARMBaseModel'
    properties:
      properties:
        $ref: '#/definitions/AlertProperties'
        description: Properties of alert.
        readOnly: true
        x-ms-client-flatten: true
      systemData:
        $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/systemData
        description: Metadata pertaining to creation and last modification of Alert
        readOnly: true
  ClearAlertRequest:
    description: The request for clearing the alert
    required:
    - alerts
    type: object
    properties:
      resolutionMessage:
        description: The resolution message while clearing the alert
        type: string
      alerts:
        description: The list of alert IDs to be cleared
        type: array
        items:
          type: string
  AlertErrorDetails:
    description: Error details for the alert.
    type: object
    properties:
      errorCode:
        description: Error code.
        type: string
        readOnly: true
      errorMessage:
        description: Error Message.
        type: string
        readOnly: true
      occurrences:
        format: int32
        description: Number of occurrences.
        type: integer
        readOnly: true
  AlertSource:
    description: The source details at which the alert was raised
    type: object
    properties:
      name:
        description: The name of the source
        type: string
      timeZone:
        description: The time zone of the source
        type: string
      alertSourceType:
        description: The source type of the alert
        enum:
        - Resource
        - Device
        type: string
        x-ms-enum:
          name: AlertSourceType
          modelAsString: false
parameters:
  resourceGroupNameParameter:
    name: resourceGroupName
    in: path
    description: The resource group name.
    required: true
    type: string
    x-ms-parameter-location: method
  managerNameParameter:
    name: managerName
    in: path
    description: The manager name
    required: true
    type: string
    maxLength: 50
    minLength: 2
    x-ms-parameter-location: method
    x-ms-skip-url-encoding: true
  resourceGroupNameParameter_2:
    name: resourceGroupName
    in: path
    description: The resource group name
    required: true
    type: string
    x-ms-parameter-location: method
    x-ms-skip-url-encoding: true
  apiVersionParameter_2:
    name: api-version
    in: query
    description: The API version.
    required: true
    type: string
  apiVersionParameter_3:
    name: api-version
    in: query
    description: The api version
    required: true
    type: string
    x-ms-skip-url-encoding: true
  subscriptionIdParameter_2:
    name: subscriptionId
    in: path
    description: The subscription id
    required: true
    type: string
    x-ms-skip-url-encoding: true
  apiVersionParameter:
    name: api-version
    in: query
    description: The version of the API to be used with the client request.
    required: true
    type: string
  deviceNameParameter:
    name: deviceName
    in: path
    description: The device name
    required: true
    type: string
    x-ms-parameter-location: method
    x-ms-skip-url-encoding: true
  subscriptionIdParameter:
    name: subscriptionId
    in: path
    description: The subscription ID.
    required: true
    type: string
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'