[Hub Generated] Review request for Microsoft.Consumption to add version stable/2023-11-01

specification/consumption/resource-manager/Microsoft.Consumption/stable/2023-11-01/consumption_pricesheet.json

@@ -0,0 +1,158 @@
+{
+  "swagger": "2.0",
+  "info": {
+    "version": "2023-11-01",
+    "title": "ConsumptionManagementClient",
+    "description": "Consumption management client provides access to consumption resources for Azure Enterprise Subscriptions."
+  },
+  "host": "management.azure.com",
+  "schemes": [
+    "https"
+  ],
+  "consumes": [
+    "application/json"
+  ],
+  "produces": [
+    "application/json"
+  ],
+  "security": [
+    {
+      "azure_auth": [
+        "user_impersonation"
+      ]
+    }
+  ],
+  "securityDefinitions": {
+    "azure_auth": {
+      "type": "oauth2",
+      "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
+      "flow": "implicit",
+      "description": "Azure Active Directory OAuth2 Flow.",
+      "scopes": {
+        "user_impersonation": "impersonate your user account"
+      }
+    }
+  },
+  "paths": {
+    "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingPeriods/{billingPeriodName}/providers/Microsoft.Consumption/pricesheets/download": {
+      "post": {
+        "tags": [
+          "PriceSheet"
+        ],
+        "operationId": "PriceSheet_DownloadByBillingAccountPeriod",
+        "description": "Generates the pricesheet for the provided billing period asynchronously based on the enrollment id",
+        "externalDocs": {
+          "url": "https://docs.microsoft.com/en-us/rest/api/consumption/"
+        },
+        "x-ms-long-running-operation": true,
+        "x-ms-long-running-operation-options": {
+          "final-state-via": "location"
+        },
+        "x-ms-examples": {
+          "EAPriceSheetForBillingPeriod": {
+            "$ref": "./examples/EAPriceSheetForBillingPeriod.json"
+          }
+        },
+        "parameters": [
+          {
+            "$ref": "#/parameters/billingAccountIdParameter"
+          },
+          {
+            "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter"
+          },
+          {
+            "$ref": "#/parameters/billingPeriodNameParameter"
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Request processing completed.",
+            "schema": {
+              "$ref": "#/definitions/OperationStatus"
+            }
+          },
+          "202": {
+            "description": "Accepted",
+            "headers": {
+              "Location": {
+                "type": "string"
+              },
+              "Retry-After": {
+                "type": "integer",
+                "format": "int64"
+              }
+            }
+          },
+          "default": {
+            "description": "Error response describing why the operation failed.",
+            "schema": {
+              "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse"
+            }
+          }
+        }
+      }
+    }
+  },
+  "definitions": {
+    "OperationStatus": {
+      "description": "The status of the long running operation.",
+      "type": "object",
+      "properties": {
+        "status": {
+          "description": "The status of the long running operation.",
+          "type": "string",
+          "enum": [
+            "Running",
+            "Completed",
+            "Failed"
+          ],
+          "x-ms-enum": {
+            "name": "OperationStatusType",
+            "modelAsString": true
+          }
+        },
+        "properties": {
+          "x-ms-client-flatten": true,
+          "description": "The properties of the resource generated.",
+          "$ref": "#/definitions/PricesheetDownloadProperties"
+        }
+      }
+    },
+    "PricesheetDownloadProperties": {
+      "description": "The properties of the price sheet download.",
+      "type": "object",
+      "properties": {
+        "downloadUrl": {
+          "description": "The link (url) to download the pricesheet.",
+          "type": "string",
+          "readOnly": true
+        },
+        "validTill": {
+          "description": "Download link validity.",
+          "type": "string",
+          "format": "date-time",
+          "readOnly": true
+        }
+      }
+    }
+  },
+  "parameters": {
+    "billingAccountIdParameter": {
+      "name": "billingAccountId",
+      "in": "path",
+      "description": "BillingAccount ID",
+      "required": true,
+      "type": "string",
+      "x-ms-parameter-location": "method"
+    },
+    "billingPeriodNameParameter": {
+      "name": "billingPeriodName",
+      "in": "path",
+      "description": "Billing Period Name.",
+      "required": true,
+      "type": "string",
+      "pattern": "^[0-9]*$",
+      "x-ms-parameter-location": "method"
+    }
+  }
+}

specification/consumption/resource-manager/Microsoft.Consumption/stable/2023-11-01/examples/AggregatedCostByManagementGroup.json

