Microsoft Azure

Workload Monitor

APIs for workload monitoring

Developer tools#openapi#cloud

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

APIs for workload monitoring

Endpoints 13

WorkloadInsights

  • GETGets the details of all operations possible on the resource provider./providers/Microsoft.WorkloadMonitor/operations?api-version=2018-08-31-preview&$skiptoken=string
  • GETGet subscription wide details of components./subscriptions/:subscriptionId/providers/Microsoft.WorkloadMonitor/componentsSummary?api-version=2018-08-31-preview&$select=string&$filter=string&$apply=string&$orderby=string&$expand=string&$top=string&$skiptoken=string
  • GETGet subscription wide health instances./subscriptions/:subscriptionId/providers/Microsoft.WorkloadMonitor/monitorInstancesSummary?api-version=2018-08-31-preview&$select=string&$filter=string&$apply=string&$orderby=string&$expand=string&$top=string&$skiptoken=string

WLIExtension

  • GETGet list of components for a resource./subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/:resourceNamespace/:resourceType/:resourceName/providers/Microsoft.WorkloadMonitor/components?api-version=2018-08-31-preview&$select=string&$filter=string&$apply=string&$orderby=string&$expand=string&$top=string&$skiptoken=string
  • GETGet details of a component./subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/:resourceNamespace/:resourceType/:resourceName/providers/Microsoft.WorkloadMonitor/components/:componentId?api-version=2018-08-31-preview&$select=string&$expand=string
  • GETGet list of monitor instances for a resource./subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/:resourceNamespace/:resourceType/:resourceName/providers/Microsoft.WorkloadMonitor/monitorInstances?api-version=2018-08-31-preview&$select=string&$filter=string&$apply=string&$orderby=string&$expand=string&$top=string&$skiptoken=string
  • GETGet details of a monitorInstance./subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/:resourceNamespace/:resourceType/:resourceName/providers/Microsoft.WorkloadMonitor/monitorInstances/:monitorInstanceId?api-version=2018-08-31-preview&$select=string&$expand=string
  • GETGet list of a monitors of a resource./subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/:resourceNamespace/:resourceType/:resourceName/providers/Microsoft.WorkloadMonitor/monitors?api-version=2018-08-31-preview&$filter=string&$skiptoken=string
  • GETGet details of a single monitor./subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/:resourceNamespace/:resourceType/:resourceName/providers/Microsoft.WorkloadMonitor/monitors/:monitorId?api-version=2018-08-31-preview
  • PATCHUpdate a Monitor's configuration./subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/:resourceNamespace/:resourceType/:resourceName/providers/Microsoft.WorkloadMonitor/monitors/:monitorId?api-version=2018-08-31-preview
  • GETGet list of notification settings for a resource./subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/:resourceNamespace/:resourceType/:resourceName/providers/Microsoft.WorkloadMonitor/notificationSettings?api-version=2018-08-31-preview&$skiptoken=string
  • GETGet a of notification setting for a resource./subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/:resourceNamespace/:resourceType/:resourceName/providers/Microsoft.WorkloadMonitor/notificationSettings/:notificationSettingName?api-version=2018-08-31-preview
  • PUTUpdate notification settings for a resource./subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/:resourceNamespace/:resourceType/:resourceName/providers/Microsoft.WorkloadMonitor/notificationSettings/:notificationSettingName?api-version=2018-08-31-preview

API details

Base URL
https://management.azure.com
Authentication
OAuth 2.0 (implicit flow) with 1 scope
Operations
13 operations on 11 pathsGET 11PUT 1PATCH 1
Main resources
WLIExtension 10WorkloadInsights 3
Response formats
application/json
Description format
Swagger 2.0, API version 2018-08-31-preview
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the Workload Monitor in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Workload Monitor collection, without the publisher's secrets.
  3. 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.
  4. Send a requestPick an endpoint, for example “Gets the details of all operations possible on the resource provider.” (GET /providers/Microsoft.WorkloadMonitor/operations?api-version=2018-08-31-preview&$skiptoken=string), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Workload Monitor?

APIs for workload monitoring It is listed under Developer tools and has 13 endpoints.

Who publishes the Workload Monitor?

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 Workload Monitor?

Requests go to https://management.azure.com. Endpoint paths are added to this base URL.

How do I authenticate with the Workload Monitor?

With OAuth 2.0 (implicit flow) with 1 scope.

How many endpoints does the Workload Monitor have?

13 operations on 11 paths (11 GET, 1 PUT, 1 PATCH). The largest groups are WLIExtension, WorkloadInsights.

Is forking the Workload Monitor free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.