{resourceNamespace} (preview:2018-08-31)

2025/09/19 • 13 new, 13 deleted methods

Monitors_ListByResource (new)
Description :  Get list of a monitors of a resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceNamespace}/{resourceType}/{resourceName}/providers/Microsoft.WorkloadMonitor/monitors
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceNamespace:
{
Description: The Namespace of the resource. ,
Required: True ,
}
string ,
resourceType:
{
Description: The type of the resource. ,
Required: True ,
}
string ,
resourceName:
{
Description: Name of the resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$filter:
{
Description: Filter to be applied on the operation. ,
Required: False ,
}
string ,
$skiptoken:
{
Description: The page-continuation token to use with a paged version of this API. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: URL for next set of results. ,
Required: False ,
}
string ,
value:
{
Description: Collection of Monitor. ,
Required: False ,
}
[
{
etag:
{
Description: For optimistic concurrency control. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of monitor instance ,
Required: False ,
}
{
description:
{
Description: Description of the monitor ,
Required: False ,
}
string ,
monitorId:
{
Description: ID of the monitor ,
Required: False ,
}
string ,
monitorName:
{
Description: Name of the monitor ,
Required: False ,
}
string ,
monitorDisplayName:
{
Description: User friendly display name of the monitor ,
Required: False ,
}
string ,
parentMonitorName:
{
Description: Name of the parent monitor ,
Required: False ,
}
string ,
parentMonitorDisplayName:
{
Description: User friendly display name of the parent monitor ,
Required: False ,
}
string ,
monitorType:
{
Description: Type of the monitor ,
Enum:
{
Aggregate: No description available. ,
Dependency: No description available. ,
Unit: No description available. ,
}
,
Required: False ,
}
enum ,
monitorCategory:
{
Description: Category of the monitor ,
Enum:
{
AvailabilityHealth: No description available. ,
Configuration: No description available. ,
EntityHealth: No description available. ,
PerformanceHealth: No description available. ,
Security: No description available. ,
}
,
Required: False ,
}
enum ,
componentTypeId:
{
Description: Component Type Id of monitor ,
Required: False ,
}
string ,
componentTypeName:
{
Description: Component Type Name of monitor ,
Required: False ,
}
string ,
componentTypeDisplayName:
{
Description: Component Type Display Name of the monitor ,
Required: False ,
}
string ,
monitorState:
{
Description: Is the monitor state enabled or disabled ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
criteria:
{
Description: Collection of MonitorCriteria. For PATCH calls, instead of partial list, complete list of expected criteria should be passed for proper updating. ,
Required: False ,
}
[
{
healthState:
{
Description: Target health state of the criteria ,
Enum:
{
Error: No description available. ,
Warning: No description available. ,
Success: No description available. ,
Unknown: No description available. ,
Uninitialized: No description available. ,
}
,
Required: False ,
}
enum ,
threshold:
{
Description: Threshold value for this criteria ,
Format: double ,
Required: False ,
}
number ,
comparisonOperator:
{
Description: Comparison enum on threshold of this criteria ,
Enum:
{
Equals: No description available. ,
GreaterThan: No description available. ,
GreaterThanOrEqual: No description available. ,
LessThan: No description available. ,
LessThanOrEqual: No description available. ,
NotEquals: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
alertGeneration:
{
Description: Generates alerts or not ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
frequency:
{
Description: Frequency at which monitor condition is evaluated ,
Format: int32 ,
Required: False ,
}
integer ,
lookbackDuration:
{
Description: The duration in minutes in the past during which the monitor is evaluated ,
Format: int32 ,
Required: False ,
}
integer ,
documentationURL:
{
Description: URL pointing to the documentation of the monitor ,
Required: False ,
}
string ,
signalName:
{
Description: Name of the signal on which this monitor is configured. ,
Required: False ,
}
string ,
signalType:
{
Description: Type of the signal on which this monitor is configured. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
Monitors_Get (new)
Description :  Get details of a single monitor.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceNamespace}/{resourceType}/{resourceName}/providers/Microsoft.WorkloadMonitor/monitors/{monitorId}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceNamespace:
{
Description: The Namespace of the resource. ,
Required: True ,
}
string ,
resourceType:
{
Description: The type of the resource. ,
Required: True ,
}
string ,
resourceName:
{
Description: Name of the resource. ,
Required: True ,
}
string ,
monitorId:
{
Description: Monitor Id. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: For optimistic concurrency control. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of monitor instance ,
Required: False ,
}
{
description:
{
Description: Description of the monitor ,
Required: False ,
}
string ,
monitorId:
{
Description: ID of the monitor ,
Required: False ,
}
string ,
monitorName:
{
Description: Name of the monitor ,
Required: False ,
}
string ,
monitorDisplayName:
{
Description: User friendly display name of the monitor ,
Required: False ,
}
string ,
parentMonitorName:
{
Description: Name of the parent monitor ,
Required: False ,
}
string ,
parentMonitorDisplayName:
{
Description: User friendly display name of the parent monitor ,
Required: False ,
}
string ,
monitorType:
{
Description: Type of the monitor ,
Enum:
{
Aggregate: No description available. ,
Dependency: No description available. ,
Unit: No description available. ,
}
,
Required: False ,
}
enum ,
monitorCategory:
{
Description: Category of the monitor ,
Enum:
{
AvailabilityHealth: No description available. ,
Configuration: No description available. ,
EntityHealth: No description available. ,
PerformanceHealth: No description available. ,
Security: No description available. ,
}
,
Required: False ,
}
enum ,
componentTypeId:
{
Description: Component Type Id of monitor ,
Required: False ,
}
string ,
componentTypeName:
{
Description: Component Type Name of monitor ,
Required: False ,
}
string ,
componentTypeDisplayName:
{
Description: Component Type Display Name of the monitor ,
Required: False ,
}
string ,
monitorState:
{
Description: Is the monitor state enabled or disabled ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
criteria:
{
Description: Collection of MonitorCriteria. For PATCH calls, instead of partial list, complete list of expected criteria should be passed for proper updating. ,
Required: False ,
}
[
{
healthState:
{
Description: Target health state of the criteria ,
Enum:
{
Error: No description available. ,
Warning: No description available. ,
Success: No description available. ,
Unknown: No description available. ,
Uninitialized: No description available. ,
}
,
Required: False ,
}
enum ,
threshold:
{
Description: Threshold value for this criteria ,
Format: double ,
Required: False ,
}
number ,
comparisonOperator:
{
Description: Comparison enum on threshold of this criteria ,
Enum:
{
Equals: No description available. ,
GreaterThan: No description available. ,
GreaterThanOrEqual: No description available. ,
LessThan: No description available. ,
LessThanOrEqual: No description available. ,
NotEquals: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
alertGeneration:
{
Description: Generates alerts or not ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
frequency:
{
Description: Frequency at which monitor condition is evaluated ,
Format: int32 ,
Required: False ,
}
integer ,
lookbackDuration:
{
Description: The duration in minutes in the past during which the monitor is evaluated ,
Format: int32 ,
Required: False ,
}
integer ,
documentationURL:
{
Description: URL pointing to the documentation of the monitor ,
Required: False ,
}
string ,
signalName:
{
Description: Name of the signal on which this monitor is configured. ,
Required: False ,
}
string ,
signalType:
{
Description: Type of the signal on which this monitor is configured. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
Monitors_Update (new)
Description :  Update a Monitor's configuration.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceNamespace}/{resourceType}/{resourceName}/providers/Microsoft.WorkloadMonitor/monitors/{monitorId}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceNamespace:
{
Description: The Namespace of the resource. ,
Required: True ,
}
string ,
resourceType:
{
Description: The type of the resource. ,
Required: True ,
}
string ,
resourceName:
{
Description: Name of the resource. ,
Required: True ,
}
string ,
monitorId:
{
Description: Monitor Id. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: Body of the Monitor PATCH object. ,
Required: True ,
}
{
etag:
{
Description: For optimistic concurrency control. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of monitor instance ,
Required: False ,
}
{
description:
{
Description: Description of the monitor ,
Required: False ,
}
string ,
monitorId:
{
Description: ID of the monitor ,
Required: False ,
}
string ,
monitorName:
{
Description: Name of the monitor ,
Required: False ,
}
string ,
monitorDisplayName:
{
Description: User friendly display name of the monitor ,
Required: False ,
}
string ,
parentMonitorName:
{
Description: Name of the parent monitor ,
Required: False ,
}
string ,
parentMonitorDisplayName:
{
Description: User friendly display name of the parent monitor ,
Required: False ,
}
string ,
monitorType:
{
Description: Type of the monitor ,
Enum:
{
Aggregate: No description available. ,
Dependency: No description available. ,
Unit: No description available. ,
}
,
Required: False ,
}
enum ,
monitorCategory:
{
Description: Category of the monitor ,
Enum:
{
AvailabilityHealth: No description available. ,
Configuration: No description available. ,
EntityHealth: No description available. ,
PerformanceHealth: No description available. ,
Security: No description available. ,
}
,
Required: False ,
}
enum ,
componentTypeId:
{
Description: Component Type Id of monitor ,
Required: False ,
}
string ,
componentTypeName:
{
Description: Component Type Name of monitor ,
Required: False ,
}
string ,
componentTypeDisplayName:
{
Description: Component Type Display Name of the monitor ,
Required: False ,
}
string ,
monitorState:
{
Description: Is the monitor state enabled or disabled ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
criteria:
{
Description: Collection of MonitorCriteria. For PATCH calls, instead of partial list, complete list of expected criteria should be passed for proper updating. ,
Required: False ,
}
[
{
healthState:
{
Description: Target health state of the criteria ,
Enum:
{
Error: No description available. ,
Warning: No description available. ,
Success: No description available. ,
Unknown: No description available. ,
Uninitialized: No description available. ,
}
,
Required: False ,
}
enum ,
threshold:
{
Description: Threshold value for this criteria ,
Format: double ,
Required: False ,
}
number ,
comparisonOperator:
{
Description: Comparison enum on threshold of this criteria ,
Enum:
{
Equals: No description available. ,
GreaterThan: No description available. ,
GreaterThanOrEqual: No description available. ,
LessThan: No description available. ,
LessThanOrEqual: No description available. ,
NotEquals: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
alertGeneration:
{
Description: Generates alerts or not ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
frequency:
{
Description: Frequency at which monitor condition is evaluated ,
Format: int32 ,
Required: False ,
}
integer ,
lookbackDuration:
{
Description: The duration in minutes in the past during which the monitor is evaluated ,
Format: int32 ,
Required: False ,
}
integer ,
documentationURL:
{
Description: URL pointing to the documentation of the monitor ,
Required: False ,
}
string ,
signalName:
{
Description: Name of the signal on which this monitor is configured. ,
Required: False ,
}
string ,
signalType:
{
Description: Type of the signal on which this monitor is configured. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
etag:
{
Description: For optimistic concurrency control. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of monitor instance ,
Required: False ,
}
{
description:
{
Description: Description of the monitor ,
Required: False ,
}
string ,
monitorId:
{
Description: ID of the monitor ,
Required: False ,
}
string ,
monitorName:
{
Description: Name of the monitor ,
Required: False ,
}
string ,
monitorDisplayName:
{
Description: User friendly display name of the monitor ,
Required: False ,
}
string ,
parentMonitorName:
{
Description: Name of the parent monitor ,
Required: False ,
}
string ,
parentMonitorDisplayName:
{
Description: User friendly display name of the parent monitor ,
Required: False ,
}
string ,
monitorType:
{
Description: Type of the monitor ,
Enum:
{
Aggregate: No description available. ,
Dependency: No description available. ,
Unit: No description available. ,
}
,
Required: False ,
}
enum ,
monitorCategory:
{
Description: Category of the monitor ,
Enum:
{
AvailabilityHealth: No description available. ,
Configuration: No description available. ,
EntityHealth: No description available. ,
PerformanceHealth: No description available. ,
Security: No description available. ,
}
,
Required: False ,
}
enum ,
componentTypeId:
{
Description: Component Type Id of monitor ,
Required: False ,
}
string ,
componentTypeName:
{
Description: Component Type Name of monitor ,
Required: False ,
}
string ,
componentTypeDisplayName:
{
Description: Component Type Display Name of the monitor ,
Required: False ,
}
string ,
monitorState:
{
Description: Is the monitor state enabled or disabled ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
criteria:
{
Description: Collection of MonitorCriteria. For PATCH calls, instead of partial list, complete list of expected criteria should be passed for proper updating. ,
Required: False ,
}
[
{
healthState:
{
Description: Target health state of the criteria ,
Enum:
{
Error: No description available. ,
Warning: No description available. ,
Success: No description available. ,
Unknown: No description available. ,
Uninitialized: No description available. ,
}
,
Required: False ,
}
enum ,
threshold:
{
Description: Threshold value for this criteria ,
Format: double ,
Required: False ,
}
number ,
comparisonOperator:
{
Description: Comparison enum on threshold of this criteria ,
Enum:
{
Equals: No description available. ,
GreaterThan: No description available. ,
GreaterThanOrEqual: No description available. ,
LessThan: No description available. ,
LessThanOrEqual: No description available. ,
NotEquals: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
alertGeneration:
{
Description: Generates alerts or not ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
frequency:
{
Description: Frequency at which monitor condition is evaluated ,
Format: int32 ,
Required: False ,
}
integer ,
lookbackDuration:
{
Description: The duration in minutes in the past during which the monitor is evaluated ,
Format: int32 ,
Required: False ,
}
integer ,
documentationURL:
{
Description: URL pointing to the documentation of the monitor ,
Required: False ,
}
string ,
signalName:
{
Description: Name of the signal on which this monitor is configured. ,
Required: False ,
}
string ,
signalType:
{
Description: Type of the signal on which this monitor is configured. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
Components_ListByResource (new)
Description :  Get list of components for a resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceNamespace}/{resourceType}/{resourceName}/providers/Microsoft.WorkloadMonitor/components
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceNamespace:
{
Description: The Namespace of the resource. ,
Required: True ,
}
string ,
resourceType:
{
Description: The type of the resource. ,
Required: True ,
}
string ,
resourceName:
{
Description: Name of the resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$select:
{
Description: Properties to be returned in the response. ,
Required: False ,
}
string ,
$filter:
{
Description: Filter to be applied on the operation. ,
Required: False ,
}
string ,
$apply:
{
Description: Apply aggregation. ,
Required: False ,
}
string ,
$orderby:
{
Description: Sort the result on one or more properties. ,
Required: False ,
}
string ,
$expand:
{
Description: Include properties inline in the response. ,
Required: False ,
}
string ,
$top:
{
Description: Limit the result to the specified number of rows. ,
Required: False ,
}
string ,
$skiptoken:
{
Description: The page-continuation token to use with a paged version of this API. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: URL to the next set of results. ,
Required: False ,
}
string ,
value:
{
Description: Collection of components. ,
Required: False ,
}
[
{
etag:
{
Description: For optimistic concurrency control. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the component. ,
Required: False ,
}
{
workspaceId:
{
Description: ID of the workspace. ,
Required: False ,
}
string ,
solutionId:
{
Description: ID of the OMS solution this component belong to. ,
Required: False ,
}
string ,
workloadType:
{
Description: Type of the workload. ,
Enum:
{
BaseOS: No description available. ,
SQL: No description available. ,
IIS: No description available. ,
Apache: No description available. ,
}
,
Required: False ,
}
enum ,
componentName:
{
Description: Name of the component. ,
Required: False ,
}
string ,
componentTypeId:
{
Description: ID of the component type. ,
Required: False ,
}
string ,
componentTypeName:
{
Description: Name of the component type. Qualifies the type of component such as whether it is a SQL database, logical disk, website, etc. ,
Required: False ,
}
string ,
componentTypeGroupCategory:
{
Description: Component type group category. Classification of component type groups into a logical category. e.g. Network, Disk, Memory, CPU. ,
Required: False ,
}
string ,
healthState:
{
Description: Health state of the component. ,
Enum:
{
Error: No description available. ,
Warning: No description available. ,
Success: No description available. ,
Unknown: No description available. ,
Uninitialized: No description available. ,
}
,
Required: False ,
}
enum ,
healthStateCategory:
{
Description: Category of component's health state. ,
Enum:
{
Identity: No description available. ,
CustomGroup: No description available. ,
}
,
Required: False ,
}
enum ,
healthStateChangesStartTime:
{
Description: Start time for health state changes. ,
Format: date-time ,
Required: False ,
}
string ,
healthStateChangesEndTime:
{
Description: End time for health state changes. ,
Format: date-time ,
Required: False ,
}
string ,
lastHealthStateChangeTime:
{
Description: Time of last health state change. ,
Format: date-time ,
Required: False ,
}
string ,
vmId:
{
Description: ID of the VM this component belongs to. ,
Required: False ,
}
string ,
vmName:
{
Description: Name of the VM this component belongs to. ,
Required: False ,
}
string ,
vmTags:
{
Description: Tags on the VM this component belongs to. ,
Required: False ,
}
object ,
aggregateProperties:
{
Description: Properties requested in aggregation queries. ,
Required: False ,
}
object ,
children:
{
Description: component children. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
Components_Get (new)
Description :  Get details of a component.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceNamespace}/{resourceType}/{resourceName}/providers/Microsoft.WorkloadMonitor/components/{componentId}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceNamespace:
{
Description: The Namespace of the resource. ,
Required: True ,
}
string ,
resourceType:
{
Description: The type of the resource. ,
Required: True ,
}
string ,
resourceName:
{
Description: Name of the resource. ,
Required: True ,
}
string ,
componentId:
{
Description: Component Id. ,
Format: uuid ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$select:
{
Description: Properties to be returned in the response. ,
Required: False ,
}
string ,
$expand:
{
Description: Include properties inline in the response. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: For optimistic concurrency control. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the component. ,
Required: False ,
}
{
workspaceId:
{
Description: ID of the workspace. ,
Required: False ,
}
string ,
solutionId:
{
Description: ID of the OMS solution this component belong to. ,
Required: False ,
}
string ,
workloadType:
{
Description: Type of the workload. ,
Enum:
{
BaseOS: No description available. ,
SQL: No description available. ,
IIS: No description available. ,
Apache: No description available. ,
}
,
Required: False ,
}
enum ,
componentName:
{
Description: Name of the component. ,
Required: False ,
}
string ,
componentTypeId:
{
Description: ID of the component type. ,
Required: False ,
}
string ,
componentTypeName:
{
Description: Name of the component type. Qualifies the type of component such as whether it is a SQL database, logical disk, website, etc. ,
Required: False ,
}
string ,
componentTypeGroupCategory:
{
Description: Component type group category. Classification of component type groups into a logical category. e.g. Network, Disk, Memory, CPU. ,
Required: False ,
}
string ,
healthState:
{
Description: Health state of the component. ,
Enum:
{
Error: No description available. ,
Warning: No description available. ,
Success: No description available. ,
Unknown: No description available. ,
Uninitialized: No description available. ,
}
,
Required: False ,
}
enum ,
healthStateCategory:
{
Description: Category of component's health state. ,
Enum:
{
Identity: No description available. ,
CustomGroup: No description available. ,
}
,
Required: False ,
}
enum ,
healthStateChangesStartTime:
{
Description: Start time for health state changes. ,
Format: date-time ,
Required: False ,
}
string ,
healthStateChangesEndTime:
{
Description: End time for health state changes. ,
Format: date-time ,
Required: False ,
}
string ,
lastHealthStateChangeTime:
{
Description: Time of last health state change. ,
Format: date-time ,
Required: False ,
}
string ,
vmId:
{
Description: ID of the VM this component belongs to. ,
Required: False ,
}
string ,
vmName:
{
Description: Name of the VM this component belongs to. ,
Required: False ,
}
string ,
vmTags:
{
Description: Tags on the VM this component belongs to. ,
Required: False ,
}
object ,
aggregateProperties:
{
Description: Properties requested in aggregation queries. ,
Required: False ,
}
object ,
children:
{
Description: component children. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
MonitorInstances_ListByResource (new)
Description :  Get list of monitor instances for a resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceNamespace}/{resourceType}/{resourceName}/providers/Microsoft.WorkloadMonitor/monitorInstances
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceNamespace:
{
Description: The Namespace of the resource. ,
Required: True ,
}
string ,
resourceType:
{
Description: The type of the resource. ,
Required: True ,
}
string ,
resourceName:
{
Description: Name of the resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$select:
{
Description: Properties to be returned in the response. ,
Required: False ,
}
string ,
$filter:
{
Description: Filter to be applied on the operation. ,
Required: False ,
}
string ,
$apply:
{
Description: Apply aggregation. ,
Required: False ,
}
string ,
$orderby:
{
Description: Sort the result on one or more properties. ,
Required: False ,
}
string ,
$expand:
{
Description: Include properties inline in the response. ,
Required: False ,
}
string ,
$top:
{
Description: Limit the result to the specified number of rows. ,
Required: False ,
}
string ,
$skiptoken:
{
Description: The page-continuation token to use with a paged version of this API. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: URL to the next set of results. ,
Required: False ,
}
string ,
value:
{
Description: Collection of health instances. ,
Required: False ,
}
[
{
etag:
{
Description: For optimistic concurrency control. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the monitor instance. ,
Required: False ,
}
{
workspaceId:
{
Description: ID of the workspace. ,
Required: False ,
}
string ,
solutionId:
{
Description: ID of the OMS solution this health instance belong to. ,
Required: False ,
}
string ,
workloadType:
{
Description: Type of the workload. ,
Enum:
{
BaseOS: No description available. ,
SQL: No description available. ,
IIS: No description available. ,
Apache: No description available. ,
}
,
Required: False ,
}
enum ,
componentId:
{
Description: ID of the component. ,
Required: False ,
}
string ,
componentName:
{
Description: Name of the component. ,
Required: False ,
}
string ,
componentTypeId:
{
Description: ID of the component type. ,
Required: False ,
}
string ,
componentTypeName:
{
Description: Name of the component type. Qualifies the type of component such as whether it is a SQL database, logical disk, website, etc. ,
Required: False ,
}
string ,
monitorId:
{
Description: ID of the monitor instance. ,
Required: False ,
}
string ,
monitorName:
{
Description: Name of the monitor. ,
Required: False ,
}
string ,
monitorType:
{
Description: Type of the monitor. The qualifier for the health criteria depending on the functionality it performs such as Unit, Aggregate, Dependency. ,
Enum:
{
Aggregate: No description available. ,
Dependency: No description available. ,
Unit: No description available. ,
}
,
Required: False ,
}
enum ,
monitorCategory:
{
Description: Monitor type category. Indicates the attribute of the component that the health criteria monitors such as Performance, Availability, etc. ,
Enum:
{
AvailabilityHealth: No description available. ,
Configuration: No description available. ,
EntityHealth: No description available. ,
PerformanceHealth: No description available. ,
Security: No description available. ,
}
,
Required: False ,
}
enum ,
healthState:
{
Description: Health state of monitor instance. ,
Enum:
{
Error: No description available. ,
Warning: No description available. ,
Success: No description available. ,
Unknown: No description available. ,
Uninitialized: No description available. ,
}
,
Required: False ,
}
enum ,
healthStateCategory:
{
Description: Category of monitor instance's health state. ,
Enum:
{
Identity: No description available. ,
CustomGroup: No description available. ,
}
,
Required: False ,
}
enum ,
healthStateChanges:
{
Description: Health state changes. ,
Required: False ,
}
[
{
healthState:
{
Description: Health state of monitor instance. ,
Enum:
{
Error: No description available. ,
Warning: No description available. ,
Success: No description available. ,
Unknown: No description available. ,
Uninitialized: No description available. ,
}
,
Required: False ,
}
enum ,
healthStateChangeTime:
{
Description: Time at which this Health state was reached. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
healthStateChangesStartTime:
{
Description: Start time for health state changes. ,
Format: date-time ,
Required: False ,
}
string ,
healthStateChangesEndTime:
{
Description: End time for health state changes. ,
Format: date-time ,
Required: False ,
}
string ,
lastHealthStateChangeTime:
{
Description: Time of last health state change. ,
Format: date-time ,
Required: False ,
}
string ,
alertGeneration:
{
Description: Generates alert or not. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
aggregateProperties:
{
Description: Properties requested in aggregation queries. ,
Required: False ,
}
object ,
children:
{
Description: Health instance children. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
MonitorInstances_Get (new)
Description :  Get details of a monitorInstance.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceNamespace}/{resourceType}/{resourceName}/providers/Microsoft.WorkloadMonitor/monitorInstances/{monitorInstanceId}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceNamespace:
{
Description: The Namespace of the resource. ,
Required: True ,
}
string ,
resourceType:
{
Description: The type of the resource. ,
Required: True ,
}
string ,
resourceName:
{
Description: Name of the resource. ,
Required: True ,
}
string ,
monitorInstanceId:
{
Description: MonitorInstance Id. ,
Format: uuid ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$select:
{
Description: Properties to be returned in the response. ,
Required: False ,
}
string ,
$expand:
{
Description: Include properties inline in the response. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: For optimistic concurrency control. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the monitor instance. ,
Required: False ,
}
{
workspaceId:
{
Description: ID of the workspace. ,
Required: False ,
}
string ,
solutionId:
{
Description: ID of the OMS solution this health instance belong to. ,
Required: False ,
}
string ,
workloadType:
{
Description: Type of the workload. ,
Enum:
{
BaseOS: No description available. ,
SQL: No description available. ,
IIS: No description available. ,
Apache: No description available. ,
}
,
Required: False ,
}
enum ,
componentId:
{
Description: ID of the component. ,
Required: False ,
}
string ,
componentName:
{
Description: Name of the component. ,
Required: False ,
}
string ,
componentTypeId:
{
Description: ID of the component type. ,
Required: False ,
}
string ,
componentTypeName:
{
Description: Name of the component type. Qualifies the type of component such as whether it is a SQL database, logical disk, website, etc. ,
Required: False ,
}
string ,
monitorId:
{
Description: ID of the monitor instance. ,
Required: False ,
}
string ,
monitorName:
{
Description: Name of the monitor. ,
Required: False ,
}
string ,
monitorType:
{
Description: Type of the monitor. The qualifier for the health criteria depending on the functionality it performs such as Unit, Aggregate, Dependency. ,
Enum:
{
Aggregate: No description available. ,
Dependency: No description available. ,
Unit: No description available. ,
}
,
Required: False ,
}
enum ,
monitorCategory:
{
Description: Monitor type category. Indicates the attribute of the component that the health criteria monitors such as Performance, Availability, etc. ,
Enum:
{
AvailabilityHealth: No description available. ,
Configuration: No description available. ,
EntityHealth: No description available. ,
PerformanceHealth: No description available. ,
Security: No description available. ,
}
,
Required: False ,
}
enum ,
healthState:
{
Description: Health state of monitor instance. ,
Enum:
{
Error: No description available. ,
Warning: No description available. ,
Success: No description available. ,
Unknown: No description available. ,
Uninitialized: No description available. ,
}
,
Required: False ,
}
enum ,
healthStateCategory:
{
Description: Category of monitor instance's health state. ,
Enum:
{
Identity: No description available. ,
CustomGroup: No description available. ,
}
,
Required: False ,
}
enum ,
healthStateChanges:
{
Description: Health state changes. ,
Required: False ,
}
[
{
healthState:
{
Description: Health state of monitor instance. ,
Enum:
{
Error: No description available. ,
Warning: No description available. ,
Success: No description available. ,
Unknown: No description available. ,
Uninitialized: No description available. ,
}
,
Required: False ,
}
enum ,
healthStateChangeTime:
{
Description: Time at which this Health state was reached. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
healthStateChangesStartTime:
{
Description: Start time for health state changes. ,
Format: date-time ,
Required: False ,
}
string ,
healthStateChangesEndTime:
{
Description: End time for health state changes. ,
Format: date-time ,
Required: False ,
}
string ,
lastHealthStateChangeTime:
{
Description: Time of last health state change. ,
Format: date-time ,
Required: False ,
}
string ,
alertGeneration:
{
Description: Generates alert or not. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
aggregateProperties:
{
Description: Properties requested in aggregation queries. ,
Required: False ,
}
object ,
children:
{
Description: Health instance children. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
NotificationSettings_ListByResource (new)
Description :  Get list of notification settings for a resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceNamespace}/{resourceType}/{resourceName}/providers/Microsoft.WorkloadMonitor/notificationSettings
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceNamespace:
{
Description: The Namespace of the resource. ,
Required: True ,
}
string ,
resourceType:
{
Description: The type of the resource. ,
Required: True ,
}
string ,
resourceName:
{
Description: Name of the resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$skiptoken:
{
Description: The page-continuation token to use with a paged version of this API. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
etag:
{
Description: For optimistic concurrency control. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of Notification Settings ,
Required: False ,
}
{
actionGroupResourceIds:
{
Description: List of action group resource ids to be notified ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
nextLink:
{
Description: URL to the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
NotificationSettings_Get (new)
Description :  Get a of notification setting for a resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceNamespace}/{resourceType}/{resourceName}/providers/Microsoft.WorkloadMonitor/notificationSettings/{notificationSettingName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceNamespace:
{
Description: The Namespace of the resource. ,
Required: True ,
}
string ,
resourceType:
{
Description: The type of the resource. ,
Required: True ,
}
string ,
resourceName:
{
Description: Name of the resource. ,
Required: True ,
}
string ,
notificationSettingName:
{
Description: Default string modeled as parameter for URL to work correctly. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: For optimistic concurrency control. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of Notification Settings ,
Required: False ,
}
{
actionGroupResourceIds:
{
Description: List of action group resource ids to be notified ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
NotificationSettings_Update (new)
Description :  Update notification settings for a resource.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceNamespace}/{resourceType}/{resourceName}/providers/Microsoft.WorkloadMonitor/notificationSettings/{notificationSettingName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceNamespace:
{
Description: The Namespace of the resource. ,
Required: True ,
}
string ,
resourceType:
{
Description: The type of the resource. ,
Required: True ,
}
string ,
resourceName:
{
Description: Name of the resource. ,
Required: True ,
}
string ,
notificationSettingName:
{
Description: Default string modeled as parameter for URL to work correctly. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: Body of the NotificationSetting PUT object. ,
Required: True ,
}
{
etag:
{
Description: For optimistic concurrency control. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of Notification Settings ,
Required: False ,
}
{
actionGroupResourceIds:
{
Description: List of action group resource ids to be notified ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (200)

{
etag:
{
Description: For optimistic concurrency control. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of Notification Settings ,
Required: False ,
}
{
actionGroupResourceIds:
{
Description: List of action group resource ids to be notified ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
ComponentsSummary_List (new)
Description :  Get subscription wide details of components.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.WorkloadMonitor/componentsSummary
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$select:
{
Description: Properties to be returned in the response. ,
Required: False ,
}
string ,
$filter:
{
Description: Filter to be applied on the operation. ,
Required: False ,
}
string ,
$apply:
{
Description: Apply aggregation. ,
Required: False ,
}
string ,
$orderby:
{
Description: Sort the result on one or more properties. ,
Required: False ,
}
string ,
$expand:
{
Description: Include properties inline in the response. ,
Required: False ,
}
string ,
$top:
{
Description: Limit the result to the specified number of rows. ,
Required: False ,
}
string ,
$skiptoken:
{
Description: The page-continuation token to use with a paged version of this API. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: URL to the next set of results. ,
Required: False ,
}
string ,
value:
{
Description: Collection of components. ,
Required: False ,
}
[
{
etag:
{
Description: For optimistic concurrency control. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the component. ,
Required: False ,
}
{
workspaceId:
{
Description: ID of the workspace. ,
Required: False ,
}
string ,
solutionId:
{
Description: ID of the OMS solution this component belong to. ,
Required: False ,
}
string ,
workloadType:
{
Description: Type of the workload. ,
Enum:
{
BaseOS: No description available. ,
SQL: No description available. ,
IIS: No description available. ,
Apache: No description available. ,
}
,
Required: False ,
}
enum ,
componentName:
{
Description: Name of the component. ,
Required: False ,
}
string ,
componentTypeId:
{
Description: ID of the component type. ,
Required: False ,
}
string ,
componentTypeName:
{
Description: Name of the component type. Qualifies the type of component such as whether it is a SQL database, logical disk, website, etc. ,
Required: False ,
}
string ,
componentTypeGroupCategory:
{
Description: Component type group category. Classification of component type groups into a logical category. e.g. Network, Disk, Memory, CPU. ,
Required: False ,
}
string ,
healthState:
{
Description: Health state of the component. ,
Enum:
{
Error: No description available. ,
Warning: No description available. ,
Success: No description available. ,
Unknown: No description available. ,
Uninitialized: No description available. ,
}
,
Required: False ,
}
enum ,
healthStateCategory:
{
Description: Category of component's health state. ,
Enum:
{
Identity: No description available. ,
CustomGroup: No description available. ,
}
,
Required: False ,
}
enum ,
healthStateChangesStartTime:
{
Description: Start time for health state changes. ,
Format: date-time ,
Required: False ,
}
string ,
healthStateChangesEndTime:
{
Description: End time for health state changes. ,
Format: date-time ,
Required: False ,
}
string ,
lastHealthStateChangeTime:
{
Description: Time of last health state change. ,
Format: date-time ,
Required: False ,
}
string ,
vmId:
{
Description: ID of the VM this component belongs to. ,
Required: False ,
}
string ,
vmName:
{
Description: Name of the VM this component belongs to. ,
Required: False ,
}
string ,
vmTags:
{
Description: Tags on the VM this component belongs to. ,
Required: False ,
}
object ,
aggregateProperties:
{
Description: Properties requested in aggregation queries. ,
Required: False ,
}
object ,
children:
{
Description: component children. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
MonitorInstancesSummary_List (new)
Description :  Get subscription wide health instances.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.WorkloadMonitor/monitorInstancesSummary
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$select:
{
Description: Properties to be returned in the response. ,
Required: False ,
}
string ,
$filter:
{
Description: Filter to be applied on the operation. ,
Required: False ,
}
string ,
$apply:
{
Description: Apply aggregation. ,
Required: False ,
}
string ,
$orderby:
{
Description: Sort the result on one or more properties. ,
Required: False ,
}
string ,
$expand:
{
Description: Include properties inline in the response. ,
Required: False ,
}
string ,
$top:
{
Description: Limit the result to the specified number of rows. ,
Required: False ,
}
string ,
$skiptoken:
{
Description: The page-continuation token to use with a paged version of this API. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: URL to the next set of results. ,
Required: False ,
}
string ,
value:
{
Description: Collection of health instances. ,
Required: False ,
}
[
{
etag:
{
Description: For optimistic concurrency control. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the monitor instance. ,
Required: False ,
}
{
workspaceId:
{
Description: ID of the workspace. ,
Required: False ,
}
string ,
solutionId:
{
Description: ID of the OMS solution this health instance belong to. ,
Required: False ,
}
string ,
workloadType:
{
Description: Type of the workload. ,
Enum:
{
BaseOS: No description available. ,
SQL: No description available. ,
IIS: No description available. ,
Apache: No description available. ,
}
,
Required: False ,
}
enum ,
componentId:
{
Description: ID of the component. ,
Required: False ,
}
string ,
componentName:
{
Description: Name of the component. ,
Required: False ,
}
string ,
componentTypeId:
{
Description: ID of the component type. ,
Required: False ,
}
string ,
componentTypeName:
{
Description: Name of the component type. Qualifies the type of component such as whether it is a SQL database, logical disk, website, etc. ,
Required: False ,
}
string ,
monitorId:
{
Description: ID of the monitor instance. ,
Required: False ,
}
string ,
monitorName:
{
Description: Name of the monitor. ,
Required: False ,
}
string ,
monitorType:
{
Description: Type of the monitor. The qualifier for the health criteria depending on the functionality it performs such as Unit, Aggregate, Dependency. ,
Enum:
{
Aggregate: No description available. ,
Dependency: No description available. ,
Unit: No description available. ,
}
,
Required: False ,
}
enum ,
monitorCategory:
{
Description: Monitor type category. Indicates the attribute of the component that the health criteria monitors such as Performance, Availability, etc. ,
Enum:
{
AvailabilityHealth: No description available. ,
Configuration: No description available. ,
EntityHealth: No description available. ,
PerformanceHealth: No description available. ,
Security: No description available. ,
}
,
Required: False ,
}
enum ,
healthState:
{
Description: Health state of monitor instance. ,
Enum:
{
Error: No description available. ,
Warning: No description available. ,
Success: No description available. ,
Unknown: No description available. ,
Uninitialized: No description available. ,
}
,
Required: False ,
}
enum ,
healthStateCategory:
{
Description: Category of monitor instance's health state. ,
Enum:
{
Identity: No description available. ,
CustomGroup: No description available. ,
}
,
Required: False ,
}
enum ,
healthStateChanges:
{
Description: Health state changes. ,
Required: False ,
}
[
{
healthState:
{
Description: Health state of monitor instance. ,
Enum:
{
Error: No description available. ,
Warning: No description available. ,
Success: No description available. ,
Unknown: No description available. ,
Uninitialized: No description available. ,
}
,
Required: False ,
}
enum ,
healthStateChangeTime:
{
Description: Time at which this Health state was reached. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
healthStateChangesStartTime:
{
Description: Start time for health state changes. ,
Format: date-time ,
Required: False ,
}
string ,
healthStateChangesEndTime:
{
Description: End time for health state changes. ,
Format: date-time ,
Required: False ,
}
string ,
lastHealthStateChangeTime:
{
Description: Time of last health state change. ,
Format: date-time ,
Required: False ,
}
string ,
alertGeneration:
{
Description: Generates alert or not. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
aggregateProperties:
{
Description: Properties requested in aggregation queries. ,
Required: False ,
}
object ,
children:
{
Description: Health instance children. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
Operations_List (new)
Description :  Gets the details of all operations possible on the resource provider.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.WorkloadMonitor/operations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$skiptoken:
{
Description: The page-continuation token to use with a paged version of this API. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: URL to the next set of results. ,
Required: False ,
}
string ,
value:
{
Description: List of operations. ,
Required: False ,
}
[
{
display:
{
Description: The properties of the resource operation. ,
Required: False ,
}
{
description:
{
Description: The description of the resource provider. ,
Required: False ,
}
string ,
operation:
{
Description: This operation name. ,
Required: False ,
}
string ,
provider:
{
Description: The provider name. ,
Required: False ,
}
string ,
resource:
{
Description: The resource name. ,
Required: False ,
}
string ,
}
,
name:
{
Description: The name of the resource operation. ,
Required: False ,
}
string ,
origin:
{
Description: The origin of the operation. ,
Required: False ,
}
string ,
}
,
]
,
}
Monitors_ListByResource (removed)
Description :  Get list of a monitors of a resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceNamespace}/{resourceType}/{resourceName}/providers/Microsoft.WorkloadMonitor/monitors
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceNamespace:
{
Description: The Namespace of the resource. ,
Required: True ,
}
string ,
resourceType:
{
Description: The type of the resource. ,
Required: True ,
}
string ,
resourceName:
{
Description: Name of the resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$filter:
{
Description: Filter to be applied on the operation. ,
Required: False ,
}
string ,
$skiptoken:
{
Description: The page-continuation token to use with a paged version of this API. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: URL for next set of results. ,
Required: False ,
}
string ,
value:
{
Description: Collection of Monitor. ,
Required: False ,
}
[
{
etag:
{
Description: For optimistic concurrency control. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of monitor instance ,
Required: False ,
}
{
description:
{
Description: Description of the monitor ,
Required: False ,
}
string ,
monitorId:
{
Description: ID of the monitor ,
Required: False ,
}
string ,
monitorName:
{
Description: Name of the monitor ,
Required: False ,
}
string ,
monitorDisplayName:
{
Description: User friendly display name of the monitor ,
Required: False ,
}
string ,
parentMonitorName:
{
Description: Name of the parent monitor ,
Required: False ,
}
string ,
parentMonitorDisplayName:
{
Description: User friendly display name of the parent monitor ,
Required: False ,
}
string ,
monitorType:
{
Description: Type of the monitor ,
Enum:
{
Aggregate: No description available. ,
Dependency: No description available. ,
Unit: No description available. ,
}
,
Required: False ,
}
enum ,
monitorCategory:
{
Description: Category of the monitor ,
Enum:
{
AvailabilityHealth: No description available. ,
Configuration: No description available. ,
EntityHealth: No description available. ,
PerformanceHealth: No description available. ,
Security: No description available. ,
}
,
Required: False ,
}
enum ,
componentTypeId:
{
Description: Component Type Id of monitor ,
Required: False ,
}
string ,
componentTypeName:
{
Description: Component Type Name of monitor ,
Required: False ,
}
string ,
componentTypeDisplayName:
{
Description: Component Type Display Name of the monitor ,
Required: False ,
}
string ,
monitorState:
{
Description: Is the monitor state enabled or disabled ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
criteria:
{
Description: Collection of MonitorCriteria. For PATCH calls, instead of partial list, complete list of expected criteria should be passed for proper updating. ,
Required: False ,
}
[
{
healthState:
{
Description: Target health state of the criteria ,
Enum:
{
Error: No description available. ,
Warning: No description available. ,
Success: No description available. ,
Unknown: No description available. ,
Uninitialized: No description available. ,
}
,
Required: False ,
}
enum ,
threshold:
{
Description: Threshold value for this criteria ,
Format: double ,
Required: False ,
}
number ,
comparisonOperator:
{
Description: Comparison enum on threshold of this criteria ,
Enum:
{
Equals: No description available. ,
GreaterThan: No description available. ,
GreaterThanOrEqual: No description available. ,
LessThan: No description available. ,
LessThanOrEqual: No description available. ,
NotEquals: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
alertGeneration:
{
Description: Generates alerts or not ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
frequency:
{
Description: Frequency at which monitor condition is evaluated ,
Format: int32 ,
Required: False ,
}
integer ,
lookbackDuration:
{
Description: The duration in minutes in the past during which the monitor is evaluated ,
Format: int32 ,
Required: False ,
}
integer ,
documentationURL:
{
Description: URL pointing to the documentation of the monitor ,
Required: False ,
}
string ,
signalName:
{
Description: Name of the signal on which this monitor is configured. ,
Required: False ,
}
string ,
signalType:
{
Description: Type of the signal on which this monitor is configured. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
Monitors_Get (removed)
Description :  Get details of a single monitor.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceNamespace}/{resourceType}/{resourceName}/providers/Microsoft.WorkloadMonitor/monitors/{monitorId}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceNamespace:
{
Description: The Namespace of the resource. ,
Required: True ,
}
string ,
resourceType:
{
Description: The type of the resource. ,
Required: True ,
}
string ,
resourceName:
{
Description: Name of the resource. ,
Required: True ,
}
string ,
monitorId:
{
Description: Monitor Id. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: For optimistic concurrency control. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of monitor instance ,
Required: False ,
}
{
description:
{
Description: Description of the monitor ,
Required: False ,
}
string ,
monitorId:
{
Description: ID of the monitor ,
Required: False ,
}
string ,
monitorName:
{
Description: Name of the monitor ,
Required: False ,
}
string ,
monitorDisplayName:
{
Description: User friendly display name of the monitor ,
Required: False ,
}
string ,
parentMonitorName:
{
Description: Name of the parent monitor ,
Required: False ,
}
string ,
parentMonitorDisplayName:
{
Description: User friendly display name of the parent monitor ,
Required: False ,
}
string ,
monitorType:
{
Description: Type of the monitor ,
Enum:
{
Aggregate: No description available. ,
Dependency: No description available. ,
Unit: No description available. ,
}
,
Required: False ,
}
enum ,
monitorCategory:
{
Description: Category of the monitor ,
Enum:
{
AvailabilityHealth: No description available. ,
Configuration: No description available. ,
EntityHealth: No description available. ,
PerformanceHealth: No description available. ,
Security: No description available. ,
}
,
Required: False ,
}
enum ,
componentTypeId:
{
Description: Component Type Id of monitor ,
Required: False ,
}
string ,
componentTypeName:
{
Description: Component Type Name of monitor ,
Required: False ,
}
string ,
componentTypeDisplayName:
{
Description: Component Type Display Name of the monitor ,
Required: False ,
}
string ,
monitorState:
{
Description: Is the monitor state enabled or disabled ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
criteria:
{
Description: Collection of MonitorCriteria. For PATCH calls, instead of partial list, complete list of expected criteria should be passed for proper updating. ,
Required: False ,
}
[
{
healthState:
{
Description: Target health state of the criteria ,
Enum:
{
Error: No description available. ,
Warning: No description available. ,
Success: No description available. ,
Unknown: No description available. ,
Uninitialized: No description available. ,
}
,
Required: False ,
}
enum ,
threshold:
{
Description: Threshold value for this criteria ,
Format: double ,
Required: False ,
}
number ,
comparisonOperator:
{
Description: Comparison enum on threshold of this criteria ,
Enum:
{
Equals: No description available. ,
GreaterThan: No description available. ,
GreaterThanOrEqual: No description available. ,
LessThan: No description available. ,
LessThanOrEqual: No description available. ,
NotEquals: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
alertGeneration:
{
Description: Generates alerts or not ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
frequency:
{
Description: Frequency at which monitor condition is evaluated ,
Format: int32 ,
Required: False ,
}
integer ,
lookbackDuration:
{
Description: The duration in minutes in the past during which the monitor is evaluated ,
Format: int32 ,
Required: False ,
}
integer ,
documentationURL:
{
Description: URL pointing to the documentation of the monitor ,
Required: False ,
}
string ,
signalName:
{
Description: Name of the signal on which this monitor is configured. ,
Required: False ,
}
string ,
signalType:
{
Description: Type of the signal on which this monitor is configured. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
Monitors_Update (removed)
Description :  Update a Monitor's configuration.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceNamespace}/{resourceType}/{resourceName}/providers/Microsoft.WorkloadMonitor/monitors/{monitorId}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceNamespace:
{
Description: The Namespace of the resource. ,
Required: True ,
}
string ,
resourceType:
{
Description: The type of the resource. ,
Required: True ,
}
string ,
resourceName:
{
Description: Name of the resource. ,
Required: True ,
}
string ,
monitorId:
{
Description: Monitor Id. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: Body of the Monitor PATCH object. ,
Required: True ,
}
{
etag:
{
Description: For optimistic concurrency control. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of monitor instance ,
Required: False ,
}
{
description:
{
Description: Description of the monitor ,
Required: False ,
}
string ,
monitorId:
{
Description: ID of the monitor ,
Required: False ,
}
string ,
monitorName:
{
Description: Name of the monitor ,
Required: False ,
}
string ,
monitorDisplayName:
{
Description: User friendly display name of the monitor ,
Required: False ,
}
string ,
parentMonitorName:
{
Description: Name of the parent monitor ,
Required: False ,
}
string ,
parentMonitorDisplayName:
{
Description: User friendly display name of the parent monitor ,
Required: False ,
}
string ,
monitorType:
{
Description: Type of the monitor ,
Enum:
{
Aggregate: No description available. ,
Dependency: No description available. ,
Unit: No description available. ,
}
,
Required: False ,
}
enum ,
monitorCategory:
{
Description: Category of the monitor ,
Enum:
{
AvailabilityHealth: No description available. ,
Configuration: No description available. ,
EntityHealth: No description available. ,
PerformanceHealth: No description available. ,
Security: No description available. ,
}
,
Required: False ,
}
enum ,
componentTypeId:
{
Description: Component Type Id of monitor ,
Required: False ,
}
string ,
componentTypeName:
{
Description: Component Type Name of monitor ,
Required: False ,
}
string ,
componentTypeDisplayName:
{
Description: Component Type Display Name of the monitor ,
Required: False ,
}
string ,
monitorState:
{
Description: Is the monitor state enabled or disabled ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
criteria:
{
Description: Collection of MonitorCriteria. For PATCH calls, instead of partial list, complete list of expected criteria should be passed for proper updating. ,
Required: False ,
}
[
{
healthState:
{
Description: Target health state of the criteria ,
Enum:
{
Error: No description available. ,
Warning: No description available. ,
Success: No description available. ,
Unknown: No description available. ,
Uninitialized: No description available. ,
}
,
Required: False ,
}
enum ,
threshold:
{
Description: Threshold value for this criteria ,
Format: double ,
Required: False ,
}
number ,
comparisonOperator:
{
Description: Comparison enum on threshold of this criteria ,
Enum:
{
Equals: No description available. ,
GreaterThan: No description available. ,
GreaterThanOrEqual: No description available. ,
LessThan: No description available. ,
LessThanOrEqual: No description available. ,
NotEquals: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
alertGeneration:
{
Description: Generates alerts or not ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
frequency:
{
Description: Frequency at which monitor condition is evaluated ,
Format: int32 ,
Required: False ,
}
integer ,
lookbackDuration:
{
Description: The duration in minutes in the past during which the monitor is evaluated ,
Format: int32 ,
Required: False ,
}
integer ,
documentationURL:
{
Description: URL pointing to the documentation of the monitor ,
Required: False ,
}
string ,
signalName:
{
Description: Name of the signal on which this monitor is configured. ,
Required: False ,
}
string ,
signalType:
{
Description: Type of the signal on which this monitor is configured. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
etag:
{
Description: For optimistic concurrency control. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of monitor instance ,
Required: False ,
}
{
description:
{
Description: Description of the monitor ,
Required: False ,
}
string ,
monitorId:
{
Description: ID of the monitor ,
Required: False ,
}
string ,
monitorName:
{
Description: Name of the monitor ,
Required: False ,
}
string ,
monitorDisplayName:
{
Description: User friendly display name of the monitor ,
Required: False ,
}
string ,
parentMonitorName:
{
Description: Name of the parent monitor ,
Required: False ,
}
string ,
parentMonitorDisplayName:
{
Description: User friendly display name of the parent monitor ,
Required: False ,
}
string ,
monitorType:
{
Description: Type of the monitor ,
Enum:
{
Aggregate: No description available. ,
Dependency: No description available. ,
Unit: No description available. ,
}
,
Required: False ,
}
enum ,
monitorCategory:
{
Description: Category of the monitor ,
Enum:
{
AvailabilityHealth: No description available. ,
Configuration: No description available. ,
EntityHealth: No description available. ,
PerformanceHealth: No description available. ,
Security: No description available. ,
}
,
Required: False ,
}
enum ,
componentTypeId:
{
Description: Component Type Id of monitor ,
Required: False ,
}
string ,
componentTypeName:
{
Description: Component Type Name of monitor ,
Required: False ,
}
string ,
componentTypeDisplayName:
{
Description: Component Type Display Name of the monitor ,
Required: False ,
}
string ,
monitorState:
{
Description: Is the monitor state enabled or disabled ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
criteria:
{
Description: Collection of MonitorCriteria. For PATCH calls, instead of partial list, complete list of expected criteria should be passed for proper updating. ,
Required: False ,
}
[
{
healthState:
{
Description: Target health state of the criteria ,
Enum:
{
Error: No description available. ,
Warning: No description available. ,
Success: No description available. ,
Unknown: No description available. ,
Uninitialized: No description available. ,
}
,
Required: False ,
}
enum ,
threshold:
{
Description: Threshold value for this criteria ,
Format: double ,
Required: False ,
}
number ,
comparisonOperator:
{
Description: Comparison enum on threshold of this criteria ,
Enum:
{
Equals: No description available. ,
GreaterThan: No description available. ,
GreaterThanOrEqual: No description available. ,
LessThan: No description available. ,
LessThanOrEqual: No description available. ,
NotEquals: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
alertGeneration:
{
Description: Generates alerts or not ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
frequency:
{
Description: Frequency at which monitor condition is evaluated ,
Format: int32 ,
Required: False ,
}
integer ,
lookbackDuration:
{
Description: The duration in minutes in the past during which the monitor is evaluated ,
Format: int32 ,
Required: False ,
}
integer ,
documentationURL:
{
Description: URL pointing to the documentation of the monitor ,
Required: False ,
}
string ,
signalName:
{
Description: Name of the signal on which this monitor is configured. ,
Required: False ,
}
string ,
signalType:
{
Description: Type of the signal on which this monitor is configured. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
Components_ListByResource (removed)
Description :  Get list of components for a resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceNamespace}/{resourceType}/{resourceName}/providers/Microsoft.WorkloadMonitor/components
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceNamespace:
{
Description: The Namespace of the resource. ,
Required: True ,
}
string ,
resourceType:
{
Description: The type of the resource. ,
Required: True ,
}
string ,
resourceName:
{
Description: Name of the resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$select:
{
Description: Properties to be returned in the response. ,
Required: False ,
}
string ,
$filter:
{
Description: Filter to be applied on the operation. ,
Required: False ,
}
string ,
$apply:
{
Description: Apply aggregation. ,
Required: False ,
}
string ,
$orderby:
{
Description: Sort the result on one or more properties. ,
Required: False ,
}
string ,
$expand:
{
Description: Include properties inline in the response. ,
Required: False ,
}
string ,
$top:
{
Description: Limit the result to the specified number of rows. ,
Required: False ,
}
string ,
$skiptoken:
{
Description: The page-continuation token to use with a paged version of this API. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: URL to the next set of results. ,
Required: False ,
}
string ,
value:
{
Description: Collection of components. ,
Required: False ,
}
[
{
etag:
{
Description: For optimistic concurrency control. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the component. ,
Required: False ,
}
{
workspaceId:
{
Description: ID of the workspace. ,
Required: False ,
}
string ,
solutionId:
{
Description: ID of the OMS solution this component belong to. ,
Required: False ,
}
string ,
workloadType:
{
Description: Type of the workload. ,
Enum:
{
BaseOS: No description available. ,
SQL: No description available. ,
IIS: No description available. ,
Apache: No description available. ,
}
,
Required: False ,
}
enum ,
componentName:
{
Description: Name of the component. ,
Required: False ,
}
string ,
componentTypeId:
{
Description: ID of the component type. ,
Required: False ,
}
string ,
componentTypeName:
{
Description: Name of the component type. Qualifies the type of component such as whether it is a SQL database, logical disk, website, etc. ,
Required: False ,
}
string ,
componentTypeGroupCategory:
{
Description: Component type group category. Classification of component type groups into a logical category. e.g. Network, Disk, Memory, CPU. ,
Required: False ,
}
string ,
healthState:
{
Description: Health state of the component. ,
Enum:
{
Error: No description available. ,
Warning: No description available. ,
Success: No description available. ,
Unknown: No description available. ,
Uninitialized: No description available. ,
}
,
Required: False ,
}
enum ,
healthStateCategory:
{
Description: Category of component's health state. ,
Enum:
{
Identity: No description available. ,
CustomGroup: No description available. ,
}
,
Required: False ,
}
enum ,
healthStateChangesStartTime:
{
Description: Start time for health state changes. ,
Format: date-time ,
Required: False ,
}
string ,
healthStateChangesEndTime:
{
Description: End time for health state changes. ,
Format: date-time ,
Required: False ,
}
string ,
lastHealthStateChangeTime:
{
Description: Time of last health state change. ,
Format: date-time ,
Required: False ,
}
string ,
vmId:
{
Description: ID of the VM this component belongs to. ,
Required: False ,
}
string ,
vmName:
{
Description: Name of the VM this component belongs to. ,
Required: False ,
}
string ,
vmTags:
{
Description: Tags on the VM this component belongs to. ,
Required: False ,
}
object ,
aggregateProperties:
{
Description: Properties requested in aggregation queries. ,
Required: False ,
}
object ,
children:
{
Description: component children. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
Components_Get (removed)
Description :  Get details of a component.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceNamespace}/{resourceType}/{resourceName}/providers/Microsoft.WorkloadMonitor/components/{componentId}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceNamespace:
{
Description: The Namespace of the resource. ,
Required: True ,
}
string ,
resourceType:
{
Description: The type of the resource. ,
Required: True ,
}
string ,
resourceName:
{
Description: Name of the resource. ,
Required: True ,
}
string ,
componentId:
{
Description: Component Id. ,
Format: uuid ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$select:
{
Description: Properties to be returned in the response. ,
Required: False ,
}
string ,
$expand:
{
Description: Include properties inline in the response. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: For optimistic concurrency control. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the component. ,
Required: False ,
}
{
workspaceId:
{
Description: ID of the workspace. ,
Required: False ,
}
string ,
solutionId:
{
Description: ID of the OMS solution this component belong to. ,
Required: False ,
}
string ,
workloadType:
{
Description: Type of the workload. ,
Enum:
{
BaseOS: No description available. ,
SQL: No description available. ,
IIS: No description available. ,
Apache: No description available. ,
}
,
Required: False ,
}
enum ,
componentName:
{
Description: Name of the component. ,
Required: False ,
}
string ,
componentTypeId:
{
Description: ID of the component type. ,
Required: False ,
}
string ,
componentTypeName:
{
Description: Name of the component type. Qualifies the type of component such as whether it is a SQL database, logical disk, website, etc. ,
Required: False ,
}
string ,
componentTypeGroupCategory:
{
Description: Component type group category. Classification of component type groups into a logical category. e.g. Network, Disk, Memory, CPU. ,
Required: False ,
}
string ,
healthState:
{
Description: Health state of the component. ,
Enum:
{
Error: No description available. ,
Warning: No description available. ,
Success: No description available. ,
Unknown: No description available. ,
Uninitialized: No description available. ,
}
,
Required: False ,
}
enum ,
healthStateCategory:
{
Description: Category of component's health state. ,
Enum:
{
Identity: No description available. ,
CustomGroup: No description available. ,
}
,
Required: False ,
}
enum ,
healthStateChangesStartTime:
{
Description: Start time for health state changes. ,
Format: date-time ,
Required: False ,
}
string ,
healthStateChangesEndTime:
{
Description: End time for health state changes. ,
Format: date-time ,
Required: False ,
}
string ,
lastHealthStateChangeTime:
{
Description: Time of last health state change. ,
Format: date-time ,
Required: False ,
}
string ,
vmId:
{
Description: ID of the VM this component belongs to. ,
Required: False ,
}
string ,
vmName:
{
Description: Name of the VM this component belongs to. ,
Required: False ,
}
string ,
vmTags:
{
Description: Tags on the VM this component belongs to. ,
Required: False ,
}
object ,
aggregateProperties:
{
Description: Properties requested in aggregation queries. ,
Required: False ,
}
object ,
children:
{
Description: component children. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
MonitorInstances_ListByResource (removed)
Description :  Get list of monitor instances for a resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceNamespace}/{resourceType}/{resourceName}/providers/Microsoft.WorkloadMonitor/monitorInstances
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceNamespace:
{
Description: The Namespace of the resource. ,
Required: True ,
}
string ,
resourceType:
{
Description: The type of the resource. ,
Required: True ,
}
string ,
resourceName:
{
Description: Name of the resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$select:
{
Description: Properties to be returned in the response. ,
Required: False ,
}
string ,
$filter:
{
Description: Filter to be applied on the operation. ,
Required: False ,
}
string ,
$apply:
{
Description: Apply aggregation. ,
Required: False ,
}
string ,
$orderby:
{
Description: Sort the result on one or more properties. ,
Required: False ,
}
string ,
$expand:
{
Description: Include properties inline in the response. ,
Required: False ,
}
string ,
$top:
{
Description: Limit the result to the specified number of rows. ,
Required: False ,
}
string ,
$skiptoken:
{
Description: The page-continuation token to use with a paged version of this API. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: URL to the next set of results. ,
Required: False ,
}
string ,
value:
{
Description: Collection of health instances. ,
Required: False ,
}
[
{
etag:
{
Description: For optimistic concurrency control. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the monitor instance. ,
Required: False ,
}
{
workspaceId:
{
Description: ID of the workspace. ,
Required: False ,
}
string ,
solutionId:
{
Description: ID of the OMS solution this health instance belong to. ,
Required: False ,
}
string ,
workloadType:
{
Description: Type of the workload. ,
Enum:
{
BaseOS: No description available. ,
SQL: No description available. ,
IIS: No description available. ,
Apache: No description available. ,
}
,
Required: False ,
}
enum ,
componentId:
{
Description: ID of the component. ,
Required: False ,
}
string ,
componentName:
{
Description: Name of the component. ,
Required: False ,
}
string ,
componentTypeId:
{
Description: ID of the component type. ,
Required: False ,
}
string ,
componentTypeName:
{
Description: Name of the component type. Qualifies the type of component such as whether it is a SQL database, logical disk, website, etc. ,
Required: False ,
}
string ,
monitorId:
{
Description: ID of the monitor instance. ,
Required: False ,
}
string ,
monitorName:
{
Description: Name of the monitor. ,
Required: False ,
}
string ,
monitorType:
{
Description: Type of the monitor. The qualifier for the health criteria depending on the functionality it performs such as Unit, Aggregate, Dependency. ,
Enum:
{
Aggregate: No description available. ,
Dependency: No description available. ,
Unit: No description available. ,
}
,
Required: False ,
}
enum ,
monitorCategory:
{
Description: Monitor type category. Indicates the attribute of the component that the health criteria monitors such as Performance, Availability, etc. ,
Enum:
{
AvailabilityHealth: No description available. ,
Configuration: No description available. ,
EntityHealth: No description available. ,
PerformanceHealth: No description available. ,
Security: No description available. ,
}
,
Required: False ,
}
enum ,
healthState:
{
Description: Health state of monitor instance. ,
Enum:
{
Error: No description available. ,
Warning: No description available. ,
Success: No description available. ,
Unknown: No description available. ,
Uninitialized: No description available. ,
}
,
Required: False ,
}
enum ,
healthStateCategory:
{
Description: Category of monitor instance's health state. ,
Enum:
{
Identity: No description available. ,
CustomGroup: No description available. ,
}
,
Required: False ,
}
enum ,
healthStateChanges:
{
Description: Health state changes. ,
Required: False ,
}
[
{
healthState:
{
Description: Health state of monitor instance. ,
Enum:
{
Error: No description available. ,
Warning: No description available. ,
Success: No description available. ,
Unknown: No description available. ,
Uninitialized: No description available. ,
}
,
Required: False ,
}
enum ,
healthStateChangeTime:
{
Description: Time at which this Health state was reached. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
healthStateChangesStartTime:
{
Description: Start time for health state changes. ,
Format: date-time ,
Required: False ,
}
string ,
healthStateChangesEndTime:
{
Description: End time for health state changes. ,
Format: date-time ,
Required: False ,
}
string ,
lastHealthStateChangeTime:
{
Description: Time of last health state change. ,
Format: date-time ,
Required: False ,
}
string ,
alertGeneration:
{
Description: Generates alert or not. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
aggregateProperties:
{
Description: Properties requested in aggregation queries. ,
Required: False ,
}
object ,
children:
{
Description: Health instance children. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
MonitorInstances_Get (removed)
Description :  Get details of a monitorInstance.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceNamespace}/{resourceType}/{resourceName}/providers/Microsoft.WorkloadMonitor/monitorInstances/{monitorInstanceId}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceNamespace:
{
Description: The Namespace of the resource. ,
Required: True ,
}
string ,
resourceType:
{
Description: The type of the resource. ,
Required: True ,
}
string ,
resourceName:
{
Description: Name of the resource. ,
Required: True ,
}
string ,
monitorInstanceId:
{
Description: MonitorInstance Id. ,
Format: uuid ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$select:
{
Description: Properties to be returned in the response. ,
Required: False ,
}
string ,
$expand:
{
Description: Include properties inline in the response. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: For optimistic concurrency control. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the monitor instance. ,
Required: False ,
}
{
workspaceId:
{
Description: ID of the workspace. ,
Required: False ,
}
string ,
solutionId:
{
Description: ID of the OMS solution this health instance belong to. ,
Required: False ,
}
string ,
workloadType:
{
Description: Type of the workload. ,
Enum:
{
BaseOS: No description available. ,
SQL: No description available. ,
IIS: No description available. ,
Apache: No description available. ,
}
,
Required: False ,
}
enum ,
componentId:
{
Description: ID of the component. ,
Required: False ,
}
string ,
componentName:
{
Description: Name of the component. ,
Required: False ,
}
string ,
componentTypeId:
{
Description: ID of the component type. ,
Required: False ,
}
string ,
componentTypeName:
{
Description: Name of the component type. Qualifies the type of component such as whether it is a SQL database, logical disk, website, etc. ,
Required: False ,
}
string ,
monitorId:
{
Description: ID of the monitor instance. ,
Required: False ,
}
string ,
monitorName:
{
Description: Name of the monitor. ,
Required: False ,
}
string ,
monitorType:
{
Description: Type of the monitor. The qualifier for the health criteria depending on the functionality it performs such as Unit, Aggregate, Dependency. ,
Enum:
{
Aggregate: No description available. ,
Dependency: No description available. ,
Unit: No description available. ,
}
,
Required: False ,
}
enum ,
monitorCategory:
{
Description: Monitor type category. Indicates the attribute of the component that the health criteria monitors such as Performance, Availability, etc. ,
Enum:
{
AvailabilityHealth: No description available. ,
Configuration: No description available. ,
EntityHealth: No description available. ,
PerformanceHealth: No description available. ,
Security: No description available. ,
}
,
Required: False ,
}
enum ,
healthState:
{
Description: Health state of monitor instance. ,
Enum:
{
Error: No description available. ,
Warning: No description available. ,
Success: No description available. ,
Unknown: No description available. ,
Uninitialized: No description available. ,
}
,
Required: False ,
}
enum ,
healthStateCategory:
{
Description: Category of monitor instance's health state. ,
Enum:
{
Identity: No description available. ,
CustomGroup: No description available. ,
}
,
Required: False ,
}
enum ,
healthStateChanges:
{
Description: Health state changes. ,
Required: False ,
}
[
{
healthState:
{
Description: Health state of monitor instance. ,
Enum:
{
Error: No description available. ,
Warning: No description available. ,
Success: No description available. ,
Unknown: No description available. ,
Uninitialized: No description available. ,
}
,
Required: False ,
}
enum ,
healthStateChangeTime:
{
Description: Time at which this Health state was reached. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
healthStateChangesStartTime:
{
Description: Start time for health state changes. ,
Format: date-time ,
Required: False ,
}
string ,
healthStateChangesEndTime:
{
Description: End time for health state changes. ,
Format: date-time ,
Required: False ,
}
string ,
lastHealthStateChangeTime:
{
Description: Time of last health state change. ,
Format: date-time ,
Required: False ,
}
string ,
alertGeneration:
{
Description: Generates alert or not. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
aggregateProperties:
{
Description: Properties requested in aggregation queries. ,
Required: False ,
}
object ,
children:
{
Description: Health instance children. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
NotificationSettings_ListByResource (removed)
Description :  Get list of notification settings for a resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceNamespace}/{resourceType}/{resourceName}/providers/Microsoft.WorkloadMonitor/notificationSettings
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceNamespace:
{
Description: The Namespace of the resource. ,
Required: True ,
}
string ,
resourceType:
{
Description: The type of the resource. ,
Required: True ,
}
string ,
resourceName:
{
Description: Name of the resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$skiptoken:
{
Description: The page-continuation token to use with a paged version of this API. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
etag:
{
Description: For optimistic concurrency control. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of Notification Settings ,
Required: False ,
}
{
actionGroupResourceIds:
{
Description: List of action group resource ids to be notified ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
nextLink:
{
Description: URL to the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
NotificationSettings_Get (removed)
Description :  Get a of notification setting for a resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceNamespace}/{resourceType}/{resourceName}/providers/Microsoft.WorkloadMonitor/notificationSettings/{notificationSettingName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceNamespace:
{
Description: The Namespace of the resource. ,
Required: True ,
}
string ,
resourceType:
{
Description: The type of the resource. ,
Required: True ,
}
string ,
resourceName:
{
Description: Name of the resource. ,
Required: True ,
}
string ,
notificationSettingName:
{
Description: Default string modeled as parameter for URL to work correctly. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: For optimistic concurrency control. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of Notification Settings ,
Required: False ,
}
{
actionGroupResourceIds:
{
Description: List of action group resource ids to be notified ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
NotificationSettings_Update (removed)
Description :  Update notification settings for a resource.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceNamespace}/{resourceType}/{resourceName}/providers/Microsoft.WorkloadMonitor/notificationSettings/{notificationSettingName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceNamespace:
{
Description: The Namespace of the resource. ,
Required: True ,
}
string ,
resourceType:
{
Description: The type of the resource. ,
Required: True ,
}
string ,
resourceName:
{
Description: Name of the resource. ,
Required: True ,
}
string ,
notificationSettingName:
{
Description: Default string modeled as parameter for URL to work correctly. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: Body of the NotificationSetting PUT object. ,
Required: True ,
}
{
etag:
{
Description: For optimistic concurrency control. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of Notification Settings ,
Required: False ,
}
{
actionGroupResourceIds:
{
Description: List of action group resource ids to be notified ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (200)

{
etag:
{
Description: For optimistic concurrency control. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of Notification Settings ,
Required: False ,
}
{
actionGroupResourceIds:
{
Description: List of action group resource ids to be notified ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
ComponentsSummary_List (removed)
Description :  Get subscription wide details of components.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.WorkloadMonitor/componentsSummary
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$select:
{
Description: Properties to be returned in the response. ,
Required: False ,
}
string ,
$filter:
{
Description: Filter to be applied on the operation. ,
Required: False ,
}
string ,
$apply:
{
Description: Apply aggregation. ,
Required: False ,
}
string ,
$orderby:
{
Description: Sort the result on one or more properties. ,
Required: False ,
}
string ,
$expand:
{
Description: Include properties inline in the response. ,
Required: False ,
}
string ,
$top:
{
Description: Limit the result to the specified number of rows. ,
Required: False ,
}
string ,
$skiptoken:
{
Description: The page-continuation token to use with a paged version of this API. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: URL to the next set of results. ,
Required: False ,
}
string ,
value:
{
Description: Collection of components. ,
Required: False ,
}
[
{
etag:
{
Description: For optimistic concurrency control. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the component. ,
Required: False ,
}
{
workspaceId:
{
Description: ID of the workspace. ,
Required: False ,
}
string ,
solutionId:
{
Description: ID of the OMS solution this component belong to. ,
Required: False ,
}
string ,
workloadType:
{
Description: Type of the workload. ,
Enum:
{
BaseOS: No description available. ,
SQL: No description available. ,
IIS: No description available. ,
Apache: No description available. ,
}
,
Required: False ,
}
enum ,
componentName:
{
Description: Name of the component. ,
Required: False ,
}
string ,
componentTypeId:
{
Description: ID of the component type. ,
Required: False ,
}
string ,
componentTypeName:
{
Description: Name of the component type. Qualifies the type of component such as whether it is a SQL database, logical disk, website, etc. ,
Required: False ,
}
string ,
componentTypeGroupCategory:
{
Description: Component type group category. Classification of component type groups into a logical category. e.g. Network, Disk, Memory, CPU. ,
Required: False ,
}
string ,
healthState:
{
Description: Health state of the component. ,
Enum:
{
Error: No description available. ,
Warning: No description available. ,
Success: No description available. ,
Unknown: No description available. ,
Uninitialized: No description available. ,
}
,
Required: False ,
}
enum ,
healthStateCategory:
{
Description: Category of component's health state. ,
Enum:
{
Identity: No description available. ,
CustomGroup: No description available. ,
}
,
Required: False ,
}
enum ,
healthStateChangesStartTime:
{
Description: Start time for health state changes. ,
Format: date-time ,
Required: False ,
}
string ,
healthStateChangesEndTime:
{
Description: End time for health state changes. ,
Format: date-time ,
Required: False ,
}
string ,
lastHealthStateChangeTime:
{
Description: Time of last health state change. ,
Format: date-time ,
Required: False ,
}
string ,
vmId:
{
Description: ID of the VM this component belongs to. ,
Required: False ,
}
string ,
vmName:
{
Description: Name of the VM this component belongs to. ,
Required: False ,
}
string ,
vmTags:
{
Description: Tags on the VM this component belongs to. ,
Required: False ,
}
object ,
aggregateProperties:
{
Description: Properties requested in aggregation queries. ,
Required: False ,
}
object ,
children:
{
Description: component children. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
MonitorInstancesSummary_List (removed)
Description :  Get subscription wide health instances.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.WorkloadMonitor/monitorInstancesSummary
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$select:
{
Description: Properties to be returned in the response. ,
Required: False ,
}
string ,
$filter:
{
Description: Filter to be applied on the operation. ,
Required: False ,
}
string ,
$apply:
{
Description: Apply aggregation. ,
Required: False ,
}
string ,
$orderby:
{
Description: Sort the result on one or more properties. ,
Required: False ,
}
string ,
$expand:
{
Description: Include properties inline in the response. ,
Required: False ,
}
string ,
$top:
{
Description: Limit the result to the specified number of rows. ,
Required: False ,
}
string ,
$skiptoken:
{
Description: The page-continuation token to use with a paged version of this API. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: URL to the next set of results. ,
Required: False ,
}
string ,
value:
{
Description: Collection of health instances. ,
Required: False ,
}
[
{
etag:
{
Description: For optimistic concurrency control. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the monitor instance. ,
Required: False ,
}
{
workspaceId:
{
Description: ID of the workspace. ,
Required: False ,
}
string ,
solutionId:
{
Description: ID of the OMS solution this health instance belong to. ,
Required: False ,
}
string ,
workloadType:
{
Description: Type of the workload. ,
Enum:
{
BaseOS: No description available. ,
SQL: No description available. ,
IIS: No description available. ,
Apache: No description available. ,
}
,
Required: False ,
}
enum ,
componentId:
{
Description: ID of the component. ,
Required: False ,
}
string ,
componentName:
{
Description: Name of the component. ,
Required: False ,
}
string ,
componentTypeId:
{
Description: ID of the component type. ,
Required: False ,
}
string ,
componentTypeName:
{
Description: Name of the component type. Qualifies the type of component such as whether it is a SQL database, logical disk, website, etc. ,
Required: False ,
}
string ,
monitorId:
{
Description: ID of the monitor instance. ,
Required: False ,
}
string ,
monitorName:
{
Description: Name of the monitor. ,
Required: False ,
}
string ,
monitorType:
{
Description: Type of the monitor. The qualifier for the health criteria depending on the functionality it performs such as Unit, Aggregate, Dependency. ,
Enum:
{
Aggregate: No description available. ,
Dependency: No description available. ,
Unit: No description available. ,
}
,
Required: False ,
}
enum ,
monitorCategory:
{
Description: Monitor type category. Indicates the attribute of the component that the health criteria monitors such as Performance, Availability, etc. ,
Enum:
{
AvailabilityHealth: No description available. ,
Configuration: No description available. ,
EntityHealth: No description available. ,
PerformanceHealth: No description available. ,
Security: No description available. ,
}
,
Required: False ,
}
enum ,
healthState:
{
Description: Health state of monitor instance. ,
Enum:
{
Error: No description available. ,
Warning: No description available. ,
Success: No description available. ,
Unknown: No description available. ,
Uninitialized: No description available. ,
}
,
Required: False ,
}
enum ,
healthStateCategory:
{
Description: Category of monitor instance's health state. ,
Enum:
{
Identity: No description available. ,
CustomGroup: No description available. ,
}
,
Required: False ,
}
enum ,
healthStateChanges:
{
Description: Health state changes. ,
Required: False ,
}
[
{
healthState:
{
Description: Health state of monitor instance. ,
Enum:
{
Error: No description available. ,
Warning: No description available. ,
Success: No description available. ,
Unknown: No description available. ,
Uninitialized: No description available. ,
}
,
Required: False ,
}
enum ,
healthStateChangeTime:
{
Description: Time at which this Health state was reached. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
healthStateChangesStartTime:
{
Description: Start time for health state changes. ,
Format: date-time ,
Required: False ,
}
string ,
healthStateChangesEndTime:
{
Description: End time for health state changes. ,
Format: date-time ,
Required: False ,
}
string ,
lastHealthStateChangeTime:
{
Description: Time of last health state change. ,
Format: date-time ,
Required: False ,
}
string ,
alertGeneration:
{
Description: Generates alert or not. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
aggregateProperties:
{
Description: Properties requested in aggregation queries. ,
Required: False ,
}
object ,
children:
{
Description: Health instance children. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
Operations_List (removed)
Description :  Gets the details of all operations possible on the resource provider.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.WorkloadMonitor/operations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$skiptoken:
{
Description: The page-continuation token to use with a paged version of this API. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: URL to the next set of results. ,
Required: False ,
}
string ,
value:
{
Description: List of operations. ,
Required: False ,
}
[
{
display:
{
Description: The properties of the resource operation. ,
Required: False ,
}
{
description:
{
Description: The description of the resource provider. ,
Required: False ,
}
string ,
operation:
{
Description: This operation name. ,
Required: False ,
}
string ,
provider:
{
Description: The provider name. ,
Required: False ,
}
string ,
resource:
{
Description: The resource name. ,
Required: False ,
}
string ,
}
,
name:
{
Description: The name of the resource operation. ,
Required: False ,
}
string ,
origin:
{
Description: The origin of the operation. ,
Required: False ,
}
string ,
}
,
]
,
}