Microsoft Azure
Microsoft Azure ServiceMembers API

The ServiceMembers API from Microsoft Azure — 9 operation(s) for servicemembers.
Documentation GitHub OpenAPI
OpenAPI Specification

swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector ServiceMembers API
schemes:
- https
tags:
- name: ServiceMembers
paths:
  /providers/Microsoft.ADHybridHealthService/services/{serviceName}/servicemembers:
    get:
      tags:
      - ServiceMembers
      description: Gets the details of the servers, for a given service, that are onboarded to Azure Active Directory Connect Health Service.
      x-ms-examples:
        serviceMembers_list:
          $ref: ./examples/ServiceMembers.json
      operationId: microsoftAzureServicemembersList
      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.
          schema:
            $ref: '#/definitions/ServiceMembers'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Providers Microsoft Adhybridhealthservice Services Servicename Servicemembers
    post:
      tags:
      - ServiceMembers
      description: Onboards  a server, for a given service, to Azure Active Directory Connect Health Service.
      x-ms-examples:
        serviceMembers_add:
          $ref: ./examples/AddServiceMembers.json
      operationId: microsoftAzureServicemembersAdd
      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 Services Servicename Servicemembers
  /providers/Microsoft.ADHybridHealthService/services/{serviceName}/servicemembers/{serviceMemberId}:
    get:
      tags:
      - ServiceMembers
      description: Gets the details of a server, for a given service, that are onboarded to Azure Active Directory Connect Health Service.
      x-ms-examples:
        serviceMembers_get:
          $ref: ./examples/ServiceMember.json
      operationId: microsoftAzureServicemembersGet
      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 specific service member.
          schema:
            $ref: '#/definitions/ServiceMember'
      summary: Microsoft Azure Get Providers Microsoft Adhybridhealthservice Services Servicename Servicemembers Servicememberid
    delete:
      tags:
      - ServiceMembers
      description: Deletes a server that has been onboarded to Azure Active Directory Connect Health Service.
      x-ms-examples:
        serviceMembers_delete:
          $ref: ./examples/DeleteServer.json
      operationId: microsoftAzureServicemembersDelete
      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 Services Servicename Servicemembers Servicememberid
  /providers/Microsoft.ADHybridHealthService/service/{serviceName}/servicemembers/{serviceMemberId}/connectors:
    get:
      tags:
      - ServiceMembers
      description: Gets the connector details for a service.
      x-ms-examples:
        serviceMembers_listConnectors:
          $ref: ./examples/Connectors.json
      operationId: microsoftAzureServicemembersListconnectors
      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 list of connector details.
          schema:
            $ref: '#/definitions/Connectors'
      x-ms-pageable:
        nextLinkName: null
      summary: Microsoft Azure Get Providers Microsoft Adhybridhealthservice Service Servicename Servicemembers Servicememberid Connectors
  /providers/Microsoft.ADHybridHealthService/services/{serviceName}/servicemembers/{serviceMemberId}/credentials:
    get:
      tags:
      - ServiceMembers
      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:
        serviceMembers_listCredentials:
          $ref: ./examples/Credentials.json
      operationId: microsoftAzureServicemembersListcredentials
      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 service member credentials.
          schema:
            $ref: '#/definitions/Credentials'
      x-ms-pageable:
        nextLinkName: null
      summary: Microsoft Azure Get Providers Microsoft Adhybridhealthservice Services Servicename Servicemembers Servicememberid Credentials
  /providers/Microsoft.ADHybridHealthService/services/{serviceName}/servicemembers/{serviceMemberId}/data:
    delete:
      tags:
      - ServiceMembers
      description: Deletes the data uploaded by the server to Azure Active Directory Connect Health Service.
      x-ms-examples:
        serviceMembers_deleteData:
          $ref: ./examples/DeleteServer.json
      operationId: microsoftAzureServicemembersDeletedata
      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: Successfully deleted the service member.
      summary: Microsoft Azure Delete Providers Microsoft Adhybridhealthservice Services Servicename Servicemembers Servicememberid Data
  /providers/Microsoft.ADHybridHealthService/services/{serviceName}/servicemembers/{serviceMemberId}/datafreshness:
    get:
      tags:
      - ServiceMembers
      description: Gets the last time when the server uploaded data to Azure Active Directory Connect Health Service.
      x-ms-examples:
        serviceMembers_listDataFreshness:
          $ref: ./examples/Datafreshness.json
      operationId: microsoftAzureServicemembersListdatafreshness
      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 list of datafreshness details for a server.
          schema:
            $ref: '#/definitions/DataFreshnessDetails'
      x-ms-pageable:
        nextLinkName: null
      summary: Microsoft Azure Get Providers Microsoft Adhybridhealthservice Services Servicename Servicemembers Servicememberid Datafreshness
  /providers/Microsoft.ADHybridHealthService/services/{serviceName}/servicemembers/{serviceMemberId}/exportstatus:
    get:
      tags:
      - ServiceMembers
      description: Gets the export status.
      x-ms-examples:
        serviceMembers_listExportStatus:
          $ref: ./examples/Server_ExportStatus.json
      operationId: microsoftAzureServicemembersListexportstatus
      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 list of export statuses.
          schema:
            $ref: '#/definitions/ExportStatuses'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Providers Microsoft Adhybridhealthservice Services Servicename Servicemembers Servicememberid Exportstatus
  /providers/Microsoft.ADHybridHealthService/services/{serviceName}/servicemembers/{serviceMemberId}/globalconfiguration:
    get:
      tags:
      - ServiceMembers
      description: Gets the global configuration.
      x-ms-examples:
        serviceMembers_listGlobalConfiguration:
          $ref: ./examples/GlobalConfiguration.json
      operationId: microsoftAzureServicemembersListglobalconfiguration
      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
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: The list of global configurations.
          schema:
            $ref: '#/definitions/GlobalConfigurations'
      x-ms-pageable:
        nextLinkName: null
      summary: Microsoft Azure Get Providers Microsoft Adhybridhealthservice Services Servicename Servicemembers Servicememberid Globalconfiguration
  /providers/Microsoft.ADHybridHealthService/services/{serviceName}/servicemembers/{serviceMemberId}/serviceconfiguration:
    get:
      tags:
      - ServiceMembers
      description: Gets the service configuration.
      x-ms-examples:
        serviceMembers_getServiceConfiguration:
          $ref: ./examples/ServiceConfiguration.json
      operationId: microsoftAzureServicemembersGetserviceconfiguration
      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
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: The service configuration.
          schema:
            $ref: '#/definitions/ServiceConfiguration'
      summary: Microsoft Azure Get Providers Microsoft Adhybridhealthservice Services Servicename Servicemembers Servicememberid Serviceconfiguration
