swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector NotificationChannels API
schemes:
- https
tags:
- name: NotificationChannels
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/notificationchannels
  : get:
      tags:
      - NotificationChannels
      description: List notification channels in a given lab.
      operationId: microsoftAzureNotificationchannelsList
      parameters:
      - $ref: '#/parameters/subscriptionId'
      - $ref: '#/parameters/resourceGroupName'
      - name: labName
        in: path
        description: The name of the lab.
        required: true
        type: string
      - name: $expand
        in: query
        description: 'Specify the $expand query. Example: ''properties($select=webHookUrl)'''
        type: string
      - name: $filter
        in: query
        description: 'The filter to apply to the operation. Example: ''$filter=contains(name,''myName'')'
        type: string
      - name: $top
        in: query
        description: 'The maximum number of resources to return from the operation. Example: ''$top=10'''
        type: integer
        format: int32
      - name: $orderby
        in: query
        description: 'The ordering expression for the results, using OData notation. Example: ''$orderby=name desc'''
        type: string
      - $ref: '#/parameters/api-version'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/NotificationChannelList'
        default:
          description: BadRequest
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-odata: '#/definitions/NotificationChannel'
      x-ms-examples:
        NotificationChannels_List:
          $ref: ./examples/NotificationChannels_List.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Devtestlab Labs Labname Notificationchannels
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/notificationchannels/{name}
  : get:
      tags:
      - NotificationChannels
      description: Get notification channel.
      operationId: microsoftAzureNotificationchannelsGet
      parameters:
      - $ref: '#/parameters/subscriptionId'
      - $ref: '#/parameters/resourceGroupName'
      - name: labName
        in: path
        description: The name of the lab.
        required: true
        type: string
      - name: name
        in: path
        description: The name of the notification channel.
        required: true
        type: string
      - name: $expand
        in: query
        description: 'Specify the $expand query. Example: ''properties($select=webHookUrl)'''
        type: string
      - $ref: '#/parameters/api-version'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/NotificationChannel'
        default:
          description: BadRequest
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-examples:
        NotificationChannels_Get:
          $ref: ./examples/NotificationChannels_Get.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Devtestlab Labs Labname Notificationchannels Name
    put:
      tags:
      - NotificationChannels
      description: Create or replace an existing notification channel.
      operationId: microsoftAzureNotificationchannelsCreateorupdate
      parameters:
      - $ref: '#/parameters/subscriptionId'
      - $ref: '#/parameters/resourceGroupName'
      - name: labName
        in: path
        description: The name of the lab.
        required: true
        type: string
      - name: name
        in: path
        description: The name of the notification channel.
        required: true
        type: string
      - name: notificationChannel
        in: body
        description: A notification.
        required: true
        schema:
          $ref: '#/definitions/NotificationChannel'
      - $ref: '#/parameters/api-version'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/NotificationChannel'
        '201':
          description: Created
          schema:
            $ref: '#/definitions/NotificationChannel'
        default:
          description: BadRequest
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-examples:
        NotificationChannels_CreateOrUpdate:
          $ref: ./examples/NotificationChannels_CreateOrUpdate.json
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Devtestlab Labs Labname Notificationchannels Name
    delete:
      tags:
      - NotificationChannels
      description: Delete notification channel.
      operationId: microsoftAzureNotificationchannelsDelete
      parameters:
      - $ref: '#/parameters/subscriptionId'
      - $ref: '#/parameters/resourceGroupName'
      - name: labName
        in: path
        description: The name of the lab.
        required: true
        type: string
      - name: name
        in: path
        description: The name of the notification channel.
        required: true
        type: string
      - $ref: '#/parameters/api-version'
      responses:
        '200':
          description: OK
        '204':
          description: No Content
        default:
          description: BadRequest
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-examples:
        NotificationChannels_Delete:
          $ref: ./examples/NotificationChannels_Delete.json
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Devtestlab Labs Labname Notificationchannels Name
    patch:
      tags:
      - NotificationChannels
      description: Allows modifying tags of notification channels. All other properties will be ignored.
      operationId: microsoftAzureNotificationchannelsUpdate
      parameters:
      - $ref: '#/parameters/subscriptionId'
      - $ref: '#/parameters/resourceGroupName'
      - name: labName
        in: path
        description: The name of the lab.
        required: true
        type: string
      - name: name
        in: path
        description: The name of the notification channel.
        required: true
        type: string
      - name: notificationChannel
        in: body
        description: A notification.
        required: true
        schema:
          $ref: '#/definitions/NotificationChannelFragment'
      - $ref: '#/parameters/api-version'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/NotificationChannel'
        default:
          description: BadRequest
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-examples:
        NotificationChannels_Update:
          $ref: ./examples/NotificationChannels_Update.json
      summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Devtestlab Labs Labname Notificationchannels Name
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/notificationchannels/{name}/notify
  : post:
      tags:
      - NotificationChannels
      description: Send notification to provided channel.
      operationId: microsoftAzureNotificationchannelsNotify
      parameters:
      - $ref: '#/parameters/subscriptionId'
      - $ref: '#/parameters/resourceGroupName'
      - name: labName
        in: path
        description: The name of the lab.
        required: true
        type: string
      - name: name
        in: path
        description: The name of the notification channel.
        required: true
        type: string
      - name: notifyParameters
        in: body
        description: Properties for generating a Notification.
        required: true
        schema:
          $ref: '#/definitions/NotifyParameters'
      - $ref: '#/parameters/api-version'
      responses:
        '200':
          description: OK
        default:
          description: BadRequest
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-examples:
        NotificationChannels_Notify:
          $ref: ./examples/NotificationChannels_Notify.json
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Devtestlab Labs Labname Notificationchannels Name Notify
definitions:
  NotificationChannel:
    description: A notification.
    required:
    - properties
    type: object
    allOf:
    - $ref: '#/definitions/Resource'
    properties:
      properties:
        $ref: '#/definitions/NotificationChannelProperties'
        description: The properties of the resource.
        x-ms-client-flatten: true
  NotifyParameters:
    description: Properties for generating a Notification.
    type: object
    properties:
      eventName:
        description: The type of event (i.e. AutoShutdown, Cost)
        enum:
        - AutoShutdown
        - Cost
        type: string
        x-ms-enum:
          name: NotificationChannelEventType
          modelAsString: true
      jsonPayload:
        description: Properties for the notification in json format.
        type: string
  NotificationChannelList:
    description: The response of a list operation.
    type: object
    properties:
      value:
        description: Results of the list operation.
        type: array
        items:
          $ref: '#/definitions/NotificationChannel'
      nextLink:
        description: Link for next set of results.
        type: string
  Resource:
    description: An Azure resource.
    type: object
    properties:
      id:
        description: The identifier of the resource.
        type: string
        readOnly: true
      name:
        description: The name of the resource.
        type: string
        readOnly: true
      type:
        description: The type of the resource.
        type: string
        readOnly: true
      location:
        description: The location of the resource.
        type: string
      tags:
        description: The tags of the resource.
        type: object
        additionalProperties:
          type: string
    x-ms-azure-resource: true
  CloudError:
    description: Error from a REST request.
    type: object
    properties:
      error:
        $ref: '#/definitions/CloudErrorBody'
        description: The cloud error that occurred
    x-ms-external: true
  NotificationChannelFragment:
    description: A notification.
    type: object
    allOf:
    - $ref: '#/definitions/UpdateResource'
    properties: {}
  Event:
    description: An event to be notified for.
    type: object
    properties:
      eventName:
        description: The event type for which this notification is enabled (i.e. AutoShutdown, Cost)
        enum:
        - AutoShutdown
        - Cost
        type: string
        x-ms-enum:
          name: NotificationChannelEventType
          modelAsString: true
  CloudErrorBody:
    description: Body of an error from a REST request.
    type: object
    properties:
      code:
        description: The error code.
        type: string
      message:
        description: The error message.
        type: string
      target:
        description: The error target.
        type: string
      details:
        description: Inner errors.
        type: array
        items:
          $ref: '#/definitions/CloudErrorBody'
    x-ms-external: true
  UpdateResource:
    description: Represents an update resource
    type: object
    properties:
      tags:
        description: The tags of the resource.
        type: object
        additionalProperties:
          type: string
  NotificationChannelProperties:
    description: Properties of a schedule.
    type: object
    properties:
      webHookUrl:
        description: The webhook URL to send notifications to.
        type: string
      emailRecipient:
        description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses).
        type: string
      notificationLocale:
        description: The locale to use when sending a notification (fallback for unsupported languages is EN).
        type: string
      description:
        description: Description of notification.
        type: string
      events:
        description: The list of event for which this notification is enabled.
        type: array
        items:
          $ref: '#/definitions/Event'
      createdDate:
        format: date-time
        description: The creation date of the notification channel.
        type: string
        readOnly: true
      provisioningState:
        description: The provisioning status of the resource.
        type: string
        readOnly: true
      uniqueIdentifier:
        description: The unique immutable identifier of a resource (Guid).
        type: string
        readOnly: true
parameters:
  resourceGroupName:
    name: resourceGroupName
    in: path
    description: The name of the resource group.
    required: true
    type: string
    x-ms-parameter-location: method
  subscriptionId:
    name: subscriptionId
    in: path
    description: The subscription ID.
    required: true
    type: string
  api-version:
    name: api-version
    in: query
    description: Client API version.
    required: true
    type: string
    default: '2018-09-15'
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'