swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector NotificationRegistration API
schemes:
- https
tags:
- name: NotificationRegistration
paths:
  ? /subscriptions/{subscriptionId}/providers/Microsoft.ProviderHub/providerRegistrations/{providerNamespace}/notificationRegistrations/{notificationRegistrationName}
  : get:
      tags:
      - NotificationRegistration
      description: Gets the notification registration details.
      operationId: microsoftAzureNotificationregistrationsGet
      produces:
      - application/json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter
      - $ref: '#/parameters/ProviderNamespaceParameter'
      - $ref: '#/parameters/GetNotificationRegistrationNameParameter'
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
      x-ms-examples:
        NotificationRegistrations_Get:
          $ref: ./examples/NotificationRegistrations_Get.json
      responses:
        '200':
          description: Successfully retrieved the notification registration.
          schema:
            $ref: '#/definitions/NotificationRegistration'
        default:
          description: Error
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Providerhub Providerregistrations Providernamespace Notificationregistrations Notificationregistrationname
    put:
      tags:
      - NotificationRegistration
      description: Creates or updates a notification registration.
      operationId: microsoftAzureNotificationregistrationsCreateorupdate
      produces:
      - application/json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter
      - $ref: '#/parameters/ProviderNamespaceParameter'
      - $ref: '#/parameters/GetNotificationRegistrationNameParameter'
      - name: properties
        in: body
        required: true
        schema:
          $ref: '#/definitions/NotificationRegistration'
        description: The required body parameters supplied to the notification registration operation.
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
      x-ms-examples:
        NotificationRegistrations_CreateOrUpdate:
          $ref: ./examples/NotificationRegistrations_CreateOrUpdate.json
      responses:
        '200':
          description: Successfully created or updated the notification registration.
          schema:
            $ref: '#/definitions/NotificationRegistration'
        default:
          description: Error
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Put Subscriptions Subscriptionid Providers Microsoft Providerhub Providerregistrations Providernamespace Notificationregistrations Notificationregistrationname
    delete:
      tags:
      - NotificationRegistration
      description: Deletes a notification registration.
      operationId: microsoftAzureNotificationregistrationsDelete
      produces:
      - application/json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter
      - $ref: '#/parameters/ProviderNamespaceParameter'
      - $ref: '#/parameters/GetNotificationRegistrationNameParameter'
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
      x-ms-examples:
        NotificationRegistrations_Delete:
          $ref: ./examples/NotificationRegistrations_Delete.json
      responses:
        '200':
          description: Successfully deleted the notification registration.
        '204':
          description: Resource does not exist.
        default:
          description: Error
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Providers Microsoft Providerhub Providerregistrations Providernamespace Notificationregistrations Notificationregistrationname
  ? /subscriptions/{subscriptionId}/providers/Microsoft.ProviderHub/providerRegistrations/{providerNamespace}/notificationRegistrations
  : get:
      tags:
      - NotificationRegistration
      description: Gets the list of the notification registrations for the given provider.
      operationId: microsoftAzureNotificationregistrationsListbyproviderregistration
      produces:
      - application/json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter
      - $ref: '#/parameters/ProviderNamespaceParameter'
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
      x-ms-examples:
        NotificationRegistrations_ListByProviderRegistration:
          $ref: ./examples/NotificationRegistrations_ListByProviderRegistration.json
      responses:
        '200':
          description: Successfully retrieved the notification registrations.
          schema:
            $ref: '#/definitions/NotificationRegistrationArrayResponseWithContinuation'
        default:
          description: Error
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Providerhub Providerregistrations Providernamespace Notificationregistrations
definitions:
  ErrorResponse:
    description: Standard error response.
    type: object
    properties:
      error:
        description: Standard error object.
        allOf:
        - $ref: '#/definitions/Error'
  NotificationEndpoint:
    type: object
    properties:
      notificationDestination:
        type: string
      locations:
        type: array
        items:
          type: string
  NotificationRegistration:
    description: The notification registration definition.
    type: object
    allOf:
    - $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/Resource
    properties:
      properties:
        allOf:
        - $ref: '#/definitions/NotificationRegistrationProperties'
      systemData:
        $ref: ../../../../../common-types/resource-management/v1/types.json#/definitions/systemData
        readOnly: true
    x-ms-azure-resource: true
  ProvisioningState:
    enum:
    - NotSpecified
    - Accepted
    - Running
    - Creating
    - Created
    - Deleting
    - Deleted
    - Canceled
    - Failed
    - Succeeded
    - MovingResources
    - TransientFailure
    - RolloutInProgress
    type: string
    x-ms-enum:
      name: ProvisioningState
      modelAsString: true
  NotificationRegistrationProperties:
    type: object
    properties:
      notificationMode:
        enum:
        - NotSpecified
        - EventHub
        - WebHook
        type: string
        x-ms-enum:
          name: NotificationMode
          modelAsString: true
      messageScope:
        enum:
        - NotSpecified
        - RegisteredSubscriptions
        type: string
        x-ms-enum:
          name: MessageScope
          modelAsString: true
      includedEvents:
        type: array
        items:
          type: string
      notificationEndpoints:
        type: array
        items:
          $ref: '#/definitions/NotificationEndpoint'
      provisioningState:
        $ref: '#/definitions/ProvisioningState'
        description: The provisioned state of the resource.
  NotificationRegistrationArrayResponseWithContinuation:
    type: object
    properties:
      value:
        type: array
        items:
          $ref: '#/definitions/NotificationRegistration'
      nextLink:
        description: The URL to get to the next set of results, if there are any.
        type: string
  InnerError:
    description: Inner error containing list of errors.
    type: object
    properties:
      code:
        description: Specific error code than was provided by the containing error.
        type: string
        readOnly: true
      innerError:
        description: Object containing more specific information than the current object about the error.
        type: object
        readOnly: true
    additionalProperties:
      type: object
  Error:
    description: Standard error object.
    type: object
    properties:
      code:
        description: Server-defined set of error codes.
        type: string
        readOnly: true
      message:
        description: Human-readable representation of the error.
        type: string
        readOnly: true
      target:
        description: Target of the error.
        type: string
        readOnly: true
      details:
        description: Array of details about specific errors that led to this reported error.
        type: array
        items:
          $ref: '#/definitions/Error'
        readOnly: true
      innerError:
        description: Object containing more specific information than  the current object about the error.
        allOf:
        - $ref: '#/definitions/InnerError'
        readOnly: true
parameters:
  GetNotificationRegistrationNameParameter:
    in: path
    name: notificationRegistrationName
    description: The notification registration.
    required: true
    type: string
    x-ms-parameter-location: method
  ProviderNamespaceParameter:
    in: path
    name: providerNamespace
    description: The name of the resource provider hosted within ProviderHub.
    required: true
    type: string
    x-ms-parameter-location: method
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'