Skip to content

Changed the descriptions of multiple items to bring more clarity for users. #4365

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jhendrixMSFT merged 2 commits into from
Oct 31, 2018
Merged

Changed the descriptions of multiple items to bring more clarity for users. #4365

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ae67e8e
Some description text changes
ananthradhakrishnan Oct 31, 2018
486ee92
fix Go SDK codegen
jhendrixMSFT Oct 31, 2018
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
54 changes: 27 additions & 27 deletions ...ement/resource-manager/Microsoft.AlertsManagement/stable/2018-05-05/AlertsManagement.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"info": {
"version": "2018-05-05",
"title": "Azure Alerts Management Service Resource Provider",
"description": "Azure Alerts Management Service provides a single pane of glass of alerts borne from Azure Monitor."
"description": "Azure Alerts Management Service provides a single pane of glass of alerts across Azure Monitor."
},
"schemes": [
"https"
Expand Down Expand Up @@ -54,7 +54,7 @@
"/subscriptions/{subscriptionId}/providers/Microsoft.AlertsManagement/alerts": {
"get": {
"operationId": "Alerts_GetAll",
"description": "List all the existing alerts, where the results can be selective by passing multiple filter parameters including time range and sorted on specific fields. ",
"description": "List all existing alerts, where the results can be filtered on the basis of multiple parameters (e.g. time range). The results can then be sorted on the basis specific fields, with the default being lastModifiedDateTime. ",
"parameters": [
{
"$ref": "#/parameters/subscriptionId"
Expand Down Expand Up @@ -184,7 +184,7 @@
"/subscriptions/{subscriptionId}/providers/Microsoft.AlertsManagement/alerts/{alertId}/changestate": {
"post": {
"operationId": "Alerts_ChangeState",
"description": "Change the state of the alert.",
"description": "Change the state of an alert.",
"parameters": [
{
"$ref": "#/parameters/subscriptionId"
Expand Down Expand Up @@ -223,7 +223,7 @@
"/subscriptions/{subscriptionId}/providers/Microsoft.AlertsManagement/alerts/{alertId}/history": {
"get": {
"operationId": "Alerts_GetHistory",
"description": "Get the history of the changes of an alert.",
"description": "Get the history of an alert, which captures any monitor condition changes (Fired/Resolved) and alert state changes (New/Acknowledged/Closed).",
"parameters": [
{
"$ref": "#/parameters/subscriptionId"
Expand All @@ -237,7 +237,7 @@
],
"responses": {
"200": {
"description": "OK. Returns the list of changes of alert.",
"description": "OK. Returns the history of the specified alert.",
"schema": {
"$ref": "#/definitions/alertModification"
}
Expand All @@ -259,7 +259,7 @@
"/subscriptions/{subscriptionId}/providers/Microsoft.AlertsManagement/alertsSummary": {
"get": {
"operationId": "Alerts_GetSummary",
"description": "Summary of alerts with the count each severity.",
"description": "Get a summarized count of your alerts grouped by various parameters (e.g. grouping by 'Severity' returns the count of alerts for each severity).",
"parameters": [
{
"$ref": "#/parameters/subscriptionId"
Expand Down Expand Up @@ -328,8 +328,8 @@
"/subscriptions/{subscriptionId}/providers/Microsoft.AlertsManagement/smartGroups": {
"get": {
"operationId": "SmartGroups_GetAll",
"summary": "Get all smartGroups within the subscription",
"description": "List all the smartGroups within the specified subscription. ",
"summary": "Get all Smart Groups within a specified subscription",
"description": "List all the Smart Groups within a specified subscription. ",
"parameters": [
{
"$ref": "#/parameters/subscriptionId"
Expand Down Expand Up @@ -399,8 +399,8 @@
"/subscriptions/{subscriptionId}/providers/Microsoft.AlertsManagement/smartGroups/{smartGroupId}": {
"get": {
"operationId": "SmartGroups_GetById",
"summary": "Get information of smart alerts group.",
"description": "Get details of smart group.",
"summary": "Get information related to a specific Smart Group.",
"description": "Get information related to a specific Smart Group.",
"produces": [
"application/json"
],
Expand Down Expand Up @@ -445,7 +445,7 @@
"/subscriptions/{subscriptionId}/providers/Microsoft.AlertsManagement/smartGroups/{smartGroupId}/changeState": {
"post": {
"operationId": "SmartGroups_ChangeState",
"description": "Change the state from unresolved to resolved and all the alerts within the smart group will also be resolved.",
"description": "Change the state of a Smart Group.",
"parameters": [
{
"$ref": "#/parameters/subscriptionId"
Expand All @@ -462,7 +462,7 @@
],
"responses": {
"200": {
"description": "OK. Alert state updated.",
"description": "OK. Smart Group state updated.",
"headers": {
"x-ms-request-id": {
"type": "string",
Expand Down Expand Up @@ -490,7 +490,7 @@
"/subscriptions/{subscriptionId}/providers/Microsoft.AlertsManagement/smartGroups/{smartGroupId}/history": {
"get": {
"operationId": "SmartGroups_GetHistory",
"description": "Get the history of the changes of smart group.",
"description": "Get the history a smart group, which captures any Smart Group state changes (New/Acknowledged/Closed) .",
"parameters": [
{
"$ref": "#/parameters/subscriptionId"
Expand Down Expand Up @@ -579,7 +579,7 @@
"x-ms-parameter-location": "method"
},
"monitorService": {
"description": "Filter by monitor service which is the source of the alert instance. Default value is select all.",
"description": "Filter by monitor service which generates the alert instance. Default value is select all.",
"name": "monitorService",
"type": "string",
"in": "query",
Expand Down Expand Up @@ -693,7 +693,7 @@
}
},
"monitorCondition": {
"description": "Filter by monitor condition which is the state of the monitor(alertRule) at monitor service. Default value is to select all.",
"description": "Filter by monitor condition which is either 'Fired' or 'Resolved'. Default value is to select all.",
"name": "monitorCondition",
"type": "string",
"in": "query",
Expand All @@ -709,7 +709,7 @@
}
},
"alertRule": {
"description": "Filter by alert rule(monitor) which fired alert instance. Default value is to select all.",
"description": "Filter by specific alert rule. Default value is to select all.",
"name": "alertRule",
"type": "string",
"in": "query",
Expand Down Expand Up @@ -743,7 +743,7 @@
"x-ms-parameter-location": "method"
},
"includeContext": {
"description": "Include context which has data contextual to the monitor service. Default value is false'",
"description": "Include context which has contextual data specific to the monitor service. Default value is false'",
"name": "includeContext",
"type": "boolean",
"in": "query",
Expand Down Expand Up @@ -799,7 +799,7 @@
}
},
"alertsSummaryGroupBy": {
"description": "This parameter allows the result set to be aggregated by input fields. For example, groupby=severity,alertstate.",
"description": "This parameter allows the result set to be grouped by input fields. For example, groupby=severity,alertstate.",
"name": "groupby",
"type": "string",
"in": "query",
Expand All @@ -819,7 +819,7 @@
}
},
"smartGroupsSortBy": {
"description": "Sort the query results by input field Default value is sort by 'lastModifiedDateTime'.",
"description": "Sort the query results by input field. Default value is sort by 'lastModifiedDateTime'.",
"name": "sortBy",
"type": "string",
"in": "query",
Expand Down Expand Up @@ -1015,16 +1015,16 @@
},
"alertContext": {
"type": "object",
"description": "More details which are contextual to the monitor service.",
"description": "Information specific to the monitor service that gives more contextual details about the alert.",
"readOnly": true
},
"essentials": {
"type": "object",
"description": "This object contains normalized fields across different monitor service and also contains state related fields.",
"description": "This object contains consistent fields across different monitor services.",
"properties": {
"severity": {
"type": "string",
"description": "Severity of alert Sev0 being highest and Sev3 being lowest.",
"description": "Severity of alert Sev0 being highest and Sev4 being lowest.",
"readOnly": true,
"enum": [
"Sev0",
Expand All @@ -1040,7 +1040,7 @@
},
"signalType": {
"type": "string",
"description": "Log based alert or metric based alert",
"description": "The type of signal the alert is based on, which could be metrics, logs or activity logs.",
"readOnly": true,
"enum": [
"Metric",
Expand All @@ -1054,7 +1054,7 @@
},
"alertState": {
"type": "string",
"description": "Alert object state, which is modified by the user.",
"description": "Alert object state, which can be modified by the user.",
"readOnly": true,
"enum": [
"New",
Expand All @@ -1068,7 +1068,7 @@
},
"monitorCondition": {
"type": "string",
"description": "Represents rule condition(Fired/Resolved) maintained by monitor service depending on the state of the state.",
"description": "Can be 'Fired' or 'Resolved', which represents whether the underlying conditions have crossed the defined alert rule thresholds.",
"readOnly": true,
"enum": [
"Fired",
Expand Down Expand Up @@ -1155,7 +1155,7 @@
"monitorConditionResolvedDateTime": {
"type": "string",
"format": "date-time",
"description": "Resolved time(ISO-8601 format) of alert instance. This will be updated when monitor service resolves the alert instance because of the rule condition is not met.",
"description": "Resolved time(ISO-8601 format) of alert instance. This will be updated when monitor service resolves the alert instance because the rule condition is no longer met.",
"readOnly": true
},
"lastModifiedUserName": {
Expand Down Expand Up @@ -1531,4 +1531,4 @@
}
}
}
}
}
12 changes: 6 additions & 6 deletions specification/alertsmanagement/resource-manager/readme.go.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,14 @@ go:
### Go multi-api
``` yaml $(go) && $(multiapi)
batch:
- tag: package-2018-05-preview
- tag: package-2018-05
```

### Tag: package-2018-05-preview and go
### Tag: package-2018-05 and go

These settings apply only when `--tag=package-2018-05-preview --go` is specified on the command line.
These settings apply only when `--tag=package-2018-05 --go` is specified on the command line.
Please also specify `--go-sdk-folder=<path to the root directory of your azure-sdk-for-go clone>`.

``` yaml $(tag) == 'package-2018-05-preview' && $(go)
output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2018-05-05-preview/$(namespace)
```
``` yaml $(tag) == 'package-2018-05' && $(go)
output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2018-05-05/$(namespace)
```