{ "swagger": "2.0", "info": { "title": "CostManagementClient", "version": "2026-06-01", "description": "CostManagement management client provides access to CostManagement resources for Azure Enterprise Subscriptions.", "x-typespec-generated": [ { "emitter": "@azure-tools/typespec-autorest" } ] }, "schemes": [ "https" ], "host": "management.azure.com", "produces": [ "application/json" ], "consumes": [ "application/json" ], "security": [ { "azure_auth": [ "user_impersonation" ] } ], "securityDefinitions": { "azure_auth": { "type": "oauth2", "description": "Azure Active Directory OAuth2 Flow.", "flow": "implicit", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "scopes": { "user_impersonation": "impersonate your user account" } } }, "tags": [ { "name": "Operations" }, { "name": "CostAllocationRuleDefinitions" }, { "name": "Budgets" }, { "name": "Exports" }, { "name": "GenerateDetailedCostReportOperationResults" }, { "name": "GenerateDetailedCostReportOperationStatus" }, { "name": "Views" }, { "name": "ViewOperationGroup" }, { "name": "Alerts" }, { "name": "ScheduledActions" }, { "name": "ScheduledActionOperationGroup" }, { "name": "Settings" }, { "name": "MarkupRules" }, { "name": "GenerateCostDetailsReport" } ], "paths": { "/{scope}/providers/Microsoft.CostManagement/alerts": { "get": { "operationId": "Alerts_List", "tags": [ "Alerts" ], "description": "Lists the alerts for scope defined.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "scope", "in": "path", "description": "The scope associated with alerts operations. This includes '/subscriptions/{subscriptionId}/' for subscription scope, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope and '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, '/providers/Microsoft.Management/managementGroups/{managementGroupId} for Management Group scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billingProfile scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/invoiceSections/{invoiceSectionId}' for invoiceSection scope, and '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/customers/{customerId}' specific for partners.", "required": true, "type": "string", "x-ms-skip-url-encoding": true } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/AlertsResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "BillingAccountAlerts": { "$ref": "./examples/BillingAccountAlerts.json" }, "BillingProfileAlerts": { "$ref": "./examples/BillingProfileAlerts.json" }, "DepartmentAlerts": { "$ref": "./examples/DepartmentAlerts.json" }, "EnrollmentAccountAlerts": { "$ref": "./examples/EnrollmentAccountAlerts.json" }, "InvoiceSectionAlerts": { "$ref": "./examples/InvoiceSectionAlerts.json" }, "ResourceGroupAlerts": { "$ref": "./examples/ResourceGroupAlerts.json" }, "SubscriptionAlerts": { "$ref": "./examples/SubscriptionAlerts.json" } } } }, "/{scope}/providers/Microsoft.CostManagement/alerts/{alertId}": { "get": { "operationId": "Alerts_Get", "tags": [ "Alerts" ], "description": "Gets the alert for the scope by alert ID.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "scope", "in": "path", "description": "The fully qualified Azure Resource manager identifier of the resource.", "required": true, "type": "string", "x-ms-skip-url-encoding": true }, { "name": "alertId", "in": "path", "description": "Alert ID", "required": true, "type": "string", "x-ms-skip-url-encoding": true } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Alert" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "SingleResourceGroupAlerts": { "$ref": "./examples/SingleResourceGroupAlert.json" }, "SingleSubscriptionAlerts": { "$ref": "./examples/SingleSubscriptionAlert.json" } } }, "patch": { "operationId": "Alerts_Dismiss", "tags": [ "Alerts" ], "description": "Dismisses the specified alert", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "scope", "in": "path", "description": "The fully qualified Azure Resource manager identifier of the resource.", "required": true, "type": "string", "x-ms-skip-url-encoding": true }, { "name": "alertId", "in": "path", "description": "Alert ID", "required": true, "type": "string", "x-ms-skip-url-encoding": true }, { "name": "parameters", "in": "body", "description": "Parameters supplied to the Dismiss Alert operation.", "required": true, "schema": { "$ref": "#/definitions/DismissAlertPayload" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Alert" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "PatchResourceGroupAlerts": { "$ref": "./examples/DismissResourceGroupAlerts.json" }, "PatchSubscriptionAlerts": { "$ref": "./examples/DismissSubscriptionAlerts.json" } } } }, "/{billingScope}/providers/Microsoft.CostManagement/benefitRecommendations": { "get": { "operationId": "BenefitRecommendations_List", "description": "List of recommendations for purchasing savings plan.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/CostManagement/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "$filter", "in": "query", "description": "Can be used to filter benefitRecommendations by: properties/scope with allowed values ['Single', 'Shared'] and default value 'Shared'; and properties/lookBackPeriod with allowed values ['Last7Days', 'Last30Days', 'Last60Days'] and default value 'Last60Days'; properties/term with allowed values ['P1Y', 'P3Y'] and default value 'P3Y'; properties/subscriptionId; properties/resourceGroup", "required": false, "type": "string" }, { "name": "$orderby", "in": "query", "description": "May be used to order the recommendations by: properties/armSkuName. For the savings plan, the results are in order by default. There is no need to use this clause.", "required": false, "type": "string" }, { "name": "$expand", "in": "query", "description": "May be used to expand the properties by: properties/usage, properties/allRecommendationDetails", "required": false, "type": "string" }, { "name": "billingScope", "in": "path", "description": "The scope associated with benefit recommendation operations. This includes '/subscriptions/{subscriptionId}/' for subscription scope, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resource group scope, /providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for enterprise agreement scope, and '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billing profile scope", "required": true, "type": "string", "x-ms-skip-url-encoding": true } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/benefitRecommendationsListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "BenefitRecommendationsBillingAccountList": { "$ref": "./examples/BenefitRecommendationsByBillingAccount.json" }, "BenefitRecommendationsManagementGroupList": { "$ref": "./examples/BenefitRecommendationsByBillingAccountForManagementGroup.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/{scope}/providers/Microsoft.CostManagement/budgets": { "get": { "operationId": "Budgets_List", "tags": [ "Budgets" ], "description": "Lists all budgets for the defined scope.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/CostManagement/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "scope", "in": "path", "description": "The fully qualified Azure Resource manager identifier of the resource.", "required": true, "type": "string", "x-ms-skip-url-encoding": true }, { "name": "$filter", "in": "query", "description": "OData filter option. May be used to filter budgets by properties/category. The filter supports 'eq' only.", "required": false, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/BudgetsListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "BillingAccountBudgetsList-EA": { "$ref": "./examples/Budgets/List/EA/BillingAccountBudgetsList-EA.json" }, "BillingAccountBudgetsList-EA-CategoryTypeFilter": { "$ref": "./examples/Budgets/List/EA/BillingAccountBudgetsList-EA-CategoryTypeFilter.json" }, "BillingAccountBudgetsList-MCA": { "$ref": "./examples/Budgets/List/MCA/BillingAccountBudgetsList-MCA.json" }, "BillingAccountBudgetsList-MCA-CategoryTypeFilter": { "$ref": "./examples/Budgets/List/MCA/BillingAccountBudgetsList-MCA-CategoryTypeFilter.json" }, "BillingProfileBudgetsList-MCA": { "$ref": "./examples/Budgets/List/MCA/BillingProfileBudgetsList.json" }, "BillingProfileBudgetsList-MCA-CategoryTypeFilter": { "$ref": "./examples/Budgets/List/MCA/BillingProfileBudgetsList-CategoryTypeFilter.json" }, "CustomerBudgetsList-MCA-CSP": { "$ref": "./examples/Budgets/List/MCA/CustomerBudgetsList.json" }, "CustomerBudgetsList-MCA-CSP-CategoryTypeFilter": { "$ref": "./examples/Budgets/List/MCA/CustomerBudgetsList-CategoryTypeFilter.json" }, "DepartmentBudgetsList-EA": { "$ref": "./examples/Budgets/List/EA/DepartmentBudgetsList.json" }, "EnrollmentAccountBudgetsList-EA": { "$ref": "./examples/Budgets/List/EA/EnrollmentAccountBudgetsList.json" }, "InvoiceSectionBudgetsList-MCA": { "$ref": "./examples/Budgets/List/MCA/InvoiceSectionBudgetsList.json" }, "ManagementGroupBudgetsList": { "$ref": "./examples/Budgets/List/RBAC/ManagementGroupBudgetsList.json" }, "ResourceGroupBudgetsList": { "$ref": "./examples/Budgets/List/RBAC/ResourceGroupBudgetsList.json" }, "SubscriptionBudgetsList": { "$ref": "./examples/Budgets/List/RBAC/SubscriptionBudgetsList.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/{scope}/providers/Microsoft.CostManagement/budgets/{budgetName}": { "get": { "operationId": "Budgets_Get", "tags": [ "Budgets" ], "description": "Gets the budget for the scope by budget name.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/CostManagement/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "scope", "in": "path", "description": "The fully qualified Azure Resource manager identifier of the resource.", "required": true, "type": "string", "x-ms-skip-url-encoding": true }, { "name": "budgetName", "in": "path", "description": "Budget Name.", "required": true, "type": "string", "minLength": 1, "maxLength": 63, "pattern": "^[a-zA-Z0-9_-]+$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Budget" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get-Cost-Budget": { "$ref": "./examples/Budgets/Get/Cost/Get-Cost-Budget.json" }, "Get-ReservationUtilization-AlertRule": { "$ref": "./examples/Budgets/Get/ReservationUtilization/Get-ReservationUtilization-AlertRule.json" } } }, "put": { "operationId": "Budgets_CreateOrUpdate", "tags": [ "Budgets" ], "description": "The operation to create or update a budget. You can optionally provide an eTag if desired as a form of concurrency control. To obtain the latest eTag for a given budget, perform a get operation prior to your put operation.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/CostManagement/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "scope", "in": "path", "description": "The fully qualified Azure Resource manager identifier of the resource.", "required": true, "type": "string", "x-ms-skip-url-encoding": true }, { "name": "budgetName", "in": "path", "description": "Budget Name.", "required": true, "type": "string", "minLength": 1, "maxLength": 63, "pattern": "^[a-zA-Z0-9_-]+$" }, { "name": "parameters", "in": "body", "description": "Parameters supplied to the Create Budget operation.", "required": true, "schema": { "$ref": "#/definitions/Budget" } } ], "responses": { "200": { "description": "Resource 'Budget' update operation succeeded", "schema": { "$ref": "#/definitions/Budget" } }, "201": { "description": "Resource 'Budget' create operation succeeded", "schema": { "$ref": "#/definitions/Budget" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "CreateOrUpdate-Cost-Subscription-Budget": { "$ref": "./examples/Budgets/CreateOrUpdate/Cost/CreateOrUpdate-Cost-Subscription-Budget.json" }, "CreateOrUpdate-ReservationUtilization-BillingAccountEA-AlertRule": { "$ref": "./examples/Budgets/CreateOrUpdate/ReservationUtilization/EA/BillingAccountEA-AlertRule.json" }, "CreateOrUpdate-ReservationUtilization-BillingAccountEA-AlertRule-ReservationIdFilter": { "$ref": "./examples/Budgets/CreateOrUpdate/ReservationUtilization/EA/BillingAccountEA-AlertRule-ReservationIdFilter.json" }, "CreateOrUpdate-ReservationUtilization-BillingAccountEA-AlertRule-ReservedResourceTypeFilter": { "$ref": "./examples/Budgets/CreateOrUpdate/ReservationUtilization/EA/BillingAccountEA-AlertRule-ReservedResourceTypeFilter.json" }, "CreateOrUpdate-ReservationUtilization-BillingProfileMCA-AlertRule-ReservationIdFilter": { "$ref": "./examples/Budgets/CreateOrUpdate/ReservationUtilization/MCA/BillingProfile-AlertRule-ReservationIdFilter.json" }, "CreateOrUpdate-ReservationUtilization-BillingProfileMCA-AlertRule-ReservedResourceTypeFilter": { "$ref": "./examples/Budgets/CreateOrUpdate/ReservationUtilization/MCA/BillingProfile-AlertRule-ReservedResourceTypeFilter.json" }, "CreateOrUpdate-ReservationUtilization-BillingProfileMCA-AlertRule.json": { "$ref": "./examples/Budgets/CreateOrUpdate/ReservationUtilization/MCA/BillingProfile-AlertRule.json" }, "CreateOrUpdate-ReservationUtilization-CustomerCSP-AlertRule-ReservationIdFilter": { "$ref": "./examples/Budgets/CreateOrUpdate/ReservationUtilization/MCA/Customer-AlertRule-ReservationIdFilter.json" }, "CreateOrUpdate-ReservationUtilization-CustomerCSP-AlertRule-ReservedResourceTypeFilter": { "$ref": "./examples/Budgets/CreateOrUpdate/ReservationUtilization/MCA/Customer-AlertRule-ReservedResourceTypeFilter.json" }, "CreateOrUpdate-ReservationUtilization-CustomerCSP-AlertRule.json": { "$ref": "./examples/Budgets/CreateOrUpdate/ReservationUtilization/MCA/Customer-AlertRule.json" } } }, "delete": { "operationId": "Budgets_Delete", "tags": [ "Budgets" ], "description": "The operation to delete a budget.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/CostManagement/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "scope", "in": "path", "description": "The fully qualified Azure Resource manager identifier of the resource.", "required": true, "type": "string", "x-ms-skip-url-encoding": true }, { "name": "budgetName", "in": "path", "description": "Budget Name.", "required": true, "type": "string", "minLength": 1, "maxLength": 63, "pattern": "^[a-zA-Z0-9_-]+$" } ], "responses": { "200": { "description": "Resource deleted successfully." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "DeleteBudget": { "$ref": "./examples/Budgets/Delete/DeleteBudget.json" } } } }, "/{scope}/providers/Microsoft.CostManagement/checkNameAvailability": { "post": { "operationId": "ScheduledActions_CheckNameAvailabilityByScope", "description": "Checks availability and correctness of the name for a scheduled action within the given scope.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "scope", "in": "path", "description": "The scope associated with scheduled action operations. This includes 'subscriptions/{subscriptionId}' for subscription scope, 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for BillingProfile scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' for InvoiceSection scope, 'providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}' for External Billing Account scope and 'providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}' for External Subscription scope. Note: Insight Alerts are only available on subscription scope.", "required": true, "type": "string" }, { "name": "checkNameAvailabilityRequest", "in": "body", "description": "Scheduled action to be created or updated.", "required": true, "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/CheckNameAvailabilityRequest" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/CheckNameAvailabilityResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponseWithNestedDetails" } } }, "x-ms-examples": { "ScheduledActionCheckNameAvailabilityByScope": { "$ref": "./examples/scheduledActions/checkNameAvailability-shared-scheduledAction.json" } } } }, "/{scope}/providers/Microsoft.CostManagement/costDetailsOperationResults/{operationId}": { "get": { "operationId": "GenerateCostDetailsReport_GetOperationResults", "tags": [ "GenerateCostDetailsReport" ], "description": "Get the result of the specified operation. This link is provided in the CostDetails creation request response Location header.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "scope", "in": "path", "description": "The ARM Resource ID for subscription, billing account, or other billing scopes.Currently Resource Group and Management Group are not supported. For details, see https://aka.ms/costmgmt/scopes.", "required": true, "type": "string", "x-ms-skip-url-encoding": true }, { "name": "operationId", "in": "path", "description": "The target operation Id.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/CostDetailsOperationResults" } }, "202": { "description": "Resource operation accepted.", "headers": { "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get details of the operation result": { "$ref": "./examples/CostDetailsOperationResultsBySubscriptionScope.json" } }, "x-ms-long-running-operation": true } }, "/{scope}/providers/Microsoft.CostManagement/dimensions": { "get": { "operationId": "Dimensions_List", "description": "Lists the dimensions by the defined scope.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "scope", "in": "path", "description": "The scope associated with dimension operations. This includes '/subscriptions/{subscriptionId}/' for subscription scope, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, '/providers/Microsoft.Management/managementGroups/{managementGroupId}' for Management Group scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billingProfile scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/invoiceSections/{invoiceSectionId}' for invoiceSection scope, and 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/customers/{customerId}' specific for partners.", "required": true, "type": "string", "x-ms-skip-url-encoding": true }, { "name": "$filter", "in": "query", "description": "May be used to filter dimensions by properties/category, properties/usageStart, properties/usageEnd. Supported operators are 'eq','lt', 'gt', 'le', 'ge'.", "required": false, "type": "string" }, { "name": "$expand", "in": "query", "description": "May be used to expand the properties/data within a dimension category. By default, data is not included when listing dimensions.", "required": false, "type": "string" }, { "name": "$skiptoken", "in": "query", "description": "Skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls.", "required": false, "type": "string" }, { "name": "$top", "in": "query", "description": "May be used to limit the number of results to the most recent N dimension data.", "required": false, "type": "integer", "format": "int32", "minimum": 1, "maximum": 1000 } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/DimensionsListResult" } }, "204": { "description": "There is no content to send for this request, but the headers may be useful." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "BillingAccountDimensionsList-Legacy": { "$ref": "./examples/BillingAccountDimensionsList.json" }, "BillingAccountDimensionsList-MCA": { "$ref": "./examples/MCABillingAccountDimensionsList.json" }, "BillingAccountDimensionsListExpandAndTop-Legacy": { "$ref": "./examples/BillingAccountDimensionsListExpandAndTop.json" }, "BillingAccountDimensionsListExpandAndTop-MCA": { "$ref": "./examples/MCABillingAccountDimensionsListExpandAndTop.json" }, "BillingAccountDimensionsListWithFilter-Legacy": { "$ref": "./examples/BillingAccountDimensionsListWithFilter.json" }, "BillingAccountDimensionsListWithFilter-MCA": { "$ref": "./examples/MCABillingAccountDimensionsListWithFilter.json" }, "BillingProfileDimensionsList-MCA": { "$ref": "./examples/MCABillingProfileDimensionsList.json" }, "BillingProfileDimensionsListExpandAndTop-MCA": { "$ref": "./examples/MCABillingProfileDimensionsListExpandAndTop.json" }, "BillingProfileDimensionsListWithFilter-MCA": { "$ref": "./examples/MCABillingProfileDimensionsListWithFilter.json" }, "CustomerDimensionsList-MCA": { "$ref": "./examples/MCACustomerDimensionsList.json" }, "CustomerDimensionsListExpandAndTop-MCA": { "$ref": "./examples/MCACustomerDimensionsListExpandAndTop.json" }, "CustomerDimensionsListWithFilter-MCA": { "$ref": "./examples/MCACustomerDimensionsListWithFilter.json" }, "DepartmentDimensionsList-Legacy": { "$ref": "./examples/DepartmentDimensionsList.json" }, "DepartmentDimensionsListExpandAndTop-Legacy": { "$ref": "./examples/DepartmentDimensionsListExpandAndTop.json" }, "DepartmentDimensionsListWithFilter-Legacy": { "$ref": "./examples/DepartmentDimensionsListWithFilter.json" }, "EnrollmentAccountDimensionsList-Legacy": { "$ref": "./examples/EnrollmentAccountDimensionsList.json" }, "EnrollmentAccountDimensionsListExpandAndTop-Legacy": { "$ref": "./examples/EnrollmentAccountDimensionsListExpandAndTop.json" }, "EnrollmentAccountDimensionsListWithFilter-Legacy": { "$ref": "./examples/EnrollmentAccountDimensionsListWithFilter.json" }, "InvoiceSectionDimensionsList-MCA": { "$ref": "./examples/MCAInvoiceSectionDimensionsList.json" }, "InvoiceSectionDimensionsListExpandAndTop-MCA": { "$ref": "./examples/MCAInvoiceSectionDimensionsListExpandAndTop.json" }, "InvoiceSectionDimensionsListWithFilter-MCA": { "$ref": "./examples/MCAInvoiceSectionDimensionsListWithFilter.json" }, "ManagementGroupDimensionsList-Legacy": { "$ref": "./examples/ManagementGroupDimensionsList.json" }, "ManagementGroupDimensionsListExpandAndTop-Legacy": { "$ref": "./examples/ManagementGroupDimensionsListExpandAndTop.json" }, "ManagementGroupDimensionsListWithFilter-Legacy": { "$ref": "./examples/ManagementGroupDimensionsListWithFilter.json" }, "ResourceGroupDimensionsList-Legacy": { "$ref": "./examples/ResourceGroupDimensionsList.json" }, "SubscriptionDimensionsList-Legacy": { "$ref": "./examples/SubscriptionDimensionsList.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/{scope}/providers/Microsoft.CostManagement/exports": { "get": { "operationId": "Exports_List", "tags": [ "Exports" ], "description": "The operation to list all exports at the given scope.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "scope", "in": "path", "description": "The scope associated with alerts operations. This includes '/subscriptions/{subscriptionId}/' for subscription scope, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope and '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, '/providers/Microsoft.Management/managementGroups/{managementGroupId} for Management Group scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billingProfile scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/invoiceSections/{invoiceSectionId}' for invoiceSection scope, and '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/customers/{customerId}' specific for partners.", "required": true, "type": "string", "x-ms-skip-url-encoding": true }, { "name": "$expand", "in": "query", "description": "May be used to expand the properties within an export. Currently only 'runHistory' is supported and will return information for the last run of each export.", "required": false, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ExportListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "ExportsGetByBillingAccount": { "$ref": "./examples/ExportsGetByBillingAccount.json" }, "ExportsGetByDepartment": { "$ref": "./examples/ExportsGetByDepartment.json" }, "ExportsGetByEnrollmentAccount": { "$ref": "./examples/ExportsGetByEnrollmentAccount.json" }, "ExportsGetByManagementGroup": { "$ref": "./examples/ExportsGetByManagementGroup.json" }, "ExportsGetByResourceGroup": { "$ref": "./examples/ExportsGetByResourceGroup.json" }, "ExportsGetBySubscription": { "$ref": "./examples/ExportsGetBySubscription.json" } } } }, "/{scope}/providers/Microsoft.CostManagement/exports/{exportName}": { "get": { "operationId": "Exports_Get", "tags": [ "Exports" ], "description": "The operation to get the export for the defined scope by export name.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "scope", "in": "path", "description": "The fully qualified Azure Resource manager identifier of the resource.", "required": true, "type": "string", "x-ms-skip-url-encoding": true }, { "name": "exportName", "in": "path", "description": "Export Name.", "required": true, "type": "string" }, { "name": "$expand", "in": "query", "description": "May be used to expand the properties within an export. Currently only 'runHistory' is supported and will return information for the last 10 runs of the export.", "required": false, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Export" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "ExportGetByBillingAccount": { "$ref": "./examples/ExportGetByBillingAccount.json" }, "ExportGetByDepartment": { "$ref": "./examples/ExportGetByDepartment.json" }, "ExportGetByEnrollmentAccount": { "$ref": "./examples/ExportGetByEnrollmentAccount.json" }, "ExportGetByManagementGroup": { "$ref": "./examples/ExportGetByManagementGroup.json" }, "ExportGetByResourceGroup": { "$ref": "./examples/ExportGetByResourceGroup.json" }, "ExportGetBySubscription": { "$ref": "./examples/ExportGetBySubscription.json" } } }, "put": { "operationId": "Exports_CreateOrUpdate", "tags": [ "Exports" ], "description": "The operation to create or update a export. Update operation requires latest eTag to be set in the request. You may obtain the latest eTag by performing a get operation. Create operation does not require eTag.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "scope", "in": "path", "description": "The fully qualified Azure Resource manager identifier of the resource.", "required": true, "type": "string", "x-ms-skip-url-encoding": true }, { "name": "exportName", "in": "path", "description": "Export Name.", "required": true, "type": "string" }, { "name": "parameters", "in": "body", "description": "Parameters supplied to the CreateOrUpdate Export operation.", "required": true, "schema": { "$ref": "#/definitions/Export" } } ], "responses": { "200": { "description": "Resource 'Export' update operation succeeded", "schema": { "$ref": "#/definitions/Export" } }, "201": { "description": "Resource 'Export' create operation succeeded", "schema": { "$ref": "#/definitions/Export" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "ExportCreateOrUpdateByBillingAccount": { "$ref": "./examples/ExportCreateOrUpdateByBillingAccount.json" }, "ExportCreateOrUpdateByBillingAccountCustom": { "$ref": "./examples/ExportCreateOrUpdateByBillingAccountCustom.json" }, "ExportCreateOrUpdateByBillingAccountMonthly": { "$ref": "./examples/ExportCreateOrUpdateByBillingAccountMonthly.json" }, "ExportCreateOrUpdateByBillingAccountPricesheet": { "$ref": "./examples/ExportCreateOrUpdateByBillingAccountPricesheet.json" }, "ExportCreateOrUpdateByBillingAccountReservationDetails": { "$ref": "./examples/ExportCreateOrUpdateByBillingAccountReservationDetails.json" }, "ExportCreateOrUpdateByBillingAccountReservationRecommendation": { "$ref": "./examples/ExportCreateOrUpdateByBillingAccountReservationRecommendation.json" }, "ExportCreateOrUpdateByDepartment": { "$ref": "./examples/ExportCreateOrUpdateByDepartment.json" }, "ExportCreateOrUpdateByEnrollmentAccount": { "$ref": "./examples/ExportCreateOrUpdateByEnrollmentAccount.json" }, "ExportCreateOrUpdateByManagementGroup": { "$ref": "./examples/ExportCreateOrUpdateByManagementGroup.json" }, "ExportCreateOrUpdateByResourceGroup": { "$ref": "./examples/ExportCreateOrUpdateByResourceGroup.json" }, "ExportCreateOrUpdateBySubscription": { "$ref": "./examples/ExportCreateOrUpdateBySubscription.json" }, "ExportCreateOrUpdateExportCreateOrUpdateByBillingAccountReservationTransactionsByBillingAccount": { "$ref": "./examples/ExportCreateOrUpdateByBillingAccountReservationTransactions.json" } } }, "delete": { "operationId": "Exports_Delete", "tags": [ "Exports" ], "description": "The operation to delete a export.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "scope", "in": "path", "description": "The fully qualified Azure Resource manager identifier of the resource.", "required": true, "type": "string", "x-ms-skip-url-encoding": true }, { "name": "exportName", "in": "path", "description": "Export Name.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Resource deleted successfully." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "ExportDeleteByBillingAccount": { "$ref": "./examples/ExportDeleteByBillingAccount.json" }, "ExportDeleteByDepartment": { "$ref": "./examples/ExportDeleteByDepartment.json" }, "ExportDeleteByEnrollmentAccount": { "$ref": "./examples/ExportDeleteByEnrollmentAccount.json" }, "ExportDeleteByManagementGroup": { "$ref": "./examples/ExportDeleteByManagementGroup.json" }, "ExportDeleteByResourceGroup": { "$ref": "./examples/ExportDeleteByResourceGroup.json" }, "ExportDeleteBySubscription": { "$ref": "./examples/ExportDeleteBySubscription.json" } } } }, "/{scope}/providers/Microsoft.CostManagement/exports/{exportName}/run": { "post": { "operationId": "Exports_Execute", "tags": [ "Exports" ], "description": "The operation to run an export.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "scope", "in": "path", "description": "The fully qualified Azure Resource manager identifier of the resource.", "required": true, "type": "string", "x-ms-skip-url-encoding": true }, { "name": "exportName", "in": "path", "description": "Export Name.", "required": true, "type": "string" }, { "name": "parameters", "in": "body", "description": "Parameters supplied to the Execute Export operation.", "required": false, "schema": { "$ref": "#/definitions/ExportRunRequest" } } ], "responses": { "200": { "description": "The request has succeeded." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "ExportRunByBillingAccount": { "$ref": "./examples/ExportRunByBillingAccount.json" }, "ExportRunByBillingAccountWithOptionalRequestBody": { "$ref": "./examples/ExportRunByBillingAccountWithOptionalRequestBody.json" }, "ExportRunByDepartment": { "$ref": "./examples/ExportRunByDepartment.json" }, "ExportRunByEnrollmentAccount": { "$ref": "./examples/ExportRunByEnrollmentAccount.json" }, "ExportRunByManagementGroup": { "$ref": "./examples/ExportRunByManagementGroup.json" }, "ExportRunByResourceGroup": { "$ref": "./examples/ExportRunByResourceGroup.json" }, "ExportRunBySubscription": { "$ref": "./examples/ExportRunBySubscription.json" } } } }, "/{scope}/providers/Microsoft.CostManagement/exports/{exportName}/runHistory": { "get": { "operationId": "Exports_GetExecutionHistory", "tags": [ "Exports" ], "description": "The operation to get the run history of an export for the defined scope and export name.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "scope", "in": "path", "description": "The fully qualified Azure Resource manager identifier of the resource.", "required": true, "type": "string", "x-ms-skip-url-encoding": true }, { "name": "exportName", "in": "path", "description": "Export Name.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ExportExecutionListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "ExportRunHistoryGetByBillingAccount": { "$ref": "./examples/ExportRunHistoryGetByBillingAccount.json" }, "ExportRunHistoryGetByDepartment": { "$ref": "./examples/ExportRunHistoryGetByDepartment.json" }, "ExportRunHistoryGetByEnrollmentAccount": { "$ref": "./examples/ExportRunHistoryGetByEnrollmentAccount.json" }, "ExportRunHistoryGetByManagementGroup": { "$ref": "./examples/ExportRunHistoryGetByManagementGroup.json" }, "ExportRunHistoryGetByResourceGroup": { "$ref": "./examples/ExportRunHistoryGetByResourceGroup.json" }, "ExportRunHistoryGetBySubscription": { "$ref": "./examples/ExportRunHistoryGetBySubscription.json" } } } }, "/{scope}/providers/Microsoft.CostManagement/forecast": { "post": { "operationId": "Forecast_Usage", "description": "Lists the forecast charges for scope defined.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "$filter", "in": "query", "description": "May be used to filter forecasts by properties/usageDate (Utc time), properties/chargeType or properties/grain. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'.", "required": false, "type": "string" }, { "name": "scope", "in": "path", "description": "The scope associated with forecast operations. This includes '/subscriptions/{subscriptionId}/' for subscription scope, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope and '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, '/providers/Microsoft.Management/managementGroups/{managementGroupId} for Management Group scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billingProfile scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/invoiceSections/{invoiceSectionId}' for invoiceSection scope, and '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/customers/{customerId}' specific for partners.", "required": true, "type": "string", "x-ms-skip-url-encoding": true }, { "name": "parameters", "in": "body", "description": "Parameters supplied to the CreateOrUpdate Forecast Config operation.", "required": true, "schema": { "$ref": "#/definitions/ForecastDefinition" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ForecastResult" } }, "204": { "description": "There is no content to send for this request, but the headers may be useful." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "BillingAccountForecast": { "$ref": "./examples/BillingAccountForecast.json" }, "BillingProfileForecast": { "$ref": "./examples/BillingProfileForecast.json" }, "DepartmentForecast": { "$ref": "./examples/DepartmentForecast.json" }, "EnrollmentAccountForecast": { "$ref": "./examples/EnrollmentAccountForecast.json" }, "InvoiceSectionForecast": { "$ref": "./examples/InvoiceSectionForecast.json" }, "ResourceGroupForecast": { "$ref": "./examples/ResourceGroupForecast.json" }, "SubscriptionForecast": { "$ref": "./examples/SubscriptionForecast.json" } } } }, "/{scope}/providers/Microsoft.CostManagement/generateCostDetailsReport": { "post": { "operationId": "GenerateCostDetailsReport_CreateOperation", "description": "This API is the replacement for all previously release Usage Details APIs. Request to generate a cost details report for the provided date range, billing period (Only enterprise customers) or Invoice Id asynchronously at a certain scope. The initial call to request a report will return a 202 with a 'Location' and 'Retry-After' header. The 'Location' header will provide the endpoint to poll to get the result of the report generation. The 'Retry-After' provides the duration to wait before polling for the generated report. A call to poll the report operation will provide a 202 response with a 'Location' header if the operation is still in progress. Once the report generation operation completes, the polling endpoint will provide a 200 response along with details on the report blob(s) that are available for download. The details on the file(s) available for download will be available in the polling response body. To Understand cost details (formerly known as usage details) fields found in files ,see https://learn.microsoft.com/en-us/azure/cost-management-billing/automate/understand-usage-details-fields", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "scope", "in": "path", "description": "The ARM Resource ID for subscription, billing account, or other billing scopes.Currently Resource Group and Management Group are not supported. For details, see https://aka.ms/costmgmt/scopes.", "required": true, "type": "string", "x-ms-skip-url-encoding": true }, { "name": "parameters", "in": "body", "description": "Parameters supplied to the Create cost details operation.", "required": true, "schema": { "$ref": "#/definitions/GenerateCostDetailsReportRequestDefinition" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/CostDetailsOperationResults" } }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." } } }, "204": { "description": "There is no content to send for this request, but the headers may be useful." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/GenerateCostDetailsReportErrorResponse" } } }, "x-ms-examples": { "GenerateCostDetailsReportByBillingAccountEnterpriseAgreementCustomerAndBillingPeriod": { "$ref": "./examples/GenerateCostDetailsReportByBillingAccountEnterpriseAgreementCustomerAndBillingPeriod.json" }, "GenerateCostDetailsReportByBillingProfileAndInvoiceId": { "$ref": "./examples/GenerateCostDetailsReportByBillingProfileAndInvoiceId.json" }, "GenerateCostDetailsReportByBillingProfileAndInvoiceIdAndCustomerId": { "$ref": "./examples/GenerateCostDetailsReportByBillingProfileAndInvoiceIdAndCustomerId.json" }, "GenerateCostDetailsReportByCustomerAndTimePeriod": { "$ref": "./examples/GenerateCostDetailsReportByCustomerAndTimePeriod.json" }, "GenerateCostDetailsReportByDepartmentsAndTimePeriod": { "$ref": "./examples/GenerateCostDetailsReportByDepartmentsAndTimePeriod.json" }, "GenerateCostDetailsReportByEnrollmentAccountsAndTimePeriod": { "$ref": "./examples/GenerateCostDetailsReportByEnrollmentAccountsAndTimePeriod.json" }, "GenerateCostDetailsReportBySubscriptionAndTimePeriod": { "$ref": "./examples/GenerateCostDetailsReportBySubscriptionAndTimePeriod.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/CostDetailsOperationResults" }, "x-ms-long-running-operation": true } }, "/{scope}/providers/Microsoft.CostManagement/generateDetailedCostReport": { "post": { "operationId": "GenerateDetailedCostReport_CreateOperation", "description": "Generates the detailed cost report for provided date range, billing period(only enterprise customers) or Invoice ID asynchronously at a certain scope. Call returns a 202 with header Azure-Consumption-AsyncOperation providing a link to the operation created. A call on the operation will provide the status and if the operation is completed the blob file where generated detailed cost report is being stored.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "scope", "in": "path", "description": "The ARM Resource ID for subscription, resource group, billing account, or other billing scopes. For details, see https://aka.ms/costmgmt/scopes.", "required": true, "type": "string", "x-ms-skip-url-encoding": true }, { "name": "parameters", "in": "body", "description": "Parameters supplied to the Create detailed cost report operation.", "required": true, "schema": { "$ref": "#/definitions/GenerateDetailedCostReportDefinition" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/GenerateDetailedCostReportOperationResult" } }, "202": { "description": "The request has been accepted for processing, but processing has not yet completed.", "headers": { "Azure-AsyncOperation": { "type": "string", "format": "uri", "description": "A link to the status monitor" }, "Azure-Consumption-AsyncOperation": { "type": "string", "description": "The URL to check the status of the asynchronous operation." }, "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/GenerateDetailedCostReportErrorResponse" } } }, "x-ms-examples": { "GenerateDetailedCostReportByBillingAccountLegacyAndBillingPeriod": { "$ref": "./examples/GenerateDetailedCostReportByBillingAccountLegacyAndBillingPeriod.json" }, "GenerateDetailedCostReportByBillingProfileAndInvoiceId": { "$ref": "./examples/GenerateDetailedCostReportByBillingProfileAndInvoiceId.json" }, "GenerateDetailedCostReportByBillingProfileAndInvoiceIdAndCustomerId": { "$ref": "./examples/GenerateDetailedCostReportByBillingProfileAndInvoiceIdAndCustomerId.json" }, "GenerateDetailedCostReportByCustomerAndTimePeriod": { "$ref": "./examples/GenerateDetailedCostReportByCustomerAndTimePeriod.json" }, "GenerateDetailedCostReportBySubscriptionAndTimePeriod": { "$ref": "./examples/GenerateDetailedCostReportBySubscriptionAndTimePeriod.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/GenerateDetailedCostReportOperationResult" }, "x-ms-long-running-operation": true } }, "/{scope}/providers/Microsoft.CostManagement/operationResults/{operationId}": { "get": { "operationId": "GenerateDetailedCostReportOperationResults_Get", "tags": [ "GenerateDetailedCostReportOperationResults" ], "description": "Gets the result of the specified operation. The link with this operationId is provided as a response header of the initial request.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "scope", "in": "path", "description": "The fully qualified Azure Resource manager identifier of the resource.", "required": true, "type": "string", "x-ms-skip-url-encoding": true }, { "name": "operationId", "in": "path", "description": "The target operation Id.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/GenerateDetailedCostReportOperationResult" } }, "202": { "description": "Resource operation accepted.", "headers": { "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get details of the operation result": { "$ref": "./examples/GenerateDetailedCostReportOperationResultsBySubscriptionScope.json" } }, "x-ms-long-running-operation": true } }, "/{scope}/providers/Microsoft.CostManagement/operationStatus/{operationId}": { "get": { "operationId": "GenerateDetailedCostReportOperationStatus_Get", "tags": [ "GenerateDetailedCostReportOperationStatus" ], "description": "Get the status of the specified operation. This link is provided in the GenerateDetailedCostReport creation request response header.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "scope", "in": "path", "description": "The fully qualified Azure Resource manager identifier of the resource.", "required": true, "type": "string", "x-ms-skip-url-encoding": true }, { "name": "operationId", "in": "path", "description": "The target operation Id.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/GenerateDetailedCostReportOperationStatuses" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get details of the operation status": { "$ref": "./examples/GenerateDetailedCostReportOperationStatusBySubscriptionScope.json" } } } }, "/{scope}/providers/Microsoft.CostManagement/query": { "post": { "operationId": "Query_Usage", "description": "Query the usage data for scope defined.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "scope", "in": "path", "description": "The scope associated with query and export operations. This includes '/subscriptions/{subscriptionId}/' for subscription scope, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope and '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, '/providers/Microsoft.Management/managementGroups/{managementGroupId} for Management Group scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billingProfile scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/invoiceSections/{invoiceSectionId}' for invoiceSection scope, and '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/customers/{customerId}' specific for partners.", "required": true, "type": "string", "x-ms-skip-url-encoding": true }, { "name": "parameters", "in": "body", "description": "Parameters supplied to the CreateOrUpdate Query Config operation.", "required": true, "schema": { "$ref": "#/definitions/QueryDefinition" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/QueryResult" } }, "204": { "description": "There is no content to send for this request, but the headers may be useful." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "BillingAccountQuery-Legacy": { "$ref": "./examples/BillingAccountQuery.json" }, "BillingAccountQuery-MCA": { "$ref": "./examples/MCABillingAccountQuery.json" }, "BillingAccountQueryGrouping-Legacy": { "$ref": "./examples/BillingAccountQueryGrouping.json" }, "BillingAccountQueryGrouping-MCA": { "$ref": "./examples/MCABillingAccountQueryGrouping.json" }, "BillingProfileQuery-MCA": { "$ref": "./examples/MCABillingProfileQuery.json" }, "BillingProfileQueryGrouping-MCA": { "$ref": "./examples/MCABillingProfileQueryGrouping.json" }, "CustomerQuery-MCA": { "$ref": "./examples/MCACustomerQuery.json" }, "CustomerQueryGrouping-MCA": { "$ref": "./examples/MCACustomerQueryGrouping.json" }, "DepartmentQuery-Legacy": { "$ref": "./examples/DepartmentQuery.json" }, "DepartmentQueryGrouping-Legacy": { "$ref": "./examples/DepartmentQueryGrouping.json" }, "EnrollmentAccountQuery-Legacy": { "$ref": "./examples/EnrollmentAccountQuery.json" }, "EnrollmentAccountQueryGrouping-Legacy": { "$ref": "./examples/EnrollmentAccountQueryGrouping.json" }, "InvoiceSectionQuery-MCA": { "$ref": "./examples/MCAInvoiceSectionQuery.json" }, "InvoiceSectionQueryGrouping-MCA": { "$ref": "./examples/MCAInvoiceSectionQueryGrouping.json" }, "ManagementGroupQuery-Legacy": { "$ref": "./examples/ManagementGroupQuery.json" }, "ManagementGroupQueryGrouping-Legacy": { "$ref": "./examples/ManagementGroupQueryGrouping.json" }, "ResourceGroupQuery-Legacy": { "$ref": "./examples/ResourceGroupQuery.json" }, "ResourceGroupQueryGrouping-Legacy": { "$ref": "./examples/ResourceGroupQueryGrouping.json" }, "SubscriptionQuery-Legacy": { "$ref": "./examples/SubscriptionQuery.json" }, "SubscriptionQueryGrouping-Legacy": { "$ref": "./examples/SubscriptionQueryGrouping.json" } } } }, "/{scope}/providers/Microsoft.CostManagement/scheduledActions": { "get": { "operationId": "ScheduledActions_ListByScope", "tags": [ "ScheduledActionOperationGroup" ], "description": "List all shared scheduled actions within the given scope.", "externalDocs": { "url": "https://docs.microsoft.com/rest/api/cost-management/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "scope", "in": "path", "description": "undefined", "required": true, "type": "string" }, { "name": "$filter", "in": "query", "description": "May be used to filter scheduled actions by properties/viewId. Supported operator is 'eq'.", "required": false, "type": "string" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/ScheduledActionListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponseWithNestedDetails" } } }, "x-ms-examples": { "ScheduledActionsListByScope": { "$ref": "./examples/scheduledActions/scheduledActions-list-shared.json" }, "ScheduledActionsListByScopeFilterByViewId": { "$ref": "./examples/scheduledActions/scheduledActions-listWithFilter-shared.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/{scope}/providers/Microsoft.CostManagement/scheduledActions/{name}": { "get": { "operationId": "ScheduledActions_GetByScope", "tags": [ "ScheduledActionOperationGroup" ], "description": "Get the shared scheduled action from the given scope by name.", "externalDocs": { "url": "https://docs.microsoft.com/rest/api/cost-management/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "scope", "in": "path", "description": "undefined", "required": true, "type": "string" }, { "name": "name", "in": "path", "description": "Scheduled action name.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ScheduledAction" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponseWithNestedDetails" } } }, "x-ms-examples": { "ScheduledActionByScope": { "$ref": "./examples/scheduledActions/scheduledAction-get-shared.json" } } }, "put": { "operationId": "ScheduledActions_CreateOrUpdateByScope", "tags": [ "ScheduledActionOperationGroup" ], "description": "Create or update a shared scheduled action within the given scope.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "scope", "in": "path", "description": "undefined", "required": true, "type": "string" }, { "name": "name", "in": "path", "description": "Scheduled action name.", "required": true, "type": "string" }, { "name": "If-Match", "in": "header", "description": "ETag of the Entity. Not required when creating an entity. Optional when updating an entity and can be specified to achieve optimistic concurrency.", "required": false, "type": "string" }, { "name": "scheduledAction", "in": "body", "description": "Scheduled action to be created or updated.", "required": true, "schema": { "$ref": "#/definitions/ScheduledAction" } } ], "responses": { "200": { "description": "Resource 'ScheduledAction' update operation succeeded", "schema": { "$ref": "#/definitions/ScheduledAction" } }, "201": { "description": "Resource 'ScheduledAction' create operation succeeded", "schema": { "$ref": "#/definitions/ScheduledAction" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponseWithNestedDetails" } } }, "x-ms-examples": { "CreateOrUpdateInsightAlertScheduledActionByScope": { "$ref": "./examples/scheduledActions/scheduledAction-insightAlert-createOrUpdate-shared.json" }, "CreateOrUpdateScheduledActionByScope": { "$ref": "./examples/scheduledActions/scheduledAction-createOrUpdate-shared.json" } } }, "delete": { "operationId": "ScheduledActions_DeleteByScope", "tags": [ "ScheduledActionOperationGroup" ], "description": "Delete a scheduled action within the given scope.", "externalDocs": { "url": "https://docs.microsoft.com/rest/api/cost-management/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "scope", "in": "path", "description": "undefined", "required": true, "type": "string" }, { "name": "name", "in": "path", "description": "Scheduled action name.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Resource deleted successfully." }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponseWithNestedDetails" } } }, "x-ms-examples": { "ScheduledActionDeleteByScope": { "$ref": "./examples/scheduledActions/scheduledAction-delete-shared.json" } } } }, "/{scope}/providers/Microsoft.CostManagement/scheduledActions/{name}/execute": { "post": { "operationId": "ScheduledActions_RunByScope", "tags": [ "ScheduledActionOperationGroup" ], "description": "Runs a shared scheduled action within the given scope.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "scope", "in": "path", "description": "undefined", "required": true, "type": "string" }, { "name": "name", "in": "path", "description": "Scheduled action name.", "required": true, "type": "string" } ], "responses": { "200": { "description": "The request has succeeded." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponseWithNestedDetails" } } }, "x-ms-examples": { "ScheduledActionRunByScope": { "$ref": "./examples/scheduledActions/scheduledAction-sendNow-shared.json" } } } }, "/{scope}/providers/Microsoft.CostManagement/settings": { "get": { "operationId": "Settings_List", "tags": [ "Settings" ], "description": "List all cost management settings in the requested scope.", "externalDocs": { "url": "https://docs.microsoft.com/rest/api/cost-management/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "scope", "in": "path", "description": "undefined", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/SettingsListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "SettingsList": { "$ref": "./examples/settingsList.json" } } } }, "/{scope}/providers/Microsoft.CostManagement/settings/{type}": { "get": { "operationId": "Settings_GetByScope", "tags": [ "Settings" ], "description": "Get the setting from the given scope by name.", "externalDocs": { "url": "https://docs.microsoft.com/rest/api/cost-management/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "scope", "in": "path", "description": "undefined", "required": true, "type": "string" }, { "name": "type", "in": "path", "description": "Setting type.", "required": true, "type": "string", "enum": [ "taginheritance" ], "x-ms-enum": { "name": "SettingType", "modelAsString": true, "values": [ { "name": "taginheritance", "value": "taginheritance", "description": "This setting applies billing profile, invoice section, subscription and resource group tags to current month's usage data of child resources." } ] } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Setting" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "SettingByScope": { "$ref": "./examples/setting-get.json" } } }, "put": { "operationId": "Settings_CreateOrUpdateByScope", "tags": [ "Settings" ], "description": "Create or update a setting within the given scope.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "scope", "in": "path", "description": "undefined", "required": true, "type": "string" }, { "name": "type", "in": "path", "description": "Setting type.", "required": true, "type": "string", "enum": [ "taginheritance" ], "x-ms-enum": { "name": "SettingType", "modelAsString": true, "values": [ { "name": "taginheritance", "value": "taginheritance", "description": "This setting applies billing profile, invoice section, subscription and resource group tags to current month's usage data of child resources." } ] } }, { "name": "setting", "in": "body", "description": "Setting to be created or updated.", "required": true, "schema": { "$ref": "#/definitions/Setting" } } ], "responses": { "200": { "description": "Resource 'Setting' update operation succeeded", "schema": { "$ref": "#/definitions/Setting" } }, "201": { "description": "Resource 'Setting' create operation succeeded", "schema": { "$ref": "#/definitions/Setting" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "CreateOrUpdateSettingByScope": { "$ref": "./examples/settings-createOrUpdate.json" } } }, "delete": { "operationId": "Settings_DeleteByScope", "tags": [ "Settings" ], "description": "Delete a setting within the given scope.", "externalDocs": { "url": "https://docs.microsoft.com/rest/api/cost-management/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "scope", "in": "path", "description": "undefined", "required": true, "type": "string" }, { "name": "type", "in": "path", "description": "Setting type.", "required": true, "type": "string", "enum": [ "taginheritance" ], "x-ms-enum": { "name": "SettingType", "modelAsString": true, "values": [ { "name": "taginheritance", "value": "taginheritance", "description": "This setting applies billing profile, invoice section, subscription and resource group tags to current month's usage data of child resources." } ] } } ], "responses": { "200": { "description": "Resource deleted successfully." }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "SettingDeleteByScope": { "$ref": "./examples/setting-delete.json" } } } }, "/{scope}/providers/Microsoft.CostManagement/views": { "get": { "operationId": "Views_ListByScope", "tags": [ "ViewOperationGroup" ], "description": "Lists all views at the given scope.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "scope", "in": "path", "description": "undefined", "required": true, "type": "string" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/ViewListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "ResourceGroupViewList": { "$ref": "./examples/ViewListByResourceGroup.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/{scope}/providers/Microsoft.CostManagement/views/{viewName}": { "get": { "operationId": "Views_GetByScope", "tags": [ "ViewOperationGroup" ], "description": "Gets the view for the defined scope by view name.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "scope", "in": "path", "description": "undefined", "required": true, "type": "string" }, { "name": "viewName", "in": "path", "description": "View name", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/View" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "ResourceGroupView": { "$ref": "./examples/ViewByResourceGroup.json" } } }, "put": { "operationId": "Views_CreateOrUpdateByScope", "tags": [ "ViewOperationGroup" ], "description": "The operation to create or update a view. Update operation requires latest eTag to be set in the request. You may obtain the latest eTag by performing a get operation. Create operation does not require eTag.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "scope", "in": "path", "description": "undefined", "required": true, "type": "string" }, { "name": "viewName", "in": "path", "description": "View name", "required": true, "type": "string" }, { "name": "parameters", "in": "body", "description": "Parameters supplied to the CreateOrUpdate View operation.", "required": true, "schema": { "$ref": "#/definitions/View" } } ], "responses": { "200": { "description": "Resource 'View' update operation succeeded", "schema": { "$ref": "#/definitions/View" } }, "201": { "description": "Resource 'View' create operation succeeded", "schema": { "$ref": "#/definitions/View" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "ResourceGroupCreateOrUpdateView": { "$ref": "./examples/ViewCreateOrUpdateByResourceGroup.json" } } }, "delete": { "operationId": "Views_DeleteByScope", "tags": [ "ViewOperationGroup" ], "description": "The operation to delete a view.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "scope", "in": "path", "description": "undefined", "required": true, "type": "string" }, { "name": "viewName", "in": "path", "description": "View name", "required": true, "type": "string" } ], "responses": { "200": { "description": "Resource deleted successfully." }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "ResourceGroupDeleteView": { "$ref": "./examples/ViewDeleteByResourceGroup.json" } } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/providers/Microsoft.CostManagement/markupRules": { "get": { "operationId": "MarkupRules_List", "tags": [ "MarkupRules" ], "description": "List all markup rules for a billing account and billing profile.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountId", "in": "path", "description": "BillingAccount ID", "required": true, "type": "string" }, { "name": "billingProfileId", "in": "path", "description": "BillingProfile ID", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/MarkupRulePagedResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "MarkupRulesList": { "$ref": "./examples/MarkupRulesList.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/providers/Microsoft.CostManagement/markupRules/{ruleName}": { "get": { "operationId": "MarkupRules_Get", "tags": [ "MarkupRules" ], "description": "Get a markup rule by name for a billing account and billing profile.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountId", "in": "path", "description": "BillingAccount ID", "required": true, "type": "string" }, { "name": "billingProfileId", "in": "path", "description": "BillingProfile ID", "required": true, "type": "string" }, { "name": "ruleName", "in": "path", "description": "Markup rule name.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9_][a-zA-Z0-9_-]{0,63}$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/MarkupRule" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "MarkupRulesGet": { "$ref": "./examples/MarkupRulesGet.json" } } }, "put": { "operationId": "MarkupRules_CreateOrUpdate", "tags": [ "MarkupRules" ], "description": "Create or update a markup rule for a billing account and billing profile.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountId", "in": "path", "description": "BillingAccount ID", "required": true, "type": "string" }, { "name": "billingProfileId", "in": "path", "description": "BillingProfile ID", "required": true, "type": "string" }, { "name": "ruleName", "in": "path", "description": "Markup rule name.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9_][a-zA-Z0-9_-]{0,63}$" }, { "name": "resource", "in": "body", "description": "The markup rule to create or update.", "required": true, "schema": { "$ref": "#/definitions/MarkupRule" } } ], "responses": { "200": { "description": "Resource 'MarkupRule' update operation succeeded", "schema": { "$ref": "#/definitions/MarkupRule" } }, "201": { "description": "Resource 'MarkupRule' create operation succeeded", "schema": { "$ref": "#/definitions/MarkupRule" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "MarkupRulesCreateOrUpdate": { "$ref": "./examples/MarkupRulesCreateOrUpdate.json" } } }, "delete": { "operationId": "MarkupRules_Delete", "tags": [ "MarkupRules" ], "description": "Delete a markup rule for a billing account and billing profile.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountId", "in": "path", "description": "BillingAccount ID", "required": true, "type": "string" }, { "name": "billingProfileId", "in": "path", "description": "BillingProfile ID", "required": true, "type": "string" }, { "name": "ruleName", "in": "path", "description": "Markup rule name.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9_][a-zA-Z0-9_-]{0,63}$" } ], "responses": { "200": { "description": "Resource deleted successfully." }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "MarkupRulesDelete": { "$ref": "./examples/MarkupRulesDelete.json" } } } }, "/providers/Microsoft.CostManagement/{externalCloudProviderType}/{externalCloudProviderId}/alerts": { "get": { "operationId": "Alerts_ListExternal", "description": "Lists the Alerts for external cloud provider type defined.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "externalCloudProviderType", "in": "path", "description": "The external cloud provider type associated with dimension/query operations. This includes 'externalSubscriptions' for linked account and 'externalBillingAccounts' for consolidated account.", "required": true, "type": "string", "enum": [ "externalSubscriptions", "externalBillingAccounts" ], "x-ms-enum": { "name": "ExternalCloudProviderType", "modelAsString": true, "values": [ { "name": "externalSubscriptions", "value": "externalSubscriptions" }, { "name": "externalBillingAccounts", "value": "externalBillingAccounts" } ] } }, { "name": "externalCloudProviderId", "in": "path", "description": "This can be '{externalSubscriptionId}' for linked account or '{externalBillingAccountId}' for consolidated account used with dimension/query operations.", "required": true, "type": "string" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/AlertsResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "ExternalBillingAccountAlerts": { "$ref": "./examples/ExternalBillingAccountAlerts.json" }, "ExternalSubscriptionAlerts": { "$ref": "./examples/ExternalSubscriptionAlerts.json" } } } }, "/providers/Microsoft.CostManagement/{externalCloudProviderType}/{externalCloudProviderId}/dimensions": { "get": { "operationId": "Dimensions_ByExternalCloudProviderType", "description": "Lists the dimensions by the external cloud provider type.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "externalCloudProviderType", "in": "path", "description": "The external cloud provider type associated with dimension/query operations. This includes 'externalSubscriptions' for linked account and 'externalBillingAccounts' for consolidated account.", "required": true, "type": "string", "enum": [ "externalSubscriptions", "externalBillingAccounts" ], "x-ms-enum": { "name": "ExternalCloudProviderType", "modelAsString": true, "values": [ { "name": "externalSubscriptions", "value": "externalSubscriptions" }, { "name": "externalBillingAccounts", "value": "externalBillingAccounts" } ] } }, { "name": "externalCloudProviderId", "in": "path", "description": "This can be '{externalSubscriptionId}' for linked account or '{externalBillingAccountId}' for consolidated account used with dimension/query operations.", "required": true, "type": "string" }, { "name": "$filter", "in": "query", "description": "May be used to filter dimensions by properties/category, properties/usageStart, properties/usageEnd. Supported operators are 'eq','lt', 'gt', 'le', 'ge'.", "required": false, "type": "string" }, { "name": "$expand", "in": "query", "description": "May be used to expand the properties/data within a dimension category. By default, data is not included when listing dimensions.", "required": false, "type": "string" }, { "name": "$skiptoken", "in": "query", "description": "Skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls.", "required": false, "type": "string" }, { "name": "$top", "in": "query", "description": "May be used to limit the number of results to the most recent N dimension data.", "required": false, "type": "integer", "format": "int32", "minimum": 1, "maximum": 1000 } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/DimensionsListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "ExternalBillingAccountDimensionList": { "$ref": "./examples/ExternalBillingAccountsDimensions.json" }, "ExternalSubscriptionDimensionList": { "$ref": "./examples/ExternalSubscriptionsDimensions.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.CostManagement/{externalCloudProviderType}/{externalCloudProviderId}/forecast": { "post": { "operationId": "Forecast_ExternalCloudProviderUsage", "description": "Lists the forecast charges for external cloud provider type defined.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "$filter", "in": "query", "description": "May be used to filter forecasts by properties/usageDate (Utc time), properties/chargeType or properties/grain. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'.", "required": false, "type": "string" }, { "name": "externalCloudProviderType", "in": "path", "description": "The external cloud provider type associated with dimension/query operations. This includes 'externalSubscriptions' for linked account and 'externalBillingAccounts' for consolidated account.", "required": true, "type": "string", "enum": [ "externalSubscriptions", "externalBillingAccounts" ], "x-ms-enum": { "name": "ExternalCloudProviderType", "modelAsString": true, "values": [ { "name": "externalSubscriptions", "value": "externalSubscriptions" }, { "name": "externalBillingAccounts", "value": "externalBillingAccounts" } ] } }, { "name": "externalCloudProviderId", "in": "path", "description": "This can be '{externalSubscriptionId}' for linked account or '{externalBillingAccountId}' for consolidated account used with dimension/query operations.", "required": true, "type": "string" }, { "name": "parameters", "in": "body", "description": "The request body", "required": true, "schema": { "$ref": "#/definitions/ForecastDefinition" } } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/ForecastResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "ExternalBillingAccountForecast": { "$ref": "./examples/ExternalBillingAccountForecast.json" }, "ExternalSubscriptionForecast": { "$ref": "./examples/ExternalSubscriptionForecast.json" } } } }, "/providers/Microsoft.CostManagement/{externalCloudProviderType}/{externalCloudProviderId}/query": { "post": { "operationId": "Query_UsageByExternalCloudProviderType", "description": "Query the usage data for external cloud provider type defined.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "externalCloudProviderType", "in": "path", "description": "The external cloud provider type associated with dimension/query operations. This includes 'externalSubscriptions' for linked account and 'externalBillingAccounts' for consolidated account.", "required": true, "type": "string", "enum": [ "externalSubscriptions", "externalBillingAccounts" ], "x-ms-enum": { "name": "ExternalCloudProviderType", "modelAsString": true, "values": [ { "name": "externalSubscriptions", "value": "externalSubscriptions" }, { "name": "externalBillingAccounts", "value": "externalBillingAccounts" } ] } }, { "name": "externalCloudProviderId", "in": "path", "description": "This can be '{externalSubscriptionId}' for linked account or '{externalBillingAccountId}' for consolidated account used with dimension/query operations.", "required": true, "type": "string" }, { "name": "parameters", "in": "body", "description": "The request body", "required": true, "schema": { "$ref": "#/definitions/QueryDefinition" } } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/QueryResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "ExternalBillingAccountQueryList": { "$ref": "./examples/ExternalBillingAccountsQuery.json" }, "ExternalSubscriptionsQuery": { "$ref": "./examples/ExternalSubscriptionsQuery.json" } } } }, "/providers/Microsoft.CostManagement/checkNameAvailability": { "post": { "operationId": "ScheduledActions_CheckNameAvailability", "description": "Checks availability and correctness of the name for a scheduled action.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "checkNameAvailabilityRequest", "in": "body", "description": "The request body", "required": true, "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/CheckNameAvailabilityRequest" } } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/CheckNameAvailabilityResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponseWithNestedDetails" } } }, "x-ms-examples": { "ScheduledActionCheckNameAvailability": { "$ref": "./examples/scheduledActions/checkNameAvailability-private-scheduledAction.json" } } } }, "/providers/Microsoft.CostManagement/operations": { "get": { "operationId": "Operations_List", "tags": [ "Operations" ], "description": "List the operations for the provider", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/OperationListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "OperationList": { "$ref": "./examples/OperationList.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.CostManagement/scheduledActions": { "get": { "operationId": "ScheduledActions_List", "tags": [ "ScheduledActions" ], "description": "List all private scheduled actions.", "externalDocs": { "url": "https://docs.microsoft.com/rest/api/cost-management/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "$filter", "in": "query", "description": "May be used to filter scheduled actions by properties/viewId. Supported operator is 'eq'.", "required": false, "type": "string" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/ScheduledActionListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponseWithNestedDetails" } } }, "x-ms-examples": { "PrivateScheduledActionsList": { "$ref": "./examples/scheduledActions/scheduledActions-list-private.json" }, "PrivateScheduledActionsListFilterByViewId": { "$ref": "./examples/scheduledActions/scheduledActions-listWithFilter-private.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.CostManagement/scheduledActions/{name}": { "get": { "operationId": "ScheduledActions_Get", "tags": [ "ScheduledActions" ], "description": "Get the private scheduled action by name.", "externalDocs": { "url": "https://docs.microsoft.com/rest/api/cost-management/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "name", "in": "path", "description": "Scheduled action name.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ScheduledAction" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponseWithNestedDetails" } } }, "x-ms-examples": { "PrivateScheduledAction": { "$ref": "./examples/scheduledActions/scheduledAction-get-private.json" } } }, "put": { "operationId": "ScheduledActions_CreateOrUpdate", "tags": [ "ScheduledActions" ], "description": "Create or update a private scheduled action.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "name", "in": "path", "description": "Scheduled action name.", "required": true, "type": "string" }, { "name": "If-Match", "in": "header", "description": "ETag of the Entity. Not required when creating an entity. Optional when updating an entity and can be specified to achieve optimistic concurrency.", "required": false, "type": "string" }, { "name": "scheduledAction", "in": "body", "description": "Scheduled action to be created or updated.", "required": true, "schema": { "$ref": "#/definitions/ScheduledAction" } } ], "responses": { "200": { "description": "Resource 'ScheduledAction' update operation succeeded", "schema": { "$ref": "#/definitions/ScheduledAction" } }, "201": { "description": "Resource 'ScheduledAction' create operation succeeded", "schema": { "$ref": "#/definitions/ScheduledAction" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponseWithNestedDetails" } } }, "x-ms-examples": { "CreateOrUpdatePrivateScheduledAction": { "$ref": "./examples/scheduledActions/scheduledAction-createOrUpdate-private.json" } } }, "delete": { "operationId": "ScheduledActions_Delete", "tags": [ "ScheduledActions" ], "description": "Delete a private scheduled action.", "externalDocs": { "url": "https://docs.microsoft.com/rest/api/cost-management/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "name", "in": "path", "description": "Scheduled action name.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Resource deleted successfully." }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponseWithNestedDetails" } } }, "x-ms-examples": { "PrivateScheduledActionDelete": { "$ref": "./examples/scheduledActions/scheduledAction-delete-private.json" } } } }, "/providers/Microsoft.CostManagement/scheduledActions/{name}/execute": { "post": { "operationId": "ScheduledActions_Run", "tags": [ "ScheduledActions" ], "description": "Processes a private scheduled action.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "name", "in": "path", "description": "Scheduled action name.", "required": true, "type": "string" } ], "responses": { "200": { "description": "The request has succeeded." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponseWithNestedDetails" } } }, "x-ms-examples": { "ScheduledActionSendNow": { "$ref": "./examples/scheduledActions/scheduledAction-sendNow-private.json" } } } }, "/providers/Microsoft.CostManagement/views": { "get": { "operationId": "Views_List", "tags": [ "Views" ], "description": "Lists all views by tenant and object.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/ViewListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "PrivateViewList": { "$ref": "./examples/PrivateViewList.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.CostManagement/views/{viewName}": { "get": { "operationId": "Views_Get", "tags": [ "Views" ], "description": "Gets the view by view name.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "viewName", "in": "path", "description": "View name", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/View" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "PrivateView": { "$ref": "./examples/PrivateView.json" } } }, "put": { "operationId": "Views_CreateOrUpdate", "tags": [ "Views" ], "description": "The operation to create or update a view. Update operation requires latest eTag to be set in the request. You may obtain the latest eTag by performing a get operation. Create operation does not require eTag.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "viewName", "in": "path", "description": "View name", "required": true, "type": "string" }, { "name": "parameters", "in": "body", "description": "Parameters supplied to the CreateOrUpdate View operation.", "required": true, "schema": { "$ref": "#/definitions/View" } } ], "responses": { "200": { "description": "Resource 'View' update operation succeeded", "schema": { "$ref": "#/definitions/View" } }, "201": { "description": "Resource 'View' create operation succeeded", "schema": { "$ref": "#/definitions/View" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "CreateOrUpdatePrivateView": { "$ref": "./examples/PrivateViewCreateOrUpdate.json" } } }, "delete": { "operationId": "Views_Delete", "tags": [ "Views" ], "description": "The operation to delete a view.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "viewName", "in": "path", "description": "View name", "required": true, "type": "string" } ], "responses": { "200": { "description": "Resource deleted successfully." }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "DeletePrivateView": { "$ref": "./examples/PrivateViewDelete.json" } } } }, "/providers/microsoft.Billing/billingAccounts/{billingAccountId}/billingPeriods/{billingPeriodName}/providers/Microsoft.CostManagement/pricesheets/default/download": { "post": { "operationId": "PriceSheet_DownloadByBillingAccount", "description": "Generates the pricesheet for the provided billing period asynchronously based on the Enrollment ID. This is for Enterprise Agreement customers.\n\n**Migrate to version 2025-03-01**\n\nYou can use the 2025-03-01 API version with the new URI:\n\n'/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingPeriods/{billingPeriodName}/providers/Microsoft.CostManagement/pricesheets/default/download'\n\nWith a new schema detailed below, the new version of the price sheet provides additional information and includes prices for Azure Reserved Instances (RI) for the current billing period. We recommend downloading an Azure Price Sheet for when entering a new billing period if you would maintain an ongoing record of past Azure Reserved Instance (RI) pricing.\n\nThe EA Azure price sheet is available for billing periods in the past 13 months. To request a price sheet for a billing period older than 13 months, please contact support.\n\nThe Azure price sheet download experience has been updated from a single .csv file to a zip file containing multiple .csv files, each with max size of 75MB. The 2023-11-01 version has been upgraded to use http POST method; details can be found below.\n\nAll versions of the Microsoft.Consumption Azure Price Sheet - Download by Billing Account (including 2022-06-01, 2021-10-01, 2020-01-01-preview, 2019-10-01, 2019-05-01) are scheduled to be retired on 01 June 2026 and will no longer be supported after this date.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountId", "in": "path", "description": "BillingAccount ID", "required": true, "type": "string" }, { "name": "billingPeriodName", "in": "path", "description": "Billing Period Name.", "required": true, "type": "string", "pattern": "^[0-9]*$" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/OperationStatus" } }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "EAPriceSheetForBillingPeriod": { "$ref": "./examples/EAPriceSheetForBillingPeriod.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/OperationStatus" }, "x-ms-long-running-operation": true } }, "/providers/microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoices/{invoiceName}/providers/Microsoft.CostManagement/pricesheets/default/download": { "post": { "operationId": "PriceSheet_DownloadByInvoice", "description": "Gets a URL to download the pricesheet for an invoice. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "BillingAccount ID", "required": true, "type": "string", "pattern": "([A-Za-z0-9]+(-[A-Za-z0-9]+)+):([A-Za-z0-9]+(-[A-Za-z0-9]+)+)_[0-9]{4}-[0-9]{2}-[0-9]{2}" }, { "name": "billingProfileName", "in": "path", "description": "Billing Profile Name.", "required": true, "type": "string", "pattern": "([A-Za-z0-9]+(-[A-Za-z0-9]+)+)" }, { "name": "invoiceName", "in": "path", "description": "The ID that uniquely identifies an invoice.", "required": true, "type": "string", "pattern": "[A-Za-z0-9]+" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/DownloadURL" } }, "202": { "description": "The request has been accepted for processing, but processing has not yet completed.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "OData-EntityId": { "type": "string", "description": "The operation entity Id GUID." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "PricesheetDownload": { "$ref": "./examples/PricesheetDownload.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/DownloadURL" }, "x-ms-long-running-operation": true } }, "/providers/microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/providers/Microsoft.CostManagement/benefitUtilizationSummaries": { "get": { "operationId": "BenefitUtilizationSummaries_ListByBillingProfileId", "description": "Lists savings plan utilization summaries for billing profile. Supported at grain values: 'Daily' and 'Monthly'.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/cost-management/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountId", "in": "path", "description": "BillingAccount ID", "required": true, "type": "string" }, { "name": "billingProfileId", "in": "path", "description": "Billing Profile ID.", "required": true, "type": "string" }, { "name": "grainParameter", "in": "query", "description": "Grain.", "required": false, "type": "string", "enum": [ "Hourly", "Daily", "Monthly" ], "x-ms-enum": { "name": "GrainParameter", "modelAsString": true, "values": [ { "name": "Hourly", "value": "Hourly", "description": "Hourly grain corresponds to value per hour." }, { "name": "Daily", "value": "Daily", "description": "Hourly grain corresponds to value per day." }, { "name": "Monthly", "value": "Monthly", "description": "Hourly grain corresponds to value per month." } ] } }, { "name": "filter", "in": "query", "description": "Supports filtering by properties/benefitId, properties/benefitOrderId and properties/usageDate.", "required": false, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/BenefitUtilizationSummariesListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "SavingsPlanUtilizationSummaries-BillingProfile": { "$ref": "./examples/BenefitUtilizationSummaries/SavingsPlan-BillingProfile.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/providers/Microsoft.CostManagement/generateBenefitUtilizationSummariesReport": { "post": { "operationId": "GenerateBenefitUtilizationSummariesReport_GenerateByBillingProfile", "description": "Triggers generation of a benefit utilization summaries report for the provided billing account and billing profile.", "externalDocs": { "url": "https://docs.microsoft.com/rest/api/cost-management/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountId", "in": "path", "description": "BillingAccount ID", "required": true, "type": "string" }, { "name": "billingProfileId", "in": "path", "description": "Billing Profile ID.", "required": true, "type": "string" }, { "name": "benefitUtilizationSummariesRequest", "in": "body", "description": "Async Benefit Utilization Summary report to be created.", "required": true, "schema": { "$ref": "#/definitions/BenefitUtilizationSummariesRequest" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/BenefitUtilizationSummariesOperationStatus" } }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "GenerateUtilizationSummariesReportByBillingProfile": { "$ref": "./examples/BenefitUtilizationSummaries/Async/GenerateBenefitUtilizationSummariesReportByBillingProfile.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/BenefitUtilizationSummariesOperationStatus" }, "x-ms-long-running-operation": true } }, "/providers/microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/providers/Microsoft.CostManagement/generateReservationDetailsReport": { "post": { "operationId": "GenerateReservationDetailsReport_ByBillingProfileId", "description": "Generates the reservations details report for provided date range asynchronously by billing profile. The Reservation usage details can be viewed by only certain enterprise roles by default. For more details on the roles see, https://docs.microsoft.com/en-us/azure/cost-management-billing/reservations/reservation-utilization#view-utilization-in-the-azure-portal-with-azure-rbac-access", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountId", "in": "path", "description": "BillingAccount ID", "required": true, "type": "string" }, { "name": "billingProfileId", "in": "path", "description": "Billing Profile ID.", "required": true, "type": "string" }, { "name": "startDate", "in": "query", "description": "Start Date", "required": true, "type": "string" }, { "name": "endDate", "in": "query", "description": "End Date", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/OperationStatus" } }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "ReservationDetails": { "$ref": "./examples/GenerateReservationDetailsReportByBillingProfile.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/OperationStatus" }, "x-ms-long-running-operation": true } }, "/providers/microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/providers/Microsoft.CostManagement/pricesheets/default/download": { "post": { "operationId": "PriceSheet_DownloadByBillingProfile", "description": "Gets a URL to download the current month's pricesheet for a billing profile. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.\n\nYou can use the new 2023-09-01 API version for billing periods January 2023 onwards. Azure Reserved Instance (RI) pricing is only available through the new version of the API.\n\nDue to Azure product growth, the Azure price sheet download experience in this preview version will be updated from a single csv/json file to a Zip file containing multiple csv/json files, each with max size of 75MB.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "BillingAccount ID", "required": true, "type": "string", "pattern": "([A-Za-z0-9]+(-[A-Za-z0-9]+)+):([A-Za-z0-9]+(-[A-Za-z0-9]+)+)_[0-9]{4}-[0-9]{2}-[0-9]{2}" }, { "name": "billingProfileName", "in": "path", "description": "Billing Profile Name.", "required": true, "type": "string", "pattern": "([A-Za-z0-9]+(-[A-Za-z0-9]+)+)" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/PricesheetDownloadProperties" } }, "202": { "description": "The request has been accepted for processing, but processing has not yet completed.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "OData-EntityId": { "type": "string", "description": "The operation entity Id GUID." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "PricesheetDownloadByBillingProfile": { "$ref": "./examples/PricesheetDownloadByBillingProfile.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/PricesheetDownloadProperties" }, "x-ms-long-running-operation": true } }, "/providers/microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.CostManagement/benefitUtilizationSummaries": { "get": { "operationId": "BenefitUtilizationSummaries_ListByBillingAccountId", "description": "Lists savings plan utilization summaries for the enterprise agreement scope. Supported at grain values: 'Daily' and 'Monthly'.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/cost-management/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountId", "in": "path", "description": "BillingAccount ID", "required": true, "type": "string" }, { "name": "grainParameter", "in": "query", "description": "Grain.", "required": false, "type": "string", "enum": [ "Hourly", "Daily", "Monthly" ], "x-ms-enum": { "name": "GrainParameter", "modelAsString": true, "values": [ { "name": "Hourly", "value": "Hourly", "description": "Hourly grain corresponds to value per hour." }, { "name": "Daily", "value": "Daily", "description": "Hourly grain corresponds to value per day." }, { "name": "Monthly", "value": "Monthly", "description": "Hourly grain corresponds to value per month." } ] } }, { "name": "filter", "in": "query", "description": "Supports filtering by properties/benefitId, properties/benefitOrderId and properties/usageDate.", "required": false, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/BenefitUtilizationSummariesListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "SavingsPlanUtilizationSummaries-BillingAccount": { "$ref": "./examples/BenefitUtilizationSummaries/SavingsPlan-BillingAccount.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.CostManagement/costAllocationRules": { "get": { "operationId": "CostAllocationRules_List", "tags": [ "CostAllocationRuleDefinitions" ], "description": "Get the list of all cost allocation rules for a billing account or enterprise enrollment.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountId", "in": "path", "description": "BillingAccount ID", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/CostAllocationRuleList" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "CostAllocationRulesList": { "$ref": "./examples/CostAllocationRulesList.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.CostManagement/costAllocationRules/{ruleName}": { "get": { "operationId": "CostAllocationRules_Get", "tags": [ "CostAllocationRuleDefinitions" ], "description": "Get a cost allocation rule by rule name and billing account or enterprise enrollment.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountId", "in": "path", "description": "BillingAccount ID", "required": true, "type": "string" }, { "name": "ruleName", "in": "path", "description": "Cost allocation rule name. The name cannot include spaces or any non alphanumeric characters other than '_' and '-'. The max length is 260 characters.", "required": true, "type": "string", "pattern": "[A-Za-z0-9\\-_]+" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/CostAllocationRuleDefinition" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "CostAllocationRules": { "$ref": "./examples/CostAllocationRuleGet.json" } } }, "put": { "operationId": "CostAllocationRules_CreateOrUpdate", "tags": [ "CostAllocationRuleDefinitions" ], "description": "Create/Update a rule to allocate cost between different resources within a billing account or enterprise enrollment.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountId", "in": "path", "description": "BillingAccount ID", "required": true, "type": "string" }, { "name": "ruleName", "in": "path", "description": "Cost allocation rule name. The name cannot include spaces or any non alphanumeric characters other than '_' and '-'. The max length is 260 characters.", "required": true, "type": "string", "pattern": "[A-Za-z0-9\\-_]+" }, { "name": "costAllocationRule", "in": "body", "description": "Cost allocation rule to be created or updated", "required": true, "schema": { "$ref": "#/definitions/CostAllocationRuleDefinition" } } ], "responses": { "200": { "description": "Resource 'CostAllocationRuleDefinition' update operation succeeded", "schema": { "$ref": "#/definitions/CostAllocationRuleDefinition" } }, "201": { "description": "Resource 'CostAllocationRuleDefinition' create operation succeeded", "schema": { "$ref": "#/definitions/CostAllocationRuleDefinition" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "CostAllocationRulesCreateResourceGroup": { "$ref": "./examples/CostAllocationRuleCreate.json" }, "CostAllocationRulesCreateTag": { "$ref": "./examples/CostAllocationRuleCreateTag.json" } } }, "delete": { "operationId": "CostAllocationRules_Delete", "tags": [ "CostAllocationRuleDefinitions" ], "description": "Delete cost allocation rule for billing account or enterprise enrollment.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountId", "in": "path", "description": "BillingAccount ID", "required": true, "type": "string" }, { "name": "ruleName", "in": "path", "description": "Cost allocation rule name. The name cannot include spaces or any non alphanumeric characters other than '_' and '-'. The max length is 260 characters.", "required": true, "type": "string", "pattern": "[A-Za-z0-9\\-_]+" } ], "responses": { "200": { "description": "Resource deleted successfully." }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "DeleteCostAllocationRule": { "$ref": "./examples/CostAllocationRuleDelete.json" } } } }, "/providers/microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.CostManagement/costAllocationRules/checkNameAvailability": { "post": { "operationId": "CostAllocationRules_CheckNameAvailability", "description": "Checks availability and correctness of a name for a cost allocation rule", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountId", "in": "path", "description": "BillingAccount ID", "required": true, "type": "string" }, { "name": "costAllocationRuleCheckNameAvailabilityRequest", "in": "body", "description": "Cost allocation rule to be created or updated", "required": true, "schema": { "$ref": "#/definitions/CostAllocationRuleCheckNameAvailabilityRequest" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/CostAllocationRuleCheckNameAvailabilityResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "CostAllocationRuleCheckNameAvailability": { "$ref": "./examples/CostAllocationRuleCheckNameAvailability.json" } } } }, "/providers/microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.CostManagement/generateBenefitUtilizationSummariesReport": { "post": { "operationId": "GenerateBenefitUtilizationSummariesReport_GenerateByBillingAccount", "description": "Triggers generation of a benefit utilization summaries report for the provided billing account. This API supports only enrollment accounts.", "externalDocs": { "url": "https://docs.microsoft.com/rest/api/cost-management/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountId", "in": "path", "description": "BillingAccount ID", "required": true, "type": "string" }, { "name": "benefitUtilizationSummariesRequest", "in": "body", "description": "Async Benefit Utilization Summary report to be created.", "required": true, "schema": { "$ref": "#/definitions/BenefitUtilizationSummariesRequest" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/BenefitUtilizationSummariesOperationStatus" } }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "GenerateUtilizationSummariesReportByBillingAccount": { "$ref": "./examples/BenefitUtilizationSummaries/Async/GenerateBenefitUtilizationSummariesReportByBillingAccount.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/BenefitUtilizationSummariesOperationStatus" }, "x-ms-long-running-operation": true } }, "/providers/microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.CostManagement/generateReservationDetailsReport": { "post": { "operationId": "GenerateReservationDetailsReport_ByBillingAccountId", "description": "Generates the reservations details report for provided date range asynchronously based on enrollment id. The Reservation usage details can be viewed only by certain enterprise roles. For more details on the roles see, https://docs.microsoft.com/en-us/azure/cost-management-billing/manage/understand-ea-roles#usage-and-costs-access-by-role", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountId", "in": "path", "description": "BillingAccount ID", "required": true, "type": "string" }, { "name": "startDate", "in": "query", "description": "Start Date", "required": true, "type": "string" }, { "name": "endDate", "in": "query", "description": "End Date", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/OperationStatus" } }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "ReservationDetails": { "$ref": "./examples/GenerateReservationDetailsReportByBillingAccount.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/OperationStatus" }, "x-ms-long-running-operation": true } }, "/providers/microsoft.BillingBenefits/savingsPlanOrders/{savingsPlanOrderId}/providers/Microsoft.CostManagement/benefitUtilizationSummaries": { "get": { "operationId": "BenefitUtilizationSummaries_ListBySavingsPlanOrder", "description": "Lists the savings plan utilization summaries for daily or monthly grain.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/cost-management/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "$filter", "in": "query", "description": "Supports filtering by properties/usageDate.", "required": false, "type": "string" }, { "name": "grainParameter", "in": "query", "description": "Grain.", "required": false, "type": "string", "enum": [ "Hourly", "Daily", "Monthly" ], "x-ms-enum": { "name": "GrainParameter", "modelAsString": true, "values": [ { "name": "Hourly", "value": "Hourly", "description": "Hourly grain corresponds to value per hour." }, { "name": "Daily", "value": "Daily", "description": "Hourly grain corresponds to value per day." }, { "name": "Monthly", "value": "Monthly", "description": "Hourly grain corresponds to value per month." } ] } }, { "name": "savingsPlanOrderId", "in": "path", "description": "Savings plan order ID.", "required": true, "type": "string" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/BenefitUtilizationSummariesListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "SavingsPlanUtilizationSummariesDaily": { "$ref": "./examples/BenefitUtilizationSummaries/SavingsPlan-SavingsPlanOrderId-Daily.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/microsoft.BillingBenefits/savingsPlanOrders/{savingsPlanOrderId}/providers/Microsoft.CostManagement/generateBenefitUtilizationSummariesReport": { "post": { "operationId": "GenerateBenefitUtilizationSummariesReport_GenerateBySavingsPlanOrderId", "description": "Triggers generation of a benefit utilization summaries report for the provided savings plan order.", "externalDocs": { "url": "https://docs.microsoft.com/rest/api/cost-management/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "savingsPlanOrderId", "in": "path", "description": "Savings plan order ID.", "required": true, "type": "string" }, { "name": "benefitUtilizationSummariesRequest", "in": "body", "description": "Async Benefit Utilization Summary report to be created.", "required": true, "schema": { "$ref": "#/definitions/BenefitUtilizationSummariesRequest" } } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/BenefitUtilizationSummariesOperationStatus" } }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "GenerateUtilizationSummariesReportBySavingsPlanOrder": { "$ref": "./examples/BenefitUtilizationSummaries/Async/GenerateBenefitUtilizationSummariesReportBySavingsPlanOrder.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/BenefitUtilizationSummariesOperationStatus" }, "x-ms-long-running-operation": true } }, "/providers/microsoft.BillingBenefits/savingsPlanOrders/{savingsPlanOrderId}/savingsPlans/{savingsPlanId}/providers/Microsoft.CostManagement/benefitUtilizationSummaries": { "get": { "operationId": "BenefitUtilizationSummaries_ListBySavingsPlanId", "description": "Lists the savings plan utilization summaries for daily or monthly grain.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/cost-management/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "$filter", "in": "query", "description": "Supports filtering by properties/usageDate.", "required": false, "type": "string" }, { "name": "grainParameter", "in": "query", "description": "Grain.", "required": false, "type": "string", "enum": [ "Hourly", "Daily", "Monthly" ], "x-ms-enum": { "name": "GrainParameter", "modelAsString": true, "values": [ { "name": "Hourly", "value": "Hourly", "description": "Hourly grain corresponds to value per hour." }, { "name": "Daily", "value": "Daily", "description": "Hourly grain corresponds to value per day." }, { "name": "Monthly", "value": "Monthly", "description": "Hourly grain corresponds to value per month." } ] } }, { "name": "savingsPlanOrderId", "in": "path", "description": "Savings plan order ID.", "required": true, "type": "string" }, { "name": "savingsPlanId", "in": "path", "description": "Savings plan ID.", "required": true, "type": "string" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/BenefitUtilizationSummariesListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "SavingsPlanUtilizationSummariesMonthlyWithSavingsPlanId": { "$ref": "./examples/BenefitUtilizationSummaries/SavingsPlan-SavingsPlanId-Monthly.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/microsoft.BillingBenefits/savingsPlanOrders/{savingsPlanOrderId}/savingsPlans/{savingsPlanId}/providers/Microsoft.CostManagement/generateBenefitUtilizationSummariesReport": { "post": { "operationId": "GenerateBenefitUtilizationSummariesReport_GenerateBySavingsPlanId", "description": "Triggers generation of a benefit utilization summaries report for the provided savings plan.", "externalDocs": { "url": "https://docs.microsoft.com/rest/api/cost-management/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "savingsPlanOrderId", "in": "path", "description": "Savings plan order ID.", "required": true, "type": "string" }, { "name": "savingsPlanId", "in": "path", "description": "Savings plan ID.", "required": true, "type": "string" }, { "name": "benefitUtilizationSummariesRequest", "in": "body", "description": "Async Benefit Utilization Summary report to be created.", "required": true, "schema": { "$ref": "#/definitions/BenefitUtilizationSummariesRequest" } } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/BenefitUtilizationSummariesOperationStatus" } }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "GenerateUtilizationSummariesReportBySavingsPlan": { "$ref": "./examples/BenefitUtilizationSummaries/Async/GenerateBenefitUtilizationSummariesReportBySavingsPlan.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/BenefitUtilizationSummariesOperationStatus" }, "x-ms-long-running-operation": true } }, "/providers/microsoft.Capacity/reservationorders/{reservationOrderId}/providers/Microsoft.CostManagement/generateBenefitUtilizationSummariesReport": { "post": { "operationId": "GenerateBenefitUtilizationSummariesReport_GenerateByReservationOrderId", "description": "Triggers generation of a benefit utilization summaries report for the provided reservation order.", "externalDocs": { "url": "https://docs.microsoft.com/rest/api/cost-management/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "reservationOrderId", "in": "path", "description": "Reservation Order ID", "required": true, "type": "string" }, { "name": "benefitUtilizationSummariesRequest", "in": "body", "description": "Async Benefit Utilization Summary report to be created.", "required": true, "schema": { "$ref": "#/definitions/BenefitUtilizationSummariesRequest" } } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/BenefitUtilizationSummariesOperationStatus" } }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "GenerateUtilizationSummariesReportByReservationOrder": { "$ref": "./examples/BenefitUtilizationSummaries/Async/GenerateBenefitUtilizationSummariesReportByReservationOrder.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/BenefitUtilizationSummariesOperationStatus" }, "x-ms-long-running-operation": true } }, "/providers/microsoft.Capacity/reservationorders/{reservationOrderId}/reservations/{reservationId}/providers/Microsoft.CostManagement/generateBenefitUtilizationSummariesReport": { "post": { "operationId": "GenerateBenefitUtilizationSummariesReport_GenerateByReservationId", "description": "Triggers generation of a benefit utilization summaries report for the provided reservation.", "externalDocs": { "url": "https://docs.microsoft.com/rest/api/cost-management/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "reservationOrderId", "in": "path", "description": "Reservation Order ID", "required": true, "type": "string" }, { "name": "reservationId", "in": "path", "description": "Reservation ID", "required": true, "type": "string" }, { "name": "benefitUtilizationSummariesRequest", "in": "body", "description": "Async Benefit Utilization Summary report to be created.", "required": true, "schema": { "$ref": "#/definitions/BenefitUtilizationSummariesRequest" } } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/BenefitUtilizationSummariesOperationStatus" } }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "GenerateUtilizationSummariesReportByReservation": { "$ref": "./examples/BenefitUtilizationSummaries/Async/GenerateBenefitUtilizationSummariesReportByReservation.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/BenefitUtilizationSummariesOperationStatus" }, "x-ms-long-running-operation": true } } }, "definitions": { "AccumulatedType": { "type": "string", "description": "Show costs accumulated over time.", "enum": [ "true", "false" ], "x-ms-enum": { "name": "AccumulatedType", "modelAsString": true, "values": [ { "name": "true", "value": "true" }, { "name": "false", "value": "false" } ] } }, "ActionType": { "type": "string", "description": "Enum. Indicates the action type. \"Internal\" refers to actions that are for internal only APIs.", "enum": [ "Internal" ], "x-ms-enum": { "name": "ActionType", "modelAsString": true, "values": [ { "name": "Internal", "value": "Internal" } ] } }, "Alert": { "type": "object", "description": "An individual alert.", "properties": { "properties": { "$ref": "#/definitions/AlertProperties", "description": "Alert properties.", "x-ms-client-flatten": true }, "eTag": { "$ref": "#/definitions/Azure.Core.eTag", "description": "eTag of the resource. To handle concurrent update scenario, this field will be used to determine whether the user is updating the latest version or not." } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" } ] }, "AlertCategory": { "type": "string", "description": "Alert category", "enum": [ "Cost", "Usage", "Billing", "System" ], "x-ms-enum": { "name": "AlertCategory", "modelAsString": true, "values": [ { "name": "Cost", "value": "Cost" }, { "name": "Usage", "value": "Usage" }, { "name": "Billing", "value": "Billing" }, { "name": "System", "value": "System" } ] } }, "AlertCriteria": { "type": "string", "description": "Criteria that triggered alert", "enum": [ "CostThresholdExceeded", "UsageThresholdExceeded", "CreditThresholdApproaching", "CreditThresholdReached", "QuotaThresholdApproaching", "QuotaThresholdReached", "MultiCurrency", "ForecastCostThresholdExceeded", "ForecastUsageThresholdExceeded", "InvoiceDueDateApproaching", "InvoiceDueDateReached", "CrossCloudNewDataAvailable", "CrossCloudCollectionError", "GeneralThresholdError" ], "x-ms-enum": { "name": "AlertCriteria", "modelAsString": true, "values": [ { "name": "CostThresholdExceeded", "value": "CostThresholdExceeded" }, { "name": "UsageThresholdExceeded", "value": "UsageThresholdExceeded" }, { "name": "CreditThresholdApproaching", "value": "CreditThresholdApproaching" }, { "name": "CreditThresholdReached", "value": "CreditThresholdReached" }, { "name": "QuotaThresholdApproaching", "value": "QuotaThresholdApproaching" }, { "name": "QuotaThresholdReached", "value": "QuotaThresholdReached" }, { "name": "MultiCurrency", "value": "MultiCurrency" }, { "name": "ForecastCostThresholdExceeded", "value": "ForecastCostThresholdExceeded" }, { "name": "ForecastUsageThresholdExceeded", "value": "ForecastUsageThresholdExceeded" }, { "name": "InvoiceDueDateApproaching", "value": "InvoiceDueDateApproaching" }, { "name": "InvoiceDueDateReached", "value": "InvoiceDueDateReached" }, { "name": "CrossCloudNewDataAvailable", "value": "CrossCloudNewDataAvailable" }, { "name": "CrossCloudCollectionError", "value": "CrossCloudCollectionError" }, { "name": "GeneralThresholdError", "value": "GeneralThresholdError" } ] } }, "AlertOperator": { "type": "string", "description": "operator used to compare currentSpend with amount", "enum": [ "None", "EqualTo", "GreaterThan", "GreaterThanOrEqualTo", "LessThan", "LessThanOrEqualTo" ], "x-ms-enum": { "name": "AlertOperator", "modelAsString": true, "values": [ { "name": "None", "value": "None" }, { "name": "EqualTo", "value": "EqualTo" }, { "name": "GreaterThan", "value": "GreaterThan" }, { "name": "GreaterThanOrEqualTo", "value": "GreaterThanOrEqualTo" }, { "name": "LessThan", "value": "LessThan" }, { "name": "LessThanOrEqualTo", "value": "LessThanOrEqualTo" } ] } }, "AlertProperties": { "type": "object", "description": "Alert properties.", "properties": { "definition": { "$ref": "#/definitions/AlertPropertiesDefinition", "description": "defines the type of alert" }, "description": { "type": "string", "description": "Alert description" }, "source": { "$ref": "#/definitions/AlertSource", "description": "Source of alert" }, "details": { "$ref": "#/definitions/AlertPropertiesDetails", "description": "Alert details" }, "costEntityId": { "type": "string", "description": "related budget" }, "status": { "$ref": "#/definitions/AlertStatus", "description": "alert status" }, "creationTime": { "type": "string", "description": "dateTime in which alert was created" }, "closeTime": { "type": "string", "description": "dateTime in which alert was closed" }, "modificationTime": { "type": "string", "description": "dateTime in which alert was last modified" }, "statusModificationUserName": { "type": "string", "description": "User who last modified the alert" }, "statusModificationTime": { "type": "string", "description": "dateTime in which the alert status was last modified" } } }, "AlertPropertiesDefinition": { "type": "object", "description": "defines the type of alert", "properties": { "type": { "$ref": "#/definitions/AlertType", "description": "type of alert" }, "category": { "$ref": "#/definitions/AlertCategory", "description": "Alert category" }, "criteria": { "$ref": "#/definitions/AlertCriteria", "description": "Criteria that triggered alert" } } }, "AlertPropertiesDetails": { "type": "object", "description": "Alert details", "properties": { "timeGrainType": { "$ref": "#/definitions/AlertTimeGrainType", "description": "Type of timegrain cadence" }, "periodStartDate": { "type": "string", "description": "datetime of periodStartDate" }, "triggeredBy": { "type": "string", "description": "notificationId that triggered this alert" }, "resourceGroupFilter": { "type": "array", "description": "array of resourceGroups to filter by", "items": {} }, "resourceFilter": { "type": "array", "description": "array of resources to filter by", "items": {} }, "meterFilter": { "type": "array", "description": "array of meters to filter by", "items": {} }, "tagFilter": { "description": "tags to filter by" }, "threshold": { "type": "number", "format": "decimal", "description": "notification threshold percentage as a decimal which activated this alert" }, "operator": { "$ref": "#/definitions/AlertOperator", "description": "operator used to compare currentSpend with amount" }, "amount": { "type": "number", "format": "decimal", "description": "budget threshold amount" }, "unit": { "type": "string", "description": "unit of currency being used" }, "currentSpend": { "type": "number", "format": "decimal", "description": "current spend" }, "contactEmails": { "type": "array", "description": "list of emails to contact", "items": { "type": "string" } }, "contactGroups": { "type": "array", "description": "list of action groups to broadcast to", "items": { "type": "string" } }, "contactRoles": { "type": "array", "description": "list of contact roles", "items": { "type": "string" } }, "overridingAlert": { "type": "string", "description": "overriding alert" }, "departmentName": { "type": "string", "description": "department name" }, "companyName": { "type": "string", "description": "company name" }, "enrollmentNumber": { "type": "string", "description": "enrollment number" }, "enrollmentStartDate": { "type": "string", "description": "datetime of enrollmentStartDate" }, "enrollmentEndDate": { "type": "string", "description": "datetime of enrollmentEndDate" }, "invoicingThreshold": { "type": "number", "format": "decimal", "description": "invoicing threshold" } } }, "AlertSource": { "type": "string", "description": "Source of alert", "enum": [ "Preset", "User" ], "x-ms-enum": { "name": "AlertSource", "modelAsString": true, "values": [ { "name": "Preset", "value": "Preset" }, { "name": "User", "value": "User" } ] } }, "AlertStatus": { "type": "string", "description": "alert status", "enum": [ "None", "Active", "Overridden", "Resolved", "Dismissed" ], "x-ms-enum": { "name": "AlertStatus", "modelAsString": true, "values": [ { "name": "None", "value": "None" }, { "name": "Active", "value": "Active" }, { "name": "Overridden", "value": "Overridden" }, { "name": "Resolved", "value": "Resolved" }, { "name": "Dismissed", "value": "Dismissed" } ] } }, "AlertTimeGrainType": { "type": "string", "description": "Type of timegrain cadence", "enum": [ "None", "Monthly", "Quarterly", "Annually", "BillingMonth", "BillingQuarter", "BillingAnnual" ], "x-ms-enum": { "name": "AlertTimeGrainType", "modelAsString": true, "values": [ { "name": "None", "value": "None" }, { "name": "Monthly", "value": "Monthly" }, { "name": "Quarterly", "value": "Quarterly" }, { "name": "Annually", "value": "Annually" }, { "name": "BillingMonth", "value": "BillingMonth" }, { "name": "BillingQuarter", "value": "BillingQuarter" }, { "name": "BillingAnnual", "value": "BillingAnnual" } ] } }, "AlertType": { "type": "string", "description": "type of alert", "enum": [ "Budget", "Invoice", "Credit", "Quota", "General", "xCloud", "BudgetForecast" ], "x-ms-enum": { "name": "AlertType", "modelAsString": true, "values": [ { "name": "Budget", "value": "Budget" }, { "name": "Invoice", "value": "Invoice" }, { "name": "Credit", "value": "Credit" }, { "name": "Quota", "value": "Quota" }, { "name": "General", "value": "General" }, { "name": "xCloud", "value": "xCloud" }, { "name": "BudgetForecast", "value": "BudgetForecast" } ] } }, "AlertsResult": { "type": "object", "description": "Result of alerts.", "properties": { "value": { "type": "array", "description": "List of alerts.", "items": { "$ref": "#/definitions/Alert" }, "readOnly": true }, "nextLink": { "type": "string", "description": "URL to get the next set of alerts results if there are any.", "readOnly": true } } }, "AsyncOperationStatusProperties": { "type": "object", "description": "Object representing the report url and valid until date of the async report generated.", "properties": { "reportUrl": { "$ref": "#/definitions/BenefitUtilizationSummaryReportSchema", "format": "password", "description": "Sas url to the async benefit utilization summaries report. Will be empty if the report is in Running or Failed state.", "x-ms-secret": true }, "secondaryReportUrl": { "$ref": "#/definitions/BenefitUtilizationSummaryReportSchema", "format": "password", "description": "Sas url to async benefit utilization summaries report in secondary storage in case of primary outage. Will be empty if the report is in Running or Failed state.", "x-ms-secret": true }, "validUntil": { "type": "string", "format": "date-time", "description": "The date that the sas url provided in reportUrl expires." } } }, "Azure.Core.eTag": { "type": "string", "description": "The ETag (or entity tag) HTTP response header is an identifier for a specific version of a resource.\nIt lets caches be more efficient and save bandwidth, as a web server does not need to resend a full response if the content was not changed.\n\nIt is a string of ASCII characters placed between double quotes, like \"675af34563dc-tr34\"." }, "BenefitKind": { "type": "string", "description": "Kind/type of the benefit.", "enum": [ "IncludedQuantity", "Reservation", "SavingsPlan" ], "x-ms-enum": { "name": "BenefitKind", "modelAsString": true, "values": [ { "name": "IncludedQuantity", "value": "IncludedQuantity", "description": "Benefit is IncludedQuantity." }, { "name": "Reservation", "value": "Reservation", "description": "Benefit is Reservation." }, { "name": "SavingsPlan", "value": "SavingsPlan", "description": "Benefit is SavingsPlan." } ] } }, "BenefitResource": { "type": "object", "description": "The benefit resource model definition.", "properties": { "kind": { "$ref": "#/definitions/BenefitKind", "description": "Reservation or SavingsPlan." } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/Resource" } ] }, "BenefitUtilizationSummariesListResult": { "type": "object", "description": "List of benefit utilization summaries.", "properties": { "value": { "type": "array", "description": "The list of benefit utilization summaries.", "items": { "$ref": "#/definitions/BenefitUtilizationSummary" }, "readOnly": true }, "nextLink": { "type": "string", "description": "The link (URL) to the next page of results." } } }, "BenefitUtilizationSummariesOperationStatus": { "type": "object", "description": "Status of a benefit utilization summaries report. Provides Async Benefit Utilization Summaries Request input, status, and report sas url.", "properties": { "input": { "$ref": "#/definitions/BenefitUtilizationSummariesRequest", "description": "Input given to create the benefit utilization summaries report." }, "status": { "$ref": "#/definitions/OperationStatusType", "description": "The status of the creation of the benefit utilization summaries report." }, "properties": { "$ref": "#/definitions/AsyncOperationStatusProperties", "description": "Contains sas url to the async benefit utilization summaries report and a date that the url is valid until. These values will be empty if the report is in a Running or Failed state" } } }, "BenefitUtilizationSummariesRequest": { "type": "object", "description": "Properties of an async benefit utilization summaries request.", "properties": { "billingAccountId": { "type": "string", "description": "Billing account the benefit utilization summaries report is for. Required for billing account and billing profile scopes. Not supported for any benefit scopes." }, "billingProfileId": { "type": "string", "description": "Billing profile id the benefit utilization summaries report is for. Required for billing profile scope. Not supported for billing account or any benefit scopes." }, "benefitOrderId": { "type": "string", "description": "Benefit order id the benefit utilization summaries report is for. Required for benefit order and benefit id scopes. Not supported for any billing scopes." }, "benefitId": { "type": "string", "description": "Benefit id the benefit utilization summaries report is for. Required for benefit id scope. Not supported for benefit order or any billing scopes." }, "grain": { "$ref": "#/definitions/Grain", "description": "The grain the summaries data is served at in the report. Accepted values are 'Daily' or 'Monthly'." }, "startDate": { "type": "string", "format": "date-time", "description": "The start date of the summaries data that will be served in the report." }, "endDate": { "type": "string", "format": "date-time", "description": "The end date of the summaries data that will be served in the report." }, "kind": { "$ref": "#/definitions/BenefitKind", "description": "The type of benefit data requested. Required for billing account and billing profile scopes. Implied and not to be passed at benefit scopes. Supported values are Reservation and SavingsPlan" } }, "required": [ "grain", "startDate", "endDate" ] }, "BenefitUtilizationSummary": { "type": "object", "description": "Benefit utilization summary resource.", "properties": { "kind": { "$ref": "#/definitions/BenefitKind", "description": "Supported values: 'SavingsPlan'." } }, "discriminator": "kind", "required": [ "kind" ], "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/Resource" } ] }, "BenefitUtilizationSummaryProperties": { "type": "object", "description": "The properties of a benefit utilization summary.", "properties": { "armSkuName": { "type": "string", "description": "ARM SKU name. For example, 'Compute_Savings_Plan' for savings plan.", "readOnly": true }, "benefitId": { "type": "string", "description": "The benefit ID is the identifier of the benefit.", "readOnly": true }, "benefitOrderId": { "type": "string", "description": "The benefit order ID is the identifier for a benefit purchase.", "readOnly": true }, "benefitType": { "$ref": "#/definitions/BenefitKind", "description": "The benefit type. Supported values: 'SavingsPlan'." }, "usageDate": { "type": "string", "format": "date-time", "description": "Date corresponding to the utilization summary record. If the grain of data is monthly, value for this field will be first day of the month.", "readOnly": true } } }, "BenefitUtilizationSummaryReportSchema": { "type": "string", "description": "The CSV file from the reportUrl and secondaryReportUrl blob link will consist of the following columns of benefit utilization data. UtilizedPercentage will be 0 for savings plans reports and non data bricks reservations. Utilization percentages will be 0 for data bricks reservations.", "enum": [ "Kind", "AvgUtilizationPercentage", "BenefitOrderId", "BenefitId", "BenefitType", "MaxUtilizationPercentage", "MinUtilizationPercentage", "UsageDate", "UtilizedPercentage" ], "x-ms-enum": { "name": "BenefitUtilizationSummaryReportSchema", "modelAsString": true, "values": [ { "name": "Kind", "value": "Kind" }, { "name": "AvgUtilizationPercentage", "value": "AvgUtilizationPercentage" }, { "name": "BenefitOrderId", "value": "BenefitOrderId" }, { "name": "BenefitId", "value": "BenefitId" }, { "name": "BenefitType", "value": "BenefitType" }, { "name": "MaxUtilizationPercentage", "value": "MaxUtilizationPercentage" }, { "name": "MinUtilizationPercentage", "value": "MinUtilizationPercentage" }, { "name": "UsageDate", "value": "UsageDate" }, { "name": "UtilizedPercentage", "value": "UtilizedPercentage" } ] } }, "BlobInfo": { "type": "object", "description": "The blob information generated by this operation.", "properties": { "blobLink": { "type": "string", "description": "Link to the blob to download file." }, "byteCount": { "type": "integer", "format": "int64", "description": "Bytes in the blob." } } }, "Budget": { "type": "object", "description": "A budget resource.", "properties": { "properties": { "$ref": "#/definitions/BudgetProperties", "description": "The properties of the budget.", "x-ms-client-flatten": true }, "eTag": { "$ref": "#/definitions/Azure.Core.eTag", "description": "eTag of the resource. To handle concurrent update scenario, this field will be used to determine whether the user is updating the latest version or not." } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" } ] }, "BudgetComparisonExpression": { "type": "object", "description": "The comparison expression to be used in the budgets.", "properties": { "name": { "type": "string", "description": "The name of the column to use in comparison." }, "operator": { "$ref": "#/definitions/BudgetOperatorType", "description": "The operator to use for comparison." }, "values": { "type": "array", "description": "Array of values to use for comparison", "minItems": 0, "items": { "type": "string" } } }, "required": [ "name", "operator", "values" ] }, "BudgetFilter": { "type": "object", "description": "May be used to filter budgets by user-specified dimensions and/or tags.\n\nSupported for CategoryType(s): Cost, ReservationUtilization.", "properties": { "and": { "type": "array", "description": "The logical \"AND\" expression. Must have at least 2 items.\n\nSupported for CategoryType(s): Cost.", "minItems": 0, "items": { "$ref": "#/definitions/BudgetFilterProperties" }, "x-ms-identifiers": [] }, "dimensions": { "$ref": "#/definitions/BudgetComparisonExpression", "description": "Has comparison expression for a dimension.\n\nSupported for CategoryType(s): Cost, ReservationUtilization.\n\nSupported dimension names for **CategoryType: ReservationUtilization**\n- ReservationId\n- ReservedResourceType" }, "tags": { "$ref": "#/definitions/BudgetComparisonExpression", "description": "Has comparison expression for a tag.\n\nSupported for CategoryType(s): Cost." } } }, "BudgetFilterProperties": { "type": "object", "description": "The Dimensions or Tags to filter a budget by.\n\nSupported for CategoryType(s): Cost, ReservationUtilization.", "properties": { "dimensions": { "$ref": "#/definitions/BudgetComparisonExpression", "description": "Has comparison expression for a dimension.\n\nSupported for CategoryType(s): Cost, ReservationUtilization.\n\nSupported dimension names for **CategoryType: ReservationUtilization**\n- ReservationId\n- ReservedResourceType" }, "tags": { "$ref": "#/definitions/BudgetComparisonExpression", "description": "Has comparison expression for a tag.\n\nSupported for CategoryType(s): Cost." } } }, "BudgetNotificationOperatorType": { "type": "string", "description": "The comparison operator.\n\nSupported for CategoryType(s): Cost, ReservationUtilization.\n\nSupported operators for **CategoryType: Cost**\n- GreaterThan\n- GreaterThanOrEqualTo\n\nSupported operators for **CategoryType: ReservationUtilization**\n- LessThan", "enum": [ "EqualTo", "GreaterThan", "GreaterThanOrEqualTo", "LessThan" ], "x-ms-enum": { "name": "BudgetNotificationOperatorType", "modelAsString": true, "values": [ { "name": "EqualTo", "value": "EqualTo", "description": "Notification will be triggered if the evaluated cost is the same as threshold value. Note: It’s not recommended to use this OperatorType as there’s low chance of cost being exactly the same as threshold value, leading to missing of your alert. This OperatorType will be deprecated in future.\n\nSupported for CategoryType(s): Cost." }, { "name": "GreaterThan", "value": "GreaterThan", "description": "Notification will be triggered if the evaluated cost is greater than the threshold value. Note: This is the recommended OperatorType while configuring Budget Alert.\n\nSupported for CategoryType(s): Cost." }, { "name": "GreaterThanOrEqualTo", "value": "GreaterThanOrEqualTo", "description": "Notification will be triggered if the evaluated cost is greater than or equal to the threshold value.\n\nSupported for CategoryType(s): Cost." }, { "name": "LessThan", "value": "LessThan", "description": "Notification will be triggered if any Reservations in the scope of the Reservation Utilization Alert Rule have a utilization less than the threshold percentage.\n\nSupported for CategoryType(s): ReservationUtilization." } ] } }, "BudgetOperatorType": { "type": "string", "description": "The operator to use for comparison.", "enum": [ "In" ], "x-ms-enum": { "name": "BudgetOperatorType", "modelAsString": true, "values": [ { "name": "In", "value": "In" } ] } }, "BudgetProperties": { "type": "object", "description": "The properties of the budget.", "properties": { "category": { "$ref": "#/definitions/CategoryType", "description": "The category of the budget.\n- 'Cost' defines a Budget.\n- 'ReservationUtilization' defines a Reservation Utilization Alert Rule." }, "amount": { "type": "number", "format": "float", "description": "The total amount of cost to track with the budget.\n\nSupported for CategoryType(s): Cost.\n\nRequired for CategoryType(s): Cost." }, "timeGrain": { "$ref": "#/definitions/TimeGrainType", "description": "The time covered by a budget. Tracking of the amount will be reset based on the time grain.\n\nSupported for CategoryType(s): Cost, ReservationUtilization.\n\nSupported timeGrainTypes for **CategoryType: Cost**\n\n- Monthly\n- Quarterly\n- Annually\n- BillingMonth*\n- BillingQuarter*\n- BillingAnnual*\n\n*only supported for Web Direct customers.\n\nSupported timeGrainTypes for **CategoryType: ReservationUtilization**\n- Last7Days\n- Last30Days\n\nRequired for CategoryType(s): Cost, ReservationUtilization." }, "timePeriod": { "$ref": "#/definitions/BudgetTimePeriod", "description": "The time period that defines the active period of the budget. The budget will evaluate data on or after the startDate and will expire on the endDate.\n\nSupported for CategoryType(s): Cost, ReservationUtilization.\n\nRequired for CategoryType(s): Cost, ReservationUtilization." }, "filter": { "$ref": "#/definitions/BudgetFilter", "description": "May be used to filter budgets by user-specified dimensions and/or tags.\n\nSupported for CategoryType(s): Cost, ReservationUtilization." }, "currentSpend": { "$ref": "#/definitions/CurrentSpend", "description": "The current amount of cost which is being tracked for a budget.\n\nSupported for CategoryType(s): Cost.", "readOnly": true }, "notifications": { "type": "object", "description": "Dictionary of notifications associated with the budget.\n\nSupported for CategoryType(s): Cost, ReservationUtilization.\n\n- Constraints for **CategoryType: Cost** - Budget can have up to 5 notifications with thresholdType: Actual and 5 notifications with thresholdType: Forecasted.\n- Constraints for **CategoryType: ReservationUtilization** - Only one notification allowed. thresholdType is not applicable.", "additionalProperties": { "$ref": "#/definitions/Notification" } }, "forecastSpend": { "$ref": "#/definitions/ForecastSpend", "description": "The forecasted cost which is being tracked for a budget.\n\nSupported for CategoryType(s): Cost.", "readOnly": true } }, "required": [ "category", "timeGrain", "timePeriod" ] }, "BudgetTimePeriod": { "type": "object", "description": "The time period that defines the active period of the budget. The budget will evaluate data on or after the startDate and will expire on the endDate.\n\nSupported for CategoryType(s): Cost, ReservationUtilization.\n\nRequired for CategoryType(s): Cost, ReservationUtilization.", "properties": { "startDate": { "type": "string", "format": "date-time", "description": "The start date for the budget.\n\n- Constraints for **CategoryType: Cost** - Must be first of the month and should be less than the end date. Budget start date must be on or after June 1, 2017. Future start date should not be more than twelve months. Past start date should be selected within the timegrain period.\n\n- Constraints for **CategoryType: ReservationUtilization** - Must be on or after the current date and less than the end date." }, "endDate": { "type": "string", "format": "date-time", "description": "The end date for the budget.\n\n- Constraints for **CategoryType: Cost** - No constraints. If not provided, we default this to 10 years from the start date.\n\n- Constraints for **CategoryType: ReservationUtilization** - End date cannot be more than 3 years after the start date." } }, "required": [ "startDate" ] }, "BudgetsListResult": { "type": "object", "description": "Result of listing budgets. It contains a list of available budgets in the scope provided.", "properties": { "value": { "type": "array", "description": "The list of budgets.", "items": { "$ref": "#/definitions/Budget" }, "readOnly": true }, "nextLink": { "type": "string", "description": "The link (url) to the next page of results.\\r\\nIt's null for now, added for future use." } } }, "CategoryType": { "type": "string", "description": "The category of the budget.\n- 'Cost' defines a Budget.\n- 'ReservationUtilization' defines a Reservation Utilization Alert Rule.", "enum": [ "Cost", "ReservationUtilization" ], "x-ms-enum": { "name": "CategoryType", "modelAsString": true, "values": [ { "name": "Cost", "value": "Cost", "description": "A Budget that evaluates monetary cost of Azure resources against an amount, and alerts based on a configured notification threshold." }, { "name": "ReservationUtilization", "value": "ReservationUtilization", "description": "An Alert Rule that evaluates the utilization percentage of Azure Reservations, and alerts based on a configured notification threshold." } ] } }, "ChartType": { "type": "string", "description": "Chart type of the main view in Cost Analysis. Required.", "enum": [ "Area", "Line", "StackedColumn", "GroupedColumn", "Table" ], "x-ms-enum": { "name": "ChartType", "modelAsString": true, "values": [ { "name": "Area", "value": "Area" }, { "name": "Line", "value": "Line" }, { "name": "StackedColumn", "value": "StackedColumn" }, { "name": "GroupedColumn", "value": "GroupedColumn" }, { "name": "Table", "value": "Table" } ] } }, "CheckNameAvailabilityReason": { "type": "string", "description": "The reason why the given name is not available.", "enum": [ "Invalid", "AlreadyExists" ], "x-ms-enum": { "name": "CheckNameAvailabilityReason", "modelAsString": true, "values": [ { "name": "Invalid", "value": "Invalid" }, { "name": "AlreadyExists", "value": "AlreadyExists" } ] } }, "CommonExportProperties": { "type": "object", "description": "The common properties of the export.", "properties": { "format": { "$ref": "#/definitions/FormatType", "description": "The format of the export being delivered." }, "deliveryInfo": { "$ref": "#/definitions/ExportDeliveryInfo", "description": "Has delivery information for the export." }, "definition": { "$ref": "#/definitions/ExportDefinition", "description": "Has the definition for the export." }, "runHistory": { "$ref": "#/definitions/ExportExecutionListResult", "description": "If requested, has the most recent run history for the export." }, "partitionData": { "type": "boolean", "description": "If set to true, exported data will be partitioned by size and placed in a blob directory together with a manifest file." }, "dataOverwriteBehavior": { "$ref": "#/definitions/DataOverwriteBehaviorType", "description": "Allow customers to select overwrite data(OverwritePreviousReport) for exports. This setting will enable overwrite data for the same month in customer storage account. By default set to CreateNewReport." }, "compressionMode": { "$ref": "#/definitions/CompressionModeType", "description": "Allow customers to select compress data for exports. This setting will enable destination file compression scheme at runtime. By default set to None. Gzip is for csv and snappy for parquet." }, "exportDescription": { "type": "string", "description": "The export description set by customer at time of export creation/update." }, "nextRunTimeEstimate": { "type": "string", "format": "date-time", "description": "If the export has an active schedule, provides an estimate of the next run time.", "readOnly": true }, "systemSuspensionContext": { "$ref": "#/definitions/ExportSuspensionContext", "description": "The export suspension reason if export is in SystemSuspended state. This is not populated currently.", "readOnly": true } }, "required": [ "deliveryInfo", "definition" ] }, "CompressionModeType": { "type": "string", "description": "Allow customers to select compress data for exports. This setting will enable destination file compression scheme at runtime. By default set to None. Gzip is for csv and snappy for parquet.", "enum": [ "gzip", "snappy", "none" ], "x-ms-enum": { "name": "CompressionModeType", "modelAsString": true, "values": [ { "name": "gzip", "value": "gzip" }, { "name": "snappy", "value": "snappy" }, { "name": "none", "value": "none" } ] } }, "CostAllocationPolicyType": { "type": "string", "description": "Method to use for allocating cost. FixedProportion indicates that cost will be split based on specified percentage values.", "enum": [ "FixedProportion" ], "x-ms-enum": { "name": "CostAllocationPolicyType", "modelAsString": true, "values": [ { "name": "FixedProportion", "value": "FixedProportion" } ] } }, "CostAllocationProportion": { "type": "object", "description": "Target resources and allocation", "properties": { "name": { "type": "string", "description": "Target resource for cost allocation" }, "percentage": { "type": "number", "format": "float", "description": "Percentage of source cost to allocate to this resource. This value can be specified to two decimal places and the total percentage of all resources in this rule must sum to 100.00." } }, "required": [ "name", "percentage" ] }, "CostAllocationResource": { "type": "object", "description": "Common values for resources for cost allocation", "properties": { "resourceType": { "$ref": "#/definitions/CostAllocationResourceType", "description": "Type of resources contained in this cost allocation rule" }, "name": { "type": "string", "description": "If resource type is dimension, this must be either ResourceGroupName or SubscriptionId. If resource type is tag, this must be a valid Azure tag" } }, "required": [ "resourceType", "name" ] }, "CostAllocationResourceType": { "type": "string", "description": "Category of resource to use for allocation.", "enum": [ "Dimension", "Tag" ], "x-ms-enum": { "name": "CostAllocationResourceType", "modelAsString": true, "values": [ { "name": "Dimension", "value": "Dimension", "description": "Indicates an Azure dimension such as a subscription id or resource group name is being used for allocation." }, { "name": "Tag", "value": "Tag", "description": "Allocates cost based on Azure Tag key value pairs." } ] } }, "CostAllocationRuleCheckNameAvailabilityRequest": { "type": "object", "description": "The cost allocation rule check name availability request", "properties": { "name": { "type": "string", "description": "Rule name" }, "type": { "type": "string", "description": "Resource type. This is expected to be Microsoft.CostManagement/costAllocationRules" } } }, "CostAllocationRuleCheckNameAvailabilityResponse": { "type": "object", "description": "The cost allocation rule check name availability response", "properties": { "nameAvailable": { "type": "boolean", "description": "Whether this rule name is available" }, "reason": { "$ref": "#/definitions/Reason", "description": "The reason this name is not available" }, "message": { "type": "string", "description": "Error message if the name is not available" } } }, "CostAllocationRuleDefinition": { "type": "object", "description": "The cost allocation rule model definition", "properties": { "properties": { "$ref": "#/definitions/CostAllocationRuleProperties", "description": "Cost allocation rule properties" } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" } ] }, "CostAllocationRuleDetails": { "type": "object", "description": "Resource details of the cost allocation rule", "properties": { "sourceResources": { "type": "array", "description": "Source resources for cost allocation. At this time, this list can contain no more than one element.", "items": { "$ref": "#/definitions/SourceCostAllocationResource" }, "x-ms-identifiers": [ "name" ] }, "targetResources": { "type": "array", "description": "Target resources for cost allocation. At this time, this list can contain no more than one element.", "items": { "$ref": "#/definitions/TargetCostAllocationResource" }, "x-ms-identifiers": [ "name" ] } } }, "CostAllocationRuleList": { "type": "object", "description": "Result of listing cost allocation rules. It contains a list of available rules in the billing account or enterprise enrollment provided.", "properties": { "value": { "type": "array", "description": "The list of cost allocation rules.", "items": { "$ref": "#/definitions/CostAllocationRuleDefinition" }, "x-ms-identifiers": [ "id" ] }, "nextLink": { "type": "string", "description": "URL to get the next set of rule list results if there are any." } } }, "CostAllocationRuleProperties": { "type": "object", "description": "The properties of a cost allocation rule", "properties": { "description": { "type": "string", "description": "Description of a cost allocation rule." }, "details": { "$ref": "#/definitions/CostAllocationRuleDetails", "description": "Resource information for the cost allocation rule" }, "status": { "$ref": "#/definitions/RuleStatus", "description": "Status of the rule" }, "createdDate": { "type": "string", "format": "date-time", "description": "Time at which the rule was created. Rules that change cost for the same resource are applied in order of creation.", "readOnly": true }, "updatedDate": { "type": "string", "format": "date-time", "description": "Time at which the rule was last updated.", "readOnly": true } }, "required": [ "details", "status" ] }, "CostDetailsDataFormat": { "type": "string", "description": "The data format of the report", "enum": [ "Csv" ], "x-ms-enum": { "name": "CostDetailsDataFormat", "modelAsString": true, "values": [ { "name": "CsvCostDetailsDataFormat", "value": "Csv", "description": "Csv data format." } ] } }, "CostDetailsMetricType": { "type": "string", "description": "The type of the detailed report. By default ActualCost is provided", "enum": [ "ActualCost", "AmortizedCost" ], "x-ms-enum": { "name": "CostDetailsMetricType", "modelAsString": true, "values": [ { "name": "ActualCostCostDetailsMetricType", "value": "ActualCost", "description": "Actual cost data." }, { "name": "AmortizedCostCostDetailsMetricType", "value": "AmortizedCost", "description": "Amortized cost data." } ] } }, "CostDetailsOperationResults": { "type": "object", "description": "The result of the long running operation for cost details Api.", "properties": { "id": { "type": "string", "description": "The id of the long running operation." }, "name": { "type": "string", "description": "The name of the long running operation." }, "type": { "type": "string", "description": "The type of the long running operation." }, "status": { "$ref": "#/definitions/CostDetailsStatusType", "description": "The status of the cost details operation" }, "manifest": { "$ref": "#/definitions/ReportManifest", "description": "The manifest of the report generated by the operation.", "x-ms-client-flatten": true }, "validTill": { "type": "string", "format": "date-time", "description": "The time at which report URL becomes invalid/expires in UTC e.g. 2020-12-08T05:55:59.4394737Z." }, "error": { "$ref": "#/definitions/ErrorDetails", "description": "The details of the error." } } }, "CostDetailsStatusType": { "type": "string", "description": "The status of the cost details operation", "enum": [ "Completed", "NoDataFound", "Failed" ], "x-ms-enum": { "name": "CostDetailsStatusType", "modelAsString": true, "values": [ { "name": "CompletedCostDetailsStatusType", "value": "Completed", "description": "Operation is Completed." }, { "name": "NoDataFoundCostDetailsStatusType", "value": "NoDataFound", "description": "Operation is Completed and no cost data found." }, { "name": "FailedCostDetailsStatusType", "value": "Failed", "description": "Operation Failed." } ] } }, "CostDetailsTimePeriod": { "type": "object", "description": "The start and end date for pulling data for the cost detailed report. API only allows data to be pulled for 1 month or less and no older than 13 months.", "properties": { "start": { "type": "string", "description": "The start date to pull data from. example format 2020-03-15" }, "end": { "type": "string", "description": "The end date to pull data to. example format 2020-03-15" } }, "required": [ "start", "end" ] }, "CostManagementOperation": { "type": "object", "description": "A Cost management REST API operation.", "properties": { "id": { "type": "string", "description": "Operation id: {provider}/{resource}/{operation}.", "readOnly": true } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/Operation" } ] }, "CostManagementProxyResource": { "type": "object", "description": "The Resource model definition.", "properties": { "id": { "type": "string", "description": "Resource Id.", "readOnly": true }, "name": { "type": "string", "description": "Resource name.", "readOnly": true }, "type": { "type": "string", "description": "Resource type.", "readOnly": true }, "eTag": { "type": "string", "description": "eTag of the resource. To handle concurrent update scenario, this field will be used to determine whether the user is updating the latest version or not." } } }, "CostManagementResource": { "type": "object", "description": "The Resource model definition.", "properties": { "id": { "type": "string", "description": "Resource Id.", "readOnly": true }, "name": { "type": "string", "description": "Resource name.", "readOnly": true }, "type": { "type": "string", "description": "Resource type.", "readOnly": true }, "location": { "type": "string", "description": "Location of the resource.", "readOnly": true }, "sku": { "type": "string", "description": "SKU of the resource.", "readOnly": true }, "eTag": { "type": "string", "description": "ETag of the resource.", "readOnly": true }, "tags": { "type": "object", "description": "Resource tags.", "additionalProperties": { "type": "string" }, "readOnly": true } } }, "CreatedByType": { "type": "string", "description": "The type of identity that created the resource.", "enum": [ "User", "Application", "ManagedIdentity", "Key" ], "x-ms-enum": { "name": "CreatedByType", "modelAsString": true, "values": [ { "name": "User", "value": "User" }, { "name": "Application", "value": "Application" }, { "name": "ManagedIdentity", "value": "ManagedIdentity" }, { "name": "Key", "value": "Key" } ] } }, "CultureCode": { "type": "string", "description": "Language in which the recipient will receive the notification,\n\nSupported for CategoryType(s): Cost, ReservationUtilization.", "enum": [ "en-us", "ja-jp", "zh-cn", "de-de", "es-es", "fr-fr", "it-it", "ko-kr", "pt-br", "ru-ru", "zh-tw", "cs-cz", "pl-pl", "tr-tr", "da-dk", "en-gb", "hu-hu", "nb-no", "nl-nl", "pt-pt", "sv-se" ], "x-ms-enum": { "name": "CultureCode", "modelAsString": true, "values": [ { "name": "en-us", "value": "en-us" }, { "name": "ja-jp", "value": "ja-jp" }, { "name": "zh-cn", "value": "zh-cn" }, { "name": "de-de", "value": "de-de" }, { "name": "es-es", "value": "es-es" }, { "name": "fr-fr", "value": "fr-fr" }, { "name": "it-it", "value": "it-it" }, { "name": "ko-kr", "value": "ko-kr" }, { "name": "pt-br", "value": "pt-br" }, { "name": "ru-ru", "value": "ru-ru" }, { "name": "zh-tw", "value": "zh-tw" }, { "name": "cs-cz", "value": "cs-cz" }, { "name": "pl-pl", "value": "pl-pl" }, { "name": "tr-tr", "value": "tr-tr" }, { "name": "da-dk", "value": "da-dk" }, { "name": "en-gb", "value": "en-gb" }, { "name": "hu-hu", "value": "hu-hu" }, { "name": "nb-no", "value": "nb-no" }, { "name": "nl-nl", "value": "nl-nl" }, { "name": "pt-pt", "value": "pt-pt" }, { "name": "sv-se", "value": "sv-se" } ] } }, "CurrentSpend": { "type": "object", "description": "The current amount of cost which is being tracked for a budget.\n\nSupported for CategoryType(s): Cost.", "properties": { "amount": { "type": "number", "format": "float", "description": "The total amount of cost which is being tracked by the budget.", "readOnly": true }, "unit": { "type": "string", "description": "The unit of measure for the budget amount.", "readOnly": true } } }, "CustomerMetadata": { "type": "object", "description": "The customer billing metadata", "properties": { "billingAccountId": { "type": "string", "description": "Customer billing account id" }, "billingProfileId": { "type": "string", "description": "Customer billing profile id" } }, "required": [ "billingAccountId", "billingProfileId" ] }, "DataOverwriteBehaviorType": { "type": "string", "description": "Allow customers to select overwrite data(OverwritePreviousReport) for exports. This setting will enable overwrite data for the same month in customer storage account. By default set to CreateNewReport.", "enum": [ "OverwritePreviousReport", "CreateNewReport" ], "x-ms-enum": { "name": "DataOverwriteBehaviorType", "modelAsString": true, "values": [ { "name": "OverwritePreviousReport", "value": "OverwritePreviousReport" }, { "name": "CreateNewReport", "value": "CreateNewReport" } ] } }, "DaysOfWeek": { "type": "string", "description": "Days of Week.", "enum": [ "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday" ], "x-ms-enum": { "name": "DaysOfWeek", "modelAsString": true, "values": [ { "name": "Monday", "value": "Monday" }, { "name": "Tuesday", "value": "Tuesday" }, { "name": "Wednesday", "value": "Wednesday" }, { "name": "Thursday", "value": "Thursday" }, { "name": "Friday", "value": "Friday" }, { "name": "Saturday", "value": "Saturday" }, { "name": "Sunday", "value": "Sunday" } ] } }, "DestinationType": { "type": "string", "description": "The export delivery destination type. Currently only 'AzureBlob' is supported.", "enum": [ "AzureBlob" ], "x-ms-enum": { "name": "DestinationType", "modelAsString": true, "values": [ { "name": "AzureBlob", "value": "AzureBlob" } ] } }, "Dimension": { "type": "object", "description": "List of Dimension.", "properties": { "properties": { "$ref": "#/definitions/DimensionProperties", "description": "Dimension properties.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "#/definitions/CostManagementResource" } ] }, "DimensionProperties": { "type": "object", "description": "Dimension properties.", "properties": { "description": { "type": "string", "description": "Dimension description.", "readOnly": true }, "filterEnabled": { "type": "boolean", "description": "Filter enabled.", "readOnly": true }, "groupingEnabled": { "type": "boolean", "description": "Grouping enabled.", "readOnly": true }, "data": { "type": "array", "description": "Dimension data.", "items": { "type": "string" } }, "total": { "type": "integer", "format": "int32", "description": "Total number of data for the dimension.", "readOnly": true }, "category": { "type": "string", "description": "Dimension category.", "readOnly": true }, "usageStart": { "type": "string", "format": "date-time", "description": "Usage start.", "readOnly": true }, "usageEnd": { "type": "string", "format": "date-time", "description": "Usage end.", "readOnly": true }, "nextLink": { "type": "string", "description": "The link (url) to the next page of results.", "readOnly": true } } }, "DimensionsListResult": { "type": "object", "description": "Result of listing dimensions. It contains a list of available dimensions.", "properties": { "value": { "type": "array", "description": "The list of dimensions.", "items": { "$ref": "#/definitions/Dimension" }, "readOnly": true }, "nextLink": { "type": "string", "description": "The link (url) to the next page of results." } } }, "DismissAlertPayload": { "type": "object", "description": "The request payload to update an alert", "properties": { "properties": { "$ref": "#/definitions/AlertProperties", "description": "Alert properties.", "x-ms-client-flatten": true } } }, "DownloadURL": { "type": "object", "description": "The URL to download the generated report.", "properties": { "expiryTime": { "type": "string", "format": "date-time", "description": "The time at which report URL becomes invalid/expires in UTC e.g. 2020-12-08T05:55:59.4394737Z.", "readOnly": true }, "validTill": { "type": "string", "format": "date-time", "description": "The time at which report URL becomes invalid/expires in UTC e.g. 2020-12-08T05:55:59.4394737Z." }, "downloadUrl": { "type": "string", "description": "The URL to download the generated report." } } }, "EAPriceSheetProperties": { "type": "object", "description": "The properties of the EA price sheet. Properties supported with version 2025-03-01 are as below", "properties": { "enrollmentNumber": { "type": "string", "description": "Unique identifier for the EA billing account.", "readOnly": true }, "serviceFamily": { "type": "number", "format": "float", "description": "Type of Azure service. For example, Compute, Analytics, and Security.", "readOnly": true }, "product": { "type": "string", "description": "Name of the product accruing the charges.", "readOnly": true }, "productId": { "type": "string", "description": "Unique identifier for the product whose meter is consumed.", "readOnly": true }, "skuId": { "type": "string", "description": "Unique identifier of the SKU", "readOnly": true }, "unitOfMeasure": { "type": "string", "description": "How usage is measured for the service. Note: The field “Unit” has been removed with version 2023-11-01 as a duplicate of “UnitofMeasure”, please use the field “UnitOfMeasure”.", "readOnly": true }, "meterId": { "type": "string", "description": "Unique identifier of the meter", "readOnly": true }, "meterName": { "type": "string", "description": "Name of the meter. The meter represents the deployable resource of an Azure service.", "readOnly": true }, "meterType": { "type": "string", "description": "Name of the meter type", "readOnly": true }, "offerId": { "type": "string", "description": "Determines the Azure offer associated with this meter. [Learn more about Azure offers] (https://azure.microsoft.com/en-us/support/legal/offer-details/)", "readOnly": true }, "meterCategory": { "type": "string", "description": "Name of the classification category for the meter. For example, Cloud services, Networking, etc.", "readOnly": true }, "meterSubCategory": { "type": "string", "description": "Name of the meter subclassification category.", "readOnly": true }, "meterRegion": { "type": "string", "description": "Name of the Azure region where the meter for the service is available.", "readOnly": true }, "effectiveStartDate": { "type": "string", "format": "date-time", "description": "Effective start date of the Price Sheet billing period", "readOnly": true }, "effectiveEndDate": { "type": "string", "format": "date-time", "description": "Effective end date of the Price Sheet billing period", "readOnly": true }, "unitPrice": { "type": "string", "description": "The per-unit price at the time of billing for a given product or service, inclusive of any negotiated discounts on top of the market price.\n\nFor PriceType ReservedInstance, unit price reflects the total cost of the 1 or 3-year commitment including discounts.\n\nNote: The unit price isn't the same as the effective price in usage details downloads when services have differential prices across tiers.\n\nIf services have multi-tiered pricing, the effective price is a blended rate across the tiers and doesn't show a tier-specific unit price. The blended price or effective price is the net price for the consumed quantity spanning across the multiple tiers (where each tier has a specific unit price).", "readOnly": true }, "basePrice": { "type": "string", "description": "The unit price at the time the customer signs on or the unit price at the time of service meter GA launch if it is after sign-on.\n\nThis is applicable for Enterprise Agreement users", "readOnly": true }, "marketPrice": { "type": "string", "description": "The current list price for a given product or service. This price is without any negotiations and is based on your Microsoft Agreement type.\n\nFor PriceType Consumption, market price is reflected as the pay-as-you-go price.\n\nFor PriceType Savings Plan, market price reflects the Savings plan benefit on top of pay-as-you-go price for the corresponding commitment term.\n\nFor PriceType ReservedInstance, market price reflects the total price of the 1 or 3-year commitment.\n\nNote: For EA customers with no negotiations, market price may appear rounded to a different decimal precision than unit price.", "readOnly": true }, "includedQuantity": { "type": "string", "description": "Quantities of a specific service to which an EA customer is entitled to consume without incremental charges.", "readOnly": true }, "currencyCode": { "type": "string", "description": "Currency in which the Enterprise Agreement was signed", "readOnly": true }, "term": { "type": "string", "description": "Term length for Azure Savings Plan or Reservation term – one year or three years (P1Y or P3Y)", "readOnly": true }, "priceType": { "type": "string", "description": "Price type for a product. For example, an Azure resource with a pay-as-you-go rate with priceType as Consumption. Other price types include ReservedInstance and Savings Plan.", "readOnly": true }, "partNumber": { "type": "string", "description": "Part number associated with the meter", "readOnly": true } } }, "EAPricesheetDownloadProperties": { "type": "object", "description": "The properties of the price sheet download.", "properties": { "downloadUrl": { "type": "string", "description": "The link (url) to download the pricesheet.", "readOnly": true }, "validTill": { "type": "string", "format": "date-time", "description": "Download link validity.", "readOnly": true }, "downloadFileProperties": { "$ref": "#/definitions/EAPriceSheetProperties", "description": "The properties in downloaded file" } } }, "ErrorDetails": { "type": "object", "description": "The details of the error.", "properties": { "code": { "type": "string", "description": "Error code.", "readOnly": true }, "message": { "type": "string", "description": "Error message indicating why the operation failed.", "readOnly": true } } }, "ErrorDetailsWithNestedDetails": { "type": "object", "description": "The details of the error.", "properties": { "details": { "type": "array", "description": "The additional details of the error.", "items": { "$ref": "#/definitions/ErrorDetailsWithNestedDetails" }, "readOnly": true, "x-ms-identifiers": [] } }, "allOf": [ { "$ref": "#/definitions/ErrorDetails" } ] }, "ErrorResponse": { "type": "object", "description": "Error response indicates that the service is not able to process the incoming request. The reason is provided in the error message. \\n\\nSome Error responses: \\n\\n * 429 TooManyRequests - Request is throttled. Retry after waiting for the time specified in the \\\"x-ms-ratelimit-microsoft.consumption-retry-after\\\" header. \\n\\n * 503 ServiceUnavailable - Service is temporarily unavailable. Retry after waiting for the time specified in the \\\"Retry-After\\\" header.", "properties": { "error": { "$ref": "#/definitions/ErrorDetails", "description": "The details of the error." } } }, "ErrorResponseWithNestedDetails": { "type": "object", "description": "Error response indicates that the service is not able to process the incoming request. The reason is provided in the error message.\n\nSome Error responses:\n\n* 429 TooManyRequests - Request is throttled. Retry after waiting for the time specified in the \"x-ms-ratelimit-microsoft.consumption-retry-after\" header.\n\n* 503 ServiceUnavailable - Service is temporarily unavailable. Retry after waiting for the time specified in the \"Retry-After\" header.", "properties": { "error": { "$ref": "#/definitions/ErrorDetailsWithNestedDetails", "description": "The details of the error." } } }, "ExecutionStatus": { "type": "string", "description": "The last known status of the export run.", "enum": [ "Queued", "InProgress", "Completed", "Failed", "Timeout", "NewDataNotAvailable", "DataNotAvailable" ], "x-ms-enum": { "name": "ExecutionStatus", "modelAsString": true, "values": [ { "name": "Queued", "value": "Queued" }, { "name": "InProgress", "value": "InProgress" }, { "name": "Completed", "value": "Completed" }, { "name": "Failed", "value": "Failed" }, { "name": "Timeout", "value": "Timeout" }, { "name": "NewDataNotAvailable", "value": "NewDataNotAvailable" }, { "name": "DataNotAvailable", "value": "DataNotAvailable" } ] } }, "ExecutionType": { "type": "string", "description": "The type of the export run.", "enum": [ "OnDemand", "Scheduled" ], "x-ms-enum": { "name": "ExecutionType", "modelAsString": true, "values": [ { "name": "OnDemand", "value": "OnDemand" }, { "name": "Scheduled", "value": "Scheduled" } ] } }, "Export": { "type": "object", "description": "An export resource.", "properties": { "properties": { "$ref": "#/definitions/ExportProperties", "description": "The properties of the export.", "x-ms-client-flatten": true }, "identity": { "$ref": "../../../../../../common-types/resource-management/v5/managedidentity.json#/definitions/SystemAssignedServiceIdentity", "description": "The managed identity associated with Export" }, "location": { "type": "string", "description": "The location of the Export's managed identity. Only required when utilizing managed identity.", "x-ms-mutability": [ "read", "create" ] }, "eTag": { "$ref": "#/definitions/Azure.Core.eTag", "description": "eTag of the resource. To handle concurrent update scenario, this field will be used to determine whether the user is updating the latest version or not." } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" } ] }, "ExportDataset": { "type": "object", "description": "The definition for data in the export.", "properties": { "granularity": { "$ref": "#/definitions/GranularityType", "description": "The granularity of rows in the export. Currently 'Daily' is supported for most cases." }, "configuration": { "$ref": "#/definitions/ExportDatasetConfiguration", "description": "The export dataset configuration." } } }, "ExportDatasetConfiguration": { "type": "object", "description": "This is on path to deprecation and will not be supported going forward.", "properties": { "columns": { "type": "array", "description": "Array of column names to be included in the export. If not provided then the export will include all available columns. The available columns can vary by customer channel (see examples).", "items": { "type": "string" } }, "dataVersion": { "type": "string", "description": "The data version for the selected for the export. If not provided then the export will default to latest data version." }, "filters": { "type": "array", "description": "Filters associated with the data sets.", "items": { "$ref": "#/definitions/FilterItems" }, "x-ms-identifiers": [ "name" ] } } }, "ExportDefinition": { "type": "object", "description": "The definition of an export.", "properties": { "type": { "$ref": "#/definitions/ExportType", "description": "The type of the export. Note that 'Usage' is equivalent to 'ActualCost' and is applicable to exports that do not yet provide data for charges or amortization for service reservations." }, "timeframe": { "$ref": "#/definitions/TimeframeType", "description": "The time frame for pulling data for the export. If custom, then a specific time period must be provided." }, "timePeriod": { "$ref": "#/definitions/ExportTimePeriod", "description": "Has time period for pulling data for the export." }, "dataSet": { "$ref": "#/definitions/ExportDataset", "description": "The definition for data in the export." } }, "required": [ "type", "timeframe" ] }, "ExportDeliveryDestination": { "type": "object", "description": "This represents the blob storage account location where exports of costs will be delivered. There are two ways to configure the destination. The approach recommended for most customers is to specify the resourceId of the storage account. This requires a one-time registration of the account's subscription with the Microsoft.CostManagementExports resource provider in order to give Cost Management services access to the storage. When creating an export in the Azure portal this registration is performed automatically but API users may need to register the subscription explicitly (for more information see https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-supported-services ). Another way to configure the destination is available ONLY to Partners with a Microsoft Partner Agreement plan who are global admins of their billing account. These Partners, instead of specifying the resourceId of a storage account, can specify the storage account name along with a SAS token for the account. This allows exports of costs to a storage account in any tenant. The SAS token should be created for the blob service with Service/Container/Object resource types and with Read/Write/Delete/List/Add/Create permissions (for more information see https://docs.microsoft.com/en-us/azure/cost-management-billing/costs/export-cost-data-storage-account-sas-key ).", "properties": { "type": { "$ref": "#/definitions/DestinationType", "description": "The export delivery destination type. Currently only 'AzureBlob' is supported." }, "resourceId": { "type": "string", "description": "The resource id of the storage account where exports will be delivered. This is not required if a sasToken and storageAccount are specified." }, "container": { "type": "string", "description": "The name of the container where exports will be uploaded. If the container does not exist it will be created." }, "rootFolderPath": { "type": "string", "description": "The name of the directory where exports will be uploaded." }, "sasToken": { "type": "string", "format": "password", "description": "A SAS token for the storage account. For a restricted set of Azure customers this together with storageAccount can be specified instead of resourceId. Note: the value returned by the API for this property will always be obfuscated. Returning this same obfuscated value will not result in the SAS token being updated. To update this value a new SAS token must be specified.", "x-ms-secret": true }, "storageAccount": { "type": "string", "description": "The storage account where exports will be uploaded. For a restricted set of Azure customers this together with sasToken can be specified instead of resourceId." } }, "required": [ "container" ] }, "ExportDeliveryInfo": { "type": "object", "description": "The delivery information associated with a export.", "properties": { "destination": { "$ref": "#/definitions/ExportDeliveryDestination", "description": "Has destination for the export being delivered." } }, "required": [ "destination" ] }, "ExportExecutionListResult": { "type": "object", "description": "Result of listing the run history of an export.", "properties": { "value": { "type": "array", "description": "A list of export runs.", "items": { "$ref": "#/definitions/ExportRun" }, "readOnly": true } } }, "ExportListResult": { "type": "object", "description": "Result of listing exports. It contains a list of available exports in the scope provided.", "properties": { "value": { "type": "array", "description": "The list of exports.", "items": { "$ref": "#/definitions/Export" }, "readOnly": true } } }, "ExportProperties": { "type": "object", "description": "The properties of the export.", "properties": { "schedule": { "$ref": "#/definitions/ExportSchedule", "description": "Has schedule information for the export." } }, "allOf": [ { "$ref": "#/definitions/CommonExportProperties" } ] }, "ExportRecurrencePeriod": { "type": "object", "description": "The start and end date for recurrence schedule.", "properties": { "from": { "type": "string", "format": "date-time", "description": "The start date of recurrence." }, "to": { "type": "string", "format": "date-time", "description": "The end date of recurrence." } }, "required": [ "from" ] }, "ExportRun": { "type": "object", "description": "An export run.", "properties": { "properties": { "$ref": "#/definitions/ExportRunProperties", "description": "The properties of the export run.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "#/definitions/CostManagementProxyResource" } ] }, "ExportRunProperties": { "type": "object", "description": "The properties of the export run.", "properties": { "executionType": { "$ref": "#/definitions/ExecutionType", "description": "The type of the export run." }, "status": { "$ref": "#/definitions/ExecutionStatus", "description": "The last known status of the export run." }, "submittedBy": { "type": "string", "description": "The identifier for the entity that triggered the export. For on-demand runs it is the user email. For scheduled runs it is 'System'." }, "submittedTime": { "type": "string", "format": "date-time", "description": "The time when export was queued to be run." }, "processingStartTime": { "type": "string", "format": "date-time", "description": "The time when export was picked up to be run." }, "processingEndTime": { "type": "string", "format": "date-time", "description": "The time when the export run finished." }, "startDate": { "type": "string", "format": "date-time", "description": "The start datetime for the export." }, "endDate": { "type": "string", "format": "date-time", "description": "The end datetime for the export." }, "fileName": { "type": "string", "description": "The name of the exported file." }, "manifestFile": { "type": "string", "description": "The manifest file location(URI location) for the exported files." }, "runSettings": { "$ref": "#/definitions/CommonExportProperties", "description": "The export settings that were in effect for this run." }, "error": { "$ref": "#/definitions/ErrorDetails", "description": "The details of any error." } } }, "ExportRunRequest": { "type": "object", "description": "The export run request.", "properties": { "timePeriod": { "$ref": "#/definitions/ExportTimePeriod", "description": "Has time period for pulling data for the export." } } }, "ExportSchedule": { "type": "object", "description": "The schedule associated with the export.", "properties": { "status": { "$ref": "#/definitions/StatusType", "description": "The status of the export's schedule. If 'Inactive', the export's schedule is paused. To enable export set the status to be Active and then make a PUT request." }, "recurrence": { "$ref": "#/definitions/RecurrenceType", "description": "The schedule recurrence." }, "recurrencePeriod": { "$ref": "#/definitions/ExportRecurrencePeriod", "description": "Has start and end date of the recurrence. The start date must be in future. If present, the end date must be greater than start date." } } }, "ExportSuspensionContext": { "type": "object", "description": "The properties of the export run. This is not populated currently.", "properties": { "suspensionCode": { "type": "string", "description": "The code for export suspension." }, "suspensionReason": { "type": "string", "description": "The detailed reason for export suspension." }, "suspensionTime": { "type": "string", "format": "date-time", "description": "The time when the export was suspended." } } }, "ExportTimePeriod": { "type": "object", "description": "The date range for data in the export. This should only be specified with timeFrame set to 'Custom'. The maximum date range is 1 calendar month.", "properties": { "from": { "type": "string", "format": "date-time", "description": "The start date for export data." }, "to": { "type": "string", "format": "date-time", "description": "The end date for export data." } }, "required": [ "from", "to" ] }, "ExportType": { "type": "string", "description": "The type of the export. Note that 'Usage' is equivalent to 'ActualCost' and is applicable to exports that do not yet provide data for charges or amortization for service reservations.", "enum": [ "Usage", "ActualCost", "AmortizedCost", "FocusCost", "PriceSheet", "ReservationTransactions", "ReservationRecommendations", "ReservationDetails" ], "x-ms-enum": { "name": "ExportType", "modelAsString": true, "values": [ { "name": "Usage", "value": "Usage" }, { "name": "ActualCost", "value": "ActualCost" }, { "name": "AmortizedCost", "value": "AmortizedCost" }, { "name": "FocusCost", "value": "FocusCost" }, { "name": "PriceSheet", "value": "PriceSheet" }, { "name": "ReservationTransactions", "value": "ReservationTransactions" }, { "name": "ReservationRecommendations", "value": "ReservationRecommendations" }, { "name": "ReservationDetails", "value": "ReservationDetails" } ] } }, "ExternalCloudProviderType": { "type": "string", "enum": [ "externalSubscriptions", "externalBillingAccounts" ], "x-ms-enum": { "name": "ExternalCloudProviderType", "modelAsString": true, "values": [ { "name": "externalSubscriptions", "value": "externalSubscriptions" }, { "name": "externalBillingAccounts", "value": "externalBillingAccounts" } ] } }, "FileDestination": { "type": "object", "description": "Destination of the view data. This is optional. Currently only CSV format is supported.", "properties": { "fileFormats": { "type": "array", "description": "Destination of the view data. Currently only CSV format is supported.", "items": { "$ref": "#/definitions/FileFormat" } } } }, "FileFormat": { "type": "string", "description": "Destination of the view data. Currently only CSV format is supported.", "enum": [ "Csv" ], "x-ms-enum": { "name": "FileFormat", "modelAsString": true, "values": [ { "name": "Csv", "value": "Csv" } ] } }, "FilterItemNames": { "type": "string", "description": "The name of the filter. This is currently only supported for Export Definition type of ReservationRecommendations. Supported names are ['ReservationScope', 'LookBackPeriod', 'ResourceType']", "enum": [ "ReservationScope", "ResourceType", "LookBackPeriod" ], "x-ms-enum": { "name": "FilterItemNames", "modelAsString": true, "values": [ { "name": "ReservationScope", "value": "ReservationScope" }, { "name": "ResourceType", "value": "ResourceType" }, { "name": "LookBackPeriod", "value": "LookBackPeriod" } ] } }, "FilterItems": { "type": "object", "description": "Will contain the filter name and value to operate on. This is currently only supported for Export Definition type of ReservationRecommendations.", "properties": { "name": { "$ref": "#/definitions/FilterItemNames", "description": "The name of the filter. This is currently only supported for Export Definition type of ReservationRecommendations. Supported names are ['ReservationScope', 'LookBackPeriod', 'ResourceType']" }, "value": { "type": "string", "description": "Value to filter by. Currently values supported per name are, for 'ReservationScope' supported values are ['Single', 'Shared'], for 'LookBackPeriod' supported values are ['Last7Days', 'Last30Days', 'Last60Days'] and for 'ResourceType' supported values are ['VirtualMachines', 'SQLDatabases', 'PostgreSQL', 'ManagedDisk', 'MySQL', 'RedHat', 'MariaDB', 'RedisCache', 'CosmosDB', 'SqlDataWarehouse', 'SUSELinux', 'AppService', 'BlockBlob', 'AzureDataExplorer', 'VMwareCloudSimple']." } } }, "ForecastAggregation": { "type": "object", "description": "The aggregation expression to be used in the forecast.", "properties": { "name": { "$ref": "#/definitions/FunctionName", "description": "The name of the column to aggregate." }, "function": { "$ref": "#/definitions/FunctionType", "description": "The name of the aggregation function to use." } }, "required": [ "name", "function" ] }, "ForecastColumn": { "type": "object", "description": "Forecast column properties", "properties": { "name": { "type": "string", "description": "The name of column." }, "type": { "type": "string", "description": "The type of column." } } }, "ForecastComparisonExpression": { "type": "object", "description": "The comparison expression to be used in the forecast.", "properties": { "name": { "type": "string", "description": "The name of the column to use in comparison." }, "operator": { "$ref": "#/definitions/ForecastOperatorType", "description": "The operator to use for comparison." }, "values": { "type": "array", "description": "Array of values to use for comparison", "minItems": 1, "items": { "type": "string" } } }, "required": [ "name", "operator", "values" ] }, "ForecastDataset": { "type": "object", "description": "The definition of data present in the forecast.", "properties": { "granularity": { "$ref": "#/definitions/GranularityType", "description": "The granularity of rows in the forecast." }, "configuration": { "$ref": "#/definitions/ForecastDatasetConfiguration", "description": "Has configuration information for the data in the export. The configuration will be ignored if aggregation and grouping are provided." }, "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.", "additionalProperties": { "$ref": "#/definitions/ForecastAggregation" } }, "filter": { "$ref": "#/definitions/ForecastFilter", "description": "Has filter expression to use in the forecast." } }, "required": [ "aggregation" ] }, "ForecastDatasetConfiguration": { "type": "object", "description": "The configuration of dataset in the forecast.", "properties": { "columns": { "type": "array", "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.", "items": { "type": "string" } } } }, "ForecastDefinition": { "type": "object", "description": "The definition of a forecast.", "properties": { "type": { "$ref": "#/definitions/ForecastType", "description": "The type of the forecast." }, "timeframe": { "$ref": "#/definitions/ForecastTimeframe", "description": "The time frame for pulling data for the forecast. If custom, then a specific time period must be provided." }, "timePeriod": { "$ref": "#/definitions/ForecastTimePeriod", "description": "Has time period for pulling data for the forecast." }, "dataset": { "$ref": "#/definitions/ForecastDataset", "description": "Has definition for data in this forecast." }, "includeActualCost": { "type": "boolean", "description": "A boolean determining if actualCost will be included." }, "includeFreshPartialCost": { "type": "boolean", "description": "A boolean determining if FreshPartialCost will be included." } }, "required": [ "type", "timeframe", "dataset" ] }, "ForecastFilter": { "type": "object", "description": "The filter expression to be used in the export.", "properties": { "and": { "type": "array", "description": "The logical \"AND\" expression. Must have at least 2 items.", "minItems": 2, "items": { "$ref": "#/definitions/ForecastFilter" }, "x-ms-identifiers": [] }, "or": { "type": "array", "description": "The logical \"OR\" expression. Must have at least 2 items.", "minItems": 2, "items": { "$ref": "#/definitions/ForecastFilter" }, "x-ms-identifiers": [] }, "dimensions": { "$ref": "#/definitions/ForecastComparisonExpression", "description": "Has comparison expression for a dimension" }, "tags": { "$ref": "#/definitions/ForecastComparisonExpression", "description": "Has comparison expression for a tag" } } }, "ForecastOperatorType": { "type": "string", "description": "The operator to use for comparison.", "enum": [ "In" ], "x-ms-enum": { "name": "ForecastOperatorType", "modelAsString": true, "values": [ { "name": "In", "value": "In" } ] } }, "ForecastProperties": { "type": "object", "description": "Forecast properties", "properties": { "nextLink": { "type": "string", "description": "The link (url) to the next page of results." }, "columns": { "type": "array", "description": "Array of columns", "items": { "$ref": "#/definitions/ForecastColumn" }, "x-ms-identifiers": [ "name" ] }, "rows": { "type": "array", "description": "Array of rows", "items": { "type": "array", "items": {} }, "x-ms-identifiers": [] } } }, "ForecastResult": { "type": "object", "description": "Result of forecast. It contains all columns listed under groupings and aggregation.", "properties": { "properties": { "$ref": "#/definitions/ForecastProperties", "description": "Forecast properties", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "#/definitions/CostManagementResource" } ] }, "ForecastSpend": { "type": "object", "description": "The forecasted cost which is being tracked for a budget.\n\nSupported for CategoryType(s): Cost.", "properties": { "amount": { "type": "number", "format": "float", "description": "The forecasted cost for the total time period which is being tracked by the budget. This value is only provided if the budget contains a forecast alert type.", "readOnly": true }, "unit": { "type": "string", "description": "The unit of measure for the budget amount.", "readOnly": true } } }, "ForecastTimePeriod": { "type": "object", "description": "Has time period for pulling data for the forecast.", "properties": { "from": { "type": "string", "format": "date-time", "description": "The start date to pull data from." }, "to": { "type": "string", "format": "date-time", "description": "The end date to pull data to." } }, "required": [ "from", "to" ] }, "ForecastTimeframe": { "type": "string", "description": "The time frame for pulling data for the forecast.", "enum": [ "Custom" ], "x-ms-enum": { "name": "ForecastTimeframe", "modelAsString": true, "values": [ { "name": "Custom", "value": "Custom" } ] } }, "ForecastType": { "type": "string", "description": "The type of the forecast.", "enum": [ "Usage", "ActualCost", "AmortizedCost" ], "x-ms-enum": { "name": "ForecastType", "modelAsString": true, "values": [ { "name": "Usage", "value": "Usage" }, { "name": "ActualCost", "value": "ActualCost" }, { "name": "AmortizedCost", "value": "AmortizedCost" } ] } }, "FormatType": { "type": "string", "description": "The format of the export being delivered.", "enum": [ "Csv", "Parquet" ], "x-ms-enum": { "name": "FormatType", "modelAsString": true, "values": [ { "name": "Csv", "value": "Csv" }, { "name": "Parquet", "value": "Parquet" } ] } }, "Frequency": { "type": "string", "description": "Frequency of a notification. Represents how long the notification will be silent after triggering an alert for a threshold breach. If not specified, the frequency will be set by default based on the timeGrain (Weekly when timeGrain: Last7Days, Monthly when timeGrain: Last30Days).\n\nSupported for CategoryType(s): ReservationUtilization.", "enum": [ "Daily", "Weekly", "Monthly" ], "x-ms-enum": { "name": "Frequency", "modelAsString": true, "values": [ { "name": "Daily", "value": "Daily", "description": "After the threshold breaches and an Alert is fired, no further alerts will be sent until the next calendar day." }, { "name": "Weekly", "value": "Weekly", "description": "After the threshold breaches and an Alert is fired, no further alerts will be sent for 7 calendar days." }, { "name": "Monthly", "value": "Monthly", "description": "After the threshold breaches and an Alert is fired, no further alerts will be sent for 30 calendar days." } ] } }, "FunctionName": { "type": "string", "description": "The name of the column to aggregate.", "enum": [ "PreTaxCostUSD", "Cost", "CostUSD", "PreTaxCost" ], "x-ms-enum": { "name": "FunctionName", "modelAsString": true, "values": [ { "name": "PreTaxCostUSD", "value": "PreTaxCostUSD" }, { "name": "Cost", "value": "Cost" }, { "name": "CostUSD", "value": "CostUSD" }, { "name": "PreTaxCost", "value": "PreTaxCost" } ] } }, "FunctionType": { "type": "string", "description": "The name of the aggregation function to use.", "enum": [ "Sum" ], "x-ms-enum": { "name": "FunctionType", "modelAsString": true, "values": [ { "name": "Sum", "value": "Sum" } ] } }, "GenerateCostDetailsReportErrorResponse": { "type": "object", "description": "Error response indicates that the service is not able to process the incoming request. The reason is provided in the error message.\n\nSome Error responses:\n\n* 400 Bad Request - Invalid Request Payload. Request payload provided is not in a json format or had an invalid member not accepted in the request payload.\n\n* 400 Bad Request - Invalid request payload: can only have either timePeriod or invoiceId or billingPeriod. API only allows data to be pulled for either timePeriod or invoiceId or billingPeriod. Customer should provide only one of these parameters.\n\n* 400 Bad Request - Start date must be after . API only allows data to be pulled no older than 13 months from now.\n\n* 400 Bad Request - The maximum allowed date range is 1 months. API only allows data to be pulled for 1 month or less.\n\n* 429 TooManyRequests - Request is throttled. Retry after waiting for the time specified in the \"retry-after\" header.\n\n* 503 ServiceUnavailable - Service is temporarily unavailable. Retry after waiting for the time specified in the \"Retry-After\" header.", "properties": { "error": { "$ref": "#/definitions/ErrorDetails", "description": "The details of the error." } } }, "GenerateCostDetailsReportRequestDefinition": { "type": "object", "description": "The definition of a cost detailed report.", "properties": { "metric": { "$ref": "#/definitions/CostDetailsMetricType", "description": "The type of the detailed report. By default ActualCost is provided" }, "timePeriod": { "$ref": "#/definitions/CostDetailsTimePeriod", "description": "The specific date range of cost details requested for the report. This parameter cannot be used alongside either the invoiceId or billingPeriod parameters. If a timePeriod, invoiceId or billingPeriod parameter is not provided in the request body the API will return the current month's cost. API only allows data to be pulled for 1 month or less and no older than 13 months. If no timePeriod or billingPeriod or invoiceId is provided the API defaults to the open month time period" }, "billingPeriod": { "type": "string", "description": "This parameter can be used only by Enterprise Agreement customers. Use the YearMonth(e.g. 202008) format. This parameter cannot be used alongside either the invoiceId or timePeriod parameters. If a timePeriod, invoiceId or billingPeriod parameter is not provided in the request body the API will return the current month's cost." }, "invoiceId": { "type": "string", "description": "This parameter can only be used by Microsoft Customer Agreement customers. Additionally, it can only be used at the Billing Profile or Customer scope. This parameter cannot be used alongside either the billingPeriod or timePeriod parameters. If a timePeriod, invoiceId or billingPeriod parameter is not provided in the request body the API will return the current month's cost." } } }, "GenerateDetailedCostReportDefinition": { "type": "object", "description": "The definition of a cost detailed report.", "properties": { "metric": { "$ref": "#/definitions/GenerateDetailedCostReportMetricType", "description": "The type of the detailed report. By default ActualCost is provided" }, "timePeriod": { "$ref": "#/definitions/GenerateDetailedCostReportTimePeriod", "description": "Has time period for pulling data for the cost detailed report. Can only have one of either timePeriod or invoiceId or billingPeriod parameters. If none provided current month cost is provided." }, "billingPeriod": { "type": "string", "description": "Billing period in YearMonth(e.g. 202008) format. Only for legacy enterprise customers can use this. Can only have one of either timePeriod or invoiceId or billingPeriod parameters. If none provided current month cost is provided." }, "invoiceId": { "type": "string", "description": "Invoice ID for Pay-as-you-go and Microsoft Customer Agreement scopes. Can only have one of either timePeriod or invoiceId or billingPeriod parameters. If none provided current month cost is provided." }, "customerId": { "type": "string", "description": "Customer ID for Microsoft Customer Agreement scopes (Invoice Id is also required for this)." } } }, "GenerateDetailedCostReportErrorResponse": { "type": "object", "description": "Error response indicates that the service is not able to process the incoming request. The reason is provided in the error message.\n\nSome Error responses:\n\n* 413 Request Entity Too Large - Request is throttled. The amount of data required to fulfill the request exceeds the maximum size permitted of 2Gb. Please utilize our Exports feature instead.\n\n* 429 TooManyRequests - Request is throttled. Retry after waiting for the time specified in the \"x-ms-ratelimit-microsoft.consumption-retry-after\" header.\n\n* 503 ServiceUnavailable - Service is temporarily unavailable. Retry after waiting for the time specified in the \"Retry-After\" header.", "properties": { "error": { "$ref": "#/definitions/ErrorDetails", "description": "The details of the error." } } }, "GenerateDetailedCostReportMetricType": { "type": "string", "description": "The type of the detailed report. By default ActualCost is provided", "enum": [ "ActualCost", "AmortizedCost" ], "x-ms-enum": { "name": "GenerateDetailedCostReportMetricType", "modelAsString": true, "values": [ { "name": "ActualCost", "value": "ActualCost" }, { "name": "AmortizedCost", "value": "AmortizedCost" } ] } }, "GenerateDetailedCostReportOperationResult": { "type": "object", "description": "The result of the long running operation for cost detailed report.", "properties": { "properties": { "$ref": "#/definitions/DownloadURL", "description": "The properties of the resource generated.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" } ] }, "GenerateDetailedCostReportOperationStatuses": { "type": "object", "description": "The status of the long running operation for cost detailed report.", "properties": { "properties": { "$ref": "#/definitions/DownloadURL", "description": "The properties of the usage file generated.", "x-ms-client-flatten": true }, "status": { "$ref": "#/definitions/Status", "description": "The status of the long running operation." }, "startTime": { "type": "string", "description": "The startTime of the operation." }, "endTime": { "type": "string", "description": "The endTime of the operation." }, "error": { "$ref": "#/definitions/ErrorDetails", "description": "The details of the error." } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" } ] }, "GenerateDetailedCostReportTimePeriod": { "type": "object", "description": "The start and end date for pulling data for the cost detailed report.", "properties": { "start": { "type": "string", "description": "The start date to pull data from. example format 2020-03-15" }, "end": { "type": "string", "description": "The end date to pull data to. example format 2020-03-15" } }, "required": [ "start", "end" ] }, "Grain": { "type": "string", "description": "Grain which corresponds to value.", "enum": [ "Hourly", "Daily", "Monthly" ], "x-ms-enum": { "name": "Grain", "modelAsString": true, "values": [ { "name": "Hourly", "value": "Hourly", "description": "Hourly grain corresponds to value per hour." }, { "name": "Daily", "value": "Daily", "description": "Hourly grain corresponds to value per day." }, { "name": "Monthly", "value": "Monthly", "description": "Hourly grain corresponds to value per month." } ] } }, "GrainParameter": { "type": "string", "enum": [ "Hourly", "Daily", "Monthly" ], "x-ms-enum": { "name": "GrainParameter", "modelAsString": true, "values": [ { "name": "Hourly", "value": "Hourly", "description": "Hourly grain corresponds to value per hour." }, { "name": "Daily", "value": "Daily", "description": "Hourly grain corresponds to value per day." }, { "name": "Monthly", "value": "Monthly", "description": "Hourly grain corresponds to value per month." } ] } }, "GranularityType": { "type": "string", "description": "The granularity of rows in the export. Currently 'Daily' is supported for most cases.", "enum": [ "Daily", "Monthly" ], "x-ms-enum": { "name": "GranularityType", "modelAsString": true, "values": [ { "name": "Daily", "value": "Daily" }, { "name": "Monthly", "value": "Monthly" } ] } }, "IncludedQuantityUtilizationSummary": { "type": "object", "description": "Included Quantity utilization summary resource.", "properties": { "properties": { "$ref": "#/definitions/IncludedQuantityUtilizationSummaryProperties", "description": "Included Quantity utilization summary properties.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "#/definitions/BenefitUtilizationSummary" } ], "x-ms-discriminator-value": "IncludedQuantity" }, "IncludedQuantityUtilizationSummaryProperties": { "type": "object", "description": "Included Quantity utilization summary properties.", "properties": { "utilizationPercentage": { "type": "number", "format": "decimal", "description": "This is the utilized percentage for the benefit ID.", "readOnly": true } }, "allOf": [ { "$ref": "#/definitions/BenefitUtilizationSummaryProperties" } ] }, "KpiProperties": { "type": "object", "description": "Each KPI must contain a 'type' and 'enabled' key.", "properties": { "type": { "$ref": "#/definitions/KpiTypeType", "description": "KPI type (Forecast, Budget)." }, "id": { "type": "string", "description": "ID of resource related to metric (budget)." }, "enabled": { "type": "boolean", "description": "show the KPI in the UI?" } } }, "KpiTypeType": { "type": "string", "description": "KPI type (Forecast, Budget).", "enum": [ "Forecast", "Budget" ], "x-ms-enum": { "name": "KpiTypeType", "modelAsString": true, "values": [ { "name": "Forecast", "value": "Forecast" }, { "name": "Budget", "value": "Budget" } ] } }, "LookBackPeriod": { "type": "string", "description": "The number of days used to look back.", "enum": [ "Last7Days", "Last30Days", "Last60Days" ], "x-ms-enum": { "name": "LookBackPeriod", "modelAsString": true, "values": [ { "name": "Last7Days", "value": "Last7Days", "description": "7 days used to look back." }, { "name": "Last30Days", "value": "Last30Days", "description": "30 days used to look back." }, { "name": "Last60Days", "value": "Last60Days", "description": "60 days used to look back." } ] } }, "MCAPriceSheetProperties": { "type": "object", "description": "The properties of the price sheet.", "properties": { "billingAccountID": { "type": "string", "description": "Unique identifier for the billing account.", "readOnly": true }, "billingAccountName": { "type": "string", "description": "Name of the billing profile that is set up to receive invoices. The prices in the price sheet are associated with this billing profile.", "readOnly": true }, "billingProfileId": { "type": "string", "description": "Unique identifier for the billing profile.", "readOnly": true }, "billingProfileName": { "type": "string", "description": "Name of the billing profile that is set up to receive invoices. The prices in the price sheet are associated with this billing profile.", "readOnly": true }, "productOrderName": { "type": "string", "description": "Name of the purchased product plan. Indicates if this pricing is standard Azure Plan pricing, Dev/Test pricing etc.\n\nCurrently unavailable for Azure 3rd party and ReservedInstance meters.", "readOnly": true }, "serviceFamily": { "type": "number", "format": "float", "description": "Type of Azure service. For example, Compute, Analytics, and Security.", "readOnly": true }, "product": { "type": "string", "description": "Name of the product accruing the charges.", "readOnly": true }, "productId": { "type": "string", "description": "Unique identifier for the product whose meter is consumed.", "readOnly": true }, "skuId": { "type": "string", "description": "Unique identifier of the SKU", "readOnly": true }, "unitOfMeasure": { "type": "string", "description": "How usage is measured for the service", "readOnly": true }, "meterId": { "type": "string", "description": "Unique identifier of the meter", "readOnly": true }, "meterName": { "type": "string", "description": "Name of the meter. The meter represents the deployable resource of an Azure service.", "readOnly": true }, "meterType": { "type": "string", "description": "Name of the meter type", "readOnly": true }, "meterCategory": { "type": "string", "description": "Name of the classification category for the meter. For example, Cloud services, Networking, etc.", "readOnly": true }, "meterSubCategory": { "type": "string", "description": "Name of the meter subclassification category.", "readOnly": true }, "meterRegion": { "type": "string", "description": "Name of the Azure region where the meter for the service is available.", "readOnly": true }, "tierMinimumUnits": { "type": "string", "description": "Defines the lower bound of the tier range for which prices are defined. For example, if the range is 0 to 100, tierMinimumUnits would be 0.", "readOnly": true }, "effectiveStartDate": { "type": "string", "format": "date-time", "description": "Effective start date of the Price Sheet billing period", "readOnly": true }, "effectiveEndDate": { "type": "string", "format": "date-time", "description": "Effective end date of the Price Sheet billing period", "readOnly": true }, "unitPrice": { "type": "string", "description": "The per-unit price at the time of billing for a given product or service, inclusive of any negotiated discounts on top of the market price.\n\nFor PriceType ReservedInstance, unit price reflects the total cost of the 1 or 3-year commitment including discounts.\n\nNote: The unit price isn't the same as the effective price in usage details downloads when services have differential prices across tiers.\n\nIf services have multi-tiered pricing, the effective price is a blended rate across the tiers and doesn't show a tier-specific unit price. The blended price or effective price is the net price for the consumed quantity spanning across the multiple tiers (where each tier has a specific unit price).", "readOnly": true }, "basePrice": { "type": "string", "description": "The unit price at the time the customer signs on or the unit price at the time of service meter GA launch if it is after sign-on.\n\nThis is applicable for Enterprise Agreement users", "readOnly": true }, "marketPrice": { "type": "string", "description": "The current list price for a given product or service. This price is without any negotiations and is based on your Microsoft Agreement type.\n\nFor PriceType Consumption, market price is reflected as the pay-as-you-go price.\n\nFor PriceType Savings Plan, market price reflects the Savings plan benefit on top of pay-as-you-go price for the corresponding commitment term.\n\nFor PriceType ReservedInstance, market price reflects the total price of the 1 or 3-year commitment.", "readOnly": true }, "currency": { "type": "string", "description": "Currency in which all the prices are reflected.", "readOnly": true }, "billingCurrency": { "type": "string", "description": "Currency in which charges are posted.", "readOnly": true }, "term": { "type": "string", "description": "Term length for Azure Savings Plan or Reservation term – one year or three years (P1Y or P3Y)", "readOnly": true }, "priceType": { "type": "string", "description": "Price type for a product. For example, an Azure resource with a pay-as-you-go rate with priceType as Consumption. Other price types include ReservedInstance and Savings Plan.", "readOnly": true } } }, "MarkupRule": { "type": "object", "description": "Markup rule", "properties": { "properties": { "$ref": "#/definitions/MarkupRuleProperties", "description": "Markup rule properties" } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" } ] }, "MarkupRulePagedResponse": { "type": "object", "description": "Markup rule list result. It contains a list of Markup rules.", "properties": { "value": { "type": "array", "description": "The list of markup rules.", "items": { "$ref": "#/definitions/MarkupRule" }, "x-ms-identifiers": [ "id" ] }, "nextLink": { "type": "string", "description": "The link (url) to the next page of results." } } }, "MarkupRuleProperties": { "type": "object", "description": "The properties of the markup rule.", "properties": { "description": { "type": "string", "description": "The description of the markup rule." }, "percentage": { "type": "number", "format": "double", "description": "The markup percentage of the rule." }, "startDate": { "type": "string", "format": "date-time", "description": "Starting date of the markup rule." }, "endDate": { "type": "string", "format": "date-time", "description": "Ending date of the markup rule." }, "customerDetails": { "$ref": "#/definitions/CustomerMetadata", "description": "Customer information for the markup rule." } }, "required": [ "percentage", "startDate", "customerDetails" ] }, "MetricType": { "type": "string", "description": "Metric to use when displaying costs.", "enum": [ "ActualCost", "AmortizedCost", "AHUB" ], "x-ms-enum": { "name": "MetricType", "modelAsString": true, "values": [ { "name": "ActualCost", "value": "ActualCost" }, { "name": "AmortizedCost", "value": "AmortizedCost" }, { "name": "AHUB", "value": "AHUB" } ] } }, "Notification": { "type": "object", "description": "The notification associated with a budget.\n\nSupported for CategoryType(s): Cost, ReservationUtilization.", "properties": { "enabled": { "type": "boolean", "description": "The notification is enabled or not.\n\nSupported for CategoryType(s): Cost, ReservationUtilization." }, "operator": { "$ref": "#/definitions/BudgetNotificationOperatorType", "description": "The comparison operator.\n\nSupported for CategoryType(s): Cost, ReservationUtilization.\n\nSupported operators for **CategoryType: Cost**\n- GreaterThan\n- GreaterThanOrEqualTo\n\nSupported operators for **CategoryType: ReservationUtilization**\n- LessThan" }, "threshold": { "type": "number", "format": "float", "description": "Threshold value associated with a notification. It is always percent with a maximum of 2 decimal places.\n\nSupported for CategoryType(s): Cost, ReservationUtilization.\n\n**CategoryType: Cost** - Must be between 0 and 1000. Notification is sent when the cost exceeded the threshold.\n\n**CategoryType: ReservationUtilization** - Must be between 0 and 100. Notification is sent when a reservation has a utilization percentage below the threshold." }, "frequency": { "$ref": "#/definitions/Frequency", "description": "Frequency of a notification. Represents how long the notification will be silent after triggering an alert for a threshold breach. If not specified, the frequency will be set by default based on the timeGrain (Weekly when timeGrain: Last7Days, Monthly when timeGrain: Last30Days).\n\nSupported for CategoryType(s): ReservationUtilization." }, "contactEmails": { "type": "array", "description": "Email addresses to send the notification to when the threshold is breached. Must have at least one contact email or contact group specified at the Subscription or Resource Group scopes. All other scopes must have at least one contact email specified.\n\nSupported for CategoryType(s): Cost, ReservationUtilization.", "minItems": 0, "maxItems": 50, "items": { "type": "string" } }, "contactRoles": { "type": "array", "description": "Subscription or Resource Group scopes only. Contact roles to send the notification to when the threshold is breached.\n\nSupported for CategoryType(s): Cost.", "items": { "type": "string" } }, "contactGroups": { "type": "array", "description": "Subscription or Resource Group scopes only. Action groups to send the notification to when the threshold is exceeded. Must be provided as a fully qualified Azure resource id.\n\nSupported for CategoryType(s): Cost.", "minItems": 0, "maxItems": 50, "items": { "type": "string" } }, "thresholdType": { "type": "string", "description": "The type of threshold.\n\nSupported for CategoryType(s): Cost.", "default": "Actual", "enum": [ "Actual", "Forecasted" ], "x-ms-enum": { "name": "ThresholdType", "modelAsString": true, "values": [ { "name": "Actual", "value": "Actual", "description": "Actual costs budget alerts notify when the actual accrued cost exceeds the allocated budget." }, { "name": "Forecasted", "value": "Forecasted", "description": "Forecasted costs budget alerts provide advanced notification that your spending trends are likely to exceed your allocated budget, as it relies on forecasted cost predictions." } ] } }, "locale": { "$ref": "#/definitions/CultureCode", "description": "Language in which the recipient will receive the notification,\n\nSupported for CategoryType(s): Cost, ReservationUtilization." } }, "required": [ "enabled", "operator", "threshold", "contactEmails" ] }, "NotificationProperties": { "type": "object", "description": "The properties of the scheduled action notification.", "properties": { "to": { "type": "array", "description": "Array of email addresses.", "minItems": 1, "maxItems": 20, "items": { "type": "string" } }, "language": { "type": "string", "description": "Locale of the email." }, "message": { "type": "string", "description": "Optional message to be added in the email. Length is limited to 250 characters." }, "regionalFormat": { "type": "string", "description": "Regional format used for formatting date/time and currency values in the email." }, "subject": { "type": "string", "description": "Subject of the email. Length is limited to 70 characters." } }, "required": [ "to", "subject" ] }, "OperationListResult": { "type": "object", "description": "Result of listing cost management operations. It contains a list of operations and a URL link to get the next set of results.", "properties": { "value": { "type": "array", "description": "List of cost management operations supported by the Microsoft.CostManagement resource provider.", "items": { "$ref": "#/definitions/CostManagementOperation" }, "readOnly": true }, "nextLink": { "type": "string", "description": "URL to get the next set of operation list results if there are any.", "readOnly": true } } }, "OperationStatus": { "type": "object", "description": "The status of the long running operation.", "properties": { "status": { "$ref": "#/definitions/OperationStatusType", "description": "The status of the long running operation." }, "properties": { "$ref": "#/definitions/ReportURL", "description": "The properties of the resource generated.", "x-ms-client-flatten": true } } }, "OperationStatusType": { "type": "string", "description": "Enum representing the status of an async operation.", "enum": [ "Running", "Completed", "Failed" ], "x-ms-enum": { "name": "OperationStatusType", "modelAsString": true, "values": [ { "name": "Running", "value": "Running" }, { "name": "Completed", "value": "Completed" }, { "name": "Failed", "value": "Failed" } ] } }, "OperatorType": { "type": "string", "description": "The operator to use for comparison.", "enum": [ "In", "Contains" ], "x-ms-enum": { "name": "OperatorType", "modelAsString": true, "values": [ { "name": "In", "value": "In" }, { "name": "Contains", "value": "Contains" } ] } }, "Origin": { "type": "string", "description": "The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is \"user,system\"", "enum": [ "user", "system", "user,system" ], "x-ms-enum": { "name": "Origin", "modelAsString": true, "values": [ { "name": "user", "value": "user" }, { "name": "system", "value": "system" }, { "name": "user,system", "value": "user,system" } ] } }, "PivotProperties": { "type": "object", "description": "Each pivot must contain a 'type' and 'name'.", "properties": { "type": { "$ref": "#/definitions/PivotTypeType", "description": "Data type to show in view." }, "name": { "type": "string", "description": "Data field to show in view." } } }, "PivotTypeType": { "type": "string", "description": "Data type to show in view.", "enum": [ "Dimension", "TagKey" ], "x-ms-enum": { "name": "PivotTypeType", "modelAsString": true, "values": [ { "name": "Dimension", "value": "Dimension" }, { "name": "TagKey", "value": "TagKey" } ] } }, "PricesheetDownloadProperties": { "type": "object", "description": "The URL to download the generated report.", "properties": { "expiryTime": { "type": "string", "format": "date-time", "description": "The time at which report URL becomes invalid/expires in UTC e.g. 2020-12-08T05:55:59.4394737Z.", "readOnly": true }, "downloadUrl": { "type": "string", "description": "The URL to download the generated report." }, "downloadFileProperties": { "$ref": "#/definitions/MCAPriceSheetProperties", "description": "The properties in downloaded file" } } }, "QueryAggregation": { "type": "object", "description": "The aggregation expression to be used in the query.", "properties": { "name": { "type": "string", "description": "The name of the column to aggregate." }, "function": { "$ref": "#/definitions/FunctionType", "description": "The name of the aggregation function to use." } }, "required": [ "name", "function" ] }, "QueryColumn": { "type": "object", "description": "QueryColumn properties", "properties": { "name": { "type": "string", "description": "The name of column." }, "type": { "type": "string", "description": "The type of column." } } }, "QueryColumnType": { "type": "string", "description": "The type of the column in the report.", "enum": [ "TagKey", "Dimension" ], "x-ms-enum": { "name": "QueryColumnType", "modelAsString": true, "values": [ { "name": "TagKey", "value": "TagKey", "description": "The tag associated with the cost data." }, { "name": "Dimension", "value": "Dimension", "description": "The dimension of cost data." } ] } }, "QueryComparisonExpression": { "type": "object", "description": "The comparison expression to be used in the query.", "properties": { "name": { "type": "string", "description": "The name of the column to use in comparison." }, "operator": { "$ref": "#/definitions/QueryOperatorType", "description": "The operator to use for comparison." }, "values": { "type": "array", "description": "Array of values to use for comparison", "minItems": 1, "items": { "type": "string" } } }, "required": [ "name", "operator", "values" ] }, "QueryDataset": { "type": "object", "description": "The definition of data present in the query.", "properties": { "granularity": { "$ref": "#/definitions/GranularityType", "description": "The granularity of rows in the query." }, "configuration": { "$ref": "#/definitions/QueryDatasetConfiguration", "description": "Has configuration information for the data in the export. The configuration will be ignored if aggregation and grouping are provided." }, "aggregation": { "type": "object", "description": "Dictionary of aggregation expression to use in the query. The key of each item in the dictionary is the alias for the aggregated column. Query can have up to 2 aggregation clauses.", "additionalProperties": { "$ref": "#/definitions/QueryAggregation" } }, "grouping": { "type": "array", "description": "Array of group by expression to use in the query. Query can have up to 2 group by clauses.", "maxItems": 2, "items": { "$ref": "#/definitions/QueryGrouping" }, "x-ms-identifiers": [ "name", "type" ] }, "filter": { "$ref": "#/definitions/QueryFilter", "description": "The filter expression to use in the query. Please reference our Query API REST documentation for how to properly format the filter." } } }, "QueryDatasetConfiguration": { "type": "object", "description": "The configuration of dataset in the query.", "properties": { "columns": { "type": "array", "description": "Array of column names to be included in the query. Any valid query column name is allowed. If not provided, then query includes all columns.", "items": { "type": "string" } } } }, "QueryDefinition": { "type": "object", "description": "The definition of a query.", "properties": { "type": { "$ref": "#/definitions/ExportType", "description": "The type of the query." }, "timeframe": { "$ref": "#/definitions/TimeframeType", "description": "The time frame for pulling data for the query. If custom, then a specific time period must be provided." }, "timePeriod": { "$ref": "#/definitions/QueryTimePeriod", "description": "Has time period for pulling data for the query." }, "dataset": { "$ref": "#/definitions/QueryDataset", "description": "Has definition for data in this query." } }, "required": [ "type", "timeframe", "dataset" ] }, "QueryFilter": { "type": "object", "description": "The filter expression to be used in the export.", "properties": { "and": { "type": "array", "description": "The logical \"AND\" expression. Must have at least 2 items.", "minItems": 2, "items": { "$ref": "#/definitions/QueryFilter" }, "x-ms-identifiers": [] }, "or": { "type": "array", "description": "The logical \"OR\" expression. Must have at least 2 items.", "minItems": 2, "items": { "$ref": "#/definitions/QueryFilter" }, "x-ms-identifiers": [] }, "dimensions": { "$ref": "#/definitions/QueryComparisonExpression", "description": "Has comparison expression for a dimension" }, "tags": { "$ref": "#/definitions/QueryComparisonExpression", "description": "Has comparison expression for a tag" } } }, "QueryGrouping": { "type": "object", "description": "The group by expression to be used in the query.", "properties": { "type": { "$ref": "#/definitions/QueryColumnType", "description": "Has type of the column to group." }, "name": { "type": "string", "description": "The name of the column to group." } }, "required": [ "type", "name" ] }, "QueryOperatorType": { "type": "string", "description": "The operator to use for comparison.", "enum": [ "In" ], "x-ms-enum": { "name": "QueryOperatorType", "modelAsString": true, "values": [ { "name": "In", "value": "In" } ] } }, "QueryProperties": { "type": "object", "description": "Query properties", "properties": { "nextLink": { "type": "string", "description": "The link (url) to the next page of results." }, "columns": { "type": "array", "description": "Array of columns", "items": { "$ref": "#/definitions/QueryColumn" }, "x-ms-identifiers": [ "name" ] }, "rows": { "type": "array", "description": "Array of rows", "items": { "type": "array", "items": {} }, "x-ms-identifiers": [] } } }, "QueryResult": { "type": "object", "description": "Result of query. It contains all columns listed under groupings and aggregation.", "properties": { "properties": { "$ref": "#/definitions/QueryProperties", "description": "Query properties", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "#/definitions/CostManagementResource" } ] }, "QueryTimePeriod": { "type": "object", "description": "The start and end date for pulling data for the query.", "properties": { "from": { "type": "string", "format": "date-time", "description": "The start date to pull data from." }, "to": { "type": "string", "format": "date-time", "description": "The end date to pull data to." } }, "required": [ "from", "to" ] }, "Reason": { "type": "string", "description": "The reason this name is not available.", "enum": [ "Invalid", "AlreadyExists", "Valid" ], "x-ms-enum": { "name": "Reason", "modelAsString": true, "values": [ { "name": "Invalid", "value": "Invalid" }, { "name": "AlreadyExists", "value": "AlreadyExists" }, { "name": "Valid", "value": "Valid" } ] } }, "RecurrenceType": { "type": "string", "description": "The schedule recurrence.", "enum": [ "Daily", "Weekly", "Monthly", "Annually" ], "x-ms-enum": { "name": "RecurrenceType", "modelAsString": true, "values": [ { "name": "Daily", "value": "Daily" }, { "name": "Weekly", "value": "Weekly" }, { "name": "Monthly", "value": "Monthly" }, { "name": "Annually", "value": "Annually" } ] } }, "ReportConfigAggregation": { "type": "object", "description": "The aggregation expression to be used in the report.", "properties": { "name": { "type": "string", "description": "The name of the column to aggregate." }, "function": { "$ref": "#/definitions/FunctionType", "description": "The name of the aggregation function to use." } }, "required": [ "name", "function" ] }, "ReportConfigComparisonExpression": { "type": "object", "description": "The comparison expression to be used in the report.", "properties": { "name": { "type": "string", "description": "The name of the column to use in comparison." }, "operator": { "$ref": "#/definitions/OperatorType", "description": "The operator to use for comparison." }, "values": { "type": "array", "description": "Array of values to use for comparison", "minItems": 1, "items": { "type": "string" } } }, "required": [ "name", "operator", "values" ] }, "ReportConfigDataset": { "type": "object", "description": "The definition of data present in the report.", "properties": { "granularity": { "$ref": "#/definitions/ReportGranularityType", "description": "The granularity of rows in the report." }, "configuration": { "$ref": "#/definitions/ReportConfigDatasetConfiguration", "description": "Has configuration information for the data in the report. The configuration will be ignored if aggregation and grouping are provided." }, "aggregation": { "type": "object", "description": "Dictionary of aggregation expression to use in the report. The key of each item in the dictionary is the alias for the aggregated column. Report can have up to 2 aggregation clauses.", "additionalProperties": { "$ref": "#/definitions/ReportConfigAggregation" } }, "grouping": { "type": "array", "description": "Array of group by expression to use in the report. Report can have up to 2 group by clauses.", "maxItems": 2, "items": { "$ref": "#/definitions/ReportConfigGrouping" }, "x-ms-identifiers": [ "name", "type" ] }, "sorting": { "type": "array", "description": "Array of order by expression to use in the report.", "items": { "$ref": "#/definitions/ReportConfigSorting" }, "x-ms-identifiers": [] }, "filter": { "$ref": "#/definitions/ReportConfigFilter", "description": "Has filter expression to use in the report." } } }, "ReportConfigDatasetConfiguration": { "type": "object", "description": "The configuration of dataset in the report.", "properties": { "columns": { "type": "array", "description": "Array of column names to be included in the report. Any valid report column name is allowed. If not provided, then report includes all columns.", "items": { "type": "string" } } } }, "ReportConfigDefinition": { "type": "object", "description": "The definition of a report config.", "properties": { "type": { "$ref": "#/definitions/ReportType", "description": "The type of the report. Usage represents actual usage, forecast represents forecasted data and UsageAndForecast represents both usage and forecasted data. Actual usage and forecasted data can be differentiated based on dates." }, "timeframe": { "$ref": "#/definitions/ReportTimeframeType", "description": "The time frame for pulling data for the report. If custom, then a specific time period must be provided." }, "timePeriod": { "$ref": "#/definitions/ReportConfigTimePeriod", "description": "Has time period for pulling data for the report." }, "dataSet": { "$ref": "#/definitions/ReportConfigDataset", "description": "Has definition for data in this report config." }, "includeMonetaryCommitment": { "type": "boolean", "description": "If true, report includes monetary commitment." } }, "required": [ "type", "timeframe" ] }, "ReportConfigFilter": { "type": "object", "description": "The filter expression to be used in the report.", "properties": { "and": { "type": "array", "description": "The logical \"AND\" expression. Must have at least 2 items.", "minItems": 2, "items": { "$ref": "#/definitions/ReportConfigFilter" }, "x-ms-identifiers": [] }, "or": { "type": "array", "description": "The logical \"OR\" expression. Must have at least 2 items.", "minItems": 2, "items": { "$ref": "#/definitions/ReportConfigFilter" }, "x-ms-identifiers": [] }, "dimensions": { "$ref": "#/definitions/ReportConfigComparisonExpression", "description": "Has comparison expression for a dimension" }, "tags": { "$ref": "#/definitions/ReportConfigComparisonExpression", "description": "Has comparison expression for a tag" } } }, "ReportConfigGrouping": { "type": "object", "description": "The group by expression to be used in the report.", "properties": { "type": { "$ref": "#/definitions/QueryColumnType", "description": "Has type of the column to group." }, "name": { "type": "string", "description": "The name of the column to group. This version supports subscription lowest possible grain." } }, "required": [ "type", "name" ] }, "ReportConfigSorting": { "type": "object", "description": "The order by expression to be used in the report.", "properties": { "direction": { "$ref": "#/definitions/ReportConfigSortingType", "description": "Direction of sort." }, "name": { "type": "string", "description": "The name of the column to sort." } }, "required": [ "name" ] }, "ReportConfigSortingType": { "type": "string", "description": "Direction of sort.", "enum": [ "Ascending", "Descending" ], "x-ms-enum": { "name": "ReportConfigSortingType", "modelAsString": true, "values": [ { "name": "Ascending", "value": "Ascending" }, { "name": "Descending", "value": "Descending" } ] } }, "ReportConfigTimePeriod": { "type": "object", "description": "The start and end date for pulling data for the report.", "properties": { "from": { "type": "string", "format": "date-time", "description": "The start date to pull data from." }, "to": { "type": "string", "format": "date-time", "description": "The end date to pull data to." } }, "required": [ "from", "to" ] }, "ReportGranularityType": { "type": "string", "description": "The granularity of rows in the report.", "enum": [ "Daily", "Monthly" ], "x-ms-enum": { "name": "ReportGranularityType", "modelAsString": true, "values": [ { "name": "Daily", "value": "Daily" }, { "name": "Monthly", "value": "Monthly" } ] } }, "ReportManifest": { "type": "object", "description": "The manifest of the report generated by the operation.", "properties": { "manifestVersion": { "type": "string", "description": "The Manifest version." }, "dataFormat": { "$ref": "#/definitions/CostDetailsDataFormat", "description": "The data format of the report" }, "byteCount": { "type": "integer", "format": "int64", "description": "The total number of bytes in all blobs." }, "blobCount": { "type": "integer", "format": "int32", "description": "The total number of blobs." }, "compressData": { "type": "boolean", "description": "Is the data in compressed format." }, "requestContext": { "$ref": "#/definitions/RequestContext", "description": "The context of the Cost Details request.", "x-ms-client-flatten": true }, "blobs": { "type": "array", "description": "List of blob information generated by this operation.", "items": { "$ref": "#/definitions/BlobInfo" }, "x-ms-identifiers": [ "blobLink" ] } } }, "ReportOperationStatusType": { "type": "string", "description": "The status of the long running operation.", "enum": [ "InProgress", "Completed", "Failed", "Queued", "NoDataFound", "ReadyToDownload", "TimedOut" ], "x-ms-enum": { "name": "ReportOperationStatusType", "modelAsString": true, "values": [ { "name": "InProgress", "value": "InProgress" }, { "name": "Completed", "value": "Completed" }, { "name": "Failed", "value": "Failed" }, { "name": "Queued", "value": "Queued" }, { "name": "NoDataFound", "value": "NoDataFound" }, { "name": "ReadyToDownload", "value": "ReadyToDownload" }, { "name": "TimedOut", "value": "TimedOut" } ] } }, "ReportTimeframeType": { "type": "string", "description": "The time frame for pulling data for the report. If custom, then a specific time period must be provided.", "enum": [ "WeekToDate", "MonthToDate", "YearToDate", "Custom" ], "x-ms-enum": { "name": "ReportTimeframeType", "modelAsString": true, "values": [ { "name": "WeekToDate", "value": "WeekToDate" }, { "name": "MonthToDate", "value": "MonthToDate" }, { "name": "YearToDate", "value": "YearToDate" }, { "name": "Custom", "value": "Custom" } ] } }, "ReportType": { "type": "string", "description": "The type of the report. Usage represents actual usage, forecast represents forecasted data and UsageAndForecast represents both usage and forecasted data. Actual usage and forecasted data can be differentiated based on dates.", "enum": [ "Usage" ], "x-ms-enum": { "name": "ReportType", "modelAsString": true, "values": [ { "name": "Usage", "value": "Usage" } ] } }, "ReportURL": { "type": "object", "description": "The URL to download the generated report.", "properties": { "reportUrl": { "$ref": "#/definitions/ReservationReportSchema", "description": "The CSV file from the reportUrl blob link consists of reservation usage data with the following schema at daily granularity" }, "validUntil": { "type": "string", "format": "date-time", "description": "The time at which report URL becomes invalid." } } }, "RequestContext": { "type": "object", "description": "The context of the Cost Details request.", "properties": { "requestScope": { "type": "string", "description": "The request scope of the request." }, "requestBody": { "$ref": "#/definitions/GenerateCostDetailsReportRequestDefinition", "description": "The request payload body provided in Cost Details call" } } }, "ReservationReportSchema": { "type": "string", "description": "The CSV file from the reportUrl blob link consists of reservation usage data with the following schema at daily granularity", "enum": [ "InstanceFlexibilityGroup", "InstanceFlexibilityRatio", "InstanceId", "Kind", "ReservationId", "ReservationOrderId", "ReservedHours", "SkuName", "TotalReservedQuantity", "UsageDate", "UsedHours" ], "x-ms-enum": { "name": "ReservationReportSchema", "modelAsString": true, "values": [ { "name": "InstanceFlexibilityGroup", "value": "InstanceFlexibilityGroup" }, { "name": "InstanceFlexibilityRatio", "value": "InstanceFlexibilityRatio" }, { "name": "InstanceId", "value": "InstanceId" }, { "name": "Kind", "value": "Kind" }, { "name": "ReservationId", "value": "ReservationId" }, { "name": "ReservationOrderId", "value": "ReservationOrderId" }, { "name": "ReservedHours", "value": "ReservedHours" }, { "name": "SkuName", "value": "SkuName" }, { "name": "TotalReservedQuantity", "value": "TotalReservedQuantity" }, { "name": "UsageDate", "value": "UsageDate" }, { "name": "UsedHours", "value": "UsedHours" } ] } }, "RuleStatus": { "type": "string", "description": "Current status of the rule.", "enum": [ "NotActive", "Active", "Processing" ], "x-ms-enum": { "name": "RuleStatus", "modelAsString": true, "values": [ { "name": "NotActive", "value": "NotActive", "description": "Rule is saved but not used to allocate costs." }, { "name": "Active", "value": "Active", "description": "Rule is saved and impacting cost allocation." }, { "name": "Processing", "value": "Processing", "description": "Rule is saved and cost allocation is being updated. Readonly value that cannot be submitted in a put request." } ] } }, "SavingsPlanUtilizationSummary": { "type": "object", "description": "Savings plan utilization summary resource.", "properties": { "properties": { "$ref": "#/definitions/SavingsPlanUtilizationSummaryProperties", "description": "Savings plan utilization summary properties.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "#/definitions/BenefitUtilizationSummary" } ], "x-ms-discriminator-value": "SavingsPlan" }, "SavingsPlanUtilizationSummaryProperties": { "type": "object", "description": "Savings plan utilization summary properties.", "properties": { "avgUtilizationPercentage": { "type": "number", "format": "decimal", "description": "This is the average hourly utilization for each date range that corresponds to given grain (Daily, Monthly). Suppose the API call is for usageDate > 2025-03-01 and usageDate < 2022-10-31 at a daily granularity. There will be one record per benefit id for each day. For a single day, the avgUtilizationPercentage value will be equal to the average of the set of values where the set contains 24 utilization percentage entries one for each hour in a specific day.", "readOnly": true }, "minUtilizationPercentage": { "type": "number", "format": "decimal", "description": "This is the minimum hourly utilization for each date range that corresponds to given grain (Daily, Monthly). Suppose the API call is for usageDate > 2025-03-01 and usageDate < 2022-10-31 at a daily granularity. There will be one record per benefit id for each day. For a single day, the minUtilizationPercentage value will be equal to the smallest in the set of values where the set contains 24 utilization percentage entries one for each hour in a specific day. If on the day 2022-10-18, the lowest utilization percentage was 10% at hour 4, then the value for the minUtilizationPercentage in the response will be 10%.", "readOnly": true }, "maxUtilizationPercentage": { "type": "number", "format": "decimal", "description": "This is the maximum hourly utilization for each date range that corresponds to given grain (Daily, Monthly). Suppose the API call is for usageDate > 2025-03-01 and usageDate < 2022-10-31 at a daily granularity. There will be one record per benefit id for each day. For a single day, the maxUtilizationPercentage value will be equal to the largest in the set of values where the set contains 24 utilization percentage entries one for each hour in a specific day. If on the day 2022-10-18, the largest utilization percentage was 90% at hour 5, then the value for the maxUtilizationPercentage in the response will be 90%.", "readOnly": true } }, "allOf": [ { "$ref": "#/definitions/BenefitUtilizationSummaryProperties" } ] }, "ScheduleFrequency": { "type": "string", "description": "Frequency of the schedule.", "enum": [ "Daily", "Weekly", "Monthly" ], "x-ms-enum": { "name": "ScheduleFrequency", "modelAsString": true, "values": [ { "name": "Daily", "value": "Daily", "description": "Cost analysis data will be emailed every day." }, { "name": "Weekly", "value": "Weekly", "description": "Cost analysis data will be emailed every week." }, { "name": "Monthly", "value": "Monthly", "description": "Cost analysis data will be emailed every month." } ] } }, "ScheduleProperties": { "type": "object", "description": "The properties of the schedule.", "properties": { "frequency": { "$ref": "#/definitions/ScheduleFrequency", "description": "Frequency of the schedule." }, "hourOfDay": { "type": "integer", "format": "int32", "description": "UTC time at which cost analysis data will be emailed." }, "daysOfWeek": { "type": "array", "description": "Day names in english on which cost analysis data will be emailed. This property is applicable when frequency is Weekly or Monthly.", "items": { "$ref": "#/definitions/DaysOfWeek" } }, "weeksOfMonth": { "type": "array", "description": "Weeks in which cost analysis data will be emailed. This property is applicable when frequency is Monthly and used in combination with daysOfWeek.", "items": { "$ref": "#/definitions/WeeksOfMonth" } }, "dayOfMonth": { "type": "integer", "format": "int32", "description": "UTC day on which cost analysis data will be emailed. Must be between 1 and 31. This property is applicable when frequency is Monthly and overrides weeksOfMonth or daysOfWeek." }, "startDate": { "type": "string", "format": "date-time", "description": "The start date and time of the scheduled action (UTC)." }, "endDate": { "type": "string", "format": "date-time", "description": "The end date and time of the scheduled action (UTC)." } }, "required": [ "frequency", "startDate", "endDate" ] }, "ScheduledAction": { "type": "object", "description": "Scheduled action definition.", "properties": { "properties": { "$ref": "#/definitions/ScheduledActionProperties", "description": "The properties of the scheduled action.", "x-ms-client-flatten": true }, "eTag": { "$ref": "#/definitions/Azure.Core.eTag", "description": "Resource Etag. For update calls, eTag is optional and can be specified to achieve optimistic concurrency. Fetch the resource's eTag by doing a 'GET' call first and then including the latest eTag as part of the request body or 'If-Match' header while performing the update. For create calls, eTag is not required." }, "kind": { "$ref": "#/definitions/ScheduledActionKind", "description": "Kind of the scheduled action." } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" } ] }, "ScheduledActionKind": { "type": "string", "description": "Kind of the scheduled action.", "enum": [ "Email", "InsightAlert" ], "x-ms-enum": { "name": "ScheduledActionKind", "modelAsString": true, "values": [ { "name": "Email", "value": "Email", "description": "Cost analysis data will be emailed." }, { "name": "InsightAlert", "value": "InsightAlert", "description": "Cost anomaly information will be emailed. Available only on subscription scope at daily frequency. If no anomaly is detected on the resource, an email won't be sent." } ] } }, "ScheduledActionListResult": { "type": "object", "description": "Scheduled actions list result. It contains a list of scheduled actions.", "properties": { "value": { "type": "array", "description": "The list of scheduled actions.", "items": { "$ref": "#/definitions/ScheduledAction" }, "readOnly": true }, "nextLink": { "type": "string", "description": "The link (url) to the next page of results." } } }, "ScheduledActionProperties": { "type": "object", "description": "The properties of the scheduled action.", "properties": { "displayName": { "type": "string", "description": "Scheduled action name." }, "fileDestination": { "$ref": "#/definitions/FileDestination", "description": "Destination format of the view data. This is optional." }, "notification": { "$ref": "#/definitions/NotificationProperties", "description": "Notification properties based on scheduled action kind." }, "notificationEmail": { "type": "string", "description": "Email address of the point of contact that should get the unsubscribe requests and notification emails." }, "schedule": { "$ref": "#/definitions/ScheduleProperties", "description": "Schedule of the scheduled action." }, "scope": { "type": "string", "description": "For private scheduled action(Create or Update), scope will be empty.
For shared scheduled action(Create or Update By Scope), Cost Management scope can be 'subscriptions/{subscriptionId}' for subscription scope, 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for BillingProfile scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' for InvoiceSection scope, '/providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}' for ExternalBillingAccount scope, and '/providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}' for ExternalSubscription scope." }, "status": { "$ref": "#/definitions/ScheduledActionStatus", "description": "Status of the scheduled action." }, "viewId": { "type": "string", "description": "Cost analysis viewId used for scheduled action. For example, '/providers/Microsoft.CostManagement/views/swaggerExample'" } }, "required": [ "displayName", "notification", "schedule", "status", "viewId" ] }, "ScheduledActionProxyResource": { "type": "object", "description": "The Resource model definition.", "properties": { "eTag": { "type": "string", "description": "Resource Etag. For update calls, eTag is optional and can be specified to achieve optimistic concurrency. Fetch the resource's eTag by doing a 'GET' call first and then including the latest eTag as part of the request body or 'If-Match' header while performing the update. For create calls, eTag is not required.", "readOnly": true }, "kind": { "$ref": "#/definitions/ScheduledActionKind", "description": "Kind of the scheduled action." }, "systemData": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/systemData", "description": "Kind of the scheduled action." } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" } ] }, "ScheduledActionStatus": { "type": "string", "description": "Status of the scheduled action.", "enum": [ "Enabled", "Expired", "Disabled" ], "x-ms-enum": { "name": "ScheduledActionStatus", "modelAsString": true, "values": [ { "name": "Enabled", "value": "Enabled", "description": "Scheduled action is saved and will be run." }, { "name": "Expired", "value": "Expired", "description": "Scheduled action is expired." }, { "name": "Disabled", "value": "Disabled", "description": "Scheduled action is saved but will not be run." } ] } }, "Scope": { "type": "string", "description": "Kind of the recommendation scope.", "enum": [ "Single", "Shared", "ManagementGroup" ], "x-ms-enum": { "name": "Scope", "modelAsString": true, "values": [ { "name": "Single", "value": "Single", "description": "Single scope recommendation." }, { "name": "Shared", "value": "Shared", "description": "Shared scope recommendation." }, { "name": "ManagementGroup", "value": "ManagementGroup", "description": "Management group scope recommendation." } ] } }, "Setting": { "type": "object", "description": "Setting definition.", "properties": { "kind": { "$ref": "#/definitions/SettingsKind", "description": "Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value.", "pattern": "^[-\\w\\._,\\(\\\\\\)]+$" } }, "discriminator": "kind", "required": [ "kind" ], "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" } ] }, "SettingType": { "type": "string", "enum": [ "taginheritance" ], "x-ms-enum": { "name": "SettingType", "modelAsString": true, "values": [ { "name": "taginheritance", "value": "taginheritance", "description": "This setting applies billing profile, invoice section, subscription and resource group tags to current month's usage data of child resources." } ] } }, "SettingsKind": { "type": "string", "description": "Specifies the kind of settings.", "enum": [ "taginheritance" ], "x-ms-enum": { "name": "SettingsKind", "modelAsString": true, "values": [ { "name": "taginheritance", "value": "taginheritance" } ] } }, "SettingsListResult": { "type": "object", "description": "Setting list result. It contains a list of settings.", "properties": { "value": { "type": "array", "description": "The list of settings.", "items": { "$ref": "#/definitions/Setting" }, "readOnly": true, "x-ms-identifiers": [ "id" ] } } }, "SourceCostAllocationResource": { "type": "object", "description": "Source resources for cost allocation", "properties": { "values": { "type": "array", "description": "Source Resources for cost allocation. This list cannot contain more than 25 values.", "items": { "type": "string" } } }, "required": [ "values" ], "allOf": [ { "$ref": "#/definitions/CostAllocationResource" } ] }, "Status": { "type": "object", "description": "The status of the long running operation.", "properties": { "status": { "$ref": "#/definitions/ReportOperationStatusType", "description": "The status of the long running operation." } } }, "StatusType": { "type": "string", "description": "The status of the export's schedule. If 'Inactive', the export's schedule is paused. To enable export set the status to be Active and then make a PUT request.", "enum": [ "Active", "Inactive" ], "x-ms-enum": { "name": "StatusType", "modelAsString": true, "values": [ { "name": "Active", "value": "Active" }, { "name": "Inactive", "value": "Inactive" } ] } }, "TagInheritanceProperties": { "type": "object", "description": "The properties of the tag inheritance setting.", "properties": { "preferContainerTags": { "type": "boolean", "description": "This property defines the behavior when an inherited tag being applied matches a lower scope tag (Eg. Subscription tag matches the resource tag). If set to true - when tags match, the highest scope tags will be applied. Billing profile is the highest scope, followed by invoice sections, subscriptions and resource groups (allows overriding of lower scope tag values). If set to false - when tags match, the lowest scope tags will be applied. So, if a resource has the same tag as a subscription tag, the resource tag will be applied (does not allow overriding of lower scope tag values)." } }, "required": [ "preferContainerTags" ] }, "TagInheritanceSetting": { "type": "object", "description": "Tag Inheritance Setting definition.", "properties": { "properties": { "$ref": "#/definitions/TagInheritanceProperties", "description": "The properties of the tag inheritance setting." } }, "allOf": [ { "$ref": "#/definitions/Setting" } ], "x-ms-discriminator-value": "taginheritance" }, "TargetCostAllocationResource": { "type": "object", "description": "Target resources for cost allocation.", "properties": { "values": { "type": "array", "description": "Target resources for cost allocation. This list cannot contain more than 25 values.", "items": { "$ref": "#/definitions/CostAllocationProportion" }, "x-ms-identifiers": [ "name" ] }, "policyType": { "$ref": "#/definitions/CostAllocationPolicyType", "description": "Method of cost allocation for the rule" } }, "required": [ "values", "policyType" ], "allOf": [ { "$ref": "#/definitions/CostAllocationResource" } ] }, "Term": { "type": "string", "description": "Grain which corresponds to value.", "enum": [ "P1Y", "P3Y" ], "x-ms-enum": { "name": "Term", "modelAsString": true, "values": [ { "name": "P1Y", "value": "P1Y", "description": "Benefit term is 1 year." }, { "name": "P3Y", "value": "P3Y", "description": "Benefit term is 3 years." } ] } }, "ThresholdType": { "type": "string", "description": "The type of threshold.\n\nSupported for CategoryType(s): Cost.", "enum": [ "Actual", "Forecasted" ], "x-ms-enum": { "name": "ThresholdType", "modelAsString": true, "values": [ { "name": "Actual", "value": "Actual", "description": "Actual costs budget alerts notify when the actual accrued cost exceeds the allocated budget." }, { "name": "Forecasted", "value": "Forecasted", "description": "Forecasted costs budget alerts provide advanced notification that your spending trends are likely to exceed your allocated budget, as it relies on forecasted cost predictions." } ] } }, "TimeGrainType": { "type": "string", "description": "The time covered by a budget. Tracking of the amount will be reset based on the time grain.\n\nSupported for CategoryType(s): Cost, ReservationUtilization.\n\nSupported timeGrainTypes for **CategoryType: Cost**\n\n- Monthly\n- Quarterly\n- Annually\n- BillingMonth*\n- BillingQuarter*\n- BillingAnnual*\n\n*only supported for Web Direct customers.\n\nSupported timeGrainTypes for **CategoryType: ReservationUtilization**\n- Last7Days\n- Last30Days\n\nRequired for CategoryType(s): Cost, ReservationUtilization.", "enum": [ "Monthly", "Quarterly", "Annually", "BillingMonth", "BillingQuarter", "BillingAnnual", "Last7Days", "Last30Days" ], "x-ms-enum": { "name": "TimeGrainType", "modelAsString": true, "values": [ { "name": "Monthly", "value": "Monthly", "description": "The budget will track costs in the current calendar month against the amount.\n\nSupported for CategoryType: Cost only." }, { "name": "Quarterly", "value": "Quarterly", "description": "The budget will track costs in the current calendar quarter against the amount.\n\nSupported for CategoryType: Cost only." }, { "name": "Annually", "value": "Annually", "description": "The budget will track costs in the current calendar year against the amount.\n\nSupported for CategoryType: Cost only." }, { "name": "BillingMonth", "value": "BillingMonth", "description": "The budget will track costs in the current billing month against the amount.\n\nSupported for CategoryType: Cost and Web Direct customers only." }, { "name": "BillingQuarter", "value": "BillingQuarter", "description": "The budget will track costs in the current billing quarter against the amount.\n\nSupported for CategoryType: Cost and Web Direct customers only." }, { "name": "BillingAnnual", "value": "BillingAnnual", "description": "The budget will track costs in the current billing year against the amount.\n\nSupported for CategoryType: Cost and Web Direct customers only." }, { "name": "Last7Days", "value": "Last7Days", "description": "The Reservation Utilization Alert Rule will evaluate reservations based on their 7-Day utilization percentage.\n\nSupported for CategoryType: ReservationUtilization only." }, { "name": "Last30Days", "value": "Last30Days", "description": "The Reservation Utilization Alert Rule will evaluate reservations based on their 30-Day utilization percentage.\n\nSupported for CategoryType: ReservationUtilization only." } ] } }, "TimeframeType": { "type": "string", "description": "The time frame for pulling data for the export. If custom, then a specific time period must be provided.", "enum": [ "MonthToDate", "BillingMonthToDate", "TheLastMonth", "TheLastBillingMonth", "WeekToDate", "Custom", "TheCurrentMonth" ], "x-ms-enum": { "name": "TimeframeType", "modelAsString": true, "values": [ { "name": "MonthToDate", "value": "MonthToDate" }, { "name": "BillingMonthToDate", "value": "BillingMonthToDate" }, { "name": "TheLastMonth", "value": "TheLastMonth" }, { "name": "TheLastBillingMonth", "value": "TheLastBillingMonth" }, { "name": "WeekToDate", "value": "WeekToDate" }, { "name": "Custom", "value": "Custom" }, { "name": "TheCurrentMonth", "value": "TheCurrentMonth" } ] } }, "View": { "type": "object", "description": "States and configurations of Cost Analysis.", "properties": { "properties": { "$ref": "#/definitions/ViewProperties", "description": "The properties of the view.", "x-ms-client-flatten": true }, "eTag": { "$ref": "#/definitions/Azure.Core.eTag", "description": "eTag of the resource. To handle concurrent update scenario, this field will be used to determine whether the user is updating the latest version or not." } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" } ] }, "ViewListResult": { "type": "object", "description": "Result of listing views. It contains a list of available views.", "properties": { "value": { "type": "array", "description": "The list of views.", "items": { "$ref": "#/definitions/View" }, "readOnly": true }, "nextLink": { "type": "string", "description": "The link (url) to the next page of results." } } }, "ViewProperties": { "type": "object", "description": "The properties of the view.", "properties": { "displayName": { "type": "string", "description": "User input name of the view. Required." }, "scope": { "type": "string", "description": "Cost Management scope to save the view on. This includes 'subscriptions/{subscriptionId}' for subscription scope, 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for BillingProfile scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' for InvoiceSection scope, 'providers/Microsoft.Management/managementGroups/{managementGroupId}' for Management Group scope, '/providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}' for ExternalBillingAccount scope, and '/providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}' for ExternalSubscription scope." }, "createdOn": { "type": "string", "format": "date-time", "description": "Date the user created this view.", "readOnly": true }, "modifiedOn": { "type": "string", "format": "date-time", "description": "Date when the user last modified this view." }, "dateRange": { "type": "string", "description": "Date range of the current view." }, "currency": { "type": "string", "description": "Currency of the current view.", "readOnly": true }, "query": { "$ref": "#/definitions/ReportConfigDefinition", "description": "Query body configuration. Required.", "x-ms-client-flatten": true }, "chart": { "$ref": "#/definitions/ChartType", "description": "Chart type of the main view in Cost Analysis. Required." }, "accumulated": { "$ref": "#/definitions/AccumulatedType", "description": "Show costs accumulated over time." }, "metric": { "$ref": "#/definitions/MetricType", "description": "Metric to use when displaying costs." }, "kpis": { "type": "array", "description": "List of KPIs to show in Cost Analysis UI.", "items": { "$ref": "#/definitions/KpiProperties" } }, "pivots": { "type": "array", "description": "Configuration of 3 sub-views in the Cost Analysis UI.", "items": { "$ref": "#/definitions/PivotProperties" }, "x-ms-identifiers": [ "name" ] } } }, "WeeksOfMonth": { "type": "string", "description": "Weeks of month.", "enum": [ "First", "Second", "Third", "Fourth", "Last" ], "x-ms-enum": { "name": "WeeksOfMonth", "modelAsString": true, "values": [ { "name": "First", "value": "First" }, { "name": "Second", "value": "Second" }, { "name": "Third", "value": "Third" }, { "name": "Fourth", "value": "Fourth" }, { "name": "Last", "value": "Last" } ] } }, "allSavingsBenefitDetails": { "type": "object", "description": "Benefit recommendation details.", "properties": { "overageCost": { "type": "number", "format": "decimal", "description": "The difference between total cost and benefit cost for the 'totalHours' in the look-back period.", "readOnly": true }, "benefitCost": { "type": "number", "format": "decimal", "description": "The estimated cost with benefit for the 'totalHours' in the look-back period. It's equal to (commitmentAmount * totalHours)", "readOnly": true }, "totalCost": { "type": "number", "format": "decimal", "description": "Total cost, which is sum of benefit cost and overage cost.", "readOnly": true }, "savingsAmount": { "type": "number", "format": "decimal", "description": "The amount saved for the 'totalHours' in the look-back period, by purchasing the recommended quantity of the benefit.", "readOnly": true }, "savingsPercentage": { "type": "number", "format": "decimal", "description": "The savings in percentage for the 'totalHours' in the look-back period, by purchasing the recommended quantity of benefit.", "readOnly": true }, "coveragePercentage": { "type": "number", "format": "decimal", "description": "Estimated benefit coverage percentage for the 'totalHours' in the look-back period, with this commitment.", "readOnly": true }, "commitmentAmount": { "type": "number", "format": "decimal", "description": "The commitment amount at the commitmentGranularity.", "readOnly": true }, "averageUtilizationPercentage": { "type": "number", "format": "decimal", "description": "Estimated average utilization percentage for the 'totalHours' in the look-back period, with this commitment.", "readOnly": true }, "wastageCost": { "type": "number", "format": "decimal", "description": "Estimated unused portion of the 'benefitCost'.", "readOnly": true } } }, "allSavingsList": { "type": "object", "description": "The list of all benefit recommendations with the recommendation details.", "properties": { "value": { "type": "array", "description": "The list of benefit recommendations with the recommendation details..", "items": { "$ref": "#/definitions/allSavingsBenefitDetails" }, "readOnly": true, "x-ms-identifiers": [] }, "nextLink": { "type": "string", "format": "uri", "description": "The link (URL) to the next page of results.", "readOnly": true } } }, "benefitRecommendationModel": { "type": "object", "description": "benefit plan recommendation details.", "properties": { "properties": { "$ref": "#/definitions/benefitRecommendationProperties", "description": "The properties of the benefit recommendations." } }, "allOf": [ { "$ref": "#/definitions/BenefitResource" } ] }, "benefitRecommendationProperties": { "type": "object", "description": "The properties of the benefit recommendations.", "properties": { "firstConsumptionDate": { "type": "string", "format": "date-time", "description": "The first usage date used for looking back for computing the recommendations.", "readOnly": true }, "lastConsumptionDate": { "type": "string", "format": "date-time", "description": "The last usage date used for looking back for computing the recommendations.", "readOnly": true }, "lookBackPeriod": { "$ref": "#/definitions/LookBackPeriod", "description": "The number of days of usage evaluated for computing the recommendations." }, "totalHours": { "type": "integer", "format": "int32", "description": "The total hours for which the cost is covered. Its equal to number of records in a property 'properties/usage/charges'.", "readOnly": true }, "usage": { "$ref": "#/definitions/recommendationUsageDetails", "description": "On-demand charges between firstConsumptionDate and lastConsumptionDate that were used for computing benefit recommendations." }, "armSkuName": { "type": "string", "description": "ARM SKU name. 'Compute_Savings_Plan' for SavingsPlan.", "readOnly": true }, "term": { "$ref": "#/definitions/Term", "description": "Term period of the benefit. For example, P1Y or P3Y." }, "commitmentGranularity": { "$ref": "#/definitions/Grain", "description": "Grain of the proposed commitment amount. Supported values: 'Hourly'" }, "currencyCode": { "type": "string", "description": "An ISO 4217 currency code identifier for the costs and savings amounts.", "readOnly": true }, "costWithoutBenefit": { "type": "number", "format": "decimal", "description": "The current cost without benefit, corresponds to 'totalHours' in the look-back period.", "readOnly": true }, "recommendationDetails": { "$ref": "#/definitions/allSavingsBenefitDetails", "description": "The details of the proposed recommendation." }, "allRecommendationDetails": { "$ref": "#/definitions/allSavingsList", "description": "The list of all benefit recommendations with the recommendation details.", "readOnly": true }, "scope": { "$ref": "#/definitions/Scope", "description": "Benefit scope. For example, Single or Shared." } }, "discriminator": "scope", "required": [ "scope" ] }, "benefitRecommendationsListResult": { "type": "object", "description": "Result of listing benefit recommendations.", "properties": { "value": { "type": "array", "description": "The list of benefit recommendations.", "items": { "$ref": "#/definitions/benefitRecommendationModel" }, "readOnly": true }, "nextLink": { "type": "string", "description": "The link (url) to the next page of results." } } }, "managementGroupScopeBenefitRecommendationProperties": { "type": "object", "description": "The properties of the benefit recommendation when scope is 'ManagementGroup'.", "properties": { "managementGroupId": { "type": "string", "description": "Fully-qualified identifier of the management group that this management group scope recommendation is for, of the format /providers/Microsoft.Management/managementGroups/{managementGroupId}. Applicable only if recommendation is for 'ManagementGroup' scope.", "readOnly": true }, "tenantId": { "type": "string", "description": "The tenant ID associated with the management group. Populated only when managementGroupId is populated.", "readOnly": true } }, "allOf": [ { "$ref": "#/definitions/benefitRecommendationProperties" } ], "x-ms-discriminator-value": "ManagementGroup" }, "recommendationUsageDetails": { "type": "object", "description": "On-demand charges between firstConsumptionDate and lastConsumptionDate that were used for computing benefit recommendations.", "properties": { "usageGrain": { "$ref": "#/definitions/Grain", "description": "The grain of the usage. Supported values: 'Hourly'" }, "charges": { "type": "array", "description": "On-demand charges for each hour between firstConsumptionDate and lastConsumptionDate that were used for computing benefit recommendations.", "items": { "type": "number", "format": "decimal" }, "readOnly": true } } }, "sharedScopeBenefitRecommendationProperties": { "type": "object", "description": "The properties of the benefit recommendation when scope is 'Shared'.", "allOf": [ { "$ref": "#/definitions/benefitRecommendationProperties" } ], "x-ms-discriminator-value": "Shared" }, "singleScopeBenefitRecommendationProperties": { "type": "object", "description": "The properties of the benefit recommendations when scope is 'Single'.", "properties": { "subscriptionId": { "type": "string", "description": "The subscription ID that this single scope recommendation is for. Applicable only if recommendation is for 'Single' scope.", "readOnly": true }, "resourceGroup": { "type": "string", "description": "The resource group that this single scope recommendation is for. Applicable only if recommendation is for 'Single' scope and 'ResourceGroup' request scope.", "readOnly": true } }, "allOf": [ { "$ref": "#/definitions/benefitRecommendationProperties" } ], "x-ms-discriminator-value": "Single" } }, "parameters": {} }