Skip to content

[Hub Generated] Review request for Microsoft.CostManagement to add version stable/2021-10-01 #20383

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
akning-ms merged 7 commits into from
Sep 13, 2022
Merged

[Hub Generated] Review request for Microsoft.CostManagement to add version stable/2021-10-01 #20383

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
60e6534
Initial Change
omrodrig Aug 25, 2022
e691b10
Added enum property
omrodrig Aug 25, 2022
9f84c50
Fixed example files
omrodrig Aug 25, 2022
c9719fb
Re-added property
omrodrig Aug 25, 2022
39ecdd4
Added x-ms-enum to enums
omrodrig Aug 25, 2022
544667c
Ran prettier
omrodrig Aug 25, 2022
e1414c1
Removed non-required property
omrodrig Aug 25, 2022
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
285 changes: 247 additions & 38 deletions ...anagement/resource-manager/Microsoft.CostManagement/stable/2021-10-01/costmanagement.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -639,7 +639,7 @@
"200": {
"description": "OK. The request has succeeded.",
"schema": {
"$ref": "#/definitions/QueryResult"
"$ref": "#/definitions/ForecastResult"
}
},
"204": {
Expand Down Expand Up @@ -703,7 +703,7 @@
"200": {
"description": "OK. The request has succeeded.",
"schema": {
"$ref": "#/definitions/QueryResult"
"$ref": "#/definitions/ForecastResult"
}
},
"default": {
Expand Down Expand Up @@ -2184,6 +2184,66 @@
}
}
},
"ForecastResult": {
"description": "Result of forecast. It contains all columns listed under groupings and aggregation.",
"type": "object",
"allOf": [
{
"$ref": "#/definitions/Resource"
}
],
"properties": {
"properties": {
"x-ms-client-flatten": true,
"$ref": "#/definitions/ForecastProperties",
"title": "Forecast properties"
}
}
},
"ForecastProperties": {
"description": "Forecast properties",
"type": "object",
"properties": {
"nextLink": {
"description": "The link (url) to the next page of results.",
"type": "string"
},
"columns": {
"description": "Array of columns",
"type": "array",
"items": {
"$ref": "#/definitions/ForecastColumn"
},
"x-ms-identifiers": [
"name"
]
},
"rows": {
"description": "Array of rows",
"type": "array",
"items": {
"type": "array",
"items": {},
"x-ms-identifiers": []
},
"x-ms-identifiers": []
}
}
},
"ForecastColumn": {
"description": "Forecast column properties",
"type": "object",
"properties": {
"name": {
"description": "The name of column.",
"type": "string"
},
"type": {
"description": "The type of column.",
"type": "string"
}
}
},
"QueryResult": {
"description": "Result of query. It contains all columns listed under groupings and aggregation.",
"type": "object",
Expand Down Expand Up @@ -2312,46 +2372,29 @@
"type": {
"description": "The type of the forecast.",
"type": "string",
"enum": [
"Usage",
"ActualCost",
"AmortizedCost"
],
"x-ms-enum": {
"name": "ForecastType",
"modelAsString": true
}
"$ref": "#/definitions/ForecastType"
},
"timeframe": {
"description": "The time frame for pulling data for the forecast. If custom, then a specific time period must be provided.",
"type": "string",
"enum": [
"MonthToDate",
"BillingMonthToDate",
"TheLastMonth",
"TheLastBillingMonth",
"WeekToDate",
"Custom"
],
"x-ms-enum": {
"name": "ForecastTimeframeType",
"modelAsString": true
}
"$ref": "#/definitions/ForecastTimeframe"
},
"timePeriod": {
"description": "Has time period for pulling data for the forecast.",
"$ref": "#/definitions/QueryTimePeriod"
"type": "object",
"$ref": "#/definitions/ForecastTimePeriod"
},
"dataset": {
"description": "Has definition for data in this forecast.",
"type": "object",
"$ref": "#/definitions/ForecastDataset"
},
"includeActualCost": {
"description": "a boolean determining if actualCost will be included",
"description": "A boolean determining if actualCost will be included.",
"type": "boolean"
},
"includeFreshPartialCost": {
"description": "a boolean determining if FreshPartialCost will be included",
"description": "A boolean determining if FreshPartialCost will be included.",
"type": "boolean"
}
},
Expand All @@ -2361,41 +2404,207 @@
"dataset"
]
},
"ForecastType": {
"description": "The type of the forecast.",
"type": "string",
"enum": [
"Usage",
"ActualCost",
"AmortizedCost"
],
"x-ms-enum": {
"name": "ForecastType",
"modelAsString": true
}
},
"ForecastTimeframe": {
"description": "The time frame for pulling data for the forecast.",
"type": "string",
"enum": [
"Custom"
],
"x-ms-enum": {
"name": "ForecastTimeframe",
"modelAsString": true
}
},
"ForecastTimePeriod": {
"description": "Has time period for pulling data for the forecast.",
"type": "object",
"properties": {
"from": {
"description": "The start date to pull data from.",
"type": "string",
"format": "date-time"
},
"to": {
"description": "The end date to pull data to.",
"type": "string",
"format": "date-time"
}
},
"required": [
"from",
"to"
]
},
"ForecastDataset": {
"description": "The definition of data present in the forecast.",
"type": "object",
"properties": {
"granularity": {
"description": "The granularity of rows in the forecast.",
"type": "string",
"enum": [
"Daily"
],
"x-ms-enum": {
"name": "GranularityType",
"modelAsString": true
}
"$ref": "#/definitions/GranularityType"
},
"configuration": {
"description": "Has configuration information for the data in the export. The configuration will be ignored if aggregation and grouping are provided.",
"$ref": "#/definitions/QueryDatasetConfiguration"
"$ref": "#/definitions/ForecastDatasetConfiguration"
},
"aggregation": {
"type": "object",
"description": "Dictionary of aggregation expression to use in the forecast. The key of each item in the dictionary is the alias for the aggregated column. forecast can have up to 2 aggregation clauses.",
"type": "object",
"additionalProperties": {
"type": "object",
"$ref": "#/definitions/QueryAggregation"
"$ref": "#/definitions/ForecastAggregation"
},
"maxItems": 2
},
"filter": {
"type": "object",
"description": "Has filter expression to use in the forecast.",
"$ref": "#/definitions/QueryFilter"
"type": "object",
"$ref": "#/definitions/ForecastFilter"
}
},
"required": [
"aggregation"
]
},
"GranularityType": {
"description": "The granularity of rows in the forecast.",
"type": "string",
"enum": [
"Daily"
],
"x-ms-enum": {
"name": "GranularityType",
"modelAsString": true
}
},
"ForecastDatasetConfiguration": {
"description": "The configuration of dataset in the forecast.",
"type": "object",
"properties": {
"columns": {
"description": "Array of column names to be included in the forecast. Any valid forecast column name is allowed. If not provided, then forecast includes all columns.",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"ForecastAggregation": {
"description": "The aggregation expression to be used in the forecast.",
"type": "object",
"properties": {
"name": {
"description": "The name of the column to aggregate.",
"type": "string",
"enum": [
"PreTaxCostUSD",
"Cost",
"CostUSD",
"PreTaxCost"
],
"x-ms-enum": {
"name": "FunctionName",
"modelAsString": true
}
},
"function": {
"description": "The name of the aggregation function to use.",
"type": "string",
"enum": [
"Sum"
],
"x-ms-enum": {
"name": "FunctionType",
"modelAsString": true
}
}
},
"required": [
"name",
"function"
]
},
"ForecastFilter": {
"description": "The filter expression to be used in the export.",
"type": "object",
"properties": {
"and": {
"description": "The logical \"AND\" expression. Must have at least 2 items.",
"type": "array",
"items": {
"$ref": "#/definitions/ForecastFilter"
},
"x-ms-identifiers": [],
"minItems": 2
},
"or": {
"description": "The logical \"OR\" expression. Must have at least 2 items.",
"type": "array",
"items": {
"$ref": "#/definitions/ForecastFilter"
},
"x-ms-identifiers": [],
"minItems": 2
},
"dimensions": {
"description": "Has comparison expression for a dimension",
"$ref": "#/definitions/ForecastComparisonExpression"
},
"tags": {
"description": "Has comparison expression for a tag",
"$ref": "#/definitions/ForecastComparisonExpression"
}
}
},
"ForecastComparisonExpression": {
"description": "The comparison expression to be used in the forecast.",
"type": "object",
"properties": {
"name": {
"description": "The name of the column to use in comparison.",
"type": "string"
},
"operator": {
"description": "The operator to use for comparison.",
"type": "string",
"enum": [
"In"
],
"x-ms-enum": {
"name": "ForecastOperatorType",
"modelAsString": true
}
},
"values": {
"description": "Array of values to use for comparison",
"type": "array",
"items": {
"type": "string"
},
"minItems": 1
}
},
"required": [
"name",
"operator",
"values"
]
},
"QueryDefinition": {
"description": "The definition of a query.",
"type": "object",
Expand Down
14 changes: 12 additions & 2 deletions ...e-manager/Microsoft.CostManagement/stable/2021-10-01/examples/BillingAccountForecast.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,19 @@
"scope": "providers/Microsoft.Billing/billingAccounts/12345:6789",
"parameters": {
"type": "Usage",
"timeframe": "MonthToDate",
"timeframe": "Custom",
"timePeriod": {
"from": "2022-08-01T00:00:00+00:00",
"to": "2022-08-31T23:59:59+00:00"
},
"dataset": {
"granularity": "Daily",
"aggregation": {
"totalCost": {
"name": "Cost",
"function": "Sum"
}
},
"filter": {
"and": [
{
Expand Down Expand Up @@ -55,7 +65,7 @@
"body": {
"id": "providers/Microsoft.Billing/billingAccounts/12345:6789/providers/Microsoft.CostManagement/query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd",
"name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd",
"type": "microsoft.costmanagement/Query",
"type": "Microsoft.CostManagement/query",
"properties": {
"nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/providers/Microsoft.CostManagement/Forecast?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D",
"columns": [
Expand Down
Loading