swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Watchers API
schemes:
- https
tags:
- name: Watchers
paths:
  /subscriptions/{subscriptionId}/providers/Microsoft.DatabaseWatcher/watchers:
    get:
      operationId: microsoftAzureWatchersListbysubscription
      tags:
      - Watchers
      description: List Watcher resources by subscription ID
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      responses:
        '200':
          description: Azure operation completed successfully.
          schema:
            $ref: '#/definitions/WatcherListResult'
        default:
          description: An unexpected error response.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Watchers_ListBySubscription:
          $ref: ./examples/Watchers_ListBySubscription_200.json
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Databasewatcher Watchers
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DatabaseWatcher/watchers:
    get:
      operationId: microsoftAzureWatchersListbyresourcegroup
      tags:
      - Watchers
      description: List Watcher resources by resource group
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      responses:
        '200':
          description: Azure operation completed successfully.
          schema:
            $ref: '#/definitions/WatcherListResult'
        default:
          description: An unexpected error response.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Watchers_ListByResourceGroup:
          $ref: ./examples/Watchers_ListByResourceGroup_200.json
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Databasewatcher Watchers
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DatabaseWatcher/watchers/{watcherName}
  : get:
      operationId: microsoftAzureWatchersGet
      tags:
      - Watchers
      description: Get a Watcher
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - name: watcherName
        in: path
        description: The database watcher name.
        required: true
        type: string
        pattern: ^[a-zA-Z0-9]{1}[a-zA-Z0-9-_]{3,60}$
      responses:
        '200':
          description: Azure operation completed successfully.
          schema:
            $ref: '#/definitions/Watcher'
        default:
          description: An unexpected error response.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Watchers_Get:
          $ref: ./examples/Watchers_Get_200.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Databasewatcher Watchers Watchername
    put:
      operationId: microsoftAzureWatchersCreateorupdate
      tags:
      - Watchers
      description: Create a Watcher
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - name: watcherName
        in: path
        description: The database watcher name.
        required: true
        type: string
        pattern: ^[a-zA-Z0-9]{1}[a-zA-Z0-9-_]{3,60}$
      - name: resource
        in: body
        description: Resource create parameters.
        required: true
        schema:
          $ref: '#/definitions/Watcher'
      responses:
        '200':
          description: Resource 'Watcher' update operation succeeded
          schema:
            $ref: '#/definitions/Watcher'
        '201':
          description: Resource 'Watcher' create operation succeeded
          schema:
            $ref: '#/definitions/Watcher'
          headers:
            Retry-After:
              type: integer
              format: int32
              description: The Retry-After header can indicate how long the client should wait before polling the operation status.
        default:
          description: An unexpected error response.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Watchers_CreateOrUpdate:
          $ref: ./examples/Watchers_CreateOrUpdate_200.json
      x-ms-long-running-operation-options:
        final-state-via: azure-async-operation
      x-ms-long-running-operation: true
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Databasewatcher Watchers Watchername
    patch:
      operationId: microsoftAzureWatchersUpdate
      tags:
      - Watchers
      description: Update a Watcher
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - name: watcherName
        in: path
        description: The database watcher name.
        required: true
        type: string
        pattern: ^[a-zA-Z0-9]{1}[a-zA-Z0-9-_]{3,60}$
      - name: properties
        in: body
        description: The resource properties to be updated.
        required: true
        schema:
          $ref: '#/definitions/WatcherUpdate'
      responses:
        '200':
          description: Azure operation completed successfully.
          schema:
            $ref: '#/definitions/Watcher'
        '202':
          description: Resource update request accepted.
          headers:
            Location:
              type: string
              description: The Location header contains the URL where the status of the long running operation can be checked.
            Retry-After:
              type: integer
              format: int32
              description: The Retry-After header can indicate how long the client should wait before polling the operation status.
        default:
          description: An unexpected error response.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Watchers_Update:
          $ref: ./examples/Watchers_Update_200.json
      x-ms-long-running-operation-options:
        final-state-via: location
      x-ms-long-running-operation: true
      summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Databasewatcher Watchers Watchername
    delete:
      operationId: microsoftAzureWatchersDelete
      tags:
      - Watchers
      description: Delete a Watcher
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - name: watcherName
        in: path
        description: The database watcher name.
        required: true
        type: string
        pattern: ^[a-zA-Z0-9]{1}[a-zA-Z0-9-_]{3,60}$
      responses:
        '202':
          description: Resource deletion accepted.
          headers:
            Location:
              type: string
              description: The Location header contains the URL where the status of the long running operation can be checked.
            Retry-After:
              type: integer
              format: int32
              description: The Retry-After header can indicate how long the client should wait before polling the operation status.
        '204':
          description: Resource does not exist.
        default:
          description: An unexpected error response.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Watchers_Delete:
          $ref: ./examples/Watchers_Delete_200.json
      x-ms-long-running-operation-options:
        final-state-via: location
      x-ms-long-running-operation: true
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Databasewatcher Watchers Watchername
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DatabaseWatcher/watchers/{watcherName}/start
  : post:
      operationId: microsoftAzureWatchersStart
      tags:
      - Watchers
      description: The action to start monitoring all targets configured for a database watcher.
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - name: watcherName
        in: path
        description: The database watcher name.
        required: true
        type: string
        pattern: ^[a-zA-Z0-9]{1}[a-zA-Z0-9-_]{3,60}$
      responses:
        '200':
          description: Azure operation completed successfully.
          schema:
            $ref: '#/definitions/Watcher'
        '202':
          description: Resource operation accepted.
          headers:
            Location:
              type: string
              description: The Location header contains the URL where the status of the long running operation can be checked.
            Retry-After:
              type: integer
              format: int32
              description: The Retry-After header can indicate how long the client should wait before polling the operation status.
        default:
          description: An unexpected error response.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Watchers_Start:
          $ref: ./examples/Watchers_Start_200.json
      x-ms-long-running-operation-options:
        final-state-via: azure-async-operation
      x-ms-long-running-operation: true
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Databasewatcher Watchers Watchername Start
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DatabaseWatcher/watchers/{watcherName}/stop
  : post:
      operationId: microsoftAzureWatchersStop
      tags:
      - Watchers
      description: The action to stop monitoring all targets configured for a database watcher.
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - name: watcherName
        in: path
        description: The database watcher name.
        required: true
        type: string
        pattern: ^[a-zA-Z0-9]{1}[a-zA-Z0-9-_]{3,60}$
      responses:
        '200':
          description: Azure operation completed successfully.
          schema:
            $ref: '#/definitions/Watcher'
        '202':
          description: Resource operation accepted.
          headers:
            Location:
              type: string
              description: The Location header contains the URL where the status of the long running operation can be checked.
            Retry-After:
              type: integer
              format: int32
              description: The Retry-After header can indicate how long the client should wait before polling the operation status.
        default:
          description: An unexpected error response.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Watchers_Stop:
          $ref: ./examples/Watchers_Stop_200.json
      x-ms-long-running-operation-options:
        final-state-via: azure-async-operation
      x-ms-long-running-operation: true
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Databasewatcher Watchers Watchername Stop
definitions:
  WatcherProperties:
    type: object
    description: The RP specific properties of the resource.
    properties:
      datastore:
        $ref: '#/definitions/Datastore'
        description: The data store for collected monitoring data.
      status:
        $ref: '#/definitions/WatcherStatus'
        description: The monitoring collection status of the watcher.
        readOnly: true
      provisioningState:
        $ref: '#/definitions/DatabaseWatcherProvisioningState'
        description: The provisioning state of the resource watcher.
        readOnly: true
  KustoOfferingType:
    type: string
    description: The type of Kusto offering.
    enum:
    - adx
    - free
    - fabric
    x-ms-enum:
      name: KustoOfferingType
      modelAsString: true
      values:
      - name: adx
        value: adx
        description: The Azure Data Explorer cluster Kusto offering.
      - name: free
        value: free
        description: The free Azure Data Explorer cluster Kusto offering.
      - name: fabric
        value: fabric
        description: The Fabric Real-Time Analytics Kusto offering.
  WatcherUpdateProperties:
    type: object
    description: The updatable properties of the Watcher.
    properties:
      datastore:
        $ref: '#/definitions/DatastoreUpdate'
        description: The data store for collected monitoring data.
  WatcherListResult:
    type: object
    description: The response of a Watcher list operation.
    properties:
      value:
        type: array
        description: The Watcher items on this page
        items:
          $ref: '#/definitions/Watcher'
      nextLink:
        type: string
        format: uri
        description: The link to the next page of items
    required:
    - value
  DatabaseWatcherProvisioningState:
    type: string
    description: The status of the last provisioning operation performed on the resource.
    enum:
    - Succeeded
    - Failed
    - Canceled
    x-ms-enum:
      name: DatabaseWatcherProvisioningState
      modelAsString: true
      values:
      - name: Succeeded
        value: Succeeded
        description: Resource has been created.
      - name: Failed
        value: Failed
        description: Resource creation failed.
      - name: Canceled
        value: Canceled
        description: Resource creation was canceled.
    readOnly: true
  Datastore:
    type: object
    description: The properties of a data store.
    properties:
      adxClusterResourceId:
        type: string
        format: arm-id
        description: The Azure ResourceId of an Azure Data Explorer cluster.
        x-ms-arm-id-details:
          allowedResources:
          - type: Microsoft.Kusto/clusters
      kustoClusterDisplayName:
        type: string
        description: The Kusto cluster display name.
      kustoClusterUri:
        type: string
        description: The Kusto cluster URI.
      kustoDataIngestionUri:
        type: string
        description: The Kusto data ingestion URI.
      kustoDatabaseName:
        type: string
        description: The name of a Kusto database.
      kustoManagementUrl:
        type: string
        description: The Kusto management URL.
      kustoOfferingType:
        $ref: '#/definitions/KustoOfferingType'
        description: The type of a Kusto offering.
    required:
    - kustoClusterUri
    - kustoDataIngestionUri
    - kustoDatabaseName
    - kustoManagementUrl
    - kustoOfferingType
  Watcher:
    type: object
    description: The DatabaseWatcherProviderHub resource.
    properties:
      properties:
        $ref: '#/definitions/WatcherProperties'
        description: The resource-specific properties for this resource.
        x-ms-client-flatten: true
        x-ms-mutability:
        - read
        - create
      identity:
        $ref: ../../../../../common-types/resource-management/v4/managedidentity.json#/definitions/ManagedServiceIdentity
        description: The managed service identities assigned to this resource.
    allOf:
    - $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource
  DatastoreUpdate:
    type: object
    description: The properties of a data store.
    properties:
      adxClusterResourceId:
        type: string
        format: arm-id
        description: The Azure ResourceId of an Azure Data Explorer cluster.
        x-ms-arm-id-details:
          allowedResources:
          - type: Microsoft.Kusto/clusters
      kustoClusterDisplayName:
        type: string
        description: The Kusto cluster display name.
      kustoClusterUri:
        type: string
        description: The Kusto cluster URI.
      kustoDataIngestionUri:
        type: string
        description: The Kusto data ingestion URI.
      kustoDatabaseName:
        type: string
        description: The name of a Kusto database.
      kustoManagementUrl:
        type: string
        description: The Kusto management URL.
      kustoOfferingType:
        $ref: '#/definitions/KustoOfferingType'
        description: The type of a Kusto offering.
  WatcherUpdate:
    type: object
    description: The type used for update operations of the Watcher.
    properties:
      identity:
        $ref: ../../../../../common-types/resource-management/v4/managedidentity.json#/definitions/ManagedServiceIdentity
        description: The managed service identities assigned to this resource.
      tags:
        type: object
        description: Resource tags.
        additionalProperties:
          type: string
      properties:
        $ref: '#/definitions/WatcherUpdateProperties'
        x-ms-client-flatten: true
  WatcherStatus:
    type: string
    description: The monitoring collection status of a watcher.
    enum:
    - Starting
    - Running
    - Stopping
    - Stopped
    - Deleting
    x-ms-enum:
      name: WatcherStatus
      modelAsString: true
      values:
      - name: Starting
        value: Starting
        description: Denotes the watcher is in a starting state.
      - name: Running
        value: Running
        description: Denotes the watcher is in a running state.
      - name: Stopping
        value: Stopping
        description: Denotes the watcher is in a stopping state.
      - name: Stopped
        value: Stopped
        description: Denotes the watcher is in a stopped state.
      - name: Deleting
        value: Deleting
        description: Denotes the watcher is in a deleting state.
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'