{"note":"OpenAPI conversion -- returning structured metadata","name":"azure-com-service-map-arm-service-map","description":"Service Map","version":"2015-11-01-preview","base_url":"https://management.azure.com","endpoints":25,"raw":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api Service Map\n@base https://management.azure.com\n@version 2015-11-01-preview\n@auth OAuth2\n@common_fields {subscriptionId: any # Azure subscription identifier., resourceGroupName: any # Resource group name within the specified subscriptionId., workspaceName: any # OMS workspace containing the resources of interest., api-version: any # API version.}\n@endpoints 25\n@hint download_for_search\n@toc subscriptions(25)\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/features/serviceMap/machines\n@desc 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).\n@optional {live: any # 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., startTime: any # UTC date and time specifying the start time of an interval. When not specified the service uses DateTime.UtcNow - 10m, endTime: any # UTC date and time specifying the end time of an interval. When not specified the service uses DateTime.UtcNow, timestamp: any # 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., $top: any # Page size to use. When not specified, the default page size is 100 records.}\n@returns(200) The operation completed successfully.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/features/serviceMap/machines/{machineName}\n@desc Returns the specified machine.\n@required {machineName: any # Machine resource name.}\n@optional {timestamp: any # UTC date and time specifying a time instance relative to which to evaluate the machine resource. When not specified, the service uses DateTime.UtcNow.}\n@returns(200) The operation completed successfully.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/features/serviceMap/machines/{machineName}/liveness\n@desc Obtains the liveness status of the machine during the specified time interval.\n@required {machineName: any # Machine resource name.}\n@optional {startTime: any # UTC date and time specifying the start time of an interval. When not specified the service uses DateTime.UtcNow - 10m, endTime: any # UTC date and time specifying the end time of an interval. When not specified the service uses DateTime.UtcNow}\n@returns(200) The operation completed successfully.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/features/serviceMap/machines/{machineName}/connections\n@desc Returns a collection of connections terminating or originating at the specified machine\n@required {machineName: any # Machine resource name.}\n@optional {startTime: any # UTC date and time specifying the start time of an interval. When not specified the service uses DateTime.UtcNow - 10m, endTime: any # UTC date and time specifying the end time of an interval. When not specified the service uses DateTime.UtcNow}\n@returns(200) The operation completed successfully.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/features/serviceMap/machines/{machineName}/processes\n@desc 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).\n@required {machineName: any # Machine resource name.}\n@optional {live: any # 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., startTime: any # UTC date and time specifying the start time of an interval. When not specified the service uses DateTime.UtcNow - 10m, endTime: any # UTC date and time specifying the end time of an interval. When not specified the service uses DateTime.UtcNow, timestamp: any # 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.}\n@returns(200) The operation completed successfully.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/features/serviceMap/machines/{machineName}/processes/{processName}\n@desc Returns the specified process.\n@required {machineName: any # Machine resource name., processName: any # Process resource name.}\n@optional {timestamp: any # UTC date and time specifying a time instance relative to which to evaluate a resource. When not specified, the service uses DateTime.UtcNow.}\n@returns(200) The operation completed successfully.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/features/serviceMap/machines/{machineName}/processes/{processName}/liveness\n@desc Obtains the liveness status of the process during the specified time interval.\n@required {machineName: any # Machine resource name., processName: any # Process resource name.}\n@optional {startTime: any # UTC date and time specifying the start time of an interval. When not specified the service uses DateTime.UtcNow - 10m, endTime: any # UTC date and time specifying the end time of an interval. When not specified the service uses DateTime.UtcNow}\n@returns(200) The operation completed successfully.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/features/serviceMap/machines/{machineName}/processes/{processName}/acceptingPorts\n@desc Returns a collection of ports on which this process is accepting\n@required {machineName: any # Machine resource name., processName: any # Process resource name.}\n@optional {startTime: any # UTC date and time specifying the start time of an interval. When not specified the service uses DateTime.UtcNow - 10m, endTime: any # UTC date and time specifying the end time of an interval. When not specified the service uses DateTime.UtcNow}\n@returns(200) The operation completed successfully.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/features/serviceMap/machines/{machineName}/processes/{processName}/connections\n@desc Returns a collection of connections terminating or originating at the specified process\n@required {machineName: any # Machine resource name., processName: any # Process resource name.}\n@optional {startTime: any # UTC date and time specifying the start time of an interval. When not specified the service uses DateTime.UtcNow - 10m, endTime: any # UTC date and time specifying the end time of an interval. When not specified the service uses DateTime.UtcNow}\n@returns(200) The operation completed successfully.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/features/serviceMap/machines/{machineName}/ports\n@desc Returns a collection of live ports on the specified machine during the specified time interval.\n@required {machineName: any # Machine resource name.}\n@optional {startTime: any # UTC date and time specifying the start time of an interval. When not specified the service uses DateTime.UtcNow - 10m, endTime: any # UTC date and time specifying the end time of an interval. When not specified the service uses DateTime.UtcNow}\n@returns(200) The operation completed successfully.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/features/serviceMap/machines/{machineName}/ports/{portName}\n@desc 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.\n@required {machineName: any # Machine resource name., portName: any # Port resource name.}\n@optional {startTime: any # UTC date and time specifying the start time of an interval. When not specified the service uses DateTime.UtcNow - 10m, endTime: any # UTC date and time specifying the end time of an interval. When not specified the service uses DateTime.UtcNow}\n@returns(200) The operation completed successfully.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/features/serviceMap/machines/{machineName}/ports/{portName}/liveness\n@desc Obtains the liveness status of the port during the specified time interval.\n@required {machineName: any # Machine resource name., portName: any # Port resource name.}\n@optional {startTime: any # UTC date and time specifying the start time of an interval. When not specified the service uses DateTime.UtcNow - 10m, endTime: any # UTC date and time specifying the end time of an interval. When not specified the service uses DateTime.UtcNow}\n@returns(200) The operation completed successfully.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/features/serviceMap/machines/{machineName}/ports/{portName}/acceptingProcesses\n@desc Returns a collection of processes accepting on the specified port\n@required {machineName: any # Machine resource name., portName: any # Port resource name.}\n@optional {startTime: any # UTC date and time specifying the start time of an interval. When not specified the service uses DateTime.UtcNow - 10m, endTime: any # UTC date and time specifying the end time of an interval. When not specified the service uses DateTime.UtcNow}\n@returns(200) The operation completed successfully.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/features/serviceMap/machines/{machineName}/ports/{portName}/connections\n@desc Returns a collection of connections established via the specified port.\n@required {machineName: any # Machine resource name., portName: any # Port resource name.}\n@optional {startTime: any # UTC date and time specifying the start time of an interval. When not specified the service uses DateTime.UtcNow - 10m, endTime: any # UTC date and time specifying the end time of an interval. When not specified the service uses DateTime.UtcNow}\n@returns(200) The operation completed successfully.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/features/serviceMap/machines/{machineName}/machineGroups\n@desc Returns a collection of machine groups this machine belongs to during the specified time interval.\n@required {machineName: any # Machine resource name.}\n@optional {startTime: any # UTC date and time specifying the start time of an interval. When not specified the service uses DateTime.UtcNow - 10m, endTime: any # UTC date and time specifying the end time of an interval. When not specified the service uses DateTime.UtcNow}\n@returns(200) The operation completed successfully.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/features/serviceMap/clientGroups/{clientGroupName}\n@desc Retrieves the specified client group\n@required {clientGroupName: any # Client Group resource name.}\n@optional {startTime: any # UTC date and time specifying the start time of an interval. When not specified the service uses DateTime.UtcNow - 10m, endTime: any # UTC date and time specifying the end time of an interval. When not specified the service uses DateTime.UtcNow}\n@returns(200) The operation completed successfully.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/features/serviceMap/clientGroups/{clientGroupName}/membersCount\n@desc Returns the approximate number of members in the client group.\n@required {clientGroupName: any # Client Group resource name.}\n@optional {startTime: any # UTC date and time specifying the start time of an interval. When not specified the service uses DateTime.UtcNow - 10m, endTime: any # UTC date and time specifying the end time of an interval. When not specified the service uses DateTime.UtcNow}\n@returns(200) The operation completed successfully.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/features/serviceMap/clientGroups/{clientGroupName}/members\n@desc Returns the members of the client group during the specified time interval.\n@required {clientGroupName: any # Client Group resource name.}\n@optional {startTime: any # UTC date and time specifying the start time of an interval. When not specified the service uses DateTime.UtcNow - 10m, endTime: any # UTC date and time specifying the end time of an interval. When not specified the service uses DateTime.UtcNow, $top: any # Page size to use. When not specified, the default page size is 100 records.}\n@returns(200) The operation completed successfully.\n\n@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/features/serviceMap/generateMap\n@desc Generates the specified map.\n@required {request: map # Request options.}\n@returns(200) The operation completed successfully.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/features/serviceMap/summaries/machines\n@desc Returns summary information about the machines in the workspace.\n@optional {startTime: any # UTC date and time specifying the start time of an interval. When not specified the service uses DateTime.UtcNow - 10m, endTime: any # UTC date and time specifying the end time of an interval. When not specified the service uses DateTime.UtcNow}\n@returns(200) The operation completed successfully.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/features/serviceMap/machineGroups\n@desc Returns all machine groups during the specified time interval.\n@optional {startTime: any # UTC date and time specifying the start time of an interval. When not specified the service uses DateTime.UtcNow - 10m, endTime: any # UTC date and time specifying the end time of an interval. When not specified the service uses DateTime.UtcNow}\n@returns(200) The operation completed successfully.\n\n@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/features/serviceMap/machineGroups\n@desc Creates a new machine group.\n@required {machineGroup: any # Machine Group resource to create.}\n@returns(201) The operation completed successfully.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/features/serviceMap/machineGroups/{machineGroupName}\n@desc Returns the specified machine group as it existed during the specified time interval.\n@required {machineGroupName: any # Machine Group resource name.}\n@optional {startTime: any # UTC date and time specifying the start time of an interval. When not specified the service uses DateTime.UtcNow - 10m, endTime: any # UTC date and time specifying the end time of an interval. When not specified the service uses DateTime.UtcNow}\n@returns(200) The operation completed successfully.\n\n@endpoint PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/features/serviceMap/machineGroups/{machineGroupName}\n@desc Updates a machine group.\n@required {machineGroupName: any # Machine Group resource name., machineGroup: any # Machine Group resource to update.}\n@returns(200) The operation completed successfully.\n\n@endpoint DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/features/serviceMap/machineGroups/{machineGroupName}\n@desc Deletes the specified Machine Group.\n@required {machineGroupName: any # Machine Group resource name.}\n@returns(204) The operation completed successfully.\n\n@end\n"}