Service Map
Service Map API Reference
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Service Map API Reference
Endpoints 25
Client Groups
- GETClientGroups_Get
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.OperationalInsights/workspaces/:workspaceName/features/serviceMap/clientGroups/:clientGroupName?api-version=string&startTime=2024-01-01T00:00:00Z&endTime=2024-01-01T00:00:00ZRetrieves the specified client group - GETClientGroups_ListMembers
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.OperationalInsights/workspaces/:workspaceName/features/serviceMap/clientGroups/:clientGroupName/members?api-version=string&startTime=2024-01-01T00:00:00Z&endTime=2024-01-01T00:00:00Z&$top=1Returns the members of the client group during the specified time interval. - GETClientGroups_GetMembersCount
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.OperationalInsights/workspaces/:workspaceName/features/serviceMap/clientGroups/:clientGroupName/membersCount?api-version=string&startTime=2024-01-01T00:00:00Z&endTime=2024-01-01T00:00:00ZReturns the approximate number of members in the client group.
Maps
- POSTMaps_Generate
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.OperationalInsights/workspaces/:workspaceName/features/serviceMap/generateMap?api-version=stringGenerates the specified map.
MachineGroups
- GETMachineGroups_ListByWorkspace
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.OperationalInsights/workspaces/:workspaceName/features/serviceMap/machineGroups?api-version=string&startTime=2024-01-01T00:00:00Z&endTime=2024-01-01T00:00:00ZReturns all machine groups during the specified time interval. - POSTMachineGroups_Create
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.OperationalInsights/workspaces/:workspaceName/features/serviceMap/machineGroups?api-version=stringCreates a new machine group. - GETMachineGroups_Get
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.OperationalInsights/workspaces/:workspaceName/features/serviceMap/machineGroups/:machineGroupName?api-version=string&startTime=2024-01-01T00:00:00Z&endTime=2024-01-01T00:00:00ZReturns the specified machine group as it existed during the specified time interval. - PUTMachineGroups_Update
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.OperationalInsights/workspaces/:workspaceName/features/serviceMap/machineGroups/:machineGroupName?api-version=stringUpdates a machine group. - DELETEMachineGroups_Delete
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.OperationalInsights/workspaces/:workspaceName/features/serviceMap/machineGroups/:machineGroupName?api-version=stringDeletes the specified Machine Group.
Machines
- GETMachines_ListByWorkspace
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.OperationalInsights/workspaces/:workspaceName/features/serviceMap/machines?api-version=string&live=true&startTime=2024-01-01T00:00:00Z&endTime=2024-01-01T00:00:00Z×tamp=2024-01-01T00:00:00Z&$top=1Returns a collection of machines matching the specified conditions. The returned collection represents either machines that are active/live during the… - GETMachines_Get
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.OperationalInsights/workspaces/:workspaceName/features/serviceMap/machines/:machineName?api-version=string×tamp=2024-01-01T00:00:00ZReturns the specified machine. - GETMachines_ListConnections
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.OperationalInsights/workspaces/:workspaceName/features/serviceMap/machines/:machineName/connections?api-version=string&startTime=2024-01-01T00:00:00Z&endTime=2024-01-01T00:00:00ZReturns a collection of connections terminating or originating at the specified machine - GETMachines_GetLiveness
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.OperationalInsights/workspaces/:workspaceName/features/serviceMap/machines/:machineName/liveness?api-version=string&startTime=2024-01-01T00:00:00Z&endTime=2024-01-01T00:00:00ZObtains the liveness status of the machine during the specified time interval. - GETMachines_ListMachineGroupMembership
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.OperationalInsights/workspaces/:workspaceName/features/serviceMap/machines/:machineName/machineGroups?api-version=string&startTime=2024-01-01T00:00:00Z&endTime=2024-01-01T00:00:00ZReturns a collection of machine groups this machine belongs to during the specified time interval. - GETMachines_ListPorts
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.OperationalInsights/workspaces/:workspaceName/features/serviceMap/machines/:machineName/ports?api-version=string&startTime=2024-01-01T00:00:00Z&endTime=2024-01-01T00:00:00ZReturns a collection of live ports on the specified machine during the specified time interval.
Ports
- GETPorts_Get
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.OperationalInsights/workspaces/:workspaceName/features/serviceMap/machines/:machineName/ports/:portName?api-version=string&startTime=2024-01-01T00:00:00Z&endTime=2024-01-01T00:00:00ZReturns 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… - GETPorts_ListAcceptingProcesses
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.OperationalInsights/workspaces/:workspaceName/features/serviceMap/machines/:machineName/ports/:portName/acceptingProcesses?api-version=string&startTime=2024-01-01T00:00:00Z&endTime=2024-01-01T00:00:00ZReturns a collection of processes accepting on the specified port - GETPorts_ListConnections
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.OperationalInsights/workspaces/:workspaceName/features/serviceMap/machines/:machineName/ports/:portName/connections?api-version=string&startTime=2024-01-01T00:00:00Z&endTime=2024-01-01T00:00:00ZReturns a collection of connections established via the specified port. - GETPorts_GetLiveness
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.OperationalInsights/workspaces/:workspaceName/features/serviceMap/machines/:machineName/ports/:portName/liveness?api-version=string&startTime=2024-01-01T00:00:00Z&endTime=2024-01-01T00:00:00ZObtains the liveness status of the port during the specified time interval.
Processes
- GETMachines_ListProcesses
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.OperationalInsights/workspaces/:workspaceName/features/serviceMap/machines/:machineName/processes?api-version=string&live=true&startTime=2024-01-01T00:00:00Z&endTime=2024-01-01T00:00:00Z×tamp=2024-01-01T00:00:00ZReturns a collection of processes on the specified machine matching the specified conditions. The returned collection represents either processes that are… - GETProcesses_Get
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.OperationalInsights/workspaces/:workspaceName/features/serviceMap/machines/:machineName/processes/:processName?api-version=string×tamp=2024-01-01T00:00:00ZReturns the specified process. - GETProcesses_ListAcceptingPorts
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.OperationalInsights/workspaces/:workspaceName/features/serviceMap/machines/:machineName/processes/:processName/acceptingPorts?api-version=string&startTime=2024-01-01T00:00:00Z&endTime=2024-01-01T00:00:00ZReturns a collection of ports on which this process is accepting - GETProcesses_ListConnections
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.OperationalInsights/workspaces/:workspaceName/features/serviceMap/machines/:machineName/processes/:processName/connections?api-version=string&startTime=2024-01-01T00:00:00Z&endTime=2024-01-01T00:00:00ZReturns a collection of connections terminating or originating at the specified process - GETProcesses_GetLiveness
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.OperationalInsights/workspaces/:workspaceName/features/serviceMap/machines/:machineName/processes/:processName/liveness?api-version=string&startTime=2024-01-01T00:00:00Z&endTime=2024-01-01T00:00:00ZObtains the liveness status of the process during the specified time interval.
Summaries
- GETSummaries_GetMachines
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.OperationalInsights/workspaces/:workspaceName/features/serviceMap/summaries/machines?api-version=string&startTime=2024-01-01T00:00:00Z&endTime=2024-01-01T00:00:00ZReturns summary information about the machines in the workspace.
API details
- Base URL
https://management.azure.com- Authentication
- OAuth 2.0 (implicit flow) with 1 scope
- Operations
- 25 operations on 22 pathsGET 21POST 2PUT 1DELETE 1
- Main resources
- Machines 7MachineGroups 6Processes 6Ports 5Client Groups 3Maps 1Summaries 1
- Response formats
application/json- Description format
- Swagger 2.0, API version
2015-11-01-preview - Links
- OpenAPI document
- Listed from
- APIs.guru OpenAPI Directory (CC0-1.0)
Source updated
How to test the Service Map in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Service Map collection, without the publisher's secrets.
- Add your credentialsThis API uses OAuth 2.0 (implicit flow) with 1 scope. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “ClientGroups_Get” (GET /subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.OperationalInsights/workspaces/:workspaceName/features/serviceMap/clientGroups/:clientGroupName?api-version=string&startTime=2024-01-01T00:00:00Z&endTime=2024-01-01T00:00:00Z), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Service Map?
Service Map API Reference It is listed under Maps & location and has 25 endpoints.
Who publishes the Service Map?
It is listed from Microsoft Azure's public API description (an OpenAPI document), not published by Microsoft Azure on Swastik Codes. Anyone who controls azure.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Service Map?
Requests go to https://management.azure.com. Endpoint paths are added to this base URL.
How do I authenticate with the Service Map?
With OAuth 2.0 (implicit flow) with 1 scope.
How many endpoints does the Service Map have?
25 operations on 22 paths (21 GET, 2 POST, 1 PUT, 1 DELETE). The largest groups are Machines, MachineGroups, Processes, Ports.
Is forking the Service Map free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.