Microsoft Azure Ports API

swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Ports API
schemes:
- https
tags:
- name: Ports
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/features/serviceMap/machines/{machineName}/ports
  : get:
      tags:
      - Ports
      operationId: microsoftAzureMachinesListports
      x-ms-examples:
        SMMachinesListPortsGet:
          $ref: ./examples/Machines/Ports/SMMachinesListPortsGet.json
      description: Returns a collection of live ports on the specified machine during the specified time interval.
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/WorkspaceNameParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/MachineNameParameter'
      - 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/PortCollection'
        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 Machines Machinename Ports
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/features/serviceMap/machines/{machineName}/ports/{portName}
  : get:
      tags:
      - Ports
      operationId: microsoftAzurePortsGet
      x-ms-examples:
        SMMachinesPortsGetGet:
          $ref: ./examples/Machines/Ports/SMMachinesPortsGetGet.json
      description: Returns the specified port. The port must be live during the specified time interval. If the port is not live during the interval, status 404 (Not Found) is returned.
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/WorkspaceNameParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/MachineNameParameter'
      - $ref: '#/parameters/PortNameParameter'
      - 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/Port'
        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 Machines Machinename Ports Portname
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/features/serviceMap/machines/{machineName}/ports/{portName}/liveness
  : get:
      tags:
      - Ports
      operationId: microsoftAzurePortsGetliveness
      x-ms-examples:
        SMMachinesPortsGetLivenessGet:
          $ref: ./examples/Machines/Ports/SMMachinesPortsGetLivenessGet.json
      description: Obtains the liveness status of the port during the specified time interval.
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/WorkspaceNameParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/MachineNameParameter'
      - $ref: '#/parameters/PortNameParameter'
      - 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/Liveness'
        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 Machines Machinename Ports Portname Liveness
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/features/serviceMap/machines/{machineName}/ports/{portName}/acceptingProcesses
  : get:
      tags:
      - Ports
      operationId: microsoftAzurePortsListacceptingprocesses
      x-ms-examples:
        SMMachinesPortsListAcceptingProcessesGet:
          $ref: ./examples/Machines/Ports/SMMachinesPortsListAcceptingProcessesGet.json
      description: Returns a collection of processes accepting on the specified port
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/WorkspaceNameParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/MachineNameParameter'
      - $ref: '#/parameters/PortNameParameter'
      - 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/ProcessCollection'
        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 Machines Machinename Ports Portname Acceptingprocesses
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/features/serviceMap/machines/{machineName}/ports/{portName}/connections
  : get:
      tags:
      - Ports
      operationId: microsoftAzurePortsListconnections
      x-ms-examples:
        SMMachinesPortsListConnectionsGet:
          $ref: ./examples/Machines/Ports/SMMachinesPortsListConnectionsGet.json
      description: Returns a collection of connections established via the specified port.
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/WorkspaceNameParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/MachineNameParameter'
      - $ref: '#/parameters/PortNameParameter'
      - 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/ConnectionCollection'
        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 Machines Machinename Ports Portname Connections
