swagger: '2.0' info: version: 2020-08-01-preview title: Microsoft Azure AccessControlClient AccessConnector Machines API schemes: - https tags: - name: Machines paths: ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/migrateProjects/{migrateProjectName}/machines : get: tags: - Machines summary: Microsoft Azure Gets A List Of Machines In The Migrate Project operationId: microsoftAzureMachinesEnumeratemachines parameters: - $ref: '#/parameters/subscriptionId' - $ref: '#/parameters/resourceGroupName' - $ref: '#/parameters/migrateProjectName' - $ref: '#/parameters/api-version' - $ref: '#/parameters/continuationToken' - $ref: '#/parameters/pageSize' responses: '200': description: OK schema: $ref: '#/definitions/MachineCollection' deprecated: false x-ms-examples: Machines_List: $ref: ./examples/Machines_List.json description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/migrateProjects/{migrateProjectName}/machines/{machineName} : get: tags: - Machines summary: Microsoft Azure Gets A Machine In The Migrate Project operationId: microsoftAzureMachinesGetmachine parameters: - $ref: '#/parameters/subscriptionId' - $ref: '#/parameters/resourceGroupName' - $ref: '#/parameters/migrateProjectName' - $ref: '#/parameters/api-version' - $ref: '#/parameters/machineName' responses: '200': description: OK schema: $ref: '#/definitions/Machine' deprecated: false x-ms-examples: Machines_Get: $ref: ./examples/Machines_Get.json description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/features/serviceMap/machines : get: tags: - Machines operationId: microsoftAzureMachinesListbyworkspace x-ms-examples: SMMachinesListByWorkspaceGet: $ref: ./examples/Machines/SMMachinesListByWorkspaceGet.json description: Returns a collection of machines matching the specified conditions. The returned collection represents either machines that are active/live during the specified interval of time (`live=true` and `startTime`/`endTime` are specified) or that are known to have existed at or some time prior to the specified point in time (`live=false` and `timestamp` is specified). parameters: - $ref: '#/parameters/SubscriptionIdParameter' - $ref: '#/parameters/ResourceGroupNameParameter' - $ref: '#/parameters/WorkspaceNameParameter' - $ref: '#/parameters/ApiVersionParameter' - name: live in: query required: false type: boolean default: true description: Specifies whether to return live resources (true) or inventory resources (false). Defaults to **true**. When retrieving live resources, the start time (`startTime`) and end time (`endTime`) of the desired interval should be included. When retrieving inventory resources, an optional timestamp (`timestamp`) parameter can be specified to return the version of each resource closest (not-after) that timestamp. - 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: timestamp in: query required: false type: string format: date-time description: UTC date and time specifying a time instance relative to which to evaluate each machine resource. Only applies when `live=false`. 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/MachineCollection_2' 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 ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/features/serviceMap/machines/{machineName} : get: tags: - Machines operationId: microsoftAzureMachinesGet x-ms-examples: SMMachinesGetGet: $ref: ./examples/Machines/SMMachinesGetGet.json description: Returns the specified machine. parameters: - $ref: '#/parameters/SubscriptionIdParameter' - $ref: '#/parameters/ResourceGroupNameParameter' - $ref: '#/parameters/WorkspaceNameParameter' - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/MachineNameParameter' - name: timestamp in: query required: false type: string format: date-time description: UTC date and time specifying a time instance relative to which to evaluate the machine resource. When not specified, the service uses DateTime.UtcNow. responses: '200': description: The operation completed successfully. schema: $ref: '#/definitions/Machine_2' 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 ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/features/serviceMap/machines/{machineName}/liveness : get: tags: - Machines operationId: microsoftAzureMachinesGetliveness x-ms-examples: SMMachinesGetLivenessGet: $ref: ./examples/Machines/SMMachinesGetLivenessGet.json description: Obtains the liveness status of the 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/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 Liveness ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/features/serviceMap/machines/{machineName}/connections : get: tags: - Machines operationId: microsoftAzureMachinesListconnections x-ms-examples: SMMachinesListConnectionsGet: $ref: ./examples/Machines/SMMachinesListConnectionsGet.json description: Returns a collection of connections terminating or originating at the specified machine 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/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 Connections ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/features/serviceMap/machines/{machineName}/processes : get: tags: - Machines operationId: microsoftAzureMachinesListprocesses x-ms-examples: SMMachinesListProcessesGet: $ref: ./examples/Machines/Processes/SMMachinesListProcessesGet.json description: 'Returns a collection of processes on the specified machine matching the specified conditions. The returned collection represents either processes that are active/live during the specified interval of time (`live=true` and `startTime`/`endTime` are specified) or that are known to have existed at or some time prior to the specified point in time (`live=false` and `timestamp` is specified). ' parameters: - $ref: '#/parameters/SubscriptionIdParameter' - $ref: '#/parameters/ResourceGroupNameParameter' - $ref: '#/parameters/WorkspaceNameParameter' - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/MachineNameParameter' - name: live in: query required: false type: boolean default: true description: Specifies whether to return live resources (true) or inventory resources (false). Defaults to **true**. When retrieving live resources, the start time (`startTime`) and end time (`endTime`) of the desired interval should be included. When retrieving inventory resources, an optional timestamp (`timestamp`) parameter can be specified to return the version of each resource closest (not-after) that timestamp. - 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: timestamp in: query required: false type: string format: date-time description: UTC date and time specifying a time instance relative to which to evaluate all process resource. Only applies when `live=false`. 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 Processes ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/features/serviceMap/machines/{machineName}/ports : get: tags: - Machines 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}/machineGroups : get: tags: - Machines 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: '#/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/MachineGroupCollection' 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 Machinegroups 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. Machine: description: Machine REST resource. type: object properties: id: description: Gets or sets the relative URL to get to this REST resource. type: string name: description: Gets or sets the name of this REST resource. type: string type: description: Gets the type of this REST resource. type: string readOnly: true properties: $ref: '#/definitions/MachineProperties' description: Gets or sets the properties of the machine. Ipv4NetworkInterface: description: Describes an IPv4 network interface. properties: ipAddress: type: string description: IPv4 address. subnetMask: type: string default: 255.255.255.255 description: IPv4 subnet mask. required: - ipAddress HypervisorConfiguration: description: Describes the hypervisor configuration of a machine. properties: hypervisorType: $ref: '#/definitions/HypervisorType' description: Specifies the virtualization technology used by the hypervisor (hyperv, vmware, etc.) nativeHostMachineId: type: string description: The unique identifier of the hypervisor machine as reported by the underlying virtualization system. Bitness: description: Specifies the bitness of a machine or process. type: string enum: - 32bit - 64bit x-ms-enum: name: Bitness modelAsString: false Timezone: description: Describes a timezone. properties: fullName: type: string description: Timezone full name. DiscoveryDetails: description: Discovery properties that can be published by various ISVs. type: object properties: osType: description: Gets or sets the OS type. type: string osName: description: Gets or sets the OS name. type: string osVersion: description: Gets or sets the OS version. type: string enqueueTime: description: Gets or sets the time the message was enqueued. type: string solutionName: description: Gets or sets the name of the solution that sent the data. type: string machineId: description: Gets or sets the unique identifier of the machine. type: string machineManagerId: description: Gets or sets the unique identifier of the virtual machine manager(vCenter/VMM). type: string fabricType: description: Gets or sets the fabric type. type: string lastUpdatedTime: format: date-time description: Gets or sets the time of the last modification of the machine details. type: string machineName: description: Gets or sets the name of the machine. type: string ipAddresses: description: Gets or sets the list of IP addresses of the machine. IP addresses could be IP V4 or IP V6. type: array items: type: string fqdn: description: Gets or sets the FQDN of the machine. type: string biosId: description: Gets or sets the BIOS ID of the machine. type: string macAddresses: description: Gets or sets the list of MAC addresses of the machine. type: array items: type: string extendedInfo: description: Gets or sets the ISV specific extended information. type: object additionalProperties: type: string MachineCollection_2: type: object description: Collection of Machine resources. properties: value: type: array items: $ref: '#/definitions/Machine_2' description: Collection of Machine 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 VirtualizationState: description: Specifies if the machine is physical, virtual, hypervisor, or unknown. type: string enum: - unknown - physical - virtual - hypervisor x-ms-enum: name: VirtualizationState modelAsString: false 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). MachineGroupCollection: type: object description: Collection of Machine Group resources. properties: value: type: array items: $ref: '#/definitions/MachineGroup' description: Collection of Machine Group resources. nextLink: type: string description: The URL to the next set of resources. MachineReference: description: Reference to a machine. allOf: - $ref: '#/definitions/ResourceReference' x-ms-discriminator-value: ref:machine 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 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 MigrationDetails: description: Migration properties that can be shared by various publishers. type: object properties: migrationPhase: description: Gets or sets the phase of migration of the machine. type: string migrationTested: description: Gets or sets a value indicating whether migration was tested on the machine. type: boolean replicationProgressPercentage: format: int32 description: Gets or sets the progress percentage of migration on the machine. type: integer targetVMArmId: description: Gets or sets the ARM id the migrated VM. type: string enqueueTime: description: Gets or sets the time the message was enqueued. type: string solutionName: description: Gets or sets the name of the solution that sent the data. type: string machineId: description: Gets or sets the unique identifier of the machine. type: string machineManagerId: description: Gets or sets the unique identifier of the virtual machine manager(vCenter/VMM). type: string fabricType: description: Gets or sets the fabric type. type: string lastUpdatedTime: format: date-time description: Gets or sets the time of the last modification of the machine details. type: string machineName: description: Gets or sets the name of the machine. type: string ipAddresses: description: Gets or sets the list of IP addresses of the machine. IP addresses could be IP V4 or IP V6. type: array items: type: string fqdn: description: Gets or sets the FQDN of the machine. type: string biosId: description: Gets or sets the BIOS ID of the machine. type: string macAddresses: description: Gets or sets the list of MAC addresses of the machine. type: array items: type: string extendedInfo: description: Gets or sets the ISV specific extended information. type: object additionalProperties: type: string 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. MachineResourcesConfiguration: description: Describes the resources of a machine. properties: physicalMemory: type: integer format: int32 description: Physical memory in megabytes (MB). cpus: type: integer format: int32 description: Number of CPUs. cpuSpeed: type: integer format: int32 description: CPU speed in megahertz (Mhz). cpuSpeedAccuracy: $ref: '#/definitions/Accuracy' description: Describes the accuracy of the cpuSpeed field. MachineProperties: description: Properties of the machine resource. type: object properties: discoveryData: description: Gets or sets the discovery details of the machine published by various sources. type: array items: $ref: '#/definitions/DiscoveryDetails' x-ms-identifiers: - machineId assessmentData: description: Gets or sets the assessment details of the machine published by various sources. type: array items: $ref: '#/definitions/AssessmentDetails' x-ms-identifiers: - assessmentId migrationData: description: Gets or sets the migration details of the machine published by various sources. type: array items: $ref: '#/definitions/MigrationDetails' x-ms-identifiers: [] lastUpdatedTime: format: date-time description: Gets or sets the time of the last modification of the machine. type: string MachineGroup: description: A user-defined logical grouping of machines. allOf: - $ref: '#/definitions/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: '#/definitions/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 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 AgentConfiguration: description: Describes the configuration of the Dependency Agent installed on a machine. properties: agentId: type: string description: Health Service Agent unique identifier. dependencyAgentId: type: string description: Dependency Agent unique identifier. dependencyAgentVersion: type: string description: Dependency Agent version number. dependencyAgentRevision: type: string description: Dependency Agent revision number. rebootStatus: $ref: '#/definitions/MachineRebootStatus' description: Specifies whether the machine has been rebooted since the Dependency Agent installation. clockGranularity: type: integer format: int32 description: Machine clock granularity in milliseconds. required: - agentId 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 HostingConfiguration: description: Describes the hosting configuration of a machine. 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 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. 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. NetworkConfiguration: description: Describes the network configuration of a machine. properties: ipv4Interfaces: type: array items: $ref: '#/definitions/Ipv4NetworkInterface' x-ms-identifiers: - ipAddress - subnetMask description: IPv4 interfaces. ipv6Interfaces: type: array items: $ref: '#/definitions/Ipv6NetworkInterface' x-ms-identifiers: - ipAddress description: IPv6 interfaces. defaultIpv4Gateways: type: array items: type: string description: IPv4 address. description: Default IPv4 gateways. macAddresses: type: array items: type: string description: MAC address. description: MAC addresses of all active network interfaces. dnsNames: type: array items: type: string description: DNS name. description: DNS names associated with the machine. 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 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 HypervisorType: description: Specifies the hypervisor type of a machine. type: string enum: - unknown - hyperv x-ms-enum: name: HypervisorType modelAsString: false 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 MachineRebootStatus: description: Specifies if the machine has been rebooted since the installation of the dependency agent. type: string enum: - unknown - rebooted - notRebooted x-ms-enum: name: MachineRebootStatus modelAsString: false 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 MachineCollection: description: Collection of machines. type: object properties: value: description: Gets or sets the machines. type: array items: $ref: '#/definitions/Machine' nextLink: description: Gets or sets the value of nextLink. type: string Ipv6NetworkInterface: description: Describes an IPv6 network interface. properties: ipAddress: type: string description: IPv6 address. required: - ipAddress VirtualMachineType: description: Specifies the virtualization type of a machine. type: string enum: - unknown - hyperv - ldom - lpar - vmware - virtualPc - xen x-ms-enum: name: VirtualMachineType modelAsString: false OperatingSystemConfiguration: description: Describes the configuration of the operating system of a machine. properties: family: $ref: '#/definitions/OperatingSystemFamily' description: Windows, Linux, etc. fullName: type: string description: Operating system full name. bitness: $ref: '#/definitions/Bitness' description: Operating system bitness (32-bit or 64-bit). required: - family - fullName - bitness 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 VirtualMachineConfiguration: description: Describes the virtualization-related configuration of a machine. properties: virtualMachineType: $ref: '#/definitions/VirtualMachineType' description: Specifies the virtualization technology used by the machine (hyperv, vmware, etc.) nativeMachineId: type: string description: The unique identifier of the virtual machine as reported by the underlying virtualization system. virtualMachineName: type: string description: The Name of the virtual machine. nativeHostMachineId: type: string description: The unique identifier of the host of this virtual machine as reported by the underlying virtualization system. Machine_2: description: A machine resource represents a discovered computer system. It can be *monitored*, i.e., a Dependency Agent is running on it, or *discovered*, i.e., its existence was inferred by observing the data stream from monitored machines. As machines change, prior versions of the machine resource are preserved and available for access. A machine is live during an interval of time, if either its Dependency Agent has reported data during (parts) of that interval, or a Dependency agent running on other machines has reported activity associated with the machine. allOf: - $ref: '#/definitions/CoreResource' x-ms-discriminator-value: machine 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 resource was updated in the system. monitoringState: $ref: '#/definitions/MonitoringState' description: Specifies whether the machine is actively monitored or discovered. virtualizationState: $ref: '#/definitions/VirtualizationState' description: Specifies whether the machine is virtualized. displayName: type: string description: Name to use for display purposes computerName: type: string description: Name of the machine, e.g., server fullyQualifiedDomainName: type: string description: Fully-qualified name of the machine, e.g., server.company.com bootTime: type: string format: date-time description: UTC date and time when the machine last booted timezone: $ref: '#/definitions/Timezone' description: Timezone of the machine. agent: $ref: '#/definitions/AgentConfiguration' description: Dependency Agent configuration. resources: $ref: '#/definitions/MachineResourcesConfiguration' description: Machine resources (memory, cpu, etc.). networking: $ref: '#/definitions/NetworkConfiguration' description: Network configuration (ips, gateways, dns, etc.) operatingSystem: $ref: '#/definitions/OperatingSystemConfiguration' description: Operating system information. virtualMachine: $ref: '#/definitions/VirtualMachineConfiguration' description: Virtualization-related configuration. Present only when `virtualizationState` is `virtual`. hypervisor: $ref: '#/definitions/HypervisorConfiguration' description: Hypervisor-related configuration. Present only when 'virtualizationState' is `hypervisor`. hosting: $ref: '#/definitions/HostingConfiguration' description: Hosting-related configuration. Present if hosting information is discovered for the VM. MachineReferenceWithHints: description: A machine reference with a hint of the machine's name and operating system. allOf: - $ref: '#/definitions/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: '#/definitions/OperatingSystemFamily' readOnly: true AssessmentDetails: description: Assessment properties that can be shared by various publishers. type: object properties: assessmentId: description: Gets or sets the id of the assessment done on the machine. type: string targetVMSize: description: Gets or sets the target VM size. type: string targetVMLocation: description: Gets or sets the target VM location. type: string targetStorageType: description: Gets or sets the target storage type. type: object additionalProperties: type: string enqueueTime: description: Gets or sets the time the message was enqueued. type: string solutionName: description: Gets or sets the name of the solution that sent the data. type: string machineId: description: Gets or sets the unique identifier of the machine. type: string machineManagerId: description: Gets or sets the unique identifier of the virtual machine manager(vCenter/VMM). type: string fabricType: description: Gets or sets the fabric type. type: string lastUpdatedTime: format: date-time description: Gets or sets the time of the last modification of the machine details. type: string machineName: description: Gets or sets the name of the machine. type: string ipAddresses: description: Gets or sets the list of IP addresses of the machine. IP addresses could be IP V4 or IP V6. type: array items: type: string fqdn: description: Gets or sets the FQDN of the machine. type: string biosId: description: Gets or sets the BIOS ID of the machine. type: string macAddresses: description: Gets or sets the list of MAC addresses of the machine. type: array items: type: string extendedInfo: description: Gets or sets the ISV specific extended information. type: object additionalProperties: type: string 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: migrateProjectName: name: migrateProjectName description: Name of the Azure Migrate project. type: string in: path x-ms-parameter-location: method required: true ApiVersionParameter: name: api-version in: query required: true type: string description: API version. resourceGroupName: name: resourceGroupName description: Name of the Azure Resource Group that migrate project is part of. type: string in: path x-ms-parameter-location: method required: true api-version: name: api-version description: Standard request header. Used by service to identify API version used by client. type: string in: query required: true enum: - 2018-09-01-preview 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 subscriptionId: name: subscriptionId description: Azure Subscription Id in which migrate project was created. type: string in: path required: true SubscriptionIdParameter: name: subscriptionId in: path required: true type: string description: Azure subscription identifier. continuationToken: name: continuationToken description: The continuation token. type: string in: query required: false x-ms-parameter-location: method 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_]' machineName: name: machineName description: Unique name of a machine in Azure migration hub. type: string in: path x-ms-parameter-location: method required: true pageSize: name: pageSize description: The number of items to be returned in a single page. This value is honored only if it is less than the 100. type: integer in: query required: false x-ms-parameter-location: method x-ms-parameterized-host: hostTemplate: '{endpoint}' useSchemePrefix: false parameters: - $ref: '#/parameters/Endpoint'