swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Client Groups API
schemes:
- https
tags:
- name: Client Groups
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/features/serviceMap/clientGroups/{clientGroupName}
  : get:
      tags:
      - Client Groups
      operationId: microsoftAzureClientgroupsGet
      x-ms-examples:
        SMClientGroupsGetGet:
          $ref: ./examples/ClientGroups/SMClientGroupsGetGet.json
      description: Retrieves the specified client group
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/WorkspaceNameParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/ClientGroupNameParameter'
      - name: startTime
        in: query
        required: false
        type: string
        format: date-time
        description: UTC date and time specifying the start time of an interval. When not specified the service uses DateTime.UtcNow - 10m
      - name: endTime
        in: query
        required: false
        type: string
        format: date-time
        description: UTC date and time specifying the end time of an interval. When not specified the service uses DateTime.UtcNow
      responses:
        '200':
          description: The operation completed successfully.
          schema:
            $ref: '#/definitions/ClientGroup'
        default:
          description: An error occurred while processing the request. See the error.code parameter to identify the specific error.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Operationalinsights Workspaces Workspacename Features Servicemap Clientgroups Clientgroupname
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/features/serviceMap/clientGroups/{clientGroupName}/membersCount
  : get:
      tags:
      - Client Groups
      operationId: microsoftAzureClientgroupsGetmemberscount
      x-ms-examples:
        SMClientGroupsGetMembersCountGet:
          $ref: ./examples/ClientGroups/SMClientGroupsGetMembersCountGet.json
      description: Returns the approximate number of members in the client group.
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/WorkspaceNameParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/ClientGroupNameParameter'
      - name: startTime
        in: query
        required: false
        type: string
        format: date-time
        description: UTC date and time specifying the start time of an interval. When not specified the service uses DateTime.UtcNow - 10m
      - name: endTime
        in: query
        required: false
        type: string
        format: date-time
        description: UTC date and time specifying the end time of an interval. When not specified the service uses DateTime.UtcNow
      responses:
        '200':
          description: The operation completed successfully.
          schema:
            $ref: '#/definitions/ClientGroupMembersCount'
        default:
          description: An error occurred while processing the request. See the error.code parameter to identify the specific error.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Operationalinsights Workspaces Workspacename Features Servicemap Clientgroups Clientgroupname Memberscount
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/features/serviceMap/clientGroups/{clientGroupName}/members
  : get:
      tags:
      - Client Groups
      operationId: microsoftAzureClientgroupsListmembers
      x-ms-examples:
        SMClientGroupsListMembersGet:
          $ref: ./examples/ClientGroups/SMClientGroupsListMembersGet.json
      description: Returns the members of the client group during the specified time interval.
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/WorkspaceNameParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/ClientGroupNameParameter'
      - name: startTime
        in: query
        required: false
        type: string
        format: date-time
        description: UTC date and time specifying the start time of an interval. When not specified the service uses DateTime.UtcNow - 10m
      - name: endTime
        in: query
        required: false
        type: string
        format: date-time
        description: UTC date and time specifying the end time of an interval. When not specified the service uses DateTime.UtcNow
      - name: $top
        in: query
        required: false
        type: integer
        format: int32
        minimum: 1
        maximum: 200
        description: Page size to use. When not specified, the default page size is 100 records.
      responses:
        '200':
          description: The operation completed successfully.
          schema:
            $ref: '#/definitions/ClientGroupMembersCollection'
        default:
          description: An error occurred while processing the request. See the error.code parameter to identify the specific error.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Operationalinsights Workspaces Workspacename Features Servicemap Clientgroups Clientgroupname Members