definitions:
  ConnectionCollection:
    type: object
    description: Collection of Connection resources.
    properties:
      value:
        type: array
        items:
          $ref: '#/definitions/Connection'
        description: Collection of Connection resources.
      nextLink:
        type: string
        description: The URL to the next set of resources.
  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
  Relationship:
    description: A typed relationship between two entities.
    allOf:
    - $ref: '#/definitions/Resource'
    discriminator: kind
    properties:
      kind:
        type: string
        description: Additional resource type qualifier.
        enum:
        - rel:connection
        - rel:acceptor
    required:
    - kind
  MachineReference:
    description: Reference to a machine.
    allOf:
    - $ref: '#/definitions/ResourceReference'
    x-ms-discriminator-value: ref:machine
  ProcessDetails:
    description: Describes process metadata.
    properties:
      persistentKey:
        type: string
        description: A unique identifier for a process, generally resilient to process restart, computed by Service Map.
      poolId:
        type: integer
        format: int32
        description: Represents the identity of the process pool assigned to the process by Dependency Agent.
      firstPid:
        type: integer
        format: int32
        description: The Operating System Process Identifier (PID) of the first process in this process pool.
      description:
        type: string
        description: Process description.
      companyName:
        type: string
        description: Name of company that created the process executable.
      internalName:
        type: string
        description: Internal process name.
      productName:
        type: string
        description: Product name.
      productVersion:
        type: string
        description: Product version.
      fileVersion:
        type: string
        description: File version.
      commandLine:
        type: string
        description: Process command line.
      executablePath:
        type: string
        description: Process executable path.
      workingDirectory:
        type: string
        description: Process workingDirectory.
      services:
        type: array
        items:
          $ref: '#/definitions/ProcessHostedService'
        x-ms-identifiers: []
        description: Collection of services hosted by this Process (Windows only).
      zoneName:
        type: string
        description: Process zone name (Linux only).
  Connection:
    description: A network connection.
    allOf:
    - $ref: '#/definitions/Relationship'
    x-ms-discriminator-value: rel:connection
    properties:
      properties:
        x-ms-client-flatten: true
        $ref: '#/definitions/ConnectionProperties'
  ConnectionFailureState:
    description: "Connection failure state:\n * ```ok``` indicates no failures\n * ```failed``` indicates only failures\n * ```mixed``` indicates both failures and successes"
    type: string
    enum:
    - ok
    - failed
    - mixed
    x-ms-enum:
      name: ConnectionFailureState
      modelAsString: false
  Port:
    description: A port resource represents a server port on a machine. The port may be actively *monitored*, i.e., a Dependency Agent is running on its machine, or *discovered*, i.e., its existence was inferred by observing the data stream from monitored machines. A port is live during an interval of time, if that port had associated activity during (parts) of that interval.
    allOf:
    - $ref: '#/definitions/CoreResource'
    x-ms-discriminator-value: port
    properties:
      properties:
        x-ms-client-flatten: true
        type: object
        description: Resource properties.
        properties:
          monitoringState:
            $ref: '#/definitions/MonitoringState'
            description: Specifies whether the port is actively monitored or discovered.
          machine:
            $ref: '#/definitions/ResourceReference'
            description: Machine hosting this port.
          displayName:
            type: string
            description: Name to use for display purposes.
          ipAddress:
            type: string
            description: IP address associated with the port. At present only IPv4 addresses are supported.
          portNumber:
            type: integer
            format: int32
            description: Port number.
  ProcessHostingConfiguration:
    description: Describes the hosting configuration of a process.
    discriminator: kind
    properties:
      provider:
        type: string
        description: The hosting provider of the VM.
        enum:
        - azure
      kind:
        type: string
        description: Additional hosting configuration type qualifier.
        enum:
        - provider:azure
    required:
    - kind
  ProcessUser:
    description: Describes the user under which a process is running.
    properties:
      userName:
        type: string
        description: User name under which the process is running.
      userDomain:
        type: string
        description: Domain name for the user.
  Liveness:
    description: Specifies the contents of a check liveness response.
    type: object
    properties:
      startTime:
        type: string
        format: date-time
        description: Liveness interval start time.
      endTime:
        type: string
        format: date-time
        description: Liveness interval end time.
      live:
        type: boolean
        description: '`true` if the resource is live during [startTime, endTime], `false` otherwise'
    required:
    - startTime
    - endTime
    - live
  Process:
    description: A process resource represents a process running on a machine. The process may be actively *monitored*, i.e., a Dependency Agent is running on its machine, or *discovered*, i.e., its existence was inferred by observing the data stream from monitored machines. A process resource represents a pool of actual operating system resources that share command lines and metadata. As the process pool evolves over time, prior versions of the process resource are preserved and available for access. A process is live during an interval of time, if that process is executing during (parts) of that interval
    allOf:
    - $ref: '#/definitions/CoreResource'
    x-ms-discriminator-value: process
    properties:
      properties:
        x-ms-client-flatten: true
        type: object
        description: Resource properties.
        properties:
          timestamp:
            type: string
            format: date-time
            description: UTC date and time when this process resource was updated in the system
          monitoringState:
            $ref: '#/definitions/MonitoringState'
            description: Specifies whether the process is actively monitored or discovered.
          machine:
            $ref: '#/definitions/ResourceReference'
            description: Machine hosting this process.
          executableName:
            type: string
            description: The name of the process executable
          displayName:
            type: string
            description: Name to use for display purposes
          startTime:
            type: string
            format: date-time
            description: UTC date and time when the process started
          role:
            type: string
            enum:
            - webServer
            - appServer
            - databaseServer
            - ldapServer
            - smbServer
            x-ms-enum:
              name: ProcessRole
              modelAsString: true
            description: The inferred role of this process based on its name, command line, etc.
          group:
            type: string
            description: The name of the product or suite of the process. The group is determined by its executable name, command line, etc.
          details:
            $ref: '#/definitions/ProcessDetails'
            description: Process metadata (command line, product name, etc.).
          user:
            $ref: '#/definitions/ProcessUser'
            description: Information about the account under which the process is executing.
          clientOf:
            $ref: '#/definitions/ResourceReference'
            description: Present only for a discovered process acting as a client of a monitored process/machine/port. References the monitored process/machine/port that this process is a client of.
          acceptorOf:
            $ref: '#/definitions/ResourceReference'
            description: Present only for a discovered process acting as a server. References the port on which the discovered process is accepting.
          hosting:
            $ref: '#/definitions/ProcessHostingConfiguration'
            description: Information about the hosting environment
  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.
  PortCollection:
    type: object
    description: Collection of Port resources.
    properties:
      value:
        type: array
        items:
          $ref: '#/definitions/Port'
        description: Collection of Port resources.
      nextLink:
        type: string
        description: The URL to the next set of resources.
  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
  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
  ProcessCollection:
    type: object
    description: Collection of Process resources.
    properties:
      value:
        type: array
        items:
          $ref: '#/definitions/Process'
        description: Collection of Process 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
  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
  ProcessHostedService:
    description: A service hosted by a process.
    properties:
      name:
        type: string
        description: The name of the service.
      displayName:
        type: string
        description: The service's display name.
  MonitoringState:
    description: Used to specify if a resources is monitored or discovered.
    type: string
    enum:
    - monitored
    - discovered
    x-ms-enum:
      name: MonitoringState
      modelAsString: false
  RelationshipProperties:
    description: Relationship properties.
    properties:
      source:
        $ref: '#/definitions/ResourceReference'
        description: Source resource of the relationship.
      destination:
        $ref: '#/definitions/ResourceReference'
        description: Destination resource of the relationship.
      startTime:
        type: string
        format: date-time
        description: Relationship start time.
      endTime:
        type: string
        format: date-time
        description: Relationship end time.
    required:
    - source
    - destination
  ConnectionProperties:
    description: Properties for a connection resource.
    allOf:
    - $ref: '#/definitions/RelationshipProperties'
    properties:
      serverPort:
        $ref: '#/definitions/PortReference'
        description: Reference to the server port via which this connection has been established.
      failureState:
        $ref: '#/definitions/ConnectionFailureState'
        description: Specifies whether there are only successful, failed or a mixture of both connections represented by this resource.
parameters:
  ApiVersionParameter:
    name: api-version
    in: query
    required: true
    type: string
    description: API version.
  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_-]+'
  MachineNameParameter:
    name: machineName
    in: path
    x-ms-parameter-location: method
    required: true
    type: string
    description: Machine resource name.
    minLength: 3
    maxLength: 64
  SubscriptionIdParameter:
    name: subscriptionId
    in: path
    required: true
    type: string
    description: Azure subscription identifier.
  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_]'
  PortNameParameter:
    name: portName
    in: path
    x-ms-parameter-location: method
    required: true
    type: string
    description: Port resource name.
    minLength: 3
    maxLength: 64
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'