Microsoft Azure MachineGroups API

openapi: 3.2.0
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Machine Groups API
tags:
- name: MachineGroups
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/features/serviceMap/machines/{machineName}/machineGroups
  : get:
      tags:
      - MachineGroups
      operationId: microsoftAzureMachinesListmachinegroupmembership
      x-ms-examples:
        SMMachinesListMachineGroupMembershipGet:
          $ref: ./examples/Machines/MachineGroups/SMMachinesListMachineGroupMembershipGet.json
      description: Returns a collection of machine groups this machine belongs to during the specified time interval.
      parameters:
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - $ref: '#/components/parameters/WorkspaceNameParameter'
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/MachineNameParameter'
      - name: startTime
        in: query
        required: false
        description: UTC date and time specifying the start time of an interval. When not specified the service uses DateTime.UtcNow - 10m
        schema:
          type: string
          format: date-time
      - name: endTime
        in: query
        required: false
        description: UTC date and time specifying the end time of an interval. When not specified the service uses DateTime.UtcNow
        schema:
          type: string
          format: date-time
      responses:
        '200':
          description: The operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MachineGroupCollection'
        default:
          description: An error occurred while processing the request. See the error.code parameter to identify the specific error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Operationalinsights Workspaces Workspacename Features Servicemap Machines Machinename Machinegroups
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/features/serviceMap/machineGroups
  : get:
      tags:
      - MachineGroups
      operationId: microsoftAzureMachinegroupsListbyworkspace
      x-ms-examples:
        SMMachineGroupsListByWorkspaceGet:
          $ref: ./examples/MachineGroups/SMMachineGroupsListByWorkspaceGet.json
      description: Returns all machine groups during the specified time interval.
      parameters:
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - $ref: '#/components/parameters/WorkspaceNameParameter'
      - $ref: '#/components/parameters/ApiVersionParameter'
      - name: startTime
        in: query
        required: false
        description: UTC date and time specifying the start time of an interval. When not specified the service uses DateTime.UtcNow - 10m
        schema:
          type: string
          format: date-time
      - name: endTime
        in: query
        required: false
        description: UTC date and time specifying the end time of an interval. When not specified the service uses DateTime.UtcNow
        schema:
          type: string
          format: date-time
      responses:
        '200':
          description: The operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MachineGroupCollection'
        default:
          description: An error occurred while processing the request. See the error.code parameter to identify the specific error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Operationalinsights Workspaces Workspacename Features Servicemap Machinegroups
    post:
      tags:
      - MachineGroups
      operationId: microsoftAzureMachinegroupsCreate
      x-ms-examples:
        SMMachineGroupsCreatePost:
          $ref: ./examples/MachineGroups/SMMachineGroupsCreatePost.json
      description: Creates a new machine group.
      parameters:
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - $ref: '#/components/parameters/WorkspaceNameParameter'
      - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '201':
          description: The operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MachineGroup'
        default:
          description: An error occurred while processing the request. See the error.code parameter to identify the specific error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Operationalinsights Workspaces Workspacename Features Servicemap Machinegroups
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MachineGroup'
        description: Machine Group resource to create.
        required: true
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/features/serviceMap/machineGroups/{machineGroupName}
  : get:
      tags:
      - MachineGroups
      operationId: microsoftAzureMachinegroupsGet
      x-ms-examples:
        SMMachineGroupsGetGet:
          $ref: ./examples/MachineGroups/SMMachineGroupsGetGet.json
      description: Returns the specified machine group as it existed during the specified time interval.
      parameters:
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - $ref: '#/components/parameters/WorkspaceNameParameter'
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/MachineGroupNameParameter'
      - name: startTime
        in: query
        required: false
        description: UTC date and time specifying the start time of an interval. When not specified the service uses DateTime.UtcNow - 10m
        schema:
          type: string
          format: date-time
      - name: endTime
        in: query
        required: false
        description: UTC date and time specifying the end time of an interval. When not specified the service uses DateTime.UtcNow
        schema:
          type: string
          format: date-time
      responses:
        '200':
          description: The operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MachineGroup'
        default:
          description: An error occurred while processing the request. See the error.code parameter to identify the specific error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Operationalinsights Workspaces Workspacename Features Servicemap Machinegroups Machinegroupname
    put:
      tags:
      - MachineGroups
      operationId: microsoftAzureMachinegroupsUpdate
      x-ms-examples:
        SMMachineGroupsUpdatePut:
          $ref: ./examples/MachineGroups/SMMachineGroupsUpdatePut.json
      description: Updates a machine group.
      parameters:
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - $ref: '#/components/parameters/WorkspaceNameParameter'
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/MachineGroupNameParameter'
      responses:
        '200':
          description: The operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MachineGroup'
        default:
          description: An error occurred while processing the request. See the error.code parameter to identify the specific error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Operationalinsights Workspaces Workspacename Features Servicemap Machinegroups Machinegroupname
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MachineGroup'
        description: Machine Group resource to update.
        required: true
    delete:
      tags:
      - MachineGroups
      operationId: microsoftAzureMachinegroupsDelete
      x-ms-examples:
        SMMachineGroupsDeleteDelete:
          $ref: ./examples/MachineGroups/SMMachineGroupsDeleteDelete.json
      description: Deletes the specified Machine Group.
      parameters:
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - $ref: '#/components/parameters/WorkspaceNameParameter'
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/MachineGroupNameParameter'
      responses:
        '204':
          description: The operation completed successfully.
        default:
          description: An error occurred while processing the request. See the error.code parameter to identify the specific error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Operationalinsights Workspaces Workspacename Features Servicemap Machinegroups Machinegroupname