@@ -0,0 +1,47 @@
+{
+  "parameters": {
+    "api-version": "2023-11-01",
+    "managementGroupId": "managementGroupForTest"
+  },
+  "responses": {
+    "200": {
+      "body": {
+        "id": "/providers/Microsoft.Management/managementGroups/managementGroupForTest/providers/Microsoft.Consumption/aggregatedcostId1",
+        "name": "aggregatedcostId1",
+        "type": "Microsoft.Consumption/aggregatedcost",
+        "properties": {
+          "includedSubscriptions": [
+            "1caaa5a3-2b66-438e-8ab4-bce37d518c5d"
+          ],
+          "excludedSubscriptions": [],
+          "usageStart": "2023-03-01T00:00:00.0000000Z",
+          "usageEnd": "2023-11-01T00:00:00.0000000Z",
+          "azureCharges": 250.9876,
+          "marketplaceCharges": 150.786,
+          "chargesBilledSeparately": 120.345,
+          "currency": "USD",
+          "children": [
+            {
+              "id": "/providers/Microsoft.Management/managementGroups/managementGroupChildForTest/providers/Microsoft.Consumption/aggregatedcostId2",
+              "name": "aggregatedcostId2",
+              "type": "Microsoft.Consumption/aggregatedcost",
+              "properties": {
+                "includedSubscriptions": [
+                  "c349567d-c83a-48c9-ab0e-578c69dc97a4"
+                ],
+                "excludedSubscriptions": [],
+                "usageStart": "2023-03-01T00:00:00.0000000Z",
+                "usageEnd": "2023-11-01T00:00:00.0000000Z",
+                "azureCharges": 150.0,
+                "marketplaceCharges": 50.786,
+                "chargesBilledSeparately": 30.345,
+                "currency": "USD",
+                "children": []
+              }
+            }
+          ]
+        }
+      }
+    }
+  }
+}

specification/consumption/resource-manager/Microsoft.Consumption/stable/2023-11-01/examples/AggregatedCostByManagementGroupFilterByDate.json

@@ -0,0 +1,48 @@
+{
+  "parameters": {
+    "api-version": "2023-11-01",
+    "managementGroupId": "managementGroupForTest",
+    "$filter": "usageStart ge '2018-08-15' and properties/usageStart le '2018-08-31'"
+  },
+  "responses": {
+    "200": {
+      "body": {
+        "id": "/providers/Microsoft.Management/managementGroups/managementGroupForTest/providers/Microsoft.Consumption/aggregatedcostId1",
+        "name": "aggregatedcostId1",
+        "type": "Microsoft.Consumption/aggregatedcost",
+        "properties": {
+          "includedSubscriptions": [
+            "1caaa5a3-2b66-438e-8ab4-bce37d518c5d"
+          ],
+          "excludedSubscriptions": [],
+          "usageStart": "2018-08-15T00:00:00.0000000Z",
+          "usageEnd": "2018-08-31T00:00:00.0000000Z",
+          "azureCharges": 150.9876,
+          "marketplaceCharges": 80.786,
+          "chargesBilledSeparately": 90.345,
+          "currency": "USD",
+          "children": [
+            {
+              "id": "/providers/Microsoft.Management/managementGroups/managementGroupChildForTest/providers/Microsoft.Consumption/aggregatedcostId2",
+              "name": "aggregatedcostId2",
+              "type": "Microsoft.Consumption/aggregatedcost",
+              "properties": {
+                "includedSubscriptions": [
+                  "c349567d-c83a-48c9-ab0e-578c69dc97a4"
+                ],
+                "excludedSubscriptions": [],
+                "usageStart": "2018-08-15T00:00:00.0000000Z",
+                "usageEnd": "2018-08-31T00:00:00.0000000Z",
+                "azureCharges": 50.0,
+                "marketplaceCharges": 10.786,
+                "chargesBilledSeparately": 30.345,
+                "currency": "USD",
+                "children": []
+              }
+            }
+          ]
+        }
+      }
+    }
+  }
+}

specification/consumption/resource-manager/Microsoft.Consumption/stable/2023-11-01/examples/AggregatedCostForBillingPeriodByManagementGroup.json

