Skip to content
This repository has been archived by the owner on May 5, 2023. It is now read-only.

[AutoPR monitor/resource-manager] Updates to Scheduled Query Rule swagger #4773

Merged
merged 1 commit into from
Feb 27, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion lib/services/monitorManagement/LICENSE.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
The MIT License (MIT)

Copyright (c) 2018 Microsoft
Copyright (c) 2019 Microsoft

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
31 changes: 17 additions & 14 deletions lib/services/monitorManagement/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,39 +3,42 @@ uid: azure-arm-monitor
summary: *content

---
# Microsoft Azure SDK for Node.js - MonitorManagementClient
**This SDK will be deprecated next year and will be replaced by a new TypeScript-based isomorphic SDK (found at https://github.com/Azure/azure-sdk-for-js) which works on Node.js and browsers.**
## Microsoft Azure SDK for Node.js - MonitorManagementClient

This project provides a Node.js package for accessing Azure. Right now it supports:
- **Node.js version 6.x.x or higher**

## Features
### Features


## How to Install
### How to Install

```bash
npm install azure-arm-monitor
```

## How to use
### How to use

### Authentication, client creation and listByResourceGroup autoscaleSettings as an example.
#### Authentication, client creation, and listByResourceGroup autoscaleSettings as an example.

```javascript
const msRestAzure = require("ms-rest-azure");
const MonitorManagementClient = require("azure-arm-monitor");
msRestAzure.interactiveLogin().then((creds) => {
const subscriptionId = "<Subscription_Id>";
const client = new MonitorManagementClient(creds, subscriptionId);
const resourceGroupName = "testresourceGroupName";
return client.autoscaleSettings.listByResourceGroup(resourceGroupName).then((result) => {
console.log("The result is:");
console.log(result);
});
const subscriptionId = "<Subscription_Id>";
const client = new MonitorManagementClient(creds, subscriptionId);
const resourceGroupName = "testresourceGroupName";

return client.autoscaleSettings.listByResourceGroup(resourceGroupName).then((result) => {
console.log("The result is:");
console.log(result);
});
}).catch((err) => {
console.log('An error occurred:');
console.dir(err, {depth: null, colors: true});
});

## Related projects
```
### Related projects

- [Microsoft Azure SDK for Node.js](https://github.com/Azure/azure-sdk-for-node)
2 changes: 1 addition & 1 deletion lib/services/monitorManagement/lib/models/action.js
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
class Action {
/**
* Create a Action.
* @member {string} odatatype Polymorphic Discriminator
* @property {string} odatatype Polymorphic Discriminator
*/
constructor() {
}
Expand Down
4 changes: 2 additions & 2 deletions lib/services/monitorManagement/lib/models/actionGroupList.js
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@
class ActionGroupList extends Array {
/**
* Create a ActionGroupList.
* @member {string} [nextLink] Provides the link to retrieve the next set of
* elements.
* @property {string} [nextLink] Provides the link to retrieve the next set
* of elements.
*/
constructor() {
super();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@
class ActionGroupPatchBody {
/**
* Create a ActionGroupPatchBody.
* @member {object} [tags] Resource tags
* @member {boolean} [enabled] Indicates whether this action group is
* @property {object} [tags] Resource tags
* @property {boolean} [enabled] Indicates whether this action group is
* enabled. If an action group is not enabled, then none of its actions will
* be activated. Default value: true .
*/
Expand Down
40 changes: 20 additions & 20 deletions lib/services/monitorManagement/lib/models/actionGroupResource.js
Original file line number Diff line number Diff line change
Expand Up @@ -20,32 +20,32 @@ const models = require('./index');
class ActionGroupResource extends models['Resource'] {
/**
* Create a ActionGroupResource.
* @member {string} groupShortName The short name of the action group. This
* @property {string} groupShortName The short name of the action group. This
* will be used in SMS messages.
* @member {boolean} enabled Indicates whether this action group is enabled.
* If an action group is not enabled, then none of its receivers will receive
* communications. Default value: true .
* @member {array} [emailReceivers] The list of email receivers that are part
* of this action group.
* @member {array} [smsReceivers] The list of SMS receivers that are part of
* this action group.
* @member {array} [webhookReceivers] The list of webhook receivers that are
* @property {boolean} enabled Indicates whether this action group is
* enabled. If an action group is not enabled, then none of its receivers
* will receive communications. Default value: true .
* @property {array} [emailReceivers] The list of email receivers that are
* part of this action group.
* @member {array} [itsmReceivers] The list of ITSM receivers that are part
* @property {array} [smsReceivers] The list of SMS receivers that are part
* of this action group.
* @member {array} [azureAppPushReceivers] The list of AzureAppPush receivers
* that are part of this action group.
* @member {array} [automationRunbookReceivers] The list of AutomationRunbook
* receivers that are part of this action group.
* @member {array} [voiceReceivers] The list of voice receivers that are part
* @property {array} [webhookReceivers] The list of webhook receivers that
* are part of this action group.
* @property {array} [itsmReceivers] The list of ITSM receivers that are part
* of this action group.
* @member {array} [logicAppReceivers] The list of logic app receivers that
* @property {array} [azureAppPushReceivers] The list of AzureAppPush
* receivers that are part of this action group.
* @property {array} [automationRunbookReceivers] The list of
* AutomationRunbook receivers that are part of this action group.
* @property {array} [voiceReceivers] The list of voice receivers that are
* part of this action group.
* @property {array} [logicAppReceivers] The list of logic app receivers that
* are part of this action group.
* @member {array} [azureFunctionReceivers] The list of azure function
* @property {array} [azureFunctionReceivers] The list of azure function
* receivers that are part of this action group.
* @member {array} [armRoleReceivers] The list of ARM role receivers that are
* part of this action group. Roles are Azure RBAC roles and only built-in
* roles are supported.
* @property {array} [armRoleReceivers] The list of ARM role receivers that
* are part of this action group. Roles are Azure RBAC roles and only
* built-in roles are supported.
*/
constructor() {
super();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,9 @@
class ActivityLogAlertActionGroup {
/**
* Create a ActivityLogAlertActionGroup.
* @member {string} actionGroupId The resourceId of the action group. This
* @property {string} actionGroupId The resourceId of the action group. This
* cannot be null or empty.
* @member {object} [webhookProperties] the dictionary of custom properties
* @property {object} [webhookProperties] the dictionary of custom properties
* to include with the post operation. These data are appended to the webhook
* payload.
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
class ActivityLogAlertActionList {
/**
* Create a ActivityLogAlertActionList.
* @member {array} [actionGroups] The list of activity log alerts.
* @property {array} [actionGroups] The list of activity log alerts.
*/
constructor() {
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
class ActivityLogAlertAllOfCondition {
/**
* Create a ActivityLogAlertAllOfCondition.
* @member {array} allOf The list of activity log alert conditions.
* @property {array} allOf The list of activity log alert conditions.
*/
constructor() {
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,12 @@
class ActivityLogAlertLeafCondition {
/**
* Create a ActivityLogAlertLeafCondition.
* @member {string} field The name of the field that this condition will
* @property {string} field The name of the field that this condition will
* examine. The possible values for this field are (case-insensitive):
* 'resourceId', 'category', 'caller', 'level', 'operationName',
* 'resourceGroup', 'resourceProvider', 'status', 'subStatus',
* 'resourceType', or anything beginning with 'properties.'.
* @member {string} equals The field value will be compared to this value
* @property {string} equals The field value will be compared to this value
* (case-insensitive) to determine if the condition is met.
*/
constructor() {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@
class ActivityLogAlertList extends Array {
/**
* Create a ActivityLogAlertList.
* @member {string} [nextLink] Provides the link to retrieve the next set of
* elements.
* @property {string} [nextLink] Provides the link to retrieve the next set
* of elements.
*/
constructor() {
super();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@
class ActivityLogAlertPatchBody {
/**
* Create a ActivityLogAlertPatchBody.
* @member {object} [tags] Resource tags
* @member {boolean} [enabled] Indicates whether this activity log alert is
* @property {object} [tags] Resource tags
* @property {boolean} [enabled] Indicates whether this activity log alert is
* enabled. If an activity log alert is not enabled, then none of its actions
* will be activated. Default value: true .
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,21 +20,21 @@ const models = require('./index');
class ActivityLogAlertResource extends models['Resource'] {
/**
* Create a ActivityLogAlertResource.
* @member {array} scopes A list of resourceIds that will be used as
* @property {array} scopes A list of resourceIds that will be used as
* prefixes. The alert will only apply to activityLogs with resourceIds that
* fall under one of these prefixes. This list must include at least one
* item.
* @member {boolean} [enabled] Indicates whether this activity log alert is
* @property {boolean} [enabled] Indicates whether this activity log alert is
* enabled. If an activity log alert is not enabled, then none of its actions
* will be activated. Default value: true .
* @member {object} condition The condition that will cause this alert to
* @property {object} condition The condition that will cause this alert to
* activate.
* @member {array} [condition.allOf] The list of activity log alert
* @property {array} [condition.allOf] The list of activity log alert
* conditions.
* @member {object} actions The actions that will activate when the condition
* is met.
* @member {array} [actions.actionGroups] The list of activity log alerts.
* @member {string} [description] A description of this activity log alert.
* @property {object} actions The actions that will activate when the
* condition is met.
* @property {array} [actions.actionGroups] The list of activity log alerts.
* @property {string} [description] A description of this activity log alert.
*/
constructor() {
super();
Expand Down
28 changes: 14 additions & 14 deletions lib/services/monitorManagement/lib/models/alertRuleResource.js
Original file line number Diff line number Diff line change
Expand Up @@ -20,26 +20,26 @@ const models = require('./index');
class AlertRuleResource extends models['Resource'] {
/**
* Create a AlertRuleResource.
* @member {string} alertRuleResourceName the name of the alert rule.
* @member {string} [description] the description of the alert rule that will
* be included in the alert email.
* @member {boolean} isEnabled the flag that indicates whether the alert rule
* is enabled.
* @member {object} condition the condition that results in the alert rule
* @property {string} alertRuleResourceName the name of the alert rule.
* @property {string} [description] the description of the alert rule that
* will be included in the alert email.
* @property {boolean} isEnabled the flag that indicates whether the alert
* rule is enabled.
* @property {object} condition the condition that results in the alert rule
* being activated.
* @member {object} [condition.dataSource] the resource from which the rule
* @property {object} [condition.dataSource] the resource from which the rule
* collects its data. For this type dataSource will always be of type
* RuleMetricDataSource.
* @member {string} [condition.dataSource.resourceUri] the resource
* @property {string} [condition.dataSource.resourceUri] the resource
* identifier of the resource the rule monitors. **NOTE**: this property
* cannot be updated for an existing rule.
* @member {string} [condition.dataSource.odatatype] Polymorphic
* @property {string} [condition.dataSource.odatatype] Polymorphic
* Discriminator
* @member {string} [condition.odatatype] Polymorphic Discriminator
* @member {array} [actions] the array of actions that are performed when the
* alert rule becomes active, and when an alert condition is resolved.
* @member {date} [lastUpdatedTime] Last time the rule was updated in ISO8601
* format.
* @property {string} [condition.odatatype] Polymorphic Discriminator
* @property {array} [actions] the array of actions that are performed when
* the alert rule becomes active, and when an alert condition is resolved.
* @property {date} [lastUpdatedTime] Last time the rule was updated in
* ISO8601 format.
*/
constructor() {
super();
Expand Down
30 changes: 15 additions & 15 deletions lib/services/monitorManagement/lib/models/alertRuleResourcePatch.js
Original file line number Diff line number Diff line change
Expand Up @@ -17,27 +17,27 @@
class AlertRuleResourcePatch {
/**
* Create a AlertRuleResourcePatch.
* @member {object} [tags] Resource tags
* @member {string} name the name of the alert rule.
* @member {string} [description] the description of the alert rule that will
* be included in the alert email.
* @member {boolean} isEnabled the flag that indicates whether the alert rule
* is enabled.
* @member {object} condition the condition that results in the alert rule
* @property {object} [tags] Resource tags
* @property {string} name the name of the alert rule.
* @property {string} [description] the description of the alert rule that
* will be included in the alert email.
* @property {boolean} isEnabled the flag that indicates whether the alert
* rule is enabled.
* @property {object} condition the condition that results in the alert rule
* being activated.
* @member {object} [condition.dataSource] the resource from which the rule
* @property {object} [condition.dataSource] the resource from which the rule
* collects its data. For this type dataSource will always be of type
* RuleMetricDataSource.
* @member {string} [condition.dataSource.resourceUri] the resource
* @property {string} [condition.dataSource.resourceUri] the resource
* identifier of the resource the rule monitors. **NOTE**: this property
* cannot be updated for an existing rule.
* @member {string} [condition.dataSource.odatatype] Polymorphic
* @property {string} [condition.dataSource.odatatype] Polymorphic
* Discriminator
* @member {string} [condition.odatatype] Polymorphic Discriminator
* @member {array} [actions] the array of actions that are performed when the
* alert rule becomes active, and when an alert condition is resolved.
* @member {date} [lastUpdatedTime] Last time the rule was updated in ISO8601
* format.
* @property {string} [condition.odatatype] Polymorphic Discriminator
* @property {array} [actions] the array of actions that are performed when
* the alert rule becomes active, and when an alert condition is resolved.
* @property {date} [lastUpdatedTime] Last time the rule was updated in
* ISO8601 format.
*/
constructor() {
}
Expand Down
Loading