swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Adds API
schemes:
- https
tags:
- name: Adds
paths:
  /providers/Microsoft.ADHybridHealthService/addsservices:
    get:
      tags:
      - Adds
      description: Gets the details of Active Directory Domain Service, for a tenant, that are onboarded to Azure Active Directory Connect Health.
      operationId: microsoftAzureAddsservicesList
      x-ms-examples:
        addsServices_list:
          $ref: ./examples/Services.json
      parameters:
      - name: $filter
        in: query
        description: The service property filter to apply.
        required: false
        type: string
      - name: serviceType
        in: query
        description: The service type for the services onboarded to Azure Active Directory Connect Health. Depending on whether the service is monitoring, ADFS, Sync or ADDS roles, the service type can either be AdFederationService or AadSyncService or AdDomainService.
        required: false
        type: string
      - name: skipCount
        in: query
        description: The skip count, which specifies the number of elements that can be bypassed from a sequence and then return the remaining elements.
        required: false
        type: integer
      - name: takeCount
        in: query
        description: The take count , which specifies the number of elements that can be returned from a sequence.
        required: false
        type: integer
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: ' The list of Active Directory Domain Controller services.'
          schema:
            $ref: '#/definitions/Services'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Providers Microsoft Adhybridhealthservice Addsservices
    post:
      tags:
      - Adds
      description: Onboards a service for a given tenant in Azure Active Directory Connect Health.
      operationId: microsoftAzureAddsservicesAdd
      x-ms-examples:
        addsServices_add:
          $ref: ./examples/AddService.json
      parameters:
      - $ref: '#/parameters/apiVersionParameter'
      - name: service
        in: body
        description: The service object.
        required: true
        schema:
          $ref: '#/definitions/ServiceProperties'
      responses:
        '200':
          description: Adds the Active Directory Domain Controller Services.
          schema:
            $ref: '#/definitions/ServiceProperties'
      summary: Microsoft Azure Post Providers Microsoft Adhybridhealthservice Addsservices
  /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/alerts:
    get:
      tags:
      - Adds
      description: Gets the alerts for a given Active Directory Domain Service.
      x-ms-examples:
        alerts_listAddsAlerts:
          $ref: ./examples/Alerts.json
      operationId: microsoftAzureAlertsListaddsalerts
      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 for the given service.
          schema:
            $ref: '#/definitions/Alerts'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Providers Microsoft Adhybridhealthservice Addsservices Servicename Alerts
  /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/configuration:
    get:
      tags:
      - Adds
      description: Gets the service configurations.
      x-ms-examples:
        configuration_listAddsConfigurations:
          $ref: ./examples/AddsConfiguration.json
      operationId: microsoftAzureConfigurationListaddsconfigurations
      parameters:
      - name: serviceName
        in: path
        description: The name of the service.
        required: true
        type: string
      - name: grouping
        in: query
        description: The grouping for configurations.
        required: false
        type: string
      responses:
        '200':
          description: 'The Active Directory Domain Controller service configuration. '
          schema:
            $ref: '#/definitions/AddsConfiguration'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Providers Microsoft Adhybridhealthservice Addsservices Servicename Configuration
  /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/dimensions/{dimension}:
    get:
      tags:
      - Adds
      description: Gets the dimensions for a given dimension type in a server.
      x-ms-examples:
        dimensions_listAddsDimensions:
          $ref: ./examples/Dimensions.json
      operationId: microsoftAzureDimensionsListaddsdimensions
      parameters:
      - name: serviceName
        in: path
        description: The name of the service.
        required: true
        type: string
      - name: dimension
        in: path
        description: The dimension type.
        required: true
        type: string
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: 'The list of dimensions for a server. '
          schema:
            $ref: '#/definitions/Dimensions'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Providers Microsoft Adhybridhealthservice Addsservices Servicename Dimensions Dimension
  /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/addsservicemembers:
    get:
      tags:
      - Adds
      description: Gets the details of the Active Directory Domain servers, for a given Active Directory Domain Service, that are onboarded to Azure Active Directory Connect Health.
      x-ms-examples:
        addsServiceMembers_list:
          $ref: ./examples/AddsServiceMembers.json
      operationId: microsoftAzureAddsservicemembersList
      parameters:
      - name: serviceName
        in: path
        description: The name of the service.
        required: true
        type: string
      - name: $filter
        in: query
        description: The server property filter to apply.
        required: false
        type: string
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: 'The list of Active Directory Domain Servers. '
          schema:
            $ref: '#/definitions/AddsServiceMembers'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Providers Microsoft Adhybridhealthservice Addsservices Servicename Addsservicemembers
  /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/addomainservicemembers:
    get:
      tags:
      - Adds
      description: Gets the details of the servers, for a given Active Directory Domain Service, that are onboarded to Azure Active Directory Connect Health.
      x-ms-examples:
        adDomainServiceMembers_list:
          $ref: ./examples/AddomainServiceMembers.json
      operationId: microsoftAzureAddomainservicemembersList
      parameters:
      - name: serviceName
        in: path
        description: The name of the service.
        required: true
        type: string
      - name: $filter
        in: query
        description: The server property filter to apply.
        required: false
        type: string
      - name: isGroupbySite
        in: query
        description: Indicates if the result should be grouped by site or not.
        required: true
        type: boolean
      - name: query
        in: query
        description: The custom query.
        required: false
        type: string
      - name: nextPartitionKey
        in: query
        description: The next partition key to query for.
        required: true
        type: string
        enum:
        - ' '
        x-ms-enum:
          name: nextPartitionKey
          modelAsString: true
      - name: nextRowKey
        in: query
        description: The next row key to query for.
        required: true
        type: string
        enum:
        - ' '
        x-ms-enum:
          name: nextRowKey
          modelAsString: true
      - name: takeCount
        in: query
        description: The take count , which specifies the number of elements that can be returned from a sequence.
        required: false
        type: integer
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: The list of Active Directory Domain Servers.
          schema:
            $ref: '#/definitions/AddsServiceMembers'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Providers Microsoft Adhybridhealthservice Addsservices Servicename Addomainservicemembers
  /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/features/{featureName}/userpreference:
    get:
      tags:
      - Adds
      description: Gets the user preferences for a given feature.
      x-ms-examples:
        addsServicesUserPreference_get:
          $ref: ./examples/UserPreference.json
      operationId: microsoftAzureAddsservicesuserpreferenceGet
      parameters:
      - name: serviceName
        in: path
        description: The name of the service.
        required: true
        type: string
      - name: featureName
        in: path
        description: The name of the feature.
        required: true
        type: string
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: 'The user preference settings. '
          schema:
            $ref: '#/definitions/UserPreference'
      summary: Microsoft Azure Get Providers Microsoft Adhybridhealthservice Addsservices Servicename Features Featurename Userpreference
    delete:
      tags:
      - Adds
      description: Deletes the user preferences for a given feature.
      x-ms-examples:
        addsServicesUserPreference_delete:
          $ref: ./examples/DeleteUserPreference.json
      operationId: microsoftAzureAddsservicesuserpreferenceDelete
      parameters:
      - name: serviceName
        in: path
        description: The name of the service.
        required: true
        type: string
      - name: featureName
        in: path
        description: The name of the feature.
        required: true
        type: string
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: 'Successfully deleted the user preference settings. '
      summary: Microsoft Azure Delete Providers Microsoft Adhybridhealthservice Addsservices Servicename Features Featurename Userpreference
    post:
      tags:
      - Adds
      description: Adds the user preferences for a given feature.
      x-ms-examples:
        addsServicesUserPreference_add:
          $ref: ./examples/AddUserPreference.json
      operationId: microsoftAzureAddsservicesuserpreferenceAdd
      parameters:
      - name: serviceName
        in: path
        description: The name of the service.
        required: true
        type: string
      - name: featureName
        in: path
        description: The name of the feature.
        required: true
        type: string
      - name: setting
        in: body
        description: The user preference setting.
        required: true
        schema:
          $ref: '#/definitions/UserPreference'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: ' Successfully added the user preference settings. '
      summary: Microsoft Azure Post Providers Microsoft Adhybridhealthservice Addsservices Servicename Features Featurename Userpreference
  /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/forestsummary:
    get:
      tags:
      - Adds
      description: Gets the forest summary for a given Active Directory Domain Service, that is onboarded to Azure Active Directory Connect Health.
      x-ms-examples:
        addsServices_getForestSummary:
          $ref: ./examples/ForestSummary.json
      operationId: microsoftAzureAddsservicesGetforestsummary
      parameters:
      - name: serviceName
        in: path
        description: The name of the service.
        required: true
        type: string
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: 'The list of forest summary for the service. '
          schema:
            $ref: '#/definitions/ForestSummary'
      summary: Microsoft Azure Get Providers Microsoft Adhybridhealthservice Addsservices Servicename Forestsummary
  /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/metrics/{metricName}/groups/{groupName}:
    get:
      tags:
      - Adds
      description: Gets the server related metrics for a given metric and group combination.
      x-ms-examples:
        addsService_getMetrics:
          $ref: ./examples/Service_MetricSets.json
      operationId: microsoftAzureAddsserviceGetmetrics
      parameters:
      - name: serviceName
        in: path
        description: The name of the service.
        required: true
        type: string
      - name: metricName
        in: path
        description: The metric name
        required: true
        type: string
      - name: groupName
        in: path
        description: The group name
        required: true
        type: string
      - name: groupKey
        in: query
        description: The group key
        required: false
        type: string
      - name: fromDate
        in: query
        description: The start date.
        required: false
        type: string
        format: date-time
      - name: toDate
        in: query
        description: The end date.
        required: false
        type: string
        format: date-time
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: 'The metric sets for the service. '
          schema:
            $ref: '#/definitions/MetricSets'
      summary: Microsoft Azure Get Providers Microsoft Adhybridhealthservice Addsservices Servicename Metrics Metricname Groups Groupname
  /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/metrics/{metricName}/groups/{groupName}/average:
    get:
      tags:
      - Adds
      description: Gets the average of the metric values for a given metric and group combination.
      x-ms-examples:
        addsServices_listMetricsAverage:
          $ref: ./examples/Metrics.json
      operationId: microsoftAzureAddsservicesListmetricsaverage
      parameters:
      - name: serviceName
        in: path
        description: The name of the service.
        required: true
        type: string
      - name: metricName
        in: path
        description: The metric name
        required: true
        type: string
      - name: groupName
        in: path
        description: The group name
        required: true
        type: string
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: 'The list of metrics. '
          schema:
            $ref: '#/definitions/Metrics'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Providers Microsoft Adhybridhealthservice Addsservices Servicename Metrics Metricname Groups Groupname Average
  /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/metrics/{metricName}/groups/{groupName}/sum:
    get:
      tags:
      - Adds
      description: Gets the sum of the metric values for a given metric and group combination.
      x-ms-examples:
        addsServices_listMetricsSum:
          $ref: ./examples/Metrics.json
      operationId: microsoftAzureAddsservicesListmetricssum
      parameters:
      - name: serviceName
        in: path
        description: The name of the service.
        required: true
        type: string
      - name: metricName
        in: path
        description: The metric name
        required: true
        type: string
      - name: groupName
        in: path
        description: The group name
        required: true
        type: string
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: 'The list of aum of the metric values for a given service. '
          schema:
            $ref: '#/definitions/Metrics'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Providers Microsoft Adhybridhealthservice Addsservices Servicename Metrics Metricname Groups Groupname Sum
  /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/metricmetadata:
    get:
      tags:
      - Adds
      description: Gets the service related metrics information.
      x-ms-examples:
        addsServices_listMetricMetadata:
          $ref: ./examples/MetricMetadataList.json
      operationId: microsoftAzureAddsservicesListmetricmetadata
      parameters:
      - name: $filter
        in: query
        description: The metric metadata property filter to apply.
        required: false
        type: string
      - name: serviceName
        in: path
        description: The name of the service.
        required: true
        type: string
      - name: perfCounter
        in: query
        description: Indicates if only performance counter metrics are requested.
        required: false
        type: boolean
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: 'The list of metric metadata for a service. '
          schema:
            $ref: '#/definitions/MetricMetadataList'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Providers Microsoft Adhybridhealthservice Addsservices Servicename Metricmetadata
  /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/metricmetadata/{metricName}:
    get:
      tags:
      - Adds
      description: Gets the service related metric information.
      x-ms-examples:
        addsServices_getMetricMetadata:
          $ref: ./examples/MetricMetadata.json
      operationId: microsoftAzureAddsservicesGetmetricmetadata
      parameters:
      - name: serviceName
        in: path
        description: The name of the service.
        required: true
        type: string
      - name: metricName
        in: path
        description: The metric name
        required: true
        type: string
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: ' The metric metadata for the service.'
          schema:
            $ref: '#/definitions/MetricMetadata'
      summary: Microsoft Azure Get Providers Microsoft Adhybridhealthservice Addsservices Servicename Metricmetadata Metricname
  /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/metricmetadata/{metricName}/groups/{groupName}:
    get:
      tags:
      - Adds
      description: Gets the service related metrics for a given metric and group combination.
      x-ms-examples:
        addsServices_getMetricMetadataForGroup:
          $ref: ./examples/MetricSets.json
      operationId: microsoftAzureAddsservicesGetmetricmetadataforgroup
      parameters:
      - name: serviceName
        in: path
        description: The name of the service.
        required: true
        type: string
      - name: metricName
        in: path
        description: The metric name
        required: true
        type: string
      - name: groupName
        in: path
        description: The group name
        required: true
        type: string
      - name: groupKey
        in: query
        description: The group key
        required: false
        type: string
      - name: fromDate
        in: query
        description: The start date.
        required: false
        type: string
        format: date-time
      - name: toDate
        in: query
        description: The end date.
        required: false
        type: string
        format: date-time
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: 'The metric sets for a given service and group. '
          schema:
            $ref: '#/definitions/MetricSets'
      summary: Microsoft Azure Get Providers Microsoft Adhybridhealthservice Addsservices Servicename Metricmetadata Metricname Groups Groupname
  /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/replicationdetails:
    get:
      tags:
      - Adds
      description: Gets complete domain controller list along with replication details for a given Active Directory Domain Service, that is onboarded to Azure Active Directory Connect Health.
      x-ms-examples:
        addsServices_listReplicationDetails:
          $ref: ./examples/ReplicationDetails.json
      operationId: microsoftAzureAddsservicesListreplicationdetails
      parameters:
      - name: serviceName
        in: path
        description: The name of the service.
        required: true
        type: string
      - name: $filter
        in: query
        description: The server property filter to apply.
        required: false
        type: string
      - name: withDetails
        in: query
        description: Indicates if InboundReplicationNeighbor details are required or not.
        required: false
        type: boolean
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: 'The list of replication details for a service. '
          schema:
            $ref: '#/definitions/ReplicationDetailsList'
      x-ms-pageable:
        nextLinkName: null
      summary: Microsoft Azure Get Providers Microsoft Adhybridhealthservice Addsservices Servicename Replicationdetails
  /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/replicationstatus:
    get:
      tags:
      - Adds
      description: Gets Replication status for a given Active Directory Domain Service, that is onboarded to Azure Active Directory Connect Health.
      x-ms-examples:
        addsServicesReplicationStatus_get:
          $ref: ./examples/ReplicationStatus.json
      operationId: microsoftAzureAddsservicesreplicationstatusGet
      parameters:
      - name: serviceName
        in: path
        description: The name of the service.
        required: true
        type: string
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: 'The replication status for a service. '
          schema:
            $ref: '#/definitions/ReplicationStatus'
      summary: Microsoft Azure Get Providers Microsoft Adhybridhealthservice Addsservices Servicename Replicationstatus
  /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/replicationsummary:
    get:
      tags:
      - Adds
      description: Gets complete domain controller list along with replication details for a given Active Directory Domain Service, that is onboarded to Azure Active Directory Connect Health.
      x-ms-examples:
        addsServices_listReplicationSummary:
          $ref: ./examples/ReplicationSummary.json
      operationId: microsoftAzureAddsservicesListreplicationsummary
      parameters:
      - name: serviceName
        in: path
        description: The name of the service.
        required: true
        type: string
      - name: $filter
        in: query
        description: The server property filter to apply.
        required: false
        type: string
      - name: isGroupbySite
        in: query
        description: Indicates if the result should be grouped by site or not.
        required: true
        type: boolean
      - name: query
        in: query
        description: The custom query.
        required: true
        type: string
      - name: nextPartitionKey
        in: query
        description: The next partition key to query for.
        required: true
        type: string
        enum:
        - ' '
        x-ms-enum:
          name: nextPartitionKey
          modelAsString: true
      - name: nextRowKey
        in: query
        description: The next row key to query for.
        required: true
        type: string
        enum:
        - ' '
        x-ms-enum:
          name: nextRowKey
          modelAsString: true
      - name: takeCount
        in: query
        description: The take count , which specifies the number of elements that can be returned from a sequence.
        required: false
        type: integer
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: 'The list of replication summary for a service. '
          schema:
            $ref: '#/definitions/ReplicationSummaryList'
      x-ms-pageable:
        nextLinkName: null
      summary: Microsoft Azure Get Providers Microsoft Adhybridhealthservice Addsservices Servicename Replicationsummary
  /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/servicemembers:
    get:
      tags:
      - Adds
      description: Gets the details of the servers, for a given Active Directory Domain Controller service, that are onboarded to Azure Active Directory Connect Health Service.
      x-ms-examples:
        addsServicesServiceMembers_list:
          $ref: ./examples/ServiceMembers.json
      operationId: microsoftAzureAddsservicesservicemembersList
      parameters:
      - name: serviceName
        in: path
        description: The name of the service.
        required: true
        type: string
      - name: $filter
        in: query
        description: The server property filter to apply.
        required: false
        type: string
      - name: dimensionType
        in: query
        description: The server specific dimension.
        required: false
        type: string
      - name: dimensionSignature
        in: query
        description: The value of the dimension.
        required: false
        type: string
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: The list of service members for a given service.
          schema:
            $ref: '#/definitions/ServiceMembers'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Providers Microsoft Adhybridhealthservice Addsservices Servicename Servicemembers
    post:
      tags:
      - Adds
      description: Onboards  a server, for a given Active Directory Domain Controller service, to Azure Active Directory Connect Health Service.
      x-ms-examples:
        addsServicesServiceMembers_add:
          $ref: ./examples/AddServiceMembers.json
      operationId: microsoftAzureAddsservicesservicemembersAdd
      parameters:
      - name: serviceName
        in: path
        description: The name of the service under which the server is to be onboarded.
        required: true
        type: string
      - name: serviceMember
        in: body
        description: The server object.
        required: true
        schema:
          $ref: '#/definitions/ServiceMember'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: Successfully added the service member.
          schema:
            $ref: '#/definitions/ServiceMember'
      summary: Microsoft Azure Post Providers Microsoft Adhybridhealthservice Addsservices Servicename Servicemembers
  /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/servicemembers/{serviceMemberId}:
    get:
      tags:
      - Adds
      description: Gets the details of a server, for a given Active Directory Domain Controller service, that are onboarded to Azure Active Directory Connect Health Service.
      x-ms-examples:
        addsServiceMembers_get:
          $ref: ./examples/ServiceMember.json
      operationId: microsoftAzureAddsservicemembersGet
      parameters:
      - name: serviceName
        in: path
        description: The name of the service.
        required: true
        type: string
      - name: serviceMemberId
        in: path
        description: The server Id.
        required: true
        type: string
        format: uuid
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: 'The service member details for a given service. '
          schema:
            $ref: '#/definitions/ServiceMember'
      summary: Microsoft Azure Get Providers Microsoft Adhybridhealthservice Addsservices Servicename Servicemembers Servicememberid
    delete:
      tags:
      - Adds
      description: Deletes a Active Directory Domain Controller server that has been onboarded to Azure Active Directory Connect Health Service.
      x-ms-examples:
        addsServiceMembers_delete:
          $ref: ./examples/DeleteServer.json
      operationId: microsoftAzureAddsservicemembersDelete
      parameters:
      - name: serviceName
        in: path
        description: The name of the service.
        required: true
        type: string
      - name: serviceMemberId
        in: path
        description: The server Id.
        required: true
        type: string
        format: uuid
      - name: confirm
        in: query
        description: Indicates if the server will be permanently deleted or disabled. True indicates that the server will be permanently deleted and False indicates that the server will be marked disabled and then deleted after 30 days, if it is not re-registered.
        required: false
        type: boolean
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: Successfully deleted the service member.
      summary: Microsoft Azure Delete Providers Microsoft Adhybridhealthservice Addsservices Servicename Servicemembers Servicememberid
  /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/servicemembers/{serviceMemberId}/alerts:
    get:
      tags:
      - Adds
      description: Gets the details of an alert for a given Active Directory Domain Controller service and server combination.
      x-ms-examples:
        addsServices_listServerAlerts:
          $ref: ./examples/Server_Alerts.json
      operationId: microsoftAzureAddsservicesListserveralerts
      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 server alerts.
          schema:
            $ref: '#/definitions/Alerts'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Providers Microsoft Adhybridhealthservice Addsservices Servicename Servicemembers Servicememberid Alerts
  /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/servicemembers/{serviceMemberId}/credentials:
    get:
      tags:
      - Adds
      description: Gets the credentials of the server which is needed by the agent to connect to Azure Active Directory Connect Health Service.
      x-ms-examples:
        addsServiceMembers_listCredentials:
          $ref: ./examples/Credentials.json
      operationId: microsoftAzureAddsservicemembersListcredentials
      parameters:
      - name: serviceName
        in: path
        description: The name of the service.
        required: true
        type: string
      - name: $filter
        in: query
        description: The property filter to apply.
        required: false
        type: string
      - name: serviceMemberId
        in: path
        description: The server Id.
        required: true
        type: string
        format: uuid
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: The list of server credentials.
          schema:
            $ref: '#/definitions/Credentials'
      x-ms-pageable:
        nextLinkName: null
      summary: Microsoft Azure Get Providers Microsoft Adhybridhealthservice Addsservices Servicename Servicemembers Servicememberid Credentials