definitions:
  ClientGroupMembersCollection:
    type: object
    description: Collection of ClientGroupMember resources.
    properties:
      value:
        type: array
        items:
          $ref: '#/definitions/ClientGroupMember'
        description: Collection of ClientGroupMember resources.
      nextLink:
        type: string
        description: The URL to the next set of resources.
  ErrorResponse:
    type: object
    description: An error response from the API.
    properties:
      error:
        $ref: '#/definitions/Error'
        description: Error information.
    required:
    - error
  ClientGroupMembersCount:
    description: Specifies the number of members in a client group.
    type: object
    properties:
      startTime:
        type: string
        format: date-time
        description: Membership interval start time.
      endTime:
        type: string
        format: date-time
        description: Membership interval start time.
      groupId:
        type: string
        description: Client Group URI.
      count:
        type: integer
        format: int32
        description: Number of members in the client group. Use this value together with the value of ```accuracy```. If accuracy is `exact` then the value represents the actual number of members in the cloud. When accuracy is `estimated`, the actual number of members is larger than the value of ```count```.
      accuracy:
        $ref: '#/definitions/Accuracy'
        description: Accuracy of the reported count.
    required:
    - startTime
    - endTime
    - groupId
    - count
    - accuracy
  ClientGroup:
    description: Represents a collection of clients of a resource. A client group can represent the clients of a port, process, or a machine.
    allOf:
    - $ref: '#/definitions/CoreResource'
    x-ms-discriminator-value: clientGroup
    properties:
      properties:
        x-ms-client-flatten: true
        type: object
        description: Resource properties.
        properties:
          clientsOf:
            $ref: '#/definitions/ResourceReference'
            description: Reference to the resource whose clients are represented by this group.
        required:
        - clientsOf
  ResourceReference:
    description: Represents a reference to another resource.
    discriminator: kind
    properties:
      id:
        type: string
        description: Resource URI.
      type:
        type: string
        description: Resource type qualifier.
        readOnly: true
      name:
        type: string
        description: Resource name.
        readOnly: true
      kind:
        type: string
        description: Specifies the sub-class of the reference.
        enum:
        - ref:machine
        - ref:machinewithhints
        - ref:process
        - ref:port
        - ref:onmachine
        - ref:clientgroup
    required:
    - id
    - kind
  Resource:
    description: Resource model definition.
    properties:
      id:
        type: string
        description: Resource identifier.
        readOnly: true
      type:
        type: string
        description: Resource type.
        readOnly: true
      name:
        type: string
        description: Resource name.
        readOnly: true
    x-ms-azure-resource: true
  CoreResource:
    description: Marker resource for the core Service Map resources
    allOf:
    - $ref: '#/definitions/Resource'
    discriminator: kind
    properties:
      etag:
        type: string
        description: Resource ETAG.
      kind:
        type: string
        description: Additional resource type qualifier.
        enum:
        - machine
        - process
        - port
        - clientGroup
        - machineGroup
    required:
    - kind
  ProcessReference:
    description: Reference to a process.
    allOf:
    - $ref: '#/definitions/ResourceReference'
    x-ms-discriminator-value: ref:process
    properties:
      properties:
        x-ms-client-flatten: true
        type: object
        description: Resource properties.
        properties:
          machine:
            $ref: '#/definitions/MachineReference'
            description: Machine hosting the process.
            readOnly: true
  ClientGroupMember:
    description: Represents a member of a client group
    allOf:
    - $ref: '#/definitions/Resource'
    properties:
      properties:
        x-ms-client-flatten: true
        type: object
        description: Resource properties.
        properties:
          ipAddress:
            type: string
            description: IP address.
          port:
            $ref: '#/definitions/PortReference'
            description: Port into which this client connected
          processes:
            type: array
            items:
              $ref: '#/definitions/ProcessReference'
            description: Processes accepting on the above port that received connections from this client.
  MachineReference:
    description: Reference to a machine.
    allOf:
    - $ref: '#/definitions/ResourceReference'
    x-ms-discriminator-value: ref:machine
  PortReference:
    description: Reference to a port.
    allOf:
    - $ref: '#/definitions/ResourceReference'
    x-ms-discriminator-value: ref:port
    properties:
      properties:
        x-ms-client-flatten: true
        type: object
        description: Resource properties.
        properties:
          machine:
            $ref: '#/definitions/MachineReference'
            description: Machine hosting the port.
            readOnly: true
          ipAddress:
            type: string
            description: IP address of the port.
            readOnly: true
          portNumber:
            type: integer
            format: int32
            description: Port number.
  Accuracy:
    description: Specifies the accuracy of a computation.
    type: string
    enum:
    - actual
    - estimated
    x-ms-enum:
      name: Accuracy
      modelAsString: false
  Error:
    type: object
    description: Error details.
    properties:
      code:
        type: string
        description: Error code identifying the specific error.
      message:
        type: string
        description: Error message in the caller's locale.
    required:
    - code
parameters:
  ClientGroupNameParameter:
    name: clientGroupName
    in: path
    x-ms-parameter-location: method
    required: true
    type: string
    description: Client Group resource name.
    minLength: 3
    maxLength: 256
  ApiVersionParameter:
    name: api-version
    in: query
    required: true
    type: string
    description: API version.
  WorkspaceNameParameter:
    name: workspaceName
    in: path
    x-ms-parameter-location: method
    required: true
    type: string
    description: OMS workspace containing the resources of interest.
    minLength: 3
    maxLength: 63
    pattern: '[a-zA-Z0-9_][a-zA-Z0-9_-]+[a-zA-Z0-9_]'
  SubscriptionIdParameter:
    name: subscriptionId
    in: path
    required: true
    type: string
    description: Azure subscription identifier.
  ResourceGroupNameParameter:
    name: resourceGroupName
    in: path
    x-ms-parameter-location: method
    required: true
    type: string
    description: Resource group name within the specified subscriptionId.
    maxLength: 64
    minLength: 1
    pattern: '[a-zA-Z0-9_-]+'
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'