definitions:
  Partition:
    description: Describes the partition in Synchronization service.
    type: object
    properties:
      id:
        description: The partition Id.
        type: string
      dn:
        description: The distinguished name for the partition.
        type: string
      enabled:
        description: Indicates if the partition object is selected or not.
        type: boolean
      timeCreated:
        description: The date and time when the partition is created.
        type: string
        format: date-time
      timeLastModified:
        description: The time and date when the partition was last modified.
        type: string
        format: date-time
      partitionScope:
        description: The scope of the partition.
        $ref: '#/definitions/PartitionScope'
      name:
        description: The name of the partition.
        type: string
      isDomain:
        description: Indicates if the partition is a domain or not.
        type: boolean
      type:
        description: The partition type.
        type: string
  RunStep:
    description: The run step for a run profile.
    type: object
    properties:
      batchSize:
        description: The batch size used by the run step.
        type: integer
      objectProcessLimit:
        description: The object processing limit.
        type: integer
      objectDeleteLimit:
        description: The object deletion limit.
        type: integer
      pageSize:
        description: The page size of the run step.
        type: integer
      partitionId:
        description: The Id of the partition that a current run step operation is executing.
        type: string
      operationType:
        description: The run step operation types.
        type: integer
      timeout:
        description: The operation timeout.
        type: integer
  PartitionScope:
    description: The connector partition scope.
    type: object
    properties:
      isDefault:
        description: Indicates if the partition scope is default or not.
        type: boolean
      objectClasses:
        description: The in-scope object classes.
        type: array
        items:
          type: string
      containersIncluded:
        description: The list of containers included.
        type: array
        items:
          type: string
      containersExcluded:
        description: The list of containers excluded.
        type: array
        items:
          type: string
  DataFreshnessDetails:
    description: The data freshness details for the server.
    type: object
    properties:
      value:
        description: The value returned by the operation.
        type: array
        items:
          $ref: '#/definitions/Item'
  PasswordHashSyncConfiguration:
    description: The password has synchronization configuration settings.
    type: object
    properties:
      enabled:
        description: Indicates if the password hash synchronization configuration settings is enabled.
        type: boolean
      target:
        description: The target.
        type: string
  Connector:
    description: The connect details.
    type: object
    properties:
      connectorId:
        description: The connector Id.
        type: string
      id:
        description: The connector Id.
        type: string
      name:
        description: The connector name.
        type: string
      version:
        description: The connector version
        type: integer
      type:
        description: The connector type.
        type: string
      description:
        description: The connector description.
        type: string
      schemaXml:
        description: The schema xml for the connector.
        type: string
      passwordManagementSettings:
        description: The password management settings of the connector.
        type: object
        items:
          $ref: '#/definitions/PasswordManagementSettings'
      passwordHashSyncConfiguration:
        description: The password hash synchronization configuration of the connector.
        type: object
        items:
          $ref: '#/definitions/PasswordHashSyncConfiguration'
      timeCreated:
        description: The date and time when this connector was created.
        type: string
        format: date-time
      timeLastModified:
        description: The date and time when this connector was last modified.
        type: string
        format: date-time
      partitions:
        description: The partitions of the connector.
        type: array
        items:
          $ref: '#/definitions/Partition'
      runProfiles:
        description: The run profiles of the connector.
        type: array
        items:
          $ref: '#/definitions/RunProfile'
      classesIncluded:
        description: The class inclusion list of the connector.
        type: array
        items:
          type: string
      attributesIncluded:
        description: The attribute inclusion list of the connector.
        type: array
        items:
          type: string
  GlobalConfigurations:
    description: The list of global configurations.
    type: object
    properties:
      value:
        description: The value returned by the operation.
        type: array
        items:
          $ref: '#/definitions/GlobalConfiguration'
  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
  GlobalConfiguration:
    description: The global configuration settings.
    type: object
    properties:
      version:
        description: The version for the global configuration.
        type: integer
      schemaXml:
        description: The schema for the configuration.
        type: string
      passwordSyncEnabled:
        description: Indicates if password sync is enabled or not.
        type: boolean
      numSavedPwdEvent:
        description: The number of saved password events.
        type: integer
      featureSet:
        description: The list of additional feature sets.
        type: array
        items:
          $ref: '#/definitions/Item'
  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
  Credentials:
    description: The list of agent credentials.
    type: object
    properties:
      value:
        description: The value returned by the operation.
        type: array
        items:
          $ref: '#/definitions/Credential'
  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
  ExportStatus:
    description: The details of the export status.
    type: object
    properties:
      serviceId:
        description: The id of the service for whom the export status is being reported.
        type: string
        format: uuid
      serviceMemberId:
        description: The server Id for whom the export status is being reported.
        type: string
        format: uuid
      endTime:
        description: The date and time when the export ended.
        type: string
        format: date-time
      runStepResultId:
        description: The run step result Id.
        type: string
  Connectors:
    description: The list of connects for a service.
    type: object
    properties:
      value:
        description: The value returned by the operation.
        type: array
        items:
          $ref: '#/definitions/Connector'
  ExportStatuses:
    description: The list of export statuses.
    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/ExportStatus'
      totalCount:
        description: The total count of service elements.
        type: integer
      continuationToken:
        description: The continuation token for paginated calls.
        type: string
  PasswordManagementSettings:
    description: The password management settings.
    type: object
    properties:
      enabled:
        description: Indicates if the password extension is enabled.
        type: boolean
      extensionFilePath:
        description: The file path of the password management extension.
        type: string
      connectTo:
        description: Connection point of password management.
        type: string
      connectionTimeout:
        description: Connection timeout for password extension.
        type: integer
      user:
        description: User to execute password extension.
        type: string
      supportedPasswordOperations:
        description: The supported password operations.
        type: string
        enum:
        - Undefined
        - Set
        - Change
        x-ms-enum:
          name: PasswordOperationTypes
          modelAsString: true
      maximumRetryCount:
        description: The maximum number of retries.
        type: integer
      retryIntervalInSeconds:
        description: The time between retries.
        type: integer
      requiresSecureConnection:
        description: Indicates if a secure connection is required for password management.
        type: boolean
      unlockAccount:
        description: Indicates if accounts should be unlocked when resetting password.
        type: boolean
  RunProfile:
    description: Describes the run profile.
    type: object
    properties:
      id:
        description: The run profile Id.
        type: string
      name:
        description: The run profile name
        type: string
      runSteps:
        description: The run steps of the run profile.
        type: array
        items:
          $ref: '#/definitions/RunStep'
  ServiceConfiguration:
    description: The service configuration
    type: object
    properties:
      version:
        description: The version of the sync service.
        type: string
      serviceType:
        description: The service type of the server.
        type: integer
      serviceAccount:
        description: The service account.
        type: string
      sqlServer:
        description: The SQL server information.
        type: string
      sqlVersion:
        description: The SQL version.
        type: string
      sqlEdition:
        description: The SQL edition
        type: string
      sqlInstance:
        description: The SQL instance details.
        type: string
      sqlDatabaseName:
        description: The SQL database.
        type: string
      sqlDatabaseSize:
        description: The SQL database size.
        type: integer
  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'
Microsoft Azure ServiceMembers API

Documentation

Specifications

Other Resources

OpenAPI Specification
