Skip to content

Commit

Permalink
Update metrics API limit descriptions (#31277)
Browse files Browse the repository at this point in the history
* Update metrics API limit descriptions

* Update package-preview-2024-01 tag to include other active Azure Monitor APIs as well

* Revert readme change

* Fix model validation errors

* revert dataplane changes to stop confusing gated build

* Fix package-2021-05-metrics issues

* Fix broken common definitions link

* Update metrics_API.json

Update throttling limit description
  • Loading branch information
ToddKingMSFT authored Dec 11, 2024
1 parent b260ff5 commit b6bead0
Show file tree
Hide file tree
Showing 8 changed files with 19 additions and 20 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
"Metrics"
],
"operationId": "Metrics_List",
"description": "**Lists the metric values for a resource**.",
"description": "**Lists the metric values for a resource**. This API uses the [default ARM throttling limits](https://learn.microsoft.com/en-us/azure/azure-resource-manager/management/request-limits-and-throttling).",
"parameters": [
{
"$ref": "#/parameters/ResourceUriParameter"
Expand Down Expand Up @@ -93,7 +93,7 @@
}
}
},
"x-ms-odata": "../../../../commonDefinitions.json#/definitions/MetadataValue",
"x-ms-odata": "../../../../common-types/v1/commonMonitoringTypes.json#/definitions/MetadataValue",
"x-ms-examples": {
"Get Metric for data": {
"$ref": "./examples/GetMetric.json"
Expand Down Expand Up @@ -194,7 +194,7 @@
"in": "query",
"required": false,
"type": "string",
"description": "The names of the metrics (comma separated) to retrieve. Special case: If a metricname itself has a comma in it then use %2 to indicate it. Eg: 'Metric,Name1' should be **'Metric%2Name1'**",
"description": "The names of the metrics (comma separated) to retrieve. Limit 20 metrics. Special case: If a metricname itself has a comma in it then use %2 to indicate it. Eg: 'Metric,Name1' should be **'Metric%2Name1'**",
"x-ms-parameter-location": "method"
},
"AggregationsParameter": {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
"metricnames": "MongoRequestsCount,MongoRequests",
"metricnamespace": "microsoft.documentdb/databaseaccounts",
"aggregation": "average",
"interval": "FULL",
"interval": "P1D",
"AutoAdjustTimegrain": true,
"ValidateDimensions": false,
"api-version": "2019-07-01"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
"Metrics"
],
"operationId": "Metrics_List",
"description": "**Lists the metric values for a resource**.",
"description": "**Lists the metric values for a resource**. This API used the [default ARM throttling limits](https://learn.microsoft.com/en-us/azure/azure-resource-manager/management/request-limits-and-throttling).",
"parameters": [
{
"$ref": "#/parameters/ResourceUriParameter"
Expand Down Expand Up @@ -363,7 +363,7 @@
"in": "query",
"required": false,
"type": "string",
"description": "The names of the metrics (comma separated) to retrieve.",
"description": "The names of the metrics (comma separated) to retrieve. Limit 20 metrics.",
"x-ms-parameter-location": "method"
},
"AggregationsParameter": {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
"metricnames": "MongoRequestsCount,MongoRequests",
"metricnamespace": "microsoft.documentdb/databaseaccounts",
"aggregation": "average",
"interval": "FULL",
"interval": "P1D",
"AutoAdjustTimegrain": true,
"ValidateDimensions": false,
"api-version": "2021-05-01"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@
"region": "westus2",
"api-version": "2021-05-01",
"body": {
"timespan": "2021-06-08T19:00:00Z/2021-06-12T01:00:00Z",
"metricNames": "Data Disk Max Burst IOPS",
"metricNamespace": "microsoft.compute/virtualmachines",
"filter": "LUN eq '0' and Microsoft.ResourceId eq '*'",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@
"Metrics"
],
"operationId": "Metrics_ListAtSubscriptionScope",
"description": "**Lists the metric data for a subscription**.",
"description": "**Lists the metric data for a subscription**. This API used the [default ARM throttling limits](https://learn.microsoft.com/en-us/azure/azure-resource-manager/management/request-limits-and-throttling).",
"parameters": [
{
"$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter"
Expand Down Expand Up @@ -117,7 +117,7 @@
"Metrics"
],
"operationId": "Metrics_ListAtSubscriptionScopePost",
"description": "**Lists the metric data for a subscription**. Parameters can be specified on either query params or the body.",
"description": "**Lists the metric data for a subscription**. Parameters can be specified on either query params or the body. This API used the [default ARM throttling limits](https://learn.microsoft.com/en-us/azure/azure-resource-manager/management/request-limits-and-throttling).",
"parameters": [
{
"$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter"
Expand Down Expand Up @@ -204,7 +204,7 @@
"Metrics"
],
"operationId": "Metrics_List",
"description": "**Lists the metric values for a resource**.",
"description": "**Lists the metric values for a resource**. This API used the [default ARM throttling limits](https://learn.microsoft.com/en-us/azure/azure-resource-manager/management/request-limits-and-throttling).",
"parameters": [
{
"$ref": "./commonMonitoringTypes.json#/parameters/ResourceUriParameter"
Expand Down Expand Up @@ -637,7 +637,7 @@
"in": "query",
"required": false,
"type": "string",
"description": "The names of the metrics (comma separated) to retrieve.",
"description": "The names of the metrics (comma separated) to retrieve. Limit 20 metrics.",
"x-ms-parameter-location": "method"
},
"AggregationsParameter": {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@
"Metrics"
],
"operationId": "Metrics_ListAtSubscriptionScope",
"description": "**Lists the metric data for a subscription**.",
"description": "**Lists the metric data for a subscription**. This API used the [default ARM throttling limits](https://learn.microsoft.com/en-us/azure/azure-resource-manager/management/request-limits-and-throttling).",
"parameters": [
{
"$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter"
Expand Down Expand Up @@ -117,7 +117,7 @@
"Metrics"
],
"operationId": "Metrics_ListAtSubscriptionScopePost",
"description": "**Lists the metric data for a subscription**. Parameters can be specified on either query params or the body.",
"description": "**Lists the metric data for a subscription**. Parameters can be specified on either query params or the body. This API used the [default ARM throttling limits](https://learn.microsoft.com/en-us/azure/azure-resource-manager/management/request-limits-and-throttling).",
"parameters": [
{
"$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter"
Expand Down Expand Up @@ -207,7 +207,7 @@
"Metrics"
],
"operationId": "Metrics_List",
"description": "**Lists the metric values for a resource**.",
"description": "**Lists the metric values for a resource**. This API used the [default ARM throttling limits](https://learn.microsoft.com/en-us/azure/azure-resource-manager/management/request-limits-and-throttling).",
"parameters": [
{
"$ref": "../../../../common-types/v2/commonMonitoringTypes.json#/parameters/ResourceUriParameter"
Expand Down Expand Up @@ -407,7 +407,7 @@
"in": "query",
"required": false,
"type": "string",
"description": "The names of the metrics (comma separated) to retrieve.",
"description": "The names of the metrics (comma separated) to retrieve. Limit 20 metrics.",
"x-ms-parameter-location": "method"
},
"FilterParameter": {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@
"Metrics"
],
"operationId": "Metrics_ListAtSubscriptionScope",
"description": "**Lists the metric data for a subscription**.",
"description": "**Lists the metric data for a subscription**. This API used the [default ARM throttling limits](https://learn.microsoft.com/en-us/azure/azure-resource-manager/management/request-limits-and-throttling).",
"parameters": [
{
"$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter"
Expand Down Expand Up @@ -117,7 +117,7 @@
"Metrics"
],
"operationId": "Metrics_ListAtSubscriptionScopePost",
"description": "**Lists the metric data for a subscription**. Parameters can be specified on either query params or the body.",
"description": "**Lists the metric data for a subscription**. Parameters can be specified on either query params or the body. This API used the [default ARM throttling limits](https://learn.microsoft.com/en-us/azure/azure-resource-manager/management/request-limits-and-throttling).",
"parameters": [
{
"$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter"
Expand Down Expand Up @@ -207,7 +207,7 @@
"Metrics"
],
"operationId": "Metrics_List",
"description": "**Lists the metric values for a resource**.",
"description": "**Lists the metric values for a resource**. This API used the [default ARM throttling limits](https://learn.microsoft.com/en-us/azure/azure-resource-manager/management/request-limits-and-throttling).",
"parameters": [
{
"$ref": "../../../../common-types/v2/commonMonitoringTypes.json#/parameters/ResourceUriParameter"
Expand Down Expand Up @@ -407,7 +407,7 @@
"in": "query",
"required": false,
"type": "string",
"description": "The names of the metrics (comma separated) to retrieve.",
"description": "The names of the metrics (comma separated) to retrieve. Limit 20 metrics.",
"x-ms-parameter-location": "method"
},
"FilterParameter": {
Expand Down

0 comments on commit b6bead0

Please sign in to comment.