definitions:
  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
  Dimensions:
    description: The list of dimensions.
    type: object
    properties:
      nextLink:
        description: The link used to get the next page of operations.
        type: string
      value:
        description: The value returned by the operation.
        type: array
        items:
          $ref: '#/definitions/Dimension'
      totalCount:
        description: The total count of dimensions.
        type: integer
      continuationToken:
        description: The continuation token for paginated calls.
        type: string
  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
  MetricGroup:
    description: ' The metric group details.'
    type: object
    properties:
      key:
        description: The key for the group.
        type: string
      displayName:
        description: The display name for the group.
        type: string
      invisibleForUi:
        description: indicates if the metric group is displayed in Azure Active Directory Connect Health UI.
        type: boolean
  InboundReplicationNeighbor:
    description: The replication summary for the domain controller inbound neighbor.
    type: object
    properties:
      sourceDomainController:
        description: The name of the source domain controller.
        type: string
      consecutiveFailureCount:
        description: The number of consecutive failure counts.
        type: integer
      namingContext:
        description: The naming context.
        type: string
      status:
        description: The health status for the domain controller
        type: integer
      lastAttemptedSync:
        description: The last time a sync was attempted on the domain controller.
        type: string
        format: date-time
      lastSuccessfulSync:
        description: The last time when a successful sync happened.
        type: string
        format: date-time
      lastErrorCode:
        description: The last error code.
        type: integer
      lastErrorMessage:
        description: The error message of the last error.
        type: string
      errorTitle:
        description: The error title.
        type: string
      errorDescription:
        description: The error description.
        type: string
      fixLink:
        description: The link for the fix of the error.
        type: string
      fixDetails:
        description: The details of the fix.
        type: string
      additionalInfo:
        description: The additional details.
        type: string
  ReplicationDetailsList:
    description: The list of replication details.
    type: object
    properties:
      value:
        description: The value returned by the operation.
        type: array
        items:
          $ref: '#/definitions/ReplicationSummary'
      totalCount:
        description: The total count of replication detail elements.
        type: integer
      continuationToken:
        description: The continuation token for paginated calls.
        type: string
      nextLink:
        description: The link used to get the next page of operations.
        type: string
  AddsConfiguration:
    description: The list of key value properties.
    type: object
    properties:
      nextLink:
        description: The link used to get the next page of operations.
        type: string
      value:
        description: The value returned by the operation.
        type: array
        items:
          $ref: '#/definitions/Item'
      totalCount:
        description: The total count of configuration.
        type: integer
      continuationToken:
        description: The continuation token for paginated calls.
        type: string
  MetricMetadataList:
    description: The list of metric metadata.
    type: object
    properties:
      nextLink:
        description: The link used to get the next page of operations.
        type: string
      value:
        description: The value returned by the operation.
        type: array
        items:
          $ref: '#/definitions/MetricMetadata'
      totalCount:
        description: The total count of service elements.
        type: integer
      continuationToken:
        description: The continuation token for paginated calls.
        type: string
  UserPreference:
    description: ' The user preference for a given feature.'
    type: object
    properties:
      metricNames:
        description: The name of the metric.
        type: array
        items:
          type: string
  Items:
    description: The list of key value properties.
    type: object
    properties:
      value:
        description: The value returned by the operation.
        type: array
        items:
          $ref: '#/definitions/Item'
  ServiceProperties:
    description: The service properties for a given service.
    type: object
    properties:
      id:
        description: The id of the service.
        type: string
      activeAlerts:
        description: The count of alerts that are currently active for the service.
        type: integer
      additionalInformation:
        description: The additional information related to the service.
        type: string
      createdDate:
        description: The date and time, in UTC, when the service was onboarded to Azure Active Directory Connect Health.
        type: string
        format: date-time
      customNotificationEmails:
        description: The list of additional emails that are configured to receive notifications about the service.
        type: array
        items:
          type: string
      disabled:
        description: Indicates if the service is disabled or not.
        type: boolean
      displayName:
        description: The display name of the service.
        type: string
      health:
        description: The health of the service.
        type: string
      lastDisabled:
        description: The date and time, in UTC, when the service was last disabled.
        type: string
        format: date-time
      lastUpdated:
        description: The date or time , in UTC, when the service properties were last updated.
        type: string
        format: date-time
      monitoringConfigurationsComputed:
        description: The monitoring configuration of the service which determines what activities are monitored by Azure Active Directory Connect Health.
        type: object
        items:
          $ref: '#/definitions/Items'
      monitoringConfigurationsCustomized:
        description: The customized monitoring configuration of the service which determines what activities are monitored by Azure Active Directory Connect Health.
        type: object
        items:
          $ref: '#/definitions/Items'
      notificationEmailEnabled:
        description: Indicates if email notification is enabled or not.
        type: boolean
      notificationEmailEnabledForGlobalAdmins:
        description: Indicates if email notification is enabled for global administrators of the tenant.
        type: boolean
      notificationEmailsEnabledForGlobalAdmins:
        description: Indicates if email notification is enabled for global administrators of the tenant.
        type: boolean
      notificationEmails:
        description: The list of emails to whom service notifications will be sent.
        type: array
        items:
          type: string
      originalDisabledState:
        description: Gets the original disable state.
        type: boolean
      resolvedAlerts:
        description: The total count of alerts that has been resolved for the service.
        type: integer
      serviceId:
        description: The id of the service.
        type: string
      serviceName:
        description: The name of the service.
        type: string
      signature:
        description: The signature of the service.
        type: string
      simpleProperties:
        description: List of service specific configuration properties.
        type: object
        items:
          $ref: '#/definitions/Items'
      tenantId:
        description: The id of the tenant to which the service is registered to.
        type: string
      type:
        description: The service type for the services onboarded to Azure Active Directory Connect Health. Depending on whether the service is monitoring, ADFS, Sync or ADDS roles, the service type can either be AdFederationService or AadSyncService or AdDomainService.
        type: string
  MetricSet:
    description: ' The set of metric values. Example of a MetricSet are Values of token requests for a Server1 or RelyingParty1.'
    type: object
    properties:
      setName:
        description: The name of the set.
        type: string
      values:
        description: The list of the metric values.
        type: array
        items:
          type: integer
  ReplicationSummary:
    description: The replication summary for a domain controller.
    type: object
    properties:
      targetServer:
        description: The domain controller name.
        type: string
      site:
        description: The site name for a given domain controller.
        type: string
      domain:
        description: The domain name for a given domain controller.
        type: string
      status:
        description: The health status for a domain controller.
        type: integer
      lastAttemptedSync:
        description: The last time when a sync was attempted for a given domain controller.
        type: string
        format: date-time
      lastSuccessfulSync:
        description: The time when the last successful sync happened for a given domain controller.
        type: string
        format: date-time
      inboundNeighborCollection:
        description: List of individual domain controller neighbor's inbound replication status.
        type: array
        items:
          $ref: '#/definitions/InboundReplicationNeighbor'
  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
  ServiceMembers:
    description: The list of servers that are onboarded for a given service.
    type: object
    properties:
      nextLink:
        description: The link used to get the next page of operations.
        type: string
      value:
        description: The value returned by the operation.
        type: array
        items:
          $ref: '#/definitions/ServiceMember'
      totalCount:
        description: The total count of service elements.
        type: integer
      continuationToken:
        description: The continuation token for paginated calls.
        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
  Metrics:
    description: The list of metric items.
    type: object
    properties:
      nextLink:
        description: The link used to get the next page of operations.
        type: string
      value:
        description: The value returned by the operation.
        type: array
        items:
          $ref: '#/definitions/Item'
      totalCount:
        description: The total count of metrics.
        type: integer
      continuationToken:
        description: The continuation token for paginated calls.
        type: string
  ForestSummary:
    description: The forest summary for an ADDS domain.
    type: object
    properties:
      forestName:
        description: The forest name.
        type: string
      domainCount:
        description: The domain count.
        type: integer
      siteCount:
        description: The site count.
        type: integer
      monitoredDcCount:
        description: The number of domain controllers that are monitored by Azure Active Directory Connect Health.
        type: integer
      totalDcCount:
        description: The total domain controllers.
        type: integer
      domains:
        description: The list of domain controller names.
        type: array
        items:
          type: string
      sites:
        description: The list of site names.
        type: array
        items:
          type: string
  ReplicationStatus:
    description: ' Replication summary for a domain controller.'
    type: object
    properties:
      forestName:
        description: The forest name.
        type: string
      totalDcCount:
        description: The total number of domain controllers for a given forest.
        type: integer
      errorDcCount:
        description: The total number of domain controllers with error in a given forest.
        type: integer
  Services:
    description: The list of services for a given onboarded tenant.
    type: object
    properties:
      nextLink:
        description: The link used to get the next page of operations.
        type: string
      value:
        description: The value returned by the operation.
        type: array
        items:
          $ref: '#/definitions/ServiceProperties'
      totalCount:
        description: The total count of service elements.
        type: integer
      continuationToken:
        description: The continuation token for paginated calls.
        type: string
  Credential:
    description: The credential for a given server.
    type: object
    properties:
      identifier:
        description: The credential identifier.
        type: string
      type:
        description: The type of credential.
        type: string
      credentialData:
        description: The credential data.
        type: array
        items:
          type: string
  AddsServiceMember:
    description: The server details for ADDS service.
    type: object
    properties:
      domainName:
        description: The domain name.
        type: string
      siteName:
        description: The site name.
        type: string
      addsRoles:
        description: The list of ADDS roles.
        type: array
        items:
          type: string
      gcReachable:
        description: Indicates if the global catalog for this domain is reachable or not.
        type: boolean
      isAdvertising:
        description: Indicates if the Dc is advertising or not.
        type: boolean
      pdcReachable:
        description: Indicates if the primary domain controller is reachable or not.
        type: boolean
      sysvolState:
        description: Indicates if the SYSVOL state is healthy or not.
        type: boolean
      dcTypes:
        description: The list of domain controller types.
        type: array
        items:
          type: string
      serviceMemberId:
        description: The id of the server.
        type: string
      serviceId:
        description: The service id to whom this server belongs.
        type: string
      tenantId:
        description: The tenant id to whom this server belongs.
        type: string
      activeAlerts:
        description: The total number of alerts that are currently active for the server.
        type: integer
      additionalInformation:
        description: The additional information, if any, for the server.
        type: string
      createdDate:
        description: The date time , in UTC, when the server was onboarded to Azure Active Directory Connect Health.
        type: string
        format: date-time
      dimensions:
        description: The server specific configuration related dimensions.
        type: array
        items:
          $ref: '#/definitions/Item'
      disabled:
        description: 'Indicates if the server is disabled or not. '
        type: boolean
      disabledReason:
        description: The reason for disabling the server.
        type: integer
      installedQfes:
        description: The list of installed QFEs for the server.
        type: array
        items:
          $ref: '#/definitions/Hotfix'
      lastDisabled:
        description: The date and time , in UTC, when the server was last disabled.
        type: string
        format: date-time
      lastReboot:
        description: The date and time, in UTC, when the server was last rebooted.
        type: string
        format: date-time
      lastServerReportedMonitoringLevelChange:
        description: The date and time, in UTC, when the server's data monitoring configuration was last changed.
        type: string
        format: date-time
      lastUpdated:
        description: The date and time, in UTC, when the server properties were last updated.
        type: string
        format: date-time
      machineId:
        description: The id of the machine.
        type: string
      machineName:
        description: The name of the server.
        type: string
      monitoringConfigurationsComputed:
        description: The monitoring configuration of the server which determines what activities are monitored by Azure Active Directory Connect Health.
        type: array
        items:
          $ref: '#/definitions/Item'
      monitoringConfigurationsCustomized:
        description: The customized monitoring configuration of the server which determines what activities are monitored by Azure Active Directory Connect Health.
        type: array
        items:
          $ref: '#/definitions/Item'
      osName:
        description: The name of the operating system installed in the machine.
        type: string
      osVersion:
        description: The version of the operating system installed in the machine.
        type: string
      properties:
        description: Server specific properties.
        type: array
        items:
          $ref: '#/definitions/Item'
      recommendedQfes:
        description: The list of recommended hotfixes for the server.
        type: array
        items:
          $ref: '#/definitions/Hotfix'
      resolvedAlerts:
        description: The total count of alerts that are resolved for this server.
        type: integer
      role:
        description: The service role that is being monitored in the server.
        type: string
      serverReportedMonitoringLevel:
        description: The monitoring level reported by the server.
        type: string
        enum:
        - Partial
        - Full
        - 'Off'
        x-ms-enum:
          name: MonitoringLevel
          modelAsString: false
      status:
        description: The health status of the server.
        type: string
  Credentials:
    description: The list of agent credentials.
    type: object
    properties:
      value:
        description: The value returned by the operation.
        type: array
        items:
          $ref: '#/definitions/Credential'
  AddsServiceMembers:
    description: The list of  ADDS service members.
    type: object
    properties:
      nextLink:
        description: The link used to get the next page of operations.
        type: string
      value:
        description: The value returned by the operation.
        type: array
        items:
          $ref: '#/definitions/AddsServiceMember'
      totalCount:
        description: The total count of service members.
        type: integer
      continuationToken:
        description: The continuation token for paginated calls.
        type: string
  Hotfix:
    description: The details of the hotfix installed in the server.
    type: object
    properties:
      kbName:
        description: The name of the hotfix KB.
        type: string
      link:
        description: The link to the KB Article.
        type: string
      installedDate:
        description: The date and time, in UTC, when the KB was installed in the server.
        type: string
        format: date-time
  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
  MetricSets:
    description: The metrics data represented set.
    type: object
    properties:
      sets:
        description: The list of metric set.
        type: array
        items:
          $ref: '#/definitions/MetricSet'
      timeStamps:
        description: The list of timestamps for each metric in the metric set.
        type: array
        items:
          type: string
          format: date-time
  MetricMetadata:
    description: The metric meta data
    type: object
    properties:
      metricsProcessorClassName:
        description: The name of the class which retrieve and process the metric.
        type: string
      metricName:
        description: The metric name
        type: string
      groupings:
        description: The groupings for the metrics.
        type: array
        items:
          $ref: '#/definitions/MetricGroup'
      displayName:
        description: The display name for the metric.
        type: string
      valueKind:
        description: Indicates if the metrics is a rate,value, percent or duration type.
        type: string
      minValue:
        description: The minimum value.
        type: integer
      maxValue:
        description: The maximum value.
        type: integer
      kind:
        description: Indicates whether the dashboard to represent the metric is a line, bar,pie, area or donut chart.
        type: string
      isDefault:
        description: Indicates if the metric is a default metric or not.
        type: boolean
      isPerfCounter:
        description: Indicates if the metric is a performance counter metric or not.
        type: boolean
      isDevOps:
        description: Indicates if the metric is visible to DevOps or not.
        type: boolean
  Dimension:
    description: The connector object error.
    type: object
    properties:
      health:
        description: The health status for the domain controller.
        type: string
        enum:
        - Healthy
        - Warning
        - Error
        - NotMonitored
        - Missing
        x-ms-enum:
          name: HealthStatus
          modelAsString: true
      simpleProperties:
        description: List of service specific configuration properties.
        type: object
        items:
          $ref: '#/definitions/Item'
      activeAlerts:
        description: The count of alerts that are currently active for the service.
        type: integer
      additionalInformation:
        description: The additional information related to the service.
        type: string
      lastUpdated:
        description: The date or time , in UTC, when the service properties were last updated.
        type: string
        format: date-time
      displayName:
        description: The display name of the service.
        type: string
      resolvedAlerts:
        description: The total count of alerts that has been resolved for the service.
        type: integer
      signature:
        description: The signature of the service.
        type: string
      type:
        description: The service type for the services onboarded to Azure Active Directory Connect Health. Depending on whether the service is monitoring, ADFS, Sync or ADDS roles, the service type can either be AdFederationService or AadSyncService or AdDomainService.
        type: string
  ReplicationSummaryList:
    description: The list of replication summary details.
    type: object
    properties:
      value:
        description: The value returned by the operation.
        type: array
        items:
          $ref: '#/definitions/ReplicationSummary'
  ServiceMember:
    description: The server properties for a given service.
    type: object
    properties:
      serviceMemberId:
        description: The id of the server.
        type: string
      serviceId:
        description: The service id to whom this server belongs.
        type: string
      tenantId:
        description: The tenant id to whom this server belongs.
        type: string
      activeAlerts:
        description: The total number of alerts that are currently active for the server.
        type: integer
      additionalInformation:
        description: The additional information, if any, for the server.
        type: string
      createdDate:
        description: The date time , in UTC, when the server was onboarded to Azure Active Directory Connect Health.
        type: string
        format: date-time
      dimensions:
        description: The server specific configuration related dimensions.
        type: object
        items:
          $ref: '#/definitions/Item'
      disabled:
        description: 'Indicates if the server is disabled or not. '
        type: boolean
      disabledReason:
        description: The reason for disabling the server.
        type: integer
      installedQfes:
        description: The list of installed QFEs for the server.
        type: object
        items:
          $ref: '#/definitions/Hotfix'
      lastDisabled:
        description: The date and time , in UTC, when the server was last disabled.
        type: string
        format: date-time
      lastReboot:
        description: The date and time, in UTC, when the server was last rebooted.
        type: string
        format: date-time
      lastServerReportedMonitoringLevelChange:
        description: The date and time, in UTC, when the server's data monitoring configuration was last changed.
        type: string
        format: date-time
      lastUpdated:
        description: The date and time, in UTC, when the server properties were last updated.
        type: string
        format: date-time
      machineId:
        description: The id of the machine.
        type: string
      machineName:
        description: The name of the server.
        type: string
      monitoringConfigurationsComputed:
        description: The monitoring configuration of the server which determines what activities are monitored by Azure Active Directory Connect Health.
        type: object
        items:
          $ref: '#/definitions/Item'
      monitoringConfigurationsCustomized:
        description: The customized monitoring configuration of the server which determines what activities are monitored by Azure Active Directory Connect Health.
        type: object
        items:
          $ref: '#/definitions/Item'
      osName:
        description: The name of the operating system installed in the machine.
        type: string
      osVersion:
        description: The version of the operating system installed in the machine.
        type: string
      properties:
        description: Server specific properties.
        type: object
        items:
          $ref: '#/definitions/Item'
      recommendedQfes:
        description: The list of recommended hotfixes for the server.
        type: object
        items:
          $ref: '#/definitions/Hotfix'
      resolvedAlerts:
        description: The total count of alerts that are resolved for this server.
        type: integer
      role:
        description: The service role that is being monitored in the server.
        type: string
      serverReportedMonitoringLevel:
        description: The monitoring level reported by the server.
        type: string
        enum:
        - Partial
        - Full
        - 'Off'
        x-ms-enum:
          name: MonitoringLevel
          modelAsString: false
      status:
        description: The health status of the server.
        type: string
parameters:
  apiVersionParameter:
    name: api-version
    in: query
    description: The version of the API to be used with the client request.
    required: true
    type: string
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'