@@ -0,0 +1,40 @@
+{
+  "parameters": {
+    "api-version": "2023-11-01",
+    "managementGroupId": "managementGroupForTest",
+    "billingPeriodName": "201807"
+  },
+  "responses": {
+    "200": {
+      "body": {
+        "id": "/providers/Microsoft.Management/managementGroups/managementGroupForTest/providers/Microsoft.Consumption/aggregatedcostId1",
+        "name": "aggregatedcostId1",
+        "type": "Microsoft.Consumption/aggregatedcost",
+        "properties": {
+          "usageStart": "2018-07-01T00:00:00.0000000Z",
+          "usageEnd": "2018-07-31T00:00:00.0000000Z",
+          "azureCharges": 250.9876,
+          "marketplaceCharges": 150.786,
+          "chargesBilledSeparately": 120.345,
+          "currency": "USD",
+          "children": [
+            {
+              "id": "/providers/Microsoft.Management/managementGroups/managementGroupChildForTest/providers/Microsoft.Consumption/aggregatedcostId2",
+              "name": "aggregatedcostId2",
+              "type": "Microsoft.Consumption/aggregatedcost",
+              "properties": {
+                "usageStart": "2018-07-01T00:00:00.0000000Z",
+                "usageEnd": "2018-07-31T00:00:00.0000000Z",
+                "azureCharges": 150.0,
+                "marketplaceCharges": 50.786,
+                "chargesBilledSeparately": 30.345,
+                "currency": "USD",
+                "children": []
+              }
+            }
+          ]
+        }
+      }
+    }
+  }
+}

specification/consumption/resource-manager/Microsoft.Consumption/stable/2023-11-01/examples/BalancesByBillingAccount.json

@@ -0,0 +1,47 @@
+{
+  "parameters": {
+    "api-version": "2023-11-01",
+    "billingAccountId": "123456"
+  },
+  "responses": {
+    "200": {
+      "body": {
+        "id": "/providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.Billing/billingPeriods/201702/providers/Microsoft.Consumption/balances/balanceId1",
+        "name": "balanceId1",
+        "type": "Microsoft.Consumption/balances",
+        "properties": {
+          "currency": "USD  ",
+          "beginningBalance": 3396469.19,
+          "endingBalance": 2922371.02,
+          "newPurchases": 0,
+          "adjustments": 0,
+          "utilized": 474098.17,
+          "serviceOverage": 0,
+          "chargesBilledSeparately": 0,
+          "totalOverage": 0,
+          "totalUsage": 474098.17,
+          "azureMarketplaceServiceCharges": 609.82,
+          "billingFrequency": "Month",
+          "priceHidden": false,
+          "overageRefund": 2012.61,
+          "newPurchasesDetails": [
+            {
+              "name": "Promo Purchase",
+              "value": 1
+            }
+          ],
+          "adjustmentDetails": [
+            {
+              "name": "Promo Credit",
+              "value": 1.1
+            },
+            {
+              "name": "SIE Credit",
+              "value": 1.0
+            }
+          ]
+        }
+      }
+    }
+  }
+}

specification/consumption/resource-manager/Microsoft.Consumption/stable/2023-11-01/examples/BalancesByBillingAccountForBillingPeriod.json

@@ -0,0 +1,48 @@
+{
+  "parameters": {
+    "api-version": "2023-11-01",
+    "billingAccountId": "123456",
+    "billingPeriodName": "201702"
+  },
+  "responses": {
+    "200": {
+      "body": {
+        "id": "providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.Billing/billingPeriods/201702/providers/Microsoft.Consumption/balances/balanceId1",
+        "name": "balanceId1",
+        "type": "Microsoft.Consumption/balances",
+        "properties": {
+          "currency": "USD  ",
+          "beginningBalance": 3396469.19,
+          "endingBalance": 2922371.02,
+          "newPurchases": 0,
+          "adjustments": 0,
+          "utilized": 474098.17,
+          "serviceOverage": 0,
+          "chargesBilledSeparately": 0,
+          "totalOverage": 0,
+          "totalUsage": 474098.17,
+          "azureMarketplaceServiceCharges": 609.82,
+          "billingFrequency": "Month",
+          "priceHidden": false,
+          "overageRefund": 2012.61,
+          "newPurchasesDetails": [
+            {
+              "name": "Promo Purchase",
+              "value": 1
+            }
+          ],
+          "adjustmentDetails": [
+            {
+              "name": "Promo Credit",
+              "value": 1.1
+            },
+            {
+              "name": "SIE Credit",
+              "value": 1.0
+            }
+          ]
+        }
+      }
+    }
+  }
+}