components:
  schemas:
    ErrorResponse:
      type: object
      description: An error response from the API.
      properties:
        error:
          $ref: '#/components/schemas/Error'
          description: Error information.
      required:
      - error
    CoreResource:
      description: Marker resource for the core Service Map resources
      allOf:
      - $ref: '#/components/schemas/Resource'
      discriminator:
        propertyName: kind
      properties:
        etag:
          type: string
          description: Resource ETAG.
        kind:
          type: string
          description: Additional resource type qualifier.
          enum:
          - machine
          - process
          - port
          - clientGroup
          - machineGroup
      required:
      - kind
    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
    OperatingSystemFamily:
      description: Specifies the operating system family, e.g., Linux, Windows, etc.
      type: string
      enum:
      - unknown
      - windows
      - linux
      - solaris
      - aix
      x-ms-enum:
        name: OperatingSystemFamily
        modelAsString: false
    MachineGroup:
      description: A user-defined logical grouping of machines.
      allOf:
      - $ref: '#/components/schemas/CoreResource'
      x-ms-discriminator-value: machineGroup
      properties:
        etag:
          type: string
          description: Resource ETAG.
        properties:
          x-ms-client-flatten: true
          type: object
          description: Resource properties.
          properties:
            groupType:
              type: string
              enum:
              - unknown
              - azure-cs
              - azure-sf
              - azure-vmss
              - user-static
              x-ms-enum:
                name: MachineGroupType
                modelAsString: true
              description: Type of the machine group
            displayName:
              type: string
              description: User defined name for the group
              minLength: 1
              maxLength: 256
            count:
              type: integer
              format: int32
              description: Count of machines in this group. The value of count may be bigger than the number of machines in case of the group has been truncated due to exceeding the max number of machines a group can handle.
            machines:
              type: array
              items:
                $ref: '#/components/schemas/MachineReferenceWithHints'
              description: References of the machines in this group. The hints within each reference do not represent the current value of the corresponding fields. They are a snapshot created during the last time the machine group was updated.
          required:
          - displayName
    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
    MachineReferenceWithHints:
      description: A machine reference with a hint of the machine's name and operating system.
      allOf:
      - $ref: '#/components/schemas/ResourceReference'
      x-ms-discriminator-value: ref:machinewithhints
      properties:
        properties:
          x-ms-client-flatten: true
          type: object
          description: Machine reference with name and os hints.
          properties:
            displayNameHint:
              description: Last known display name.
              type: string
              readOnly: true
            osFamilyHint:
              description: Last known operating system family.
              $ref: '#/components/schemas/OperatingSystemFamily'
              readOnly: true
    MachineGroupCollection:
      type: object
      description: Collection of Machine Group resources.
      properties:
        value:
          type: array
          items:
            $ref: '#/components/schemas/MachineGroup'
          description: Collection of Machine Group resources.
        nextLink:
          type: string
          description: The URL to the next set of resources.
    ResourceReference:
      description: Represents a reference to another resource.
      discriminator:
        propertyName: 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
  parameters:
    MachineNameParameter:
      name: machineName
      in: path
      x-ms-parameter-location: method
      required: true
      description: Machine resource name.
      schema:
        type: string
        maxLength: 64
        minLength: 3
    ApiVersionParameter:
      name: api-version
      in: query
      required: true
      description: API version.
      schema:
        type: string
    WorkspaceNameParameter:
      name: workspaceName
      in: path
      x-ms-parameter-location: method
      required: true
      description: OMS workspace containing the resources of interest.
      schema:
        type: string
        maxLength: 63
        minLength: 3
        pattern: '[a-zA-Z0-9_][a-zA-Z0-9_-]+[a-zA-Z0-9_]'
    SubscriptionIdParameter:
      name: subscriptionId
      in: path
      required: true
      description: Azure subscription identifier.
      schema:
        type: string
    ResourceGroupNameParameter:
      name: resourceGroupName
      in: path
      x-ms-parameter-location: method
      required: true
      description: Resource group name within the specified subscriptionId.
      schema:
        type: string
        maxLength: 64
        minLength: 1
        pattern: '[a-zA-Z0-9_-]+'
    MachineGroupNameParameter:
      name: machineGroupName
      in: path
      x-ms-parameter-location: method
      required: true
      description: Machine Group resource name.
      schema:
        type: string
        maxLength: 36
        minLength: 36
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/components/parameters/Endpoint'