diff --git a/specification/cost-management/cspell.yaml b/specification/cost-management/cspell.yaml index 7e54c2ce15fc..814db779eaf0 100644 --- a/specification/cost-management/cspell.yaml +++ b/specification/cost-management/cspell.yaml @@ -33,8 +33,14 @@ overrides: words: - unitof - filename: >- - **/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/costmanagement.pricesheets.json + **/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/openapi.json words: - unitofmeasure - unitof - + - Unitof + - filename: >- + **/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/models.tsp + words: + - unitofmeasure + - unitof + - Unitof diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/Alert.tsp b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/Alert.tsp new file mode 100644 index 000000000000..1c1ec3e64287 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/Alert.tsp @@ -0,0 +1,86 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/openapi"; +import "@typespec/rest"; +import "./models.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; +using TypeSpec.OpenAPI; + +namespace Microsoft.CostManagement; +/** + * An individual alert. + */ +model Alert is Azure.ResourceManager.ExtensionResource { + ...ResourceNameParameter< + Resource = Alert, + KeyName = "alertId", + SegmentName = "alerts", + NamePattern = "" + >; + + /** + * 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. + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + eTag?: Azure.Core.eTag; +} + +@armResourceOperations +interface AlertsOps + extends Azure.ResourceManager.Legacy.ExtensionOperations< + { + ...ApiVersionParameter, + + /** 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. */ + @path(#{ allowReserved: true }) + scope: string, + + ...Azure.ResourceManager.Legacy.Provider, + }, + {}, + {} + > {} + +@armResourceOperations +interface Alerts { + /** + * Gets the alert for the scope by alert ID. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/costmanagement/") + get is Extension.Read; + + /** + * Dismisses the specified alert + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @patch(#{ implicitOptionality: false }) + @externalDocs("https://docs.microsoft.com/en-us/rest/api/costmanagement/") + dismiss is Extension.CustomPatchSync< + Extension.ScopeParameter, + Alert, + PatchModel = DismissAlertPayload, + Error = ErrorResponse + >; + + /** + * Lists the alerts for scope defined. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/costmanagement/") + list is AlertsOps.ListSinglePage< + Alert, + Response = ArmResponse, + ErrorType = ErrorResponse + >; +} + +@@doc(Alert.name, "Alert ID"); +@@doc(Alert.properties, "Alert properties."); +@@doc(Alerts.dismiss::parameters.properties, + "Parameters supplied to the Dismiss Alert operation." +); +@@path(Alert.name, #{ allowReserved: true }); diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/Budget.tsp b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/Budget.tsp new file mode 100644 index 000000000000..58e86db7644a --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/Budget.tsp @@ -0,0 +1,94 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/openapi"; +import "@typespec/rest"; +import "./models.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; +using TypeSpec.OpenAPI; + +namespace Microsoft.CostManagement; +/** + * A budget resource. + */ +model Budget is Azure.ResourceManager.ExtensionResource { + ...ResourceNameParameter< + Resource = Budget, + KeyName = "budgetName", + SegmentName = "budgets", + NamePattern = "^[a-zA-Z0-9_-]+$" + >; + + /** + * 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. + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + eTag?: Azure.Core.eTag; +} + +@armResourceOperations +interface Budgets { + /** + * Gets the budget for the scope by budget name. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/CostManagement/") + get is Extension.Read< + Extension.ScopeParameter, + Budget, + Error = ErrorResponse + >; + + /** + * 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. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/CostManagement/") + createOrUpdate is Extension.CreateOrReplaceSync< + Extension.ScopeParameter, + Budget, + Error = ErrorResponse + >; + + /** + * The operation to delete a budget. + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-delete-operation-response-codes" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/CostManagement/") + delete is Extension.DeleteSync< + Extension.ScopeParameter, + Budget, + Response = ArmDeletedResponse, + Error = ErrorResponse + >; + + /** + * Lists all budgets for the defined scope. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/CostManagement/") + list is Extension.ListByTarget< + Extension.ScopeParameter, + Budget, + Parameters = { + /** + * OData filter option. May be used to filter budgets by properties/category. The filter supports 'eq' only. + */ + @query("$filter") + $filter?: string; + }, + Response = ArmResponse, + Error = ErrorResponse + >; +} + +@@maxLength(Budget.name, 63); +@@minLength(Budget.name, 1); +@@doc(Budget.name, "Budget Name."); +@@doc(Budget.properties, "The properties of the budget."); +@@doc(Budgets.createOrUpdate::parameters.resource, + "Parameters supplied to the Create Budget operation." +); diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/CostAllocationRuleDefinition.tsp b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/CostAllocationRuleDefinition.tsp new file mode 100644 index 000000000000..c6b79dd5bc6c --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/CostAllocationRuleDefinition.tsp @@ -0,0 +1,83 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/openapi"; +import "@typespec/rest"; +import "./models.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; +using TypeSpec.OpenAPI; + +namespace Microsoft.CostManagement; +/** + * The cost allocation rule model definition + */ +@tenantResource +model CostAllocationRuleDefinition + is Azure.ResourceManager.ProxyResource { + ...ResourceNameParameter< + Resource = CostAllocationRuleDefinition, + KeyName = "ruleName", + SegmentName = "costAllocationRules", + NamePattern = "[A-Za-z0-9\\-_]+" + >; +} + +alias CostAllocationRuleDefinitionsOps = Extension.ExternalResource< + "microsoft.Billing", + "billingAccounts", + "billingAccountId", + Description = "BillingAccount ID", + ParentType = "Tenant" +>; + +@armResourceOperations +interface CostAllocationRuleDefinitions { + /** + * Get a cost allocation rule by rule name and billing account or enterprise enrollment. + */ + get is Extension.Read< + CostAllocationRuleDefinitionsOps, + CostAllocationRuleDefinition, + Error = ErrorResponse + >; + + /** + * Create/Update a rule to allocate cost between different resources within a billing account or enterprise enrollment. + */ + createOrUpdate is Extension.CreateOrReplaceSync< + CostAllocationRuleDefinitionsOps, + CostAllocationRuleDefinition, + Error = ErrorResponse + >; + + /** + * Delete cost allocation rule for billing account or enterprise enrollment. + */ + delete is Extension.DeleteSync< + CostAllocationRuleDefinitionsOps, + CostAllocationRuleDefinition, + Error = ErrorResponse + >; + + /** + * Get the list of all cost allocation rules for a billing account or enterprise enrollment. + */ + list is Extension.ListByTarget< + CostAllocationRuleDefinitionsOps, + CostAllocationRuleDefinition, + Response = ArmResponse, + Error = ErrorResponse + >; +} + +@@doc(CostAllocationRuleDefinition.name, + "Cost allocation rule name. The name cannot include spaces or any non alphanumeric characters other than '_' and '-'. The max length is 260 characters." +); +@@doc(CostAllocationRuleDefinition.properties, + "Cost allocation rule properties" +); +@@doc(CostAllocationRuleDefinitions.createOrUpdate::parameters.resource, + "Cost allocation rule to be created or updated" +); diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/Export.tsp b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/Export.tsp new file mode 100644 index 000000000000..db9f44dd1c99 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/Export.tsp @@ -0,0 +1,160 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/openapi"; +import "@typespec/rest"; +import "./models.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; +using TypeSpec.OpenAPI; + +namespace Microsoft.CostManagement; +/** + * An export resource. + */ +model Export is Azure.ResourceManager.ExtensionResource { + ...ResourceNameParameter< + Resource = Export, + KeyName = "exportName", + SegmentName = "exports", + NamePattern = "" + >; + + /** + * The managed identity associated with Export + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + identity?: Azure.ResourceManager.CommonTypes.SystemAssignedServiceIdentity; + + /** + * The location of the Export's managed identity. Only required when utilizing managed identity. + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @visibility(Lifecycle.Read, Lifecycle.Create) + location?: string; + + /** + * 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. + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + eTag?: Azure.Core.eTag; +} + +@armResourceOperations +interface ExportsOps + extends Azure.ResourceManager.Legacy.ExtensionOperations< + { + ...ApiVersionParameter, + + /** 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. */ + @path(#{ allowReserved: true }) + scope: string, + + ...Azure.ResourceManager.Legacy.Provider, + }, + {}, + {} + > {} + +@armResourceOperations +interface Exports { + /** + * The operation to get the export for the defined scope by export name. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/costmanagement/") + get is Extension.Read< + Extension.ScopeParameter, + Export, + Parameters = { + /** + * 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. + */ + @query("$expand") + $expand?: string; + }, + Error = ErrorResponse + >; + + /** + * 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. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/costmanagement/") + createOrUpdate is Extension.CreateOrReplaceSync< + Extension.ScopeParameter, + Export, + Error = ErrorResponse + >; + + /** + * The operation to delete a export. + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-delete-operation-response-codes" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/costmanagement/") + delete is Extension.DeleteSync< + Extension.ScopeParameter, + Export, + Response = ArmDeletedResponse, + Error = ErrorResponse + >; + + /** + * The operation to list all exports at the given scope. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/costmanagement/") + list is ExportsOps.ListSinglePage< + Export, + Parameters = { + /** + * 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. + */ + @query("$expand") + $expand?: string; + }, + Response = ArmResponse, + ErrorType = ErrorResponse + >; + + /** + * The operation to run an export. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @action("run") + @externalDocs("https://docs.microsoft.com/en-us/rest/api/costmanagement/") + execute is Extension.ActionSync< + Extension.ScopeParameter, + Export, + ExportRunRequest, + OkResponse, + OptionalRequestBody = true, + Error = ErrorResponse + >; + + /** + * The operation to get the run history of an export for the defined scope and export name. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @get + @action("runHistory") + @externalDocs("https://docs.microsoft.com/en-us/rest/api/costmanagement/") + getExecutionHistory is Extension.ActionSync< + Extension.ScopeParameter, + Export, + void, + ArmResponse, + Error = ErrorResponse + >; +} + +@@doc(Export.name, "Export Name."); +@@doc(Export.properties, "The properties of the export."); +@@doc(Exports.createOrUpdate::parameters.resource, + "Parameters supplied to the CreateOrUpdate Export operation." +); +@@doc(Exports.execute::parameters.body, + "Parameters supplied to the Execute Export operation." +); diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/GenerateDetailedCostReportOperationResult.tsp b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/GenerateDetailedCostReportOperationResult.tsp new file mode 100644 index 000000000000..d69805ac6c53 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/GenerateDetailedCostReportOperationResult.tsp @@ -0,0 +1,47 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/openapi"; +import "@typespec/rest"; +import "./models.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; +using TypeSpec.OpenAPI; + +namespace Microsoft.CostManagement; +/** + * The result of the long running operation for cost detailed report. + */ +model GenerateDetailedCostReportOperationResult + is Azure.ResourceManager.ExtensionResource { + ...ResourceNameParameter< + Resource = GenerateDetailedCostReportOperationResult, + KeyName = "operationId", + SegmentName = "operationResults", + NamePattern = "" + >; +} + +@armResourceOperations +interface GenerateDetailedCostReportOperationResults { + /** + * Gets the result of the specified operation. The link with this operationId is provided as a response header of the initial request. + */ + #suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-resource-manager/lro-location-header" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @Azure.ClientGenerator.Core.Legacy.markAsLro + get is Extension.Read< + Extension.ScopeParameter, + GenerateDetailedCostReportOperationResult, + Response = ArmResponse | ArmAcceptedResponse, + Error = ErrorResponse + >; +} + +@@doc(GenerateDetailedCostReportOperationResult.name, + "The target operation Id." +); +@@doc(GenerateDetailedCostReportOperationResult.properties, + "The properties of the resource generated." +); diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/GenerateDetailedCostReportOperationStatuses.tsp b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/GenerateDetailedCostReportOperationStatuses.tsp new file mode 100644 index 000000000000..a686aaf5edd0 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/GenerateDetailedCostReportOperationStatuses.tsp @@ -0,0 +1,67 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/openapi"; +import "@typespec/rest"; +import "./models.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; +using TypeSpec.OpenAPI; + +namespace Microsoft.CostManagement; +/** + * The status of the long running operation for cost detailed report. + */ +model GenerateDetailedCostReportOperationStatuses + is Azure.ResourceManager.ExtensionResource { + ...ResourceNameParameter< + Resource = GenerateDetailedCostReportOperationStatuses, + KeyName = "operationId", + SegmentName = "operationStatus", + NamePattern = "" + >; + + /** + * The status of the long running operation. + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + status?: Status; + + /** + * The startTime of the operation. + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + startTime?: string; + + /** + * The endTime of the operation. + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + endTime?: string; + + /** + * The details of the error. + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + error?: ErrorDetails; +} + +@armResourceOperations +interface GenerateDetailedCostReportOperationStatus { + /** + * Get the status of the specified operation. This link is provided in the GenerateDetailedCostReport creation request response header. + */ + get is Extension.Read< + Extension.ScopeParameter, + GenerateDetailedCostReportOperationStatuses, + Error = ErrorResponse + >; +} + +@@doc(GenerateDetailedCostReportOperationStatuses.name, + "The target operation Id." +); +@@doc(GenerateDetailedCostReportOperationStatuses.properties, + "The properties of the usage file generated." +); diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/ScheduledAction.tsp b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/ScheduledAction.tsp new file mode 100644 index 000000000000..208df2a7fbb2 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/ScheduledAction.tsp @@ -0,0 +1,232 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/openapi"; +import "@typespec/rest"; +import "./models.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; +using TypeSpec.OpenAPI; + +namespace Microsoft.CostManagement; +/** + * Scheduled action definition. + */ +@tenantResource +model ScheduledAction + is Azure.ResourceManager.ProxyResource { + ...ResourceNameParameter< + Resource = ScheduledAction, + KeyName = "name", + SegmentName = "scheduledActions", + NamePattern = "" + >; + + /** + * 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. + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + eTag?: Azure.Core.eTag; + + /** + * Kind of the scheduled action. + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + kind?: ScheduledActionKind; +} + +@armResourceOperations +interface ScheduledActionOps + extends Azure.ResourceManager.Legacy.ExtensionOperations< + { + ...ApiVersionParameter, + + /** the provider namespace */ + @path + @segment("providers") + @key + providerNamespace: "Microsoft.CostManagement", + }, + {}, + { + /** Scheduled action name. */ + @path + @segment("scheduledActions") + @key + name: string, + } + > {} + +@armResourceOperations +interface ScheduledActions { + /** + * Get the private scheduled action by name. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/rest/api/cost-management/") + get is ScheduledActionOps.Read< + ScheduledAction, + ErrorType = ErrorResponseWithNestedDetails + >; + + /** + * Create or update a private scheduled action. + */ + createOrUpdate is ScheduledActionOps.CreateOrUpdateSync< + ScheduledAction, + Parameters = { + /** + * ETag of the Entity. Not required when creating an entity. Optional when updating an entity and can be specified to achieve optimistic concurrency. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`?: string; + }, + ErrorType = ErrorResponseWithNestedDetails + >; + + /** + * Delete a private scheduled action. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/rest/api/cost-management/") + delete is ScheduledActionOps.DeleteSync< + ScheduledAction, + ErrorType = ErrorResponseWithNestedDetails + >; + + /** + * List all private scheduled actions. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/rest/api/cost-management/") + list is ScheduledActionOps.List< + ScheduledAction, + Parameters = { + /** + * May be used to filter scheduled actions by properties/viewId. Supported operator is 'eq'. + */ + @query("$filter") + $filter?: string; + }, + Response = ScheduledActionListResult, + ErrorType = ErrorResponseWithNestedDetails + >; + + /** + * Processes a private scheduled action. + */ + @action("execute") + run is ScheduledActionOps.ActionSync< + ScheduledAction, + void, + OkResponse, + ErrorType = ErrorResponseWithNestedDetails + >; +} + +@armResourceOperations +interface ScheduledActionOperationGroupOps + extends Azure.ResourceManager.Legacy.ExtensionOperations< + { + ...ApiVersionParameter, + + /** undefined */ + @path + @segment("") + @key + scope: string, + + /** the provider namespace */ + @path + @segment("providers") + @key + providerNamespace: "Microsoft.CostManagement", + }, + {}, + { + /** Scheduled action name. */ + @path + @segment("scheduledActions") + @key + name: string, + } + > {} + +@armResourceOperations +interface ScheduledActionOperationGroup { + /** + * Get the shared scheduled action from the given scope by name. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/rest/api/cost-management/") + getByScope is ScheduledActionOperationGroupOps.Read< + ScheduledAction, + ErrorType = ErrorResponseWithNestedDetails + >; + + /** + * Create or update a shared scheduled action within the given scope. + */ + createOrUpdateByScope is ScheduledActionOperationGroupOps.CreateOrUpdateSync< + ScheduledAction, + Parameters = { + /** + * ETag of the Entity. Not required when creating an entity. Optional when updating an entity and can be specified to achieve optimistic concurrency. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`?: string; + }, + ErrorType = ErrorResponseWithNestedDetails + >; + + /** + * Delete a scheduled action within the given scope. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/rest/api/cost-management/") + deleteByScope is ScheduledActionOperationGroupOps.DeleteSync< + ScheduledAction, + ErrorType = ErrorResponseWithNestedDetails + >; + + /** + * List all shared scheduled actions within the given scope. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/rest/api/cost-management/") + listByScope is ScheduledActionOperationGroupOps.List< + ScheduledAction, + Parameters = { + /** + * May be used to filter scheduled actions by properties/viewId. Supported operator is 'eq'. + */ + @query("$filter") + $filter?: string; + }, + Response = ScheduledActionListResult, + ErrorType = ErrorResponseWithNestedDetails + >; + + /** + * Runs a shared scheduled action within the given scope. + */ + @action("execute") + runByScope is ScheduledActionOperationGroupOps.ActionSync< + ScheduledAction, + void, + OkResponse, + ErrorType = ErrorResponseWithNestedDetails + >; +} + +@@doc(ScheduledAction.name, "Scheduled action name."); +@@doc(ScheduledAction.properties, "The properties of the scheduled action."); +@@doc(ScheduledActions.createOrUpdate::parameters.resource, + "Scheduled action to be created or updated." +); +@@doc(ScheduledActionOperationGroup.createOrUpdateByScope::parameters.resource, + "Scheduled action to be created or updated." +); diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/Setting.tsp b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/Setting.tsp new file mode 100644 index 000000000000..73a97efdd46c --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/Setting.tsp @@ -0,0 +1,97 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/openapi"; +import "@typespec/rest"; +import "./models.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; +using TypeSpec.OpenAPI; + +namespace Microsoft.CostManagement; +// FIXME: Setting has no properties property +/** + * Setting definition. + */ +@discriminator("kind") +model Setting + is Azure.ResourceManager.Legacy.DiscriminatedProxyResource { + ...ResourceNameParameter< + Resource = Setting, + KeyName = "type", + SegmentName = "settings", + NamePattern = "", + Type = SettingType + >; +} + +@armResourceOperations +interface SettingsOps + extends Azure.ResourceManager.Legacy.ExtensionOperations< + { + ...ApiVersionParameter, + + /** undefined */ + @path + @key + scope: string, + + /** the provider namespace */ + @path + @segment("providers") + @key + providerNamespace: "Microsoft.CostManagement", + }, + {}, + { + /** + * Setting type. + */ + @path + @key + @segment("settings") + type: SettingType, + } + > {} + +@armResourceOperations +interface Settings { + /** + * Get the setting from the given scope by name. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/rest/api/cost-management/") + getByScope is SettingsOps.Read; + + /** + * Create or update a setting within the given scope. + */ + createOrUpdateByScope is SettingsOps.CreateOrUpdateSync< + Setting, + ErrorType = ErrorResponse + >; + + /** + * Delete a setting within the given scope. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/rest/api/cost-management/") + deleteByScope is SettingsOps.DeleteSync; + + /** + * List all cost management settings in the requested scope. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/rest/api/cost-management/") + list is SettingsOps.List< + Setting, + Response = ArmResponse, + ErrorType = ErrorResponse + >; +} + +@@doc(Setting.name, "Setting type."); +@@doc(Settings.createOrUpdateByScope::parameters.resource, + "Setting to be created or updated." +); diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/View.tsp b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/View.tsp new file mode 100644 index 000000000000..f6c93152c9c2 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/View.tsp @@ -0,0 +1,164 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/openapi"; +import "@typespec/rest"; +import "./models.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; +using TypeSpec.OpenAPI; + +namespace Microsoft.CostManagement; +/** + * States and configurations of Cost Analysis. + */ +@tenantResource +model View is Azure.ResourceManager.ProxyResource { + ...ResourceNameParameter< + Resource = View, + KeyName = "viewName", + SegmentName = "views", + NamePattern = "" + >; + + /** + * 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. + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + eTag?: Azure.Core.eTag; +} + +@armResourceOperations +interface ViewOps + extends Azure.ResourceManager.Legacy.ExtensionOperations< + { + ...ApiVersionParameter, + + /** the provider namespace */ + @path + @segment("providers") + @key + providerNamespace: "Microsoft.CostManagement", + }, + {}, + { + /** View name */ + @path + @segment("views") + @key + viewName: string, + } + > {} + +@armResourceOperations +interface Views { + /** + * Gets the view by view name. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/costmanagement/") + get is ViewOps.Read; + + /** + * 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. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/costmanagement/") + createOrUpdate is ViewOps.CreateOrUpdateSync; + + /** + * The operation to delete a view. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/costmanagement/") + delete is ViewOps.DeleteSync; + + /** + * Lists all views by tenant and object. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/costmanagement/") + list is ViewOps.List< + View, + Response = ViewListResult, + ErrorType = ErrorResponse + >; +} +@armResourceOperations +interface ViewOperationGroupOps + extends Azure.ResourceManager.Legacy.ExtensionOperations< + { + ...ApiVersionParameter, + + /** undefined */ + @path + @segment("") + @key + scope: string, + + /** the provider namespace */ + @path + @segment("providers") + @key + providerNamespace: "Microsoft.CostManagement", + }, + {}, + { + /** View name */ + @path + @segment("views") + @key + viewName: string, + } + > {} + +@armResourceOperations +interface ViewOperationGroup { + /** + * Gets the view for the defined scope by view name. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/costmanagement/") + getByScope is ViewOperationGroupOps.Read; + + /** + * 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. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/costmanagement/") + createOrUpdateByScope is ViewOperationGroupOps.CreateOrUpdateSync< + View, + ErrorType = ErrorResponse + >; + + /** + * The operation to delete a view. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/costmanagement/") + deleteByScope is ViewOperationGroupOps.DeleteSync< + View, + ErrorType = ErrorResponse + >; + + /** + * Lists all views at the given scope. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/rest/api/costmanagement/") + listByScope is ViewOperationGroupOps.List< + View, + Response = ViewListResult, + ErrorType = ErrorResponse + >; +} + +@@doc(View.name, "View name"); +@@doc(View.properties, "The properties of the view."); +@@doc(Views.createOrUpdate::parameters.resource, + "Parameters supplied to the CreateOrUpdate View operation." +); +@@doc(ViewOperationGroup.createOrUpdateByScope::parameters.resource, + "Parameters supplied to the CreateOrUpdate View operation." +); diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/back-compatible.tsp b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/back-compatible.tsp new file mode 100644 index 000000000000..f1ed1d017c4a --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/back-compatible.tsp @@ -0,0 +1,235 @@ +import "@azure-tools/typespec-client-generator-core"; + +using Azure.ClientGenerator.Core; +using Microsoft.CostManagement; + +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(ExportRun.properties); + +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(ReportManifest.requestContext +); + +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(ViewProperties.query); + +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(DismissAlertPayload.properties +); + +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(ForecastResult.properties); + +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(Dimension.properties); + +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(QueryResult.properties); + +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(OperationStatus.properties); + +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(IncludedQuantityUtilizationSummary.properties +); + +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(SavingsPlanUtilizationSummary.properties +); + +@@clientLocation(CostAllocationRuleDefinitions.get, "CostAllocationRules"); +@@clientLocation(CostAllocationRuleDefinitions.createOrUpdate, + "CostAllocationRules" +); +@@clientName(CostAllocationRuleDefinitions.createOrUpdate::parameters.resource, + "costAllocationRule" +); +@@clientLocation(CostAllocationRuleDefinitions.delete, "CostAllocationRules"); +@@clientLocation(CostAllocationRuleDefinitions.list, "CostAllocationRules"); + +@@clientName(Budgets.createOrUpdate::parameters.resource, "parameters"); +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(Budget.properties); + +@@clientName(Exports.createOrUpdate::parameters.resource, "parameters"); +@@clientName(Exports.execute::parameters.body, "parameters"); +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(Export.properties); + +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(CostDetailsOperationResults.manifest +); + +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(GenerateDetailedCostReportOperationResult.properties +); + +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(GenerateDetailedCostReportOperationStatuses.properties +); + +@@clientName(Views.createOrUpdate::parameters.resource, "parameters"); +@@clientLocation(ViewOperationGroup.getByScope, Views); +@@clientLocation(ViewOperationGroup.createOrUpdateByScope, Views); +@@clientName(ViewOperationGroup.createOrUpdateByScope::parameters.resource, + "parameters" +); +@@clientLocation(ViewOperationGroup.deleteByScope, Views); +@@clientLocation(ViewOperationGroup.listByScope, Views); +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(View.properties); + +@@clientName(Alerts.dismiss::parameters.properties, "parameters"); +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(Alert.properties); + +@@clientName(ScheduledActions.createOrUpdate::parameters.resource, + "scheduledAction" +); +@@clientLocation(ScheduledActionOperationGroup.getByScope, ScheduledActions); +@@clientLocation(ScheduledActionOperationGroup.createOrUpdateByScope, + ScheduledActions +); +@@clientName(ScheduledActionOperationGroup.createOrUpdateByScope::parameters.resource, + "scheduledAction" +); +@@clientLocation(ScheduledActionOperationGroup.deleteByScope, ScheduledActions); +@@clientLocation(ScheduledActionOperationGroup.listByScope, ScheduledActions); +@@clientLocation(ScheduledActionOperationGroup.runByScope, ScheduledActions); +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(ScheduledAction.properties); + +@@clientName(Settings.createOrUpdateByScope::parameters.resource, "setting"); + +@@clientLocation(CostAllocationRulesOperationGroup.checkNameAvailability, + "CostAllocationRules" +); + +@@clientLocation(BenefitRecommendationsOperationGroup.list, + "BenefitRecommendations" +); + +@@clientLocation(BenefitUtilizationSummariesOperationGroup.listByBillingAccountId, + "BenefitUtilizationSummaries" +); +@@clientLocation(BenefitUtilizationSummariesOperationGroup.listByBillingProfileId, + "BenefitUtilizationSummaries" +); +@@clientLocation(BenefitUtilizationSummariesOperationGroup.listBySavingsPlanOrder, + "BenefitUtilizationSummaries" +); +@@clientLocation(BenefitUtilizationSummariesOperationGroup.listBySavingsPlanId, + "BenefitUtilizationSummaries" +); + +@@clientLocation(GenerateBenefitUtilizationSummariesReportOperationGroup.generateByBillingAccount, + "GenerateBenefitUtilizationSummariesReport" +); +@@clientLocation(GenerateBenefitUtilizationSummariesReportOperationGroup.generateByBillingProfile, + "GenerateBenefitUtilizationSummariesReport" +); +@@clientLocation(GenerateBenefitUtilizationSummariesReportOperationGroup.generateByReservationOrderId, + "GenerateBenefitUtilizationSummariesReport" +); +@@clientLocation(GenerateBenefitUtilizationSummariesReportOperationGroup.generateByReservationId, + "GenerateBenefitUtilizationSummariesReport" +); +@@clientLocation(GenerateBenefitUtilizationSummariesReportOperationGroup.generateBySavingsPlanOrderId, + "GenerateBenefitUtilizationSummariesReport" +); +@@clientLocation(GenerateBenefitUtilizationSummariesReportOperationGroup.generateBySavingsPlanId, + "GenerateBenefitUtilizationSummariesReport" +); + +@@clientLocation(GenerateCostDetailsReportOperationGroup.createOperation, + GenerateCostDetailsReport +); + +@@clientLocation(GenerateDetailedCostReportOperationGroup.createOperation, + "GenerateDetailedCostReport" +); + +@@clientLocation(AlertsOperationGroup.listExternal, Alerts); + +@@clientLocation(ForecastOperationGroup.usage, "Forecast"); +@@clientLocation(ForecastOperationGroup.externalCloudProviderUsage, "Forecast"); + +@@clientLocation(DimensionsOperationGroup.list, "Dimensions"); +@@clientLocation(DimensionsOperationGroup.byExternalCloudProviderType, + "Dimensions" +); + +@@clientLocation(QueryOperationGroup.usage, "Query"); +@@clientLocation(QueryOperationGroup.usageByExternalCloudProviderType, "Query"); + +@@clientLocation(GenerateReservationDetailsReportOperationGroup.byBillingAccountId, + "GenerateReservationDetailsReport" +); +@@clientLocation(GenerateReservationDetailsReportOperationGroup.byBillingProfileId, + "GenerateReservationDetailsReport" +); + +@@clientLocation(PriceSheetOperationGroup.downloadByInvoice, "PriceSheet"); +@@clientLocation(PriceSheetOperationGroup.downloadByBillingProfile, + "PriceSheet" +); +@@clientLocation(PriceSheetOperationGroup.downloadByBillingAccount, + "PriceSheet" +); + +@@clientLocation(ScheduledActionsOperationGroup.checkNameAvailability, + ScheduledActions +); +@@clientLocation(ScheduledActionsOperationGroup.checkNameAvailabilityByScope, + ScheduledActions +); +@@clientName(BenefitRecommendationModel, "benefitRecommendationModel"); +@@clientName(GenerateBenefitUtilizationSummariesReportOperationGroup.generateByBillingProfile::parameters.body, + "benefitUtilizationSummariesRequest" +); +@@clientName(CostAllocationRulesOperationGroup.checkNameAvailability::parameters.body, + "costAllocationRuleCheckNameAvailabilityRequest" +); +@@clientName(GenerateBenefitUtilizationSummariesReportOperationGroup.generateByBillingAccount::parameters.body, + "benefitUtilizationSummariesRequest" +); +@@clientName(GenerateBenefitUtilizationSummariesReportOperationGroup.generateBySavingsPlanOrderId::parameters.body, + "benefitUtilizationSummariesRequest" +); +@@clientName(GenerateBenefitUtilizationSummariesReportOperationGroup.generateBySavingsPlanId::parameters.body, + "benefitUtilizationSummariesRequest" +); +@@clientName(GenerateBenefitUtilizationSummariesReportOperationGroup.generateByReservationOrderId::parameters.body, + "benefitUtilizationSummariesRequest" +); +@@clientName(GenerateBenefitUtilizationSummariesReportOperationGroup.generateByReservationId::parameters.body, + "benefitUtilizationSummariesRequest" +); +@@clientName(ForecastOperationGroup.externalCloudProviderUsage::parameters.body, + "parameters" +); +@@clientName(QueryOperationGroup.usageByExternalCloudProviderType::parameters.body, + "parameters" +); +@@clientName(ScheduledActionsOperationGroup.checkNameAvailability::parameters.body, + "checkNameAvailabilityRequest" +); +@@clientName(BenefitRecommendationProperties, + "benefitRecommendationProperties" +); +@@clientName(RecommendationUsageDetails, "recommendationUsageDetails"); +@@clientName(AllSavingsBenefitDetails, "allSavingsBenefitDetails"); +@@clientName(AllSavingsList, "allSavingsList"); +@@clientName(SharedScopeBenefitRecommendationProperties, + "sharedScopeBenefitRecommendationProperties" +); +@@clientName(SingleScopeBenefitRecommendationProperties, + "singleScopeBenefitRecommendationProperties" +); +@@visibility(Setting.kind, + Lifecycle.Create, + Lifecycle.Read, + Lifecycle.Update, + Lifecycle.Delete, + Lifecycle.Query +); diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/client.tsp b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/client.tsp new file mode 100644 index 000000000000..fdcb8a02413b --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/client.tsp @@ -0,0 +1,97 @@ +import "./main.tsp"; +import "@azure-tools/typespec-client-generator-core"; + +using Http; +using Azure.ClientGenerator.Core; +using Microsoft.CostManagement; + +// Rename PivotTypeType back to PivotType for Java +@@clientName(PivotTypeType, "PivotType", "java,javascript"); + +// Rename KpiTypeType back to KpiType for Java +@@clientName(KpiTypeType, "KpiType", "java,javascript"); + +// Rename DownloadURL back to DownloadUrl for Java +@@clientName(DownloadURL, "DownloadUrl", "java"); + +// Rename ReportURL back to ReportUrl for Java +@@clientName(ReportURL, "ReportUrl", "java"); + +// Rename statusModificationUserName back to statusModificationUsername for Java +@@clientName(AlertProperties.statusModificationUserName, + "statusModificationUsername", + "java" +); + +@@alternateType(AlertPropertiesDetails.tagFilter, unknown, "java"); + +// Rename eTag back to etag for Java (backward compatibility) +@@clientName(CostManagementProxyResource.eTag, "etag", "java"); +@@clientName(CostManagementResource.eTag, "etag", "java"); +@@clientName(View.eTag, "etag", "java"); +@@clientName(ScheduledAction.eTag, "etag", "java"); +@@clientName(Export.eTag, "etag", "java"); +@@clientName(Alert.eTag, "etag", "java"); + +@@clientName(Microsoft.CostManagement, "CostManagementClient", "python"); +@@clientName(Azure.ResourceManager.CommonTypes.ErrorResponse, + "ArmErrorResponse", + "python,javascript" +); +@@clientName(Term.P1Y, "P1_Y", "python"); +@@clientName(Term.P3Y, "P3_Y", "python"); + +#suppress "@azure-tools/typespec-azure-core/casing-style" "customization" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-operation" "customization" +#suppress "@azure-tools/typespec-azure-core/documentation-required" "override" +op GetGenerateDetailedCostReportOperationResultCustomized( + #suppress "@azure-tools/typespec-azure-core/documentation-required" "override" + @path + extensionProvider: "Microsoft.CostManagement", + + #suppress "@azure-tools/typespec-azure-core/documentation-required" "override" + @query("api-version") + apiVersion: string, + + #suppress "@azure-tools/typespec-azure-core/documentation-required" "override" + @path("operationId") + operationId: string, + + #suppress "@azure-tools/typespec-azure-core/documentation-required" "override" + @path(#{ allowReserved: true }) + scope: string, +): GenerateDetailedCostReportOperationResult; + +#suppress "@azure-tools/typespec-azure-core/casing-style" "customization" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-operation" "customization" +#suppress "@azure-tools/typespec-azure-core/documentation-required" "override" +op GetGenerateDetailedCostReportOperationStatusCustomized( + #suppress "@azure-tools/typespec-azure-core/documentation-required" "override" + @path + extensionProvider: "Microsoft.CostManagement", + + #suppress "@azure-tools/typespec-azure-core/documentation-required" "override" + @query("api-version") + apiVersion: string, + + #suppress "@azure-tools/typespec-azure-core/documentation-required" "override" + @path("operationId") + operationId: string, + + #suppress "@azure-tools/typespec-azure-core/documentation-required" "override" + @path(#{ allowReserved: true }) + scope: string, +): GenerateDetailedCostReportOperationStatus; + +@@override(GenerateDetailedCostReportOperationResults.get, + GetGenerateDetailedCostReportOperationResultCustomized, + "python,go,java,javascript" +); +@@override(GenerateDetailedCostReportOperationStatus.get, + GetGenerateDetailedCostReportOperationStatusCustomized, + "python,go,java,javascript" +); +@@clientName(DimensionsOperationGroup.byExternalCloudProviderType, + "listByExternalCloudProviderType", + "javascript" +); diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/BenefitRecommendationsByBillingAccount.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/BenefitRecommendationsByBillingAccount.json new file mode 100644 index 000000000000..54a381910860 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/BenefitRecommendationsByBillingAccount.json @@ -0,0 +1,124 @@ +{ + "parameters": { + "$expand": "properties/usage,properties/allRecommendationDetails", + "$filter": "properties/lookBackPeriod eq 'Last7Days' AND properties/term eq 'P1Y'", + "api-version": "2025-03-01", + "billingScope": "providers/Microsoft.Billing/billingAccounts/123456" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "00000000-0000-0000-0000-000000000000", + "type": "Microsoft.CostManagement/benefitRecommendations", + "id": "/providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/benefitRecommendations/00000000-0000-0000-0000-000000000000", + "kind": "SavingsPlan", + "properties": { + "allRecommendationDetails": { + "value": [ + { + "averageUtilizationPercentage": 99.33, + "benefitCost": 52.002, + "commitmentAmount": 0.164, + "coveragePercentage": 54.609, + "overageCost": 144.841, + "savingsAmount": 21.424, + "savingsPercentage": 9.815, + "totalCost": 196.843, + "wastageCost": 0.035 + }, + { + "averageUtilizationPercentage": 81.474, + "benefitCost": 83.754, + "commitmentAmount": 0.161, + "coveragePercentage": 56.748, + "overageCost": 120.389, + "savingsAmount": 14.124, + "savingsPercentage": 6.47, + "totalCost": 204.143, + "wastageCost": 0.1 + } + ] + }, + "armSkuName": "Compute_Savings_Plan", + "commitmentGranularity": "Hourly", + "costWithoutBenefit": 218.267, + "currencyCode": "USD", + "firstConsumptionDate": "2022-10-18T00:00:00Z", + "lastConsumptionDate": "2022-10-25T00:00:00Z", + "lookBackPeriod": "Last7Days", + "recommendationDetails": { + "averageUtilizationPercentage": 99.33, + "benefitCost": 52.002, + "commitmentAmount": 0.164, + "coveragePercentage": 54.609, + "overageCost": 144.841, + "savingsAmount": 21.424, + "savingsPercentage": 9.815, + "totalCost": 196.843, + "wastageCost": 0.035 + }, + "scope": "Shared", + "term": "P1Y", + "totalHours": 168, + "usage": { + "charges": [ + 1, + 1, + 0, + 1, + 1, + 1, + 1, + 1, + 1, + 1, + 1, + 1, + 1, + 1, + 1, + 1, + 1, + 1, + 1, + 1, + 1, + 1, + 1, + 1, + 1, + 1, + 1, + 1, + 1, + 1, + 1, + 1, + 1, + 1, + 1, + 1, + 1, + 1, + 1, + 1, + 1, + 1, + 2, + 2, + 2, + 2 + ], + "usageGrain": "Hourly" + } + } + } + ] + } + } + }, + "operationId": "BenefitRecommendations_List", + "title": "BenefitRecommendationsBillingAccountList" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/BenefitUtilizationSummaries/Async/GenerateBenefitUtilizationSummariesReportByBillingAccount.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/BenefitUtilizationSummaries/Async/GenerateBenefitUtilizationSummariesReportByBillingAccount.json new file mode 100644 index 000000000000..d10904aa1d15 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/BenefitUtilizationSummaries/Async/GenerateBenefitUtilizationSummariesReportByBillingAccount.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "benefitUtilizationSummariesRequest": { + "endDate": "2022-08-31T00:00:00Z", + "grain": "Daily", + "kind": "Reservation", + "startDate": "2022-06-01T00:00:00Z" + }, + "billingAccountId": "8099099" + }, + "responses": { + "200": { + "body": { + "input": { + "billingAccountId": "8099099", + "endDate": "2022-08-31T00:00:00Z", + "grain": "Daily", + "kind": "Reservation", + "startDate": "2022-06-01T00:00:00Z" + }, + "properties": { + "reportUrl": "https://storage.blob.core.windows.net/details/20220611/00000000-0000-0000-0000-000000000000?sv=2016-05-31&sr=b&sig=jep8HT2aphfUkyERRZa5LRfd9RPzjXbzB%2F9TNiQ", + "secondaryReportUrl": "https://storage-secondary.blob.core.windows.net/details/20220611/00000000-0000-0000-0000-000000000000?sv=2016-05-31&sr=b&sig=jep8HT2aphfUkyERRZa5LRfd9RPzjXbzB%2F9TNiQ", + "validUntil": "2022-06-12T02:56:55.5021869Z" + }, + "status": "Complete" + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/8099099/providers/Microsoft.CostManagement/benefitUtilizationSummariesOperationResults/cf9f95c9-af6b-41dd-a622-e6f4fc60c3ee?api-version=2025-03-01", + "Retry-After": "60" + } + } + }, + "operationId": "GenerateBenefitUtilizationSummariesReport_GenerateByBillingAccount", + "title": "GenerateUtilizationSummariesReportByBillingAccount" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/BenefitUtilizationSummaries/Async/GenerateBenefitUtilizationSummariesReportByBillingProfile.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/BenefitUtilizationSummaries/Async/GenerateBenefitUtilizationSummariesReportByBillingProfile.json new file mode 100644 index 000000000000..ca2bf5230bc2 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/BenefitUtilizationSummaries/Async/GenerateBenefitUtilizationSummariesReportByBillingProfile.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "benefitUtilizationSummariesRequest": { + "endDate": "2022-08-31T00:00:00Z", + "grain": "Daily", + "kind": "Reservation", + "startDate": "2022-06-01T00:00:00Z" + }, + "billingAccountId": "00000000-0000-0000-0000-000000000000", + "billingProfileId": "CZSFR-SDFXC-DSDF" + }, + "responses": { + "200": { + "body": { + "input": { + "billingAccountId": "00000000-0000-0000-0000-000000000000", + "billingProfileId": "CZSFR-SDFXC-DSDF", + "endDate": "2022-08-31T00:00:00Z", + "grain": "Daily", + "kind": "Reservation", + "startDate": "2022-06-01T00:00:00Z" + }, + "properties": { + "reportUrl": "https://storage.blob.core.windows.net/details/20220611/00000000-0000-0000-0000-000000000000?sv=2016-05-31&sr=b&sig=jep8HT2aphfUkyERRZa5LRfd9RPzjXbzB%2F9TNiQ", + "secondaryReportUrl": "https://storage-secondary.blob.core.windows.net/details/20220611/00000000-0000-0000-0000-000000000000?sv=2016-05-31&sr=b&sig=jep8HT2aphfUkyERRZa5LRfd9RPzjXbzB%2F9TNiQ", + "validUntil": "2022-06-12T02:56:55.5021869Z" + }, + "status": "Complete" + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000/billingProfiles/CZSFR-SDFXC-DSDF/providers/Microsoft.CostManagement/benefitUtilizationSummariesOperationResults/cf9f95c9-af6b-41dd-a622-e6f4fc60c3ee?api-version=2025-03-01", + "Retry-After": "60" + } + } + }, + "operationId": "GenerateBenefitUtilizationSummariesReport_GenerateByBillingProfile", + "title": "GenerateUtilizationSummariesReportByBillingProfile" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/BenefitUtilizationSummaries/Async/GenerateBenefitUtilizationSummariesReportByReservation.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/BenefitUtilizationSummaries/Async/GenerateBenefitUtilizationSummariesReportByReservation.json new file mode 100644 index 000000000000..5e1cd9bee47a --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/BenefitUtilizationSummaries/Async/GenerateBenefitUtilizationSummariesReportByReservation.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "benefitUtilizationSummariesRequest": { + "endDate": "2022-08-31T00:00:00Z", + "grain": "Daily", + "startDate": "2022-06-01T00:00:00Z" + }, + "reservationId": "00000000-0000-0000-0000-000000000000", + "reservationOrderId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "input": { + "benefitId": "00000000-0000-0000-0000-000000000000", + "benefitOrderId": "00000000-0000-0000-0000-000000000000", + "endDate": "2022-08-31T00:00:00Z", + "grain": "Daily", + "kind": "Reservation", + "startDate": "2022-06-01T00:00:00Z" + }, + "properties": { + "reportUrl": "https://storage.blob.core.windows.net/details/20220611/00000000-0000-0000-0000-000000000000?sv=2016-05-31&sr=b&sig=jep8HT2aphfUkyERRZa5LRfd9RPzjXbzB%2F9TNiQ", + "secondaryReportUrl": "https://storage-secondary.blob.core.windows.net/details/20220611/00000000-0000-0000-0000-000000000000?sv=2016-05-31&sr=b&sig=jep8HT2aphfUkyERRZa5LRfd9RPzjXbzB%2F9TNiQ", + "validUntil": "2022-06-12T02:56:55.5021869Z" + }, + "status": "Complete" + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/providers/Microsoft.Capacity/reservationorders/00000000-0000-0000-0000-000000000000/reservations/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/benefitUtilizationSummariesOperationResults/cf9f95c9-af6b-41dd-a622-e6f4fc60c3ee?api-version=2025-03-01", + "Retry-After": "60" + } + } + }, + "operationId": "GenerateBenefitUtilizationSummariesReport_GenerateByReservationId", + "title": "GenerateUtilizationSummariesReportByReservation" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/BenefitUtilizationSummaries/Async/GenerateBenefitUtilizationSummariesReportByReservationOrder.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/BenefitUtilizationSummaries/Async/GenerateBenefitUtilizationSummariesReportByReservationOrder.json new file mode 100644 index 000000000000..78d8796421a1 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/BenefitUtilizationSummaries/Async/GenerateBenefitUtilizationSummariesReportByReservationOrder.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "benefitUtilizationSummariesRequest": { + "endDate": "2022-08-31T00:00:00Z", + "grain": "Daily", + "startDate": "2022-06-01T00:00:00Z" + }, + "reservationOrderId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "input": { + "benefitOrderId": "00000000-0000-0000-0000-000000000000", + "endDate": "2022-08-31T00:00:00Z", + "grain": "Daily", + "kind": "Reservation", + "startDate": "2022-06-01T00:00:00Z" + }, + "properties": { + "reportUrl": "https://storage.blob.core.windows.net/details/20220611/00000000-0000-0000-0000-000000000000?sv=2016-05-31&sr=b&sig=jep8HT2aphfUkyERRZa5LRfd9RPzjXbzB%2F9TNiQ", + "secondaryReportUrl": "https://storage-secondary.blob.core.windows.net/details/20220611/00000000-0000-0000-0000-000000000000?sv=2016-05-31&sr=b&sig=jep8HT2aphfUkyERRZa5LRfd9RPzjXbzB%2F9TNiQ", + "validUntil": "2022-06-12T02:56:55.5021869Z" + }, + "status": "Complete" + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/providers/Microsoft.Capacity/reservationorders/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/benefitUtilizationSummariesOperationResults/cf9f95c9-af6b-41dd-a622-e6f4fc60c3ee?api-version=2025-03-01", + "Retry-After": "60" + } + } + }, + "operationId": "GenerateBenefitUtilizationSummariesReport_GenerateByReservationOrderId", + "title": "GenerateUtilizationSummariesReportByReservationOrder" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/BenefitUtilizationSummaries/Async/GenerateBenefitUtilizationSummariesReportBySavingsPlan.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/BenefitUtilizationSummaries/Async/GenerateBenefitUtilizationSummariesReportBySavingsPlan.json new file mode 100644 index 000000000000..953ebb99fc03 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/BenefitUtilizationSummaries/Async/GenerateBenefitUtilizationSummariesReportBySavingsPlan.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "benefitUtilizationSummariesRequest": { + "endDate": "2022-08-31T00:00:00Z", + "grain": "Daily", + "startDate": "2022-06-01T00:00:00Z" + }, + "savingsPlanId": "00000000-0000-0000-0000-000000000000", + "savingsPlanOrderId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "input": { + "benefitId": "00000000-0000-0000-0000-000000000000", + "benefitOrderId": "00000000-0000-0000-0000-000000000000", + "endDate": "2022-08-31T00:00:00Z", + "grain": "Daily", + "kind": "SavingsPlan", + "startDate": "2022-06-01T00:00:00Z" + }, + "properties": { + "reportUrl": "https://storage.blob.core.windows.net/details/20220611/00000000-0000-0000-0000-000000000000?sv=2016-05-31&sr=b&sig=jep8HT2aphfUkyERRZa5LRfd9RPzjXbzB%2F9TNiQ", + "secondaryReportUrl": "https://storage-secondary.blob.core.windows.net/details/20220611/00000000-0000-0000-0000-000000000000?sv=2016-05-31&sr=b&sig=jep8HT2aphfUkyERRZa5LRfd9RPzjXbzB%2F9TNiQ", + "validUntil": "2022-06-12T02:56:55.5021869Z" + }, + "status": "Complete" + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/providers/Microsoft.Capacity/savingsPlanOrders/00000000-0000-0000-0000-000000000000/savingsPlans/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/benefitUtilizationSummariesOperationResults/cf9f95c9-af6b-41dd-a622-e6f4fc60c3ee?api-version=2025-03-01", + "Retry-After": "60" + } + } + }, + "operationId": "GenerateBenefitUtilizationSummariesReport_GenerateBySavingsPlanId", + "title": "GenerateUtilizationSummariesReportBySavingsPlan" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/BenefitUtilizationSummaries/Async/GenerateBenefitUtilizationSummariesReportBySavingsPlanOrder.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/BenefitUtilizationSummaries/Async/GenerateBenefitUtilizationSummariesReportBySavingsPlanOrder.json new file mode 100644 index 000000000000..7458dfd3ce23 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/BenefitUtilizationSummaries/Async/GenerateBenefitUtilizationSummariesReportBySavingsPlanOrder.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "benefitUtilizationSummariesRequest": { + "endDate": "2022-08-31T00:00:00Z", + "grain": "Daily", + "startDate": "2022-06-01T00:00:00Z" + }, + "savingsPlanOrderId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "input": { + "benefitOrderId": "00000000-0000-0000-0000-000000000000", + "endDate": "2022-08-31T00:00:00Z", + "grain": "Daily", + "kind": "SavingsPlan", + "startDate": "2022-06-01T00:00:00Z" + }, + "properties": { + "reportUrl": "https://storage.blob.core.windows.net/details/20220611/00000000-0000-0000-0000-000000000000?sv=2016-05-31&sr=b&sig=jep8HT2aphfUkyERRZa5LRfd9RPzjXbzB%2F9TNiQ", + "secondaryReportUrl": "https://storage-secondary.blob.core.windows.net/details/20220611/00000000-0000-0000-0000-000000000000?sv=2016-05-31&sr=b&sig=jep8HT2aphfUkyERRZa5LRfd9RPzjXbzB%2F9TNiQ", + "validUntil": "2022-06-12T02:56:55.5021869Z" + }, + "status": "Complete" + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/providers/Microsoft.BillingBenefits/savingsPlanOrders/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/benefitUtilizationSummariesOperationResults/cf9f95c9-af6b-41dd-a622-e6f4fc60c3ee?api-version=2025-03-01", + "Retry-After": "60" + } + } + }, + "operationId": "GenerateBenefitUtilizationSummariesReport_GenerateBySavingsPlanOrderId", + "title": "GenerateUtilizationSummariesReportBySavingsPlanOrder" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/BenefitUtilizationSummaries/SavingsPlan-BillingAccount.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/BenefitUtilizationSummaries/SavingsPlan-BillingAccount.json new file mode 100644 index 000000000000..4ed3bcdcb7bc --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/BenefitUtilizationSummaries/SavingsPlan-BillingAccount.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "billingAccountId": "12345", + "filter": "properties/usageDate ge 2022-10-15 and properties/usageDate le 2022-10-18", + "grain": "Daily" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "66cccc66-6ccc-6c66-666c-66cc6c6c66c6_222d22dd-d2d2-2dd2-222d-2dd2222ddddd_20211116", + "type": "Microsoft.CostManagement/benefitUtilizationSummaries", + "id": "/providers/Microsoft.Billing/billingAccounts/12345/providers/Microsoft.CostManagement/benefitUtilizationSummaries/66cccc66-6ccc-6c66-666c-66cc6c6c66c6_222d22dd-d2d2-2dd2-222d-2dd2222ddddd_20211116", + "kind": "SavingsPlan", + "properties": { + "armSkuName": "Compute_Savings_Plan", + "avgUtilizationPercentage": 90, + "benefitId": "/providers/Microsoft.BillingBenefits/savingsPlanOrders/66cccc66-6ccc-6c66-666c-66cc6c6c66c6/savingsPlans/222d22dd-d2d2-2dd2-222d-2dd2222ddddd", + "benefitOrderId": "/providers/Microsoft.BillingBenefits/savingsPlanOrders/66cccc66-6ccc-6c66-666c-66cc6c6c66c6", + "benefitType": "SavingsPlan", + "maxUtilizationPercentage": 100, + "minUtilizationPercentage": 80, + "usageDate": "2022-10-16T00:00:00Z" + } + }, + { + "name": "88cccc88-8ccc-8c88-888c-88cc8c8c88c8_444d44dd-d4d4-4dd4-444d-4dd4444ddddd_20211117", + "type": "Microsoft.CostManagement/benefitUtilizationSummaries", + "id": "/providers/Microsoft.Billing/billingAccounts/12345/providers/Microsoft.CostManagement/benefitUtilizationSummaries/88cccc88-8ccc-8c88-888c-88cc8c8c88c8_444d44dd-d4d4-4dd4-444d-4dd4444ddddd_20211117", + "kind": "SavingsPlan", + "properties": { + "armSkuName": "Compute_Savings_Plan", + "avgUtilizationPercentage": 60, + "benefitId": "/providers/Microsoft.BillingBenefits/savingsPlanOrders/88cccc88-8ccc-8c88-888c-88cc8c8c88c8/savingsPlans/444d44dd-d4d4-4dd4-444d-4dd4444ddddd", + "benefitOrderId": "/providers/Microsoft.BillingBenefits/savingsPlanOrders/88cccc88-8ccc-8c88-888c-88cc8c8c88c8", + "benefitType": "SavingsPlan", + "maxUtilizationPercentage": 70, + "minUtilizationPercentage": 50, + "usageDate": "2022-10-17T00:00:00Z" + } + } + ] + } + } + }, + "operationId": "BenefitUtilizationSummaries_ListByBillingAccountId", + "title": "SavingsPlanUtilizationSummaries-BillingAccount" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/BenefitUtilizationSummaries/SavingsPlan-BillingProfile.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/BenefitUtilizationSummaries/SavingsPlan-BillingProfile.json new file mode 100644 index 000000000000..99f01b89571a --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/BenefitUtilizationSummaries/SavingsPlan-BillingProfile.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "billingAccountId": "c0a00000-0e04-5ee3-000e-f0c6e00000ec:c0a00000-0e04-5ee3-000e-f0c6e00000ec", + "billingProfileId": "200e5e90-000e-4960-8dcd-8d00a02db000", + "filter": "properties/usageDate ge 2022-10-15 and properties/usageDate le 2022-10-18", + "grain": "Daily" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "66cccc66-6ccc-6c66-666c-66cc6c6c66c6_222d22dd-d2d2-2dd2-222d-2dd2222ddddd_20211116", + "type": "Microsoft.CostManagement/benefitUtilizationSummaries", + "id": "/providers/Microsoft.Billing/billingAccounts/c0a00000-0e04-5ee3-000e-f0c6e00000ec:c0a00000-0e04-5ee3-000e-f0c6e00000ec/billingProfiles/200e5e90-000e-4960-8dcd-8d00a02db000/providers/Microsoft.CostManagement/benefitUtilizationSummaries/66cccc66-6ccc-6c66-666c-66cc6c6c66c6_222d22dd-d2d2-2dd2-222d-2dd2222ddddd_20211116", + "kind": "SavingsPlan", + "properties": { + "armSkuName": "Compute_Savings_Plan", + "avgUtilizationPercentage": 90, + "benefitId": "/providers/Microsoft.BillingBenefits/savingsPlanOrders/66cccc66-6ccc-6c66-666c-66cc6c6c66c6/savingsPlans/222d22dd-d2d2-2dd2-222d-2dd2222ddddd", + "benefitOrderId": "/providers/Microsoft.BillingBenefits/savingsPlanOrders/66cccc66-6ccc-6c66-666c-66cc6c6c66c6", + "benefitType": "SavingsPlan", + "maxUtilizationPercentage": 100, + "minUtilizationPercentage": 80, + "usageDate": "2022-10-16T00:00:00Z" + } + } + ] + } + } + }, + "operationId": "BenefitUtilizationSummaries_ListByBillingProfileId", + "title": "SavingsPlanUtilizationSummaries-BillingProfile" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/BenefitUtilizationSummaries/SavingsPlan-SavingsPlanId-Monthly.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/BenefitUtilizationSummaries/SavingsPlan-SavingsPlanId-Monthly.json new file mode 100644 index 000000000000..92b69a173255 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/BenefitUtilizationSummaries/SavingsPlan-SavingsPlanId-Monthly.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "filter": "properties/usageDate ge 2022-10-15 and properties/usageDate le 2022-10-18", + "grain": "Monthly", + "savingsPlanId": "222d22dd-d2d2-2dd2-222d-2dd2222ddddd", + "savingsPlanOrderId": "66cccc66-6ccc-6c66-666c-66cc6c6c66c6" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "66cccc66-6ccc-6c66-666c-66cc6c6c66c6_222d22dd-d2d2-2dd2-222d-2dd2222ddddd_202111", + "type": "Microsoft.CostManagement/benefitUtilizationSummaries", + "id": "/providers/Microsoft.BillingBenefits/savingsPlanOrders/66cccc66-6ccc-6c66-666c-66cc6c6c66c6/savingsPlans/222d22dd-d2d2-2dd2-222d-2dd2222ddddd/providers/Microsoft.CostManagement/benefitUtilizationSummaries/66cccc66-6ccc-6c66-666c-66cc6c6c66c6_222d22dd-d2d2-2dd2-222d-2dd2222ddddd_202111", + "kind": "SavingsPlan", + "properties": { + "armSkuName": "Compute_Savings_Plan", + "avgUtilizationPercentage": 90, + "benefitId": "/providers/Microsoft.BillingBenefits/savingsPlanOrders/66cccc66-6ccc-6c66-666c-66cc6c6c66c6/savingsPlans/222d22dd-d2d2-2dd2-222d-2dd2222ddddd", + "benefitOrderId": "/providers/Microsoft.BillingBenefits/savingsPlanOrders/66cccc66-6ccc-6c66-666c-66cc6c6c66c6", + "benefitType": "SavingsPlan", + "maxUtilizationPercentage": 100, + "minUtilizationPercentage": 80, + "usageDate": "2022-10-16T00:00:00Z" + } + }, + { + "name": "66cccc66-6ccc-6c66-666c-66cc6c6c66c6_222d22dd-d2d2-2dd2-222d-2dd2222ddddd_202112", + "type": "Microsoft.CostManagement/benefitUtilizationSummaries", + "id": "/providers/Microsoft.BillingBenefits/savingsPlanOrders/66cccc66-6ccc-6c66-666c-66cc6c6c66c6/savingsPlans/222d22dd-d2d2-2dd2-222d-2dd2222ddddd/providers/Microsoft.CostManagement/benefitUtilizationSummaries/66cccc66-6ccc-6c66-666c-66cc6c6c66c6_222d22dd-d2d2-2dd2-222d-2dd2222ddddd_202112", + "kind": "SavingsPlan", + "properties": { + "armSkuName": "Compute_Savings_Plan", + "avgUtilizationPercentage": 80, + "benefitId": "/providers/Microsoft.BillingBenefits/savingsPlanOrders/66cccc66-6ccc-6c66-666c-66cc6c6c66c6/savingsPlans/222d22dd-d2d2-2dd2-222d-2dd2222ddddd", + "benefitOrderId": "/providers/Microsoft.BillingBenefits/savingsPlanOrders/66cccc66-6ccc-6c66-666c-66cc6c6c66c6", + "benefitType": "SavingsPlan", + "maxUtilizationPercentage": 90, + "minUtilizationPercentage": 70, + "usageDate": "2022-10-17T00:00:00Z" + } + } + ] + } + } + }, + "operationId": "BenefitUtilizationSummaries_ListBySavingsPlanId", + "title": "SavingsPlanUtilizationSummariesMonthlyWithSavingsPlanId" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/BenefitUtilizationSummaries/SavingsPlan-SavingsPlanOrderId-Daily.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/BenefitUtilizationSummaries/SavingsPlan-SavingsPlanOrderId-Daily.json new file mode 100644 index 000000000000..ad1268c24451 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/BenefitUtilizationSummaries/SavingsPlan-SavingsPlanOrderId-Daily.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "filter": "properties/usageDate ge 2022-10-15 and properties/usageDate le 2022-10-18", + "grain": "Daily", + "savingsPlanOrderId": "66cccc66-6ccc-6c66-666c-66cc6c6c66c6" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "66cccc66-6ccc-6c66-666c-66cc6c6c66c6_222d22dd-d2d2-2dd2-222d-2dd2222ddddd_20211116", + "type": "Microsoft.CostManagement/benefitUtilizationSummaries", + "id": "/providers/Microsoft.BillingBenefits/savingsPlanOrders/66cccc66-6ccc-6c66-666c-66cc6c6c66c6/providers/Microsoft.CostManagement/benefitUtilizationSummaries/66cccc66-6ccc-6c66-666c-66cc6c6c66c6_222d22dd-d2d2-2dd2-222d-2dd2222ddddd_20211116", + "kind": "SavingsPlan", + "properties": { + "armSkuName": "Compute_Savings_Plan", + "avgUtilizationPercentage": 90, + "benefitId": "/providers/Microsoft.BillingBenefits/savingsPlanOrders/66cccc66-6ccc-6c66-666c-66cc6c6c66c6/savingsPlans/222d22dd-d2d2-2dd2-222d-2dd2222ddddd", + "benefitOrderId": "/providers/Microsoft.BillingBenefits/savingsPlanOrders/66cccc66-6ccc-6c66-666c-66cc6c6c66c6", + "benefitType": "SavingsPlan", + "maxUtilizationPercentage": 100, + "minUtilizationPercentage": 80, + "usageDate": "2022-10-16T00:00:00Z" + } + } + ] + } + } + }, + "operationId": "BenefitUtilizationSummaries_ListBySavingsPlanOrder", + "title": "SavingsPlanUtilizationSummariesDaily" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/BillingAccountAlerts.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/BillingAccountAlerts.json new file mode 100644 index 000000000000..cc4717f9a569 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/BillingAccountAlerts.json @@ -0,0 +1,100 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "billingAccountId": "12345-6789", + "scope": "providers/Microsoft.Billing/billingAccounts/12345-6789" + }, + "responses": { + "200": { + "body": { + "nextLink": null, + "value": [ + { + "name": "00000000-0000-0000-0000-000000000000", + "type": "Microsoft.CostManagement/alerts", + "id": "/providers/Microsoft.Billing/billingAccounts/12345-6789/providers/Microsoft.CostManagement/alerts/00000000-0000-0000-0000-000000000000", + "properties": { + "description": "", + "closeTime": "0001-01-01T00:00:00", + "costEntityId": "budget1", + "creationTime": "2020-04-27T11:07:52.7143901Z", + "definition": { + "type": "Budget", + "category": "Cost", + "criteria": "CostThresholdExceeded" + }, + "modificationTime": "2020-04-28T11:06:02.8999373Z", + "source": "Preset", + "status": "Active", + "statusModificationTime": "0001-01-01T00:00:00", + "statusModificationUserName": null, + "details": { + "amount": 200000, + "contactEmails": [ + "1234@contoso.com" + ], + "contactGroups": [], + "contactRoles": [], + "currentSpend": 161000.12, + "meterFilter": [], + "operator": "GreaterThan", + "overridingAlert": null, + "periodStartDate": "2020-03-01T00:00:00Z", + "resourceFilter": [], + "resourceGroupFilter": [], + "tagFilter": {}, + "threshold": 0.8, + "timeGrainType": "Quarterly", + "triggeredBy": "00000000-0000-0000-0000-000000000000_1_01", + "unit": "USD" + } + } + }, + { + "name": "11111111-1111-1111-111111111111", + "type": "Microsoft.CostManagement/alerts", + "id": "/providers/Microsoft.Billing/billingAccounts/12345-6789/providers/Microsoft.CostManagement/alerts/11111111-1111-1111-111111111111", + "properties": { + "description": "", + "closeTime": "0001-01-01T00:00:00", + "costEntityId": "budget1", + "creationTime": "2019-06-24T05:51:52.8713179Z", + "definition": { + "type": "Budget", + "category": "Cost", + "criteria": "CostThresholdExceeded" + }, + "modificationTime": "2019-08-31T17:51:55.1808807Z", + "source": "Preset", + "status": "Active", + "statusModificationTime": "0001-01-01T00:00:00", + "statusModificationUserName": null, + "details": { + "amount": 200000, + "contactEmails": [ + "1234@contoso.com" + ], + "contactGroups": [], + "contactRoles": [], + "currentSpend": 171000.32, + "meterFilter": [], + "operator": "GreaterThan", + "overridingAlert": null, + "periodStartDate": "2020-03-01T00:00:00Z", + "resourceFilter": [], + "resourceGroupFilter": [], + "tagFilter": {}, + "threshold": 0.8, + "timeGrainType": "Quarterly", + "triggeredBy": "11111111-1111-1111-111111111111_1_01", + "unit": "USD" + } + } + } + ] + } + } + }, + "operationId": "Alerts_List", + "title": "BillingAccountAlerts" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/BillingAccountDimensionsList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/BillingAccountDimensionsList.json new file mode 100644 index 000000000000..d294e1d84d54 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/BillingAccountDimensionsList.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "billingAccountId": "100", + "scope": "providers/Microsoft.Billing/billingAccounts/100" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "dimensions_ResourceGroup_2018-05-01_2018-05-31", + "type": "microsoft.CostManagement/dimensions", + "id": "/providers/Microsoft.Billing/billingAccounts/100/providers/microsoft.CostManagement/dimensions_ResourceGroup_2018-05-01_2018-05-31", + "properties": { + "description": "Resource group", + "category": "ResourceGroup", + "data": [ + "thoroetrg01", + "default-notificationhubs-westus", + "jedikeyvaultrg", + "contosocodeflow8d4a", + "noobaa" + ], + "filterEnabled": true, + "groupingEnabled": true, + "total": 377, + "usageEnd": "2018-05-31T00:00:00-07:00", + "usageStart": "2018-05-01T00:00:00-07:00" + } + }, + { + "name": "dimensions_ResourceType_2018-05-01_2018-05-31", + "type": "microsoft.CostManagement/dimensions", + "id": "/providers/Microsoft.Billing/billingAccounts/100/providers/microsoft.CostManagement/dimensions_ResourceType_2018-05-01_2018-05-31", + "properties": { + "description": "Resource type", + "category": "ResourceType", + "data": [ + "thoroetrg01", + "default-notificationhubs-westus", + "jedikeyvaultrg", + "contosocodeflow8d4a", + "noobaa" + ], + "filterEnabled": true, + "groupingEnabled": true, + "total": 37, + "usageEnd": "2018-05-31T00:00:00-07:00", + "usageStart": "2018-05-01T00:00:00-07:00" + } + } + ] + } + }, + "204": {} + }, + "operationId": "Dimensions_List", + "title": "BillingAccountDimensionsList-Legacy" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/BillingAccountDimensionsListExpandAndTop.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/BillingAccountDimensionsListExpandAndTop.json new file mode 100644 index 000000000000..de01e5018f55 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/BillingAccountDimensionsListExpandAndTop.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "$expand": "properties/data", + "$top": 5, + "api-version": "2025-03-01", + "billingAccountId": "100", + "scope": "providers/Microsoft.Billing/billingAccounts/100" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "dimensions_ResourceGroup_2018-05-01_2018-05-31_5", + "type": "microsoft.CostManagement/dimensions", + "id": "/providers/Microsoft.Billing/billingAccounts/100/providers/microsoft.CostManagement/dimensions_ResourceGroup_2018-05-01_2018-05-31_5", + "properties": { + "description": "Resource group", + "category": "ResourceGroup", + "data": [ + "thoroetrg01", + "default-notificationhubs-westus", + "jedikeyvaultrg", + "contosocodeflow8d4a", + "noobaa" + ], + "filterEnabled": true, + "groupingEnabled": true, + "total": 377, + "usageEnd": "2018-05-31T00:00:00-07:00", + "usageStart": "2018-05-01T00:00:00-07:00" + } + }, + { + "name": "dimensions_ResourceType_2018-05-01_2018-05-31_5", + "type": "microsoft.CostManagement/dimensions", + "id": "/providers/Microsoft.Billing/billingAccounts/100/providers/microsoft.CostManagement/dimensions_ResourceType_2018-05-01_2018-05-31_5", + "properties": { + "description": "Resource type", + "category": "ResourceType", + "data": [ + "microsoft.automation/automationaccounts", + "microsoft.databricks/workspaces", + "microsoft.dbformysql/servers", + "microsoft.containerregistry/registries", + "microsoft.search/searchservices" + ], + "filterEnabled": true, + "groupingEnabled": true, + "total": 37, + "usageEnd": "2018-05-31T00:00:00-07:00", + "usageStart": "2018-05-01T00:00:00-07:00" + } + } + ] + } + }, + "204": {} + }, + "operationId": "Dimensions_List", + "title": "BillingAccountDimensionsListExpandAndTop-Legacy" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/BillingAccountDimensionsListWithFilter.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/BillingAccountDimensionsListWithFilter.json new file mode 100644 index 000000000000..974c36bbf34c --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/BillingAccountDimensionsListWithFilter.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "$expand": "properties/data", + "$filter": "properties/category eq 'resourceId'", + "$top": 5, + "api-version": "2025-03-01", + "billingAccountId": "100", + "scope": "providers/Microsoft.Billing/billingAccounts/100" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "dimensions_ResourceId_2018-05-01_2018-05-31_5", + "type": "microsoft.CostManagement/dimensions", + "id": "/providers/Microsoft.Billing/billingAccounts/100/providers/microsoft.CostManagement/dimensions_ResourceId_2018-05-01_2018-05-31_5", + "properties": { + "description": "Resource Id", + "category": "ResourceId", + "data": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/system.orlando/providers/microsoft.storage/storageaccounts/urphealthaccount", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/system.orlando/providers/microsoft.storage/storageaccounts/srphytenaccount", + "/subscriptions/67e24f6b-1ec2-4c90-993a-dc2d25b00b6c/resourcegroups/defaultresourcegroup-eus/providers/microsoft.operationalinsights/workspaces/defaultworkspace-67e24f6b-1ec2-4c90-993a-dc2d25b00b6c-eus", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg-sql-ha/providers/microsoft.compute/virtualmachines/sql-4qqp1", + "/subscriptions/a98d6dc5-eb8f-46cf-8938-f1fb08f03706/resourcegroups/databricks-rg-testwsp-xijmsdubneexm/providers/microsoft.compute/disks/488cdb42bf74474a98075415be3f806c-containerrootvolume" + ], + "filterEnabled": true, + "groupingEnabled": true, + "nextLink": "http://management.azure.com/providers/Microsoft.Billing/billingAccounts/100/providers/Microsoft.CostManagement/Dimensions?$filter=properties/category eq 'resourceId'&$top=5&api-version=2019-10-01&$expand=properties/data&$skiptoken=AQAAAA%3D%3D", + "total": 1409, + "usageEnd": "2018-05-31T00:00:00-07:00", + "usageStart": "2018-05-01T00:00:00-07:00" + } + } + ] + } + }, + "204": {} + }, + "operationId": "Dimensions_List", + "title": "BillingAccountDimensionsListWithFilter-Legacy" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/BillingAccountForecast.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/BillingAccountForecast.json new file mode 100644 index 000000000000..673b2507a4ec --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/BillingAccountForecast.json @@ -0,0 +1,122 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "billingAccountId": "12345:6789", + "parameters": { + "type": "Usage", + "dataset": { + "aggregation": { + "totalCost": { + "name": "Cost", + "function": "Sum" + } + }, + "filter": { + "and": [ + { + "or": [ + { + "dimensions": { + "name": "ResourceLocation", + "operator": "In", + "values": [ + "East US", + "West Europe" + ] + } + }, + { + "tags": { + "name": "Environment", + "operator": "In", + "values": [ + "UAT", + "Prod" + ] + } + } + ] + }, + { + "dimensions": { + "name": "ResourceGroup", + "operator": "In", + "values": [ + "API" + ] + } + } + ] + }, + "granularity": "Daily" + }, + "includeActualCost": false, + "includeFreshPartialCost": false, + "timePeriod": { + "from": "2022-08-01T00:00:00+00:00", + "to": "2022-08-31T23:59:59+00:00" + }, + "timeframe": "Custom" + }, + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789" + }, + "responses": { + "200": { + "body": { + "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "type": "Microsoft.CostManagement/query", + "id": "/providers/Microsoft.Billing/billingAccounts/12345:6789/providers/Microsoft.CostManagement/query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "properties": { + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "UsageDate", + "type": "Number" + }, + { + "name": "CostStatus", + "type": "String" + }, + { + "name": "Currency", + "type": "String" + } + ], + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/providers/Microsoft.CostManagement/Forecast?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", + "rows": [ + [ + 2.10333307059661, + 20180331, + "Forecast", + "USD" + ], + [ + 218.68795741935486, + 20180331, + "Forecast", + "USD" + ], + [ + 0.14384913581657052, + 20180401, + "Forecast", + "USD" + ], + [ + 0.009865586851323632, + 20180429, + "Forecast", + "USD" + ] + ] + } + } + }, + "204": {} + }, + "operationId": "Forecast_Usage", + "title": "BillingAccountForecast" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/BillingAccountQuery.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/BillingAccountQuery.json new file mode 100644 index 000000000000..95abb5802322 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/BillingAccountQuery.json @@ -0,0 +1,110 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "billingAccountId": "70664866", + "parameters": { + "type": "Usage", + "dataset": { + "filter": { + "and": [ + { + "or": [ + { + "dimensions": { + "name": "ResourceLocation", + "operator": "In", + "values": [ + "East US", + "West Europe" + ] + } + }, + { + "tags": { + "name": "Environment", + "operator": "In", + "values": [ + "UAT", + "Prod" + ] + } + } + ] + }, + { + "dimensions": { + "name": "ResourceGroup", + "operator": "In", + "values": [ + "API" + ] + } + } + ] + }, + "granularity": "Daily" + }, + "timeframe": "MonthToDate" + }, + "scope": "providers/Microsoft.Billing/billingAccounts/70664866" + }, + "responses": { + "200": { + "body": { + "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "type": "microsoft.costmanagement/Query", + "id": "/providers/Microsoft.Billing/billingAccounts/70664866/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "properties": { + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "ResourceGroup", + "type": "String" + }, + { + "name": "UsageDate", + "type": "Number" + }, + { + "name": "Currency", + "type": "String" + } + ], + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/70664866/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", + "rows": [ + [ + 19.545363672276512, + "JapanUnifia-Trial", + 20180331, + "USD" + ], + [ + 173.41979241290323, + "RVIIOT-TRIAL", + 20180331, + "USD" + ], + [ + 20.35941656262545, + "VSTSHOL-1595322048000", + 20180331, + "USD" + ], + [ + 0.16677720329728665, + "gs-stms-dev", + 20180331, + "USD" + ] + ] + } + } + }, + "204": {} + }, + "operationId": "Query_Usage", + "title": "BillingAccountQuery-Legacy" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/BillingAccountQueryGrouping.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/BillingAccountQueryGrouping.json new file mode 100644 index 000000000000..8a60ea7ede90 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/BillingAccountQueryGrouping.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "billingAccountId": "70664866", + "parameters": { + "type": "Usage", + "dataset": { + "aggregation": { + "totalCost": { + "name": "PreTaxCost", + "function": "Sum" + } + }, + "granularity": "None", + "grouping": [ + { + "name": "ResourceGroup", + "type": "Dimension" + } + ] + }, + "timeframe": "TheLastMonth" + }, + "scope": "providers/Microsoft.Billing/billingAccounts/70664866" + }, + "responses": { + "200": { + "body": { + "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "type": "microsoft.costmanagement/Query", + "id": "/providers/Microsoft.Billing/billingAccounts/70664866/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "properties": { + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "ResourceGroup", + "type": "String" + }, + { + "name": "Currency", + "type": "String" + } + ], + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/70664866/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", + "rows": [ + [ + 19.545363672276512, + "JapanUnifia-Trial", + "USD" + ], + [ + 173.41979241290323, + "RVIIOT-TRIAL", + "USD" + ], + [ + 20.35941656262545, + "VSTSHOL-1595322048000", + "USD" + ] + ] + } + } + }, + "204": {} + }, + "operationId": "Query_Usage", + "title": "BillingAccountQueryGrouping-Legacy" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/BillingProfileAlerts.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/BillingProfileAlerts.json new file mode 100644 index 000000000000..d5fe67fbd5d3 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/BillingProfileAlerts.json @@ -0,0 +1,101 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "billingAccountId": "12345-6789", + "billingProfileId": "13579", + "scope": "providers/Microsoft.Billing/billingAccounts/12345-6789/billingProfiles/13579" + }, + "responses": { + "200": { + "body": { + "nextLink": null, + "value": [ + { + "name": "00000000-0000-0000-0000-000000000000", + "type": "Microsoft.CostManagement/alerts", + "id": "/providers/Microsoft.Billing/billingAccounts/12345-6789/billingProfiles/13579/providers/Microsoft.CostManagement/alerts/00000000-0000-0000-0000-000000000000", + "properties": { + "description": "", + "closeTime": "0001-01-01T00:00:00", + "costEntityId": "budget1", + "creationTime": "2020-04-27T11:07:52.7143901Z", + "definition": { + "type": "Budget", + "category": "Cost", + "criteria": "CostThresholdExceeded" + }, + "modificationTime": "2020-04-28T11:06:02.8999373Z", + "source": "Preset", + "status": "Active", + "statusModificationTime": "0001-01-01T00:00:00", + "statusModificationUserName": null, + "details": { + "amount": 200000, + "contactEmails": [ + "1234@contoso.com" + ], + "contactGroups": [], + "contactRoles": [], + "currentSpend": 161000.12, + "meterFilter": [], + "operator": "GreaterThan", + "overridingAlert": null, + "periodStartDate": "2020-03-01T00:00:00Z", + "resourceFilter": [], + "resourceGroupFilter": [], + "tagFilter": {}, + "threshold": 0.8, + "timeGrainType": "Quarterly", + "triggeredBy": "00000000-0000-0000-0000-000000000000_1_01", + "unit": "USD" + } + } + }, + { + "name": "11111111-1111-1111-111111111111", + "type": "Microsoft.CostManagement/alerts", + "id": "/providers/Microsoft.Billing/billingAccounts/12345-6789/billingProfiles/13579/providers/Microsoft.CostManagement/alerts/11111111-1111-1111-111111111111", + "properties": { + "description": "", + "closeTime": "0001-01-01T00:00:00", + "costEntityId": "budget1", + "creationTime": "2019-06-24T05:51:52.8713179Z", + "definition": { + "type": "Budget", + "category": "Cost", + "criteria": "CostThresholdExceeded" + }, + "modificationTime": "2019-08-31T17:51:55.1808807Z", + "source": "Preset", + "status": "Active", + "statusModificationTime": "0001-01-01T00:00:00", + "statusModificationUserName": null, + "details": { + "amount": 200000, + "contactEmails": [ + "1234@contoso.com" + ], + "contactGroups": [], + "contactRoles": [], + "currentSpend": 171000.32, + "meterFilter": [], + "operator": "GreaterThan", + "overridingAlert": null, + "periodStartDate": "2020-03-01T00:00:00Z", + "resourceFilter": [], + "resourceGroupFilter": [], + "tagFilter": {}, + "threshold": 0.8, + "timeGrainType": "Quarterly", + "triggeredBy": "11111111-1111-1111-111111111111_1_01", + "unit": "USD" + } + } + } + ] + } + } + }, + "operationId": "Alerts_List", + "title": "BillingProfileAlerts" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/BillingProfileForecast.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/BillingProfileForecast.json new file mode 100644 index 000000000000..fba5b66f290b --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/BillingProfileForecast.json @@ -0,0 +1,123 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "billingAccountId": "12345:6789", + "billingProfileId": "13579", + "parameters": { + "type": "Usage", + "dataset": { + "aggregation": { + "totalCost": { + "name": "Cost", + "function": "Sum" + } + }, + "filter": { + "and": [ + { + "or": [ + { + "dimensions": { + "name": "ResourceLocation", + "operator": "In", + "values": [ + "East US", + "West Europe" + ] + } + }, + { + "tags": { + "name": "Environment", + "operator": "In", + "values": [ + "UAT", + "Prod" + ] + } + } + ] + }, + { + "dimensions": { + "name": "ResourceGroup", + "operator": "In", + "values": [ + "API" + ] + } + } + ] + }, + "granularity": "Daily" + }, + "includeActualCost": false, + "includeFreshPartialCost": false, + "timePeriod": { + "from": "2022-08-01T00:00:00+00:00", + "to": "2022-08-31T23:59:59+00:00" + }, + "timeframe": "Custom" + }, + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579" + }, + "responses": { + "200": { + "body": { + "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "type": "Microsoft.CostManagement/query", + "id": "/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "properties": { + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "UsageDate", + "type": "Number" + }, + { + "name": "CostStatus", + "type": "String" + }, + { + "name": "Currency", + "type": "String" + } + ], + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/Forecast?api-version=2019-10-01&$skiptoken=AQAAAA%3D%3D", + "rows": [ + [ + 2.10333307059661, + 20180331, + "Forecast", + "USD" + ], + [ + 218.68795741935486, + 20180331, + "Forecast", + "USD" + ], + [ + 0.14384913581657052, + 20180401, + "Forecast", + "USD" + ], + [ + 0.009865586851323632, + 20180429, + "Forecast", + "USD" + ] + ] + } + } + }, + "204": {} + }, + "operationId": "Forecast_Usage", + "title": "BillingProfileForecast" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/Budgets/CreateOrUpdate/Cost/CreateOrUpdate-Cost-Subscription-Budget.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/Budgets/CreateOrUpdate/Cost/CreateOrUpdate-Cost-Subscription-Budget.json new file mode 100644 index 000000000000..dcd0e65bff44 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/Budgets/CreateOrUpdate/Cost/CreateOrUpdate-Cost-Subscription-Budget.json @@ -0,0 +1,229 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "budgetName": "TestBudget", + "parameters": { + "eTag": "\"1d34d016a593709\"", + "properties": { + "amount": 100.65, + "category": "Cost", + "filter": { + "and": [ + { + "dimensions": { + "name": "ResourceId", + "operator": "In", + "values": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/MSVM2", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/platformcloudplatformGeneric1" + ] + } + }, + { + "tags": { + "name": "category", + "operator": "In", + "values": [ + "Dev", + "Prod" + ] + } + }, + { + "tags": { + "name": "department", + "operator": "In", + "values": [ + "engineering", + "sales" + ] + } + } + ] + }, + "notifications": { + "Actual_GreaterThan_80_Percent": { + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "contactGroups": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/microsoft.insights/actionGroups/SampleActionGroup" + ], + "contactRoles": [ + "Contributor", + "Reader" + ], + "enabled": true, + "locale": "en-us", + "operator": "GreaterThan", + "threshold": 80, + "thresholdType": "Actual" + } + }, + "timeGrain": "Monthly", + "timePeriod": { + "endDate": "2024-10-31T00:00:00Z", + "startDate": "2023-04-01T00:00:00Z" + } + } + }, + "resourceGroupName": "MYDEVTESTRG", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "TestBudget", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157f\"", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/budgets/TestBudget", + "properties": { + "amount": 100.65, + "category": "Cost", + "currentSpend": { + "amount": 80.89, + "unit": "USD" + }, + "filter": { + "and": [ + { + "dimensions": { + "name": "ResourceId", + "operator": "In", + "values": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/MSVM2", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/platformcloudplatformGeneric1" + ] + } + }, + { + "tags": { + "name": "category", + "operator": "In", + "values": [ + "Dev", + "Prod" + ] + } + }, + { + "tags": { + "name": "department", + "operator": "In", + "values": [ + "engineering", + "sales" + ] + } + } + ] + }, + "notifications": { + "Actual_GreaterThan_80_Percent": { + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "contactGroups": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/microsoft.insights/actionGroups/SampleActionGroup" + ], + "contactRoles": [ + "Contributor", + "Reader" + ], + "enabled": true, + "locale": "en-us", + "operator": "GreaterThan", + "threshold": 80, + "thresholdType": "Actual" + } + }, + "timeGrain": "Monthly", + "timePeriod": { + "endDate": "2024-10-31T00:00:00Z", + "startDate": "2023-04-01T00:00:00Z" + } + } + } + }, + "201": { + "body": { + "name": "TestBudget", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157f\"", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/budgets/TestBudget", + "properties": { + "amount": 100.65, + "category": "Cost", + "currentSpend": { + "amount": 80.89, + "unit": "USD" + }, + "filter": { + "and": [ + { + "dimensions": { + "name": "ResourceId", + "operator": "In", + "values": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/MSVM2", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/platformcloudplatformGeneric1" + ] + } + }, + { + "tags": { + "name": "category", + "operator": "In", + "values": [ + "Dev", + "Prod" + ] + } + }, + { + "tags": { + "name": "department", + "operator": "In", + "values": [ + "engineering", + "sales" + ] + } + } + ] + }, + "notifications": { + "Actual_GreaterThan_80_Percent": { + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "contactGroups": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/microsoft.insights/actionGroups/SampleActionGroup" + ], + "contactRoles": [ + "Contributor", + "Reader" + ], + "enabled": true, + "locale": "en-us", + "operator": "GreaterThan", + "threshold": 80, + "thresholdType": "Actual" + } + }, + "timeGrain": "Monthly", + "timePeriod": { + "endDate": "2024-10-31T00:00:00Z", + "startDate": "2023-04-01T00:00:00Z" + } + } + } + } + }, + "operationId": "Budgets_CreateOrUpdate", + "title": "CreateOrUpdate-Cost-Subscription-Budget" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/Budgets/CreateOrUpdate/ReservationUtilization/EA/BillingAccountEA-AlertRule-ReservationIdFilter.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/Budgets/CreateOrUpdate/ReservationUtilization/EA/BillingAccountEA-AlertRule-ReservationIdFilter.json new file mode 100644 index 000000000000..43802106ddf8 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/Budgets/CreateOrUpdate/ReservationUtilization/EA/BillingAccountEA-AlertRule-ReservationIdFilter.json @@ -0,0 +1,127 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "billingAccountId": "123456", + "budgetName": "TestAlertRule", + "parameters": { + "eTag": "\"1d34d016a593709\"", + "properties": { + "category": "ReservationUtilization", + "filter": { + "dimensions": { + "name": "ReservationId", + "operator": "In", + "values": [ + "00000000-0000-0000-0000-000000000000", + "00000000-0000-0000-0000-000000000001", + "00000000-0000-0000-0000-000000000002" + ] + } + }, + "notifications": { + "Actual_LessThan_99_Percent": { + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "enabled": true, + "frequency": "Weekly", + "locale": "en-us", + "operator": "LessThan", + "threshold": 99 + } + }, + "timeGrain": "Last7Days", + "timePeriod": { + "endDate": "2025-04-01T00:00:00Z", + "startDate": "2023-04-01T00:00:00Z" + } + } + }, + "scope": "providers/Microsoft.Billing/billingAccounts/123456" + }, + "responses": { + "200": { + "body": { + "name": "TestAlertRule", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157f\"", + "id": "/providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/budgets/TestAlertRule", + "properties": { + "category": "ReservationUtilization", + "filter": { + "dimensions": { + "name": "ReservationId", + "operator": "In", + "values": [ + "00000000-0000-0000-0000-000000000000", + "00000000-0000-0000-0000-000000000001", + "00000000-0000-0000-0000-000000000002" + ] + } + }, + "notifications": { + "Actual_LessThan_99_Percent": { + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "enabled": true, + "frequency": "Weekly", + "locale": "en-us", + "operator": "LessThan", + "threshold": 99 + } + }, + "timeGrain": "Last7Days", + "timePeriod": { + "endDate": "2025-04-01T00:00:00Z", + "startDate": "2023-04-01T00:00:00Z" + } + } + } + }, + "201": { + "body": { + "name": "TestAlertRule", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157f\"", + "id": "/providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/budgets/TestAlertRule", + "properties": { + "category": "ReservationUtilization", + "filter": { + "dimensions": { + "name": "ReservationId", + "operator": "In", + "values": [ + "00000000-0000-0000-0000-000000000000", + "00000000-0000-0000-0000-000000000001", + "00000000-0000-0000-0000-000000000002" + ] + } + }, + "notifications": { + "Actual_LessThan_99_Percent": { + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "enabled": true, + "frequency": "Weekly", + "locale": "en-us", + "operator": "LessThan", + "threshold": 99 + } + }, + "timeGrain": "Last7Days", + "timePeriod": { + "endDate": "2025-04-01T00:00:00Z", + "startDate": "2023-04-01T00:00:00Z" + } + } + } + } + }, + "operationId": "Budgets_CreateOrUpdate", + "title": "CreateOrUpdate-ReservationUtilization-BillingAccountEA-AlertRule-ReservationIdFilter" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/Budgets/CreateOrUpdate/ReservationUtilization/EA/BillingAccountEA-AlertRule-ReservedResourceTypeFilter.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/Budgets/CreateOrUpdate/ReservationUtilization/EA/BillingAccountEA-AlertRule-ReservedResourceTypeFilter.json new file mode 100644 index 000000000000..d030f2ba6111 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/Budgets/CreateOrUpdate/ReservationUtilization/EA/BillingAccountEA-AlertRule-ReservedResourceTypeFilter.json @@ -0,0 +1,127 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "billingAccountId": "123456", + "budgetName": "TestAlertRule", + "parameters": { + "eTag": "\"1d34d016a593709\"", + "properties": { + "category": "ReservationUtilization", + "filter": { + "dimensions": { + "name": "ReservedResourceType", + "operator": "In", + "values": [ + "VirtualMachines", + "SqlDatabases", + "CosmosDb" + ] + } + }, + "notifications": { + "Actual_LessThan_99_Percent": { + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "enabled": true, + "frequency": "Weekly", + "locale": "en-us", + "operator": "LessThan", + "threshold": 99 + } + }, + "timeGrain": "Last7Days", + "timePeriod": { + "endDate": "2025-04-01T00:00:00Z", + "startDate": "2023-04-01T00:00:00Z" + } + } + }, + "scope": "providers/Microsoft.Billing/billingAccounts/123456" + }, + "responses": { + "200": { + "body": { + "name": "TestAlertRule", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157f\"", + "id": "/providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/budgets/TestAlertRule", + "properties": { + "category": "ReservationUtilization", + "filter": { + "dimensions": { + "name": "ReservedResourceType", + "operator": "In", + "values": [ + "VirtualMachines", + "SqlDatabases", + "CosmosDb" + ] + } + }, + "notifications": { + "Actual_LessThan_99_Percent": { + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "enabled": true, + "frequency": "Weekly", + "locale": "en-us", + "operator": "LessThan", + "threshold": 99 + } + }, + "timeGrain": "Last7Days", + "timePeriod": { + "endDate": "2025-04-01T00:00:00Z", + "startDate": "2023-04-01T00:00:00Z" + } + } + } + }, + "201": { + "body": { + "name": "TestAlertRule", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157f\"", + "id": "/providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/budgets/TestAlertRule", + "properties": { + "category": "ReservationUtilization", + "filter": { + "dimensions": { + "name": "ReservedResourceType", + "operator": "In", + "values": [ + "VirtualMachines", + "SqlDatabases", + "CosmosDb" + ] + } + }, + "notifications": { + "Actual_LessThan_99_Percent": { + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "enabled": true, + "frequency": "Weekly", + "locale": "en-us", + "operator": "LessThan", + "threshold": 99 + } + }, + "timeGrain": "Last7Days", + "timePeriod": { + "endDate": "2025-04-01T00:00:00Z", + "startDate": "2023-04-01T00:00:00Z" + } + } + } + } + }, + "operationId": "Budgets_CreateOrUpdate", + "title": "CreateOrUpdate-ReservationUtilization-BillingAccountEA-AlertRule-ReservedResourceTypeFilter" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/Budgets/CreateOrUpdate/ReservationUtilization/EA/BillingAccountEA-AlertRule.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/Budgets/CreateOrUpdate/ReservationUtilization/EA/BillingAccountEA-AlertRule.json new file mode 100644 index 000000000000..529f09fac6ae --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/Budgets/CreateOrUpdate/ReservationUtilization/EA/BillingAccountEA-AlertRule.json @@ -0,0 +1,97 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "billingAccountId": "123456", + "budgetName": "TestAlertRule", + "parameters": { + "eTag": "\"1d34d016a593709\"", + "properties": { + "category": "ReservationUtilization", + "filter": {}, + "notifications": { + "Actual_LessThan_99_Percent": { + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "enabled": true, + "frequency": "Weekly", + "locale": "en-us", + "operator": "LessThan", + "threshold": 99 + } + }, + "timeGrain": "Last7Days", + "timePeriod": { + "endDate": "2025-04-01T00:00:00Z", + "startDate": "2023-04-01T00:00:00Z" + } + } + }, + "scope": "providers/Microsoft.Billing/billingAccounts/123456" + }, + "responses": { + "200": { + "body": { + "name": "TestAlertRule", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157f\"", + "id": "/providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/budgets/TestAlertRule", + "properties": { + "category": "ReservationUtilization", + "filter": {}, + "notifications": { + "Actual_LessThan_99_Percent": { + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "enabled": true, + "frequency": "Weekly", + "locale": "en-us", + "operator": "LessThan", + "threshold": 99 + } + }, + "timeGrain": "Last7Days", + "timePeriod": { + "endDate": "2025-04-01T00:00:00Z", + "startDate": "2023-04-01T00:00:00Z" + } + } + } + }, + "201": { + "body": { + "name": "TestAlertRule", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157f\"", + "id": "/providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/budgets/TestAlertRule", + "properties": { + "category": "ReservationUtilization", + "filter": {}, + "notifications": { + "Actual_LessThan_99_Percent": { + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "enabled": true, + "frequency": "Weekly", + "locale": "en-us", + "operator": "LessThan", + "threshold": 99 + } + }, + "timeGrain": "Last7Days", + "timePeriod": { + "endDate": "2025-04-01T00:00:00Z", + "startDate": "2023-04-01T00:00:00Z" + } + } + } + } + }, + "operationId": "Budgets_CreateOrUpdate", + "title": "CreateOrUpdate-ReservationUtilization-BillingAccountEA-AlertRule" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/Budgets/CreateOrUpdate/ReservationUtilization/MCA/BillingProfile-AlertRule-ReservationIdFilter.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/Budgets/CreateOrUpdate/ReservationUtilization/MCA/BillingProfile-AlertRule-ReservationIdFilter.json new file mode 100644 index 000000000000..0bde1231be0c --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/Budgets/CreateOrUpdate/ReservationUtilization/MCA/BillingProfile-AlertRule-ReservationIdFilter.json @@ -0,0 +1,128 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "billingAccountId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01", + "billingProfileId": "KKKK-LLLL-MMM-NNN", + "budgetName": "TestAlertRule", + "parameters": { + "eTag": "\"1d34d016a593709\"", + "properties": { + "category": "ReservationUtilization", + "filter": { + "dimensions": { + "name": "ReservationId", + "operator": "In", + "values": [ + "00000000-0000-0000-0000-000000000000", + "00000000-0000-0000-0000-000000000001", + "00000000-0000-0000-0000-000000000002" + ] + } + }, + "notifications": { + "Actual_LessThan_99_Percent": { + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "enabled": true, + "frequency": "Daily", + "locale": "en-us", + "operator": "LessThan", + "threshold": 99 + } + }, + "timeGrain": "Last30Days", + "timePeriod": { + "endDate": "2025-04-01T00:00:00Z", + "startDate": "2023-04-01T00:00:00Z" + } + } + }, + "scope": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/billingProfiles/KKKK-LLLL-MMM-NNN" + }, + "responses": { + "200": { + "body": { + "name": "TestAlertRule", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157f\"", + "id": "/providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/billingProfiles/KKKK-LLLL-MMM-NNN/providers/Microsoft.CostManagement/budgets/TestAlertRule", + "properties": { + "category": "ReservationUtilization", + "filter": { + "dimensions": { + "name": "ReservationId", + "operator": "In", + "values": [ + "00000000-0000-0000-0000-000000000000", + "00000000-0000-0000-0000-000000000001", + "00000000-0000-0000-0000-000000000002" + ] + } + }, + "notifications": { + "Actual_LessThan_99_Percent": { + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "enabled": true, + "frequency": "Daily", + "locale": "en-us", + "operator": "LessThan", + "threshold": 99 + } + }, + "timeGrain": "Last30Days", + "timePeriod": { + "endDate": "2025-04-01T00:00:00Z", + "startDate": "2023-04-01T00:00:00Z" + } + } + } + }, + "201": { + "body": { + "name": "TestAlertRule", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157f\"", + "id": "/providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/billingProfiles/KKKK-LLLL-MMM-NNN/providers/Microsoft.CostManagement/budgets/TestAlertRule", + "properties": { + "category": "ReservationUtilization", + "filter": { + "dimensions": { + "name": "ReservationId", + "operator": "In", + "values": [ + "00000000-0000-0000-0000-000000000000", + "00000000-0000-0000-0000-000000000001", + "00000000-0000-0000-0000-000000000002" + ] + } + }, + "notifications": { + "Actual_LessThan_99_Percent": { + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "enabled": true, + "frequency": "Daily", + "locale": "en-us", + "operator": "LessThan", + "threshold": 99 + } + }, + "timeGrain": "Last30Days", + "timePeriod": { + "endDate": "2025-04-01T00:00:00Z", + "startDate": "2023-04-01T00:00:00Z" + } + } + } + } + }, + "operationId": "Budgets_CreateOrUpdate", + "title": "CreateOrUpdate-ReservationUtilization-BillingProfileMCA-AlertRule-ReservationIdFilter" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/Budgets/CreateOrUpdate/ReservationUtilization/MCA/BillingProfile-AlertRule-ReservedResourceTypeFilter.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/Budgets/CreateOrUpdate/ReservationUtilization/MCA/BillingProfile-AlertRule-ReservedResourceTypeFilter.json new file mode 100644 index 000000000000..b7cc90c26ab1 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/Budgets/CreateOrUpdate/ReservationUtilization/MCA/BillingProfile-AlertRule-ReservedResourceTypeFilter.json @@ -0,0 +1,128 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "billingAccountId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01", + "billingProfileId": "KKKK-LLLL-MMM-NNN", + "budgetName": "TestAlertRule", + "parameters": { + "eTag": "\"1d34d016a593709\"", + "properties": { + "category": "ReservationUtilization", + "filter": { + "dimensions": { + "name": "ReservedResourceType", + "operator": "In", + "values": [ + "VirtualMachines", + "SqlDatabases", + "CosmosDb" + ] + } + }, + "notifications": { + "Actual_LessThan_99_Percent": { + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "enabled": true, + "frequency": "Daily", + "locale": "en-us", + "operator": "LessThan", + "threshold": 99 + } + }, + "timeGrain": "Last30Days", + "timePeriod": { + "endDate": "2025-04-01T00:00:00Z", + "startDate": "2023-04-01T00:00:00Z" + } + } + }, + "scope": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/billingProfiles/KKKK-LLLL-MMM-NNN" + }, + "responses": { + "200": { + "body": { + "name": "TestAlertRule", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157f\"", + "id": "/providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/billingProfiles/KKKK-LLLL-MMM-NNN/providers/Microsoft.CostManagement/budgets/TestAlertRule", + "properties": { + "category": "ReservationUtilization", + "filter": { + "dimensions": { + "name": "ReservedResourceType", + "operator": "In", + "values": [ + "VirtualMachines", + "SqlDatabases", + "CosmosDb" + ] + } + }, + "notifications": { + "Actual_LessThan_99_Percent": { + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "enabled": true, + "frequency": "Daily", + "locale": "en-us", + "operator": "LessThan", + "threshold": 99 + } + }, + "timeGrain": "Last30Days", + "timePeriod": { + "endDate": "2025-04-01T00:00:00Z", + "startDate": "2023-04-01T00:00:00Z" + } + } + } + }, + "201": { + "body": { + "name": "TestAlertRule", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157f\"", + "id": "/providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/billingProfiles/KKKK-LLLL-MMM-NNN/providers/Microsoft.CostManagement/budgets/TestAlertRule", + "properties": { + "category": "ReservationUtilization", + "filter": { + "dimensions": { + "name": "ReservedResourceType", + "operator": "In", + "values": [ + "VirtualMachines", + "SqlDatabases", + "CosmosDb" + ] + } + }, + "notifications": { + "Actual_LessThan_99_Percent": { + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "enabled": true, + "frequency": "Daily", + "locale": "en-us", + "operator": "LessThan", + "threshold": 99 + } + }, + "timeGrain": "Last30Days", + "timePeriod": { + "endDate": "2025-04-01T00:00:00Z", + "startDate": "2023-04-01T00:00:00Z" + } + } + } + } + }, + "operationId": "Budgets_CreateOrUpdate", + "title": "CreateOrUpdate-ReservationUtilization-BillingProfileMCA-AlertRule-ReservedResourceTypeFilter" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/Budgets/CreateOrUpdate/ReservationUtilization/MCA/BillingProfile-AlertRule.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/Budgets/CreateOrUpdate/ReservationUtilization/MCA/BillingProfile-AlertRule.json new file mode 100644 index 000000000000..4435cdfe6f0a --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/Budgets/CreateOrUpdate/ReservationUtilization/MCA/BillingProfile-AlertRule.json @@ -0,0 +1,98 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "billingAccountId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01", + "billingProfileId": "KKKK-LLLL-MMM-NNN", + "budgetName": "TestAlertRule", + "parameters": { + "eTag": "\"1d34d016a593709\"", + "properties": { + "category": "ReservationUtilization", + "filter": {}, + "notifications": { + "Actual_LessThan_99_Percent": { + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "enabled": true, + "frequency": "Daily", + "locale": "en-us", + "operator": "LessThan", + "threshold": 99 + } + }, + "timeGrain": "Last30Days", + "timePeriod": { + "endDate": "2025-04-01T00:00:00Z", + "startDate": "2023-04-01T00:00:00Z" + } + } + }, + "scope": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/billingProfiles/KKKK-LLLL-MMM-NNN" + }, + "responses": { + "200": { + "body": { + "name": "TestAlertRule", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157f\"", + "id": "/providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/billingProfiles/KKKK-LLLL-MMM-NNN/providers/Microsoft.CostManagement/budgets/TestAlertRule", + "properties": { + "category": "ReservationUtilization", + "filter": {}, + "notifications": { + "Actual_LessThan_99_Percent": { + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "enabled": true, + "frequency": "Daily", + "locale": "en-us", + "operator": "LessThan", + "threshold": 99 + } + }, + "timeGrain": "Last30Days", + "timePeriod": { + "endDate": "2025-04-01T00:00:00Z", + "startDate": "2023-04-01T00:00:00Z" + } + } + } + }, + "201": { + "body": { + "name": "TestAlertRule", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157f\"", + "id": "/providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/billingProfiles/KKKK-LLLL-MMM-NNN/providers/Microsoft.CostManagement/budgets/TestAlertRule", + "properties": { + "category": "ReservationUtilization", + "filter": {}, + "notifications": { + "Actual_LessThan_99_Percent": { + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "enabled": true, + "frequency": "Daily", + "locale": "en-us", + "operator": "LessThan", + "threshold": 99 + } + }, + "timeGrain": "Last30Days", + "timePeriod": { + "endDate": "2025-04-01T00:00:00Z", + "startDate": "2023-04-01T00:00:00Z" + } + } + } + } + }, + "operationId": "Budgets_CreateOrUpdate", + "title": "CreateOrUpdate-ReservationUtilization-BillingProfileMCA-AlertRule.json" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/Budgets/CreateOrUpdate/ReservationUtilization/MCA/Customer-AlertRule-ReservationIdFilter.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/Budgets/CreateOrUpdate/ReservationUtilization/MCA/Customer-AlertRule-ReservationIdFilter.json new file mode 100644 index 000000000000..2d86b6d7e5f0 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/Budgets/CreateOrUpdate/ReservationUtilization/MCA/Customer-AlertRule-ReservationIdFilter.json @@ -0,0 +1,128 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "billingAccountId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01", + "budgetName": "TestAlertRule", + "customerId": "000000-1111-2222-3333-444444444444", + "parameters": { + "eTag": "\"1d34d016a593709\"", + "properties": { + "category": "ReservationUtilization", + "filter": { + "dimensions": { + "name": "ReservationId", + "operator": "In", + "values": [ + "00000000-0000-0000-0000-000000000000", + "00000000-0000-0000-0000-000000000001", + "00000000-0000-0000-0000-000000000002" + ] + } + }, + "notifications": { + "Actual_LessThan_99_Percent": { + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "enabled": true, + "frequency": "Daily", + "locale": "en-us", + "operator": "LessThan", + "threshold": 99 + } + }, + "timeGrain": "Last30Days", + "timePeriod": { + "endDate": "2025-04-01T00:00:00Z", + "startDate": "2023-04-01T00:00:00Z" + } + } + }, + "scope": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/customers/000000-1111-2222-3333-444444444444" + }, + "responses": { + "200": { + "body": { + "name": "TestAlertRule", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157f\"", + "id": "/providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/customers/000000-1111-2222-3333-444444444444/providers/Microsoft.CostManagement/budgets/TestAlertRule", + "properties": { + "category": "ReservationUtilization", + "filter": { + "dimensions": { + "name": "ReservationId", + "operator": "In", + "values": [ + "00000000-0000-0000-0000-000000000000", + "00000000-0000-0000-0000-000000000001", + "00000000-0000-0000-0000-000000000002" + ] + } + }, + "notifications": { + "Actual_LessThan_99_Percent": { + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "enabled": true, + "frequency": "Daily", + "locale": "en-us", + "operator": "LessThan", + "threshold": 99 + } + }, + "timeGrain": "Last30Days", + "timePeriod": { + "endDate": "2025-04-01T00:00:00Z", + "startDate": "2023-04-01T00:00:00Z" + } + } + } + }, + "201": { + "body": { + "name": "TestAlertRule", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157f\"", + "id": "/providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/customers/000000-1111-2222-3333-444444444444/providers/Microsoft.CostManagement/budgets/TestAlertRule", + "properties": { + "category": "ReservationUtilization", + "filter": { + "dimensions": { + "name": "ReservationId", + "operator": "In", + "values": [ + "00000000-0000-0000-0000-000000000000", + "00000000-0000-0000-0000-000000000001", + "00000000-0000-0000-0000-000000000002" + ] + } + }, + "notifications": { + "Actual_LessThan_99_Percent": { + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "enabled": true, + "frequency": "Daily", + "locale": "en-us", + "operator": "LessThan", + "threshold": 99 + } + }, + "timeGrain": "Last30Days", + "timePeriod": { + "endDate": "2025-04-01T00:00:00Z", + "startDate": "2023-04-01T00:00:00Z" + } + } + } + } + }, + "operationId": "Budgets_CreateOrUpdate", + "title": "CreateOrUpdate-ReservationUtilization-CustomerCSP-AlertRule-ReservationIdFilter" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/Budgets/CreateOrUpdate/ReservationUtilization/MCA/Customer-AlertRule-ReservedResourceTypeFilter.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/Budgets/CreateOrUpdate/ReservationUtilization/MCA/Customer-AlertRule-ReservedResourceTypeFilter.json new file mode 100644 index 000000000000..32eb6fe7c10e --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/Budgets/CreateOrUpdate/ReservationUtilization/MCA/Customer-AlertRule-ReservedResourceTypeFilter.json @@ -0,0 +1,128 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "billingAccountId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01", + "budgetName": "TestAlertRule", + "customerId": "000000-1111-2222-3333-444444444444", + "parameters": { + "eTag": "\"1d34d016a593709\"", + "properties": { + "category": "ReservationUtilization", + "filter": { + "dimensions": { + "name": "ReservedResourceType", + "operator": "In", + "values": [ + "VirtualMachines", + "SqlDatabases", + "CosmosDb" + ] + } + }, + "notifications": { + "Actual_LessThan_99_Percent": { + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "enabled": true, + "frequency": "Daily", + "locale": "en-us", + "operator": "LessThan", + "threshold": 99 + } + }, + "timeGrain": "Last30Days", + "timePeriod": { + "endDate": "2025-04-01T00:00:00Z", + "startDate": "2023-04-01T00:00:00Z" + } + } + }, + "scope": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/customers/000000-1111-2222-3333-444444444444" + }, + "responses": { + "200": { + "body": { + "name": "TestAlertRule", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157f\"", + "id": "/providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/customers/000000-1111-2222-3333-444444444444/providers/Microsoft.CostManagement/budgets/TestAlertRule", + "properties": { + "category": "ReservationUtilization", + "filter": { + "dimensions": { + "name": "ReservedResourceType", + "operator": "In", + "values": [ + "VirtualMachines", + "SqlDatabases", + "CosmosDb" + ] + } + }, + "notifications": { + "Actual_LessThan_99_Percent": { + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "enabled": true, + "frequency": "Daily", + "locale": "en-us", + "operator": "LessThan", + "threshold": 99 + } + }, + "timeGrain": "Last30Days", + "timePeriod": { + "endDate": "2025-04-01T00:00:00Z", + "startDate": "2023-04-01T00:00:00Z" + } + } + } + }, + "201": { + "body": { + "name": "TestAlertRule", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157f\"", + "id": "/providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/customers/000000-1111-2222-3333-444444444444/providers/Microsoft.CostManagement/budgets/TestAlertRule", + "properties": { + "category": "ReservationUtilization", + "filter": { + "dimensions": { + "name": "ReservedResourceType", + "operator": "In", + "values": [ + "VirtualMachines", + "SqlDatabases", + "CosmosDb" + ] + } + }, + "notifications": { + "Actual_LessThan_99_Percent": { + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "enabled": true, + "frequency": "Daily", + "locale": "en-us", + "operator": "LessThan", + "threshold": 99 + } + }, + "timeGrain": "Last30Days", + "timePeriod": { + "endDate": "2025-04-01T00:00:00Z", + "startDate": "2023-04-01T00:00:00Z" + } + } + } + } + }, + "operationId": "Budgets_CreateOrUpdate", + "title": "CreateOrUpdate-ReservationUtilization-CustomerCSP-AlertRule-ReservedResourceTypeFilter" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/Budgets/CreateOrUpdate/ReservationUtilization/MCA/Customer-AlertRule.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/Budgets/CreateOrUpdate/ReservationUtilization/MCA/Customer-AlertRule.json new file mode 100644 index 000000000000..8c57381ff50e --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/Budgets/CreateOrUpdate/ReservationUtilization/MCA/Customer-AlertRule.json @@ -0,0 +1,98 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "billingAccountId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01", + "budgetName": "TestAlertRule", + "customerId": "000000-1111-2222-3333-444444444444", + "parameters": { + "eTag": "\"1d34d016a593709\"", + "properties": { + "category": "ReservationUtilization", + "filter": {}, + "notifications": { + "Actual_LessThan_99_Percent": { + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "enabled": true, + "frequency": "Daily", + "locale": "en-us", + "operator": "LessThan", + "threshold": 99 + } + }, + "timeGrain": "Last30Days", + "timePeriod": { + "endDate": "2025-04-01T00:00:00Z", + "startDate": "2023-04-01T00:00:00Z" + } + } + }, + "scope": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/customers/000000-1111-2222-3333-444444444444" + }, + "responses": { + "200": { + "body": { + "name": "TestAlertRule", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157f\"", + "id": "/providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/customers/000000-1111-2222-3333-444444444444/providers/Microsoft.CostManagement/budgets/TestAlertRule", + "properties": { + "category": "ReservationUtilization", + "filter": {}, + "notifications": { + "Actual_LessThan_99_Percent": { + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "enabled": true, + "frequency": "Daily", + "locale": "en-us", + "operator": "LessThan", + "threshold": 99 + } + }, + "timeGrain": "Last30Days", + "timePeriod": { + "endDate": "2025-04-01T00:00:00Z", + "startDate": "2023-04-01T00:00:00Z" + } + } + } + }, + "201": { + "body": { + "name": "TestAlertRule", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157f\"", + "id": "/providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/customers/000000-1111-2222-3333-444444444444/providers/Microsoft.CostManagement/budgets/TestAlertRule", + "properties": { + "category": "ReservationUtilization", + "filter": {}, + "notifications": { + "Actual_LessThan_99_Percent": { + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "enabled": true, + "frequency": "Daily", + "locale": "en-us", + "operator": "LessThan", + "threshold": 99 + } + }, + "timeGrain": "Last30Days", + "timePeriod": { + "endDate": "2025-04-01T00:00:00Z", + "startDate": "2023-04-01T00:00:00Z" + } + } + } + } + }, + "operationId": "Budgets_CreateOrUpdate", + "title": "CreateOrUpdate-ReservationUtilization-CustomerCSP-AlertRule.json" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/Budgets/Delete/DeleteBudget.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/Budgets/Delete/DeleteBudget.json new file mode 100644 index 000000000000..1b47afe55ec4 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/Budgets/Delete/DeleteBudget.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "budgetName": "TestBudget", + "resourceGroupName": "MYDEVTESTRG", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": {} + }, + "operationId": "Budgets_Delete", + "title": "DeleteBudget" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/Budgets/Get/Cost/Get-Cost-Budget.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/Budgets/Get/Cost/Get-Cost-Budget.json new file mode 100644 index 000000000000..7c4e859c698d --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/Budgets/Get/Cost/Get-Cost-Budget.json @@ -0,0 +1,87 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "budgetName": "TestBudget", + "resourceGroupName": "MYDEVTESTRG", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "TestBudget", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157f\"", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/budgets/TestBudget", + "properties": { + "amount": 100.65, + "category": "Cost", + "currentSpend": { + "amount": 80.89, + "unit": "USD" + }, + "filter": { + "and": [ + { + "dimensions": { + "name": "ResourceId", + "operator": "In", + "values": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/MSVM2", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/platformcloudplatformGeneric1" + ] + } + }, + { + "tags": { + "name": "category", + "operator": "In", + "values": [ + "Dev", + "Prod" + ] + } + }, + { + "tags": { + "name": "department", + "operator": "In", + "values": [ + "engineering", + "sales" + ] + } + } + ] + }, + "notifications": { + "Actual_GreaterThan_80_Percent": { + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "contactGroups": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/microsoft.insights/actionGroups/SampleActionGroup" + ], + "contactRoles": [ + "Contributor", + "Reader" + ], + "enabled": true, + "operator": "GreaterThan", + "threshold": 80, + "thresholdType": "Actual" + } + }, + "timeGrain": "Monthly", + "timePeriod": { + "endDate": "2024-10-31T00:00:00Z", + "startDate": "2023-04-01T00:00:00Z" + } + } + } + } + }, + "operationId": "Budgets_Get", + "title": "Get-Cost-Budget" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/Budgets/Get/ReservationUtilization/Get-ReservationUtilization-AlertRule.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/Budgets/Get/ReservationUtilization/Get-ReservationUtilization-AlertRule.json new file mode 100644 index 000000000000..515296bff9af --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/Budgets/Get/ReservationUtilization/Get-ReservationUtilization-AlertRule.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "billingAccountId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01", + "billingProfileId": "KKKK-LLLL-MMM-NNN", + "budgetName": "TestAlertRule", + "scope": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/billingProfiles/KKKK-LLLL-MMM-NNN" + }, + "responses": { + "200": { + "body": { + "name": "TestAlertRule", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157f\"", + "id": "/providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/billingProfiles/KKKK-LLLL-MMM-NNN/providers/Microsoft.CostManagement/budgets/TestAlertRule", + "properties": { + "category": "ReservationUtilization", + "filter": { + "dimensions": { + "name": "ReservedResourceType", + "operator": "In", + "values": [ + "VirtualMachines", + "SqlDatabases", + "CosmosDb" + ] + } + }, + "notifications": { + "Actual_LessThan_99_Percent": { + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "enabled": true, + "frequency": "Daily", + "locale": "en-us", + "operator": "LessThan", + "threshold": 99 + } + }, + "timeGrain": "Last30Days", + "timePeriod": { + "endDate": "2025-04-01T00:00:00Z", + "startDate": "2023-04-01T00:00:00Z" + } + } + } + } + }, + "operationId": "Budgets_Get", + "title": "Get-ReservationUtilization-AlertRule" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/Budgets/List/EA/BillingAccountBudgetsList-EA-CategoryTypeFilter.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/Budgets/List/EA/BillingAccountBudgetsList-EA-CategoryTypeFilter.json new file mode 100644 index 000000000000..87d02eae3e99 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/Budgets/List/EA/BillingAccountBudgetsList-EA-CategoryTypeFilter.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "$filter": "properties/category eq 'ReservationUtilization'", + "api-version": "2025-03-01", + "billingAccountId": "123456", + "scope": "providers/Microsoft.Billing/billingAccounts/123456" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "TestRUAlert", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157f\"", + "id": "/providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/budgets/TestRUAlert", + "properties": { + "category": "ReservationUtilization", + "filter": {}, + "notifications": { + "Actual_LessThan_99_Percent": { + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "enabled": true, + "frequency": "Weekly", + "locale": "en-us", + "operator": "LessThan", + "threshold": 99 + } + }, + "timeGrain": "Last7Days", + "timePeriod": { + "endDate": "2025-04-01T00:00:00Z", + "startDate": "2023-04-01T00:00:00Z" + } + } + } + ] + } + } + }, + "operationId": "Budgets_List", + "title": "BillingAccountBudgetsList-EA-CategoryTypeFilter" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/Budgets/List/EA/BillingAccountBudgetsList-EA.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/Budgets/List/EA/BillingAccountBudgetsList-EA.json new file mode 100644 index 000000000000..90883764c7b9 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/Budgets/List/EA/BillingAccountBudgetsList-EA.json @@ -0,0 +1,107 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "billingAccountId": "123456", + "scope": "providers/Microsoft.Billing/billingAccounts/123456" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "TestBudget1", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157c\"", + "id": "/providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/budgets/TestBudget1", + "properties": { + "amount": 10000, + "category": "Cost", + "currentSpend": { + "amount": 8000, + "unit": "USD" + }, + "notifications": { + "Actual_GreaterThanOrEqualTo_80_Percent": { + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "enabled": true, + "operator": "GreaterThanOrEqualTo", + "threshold": 80, + "thresholdType": "Actual" + } + }, + "timeGrain": "Monthly", + "timePeriod": { + "endDate": "2024-10-31T00:00:00Z", + "startDate": "2023-04-01T00:00:00Z" + } + } + }, + { + "name": "TestBudget2", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157d\"", + "id": "/providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/budgets/TestBudget2", + "properties": { + "amount": 15000, + "category": "Cost", + "currentSpend": { + "amount": 12000, + "unit": "USD" + }, + "notifications": { + "Actual_GreaterThanOrEqualTo_70_Percent": { + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "enabled": true, + "operator": "GreaterThanOrEqualTo", + "threshold": 70, + "thresholdType": "Actual" + } + }, + "timeGrain": "Monthly", + "timePeriod": { + "endDate": "2024-10-31T00:00:00Z", + "startDate": "2023-04-01T00:00:00Z" + } + } + }, + { + "name": "TestRUAlert", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157f\"", + "id": "/providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/budgets/TestRUAlert", + "properties": { + "category": "ReservationUtilization", + "filter": {}, + "notifications": { + "Actual_LessThan_99_Percent": { + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "enabled": true, + "frequency": "Weekly", + "locale": "en-us", + "operator": "LessThan", + "threshold": 99 + } + }, + "timeGrain": "Last7Days", + "timePeriod": { + "endDate": "2025-04-01T00:00:00Z", + "startDate": "2023-04-01T00:00:00Z" + } + } + } + ] + } + } + }, + "operationId": "Budgets_List", + "title": "BillingAccountBudgetsList-EA" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/Budgets/List/EA/DepartmentBudgetsList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/Budgets/List/EA/DepartmentBudgetsList.json new file mode 100644 index 000000000000..056e7f35fc06 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/Budgets/List/EA/DepartmentBudgetsList.json @@ -0,0 +1,80 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "billingAccountId": "123456", + "departmentId": "789101", + "scope": "providers/Microsoft.Billing/billingAccounts/123456/departments/789101" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "DepartmentBudget1", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157e\"", + "id": "/providers/Microsoft.Billing/billingAccounts/123456/departments/789101/providers/Microsoft.CostManagement/budgets/DepartmentBudget1", + "properties": { + "amount": 5000, + "category": "Cost", + "currentSpend": { + "amount": 3000, + "unit": "USD" + }, + "notifications": { + "Actual_GreaterThanOrEqualTo_60_Percent": { + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "enabled": true, + "operator": "GreaterThanOrEqualTo", + "threshold": 60, + "thresholdType": "Actual" + } + }, + "timeGrain": "Monthly", + "timePeriod": { + "endDate": "2024-10-31T00:00:00Z", + "startDate": "2023-04-01T00:00:00Z" + } + } + }, + { + "name": "DepartmentBudget2", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157f\"", + "id": "/providers/Microsoft.Billing/billingAccounts/123456/departments/789101/providers/Microsoft.CostManagement/budgets/DepartmentBudget2", + "properties": { + "amount": 8000, + "category": "Cost", + "currentSpend": { + "amount": 6000, + "unit": "USD" + }, + "notifications": { + "Actual_GreaterThanOrEqualTo_75_Percent": { + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "enabled": true, + "operator": "GreaterThanOrEqualTo", + "threshold": 75, + "thresholdType": "Actual" + } + }, + "timeGrain": "Monthly", + "timePeriod": { + "endDate": "2024-10-31T00:00:00Z", + "startDate": "2023-04-01T00:00:00Z" + } + } + } + ] + } + } + }, + "operationId": "Budgets_List", + "title": "DepartmentBudgetsList-EA" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/Budgets/List/EA/EnrollmentAccountBudgetsList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/Budgets/List/EA/EnrollmentAccountBudgetsList.json new file mode 100644 index 000000000000..d8a3e906c5b0 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/Budgets/List/EA/EnrollmentAccountBudgetsList.json @@ -0,0 +1,80 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "billingAccountId": "123456", + "enrollmentAccountId": "473845", + "scope": "providers/Microsoft.Billing/billingAccounts/123456/enrollmentAccounts/473845" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "EnrollmentAccountBudget1", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157e\"", + "id": "/providers/Microsoft.Billing/billingAccounts/123456/enrollmentAccounts/473845/providers/Microsoft.CostManagement/budgets/EnrollmentAccountBudget1", + "properties": { + "amount": 5000, + "category": "Cost", + "currentSpend": { + "amount": 3000, + "unit": "USD" + }, + "notifications": { + "Actual_GreaterThanOrEqualTo_60_Percent": { + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "enabled": true, + "operator": "GreaterThanOrEqualTo", + "threshold": 60, + "thresholdType": "Actual" + } + }, + "timeGrain": "Monthly", + "timePeriod": { + "endDate": "2024-10-31T00:00:00Z", + "startDate": "2023-04-01T00:00:00Z" + } + } + }, + { + "name": "EnrollmentAccountBudget2", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157f\"", + "id": "/providers/Microsoft.Billing/billingAccounts/123456/enrollmentAccounts/473845/providers/Microsoft.CostManagement/budgets/EnrollmentAccountBudget2", + "properties": { + "amount": 8000, + "category": "Cost", + "currentSpend": { + "amount": 6000, + "unit": "USD" + }, + "notifications": { + "Actual_GreaterThanOrEqualTo_75_Percent": { + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "enabled": true, + "operator": "GreaterThanOrEqualTo", + "threshold": 75, + "thresholdType": "Actual" + } + }, + "timeGrain": "Monthly", + "timePeriod": { + "endDate": "2024-10-31T00:00:00Z", + "startDate": "2023-04-01T00:00:00Z" + } + } + } + ] + } + } + }, + "operationId": "Budgets_List", + "title": "EnrollmentAccountBudgetsList-EA" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/Budgets/List/MCA/BillingAccountBudgetsList-MCA-CategoryTypeFilter.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/Budgets/List/MCA/BillingAccountBudgetsList-MCA-CategoryTypeFilter.json new file mode 100644 index 000000000000..1426cb98c39a --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/Budgets/List/MCA/BillingAccountBudgetsList-MCA-CategoryTypeFilter.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "$filter": "properties/category eq 'ReservationUtilization'", + "api-version": "2025-03-01", + "billingAccountId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01", + "scope": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "TestRUAlert", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157f\"", + "id": "/providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/billingProfiles/KKKK-LLLL-MMM-NNN/providers/Microsoft.CostManagement/budgets/TestRUAlert", + "properties": { + "category": "ReservationUtilization", + "filter": {}, + "notifications": { + "Actual_LessThan_99_Percent": { + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "enabled": true, + "frequency": "Daily", + "locale": "en-us", + "operator": "LessThan", + "threshold": 99 + } + }, + "timeGrain": "Last30Days", + "timePeriod": { + "endDate": "2025-04-01T00:00:00Z", + "startDate": "2023-04-01T00:00:00Z" + } + } + } + ] + } + } + }, + "operationId": "Budgets_List", + "title": "BillingAccountBudgetsList-MCA-CategoryTypeFilter" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/Budgets/List/MCA/BillingAccountBudgetsList-MCA.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/Budgets/List/MCA/BillingAccountBudgetsList-MCA.json new file mode 100644 index 000000000000..cd4ee6effff2 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/Budgets/List/MCA/BillingAccountBudgetsList-MCA.json @@ -0,0 +1,107 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "billingAccountId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01", + "scope": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "TestBudget1", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157c\"", + "id": "/providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/providers/Microsoft.CostManagement/budgets/TestBudget1", + "properties": { + "amount": 10000, + "category": "Cost", + "currentSpend": { + "amount": 8000, + "unit": "USD" + }, + "notifications": { + "Actual_GreaterThanOrEqualTo_80_Percent": { + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "enabled": true, + "operator": "GreaterThanOrEqualTo", + "threshold": 80, + "thresholdType": "Actual" + } + }, + "timeGrain": "Monthly", + "timePeriod": { + "endDate": "2024-10-31T00:00:00Z", + "startDate": "2023-04-01T00:00:00Z" + } + } + }, + { + "name": "TestBudget2", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157d\"", + "id": "/providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/providers/Microsoft.CostManagement/budgets/TestBudget2", + "properties": { + "amount": 15000, + "category": "Cost", + "currentSpend": { + "amount": 12000, + "unit": "USD" + }, + "notifications": { + "Actual_GreaterThanOrEqualTo_70_Percent": { + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "enabled": true, + "operator": "GreaterThanOrEqualTo", + "threshold": 70, + "thresholdType": "Actual" + } + }, + "timeGrain": "Monthly", + "timePeriod": { + "endDate": "2024-10-31T00:00:00Z", + "startDate": "2023-04-01T00:00:00Z" + } + } + }, + { + "name": "TestRUAlert", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157f\"", + "id": "/providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/billingProfiles/KKKK-LLLL-MMM-NNN/providers/Microsoft.CostManagement/budgets/TestRUAlert", + "properties": { + "category": "ReservationUtilization", + "filter": {}, + "notifications": { + "Actual_LessThan_99_Percent": { + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "enabled": true, + "frequency": "Daily", + "locale": "en-us", + "operator": "LessThan", + "threshold": 99 + } + }, + "timeGrain": "Last30Days", + "timePeriod": { + "endDate": "2025-04-01T00:00:00Z", + "startDate": "2023-04-01T00:00:00Z" + } + } + } + ] + } + } + }, + "operationId": "Budgets_List", + "title": "BillingAccountBudgetsList-MCA" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/Budgets/List/MCA/BillingProfileBudgetsList-CategoryTypeFilter.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/Budgets/List/MCA/BillingProfileBudgetsList-CategoryTypeFilter.json new file mode 100644 index 000000000000..83a789e315ce --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/Budgets/List/MCA/BillingProfileBudgetsList-CategoryTypeFilter.json @@ -0,0 +1,85 @@ +{ + "parameters": { + "$filter": "properties/category eq 'ReservationUtilization'", + "api-version": "2025-03-01", + "billingAccountId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01", + "billingProfileId": "MYDEVTESTBP", + "scope": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/billingProfiles/MYDEVTESTBP" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "TestRUAlert1", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157f\"", + "id": "/providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/billingProfiles/MYDEVTESTBP/providers/Microsoft.CostManagement/budgets/TestRUAlert1", + "properties": { + "category": "ReservationUtilization", + "filter": {}, + "notifications": { + "Actual_LessThan_99_Percent": { + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "enabled": true, + "frequency": "Daily", + "locale": "en-us", + "operator": "LessThan", + "threshold": 99 + } + }, + "timeGrain": "Last30Days", + "timePeriod": { + "endDate": "2025-04-01T00:00:00Z", + "startDate": "2023-04-01T00:00:00Z" + } + } + }, + { + "name": "TestRUAlert2", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157f\"", + "id": "/providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/billingProfiles/MYDEVTESTBP/providers/Microsoft.CostManagement/budgets/TestRUAlert2", + "properties": { + "category": "ReservationUtilization", + "filter": { + "dimensions": { + "name": "ReservationId", + "operator": "In", + "values": [ + "00000000-0000-0000-0000-000000000000", + "00000000-0000-0000-0000-000000000001", + "00000000-0000-0000-0000-000000000002" + ] + } + }, + "notifications": { + "Actual_LessThan_99_Percent": { + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "enabled": true, + "frequency": "Daily", + "locale": "en-us", + "operator": "LessThan", + "threshold": 80 + } + }, + "timeGrain": "Last7Days", + "timePeriod": { + "endDate": "2025-04-01T00:00:00Z", + "startDate": "2023-04-01T00:00:00Z" + } + } + } + ] + } + } + }, + "operationId": "Budgets_List", + "title": "BillingProfileBudgetsList-MCA-CategoryTypeFilter" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/Budgets/List/MCA/BillingProfileBudgetsList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/Budgets/List/MCA/BillingProfileBudgetsList.json new file mode 100644 index 000000000000..2ca71c58ae07 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/Budgets/List/MCA/BillingProfileBudgetsList.json @@ -0,0 +1,146 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "billingAccountId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01", + "billingProfileId": "MYDEVTESTBP", + "scope": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/billingProfiles/MYDEVTESTBP" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "TestBudget1", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157c\"", + "id": "/providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/billingProfiles/MYDEVTESTBP/providers/Microsoft.CostManagement/budgets/TestBudget1", + "properties": { + "amount": 200, + "category": "Cost", + "currentSpend": { + "amount": 30, + "unit": "USD" + }, + "notifications": { + "Actual_GreaterThanOrEqualTo_80_Percent": { + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "enabled": true, + "operator": "GreaterThanOrEqualTo", + "threshold": 80, + "thresholdType": "Actual" + } + }, + "timeGrain": "Monthly", + "timePeriod": { + "endDate": "2024-10-31T00:00:00Z", + "startDate": "2023-04-01T00:00:00Z" + } + } + }, + { + "name": "TestBudget2", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157d\"", + "id": "/providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/billingProfiles/MYDEVTESTBP/providers/Microsoft.CostManagement/budgets/TestBudget2", + "properties": { + "amount": 600, + "category": "Cost", + "currentSpend": { + "amount": 20, + "unit": "USD" + }, + "notifications": { + "Actual_GreaterThanOrEqualTo_70_Percent": { + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "enabled": true, + "operator": "GreaterThanOrEqualTo", + "threshold": 70, + "thresholdType": "Actual" + } + }, + "timeGrain": "Monthly", + "timePeriod": { + "endDate": "2024-10-31T00:00:00Z", + "startDate": "2023-04-01T00:00:00Z" + } + } + }, + { + "name": "TestRUAlert1", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157f\"", + "id": "/providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/billingProfiles/MYDEVTESTBP/providers/Microsoft.CostManagement/budgets/TestRUAlert1", + "properties": { + "category": "ReservationUtilization", + "filter": {}, + "notifications": { + "Actual_LessThan_99_Percent": { + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "enabled": true, + "frequency": "Daily", + "locale": "en-us", + "operator": "LessThan", + "threshold": 99 + } + }, + "timeGrain": "Last30Days", + "timePeriod": { + "endDate": "2025-04-01T00:00:00Z", + "startDate": "2023-04-01T00:00:00Z" + } + } + }, + { + "name": "TestRUAlert2", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157f\"", + "id": "/providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/billingProfiles/MYDEVTESTBP/providers/Microsoft.CostManagement/budgets/TestRUAlert2", + "properties": { + "category": "ReservationUtilization", + "filter": { + "dimensions": { + "name": "ReservationId", + "operator": "In", + "values": [ + "00000000-0000-0000-0000-000000000000", + "00000000-0000-0000-0000-000000000001", + "00000000-0000-0000-0000-000000000002" + ] + } + }, + "notifications": { + "Actual_LessThan_99_Percent": { + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "enabled": true, + "frequency": "Daily", + "locale": "en-us", + "operator": "LessThan", + "threshold": 80 + } + }, + "timeGrain": "Last7Days", + "timePeriod": { + "endDate": "2025-04-01T00:00:00Z", + "startDate": "2023-04-01T00:00:00Z" + } + } + } + ] + } + } + }, + "operationId": "Budgets_List", + "title": "BillingProfileBudgetsList-MCA" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/Budgets/List/MCA/CustomerBudgetsList-CategoryTypeFilter.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/Budgets/List/MCA/CustomerBudgetsList-CategoryTypeFilter.json new file mode 100644 index 000000000000..4ff91720b0b7 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/Budgets/List/MCA/CustomerBudgetsList-CategoryTypeFilter.json @@ -0,0 +1,85 @@ +{ + "parameters": { + "$filter": "properties/category eq 'ReservationUtilization'", + "api-version": "2025-03-01", + "billingAccountId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01", + "customerId": "000000-1111-2222-3333-444444444444", + "scope": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/customers/000000-1111-2222-3333-444444444444" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "TestRUAlert1", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157f\"", + "id": "/providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/customers/000000-1111-2222-3333-444444444444/providers/Microsoft.CostManagement/budgets/TestRUAlert1", + "properties": { + "category": "ReservationUtilization", + "filter": {}, + "notifications": { + "Actual_LessThan_99_Percent": { + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "enabled": true, + "frequency": "Daily", + "locale": "en-us", + "operator": "LessThan", + "threshold": 99 + } + }, + "timeGrain": "Last30Days", + "timePeriod": { + "endDate": "2025-04-01T00:00:00Z", + "startDate": "2023-04-01T00:00:00Z" + } + } + }, + { + "name": "TestRUAlert2", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157f\"", + "id": "/providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/customers/000000-1111-2222-3333-444444444444/providers/Microsoft.CostManagement/budgets/TestRUAlert2", + "properties": { + "category": "ReservationUtilization", + "filter": { + "dimensions": { + "name": "ReservationId", + "operator": "In", + "values": [ + "00000000-0000-0000-0000-000000000000", + "00000000-0000-0000-0000-000000000001", + "00000000-0000-0000-0000-000000000002" + ] + } + }, + "notifications": { + "Actual_LessThan_99_Percent": { + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "enabled": true, + "frequency": "Daily", + "locale": "en-us", + "operator": "LessThan", + "threshold": 80 + } + }, + "timeGrain": "Last7Days", + "timePeriod": { + "endDate": "2025-04-01T00:00:00Z", + "startDate": "2023-04-01T00:00:00Z" + } + } + } + ] + } + } + }, + "operationId": "Budgets_List", + "title": "CustomerBudgetsList-MCA-CSP-CategoryTypeFilter" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/Budgets/List/MCA/CustomerBudgetsList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/Budgets/List/MCA/CustomerBudgetsList.json new file mode 100644 index 000000000000..f13f583235b1 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/Budgets/List/MCA/CustomerBudgetsList.json @@ -0,0 +1,146 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "billingAccountId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01", + "customerId": "000000-1111-2222-3333-444444444444", + "scope": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/customers/000000-1111-2222-3333-444444444444" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "TestBudget1", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157c\"", + "id": "/providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/customers/000000-1111-2222-3333-444444444444", + "properties": { + "amount": 200, + "category": "Cost", + "currentSpend": { + "amount": 30, + "unit": "USD" + }, + "notifications": { + "Actual_GreaterThanOrEqualTo_80_Percent": { + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "enabled": true, + "operator": "GreaterThanOrEqualTo", + "threshold": 80, + "thresholdType": "Actual" + } + }, + "timeGrain": "Monthly", + "timePeriod": { + "endDate": "2024-10-31T00:00:00Z", + "startDate": "2023-04-01T00:00:00Z" + } + } + }, + { + "name": "TestBudget2", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157d\"", + "id": "/providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/customers/000000-1111-2222-3333-444444444444/providers/Microsoft.CostManagement/budgets/TestBudget2", + "properties": { + "amount": 600, + "category": "Cost", + "currentSpend": { + "amount": 20, + "unit": "USD" + }, + "notifications": { + "Actual_GreaterThanOrEqualTo_70_Percent": { + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "enabled": true, + "operator": "GreaterThanOrEqualTo", + "threshold": 70, + "thresholdType": "Actual" + } + }, + "timeGrain": "Monthly", + "timePeriod": { + "endDate": "2024-10-31T00:00:00Z", + "startDate": "2023-04-01T00:00:00Z" + } + } + }, + { + "name": "TestRUAlert1", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157f\"", + "id": "/providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/customers/000000-1111-2222-3333-444444444444/providers/Microsoft.CostManagement/budgets/TestRUAlert1", + "properties": { + "category": "ReservationUtilization", + "filter": {}, + "notifications": { + "Actual_LessThan_99_Percent": { + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "enabled": true, + "frequency": "Daily", + "locale": "en-us", + "operator": "LessThan", + "threshold": 99 + } + }, + "timeGrain": "Last30Days", + "timePeriod": { + "endDate": "2025-04-01T00:00:00Z", + "startDate": "2023-04-01T00:00:00Z" + } + } + }, + { + "name": "TestRUAlert2", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157f\"", + "id": "/providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/customers/000000-1111-2222-3333-444444444444/providers/Microsoft.CostManagement/budgets/TestRUAlert2", + "properties": { + "category": "ReservationUtilization", + "filter": { + "dimensions": { + "name": "ReservationId", + "operator": "In", + "values": [ + "00000000-0000-0000-0000-000000000000", + "00000000-0000-0000-0000-000000000001", + "00000000-0000-0000-0000-000000000002" + ] + } + }, + "notifications": { + "Actual_LessThan_99_Percent": { + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "enabled": true, + "frequency": "Daily", + "locale": "en-us", + "operator": "LessThan", + "threshold": 80 + } + }, + "timeGrain": "Last7Days", + "timePeriod": { + "endDate": "2025-04-01T00:00:00Z", + "startDate": "2023-04-01T00:00:00Z" + } + } + } + ] + } + } + }, + "operationId": "Budgets_List", + "title": "CustomerBudgetsList-MCA-CSP" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/Budgets/List/MCA/InvoiceSectionBudgetsList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/Budgets/List/MCA/InvoiceSectionBudgetsList.json new file mode 100644 index 000000000000..d7faaa20e016 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/Budgets/List/MCA/InvoiceSectionBudgetsList.json @@ -0,0 +1,81 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "billingAccountId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01", + "billingProfileId": "MYDEVTESTBP", + "invoiceSectionId": "AAAA-BBBB-CCC-DDD", + "scope": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/billingProfiles/MYDEVTESTBP/invoiceSections/AAAA-BBBB-CCC-DDD" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "TestBudget1", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157c\"", + "id": "/providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/billingProfiles/MYDEVTESTBP/invoiceSections/AAAA-BBBB-CCC-DDD/providers/Microsoft.CostManagement/budgets/TestBudget1", + "properties": { + "amount": 20, + "category": "Cost", + "currentSpend": { + "amount": 5, + "unit": "USD" + }, + "notifications": { + "Actual_GreaterThanOrEqualTo_80_Percent": { + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "enabled": true, + "operator": "GreaterThanOrEqualTo", + "threshold": 80, + "thresholdType": "Actual" + } + }, + "timeGrain": "Monthly", + "timePeriod": { + "endDate": "2024-10-31T00:00:00Z", + "startDate": "2023-04-01T00:00:00Z" + } + } + }, + { + "name": "TestBudget2", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157d\"", + "id": "/providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/billingProfiles/MYDEVTESTBP/invoiceSections/AAAA-BBBB-CCC-DDD/providers/Microsoft.CostManagement/budgets/TestBudget2", + "properties": { + "amount": 60, + "category": "Cost", + "currentSpend": { + "amount": 20, + "unit": "USD" + }, + "notifications": { + "Actual_GreaterThanOrEqualTo_70_Percent": { + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "enabled": true, + "operator": "GreaterThanOrEqualTo", + "threshold": 70, + "thresholdType": "Actual" + } + }, + "timeGrain": "Monthly", + "timePeriod": { + "endDate": "2024-10-31T00:00:00Z", + "startDate": "2023-04-01T00:00:00Z" + } + } + } + ] + } + } + }, + "operationId": "Budgets_List", + "title": "InvoiceSectionBudgetsList-MCA" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/Budgets/List/RBAC/ManagementGroupBudgetsList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/Budgets/List/RBAC/ManagementGroupBudgetsList.json new file mode 100644 index 000000000000..760d08da8d34 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/Budgets/List/RBAC/ManagementGroupBudgetsList.json @@ -0,0 +1,224 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "scope": "Microsoft.Management/managementGroups/MYDEVTESTMG", + "subscriptionId": "MYDEVTESTMG" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "TestBudget", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157f\"", + "id": "/providers/Microsoft.Management/managementGroups/MYDEVTESTMG/providers/Microsoft.CostManagement/budgets/TestBudget", + "properties": { + "amount": 10000, + "category": "Cost", + "currentSpend": { + "amount": 8000.89, + "unit": "USD" + }, + "filter": {}, + "notifications": { + "Actual_GreaterThanOrEqualTo_80_Percent": { + "contactEmails": [ + "managers@contoso.com" + ], + "enabled": true, + "operator": "GreaterThan", + "threshold": 80, + "thresholdType": "Actual" + } + }, + "timeGrain": "Monthly", + "timePeriod": { + "endDate": "2024-10-31T00:00:00Z", + "startDate": "2023-04-01T00:00:00Z" + } + } + }, + { + "name": "TestBudget", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157f\"", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/budgets/TestBudget", + "properties": { + "amount": 600.65, + "category": "Cost", + "currentSpend": { + "amount": 120.89, + "unit": "USD" + }, + "filter": {}, + "notifications": { + "Actual_GreaterThanOrEqualTo_60_Percent": { + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "contactGroups": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/microsoft.insights/actionGroups/SampleActionGroup" + ], + "contactRoles": [ + "Contributor", + "Reader" + ], + "enabled": true, + "operator": "GreaterThanOrEqualTo", + "threshold": 60, + "thresholdType": "Actual" + } + }, + "timeGrain": "Monthly", + "timePeriod": { + "endDate": "2024-10-31T00:00:00Z", + "startDate": "2023-04-01T00:00:00Z" + } + } + }, + { + "name": "TestBudget", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157f\"", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/budgets/TestBudget", + "properties": { + "amount": 100.65, + "category": "Cost", + "currentSpend": { + "amount": 80.89, + "unit": "USD" + }, + "filter": { + "and": [ + { + "dimensions": { + "name": "ResourceId", + "operator": "In", + "values": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/MSVM2", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/platformcloudplatformGeneric1" + ] + } + }, + { + "tags": { + "name": "category", + "operator": "In", + "values": [ + "Dev", + "Prod" + ] + } + }, + { + "tags": { + "name": "department", + "operator": "In", + "values": [ + "engineering", + "sales" + ] + } + } + ] + }, + "notifications": { + "Actual_GreaterThanOrEqualTo_90_Percent": { + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "contactGroups": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/microsoft.insights/actionGroups/SampleActionGroup" + ], + "contactRoles": [ + "Contributor", + "Reader" + ], + "enabled": true, + "operator": "GreaterThanOrEqualTo", + "threshold": 90, + "thresholdType": "Actual" + }, + "Actual_GreaterThan_80_Percent": { + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "contactRoles": [ + "Contributor", + "Reader" + ], + "enabled": true, + "operator": "GreaterThan", + "threshold": 80 + } + }, + "timeGrain": "Monthly", + "timePeriod": { + "endDate": "2024-10-31T00:00:00Z", + "startDate": "2023-04-01T00:00:00Z" + } + } + }, + { + "name": "TestBudget1", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157f\"", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/budgets/TestBudget1", + "properties": { + "amount": 200.65, + "category": "Cost", + "currentSpend": { + "amount": 120.89, + "unit": "USD" + }, + "filter": {}, + "notifications": { + "Actual_GreaterThanOrEqualTo_60_Percent": { + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "contactGroups": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/microsoft.insights/actionGroups/SampleActionGroup" + ], + "contactRoles": [ + "Contributor", + "Reader" + ], + "enabled": true, + "operator": "GreaterThanOrEqualTo", + "threshold": 60, + "thresholdType": "Actual" + }, + "Actual_GreaterThan_40_Percent": { + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "contactRoles": [ + "Contributor", + "Reader" + ], + "enabled": true, + "operator": "GreaterThan", + "threshold": 40 + } + }, + "timeGrain": "Monthly", + "timePeriod": { + "endDate": "2024-10-31T00:00:00Z", + "startDate": "2023-04-01T00:00:00Z" + } + } + } + ] + } + } + }, + "operationId": "Budgets_List", + "title": "ManagementGroupBudgetsList" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/Budgets/List/RBAC/ResourceGroupBudgetsList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/Budgets/List/RBAC/ResourceGroupBudgetsList.json new file mode 100644 index 000000000000..93661c384e36 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/Budgets/List/RBAC/ResourceGroupBudgetsList.json @@ -0,0 +1,155 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "resourceGroupName": "MYDEVTESTRG", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "TestBudget0", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157f\"", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/budgets/TestBudget0", + "properties": { + "amount": 100.65, + "category": "Cost", + "currentSpend": { + "amount": 80.89, + "unit": "USD" + }, + "filter": { + "and": [ + { + "dimensions": { + "name": "ResourceId", + "operator": "In", + "values": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/MSVM2", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/platformcloudplatformGeneric1" + ] + } + }, + { + "tags": { + "name": "category", + "operator": "In", + "values": [ + "Dev", + "Prod" + ] + } + }, + { + "tags": { + "name": "department", + "operator": "In", + "values": [ + "engineering", + "sales" + ] + } + } + ] + }, + "notifications": { + "Actual_GreaterThanOrEqualTo_90_Percent": { + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "contactGroups": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/microsoft.insights/actionGroups/SampleActionGroup" + ], + "contactRoles": [ + "Contributor", + "Reader" + ], + "enabled": true, + "operator": "GreaterThanOrEqualTo", + "threshold": 90, + "thresholdType": "Actual" + }, + "Actual_GreaterThan_80_Percent": { + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "contactRoles": [ + "Contributor", + "Reader" + ], + "enabled": true, + "operator": "GreaterThan", + "threshold": 80 + } + }, + "timeGrain": "Monthly", + "timePeriod": { + "endDate": "2024-10-31T00:00:00Z", + "startDate": "2023-04-01T00:00:00Z" + } + } + }, + { + "name": "TestBudget1", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157f\"", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/budgets/TestBudget1", + "properties": { + "amount": 200.65, + "category": "Cost", + "currentSpend": { + "amount": 120.89, + "unit": "USD" + }, + "filter": {}, + "notifications": { + "Actual_GreaterThanOrEqualTo_60_Percent": { + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "contactGroups": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/microsoft.insights/actionGroups/SampleActionGroup" + ], + "contactRoles": [ + "Contributor", + "Reader" + ], + "enabled": true, + "operator": "GreaterThanOrEqualTo", + "threshold": 60, + "thresholdType": "Actual" + }, + "Actual_GreaterThan_40_Percent": { + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "contactRoles": [ + "Contributor", + "Reader" + ], + "enabled": true, + "operator": "GreaterThan", + "threshold": 40 + } + }, + "timeGrain": "Monthly", + "timePeriod": { + "endDate": "2024-10-31T00:00:00Z", + "startDate": "2023-04-01T00:00:00Z" + } + } + } + ] + } + } + }, + "operationId": "Budgets_List", + "title": "ResourceGroupBudgetsList" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/Budgets/List/RBAC/SubscriptionBudgetsList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/Budgets/List/RBAC/SubscriptionBudgetsList.json new file mode 100644 index 000000000000..fd4b7da4b177 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/Budgets/List/RBAC/SubscriptionBudgetsList.json @@ -0,0 +1,193 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "TestBudget", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157f\"", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/budgets/TestBudget", + "properties": { + "amount": 600.65, + "category": "Cost", + "currentSpend": { + "amount": 120.89, + "unit": "USD" + }, + "filter": {}, + "notifications": { + "Actual_GreaterThanOrEqualTo_60_Percent": { + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "contactGroups": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/microsoft.insights/actionGroups/SampleActionGroup" + ], + "contactRoles": [ + "Contributor", + "Reader" + ], + "enabled": true, + "operator": "GreaterThanOrEqualTo", + "threshold": 60, + "thresholdType": "Actual" + } + }, + "timeGrain": "Monthly", + "timePeriod": { + "endDate": "2024-10-31T00:00:00Z", + "startDate": "2023-04-01T00:00:00Z" + } + } + }, + { + "name": "TestBudget", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157f\"", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/budgets/TestBudget", + "properties": { + "amount": 100.65, + "category": "Cost", + "currentSpend": { + "amount": 80.89, + "unit": "USD" + }, + "filter": { + "and": [ + { + "dimensions": { + "name": "ResourceId", + "operator": "In", + "values": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/MSVM2", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/platformcloudplatformGeneric1" + ] + } + }, + { + "tags": { + "name": "category", + "operator": "In", + "values": [ + "Dev", + "Prod" + ] + } + }, + { + "tags": { + "name": "department", + "operator": "In", + "values": [ + "engineering", + "sales" + ] + } + } + ] + }, + "notifications": { + "Actual_GreaterThanOrEqualTo_90_Percent": { + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "contactGroups": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/microsoft.insights/actionGroups/SampleActionGroup" + ], + "contactRoles": [ + "Contributor", + "Reader" + ], + "enabled": true, + "operator": "GreaterThanOrEqualTo", + "threshold": 90, + "thresholdType": "Actual" + }, + "Actual_GreaterThan_80_Percent": { + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "contactRoles": [ + "Contributor", + "Reader" + ], + "enabled": true, + "operator": "GreaterThan", + "threshold": 80 + } + }, + "timeGrain": "Monthly", + "timePeriod": { + "endDate": "2024-10-31T00:00:00Z", + "startDate": "2023-04-01T00:00:00Z" + } + } + }, + { + "name": "TestBudget1", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157f\"", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/budgets/TestBudget1", + "properties": { + "amount": 200.65, + "category": "Cost", + "currentSpend": { + "amount": 120.89, + "unit": "USD" + }, + "filter": {}, + "notifications": { + "Actual_GreaterThanOrEqualTo_60_Percent": { + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "contactGroups": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/microsoft.insights/actionGroups/SampleActionGroup" + ], + "contactRoles": [ + "Contributor", + "Reader" + ], + "enabled": true, + "operator": "GreaterThanOrEqualTo", + "threshold": 60, + "thresholdType": "Actual" + }, + "Actual_GreaterThan_40_Percent": { + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "contactRoles": [ + "Contributor", + "Reader" + ], + "enabled": true, + "operator": "GreaterThan", + "threshold": 40 + } + }, + "timeGrain": "Monthly", + "timePeriod": { + "endDate": "2024-10-31T00:00:00Z", + "startDate": "2023-04-01T00:00:00Z" + } + } + } + ] + } + } + }, + "operationId": "Budgets_List", + "title": "SubscriptionBudgetsList" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/CostAllocationRuleCheckNameAvailability.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/CostAllocationRuleCheckNameAvailability.json new file mode 100644 index 000000000000..72cf6baa94e1 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/CostAllocationRuleCheckNameAvailability.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "billingAccountId": "100", + "costAllocationRuleCheckNameAvailabilityRequest": { + "name": "testRule", + "type": "Microsoft.CostManagement/costAllocationRules" + } + }, + "responses": { + "200": { + "body": { + "message": "A cost allocation rule with name testRule is already present for the billing account 100. Please specify a differnt name.", + "nameAvailable": false, + "reason": "AlreadyExists" + } + } + }, + "operationId": "CostAllocationRules_CheckNameAvailability", + "title": "CostAllocationRuleCheckNameAvailability" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/CostAllocationRuleCreate.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/CostAllocationRuleCreate.json new file mode 100644 index 000000000000..aa2e7e9e4964 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/CostAllocationRuleCreate.json @@ -0,0 +1,128 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "billingAccountId": "100", + "costAllocationRule": { + "properties": { + "description": "This is a testRule", + "status": "Active", + "details": { + "sourceResources": [ + { + "name": "ResourceGroupName", + "resourceType": "Dimension", + "values": [ + "sampleRG", + "secondRG" + ] + } + ], + "targetResources": [ + { + "name": "ResourceGroupName", + "policyType": "FixedProportion", + "resourceType": "Dimension", + "values": [ + { + "name": "destinationRG", + "percentage": 45 + }, + { + "name": "destinationRG2", + "percentage": 54 + } + ] + } + ] + } + } + }, + "ruleName": "testRule" + }, + "responses": { + "200": { + "body": { + "name": "testRule", + "type": "Microsoft.CostManagement/costAllocationRules", + "id": "/providers/Microsoft.Billing/billingAccounts/100/providers/Microsoft.CostManagement/costAllocationRules/testRule", + "properties": { + "description": "This is a testRule", + "createdDate": "2020-06-18T22:21:51.1287144Z", + "status": "Creating", + "updatedDate": "2020-06-18T22:21:51.1287144Z", + "details": { + "sourceResources": [ + { + "name": "ResourceGroupName", + "resourceType": "Dimension", + "values": [ + "sampleRG" + ] + } + ], + "targetResources": [ + { + "name": "ResourceGroupName", + "policyType": "FixedProportion", + "resourceType": "Dimension", + "values": [ + { + "name": "destinationRG", + "percentage": 50 + }, + { + "name": "destinationRG2", + "percentage": 50 + } + ] + } + ] + } + } + } + }, + "201": { + "body": { + "name": "testRule", + "type": "Microsoft.CostManagement/costAllocationRules", + "id": "/providers/Microsoft.Billing/billingAccounts/100/providers/Microsoft.CostManagement/costAllocationRules/testRule", + "properties": { + "description": "This is a testRule", + "createdDate": "2020-06-18T22:21:51.1287144Z", + "status": "Creating", + "updatedDate": "2020-06-18T22:21:51.1287144Z", + "details": { + "sourceResources": [ + { + "name": "ResourceGroupName", + "resourceType": "Dimension", + "values": [ + "sampleRG" + ] + } + ], + "targetResources": [ + { + "name": "ResourceGroupName", + "policyType": "FixedProportion", + "resourceType": "Dimension", + "values": [ + { + "name": "destinationRG", + "percentage": 50 + }, + { + "name": "destinationRG2", + "percentage": 50 + } + ] + } + ] + } + } + } + } + }, + "operationId": "CostAllocationRules_CreateOrUpdate", + "title": "CostAllocationRulesCreateResourceGroup" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/CostAllocationRuleCreateTag.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/CostAllocationRuleCreateTag.json new file mode 100644 index 000000000000..1316efffee8f --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/CostAllocationRuleCreateTag.json @@ -0,0 +1,131 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "billingAccountId": "100", + "costAllocationRule": { + "properties": { + "description": "This is a testRule", + "status": "Active", + "details": { + "sourceResources": [ + { + "name": "category", + "resourceType": "Tag", + "values": [ + "devops" + ] + } + ], + "targetResources": [ + { + "name": "ResourceGroupName", + "policyType": "FixedProportion", + "resourceType": "Dimension", + "values": [ + { + "name": "destinationRG", + "percentage": 33.33 + }, + { + "name": "destinationRG2", + "percentage": 33.33 + }, + { + "name": "destinationRG3", + "percentage": 33.34 + } + ] + } + ] + } + } + }, + "ruleName": "testRule" + }, + "responses": { + "200": { + "body": { + "name": "testRule", + "type": "Microsoft.CostManagement/costAllocationRules", + "id": "/providers/Microsoft.Billing/billingAccounts/100/providers/Microsoft.CostManagement/costAllocationRules/testRule", + "properties": { + "description": "This is a testRule", + "createdDate": "2020-06-18T22:21:51.1287144Z", + "status": "Creating", + "updatedDate": "2020-06-18T22:21:51.1287144Z", + "details": { + "sourceResources": [ + { + "name": "ResourceGroupName", + "resourceType": "Dimension", + "values": [ + "sampleRG" + ] + } + ], + "targetResources": [ + { + "name": "ResourceGroupName", + "policyType": "FixedProportion", + "resourceType": "Dimension", + "values": [ + { + "name": "destinationRG", + "percentage": 50 + }, + { + "name": "destinationRG2", + "percentage": 50 + } + ] + } + ] + } + } + } + }, + "201": { + "body": { + "name": "testRule", + "type": "Microsoft.CostManagement/costAllocationRules", + "id": "/providers/Microsoft.Billing/billingAccounts/100/providers/Microsoft.CostManagement/costAllocationRules/testRule", + "properties": { + "description": "This is a testRule", + "createdDate": "2020-06-18T22:21:51.1287144Z", + "status": "Creating", + "updatedDate": "2020-06-18T22:21:51.1287144Z", + "details": { + "sourceResources": [ + { + "name": "ResourceGroupName", + "resourceType": "Dimension", + "values": [ + "sampleRG" + ] + } + ], + "targetResources": [ + { + "name": "ResourceGroupName", + "policyType": "FixedProportion", + "resourceType": "Dimension", + "values": [ + { + "name": "destinationRG", + "percentage": 50 + }, + { + "name": "destinationRG2", + "percentage": 50 + } + ] + } + ] + } + } + } + } + }, + "operationId": "CostAllocationRules_CreateOrUpdate", + "title": "CostAllocationRulesCreateTag" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/CostAllocationRuleDelete.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/CostAllocationRuleDelete.json new file mode 100644 index 000000000000..cf56e0154c3e --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/CostAllocationRuleDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "billingAccountId": "100", + "ruleName": "testRule" + }, + "responses": { + "200": {}, + "204": {} + }, + "operationId": "CostAllocationRules_Delete", + "title": "DeleteCostAllocationRule" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/CostAllocationRuleGet.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/CostAllocationRuleGet.json new file mode 100644 index 000000000000..6b606e4e630f --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/CostAllocationRuleGet.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "billingAccountId": "100", + "ruleName": "testRule" + }, + "responses": { + "200": { + "body": { + "name": "testRule", + "type": "Microsoft.CostManagement/costAllocationRules", + "id": "/providers/Microsoft.Billing/billingAccounts/100/providers/Microsoft.CostManagement/costAllocationRules/testRule", + "properties": { + "description": "This is a testRule", + "createdDate": "2020-06-18T22:21:51.1287144Z", + "status": "NotActive", + "updatedDate": "2020-06-18T22:21:51.1287144Z", + "details": { + "sourceResources": [ + { + "name": "ResourceGroupName", + "resourceType": "Dimension", + "values": [ + "sampleRG" + ] + } + ], + "targetResources": [ + { + "name": "ResourceGroupName", + "policyType": "FixedProportion", + "resourceType": "Dimension", + "values": [ + { + "name": "destinationRG", + "percentage": 50 + }, + { + "name": "destinationRG2", + "percentage": 50 + } + ] + } + ] + } + } + } + } + }, + "operationId": "CostAllocationRules_Get", + "title": "CostAllocationRules" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/CostAllocationRulesList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/CostAllocationRulesList.json new file mode 100644 index 000000000000..1b299794ca3a --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/CostAllocationRulesList.json @@ -0,0 +1,130 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "billingAccountId": "100" + }, + "responses": { + "200": { + "body": { + "nextLink": null, + "value": [ + { + "name": "testRule", + "type": "Microsoft.CostManagement/costAllocationRules", + "id": "/providers/Microsoft.Billing/billingAccounts/100/providers/Microsoft.CostManagement/costAllocationRules/testRule", + "properties": { + "description": "This is a testRule", + "createdDate": "2020-06-18T22:21:51.1287144Z", + "status": "NotActive", + "updatedDate": "2020-06-18T22:21:51.1287144Z", + "details": { + "sourceResources": [ + { + "name": "ResourceGroupName", + "resourceType": "Dimension", + "values": [ + "sampleRG" + ] + } + ], + "targetResources": [ + { + "name": "ResourceGroupName", + "policyType": "FixedProportion", + "resourceType": "Dimension", + "values": [ + { + "name": "destinationRG", + "percentage": 50 + }, + { + "name": "destinationRG2", + "percentage": 50 + } + ] + } + ] + } + } + }, + { + "name": "testRule2", + "type": "Microsoft.CostManagement/costAllocationRules", + "id": "/providers/Microsoft.Billing/billingAccounts/100/providers/Microsoft.CostManagement/costAllocationRules/testRule2", + "properties": { + "description": "This is a second test Rule", + "createdDate": "2020-06-18T22:21:51.1287144Z", + "status": "Active", + "updatedDate": "2020-06-18T22:21:51.1287144Z", + "details": { + "sourceResources": [ + { + "name": "SubscriptionId", + "resourceType": "Dimension", + "values": [ + "2A002F2D-536F-4D7C-90DA-3D0BAE879B0E" + ] + } + ], + "targetResources": [ + { + "name": "category", + "policyType": "FixedProportion", + "resourceType": "Tag", + "values": [ + { + "name": "devops", + "percentage": 100 + } + ] + } + ] + } + } + }, + { + "name": "testRule3", + "type": "Microsoft.CostManagement/costAllocationRules", + "id": "/providers/Microsoft.Billing/billingAccounts/100/providers/Microsoft.CostManagement/costAllocationRules/testRule3", + "properties": { + "description": "This is a third test Rule", + "createdDate": "2020-06-18T22:21:51.1287144Z", + "status": "Active", + "updatedDate": "2020-06-18T22:21:51.1287144Z", + "details": { + "sourceResources": [ + { + "name": "category", + "resourceType": "Tag", + "values": [ + "devops" + ] + } + ], + "targetResources": [ + { + "name": "ResourceGroupName", + "policyType": "FixedProportion", + "resourceType": "Dimension", + "values": [ + { + "name": "ResourceGroup", + "percentage": 55.55 + }, + { + "name": "ResourceGroupSecond", + "percentage": 44.45 + } + ] + } + ] + } + } + } + ] + } + } + }, + "operationId": "CostAllocationRules_List", + "title": "CostAllocationRulesList" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/CostDetailsOperationResultsBySubscriptionScope.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/CostDetailsOperationResultsBySubscriptionScope.json new file mode 100644 index 000000000000..04cecf827f37 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/CostDetailsOperationResultsBySubscriptionScope.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "operationId": "00000000-0000-0000-0000-000000000000", + "api-version": "2025-03-01", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "00000000-0000-0000-0000-000000000000", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000", + "manifest": { + "blobCount": 1, + "blobs": [ + { + "blobLink": "https://ccmreportstorageeastus.blob.core.windows.net/armreports/00000/00000000-0000-0000-0000-000000000000?sv=2020-05-31&sr=b&sig=abcd", + "byteCount": 32741 + } + ], + "byteCount": 32741, + "compressData": false, + "dataFormat": "Csv", + "manifestVersion": "2025-03-01", + "requestContext": { + "requestBody": { + "metric": "ActualCost", + "timePeriod": { + "end": "2020-03-15", + "start": "2020-03-01" + } + }, + "requestScope": "subscriptions/00000000-0000-0000-0000-000000000000" + } + }, + "status": "Completed", + "validTill": "2022-05-10T08:08:46.1973252Z" + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000?api-version=2025-03-01", + "Retry-After": "60" + } + } + }, + "operationId": "GenerateCostDetailsReport_GetOperationResults", + "title": "Get details of the operation result" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/DepartmentAlerts.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/DepartmentAlerts.json new file mode 100644 index 000000000000..246208304420 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/DepartmentAlerts.json @@ -0,0 +1,101 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "billingAccountId": "12345:6789", + "departmentId": "123", + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/departments/123" + }, + "responses": { + "200": { + "body": { + "nextLink": null, + "value": [ + { + "name": "00000000-0000-0000-0000-000000000000", + "type": "Microsoft.CostManagement/alerts", + "id": "/providers/Microsoft.Billing/billingAccounts/12345:6789/departments/123/providers/Microsoft.CostManagement/alerts/00000000-0000-0000-0000-000000000000", + "properties": { + "description": "", + "closeTime": "0001-01-01T00:00:00", + "costEntityId": "budget1", + "creationTime": "2020-04-27T11:07:52.7143901Z", + "definition": { + "type": "Budget", + "category": "Cost", + "criteria": "CostThresholdExceeded" + }, + "modificationTime": "2020-04-28T11:06:02.8999373Z", + "source": "Preset", + "status": "Active", + "statusModificationTime": "0001-01-01T00:00:00", + "statusModificationUserName": null, + "details": { + "amount": 200000, + "contactEmails": [ + "1234@contoso.com" + ], + "contactGroups": [], + "contactRoles": [], + "currentSpend": 161000.12, + "meterFilter": [], + "operator": "GreaterThan", + "overridingAlert": null, + "periodStartDate": "2020-03-01T00:00:00Z", + "resourceFilter": [], + "resourceGroupFilter": [], + "tagFilter": {}, + "threshold": 0.8, + "timeGrainType": "Quarterly", + "triggeredBy": "00000000-0000-0000-0000-000000000000_1_01", + "unit": "USD" + } + } + }, + { + "name": "11111111-1111-1111-111111111111", + "type": "Microsoft.CostManagement/alerts", + "id": "/providers/Microsoft.Billing/billingAccounts/12345:6789/departments/123/providers/Microsoft.CostManagement/alerts/11111111-1111-1111-111111111111", + "properties": { + "description": "", + "closeTime": "0001-01-01T00:00:00", + "costEntityId": "budget1", + "creationTime": "2019-06-24T05:51:52.8713179Z", + "definition": { + "type": "Budget", + "category": "Cost", + "criteria": "CostThresholdExceeded" + }, + "modificationTime": "2019-08-31T17:51:55.1808807Z", + "source": "Preset", + "status": "Active", + "statusModificationTime": "0001-01-01T00:00:00", + "statusModificationUserName": null, + "details": { + "amount": 200000, + "contactEmails": [ + "1234@contoso.com" + ], + "contactGroups": [], + "contactRoles": [], + "currentSpend": 171000.32, + "meterFilter": [], + "operator": "GreaterThan", + "overridingAlert": null, + "periodStartDate": "2020-03-01T00:00:00Z", + "resourceFilter": [], + "resourceGroupFilter": [], + "tagFilter": {}, + "threshold": 0.8, + "timeGrainType": "Quarterly", + "triggeredBy": "11111111-1111-1111-111111111111_1_01", + "unit": "USD" + } + } + } + ] + } + } + }, + "operationId": "Alerts_List", + "title": "DepartmentAlerts" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/DepartmentDimensionsList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/DepartmentDimensionsList.json new file mode 100644 index 000000000000..8d7a11eb6a70 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/DepartmentDimensionsList.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "billingAccountId": "100", + "departmentId": "123", + "scope": "providers/Microsoft.Billing/billingAccounts/100/departments/123" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "dimensions_ResourceGroup_2018-05-01_2018-05-31", + "type": "microsoft.CostManagement/dimensions", + "id": "/providers/Microsoft.Billing/billingAccounts/100/departments/123/providers/microsoft.CostManagement/dimensions_ResourceGroup_2018-05-01_2018-05-31", + "properties": { + "description": "Resource group", + "category": "ResourceGroup", + "data": [ + "thoroetrg01", + "default-notificationhubs-westus", + "jedikeyvaultrg", + "contosocodeflow8d4a", + "noobaa" + ], + "filterEnabled": true, + "groupingEnabled": true, + "total": 377, + "usageEnd": "2018-05-31T00:00:00-07:00", + "usageStart": "2018-05-01T00:00:00-07:00" + } + }, + { + "name": "dimensions_ResourceType_2018-05-01_2018-05-31", + "type": "microsoft.CostManagement/dimensions", + "id": "/providers/Microsoft.Billing/billingAccounts/100/departments/123/providers/microsoft.CostManagement/dimensions_ResourceType_2018-05-01_2018-05-31", + "properties": { + "description": "Resource type", + "category": "ResourceType", + "data": [ + "thoroetrg01", + "default-notificationhubs-westus", + "jedikeyvaultrg", + "contosocodeflow8d4a", + "noobaa" + ], + "filterEnabled": true, + "groupingEnabled": true, + "total": 37, + "usageEnd": "2018-05-31T00:00:00-07:00", + "usageStart": "2018-05-01T00:00:00-07:00" + } + } + ] + } + }, + "204": {} + }, + "operationId": "Dimensions_List", + "title": "DepartmentDimensionsList-Legacy" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/DepartmentDimensionsListExpandAndTop.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/DepartmentDimensionsListExpandAndTop.json new file mode 100644 index 000000000000..57550a666d2c --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/DepartmentDimensionsListExpandAndTop.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "$expand": "properties/data", + "$top": 5, + "api-version": "2025-03-01", + "billingAccountId": "100", + "departmentId": "123", + "scope": "providers/Microsoft.Billing/billingAccounts/100/departments/123" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "dimensions_ResourceGroup_2018-05-01_2018-05-31_5", + "type": "microsoft.CostManagement/dimensions", + "id": "/providers/Microsoft.Billing/billingAccounts/100/departments/123/providers/microsoft.CostManagement/dimensions_ResourceGroup_2018-05-01_2018-05-31_5", + "properties": { + "description": "Resource group", + "category": "ResourceGroup", + "data": [ + "thoroetrg01", + "default-notificationhubs-westus", + "jedikeyvaultrg", + "contosocodeflow8d4a", + "noobaa" + ], + "filterEnabled": true, + "groupingEnabled": true, + "total": 377, + "usageEnd": "2018-05-31T00:00:00-07:00", + "usageStart": "2018-05-01T00:00:00-07:00" + } + }, + { + "name": "dimensions_ResourceType_2018-05-01_2018-05-31_5", + "type": "microsoft.CostManagement/dimensions", + "id": "/providers/Microsoft.Billing/billingAccounts/100/departments/123/providers/microsoft.CostManagement/dimensions_ResourceType_2018-05-01_2018-05-31_5", + "properties": { + "description": "Resource type", + "category": "ResourceType", + "data": [ + "microsoft.automation/automationaccounts", + "microsoft.databricks/workspaces", + "microsoft.dbformysql/servers", + "microsoft.containerregistry/registries", + "microsoft.search/searchservices" + ], + "filterEnabled": true, + "groupingEnabled": true, + "total": 37, + "usageEnd": "2018-05-31T00:00:00-07:00", + "usageStart": "2018-05-01T00:00:00-07:00" + } + } + ] + } + }, + "204": {} + }, + "operationId": "Dimensions_List", + "title": "DepartmentDimensionsListExpandAndTop-Legacy" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/DepartmentDimensionsListWithFilter.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/DepartmentDimensionsListWithFilter.json new file mode 100644 index 000000000000..07b84367e200 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/DepartmentDimensionsListWithFilter.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "$expand": "properties/data", + "$filter": "properties/category eq 'resourceId'", + "$top": 5, + "api-version": "2025-03-01", + "billingAccountId": "100", + "departmentId": "123", + "scope": "providers/Microsoft.Billing/billingAccounts/100/departments/123" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "dimensions_ResourceId_2018-05-01_2018-05-31_5", + "type": "microsoft.CostManagement/dimensions", + "id": "/providers/Microsoft.Billing/billingAccounts/100/departments/123/providers/microsoft.CostManagement/dimensions_ResourceId_2018-05-01_2018-05-31_5", + "properties": { + "description": "Resource Id", + "category": "ResourceId", + "data": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/system.orlando/providers/microsoft.storage/storageaccounts/urphealthaccount", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/system.orlando/providers/microsoft.storage/storageaccounts/srphytenaccount", + "/subscriptions/67e24f6b-1ec2-4c90-993a-dc2d25b00b6c/resourcegroups/defaultresourcegroup-eus/providers/microsoft.operationalinsights/workspaces/defaultworkspace-67e24f6b-1ec2-4c90-993a-dc2d25b00b6c-eus", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg-sql-ha/providers/microsoft.compute/virtualmachines/sql-4qqp1", + "/subscriptions/a98d6dc5-eb8f-46cf-8938-f1fb08f03706/resourcegroups/databricks-rg-testwsp-xijmsdubneexm/providers/microsoft.compute/disks/488cdb42bf74474a98075415be3f806c-containerrootvolume" + ], + "filterEnabled": true, + "groupingEnabled": true, + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/100/departments/123/providers/Microsoft.CostManagement/Dimensions?$filter=properties/category eq 'resourceId'&$top=5&api-version=2019-10-01&$expand=properties/data&$skiptoken=AQAAAA%3D%3D", + "total": 1409, + "usageEnd": "2018-05-31T00:00:00-07:00", + "usageStart": "2018-05-01T00:00:00-07:00" + } + } + ] + } + }, + "204": {} + }, + "operationId": "Dimensions_List", + "title": "DepartmentDimensionsListWithFilter-Legacy" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/DepartmentForecast.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/DepartmentForecast.json new file mode 100644 index 000000000000..b26f0e21cee1 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/DepartmentForecast.json @@ -0,0 +1,123 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "billingAccountId": "12345:6789", + "departmentId": "123", + "parameters": { + "type": "Usage", + "dataset": { + "aggregation": { + "totalCost": { + "name": "Cost", + "function": "Sum" + } + }, + "filter": { + "and": [ + { + "or": [ + { + "dimensions": { + "name": "ResourceLocation", + "operator": "In", + "values": [ + "East US", + "West Europe" + ] + } + }, + { + "tags": { + "name": "Environment", + "operator": "In", + "values": [ + "UAT", + "Prod" + ] + } + } + ] + }, + { + "dimensions": { + "name": "ResourceGroup", + "operator": "In", + "values": [ + "API" + ] + } + } + ] + }, + "granularity": "Daily" + }, + "includeActualCost": false, + "includeFreshPartialCost": false, + "timePeriod": { + "from": "2022-08-01T00:00:00+00:00", + "to": "2022-08-31T23:59:59+00:00" + }, + "timeframe": "Custom" + }, + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/departments/123" + }, + "responses": { + "200": { + "body": { + "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "type": "Microsoft.CostManagement/query", + "id": "/providers/Microsoft.Billing/billingAccounts/12345:6789/departments/123/providers/Microsoft.CostManagement/query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "properties": { + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "UsageDate", + "type": "Number" + }, + { + "name": "CostStatus", + "type": "String" + }, + { + "name": "Currency", + "type": "String" + } + ], + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/departments/123/providers/Microsoft.CostManagement/Forecast?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", + "rows": [ + [ + 2.10333307059661, + 20180331, + "Forecast", + "USD" + ], + [ + 218.68795741935486, + 20180331, + "Forecast", + "USD" + ], + [ + 0.14384913581657052, + 20180401, + "Forecast", + "USD" + ], + [ + 0.009865586851323632, + 20180429, + "Forecast", + "USD" + ] + ] + } + } + }, + "204": {} + }, + "operationId": "Forecast_Usage", + "title": "DepartmentForecast" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/DepartmentQuery.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/DepartmentQuery.json new file mode 100644 index 000000000000..b91f04d9fb7f --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/DepartmentQuery.json @@ -0,0 +1,111 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "billingAccountId": "70664866", + "departmentId": "123", + "parameters": { + "type": "Usage", + "dataset": { + "filter": { + "and": [ + { + "or": [ + { + "dimensions": { + "name": "ResourceLocation", + "operator": "In", + "values": [ + "East US", + "West Europe" + ] + } + }, + { + "tags": { + "name": "Environment", + "operator": "In", + "values": [ + "UAT", + "Prod" + ] + } + } + ] + }, + { + "dimensions": { + "name": "ResourceGroup", + "operator": "In", + "values": [ + "API" + ] + } + } + ] + }, + "granularity": "Daily" + }, + "timeframe": "MonthToDate" + }, + "scope": "providers/Microsoft.Billing/billingAccounts/100/departments/123" + }, + "responses": { + "200": { + "body": { + "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "type": "microsoft.costmanagement/Query", + "id": "/providers/Microsoft.Billing/billingAccounts/70664866/departments/123/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "properties": { + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "ResourceGroup", + "type": "String" + }, + { + "name": "UsageDate", + "type": "Number" + }, + { + "name": "Currency", + "type": "String" + } + ], + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/70664866/departments/123/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", + "rows": [ + [ + 19.545363672276512, + "JapanUnifia-Trial", + 20180331, + "USD" + ], + [ + 173.41979241290323, + "RVIIOT-TRIAL", + 20180331, + "USD" + ], + [ + 20.35941656262545, + "VSTSHOL-1595322048000", + 20180331, + "USD" + ], + [ + 0.16677720329728665, + "gs-stms-dev", + 20180331, + "USD" + ] + ] + } + } + }, + "204": {} + }, + "operationId": "Query_Usage", + "title": "DepartmentQuery-Legacy" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/DepartmentQueryGrouping.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/DepartmentQueryGrouping.json new file mode 100644 index 000000000000..b0ee35674c1e --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/DepartmentQueryGrouping.json @@ -0,0 +1,73 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "billingAccountId": "70664866", + "departmentId": "123", + "parameters": { + "type": "Usage", + "dataset": { + "aggregation": { + "totalCost": { + "name": "PreTaxCost", + "function": "Sum" + } + }, + "granularity": "None", + "grouping": [ + { + "name": "ResourceGroup", + "type": "Dimension" + } + ] + }, + "timeframe": "TheLastMonth" + }, + "scope": "providers/Microsoft.Billing/billingAccounts/100/departments/123" + }, + "responses": { + "200": { + "body": { + "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "type": "microsoft.costmanagement/Query", + "id": "/providers/Microsoft.Billing/billingAccounts/70664866/departments/123/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "properties": { + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "ResourceGroup", + "type": "String" + }, + { + "name": "Currency", + "type": "String" + } + ], + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/70664866/departments/123/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", + "rows": [ + [ + 19.545363672276512, + "JapanUnifia-Trial", + "USD" + ], + [ + 173.41979241290323, + "RVIIOT-TRIAL", + "USD" + ], + [ + 20.35941656262545, + "VSTSHOL-1595322048000", + "USD" + ] + ] + } + } + }, + "204": {} + }, + "operationId": "Query_Usage", + "title": "DepartmentQueryGrouping-Legacy" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/DismissResourceGroupAlerts.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/DismissResourceGroupAlerts.json new file mode 100644 index 000000000000..b40297584616 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/DismissResourceGroupAlerts.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "alertId": "22222222-2222-2222-2222-222222222222", + "api-version": "2025-03-01", + "parameters": { + "properties": { + "status": "Dismissed" + } + }, + "resourceGroupName": "ScreenSharingTest-peer", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ScreenSharingTest-peer", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "22222222-2222-2222-2222-222222222222", + "type": "Microsoft.CostManagement/alerts", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ScreenSharingTest-peer/providers/Microsoft.CostManagement/alerts/22222222-2222-2222-2222-222222222222", + "properties": { + "description": "", + "closeTime": "0001-01-01T00:00:00", + "costEntityId": "budget1", + "creationTime": "2020-04-27T11:07:52.7143901Z", + "definition": { + "type": "Budget", + "category": "Cost", + "criteria": "CostThresholdExceeded" + }, + "modificationTime": "2020-04-28T11:06:02.8999373Z", + "source": "Preset", + "status": "Dismissed", + "statusModificationTime": "0001-01-01T00:00:00", + "statusModificationUserName": null, + "details": { + "amount": 200000, + "contactEmails": [ + "1234@contoso.com" + ], + "contactGroups": [], + "contactRoles": [], + "currentSpend": 161000.12, + "meterFilter": [], + "operator": "GreaterThan", + "overridingAlert": null, + "periodStartDate": "2020-03-01T00:00:00Z", + "resourceFilter": [], + "resourceGroupFilter": [], + "tagFilter": {}, + "threshold": 0.8, + "timeGrainType": "Quarterly", + "triggeredBy": "22222222-2222-2222-2222-222222222222_1_01", + "unit": "USD" + } + } + } + } + }, + "operationId": "Alerts_Dismiss", + "title": "PatchResourceGroupAlerts" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/DismissSubscriptionAlerts.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/DismissSubscriptionAlerts.json new file mode 100644 index 000000000000..1bd02f64c98b --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/DismissSubscriptionAlerts.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "alertId": "22222222-2222-2222-2222-222222222222", + "api-version": "2025-03-01", + "parameters": { + "properties": { + "status": "Dismissed" + } + }, + "scope": "subscriptions/00000000-0000-0000-0000-000000000000", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "22222222-2222-2222-2222-222222222222", + "type": "Microsoft.CostManagement/alerts", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/alerts/22222222-2222-2222-2222-222222222222", + "properties": { + "description": "", + "closeTime": "0001-01-01T00:00:00", + "costEntityId": "budget1", + "creationTime": "2020-04-27T11:07:52.7143901Z", + "definition": { + "type": "Budget", + "category": "Cost", + "criteria": "CostThresholdExceeded" + }, + "modificationTime": "2020-04-28T11:06:02.8999373Z", + "source": "Preset", + "status": "Dismissed", + "statusModificationTime": "0001-01-01T00:00:00", + "statusModificationUserName": null, + "details": { + "amount": 200000, + "contactEmails": [ + "1234@contoso.com" + ], + "contactGroups": [], + "contactRoles": [], + "currentSpend": 161000.12, + "meterFilter": [], + "operator": "GreaterThan", + "overridingAlert": null, + "periodStartDate": "2020-03-01T00:00:00Z", + "resourceFilter": [], + "resourceGroupFilter": [], + "tagFilter": {}, + "threshold": 0.8, + "timeGrainType": "Quarterly", + "triggeredBy": "22222222-2222-2222-2222-222222222222_1_01", + "unit": "USD" + } + } + } + } + }, + "operationId": "Alerts_Dismiss", + "title": "PatchSubscriptionAlerts" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/EAPriceSheetForBillingPeriod.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/EAPriceSheetForBillingPeriod.json new file mode 100644 index 000000000000..deebadbb6b2c --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/EAPriceSheetForBillingPeriod.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "billingAccountId": "0000000", + "billingPeriodName": "202311" + }, + "responses": { + "200": { + "body": { + "properties": { + "reportUrl": "https://myaccount.blob.core.windows.net/reportfile.csv?sv=2015-04-05&ss=bf&srt=s&st=2015-04-29T22%3A18%3A26Z&se=2015-04-30T02%3A23%3A26Z&sr=b&sp=rw&spr=https&sig=G%2TEST%4B", + "validUntil": "2023-09-30T17:32:28Z" + }, + "status": "Completed" + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/0000000/providers/Microsoft.CostManagement/operationResults/00000000-0000-0000-0000-000000000000?api-version=2023-09-01", + "Retry-After": "60" + } + } + }, + "operationId": "PriceSheet_DownloadByBillingAccount", + "title": "EAPriceSheetForBillingPeriod" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/EnrollmentAccountAlerts.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/EnrollmentAccountAlerts.json new file mode 100644 index 000000000000..edf3b1e16b5a --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/EnrollmentAccountAlerts.json @@ -0,0 +1,101 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "billingAccountId": "12345:6789", + "enrollmentAccountId": "456", + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/enrollmentAccounts/456" + }, + "responses": { + "200": { + "body": { + "nextLink": null, + "value": [ + { + "name": "00000000-0000-0000-0000-000000000000", + "type": "Microsoft.CostManagement/alerts", + "id": "/providers/Microsoft.Billing/billingAccounts/12345:6789/enrollmentAccounts/456/providers/Microsoft.CostManagement/alerts/00000000-0000-0000-0000-000000000000", + "properties": { + "description": "", + "closeTime": "0001-01-01T00:00:00", + "costEntityId": "budget1", + "creationTime": "2020-04-27T11:07:52.7143901Z", + "definition": { + "type": "Budget", + "category": "Cost", + "criteria": "CostThresholdExceeded" + }, + "modificationTime": "2020-04-28T11:06:02.8999373Z", + "source": "Preset", + "status": "Active", + "statusModificationTime": "0001-01-01T00:00:00", + "statusModificationUserName": null, + "details": { + "amount": 200000, + "contactEmails": [ + "1234@contoso.com" + ], + "contactGroups": [], + "contactRoles": [], + "currentSpend": 161000.12, + "meterFilter": [], + "operator": "GreaterThan", + "overridingAlert": null, + "periodStartDate": "2020-03-01T00:00:00Z", + "resourceFilter": [], + "resourceGroupFilter": [], + "tagFilter": {}, + "threshold": 0.8, + "timeGrainType": "Quarterly", + "triggeredBy": "00000000-0000-0000-0000-000000000000_1_01", + "unit": "USD" + } + } + }, + { + "name": "11111111-1111-1111-111111111111", + "type": "Microsoft.CostManagement/alerts", + "id": "/providers/Microsoft.Billing/billingAccounts/12345:6789/enrollmentAccounts/456/providers/Microsoft.CostManagement/alerts/11111111-1111-1111-111111111111", + "properties": { + "description": "", + "closeTime": "0001-01-01T00:00:00", + "costEntityId": "budget1", + "creationTime": "2019-06-24T05:51:52.8713179Z", + "definition": { + "type": "Budget", + "category": "Cost", + "criteria": "CostThresholdExceeded" + }, + "modificationTime": "2019-08-31T17:51:55.1808807Z", + "source": "Preset", + "status": "Active", + "statusModificationTime": "0001-01-01T00:00:00", + "statusModificationUserName": null, + "details": { + "amount": 200000, + "contactEmails": [ + "1234@contoso.com" + ], + "contactGroups": [], + "contactRoles": [], + "currentSpend": 171000.32, + "meterFilter": [], + "operator": "GreaterThan", + "overridingAlert": null, + "periodStartDate": "2020-03-01T00:00:00Z", + "resourceFilter": [], + "resourceGroupFilter": [], + "tagFilter": {}, + "threshold": 0.8, + "timeGrainType": "Quarterly", + "triggeredBy": "11111111-1111-1111-111111111111_1_01", + "unit": "USD" + } + } + } + ] + } + } + }, + "operationId": "Alerts_List", + "title": "EnrollmentAccountAlerts" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/EnrollmentAccountDimensionsList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/EnrollmentAccountDimensionsList.json new file mode 100644 index 000000000000..78fbe03f6f6a --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/EnrollmentAccountDimensionsList.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "billingAccountId": "100", + "enrollmentAccountId": "456", + "scope": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "dimensions_ResourceGroup_2018-05-01_2018-05-31", + "type": "microsoft.CostManagement/dimensions", + "id": "/providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456/providers/microsoft.CostManagement/dimensions_ResourceGroup_2018-05-01_2018-05-31", + "properties": { + "description": "Resource group", + "category": "ResourceGroup", + "data": [], + "filterEnabled": true, + "groupingEnabled": true, + "total": 377, + "usageEnd": "2018-05-31T00:00:00-07:00", + "usageStart": "2018-05-01T00:00:00-07:00" + } + }, + { + "name": "dimensions_ResourceType_2018-05-01_2018-05-31", + "type": "microsoft.CostManagement/dimensions", + "id": "/providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456/providers/microsoft.CostManagement/dimensions_ResourceType_2018-05-01_2018-05-31", + "properties": { + "description": "Resource type", + "category": "ResourceType", + "data": [], + "filterEnabled": true, + "groupingEnabled": true, + "total": 37, + "usageEnd": "2018-05-31T00:00:00-07:00", + "usageStart": "2018-05-01T00:00:00-07:00" + } + } + ] + } + }, + "204": {} + }, + "operationId": "Dimensions_List", + "title": "EnrollmentAccountDimensionsList-Legacy" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/EnrollmentAccountDimensionsListExpandAndTop.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/EnrollmentAccountDimensionsListExpandAndTop.json new file mode 100644 index 000000000000..2b7fe144534b --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/EnrollmentAccountDimensionsListExpandAndTop.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "$expand": "properties/data", + "$top": 5, + "api-version": "2025-03-01", + "billingAccountId": "100", + "enrollmentAccountId": "456", + "scope": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "dimensions_ResourceGroup_2018-05-01_2018-05-31_5", + "type": "microsoft.CostManagement/dimensions", + "id": "/providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456/providers/microsoft.CostManagement/dimensions_ResourceGroup_2018-05-01_2018-05-31_5", + "properties": { + "description": "Resource group", + "category": "ResourceGroup", + "data": [ + "thoroetrg01", + "default-notificationhubs-westus", + "jedikeyvaultrg", + "contosocodeflow8d4a", + "noobaa" + ], + "filterEnabled": true, + "groupingEnabled": true, + "total": 377, + "usageEnd": "2018-05-31T00:00:00-07:00", + "usageStart": "2018-05-01T00:00:00-07:00" + } + }, + { + "name": "dimensions_ResourceType_2018-05-01_2018-05-31_5", + "type": "microsoft.CostManagement/dimensions", + "id": "/providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456/providers/microsoft.CostManagement/dimensions_ResourceType_2018-05-01_2018-05-31_5", + "properties": { + "description": "Resource type", + "category": "ResourceType", + "data": [ + "microsoft.automation/automationaccounts", + "microsoft.databricks/workspaces", + "microsoft.dbformysql/servers", + "microsoft.containerregistry/registries", + "microsoft.search/searchservices" + ], + "filterEnabled": true, + "groupingEnabled": true, + "total": 37, + "usageEnd": "2018-05-31T00:00:00-07:00", + "usageStart": "2018-05-01T00:00:00-07:00" + } + } + ] + } + }, + "204": {} + }, + "operationId": "Dimensions_List", + "title": "EnrollmentAccountDimensionsListExpandAndTop-Legacy" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/EnrollmentAccountDimensionsListWithFilter.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/EnrollmentAccountDimensionsListWithFilter.json new file mode 100644 index 000000000000..d3500d1eebbb --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/EnrollmentAccountDimensionsListWithFilter.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "$expand": "properties/data", + "$filter": "properties/category eq 'resourceId'", + "$top": 5, + "api-version": "2025-03-01", + "billingAccountId": "100", + "enrollmentAccountId": "456", + "scope": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "dimensions_ResourceId_2018-05-01_2018-05-31_5", + "type": "microsoft.CostManagement/dimensions", + "id": "/providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456/providers/microsoft.CostManagement/dimensions_ResourceId_2018-05-01_2018-05-31_5", + "properties": { + "description": "Resource Id", + "category": "ResourceId", + "data": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/system.orlando/providers/microsoft.storage/storageaccounts/urphealthaccount", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/system.orlando/providers/microsoft.storage/storageaccounts/srphytenaccount", + "/subscriptions/67e24f6b-1ec2-4c90-993a-dc2d25b00b6c/resourcegroups/defaultresourcegroup-eus/providers/microsoft.operationalinsights/workspaces/defaultworkspace-67e24f6b-1ec2-4c90-993a-dc2d25b00b6c-eus", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg-sql-ha/providers/microsoft.compute/virtualmachines/sql-4qqp1", + "/subscriptions/a98d6dc5-eb8f-46cf-8938-f1fb08f03706/resourcegroups/databricks-rg-testwsp-xijmsdubneexm/providers/microsoft.compute/disks/488cdb42bf74474a98075415be3f806c-containerrootvolume" + ], + "filterEnabled": true, + "groupingEnabled": true, + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456/providers/Microsoft.CostManagement/Dimensions?$filter=properties/category eq 'resourceId'&$top=5&api-version=2019-10-01&$expand=properties/data&$skiptoken=AQAAAA%3D%3D", + "total": 1409, + "usageEnd": "2018-05-31T00:00:00-07:00", + "usageStart": "2018-05-01T00:00:00-07:00" + } + } + ] + } + }, + "204": {} + }, + "operationId": "Dimensions_List", + "title": "EnrollmentAccountDimensionsListWithFilter-Legacy" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/EnrollmentAccountForecast.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/EnrollmentAccountForecast.json new file mode 100644 index 000000000000..c739bf7f85c0 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/EnrollmentAccountForecast.json @@ -0,0 +1,123 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "billingAccountId": "12345:6789", + "enrollmentAccountId": "456", + "parameters": { + "type": "Usage", + "dataset": { + "aggregation": { + "totalCost": { + "name": "Cost", + "function": "Sum" + } + }, + "filter": { + "and": [ + { + "or": [ + { + "dimensions": { + "name": "ResourceLocation", + "operator": "In", + "values": [ + "East US", + "West Europe" + ] + } + }, + { + "tags": { + "name": "Environment", + "operator": "In", + "values": [ + "UAT", + "Prod" + ] + } + } + ] + }, + { + "dimensions": { + "name": "ResourceGroup", + "operator": "In", + "values": [ + "API" + ] + } + } + ] + }, + "granularity": "Daily" + }, + "includeActualCost": false, + "includeFreshPartialCost": false, + "timePeriod": { + "from": "2022-08-01T00:00:00+00:00", + "to": "2022-08-31T23:59:59+00:00" + }, + "timeframe": "Custom" + }, + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/enrollmentAccounts/456" + }, + "responses": { + "200": { + "body": { + "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "type": "Microsoft.CostManagement/query", + "id": "/providers/Microsoft.Billing/billingAccounts/12345:6789/enrollmentAccounts/456/providers/Microsoft.CostManagement/query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "properties": { + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "UsageDate", + "type": "Number" + }, + { + "name": "CostStatus", + "type": "String" + }, + { + "name": "Currency", + "type": "String" + } + ], + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/enrollmentAccounts/456/providers/Microsoft.CostManagement/Forecast?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", + "rows": [ + [ + 2.10333307059661, + 20180331, + "Forecast", + "USD" + ], + [ + 218.68795741935486, + 20180331, + "Forecast", + "USD" + ], + [ + 0.14384913581657052, + 20180401, + "Forecast", + "USD" + ], + [ + 0.009865586851323632, + 20180429, + "Forecast", + "USD" + ] + ] + } + } + }, + "204": {} + }, + "operationId": "Forecast_Usage", + "title": "EnrollmentAccountForecast" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/EnrollmentAccountQuery.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/EnrollmentAccountQuery.json new file mode 100644 index 000000000000..91f011463326 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/EnrollmentAccountQuery.json @@ -0,0 +1,111 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "billingAccountId": "70664866", + "enrollmentAccountId": "456", + "parameters": { + "type": "Usage", + "dataset": { + "filter": { + "and": [ + { + "or": [ + { + "dimensions": { + "name": "ResourceLocation", + "operator": "In", + "values": [ + "East US", + "West Europe" + ] + } + }, + { + "tags": { + "name": "Environment", + "operator": "In", + "values": [ + "UAT", + "Prod" + ] + } + } + ] + }, + { + "dimensions": { + "name": "ResourceGroup", + "operator": "In", + "values": [ + "API" + ] + } + } + ] + }, + "granularity": "Daily" + }, + "timeframe": "MonthToDate" + }, + "scope": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456" + }, + "responses": { + "200": { + "body": { + "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "type": "microsoft.costmanagement/Query", + "id": "/providers/Microsoft.Billing/billingAccounts/70664866/enrollmentAccounts/456/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "properties": { + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "ResourceGroup", + "type": "String" + }, + { + "name": "UsageDate", + "type": "Number" + }, + { + "name": "Currency", + "type": "String" + } + ], + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/70664866/enrollmentAccounts/456/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", + "rows": [ + [ + 19.545363672276512, + "JapanUnifia-Trial", + 20180331, + "USD" + ], + [ + 173.41979241290323, + "RVIIOT-TRIAL", + 20180331, + "USD" + ], + [ + 20.35941656262545, + "VSTSHOL-1595322048000", + 20180331, + "USD" + ], + [ + 0.16677720329728665, + "gs-stms-dev", + 20180331, + "USD" + ] + ] + } + } + }, + "204": {} + }, + "operationId": "Query_Usage", + "title": "EnrollmentAccountQuery-Legacy" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/EnrollmentAccountQueryGrouping.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/EnrollmentAccountQueryGrouping.json new file mode 100644 index 000000000000..5fe790a3dfbd --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/EnrollmentAccountQueryGrouping.json @@ -0,0 +1,80 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "billingAccountId": "70664866", + "enrollmentAccountId": "456", + "parameters": { + "type": "Usage", + "dataset": { + "aggregation": { + "totalCost": { + "name": "PreTaxCost", + "function": "Sum" + } + }, + "granularity": "Daily", + "grouping": [ + { + "name": "ResourceGroup", + "type": "Dimension" + } + ] + }, + "timeframe": "TheLastMonth" + }, + "scope": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456" + }, + "responses": { + "200": { + "body": { + "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "type": "microsoft.costmanagement/Query", + "id": "/providers/Microsoft.Billing/billingAccounts/70664866/enrollmentAccounts/456/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "properties": { + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "ResourceGroup", + "type": "String" + }, + { + "name": "UsageDate", + "type": "Number" + }, + { + "name": "Currency", + "type": "String" + } + ], + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/70664866/enrollmentAccounts/456/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", + "rows": [ + [ + 19.545363672276512, + "JapanUnifia-Trial", + 20180331, + "USD" + ], + [ + 173.41979241290323, + "RVIIOT-TRIAL", + 20180331, + "USD" + ], + [ + 20.35941656262545, + "VSTSHOL-1595322048000", + 20180331, + "USD" + ] + ] + } + } + }, + "204": {} + }, + "operationId": "Query_Usage", + "title": "EnrollmentAccountQueryGrouping-Legacy" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExportCreateOrUpdateByBillingAccount.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExportCreateOrUpdateByBillingAccount.json new file mode 100644 index 000000000000..18a4c7e40ade --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExportCreateOrUpdateByBillingAccount.json @@ -0,0 +1,145 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "billingAccountId": "123456", + "exportName": "TestExport", + "parameters": { + "identity": { + "type": "SystemAssigned" + }, + "location": "centralus", + "properties": { + "format": "Csv", + "compressionMode": "gzip", + "dataOverwriteBehavior": "OverwritePreviousReport", + "definition": { + "type": "ActualCost", + "dataSet": { + "configuration": { + "dataVersion": "2023-05-01" + }, + "granularity": "Daily" + }, + "timeframe": "MonthToDate" + }, + "deliveryInfo": { + "destination": { + "type": "AzureBlob", + "container": "exports", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "rootFolderPath": "ad-hoc" + } + }, + "exportDescription": "This is a test export.", + "partitionData": true, + "schedule": { + "recurrence": "Daily", + "recurrencePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-06-30T00:00:00Z" + }, + "status": "Active" + } + } + }, + "scope": "providers/Microsoft.Billing/billingAccounts/123456" + }, + "responses": { + "200": { + "body": { + "name": "TestExport", + "type": "Microsoft.CostManagement/exports", + "eTag": "\"00000000-0000-0000-0000-000000000000\"", + "id": "/providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/exports/TestExport", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000" + }, + "location": "centralus", + "properties": { + "format": "Csv", + "compressionMode": "gzip", + "dataOverwriteBehavior": "OverwritePreviousReport", + "definition": { + "type": "ActualCost", + "dataSet": { + "configuration": { + "dataVersion": "2023-05-01" + }, + "granularity": "Daily" + }, + "timeframe": "MonthToDate" + }, + "deliveryInfo": { + "destination": { + "container": "exports", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "rootFolderPath": "ad-hoc" + } + }, + "exportDescription": "This is a test export.", + "nextRunTimeEstimate": "2020-06-01T23:00:00Z", + "partitionData": true, + "schedule": { + "recurrence": "Daily", + "recurrencePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-06-30T00:00:00Z" + }, + "status": "Active" + } + } + } + }, + "201": { + "body": { + "name": "TestExport", + "type": "Microsoft.CostManagement/exports", + "eTag": "\"00000000-0000-0000-0000-000000000000\"", + "id": "/providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/exports/TestExport", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000" + }, + "location": "centralus", + "properties": { + "format": "Csv", + "compressionMode": "gzip", + "dataOverwriteBehavior": "OverwritePreviousReport", + "definition": { + "type": "ActualCost", + "dataSet": { + "configuration": { + "dataVersion": "2023-05-01" + }, + "granularity": "Daily" + }, + "timeframe": "MonthToDate" + }, + "deliveryInfo": { + "destination": { + "container": "exports", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "rootFolderPath": "ad-hoc" + } + }, + "exportDescription": "This is a test export.", + "nextRunTimeEstimate": "2020-06-01T23:00:00Z", + "partitionData": true, + "schedule": { + "recurrence": "Daily", + "recurrencePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-06-30T00:00:00Z" + }, + "status": "Active" + } + } + } + } + }, + "operationId": "Exports_CreateOrUpdate", + "title": "ExportCreateOrUpdateByBillingAccount" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExportCreateOrUpdateByBillingAccountCustom.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExportCreateOrUpdateByBillingAccountCustom.json new file mode 100644 index 000000000000..f73c7a7f5bbd --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExportCreateOrUpdateByBillingAccountCustom.json @@ -0,0 +1,142 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "billingAccountId": "123456", + "exportName": "TestExport", + "parameters": { + "identity": { + "type": "SystemAssigned" + }, + "location": "centralus", + "properties": { + "format": "Csv", + "compressionMode": "gzip", + "dataOverwriteBehavior": "OverwritePreviousReport", + "definition": { + "type": "ActualCost", + "dataSet": { + "configuration": { + "dataVersion": "2023-05-01" + }, + "granularity": "Daily" + }, + "timePeriod": { + "from": "2025-04-03T00:00:00.000Z", + "to": "2025-04-03T00:00:00.000Z" + }, + "timeframe": "Custom" + }, + "deliveryInfo": { + "destination": { + "type": "AzureBlob", + "container": "exports", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "rootFolderPath": "ad-hoc" + } + }, + "exportDescription": "This is a test export.", + "partitionData": true, + "schedule": { + "status": "Inactive" + } + } + }, + "scope": "providers/Microsoft.Billing/billingAccounts/123456" + }, + "responses": { + "200": { + "body": { + "name": "TestExport", + "type": "Microsoft.CostManagement/exports", + "eTag": "\"00000000-0000-0000-0000-000000000000\"", + "id": "/providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/exports/TestExport", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000" + }, + "location": "centralus", + "properties": { + "format": "Csv", + "compressionMode": "gzip", + "dataOverwriteBehavior": "OverwritePreviousReport", + "definition": { + "type": "ActualCost", + "dataSet": { + "configuration": { + "dataVersion": "2023-05-01" + }, + "granularity": "Daily" + }, + "timePeriod": { + "from": "2025-04-03T00:00:00Z", + "to": "2025-04-03T00:00:00Z" + }, + "timeframe": "Custom" + }, + "deliveryInfo": { + "destination": { + "container": "exports", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "rootFolderPath": "ad-hoc" + } + }, + "exportDescription": "This is a test export.", + "partitionData": true, + "schedule": { + "recurrence": "None", + "status": "Inactive" + } + } + } + }, + "201": { + "body": { + "name": "TestExport", + "type": "Microsoft.CostManagement/exports", + "eTag": "\"00000000-0000-0000-0000-000000000000\"", + "id": "/providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/exports/TestExport", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000" + }, + "location": "centralus", + "properties": { + "format": "Csv", + "compressionMode": "gzip", + "dataOverwriteBehavior": "OverwritePreviousReport", + "definition": { + "type": "ActualCost", + "dataSet": { + "configuration": { + "dataVersion": "2023-05-01" + }, + "granularity": "Daily" + }, + "timePeriod": { + "from": "2025-04-03T00:00:00Z", + "to": "2025-04-03T00:00:00Z" + }, + "timeframe": "Custom" + }, + "deliveryInfo": { + "destination": { + "container": "exports", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "rootFolderPath": "ad-hoc" + } + }, + "exportDescription": "This is a test export.", + "partitionData": true, + "schedule": { + "recurrence": "None", + "status": "Inactive" + } + } + } + } + }, + "operationId": "Exports_CreateOrUpdate", + "title": "ExportCreateOrUpdateByBillingAccountCustom" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExportCreateOrUpdateByBillingAccountMonthly.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExportCreateOrUpdateByBillingAccountMonthly.json new file mode 100644 index 000000000000..54b0da11c7f6 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExportCreateOrUpdateByBillingAccountMonthly.json @@ -0,0 +1,145 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "billingAccountId": "123456", + "exportName": "TestExport", + "parameters": { + "identity": { + "type": "SystemAssigned" + }, + "location": "centralus", + "properties": { + "format": "Csv", + "compressionMode": "gzip", + "dataOverwriteBehavior": "OverwritePreviousReport", + "definition": { + "type": "ActualCost", + "dataSet": { + "configuration": { + "dataVersion": "2023-05-01" + }, + "granularity": "Daily" + }, + "timeframe": "TheLastMonth" + }, + "deliveryInfo": { + "destination": { + "type": "AzureBlob", + "container": "exports", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "rootFolderPath": "ad-hoc" + } + }, + "exportDescription": "This is a test export.", + "partitionData": true, + "schedule": { + "recurrence": "Monthly", + "recurrencePeriod": { + "from": "2020-06-05T00:00:00Z", + "to": "2030-06-30T00:00:00Z" + }, + "status": "Active" + } + } + }, + "scope": "providers/Microsoft.Billing/billingAccounts/123456" + }, + "responses": { + "200": { + "body": { + "name": "TestExport", + "type": "Microsoft.CostManagement/exports", + "eTag": "\"00000000-0000-0000-0000-000000000000\"", + "id": "/providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/exports/TestExport", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000" + }, + "location": "centralus", + "properties": { + "format": "Csv", + "compressionMode": "gzip", + "dataOverwriteBehavior": "OverwritePreviousReport", + "definition": { + "type": "ActualCost", + "dataSet": { + "configuration": { + "dataVersion": "2023-05-01" + }, + "granularity": "Daily" + }, + "timeframe": "TheLastMonth" + }, + "deliveryInfo": { + "destination": { + "container": "exports", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "rootFolderPath": "ad-hoc" + } + }, + "exportDescription": "This is a test export.", + "nextRunTimeEstimate": "2020-06-05T23:00:00Z", + "partitionData": true, + "schedule": { + "recurrence": "Monthly", + "recurrencePeriod": { + "from": "2020-06-05T00:00:00Z", + "to": "2030-06-30T00:00:00Z" + }, + "status": "Active" + } + } + } + }, + "201": { + "body": { + "name": "TestExport", + "type": "Microsoft.CostManagement/exports", + "eTag": "\"00000000-0000-0000-0000-000000000000\"", + "id": "/providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/exports/TestExport", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000" + }, + "location": "centralus", + "properties": { + "format": "Csv", + "compressionMode": "gzip", + "dataOverwriteBehavior": "OverwritePreviousReport", + "definition": { + "type": "ActualCost", + "dataSet": { + "configuration": { + "dataVersion": "2023-05-01" + }, + "granularity": "Daily" + }, + "timeframe": "TheLastMonth" + }, + "deliveryInfo": { + "destination": { + "container": "exports", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "rootFolderPath": "ad-hoc" + } + }, + "exportDescription": "This is a test export.", + "nextRunTimeEstimate": "2020-06-05T23:00:00Z", + "partitionData": true, + "schedule": { + "recurrence": "Monthly", + "recurrencePeriod": { + "from": "2020-06-05T00:00:00Z", + "to": "2030-06-30T00:00:00Z" + }, + "status": "Active" + } + } + } + } + }, + "operationId": "Exports_CreateOrUpdate", + "title": "ExportCreateOrUpdateByBillingAccountMonthly" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExportCreateOrUpdateByBillingAccountPricesheet.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExportCreateOrUpdateByBillingAccountPricesheet.json new file mode 100644 index 000000000000..e46e98534f11 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExportCreateOrUpdateByBillingAccountPricesheet.json @@ -0,0 +1,145 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "billingAccountId": "123456", + "exportName": "TestExport", + "parameters": { + "identity": { + "type": "SystemAssigned" + }, + "location": "centralus", + "properties": { + "format": "Csv", + "compressionMode": "gzip", + "dataOverwriteBehavior": "OverwritePreviousReport", + "definition": { + "type": "PriceSheet", + "dataSet": { + "configuration": { + "dataVersion": "2023-05-01" + }, + "granularity": "Daily" + }, + "timeframe": "TheCurrentMonth" + }, + "deliveryInfo": { + "destination": { + "type": "AzureBlob", + "container": "exports", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "rootFolderPath": "ad-hoc" + } + }, + "exportDescription": "This is a test export.", + "partitionData": true, + "schedule": { + "recurrence": "Daily", + "recurrencePeriod": { + "from": "2023-06-01T00:00:00Z", + "to": "2023-06-30T00:00:00Z" + }, + "status": "Active" + } + } + }, + "scope": "providers/Microsoft.Billing/billingAccounts/123456" + }, + "responses": { + "200": { + "body": { + "name": "TestExport", + "type": "Microsoft.CostManagement/exports", + "eTag": "\"00000000-0000-0000-0000-000000000000\"", + "id": "/providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/exports/TestExport", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000" + }, + "location": "centralus", + "properties": { + "format": "Csv", + "compressionMode": "gzip", + "dataOverwriteBehavior": "OverwritePreviousReport", + "definition": { + "type": "PriceSheet", + "dataSet": { + "configuration": { + "dataVersion": "2023-05-01" + }, + "granularity": "Daily" + }, + "timeframe": "TheCurrentMonth" + }, + "deliveryInfo": { + "destination": { + "container": "exports", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "rootFolderPath": "ad-hoc" + } + }, + "exportDescription": "This is a test export.", + "nextRunTimeEstimate": "2023-06-01T23:00:00Z", + "partitionData": true, + "schedule": { + "recurrence": "Daily", + "recurrencePeriod": { + "from": "2023-06-01T00:00:00Z", + "to": "2023-06-30T00:00:00Z" + }, + "status": "Active" + } + } + } + }, + "201": { + "body": { + "name": "TestExport", + "type": "Microsoft.CostManagement/exports", + "eTag": "\"00000000-0000-0000-0000-000000000000\"", + "id": "/providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/exports/TestExport", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000" + }, + "location": "centralus", + "properties": { + "format": "Csv", + "compressionMode": "gzip", + "dataOverwriteBehavior": "OverwritePreviousReport", + "definition": { + "type": "PriceSheet", + "dataSet": { + "configuration": { + "dataVersion": "2023-05-01" + }, + "granularity": "Daily" + }, + "timeframe": "TheCurrentMonth" + }, + "deliveryInfo": { + "destination": { + "container": "exports", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "rootFolderPath": "ad-hoc" + } + }, + "exportDescription": "This is a test export.", + "nextRunTimeEstimate": "2023-06-01T23:00:00Z", + "partitionData": true, + "schedule": { + "recurrence": "Daily", + "recurrencePeriod": { + "from": "2023-06-01T00:00:00Z", + "to": "2023-06-30T00:00:00Z" + }, + "status": "Active" + } + } + } + } + }, + "operationId": "Exports_CreateOrUpdate", + "title": "ExportCreateOrUpdateByBillingAccountPricesheet" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExportCreateOrUpdateByBillingAccountReservationDetails.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExportCreateOrUpdateByBillingAccountReservationDetails.json new file mode 100644 index 000000000000..a6168c245276 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExportCreateOrUpdateByBillingAccountReservationDetails.json @@ -0,0 +1,149 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "billingAccountId": "123456", + "exportName": "TestExport", + "parameters": { + "identity": { + "type": "SystemAssigned" + }, + "location": "centralus", + "properties": { + "format": "Csv", + "compressionMode": "gzip", + "dataOverwriteBehavior": "OverwritePreviousReport", + "definition": { + "type": "ReservationDetails", + "dataSet": { + "configuration": { + "dataVersion": "2023-03-01" + }, + "granularity": "Daily" + }, + "timeframe": "MonthToDate" + }, + "deliveryInfo": { + "destination": { + "type": "AzureBlob", + "container": "exports", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "rootFolderPath": "ad-hoc" + } + }, + "exportDescription": "This is a test export.", + "partitionData": true, + "schedule": { + "recurrence": "Daily", + "recurrencePeriod": { + "from": "2023-06-01T00:00:00Z", + "to": "2023-06-30T00:00:00Z" + }, + "status": "Active" + } + } + }, + "scope": "providers/Microsoft.Billing/billingAccounts/123456" + }, + "responses": { + "200": { + "body": { + "name": "TestExport", + "type": "Microsoft.CostManagement/exports", + "eTag": "\"00000000-0000-0000-0000-000000000000\"", + "id": "/providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/exports/TestExport", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000" + }, + "location": "centralus", + "properties": { + "format": "Csv", + "compressionMode": "gzip", + "dataOverwriteBehavior": "OverwritePreviousReport", + "definition": { + "type": "ReservationDetails", + "dataSet": { + "configuration": { + "columns": [], + "dataVersion": "2023-03-01", + "filters": [] + }, + "granularity": "Daily" + }, + "timeframe": "MonthToDate" + }, + "deliveryInfo": { + "destination": { + "container": "exports", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "rootFolderPath": "ad-hoc" + } + }, + "exportDescription": "This is a test export.", + "nextRunTimeEstimate": "2023-06-01T23:00:00Z", + "partitionData": true, + "schedule": { + "recurrence": "Daily", + "recurrencePeriod": { + "from": "2023-06-01T00:00:00Z", + "to": "2023-06-30T00:00:00Z" + }, + "status": "Active" + } + } + } + }, + "201": { + "body": { + "name": "TestExport", + "type": "Microsoft.CostManagement/exports", + "eTag": "\"00000000-0000-0000-0000-000000000000\"", + "id": "/providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/exports/TestExport", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000" + }, + "location": "centralus", + "properties": { + "format": "Csv", + "compressionMode": "gzip", + "dataOverwriteBehavior": "OverwritePreviousReport", + "definition": { + "type": "ReservationDetails", + "dataSet": { + "configuration": { + "columns": [], + "dataVersion": "2023-03-01", + "filters": [] + }, + "granularity": "Daily" + }, + "timeframe": "MonthToDate" + }, + "deliveryInfo": { + "destination": { + "container": "exports", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "rootFolderPath": "ad-hoc" + } + }, + "exportDescription": "This is a test export.", + "nextRunTimeEstimate": "2023-06-01T23:00:00Z", + "partitionData": true, + "schedule": { + "recurrence": "Daily", + "recurrencePeriod": { + "from": "2023-06-01T00:00:00Z", + "to": "2023-06-30T00:00:00Z" + }, + "status": "Active" + } + } + } + } + }, + "operationId": "Exports_CreateOrUpdate", + "title": "ExportCreateOrUpdateByBillingAccountReservationDetails" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExportCreateOrUpdateByBillingAccountReservationRecommendation.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExportCreateOrUpdateByBillingAccountReservationRecommendation.json new file mode 100644 index 000000000000..f536a04b6411 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExportCreateOrUpdateByBillingAccountReservationRecommendation.json @@ -0,0 +1,188 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "billingAccountId": "123456", + "exportName": "TestExport", + "parameters": { + "identity": { + "type": "SystemAssigned" + }, + "location": "centralus", + "properties": { + "format": "Csv", + "compressionMode": "gzip", + "dataOverwriteBehavior": "OverwritePreviousReport", + "definition": { + "type": "ReservationRecommendations", + "dataSet": { + "configuration": { + "dataVersion": "2023-05-01", + "filters": [ + { + "name": "ReservationScope", + "value": "Single" + }, + { + "name": "ResourceType", + "value": "VirtualMachines" + }, + { + "name": "LookBackPeriod", + "value": "Last7Days" + } + ] + } + }, + "timeframe": "MonthToDate" + }, + "deliveryInfo": { + "destination": { + "type": "AzureBlob", + "container": "exports", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "rootFolderPath": "ad-hoc" + } + }, + "exportDescription": "This is a test export.", + "partitionData": true, + "schedule": { + "recurrence": "Daily", + "recurrencePeriod": { + "from": "2023-06-01T00:00:00Z", + "to": "2023-06-30T00:00:00Z" + }, + "status": "Active" + } + } + }, + "scope": "providers/Microsoft.Billing/billingAccounts/123456" + }, + "responses": { + "200": { + "body": { + "name": "TestExport", + "type": "Microsoft.CostManagement/exports", + "eTag": "\"00000000-0000-0000-0000-000000000000\"", + "id": "/providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/exports/TestExport", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000" + }, + "location": "centralus", + "properties": { + "format": "Csv", + "compressionMode": "gzip", + "dataOverwriteBehavior": "OverwritePreviousReport", + "definition": { + "type": "ReservationRecommendations", + "dataSet": { + "configuration": { + "columns": [], + "dataVersion": "2023-05-01", + "filters": [ + { + "name": "ReservationScope", + "value": "Single" + }, + { + "name": "ResourceType", + "value": "VirtualMachines" + }, + { + "name": "LookBackPeriod", + "value": "Last7Days" + } + ] + }, + "granularity": null + }, + "timeframe": "MonthToDate" + }, + "deliveryInfo": { + "destination": { + "container": "exports", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "rootFolderPath": "ad-hoc" + } + }, + "exportDescription": "This is a test export.", + "nextRunTimeEstimate": "2023-06-01T23:00:00Z", + "partitionData": true, + "schedule": { + "recurrence": "Daily", + "recurrencePeriod": { + "from": "2023-06-01T00:00:00Z", + "to": "2023-06-30T00:00:00Z" + }, + "status": "Active" + } + } + } + }, + "201": { + "body": { + "name": "TestExport", + "type": "Microsoft.CostManagement/exports", + "eTag": "\"00000000-0000-0000-0000-000000000000\"", + "id": "/providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/exports/TestExport", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000" + }, + "location": "centralus", + "properties": { + "format": "Csv", + "compressionMode": "gzip", + "dataOverwriteBehavior": "OverwritePreviousReport", + "definition": { + "type": "ReservationRecommendations", + "dataSet": { + "configuration": { + "columns": [], + "dataVersion": "2023-05-01", + "filters": [ + { + "name": "ReservationScope", + "value": "Single" + }, + { + "name": "ResourceType", + "value": "VirtualMachines" + }, + { + "name": "LookBackPeriod", + "value": "Last7Days" + } + ] + }, + "granularity": null + }, + "timeframe": "MonthToDate" + }, + "deliveryInfo": { + "destination": { + "container": "exports", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "rootFolderPath": "ad-hoc" + } + }, + "exportDescription": "This is a test export.", + "nextRunTimeEstimate": "2023-06-01T23:00:00Z", + "partitionData": true, + "schedule": { + "recurrence": "Daily", + "recurrencePeriod": { + "from": "2023-06-01T00:00:00Z", + "to": "2023-06-30T00:00:00Z" + }, + "status": "Active" + } + } + } + } + }, + "operationId": "Exports_CreateOrUpdate", + "title": "ExportCreateOrUpdateByBillingAccountReservationRecommendation" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExportCreateOrUpdateByBillingAccountReservationTransactions.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExportCreateOrUpdateByBillingAccountReservationTransactions.json new file mode 100644 index 000000000000..f5bfdbd19e0f --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExportCreateOrUpdateByBillingAccountReservationTransactions.json @@ -0,0 +1,148 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "billingAccountId": "123456", + "exportName": "TestExport", + "parameters": { + "identity": { + "type": "SystemAssigned" + }, + "location": "centralus", + "properties": { + "format": "Csv", + "compressionMode": "gzip", + "dataOverwriteBehavior": "OverwritePreviousReport", + "definition": { + "type": "ReservationTransactions", + "dataSet": { + "configuration": { + "dataVersion": "2023-05-01" + } + }, + "timeframe": "MonthToDate" + }, + "deliveryInfo": { + "destination": { + "type": "AzureBlob", + "container": "exports", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "rootFolderPath": "ad-hoc" + } + }, + "exportDescription": "This is a test export.", + "partitionData": true, + "schedule": { + "recurrence": "Daily", + "recurrencePeriod": { + "from": "2023-06-01T00:00:00Z", + "to": "2023-06-30T00:00:00Z" + }, + "status": "Active" + } + } + }, + "scope": "providers/Microsoft.Billing/billingAccounts/123456" + }, + "responses": { + "200": { + "body": { + "name": "TestExport", + "type": "Microsoft.CostManagement/exports", + "eTag": "\"00000000-0000-0000-0000-000000000000\"", + "id": "/providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/exports/TestExport", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000" + }, + "location": "centralus", + "properties": { + "format": "Csv", + "compressionMode": "gzip", + "dataOverwriteBehavior": "OverwritePreviousReport", + "definition": { + "type": "ReservationTransactions", + "dataSet": { + "configuration": { + "columns": [], + "dataVersion": "2023-05-01", + "filters": [] + }, + "granularity": null + }, + "timeframe": "MonthToDate" + }, + "deliveryInfo": { + "destination": { + "container": "exports", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "rootFolderPath": "ad-hoc" + } + }, + "exportDescription": "This is a test export.", + "nextRunTimeEstimate": "2023-06-01T23:00:00Z", + "partitionData": true, + "schedule": { + "recurrence": "Daily", + "recurrencePeriod": { + "from": "2023-06-01T00:00:00Z", + "to": "2023-06-30T00:00:00Z" + }, + "status": "Active" + } + } + } + }, + "201": { + "body": { + "name": "TestExport", + "type": "Microsoft.CostManagement/exports", + "eTag": "\"00000000-0000-0000-0000-000000000000\"", + "id": "/providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/exports/TestExport", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000" + }, + "location": "centralus", + "properties": { + "format": "Csv", + "compressionMode": "gzip", + "dataOverwriteBehavior": "OverwritePreviousReport", + "definition": { + "type": "ReservationTransactions", + "dataSet": { + "configuration": { + "columns": [], + "dataVersion": "2023-05-01", + "filters": [] + }, + "granularity": null + }, + "timeframe": "MonthToDate" + }, + "deliveryInfo": { + "destination": { + "container": "exports", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "rootFolderPath": "ad-hoc" + } + }, + "exportDescription": "This is a test export.", + "nextRunTimeEstimate": "2023-06-01T23:00:00Z", + "partitionData": true, + "schedule": { + "recurrence": "Daily", + "recurrencePeriod": { + "from": "2023-06-01T00:00:00Z", + "to": "2023-06-30T00:00:00Z" + }, + "status": "Active" + } + } + } + } + }, + "operationId": "Exports_CreateOrUpdate", + "title": "ExportCreateOrUpdateExportCreateOrUpdateByBillingAccountReservationTransactionsByBillingAccount" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExportCreateOrUpdateByDepartment.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExportCreateOrUpdateByDepartment.json new file mode 100644 index 000000000000..a3772d0e8c20 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExportCreateOrUpdateByDepartment.json @@ -0,0 +1,146 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "billingAccountId": "12", + "departmentId": "1234", + "exportName": "TestExport", + "parameters": { + "identity": { + "type": "SystemAssigned" + }, + "location": "centralus", + "properties": { + "format": "Parquet", + "compressionMode": "snappy", + "dataOverwriteBehavior": "OverwritePreviousReport", + "definition": { + "type": "ActualCost", + "dataSet": { + "configuration": { + "dataVersion": "2023-05-01" + }, + "granularity": "Daily" + }, + "timeframe": "MonthToDate" + }, + "deliveryInfo": { + "destination": { + "type": "AzureBlob", + "container": "exports", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "rootFolderPath": "ad-hoc" + } + }, + "exportDescription": "This is a test export.", + "partitionData": true, + "schedule": { + "recurrence": "Daily", + "recurrencePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-06-30T00:00:00Z" + }, + "status": "Active" + } + } + }, + "scope": "providers/Microsoft.Billing/billingAccounts/12/departments/1234" + }, + "responses": { + "200": { + "body": { + "name": "TestExport", + "type": "Microsoft.CostManagement/exports", + "eTag": "\"00000000-0000-0000-0000-000000000000\"", + "id": "/providers/Microsoft.Billing/billingAccounts/12/departments/1234/providers/Microsoft.CostManagement/exports/TestExport", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000" + }, + "location": "centralus", + "properties": { + "format": "Parquet", + "compressionMode": "snappy", + "dataOverwriteBehavior": "OverwritePreviousReport", + "definition": { + "type": "ActualCost", + "dataSet": { + "configuration": { + "dataVersion": "2023-05-01" + }, + "granularity": "Daily" + }, + "timeframe": "MonthToDate" + }, + "deliveryInfo": { + "destination": { + "container": "exports", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "rootFolderPath": "ad-hoc" + } + }, + "exportDescription": "This is a test export.", + "nextRunTimeEstimate": "2020-06-01T23:00:00Z", + "partitionData": true, + "schedule": { + "recurrence": "Daily", + "recurrencePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-06-30T00:00:00Z" + }, + "status": "Active" + } + } + } + }, + "201": { + "body": { + "name": "TestExport", + "type": "Microsoft.CostManagement/exports", + "eTag": "\"00000000-0000-0000-0000-000000000000\"", + "id": "/providers/Microsoft.Billing/billingAccounts/12/departments/1234/providers/Microsoft.CostManagement/exports/TestExport", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000" + }, + "location": "centralus", + "properties": { + "format": "Parquet", + "compressionMode": "snappy", + "dataOverwriteBehavior": "OverwritePreviousReport", + "definition": { + "type": "ActualCost", + "dataSet": { + "configuration": { + "dataVersion": "2023-05-01" + }, + "granularity": "Daily" + }, + "timeframe": "MonthToDate" + }, + "deliveryInfo": { + "destination": { + "container": "exports", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "rootFolderPath": "ad-hoc" + } + }, + "exportDescription": "This is a test export.", + "nextRunTimeEstimate": "2020-06-01T23:00:00Z", + "partitionData": true, + "schedule": { + "recurrence": "Daily", + "recurrencePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-06-30T00:00:00Z" + }, + "status": "Active" + } + } + } + } + }, + "operationId": "Exports_CreateOrUpdate", + "title": "ExportCreateOrUpdateByDepartment" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExportCreateOrUpdateByEnrollmentAccount.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExportCreateOrUpdateByEnrollmentAccount.json new file mode 100644 index 000000000000..cda44651df30 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExportCreateOrUpdateByEnrollmentAccount.json @@ -0,0 +1,146 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "billingAccountId": "100", + "enrollmentAccountId": "456", + "exportName": "TestExport", + "parameters": { + "identity": { + "type": "SystemAssigned" + }, + "location": "centralus", + "properties": { + "format": "Csv", + "compressionMode": "gzip", + "dataOverwriteBehavior": "OverwritePreviousReport", + "definition": { + "type": "ActualCost", + "dataSet": { + "configuration": { + "dataVersion": "2023-05-01" + }, + "granularity": "Daily" + }, + "timeframe": "MonthToDate" + }, + "deliveryInfo": { + "destination": { + "type": "AzureBlob", + "container": "exports", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "rootFolderPath": "ad-hoc" + } + }, + "exportDescription": "This is a test export.", + "partitionData": true, + "schedule": { + "recurrence": "Daily", + "recurrencePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-06-30T00:00:00Z" + }, + "status": "Active" + } + } + }, + "scope": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456" + }, + "responses": { + "200": { + "body": { + "name": "TestExport", + "type": "Microsoft.CostManagement/exports", + "eTag": "\"00000000-0000-0000-0000-000000000000\"", + "id": "/providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456/providers/Microsoft.CostManagement/exports/TestExport", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000" + }, + "location": "centralus", + "properties": { + "format": "Csv", + "compressionMode": "gzip", + "dataOverwriteBehavior": "OverwritePreviousReport", + "definition": { + "type": "ActualCost", + "dataSet": { + "configuration": { + "dataVersion": "2023-05-01" + }, + "granularity": "Daily" + }, + "timeframe": "MonthToDate" + }, + "deliveryInfo": { + "destination": { + "container": "exports", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "rootFolderPath": "ad-hoc" + } + }, + "exportDescription": "This is a test export.", + "nextRunTimeEstimate": "2020-06-01T23:00:00Z", + "partitionData": true, + "schedule": { + "recurrence": "Daily", + "recurrencePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-06-30T00:00:00Z" + }, + "status": "Active" + } + } + } + }, + "201": { + "body": { + "name": "TestExport", + "type": "Microsoft.CostManagement/exports", + "eTag": "\"00000000-0000-0000-0000-000000000000\"", + "id": "/providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456/providers/Microsoft.CostManagement/exports/TestExport", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000" + }, + "location": "centralus", + "properties": { + "format": "Csv", + "compressionMode": "gzip", + "dataOverwriteBehavior": "OverwritePreviousReport", + "definition": { + "type": "ActualCost", + "dataSet": { + "configuration": { + "dataVersion": "2023-05-01" + }, + "granularity": "Daily" + }, + "timeframe": "MonthToDate" + }, + "deliveryInfo": { + "destination": { + "container": "exports", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "rootFolderPath": "ad-hoc" + } + }, + "exportDescription": "This is a test export.", + "nextRunTimeEstimate": "2020-06-01T23:00:00Z", + "partitionData": true, + "schedule": { + "recurrence": "Daily", + "recurrencePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-06-30T00:00:00Z" + }, + "status": "Active" + } + } + } + } + }, + "operationId": "Exports_CreateOrUpdate", + "title": "ExportCreateOrUpdateByEnrollmentAccount" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExportCreateOrUpdateByManagementGroup.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExportCreateOrUpdateByManagementGroup.json new file mode 100644 index 000000000000..da7535f5aaa8 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExportCreateOrUpdateByManagementGroup.json @@ -0,0 +1,145 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "exportName": "TestExport", + "managementGroupId": "TestMG", + "parameters": { + "identity": { + "type": "SystemAssigned" + }, + "location": "centralus", + "properties": { + "format": "Csv", + "compressionMode": "gzip", + "dataOverwriteBehavior": "OverwritePreviousReport", + "definition": { + "type": "ActualCost", + "dataSet": { + "configuration": { + "dataVersion": "2023-05-01" + }, + "granularity": "Daily" + }, + "timeframe": "MonthToDate" + }, + "deliveryInfo": { + "destination": { + "type": "AzureBlob", + "container": "exports", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "rootFolderPath": "ad-hoc" + } + }, + "exportDescription": "This is a test export.", + "partitionData": true, + "schedule": { + "recurrence": "Daily", + "recurrencePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-06-30T00:00:00Z" + }, + "status": "Active" + } + } + }, + "scope": "providers/Microsoft.Management/managementGroups/TestMG" + }, + "responses": { + "200": { + "body": { + "name": "TestExport", + "type": "Microsoft.CostManagement/exports", + "eTag": "\"00000000-0000-0000-0000-000000000000\"", + "id": "/providers/Microsoft.Management/managementGroups/TestMG/providers/Microsoft.CostManagement/exports/TestExport", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000" + }, + "location": "centralus", + "properties": { + "format": "Csv", + "compressionMode": "gzip", + "dataOverwriteBehavior": "OverwritePreviousReport", + "definition": { + "type": "ActualCost", + "dataSet": { + "configuration": { + "dataVersion": "2023-05-01" + }, + "granularity": "Daily" + }, + "timeframe": "MonthToDate" + }, + "deliveryInfo": { + "destination": { + "container": "exports", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "rootFolderPath": "ad-hoc" + } + }, + "exportDescription": "This is a test export.", + "nextRunTimeEstimate": "2020-06-01T23:00:00Z", + "partitionData": true, + "schedule": { + "recurrence": "Daily", + "recurrencePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-06-30T00:00:00Z" + }, + "status": "Active" + } + } + } + }, + "201": { + "body": { + "name": "TestExport", + "type": "Microsoft.CostManagement/exports", + "eTag": "\"00000000-0000-0000-0000-000000000000\"", + "id": "/providers/Microsoft.Management/managementGroups/TestMG/providers/Microsoft.CostManagement/exports/TestExport", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000" + }, + "location": "centralus", + "properties": { + "format": "Csv", + "compressionMode": "gzip", + "dataOverwriteBehavior": "OverwritePreviousReport", + "definition": { + "type": "ActualCost", + "dataSet": { + "configuration": { + "dataVersion": "2023-05-01" + }, + "granularity": "Daily" + }, + "timeframe": "MonthToDate" + }, + "deliveryInfo": { + "destination": { + "container": "exports", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "rootFolderPath": "ad-hoc" + } + }, + "exportDescription": "This is a test export.", + "nextRunTimeEstimate": "2020-06-01T23:00:00Z", + "partitionData": true, + "schedule": { + "recurrence": "Daily", + "recurrencePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-06-30T00:00:00Z" + }, + "status": "Active" + } + } + } + } + }, + "operationId": "Exports_CreateOrUpdate", + "title": "ExportCreateOrUpdateByManagementGroup" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExportCreateOrUpdateByResourceGroup.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExportCreateOrUpdateByResourceGroup.json new file mode 100644 index 000000000000..4e251c440f6e --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExportCreateOrUpdateByResourceGroup.json @@ -0,0 +1,146 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "exportName": "TestExport", + "parameters": { + "identity": { + "type": "SystemAssigned" + }, + "location": "centralus", + "properties": { + "format": "Csv", + "compressionMode": "gzip", + "dataOverwriteBehavior": "OverwritePreviousReport", + "definition": { + "type": "ActualCost", + "dataSet": { + "configuration": { + "dataVersion": "2023-05-01" + }, + "granularity": "Daily" + }, + "timeframe": "MonthToDate" + }, + "deliveryInfo": { + "destination": { + "type": "AzureBlob", + "container": "exports", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "rootFolderPath": "ad-hoc" + } + }, + "exportDescription": "This is a test export.", + "partitionData": true, + "schedule": { + "recurrence": "Daily", + "recurrencePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-06-30T00:00:00Z" + }, + "status": "Active" + } + } + }, + "resourceGroupName": "MYDEVTESTRG", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "TestExport", + "type": "Microsoft.CostManagement/exports", + "eTag": "\"00000000-0000-0000-0000-000000000000\"", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/exports/TestExport", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000" + }, + "location": "centralus", + "properties": { + "format": "Csv", + "compressionMode": "gzip", + "dataOverwriteBehavior": "OverwritePreviousReport", + "definition": { + "type": "ActualCost", + "dataSet": { + "configuration": { + "dataVersion": "2023-05-01" + }, + "granularity": "Daily" + }, + "timeframe": "MonthToDate" + }, + "deliveryInfo": { + "destination": { + "container": "exports", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "rootFolderPath": "ad-hoc" + } + }, + "exportDescription": "This is a test export.", + "nextRunTimeEstimate": "2020-06-01T23:00:00Z", + "partitionData": true, + "schedule": { + "recurrence": "Daily", + "recurrencePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-06-30T00:00:00Z" + }, + "status": "Active" + } + } + } + }, + "201": { + "body": { + "name": "TestExport", + "type": "Microsoft.CostManagement/exports", + "eTag": "\"00000000-0000-0000-0000-000000000000\"", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/exports/TestExport", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000" + }, + "location": "centralus", + "properties": { + "format": "Csv", + "compressionMode": "gzip", + "dataOverwriteBehavior": "OverwritePreviousReport", + "definition": { + "type": "ActualCost", + "dataSet": { + "configuration": { + "dataVersion": "2023-05-01" + }, + "granularity": "Daily" + }, + "timeframe": "MonthToDate" + }, + "deliveryInfo": { + "destination": { + "container": "exports", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "rootFolderPath": "ad-hoc" + } + }, + "exportDescription": "This is a test export.", + "nextRunTimeEstimate": "2020-06-01T23:00:00Z", + "partitionData": true, + "schedule": { + "recurrence": "Daily", + "recurrencePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-06-30T00:00:00Z" + }, + "status": "Active" + } + } + } + } + }, + "operationId": "Exports_CreateOrUpdate", + "title": "ExportCreateOrUpdateByResourceGroup" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExportCreateOrUpdateBySubscription.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExportCreateOrUpdateBySubscription.json new file mode 100644 index 000000000000..6994ba94a112 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExportCreateOrUpdateBySubscription.json @@ -0,0 +1,145 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "exportName": "TestExport", + "parameters": { + "identity": { + "type": "SystemAssigned" + }, + "location": "centralus", + "properties": { + "format": "Csv", + "compressionMode": "gzip", + "dataOverwriteBehavior": "OverwritePreviousReport", + "definition": { + "type": "ActualCost", + "dataSet": { + "configuration": { + "dataVersion": "2023-05-01" + }, + "granularity": "Daily" + }, + "timeframe": "MonthToDate" + }, + "deliveryInfo": { + "destination": { + "type": "AzureBlob", + "container": "exports", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "rootFolderPath": "ad-hoc" + } + }, + "exportDescription": "This is a test export.", + "partitionData": true, + "schedule": { + "recurrence": "Daily", + "recurrencePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-06-30T00:00:00Z" + }, + "status": "Active" + } + } + }, + "scope": "subscriptions/00000000-0000-0000-0000-000000000000", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "TestExport", + "type": "Microsoft.CostManagement/exports", + "eTag": "\"00000000-0000-0000-0000-000000000000\"", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/exports/TestExport", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000" + }, + "location": "centralus", + "properties": { + "format": "Csv", + "compressionMode": "gzip", + "dataOverwriteBehavior": "OverwritePreviousReport", + "definition": { + "type": "ActualCost", + "dataSet": { + "configuration": { + "dataVersion": "2023-05-01" + }, + "granularity": "Daily" + }, + "timeframe": "MonthToDate" + }, + "deliveryInfo": { + "destination": { + "container": "exports", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "rootFolderPath": "ad-hoc" + } + }, + "exportDescription": "This is a test export.", + "nextRunTimeEstimate": "2020-06-01T23:00:00Z", + "partitionData": true, + "schedule": { + "recurrence": "Daily", + "recurrencePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-06-30T00:00:00Z" + }, + "status": "Active" + } + } + } + }, + "201": { + "body": { + "name": "TestExport", + "type": "Microsoft.CostManagement/exports", + "eTag": "\"00000000-0000-0000-0000-000000000000\"", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/exports/TestExport", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000" + }, + "location": "centralus", + "properties": { + "format": "Csv", + "compressionMode": "gzip", + "dataOverwriteBehavior": "OverwritePreviousReport", + "definition": { + "type": "ActualCost", + "dataSet": { + "configuration": { + "dataVersion": "2023-05-01" + }, + "granularity": "Daily" + }, + "timeframe": "MonthToDate" + }, + "deliveryInfo": { + "destination": { + "container": "exports", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "rootFolderPath": "ad-hoc" + } + }, + "exportDescription": "This is a test export.", + "nextRunTimeEstimate": "2020-06-01T23:00:00Z", + "partitionData": true, + "schedule": { + "recurrence": "Daily", + "recurrencePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-06-30T00:00:00Z" + }, + "status": "Active" + } + } + } + } + }, + "operationId": "Exports_CreateOrUpdate", + "title": "ExportCreateOrUpdateBySubscription" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExportDeleteByBillingAccount.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExportDeleteByBillingAccount.json new file mode 100644 index 000000000000..68620fd7e88d --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExportDeleteByBillingAccount.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "billingAccountId": "123456", + "exportName": "TestExport", + "scope": "providers/Microsoft.Billing/billingAccounts/123456" + }, + "responses": { + "200": {} + }, + "operationId": "Exports_Delete", + "title": "ExportDeleteByBillingAccount" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExportDeleteByDepartment.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExportDeleteByDepartment.json new file mode 100644 index 000000000000..37ed28910456 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExportDeleteByDepartment.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "billingAccountId": "12", + "departmentId": "1234", + "exportName": "TestExport", + "scope": "providers/Microsoft.Billing/billingAccounts/12/departments/1234" + }, + "responses": { + "200": {} + }, + "operationId": "Exports_Delete", + "title": "ExportDeleteByDepartment" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExportDeleteByEnrollmentAccount.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExportDeleteByEnrollmentAccount.json new file mode 100644 index 000000000000..661c01691200 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExportDeleteByEnrollmentAccount.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "billingAccountId": "100", + "enrollmentAccountId": "456", + "exportName": "TestExport", + "scope": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456" + }, + "responses": { + "200": {} + }, + "operationId": "Exports_Delete", + "title": "ExportDeleteByEnrollmentAccount" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExportDeleteByManagementGroup.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExportDeleteByManagementGroup.json new file mode 100644 index 000000000000..804ba311eed7 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExportDeleteByManagementGroup.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "exportName": "TestExport", + "managementGroupId": "TestMG", + "scope": "providers/Microsoft.Management/managementGroups/TestMG" + }, + "responses": { + "200": {} + }, + "operationId": "Exports_Delete", + "title": "ExportDeleteByManagementGroup" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExportDeleteByResourceGroup.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExportDeleteByResourceGroup.json new file mode 100644 index 000000000000..6a825e1a6b9d --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExportDeleteByResourceGroup.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "exportName": "TestExport", + "resourceGroupName": "MYDEVTESTRG", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": {} + }, + "operationId": "Exports_Delete", + "title": "ExportDeleteByResourceGroup" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExportDeleteBySubscription.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExportDeleteBySubscription.json new file mode 100644 index 000000000000..2eac873a6ee6 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExportDeleteBySubscription.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "exportName": "TestExport", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": {} + }, + "operationId": "Exports_Delete", + "title": "ExportDeleteBySubscription" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExportGetByBillingAccount.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExportGetByBillingAccount.json new file mode 100644 index 000000000000..4bdf7b545b9f --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExportGetByBillingAccount.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "billingAccountId": "123456", + "exportName": "TestExport", + "scope": "providers/Microsoft.Billing/billingAccounts/123456" + }, + "responses": { + "200": { + "body": { + "name": "TestExport", + "type": "Microsoft.CostManagement/exports", + "eTag": "\"00000000-0000-0000-0000-000000000000\"", + "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccount-Id}/providers/Microsoft.CostManagement/exports/TestExport", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000" + }, + "location": "centralus", + "properties": { + "format": "Csv", + "compressionMode": "gzip", + "dataOverwriteBehavior": "OverwritePreviousReport", + "definition": { + "type": "ActualCost", + "dataSet": { + "configuration": { + "dataVersion": "2023-05-01" + }, + "granularity": "Daily" + }, + "timePeriod": { + "from": "2020-05-01T00:00:00Z", + "to": "2020-05-31T00:00:00Z" + }, + "timeframe": "Custom" + }, + "deliveryInfo": { + "destination": { + "container": "exports", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "rootFolderPath": "ad-hoc" + } + }, + "exportDescription": "This is a test export.", + "partitionData": true + } + } + } + }, + "operationId": "Exports_Get", + "title": "ExportGetByBillingAccount" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExportGetByDepartment.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExportGetByDepartment.json new file mode 100644 index 000000000000..6c1531d1557f --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExportGetByDepartment.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "billingAccountId": "12", + "departmentId": "1234", + "exportName": "TestExport", + "scope": "providers/Microsoft.Billing/billingAccounts/12/departments/1234" + }, + "responses": { + "200": { + "body": { + "name": "TestExport", + "type": "Microsoft.CostManagement/exports", + "eTag": "\"00000000-0000-0000-0000-000000000000\"", + "id": "/providers/Microsoft.Billing/billingAccounts/12/departments/1234/providers/Microsoft.CostManagement/exports/TestExport", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000" + }, + "location": "centralus", + "properties": { + "format": "Csv", + "compressionMode": "gzip", + "dataOverwriteBehavior": "OverwritePreviousReport", + "definition": { + "type": "ActualCost", + "dataSet": { + "configuration": { + "dataVersion": "2023-05-01" + }, + "granularity": "Daily" + }, + "timePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-06-30T00:00:00Z" + }, + "timeframe": "Custom" + }, + "deliveryInfo": { + "destination": { + "container": "exports", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "rootFolderPath": "ad-hoc" + } + }, + "exportDescription": "This is a test export.", + "partitionData": true + } + } + } + }, + "operationId": "Exports_Get", + "title": "ExportGetByDepartment" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExportGetByEnrollmentAccount.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExportGetByEnrollmentAccount.json new file mode 100644 index 000000000000..70149fd4ad01 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExportGetByEnrollmentAccount.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "billingAccountId": "100", + "enrollmentAccountId": "456", + "exportName": "TestExport", + "scope": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456" + }, + "responses": { + "200": { + "body": { + "name": "TestExport", + "type": "Microsoft.CostManagement/exports", + "eTag": "\"00000000-0000-0000-0000-000000000000\"", + "id": "/providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456/providers/Microsoft.CostManagement/exports/TestExport", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000" + }, + "location": "centralus", + "properties": { + "format": "Csv", + "compressionMode": "gzip", + "dataOverwriteBehavior": "OverwritePreviousReport", + "definition": { + "type": "ActualCost", + "dataSet": { + "configuration": { + "dataVersion": "2023-05-01" + }, + "granularity": "Daily" + }, + "timePeriod": { + "from": "2019-09-01T00:00:00Z", + "to": "2019-09-30T00:00:00Z" + }, + "timeframe": "Custom" + }, + "deliveryInfo": { + "destination": { + "container": "exports", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "rootFolderPath": "ad-hoc" + } + }, + "exportDescription": "This is a test export.", + "partitionData": true + } + } + } + }, + "operationId": "Exports_Get", + "title": "ExportGetByEnrollmentAccount" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExportGetByManagementGroup.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExportGetByManagementGroup.json new file mode 100644 index 000000000000..996503810e27 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExportGetByManagementGroup.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "exportName": "TestExport", + "managementGroupId": "TestMG", + "scope": "providers/Microsoft.Management/managementGroups/TestMG" + }, + "responses": { + "200": { + "body": { + "name": "TestExport", + "type": "Microsoft.CostManagement/exports", + "eTag": "\"00000000-0000-0000-0000-000000000000\"", + "id": "/providers/Microsoft.Management/managementGroups/TestMG/providers/Microsoft.CostManagement/exports/TestExport", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000" + }, + "location": "centralus", + "properties": { + "format": "Csv", + "compressionMode": "gzip", + "dataOverwriteBehavior": "OverwritePreviousReport", + "definition": { + "type": "ActualCost", + "dataSet": { + "configuration": { + "dataVersion": "2023-05-01" + }, + "granularity": "Daily" + }, + "timePeriod": { + "from": "2019-09-01T00:00:00Z", + "to": "2020-09-30T00:00:00Z" + }, + "timeframe": "Custom" + }, + "deliveryInfo": { + "destination": { + "container": "exports", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "rootFolderPath": "ad-hoc" + } + }, + "exportDescription": "This is a test export.", + "partitionData": true + } + } + } + }, + "operationId": "Exports_Get", + "title": "ExportGetByManagementGroup" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExportGetByResourceGroup.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExportGetByResourceGroup.json new file mode 100644 index 000000000000..16bcdc3e1b4b --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExportGetByResourceGroup.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "exportName": "TestExport", + "resourceGroupName": "MYDEVTESTRG", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "TestExport", + "type": "Microsoft.CostManagement/exports", + "eTag": "\"00000000-0000-0000-0000-000000000000\"", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/exports/TestExport", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000" + }, + "location": "centralus", + "properties": { + "format": "Csv", + "compressionMode": "gzip", + "dataOverwriteBehavior": "OverwritePreviousReport", + "definition": { + "type": "ActualCost", + "dataSet": { + "configuration": { + "dataVersion": "2023-05-01" + }, + "granularity": "Daily" + }, + "timePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-06-30T00:00:00Z" + }, + "timeframe": "Custom" + }, + "deliveryInfo": { + "destination": { + "container": "exports", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "rootFolderPath": "ad-hoc" + } + }, + "exportDescription": "This is a test export.", + "partitionData": true + } + } + } + }, + "operationId": "Exports_Get", + "title": "ExportGetByResourceGroup" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExportGetBySubscription.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExportGetBySubscription.json new file mode 100644 index 000000000000..09b8f355512f --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExportGetBySubscription.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "exportName": "TestExport", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "TestExport", + "type": "Microsoft.CostManagement/exports", + "eTag": "\"00000000-0000-0000-0000-000000000000\"", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/exports/TestExport", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000" + }, + "location": "centralus", + "properties": { + "format": "Csv", + "compressionMode": "gzip", + "dataOverwriteBehavior": "OverwritePreviousReport", + "definition": { + "type": "ActualCost", + "dataSet": { + "configuration": { + "dataVersion": "2023-05-01" + }, + "granularity": "Daily" + }, + "timePeriod": { + "from": "2019-06-01T00:00:00Z", + "to": "2019-06-30T00:00:00Z" + }, + "timeframe": "Custom" + }, + "deliveryInfo": { + "destination": { + "container": "exports", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "rootFolderPath": "ad-hoc" + } + }, + "exportDescription": "This is a test export.", + "partitionData": true + } + } + } + }, + "operationId": "Exports_Get", + "title": "ExportGetBySubscription" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExportRunByBillingAccount.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExportRunByBillingAccount.json new file mode 100644 index 000000000000..12ddb952cc91 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExportRunByBillingAccount.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "billingAccountId": "123456", + "exportName": "TestExport", + "scope": "providers/Microsoft.Billing/billingAccounts/123456" + }, + "responses": { + "200": {} + }, + "operationId": "Exports_Execute", + "title": "ExportRunByBillingAccount" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExportRunByBillingAccountWithOptionalRequestBody.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExportRunByBillingAccountWithOptionalRequestBody.json new file mode 100644 index 000000000000..7a0f00b0baea --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExportRunByBillingAccountWithOptionalRequestBody.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "billingAccountId": "123456", + "exportName": "TestExport", + "exportRunRequest": { + "timePeriod": { + "from": "2023-12-01T00:00:00.000Z", + "to": "2023-12-31T00:00:00.000Z" + } + }, + "scope": "providers/Microsoft.Billing/billingAccounts/123456" + }, + "responses": { + "200": {} + }, + "operationId": "Exports_Execute", + "title": "ExportRunByBillingAccountWithOptionalRequestBody" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExportRunByDepartment.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExportRunByDepartment.json new file mode 100644 index 000000000000..157a354bbb41 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExportRunByDepartment.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "billingAccountId": "12", + "departmentId": "1234", + "exportName": "TestExport", + "scope": "providers/Microsoft.Billing/billingAccounts/12/departments/1234" + }, + "responses": { + "200": {} + }, + "operationId": "Exports_Execute", + "title": "ExportRunByDepartment" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExportRunByEnrollmentAccount.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExportRunByEnrollmentAccount.json new file mode 100644 index 000000000000..6594094184c2 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExportRunByEnrollmentAccount.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "billingAccountId": "100", + "enrollmentAccountId": "456", + "exportName": "TestExport", + "scope": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456" + }, + "responses": { + "200": {} + }, + "operationId": "Exports_Execute", + "title": "ExportRunByEnrollmentAccount" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExportRunByManagementGroup.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExportRunByManagementGroup.json new file mode 100644 index 000000000000..0759e67eb5d9 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExportRunByManagementGroup.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "exportName": "TestExport", + "managementGroupId": "TestMG", + "scope": "providers/Microsoft.Management/managementGroups/TestMG" + }, + "responses": { + "200": {} + }, + "operationId": "Exports_Execute", + "title": "ExportRunByManagementGroup" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExportRunByResourceGroup.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExportRunByResourceGroup.json new file mode 100644 index 000000000000..325bd21eef83 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExportRunByResourceGroup.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "exportName": "TestExport", + "resourceGroupName": "MYDEVTESTRG", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": {} + }, + "operationId": "Exports_Execute", + "title": "ExportRunByResourceGroup" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExportRunBySubscription.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExportRunBySubscription.json new file mode 100644 index 000000000000..e0e5a286f772 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExportRunBySubscription.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "exportName": "TestExport", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": {} + }, + "operationId": "Exports_Execute", + "title": "ExportRunBySubscription" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExportRunHistoryGetByBillingAccount.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExportRunHistoryGetByBillingAccount.json new file mode 100644 index 000000000000..5dd3d6bef307 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExportRunHistoryGetByBillingAccount.json @@ -0,0 +1,104 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "billingAccountId": "123456", + "exportName": "TestExport", + "scope": "providers/Microsoft.Billing/billingAccounts/123456" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccount-id}/providers/Microsoft.CostManagement/exports/JohnDoeSchedule/Run/1e25d58a-a3b0-4916-9542-6e04a89bc100", + "properties": { + "endDate": "2020-06-30T00:00:00Z", + "executionType": "OnDemand", + "fileName": "ScheduledTestsForJohnDoe/JohnDoeSchedule/20180729-20180804/JohnDoeSchedule_1e25d58a-a3b0-4916-9542-6e04a89bc100.csv", + "manifestFile": "ScheduledTestsForJohnDoe/JohnDoeSchedule/20180729-20180804/manifestfile", + "processingEndTime": "2018-08-03T07:52:28.0373318Z", + "processingStartTime": "2018-08-03T07:52:16.9123797Z", + "runSettings": { + "format": "Csv", + "compressionMode": "gzip", + "dataOverwriteBehavior": "OverwritePreviousReport", + "definition": { + "type": "ActualCost", + "dataSet": { + "configuration": { + "dataVersion": "2023-05-01" + }, + "granularity": "Daily" + }, + "timePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-06-30T00:00:00Z" + }, + "timeframe": "Custom" + }, + "deliveryInfo": { + "destination": { + "container": "exports", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "rootFolderPath": "ScheduledTestsForJohnDoe" + } + }, + "exportDescription": "This is a test export.", + "partitionData": true + }, + "startDate": "2020-06-01T00:00:00Z", + "status": "Completed", + "submittedBy": "john.doe@gmail.com", + "submittedTime": "2018-08-03T07:52:15.6016681Z" + } + }, + { + "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccount-id}/providers/Microsoft.CostManagement/exports/JohnDoeSchedule/Run/11ac6811-dca3-46ad-b326-4704cf0c58ef", + "properties": { + "endDate": "2020-06-30T00:00:00Z", + "executionType": "Scheduled", + "fileName": "ScheduledTestsForJohnDoe/JohnDoeSchedule/20180729-20180804/JohnDoeSchedule_11ac6811-dca3-46ad-b326-4704cf0c58ef.csv", + "manifestFile": "ScheduledTestsForJohnDoe/JohnDoeSchedule/20180729-20180804/manifestfile", + "processingEndTime": "2018-08-03T09:04:19.7223808Z", + "processingStartTime": "2018-08-03T09:03:58.5710244Z", + "runSettings": { + "format": "Csv", + "compressionMode": "gzip", + "dataOverwriteBehavior": "OverwritePreviousReport", + "definition": { + "type": "ActualCost", + "dataSet": { + "configuration": { + "dataVersion": "2023-05-01" + }, + "granularity": "Daily" + }, + "timePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-06-30T00:00:00Z" + }, + "timeframe": "Custom" + }, + "deliveryInfo": { + "destination": { + "container": "exports", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "rootFolderPath": "ScheduledTestsForJohnDoe" + } + }, + "exportDescription": "This is a test export.", + "partitionData": true + }, + "startDate": "2020-06-01T00:00:00Z", + "status": "Completed", + "submittedBy": "System", + "submittedTime": "2018-08-03T09:03:58.5710244Z" + } + } + ] + } + } + }, + "operationId": "Exports_GetExecutionHistory", + "title": "ExportRunHistoryGetByBillingAccount" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExportRunHistoryGetByDepartment.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExportRunHistoryGetByDepartment.json new file mode 100644 index 000000000000..36a439baaf27 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExportRunHistoryGetByDepartment.json @@ -0,0 +1,105 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "billingAccountId": "12", + "departmentId": "1234", + "exportName": "TestExport", + "scope": "providers/Microsoft.Billing/billingAccounts/12/departments/1234" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/12/departments/1234/providers/Microsoft.CostManagement/exports/JohnDoeSchedule/Run/1e25d58a-a3b0-4916-9542-6e04a89bc100", + "properties": { + "endDate": "2020-06-30T00:00:00Z", + "executionType": "OnDemand", + "fileName": "ScheduledTestsForJohnDoe/JohnDoeSchedule/20180729-20180804/JohnDoeSchedule_1e25d58a-a3b0-4916-9542-6e04a89bc100.csv", + "manifestFile": "ScheduledTestsForJohnDoe/JohnDoeSchedule/20180729-20180804/manifestfile", + "processingEndTime": "2018-08-03T07:52:28.0373318Z", + "processingStartTime": "2018-08-03T07:52:16.9123797Z", + "runSettings": { + "format": "Csv", + "compressionMode": "gzip", + "dataOverwriteBehavior": "OverwritePreviousReport", + "definition": { + "type": "ActualCost", + "dataSet": { + "configuration": { + "dataVersion": "2023-05-01" + }, + "granularity": "Daily" + }, + "timePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-06-30T00:00:00Z" + }, + "timeframe": "Custom" + }, + "deliveryInfo": { + "destination": { + "container": "exports", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "rootFolderPath": "ScheduledTestsForJohnDoe" + } + }, + "exportDescription": "This is a test export.", + "partitionData": true + }, + "startDate": "2020-06-01T00:00:00Z", + "status": "Completed", + "submittedBy": "john.doe@gmail.com", + "submittedTime": "2018-08-03T07:52:15.6016681Z" + } + }, + { + "id": "/providers/Microsoft.Billing/billingAccounts/12/departments/1234/providers/Microsoft.CostManagement/exports/JohnDoeSchedule/Run/11ac6811-dca3-46ad-b326-4704cf0c58ef", + "properties": { + "endDate": "2020-06-30T00:00:00Z", + "executionType": "Scheduled", + "fileName": "ScheduledTestsForJohnDoe/JohnDoeSchedule/20180729-20180804/JohnDoeSchedule_11ac6811-dca3-46ad-b326-4704cf0c58ef.csv", + "manifestFile": "ScheduledTestsForJohnDoe/JohnDoeSchedule/20180729-20180804/manifestfile", + "processingEndTime": "2018-08-03T09:04:19.7223808Z", + "processingStartTime": "2018-08-03T09:03:58.5710244Z", + "runSettings": { + "format": "Csv", + "compressionMode": "gzip", + "dataOverwriteBehavior": "OverwritePreviousReport", + "definition": { + "type": "ActualCost", + "dataSet": { + "configuration": { + "dataVersion": "2023-05-01" + }, + "granularity": "Daily" + }, + "timePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-06-30T00:00:00Z" + }, + "timeframe": "Custom" + }, + "deliveryInfo": { + "destination": { + "container": "exports", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "rootFolderPath": "ScheduledTestsForJohnDoe" + } + }, + "exportDescription": "This is a test export.", + "partitionData": true + }, + "startDate": "2020-06-01T00:00:00Z", + "status": "Completed", + "submittedBy": "System", + "submittedTime": "2018-08-03T09:03:58.5710244Z" + } + } + ] + } + } + }, + "operationId": "Exports_GetExecutionHistory", + "title": "ExportRunHistoryGetByDepartment" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExportRunHistoryGetByEnrollmentAccount.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExportRunHistoryGetByEnrollmentAccount.json new file mode 100644 index 000000000000..fa7195608b58 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExportRunHistoryGetByEnrollmentAccount.json @@ -0,0 +1,105 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "billingAccountId": "100", + "enrollmentAccountId": "456", + "exportName": "TestExport", + "scope": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456/providers/Microsoft.CostManagement/exports/JohnDoeSchedule/Run/1e25d58a-a3b0-4916-9542-6e04a89bc100", + "properties": { + "endDate": "2020-06-30T00:00:00Z", + "executionType": "OnDemand", + "fileName": "ScheduledTestsForJohnDoe/JohnDoeSchedule/20180729-20180804/JohnDoeSchedule_1e25d58a-a3b0-4916-9542-6e04a89bc100.csv", + "manifestFile": "ScheduledTestsForJohnDoe/JohnDoeSchedule/20180729-20180804/manifestfile", + "processingEndTime": "2018-08-03T07:52:28.0373318Z", + "processingStartTime": "2018-08-03T07:52:16.9123797Z", + "runSettings": { + "format": "Csv", + "compressionMode": "gzip", + "dataOverwriteBehavior": "OverwritePreviousReport", + "definition": { + "type": "ActualCost", + "dataSet": { + "configuration": { + "dataVersion": "2023-05-01" + }, + "granularity": "Daily" + }, + "timePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-06-30T00:00:00Z" + }, + "timeframe": "Custom" + }, + "deliveryInfo": { + "destination": { + "container": "exports", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "rootFolderPath": "ScheduledTestsForJohnDoe" + } + }, + "exportDescription": "This is a test export.", + "partitionData": true + }, + "startDate": "2020-06-01T00:00:00Z", + "status": "Completed", + "submittedBy": "john.doe@gmail.com", + "submittedTime": "2018-08-03T07:52:15.6016681Z" + } + }, + { + "id": "/providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456/providers/Microsoft.CostManagement/exports/JohnDoeSchedule/Run/11ac6811-dca3-46ad-b326-4704cf0c58ef", + "properties": { + "endDate": "2020-06-30T00:00:00Z", + "executionType": "Scheduled", + "fileName": "ScheduledTestsForJohnDoe/JohnDoeSchedule/20180729-20180804/JohnDoeSchedule_11ac6811-dca3-46ad-b326-4704cf0c58ef.csv", + "manifestFile": "ScheduledTestsForJohnDoe/JohnDoeSchedule/20180729-20180804/manifestfile", + "processingEndTime": "2018-08-03T09:04:19.7223808Z", + "processingStartTime": "2018-08-03T09:03:58.5710244Z", + "runSettings": { + "format": "Csv", + "compressionMode": "gzip", + "dataOverwriteBehavior": "OverwritePreviousReport", + "definition": { + "type": "ActualCost", + "dataSet": { + "configuration": { + "dataVersion": "2023-05-01" + }, + "granularity": "Daily" + }, + "timePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-06-30T00:00:00Z" + }, + "timeframe": "Custom" + }, + "deliveryInfo": { + "destination": { + "container": "exports", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "rootFolderPath": "ScheduledTestsForJohnDoe" + } + }, + "exportDescription": "This is a test export.", + "partitionData": true + }, + "startDate": "2020-06-01T00:00:00Z", + "status": "Completed", + "submittedBy": "System", + "submittedTime": "2018-08-03T09:03:58.5710244Z" + } + } + ] + } + } + }, + "operationId": "Exports_GetExecutionHistory", + "title": "ExportRunHistoryGetByEnrollmentAccount" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExportRunHistoryGetByManagementGroup.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExportRunHistoryGetByManagementGroup.json new file mode 100644 index 000000000000..47a5205c2d09 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExportRunHistoryGetByManagementGroup.json @@ -0,0 +1,104 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "exportName": "TestExport", + "managementGroupId": "TestMG", + "scope": "providers/Microsoft.Management/managementGroups/TestMG" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Management/managementGroups/TestMG/providers/Microsoft.CostManagement/exports/TestExport/Run/1e25d58a-a3b0-4916-9542-6e04a89bc100", + "properties": { + "endDate": "2020-06-30T00:00:00Z", + "executionType": "OnDemand", + "fileName": "ScheduledForTestExport/TestExportSchedule/20180729-20180804/TestExportSchedule_1e25d58a-a3b0-4916-9542-6e04a89bc100.csv", + "manifestFile": "ScheduledTestsForJohnDoe/JohnDoeSchedule/20180729-20180804/manifestfile", + "processingEndTime": "2018-08-03T07:52:28.0373318Z", + "processingStartTime": "2018-08-03T07:52:16.9123797Z", + "runSettings": { + "format": "Csv", + "compressionMode": "gzip", + "dataOverwriteBehavior": "OverwritePreviousReport", + "definition": { + "type": "ActualCost", + "dataSet": { + "configuration": { + "dataVersion": "2023-05-01" + }, + "granularity": "Daily" + }, + "timePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-06-30T00:00:00Z" + }, + "timeframe": "Custom" + }, + "deliveryInfo": { + "destination": { + "container": "exports", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "rootFolderPath": "ScheduledTestsForJohnDoe" + } + }, + "exportDescription": "This is a test export.", + "partitionData": true + }, + "startDate": "2020-06-01T00:00:00Z", + "status": "Completed", + "submittedBy": "john.doe@gmail.com", + "submittedTime": "2018-08-03T07:52:15.6016681Z" + } + }, + { + "id": "/providers/Microsoft.Management/managementGroups/TestMG/providers/Microsoft.CostManagement/exports/TestExport/Run/11ac6811-dca3-46ad-b326-4704cf0c58ef", + "properties": { + "endDate": "2020-06-30T00:00:00Z", + "executionType": "Scheduled", + "fileName": "ScheduledForTestExport/TestExportSchedule/20180729-20180804/TestExportSchedule_11ac6811-dca3-46ad-b326-4704cf0c58ef.csv", + "manifestFile": "ScheduledTestsForJohnDoe/JohnDoeSchedule/20180729-20180804/manifestfile", + "processingEndTime": "2018-08-03T09:04:19.7223808Z", + "processingStartTime": "2018-08-03T09:03:58.5710244Z", + "runSettings": { + "format": "Csv", + "compressionMode": "gzip", + "dataOverwriteBehavior": "OverwritePreviousReport", + "definition": { + "type": "ActualCost", + "dataSet": { + "configuration": { + "dataVersion": "2023-05-01" + }, + "granularity": "Daily" + }, + "timePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-06-30T00:00:00Z" + }, + "timeframe": "Custom" + }, + "deliveryInfo": { + "destination": { + "container": "exports", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "rootFolderPath": "ScheduledTestsForJohnDoe" + } + }, + "exportDescription": "This is a test export.", + "partitionData": true + }, + "startDate": "2020-06-01T00:00:00Z", + "status": "Completed", + "submittedBy": "System", + "submittedTime": "2018-08-03T09:03:58.5710244Z" + } + } + ] + } + } + }, + "operationId": "Exports_GetExecutionHistory", + "title": "ExportRunHistoryGetByManagementGroup" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExportRunHistoryGetByResourceGroup.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExportRunHistoryGetByResourceGroup.json new file mode 100644 index 000000000000..13b58f3461d2 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExportRunHistoryGetByResourceGroup.json @@ -0,0 +1,105 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "exportName": "TestExport", + "resourceGroupName": "MYDEVTESTRG", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/exports/JohnDoeSchedule/Run/1e25d58a-a3b0-4916-9542-6e04a89bc100", + "properties": { + "endDate": "2020-06-30T00:00:00Z", + "executionType": "OnDemand", + "fileName": "ScheduledTestsForJohnDoe/JohnDoeSchedule/20180729-20180804/JohnDoeSchedule_1e25d58a-a3b0-4916-9542-6e04a89bc100.csv", + "manifestFile": "ScheduledTestsForJohnDoe/JohnDoeSchedule/20180729-20180804/manifestfile", + "processingEndTime": "2018-08-03T07:52:28.0373318Z", + "processingStartTime": "2018-08-03T07:52:16.9123797Z", + "runSettings": { + "format": "Csv", + "compressionMode": "gzip", + "dataOverwriteBehavior": "OverwritePreviousReport", + "definition": { + "type": "ActualCost", + "dataSet": { + "configuration": { + "dataVersion": "2023-05-01" + }, + "granularity": "Daily" + }, + "timePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-06-30T00:00:00Z" + }, + "timeframe": "Custom" + }, + "deliveryInfo": { + "destination": { + "container": "exports", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "rootFolderPath": "ScheduledTestsForJohnDoe" + } + }, + "exportDescription": "This is a test export.", + "partitionData": true + }, + "startDate": "2020-06-01T00:00:00Z", + "status": "Completed", + "submittedBy": "john.doe@gmail.com", + "submittedTime": "2018-08-03T07:52:15.6016681Z" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/exports/JohnDoeSchedule/Run/11ac6811-dca3-46ad-b326-4704cf0c58ef", + "properties": { + "endDate": "2020-06-30T00:00:00Z", + "executionType": "Scheduled", + "fileName": "ScheduledTestsForJohnDoe/JohnDoeSchedule/20180729-20180804/JohnDoeSchedule_11ac6811-dca3-46ad-b326-4704cf0c58ef.csv", + "manifestFile": "ScheduledTestsForJohnDoe/JohnDoeSchedule/20180729-20180804/manifestfile", + "processingEndTime": "2018-08-03T09:04:19.7223808Z", + "processingStartTime": "2018-08-03T09:03:58.5710244Z", + "runSettings": { + "format": "Csv", + "compressionMode": "gzip", + "dataOverwriteBehavior": "OverwritePreviousReport", + "definition": { + "type": "ActualCost", + "dataSet": { + "configuration": { + "dataVersion": "2023-05-01" + }, + "granularity": "Daily" + }, + "timePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-06-30T00:00:00Z" + }, + "timeframe": "Custom" + }, + "deliveryInfo": { + "destination": { + "container": "exports", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "rootFolderPath": "ScheduledTestsForJohnDoe" + } + }, + "exportDescription": "This is a test export.", + "partitionData": true + }, + "startDate": "2020-06-01T00:00:00Z", + "status": "Completed", + "submittedBy": "System", + "submittedTime": "2018-08-03T09:03:58.5710244Z" + } + } + ] + } + } + }, + "operationId": "Exports_GetExecutionHistory", + "title": "ExportRunHistoryGetByResourceGroup" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExportRunHistoryGetBySubscription.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExportRunHistoryGetBySubscription.json new file mode 100644 index 000000000000..3a6b11e8d7a3 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExportRunHistoryGetBySubscription.json @@ -0,0 +1,104 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "exportName": "TestExport", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/exports/JohnDoeSchedule/Run/1e25d58a-a3b0-4916-9542-6e04a89bc100", + "properties": { + "endDate": "2020-06-30T00:00:00Z", + "executionType": "OnDemand", + "fileName": "ScheduledTestsForJohnDoe/JohnDoeSchedule/20180729-20180804/JohnDoeSchedule_1e25d58a-a3b0-4916-9542-6e04a89bc100.csv", + "manifestFile": "ScheduledTestsForJohnDoe/JohnDoeSchedule/20180729-20180804/manifestfile", + "processingEndTime": "2018-08-03T07:52:28.0373318Z", + "processingStartTime": "2018-08-03T07:52:16.9123797Z", + "runSettings": { + "format": "Csv", + "compressionMode": "gzip", + "dataOverwriteBehavior": "OverwritePreviousReport", + "definition": { + "type": "ActualCost", + "dataSet": { + "configuration": { + "dataVersion": "2023-05-01" + }, + "granularity": "Daily" + }, + "timePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-06-30T00:00:00Z" + }, + "timeframe": "Custom" + }, + "deliveryInfo": { + "destination": { + "container": "exports", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "rootFolderPath": "ScheduledTestsForJohnDoe" + } + }, + "exportDescription": "This is a test export.", + "partitionData": true + }, + "startDate": "2020-06-01T00:00:00Z", + "status": "Completed", + "submittedBy": "john.doe@gmail.com", + "submittedTime": "2018-08-03T07:52:15.6016681Z" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/exports/JohnDoeSchedule/Run/11ac6811-dca3-46ad-b326-4704cf0c58ef", + "properties": { + "endDate": "2020-06-30T00:00:00Z", + "executionType": "Scheduled", + "fileName": "ScheduledTestsForJohnDoe/JohnDoeSchedule/20180729-20180804/JohnDoeSchedule_11ac6811-dca3-46ad-b326-4704cf0c58ef.csv", + "manifestFile": "ScheduledTestsForJohnDoe/JohnDoeSchedule/20180729-20180804/manifestfile", + "processingEndTime": "2018-08-03T09:04:19.7223808Z", + "processingStartTime": "2018-08-03T09:03:58.5710244Z", + "runSettings": { + "format": "Csv", + "compressionMode": "gzip", + "dataOverwriteBehavior": "OverwritePreviousReport", + "definition": { + "type": "ActualCost", + "dataSet": { + "configuration": { + "dataVersion": "2023-05-01" + }, + "granularity": "Daily" + }, + "timePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-06-30T00:00:00Z" + }, + "timeframe": "Custom" + }, + "deliveryInfo": { + "destination": { + "container": "exports", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "rootFolderPath": "ScheduledTestsForJohnDoe" + } + }, + "exportDescription": "This is a test export.", + "partitionData": true + }, + "startDate": "2020-06-01T00:00:00Z", + "status": "Completed", + "submittedBy": "System", + "submittedTime": "2018-08-03T09:03:58.5710244Z" + } + } + ] + } + } + }, + "operationId": "Exports_GetExecutionHistory", + "title": "ExportRunHistoryGetBySubscription" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExportsGetByBillingAccount.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExportsGetByBillingAccount.json new file mode 100644 index 000000000000..6885e697d359 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExportsGetByBillingAccount.json @@ -0,0 +1,99 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "billingAccountId": "123456", + "scope": "providers/Microsoft.Billing/billingAccounts/123456" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "TestExport1", + "type": "Microsoft.CostManagement/exports", + "id": "/providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/exports/TestExport1", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000" + }, + "location": "centralus", + "properties": { + "format": "Csv", + "compressionMode": "gzip", + "dataOverwriteBehavior": "OverwritePreviousReport", + "definition": { + "type": "ActualCost", + "dataSet": { + "configuration": { + "dataVersion": "2023-05-01" + }, + "granularity": "Daily" + }, + "timePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-06-30T00:00:00Z" + }, + "timeframe": "Custom" + }, + "deliveryInfo": { + "destination": { + "container": "exports", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "rootFolderPath": "ad-hoc" + } + }, + "exportDescription": "This is a test export.", + "partitionData": true + } + }, + { + "name": "TestExport2", + "type": "Microsoft.CostManagement/exports", + "id": "/providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/exports/TestExport2", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000" + }, + "location": "centralus", + "properties": { + "format": "Csv", + "compressionMode": "gzip", + "dataOverwriteBehavior": "OverwritePreviousReport", + "definition": { + "type": "ActualCost", + "dataSet": { + "configuration": { + "dataVersion": "2023-05-01" + }, + "granularity": "Daily" + }, + "timeframe": "WeekToDate" + }, + "deliveryInfo": { + "destination": { + "container": "exports", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "rootFolderPath": "ad-hoc" + } + }, + "exportDescription": "This is a test export.", + "partitionData": true, + "schedule": { + "recurrence": "Weekly", + "recurrencePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-06-30T00:00:00Z" + }, + "status": "Active" + } + } + } + ] + } + } + }, + "operationId": "Exports_List", + "title": "ExportsGetByBillingAccount" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExportsGetByDepartment.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExportsGetByDepartment.json new file mode 100644 index 000000000000..782cb74eb6d2 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExportsGetByDepartment.json @@ -0,0 +1,104 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "billingAccountId": "12", + "departmentId": "1234", + "scope": "providers/Microsoft.Billing/billingAccounts/12/departments/123" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "TestExport1", + "type": "Microsoft.CostManagement/exports", + "id": "/providers/Microsoft.Billing/billingAccounts/12/departments/1234/providers/Microsoft.CostManagement/exports/TestExport1", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000" + }, + "location": "centralus", + "properties": { + "format": "Csv", + "compressionMode": "gzip", + "dataOverwriteBehavior": "OverwritePreviousReport", + "definition": { + "type": "ActualCost", + "dataSet": { + "configuration": { + "dataVersion": "2023-05-01" + }, + "granularity": "Daily" + }, + "timePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-06-30T00:00:00Z" + }, + "timeframe": "Custom" + }, + "deliveryInfo": { + "destination": { + "container": "exports", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "rootFolderPath": "ad-hoc" + } + }, + "exportDescription": "This is a test export.", + "partitionData": true + } + }, + { + "name": "TestExport2", + "type": "Microsoft.CostManagement/exports", + "id": "/providers/Microsoft.Billing/billingAccounts/12/departments/1234/providers/Microsoft.CostManagement/exports/TestExport2", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000" + }, + "location": "centralus", + "properties": { + "format": "Csv", + "compressionMode": "gzip", + "dataOverwriteBehavior": "OverwritePreviousReport", + "definition": { + "type": "ActualCost", + "dataSet": { + "configuration": { + "dataVersion": "2023-05-01" + }, + "granularity": "Daily" + }, + "timePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-06-30T00:00:00Z" + }, + "timeframe": "Custom" + }, + "deliveryInfo": { + "destination": { + "container": "exports", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "rootFolderPath": "ad-hoc" + } + }, + "exportDescription": "This is a test export.", + "partitionData": true, + "schedule": { + "recurrence": "Weekly", + "recurrencePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-06-30T00:00:00Z" + }, + "status": "Active" + } + } + } + ] + } + } + }, + "operationId": "Exports_List", + "title": "ExportsGetByDepartment" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExportsGetByEnrollmentAccount.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExportsGetByEnrollmentAccount.json new file mode 100644 index 000000000000..cbb6d8b37515 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExportsGetByEnrollmentAccount.json @@ -0,0 +1,104 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "billingAccountId": "100", + "enrollmentAccountId": "456", + "scope": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "TestExport1", + "type": "Microsoft.CostManagement/exports", + "id": "/providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456/providers/Microsoft.CostManagement/exports/TestExport1", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000" + }, + "location": "centralus", + "properties": { + "format": "Csv", + "compressionMode": "gzip", + "dataOverwriteBehavior": "OverwritePreviousReport", + "definition": { + "type": "ActualCost", + "dataSet": { + "configuration": { + "dataVersion": "2023-05-01" + }, + "granularity": "Daily" + }, + "timePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-06-30T00:00:00Z" + }, + "timeframe": "Custom" + }, + "deliveryInfo": { + "destination": { + "container": "exports", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "rootFolderPath": "ad-hoc" + } + }, + "exportDescription": "This is a test export.", + "partitionData": true + } + }, + { + "name": "TestExport2", + "type": "Microsoft.CostManagement/exports", + "id": "/providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456/providers/Microsoft.CostManagement/exports/TestExport2", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000" + }, + "location": "centralus", + "properties": { + "format": "Csv", + "compressionMode": "gzip", + "dataOverwriteBehavior": "OverwritePreviousReport", + "definition": { + "type": "ActualCost", + "dataSet": { + "configuration": { + "dataVersion": "2023-05-01" + }, + "granularity": "Daily" + }, + "timePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-06-30T00:00:00Z" + }, + "timeframe": "Custom" + }, + "deliveryInfo": { + "destination": { + "container": "exports", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "rootFolderPath": "ad-hoc" + } + }, + "exportDescription": "This is a test export.", + "partitionData": true, + "schedule": { + "recurrence": "Weekly", + "recurrencePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-06-30T00:00:00Z" + }, + "status": "Active" + } + } + } + ] + } + } + }, + "operationId": "Exports_List", + "title": "ExportsGetByEnrollmentAccount" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExportsGetByManagementGroup.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExportsGetByManagementGroup.json new file mode 100644 index 000000000000..0553c672736e --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExportsGetByManagementGroup.json @@ -0,0 +1,103 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "managementGroupId": "TestMG", + "scope": "providers/Microsoft.Management/managementGroups/TestMG" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "TestExport1", + "type": "Microsoft.CostManagement/exports", + "id": "/providers/Microsoft.Management/managementGroups/TestMG/providers/Microsoft.CostManagement/exports/TestExport1", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000" + }, + "location": "centralus", + "properties": { + "format": "Csv", + "compressionMode": "gzip", + "dataOverwriteBehavior": "OverwritePreviousReport", + "definition": { + "type": "ActualCost", + "dataSet": { + "configuration": { + "dataVersion": "2023-05-01" + }, + "granularity": "Daily" + }, + "timePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-06-30T00:00:00Z" + }, + "timeframe": "Custom" + }, + "deliveryInfo": { + "destination": { + "container": "exports", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "rootFolderPath": "ad-hoc" + } + }, + "exportDescription": "This is a test export.", + "partitionData": true + } + }, + { + "name": "TestExport2", + "type": "Microsoft.CostManagement/exports", + "id": "/providers/Microsoft.Management/managementGroups/TestMG/providers/Microsoft.CostManagement/exports/TestExport2", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000" + }, + "location": "centralus", + "properties": { + "format": "Csv", + "compressionMode": "gzip", + "dataOverwriteBehavior": "OverwritePreviousReport", + "definition": { + "type": "ActualCost", + "dataSet": { + "configuration": { + "dataVersion": "2023-05-01" + }, + "granularity": "Daily" + }, + "timePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-06-30T00:00:00Z" + }, + "timeframe": "Custom" + }, + "deliveryInfo": { + "destination": { + "container": "exports", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "rootFolderPath": "ad-hoc" + } + }, + "exportDescription": "This is a test export.", + "partitionData": true, + "schedule": { + "recurrence": "Weekly", + "recurrencePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-06-30T00:00:00Z" + }, + "status": "Active" + } + } + } + ] + } + } + }, + "operationId": "Exports_List", + "title": "ExportsGetByManagementGroup" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExportsGetByResourceGroup.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExportsGetByResourceGroup.json new file mode 100644 index 000000000000..df4b1d5942c5 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExportsGetByResourceGroup.json @@ -0,0 +1,104 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "resourceGroupName": "MYDEVTESTRG", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "TestExport1", + "type": "Microsoft.CostManagement/exports", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/exports/TestExport1", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000" + }, + "location": "centralus", + "properties": { + "format": "Csv", + "compressionMode": "gzip", + "dataOverwriteBehavior": "OverwritePreviousReport", + "definition": { + "type": "ActualCost", + "dataSet": { + "configuration": { + "dataVersion": "2023-05-01" + }, + "granularity": "Daily" + }, + "timePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-06-30T00:00:00Z" + }, + "timeframe": "Custom" + }, + "deliveryInfo": { + "destination": { + "container": "exports", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "rootFolderPath": "ad-hoc" + } + }, + "exportDescription": "This is a test export.", + "partitionData": true + } + }, + { + "name": "TestExport2", + "type": "Microsoft.CostManagement/exports", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/exports/TestExport2", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000" + }, + "location": "centralus", + "properties": { + "format": "Csv", + "compressionMode": "gzip", + "dataOverwriteBehavior": "OverwritePreviousReport", + "definition": { + "type": "ActualCost", + "dataSet": { + "configuration": { + "dataVersion": "2023-05-01" + }, + "granularity": "Daily" + }, + "timePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-06-30T00:00:00Z" + }, + "timeframe": "Custom" + }, + "deliveryInfo": { + "destination": { + "container": "exports", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "rootFolderPath": "ad-hoc" + } + }, + "exportDescription": "This is a test export.", + "partitionData": true, + "schedule": { + "recurrence": "Weekly", + "recurrencePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-06-30T00:00:00Z" + }, + "status": "Active" + } + } + } + ] + } + } + }, + "operationId": "Exports_List", + "title": "ExportsGetByResourceGroup" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExportsGetBySubscription.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExportsGetBySubscription.json new file mode 100644 index 000000000000..96aac6905443 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExportsGetBySubscription.json @@ -0,0 +1,103 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "TestExport1", + "type": "Microsoft.CostManagement/exports", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/exports/TestExport1", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000" + }, + "location": "centralus", + "properties": { + "format": "Csv", + "compressionMode": "gzip", + "dataOverwriteBehavior": "OverwritePreviousReport", + "definition": { + "type": "ActualCost", + "dataSet": { + "configuration": { + "dataVersion": "2023-05-01" + }, + "granularity": "Daily" + }, + "timePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-06-30T00:00:00Z" + }, + "timeframe": "Custom" + }, + "deliveryInfo": { + "destination": { + "container": "exports", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "rootFolderPath": "ad-hoc" + } + }, + "exportDescription": "This is a test export.", + "partitionData": true + } + }, + { + "name": "TestExport2", + "type": "Microsoft.CostManagement/exports", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/exports/TestExport2", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000" + }, + "location": "centralus", + "properties": { + "format": "Csv", + "compressionMode": "gzip", + "dataOverwriteBehavior": "OverwritePreviousReport", + "definition": { + "type": "ActualCost", + "dataSet": { + "configuration": { + "dataVersion": "2023-05-01" + }, + "granularity": "Daily" + }, + "timePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-06-30T00:00:00Z" + }, + "timeframe": "Custom" + }, + "deliveryInfo": { + "destination": { + "container": "exports", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "rootFolderPath": "ad-hoc" + } + }, + "exportDescription": "This is a test export.", + "partitionData": true, + "schedule": { + "recurrence": "Weekly", + "recurrencePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-06-30T00:00:00Z" + }, + "status": "Active" + } + } + } + ] + } + } + }, + "operationId": "Exports_List", + "title": "ExportsGetBySubscription" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExternalBillingAccountAlerts.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExternalBillingAccountAlerts.json new file mode 100644 index 000000000000..3f17e2817793 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExternalBillingAccountAlerts.json @@ -0,0 +1,100 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "externalCloudProviderId": "100", + "externalCloudProviderType": "externalBillingAccounts" + }, + "responses": { + "200": { + "body": { + "nextLink": null, + "value": [ + { + "name": "00000000-0000-0000-0000-000000000000", + "type": "Microsoft.CostManagement/alerts", + "id": "/providers/Microsoft.CostManagement/externalBillingAccounts/100/providers/Microsoft.CostManagement/alerts/00000000-0000-0000-0000-000000000000", + "properties": { + "description": "", + "closeTime": "0001-01-01T00:00:00", + "costEntityId": "budget1", + "creationTime": "2020-04-27T11:07:52.7143901Z", + "definition": { + "type": "Budget", + "category": "Cost", + "criteria": "CostThresholdExceeded" + }, + "modificationTime": "2020-04-28T11:06:02.8999373Z", + "source": "Preset", + "status": "Active", + "statusModificationTime": "0001-01-01T00:00:00", + "statusModificationUserName": null, + "details": { + "amount": 200000, + "contactEmails": [ + "1234@contoso.com" + ], + "contactGroups": [], + "contactRoles": [], + "currentSpend": 161000.12, + "meterFilter": [], + "operator": "GreaterThan", + "overridingAlert": null, + "periodStartDate": "2020-03-01T00:00:00Z", + "resourceFilter": [], + "resourceGroupFilter": [], + "tagFilter": {}, + "threshold": 0.8, + "timeGrainType": "Quarterly", + "triggeredBy": "00000000-0000-0000-0000-000000000000_1_01", + "unit": "USD" + } + } + }, + { + "name": "11111111-1111-1111-111111111111", + "type": "Microsoft.CostManagement/alerts", + "id": "/providers/Microsoft.CostManagement/externalBillingAccounts/100/providers/Microsoft.CostManagement/alerts/11111111-1111-1111-111111111111", + "properties": { + "description": "", + "closeTime": "0001-01-01T00:00:00", + "costEntityId": "budget1", + "creationTime": "2019-06-24T05:51:52.8713179Z", + "definition": { + "type": "Budget", + "category": "Cost", + "criteria": "CostThresholdExceeded" + }, + "modificationTime": "2019-08-31T17:51:55.1808807Z", + "source": "Preset", + "status": "Active", + "statusModificationTime": "0001-01-01T00:00:00", + "statusModificationUserName": null, + "details": { + "amount": 200000, + "contactEmails": [ + "1234@contoso.com" + ], + "contactGroups": [], + "contactRoles": [], + "currentSpend": 171000.32, + "meterFilter": [], + "operator": "GreaterThan", + "overridingAlert": null, + "periodStartDate": "2020-03-01T00:00:00Z", + "resourceFilter": [], + "resourceGroupFilter": [], + "tagFilter": {}, + "threshold": 0.8, + "timeGrainType": "Quarterly", + "triggeredBy": "11111111-1111-1111-111111111111_1_01", + "unit": "USD" + } + } + } + ] + } + } + }, + "operationId": "Alerts_ListExternal", + "title": "ExternalBillingAccountAlerts" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExternalBillingAccountForecast.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExternalBillingAccountForecast.json new file mode 100644 index 000000000000..51472ba6a1dd --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExternalBillingAccountForecast.json @@ -0,0 +1,111 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "externalCloudProviderId": "100", + "externalCloudProviderType": "externalBillingAccounts", + "parameters": { + "type": "Usage", + "dataset": { + "aggregation": { + "totalCost": { + "name": "Cost", + "function": "Sum" + } + }, + "filter": { + "and": [ + { + "or": [ + { + "dimensions": { + "name": "ResourceLocation", + "operator": "In", + "values": [ + "East US", + "West Europe" + ] + } + }, + { + "tags": { + "name": "Environment", + "operator": "In", + "values": [ + "UAT", + "Prod" + ] + } + } + ] + }, + { + "dimensions": { + "name": "ResourceGroup", + "operator": "In", + "values": [ + "API" + ] + } + } + ] + }, + "granularity": "Daily" + }, + "timePeriod": { + "from": "2022-08-01T00:00:00+00:00", + "to": "2022-08-31T23:59:59+00:00" + }, + "timeframe": "Custom" + } + }, + "responses": { + "200": { + "body": { + "name": "6dc7b06a-d90a-4df5-b655-ce6cf1c0814d", + "type": "Microsoft.CostManagement/query", + "id": "/providers/Microsoft.CostManagement/externalBillingAccounts/100/query/6dc7b06a-d90a-4df5-b655-ce6cf1c0814d", + "properties": { + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "CostStatus", + "type": "String" + }, + { + "name": "Currency", + "type": "String" + } + ], + "nextLink": null, + "rows": [ + [ + 0, + "Forecast", + "USD" + ], + [ + 30.2572751438, + "Forecast", + "USD" + ], + [ + 0.07675760200000002, + "Forecast", + "USD" + ], + [ + 50.43096419040001, + "Forecast", + "USD" + ] + ] + } + } + } + }, + "operationId": "Forecast_ExternalCloudProviderUsage", + "title": "ExternalBillingAccountForecast" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExternalBillingAccountsDimensions.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExternalBillingAccountsDimensions.json new file mode 100644 index 000000000000..42097259c48f --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExternalBillingAccountsDimensions.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "externalCloudProviderId": "100", + "externalCloudProviderType": "externalBillingAccounts" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "dimensions_ResourceType_2019-12-01_2019-12-31", + "type": "microsoft.consumption/dimensions", + "id": "/providers/Microsoft.CostManagement/externalBillingAccounts/100/dimensions_ResourceType_2019-12-01_2019-12-31", + "properties": { + "description": "Resource type", + "category": "ResourceType", + "data": [ + "thoroetrg01", + "default-notificationhubs-westus", + "jedikeyvaultrg", + "contosocodeflow8d4a", + "noobaa" + ], + "filterEnabled": true, + "groupingEnabled": true, + "total": 0, + "usageEnd": "2019-12-31T00:00:00Z", + "usageStart": "2019-12-01T00:00:00Z" + } + }, + { + "name": "dimensions_ResourceId_2019-12-01_2019-12-31", + "type": "microsoft.consumption/dimensions", + "id": "/providers/Microsoft.CostManagement/externalBillingAccounts/100/dimensions_ResourceId_2019-12-01_2019-12-31", + "properties": { + "description": "Resource ID", + "category": "ResourceId", + "data": [ + "thoroetrg01", + "default-notificationhubs-westus", + "jedikeyvaultrg", + "contosocodeflow8d4a", + "noobaa" + ], + "filterEnabled": true, + "groupingEnabled": true, + "total": 0, + "usageEnd": "2019-12-31T00:00:00Z", + "usageStart": "2019-12-01T00:00:00Z" + } + } + ] + } + } + }, + "operationId": "Dimensions_ByExternalCloudProviderType", + "title": "ExternalBillingAccountDimensionList" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExternalBillingAccountsQuery.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExternalBillingAccountsQuery.json new file mode 100644 index 000000000000..27088513dbe1 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExternalBillingAccountsQuery.json @@ -0,0 +1,101 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "externalCloudProviderId": "100", + "externalCloudProviderType": "externalBillingAccounts", + "parameters": { + "type": "Usage", + "dataset": { + "filter": { + "and": [ + { + "or": [ + { + "dimensions": { + "name": "ResourceLocation", + "operator": "In", + "values": [ + "East US", + "West Europe" + ] + } + }, + { + "tags": { + "name": "Environment", + "operator": "In", + "values": [ + "UAT", + "Prod" + ] + } + } + ] + }, + { + "dimensions": { + "name": "ResourceGroup", + "operator": "In", + "values": [ + "API" + ] + } + } + ] + }, + "granularity": "Daily" + }, + "timeframe": "MonthToDate" + } + }, + "responses": { + "200": { + "body": { + "name": "6dc7b06a-d90a-4df5-b655-ce6cf1c0814d", + "type": "Microsoft.CostManagement/query", + "id": "/providers/Microsoft.CostManagement/externalBillingAccounts/100/query/6dc7b06a-d90a-4df5-b655-ce6cf1c0814d", + "properties": { + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "ServiceName", + "type": "String" + }, + { + "name": "Currency", + "type": "String" + } + ], + "nextLink": null, + "rows": [ + [ + 0, + "abc db", + "USD" + ], + [ + 30.2572751438, + "abc compute cloud", + "USD" + ], + [ + 0.07675760200000002, + "abc file system", + "USD" + ], + [ + 50.43096419040001, + "abc elasticache", + "USD" + ] + ] + } + } + } + }, + "operationId": "Query_UsageByExternalCloudProviderType", + "title": "ExternalBillingAccountQueryList" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExternalSubscriptionAlerts.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExternalSubscriptionAlerts.json new file mode 100644 index 000000000000..5aa2c4476ab6 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExternalSubscriptionAlerts.json @@ -0,0 +1,100 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "externalCloudProviderId": "100", + "externalCloudProviderType": "externalSubscriptions" + }, + "responses": { + "200": { + "body": { + "nextLink": null, + "value": [ + { + "name": "00000000-0000-0000-0000-000000000000", + "type": "Microsoft.CostManagement/alerts", + "id": "/providers/Microsoft.CostManagement/externalSubscriptions/100/providers/Microsoft.CostManagement/alerts/00000000-0000-0000-0000-000000000000", + "properties": { + "description": "", + "closeTime": "0001-01-01T00:00:00", + "costEntityId": "budget1", + "creationTime": "2020-04-27T11:07:52.7143901Z", + "definition": { + "type": "Budget", + "category": "Cost", + "criteria": "CostThresholdExceeded" + }, + "modificationTime": "2020-04-28T11:06:02.8999373Z", + "source": "Preset", + "status": "Active", + "statusModificationTime": "0001-01-01T00:00:00", + "statusModificationUserName": null, + "details": { + "amount": 200000, + "contactEmails": [ + "1234@contoso.com" + ], + "contactGroups": [], + "contactRoles": [], + "currentSpend": 161000.12, + "meterFilter": [], + "operator": "GreaterThan", + "overridingAlert": null, + "periodStartDate": "2020-03-01T00:00:00Z", + "resourceFilter": [], + "resourceGroupFilter": [], + "tagFilter": {}, + "threshold": 0.8, + "timeGrainType": "Quarterly", + "triggeredBy": "00000000-0000-0000-0000-000000000000_1_01", + "unit": "USD" + } + } + }, + { + "name": "11111111-1111-1111-111111111111", + "type": "Microsoft.CostManagement/alerts", + "id": "/providers/Microsoft.CostManagement/externalSubscriptions/100/providers/Microsoft.CostManagement/alerts/11111111-1111-1111-111111111111", + "properties": { + "description": "", + "closeTime": "0001-01-01T00:00:00", + "costEntityId": "budget1", + "creationTime": "2019-06-24T05:51:52.8713179Z", + "definition": { + "type": "Budget", + "category": "Cost", + "criteria": "CostThresholdExceeded" + }, + "modificationTime": "2019-08-31T17:51:55.1808807Z", + "source": "Preset", + "status": "Active", + "statusModificationTime": "0001-01-01T00:00:00", + "statusModificationUserName": null, + "details": { + "amount": 200000, + "contactEmails": [ + "1234@contoso.com" + ], + "contactGroups": [], + "contactRoles": [], + "currentSpend": 171000.32, + "meterFilter": [], + "operator": "GreaterThan", + "overridingAlert": null, + "periodStartDate": "2020-03-01T00:00:00Z", + "resourceFilter": [], + "resourceGroupFilter": [], + "tagFilter": {}, + "threshold": 0.8, + "timeGrainType": "Quarterly", + "triggeredBy": "11111111-1111-1111-111111111111_1_01", + "unit": "USD" + } + } + } + ] + } + } + }, + "operationId": "Alerts_ListExternal", + "title": "ExternalSubscriptionAlerts" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExternalSubscriptionForecast.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExternalSubscriptionForecast.json new file mode 100644 index 000000000000..4aa83bbbd370 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExternalSubscriptionForecast.json @@ -0,0 +1,94 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "externalCloudProviderId": "100", + "externalCloudProviderType": "externalSubscriptions", + "parameters": { + "type": "Usage", + "dataset": { + "aggregation": { + "totalCost": { + "name": "Cost", + "function": "Sum" + } + }, + "filter": { + "and": [ + { + "or": [ + { + "dimensions": { + "name": "ResourceLocation", + "operator": "In", + "values": [ + "East US", + "West Europe" + ] + } + }, + { + "tags": { + "name": "Environment", + "operator": "In", + "values": [ + "UAT", + "Prod" + ] + } + } + ] + }, + { + "dimensions": { + "name": "ResourceGroup", + "operator": "In", + "values": [ + "API" + ] + } + } + ] + }, + "granularity": "Daily" + }, + "timePeriod": { + "from": "2022-08-01T00:00:00+00:00", + "to": "2022-08-31T23:59:59+00:00" + }, + "timeframe": "Custom" + } + }, + "responses": { + "200": { + "body": { + "name": "d99477af-7510-40ee-aca2-e59bdca0d10d", + "type": "Microsoft.CostManagement/query", + "id": "/providers/Microsoft.CostManagement/externalSubscriptions/100/query/d99477af-7510-40ee-aca2-e59bdca0d10d", + "properties": { + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "UsageDate", + "type": "Number" + }, + { + "name": "CostStatus", + "type": "String" + }, + { + "name": "Currency", + "type": "String" + } + ], + "nextLink": null, + "rows": [] + } + } + } + }, + "operationId": "Forecast_ExternalCloudProviderUsage", + "title": "ExternalSubscriptionForecast" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExternalSubscriptionsDimensions.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExternalSubscriptionsDimensions.json new file mode 100644 index 000000000000..fe865e2a9b3d --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExternalSubscriptionsDimensions.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "externalCloudProviderId": "100", + "externalCloudProviderType": "externalSubscriptions" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "dimensions_ResourceType_2019-12-01_2019-12-31", + "type": "microsoft.consumption/dimensions", + "id": "/providers/Microsoft.CostManagement/externalSubscriptions/123/dimensions_ResourceType_2019-12-01_2019-12-31", + "properties": { + "description": "Resource type", + "category": "ResourceType", + "data": [ + "thoroetrg01", + "default-notificationhubs-westus", + "jedikeyvaultrg", + "contosocodeflow8d4a", + "noobaa" + ], + "filterEnabled": true, + "groupingEnabled": true, + "total": 0, + "usageEnd": "2019-12-31T00:00:00Z", + "usageStart": "2019-12-01T00:00:00Z" + } + }, + { + "name": "dimensions_ResourceId_2019-12-01_2019-12-31", + "type": "microsoft.consumption/dimensions", + "id": "/providers/Microsoft.CostManagement/externalSubscriptions/123/dimensions_ResourceId_2019-12-01_2019-12-31", + "properties": { + "description": "Resource ID", + "category": "ResourceId", + "data": [ + "thoroetrg01", + "default-notificationhubs-westus", + "jedikeyvaultrg", + "contosocodeflow8d4a", + "noobaa" + ], + "filterEnabled": true, + "groupingEnabled": true, + "total": 0, + "usageEnd": "2019-12-31T00:00:00Z", + "usageStart": "2019-12-01T00:00:00Z" + } + } + ] + } + } + }, + "operationId": "Dimensions_ByExternalCloudProviderType", + "title": "ExternalSubscriptionDimensionList" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExternalSubscriptionsQuery.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExternalSubscriptionsQuery.json new file mode 100644 index 000000000000..d45465bd5742 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ExternalSubscriptionsQuery.json @@ -0,0 +1,80 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "externalCloudProviderId": "100", + "externalCloudProviderType": "externalSubscriptions", + "parameters": { + "type": "Usage", + "dataset": { + "filter": { + "and": [ + { + "or": [ + { + "dimensions": { + "name": "ResourceLocation", + "operator": "In", + "values": [ + "East US", + "West Europe" + ] + } + }, + { + "tags": { + "name": "Environment", + "operator": "In", + "values": [ + "UAT", + "Prod" + ] + } + } + ] + }, + { + "dimensions": { + "name": "ResourceGroup", + "operator": "In", + "values": [ + "API" + ] + } + } + ] + }, + "granularity": "Daily" + }, + "timeframe": "MonthToDate" + } + }, + "responses": { + "200": { + "body": { + "name": "d99477af-7510-40ee-aca2-e59bdca0d10d", + "type": "Microsoft.CostManagement/query", + "id": "/providers/Microsoft.CostManagement/externalSubscriptions/100/query/d99477af-7510-40ee-aca2-e59bdca0d10d", + "properties": { + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "UsageDate", + "type": "Number" + }, + { + "name": "Currency", + "type": "String" + } + ], + "nextLink": null, + "rows": [] + } + } + } + }, + "operationId": "Query_UsageByExternalCloudProviderType", + "title": "ExternalSubscriptionsQuery" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/GenerateCostDetailsReportByBillingAccountEnterpriseAgreementCustomerAndBillingPeriod.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/GenerateCostDetailsReportByBillingAccountEnterpriseAgreementCustomerAndBillingPeriod.json new file mode 100644 index 000000000000..696d017784ab --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/GenerateCostDetailsReportByBillingAccountEnterpriseAgreementCustomerAndBillingPeriod.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "parameters": { + "billingPeriod": "202205", + "metric": "ActualCost" + }, + "scope": "providers/Microsoft.Billing/billingAccounts/12345" + }, + "responses": { + "200": { + "body": { + "name": "00000000-0000-0000-0000-000000000000", + "id": "/providers/Microsoft.Billing/billingAccounts/12345/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000", + "manifest": { + "blobCount": 1, + "blobs": [ + { + "blobLink": "https://ccmreportstorageeastus.blob.core.windows.net/armreports/00000/00000000-0000-0000-0000-000000000000?sv=2020-05-31&sr=b&sig=abcd", + "byteCount": 32741 + } + ], + "byteCount": 32741, + "compressData": false, + "dataFormat": "Csv", + "manifestVersion": "2025-03-01", + "requestContext": { + "requestBody": { + "billingPeriod": "202205", + "metric": "ActualCost" + }, + "requestScope": "providers/Microsoft.Billing/billingAccounts/12345" + } + }, + "status": "Completed", + "validTill": "2022-05-10T08:08:46.1973252Z" + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000?api-version=2025-03-01", + "Retry-After": "60" + } + }, + "204": {} + }, + "operationId": "GenerateCostDetailsReport_CreateOperation", + "title": "GenerateCostDetailsReportByBillingAccountEnterpriseAgreementCustomerAndBillingPeriod" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/GenerateCostDetailsReportByBillingProfileAndInvoiceId.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/GenerateCostDetailsReportByBillingProfileAndInvoiceId.json new file mode 100644 index 000000000000..92d17f0512fb --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/GenerateCostDetailsReportByBillingProfileAndInvoiceId.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "parameters": { + "invoiceId": "M1234567", + "metric": "ActualCost" + }, + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579" + }, + "responses": { + "200": { + "body": { + "name": "00000000-0000-0000-0000-000000000000", + "id": "/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000", + "manifest": { + "blobCount": 1, + "blobs": [ + { + "blobLink": "https://ccmreportstorageeastus.blob.core.windows.net/armreports/00000/00000000-0000-0000-0000-000000000000?sv=2020-05-31&sr=b&sig=abcd", + "byteCount": 32741 + } + ], + "byteCount": 32741, + "compressData": false, + "dataFormat": "Csv", + "manifestVersion": "2025-03-01", + "requestContext": { + "requestBody": { + "billingPeriod": "202205", + "metric": "ActualCost" + }, + "requestScope": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579" + } + }, + "status": "Completed", + "validTill": "2022-05-10T08:08:46.1973252Z" + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000?api-version=2025-03-01", + "Retry-After": "60" + } + }, + "204": {} + }, + "operationId": "GenerateCostDetailsReport_CreateOperation", + "title": "GenerateCostDetailsReportByBillingProfileAndInvoiceId" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/GenerateCostDetailsReportByBillingProfileAndInvoiceIdAndCustomerId.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/GenerateCostDetailsReportByBillingProfileAndInvoiceIdAndCustomerId.json new file mode 100644 index 000000000000..3b04e313d4f1 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/GenerateCostDetailsReportByBillingProfileAndInvoiceIdAndCustomerId.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "parameters": { + "invoiceId": "M1234567", + "metric": "ActualCost" + }, + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/13579" + }, + "responses": { + "200": { + "body": { + "name": "00000000-0000-0000-0000-000000000000", + "id": "/providers/Microsoft.Billing/billingAccounts/12345:6789/customers/13579/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000", + "manifest": { + "blobCount": 1, + "blobs": [ + { + "blobLink": "https://ccmreportstorageeastus.blob.core.windows.net/armreports/00000/00000000-0000-0000-0000-000000000000?sv=2020-05-31&sr=b&sig=abcd", + "byteCount": 32741 + } + ], + "byteCount": 32741, + "compressData": false, + "dataFormat": "Csv", + "manifestVersion": "2025-03-01", + "requestContext": { + "requestBody": { + "billingPeriod": "202205", + "metric": "ActualCost" + }, + "requestScope": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/13579" + } + }, + "status": "Completed", + "validTill": "2022-05-10T08:08:46.1973252Z" + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/customers/13579/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000?api-version=2025-03-01", + "Retry-After": "60" + } + }, + "204": {} + }, + "operationId": "GenerateCostDetailsReport_CreateOperation", + "title": "GenerateCostDetailsReportByBillingProfileAndInvoiceIdAndCustomerId" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/GenerateCostDetailsReportByCustomerAndTimePeriod.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/GenerateCostDetailsReportByCustomerAndTimePeriod.json new file mode 100644 index 000000000000..aa85991500e3 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/GenerateCostDetailsReportByCustomerAndTimePeriod.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "parameters": { + "metric": "ActualCost", + "timePeriod": { + "end": "2020-03-15", + "start": "2020-03-01" + } + }, + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/13579" + }, + "responses": { + "200": { + "body": { + "name": "00000000-0000-0000-0000-000000000000", + "id": "/providers/Microsoft.Billing/billingAccounts/12345:6789/customers/13579/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000", + "manifest": { + "blobCount": 1, + "blobs": [ + { + "blobLink": "https://ccmreportstorageeastus.blob.core.windows.net/armreports/00000/00000000-0000-0000-0000-000000000000?sv=2020-05-31&sr=b&sig=abcd", + "byteCount": 32741 + } + ], + "byteCount": 32741, + "compressData": false, + "dataFormat": "Csv", + "manifestVersion": "2025-03-01", + "requestContext": { + "requestBody": { + "metric": "ActualCost", + "timePeriod": { + "end": "2020-03-15", + "start": "2020-03-01" + } + }, + "requestScope": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/13579" + } + }, + "status": "Completed", + "validTill": "2022-05-10T08:08:46.1973252Z" + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/customers/13579/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000?api-version=2025-03-01", + "Retry-After": "60" + } + }, + "204": {} + }, + "operationId": "GenerateCostDetailsReport_CreateOperation", + "title": "GenerateCostDetailsReportByCustomerAndTimePeriod" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/GenerateCostDetailsReportByDepartmentsAndTimePeriod.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/GenerateCostDetailsReportByDepartmentsAndTimePeriod.json new file mode 100644 index 000000000000..1bf8f5af711b --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/GenerateCostDetailsReportByDepartmentsAndTimePeriod.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "parameters": { + "metric": "ActualCost", + "timePeriod": { + "end": "2020-03-15", + "start": "2020-03-01" + } + }, + "scope": "providers/Microsoft.Billing/departments/12345" + }, + "responses": { + "200": { + "body": { + "name": "00000000-0000-0000-0000-000000000000", + "id": "/providers/Microsoft.Billing/departments/12345/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000", + "manifest": { + "blobCount": 1, + "blobs": [ + { + "blobLink": "https://ccmreportstorageeastus.blob.core.windows.net/armreports/00000/00000000-0000-0000-0000-000000000000?sv=2020-05-31&sr=b&sig=abcd", + "byteCount": 32741 + } + ], + "byteCount": 32741, + "compressData": false, + "dataFormat": "Csv", + "manifestVersion": "2025-03-01", + "requestContext": { + "requestBody": { + "metric": "ActualCost", + "timePeriod": { + "end": "2020-03-15", + "start": "2020-03-01" + } + }, + "requestScope": "providers/Microsoft.Billing/departments/12345" + } + }, + "status": "Completed", + "validTill": "2022-05-10T08:08:46.1973252Z" + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/providers/Microsoft.Billing/departments/12345/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000?api-version=2025-03-01", + "Retry-After": "60" + } + }, + "204": {} + }, + "operationId": "GenerateCostDetailsReport_CreateOperation", + "title": "GenerateCostDetailsReportByDepartmentsAndTimePeriod" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/GenerateCostDetailsReportByEnrollmentAccountsAndTimePeriod.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/GenerateCostDetailsReportByEnrollmentAccountsAndTimePeriod.json new file mode 100644 index 000000000000..45de492986f4 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/GenerateCostDetailsReportByEnrollmentAccountsAndTimePeriod.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "parameters": { + "metric": "ActualCost", + "timePeriod": { + "end": "2020-03-15", + "start": "2020-03-01" + } + }, + "scope": "providers/Microsoft.Billing/enrollmentAccounts/1234" + }, + "responses": { + "200": { + "body": { + "name": "00000000-0000-0000-0000-000000000000", + "id": "/providers/Microsoft.Billing/enrollmentAccounts/1234/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000", + "manifest": { + "blobCount": 1, + "blobs": [ + { + "blobLink": "https://ccmreportstorageeastus.blob.core.windows.net/armreports/00000/00000000-0000-0000-0000-000000000000?sv=2020-05-31&sr=b&sig=abcd", + "byteCount": 32741 + } + ], + "byteCount": 32741, + "compressData": false, + "dataFormat": "Csv", + "manifestVersion": "2025-03-01", + "requestContext": { + "requestBody": { + "metric": "ActualCost", + "timePeriod": { + "end": "2020-03-15", + "start": "2020-03-01" + } + }, + "requestScope": "providers/Microsoft.Billing/enrollmentAccounts/1234" + } + }, + "status": "Completed", + "validTill": "2022-05-10T08:08:46.1973252Z" + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/providers/Microsoft.Billing/enrollmentAccounts/1234/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000?api-version=2025-03-01", + "Retry-After": "60" + } + }, + "204": {} + }, + "operationId": "GenerateCostDetailsReport_CreateOperation", + "title": "GenerateCostDetailsReportByEnrollmentAccountsAndTimePeriod" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/GenerateCostDetailsReportBySubscriptionAndTimePeriod.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/GenerateCostDetailsReportBySubscriptionAndTimePeriod.json new file mode 100644 index 000000000000..3f454ffc3319 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/GenerateCostDetailsReportBySubscriptionAndTimePeriod.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "parameters": { + "metric": "ActualCost", + "timePeriod": { + "end": "2020-03-15", + "start": "2020-03-01" + } + }, + "scope": "subscriptions/00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "00000000-0000-0000-0000-000000000000", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000", + "manifest": { + "blobCount": 1, + "blobs": [ + { + "blobLink": "https://ccmreportstorageeastus.blob.core.windows.net/armreports/00000/00000000-0000-0000-0000-000000000000?sv=2020-05-31&sr=b&sig=abcd", + "byteCount": 32741 + } + ], + "byteCount": 32741, + "compressData": false, + "dataFormat": "Csv", + "manifestVersion": "2025-03-01", + "requestContext": { + "requestBody": { + "metric": "ActualCost", + "timePeriod": { + "end": "2020-03-15", + "start": "2020-03-01" + } + }, + "requestScope": "subscriptions/00000000-0000-0000-0000-000000000000" + } + }, + "status": "Completed", + "validTill": "2022-05-10T08:08:46.1973252Z" + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000?api-version=2025-03-01", + "Retry-After": "60" + } + }, + "204": {} + }, + "operationId": "GenerateCostDetailsReport_CreateOperation", + "title": "GenerateCostDetailsReportBySubscriptionAndTimePeriod" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/GenerateDetailedCostReportByBillingAccountLegacyAndBillingPeriod.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/GenerateDetailedCostReportByBillingAccountLegacyAndBillingPeriod.json new file mode 100644 index 000000000000..a15e4195b84e --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/GenerateDetailedCostReportByBillingAccountLegacyAndBillingPeriod.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "parameters": { + "billingPeriod": "202008", + "metric": "ActualCost" + }, + "scope": "providers/Microsoft.Billing/billingAccounts/12345" + }, + "responses": { + "200": { + "body": { + "name": "00000000-0000-0000-0000-000000000000", + "type": "Microsoft.Consumption/operationResult", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/operationResults/00000000-0000-0000-0000-000000000000", + "properties": { + "downloadUrl": "https://ccmreportstorageeastus.blob.core.windows.net/armreports/20201207/00000000-0000-0000-0000-000000000000?sv=2020-05-31&sr=b&sig=abcd", + "validTill": "2020-12-08T05:55:59.4394737Z" + } + } + }, + "202": { + "headers": { + "Azure-Consumption-AsyncOperation": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345/providers/Microsoft.CostManagement/operationStatus/ad0d632f-1186-41fe-89f9-ae29e198d223?api-version=2021-10-01", + "Location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345/providers/Microsoft.CostManagement/operationResults/ad0d632f-1186-41fe-89f9-ae29e198d223?api-version=2021-10-01", + "Retry-After": "60" + } + } + }, + "operationId": "GenerateDetailedCostReport_CreateOperation", + "title": "GenerateDetailedCostReportByBillingAccountLegacyAndBillingPeriod" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/GenerateDetailedCostReportByBillingProfileAndInvoiceId.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/GenerateDetailedCostReportByBillingProfileAndInvoiceId.json new file mode 100644 index 000000000000..10444fed51bf --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/GenerateDetailedCostReportByBillingProfileAndInvoiceId.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "parameters": { + "invoiceId": "M1234567", + "metric": "ActualCost" + }, + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579" + }, + "responses": { + "200": { + "body": { + "name": "00000000-0000-0000-0000-000000000000", + "type": "Microsoft.Consumption/operationResult", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/operationResults/00000000-0000-0000-0000-000000000000", + "properties": { + "downloadUrl": "https://ccmreportstorageeastus.blob.core.windows.net/armreports/20201207/00000000-0000-0000-0000-000000000000?sv=2020-05-31&sr=b&sig=abcd", + "validTill": "2020-12-08T05:55:59.4394737Z" + } + } + }, + "202": { + "headers": { + "Azure-Consumption-AsyncOperation": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/operationStatus/ad0d632f-1186-41fe-89f9-ae29e198d223?api-version=2021-10-01", + "Location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/operationResults/ad0d632f-1186-41fe-89f9-ae29e198d223?api-version=2021-10-01", + "Retry-After": "60" + } + } + }, + "operationId": "GenerateDetailedCostReport_CreateOperation", + "title": "GenerateDetailedCostReportByBillingProfileAndInvoiceId" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/GenerateDetailedCostReportByBillingProfileAndInvoiceIdAndCustomerId.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/GenerateDetailedCostReportByBillingProfileAndInvoiceIdAndCustomerId.json new file mode 100644 index 000000000000..08ff4ecf1f7c --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/GenerateDetailedCostReportByBillingProfileAndInvoiceIdAndCustomerId.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "parameters": { + "customerId": "456789", + "invoiceId": "M1234567", + "metric": "ActualCost" + }, + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579" + }, + "responses": { + "200": { + "body": { + "name": "00000000-0000-0000-0000-000000000000", + "type": "Microsoft.Consumption/operationResult", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/operationResults/00000000-0000-0000-0000-000000000000", + "properties": { + "downloadUrl": "https://ccmreportstorageeastus.blob.core.windows.net/armreports/20201207/00000000-0000-0000-0000-000000000000?sv=2020-05-31&sr=b&sig=abcd", + "validTill": "2020-12-08T05:55:59.4394737Z" + } + } + }, + "202": { + "headers": { + "Azure-Consumption-AsyncOperation": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/operationStatus/ad0d632f-1186-41fe-89f9-ae29e198d223?api-version=2021-10-01", + "Location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/operationResults/ad0d632f-1186-41fe-89f9-ae29e198d223?api-version=2021-10-01", + "Retry-After": "60" + } + } + }, + "operationId": "GenerateDetailedCostReport_CreateOperation", + "title": "GenerateDetailedCostReportByBillingProfileAndInvoiceIdAndCustomerId" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/GenerateDetailedCostReportByCustomerAndTimePeriod.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/GenerateDetailedCostReportByCustomerAndTimePeriod.json new file mode 100644 index 000000000000..703cc6d3f3a6 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/GenerateDetailedCostReportByCustomerAndTimePeriod.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "parameters": { + "metric": "ActualCost", + "timePeriod": { + "end": "2020-03-15", + "start": "2020-03-01" + } + }, + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/13579" + }, + "responses": { + "200": { + "body": { + "name": "00000000-0000-0000-0000-000000000000", + "type": "Microsoft.Consumption/operationResult", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/operationResults/00000000-0000-0000-0000-000000000000", + "properties": { + "downloadUrl": "https://ccmreportstorageeastus.blob.core.windows.net/armreports/20201207/00000000-0000-0000-0000-000000000000?sv=2020-05-31&sr=b&sig=abcd", + "validTill": "2020-12-08T05:55:59.4394737Z" + } + } + }, + "202": { + "headers": { + "Azure-Consumption-AsyncOperation": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/customers/13579/providers/Microsoft.CostManagement/operationStatus/ad0d632f-1186-41fe-89f9-ae29e198d223?api-version=2021-10-01", + "Location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/customers/13579/providers/Microsoft.CostManagement/operationResults/ad0d632f-1186-41fe-89f9-ae29e198d223?api-version=2021-10-01", + "Retry-After": "60" + } + } + }, + "operationId": "GenerateDetailedCostReport_CreateOperation", + "title": "GenerateDetailedCostReportByCustomerAndTimePeriod" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/GenerateDetailedCostReportBySubscriptionAndTimePeriod.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/GenerateDetailedCostReportBySubscriptionAndTimePeriod.json new file mode 100644 index 000000000000..9122133cb07b --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/GenerateDetailedCostReportBySubscriptionAndTimePeriod.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "parameters": { + "metric": "ActualCost", + "timePeriod": { + "end": "2020-03-15", + "start": "2020-03-01" + } + }, + "scope": "subscriptions/00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "00000000-0000-0000-0000-000000000000", + "type": "Microsoft.Consumption/operationResult", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/operationResults/00000000-0000-0000-0000-000000000000", + "properties": { + "downloadUrl": "https://ccmreportstorageeastus.blob.core.windows.net/armreports/20201207/00000000-0000-0000-0000-000000000000?sv=2020-05-31&sr=b&sig=abcd", + "validTill": "2020-12-08T05:55:59.4394737Z" + } + } + }, + "202": { + "headers": { + "Azure-Consumption-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/operationStatus/00000000-0000-0000-0000-000000000000?api-version=2021-10-01", + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/operationResults/00000000-0000-0000-0000-000000000000?api-version=2021-10-01", + "Retry-After": "60" + } + } + }, + "operationId": "GenerateDetailedCostReport_CreateOperation", + "title": "GenerateDetailedCostReportBySubscriptionAndTimePeriod" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/GenerateDetailedCostReportOperationResultsBySubscriptionScope.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/GenerateDetailedCostReportOperationResultsBySubscriptionScope.json new file mode 100644 index 000000000000..a4f2b416030e --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/GenerateDetailedCostReportOperationResultsBySubscriptionScope.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "operationId": "00000000-0000-0000-0000-000000000000", + "api-version": "2025-03-01", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "00000000-0000-0000-0000-000000000000", + "type": "Microsoft.Consumption/operationResult", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/operationResults/00000000-0000-0000-0000-000000000000", + "properties": { + "downloadUrl": "https://ccmreportstorageeastus.blob.core.windows.net/armreports/20201207/00000000-0000-0000-0000-000000000000?sv=2020-05-31&sr=b&sig=abcd", + "validTill": "2020-12-08T05:55:59.4394737Z" + } + } + }, + "202": { + "headers": { + "Azure-Consumption-AsyncOperation": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345/providers/Microsoft.CostManagement/operationStatus/ad0d632f-1186-41fe-89f9-ae29e198d223?api-version=2021-10-01", + "Location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345/providers/Microsoft.CostManagement/operationResults/ad0d632f-1186-41fe-89f9-ae29e198d223?api-version=2021-10-01", + "Retry-After": "60" + } + } + }, + "operationId": "GenerateDetailedCostReportOperationResults_Get", + "title": "Get details of the operation result" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/GenerateDetailedCostReportOperationStatusBySubscriptionScope.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/GenerateDetailedCostReportOperationStatusBySubscriptionScope.json new file mode 100644 index 000000000000..ff936acad223 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/GenerateDetailedCostReportOperationStatusBySubscriptionScope.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "operationId": "00000000-0000-0000-0000-000000000000", + "api-version": "2025-03-01", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "00000000-0000-0000-0000-000000000000", + "type": "Microsoft.Consumption/operationStatus", + "error": { + "code": "0", + "message": null + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/operationStatus/00000000-0000-0000-0000-000000000000", + "properties": { + "downloadUrl": "https://ccmreportstorageeastus.blob.core.windows.net/armreports/20201207/00000000-0000-0000-0000-000000000000?sv=2020-05-31&sr=b&sig=abcd", + "validTill": "2020-12-08T05:55:59.4394737Z" + }, + "status": { + "status": "Completed" + } + } + } + }, + "operationId": "GenerateDetailedCostReportOperationStatus_Get", + "title": "Get details of the operation status" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/GenerateReservationDetailsReportByBillingAccount.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/GenerateReservationDetailsReportByBillingAccount.json new file mode 100644 index 000000000000..b6a60849c2b9 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/GenerateReservationDetailsReportByBillingAccount.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "billingAccountId": "9845612", + "endDate": "2020-01-30", + "startDate": "2020-01-01" + }, + "responses": { + "200": { + "body": { + "properties": { + "reportUrl": "https://storage.blob.core.windows.net/details/20200911/00000000-0000-0000-0000-000000000000?sv=2016-05-31&sr=b&sig=jep8HT2aphfUkyERRZa5LRfd9RPzjXbzB%2F9TNiQ", + "validUntil": "2020-09-12T02:56:55.5021869Z" + }, + "status": "Completed" + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/9845612/providers/Microsoft.CostManagement/reservationDetailsOperationResults/cf9f95c9-af6b-41dd-a622-e6f4fc60c3ee?api-version=2019-11-01", + "Retry-After": "60" + } + } + }, + "operationId": "GenerateReservationDetailsReport_ByBillingAccountId", + "title": "ReservationDetails" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/GenerateReservationDetailsReportByBillingProfile.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/GenerateReservationDetailsReportByBillingProfile.json new file mode 100644 index 000000000000..e79a1c7066ec --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/GenerateReservationDetailsReportByBillingProfile.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "billingAccountId": "00000000-0000-0000-0000-000000000000", + "billingProfileId": "CZSFR-SDFXC-DSDF", + "endDate": "2020-01-30", + "startDate": "2020-01-01" + }, + "responses": { + "200": { + "body": { + "properties": { + "reportUrl": "https://storage.blob.core.windows.net/details/20200911/00000000-0000-0000-0000-000000000000?sv=2016-05-31&sr=b&sig=jep8HT2aphfUkyERRZa5LRfd9RPzjXbzB%2F9TNiQ", + "validUntil": "2020-09-12T02:56:55.5021869Z" + }, + "status": "Completed" + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000/billingProfiles/CZSFR-SDFXC-DSDF/providers/Microsoft.CostManagement/reservationDetailsOperationResults/cf9f95c9-af6b-41dd-a622-e6f4fc60c3ee?api-version=2019-11-01", + "Retry-After": "60" + } + } + }, + "operationId": "GenerateReservationDetailsReport_ByBillingProfileId", + "title": "ReservationDetails" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/InvoiceSectionAlerts.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/InvoiceSectionAlerts.json new file mode 100644 index 000000000000..0afd232f3c7d --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/InvoiceSectionAlerts.json @@ -0,0 +1,102 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "billingAccountId": "12345:6789", + "billingProfileId": "13579", + "invoiceSectionId": "9876", + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876" + }, + "responses": { + "200": { + "body": { + "nextLink": null, + "value": [ + { + "name": "00000000-0000-0000-0000-000000000000", + "type": "Microsoft.CostManagement/alerts", + "id": "/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/Microsoft.CostManagement/alerts/00000000-0000-0000-0000-000000000000", + "properties": { + "description": "", + "closeTime": "0001-01-01T00:00:00", + "costEntityId": "budget1", + "creationTime": "2020-04-27T11:07:52.7143901Z", + "definition": { + "type": "Budget", + "category": "Cost", + "criteria": "CostThresholdExceeded" + }, + "modificationTime": "2020-04-28T11:06:02.8999373Z", + "source": "Preset", + "status": "Active", + "statusModificationTime": "0001-01-01T00:00:00", + "statusModificationUserName": null, + "details": { + "amount": 200000, + "contactEmails": [ + "1234@contoso.com" + ], + "contactGroups": [], + "contactRoles": [], + "currentSpend": 161000.12, + "meterFilter": [], + "operator": "GreaterThan", + "overridingAlert": null, + "periodStartDate": "2020-03-01T00:00:00Z", + "resourceFilter": [], + "resourceGroupFilter": [], + "tagFilter": {}, + "threshold": 0.8, + "timeGrainType": "Quarterly", + "triggeredBy": "00000000-0000-0000-0000-000000000000_1_01", + "unit": "USD" + } + } + }, + { + "name": "11111111-1111-1111-111111111111", + "type": "Microsoft.CostManagement/alerts", + "id": "/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/Microsoft.CostManagement/alerts/11111111-1111-1111-111111111111", + "properties": { + "description": "", + "closeTime": "0001-01-01T00:00:00", + "costEntityId": "budget1", + "creationTime": "2019-06-24T05:51:52.8713179Z", + "definition": { + "type": "Budget", + "category": "Cost", + "criteria": "CostThresholdExceeded" + }, + "modificationTime": "2019-08-31T17:51:55.1808807Z", + "source": "Preset", + "status": "Active", + "statusModificationTime": "0001-01-01T00:00:00", + "statusModificationUserName": null, + "details": { + "amount": 200000, + "contactEmails": [ + "1234@contoso.com" + ], + "contactGroups": [], + "contactRoles": [], + "currentSpend": 171000.32, + "meterFilter": [], + "operator": "GreaterThan", + "overridingAlert": null, + "periodStartDate": "2020-03-01T00:00:00Z", + "resourceFilter": [], + "resourceGroupFilter": [], + "tagFilter": {}, + "threshold": 0.8, + "timeGrainType": "Quarterly", + "triggeredBy": "11111111-1111-1111-111111111111_1_01", + "unit": "USD" + } + } + } + ] + } + } + }, + "operationId": "Alerts_List", + "title": "InvoiceSectionAlerts" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/InvoiceSectionForecast.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/InvoiceSectionForecast.json new file mode 100644 index 000000000000..d9b22b111bb2 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/InvoiceSectionForecast.json @@ -0,0 +1,124 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "billingAccountId": "12345:6789", + "billingProfileId": "13579", + "invoiceSectionId": "9876", + "parameters": { + "type": "Usage", + "dataset": { + "aggregation": { + "totalCost": { + "name": "Cost", + "function": "Sum" + } + }, + "filter": { + "and": [ + { + "or": [ + { + "dimensions": { + "name": "ResourceLocation", + "operator": "In", + "values": [ + "East US", + "West Europe" + ] + } + }, + { + "tags": { + "name": "Environment", + "operator": "In", + "values": [ + "UAT", + "Prod" + ] + } + } + ] + }, + { + "dimensions": { + "name": "ResourceGroup", + "operator": "In", + "values": [ + "API" + ] + } + } + ] + }, + "granularity": "Daily" + }, + "includeActualCost": false, + "includeFreshPartialCost": false, + "timePeriod": { + "from": "2022-08-01T00:00:00+00:00", + "to": "2022-08-31T23:59:59+00:00" + }, + "timeframe": "Custom" + }, + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876" + }, + "responses": { + "200": { + "body": { + "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "type": "Microsoft.CostManagement/query", + "id": "/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/Microsoft.CostManagement/query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "properties": { + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "UsageDate", + "type": "Number" + }, + { + "name": "CostStatus", + "type": "String" + }, + { + "name": "Currency", + "type": "String" + } + ], + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/Microsoft.CostManagement/Forecast?api-version=2019-10-01&$skiptoken=AQAAAA%3D%3D", + "rows": [ + [ + 2.10333307059661, + 20180331, + "Forecast", + "USD" + ], + [ + 218.68795741935486, + 20180331, + "Forecast", + "USD" + ], + [ + 0.14384913581657052, + 20180401, + "Forecast", + "USD" + ], + [ + 0.009865586851323632, + 20180429, + "Forecast", + "USD" + ] + ] + } + } + }, + "204": {} + }, + "operationId": "Forecast_Usage", + "title": "InvoiceSectionForecast" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/MCABillingAccountDimensionsList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/MCABillingAccountDimensionsList.json new file mode 100644 index 000000000000..120d93d89506 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/MCABillingAccountDimensionsList.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "billingAccountId": "12345:6789", + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "dimensions_ResourceGroup_2019-10-01_2019-10-31", + "type": "microsoft.CostManagement/dimensions", + "id": "/providers/Microsoft.Billing/billingAccounts/12345:6789/providers/microsoft.CostManagement/dimensions_ResourceGroup_2019-10-01_2019-10-31", + "properties": { + "description": "Resource group", + "category": "ResourceGroup", + "data": [], + "filterEnabled": true, + "groupingEnabled": true, + "total": 377, + "usageEnd": "2019-10-31T00:00:00-07:00", + "usageStart": "2019-10-01T00:00:00-07:00" + } + }, + { + "name": "dimensions_ResourceType_2019-10-01_2019-10-31", + "type": "microsoft.CostManagement/dimensions", + "id": "/providers/Microsoft.Billing/billingAccounts/12345:6789/providers/microsoft.CostManagement/dimensions_ResourceType_2019-10-01_2019-10-31", + "properties": { + "description": "Resource type", + "category": "ResourceType", + "data": [], + "filterEnabled": true, + "groupingEnabled": true, + "total": 37, + "usageEnd": "2019-10-31T00:00:00-07:00", + "usageStart": "2019-10-01T00:00:00-07:00" + } + } + ] + } + }, + "204": {} + }, + "operationId": "Dimensions_List", + "title": "BillingAccountDimensionsList-MCA" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/MCABillingAccountDimensionsListExpandAndTop.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/MCABillingAccountDimensionsListExpandAndTop.json new file mode 100644 index 000000000000..627dcfb2e214 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/MCABillingAccountDimensionsListExpandAndTop.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "$expand": "properties/data", + "$top": 5, + "api-version": "2025-03-01", + "billingAccountId": "12345:6789", + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "dimensions_ResourceGroup_2019-10-01_2019-10-31", + "type": "microsoft.CostManagement/dimensions", + "id": "/providers/Microsoft.Billing/billingAccounts/12345:6789/providers/microsoft.CostManagement/dimensions_ResourceGroup_2019-10-01_2019-10-31", + "properties": { + "description": "Resource group", + "category": "ResourceGroup", + "data": [ + "thoroetrg01", + "default-notificationhubs-westus", + "jedikeyvaultrg", + "contosocodeflow8d4a", + "noobaa" + ], + "filterEnabled": true, + "groupingEnabled": true, + "total": 377, + "usageEnd": "2019-10-31T00:00:00-07:00", + "usageStart": "2019-10-01T00:00:00-07:00" + } + }, + { + "name": "dimensions_ResourceType_2019-10-01_2019-10-31", + "type": "microsoft.CostManagement/dimensions", + "id": "/providers/Microsoft.Billing/billingAccounts/12345:6789/providers/microsoft.CostManagement/dimensions_ResourceType_2019-10-01_2019-10-31", + "properties": { + "description": "Resource type", + "category": "ResourceType", + "data": [ + "microsoft.automation/automationaccounts", + "microsoft.databricks/workspaces", + "microsoft.dbformysql/servers", + "microsoft.containerregistry/registries", + "microsoft.search/searchservices" + ], + "filterEnabled": true, + "groupingEnabled": true, + "total": 37, + "usageEnd": "2019-10-31T00:00:00-07:00", + "usageStart": "2019-10-01T00:00:00-07:00" + } + } + ] + } + }, + "204": {} + }, + "operationId": "Dimensions_List", + "title": "BillingAccountDimensionsListExpandAndTop-MCA" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/MCABillingAccountDimensionsListWithFilter.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/MCABillingAccountDimensionsListWithFilter.json new file mode 100644 index 000000000000..537fa5d9b565 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/MCABillingAccountDimensionsListWithFilter.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "$expand": "properties/data", + "$filter": "properties/category eq 'resourceId'", + "$top": 5, + "api-version": "2025-03-01", + "billingAccountId": "12345:6789", + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "dimensions_ResourceId_2019-10-01_2019-10-31", + "type": "microsoft.CostManagement/dimensions", + "id": "/providers/Microsoft.Billing/billingAccounts/12345:6789/providers/microsoft.CostManagement/dimensions_ResourceId_2019-10-01_2019-10-31", + "properties": { + "description": "Resource Id", + "category": "ResourceId", + "data": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/system.orlando/providers/microsoft.storage/storageaccounts/urphealthaccount", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/system.orlando/providers/microsoft.storage/storageaccounts/srphytenaccount", + "/subscriptions/67e24f6b-1ec2-4c90-993a-dc2d25b00b6c/resourcegroups/defaultresourcegroup-eus/providers/microsoft.operationalinsights/workspaces/defaultworkspace-67e24f6b-1ec2-4c90-993a-dc2d25b00b6c-eus", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg-sql-ha/providers/microsoft.compute/virtualmachines/sql-4qqp1", + "/subscriptions/a98d6dc5-eb8f-46cf-8938-f1fb08f03706/resourcegroups/databricks-rg-testwsp-xijmsdubneexm/providers/microsoft.compute/disks/488cdb42bf74474a98075415be3f806c-containerrootvolume" + ], + "filterEnabled": true, + "groupingEnabled": true, + "nextLink": "http://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/providers/Microsoft.CostManagement/Dimensions?$filter=properties/category eq 'resourceId'&$top=5&api-version=2019-10-01&$expand=properties/data&$skiptoken=AQAAAA%3D%3D", + "total": 1409, + "usageEnd": "2019-10-31T00:00:00-07:00", + "usageStart": "2019-10-01T00:00:00-07:00" + } + } + ] + } + }, + "204": {} + }, + "operationId": "Dimensions_List", + "title": "BillingAccountDimensionsListWithFilter-MCA" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/MCABillingAccountQuery.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/MCABillingAccountQuery.json new file mode 100644 index 000000000000..fe392f70d889 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/MCABillingAccountQuery.json @@ -0,0 +1,110 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "billingAccountId": "12345:6789", + "parameters": { + "type": "Usage", + "dataset": { + "filter": { + "and": [ + { + "or": [ + { + "dimensions": { + "name": "ResourceLocation", + "operator": "In", + "values": [ + "East US", + "West Europe" + ] + } + }, + { + "tags": { + "name": "Environment", + "operator": "In", + "values": [ + "UAT", + "Prod" + ] + } + } + ] + }, + { + "dimensions": { + "name": "ResourceGroup", + "operator": "In", + "values": [ + "API" + ] + } + } + ] + }, + "granularity": "Daily" + }, + "timeframe": "MonthToDate" + }, + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789" + }, + "responses": { + "200": { + "body": { + "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "type": "microsoft.costmanagement/Query", + "id": "/providers/Microsoft.Billing/billingAccounts/12345:6789/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "properties": { + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "ResourceGroup", + "type": "String" + }, + { + "name": "UsageDate", + "type": "Number" + }, + { + "name": "Currency", + "type": "String" + } + ], + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", + "rows": [ + [ + 19.545363672276512, + "JapanUnifia-Trial", + 20180331, + "USD" + ], + [ + 173.41979241290323, + "RVIIOT-TRIAL", + 20180331, + "USD" + ], + [ + 20.35941656262545, + "VSTSHOL-1595322048000", + 20180331, + "USD" + ], + [ + 0.16677720329728665, + "gs-stms-dev", + 20180331, + "USD" + ] + ] + } + } + }, + "204": {} + }, + "operationId": "Query_Usage", + "title": "BillingAccountQuery-MCA" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/MCABillingAccountQueryGrouping.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/MCABillingAccountQueryGrouping.json new file mode 100644 index 000000000000..398f03d4ac81 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/MCABillingAccountQueryGrouping.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "billingAccountId": "12345:6789", + "parameters": { + "type": "Usage", + "dataset": { + "aggregation": { + "totalCost": { + "name": "PreTaxCost", + "function": "Sum" + } + }, + "granularity": "None", + "grouping": [ + { + "name": "ResourceGroup", + "type": "Dimension" + } + ] + }, + "timeframe": "TheLastMonth" + }, + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789" + }, + "responses": { + "200": { + "body": { + "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "type": "microsoft.costmanagement/Query", + "id": "/providers/Microsoft.Billing/billingAccounts/12345:6789/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "properties": { + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "ResourceGroup", + "type": "String" + }, + { + "name": "Currency", + "type": "String" + } + ], + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", + "rows": [ + [ + 19.545363672276512, + "JapanUnifia-Trial", + "USD" + ], + [ + 173.41979241290323, + "RVIIOT-TRIAL", + "USD" + ], + [ + 20.35941656262545, + "VSTSHOL-1595322048000", + "USD" + ] + ] + } + } + }, + "204": {} + }, + "operationId": "Query_Usage", + "title": "BillingAccountQueryGrouping-MCA" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/MCABillingProfileDimensionsList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/MCABillingProfileDimensionsList.json new file mode 100644 index 000000000000..79489c4dc236 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/MCABillingProfileDimensionsList.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "billingAccountId": "12345:6789", + "billingProfileId": "13579", + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "dimensions_ResourceGroup_2019-10-01_2019-10-31", + "type": "microsoft.CostManagement/dimensions", + "id": "/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/microsoft.CostManagement/dimensions_ResourceGroup_2019-10-01_2019-10-31", + "properties": { + "description": "Resource group", + "category": "ResourceGroup", + "data": [], + "filterEnabled": true, + "groupingEnabled": true, + "total": 377, + "usageEnd": "2019-10-31T00:00:00-07:00", + "usageStart": "2019-10-01T00:00:00-07:00" + } + }, + { + "name": "dimensions_ResourceType_2019-10-01_2019-10-31", + "type": "microsoft.CostManagement/dimensions", + "id": "/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/microsoft.CostManagement/dimensions_ResourceType_2019-10-01_2019-10-31", + "properties": { + "description": "Resource type", + "category": "ResourceType", + "data": [], + "filterEnabled": true, + "groupingEnabled": true, + "total": 37, + "usageEnd": "2019-10-31T00:00:00-07:00", + "usageStart": "2019-10-01T00:00:00-07:00" + } + } + ] + } + }, + "204": {} + }, + "operationId": "Dimensions_List", + "title": "BillingProfileDimensionsList-MCA" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/MCABillingProfileDimensionsListExpandAndTop.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/MCABillingProfileDimensionsListExpandAndTop.json new file mode 100644 index 000000000000..e1057e5c1b32 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/MCABillingProfileDimensionsListExpandAndTop.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "$expand": "properties/data", + "$top": 5, + "api-version": "2025-03-01", + "billingAccountId": "12345:6789", + "billingProfileId": "13579", + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "dimensions_ResourceGroup_2019-10-01_2019-10-31", + "type": "microsoft.CostManagement/dimensions", + "id": "/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/microsoft.CostManagement/dimensions_ResourceGroup_2019-10-01_2019-10-31", + "properties": { + "description": "Resource group", + "category": "ResourceGroup", + "data": [ + "thoroetrg01", + "default-notificationhubs-westus", + "jedikeyvaultrg", + "contosocodeflow8d4a", + "noobaa" + ], + "filterEnabled": true, + "groupingEnabled": true, + "total": 377, + "usageEnd": "2019-10-31T00:00:00-07:00", + "usageStart": "2019-10-01T00:00:00-07:00" + } + }, + { + "name": "dimensions_ResourceType_2019-10-01_2019-10-31", + "type": "microsoft.CostManagement/dimensions", + "id": "/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/microsoft.CostManagement/dimensions_ResourceType_2019-10-01_2019-10-31", + "properties": { + "description": "Resource type", + "category": "ResourceType", + "data": [ + "microsoft.automation/automationaccounts", + "microsoft.databricks/workspaces", + "microsoft.dbformysql/servers", + "microsoft.containerregistry/registries", + "microsoft.search/searchservices" + ], + "filterEnabled": true, + "groupingEnabled": true, + "total": 37, + "usageEnd": "2019-10-31T00:00:00-07:00", + "usageStart": "2019-10-01T00:00:00-07:00" + } + } + ] + } + }, + "204": {} + }, + "operationId": "Dimensions_List", + "title": "BillingProfileDimensionsListExpandAndTop-MCA" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/MCABillingProfileDimensionsListWithFilter.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/MCABillingProfileDimensionsListWithFilter.json new file mode 100644 index 000000000000..1c33525244e7 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/MCABillingProfileDimensionsListWithFilter.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "$expand": "properties/data", + "$filter": "properties/category eq 'resourceId'", + "$top": 5, + "api-version": "2025-03-01", + "billingAccountId": "12345:6789", + "billingProfileId": "13579", + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "dimensions_ResourceId_2019-10-01_2019-10-31", + "type": "microsoft.CostManagement/dimensions", + "id": "/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/microsoft.CostManagement/dimensions_ResourceId_2019-10-01_2019-10-31", + "properties": { + "description": "Resource Id", + "category": "ResourceId", + "data": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/system.orlando/providers/microsoft.storage/storageaccounts/urphealthaccount", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/system.orlando/providers/microsoft.storage/storageaccounts/srphytenaccount", + "/subscriptions/67e24f6b-1ec2-4c90-993a-dc2d25b00b6c/resourcegroups/defaultresourcegroup-eus/providers/microsoft.operationalinsights/workspaces/defaultworkspace-67e24f6b-1ec2-4c90-993a-dc2d25b00b6c-eus", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg-sql-ha/providers/microsoft.compute/virtualmachines/sql-4qqp1", + "/subscriptions/a98d6dc5-eb8f-46cf-8938-f1fb08f03706/resourcegroups/databricks-rg-testwsp-xijmsdubneexm/providers/microsoft.compute/disks/488cdb42bf74474a98075415be3f806c-containerrootvolume" + ], + "filterEnabled": true, + "groupingEnabled": true, + "nextLink": "http://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/Dimensions?$filter=properties/category eq 'resourceId'&$top=5&api-version=2019-10-01&$expand=properties/data&$skiptoken=AQAAAA%3D%3D", + "total": 1409, + "usageEnd": "2019-10-31T00:00:00-07:00", + "usageStart": "2019-10-01T00:00:00-07:00" + } + } + ] + } + }, + "204": {} + }, + "operationId": "Dimensions_List", + "title": "BillingProfileDimensionsListWithFilter-MCA" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/MCABillingProfileQuery.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/MCABillingProfileQuery.json new file mode 100644 index 000000000000..06b65795172a --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/MCABillingProfileQuery.json @@ -0,0 +1,111 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "billingAccountId": "12345:6789", + "billingProfileId": "13579", + "parameters": { + "type": "Usage", + "dataset": { + "filter": { + "and": [ + { + "or": [ + { + "dimensions": { + "name": "ResourceLocation", + "operator": "In", + "values": [ + "East US", + "West Europe" + ] + } + }, + { + "tags": { + "name": "Environment", + "operator": "In", + "values": [ + "UAT", + "Prod" + ] + } + } + ] + }, + { + "dimensions": { + "name": "ResourceGroup", + "operator": "In", + "values": [ + "API" + ] + } + } + ] + }, + "granularity": "Daily" + }, + "timeframe": "MonthToDate" + }, + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579" + }, + "responses": { + "200": { + "body": { + "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "type": "microsoft.costmanagement/Query", + "id": "/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "properties": { + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "ResourceGroup", + "type": "String" + }, + { + "name": "UsageDate", + "type": "Number" + }, + { + "name": "Currency", + "type": "String" + } + ], + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", + "rows": [ + [ + 19.545363672276512, + "JapanUnifia-Trial", + 20180331, + "USD" + ], + [ + 173.41979241290323, + "RVIIOT-TRIAL", + 20180331, + "USD" + ], + [ + 20.35941656262545, + "VSTSHOL-1595322048000", + 20180331, + "USD" + ], + [ + 0.16677720329728665, + "gs-stms-dev", + 20180331, + "USD" + ] + ] + } + } + }, + "204": {} + }, + "operationId": "Query_Usage", + "title": "BillingProfileQuery-MCA" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/MCABillingProfileQueryGrouping.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/MCABillingProfileQueryGrouping.json new file mode 100644 index 000000000000..f8665fcb799b --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/MCABillingProfileQueryGrouping.json @@ -0,0 +1,73 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "billingAccountId": "12345:6789", + "billingProfileId": "13579", + "parameters": { + "type": "Usage", + "dataset": { + "aggregation": { + "totalCost": { + "name": "PreTaxCost", + "function": "Sum" + } + }, + "granularity": "None", + "grouping": [ + { + "name": "ResourceGroup", + "type": "Dimension" + } + ] + }, + "timeframe": "TheLastMonth" + }, + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579" + }, + "responses": { + "200": { + "body": { + "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "type": "microsoft.costmanagement/Query", + "id": "/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "properties": { + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "ResourceGroup", + "type": "String" + }, + { + "name": "Currency", + "type": "String" + } + ], + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", + "rows": [ + [ + 19.545363672276512, + "JapanUnifia-Trial", + "USD" + ], + [ + 173.41979241290323, + "RVIIOT-TRIAL", + "USD" + ], + [ + 20.35941656262545, + "VSTSHOL-1595322048000", + "USD" + ] + ] + } + } + }, + "204": {} + }, + "operationId": "Query_Usage", + "title": "BillingProfileQueryGrouping-MCA" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/MCACustomerDimensionsList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/MCACustomerDimensionsList.json new file mode 100644 index 000000000000..fcec34a4b793 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/MCACustomerDimensionsList.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "billingAccountId": "12345:6789", + "customerId": "5678", + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "dimensions_ResourceGroup_2019-10-01_2019-10-31", + "type": "microsoft.CostManagement/dimensions", + "id": "/providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678/providers/microsoft.CostManagement/dimensions_ResourceGroup_2019-10-01_2019-10-31", + "properties": { + "description": "Resource group", + "category": "ResourceGroup", + "data": [], + "filterEnabled": true, + "groupingEnabled": true, + "total": 377, + "usageEnd": "2019-10-31T00:00:00-07:00", + "usageStart": "2019-10-01T00:00:00-07:00" + } + }, + { + "name": "dimensions_ResourceType_2019-10-01_2019-10-31", + "type": "microsoft.CostManagement/dimensions", + "id": "/providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678/providers/microsoft.CostManagement/dimensions_ResourceType_2019-10-01_2019-10-31", + "properties": { + "description": "Resource type", + "category": "ResourceType", + "data": [], + "filterEnabled": true, + "groupingEnabled": true, + "total": 37, + "usageEnd": "2019-10-31T00:00:00-07:00", + "usageStart": "2019-10-01T00:00:00-07:00" + } + } + ] + } + }, + "204": {} + }, + "operationId": "Dimensions_List", + "title": "CustomerDimensionsList-MCA" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/MCACustomerDimensionsListExpandAndTop.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/MCACustomerDimensionsListExpandAndTop.json new file mode 100644 index 000000000000..49c24b189f62 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/MCACustomerDimensionsListExpandAndTop.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "$expand": "properties/data", + "$top": 5, + "api-version": "2025-03-01", + "billingAccountId": "12345:6789", + "customerId": "5678", + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "dimensions_ResourceGroup_2019-10-01_2019-10-31", + "type": "microsoft.CostManagement/dimensions", + "id": "/providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678/providers/microsoft.CostManagement/dimensions_ResourceGroup_2019-10-01_2019-10-31", + "properties": { + "description": "Resource group", + "category": "ResourceGroup", + "data": [ + "thoroetrg01", + "default-notificationhubs-westus", + "jedikeyvaultrg", + "contosocodeflow8d4a", + "noobaa" + ], + "filterEnabled": true, + "groupingEnabled": true, + "total": 377, + "usageEnd": "2019-10-31T00:00:00-07:00", + "usageStart": "2019-10-01T00:00:00-07:00" + } + }, + { + "name": "dimensions_ResourceType_2019-10-01_2019-10-31", + "type": "microsoft.CostManagement/dimensions", + "id": "/providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678/providers/microsoft.CostManagement/dimensions_ResourceType_2019-10-01_2019-10-31", + "properties": { + "description": "Resource type", + "category": "ResourceType", + "data": [ + "microsoft.automation/automationaccounts", + "microsoft.databricks/workspaces", + "microsoft.dbformysql/servers", + "microsoft.containerregistry/registries", + "microsoft.search/searchservices" + ], + "filterEnabled": true, + "groupingEnabled": true, + "total": 37, + "usageEnd": "2019-10-31T00:00:00-07:00", + "usageStart": "2019-10-01T00:00:00-07:00" + } + } + ] + } + }, + "204": {} + }, + "operationId": "Dimensions_List", + "title": "CustomerDimensionsListExpandAndTop-MCA" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/MCACustomerDimensionsListWithFilter.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/MCACustomerDimensionsListWithFilter.json new file mode 100644 index 000000000000..0f8a72cc4bf5 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/MCACustomerDimensionsListWithFilter.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "$expand": "properties/data", + "$filter": "properties/category eq 'resourceId'", + "$top": 5, + "api-version": "2025-03-01", + "billingAccountId": "12345:6789", + "customerId": "13579", + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "dimensions_ResourceId_2019-10-01_2019-10-31", + "type": "microsoft.CostManagement/dimensions", + "id": "/providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678/providers/microsoft.CostManagement/dimensions_ResourceId_2019-10-01_2019-10-31", + "properties": { + "description": "Resource Id", + "category": "ResourceId", + "data": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/system.orlando/providers/microsoft.storage/storageaccounts/urphealthaccount", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/system.orlando/providers/microsoft.storage/storageaccounts/srphytenaccount", + "/subscriptions/67e24f6b-1ec2-4c90-993a-dc2d25b00b6c/resourcegroups/defaultresourcegroup-eus/providers/microsoft.operationalinsights/workspaces/defaultworkspace-67e24f6b-1ec2-4c90-993a-dc2d25b00b6c-eus", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg-sql-ha/providers/microsoft.compute/virtualmachines/sql-4qqp1", + "/subscriptions/a98d6dc5-eb8f-46cf-8938-f1fb08f03706/resourcegroups/databricks-rg-testwsp-xijmsdubneexm/providers/microsoft.compute/disks/488cdb42bf74474a98075415be3f806c-containerrootvolume" + ], + "filterEnabled": true, + "groupingEnabled": true, + "nextLink": "http://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678/providers/Microsoft.CostManagement/Dimensions?$filter=properties/category eq 'resourceId'&$top=5&api-version=2019-10-01&$expand=properties/data&$skiptoken=AQAAAA%3D%3D", + "total": 1409, + "usageEnd": "2019-10-31T00:00:00-07:00", + "usageStart": "2019-10-01T00:00:00-07:00" + } + } + ] + } + }, + "204": {} + }, + "operationId": "Dimensions_List", + "title": "CustomerDimensionsListWithFilter-MCA" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/MCACustomerQuery.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/MCACustomerQuery.json new file mode 100644 index 000000000000..8c41f16f4073 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/MCACustomerQuery.json @@ -0,0 +1,111 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "billingAccountId": "12345:6789", + "customerId": "5678", + "parameters": { + "type": "Usage", + "dataset": { + "filter": { + "and": [ + { + "or": [ + { + "dimensions": { + "name": "ResourceLocation", + "operator": "In", + "values": [ + "East US", + "West Europe" + ] + } + }, + { + "tags": { + "name": "Environment", + "operator": "In", + "values": [ + "UAT", + "Prod" + ] + } + } + ] + }, + { + "dimensions": { + "name": "ResourceGroup", + "operator": "In", + "values": [ + "API" + ] + } + } + ] + }, + "granularity": "Daily" + }, + "timeframe": "MonthToDate" + }, + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678" + }, + "responses": { + "200": { + "body": { + "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "type": "microsoft.costmanagement/Query", + "id": "/providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "properties": { + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "ResourceGroup", + "type": "String" + }, + { + "name": "UsageDate", + "type": "Number" + }, + { + "name": "Currency", + "type": "String" + } + ], + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", + "rows": [ + [ + 19.545363672276512, + "JapanUnifia-Trial", + 20180331, + "USD" + ], + [ + 173.41979241290323, + "RVIIOT-TRIAL", + 20180331, + "USD" + ], + [ + 20.35941656262545, + "VSTSHOL-1595322048000", + 20180331, + "USD" + ], + [ + 0.16677720329728665, + "gs-stms-dev", + 20180331, + "USD" + ] + ] + } + } + }, + "204": {} + }, + "operationId": "Query_Usage", + "title": "CustomerQuery-MCA" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/MCACustomerQueryGrouping.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/MCACustomerQueryGrouping.json new file mode 100644 index 000000000000..323958965b5a --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/MCACustomerQueryGrouping.json @@ -0,0 +1,73 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "billingAccountId": "12345:6789", + "customerId": "5678", + "parameters": { + "type": "Usage", + "dataset": { + "aggregation": { + "totalCost": { + "name": "PreTaxCost", + "function": "Sum" + } + }, + "granularity": "None", + "grouping": [ + { + "name": "ResourceGroup", + "type": "Dimension" + } + ] + }, + "timeframe": "TheLastMonth" + }, + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678" + }, + "responses": { + "200": { + "body": { + "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "type": "microsoft.costmanagement/Query", + "id": "/providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "properties": { + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "ResourceGroup", + "type": "String" + }, + { + "name": "Currency", + "type": "String" + } + ], + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", + "rows": [ + [ + 19.545363672276512, + "JapanUnifia-Trial", + "USD" + ], + [ + 173.41979241290323, + "RVIIOT-TRIAL", + "USD" + ], + [ + 20.35941656262545, + "VSTSHOL-1595322048000", + "USD" + ] + ] + } + } + }, + "204": {} + }, + "operationId": "Query_Usage", + "title": "CustomerQueryGrouping-MCA" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/MCAInvoiceSectionDimensionsList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/MCAInvoiceSectionDimensionsList.json new file mode 100644 index 000000000000..3c8a901cc668 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/MCAInvoiceSectionDimensionsList.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "billingAccountId": "12345:6789", + "billingProfileId": "13579", + "invoiceSectionId": "9876", + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "dimensions_ResourceGroup_2019-10-01_2019-10-31", + "type": "microsoft.CostManagement/dimensions", + "id": "/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/microsoft.CostManagement/dimensions_ResourceGroup_2019-10-01_2019-10-31", + "properties": { + "description": "Resource group", + "category": "ResourceGroup", + "data": [], + "filterEnabled": true, + "groupingEnabled": true, + "total": 377, + "usageEnd": "2019-10-31T00:00:00-07:00", + "usageStart": "2019-10-01T00:00:00-07:00" + } + }, + { + "name": "dimensions_ResourceType_2019-10-01_2019-10-31", + "type": "microsoft.CostManagement/dimensions", + "id": "/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/microsoft.CostManagement/dimensions_ResourceType_2019-10-01_2019-10-31", + "properties": { + "description": "Resource type", + "category": "ResourceType", + "data": [], + "filterEnabled": true, + "groupingEnabled": true, + "total": 37, + "usageEnd": "2019-10-31T00:00:00-07:00", + "usageStart": "2019-10-01T00:00:00-07:00" + } + } + ] + } + }, + "204": {} + }, + "operationId": "Dimensions_List", + "title": "InvoiceSectionDimensionsList-MCA" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/MCAInvoiceSectionDimensionsListExpandAndTop.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/MCAInvoiceSectionDimensionsListExpandAndTop.json new file mode 100644 index 000000000000..5211f494b0e8 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/MCAInvoiceSectionDimensionsListExpandAndTop.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "$expand": "properties/data", + "$top": 5, + "api-version": "2025-03-01", + "billingAccountId": "12345:6789", + "billingProfileId": "13579", + "invoiceSectionId": "9876", + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "dimensions_ResourceGroup_2019-10-01_2019-10-31", + "type": "microsoft.CostManagement/dimensions", + "id": "/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/microsoft.CostManagement/dimensions_ResourceGroup_2019-10-01_2019-10-31", + "properties": { + "description": "Resource group", + "category": "ResourceGroup", + "data": [ + "thoroetrg01", + "default-notificationhubs-westus", + "jedikeyvaultrg", + "contosocodeflow8d4a", + "noobaa" + ], + "filterEnabled": true, + "groupingEnabled": true, + "total": 377, + "usageEnd": "2019-10-31T00:00:00-07:00", + "usageStart": "2019-10-01T00:00:00-07:00" + } + }, + { + "name": "dimensions_ResourceType_2019-10-01_2019-10-31", + "type": "microsoft.CostManagement/dimensions", + "id": "/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/microsoft.CostManagement/dimensions_ResourceType_2019-10-01_2019-10-31", + "properties": { + "description": "Resource type", + "category": "ResourceType", + "data": [ + "microsoft.automation/automationaccounts", + "microsoft.databricks/workspaces", + "microsoft.dbformysql/servers", + "microsoft.containerregistry/registries", + "microsoft.search/searchservices" + ], + "filterEnabled": true, + "groupingEnabled": true, + "total": 37, + "usageEnd": "2019-10-31T00:00:00-07:00", + "usageStart": "2019-10-01T00:00:00-07:00" + } + } + ] + } + }, + "204": {} + }, + "operationId": "Dimensions_List", + "title": "InvoiceSectionDimensionsListExpandAndTop-MCA" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/MCAInvoiceSectionDimensionsListWithFilter.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/MCAInvoiceSectionDimensionsListWithFilter.json new file mode 100644 index 000000000000..b9c7e43ee039 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/MCAInvoiceSectionDimensionsListWithFilter.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "$expand": "properties/data", + "$filter": "properties/category eq 'resourceId'", + "$top": 5, + "api-version": "2025-03-01", + "billingAccountId": "12345:6789", + "billingProfileId": "13579", + "invoiceSectionId": "9876", + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "dimensions_ResourceId_2019-10-01_2019-10-31", + "type": "microsoft.CostManagement/dimensions", + "id": "/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/microsoft.CostManagement/dimensions_ResourceId_2019-10-01_2019-10-31", + "properties": { + "description": "Resource Id", + "category": "ResourceId", + "data": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/system.orlando/providers/microsoft.storage/storageaccounts/urphealthaccount", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/system.orlando/providers/microsoft.storage/storageaccounts/srphytenaccount", + "/subscriptions/67e24f6b-1ec2-4c90-993a-dc2d25b00b6c/resourcegroups/defaultresourcegroup-eus/providers/microsoft.operationalinsights/workspaces/defaultworkspace-67e24f6b-1ec2-4c90-993a-dc2d25b00b6c-eus", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg-sql-ha/providers/microsoft.compute/virtualmachines/sql-4qqp1", + "/subscriptions/a98d6dc5-eb8f-46cf-8938-f1fb08f03706/resourcegroups/databricks-rg-testwsp-xijmsdubneexm/providers/microsoft.compute/disks/488cdb42bf74474a98075415be3f806c-containerrootvolume" + ], + "filterEnabled": true, + "groupingEnabled": true, + "nextLink": "http://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/Microsoft.CostManagement/Dimensions?$filter=properties/category eq 'resourceId'&$top=5&api-version=2019-10-01&$expand=properties/data&$skiptoken=AQAAAA%3D%3D", + "total": 1409, + "usageEnd": "2019-10-31T00:00:00-07:00", + "usageStart": "2019-10-01T00:00:00-07:00" + } + } + ] + } + }, + "204": {} + }, + "operationId": "Dimensions_List", + "title": "InvoiceSectionDimensionsListWithFilter-MCA" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/MCAInvoiceSectionQuery.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/MCAInvoiceSectionQuery.json new file mode 100644 index 000000000000..bc001067ccf3 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/MCAInvoiceSectionQuery.json @@ -0,0 +1,112 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "billingAccountId": "12345:6789", + "billingProfileId": "13579", + "invoiceSectionId": "9876", + "parameters": { + "type": "Usage", + "dataset": { + "filter": { + "and": [ + { + "or": [ + { + "dimensions": { + "name": "ResourceLocation", + "operator": "In", + "values": [ + "East US", + "West Europe" + ] + } + }, + { + "tags": { + "name": "Environment", + "operator": "In", + "values": [ + "UAT", + "Prod" + ] + } + } + ] + }, + { + "dimensions": { + "name": "ResourceGroup", + "operator": "In", + "values": [ + "API" + ] + } + } + ] + }, + "granularity": "Daily" + }, + "timeframe": "MonthToDate" + }, + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876" + }, + "responses": { + "200": { + "body": { + "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "type": "microsoft.costmanagement/Query", + "id": "/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "properties": { + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "ResourceGroup", + "type": "String" + }, + { + "name": "UsageDate", + "type": "Number" + }, + { + "name": "Currency", + "type": "String" + } + ], + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", + "rows": [ + [ + 19.545363672276512, + "JapanUnifia-Trial", + 20180331, + "USD" + ], + [ + 173.41979241290323, + "RVIIOT-TRIAL", + 20180331, + "USD" + ], + [ + 20.35941656262545, + "VSTSHOL-1595322048000", + 20180331, + "USD" + ], + [ + 0.16677720329728665, + "gs-stms-dev", + 20180331, + "USD" + ] + ] + } + } + }, + "204": {} + }, + "operationId": "Query_Usage", + "title": "InvoiceSectionQuery-MCA" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/MCAInvoiceSectionQueryGrouping.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/MCAInvoiceSectionQueryGrouping.json new file mode 100644 index 000000000000..f4337cd3786e --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/MCAInvoiceSectionQueryGrouping.json @@ -0,0 +1,74 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "billingAccountId": "12345:6789", + "billingProfileId": "13579", + "invoiceSectionId": "9876", + "parameters": { + "type": "Usage", + "dataset": { + "aggregation": { + "totalCost": { + "name": "PreTaxCost", + "function": "Sum" + } + }, + "granularity": "None", + "grouping": [ + { + "name": "ResourceGroup", + "type": "Dimension" + } + ] + }, + "timeframe": "TheLastMonth" + }, + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876" + }, + "responses": { + "200": { + "body": { + "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "type": "microsoft.costmanagement/Query", + "id": "/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "properties": { + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "ResourceGroup", + "type": "String" + }, + { + "name": "Currency", + "type": "String" + } + ], + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", + "rows": [ + [ + 19.545363672276512, + "JapanUnifia-Trial", + "USD" + ], + [ + 173.41979241290323, + "RVIIOT-TRIAL", + "USD" + ], + [ + 20.35941656262545, + "VSTSHOL-1595322048000", + "USD" + ] + ] + } + } + }, + "204": {} + }, + "operationId": "Query_Usage", + "title": "InvoiceSectionQueryGrouping-MCA" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ManagementGroupDimensionsList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ManagementGroupDimensionsList.json new file mode 100644 index 000000000000..a939f3e82006 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ManagementGroupDimensionsList.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "managementGroupId": "MyMgId", + "scope": "providers/Microsoft.Management/managementGroups/MyMgId" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "dimensions_ResourceGroup_2018-05-01_2018-05-31", + "type": "microsoft.CostManagement/dimensions", + "id": "/providers/Microsoft.Management/managementGroups/MyMgId/providers/microsoft.CostManagement/dimensions_ResourceGroup_2018-05-01_2018-05-31", + "properties": { + "description": "Resource group", + "category": "ResourceGroup", + "data": [], + "filterEnabled": true, + "groupingEnabled": true, + "total": 377, + "usageEnd": "2018-05-31T00:00:00-07:00", + "usageStart": "2018-05-01T00:00:00-07:00" + } + }, + { + "name": "dimensions_ResourceType_2018-05-01_2018-05-31", + "type": "microsoft.CostManagement/dimensions", + "id": "/providers/Microsoft.Management/managementGroups/MyMgId/providers/microsoft.CostManagement/dimensions_ResourceType_2018-05-01_2018-05-31", + "properties": { + "description": "Resource type", + "category": "ResourceType", + "data": [], + "filterEnabled": true, + "groupingEnabled": true, + "total": 37, + "usageEnd": "2018-05-31T00:00:00-07:00", + "usageStart": "2018-05-01T00:00:00-07:00" + } + } + ] + } + }, + "204": {} + }, + "operationId": "Dimensions_List", + "title": "ManagementGroupDimensionsList-Legacy" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ManagementGroupDimensionsListExpandAndTop.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ManagementGroupDimensionsListExpandAndTop.json new file mode 100644 index 000000000000..4f9edc2c24e0 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ManagementGroupDimensionsListExpandAndTop.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "$expand": "properties/data", + "$top": 5, + "api-version": "2025-03-01", + "managementGroupId": "MyMgId", + "scope": "providers/Microsoft.Management/managementGroups/MyMgId" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "dimensions_ResourceGroup_2018-05-01_2018-05-31_5", + "type": "microsoft.CostManagement/dimensions", + "id": "/providers/Microsoft.Management/managementGroups/MyMgId/providers/microsoft.CostManagement/dimensions_ResourceGroup_2018-05-01_2018-05-31_5", + "properties": { + "description": "Resource group", + "category": "ResourceGroup", + "data": [ + "thoroetrg01", + "default-notificationhubs-westus", + "jedikeyvaultrg", + "contosocodeflow8d4a", + "noobaa" + ], + "filterEnabled": true, + "groupingEnabled": true, + "total": 377, + "usageEnd": "2018-05-31T00:00:00-07:00", + "usageStart": "2018-05-01T00:00:00-07:00" + } + }, + { + "name": "dimensions_ResourceType_2018-05-01_2018-05-31_5", + "type": "microsoft.CostManagement/dimensions", + "id": "/providers/Microsoft.Management/managementGroups/MyMgId/providers/microsoft.CostManagement/dimensions_ResourceType_2018-05-01_2018-05-31_5", + "properties": { + "description": "Resource type", + "category": "ResourceType", + "data": [ + "microsoft.automation/automationaccounts", + "microsoft.databricks/workspaces", + "microsoft.dbformysql/servers", + "microsoft.containerregistry/registries", + "microsoft.search/searchservices" + ], + "filterEnabled": true, + "groupingEnabled": true, + "total": 37, + "usageEnd": "2018-05-31T00:00:00-07:00", + "usageStart": "2018-05-01T00:00:00-07:00" + } + } + ] + } + }, + "204": {} + }, + "operationId": "Dimensions_List", + "title": "ManagementGroupDimensionsListExpandAndTop-Legacy" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ManagementGroupDimensionsListWithFilter.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ManagementGroupDimensionsListWithFilter.json new file mode 100644 index 000000000000..922052bfdd30 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ManagementGroupDimensionsListWithFilter.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "$expand": "properties/data", + "$filter": "properties/category eq 'resourceId'", + "$top": 5, + "api-version": "2025-03-01", + "managementGroupId": "MyMgId", + "scope": "providers/Microsoft.Management/managementGroups/MyMgId" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "dimensions_ResourceId_2018-05-01_2018-05-31_5", + "type": "microsoft.CostManagement/dimensions", + "id": "/providers/Microsoft.Management/managementGroups/MyMgId/providers/microsoft.CostManagement/dimensions_ResourceId_2018-05-01_2018-05-31_5", + "properties": { + "description": "Resource Id", + "category": "ResourceId", + "data": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/system.orlando/providers/microsoft.storage/storageaccounts/urphealthaccount", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/system.orlando/providers/microsoft.storage/storageaccounts/srphytenaccount", + "/subscriptions/67e24f6b-1ec2-4c90-993a-dc2d25b00b6c/resourcegroups/defaultresourcegroup-eus/providers/microsoft.operationalinsights/workspaces/defaultworkspace-67e24f6b-1ec2-4c90-993a-dc2d25b00b6c-eus", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg-sql-ha/providers/microsoft.compute/virtualmachines/sql-4qqp1", + "/subscriptions/a98d6dc5-eb8f-46cf-8938-f1fb08f03706/resourcegroups/databricks-rg-testwsp-xijmsdubneexm/providers/microsoft.compute/disks/488cdb42bf74474a98075415be3f806c-containerrootvolume" + ], + "filterEnabled": true, + "groupingEnabled": true, + "nextLink": "http://management.azure.com/providers/Microsoft.Management/managementGroups/MyMgId/providers/Microsoft.CostManagement/Dimensions?$filter=properties/category eq 'resourceId'&$top=5&api-version=2019-10-01&$expand=properties/data&$skiptoken=AQAAAA%3D%3D", + "total": 1409, + "usageEnd": "2018-05-31T00:00:00-07:00", + "usageStart": "2018-05-01T00:00:00-07:00" + } + } + ] + } + }, + "204": {} + }, + "operationId": "Dimensions_List", + "title": "ManagementGroupDimensionsListWithFilter-Legacy" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ManagementGroupQuery.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ManagementGroupQuery.json new file mode 100644 index 000000000000..47b38a83c8da --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ManagementGroupQuery.json @@ -0,0 +1,110 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "managementGroupId": "MyMgId", + "parameters": { + "type": "Usage", + "dataset": { + "filter": { + "and": [ + { + "or": [ + { + "dimensions": { + "name": "ResourceLocation", + "operator": "In", + "values": [ + "East US", + "West Europe" + ] + } + }, + { + "tags": { + "name": "Environment", + "operator": "In", + "values": [ + "UAT", + "Prod" + ] + } + } + ] + }, + { + "dimensions": { + "name": "ResourceGroup", + "operator": "In", + "values": [ + "API" + ] + } + } + ] + }, + "granularity": "Daily" + }, + "timeframe": "MonthToDate" + }, + "scope": "providers/Microsoft.Management/managementGroups/MyMgId" + }, + "responses": { + "200": { + "body": { + "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "type": "microsoft.costmanagement/Query", + "id": "/providers/Microsoft.Management/managementGroups/MyMgId/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "properties": { + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "ResourceGroup", + "type": "String" + }, + { + "name": "UsageDate", + "type": "Number" + }, + { + "name": "Currency", + "type": "String" + } + ], + "nextLink": "https://management.azure.com/providers/Microsoft.Management/managementGroups/MyMgId/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", + "rows": [ + [ + 19.545363672276512, + "JapanUnifia-Trial", + 20180331, + "USD" + ], + [ + 173.41979241290323, + "RVIIOT-TRIAL", + 20180331, + "USD" + ], + [ + 20.35941656262545, + "VSTSHOL-1595322048000", + 20180331, + "USD" + ], + [ + 0.16677720329728665, + "gs-stms-dev", + 20180331, + "USD" + ] + ] + } + } + }, + "204": {} + }, + "operationId": "Query_Usage", + "title": "ManagementGroupQuery-Legacy" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ManagementGroupQueryGrouping.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ManagementGroupQueryGrouping.json new file mode 100644 index 000000000000..900ed7fc8094 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ManagementGroupQueryGrouping.json @@ -0,0 +1,79 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "managementGroupId": "MyMgId", + "parameters": { + "type": "Usage", + "dataset": { + "aggregation": { + "totalCost": { + "name": "PreTaxCost", + "function": "Sum" + } + }, + "granularity": "None", + "grouping": [ + { + "name": "ResourceGroup", + "type": "Dimension" + } + ] + }, + "timeframe": "TheLastMonth" + }, + "scope": "providers/Microsoft.Management/managementGroups/MyMgId" + }, + "responses": { + "200": { + "body": { + "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "type": "microsoft.costmanagement/Query", + "id": "/providers/Microsoft.Management/managementGroups/MyMgId/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "properties": { + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "ResourceGroup", + "type": "String" + }, + { + "name": "UsageDate", + "type": "Number" + }, + { + "name": "Currency", + "type": "String" + } + ], + "nextLink": "https://management.azure.com/providers/Microsoft.Management/managementGroups/MyMgId/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", + "rows": [ + [ + 20.35941656262545, + "VSTSHOL-1595322048000", + 20180331, + "USD" + ], + [ + 173.41979241290323, + "RVIIOT-TRIAL", + 20180331, + "USD" + ], + [ + 19.545363672276512, + "JapanUnifia-Trial", + 20180331, + "USD" + ] + ] + } + } + }, + "204": {} + }, + "operationId": "Query_Usage", + "title": "ManagementGroupQueryGrouping-Legacy" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/OperationList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/OperationList.json new file mode 100644 index 000000000000..9f1222c1074a --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/OperationList.json @@ -0,0 +1,115 @@ +{ + "parameters": { + "api-version": "2025-03-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.CostManagement/budgets/read", + "display": { + "description": "List the budgets by a subscription or a management group.", + "operation": "List budgets", + "provider": "Microsoft.CostManagement", + "resource": "Budgets" + }, + "id": "Microsoft.CostManagement/budgets/read" + }, + { + "name": "Microsoft.CostManagement/query/action", + "display": { + "description": "Query usage data by a scope.", + "operation": "Query usage data", + "provider": "Microsoft.CostManagement", + "resource": "Query" + }, + "id": "Microsoft.CostManagement/query/action" + }, + { + "name": "Microsoft.CostManagement/exports/read", + "display": { + "description": "List the exports by scope.", + "operation": "List exports", + "provider": "Microsoft.CostManagement", + "resource": "Exports" + }, + "id": "Microsoft.CostManagement/exports/read" + }, + { + "name": "Microsoft.CostManagement/exports/write", + "display": { + "description": "Create or update the specified export.", + "operation": "Create and update export", + "provider": "Microsoft.CostManagement", + "resource": "Exports" + }, + "id": "Microsoft.CostManagement/exports/write" + }, + { + "name": "Microsoft.CostManagement/exports/action", + "display": { + "description": "Run the specified export.", + "operation": "Run export", + "provider": "Microsoft.CostManagement", + "resource": "Exports" + }, + "id": "Microsoft.CostManagement/exports/action" + }, + { + "name": "Microsoft.CostManagement/exports/run/action", + "display": { + "description": "Run exports.", + "operation": "Run exports", + "provider": "Microsoft.CostManagement", + "resource": "exports/run" + }, + "id": "Microsoft.CostManagement/exports/run/action" + }, + { + "name": "Microsoft.CostManagement/alerts/read", + "display": { + "description": "List alerts.", + "operation": "List Alerts", + "provider": "Microsoft.CostManagement", + "resource": "Alerts" + }, + "id": "Microsoft.CostManagement/alerts/read" + }, + { + "name": "Microsoft.CostManagement/operations/read", + "display": { + "description": "List all supported operations by Microsoft.CostManagement resource provider.", + "operation": "List supported operations", + "provider": "Microsoft.CostManagement", + "resource": "Operations" + }, + "id": "Microsoft.CostManagement/operations/read" + }, + { + "name": "Microsoft.CostManagement/views/action", + "display": { + "description": "Create view.", + "operation": "Create views", + "provider": "Microsoft.CostManagement", + "resource": "Views" + }, + "id": "Microsoft.CostManagement/views/action" + }, + { + "name": "Microsoft.CostManagement/views/write", + "display": { + "description": "Update view.", + "operation": "Update views", + "provider": "Microsoft.CostManagement", + "resource": "Views" + }, + "id": "Microsoft.CostManagement/views/write" + } + ] + } + } + }, + "operationId": "Operations_List", + "title": "OperationList" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/PricesheetDownload.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/PricesheetDownload.json new file mode 100644 index 000000000000..f5aee427e5b6 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/PricesheetDownload.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "billingAccountName": "7c05a543-80ff-571e-9f98-1063b3b53cf2:99ad03ad-2d1b-4889-a452-090ad407d25f_2019-05-31", + "billingProfileName": "2USN-TPCD-BG7-TGB", + "invoiceName": "T000940677" + }, + "responses": { + "200": { + "body": { + "downloadUrl": "https://myaccount.blob.core.windows.net/?restype=service&comp=properties&sv=2015-04-05&ss=bf&srt=s&st=2015-04-29T22%3A18%3A26Z&se=2015-04-30T02%3A23%3A26Z&sr=b&sp=rw&spr=https&sig=G%2TEST%4B", + "expiryTime": "2022-09-30T17:32:28Z" + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com:443/providers/Microsoft.Billing/billingAccounts/7c05a543-80ff-571e-9f98-1063b3b53cf2:99ad03ad-2d1b-4889-a452-090ad407d25f_2019-05-31/billingProfiles/2USN-TPCD-BG7-TGB/providers/Microsoft.CostManagement/operationResults/45000000-0000-0000-0000-000000000000?sessiontoken=0:000000&api-version=2025-03-01&OperationType=PriceSheet", + "OData-EntityId": "45000000-0000-0000-0000-000000000000", + "Retry-After": "60" + } + } + }, + "operationId": "PriceSheet_DownloadByInvoice", + "title": "PricesheetDownload" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/PricesheetDownloadByBillingProfile.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/PricesheetDownloadByBillingProfile.json new file mode 100644 index 000000000000..0a5fdc8420ea --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/PricesheetDownloadByBillingProfile.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "billingAccountName": "7c05a543-80ff-571e-9f98-1063b3b53cf2:99ad03ad-2d1b-4889-a452-090ad407d25f_2019-05-31", + "billingProfileName": "2USN-TPCD-BG7-TGB" + }, + "responses": { + "200": { + "body": { + "downloadUrl": "https://myaccount.blob.core.windows.net/?restype=service&comp=properties&sv=2015-04-05&ss=bf&srt=s&st=2015-04-29T22%3A18%3A26Z&se=2015-04-30T02%3A23%3A26Z&sr=b&sp=rw&spr=https&sig=G%2TEST%4B", + "expiryTime": "2018-07-21T17:32:28Z" + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com:443/providers/Microsoft.Billing/billingAccounts/7c05a543-80ff-571e-9f98-1063b3b53cf2:99ad03ad-2d1b-4889-a452-090ad407d25f_2019-05-31/billingProfiles/2USN-TPCD-BG7-TGB/providers/Microsoft.CostManagement/operationResults/45000000-0000-0000-0000-000000000000?sessiontoken=0:000000&api-version=2025-03-01&OperationType=PriceSheet", + "OData-EntityId": "45000000-0000-0000-0000-000000000000", + "Retry-After": "60" + } + } + }, + "operationId": "PriceSheet_DownloadByBillingProfile", + "title": "PricesheetDownloadByBillingProfile" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/PrivateView.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/PrivateView.json new file mode 100644 index 000000000000..d22e14fc41f0 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/PrivateView.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "viewName": "swaggerExample" + }, + "responses": { + "200": { + "body": { + "name": "swaggerExample", + "type": "Microsoft.CostManagement/Views", + "eTag": "\"1d4ff9fe66f1d10\"", + "id": "/providers/Microsoft.CostManagement/views/swaggerExample", + "properties": { + "accumulated": "true", + "chart": "Table", + "displayName": "swagger Example", + "kpis": [ + { + "type": "Forecast", + "enabled": true, + "id": null + }, + { + "type": "Budget", + "enabled": true, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Consumption/budgets/swaggerDemo" + } + ], + "metric": "ActualCost", + "pivots": [ + { + "name": "ServiceName", + "type": "Dimension" + }, + { + "name": "MeterCategory", + "type": "Dimension" + }, + { + "name": "swaggerTagKey", + "type": "TagKey" + } + ], + "query": { + "type": "Usage", + "dataSet": { + "aggregation": { + "totalCost": { + "name": "PreTaxCost", + "function": "Sum" + } + }, + "granularity": "Daily", + "grouping": [], + "sorting": [ + { + "name": "UsageDate", + "direction": "Ascending" + } + ] + }, + "timeframe": "MonthToDate" + }, + "scope": "" + } + } + } + }, + "operationId": "Views_Get", + "title": "PrivateView" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/PrivateViewCreateOrUpdate.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/PrivateViewCreateOrUpdate.json new file mode 100644 index 000000000000..4ceda637895e --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/PrivateViewCreateOrUpdate.json @@ -0,0 +1,187 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "parameters": { + "eTag": "\"1d4ff9fe66f1d10\"", + "properties": { + "accumulated": "true", + "chart": "Table", + "displayName": "swagger Example", + "kpis": [ + { + "type": "Forecast", + "enabled": true, + "id": null + }, + { + "type": "Budget", + "enabled": true, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Consumption/budgets/swaggerDemo" + } + ], + "metric": "ActualCost", + "pivots": [ + { + "name": "ServiceName", + "type": "Dimension" + }, + { + "name": "MeterCategory", + "type": "Dimension" + }, + { + "name": "swaggerTagKey", + "type": "TagKey" + } + ], + "query": { + "type": "Usage", + "dataSet": { + "aggregation": { + "totalCost": { + "name": "PreTaxCost", + "function": "Sum" + } + }, + "granularity": "Daily", + "grouping": [], + "sorting": [ + { + "name": "UsageDate", + "direction": "Ascending" + } + ] + }, + "timeframe": "MonthToDate" + } + } + }, + "viewName": "swaggerExample" + }, + "responses": { + "200": { + "body": { + "name": "swaggerExample", + "type": "Microsoft.CostManagement/Views", + "eTag": "\"1d4ffa5a9c2430c\"", + "id": "/providers/Microsoft.CostManagement/views/swaggerExample", + "properties": { + "accumulated": "true", + "chart": "Table", + "displayName": "swagger Example", + "kpis": [ + { + "type": "Forecast", + "enabled": true, + "id": null + }, + { + "type": "Budget", + "enabled": true, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Consumption/budgets/swaggerDemo" + } + ], + "metric": "ActualCost", + "pivots": [ + { + "name": "ServiceName", + "type": "Dimension" + }, + { + "name": "MeterCategory", + "type": "Dimension" + }, + { + "name": "swaggerTagKey", + "type": "TagKey" + } + ], + "query": { + "type": "Usage", + "dataSet": { + "aggregation": { + "totalCost": { + "name": "PreTaxCost", + "function": "Sum" + } + }, + "granularity": "Daily", + "grouping": [], + "sorting": [ + { + "name": "UsageDate", + "direction": "Ascending" + } + ] + }, + "timeframe": "MonthToDate" + }, + "scope": "" + } + } + }, + "201": { + "body": { + "name": "swaggerExample", + "type": "Microsoft.CostManagement/Views", + "eTag": "\"1d4ffa5a9c2430c\"", + "id": "/providers/Microsoft.CostManagement/views/swaggerExample", + "properties": { + "accumulated": "true", + "chart": "Table", + "displayName": "swagger Example", + "kpis": [ + { + "type": "Forecast", + "enabled": true, + "id": null + }, + { + "type": "Budget", + "enabled": true, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Consumption/budgets/swaggerDemo" + } + ], + "metric": "ActualCost", + "pivots": [ + { + "name": "ServiceName", + "type": "Dimension" + }, + { + "name": "MeterCategory", + "type": "Dimension" + }, + { + "name": "swaggerTagKey", + "type": "TagKey" + } + ], + "query": { + "type": "Usage", + "dataSet": { + "aggregation": { + "totalCost": { + "name": "PreTaxCost", + "function": "Sum" + } + }, + "granularity": "Daily", + "grouping": [], + "sorting": [ + { + "name": "UsageDate", + "direction": "Ascending" + } + ] + }, + "timeframe": "MonthToDate" + }, + "scope": "" + } + } + } + }, + "operationId": "Views_CreateOrUpdate", + "title": "CreateOrUpdatePrivateView" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/PrivateViewDelete.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/PrivateViewDelete.json new file mode 100644 index 000000000000..81ad15abaab5 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/PrivateViewDelete.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "viewName": "TestView" + }, + "responses": { + "200": {}, + "204": {} + }, + "operationId": "Views_Delete", + "title": "DeletePrivateView" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/PrivateViewList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/PrivateViewList.json new file mode 100644 index 000000000000..adce1dda4c87 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/PrivateViewList.json @@ -0,0 +1,133 @@ +{ + "parameters": { + "api-version": "2025-03-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "swaggerExample", + "type": "Microsoft.CostManagement/Views", + "eTag": "\"1d4ff9fe66f1d10\"", + "id": "/providers/Microsoft.CostManagement/views/swaggerExample", + "properties": { + "accumulated": "true", + "chart": "Table", + "displayName": "swagger Example", + "kpis": [ + { + "type": "Forecast", + "enabled": true, + "id": null + }, + { + "type": "Budget", + "enabled": true, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Consumption/budgets/swaggerDemo" + } + ], + "metric": "ActualCost", + "pivots": [ + { + "name": "ServiceName", + "type": "Dimension" + }, + { + "name": "MeterCategory", + "type": "Dimension" + }, + { + "name": "swaggerTagKey", + "type": "TagKey" + } + ], + "query": { + "type": "Usage", + "dataSet": { + "aggregation": { + "totalCost": { + "name": "PreTaxCost", + "function": "Sum" + } + }, + "granularity": "Daily", + "grouping": [], + "sorting": [ + { + "name": "UsageDate", + "direction": "Ascending" + } + ] + }, + "timeframe": "MonthToDate" + }, + "scope": "" + } + }, + { + "name": "swaggerExample2", + "type": "Microsoft.CostManagement/Views", + "eTag": "\"1d4ffa5a9c2430c\"", + "id": "/providers/Microsoft.CostManagement/views/swaggerExample2", + "properties": { + "accumulated": "true", + "chart": "GroupedColumn", + "displayName": "swagger Example 2", + "kpis": [ + { + "type": "Forecast", + "enabled": true, + "id": null + }, + { + "type": "Budget", + "enabled": true, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Consumption/budgets/swaggerDemo" + } + ], + "metric": "ActualCost", + "pivots": [ + { + "name": "ServiceName", + "type": "Dimension" + }, + { + "name": "MeterCategory", + "type": "Dimension" + }, + { + "name": "swaggerTagKey", + "type": "TagKey" + } + ], + "query": { + "type": "Usage", + "dataSet": { + "aggregation": { + "totalCost": { + "name": "PreTaxCost", + "function": "Sum" + } + }, + "granularity": "Daily", + "grouping": [], + "sorting": [ + { + "name": "UsageDate", + "direction": "Ascending" + } + ] + }, + "timeframe": "LastMonthToDate" + }, + "scope": "" + } + } + ] + } + } + }, + "operationId": "Views_List", + "title": "PrivateViewList" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ResourceGroupAlerts.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ResourceGroupAlerts.json new file mode 100644 index 000000000000..bc87167a4c52 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ResourceGroupAlerts.json @@ -0,0 +1,101 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "resourceGroupName": "ScreenSharingTest-peer", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ScreenSharingTest-peer", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "nextLink": null, + "value": [ + { + "name": "00000000-0000-0000-0000-000000000000", + "type": "Microsoft.CostManagement/alerts", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ScreenSharingTest-peer/providers/Microsoft.CostManagement/alerts/00000000-0000-0000-0000-000000000000", + "properties": { + "description": "", + "closeTime": "0001-01-01T00:00:00", + "costEntityId": "budget1", + "creationTime": "2020-04-27T11:07:52.7143901Z", + "definition": { + "type": "Budget", + "category": "Cost", + "criteria": "CostThresholdExceeded" + }, + "modificationTime": "2020-04-28T11:06:02.8999373Z", + "source": "Preset", + "status": "Active", + "statusModificationTime": "0001-01-01T00:00:00", + "statusModificationUserName": null, + "details": { + "amount": 200000, + "contactEmails": [ + "1234@contoso.com" + ], + "contactGroups": [], + "contactRoles": [], + "currentSpend": 161000.12, + "meterFilter": [], + "operator": "GreaterThan", + "overridingAlert": null, + "periodStartDate": "2020-03-01T00:00:00Z", + "resourceFilter": [], + "resourceGroupFilter": [], + "tagFilter": {}, + "threshold": 0.8, + "timeGrainType": "Quarterly", + "triggeredBy": "00000000-0000-0000-0000-000000000000_1_01", + "unit": "USD" + } + } + }, + { + "name": "11111111-1111-1111-111111111111", + "type": "Microsoft.CostManagement/alerts", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ScreenSharingTest-peer/providers/Microsoft.CostManagement/alerts/11111111-1111-1111-111111111111", + "properties": { + "description": "", + "closeTime": "0001-01-01T00:00:00", + "costEntityId": "budget1", + "creationTime": "2019-06-24T05:51:52.8713179Z", + "definition": { + "type": "Budget", + "category": "Cost", + "criteria": "CostThresholdExceeded" + }, + "modificationTime": "2019-08-31T17:51:55.1808807Z", + "source": "Preset", + "status": "Active", + "statusModificationTime": "0001-01-01T00:00:00", + "statusModificationUserName": null, + "details": { + "amount": 200000, + "contactEmails": [ + "1234@contoso.com" + ], + "contactGroups": [], + "contactRoles": [], + "currentSpend": 171000.32, + "meterFilter": [], + "operator": "GreaterThan", + "overridingAlert": null, + "periodStartDate": "2020-03-01T00:00:00Z", + "resourceFilter": [], + "resourceGroupFilter": [], + "tagFilter": {}, + "threshold": 0.8, + "timeGrainType": "Quarterly", + "triggeredBy": "11111111-1111-1111-111111111111_1_01", + "unit": "USD" + } + } + } + ] + } + } + }, + "operationId": "Alerts_List", + "title": "ResourceGroupAlerts" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ResourceGroupDimensionsList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ResourceGroupDimensionsList.json new file mode 100644 index 000000000000..f3429a873503 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ResourceGroupDimensionsList.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "$expand": "properties/data", + "$top": 5, + "api-version": "2025-03-01", + "resourceGroupName": "system.orlando", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/system.orlando", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "dimensions_ResourceType_2018-05-01_2018-05-31_5", + "type": "microsoft.CostManagement/dimensions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/system.orlando/providers/microsoft.CostManagement/dimensions_ResourceType_2018-05-01_2018-05-31_5", + "properties": { + "description": "Resource type", + "category": "ResourceType", + "data": [ + "microsoft.storage/storageaccounts" + ], + "filterEnabled": true, + "groupingEnabled": true, + "total": 1, + "usageEnd": "2018-05-31T00:00:00-07:00", + "usageStart": "2018-05-01T00:00:00-07:00" + } + }, + { + "name": "dimensions_ResourceId_2018-05-01_2018-05-31_5", + "type": "microsoft.CostManagement/dimensions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/system.orlando/providers/microsoft.CostManagement/dimensions_ResourceId_2018-05-01_2018-05-31_5", + "properties": { + "description": "Resource Id", + "category": "ResourceId", + "data": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/system.orlando/providers/microsoft.storage/storageaccounts/authprod", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/system.orlando/providers/microsoft.storage/storageaccounts/systemevents", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/system.orlando/providers/microsoft.storage/storageaccounts/armadminprod", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/system.orlando/providers/microsoft.storage/storageaccounts/srphytenaccount", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/system.orlando/providers/microsoft.storage/storageaccounts/publicsystemportal" + ], + "filterEnabled": true, + "groupingEnabled": true, + "total": 27, + "usageEnd": "2018-05-31T00:00:00-07:00", + "usageStart": "2018-05-01T00:00:00-07:00" + } + } + ] + } + }, + "204": {} + }, + "operationId": "Dimensions_List", + "title": "ResourceGroupDimensionsList-Legacy" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ResourceGroupForecast.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ResourceGroupForecast.json new file mode 100644 index 000000000000..e14c8a8dfe61 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ResourceGroupForecast.json @@ -0,0 +1,105 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "parameters": { + "type": "Usage", + "dataset": { + "aggregation": { + "totalCost": { + "name": "Cost", + "function": "Sum" + } + }, + "filter": { + "and": [ + { + "or": [ + { + "dimensions": { + "name": "ResourceLocation", + "operator": "In", + "values": [ + "East US", + "West Europe" + ] + } + }, + { + "tags": { + "name": "Environment", + "operator": "In", + "values": [ + "UAT", + "Prod" + ] + } + } + ] + }, + { + "dimensions": { + "name": "ResourceGroup", + "operator": "In", + "values": [ + "API" + ] + } + } + ] + }, + "granularity": "Daily" + }, + "includeActualCost": false, + "includeFreshPartialCost": false, + "timePeriod": { + "from": "2022-08-01T00:00:00+00:00", + "to": "2022-08-31T23:59:59+00:00" + }, + "timeframe": "Custom" + }, + "resourceGroupName": "ScreenSharingTest-peer", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ScreenSharingTest-peer", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "55312978-ba1b-415c-9304-cfd9c43c0481", + "type": "Microsoft.CostManagement/query", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ScreenSharingTest-peer/providers/Microsoft.CostManagement/query/00000000-0000-0000-0000-000000000000", + "properties": { + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "UsageDate", + "type": "Number" + }, + { + "name": "CostStatus", + "type": "String" + }, + { + "name": "Currency", + "type": "String" + } + ], + "nextLink": null, + "rows": [ + [ + 2.10333307059661, + 20180331, + "Forecast", + "USD" + ] + ] + } + } + }, + "204": {} + }, + "operationId": "Forecast_Usage", + "title": "ResourceGroupForecast" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ResourceGroupQuery.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ResourceGroupQuery.json new file mode 100644 index 000000000000..0afe919888f0 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ResourceGroupQuery.json @@ -0,0 +1,99 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "parameters": { + "type": "Usage", + "dataset": { + "filter": { + "and": [ + { + "or": [ + { + "dimensions": { + "name": "ResourceLocation", + "operator": "In", + "values": [ + "East US", + "West Europe" + ] + } + }, + { + "tags": { + "name": "Environment", + "operator": "In", + "values": [ + "UAT", + "Prod" + ] + } + } + ] + }, + { + "dimensions": { + "name": "ResourceGroup", + "operator": "In", + "values": [ + "API" + ] + } + } + ] + }, + "granularity": "Daily" + }, + "timeframe": "MonthToDate" + }, + "resourceGroupName": "ScreenSharingTest-peer", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ScreenSharingTest-peer", + "subscriptionId": "55312978-ba1b-415c-9304-c4b9c43c0481" + }, + "responses": { + "200": { + "body": { + "name": "9af9459d-441d-4055-9ed0-83d4c4a363fb", + "type": "microsoft.costmanagement/Query", + "id": "/subscriptions/55312978-ba1b-415c-9304-c4b9c43c0481/resourcegroups/ScreenSharingTest-peer/providers/Microsoft.CostManagement/Query/9af9459d-441d-4055-9ed0-83d4c4a363fb", + "properties": { + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "ResourceGroup", + "type": "String" + }, + { + "name": "UsageDate", + "type": "Number" + }, + { + "name": "Currency", + "type": "String" + } + ], + "nextLink": null, + "rows": [ + [ + 2.10333307059661, + "ScreenSharingTest-peer", + 20180417, + "USD" + ], + [ + 20.10333307059661, + "ScreenSharingTest-peer", + 20180418, + "USD" + ] + ] + } + } + }, + "204": {} + }, + "operationId": "Query_Usage", + "title": "ResourceGroupQuery-Legacy" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ResourceGroupQueryGrouping.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ResourceGroupQueryGrouping.json new file mode 100644 index 000000000000..c7e3a47659d1 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ResourceGroupQueryGrouping.json @@ -0,0 +1,74 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "parameters": { + "type": "Usage", + "dataset": { + "aggregation": { + "totalCost": { + "name": "PreTaxCost", + "function": "Sum" + } + }, + "granularity": "Daily", + "grouping": [ + { + "name": "ResourceType", + "type": "Dimension" + } + ] + }, + "timeframe": "TheLastMonth" + }, + "resourceGroupName": "ScreenSharingTest-peer", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ScreenSharingTest-peer", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "9af9459d-441d-4055-9ed0-83d4c4a363fb", + "type": "microsoft.costmanagement/Query", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/ScreenSharingTest-peer/providers/Microsoft.CostManagement/Query/9af9459d-441d-4055-9ed0-83d4c4a363fb", + "properties": { + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "ResourceType", + "type": "String" + }, + { + "name": "UsageDate", + "type": "Number" + }, + { + "name": "Currency", + "type": "String" + } + ], + "nextLink": null, + "rows": [ + [ + 2.10333307059661, + "Microsoft.SqlServer", + 20180417, + "USD" + ], + [ + 20.10333307059661, + "Microsoft.Compute", + 20180418, + "USD" + ] + ] + } + } + }, + "204": {} + }, + "operationId": "Query_Usage", + "title": "ResourceGroupQueryGrouping-Legacy" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/SingleResourceGroupAlert.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/SingleResourceGroupAlert.json new file mode 100644 index 000000000000..b54eb542ddf7 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/SingleResourceGroupAlert.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "alertId": "22222222-2222-2222-2222-222222222222", + "api-version": "2025-03-01", + "resourceGroupName": "ScreenSharingTest-peer", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ScreenSharingTest-peer", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "22222222-2222-2222-2222-222222222222", + "type": "Microsoft.CostManagement/alerts", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ScreenSharingTest-peer/providers/Microsoft.CostManagement/alerts/22222222-2222-2222-2222-222222222222", + "properties": { + "description": "", + "closeTime": "0001-01-01T00:00:00", + "costEntityId": "budget1", + "creationTime": "2020-04-27T11:07:52.7143901Z", + "definition": { + "type": "Budget", + "category": "Cost", + "criteria": "CostThresholdExceeded" + }, + "modificationTime": "2020-04-28T11:06:02.8999373Z", + "source": "Preset", + "status": "Active", + "statusModificationTime": "0001-01-01T00:00:00", + "statusModificationUserName": null, + "details": { + "amount": 200000, + "contactEmails": [ + "1234@contoso.com" + ], + "contactGroups": [], + "contactRoles": [], + "currentSpend": 161000.12, + "meterFilter": [], + "operator": "GreaterThan", + "overridingAlert": null, + "periodStartDate": "2020-03-01T00:00:00Z", + "resourceFilter": [], + "resourceGroupFilter": [], + "tagFilter": {}, + "threshold": 0.8, + "timeGrainType": "Quarterly", + "triggeredBy": "22222222-2222-2222-2222-222222222222_1_01", + "unit": "USD" + } + } + } + } + }, + "operationId": "Alerts_Get", + "title": "SingleResourceGroupAlerts" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/SingleSubscriptionAlert.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/SingleSubscriptionAlert.json new file mode 100644 index 000000000000..2980a69ecb27 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/SingleSubscriptionAlert.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "alertId": "22222222-2222-2222-2222-222222222222", + "api-version": "2025-03-01", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "22222222-2222-2222-2222-222222222222", + "type": "Microsoft.CostManagement/alerts", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/alerts/22222222-2222-2222-2222-222222222222", + "properties": { + "description": "", + "closeTime": "0001-01-01T00:00:00", + "costEntityId": "budget1", + "creationTime": "2020-04-27T11:07:52.7143901Z", + "definition": { + "type": "Budget", + "category": "Cost", + "criteria": "CostThresholdExceeded" + }, + "modificationTime": "2020-04-28T11:06:02.8999373Z", + "source": "Preset", + "status": "Active", + "statusModificationTime": "0001-01-01T00:00:00", + "statusModificationUserName": null, + "details": { + "amount": 200000, + "contactEmails": [ + "1234@contoso.com" + ], + "contactGroups": [], + "contactRoles": [], + "currentSpend": 161000.12, + "meterFilter": [], + "operator": "GreaterThan", + "overridingAlert": null, + "periodStartDate": "2020-03-01T00:00:00Z", + "resourceFilter": [], + "resourceGroupFilter": [], + "tagFilter": {}, + "threshold": 0.8, + "timeGrainType": "Quarterly", + "triggeredBy": "22222222-2222-2222-2222-222222222222_1_01", + "unit": "USD" + } + } + } + } + }, + "operationId": "Alerts_Get", + "title": "SingleSubscriptionAlerts" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/SubscriptionAlerts.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/SubscriptionAlerts.json new file mode 100644 index 000000000000..efa696816277 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/SubscriptionAlerts.json @@ -0,0 +1,100 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "nextLink": null, + "value": [ + { + "name": "00000000-0000-0000-0000-000000000000", + "type": "Microsoft.CostManagement/alerts", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/alerts/00000000-0000-0000-0000-000000000000", + "properties": { + "description": "", + "closeTime": "0001-01-01T00:00:00", + "costEntityId": "budget1", + "creationTime": "2020-04-27T11:07:52.7143901Z", + "definition": { + "type": "Budget", + "category": "Cost", + "criteria": "CostThresholdExceeded" + }, + "modificationTime": "2020-04-28T11:06:02.8999373Z", + "source": "Preset", + "status": "Active", + "statusModificationTime": "0001-01-01T00:00:00", + "statusModificationUserName": null, + "details": { + "amount": 200000, + "contactEmails": [ + "1234@contoso.com" + ], + "contactGroups": [], + "contactRoles": [], + "currentSpend": 161000.12, + "meterFilter": [], + "operator": "GreaterThan", + "overridingAlert": null, + "periodStartDate": "2020-03-01T00:00:00Z", + "resourceFilter": [], + "resourceGroupFilter": [], + "tagFilter": {}, + "threshold": 0.8, + "timeGrainType": "Quarterly", + "triggeredBy": "00000000-0000-0000-0000-000000000000_1_01", + "unit": "USD" + } + } + }, + { + "name": "11111111-1111-1111-111111111111", + "type": "Microsoft.CostManagement/alerts", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/alerts/11111111-1111-1111-111111111111", + "properties": { + "description": "", + "closeTime": "0001-01-01T00:00:00", + "costEntityId": "budget1", + "creationTime": "2019-06-24T05:51:52.8713179Z", + "definition": { + "type": "Budget", + "category": "Cost", + "criteria": "CostThresholdExceeded" + }, + "modificationTime": "2019-08-31T17:51:55.1808807Z", + "source": "Preset", + "status": "Active", + "statusModificationTime": "0001-01-01T00:00:00", + "statusModificationUserName": null, + "details": { + "amount": 200000, + "contactEmails": [ + "1234@contoso.com" + ], + "contactGroups": [], + "contactRoles": [], + "currentSpend": 171000.32, + "meterFilter": [], + "operator": "GreaterThan", + "overridingAlert": null, + "periodStartDate": "2020-03-01T00:00:00Z", + "resourceFilter": [], + "resourceGroupFilter": [], + "tagFilter": {}, + "threshold": 0.8, + "timeGrainType": "Quarterly", + "triggeredBy": "11111111-1111-1111-111111111111_1_01", + "unit": "USD" + } + } + } + ] + } + } + }, + "operationId": "Alerts_List", + "title": "SubscriptionAlerts" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/SubscriptionDimensionsList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/SubscriptionDimensionsList.json new file mode 100644 index 000000000000..766cce45284f --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/SubscriptionDimensionsList.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "$expand": "properties/data", + "$top": 5, + "api-version": "2025-03-01", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "dimensions_ResourceGroup_2018-05-01_2018-05-31_5", + "type": "microsoft.CostManagement/dimensions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/dimensions_ResourceGroup_2018-05-01_2018-05-31_5", + "properties": { + "description": "Resource group", + "category": "ResourceGroup", + "data": [ + "dcrg", + "rg", + "offlinegalleryrg", + "system.orlando.adminkeyvault", + "system.orlando.keyvault" + ], + "filterEnabled": true, + "groupingEnabled": true, + "total": 68, + "usageEnd": "2018-05-31T00:00:00-07:00", + "usageStart": "2018-05-01T00:00:00-07:00" + } + }, + { + "name": "dimensions_ResourceType_2018-05-01_2018-05-31_5", + "type": "microsoft.CostManagement/dimensions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/dimensions_ResourceType_2018-05-01_2018-05-31_5", + "properties": { + "description": "Resource type", + "category": "ResourceType", + "data": [ + "microsoft.storage/storageaccounts", + "microsoft.web.admin/role", + "microsoft.sql/servers", + "microsoft.compute/virtualmachines" + ], + "filterEnabled": true, + "groupingEnabled": true, + "total": 4, + "usageEnd": "2018-05-31T00:00:00-07:00", + "usageStart": "2018-05-01T00:00:00-07:00" + } + } + ] + } + }, + "204": {} + }, + "operationId": "Dimensions_List", + "title": "SubscriptionDimensionsList-Legacy" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/SubscriptionForecast.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/SubscriptionForecast.json new file mode 100644 index 000000000000..2f8717565a64 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/SubscriptionForecast.json @@ -0,0 +1,122 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "parameters": { + "type": "Usage", + "dataset": { + "aggregation": { + "totalCost": { + "name": "Cost", + "function": "Sum" + } + }, + "filter": { + "and": [ + { + "or": [ + { + "dimensions": { + "name": "ResourceLocation", + "operator": "In", + "values": [ + "East US", + "West Europe" + ] + } + }, + { + "tags": { + "name": "Environment", + "operator": "In", + "values": [ + "UAT", + "Prod" + ] + } + } + ] + }, + { + "dimensions": { + "name": "ResourceGroup", + "operator": "In", + "values": [ + "API" + ] + } + } + ] + }, + "granularity": "Daily" + }, + "includeActualCost": false, + "includeFreshPartialCost": false, + "timePeriod": { + "from": "2022-08-01T00:00:00+00:00", + "to": "2022-08-31T23:59:59+00:00" + }, + "timeframe": "Custom" + }, + "scope": "subscriptions/00000000-0000-0000-0000-000000000000", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "55312978-ba1b-415c-9304-cfd9c43c0481", + "type": "Microsoft.CostManagement/query", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/query/00000000-0000-0000-0000-000000000000", + "properties": { + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "UsageDate", + "type": "Number" + }, + { + "name": "CostStatus", + "type": "String" + }, + { + "name": "Currency", + "type": "String" + } + ], + "nextLink": null, + "rows": [ + [ + 2.10333307059661, + 20180331, + "Forecast", + "USD" + ], + [ + 218.68795741935486, + 20180331, + "Forecast", + "USD" + ], + [ + 0.14384913581657052, + 20180401, + "Forecast", + "USD" + ], + [ + 0.009865586851323632, + 20180429, + "Forecast", + "USD" + ] + ] + } + } + }, + "204": {} + }, + "operationId": "Forecast_Usage", + "title": "SubscriptionForecast" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/SubscriptionQuery.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/SubscriptionQuery.json new file mode 100644 index 000000000000..510b4ccacfe6 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/SubscriptionQuery.json @@ -0,0 +1,110 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "parameters": { + "type": "Usage", + "dataset": { + "filter": { + "and": [ + { + "or": [ + { + "dimensions": { + "name": "ResourceLocation", + "operator": "In", + "values": [ + "East US", + "West Europe" + ] + } + }, + { + "tags": { + "name": "Environment", + "operator": "In", + "values": [ + "UAT", + "Prod" + ] + } + } + ] + }, + { + "dimensions": { + "name": "ResourceGroup", + "operator": "In", + "values": [ + "API" + ] + } + } + ] + }, + "granularity": "Daily" + }, + "timeframe": "MonthToDate" + }, + "scope": "subscriptions/00000000-0000-0000-0000-000000000000", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "55312978-ba1b-415c-9304-cfd9c43c0481", + "type": "microsoft.costmanagement/Query", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/Query/00000000-0000-0000-0000-000000000000", + "properties": { + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "ResourceGroup", + "type": "String" + }, + { + "name": "UsageDate", + "type": "Number" + }, + { + "name": "Currency", + "type": "String" + } + ], + "nextLink": null, + "rows": [ + [ + 2.10333307059661, + "ScreenSharingTest-peer", + 20180331, + "USD" + ], + [ + 218.68795741935486, + "Ict_StratAndPlan_GoldSprova_Prod", + 20180331, + "USD" + ], + [ + 0.14384913581657052, + "ssbciotelement01", + 20180401, + "USD" + ], + [ + 0.009865586851323632, + "ict_stratandplan_goldsprova_prod", + 20180429, + "USD" + ] + ] + } + } + }, + "204": {} + }, + "operationId": "Query_Usage", + "title": "SubscriptionQuery-Legacy" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/SubscriptionQueryGrouping.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/SubscriptionQueryGrouping.json new file mode 100644 index 000000000000..6b3672181d99 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/SubscriptionQueryGrouping.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "parameters": { + "type": "Usage", + "dataset": { + "aggregation": { + "totalCost": { + "name": "PreTaxCost", + "function": "Sum" + } + }, + "granularity": "None", + "grouping": [ + { + "name": "ResourceGroup", + "type": "Dimension" + } + ] + }, + "timeframe": "TheLastMonth" + }, + "scope": "subscriptions/00000000-0000-0000-0000-000000000000", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "55312978-ba1b-415c-9304-cfd9c43c0481", + "type": "microsoft.costmanagement/Query", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/Query/00000000-0000-0000-0000-000000000000", + "properties": { + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "ResourceGroup", + "type": "String" + }, + { + "name": "Currency", + "type": "String" + } + ], + "nextLink": null, + "rows": [ + [ + 0.009865586851323632, + "Ict_StratAndPlan_GoldSprova_Prod_0", + "USD" + ], + [ + 218.68795741935486, + "Ict_StratAndPlan_GoldSprova_Prod_1", + "USD" + ], + [ + 2.10333307059661, + "ScreenSharingTest-peer1", + "USD" + ], + [ + 0.14384913581657052, + "Ssbciotelement01", + "USD" + ] + ] + } + } + }, + "204": {} + }, + "operationId": "Query_Usage", + "title": "SubscriptionQueryGrouping-Legacy" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ViewByResourceGroup.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ViewByResourceGroup.json new file mode 100644 index 000000000000..a29498f439cc --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ViewByResourceGroup.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG", + "viewName": "swaggerExample" + }, + "responses": { + "200": { + "body": { + "name": "swaggerExample", + "type": "Microsoft.CostManagement/Views", + "eTag": "\"1d4ff9fe66f1d10\"", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/views/swaggerExample", + "properties": { + "accumulated": "true", + "chart": "Table", + "displayName": "swagger Example", + "kpis": [ + { + "type": "Forecast", + "enabled": true, + "id": null + }, + { + "type": "Budget", + "enabled": true, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Consumption/budgets/swaggerDemo" + } + ], + "metric": "ActualCost", + "pivots": [ + { + "name": "ServiceName", + "type": "Dimension" + }, + { + "name": "MeterCategory", + "type": "Dimension" + }, + { + "name": "swaggerTagKey", + "type": "TagKey" + } + ], + "query": { + "type": "Usage", + "dataSet": { + "aggregation": { + "totalCost": { + "name": "PreTaxCost", + "function": "Sum" + } + }, + "granularity": "Daily", + "grouping": [], + "sorting": [ + { + "name": "UsageDate", + "direction": "Ascending" + } + ] + }, + "timeframe": "MonthToDate" + }, + "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG" + } + } + } + }, + "operationId": "Views_GetByScope", + "title": "ResourceGroupView" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ViewCreateOrUpdateByResourceGroup.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ViewCreateOrUpdateByResourceGroup.json new file mode 100644 index 000000000000..f4a025cb74f8 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ViewCreateOrUpdateByResourceGroup.json @@ -0,0 +1,188 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "parameters": { + "eTag": "\"1d4ff9fe66f1d10\"", + "properties": { + "accumulated": "true", + "chart": "Table", + "displayName": "swagger Example", + "kpis": [ + { + "type": "Forecast", + "enabled": true, + "id": null + }, + { + "type": "Budget", + "enabled": true, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Consumption/budgets/swaggerDemo" + } + ], + "metric": "ActualCost", + "pivots": [ + { + "name": "ServiceName", + "type": "Dimension" + }, + { + "name": "MeterCategory", + "type": "Dimension" + }, + { + "name": "swaggerTagKey", + "type": "TagKey" + } + ], + "query": { + "type": "Usage", + "dataSet": { + "aggregation": { + "totalCost": { + "name": "PreTaxCost", + "function": "Sum" + } + }, + "granularity": "Daily", + "grouping": [], + "sorting": [ + { + "name": "UsageDate", + "direction": "Ascending" + } + ] + }, + "timeframe": "MonthToDate" + } + } + }, + "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG", + "viewName": "swaggerExample" + }, + "responses": { + "200": { + "body": { + "name": "swaggerExample", + "type": "Microsoft.CostManagement/Views", + "eTag": "\"1d4ffa5a9c2430c\"", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/views/swaggerExample", + "properties": { + "accumulated": "true", + "chart": "Table", + "displayName": "swagger Example", + "kpis": [ + { + "type": "Forecast", + "enabled": true, + "id": null + }, + { + "type": "Budget", + "enabled": true, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Consumption/budgets/swaggerDemo" + } + ], + "metric": "ActualCost", + "pivots": [ + { + "name": "ServiceName", + "type": "Dimension" + }, + { + "name": "MeterCategory", + "type": "Dimension" + }, + { + "name": "swaggerTagKey", + "type": "TagKey" + } + ], + "query": { + "type": "Usage", + "dataSet": { + "aggregation": { + "totalCost": { + "name": "PreTaxCost", + "function": "Sum" + } + }, + "granularity": "Daily", + "grouping": [], + "sorting": [ + { + "name": "UsageDate", + "direction": "Ascending" + } + ] + }, + "timeframe": "MonthToDate" + }, + "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG" + } + } + }, + "201": { + "body": { + "name": "swaggerExample", + "type": "Microsoft.CostManagement/Views", + "eTag": "\"1d4ffa5a9c2430c\"", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/views/swaggerExample", + "properties": { + "accumulated": "true", + "chart": "Table", + "displayName": "swagger Example", + "kpis": [ + { + "type": "Forecast", + "enabled": true, + "id": null + }, + { + "type": "Budget", + "enabled": true, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Consumption/budgets/swaggerDemo" + } + ], + "metric": "ActualCost", + "pivots": [ + { + "name": "ServiceName", + "type": "Dimension" + }, + { + "name": "MeterCategory", + "type": "Dimension" + }, + { + "name": "swaggerTagKey", + "type": "TagKey" + } + ], + "query": { + "type": "Usage", + "dataSet": { + "aggregation": { + "totalCost": { + "name": "PreTaxCost", + "function": "Sum" + } + }, + "granularity": "Daily", + "grouping": [], + "sorting": [ + { + "name": "UsageDate", + "direction": "Ascending" + } + ] + }, + "timeframe": "MonthToDate" + }, + "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG" + } + } + } + }, + "operationId": "Views_CreateOrUpdateByScope", + "title": "ResourceGroupCreateOrUpdateView" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ViewDeleteByResourceGroup.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ViewDeleteByResourceGroup.json new file mode 100644 index 000000000000..d42216abe104 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ViewDeleteByResourceGroup.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG", + "viewName": "TestView" + }, + "responses": { + "200": {}, + "204": {} + }, + "operationId": "Views_DeleteByScope", + "title": "ResourceGroupDeleteView" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ViewListByResourceGroup.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ViewListByResourceGroup.json new file mode 100644 index 000000000000..083410a792a2 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/ViewListByResourceGroup.json @@ -0,0 +1,134 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/views/swaggerExample", + "name": "swaggerExample", + "type": "Microsoft.CostManagement/Views", + "eTag": "\"1d4ff9fe66f1d10\"", + "properties": { + "displayName": "swagger Example", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG", + "query": { + "type": "Usage", + "timeframe": "MonthToDate", + "dataSet": { + "granularity": "Daily", + "aggregation": { + "totalCost": { + "name": "PreTaxCost", + "function": "Sum" + } + }, + "grouping": [], + "sorting": [ + { + "direction": "Ascending", + "name": "UsageDate" + } + ] + } + }, + "chart": "Table", + "accumulated": "true", + "metric": "ActualCost", + "kpis": [ + { + "type": "Forecast", + "id": null, + "enabled": true + }, + { + "type": "Budget", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Consumption/budgets/swaggerDemo", + "enabled": true + } + ], + "pivots": [ + { + "type": "Dimension", + "name": "ServiceName" + }, + { + "type": "Dimension", + "name": "MeterCategory" + }, + { + "type": "TagKey", + "name": "swaggerTagKey" + } + ] + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/views/swaggerExample2", + "name": "swaggerExample2", + "type": "Microsoft.CostManagement/Views", + "eTag": "\"1d4ffa5a9c2430c\"", + "properties": { + "displayName": "swagger Example 2", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG", + "query": { + "type": "Usage", + "timeframe": "LastMonthToDate", + "dataSet": { + "granularity": "Daily", + "aggregation": { + "totalCost": { + "name": "PreTaxCost", + "function": "Sum" + } + }, + "grouping": [], + "sorting": [ + { + "direction": "Ascending", + "name": "UsageDate" + } + ] + } + }, + "chart": "GroupedColumn", + "accumulated": "true", + "metric": "ActualCost", + "kpis": [ + { + "type": "Forecast", + "id": null, + "enabled": true + }, + { + "type": "Budget", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Consumption/budgets/swaggerDemo", + "enabled": true + } + ], + "pivots": [ + { + "type": "Dimension", + "name": "ServiceName" + }, + { + "type": "Dimension", + "name": "MeterCategory" + }, + { + "type": "TagKey", + "name": "swaggerTagKey" + } + ] + } + } + ] + } + } + }, + "operationId": "Views_ListByScope", + "title": "ResourceGroupViewList" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/scheduledActions/checkNameAvailability-private-scheduledAction.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/scheduledActions/checkNameAvailability-private-scheduledAction.json new file mode 100644 index 000000000000..595efbdd6fc3 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/scheduledActions/checkNameAvailability-private-scheduledAction.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "checkNameAvailabilityRequest": { + "name": "testName", + "type": "Microsoft.CostManagement/ScheduledActions" + } + }, + "responses": { + "200": { + "body": { + "message": "A private scheduled action with name 'testName' is already present. Please specify a differnt name.", + "nameAvailable": false, + "reason": "AlreadyExists" + } + } + }, + "operationId": "ScheduledActions_CheckNameAvailability", + "title": "ScheduledActionCheckNameAvailability" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/scheduledActions/checkNameAvailability-shared-scheduledAction.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/scheduledActions/checkNameAvailability-shared-scheduledAction.json new file mode 100644 index 000000000000..0142bce2aa83 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/scheduledActions/checkNameAvailability-shared-scheduledAction.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "checkNameAvailabilityRequest": { + "name": "testName", + "type": "Microsoft.CostManagement/ScheduledActions" + }, + "scope": "subscriptions/00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "nameAvailable": true + } + } + }, + "operationId": "ScheduledActions_CheckNameAvailabilityByScope", + "title": "ScheduledActionCheckNameAvailabilityByScope" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/scheduledActions/scheduledAction-createOrUpdate-private.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/scheduledActions/scheduledAction-createOrUpdate-private.json new file mode 100644 index 000000000000..8455b591e0fd --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/scheduledActions/scheduledAction-createOrUpdate-private.json @@ -0,0 +1,129 @@ +{ + "parameters": { + "name": "monthlyCostByResource", + "If-Match": "", + "api-version": "2025-03-01", + "scheduledAction": { + "kind": "Email", + "properties": { + "displayName": "Monthly Cost By Resource", + "notification": { + "subject": "Cost by resource this month", + "to": [ + "user@gmail.com", + "team@gmail.com" + ] + }, + "schedule": { + "daysOfWeek": [ + "Monday" + ], + "endDate": "2021-06-19T22:21:51.1287144Z", + "frequency": "Monthly", + "hourOfDay": 10, + "startDate": "2020-06-19T22:21:51.1287144Z", + "weeksOfMonth": [ + "First", + "Third" + ] + }, + "status": "Enabled", + "viewId": "/providers/Microsoft.CostManagement/views/swaggerExample" + } + } + }, + "responses": { + "200": { + "body": { + "name": "monthlyCostByResource", + "type": "Microsoft.CostManagement/ScheduledActions", + "eTag": "\"1d4ff9fe66f1d10\"", + "id": "/providers/Microsoft.CostManagement/scheduledActions/monthlyCostByResource", + "kind": "Email", + "properties": { + "displayName": "Monthly Cost By Resource", + "notification": { + "regionalFormat": "fr", + "subject": "Cost by resource this month", + "to": [ + "user@gmail.com", + "team@gmail.com" + ], + "language": "fr" + }, + "schedule": { + "daysOfWeek": [ + "Monday" + ], + "endDate": "2021-06-19T22:21:51.1287144Z", + "frequency": "Monthly", + "hourOfDay": 10, + "startDate": "2020-06-19T22:21:51.1287144Z", + "weeksOfMonth": [ + "First", + "Third" + ] + }, + "scope": "", + "status": "Enabled", + "viewId": "/providers/Microsoft.CostManagement/views/swaggerExample" + }, + "systemData": { + "createdAt": "2020-06-18T22:21:51.1287144Z", + "createdBy": "testuser", + "createdByType": "User", + "lastModifiedAt": "2020-06-19T22:21:51.1287144Z", + "lastModifiedBy": "testuser", + "lastModifiedByType": "User" + } + } + }, + "201": { + "body": { + "name": "monthlyCostByResource", + "type": "Microsoft.CostManagement/ScheduledActions", + "eTag": "\"1d4ff9fe66f1d10\"", + "id": "/providers/Microsoft.CostManagement/scheduledActions/monthlyCostByResource", + "kind": "Email", + "properties": { + "displayName": "Monthly Cost By Resource", + "notification": { + "regionalFormat": "fr", + "subject": "Cost by resource this month", + "to": [ + "user@gmail.com", + "team@gmail.com" + ], + "language": "fr" + }, + "schedule": { + "daysOfWeek": [ + "Monday" + ], + "endDate": "2021-06-19T22:21:51.1287144Z", + "frequency": "Monthly", + "hourOfDay": 10, + "startDate": "2020-06-19T22:21:51.1287144Z", + "weeksOfMonth": [ + "First", + "Third" + ] + }, + "scope": "", + "status": "Enabled", + "viewId": "/providers/Microsoft.CostManagement/views/swaggerExample" + }, + "systemData": { + "createdAt": "2020-06-18T22:21:51.1287144Z", + "createdBy": "testuser", + "createdByType": "User", + "lastModifiedAt": "2020-06-18T22:21:51.1287144Z", + "lastModifiedBy": "testuser", + "lastModifiedByType": "User" + } + } + } + }, + "operationId": "ScheduledActions_CreateOrUpdate", + "title": "CreateOrUpdatePrivateScheduledAction" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/scheduledActions/scheduledAction-createOrUpdate-shared.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/scheduledActions/scheduledAction-createOrUpdate-shared.json new file mode 100644 index 000000000000..8907ec730eb2 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/scheduledActions/scheduledAction-createOrUpdate-shared.json @@ -0,0 +1,136 @@ +{ + "parameters": { + "name": "monthlyCostByResource", + "If-Match": "", + "api-version": "2025-03-01", + "scheduledAction": { + "kind": "Email", + "properties": { + "displayName": "Monthly Cost By Resource", + "fileDestination": { + "fileFormats": [ + "Csv" + ] + }, + "notification": { + "subject": "Cost by resource this month", + "to": [ + "user@gmail.com", + "team@gmail.com" + ] + }, + "schedule": { + "daysOfWeek": [ + "Monday" + ], + "endDate": "2021-06-19T22:21:51.1287144Z", + "frequency": "Monthly", + "hourOfDay": 10, + "startDate": "2020-06-19T22:21:51.1287144Z", + "weeksOfMonth": [ + "First", + "Third" + ] + }, + "status": "Enabled", + "viewId": "/providers/Microsoft.CostManagement/views/swaggerExample" + } + }, + "scope": "subscriptions/00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "monthlyCostByResource", + "type": "Microsoft.CostManagement/ScheduledActions", + "eTag": "\"1d4ff9fe66f1d10\"", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/scheduledActions/monthlyCostByResource", + "kind": "Email", + "properties": { + "displayName": "Monthly Cost By Resource", + "notification": { + "subject": "Cost by resource this month", + "to": [ + "user@gmail.com", + "team@gmail.com" + ] + }, + "schedule": { + "daysOfWeek": [ + "Monday" + ], + "endDate": "2021-06-19T22:21:51.1287144Z", + "frequency": "Monthly", + "hourOfDay": 10, + "startDate": "2020-06-19T22:21:51.1287144Z", + "weeksOfMonth": [ + "First", + "Third" + ] + }, + "scope": "subscriptions/00000000-0000-0000-0000-000000000000", + "status": "Enabled", + "viewId": "/providers/Microsoft.CostManagement/views/swaggerExample" + }, + "systemData": { + "createdAt": "2020-06-18T22:21:51.1287144Z", + "createdBy": "testuser", + "createdByType": "User", + "lastModifiedAt": "2020-06-19T22:21:51.1287144Z", + "lastModifiedBy": "testuser", + "lastModifiedByType": "User" + } + } + }, + "201": { + "body": { + "name": "monthlyCostByResource", + "type": "Microsoft.CostManagement/ScheduledActions", + "eTag": "\"1d4ff9fe66f1d10\"", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/scheduledActions/monthlyCostByResource", + "kind": "Email", + "properties": { + "displayName": "Monthly Cost By Resource", + "fileDestination": { + "fileFormats": [ + "Csv" + ] + }, + "notification": { + "subject": "Cost by resource this month", + "to": [ + "user@gmail.com", + "team@gmail.com" + ] + }, + "schedule": { + "daysOfWeek": [ + "Monday" + ], + "endDate": "2021-06-19T22:21:51.1287144Z", + "frequency": "Monthly", + "hourOfDay": 10, + "startDate": "2020-06-19T22:21:51.1287144Z", + "weeksOfMonth": [ + "First", + "Third" + ] + }, + "scope": "subscriptions/00000000-0000-0000-0000-000000000000", + "status": "Enabled", + "viewId": "/providers/Microsoft.CostManagement/views/swaggerExample" + }, + "systemData": { + "createdAt": "2020-06-18T22:21:51.1287144Z", + "createdBy": "testuser", + "createdByType": "User", + "lastModifiedAt": "2020-06-18T22:21:51.1287144Z", + "lastModifiedBy": "testuser", + "lastModifiedByType": "User" + } + } + } + }, + "operationId": "ScheduledActions_CreateOrUpdateByScope", + "title": "CreateOrUpdateScheduledActionByScope" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/scheduledActions/scheduledAction-delete-private.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/scheduledActions/scheduledAction-delete-private.json new file mode 100644 index 000000000000..8acaef929837 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/scheduledActions/scheduledAction-delete-private.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "name": "monthlyCostByResource", + "api-version": "2025-03-01" + }, + "responses": { + "200": {}, + "204": {} + }, + "operationId": "ScheduledActions_Delete", + "title": "PrivateScheduledActionDelete" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/scheduledActions/scheduledAction-delete-shared.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/scheduledActions/scheduledAction-delete-shared.json new file mode 100644 index 000000000000..b58965e6b22f --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/scheduledActions/scheduledAction-delete-shared.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "name": "monthlyCostByResource", + "api-version": "2025-03-01", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": {}, + "204": {} + }, + "operationId": "ScheduledActions_DeleteByScope", + "title": "ScheduledActionDeleteByScope" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/scheduledActions/scheduledAction-get-private.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/scheduledActions/scheduledAction-get-private.json new file mode 100644 index 000000000000..94e9bba45d45 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/scheduledActions/scheduledAction-get-private.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "name": "monthlyCostByResource", + "api-version": "2025-03-01" + }, + "responses": { + "200": { + "body": { + "name": "monthlyCostByResource", + "type": "Microsoft.CostManagement/ScheduledActions", + "eTag": "\"1d4ff9fe66f1d10\"", + "id": "/providers/Microsoft.CostManagement/scheduledActions/monthlyCostByResource", + "kind": "Email", + "properties": { + "displayName": "Monthly Cost By Resource", + "notification": { + "subject": "Cost by resource this month", + "to": [ + "user@gmail.com", + "team@gmail.com" + ] + }, + "schedule": { + "daysOfWeek": [ + "Monday" + ], + "endDate": "2021-06-19T22:21:51.1287144Z", + "frequency": "Monthly", + "hourOfDay": 10, + "startDate": "2020-06-19T22:21:51.1287144Z", + "weeksOfMonth": [ + "First", + "Third" + ] + }, + "scope": "", + "status": "Enabled", + "viewId": "/providers/Microsoft.CostManagement/views/swaggerExample" + }, + "systemData": { + "createdAt": "2020-06-18T22:21:51.1287144Z", + "createdBy": "testuser", + "createdByType": "User", + "lastModifiedAt": "2020-06-18T22:21:51.1287144Z", + "lastModifiedBy": "testuser", + "lastModifiedByType": "User" + } + } + } + }, + "operationId": "ScheduledActions_Get", + "title": "PrivateScheduledAction" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/scheduledActions/scheduledAction-get-shared.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/scheduledActions/scheduledAction-get-shared.json new file mode 100644 index 000000000000..f5247adf2375 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/scheduledActions/scheduledAction-get-shared.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "name": "monthlyCostByResource", + "api-version": "2025-03-01", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "monthlyCostByResource", + "type": "Microsoft.CostManagement/ScheduledActions", + "eTag": "\"1d4ff9fe66f1d10\"", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/scheduledActions/monthlyCostByResource", + "kind": "Email", + "properties": { + "displayName": "Monthly Cost By Resource", + "notification": { + "subject": "Cost by resource this month", + "to": [ + "user@gmail.com", + "team@gmail.com" + ] + }, + "schedule": { + "daysOfWeek": [ + "Monday" + ], + "endDate": "2021-06-19T22:21:51.1287144Z", + "frequency": "Monthly", + "hourOfDay": 10, + "startDate": "2020-06-19T22:21:51.1287144Z", + "weeksOfMonth": [ + "First", + "Third" + ] + }, + "scope": "subscriptions/00000000-0000-0000-0000-000000000000", + "status": "Enabled", + "viewId": "/providers/Microsoft.CostManagement/views/swaggerExample" + }, + "systemData": { + "createdAt": "2020-06-18T22:21:51.1287144Z", + "createdBy": "testuser", + "createdByType": "User", + "lastModifiedAt": "2020-06-18T22:21:51.1287144Z", + "lastModifiedBy": "testuser", + "lastModifiedByType": "User" + } + } + } + }, + "operationId": "ScheduledActions_GetByScope", + "title": "ScheduledActionByScope" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/scheduledActions/scheduledAction-insightAlert-createOrUpdate-shared.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/scheduledActions/scheduledAction-insightAlert-createOrUpdate-shared.json new file mode 100644 index 000000000000..f39baba5ab1c --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/scheduledActions/scheduledAction-insightAlert-createOrUpdate-shared.json @@ -0,0 +1,108 @@ +{ + "parameters": { + "name": "dailyAnomalyByResource", + "If-Match": "", + "api-version": "2025-03-01", + "scheduledAction": { + "kind": "InsightAlert", + "properties": { + "displayName": "Daily anomaly by resource", + "notification": { + "subject": "Cost anomaly detected in the resource", + "to": [ + "user@gmail.com", + "team@gmail.com" + ] + }, + "schedule": { + "endDate": "2021-06-19T22:21:51.1287144Z", + "frequency": "Daily", + "startDate": "2020-06-19T22:21:51.1287144Z" + }, + "status": "Enabled", + "viewId": "/providers/Microsoft.CostManagement/views/swaggerExample" + } + }, + "scope": "subscriptions/00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "dailyAnomalyByResource", + "type": "Microsoft.CostManagement/ScheduledActions", + "eTag": "\"1d4ff9fe66f1d10\"", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/scheduledActions/dailyAnomalyByResource", + "kind": "InsightAlert", + "properties": { + "displayName": "Daily anomaly by resource", + "fileDestination": { + "fileFormats": [] + }, + "notification": { + "subject": "Cost anomaly detected in the resource", + "to": [ + "user@gmail.com", + "team@gmail.com" + ] + }, + "schedule": { + "endDate": "2021-06-19T22:21:51.1287144Z", + "frequency": "Daily", + "startDate": "2020-06-19T22:21:51.1287144Z" + }, + "scope": "subscriptions/00000000-0000-0000-0000-000000000000", + "status": "Enabled", + "viewId": "/providers/Microsoft.CostManagement/views/swaggerExample" + }, + "systemData": { + "createdAt": "2020-06-18T22:21:51.1287144Z", + "createdBy": "testuser", + "createdByType": "User", + "lastModifiedAt": "2020-06-19T22:21:51.1287144Z", + "lastModifiedBy": "testuser", + "lastModifiedByType": "User" + } + } + }, + "201": { + "body": { + "name": "dailyAnomalyByResource", + "type": "Microsoft.CostManagement/ScheduledActions", + "eTag": "\"1d4ff9fe66f1d10\"", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/scheduledActions/dailyAnomalyByResource", + "kind": "InsightAlert", + "properties": { + "displayName": "Daily anomaly by resource", + "fileDestination": { + "fileFormats": [] + }, + "notification": { + "subject": "Cost anomaly detected in the resource", + "to": [ + "user@gmail.com", + "team@gmail.com" + ] + }, + "schedule": { + "endDate": "2021-06-19T22:21:51.1287144Z", + "frequency": "Daily", + "startDate": "2020-06-19T22:21:51.1287144Z" + }, + "scope": "subscriptions/00000000-0000-0000-0000-000000000000", + "status": "Enabled", + "viewId": "/providers/Microsoft.CostManagement/views/swaggerExample" + }, + "systemData": { + "createdAt": "2020-06-18T22:21:51.1287144Z", + "createdBy": "testuser", + "createdByType": "User", + "lastModifiedAt": "2020-06-18T22:21:51.1287144Z", + "lastModifiedBy": "testuser", + "lastModifiedByType": "User" + } + } + } + }, + "operationId": "ScheduledActions_CreateOrUpdateByScope", + "title": "CreateOrUpdateInsightAlertScheduledActionByScope" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/scheduledActions/scheduledAction-sendNow-private.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/scheduledActions/scheduledAction-sendNow-private.json new file mode 100644 index 000000000000..a323a9f881d8 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/scheduledActions/scheduledAction-sendNow-private.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "name": "monthlyCostByResource", + "api-version": "2025-03-01" + }, + "responses": { + "200": {} + }, + "operationId": "ScheduledActions_Run", + "title": "ScheduledActionSendNow" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/scheduledActions/scheduledAction-sendNow-shared.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/scheduledActions/scheduledAction-sendNow-shared.json new file mode 100644 index 000000000000..0bf9ac7dd58b --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/scheduledActions/scheduledAction-sendNow-shared.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "name": "monthlyCostByResource", + "api-version": "2025-03-01", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": {} + }, + "operationId": "ScheduledActions_RunByScope", + "title": "ScheduledActionRunByScope" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/scheduledActions/scheduledActions-list-private.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/scheduledActions/scheduledActions-list-private.json new file mode 100644 index 000000000000..5c5fc7996b77 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/scheduledActions/scheduledActions-list-private.json @@ -0,0 +1,91 @@ +{ + "parameters": { + "api-version": "2025-03-01" + }, + "responses": { + "200": { + "body": { + "nextLink": null, + "value": [ + { + "name": "monthlyCostByResource", + "type": "Microsoft.CostManagement/ScheduledActions", + "eTag": "\"1d4ff9fe66f1d10\"", + "id": "/providers/Microsoft.CostManagement/scheduledActions/monthlyCostByResource", + "kind": "Email", + "properties": { + "displayName": "Monthly Cost By Resource", + "notification": { + "subject": "Cost by resource this month", + "to": [ + "user@gmail.com", + "team@gmail.com" + ] + }, + "schedule": { + "daysOfWeek": [ + "Monday" + ], + "endDate": "2021-06-19T22:21:51.1287144Z", + "frequency": "Monthly", + "hourOfDay": 10, + "startDate": "2020-06-19T22:21:51.1287144Z", + "weeksOfMonth": [ + "First", + "Third" + ] + }, + "scope": "", + "status": "Enabled", + "viewId": "/providers/Microsoft.CostManagement/views/swaggerExample" + }, + "systemData": { + "createdAt": "2020-06-18T22:21:51.1287144Z", + "createdBy": "testuser", + "createdByType": "User", + "lastModifiedAt": "2020-06-18T22:21:51.1287144Z", + "lastModifiedBy": "testuser", + "lastModifiedByType": "User" + } + }, + { + "name": "dailyCostByResource", + "type": "Microsoft.CostManagement/ScheduledActions", + "eTag": "\"1d4ff9fe66f1d15\"", + "id": "/providers/Microsoft.CostManagement/scheduledActions/dailyCostByResource", + "kind": "Email", + "properties": { + "displayName": "Daily Cost By Resource", + "notification": { + "subject": "Daily Cost By Resource", + "to": [ + "user@gmail.com", + "team@gmail.com" + ] + }, + "schedule": { + "endDate": "2021-06-19T22:21:51.1287144Z", + "frequency": "Daily", + "hourOfDay": 12, + "startDate": "2020-06-19T22:21:51.1287144Z" + }, + "scope": "", + "status": "Disabled", + "viewId": "/providers/Microsoft.CostManagement/views/swaggerExample" + }, + "systemData": { + "createdAt": "2020-06-18T22:21:51.1287144Z", + "createdBy": "testuser", + "createdByType": "User", + "lastModifiedAt": "2020-06-18T22:21:51.1287144Z", + "lastModifiedBy": "testuser", + "lastModifiedByType": "User" + } + } + ] + } + } + }, + "operationId": "ScheduledActions_List", + "title": "PrivateScheduledActionsList" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/scheduledActions/scheduledActions-list-shared.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/scheduledActions/scheduledActions-list-shared.json new file mode 100644 index 000000000000..33616467254a --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/scheduledActions/scheduledActions-list-shared.json @@ -0,0 +1,92 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/scheduledActions/monthlyCostByResource", + "name": "monthlyCostByResource", + "type": "Microsoft.CostManagement/ScheduledActions", + "kind": "Email", + "eTag": "\"1d4ff9fe66f1d10\"", + "systemData": { + "createdBy": "testuser", + "createdByType": "User", + "createdAt": "2020-06-18T22:21:51.1287144Z", + "lastModifiedBy": "testuser", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-06-18T22:21:51.1287144Z" + }, + "properties": { + "displayName": "Monthly Cost By Resource", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000", + "status": "Enabled", + "viewId": "/providers/Microsoft.CostManagement/views/swaggerExample", + "schedule": { + "frequency": "Monthly", + "weeksOfMonth": [ + "First", + "Third" + ], + "daysOfWeek": [ + "Monday" + ], + "hourOfDay": 10, + "startDate": "2020-06-19T22:21:51.1287144Z", + "endDate": "2021-06-19T22:21:51.1287144Z" + }, + "notification": { + "to": [ + "user@gmail.com", + "team@gmail.com" + ], + "subject": "Cost by resource this month" + } + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/scheduledActions/dailyCostByResource", + "name": "dailyCostByResource", + "type": "Microsoft.CostManagement/ScheduledActions", + "kind": "Email", + "eTag": "\"1d4ff9fe66f1d15\"", + "systemData": { + "createdBy": "testuser", + "createdByType": "User", + "createdAt": "2020-06-18T22:21:51.1287144Z", + "lastModifiedBy": "testuser", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-06-18T22:21:51.1287144Z" + }, + "properties": { + "displayName": "Daily Cost By Resource", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000", + "status": "Disabled", + "viewId": "/providers/Microsoft.CostManagement/views/swaggerExample", + "schedule": { + "frequency": "Daily", + "hourOfDay": 12, + "startDate": "2020-06-19T22:21:51.1287144Z", + "endDate": "2021-06-19T22:21:51.1287144Z" + }, + "notification": { + "to": [ + "user@gmail.com", + "team@gmail.com" + ], + "subject": "Daily Cost By Resource" + } + } + } + ], + "nextLink": null + } + } + }, + "operationId": "ScheduledActions_ListByScope", + "title": "ScheduledActionsListByScope" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/scheduledActions/scheduledActions-listWithFilter-private.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/scheduledActions/scheduledActions-listWithFilter-private.json new file mode 100644 index 000000000000..00bd7ca2e9c8 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/scheduledActions/scheduledActions-listWithFilter-private.json @@ -0,0 +1,92 @@ +{ + "parameters": { + "$filter": "properties/viewId eq '/providers/Microsoft.CostManagement/views/swaggerExample'", + "api-version": "2025-03-01" + }, + "responses": { + "200": { + "body": { + "nextLink": null, + "value": [ + { + "name": "monthlyCostByResource", + "type": "Microsoft.CostManagement/ScheduledActions", + "eTag": "\"1d4ff9fe66f1d10\"", + "id": "/providers/Microsoft.CostManagement/scheduledActions/monthlyCostByResource", + "kind": "Email", + "properties": { + "displayName": "Monthly Cost By Resource", + "notification": { + "subject": "Cost by resource this month", + "to": [ + "user@gmail.com", + "team@gmail.com" + ] + }, + "schedule": { + "daysOfWeek": [ + "Monday" + ], + "endDate": "2021-06-19T22:21:51.1287144Z", + "frequency": "Monthly", + "hourOfDay": 10, + "startDate": "2020-06-19T22:21:51.1287144Z", + "weeksOfMonth": [ + "First", + "Third" + ] + }, + "scope": "", + "status": "Enabled", + "viewId": "/providers/Microsoft.CostManagement/views/swaggerExample" + }, + "systemData": { + "createdAt": "2020-06-18T22:21:51.1287144Z", + "createdBy": "testuser", + "createdByType": "User", + "lastModifiedAt": "2020-06-18T22:21:51.1287144Z", + "lastModifiedBy": "testuser", + "lastModifiedByType": "User" + } + }, + { + "name": "dailyCostByResource", + "type": "Microsoft.CostManagement/ScheduledActions", + "eTag": "\"1d4ff9fe66f1d15\"", + "id": "/providers/Microsoft.CostManagement/scheduledActions/dailyCostByResource", + "kind": "Email", + "properties": { + "displayName": "Daily Cost By Resource", + "notification": { + "subject": "Daily Cost By Resource", + "to": [ + "user@gmail.com", + "team@gmail.com" + ] + }, + "schedule": { + "endDate": "2021-06-19T22:21:51.1287144Z", + "frequency": "Daily", + "hourOfDay": 12, + "startDate": "2020-06-19T22:21:51.1287144Z" + }, + "scope": "", + "status": "Disabled", + "viewId": "/providers/Microsoft.CostManagement/views/swaggerExample" + }, + "systemData": { + "createdAt": "2020-06-18T22:21:51.1287144Z", + "createdBy": "testuser", + "createdByType": "User", + "lastModifiedAt": "2020-06-18T22:21:51.1287144Z", + "lastModifiedBy": "testuser", + "lastModifiedByType": "User" + } + } + ] + } + } + }, + "operationId": "ScheduledActions_List", + "title": "PrivateScheduledActionsListFilterByViewId" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/scheduledActions/scheduledActions-listWithFilter-shared.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/scheduledActions/scheduledActions-listWithFilter-shared.json new file mode 100644 index 000000000000..e13be2c9ffa8 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/scheduledActions/scheduledActions-listWithFilter-shared.json @@ -0,0 +1,93 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000", + "$filter": "properties/viewId eq '/providers/Microsoft.CostManagement/views/swaggerExample'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/scheduledActions/monthlyCostByResource", + "name": "monthlyCostByResource", + "type": "Microsoft.CostManagement/ScheduledActions", + "kind": "Email", + "eTag": "\"1d4ff9fe66f1d10\"", + "systemData": { + "createdBy": "testuser", + "createdByType": "User", + "createdAt": "2020-06-18T22:21:51.1287144Z", + "lastModifiedBy": "testuser", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-06-18T22:21:51.1287144Z" + }, + "properties": { + "displayName": "Monthly Cost By Resource", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000", + "status": "Enabled", + "viewId": "/providers/Microsoft.CostManagement/views/swaggerExample", + "schedule": { + "frequency": "Monthly", + "weeksOfMonth": [ + "First", + "Third" + ], + "daysOfWeek": [ + "Monday" + ], + "hourOfDay": 10, + "startDate": "2020-06-19T22:21:51.1287144Z", + "endDate": "2021-06-19T22:21:51.1287144Z" + }, + "notification": { + "to": [ + "user@gmail.com", + "team@gmail.com" + ], + "subject": "Cost by resource this month" + } + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/scheduledActions/dailyCostByResource", + "name": "dailyCostByResource", + "type": "Microsoft.CostManagement/ScheduledActions", + "kind": "Email", + "eTag": "\"1d4ff9fe66f1d15\"", + "systemData": { + "createdBy": "testuser", + "createdByType": "User", + "createdAt": "2020-06-18T22:21:51.1287144Z", + "lastModifiedBy": "testuser", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-06-18T22:21:51.1287144Z" + }, + "properties": { + "displayName": "Daily Cost By Resource", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000", + "status": "Disabled", + "viewId": "/providers/Microsoft.CostManagement/views/swaggerExample", + "schedule": { + "frequency": "Daily", + "hourOfDay": 12, + "startDate": "2020-06-19T22:21:51.1287144Z", + "endDate": "2021-06-19T22:21:51.1287144Z" + }, + "notification": { + "to": [ + "user@gmail.com", + "team@gmail.com" + ], + "subject": "Daily Cost By Resource" + } + } + } + ], + "nextLink": null + } + } + }, + "operationId": "ScheduledActions_ListByScope", + "title": "ScheduledActionsListByScopeFilterByViewId" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/setting-delete.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/setting-delete.json new file mode 100644 index 000000000000..58ed1b269af9 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/setting-delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "type": "taginheritance", + "api-version": "2025-03-01", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": {}, + "204": {} + }, + "operationId": "Settings_DeleteByScope", + "title": "SettingDeleteByScope" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/setting-get.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/setting-get.json new file mode 100644 index 000000000000..e4cea79dd5fe --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/setting-get.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "type": "taginheritance", + "api-version": "2025-03-01", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "taginheritance", + "type": "Microsoft.CostManagement/Settings", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/settings/taginheritance", + "kind": "taginheritance", + "properties": { + "preferContainerTags": false + } + } + } + }, + "operationId": "Settings_GetByScope", + "title": "SettingByScope" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/settings-createOrUpdate.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/settings-createOrUpdate.json new file mode 100644 index 000000000000..e2ed25e1f11b --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/settings-createOrUpdate.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "type": "taginheritance", + "api-version": "2025-03-01", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000", + "setting": { + "kind": "taginheritance", + "properties": { + "preferContainerTags": false + } + } + }, + "responses": { + "200": { + "body": { + "name": "taginheritance", + "type": "Microsoft.CostManagement/Settings", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/settings/taginheritance", + "kind": "taginheritance", + "properties": { + "preferContainerTags": false + } + } + }, + "201": { + "body": { + "name": "taginheritance", + "type": "Microsoft.CostManagement/Settings", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/settings/taginheritance", + "kind": "taginheritance", + "properties": { + "preferContainerTags": false + } + } + } + }, + "operationId": "Settings_CreateOrUpdateByScope", + "title": "CreateOrUpdateSettingByScope" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/settingsList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/settingsList.json new file mode 100644 index 000000000000..f59ce3fd2377 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/examples/2025-03-01/settingsList.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "taginheritance", + "type": "Microsoft.CostManagement/Settings", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/settings/taginheritance", + "kind": "taginheritance", + "properties": { + "preferContainerTags": false + } + } + ] + } + } + }, + "operationId": "Settings_List", + "title": "SettingsList" +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/main.tsp b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/main.tsp new file mode 100644 index 000000000000..b51464c977c1 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/main.tsp @@ -0,0 +1,56 @@ +/** + * PLEASE DO NOT REMOVE - USED FOR CONVERTER METRICS + * Generated by package: @autorest/openapi-to-typespec + * Parameters used: + * isFullCompatible: true + * guessResourceKey: false + * Version: 0.11.5 + * Date: 2025-08-29T08:07:29.469Z + */ +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "./models.tsp"; +import "./back-compatible.tsp"; +import "./CostAllocationRuleDefinition.tsp"; +import "./Budget.tsp"; +import "./Export.tsp"; +import "./GenerateDetailedCostReportOperationResult.tsp"; +import "./GenerateDetailedCostReportOperationStatuses.tsp"; +import "./View.tsp"; +import "./Alert.tsp"; +import "./ScheduledAction.tsp"; +import "./Setting.tsp"; +import "./routes.tsp"; + +using TypeSpec.Rest; +using TypeSpec.Http; +using Azure.ResourceManager.Foundations; +using Azure.Core; +using Azure.ResourceManager; +using TypeSpec.Versioning; +/** + * CostManagement management client provides access to CostManagement resources for Azure Enterprise Subscriptions. + */ +@armProviderNamespace +@service(#{ title: "CostManagementClient" }) +@versioned(Versions) +@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) +namespace Microsoft.CostManagement; + +/** + * The available API versions. + */ +enum Versions { + /** + * The 2025-03-01 API version. + */ + v2025_03_01: "2025-03-01", +} + +interface Operations + extends Azure.ResourceManager.Legacy.Operations< + ArmResponse, + ErrorResponse + > {} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/models.tsp b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/models.tsp new file mode 100644 index 000000000000..9e83012cf64e --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/models.tsp @@ -0,0 +1,4782 @@ +import "@typespec/rest"; +import "@typespec/http"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; + +using TypeSpec.Rest; +using TypeSpec.Http; +using Azure.Core; +using Azure.ResourceManager; +using Azure.ResourceManager.Foundations; + +namespace Microsoft.CostManagement; + +/** + * The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" + */ +union Origin { + string, + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + user: "user", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + system: "system", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + `user,system`: "user,system", +} + +/** + * Enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. + */ +union ActionType { + string, + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + Internal: "Internal", +} + +/** + * Category of resource to use for allocation. + */ +union CostAllocationResourceType { + string, + + /** + * Indicates an Azure dimension such as a subscription id or resource group name is being used for allocation. + */ + Dimension: "Dimension", + + /** + * Allocates cost based on Azure Tag key value pairs. + */ + Tag: "Tag", +} + +/** + * Method to use for allocating cost. FixedProportion indicates that cost will be split based on specified percentage values. + */ +union CostAllocationPolicyType { + string, + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + FixedProportion: "FixedProportion", +} + +/** + * Current status of the rule. + */ +union RuleStatus { + string, + + /** + * Rule is saved but not used to allocate costs. + */ + NotActive: "NotActive", + + /** + * Rule is saved and impacting cost allocation. + */ + Active: "Active", + + /** + * Rule is saved and cost allocation is being updated. Readonly value that cannot be submitted in a put request. + */ + Processing: "Processing", +} + +/** + * The reason this name is not available. + */ +union Reason { + string, + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + Invalid: "Invalid", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + AlreadyExists: "AlreadyExists", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + Valid: "Valid", +} + +/** + * The number of days used to look back. + */ +union LookBackPeriod { + string, + + /** + * 7 days used to look back. + */ + Last7Days: "Last7Days", + + /** + * 30 days used to look back. + */ + Last30Days: "Last30Days", + + /** + * 60 days used to look back. + */ + Last60Days: "Last60Days", +} + +/** + * Grain which corresponds to value. + */ +union Grain { + string, + + /** + * Hourly grain corresponds to value per hour. + */ + Hourly: "Hourly", + + /** + * Hourly grain corresponds to value per day. + */ + Daily: "Daily", + + /** + * Hourly grain corresponds to value per month. + */ + Monthly: "Monthly", +} + +/** + * Grain which corresponds to value. + */ +union Term { + string, + + /** + * Benefit term is 1 year. + */ + P1Y: "P1Y", + + /** + * Benefit term is 3 years. + */ + P3Y: "P3Y", +} + +/** + * Kind of the recommendation scope. + */ +union Scope { + string, + + /** + * Single scope recommendation. + */ + Single: "Single", + + /** + * Shared scope recommendation. + */ + Shared: "Shared", +} + +/** + * Kind/type of the benefit. + */ +union BenefitKind { + string, + + /** + * Benefit is IncludedQuantity. + */ + IncludedQuantity: "IncludedQuantity", + + /** + * Benefit is Reservation. + */ + Reservation: "Reservation", + + /** + * Benefit is SavingsPlan. + */ + SavingsPlan: "SavingsPlan", +} + +#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +union GrainParameter { + string, + + /** + * Hourly grain corresponds to value per hour. + */ + Hourly: "Hourly", + + /** + * Hourly grain corresponds to value per day. + */ + Daily: "Daily", + + /** + * Hourly grain corresponds to value per month. + */ + Monthly: "Monthly", +} + +/** + * Enum representing the status of an async operation. + */ +union OperationStatusType { + string, + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + Running: "Running", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + Completed: "Completed", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + Failed: "Failed", +} + +/** + * 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. + */ +union BenefitUtilizationSummaryReportSchema { + string, + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + Kind: "Kind", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + AvgUtilizationPercentage: "AvgUtilizationPercentage", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + BenefitOrderId: "BenefitOrderId", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + BenefitId: "BenefitId", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + BenefitType: "BenefitType", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + MaxUtilizationPercentage: "MaxUtilizationPercentage", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + MinUtilizationPercentage: "MinUtilizationPercentage", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + UsageDate: "UsageDate", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + UtilizedPercentage: "UtilizedPercentage", +} + +/** + * The category of the budget. + * - 'Cost' defines a Budget. + * - 'ReservationUtilization' defines a Reservation Utilization Alert Rule. + */ +union CategoryType { + string, + + /** + * A Budget that evaluates monetary cost of Azure resources against an amount, and alerts based on a configured notification threshold. + */ + Cost: "Cost", + + /** + * An Alert Rule that evaluates the utilization percentage of Azure Reservations, and alerts based on a configured notification threshold. + */ + ReservationUtilization: "ReservationUtilization", +} + +/** + * The time covered by a budget. Tracking of the amount will be reset based on the time grain. + * + * Supported for CategoryType(s): Cost, ReservationUtilization. + * + * Supported timeGrainTypes for **CategoryType: Cost** + * + * - Monthly + * - Quarterly + * - Annually + * - BillingMonth* + * - BillingQuarter* + * - BillingAnnual* + * + * *only supported for Web Direct customers. + * + * Supported timeGrainTypes for **CategoryType: ReservationUtilization** + * - Last7Days + * - Last30Days + * + * Required for CategoryType(s): Cost, ReservationUtilization. + */ +union TimeGrainType { + string, + + /** + * The budget will track costs in the current calendar month against the amount. + * + * Supported for CategoryType: Cost only. + */ + Monthly: "Monthly", + + /** + * The budget will track costs in the current calendar quarter against the amount. + * + * Supported for CategoryType: Cost only. + */ + Quarterly: "Quarterly", + + /** + * The budget will track costs in the current calendar year against the amount. + * + * Supported for CategoryType: Cost only. + */ + Annually: "Annually", + + /** + * The budget will track costs in the current billing month against the amount. + * + * Supported for CategoryType: Cost and Web Direct customers only. + */ + BillingMonth: "BillingMonth", + + /** + * The budget will track costs in the current billing quarter against the amount. + * + * Supported for CategoryType: Cost and Web Direct customers only. + */ + BillingQuarter: "BillingQuarter", + + /** + * The budget will track costs in the current billing year against the amount. + * + * Supported for CategoryType: Cost and Web Direct customers only. + */ + BillingAnnual: "BillingAnnual", + + /** + * The Reservation Utilization Alert Rule will evaluate reservations based on their 7-Day utilization percentage. + * + * Supported for CategoryType: ReservationUtilization only. + */ + Last7Days: "Last7Days", + + /** + * The Reservation Utilization Alert Rule will evaluate reservations based on their 30-Day utilization percentage. + * + * Supported for CategoryType: ReservationUtilization only. + */ + Last30Days: "Last30Days", +} + +/** + * The operator to use for comparison. + */ +union BudgetOperatorType { + string, + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + In: "In", +} + +/** + * The comparison operator. + * + * Supported for CategoryType(s): Cost, ReservationUtilization. + * + * Supported operators for **CategoryType: Cost** + * - GreaterThan + * - GreaterThanOrEqualTo + * + * Supported operators for **CategoryType: ReservationUtilization** + * - LessThan + */ +union BudgetNotificationOperatorType { + string, + + /** + * 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. + * + * Supported for CategoryType(s): Cost. + */ + EqualTo: "EqualTo", + + /** + * Notification will be triggered if the evaluated cost is greater than the threshold value. Note: This is the recommended OperatorType while configuring Budget Alert. + * + * Supported for CategoryType(s): Cost. + */ + GreaterThan: "GreaterThan", + + /** + * Notification will be triggered if the evaluated cost is greater than or equal to the threshold value. + * + * Supported for CategoryType(s): Cost. + */ + GreaterThanOrEqualTo: "GreaterThanOrEqualTo", + + /** + * Notification will be triggered if any Reservations in the scope of the Reservation Utilization Alert Rule have a utilization less than the threshold percentage. + * + * Supported for CategoryType(s): ReservationUtilization. + */ + LessThan: "LessThan", +} + +/** + * 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). + * + * Supported for CategoryType(s): ReservationUtilization. + */ +union Frequency { + string, + + /** + * After the threshold breaches and an Alert is fired, no further alerts will be sent until the next calendar day. + */ + Daily: "Daily", + + /** + * After the threshold breaches and an Alert is fired, no further alerts will be sent for 7 calendar days. + */ + Weekly: "Weekly", + + /** + * After the threshold breaches and an Alert is fired, no further alerts will be sent for 30 calendar days. + */ + Monthly: "Monthly", +} + +/** + * The type of threshold. + * + * Supported for CategoryType(s): Cost. + */ +union ThresholdType { + string, + + /** + * Actual costs budget alerts notify when the actual accrued cost exceeds the allocated budget. + */ + Actual: "Actual", + + /** + * 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. + */ + Forecasted: "Forecasted", +} + +/** + * Language in which the recipient will receive the notification, + * + * Supported for CategoryType(s): Cost, ReservationUtilization. + */ +union CultureCode { + string, + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + `en-us`: "en-us", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + `ja-jp`: "ja-jp", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + `zh-cn`: "zh-cn", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + `de-de`: "de-de", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + `es-es`: "es-es", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + `fr-fr`: "fr-fr", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + `it-it`: "it-it", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + `ko-kr`: "ko-kr", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + `pt-br`: "pt-br", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + `ru-ru`: "ru-ru", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + `zh-tw`: "zh-tw", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + `cs-cz`: "cs-cz", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + `pl-pl`: "pl-pl", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + `tr-tr`: "tr-tr", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + `da-dk`: "da-dk", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + `en-gb`: "en-gb", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + `hu-hu`: "hu-hu", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + `nb-no`: "nb-no", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + `nl-nl`: "nl-nl", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + `pt-pt`: "pt-pt", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + `sv-se`: "sv-se", +} + +/** + * 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. + */ +union StatusType { + string, + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + Active: "Active", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + Inactive: "Inactive", +} + +/** + * The schedule recurrence. + */ +union RecurrenceType { + string, + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + Daily: "Daily", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + Weekly: "Weekly", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + Monthly: "Monthly", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + Annually: "Annually", +} + +/** + * The format of the export being delivered. + */ +union FormatType { + string, + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + Csv: "Csv", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + Parquet: "Parquet", +} + +/** + * The export delivery destination type. Currently only 'AzureBlob' is supported. + */ +union DestinationType { + string, + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + AzureBlob: "AzureBlob", +} + +/** + * 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. + */ +union ExportType { + string, + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + Usage: "Usage", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + ActualCost: "ActualCost", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + AmortizedCost: "AmortizedCost", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + FocusCost: "FocusCost", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + PriceSheet: "PriceSheet", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + ReservationTransactions: "ReservationTransactions", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + ReservationRecommendations: "ReservationRecommendations", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + ReservationDetails: "ReservationDetails", +} + +/** + * The time frame for pulling data for the export. If custom, then a specific time period must be provided. + */ +union TimeframeType { + string, + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + MonthToDate: "MonthToDate", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + BillingMonthToDate: "BillingMonthToDate", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + TheLastMonth: "TheLastMonth", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + TheLastBillingMonth: "TheLastBillingMonth", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + WeekToDate: "WeekToDate", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + Custom: "Custom", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + TheCurrentMonth: "TheCurrentMonth", +} + +/** + * The granularity of rows in the export. Currently 'Daily' is supported for most cases. + */ +union GranularityType { + string, + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + Daily: "Daily", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + Monthly: "Monthly", +} + +/** + * The name of the filter. This is currently only supported for Export Definition type of ReservationRecommendations. Supported names are ['ReservationScope', 'LookBackPeriod', 'ResourceType'] + */ +union FilterItemNames { + string, + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + ReservationScope: "ReservationScope", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + ResourceType: "ResourceType", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + LookBackPeriod: "LookBackPeriod", +} + +/** + * The type of the export run. + */ +union ExecutionType { + string, + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + OnDemand: "OnDemand", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + Scheduled: "Scheduled", +} + +/** + * The last known status of the export run. + */ +union ExecutionStatus { + string, + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + Queued: "Queued", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + InProgress: "InProgress", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + Completed: "Completed", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + Failed: "Failed", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + Timeout: "Timeout", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + NewDataNotAvailable: "NewDataNotAvailable", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + DataNotAvailable: "DataNotAvailable", +} + +/** + * 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. + */ +union DataOverwriteBehaviorType { + string, + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + OverwritePreviousReport: "OverwritePreviousReport", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + CreateNewReport: "CreateNewReport", +} + +/** + * 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. + */ +union CompressionModeType { + string, + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + gzip: "gzip", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + snappy: "snappy", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + none: "none", +} + +/** + * The type of the detailed report. By default ActualCost is provided + */ +union CostDetailsMetricType { + string, + + /** + * Actual cost data. + */ + ActualCostCostDetailsMetricType: "ActualCost", + + /** + * Amortized cost data. + */ + AmortizedCostCostDetailsMetricType: "AmortizedCost", +} + +/** + * The status of the cost details operation + */ +union CostDetailsStatusType { + string, + + /** + * Operation is Completed. + */ + CompletedCostDetailsStatusType: "Completed", + + /** + * Operation is Completed and no cost data found. + */ + NoDataFoundCostDetailsStatusType: "NoDataFound", + + /** + * Operation Failed. + */ + FailedCostDetailsStatusType: "Failed", +} + +/** + * The data format of the report + */ +union CostDetailsDataFormat { + string, + + /** + * Csv data format. + */ + CsvCostDetailsDataFormat: "Csv", +} + +/** + * The type of the detailed report. By default ActualCost is provided + */ +union GenerateDetailedCostReportMetricType { + string, + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + ActualCost: "ActualCost", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + AmortizedCost: "AmortizedCost", +} + +/** + * The status of the long running operation. + */ +union ReportOperationStatusType { + string, + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + InProgress: "InProgress", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + Completed: "Completed", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + Failed: "Failed", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + Queued: "Queued", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + NoDataFound: "NoDataFound", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + ReadyToDownload: "ReadyToDownload", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + TimedOut: "TimedOut", +} + +/** + * 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. + */ +union ReportType { + string, + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + Usage: "Usage", +} + +/** + * The time frame for pulling data for the report. If custom, then a specific time period must be provided. + */ +union ReportTimeframeType { + string, + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + WeekToDate: "WeekToDate", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + MonthToDate: "MonthToDate", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + YearToDate: "YearToDate", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + Custom: "Custom", +} + +/** + * The granularity of rows in the report. + */ +union ReportGranularityType { + string, + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + Daily: "Daily", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + Monthly: "Monthly", +} + +/** + * The name of the aggregation function to use. + */ +union FunctionType { + string, + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + Sum: "Sum", +} + +/** + * The type of the column in the report. + */ +union QueryColumnType { + string, + + /** + * The tag associated with the cost data. + */ + TagKey: "TagKey", + + /** + * The dimension of cost data. + */ + Dimension: "Dimension", +} + +/** + * Direction of sort. + */ +union ReportConfigSortingType { + string, + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + Ascending: "Ascending", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + Descending: "Descending", +} + +/** + * The operator to use for comparison. + */ +union OperatorType { + string, + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + In: "In", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + Contains: "Contains", +} + +/** + * Chart type of the main view in Cost Analysis. Required. + */ +union ChartType { + string, + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + Area: "Area", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + Line: "Line", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + StackedColumn: "StackedColumn", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + GroupedColumn: "GroupedColumn", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + Table: "Table", +} + +/** + * Show costs accumulated over time. + */ +union AccumulatedType { + string, + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + `true`: "true", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + `false`: "false", +} + +/** + * Metric to use when displaying costs. + */ +union MetricType { + string, + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + ActualCost: "ActualCost", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + AmortizedCost: "AmortizedCost", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + AHUB: "AHUB", +} + +/** + * KPI type (Forecast, Budget). + */ +union KpiTypeType { + string, + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + Forecast: "Forecast", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + Budget: "Budget", +} + +/** + * Data type to show in view. + */ +union PivotTypeType { + string, + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + Dimension: "Dimension", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + TagKey: "TagKey", +} + +/** + * type of alert + */ +union AlertType { + string, + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + Budget: "Budget", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + Invoice: "Invoice", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + Credit: "Credit", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + Quota: "Quota", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + General: "General", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + xCloud: "xCloud", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + BudgetForecast: "BudgetForecast", +} + +/** + * Alert category + */ +union AlertCategory { + string, + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + Cost: "Cost", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + Usage: "Usage", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + Billing: "Billing", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + System: "System", +} + +/** + * Criteria that triggered alert + */ +union AlertCriteria { + string, + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + CostThresholdExceeded: "CostThresholdExceeded", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + UsageThresholdExceeded: "UsageThresholdExceeded", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + CreditThresholdApproaching: "CreditThresholdApproaching", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + CreditThresholdReached: "CreditThresholdReached", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + QuotaThresholdApproaching: "QuotaThresholdApproaching", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + QuotaThresholdReached: "QuotaThresholdReached", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + MultiCurrency: "MultiCurrency", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + ForecastCostThresholdExceeded: "ForecastCostThresholdExceeded", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + ForecastUsageThresholdExceeded: "ForecastUsageThresholdExceeded", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + InvoiceDueDateApproaching: "InvoiceDueDateApproaching", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + InvoiceDueDateReached: "InvoiceDueDateReached", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + CrossCloudNewDataAvailable: "CrossCloudNewDataAvailable", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + CrossCloudCollectionError: "CrossCloudCollectionError", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + GeneralThresholdError: "GeneralThresholdError", +} + +/** + * Source of alert + */ +union AlertSource { + string, + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + Preset: "Preset", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + User: "User", +} + +/** + * Type of timegrain cadence + */ +union AlertTimeGrainType { + string, + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + None: "None", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + Monthly: "Monthly", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + Quarterly: "Quarterly", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + Annually: "Annually", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + BillingMonth: "BillingMonth", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + BillingQuarter: "BillingQuarter", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + BillingAnnual: "BillingAnnual", +} + +/** + * operator used to compare currentSpend with amount + */ +union AlertOperator { + string, + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + None: "None", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + EqualTo: "EqualTo", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + GreaterThan: "GreaterThan", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + GreaterThanOrEqualTo: "GreaterThanOrEqualTo", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + LessThan: "LessThan", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + LessThanOrEqualTo: "LessThanOrEqualTo", +} + +/** + * alert status + */ +union AlertStatus { + string, + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + None: "None", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + Active: "Active", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + Overridden: "Overridden", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + Resolved: "Resolved", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + Dismissed: "Dismissed", +} + +#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +union ExternalCloudProviderType { + string, + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + externalSubscriptions: "externalSubscriptions", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + externalBillingAccounts: "externalBillingAccounts", +} + +/** + * The type of the forecast. + */ +union ForecastType { + string, + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + Usage: "Usage", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + ActualCost: "ActualCost", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + AmortizedCost: "AmortizedCost", +} + +/** + * The time frame for pulling data for the forecast. + */ +union ForecastTimeframe { + string, + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + Custom: "Custom", +} + +/** + * The name of the column to aggregate. + */ +union FunctionName { + string, + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + PreTaxCostUSD: "PreTaxCostUSD", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + Cost: "Cost", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + CostUSD: "CostUSD", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + PreTaxCost: "PreTaxCost", +} + +/** + * The operator to use for comparison. + */ +union ForecastOperatorType { + string, + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + In: "In", +} + +/** + * The operator to use for comparison. + */ +union QueryOperatorType { + string, + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + In: "In", +} + +/** + * The CSV file from the reportUrl blob link consists of reservation usage data with the following schema at daily granularity + */ +union ReservationReportSchema { + string, + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + InstanceFlexibilityGroup: "InstanceFlexibilityGroup", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + InstanceFlexibilityRatio: "InstanceFlexibilityRatio", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + InstanceId: "InstanceId", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + Kind: "Kind", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + ReservationId: "ReservationId", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + ReservationOrderId: "ReservationOrderId", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + ReservedHours: "ReservedHours", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + SkuName: "SkuName", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + TotalReservedQuantity: "TotalReservedQuantity", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + UsageDate: "UsageDate", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + UsedHours: "UsedHours", +} + +/** + * Destination of the view data. Currently only CSV format is supported. + */ +union FileFormat { + string, + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + Csv: "Csv", +} + +/** + * Frequency of the schedule. + */ +union ScheduleFrequency { + string, + + /** + * Cost analysis data will be emailed every day. + */ + Daily: "Daily", + + /** + * Cost analysis data will be emailed every week. + */ + Weekly: "Weekly", + + /** + * Cost analysis data will be emailed every month. + */ + Monthly: "Monthly", +} + +/** + * Days of Week. + */ +union DaysOfWeek { + string, + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + Monday: "Monday", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + Tuesday: "Tuesday", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + Wednesday: "Wednesday", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + Thursday: "Thursday", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + Friday: "Friday", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + Saturday: "Saturday", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + Sunday: "Sunday", +} + +/** + * Weeks of month. + */ +union WeeksOfMonth { + string, + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + First: "First", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + Second: "Second", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + Third: "Third", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + Fourth: "Fourth", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + Last: "Last", +} + +/** + * Status of the scheduled action. + */ +union ScheduledActionStatus { + string, + + /** + * Scheduled action is saved and will be run. + */ + Enabled: "Enabled", + + /** + * Scheduled action is expired. + */ + Expired: "Expired", + + /** + * Scheduled action is saved but will not be run. + */ + Disabled: "Disabled", +} + +/** + * Kind of the scheduled action. + */ +union ScheduledActionKind { + string, + + /** + * Cost analysis data will be emailed. + */ + Email: "Email", + + /** + * 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. + */ + InsightAlert: "InsightAlert", +} + +/** + * The type of identity that created the resource. + */ +union CreatedByType { + string, + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + User: "User", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + Application: "Application", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + ManagedIdentity: "ManagedIdentity", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + Key: "Key", +} + +/** + * The reason why the given name is not available. + */ +union CheckNameAvailabilityReason { + string, + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + Invalid: "Invalid", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + AlreadyExists: "AlreadyExists", +} + +/** + * Specifies the kind of settings. + */ +union SettingsKind { + string, + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + taginheritance: "taginheritance", +} + +#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +union SettingType { + string, + + /** + * This setting applies billing profile, invoice section, subscription and resource group tags to current month's usage data of child resources. + */ + taginheritance: "taginheritance", +} + +/** + * A Cost management REST API operation. + */ +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model CostManagementOperation + extends Azure.ResourceManager.CommonTypes.Operation { + /** + * Operation id: {provider}/{resource}/{operation}. + */ + @visibility(Lifecycle.Read) + id?: string; +} + +/** + * Result of listing cost allocation rules. It contains a list of available rules in the billing account or enterprise enrollment provided. + */ +model CostAllocationRuleList { + /** + * The list of cost allocation rules. + */ + @pageItems + @identifiers(#["id"]) + value?: CostAllocationRuleDefinition[]; + + /** + * URL to get the next set of rule list results if there are any. + */ + @nextLink + nextLink?: string; +} + +/** + * The properties of a cost allocation rule + */ +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model CostAllocationRuleProperties { + /** + * Description of a cost allocation rule. + */ + description?: string; + + /** + * Resource information for the cost allocation rule + */ + details: CostAllocationRuleDetails; + + /** + * Status of the rule + */ + status: RuleStatus; + + /** + * Time at which the rule was created. Rules that change cost for the same resource are applied in order of creation. + */ + @visibility(Lifecycle.Read) + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + createdDate?: utcDateTime; + + /** + * Time at which the rule was last updated. + */ + @visibility(Lifecycle.Read) + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + updatedDate?: utcDateTime; +} + +/** + * Resource details of the cost allocation rule + */ +model CostAllocationRuleDetails { + /** + * Source resources for cost allocation. At this time, this list can contain no more than one element. + */ + @identifiers(#["name"]) + sourceResources?: SourceCostAllocationResource[]; + + /** + * Target resources for cost allocation. At this time, this list can contain no more than one element. + */ + @identifiers(#["name"]) + targetResources?: TargetCostAllocationResource[]; +} + +/** + * Source resources for cost allocation + */ +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model SourceCostAllocationResource extends CostAllocationResource { + /** + * Source Resources for cost allocation. This list cannot contain more than 25 values. + */ + values: string[]; +} + +/** + * Common values for resources for cost allocation + */ +model CostAllocationResource { + /** + * Type of resources contained in this cost allocation rule + */ + resourceType: CostAllocationResourceType; + + /** + * If resource type is dimension, this must be either ResourceGroupName or SubscriptionId. If resource type is tag, this must be a valid Azure tag + */ + name: string; +} + +/** + * Target resources for cost allocation. + */ +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model TargetCostAllocationResource extends CostAllocationResource { + /** + * Target resources for cost allocation. This list cannot contain more than 25 values. + */ + @identifiers(#["name"]) + values: CostAllocationProportion[]; + + /** + * Method of cost allocation for the rule + */ + policyType: CostAllocationPolicyType; +} + +/** + * Target resources and allocation + */ +model CostAllocationProportion { + /** + * Target resource for cost allocation + */ + name: string; + + /** + * 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. + */ + percentage: float32; +} + +/** + * The cost allocation rule check name availability request + */ +model CostAllocationRuleCheckNameAvailabilityRequest { + /** + * Rule name + */ + name?: string; + + /** + * Resource type. This is expected to be Microsoft.CostManagement/costAllocationRules + */ + type?: string; +} + +/** + * The cost allocation rule check name availability response + */ +model CostAllocationRuleCheckNameAvailabilityResponse { + /** + * Whether this rule name is available + */ + nameAvailable?: boolean; + + /** + * The reason this name is not available + */ + reason?: Reason; + + /** + * Error message if the name is not available + */ + message?: string; +} + +/** + * benefit plan recommendation details. + */ +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model BenefitRecommendationModel extends BenefitResource { + /** + * The properties of the benefit recommendations. + */ + properties?: BenefitRecommendationProperties; +} + +/** + * The properties of the benefit recommendations. + */ +@discriminator("scope") +model BenefitRecommendationProperties { + /** + * The first usage date used for looking back for computing the recommendations. + */ + @visibility(Lifecycle.Read) + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + firstConsumptionDate?: utcDateTime; + + /** + * The last usage date used for looking back for computing the recommendations. + */ + @visibility(Lifecycle.Read) + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + lastConsumptionDate?: utcDateTime; + + /** + * The number of days of usage evaluated for computing the recommendations. + */ + lookBackPeriod?: LookBackPeriod; + + /** + * The total hours for which the cost is covered. Its equal to number of records in a property 'properties/usage/charges'. + */ + @visibility(Lifecycle.Read) + totalHours?: int32; + + /** + * On-demand charges between firstConsumptionDate and lastConsumptionDate that were used for computing benefit recommendations. + */ + usage?: RecommendationUsageDetails; + + /** + * ARM SKU name. 'Compute_Savings_Plan' for SavingsPlan. + */ + @visibility(Lifecycle.Read) + armSkuName?: string; + + /** + * Term period of the benefit. For example, P1Y or P3Y. + */ + term?: Term; + + /** + * Grain of the proposed commitment amount. Supported values: 'Hourly' + */ + commitmentGranularity?: Grain; + + /** + * An ISO 4217 currency code identifier for the costs and savings amounts. + */ + @visibility(Lifecycle.Read) + currencyCode?: string; + + /** + * The current cost without benefit, corresponds to 'totalHours' in the look-back period. + */ + #suppress "@azure-tools/typespec-azure-core/no-generic-numeric" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @visibility(Lifecycle.Read) + costWithoutBenefit?: decimal; + + /** + * The details of the proposed recommendation. + */ + recommendationDetails?: AllSavingsBenefitDetails; + + /** + * The list of all benefit recommendations with the recommendation details. + */ + @visibility(Lifecycle.Read) + allRecommendationDetails?: AllSavingsList; + + /** + * Benefit scope. For example, Single or Shared. + */ + scope: Scope; +} + +/** + * On-demand charges between firstConsumptionDate and lastConsumptionDate that were used for computing benefit recommendations. + */ +model RecommendationUsageDetails { + /** + * The grain of the usage. Supported values: 'Hourly' + */ + usageGrain?: Grain; + + /** + * On-demand charges for each hour between firstConsumptionDate and lastConsumptionDate that were used for computing benefit recommendations. + */ + @visibility(Lifecycle.Read) + charges?: decimal[]; +} + +/** + * Benefit recommendation details. + */ +model AllSavingsBenefitDetails { + /** + * The difference between total cost and benefit cost for the 'totalHours' in the look-back period. + */ + #suppress "@azure-tools/typespec-azure-core/no-generic-numeric" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @visibility(Lifecycle.Read) + overageCost?: decimal; + + /** + * The estimated cost with benefit for the 'totalHours' in the look-back period. It's equal to (commitmentAmount * totalHours) + */ + #suppress "@azure-tools/typespec-azure-core/no-generic-numeric" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @visibility(Lifecycle.Read) + benefitCost?: decimal; + + /** + * Total cost, which is sum of benefit cost and overage cost. + */ + #suppress "@azure-tools/typespec-azure-core/no-generic-numeric" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @visibility(Lifecycle.Read) + totalCost?: decimal; + + /** + * The amount saved for the 'totalHours' in the look-back period, by purchasing the recommended quantity of the benefit. + */ + #suppress "@azure-tools/typespec-azure-core/no-generic-numeric" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @visibility(Lifecycle.Read) + savingsAmount?: decimal; + + /** + * The savings in percentage for the 'totalHours' in the look-back period, by purchasing the recommended quantity of benefit. + */ + #suppress "@azure-tools/typespec-azure-core/no-generic-numeric" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @visibility(Lifecycle.Read) + savingsPercentage?: decimal; + + /** + * Estimated benefit coverage percentage for the 'totalHours' in the look-back period, with this commitment. + */ + #suppress "@azure-tools/typespec-azure-core/no-generic-numeric" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @visibility(Lifecycle.Read) + coveragePercentage?: decimal; + + /** + * The commitment amount at the commitmentGranularity. + */ + #suppress "@azure-tools/typespec-azure-core/no-generic-numeric" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @visibility(Lifecycle.Read) + commitmentAmount?: decimal; + + /** + * Estimated average utilization percentage for the 'totalHours' in the look-back period, with this commitment. + */ + #suppress "@azure-tools/typespec-azure-core/no-generic-numeric" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @visibility(Lifecycle.Read) + averageUtilizationPercentage?: decimal; + + /** + * Estimated unused portion of the 'benefitCost'. + */ + #suppress "@azure-tools/typespec-azure-core/no-generic-numeric" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @visibility(Lifecycle.Read) + wastageCost?: decimal; +} + +/** + * The list of all benefit recommendations with the recommendation details. + */ +model AllSavingsList { + /** + * The list of benefit recommendations with the recommendation details.. + */ + @visibility(Lifecycle.Read) + @identifiers(#[]) + value?: AllSavingsBenefitDetails[]; + + /** + * The link (URL) to the next page of results. + */ + @visibility(Lifecycle.Read) + nextLink?: url; +} + +/** + * The benefit resource model definition. + */ +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model BenefitResource extends Azure.ResourceManager.CommonTypes.Resource { + /** + * Reservation or SavingsPlan. + */ + kind?: BenefitKind; +} + +/** + * Benefit utilization summary resource. + */ +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@discriminator("kind") +model BenefitUtilizationSummary + extends Azure.ResourceManager.CommonTypes.Resource { + /** + * Supported values: 'SavingsPlan'. + */ + kind: BenefitKind; +} + +/** + * Properties of an async benefit utilization summaries request. + */ +model BenefitUtilizationSummariesRequest { + /** + * Billing account the benefit utilization summaries report is for. Required for billing account and billing profile scopes. Not supported for any benefit scopes. + */ + billingAccountId?: string; + + /** + * Billing profile id the benefit utilization summaries report is for. Required for billing profile scope. Not supported for billing account or any benefit scopes. + */ + billingProfileId?: string; + + /** + * Benefit order id the benefit utilization summaries report is for. Required for benefit order and benefit id scopes. Not supported for any billing scopes. + */ + benefitOrderId?: string; + + /** + * Benefit id the benefit utilization summaries report is for. Required for benefit id scope. Not supported for benefit order or any billing scopes. + */ + benefitId?: string; + + /** + * The grain the summaries data is served at in the report. Accepted values are 'Daily' or 'Monthly'. + */ + grain: Grain; + + /** + * The start date of the summaries data that will be served in the report. + */ + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + startDate: utcDateTime; + + /** + * The end date of the summaries data that will be served in the report. + */ + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + endDate: utcDateTime; + + /** + * 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 + */ + kind?: BenefitKind; +} + +/** + * Status of a benefit utilization summaries report. Provides Async Benefit Utilization Summaries Request input, status, and report sas url. + */ +model BenefitUtilizationSummariesOperationStatus { + /** + * Input given to create the benefit utilization summaries report. + */ + input?: BenefitUtilizationSummariesRequest; + + /** + * The status of the creation of the benefit utilization summaries report. + */ + status?: OperationStatusType; + + /** + * 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 + */ + properties?: AsyncOperationStatusProperties; +} + +/** + * Object representing the report url and valid until date of the async report generated. + */ +model AsyncOperationStatusProperties { + /** + * Sas url to the async benefit utilization summaries report. Will be empty if the report is in Running or Failed state. + */ + @secret + reportUrl?: BenefitUtilizationSummaryReportSchema; + + /** + * 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. + */ + @secret + secondaryReportUrl?: BenefitUtilizationSummaryReportSchema; + + /** + * The date that the sas url provided in reportUrl expires. + */ + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + validUntil?: utcDateTime; +} + +/** + * The properties of the budget. + */ +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model BudgetProperties { + /** + * The category of the budget. + * - 'Cost' defines a Budget. + * - 'ReservationUtilization' defines a Reservation Utilization Alert Rule. + */ + category: CategoryType; + + /** + * The total amount of cost to track with the budget. + * + * Supported for CategoryType(s): Cost. + * + * Required for CategoryType(s): Cost. + */ + amount?: float32; + + /** + * The time covered by a budget. Tracking of the amount will be reset based on the time grain. + * + * Supported for CategoryType(s): Cost, ReservationUtilization. + * + * Supported timeGrainTypes for **CategoryType: Cost** + * + * - Monthly + * - Quarterly + * - Annually + * - BillingMonth* + * - BillingQuarter* + * - BillingAnnual* + * + * *only supported for Web Direct customers. + * + * Supported timeGrainTypes for **CategoryType: ReservationUtilization** + * - Last7Days + * - Last30Days + * + * Required for CategoryType(s): Cost, ReservationUtilization. + */ + timeGrain: TimeGrainType; + + /** + * 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. + * + * Supported for CategoryType(s): Cost, ReservationUtilization. + * + * Required for CategoryType(s): Cost, ReservationUtilization. + */ + timePeriod: BudgetTimePeriod; + + /** + * May be used to filter budgets by user-specified dimensions and/or tags. + * + * Supported for CategoryType(s): Cost, ReservationUtilization. + */ + filter?: BudgetFilter; + + /** + * The current amount of cost which is being tracked for a budget. + * + * Supported for CategoryType(s): Cost. + */ + @visibility(Lifecycle.Read) + currentSpend?: CurrentSpend; + + /** + * Dictionary of notifications associated with the budget. + * + * Supported for CategoryType(s): Cost, ReservationUtilization. + * + * - Constraints for **CategoryType: Cost** - Budget can have up to 5 notifications with thresholdType: Actual and 5 notifications with thresholdType: Forecasted. + * - Constraints for **CategoryType: ReservationUtilization** - Only one notification allowed. thresholdType is not applicable. + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + notifications?: Record; + + /** + * The forecasted cost which is being tracked for a budget. + * + * Supported for CategoryType(s): Cost. + */ + @visibility(Lifecycle.Read) + forecastSpend?: ForecastSpend; +} + +/** + * 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. + * + * Supported for CategoryType(s): Cost, ReservationUtilization. + * + * Required for CategoryType(s): Cost, ReservationUtilization. + */ +model BudgetTimePeriod { + /** + * The start date for the budget. + * + * - 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. + * + * - Constraints for **CategoryType: ReservationUtilization** - Must be on or after the current date and less than the end date. + */ + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + startDate: utcDateTime; + + /** + * The end date for the budget. + * + * - Constraints for **CategoryType: Cost** - No constraints. If not provided, we default this to 10 years from the start date. + * + * - Constraints for **CategoryType: ReservationUtilization** - End date cannot be more than 3 years after the start date. + */ + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + endDate?: utcDateTime; +} + +/** + * May be used to filter budgets by user-specified dimensions and/or tags. + * + * Supported for CategoryType(s): Cost, ReservationUtilization. + */ +model BudgetFilter { + /** + * The logical "AND" expression. Must have at least 2 items. + * + * Supported for CategoryType(s): Cost. + */ + @identifiers(#[]) + @minItems(0) + and?: BudgetFilterProperties[]; + + /** + * Has comparison expression for a dimension. + * + * Supported for CategoryType(s): Cost, ReservationUtilization. + * + * Supported dimension names for **CategoryType: ReservationUtilization** + * - ReservationId + * - ReservedResourceType + */ + dimensions?: BudgetComparisonExpression; + + /** + * Has comparison expression for a tag. + * + * Supported for CategoryType(s): Cost. + */ + tags?: BudgetComparisonExpression; +} + +/** + * The Dimensions or Tags to filter a budget by. + * + * Supported for CategoryType(s): Cost, ReservationUtilization. + */ +model BudgetFilterProperties { + /** + * Has comparison expression for a dimension. + * + * Supported for CategoryType(s): Cost, ReservationUtilization. + * + * Supported dimension names for **CategoryType: ReservationUtilization** + * - ReservationId + * - ReservedResourceType + */ + dimensions?: BudgetComparisonExpression; + + /** + * Has comparison expression for a tag. + * + * Supported for CategoryType(s): Cost. + */ + tags?: BudgetComparisonExpression; +} + +/** + * The comparison expression to be used in the budgets. + */ +model BudgetComparisonExpression { + /** + * The name of the column to use in comparison. + */ + name: string; + + /** + * The operator to use for comparison. + */ + operator: BudgetOperatorType; + + /** + * Array of values to use for comparison + */ + @minItems(0) + values: string[]; +} + +/** + * The current amount of cost which is being tracked for a budget. + * + * Supported for CategoryType(s): Cost. + */ +model CurrentSpend { + /** + * The total amount of cost which is being tracked by the budget. + */ + @visibility(Lifecycle.Read) + amount?: float32; + + /** + * The unit of measure for the budget amount. + */ + @visibility(Lifecycle.Read) + unit?: string; +} + +/** + * The notification associated with a budget. + * + * Supported for CategoryType(s): Cost, ReservationUtilization. + */ +model Notification { + /** + * The notification is enabled or not. + * + * Supported for CategoryType(s): Cost, ReservationUtilization. + */ + enabled: boolean; + + /** + * The comparison operator. + * + * Supported for CategoryType(s): Cost, ReservationUtilization. + * + * Supported operators for **CategoryType: Cost** + * - GreaterThan + * - GreaterThanOrEqualTo + * + * Supported operators for **CategoryType: ReservationUtilization** + * - LessThan + */ + operator: BudgetNotificationOperatorType; + + /** + * Threshold value associated with a notification. It is always percent with a maximum of 2 decimal places. + * + * Supported for CategoryType(s): Cost, ReservationUtilization. + * + * **CategoryType: Cost** - Must be between 0 and 1000. Notification is sent when the cost exceeded the threshold. + * + * **CategoryType: ReservationUtilization** - Must be between 0 and 100. Notification is sent when a reservation has a utilization percentage below the threshold. + */ + threshold: float32; + + /** + * 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). + * + * Supported for CategoryType(s): ReservationUtilization. + */ + frequency?: Frequency; + + /** + * 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. + * + * Supported for CategoryType(s): Cost, ReservationUtilization. + */ + @minItems(0) + @maxItems(50) + contactEmails: string[]; + + /** + * Subscription or Resource Group scopes only. Contact roles to send the notification to when the threshold is breached. + * + * Supported for CategoryType(s): Cost. + */ + contactRoles?: string[]; + + /** + * 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. + * + * Supported for CategoryType(s): Cost. + */ + @minItems(0) + @maxItems(50) + contactGroups?: string[]; + + /** + * The type of threshold. + * + * Supported for CategoryType(s): Cost. + */ + thresholdType?: ThresholdType = ThresholdType.Actual; + + /** + * Language in which the recipient will receive the notification, + * + * Supported for CategoryType(s): Cost, ReservationUtilization. + */ + locale?: CultureCode; +} + +/** + * The forecasted cost which is being tracked for a budget. + * + * Supported for CategoryType(s): Cost. + */ +model ForecastSpend { + /** + * 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. + */ + @visibility(Lifecycle.Read) + amount?: float32; + + /** + * The unit of measure for the budget amount. + */ + @visibility(Lifecycle.Read) + unit?: string; +} + +/** + * The Resource model definition. + */ +model CostManagementProxyResource { + /** + * Resource Id. + */ + @visibility(Lifecycle.Read) + id?: string; + + /** + * Resource name. + */ + @visibility(Lifecycle.Read) + name?: string; + + /** + * Resource type. + */ + @visibility(Lifecycle.Read) + type?: string; + + /** + * 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. + */ + eTag?: string; +} + +/** + * Result of listing exports. It contains a list of available exports in the scope provided. + */ +model ExportListResult { + /** + * The list of exports. + */ + @pageItems + @visibility(Lifecycle.Read) + value?: Export[]; +} + +/** + * The properties of the export. + */ +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model ExportProperties extends CommonExportProperties { + /** + * Has schedule information for the export. + */ + schedule?: ExportSchedule; +} + +/** + * The schedule associated with the export. + */ +model ExportSchedule { + /** + * 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. + */ + status?: StatusType; + + /** + * The schedule recurrence. + */ + recurrence?: RecurrenceType; + + /** + * 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. + */ + recurrencePeriod?: ExportRecurrencePeriod; +} + +/** + * The start and end date for recurrence schedule. + */ +model ExportRecurrencePeriod { + /** + * The start date of recurrence. + */ + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + from: utcDateTime; + + /** + * The end date of recurrence. + */ + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + to?: utcDateTime; +} + +/** + * The common properties of the export. + */ +model CommonExportProperties { + /** + * The format of the export being delivered. + */ + format?: FormatType; + + /** + * Has delivery information for the export. + */ + deliveryInfo: ExportDeliveryInfo; + + /** + * Has the definition for the export. + */ + definition: ExportDefinition; + + /** + * If requested, has the most recent run history for the export. + */ + runHistory?: ExportExecutionListResult; + + /** + * If set to true, exported data will be partitioned by size and placed in a blob directory together with a manifest file. + */ + partitionData?: boolean; + + /** + * 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. + */ + dataOverwriteBehavior?: DataOverwriteBehaviorType; + + /** + * 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. + */ + compressionMode?: CompressionModeType; + + /** + * The export description set by customer at time of export creation/update. + */ + exportDescription?: string; + + /** + * If the export has an active schedule, provides an estimate of the next run time. + */ + @visibility(Lifecycle.Read) + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + nextRunTimeEstimate?: utcDateTime; + + /** + * The export suspension reason if export is in SystemSuspended state. This is not populated currently. + */ + @visibility(Lifecycle.Read) + systemSuspensionContext?: ExportSuspensionContext; +} + +/** + * The delivery information associated with a export. + */ +model ExportDeliveryInfo { + /** + * Has destination for the export being delivered. + */ + destination: ExportDeliveryDestination; +} + +/** + * 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 ). + */ +model ExportDeliveryDestination { + /** + * The export delivery destination type. Currently only 'AzureBlob' is supported. + */ + type?: DestinationType; + + /** + * The resource id of the storage account where exports will be delivered. This is not required if a sasToken and storageAccount are specified. + */ + resourceId?: string; + + /** + * The name of the container where exports will be uploaded. If the container does not exist it will be created. + */ + container: string; + + /** + * The name of the directory where exports will be uploaded. + */ + rootFolderPath?: string; + + /** + * 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. + */ + @secret + sasToken?: string; + + /** + * 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. + */ + storageAccount?: string; +} + +/** + * The definition of an export. + */ +model ExportDefinition { + /** + * 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. + */ + type: ExportType; + + /** + * The time frame for pulling data for the export. If custom, then a specific time period must be provided. + */ + timeframe: TimeframeType; + + /** + * Has time period for pulling data for the export. + */ + timePeriod?: ExportTimePeriod; + + /** + * The definition for data in the export. + */ + dataSet?: ExportDataset; +} + +/** + * 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. + */ +model ExportTimePeriod { + /** + * The start date for export data. + */ + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + from: utcDateTime; + + /** + * The end date for export data. + */ + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + to: utcDateTime; +} + +/** + * The definition for data in the export. + */ +model ExportDataset { + /** + * The granularity of rows in the export. Currently 'Daily' is supported for most cases. + */ + granularity?: GranularityType; + + /** + * The export dataset configuration. + */ + configuration?: ExportDatasetConfiguration; +} + +/** + * This is on path to deprecation and will not be supported going forward. + */ +model ExportDatasetConfiguration { + /** + * 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). + */ + columns?: string[]; + + /** + * The data version for the selected for the export. If not provided then the export will default to latest data version. + */ + dataVersion?: string; + + /** + * Filters associated with the data sets. + */ + @identifiers(#["name"]) + filters?: FilterItems[]; +} + +/** + * Will contain the filter name and value to operate on. This is currently only supported for Export Definition type of ReservationRecommendations. + */ +model FilterItems { + /** + * The name of the filter. This is currently only supported for Export Definition type of ReservationRecommendations. Supported names are ['ReservationScope', 'LookBackPeriod', 'ResourceType'] + */ + name?: FilterItemNames; + + /** + * 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']. + */ + value?: string; +} + +/** + * Result of listing the run history of an export. + */ +model ExportExecutionListResult { + /** + * A list of export runs. + */ + @visibility(Lifecycle.Read) + value?: ExportRun[]; +} + +/** + * An export run. + */ +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model ExportRun extends CostManagementProxyResource { + /** + * The properties of the export run. + */ + properties?: ExportRunProperties; +} + +/** + * The properties of the export run. + */ +model ExportRunProperties { + /** + * The type of the export run. + */ + executionType?: ExecutionType; + + /** + * The last known status of the export run. + */ + status?: ExecutionStatus; + + /** + * The identifier for the entity that triggered the export. For on-demand runs it is the user email. For scheduled runs it is 'System'. + */ + submittedBy?: string; + + /** + * The time when export was queued to be run. + */ + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + submittedTime?: utcDateTime; + + /** + * The time when export was picked up to be run. + */ + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + processingStartTime?: utcDateTime; + + /** + * The time when the export run finished. + */ + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + processingEndTime?: utcDateTime; + + /** + * The start datetime for the export. + */ + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + startDate?: utcDateTime; + + /** + * The end datetime for the export. + */ + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + endDate?: utcDateTime; + + /** + * The name of the exported file. + */ + fileName?: string; + + /** + * The manifest file location(URI location) for the exported files. + */ + manifestFile?: string; + + /** + * The export settings that were in effect for this run. + */ + runSettings?: CommonExportProperties; + + /** + * The details of any error. + */ + error?: ErrorDetails; +} + +/** + * The details of the error. + */ +model ErrorDetails { + /** + * Error code. + */ + @visibility(Lifecycle.Read) + code?: string; + + /** + * Error message indicating why the operation failed. + */ + @visibility(Lifecycle.Read) + message?: string; +} + +/** + * The properties of the export run. This is not populated currently. + */ +model ExportSuspensionContext { + /** + * The code for export suspension. + */ + suspensionCode?: string; + + /** + * The detailed reason for export suspension. + */ + suspensionReason?: string; + + /** + * The time when the export was suspended. + */ + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + suspensionTime?: utcDateTime; +} + +/** + * The export run request. + */ +model ExportRunRequest { + /** + * Has time period for pulling data for the export. + */ + timePeriod?: ExportTimePeriod; +} + +/** + * The definition of a cost detailed report. + */ +model GenerateCostDetailsReportRequestDefinition { + /** + * The type of the detailed report. By default ActualCost is provided + */ + metric?: CostDetailsMetricType; + + /** + * 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 + */ + timePeriod?: CostDetailsTimePeriod; + + /** + * 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. + */ + billingPeriod?: string; + + /** + * 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. + */ + invoiceId?: string; +} + +/** + * 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. + */ +model CostDetailsTimePeriod { + /** + * The start date to pull data from. example format 2020-03-15 + */ + start: string; + + /** + * The end date to pull data to. example format 2020-03-15 + */ + end: string; +} + +/** + * The manifest of the report generated by the operation. + */ +model ReportManifest { + /** + * The Manifest version. + */ + manifestVersion?: string; + + /** + * The data format of the report + */ + dataFormat?: CostDetailsDataFormat; + + /** + * The total number of bytes in all blobs. + */ + byteCount?: int64; + + /** + * The total number of blobs. + */ + blobCount?: int32; + + /** + * Is the data in compressed format. + */ + compressData?: boolean; + + /** + * The context of the Cost Details request. + */ + requestContext?: RequestContext; + + /** + * List of blob information generated by this operation. + */ + @identifiers(#["blobLink"]) + blobs?: BlobInfo[]; +} + +/** + * The context of the Cost Details request. + */ +model RequestContext { + /** + * The request scope of the request. + */ + requestScope?: string; + + /** + * The request payload body provided in Cost Details call + */ + requestBody?: GenerateCostDetailsReportRequestDefinition; +} + +/** + * The blob information generated by this operation. + */ +model BlobInfo { + /** + * Link to the blob to download file. + */ + blobLink?: string; + + /** + * Bytes in the blob. + */ + byteCount?: int64; +} + +/** + * Error response indicates that the service is not able to process the incoming request. The reason is provided in the error message. + * + * Some Error responses: + * + * * 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. + * + * * 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. + * + * * 400 Bad Request - Start date must be after . API only allows data to be pulled no older than 13 months from now. + * + * * 400 Bad Request - The maximum allowed date range is 1 months. API only allows data to be pulled for 1 month or less. + * + * * 429 TooManyRequests - Request is throttled. Retry after waiting for the time specified in the "retry-after" header. + * + * * 503 ServiceUnavailable - Service is temporarily unavailable. Retry after waiting for the time specified in the "Retry-After" header. + */ +@error +model GenerateCostDetailsReportErrorResponse { + /** + * The details of the error. + */ + error?: ErrorDetails; +} + +/** + * The definition of a cost detailed report. + */ +model GenerateDetailedCostReportDefinition { + /** + * The type of the detailed report. By default ActualCost is provided + */ + metric?: GenerateDetailedCostReportMetricType; + + /** + * 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. + */ + timePeriod?: GenerateDetailedCostReportTimePeriod; + + /** + * 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. + */ + billingPeriod?: string; + + /** + * 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. + */ + invoiceId?: string; + + /** + * Customer ID for Microsoft Customer Agreement scopes (Invoice Id is also required for this). + */ + customerId?: string; +} + +/** + * The start and end date for pulling data for the cost detailed report. + */ +model GenerateDetailedCostReportTimePeriod { + /** + * The start date to pull data from. example format 2020-03-15 + */ + start: string; + + /** + * The end date to pull data to. example format 2020-03-15 + */ + end: string; +} + +/** + * The URL to download the generated report. + */ +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model DownloadURL { + /** + * The time at which report URL becomes invalid/expires in UTC e.g. 2020-12-08T05:55:59.4394737Z. + */ + @visibility(Lifecycle.Read) + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + expiryTime?: utcDateTime; + + /** + * The time at which report URL becomes invalid/expires in UTC e.g. 2020-12-08T05:55:59.4394737Z. + */ + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + validTill?: utcDateTime; + + /** + * The URL to download the generated report. + */ + #suppress "@azure-tools/typespec-client-generator-core/property-name-conflict" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + downloadUrl?: string; +} + +/** + * Error response indicates that the service is not able to process the incoming request. The reason is provided in the error message. + * + * Some Error responses: + * + * * 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. + * + * * 429 TooManyRequests - Request is throttled. Retry after waiting for the time specified in the "x-ms-ratelimit-microsoft.consumption-retry-after" header. + * + * * 503 ServiceUnavailable - Service is temporarily unavailable. Retry after waiting for the time specified in the "Retry-After" header. + */ +@error +model GenerateDetailedCostReportErrorResponse { + /** + * The details of the error. + */ + error?: ErrorDetails; +} + +/** + * The status of the long running operation. + */ +model Status { + /** + * The status of the long running operation. + */ + #suppress "@azure-tools/typespec-client-generator-core/property-name-conflict" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + status?: ReportOperationStatusType; +} + +/** + * The properties of the view. + */ +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model ViewProperties { + /** + * User input name of the view. Required. + */ + displayName?: string; + + /** + * 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. + */ + scope?: string; + + /** + * Date the user created this view. + */ + @visibility(Lifecycle.Read) + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + createdOn?: utcDateTime; + + /** + * Date when the user last modified this view. + */ + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + modifiedOn?: utcDateTime; + + /** + * Date range of the current view. + */ + dateRange?: string; + + /** + * Currency of the current view. + */ + @visibility(Lifecycle.Read) + currency?: string; + + /** + * Query body configuration. Required. + */ + query?: ReportConfigDefinition; + + /** + * Chart type of the main view in Cost Analysis. Required. + */ + chart?: ChartType; + + /** + * Show costs accumulated over time. + */ + accumulated?: AccumulatedType; + + /** + * Metric to use when displaying costs. + */ + metric?: MetricType; + + /** + * List of KPIs to show in Cost Analysis UI. + */ + kpis?: KpiProperties[]; + + /** + * Configuration of 3 sub-views in the Cost Analysis UI. + */ + @identifiers(#["name"]) + pivots?: PivotProperties[]; +} + +/** + * The definition of a report config. + */ +model ReportConfigDefinition { + /** + * 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. + */ + type: ReportType; + + /** + * The time frame for pulling data for the report. If custom, then a specific time period must be provided. + */ + timeframe: ReportTimeframeType; + + /** + * Has time period for pulling data for the report. + */ + timePeriod?: ReportConfigTimePeriod; + + /** + * Has definition for data in this report config. + */ + dataSet?: ReportConfigDataset; + + /** + * If true, report includes monetary commitment. + */ + includeMonetaryCommitment?: boolean; +} + +/** + * The start and end date for pulling data for the report. + */ +model ReportConfigTimePeriod { + /** + * The start date to pull data from. + */ + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + from: utcDateTime; + + /** + * The end date to pull data to. + */ + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + to: utcDateTime; +} + +/** + * The definition of data present in the report. + */ +model ReportConfigDataset { + /** + * The granularity of rows in the report. + */ + granularity?: ReportGranularityType; + + /** + * Has configuration information for the data in the report. The configuration will be ignored if aggregation and grouping are provided. + */ + configuration?: ReportConfigDatasetConfiguration; + + /** + * 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. + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + aggregation?: Record; + + /** + * Array of group by expression to use in the report. Report can have up to 2 group by clauses. + */ + @identifiers(#["name", "type"]) + @maxItems(2) + grouping?: ReportConfigGrouping[]; + + /** + * Array of order by expression to use in the report. + */ + @identifiers(#[]) + sorting?: ReportConfigSorting[]; + + /** + * Has filter expression to use in the report. + */ + filter?: ReportConfigFilter; +} + +/** + * The configuration of dataset in the report. + */ +model ReportConfigDatasetConfiguration { + /** + * 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. + */ + columns?: string[]; +} + +/** + * The aggregation expression to be used in the report. + */ +model ReportConfigAggregation { + /** + * The name of the column to aggregate. + */ + name: string; + + /** + * The name of the aggregation function to use. + */ + function: FunctionType; +} + +/** + * The group by expression to be used in the report. + */ +model ReportConfigGrouping { + /** + * Has type of the column to group. + */ + type: QueryColumnType; + + /** + * The name of the column to group. This version supports subscription lowest possible grain. + */ + name: string; +} + +/** + * The order by expression to be used in the report. + */ +model ReportConfigSorting { + /** + * Direction of sort. + */ + direction?: ReportConfigSortingType; + + /** + * The name of the column to sort. + */ + name: string; +} + +/** + * The filter expression to be used in the report. + */ +model ReportConfigFilter { + /** + * The logical "AND" expression. Must have at least 2 items. + */ + @identifiers(#[]) + @minItems(2) + and?: ReportConfigFilter[]; + + /** + * The logical "OR" expression. Must have at least 2 items. + */ + @identifiers(#[]) + @minItems(2) + or?: ReportConfigFilter[]; + + /** + * Has comparison expression for a dimension + */ + dimensions?: ReportConfigComparisonExpression; + + /** + * Has comparison expression for a tag + */ + tags?: ReportConfigComparisonExpression; +} + +/** + * The comparison expression to be used in the report. + */ +model ReportConfigComparisonExpression { + /** + * The name of the column to use in comparison. + */ + name: string; + + /** + * The operator to use for comparison. + */ + operator: OperatorType; + + /** + * Array of values to use for comparison + */ + @minItems(1) + values: string[]; +} + +/** + * Each KPI must contain a 'type' and 'enabled' key. + */ +model KpiProperties { + /** + * KPI type (Forecast, Budget). + */ + type?: KpiTypeType; + + /** + * ID of resource related to metric (budget). + */ + id?: string; + + /** + * show the KPI in the UI? + */ + enabled?: boolean; +} + +/** + * Each pivot must contain a 'type' and 'name'. + */ +model PivotProperties { + /** + * Data type to show in view. + */ + type?: PivotTypeType; + + /** + * Data field to show in view. + */ + name?: string; +} + +/** + * Result of alerts. + */ +model AlertsResult { + /** + * List of alerts. + */ + @visibility(Lifecycle.Read) + @pageItems + value?: Alert[]; + + /** + * URL to get the next set of alerts results if there are any. + */ + @visibility(Lifecycle.Read) + nextLink?: string; +} + +/** + * Alert properties. + */ +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model AlertProperties { + /** + * defines the type of alert + */ + definition?: AlertPropertiesDefinition; + + /** + * Alert description + */ + description?: string; + + /** + * Source of alert + */ + source?: AlertSource; + + /** + * Alert details + */ + details?: AlertPropertiesDetails; + + /** + * related budget + */ + costEntityId?: string; + + /** + * alert status + */ + status?: AlertStatus; + + /** + * dateTime in which alert was created + */ + creationTime?: string; + + /** + * dateTime in which alert was closed + */ + closeTime?: string; + + /** + * dateTime in which alert was last modified + */ + modificationTime?: string; + + /** + * User who last modified the alert + */ + statusModificationUserName?: string; + + /** + * dateTime in which the alert status was last modified + */ + statusModificationTime?: string; +} + +/** + * defines the type of alert + */ +model AlertPropertiesDefinition { + /** + * type of alert + */ + type?: AlertType; + + /** + * Alert category + */ + category?: AlertCategory; + + /** + * Criteria that triggered alert + */ + criteria?: AlertCriteria; +} + +/** + * Alert details + */ +model AlertPropertiesDetails { + /** + * Type of timegrain cadence + */ + timeGrainType?: AlertTimeGrainType; + + /** + * datetime of periodStartDate + */ + periodStartDate?: string; + + /** + * notificationId that triggered this alert + */ + triggeredBy?: string; + + /** + * array of resourceGroups to filter by + */ + resourceGroupFilter?: unknown[]; + + /** + * array of resources to filter by + */ + resourceFilter?: unknown[]; + + /** + * array of meters to filter by + */ + meterFilter?: unknown[]; + + /** + * tags to filter by + */ + #suppress "@azure-tools/typespec-client-generator-core/property-name-conflict" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-core/no-unknown" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + tagFilter?: unknown; + + /** + * notification threshold percentage as a decimal which activated this alert + */ + #suppress "@azure-tools/typespec-azure-core/no-generic-numeric" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + threshold?: decimal; + + /** + * operator used to compare currentSpend with amount + */ + operator?: AlertOperator; + + /** + * budget threshold amount + */ + #suppress "@azure-tools/typespec-azure-core/no-generic-numeric" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + amount?: decimal; + + /** + * unit of currency being used + */ + unit?: string; + + /** + * current spend + */ + #suppress "@azure-tools/typespec-azure-core/no-generic-numeric" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + currentSpend?: decimal; + + /** + * list of emails to contact + */ + contactEmails?: string[]; + + /** + * list of action groups to broadcast to + */ + contactGroups?: string[]; + + /** + * list of contact roles + */ + contactRoles?: string[]; + + /** + * overriding alert + */ + overridingAlert?: string; + + /** + * department name + */ + departmentName?: string; + + /** + * company name + */ + companyName?: string; + + /** + * enrollment number + */ + enrollmentNumber?: string; + + /** + * datetime of enrollmentStartDate + */ + enrollmentStartDate?: string; + + /** + * datetime of enrollmentEndDate + */ + enrollmentEndDate?: string; + + /** + * invoicing threshold + */ + #suppress "@azure-tools/typespec-azure-core/no-generic-numeric" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + invoicingThreshold?: decimal; +} + +/** + * The request payload to update an alert + */ +model DismissAlertPayload { + /** + * Alert properties. + */ + properties?: AlertProperties; +} + +/** + * The definition of a forecast. + */ +model ForecastDefinition { + /** + * The type of the forecast. + */ + type: ForecastType; + + /** + * The time frame for pulling data for the forecast. If custom, then a specific time period must be provided. + */ + timeframe: ForecastTimeframe; + + /** + * Has time period for pulling data for the forecast. + */ + timePeriod?: ForecastTimePeriod; + + /** + * Has definition for data in this forecast. + */ + dataset: ForecastDataset; + + /** + * A boolean determining if actualCost will be included. + */ + includeActualCost?: boolean; + + /** + * A boolean determining if FreshPartialCost will be included. + */ + includeFreshPartialCost?: boolean; +} + +/** + * Has time period for pulling data for the forecast. + */ +model ForecastTimePeriod { + /** + * The start date to pull data from. + */ + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + from: utcDateTime; + + /** + * The end date to pull data to. + */ + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + to: utcDateTime; +} + +/** + * The definition of data present in the forecast. + */ +model ForecastDataset { + /** + * The granularity of rows in the forecast. + */ + granularity?: GranularityType; + + /** + * Has configuration information for the data in the export. The configuration will be ignored if aggregation and grouping are provided. + */ + configuration?: ForecastDatasetConfiguration; + + /** + * 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. + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + aggregation: Record; + + /** + * Has filter expression to use in the forecast. + */ + filter?: ForecastFilter; +} + +/** + * The configuration of dataset in the forecast. + */ +model ForecastDatasetConfiguration { + /** + * 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. + */ + columns?: string[]; +} + +/** + * The aggregation expression to be used in the forecast. + */ +model ForecastAggregation { + /** + * The name of the column to aggregate. + */ + name: FunctionName; + + /** + * The name of the aggregation function to use. + */ + function: FunctionType; +} + +/** + * The filter expression to be used in the export. + */ +model ForecastFilter { + /** + * The logical "AND" expression. Must have at least 2 items. + */ + @identifiers(#[]) + @minItems(2) + and?: ForecastFilter[]; + + /** + * The logical "OR" expression. Must have at least 2 items. + */ + @identifiers(#[]) + @minItems(2) + or?: ForecastFilter[]; + + /** + * Has comparison expression for a dimension + */ + dimensions?: ForecastComparisonExpression; + + /** + * Has comparison expression for a tag + */ + tags?: ForecastComparisonExpression; +} + +/** + * The comparison expression to be used in the forecast. + */ +model ForecastComparisonExpression { + /** + * The name of the column to use in comparison. + */ + name: string; + + /** + * The operator to use for comparison. + */ + operator: ForecastOperatorType; + + /** + * Array of values to use for comparison + */ + @minItems(1) + values: string[]; +} + +/** + * Result of forecast. It contains all columns listed under groupings and aggregation. + */ +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model ForecastResult extends CostManagementResource { + /** + * Forecast properties + */ + properties?: ForecastProperties; +} + +/** + * Forecast properties + */ +model ForecastProperties { + /** + * The link (url) to the next page of results. + */ + nextLink?: string; + + /** + * Array of columns + */ + @identifiers(#["name"]) + columns?: ForecastColumn[]; + + /** + * Array of rows + */ + @identifiers(#[]) + rows?: unknown[][]; +} + +/** + * Forecast column properties + */ +model ForecastColumn { + /** + * The name of column. + */ + name?: string; + + /** + * The type of column. + */ + type?: string; +} + +/** + * The Resource model definition. + */ +model CostManagementResource { + /** + * Resource Id. + */ + @visibility(Lifecycle.Read) + id?: string; + + /** + * Resource name. + */ + @visibility(Lifecycle.Read) + name?: string; + + /** + * Resource type. + */ + @visibility(Lifecycle.Read) + type?: string; + + /** + * Location of the resource. + */ + @visibility(Lifecycle.Read) + location?: string; + + /** + * SKU of the resource. + */ + @visibility(Lifecycle.Read) + sku?: string; + + /** + * ETag of the resource. + */ + @visibility(Lifecycle.Read) + eTag?: string; + + /** + * Resource tags. + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @visibility(Lifecycle.Read) + tags?: Record; +} + +/** + * Result of listing dimensions. It contains a list of available dimensions. + */ +model DimensionsListResult { + /** + * The list of dimensions. + */ + @visibility(Lifecycle.Read) + @pageItems + value?: Dimension[]; + + /** + * The link (url) to the next page of results. + */ + @nextLink + nextLink?: string; +} + +/** + * List of Dimension. + */ +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model Dimension extends CostManagementResource { + /** + * Dimension properties. + */ + properties?: DimensionProperties; +} + +/** + * Dimension properties. + */ +model DimensionProperties { + /** + * Dimension description. + */ + @visibility(Lifecycle.Read) + description?: string; + + /** + * Filter enabled. + */ + @visibility(Lifecycle.Read) + filterEnabled?: boolean; + + /** + * Grouping enabled. + */ + @visibility(Lifecycle.Read) + groupingEnabled?: boolean; + + /** + * Dimension data. + */ + data?: string[]; + + /** + * Total number of data for the dimension. + */ + @visibility(Lifecycle.Read) + total?: int32; + + /** + * Dimension category. + */ + @visibility(Lifecycle.Read) + category?: string; + + /** + * Usage start. + */ + @visibility(Lifecycle.Read) + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + usageStart?: utcDateTime; + + /** + * Usage end. + */ + @visibility(Lifecycle.Read) + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + usageEnd?: utcDateTime; + + /** + * The link (url) to the next page of results. + */ + @visibility(Lifecycle.Read) + nextLink?: string; +} + +/** + * The definition of a query. + */ +model QueryDefinition { + /** + * The type of the query. + */ + type: ExportType; + + /** + * The time frame for pulling data for the query. If custom, then a specific time period must be provided. + */ + timeframe: TimeframeType; + + /** + * Has time period for pulling data for the query. + */ + timePeriod?: QueryTimePeriod; + + /** + * Has definition for data in this query. + */ + dataset: QueryDataset; +} + +/** + * The start and end date for pulling data for the query. + */ +model QueryTimePeriod { + /** + * The start date to pull data from. + */ + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + from: utcDateTime; + + /** + * The end date to pull data to. + */ + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + to: utcDateTime; +} + +/** + * The definition of data present in the query. + */ +model QueryDataset { + /** + * The granularity of rows in the query. + */ + granularity?: GranularityType; + + /** + * Has configuration information for the data in the export. The configuration will be ignored if aggregation and grouping are provided. + */ + configuration?: QueryDatasetConfiguration; + + /** + * 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. + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + aggregation?: Record; + + /** + * Array of group by expression to use in the query. Query can have up to 2 group by clauses. + */ + @identifiers(#["name", "type"]) + @maxItems(2) + grouping?: QueryGrouping[]; + + /** + * The filter expression to use in the query. Please reference our Query API REST documentation for how to properly format the filter. + */ + filter?: QueryFilter; +} + +/** + * The configuration of dataset in the query. + */ +model QueryDatasetConfiguration { + /** + * 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. + */ + columns?: string[]; +} + +/** + * The aggregation expression to be used in the query. + */ +model QueryAggregation { + /** + * The name of the column to aggregate. + */ + name: string; + + /** + * The name of the aggregation function to use. + */ + function: FunctionType; +} + +/** + * The group by expression to be used in the query. + */ +model QueryGrouping { + /** + * Has type of the column to group. + */ + type: QueryColumnType; + + /** + * The name of the column to group. + */ + name: string; +} + +/** + * The filter expression to be used in the export. + */ +model QueryFilter { + /** + * The logical "AND" expression. Must have at least 2 items. + */ + @identifiers(#[]) + @minItems(2) + and?: QueryFilter[]; + + /** + * The logical "OR" expression. Must have at least 2 items. + */ + @identifiers(#[]) + @minItems(2) + or?: QueryFilter[]; + + /** + * Has comparison expression for a dimension + */ + dimensions?: QueryComparisonExpression; + + /** + * Has comparison expression for a tag + */ + tags?: QueryComparisonExpression; +} + +/** + * The comparison expression to be used in the query. + */ +model QueryComparisonExpression { + /** + * The name of the column to use in comparison. + */ + name: string; + + /** + * The operator to use for comparison. + */ + operator: QueryOperatorType; + + /** + * Array of values to use for comparison + */ + @minItems(1) + values: string[]; +} + +/** + * Result of query. It contains all columns listed under groupings and aggregation. + */ +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model QueryResult extends CostManagementResource { + /** + * Query properties + */ + properties?: QueryProperties; +} + +/** + * Query properties + */ +model QueryProperties { + /** + * The link (url) to the next page of results. + */ + nextLink?: string; + + /** + * Array of columns + */ + @identifiers(#["name"]) + columns?: QueryColumn[]; + + /** + * Array of rows + */ + @identifiers(#[]) + rows?: unknown[][]; +} + +/** + * QueryColumn properties + */ +model QueryColumn { + /** + * The name of column. + */ + name?: string; + + /** + * The type of column. + */ + type?: string; +} + +/** + * The status of the long running operation. + */ +model OperationStatus { + /** + * The status of the long running operation. + */ + status?: OperationStatusType; + + /** + * The properties of the resource generated. + */ + properties?: ReportURL; +} + +/** + * The URL to download the generated report. + */ +#suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model ReportURL { + /** + * The CSV file from the reportUrl blob link consists of reservation usage data with the following schema at daily granularity + */ + #suppress "@azure-tools/typespec-client-generator-core/property-name-conflict" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + reportUrl?: ReservationReportSchema; + + /** + * The time at which report URL becomes invalid. + */ + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + validUntil?: utcDateTime; +} + +/** + * The URL to download the generated report. + */ +model PricesheetDownloadProperties { + /** + * The time at which report URL becomes invalid/expires in UTC e.g. 2020-12-08T05:55:59.4394737Z. + */ + @visibility(Lifecycle.Read) + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + expiryTime?: utcDateTime; + + /** + * The URL to download the generated report. + */ + downloadUrl?: string; + + /** + * The properties in downloaded file + */ + downloadFileProperties?: MCAPriceSheetProperties; +} + +/** + * The properties of the price sheet. + */ +#suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model MCAPriceSheetProperties { + /** + * Unique identifier for the billing account. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @visibility(Lifecycle.Read) + billingAccountID?: string; + + /** + * Name of the billing profile that is set up to receive invoices. The prices in the price sheet are associated with this billing profile. + */ + @visibility(Lifecycle.Read) + billingAccountName?: string; + + /** + * Unique identifier for the billing profile. + */ + @visibility(Lifecycle.Read) + billingProfileId?: string; + + /** + * Name of the billing profile that is set up to receive invoices. The prices in the price sheet are associated with this billing profile. + */ + @visibility(Lifecycle.Read) + billingProfileName?: string; + + /** + * Name of the purchased product plan. Indicates if this pricing is standard Azure Plan pricing, Dev/Test pricing etc. + * + * Currently unavailable for Azure 3rd party and ReservedInstance meters. + */ + @visibility(Lifecycle.Read) + productOrderName?: string; + + /** + * Type of Azure service. For example, Compute, Analytics, and Security. + */ + @visibility(Lifecycle.Read) + serviceFamily?: float32; + + /** + * Name of the product accruing the charges. + */ + @visibility(Lifecycle.Read) + product?: string; + + /** + * Unique identifier for the product whose meter is consumed. + */ + @visibility(Lifecycle.Read) + productId?: string; + + /** + * Unique identifier of the SKU + */ + @visibility(Lifecycle.Read) + skuId?: string; + + /** + * How usage is measured for the service + */ + @visibility(Lifecycle.Read) + unitOfMeasure?: string; + + /** + * Unique identifier of the meter + */ + @visibility(Lifecycle.Read) + meterId?: string; + + /** + * Name of the meter. The meter represents the deployable resource of an Azure service. + */ + @visibility(Lifecycle.Read) + meterName?: string; + + /** + * Name of the meter type + */ + @visibility(Lifecycle.Read) + meterType?: string; + + /** + * Name of the classification category for the meter. For example, Cloud services, Networking, etc. + */ + @visibility(Lifecycle.Read) + meterCategory?: string; + + /** + * Name of the meter subclassification category. + */ + @visibility(Lifecycle.Read) + meterSubCategory?: string; + + /** + * Name of the Azure region where the meter for the service is available. + */ + @visibility(Lifecycle.Read) + meterRegion?: string; + + /** + * 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. + */ + @visibility(Lifecycle.Read) + tierMinimumUnits?: string; + + /** + * Effective start date of the Price Sheet billing period + */ + @visibility(Lifecycle.Read) + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + effectiveStartDate?: utcDateTime; + + /** + * Effective end date of the Price Sheet billing period + */ + @visibility(Lifecycle.Read) + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + effectiveEndDate?: utcDateTime; + + /** + * 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. + * + * For PriceType ReservedInstance, unit price reflects the total cost of the 1 or 3-year commitment including discounts. + * + * Note: The unit price isn't the same as the effective price in usage details downloads when services have differential prices across tiers. + * + * If 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). + */ + @visibility(Lifecycle.Read) + unitPrice?: string; + + /** + * 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. + * + * This is applicable for Enterprise Agreement users + */ + @visibility(Lifecycle.Read) + basePrice?: string; + + /** + * The current list price for a given product or service. This price is without any negotiations and is based on your Microsoft Agreement type. + * + * For PriceType Consumption, market price is reflected as the pay-as-you-go price. + * + * For PriceType Savings Plan, market price reflects the Savings plan benefit on top of pay-as-you-go price for the corresponding commitment term. + * + * For PriceType ReservedInstance, market price reflects the total price of the 1 or 3-year commitment. + */ + @visibility(Lifecycle.Read) + marketPrice?: string; + + /** + * Currency in which all the prices are reflected. + */ + @visibility(Lifecycle.Read) + currency?: string; + + /** + * Currency in which charges are posted. + */ + @visibility(Lifecycle.Read) + billingCurrency?: string; + + /** + * Term length for Azure Savings Plan or Reservation term – one year or three years (P1Y or P3Y) + */ + @visibility(Lifecycle.Read) + term?: string; + + /** + * 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. + */ + @visibility(Lifecycle.Read) + priceType?: string; +} + +/** + * The properties of the price sheet download. + */ +#suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model EAPricesheetDownloadProperties { + /** + * The link (url) to download the pricesheet. + */ + @visibility(Lifecycle.Read) + downloadUrl?: string; + + /** + * Download link validity. + */ + @visibility(Lifecycle.Read) + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + validTill?: utcDateTime; + + /** + * The properties in downloaded file + */ + downloadFileProperties?: EAPriceSheetProperties; +} + +/** + * The properties of the EA price sheet. Properties supported with version 2025-03-01 are as below + */ +#suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model EAPriceSheetProperties { + /** + * Unique identifier for the EA billing account. + */ + @visibility(Lifecycle.Read) + enrollmentNumber?: string; + + /** + * Type of Azure service. For example, Compute, Analytics, and Security. + */ + @visibility(Lifecycle.Read) + serviceFamily?: float32; + + /** + * Name of the product accruing the charges. + */ + @visibility(Lifecycle.Read) + product?: string; + + /** + * Unique identifier for the product whose meter is consumed. + */ + @visibility(Lifecycle.Read) + productId?: string; + + /** + * Unique identifier of the SKU + */ + @visibility(Lifecycle.Read) + skuId?: string; + + /** + * 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”. + */ + @visibility(Lifecycle.Read) + unitOfMeasure?: string; + + /** + * Unique identifier of the meter + */ + @visibility(Lifecycle.Read) + meterId?: string; + + /** + * Name of the meter. The meter represents the deployable resource of an Azure service. + */ + @visibility(Lifecycle.Read) + meterName?: string; + + /** + * Name of the meter type + */ + @visibility(Lifecycle.Read) + meterType?: string; + + /** + * Determines the Azure offer associated with this meter. [Learn more about Azure offers] (https://azure.microsoft.com/en-us/support/legal/offer-details/) + */ + @visibility(Lifecycle.Read) + offerId?: string; + + /** + * Name of the classification category for the meter. For example, Cloud services, Networking, etc. + */ + @visibility(Lifecycle.Read) + meterCategory?: string; + + /** + * Name of the meter subclassification category. + */ + @visibility(Lifecycle.Read) + meterSubCategory?: string; + + /** + * Name of the Azure region where the meter for the service is available. + */ + @visibility(Lifecycle.Read) + meterRegion?: string; + + /** + * Effective start date of the Price Sheet billing period + */ + @visibility(Lifecycle.Read) + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + effectiveStartDate?: utcDateTime; + + /** + * Effective end date of the Price Sheet billing period + */ + @visibility(Lifecycle.Read) + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + effectiveEndDate?: utcDateTime; + + /** + * 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. + * + * For PriceType ReservedInstance, unit price reflects the total cost of the 1 or 3-year commitment including discounts. + * + * Note: The unit price isn't the same as the effective price in usage details downloads when services have differential prices across tiers. + * + * If 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). + */ + @visibility(Lifecycle.Read) + unitPrice?: string; + + /** + * 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. + * + * This is applicable for Enterprise Agreement users + */ + @visibility(Lifecycle.Read) + basePrice?: string; + + /** + * The current list price for a given product or service. This price is without any negotiations and is based on your Microsoft Agreement type. + * + * For PriceType Consumption, market price is reflected as the pay-as-you-go price. + * + * For PriceType Savings Plan, market price reflects the Savings plan benefit on top of pay-as-you-go price for the corresponding commitment term. + * + * For PriceType ReservedInstance, market price reflects the total price of the 1 or 3-year commitment. + * + * Note: For EA customers with no negotiations, market price may appear rounded to a different decimal precision than unit price. + */ + @visibility(Lifecycle.Read) + marketPrice?: string; + + /** + * Quantities of a specific service to which an EA customer is entitled to consume without incremental charges. + */ + @visibility(Lifecycle.Read) + includedQuantity?: string; + + /** + * Currency in which the Enterprise Agreement was signed + */ + @visibility(Lifecycle.Read) + currencyCode?: string; + + /** + * Term length for Azure Savings Plan or Reservation term – one year or three years (P1Y or P3Y) + */ + @visibility(Lifecycle.Read) + term?: string; + + /** + * 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. + */ + @visibility(Lifecycle.Read) + priceType?: string; + + /** + * Part number associated with the meter + */ + @visibility(Lifecycle.Read) + partNumber?: string; +} + +/** + * The properties of the scheduled action. + */ +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model ScheduledActionProperties { + /** + * Scheduled action name. + */ + displayName: string; + + /** + * Destination format of the view data. This is optional. + */ + fileDestination?: FileDestination; + + /** + * Notification properties based on scheduled action kind. + */ + notification: NotificationProperties; + + /** + * Email address of the point of contact that should get the unsubscribe requests and notification emails. + */ + notificationEmail?: string; + + /** + * Schedule of the scheduled action. + */ + schedule: ScheduleProperties; + + /** + * 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. + */ + scope?: string; + + /** + * Status of the scheduled action. + */ + status: ScheduledActionStatus; + + /** + * Cost analysis viewId used for scheduled action. For example, '/providers/Microsoft.CostManagement/views/swaggerExample' + */ + viewId: string; +} + +/** + * Destination of the view data. This is optional. Currently only CSV format is supported. + */ +model FileDestination { + /** + * Destination of the view data. Currently only CSV format is supported. + */ + fileFormats?: FileFormat[]; +} + +/** + * The properties of the scheduled action notification. + */ +model NotificationProperties { + /** + * Array of email addresses. + */ + @minItems(1) + @maxItems(20) + to: string[]; + + /** + * Locale of the email. + */ + language?: string; + + /** + * Optional message to be added in the email. Length is limited to 250 characters. + */ + message?: string; + + /** + * Regional format used for formatting date/time and currency values in the email. + */ + regionalFormat?: string; + + /** + * Subject of the email. Length is limited to 70 characters. + */ + subject: string; +} + +/** + * The properties of the schedule. + */ +model ScheduleProperties { + /** + * Frequency of the schedule. + */ + frequency: ScheduleFrequency; + + /** + * UTC time at which cost analysis data will be emailed. + */ + hourOfDay?: int32; + + /** + * Day names in english on which cost analysis data will be emailed. This property is applicable when frequency is Weekly or Monthly. + */ + daysOfWeek?: DaysOfWeek[]; + + /** + * Weeks in which cost analysis data will be emailed. This property is applicable when frequency is Monthly and used in combination with daysOfWeek. + */ + weeksOfMonth?: WeeksOfMonth[]; + + /** + * 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. + */ + dayOfMonth?: int32; + + /** + * The start date and time of the scheduled action (UTC). + */ + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + startDate: utcDateTime; + + /** + * The end date and time of the scheduled action (UTC). + */ + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + endDate: utcDateTime; +} + +/** + * The Resource model definition. + */ +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model ScheduledActionProxyResource + extends Azure.ResourceManager.CommonTypes.ProxyResource { + /** + * 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. + */ + @visibility(Lifecycle.Read) + eTag?: string; + + /** + * Kind of the scheduled action. + */ + kind?: ScheduledActionKind; + + /** + * Kind of the scheduled action. + */ + systemData?: SystemData; +} + +/** + * Error response indicates that the service is not able to process the incoming request. The reason is provided in the error message. + * + * Some Error responses: + * + * * 429 TooManyRequests - Request is throttled. Retry after waiting for the time specified in the "x-ms-ratelimit-microsoft.consumption-retry-after" header. + * + * * 503 ServiceUnavailable - Service is temporarily unavailable. Retry after waiting for the time specified in the "Retry-After" header. + */ +@error +model ErrorResponseWithNestedDetails { + /** + * The details of the error. + */ + error?: ErrorDetailsWithNestedDetails; +} + +/** + * The details of the error. + */ +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model ErrorDetailsWithNestedDetails extends ErrorDetails { + /** + * The additional details of the error. + */ + @visibility(Lifecycle.Read) + @identifiers(#[]) + details?: ErrorDetailsWithNestedDetails[]; +} + +/** + * Setting list result. It contains a list of settings. + */ +model SettingsListResult { + /** + * The list of settings. + */ + @visibility(Lifecycle.Read) + @identifiers(#["id"]) + @pageItems + value?: Setting[]; +} + +/** + * The properties of the benefit recommendations when scope is 'Single'. + */ +model SingleScopeBenefitRecommendationProperties + extends BenefitRecommendationProperties { + /** + * The subscription ID that this single scope recommendation is for. Applicable only if recommendation is for 'Single' scope. + */ + @visibility(Lifecycle.Read) + subscriptionId?: string; + + /** + * The resource group that this single scope recommendation is for. Applicable only if recommendation is for 'Single' scope and 'ResourceGroup' request scope. + */ + @visibility(Lifecycle.Read) + resourceGroup?: string; + + /** + * Benefit scope. For example, Single or Shared. + */ + scope: "Single"; +} + +/** + * The properties of the benefit recommendation when scope is 'Shared'. + */ +model SharedScopeBenefitRecommendationProperties + extends BenefitRecommendationProperties { + /** + * Benefit scope. For example, Single or Shared. + */ + scope: "Shared"; +} + +/** + * The properties of a benefit utilization summary. + */ +model BenefitUtilizationSummaryProperties { + /** + * ARM SKU name. For example, 'Compute_Savings_Plan' for savings plan. + */ + @visibility(Lifecycle.Read) + armSkuName?: string; + + /** + * The benefit ID is the identifier of the benefit. + */ + @visibility(Lifecycle.Read) + benefitId?: string; + + /** + * The benefit order ID is the identifier for a benefit purchase. + */ + @visibility(Lifecycle.Read) + benefitOrderId?: string; + + /** + * The benefit type. Supported values: 'SavingsPlan'. + */ + benefitType?: BenefitKind; + + /** + * 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. + */ + @visibility(Lifecycle.Read) + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + usageDate?: utcDateTime; +} + +/** + * Included Quantity utilization summary resource. + */ +model IncludedQuantityUtilizationSummary extends BenefitUtilizationSummary { + /** + * Included Quantity utilization summary properties. + */ + properties?: IncludedQuantityUtilizationSummaryProperties; + + /** + * Supported values: 'SavingsPlan'. + */ + kind: "IncludedQuantity"; +} + +/** + * Included Quantity utilization summary properties. + */ +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model IncludedQuantityUtilizationSummaryProperties + extends BenefitUtilizationSummaryProperties { + /** + * This is the utilized percentage for the benefit ID. + */ + #suppress "@azure-tools/typespec-azure-core/no-generic-numeric" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @visibility(Lifecycle.Read) + utilizationPercentage?: decimal; +} + +/** + * Savings plan utilization summary resource. + */ +model SavingsPlanUtilizationSummary extends BenefitUtilizationSummary { + /** + * Savings plan utilization summary properties. + */ + properties?: SavingsPlanUtilizationSummaryProperties; + + /** + * Supported values: 'SavingsPlan'. + */ + kind: "SavingsPlan"; +} + +/** + * Savings plan utilization summary properties. + */ +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model SavingsPlanUtilizationSummaryProperties + extends BenefitUtilizationSummaryProperties { + /** + * 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. + */ + #suppress "@azure-tools/typespec-azure-core/no-generic-numeric" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @visibility(Lifecycle.Read) + avgUtilizationPercentage?: decimal; + + /** + * 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%. + */ + #suppress "@azure-tools/typespec-azure-core/no-generic-numeric" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @visibility(Lifecycle.Read) + minUtilizationPercentage?: decimal; + + /** + * 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%. + */ + #suppress "@azure-tools/typespec-azure-core/no-generic-numeric" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @visibility(Lifecycle.Read) + maxUtilizationPercentage?: decimal; +} + +/** + * Tag Inheritance Setting definition. + */ +model TagInheritanceSetting extends Setting { + /** + * The properties of the tag inheritance setting. + */ + properties?: TagInheritanceProperties; + + /** + * Specifies the kind of settings. + */ + kind: "taginheritance"; +} + +/** + * The properties of the tag inheritance setting. + */ +model TagInheritanceProperties { + /** + * 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). + */ + preferContainerTags: boolean; +} + +/** + * Result of listing benefit recommendations. + */ +#suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model benefitRecommendationsListResult { + /** + * The list of benefit recommendations. + */ + @visibility(Lifecycle.Read) + @pageItems + value?: BenefitRecommendationModel[]; + + /** + * The link (url) to the next page of results. + */ + @nextLink + nextLink?: string; +} + +/** + * Result of listing budgets. It contains a list of available budgets in the scope provided. + */ +#suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model BudgetsListResult { + /** + * The list of budgets. + */ + @visibility(Lifecycle.Read) + @pageItems + value?: Budget[]; + + /** + * The link (url) to the next page of results.\r\nIt's null for now, added for future use. + */ + @nextLink + nextLink?: string; +} + +/** + * List of benefit utilization summaries. + */ +model BenefitUtilizationSummariesListResult { + /** + * The list of benefit utilization summaries. + */ + @visibility(Lifecycle.Read) + @pageItems + value?: BenefitUtilizationSummary[]; + + /** + * The link (URL) to the next page of results. + */ + @nextLink + nextLink?: string; +} + +/** + * Scheduled actions list result. It contains a list of scheduled actions. + */ +model ScheduledActionListResult { + /** + * The list of scheduled actions. + */ + @visibility(Lifecycle.Read) + @pageItems + value?: ScheduledAction[]; + + /** + * The link (url) to the next page of results. + */ + @nextLink + nextLink?: string; +} + +/** + * Result of listing views. It contains a list of available views. + */ +model ViewListResult { + /** + * The list of views. + */ + @visibility(Lifecycle.Read) + @pageItems + value?: View[]; + + /** + * The link (url) to the next page of results. + */ + @nextLink + nextLink?: string; +} + +/** + * 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. + */ +@error +model ErrorResponse { + /** + * The details of the error. + */ + error?: ErrorDetails; +} + +/** + * Result of listing cost management operations. It contains a list of operations and a URL link to get the next set of results. + */ +model OperationListResult { + /** + * List of cost management operations supported by the Microsoft.CostManagement resource provider. + */ + @visibility(Lifecycle.Read) + @pageItems + value?: CostManagementOperation[]; + + /** + * URL to get the next set of operation list results if there are any. + */ + @nextLink + @visibility(Lifecycle.Read) + nextLink?: string; +} + +/** + * The result of the long running operation for cost details Api. + */ +model CostDetailsOperationResults { + /** + * The id of the long running operation. + */ + id?: string; + + /** + * The name of the long running operation. + */ + name?: string; + + /** + * The type of the long running operation. + */ + type?: string; + + /** + * The status of the cost details operation + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + status?: CostDetailsStatusType; + + /** + * The manifest of the report generated by the operation. + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + manifest?: ReportManifest; + + /** + * The time at which report URL becomes invalid/expires in UTC e.g. 2020-12-08T05:55:59.4394737Z. + */ + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + validTill?: utcDateTime; + + /** + * The details of the error. + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + error?: ErrorDetails; +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/readme.md b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/readme.md index 01b7bd7305b0..f16a042fa845 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/readme.md +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/readme.md @@ -39,17 +39,7 @@ These settings apply only when `--tag=package-2025-03` is specified on the comma ```yaml $(tag) == 'package-2025-03' input-file: - - stable/2025-03-01/common-types.json - - stable/2025-03-01/costallocation.json - - stable/2025-03-01/costmanagement.benefits.json - - stable/2025-03-01/costmanagement.budgets.json - - stable/2025-03-01/costmanagement.exports.json - - stable/2025-03-01/costmanagement.generatecostdetailsreport.json - - stable/2025-03-01/costmanagement.generatedetailedcostreport.json - - stable/2025-03-01/costmanagement.json - - stable/2025-03-01/costmanagement.pricesheets.json - - stable/2025-03-01/scheduledActions.json - - stable/2025-03-01/settings.json + - stable/2025-03-01/openapi.json ``` ### Tag: package-preview-2024-10-01-preview diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/routes.tsp b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/routes.tsp new file mode 100644 index 000000000000..0421b8cf59cb --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/routes.tsp @@ -0,0 +1,1155 @@ +// FIXME: Operations in this file are not detected as a resource operation, please confirm the conversion result manually + +import "@azure-tools/typespec-azure-core"; +import "@typespec/rest"; +import "./models.tsp"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/openapi"; + +using TypeSpec.Rest; +using TypeSpec.Http; +using Azure.ResourceManager; +using TypeSpec.OpenAPI; + +namespace Microsoft.CostManagement; + +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-interface-requires-decorator" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +interface CostAllocationRulesOperationGroup { + /** + * Checks availability and correctness of a name for a cost allocation rule + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @operationId("CostAllocationRules_CheckNameAvailability") + @autoRoute + @post + @action("costAllocationRules/checkNameAvailability") + @armResourceCollectionAction + checkNameAvailability( + ...ApiVersionParameter, + + /** the provider namespace */ + @path + @segment("providers") + @key + providerNamespace: "microsoft.Billing", + + /** + * BillingAccount ID + */ + @path + @segment("billingAccounts") + billingAccountId: string, + + ...Azure.ResourceManager.Legacy.Provider, + + /** + * Cost allocation rule to be created or updated + */ + @bodyRoot + body: CostAllocationRuleCheckNameAvailabilityRequest, + ): ArmResponse | ErrorResponse; +} + +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-interface-requires-decorator" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +interface BenefitRecommendationsOperationGroup { + /** + * List of recommendations for purchasing savings plan. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-operation" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @operationId("BenefitRecommendations_List") + @externalDocs("https://docs.microsoft.com/en-us/rest/api/CostManagement/") + @get + @list + @action("benefitRecommendations") + @autoRoute + list( + ...ApiVersionParameter, + + /** + * 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 + */ + @query("$filter") + $filter?: string, + + /** + * 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. + */ + @query("$orderby") + $orderby?: string, + + /** + * May be used to expand the properties by: properties/usage, properties/allRecommendationDetails + */ + @query("$expand") + $expand?: string, + + /** + * 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 + */ + @path(#{ allowReserved: true }) + billingScope: string, + + ...Azure.ResourceManager.Legacy.Provider, + ): ArmResponse | ErrorResponse; +} + +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-interface-requires-decorator" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +interface BenefitUtilizationSummariesOperationGroup { + /** + * Lists savings plan utilization summaries for the enterprise agreement scope. Supported at grain values: 'Daily' and 'Monthly'. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-operation" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @operationId("BenefitUtilizationSummaries_ListByBillingAccountId") + @autoRoute + @get + @action("benefitUtilizationSummaries") + @list + @externalDocs("https://docs.microsoft.com/en-us/rest/api/cost-management/") + listByBillingAccountId( + ...ApiVersionParameter, + + /** the provider namespace */ + @path + @segment("providers") + @key + providerNamespace: "microsoft.Billing", + + /** + * BillingAccount ID + */ + @path + @segment("billingAccounts") + billingAccountId: string, + + ...Azure.ResourceManager.Legacy.Provider, + + /** + * Grain. + */ + @query("grainParameter") + grainParameter?: GrainParameter, + + /** + * Supports filtering by properties/benefitId, properties/benefitOrderId and properties/usageDate. + */ + @query("filter") + filter?: string, + ): ArmResponse | ErrorResponse; + + /** + * Lists savings plan utilization summaries for billing profile. Supported at grain values: 'Daily' and 'Monthly'. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-operation" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @operationId("BenefitUtilizationSummaries_ListByBillingProfileId") + @autoRoute + @get + @action("benefitUtilizationSummaries") + @externalDocs("https://docs.microsoft.com/en-us/rest/api/cost-management/") + @list + listByBillingProfileId( + ...ApiVersionParameter, + + /** the provider namespace */ + @path + @segment("providers") + @key + providerNamespace: "microsoft.Billing", + + /** + * BillingAccount ID + */ + @path + @segment("billingAccounts") + billingAccountId: string, + + /** + * Billing Profile ID. + */ + @path + @segment("billingProfiles") + billingProfileId: string, + + ...Azure.ResourceManager.Legacy.Provider, + + /** + * Grain. + */ + @query("grainParameter") + grainParameter?: GrainParameter, + + /** + * Supports filtering by properties/benefitId, properties/benefitOrderId and properties/usageDate. + */ + @query("filter") + filter?: string, + ): ArmResponse | ErrorResponse; + + /** + * Lists the savings plan utilization summaries for daily or monthly grain. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-operation" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @operationId("BenefitUtilizationSummaries_ListBySavingsPlanOrder") + @externalDocs("https://docs.microsoft.com/en-us/rest/api/cost-management/") + @autoRoute + @get + @action("benefitUtilizationSummaries") + @list + listBySavingsPlanOrder( + ...ApiVersionParameter, + + /** + * Supports filtering by properties/usageDate. + */ + @query("$filter") + $filter?: string, + + /** + * Grain. + */ + @query("grainParameter") + grainParameter?: GrainParameter, + + /** the provider namespace */ + @path + @segment("providers") + @key + providerNamespace: "microsoft.BillingBenefits", + + /** + * Savings plan order ID. + */ + @path + @segment("savingsPlanOrders") + savingsPlanOrderId: string, + + ...Azure.ResourceManager.Legacy.Provider, + ): BenefitUtilizationSummariesListResult | ErrorResponse; + /** + * Lists the savings plan utilization summaries for daily or monthly grain. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-operation" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @operationId("BenefitUtilizationSummaries_ListBySavingsPlanId") + @externalDocs("https://docs.microsoft.com/en-us/rest/api/cost-management/") + @autoRoute + @get + @action("benefitUtilizationSummaries") + @list + listBySavingsPlanId( + ...ApiVersionParameter, + + /** + * Supports filtering by properties/usageDate. + */ + @query("$filter") + $filter?: string, + + /** + * Grain. + */ + @query("grainParameter") + grainParameter?: GrainParameter, + + /** the provider namespace */ + @path + @segment("providers") + @key + providerNamespace: "microsoft.BillingBenefits", + + /** + * Savings plan order ID. + */ + @path + @segment("savingsPlanOrders") + savingsPlanOrderId: string, + + /** + * Savings plan ID. + */ + @path + @segment("savingsPlans") + savingsPlanId: string, + + ...Azure.ResourceManager.Legacy.Provider, + ): BenefitUtilizationSummariesListResult | ErrorResponse; +} + +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-interface-requires-decorator" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +interface GenerateBenefitUtilizationSummariesReportOperationGroup { + /** + * Triggers generation of a benefit utilization summaries report for the provided billing account. This API supports only enrollment accounts. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @operationId("GenerateBenefitUtilizationSummariesReport_GenerateByBillingAccount") + @externalDocs("https://docs.microsoft.com/rest/api/cost-management/") + @autoRoute + @action("generateBenefitUtilizationSummariesReport") + @post + @armResourceCollectionAction + generateByBillingAccount( + ...ApiVersionParameter, + + /** the provider namespace */ + @path + @segment("providers") + @key + providerNamespace: "microsoft.Billing", + + /** + * BillingAccount ID + */ + @path + @segment("billingAccounts") + billingAccountId: string, + + ...Azure.ResourceManager.Legacy.Provider, + + /** + * Async Benefit Utilization Summary report to be created. + */ + @body + body: BenefitUtilizationSummariesRequest, + ): ArmResponse | ArmAcceptedLroResponse> | CommonTypes.ErrorResponse; + + /** + * Triggers generation of a benefit utilization summaries report for the provided billing account and billing profile. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @operationId("GenerateBenefitUtilizationSummariesReport_GenerateByBillingProfile") + @autoRoute + @action("generateBenefitUtilizationSummariesReport") + @externalDocs("https://docs.microsoft.com/rest/api/cost-management/") + @post + @armResourceCollectionAction + generateByBillingProfile( + ...ApiVersionParameter, + + /** the provider namespace */ + @path + @segment("providers") + @key + providerNamespace: "microsoft.Billing", + + /** + * BillingAccount ID + */ + @path + @segment("billingAccounts") + billingAccountId: string, + + /** + * Billing Profile ID. + */ + @path + @segment("billingProfiles") + billingProfileId: string, + + ...Azure.ResourceManager.Legacy.Provider, + + /** + * Async Benefit Utilization Summary report to be created. + */ + @body + body: BenefitUtilizationSummariesRequest, + ): ArmResponse | ArmAcceptedLroResponse> | CommonTypes.ErrorResponse; + + /** + * Triggers generation of a benefit utilization summaries report for the provided reservation order. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @operationId("GenerateBenefitUtilizationSummariesReport_GenerateByReservationOrderId") + @externalDocs("https://docs.microsoft.com/rest/api/cost-management/") + @autoRoute + @action("generateBenefitUtilizationSummariesReport") + @post + @armResourceCollectionAction + generateByReservationOrderId( + ...ApiVersionParameter, + + /** the provider namespace */ + @path + @segment("providers") + @key + providerNamespace: "microsoft.Capacity", + + /** + * Reservation Order ID + */ + @path + @segment("reservationorders") + reservationOrderId: string, + + ...Azure.ResourceManager.Legacy.Provider, + + /** + * Async Benefit Utilization Summary report to be created. + */ + @body + body: BenefitUtilizationSummariesRequest, + ): BenefitUtilizationSummariesOperationStatus | ArmAcceptedLroResponse> | CommonTypes.ErrorResponse; + + /** + * Triggers generation of a benefit utilization summaries report for the provided reservation. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @operationId("GenerateBenefitUtilizationSummariesReport_GenerateByReservationId") + @externalDocs("https://docs.microsoft.com/rest/api/cost-management/") + @autoRoute + @action("generateBenefitUtilizationSummariesReport") + @post + @armResourceCollectionAction + generateByReservationId( + ...ApiVersionParameter, + + /** the provider namespace */ + @path + @segment("providers") + @key + providerNamespace: "microsoft.Capacity", + + /** + * Reservation Order ID + */ + @path + @segment("reservationorders") + reservationOrderId: string, + + /** + * Reservation ID + */ + @path + @segment("reservations") + reservationId: string, + + ...Azure.ResourceManager.Legacy.Provider, + + /** + * Async Benefit Utilization Summary report to be created. + */ + @body + body: BenefitUtilizationSummariesRequest, + ): BenefitUtilizationSummariesOperationStatus | ArmAcceptedLroResponse> | CommonTypes.ErrorResponse; + /** + * Triggers generation of a benefit utilization summaries report for the provided savings plan order. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @operationId("GenerateBenefitUtilizationSummariesReport_GenerateBySavingsPlanOrderId") + @externalDocs("https://docs.microsoft.com/rest/api/cost-management/") + @autoRoute + @action("generateBenefitUtilizationSummariesReport") + @post + @armResourceCollectionAction + generateBySavingsPlanOrderId( + ...ApiVersionParameter, + + /** the provider namespace */ + @path + @segment("providers") + @key + providerNamespace: "microsoft.BillingBenefits", + + /** + * Savings plan order ID. + */ + @path + @segment("savingsPlanOrders") + savingsPlanOrderId: string, + + ...Azure.ResourceManager.Legacy.Provider, + + /** + * Async Benefit Utilization Summary report to be created. + */ + @body + body: BenefitUtilizationSummariesRequest, + ): BenefitUtilizationSummariesOperationStatus | ArmAcceptedLroResponse> | CommonTypes.ErrorResponse; + /** + * Triggers generation of a benefit utilization summaries report for the provided savings plan. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @operationId("GenerateBenefitUtilizationSummariesReport_GenerateBySavingsPlanId") + @externalDocs("https://docs.microsoft.com/rest/api/cost-management/") + @autoRoute + @action("generateBenefitUtilizationSummariesReport") + @post + @armResourceCollectionAction + generateBySavingsPlanId( + ...ApiVersionParameter, + + /** the provider namespace */ + @path + @segment("providers") + @key + providerNamespace: "microsoft.BillingBenefits", + + /** + * Savings plan order ID. + */ + @path + @segment("savingsPlanOrders") + savingsPlanOrderId: string, + + /** + * Savings plan ID. + */ + @path + @segment("savingsPlans") + savingsPlanId: string, + + ...Azure.ResourceManager.Legacy.Provider, + + /** + * Async Benefit Utilization Summary report to be created. + */ + @body + body: BenefitUtilizationSummariesRequest, + ): BenefitUtilizationSummariesOperationStatus | ArmAcceptedLroResponse> | CommonTypes.ErrorResponse; +} + +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-interface-requires-decorator" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +interface GenerateCostDetailsReportOperationGroup { + /** + * 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 + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @operationId("GenerateCostDetailsReport_CreateOperation") + @post + @autoRoute + @action("generateCostDetailsReport") + @externalDocs("https://docs.microsoft.com/en-us/rest/api/costmanagement/") + createOperation( + ...ApiVersionParameter, + + /** + * 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. + */ + @path(#{ allowReserved: true }) + scope: string, + + ...Azure.ResourceManager.Legacy.Provider, + + /** + * Parameters supplied to the Create cost details operation. + */ + @bodyRoot + parameters: GenerateCostDetailsReportRequestDefinition, + ): + | ArmResponse + | ArmAcceptedLroResponse> + | NoContentResponse + | GenerateCostDetailsReportErrorResponse; +} + +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-interface-requires-decorator" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +interface GenerateDetailedCostReportOperationGroup { + /** + * 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. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @operationId("GenerateDetailedCostReport_CreateOperation") + @post + @externalDocs("https://docs.microsoft.com/en-us/rest/api/costmanagement/") + @autoRoute + @action("generateDetailedCostReport") + createOperation( + ...ApiVersionParameter, + + /** + * The ARM Resource ID for subscription, resource group, billing account, or other billing scopes. For details, see https://aka.ms/costmgmt/scopes. + */ + @path(#{ allowReserved: true }) + scope: string, + + ...Azure.ResourceManager.Legacy.Provider, + + /** + * Parameters supplied to the Create detailed cost report operation. + */ + @bodyRoot + parameters: GenerateDetailedCostReportDefinition, + ): ArmResponse | (ArmAcceptedLroResponse> & { + /** + * The URL to check the status of the asynchronous operation. + */ + @header("Azure-Consumption-AsyncOperation") + azureConsumptionAsyncOperation: string; + }) | GenerateDetailedCostReportErrorResponse; +} + +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-interface-requires-decorator" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +interface AlertsOperationGroup { + /** + * Lists the Alerts for external cloud provider type defined. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @operationId("Alerts_ListExternal") + @externalDocs("https://docs.microsoft.com/en-us/rest/api/costmanagement/") + @autoRoute + @get + @action("alerts") + listExternal is ArmProviderActionSync< + Response = AlertsResult, + Parameters = { + /** + * The external cloud provider type associated with dimension/query operations. This includes 'externalSubscriptions' for linked account and 'externalBillingAccounts' for consolidated account. + */ + @path + externalCloudProviderType: ExternalCloudProviderType; + + /** + * This can be '{externalSubscriptionId}' for linked account or '{externalBillingAccountId}' for consolidated account used with dimension/query operations. + */ + @path + externalCloudProviderId: string; + }, + Error = ErrorResponse + >; +} + +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-interface-requires-decorator" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +interface ForecastOperationGroup { + /** + * Lists the forecast charges for scope defined. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @operationId("Forecast_Usage") + @externalDocs("https://docs.microsoft.com/en-us/rest/api/costmanagement/") + @post + @action("forecast") + @autoRoute + usage( + ...ApiVersionParameter, + + /** + * 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'. + */ + @query("$filter") + $filter?: string, + + /** + * 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. + */ + @path(#{ allowReserved: true }) + scope: string, + + ...Azure.ResourceManager.Legacy.Provider, + + /** + * Parameters supplied to the CreateOrUpdate Forecast Config operation. + */ + @bodyRoot + parameters: ForecastDefinition, + ): ArmResponse | NoContentResponse | ErrorResponse; + + /** + * Lists the forecast charges for external cloud provider type defined. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @operationId("Forecast_ExternalCloudProviderUsage") + @externalDocs("https://docs.microsoft.com/en-us/rest/api/costmanagement/") + @autoRoute + @action("forecast") + externalCloudProviderUsage is ArmProviderActionSync< + Request = ForecastDefinition, + Response = ForecastResult, + Parameters = { + /** + * 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'. + */ + @query("$filter") + $filter?: string; + + /** + * The external cloud provider type associated with dimension/query operations. This includes 'externalSubscriptions' for linked account and 'externalBillingAccounts' for consolidated account. + */ + @path + externalCloudProviderType: ExternalCloudProviderType; + + /** + * This can be '{externalSubscriptionId}' for linked account or '{externalBillingAccountId}' for consolidated account used with dimension/query operations. + */ + @path + externalCloudProviderId: string; + }, + Error = ErrorResponse + >; +} + +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-interface-requires-decorator" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +interface DimensionsOperationGroup { + /** + * Lists the dimensions by the defined scope. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @operationId("Dimensions_List") + @externalDocs("https://docs.microsoft.com/en-us/rest/api/costmanagement/") + @get + @action("dimensions") + @autoRoute + @list + list( + ...ApiVersionParameter, + + /** + * 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. + */ + @path(#{ allowReserved: true }) + scope: string, + + ...Azure.ResourceManager.Legacy.Provider, + + /** + * May be used to filter dimensions by properties/category, properties/usageStart, properties/usageEnd. Supported operators are 'eq','lt', 'gt', 'le', 'ge'. + */ + @query("$filter") + $filter?: string, + + /** + * May be used to expand the properties/data within a dimension category. By default, data is not included when listing dimensions. + */ + @query("$expand") + $expand?: string, + + /** + * 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. + */ + @query("$skiptoken") + $skiptoken?: string, + + /** + * May be used to limit the number of results to the most recent N dimension data. + */ + @maxValue(1000) + @minValue(1) + @query("$top") + $top?: int32, + ): ArmResponse | NoContentResponse | ErrorResponse; + + /** + * Lists the dimensions by the external cloud provider type. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @operationId("Dimensions_ByExternalCloudProviderType") + @externalDocs("https://docs.microsoft.com/en-us/rest/api/costmanagement/") + @autoRoute + @get + @action("dimensions") + @list + byExternalCloudProviderType is ArmProviderActionSync< + Response = DimensionsListResult, + Parameters = { + /** + * The external cloud provider type associated with dimension/query operations. This includes 'externalSubscriptions' for linked account and 'externalBillingAccounts' for consolidated account. + */ + @path + externalCloudProviderType: ExternalCloudProviderType; + + /** + * This can be '{externalSubscriptionId}' for linked account or '{externalBillingAccountId}' for consolidated account used with dimension/query operations. + */ + @path + externalCloudProviderId: string; + + /** + * May be used to filter dimensions by properties/category, properties/usageStart, properties/usageEnd. Supported operators are 'eq','lt', 'gt', 'le', 'ge'. + */ + @query("$filter") + $filter?: string; + + /** + * May be used to expand the properties/data within a dimension category. By default, data is not included when listing dimensions. + */ + @query("$expand") + $expand?: string; + + /** + * 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. + */ + @query("$skiptoken") + $skiptoken?: string; + + /** + * May be used to limit the number of results to the most recent N dimension data. + */ + @maxValue(1000) + @minValue(1) + @query("$top") + $top?: int32; + }, + Error = ErrorResponse + >; +} + +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-interface-requires-decorator" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +interface QueryOperationGroup { + /** + * Query the usage data for scope defined. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @operationId("Query_Usage") + @post + @action("query") + @externalDocs("https://docs.microsoft.com/en-us/rest/api/costmanagement/") + @autoRoute + usage( + ...ApiVersionParameter, + + /** + * 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. + */ + @path(#{ allowReserved: true }) + scope: string, + + ...Azure.ResourceManager.Legacy.Provider, + + /** + * Parameters supplied to the CreateOrUpdate Query Config operation. + */ + @bodyRoot + parameters: QueryDefinition, + ): ArmResponse | NoContentResponse | ErrorResponse; + + /** + * Query the usage data for external cloud provider type defined. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @operationId("Query_UsageByExternalCloudProviderType") + @externalDocs("https://docs.microsoft.com/en-us/rest/api/costmanagement/") + @autoRoute + @action("query") + usageByExternalCloudProviderType is ArmProviderActionSync< + Request = QueryDefinition, + Response = QueryResult, + Parameters = { + /** + * The external cloud provider type associated with dimension/query operations. This includes 'externalSubscriptions' for linked account and 'externalBillingAccounts' for consolidated account. + */ + @path + externalCloudProviderType: ExternalCloudProviderType; + + /** + * This can be '{externalSubscriptionId}' for linked account or '{externalBillingAccountId}' for consolidated account used with dimension/query operations. + */ + @path + externalCloudProviderId: string; + }, + Error = ErrorResponse + >; +} + +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-interface-requires-decorator" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +interface GenerateReservationDetailsReportOperationGroup { + /** + * 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 + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @operationId("GenerateReservationDetailsReport_ByBillingAccountId") + @externalDocs("https://docs.microsoft.com/en-us/rest/api/costmanagement/") + @autoRoute + @action("generateReservationDetailsReport") + @post + @armResourceCollectionAction + byBillingAccountId( + ...ApiVersionParameter, + + /** the provider namespace */ + @path + @segment("providers") + @key + providerNamespace: "microsoft.Billing", + + /** + * BillingAccount ID + */ + @path + @segment("billingAccounts") + billingAccountId: string, + + ...Azure.ResourceManager.Legacy.Provider, + + /** + * Start Date + */ + @query("startDate") + startDate: string, + + /** + * End Date + */ + @query("endDate") + endDate: string, + ): ArmResponse | ArmAcceptedLroResponse> | ErrorResponse; + /** + * 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 + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @operationId("GenerateReservationDetailsReport_ByBillingProfileId") + @autoRoute + @action("generateReservationDetailsReport") + @externalDocs("https://docs.microsoft.com/en-us/rest/api/costmanagement/") + @post + @armResourceCollectionAction + byBillingProfileId( + ...ApiVersionParameter, + + /** the provider namespace */ + @path + @segment("providers") + @key + providerNamespace: "microsoft.Billing", + + /** + * BillingAccount ID + */ + @path + @segment("billingAccounts") + billingAccountId: string, + + /** + * Billing Profile ID. + */ + @path + @segment("billingProfiles") + billingProfileId: string, + + ...Azure.ResourceManager.Legacy.Provider, + + /** + * Start Date + */ + @query("startDate") + startDate: string, + + /** + * End Date + */ + @query("endDate") + endDate: string, + ): ArmResponse | ArmAcceptedLroResponse> | ErrorResponse; +} + +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-interface-requires-decorator" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +interface PriceSheetOperationGroup { + /** + * 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. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @operationId("PriceSheet_DownloadByInvoice") + @autoRoute + @action("pricesheets/default/download") + @post + @armResourceCollectionAction + downloadByInvoice( + ...ApiVersionParameter, + + /** the provider namespace */ + @path + @segment("providers") + @key + providerNamespace: "microsoft.Billing", + + /** + * BillingAccount ID + */ + @path + @segment("billingAccounts") + @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}") + billingAccountName: string, + + /** + * Billing Profile Name. + */ + @path + @segment("billingProfiles") + @pattern("([A-Za-z0-9]+(-[A-Za-z0-9]+)+)") + billingProfileName: string, + + /** + * The ID that uniquely identifies an invoice. + */ + @pattern("[A-Za-z0-9]+") + @path + @segment("invoices") + invoiceName: string, + + ...Azure.ResourceManager.Legacy.Provider, + ): DownloadURL | (ArmAcceptedLroResponse> & { + /** + * The operation entity Id GUID. + */ + @header("OData-EntityId") + odataEntityId: string; + }) | ErrorResponse; + /** + * 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. + * + * You 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. + * + * Due 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. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @operationId("PriceSheet_DownloadByBillingProfile") + @autoRoute + @action("pricesheets/default/download") + @post + @armResourceCollectionAction + downloadByBillingProfile( + ...ApiVersionParameter, + + /** the provider namespace */ + @path + @segment("providers") + @key + providerNamespace: "microsoft.Billing", + + /** + * BillingAccount ID + */ + @path + @segment("billingAccounts") + @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}") + billingAccountName: string, + + /** + * Billing Profile Name. + */ + @path + @segment("billingProfiles") + @pattern("([A-Za-z0-9]+(-[A-Za-z0-9]+)+)") + billingProfileName: string, + + ...Azure.ResourceManager.Legacy.Provider, + ): PricesheetDownloadProperties | (ArmAcceptedLroResponse> & { + /** + * The operation entity Id GUID. + */ + @header("OData-EntityId") + odataEntityId: string; + }) | ErrorResponse; + + /** + * Generates the pricesheet for the provided billing period asynchronously based on the Enrollment ID. This is for Enterprise Agreement customers. + * + * **Migrate to version 2025-03-01** + * + * You can use the 2025-03-01 API version with the new URI: + * + * '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingPeriods/{billingPeriodName}/providers/Microsoft.CostManagement/pricesheets/default/download' + * + * With 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. + * + * The 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. + * + * The 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. + * + * All 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. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @operationId("PriceSheet_DownloadByBillingAccount") + @autoRoute + @post + @action("pricesheets/default/download") + @armResourceCollectionAction + downloadByBillingAccount( + ...ApiVersionParameter, + + /** the provider namespace */ + @path + @segment("providers") + @key + providerNamespace: "microsoft.Billing", + + /** + * BillingAccount ID + */ + @path + @segment("billingAccounts") + billingAccountId: string, + + /** + * Billing Period Name. + */ + @pattern("^[0-9]*$") + @path + @segment("billingPeriods") + billingPeriodName: string, + + ...Azure.ResourceManager.Legacy.Provider, + ): OperationStatus | ArmAcceptedLroResponse> | CommonTypes.ErrorResponse; +} + +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-interface-requires-decorator" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +interface ScheduledActionsOperationGroup { + /** + * Checks availability and correctness of the name for a scheduled action. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @operationId("ScheduledActions_CheckNameAvailability") + @autoRoute + checkNameAvailability is ArmProviderActionSync< + Request = Azure.ResourceManager.CommonTypes.CheckNameAvailabilityRequest, + Response = Azure.ResourceManager.CommonTypes.CheckNameAvailabilityResponse, + Error = ErrorResponseWithNestedDetails + >; + /** + * Checks availability and correctness of the name for a scheduled action within the given scope. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @operationId("ScheduledActions_CheckNameAvailabilityByScope") + @route("/{scope}/providers/Microsoft.CostManagement/checkNameAvailability") + @post + checkNameAvailabilityByScope( + ...ApiVersionParameter, + + /** + * 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. + */ + @path + scope: string, + + /** + * Scheduled action to be created or updated. + */ + @bodyRoot + checkNameAvailabilityRequest: Azure.ResourceManager.CommonTypes.CheckNameAvailabilityRequest, + ): ArmResponse | ErrorResponseWithNestedDetails; +} + +@armResourceOperations +interface GenerateCostDetailsReport { + /** + * Get the result of the specified operation. This link is provided in the CostDetails creation request response Location header. + */ + #suppress "@azure-tools/typespec-client-generator-core/mark-as-lro-ineffective" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-resource-manager/lro-location-header" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @Azure.ClientGenerator.Core.Legacy.markAsLro + getOperationResults( + ...ApiVersionParameter, + + /** + * 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. + */ + @path(#{ allowReserved: true }) + scope: string, + + ...Azure.ResourceManager.Legacy.Provider, + + /** + * The target operation Id. + */ + @path + @segment("costDetailsOperationResults") + operationId: string, + ): ArmResponse | ArmAcceptedResponse | ErrorResponse; +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/common-types.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/common-types.json deleted file mode 100644 index 129987696574..000000000000 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/common-types.json +++ /dev/null @@ -1,231 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "version": "2025-03-01", - "title": "CostManagementClient" - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ], - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Azure Active Directory OAuth2 Flow.", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "paths": { - "/providers/Microsoft.CostManagement/operations": { - "get": { - "tags": [ - "Operations" - ], - "operationId": "Operations_List", - "description": "Lists all of the available cost management REST API operations.", - "x-ms-examples": { - "OperationList": { - "$ref": "./examples/OperationList.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK. The request has succeeded.", - "schema": { - "$ref": "#/definitions/OperationListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - } - }, - "definitions": { - "ErrorResponse": { - "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.", - "type": "object", - "properties": { - "error": { - "description": "The details of the error.", - "$ref": "#/definitions/ErrorDetails" - } - } - }, - "ErrorDetails": { - "description": "The details of the error.", - "type": "object", - "properties": { - "code": { - "description": "Error code.", - "type": "string", - "readOnly": true - }, - "message": { - "description": "Error message indicating why the operation failed.", - "type": "string", - "readOnly": true - } - } - }, - "ErrorDetailsWithNestedDetails": { - "description": "The details of the error.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ErrorDetails" - } - ], - "properties": { - "details": { - "type": "array", - "readOnly": true, - "description": "The additional details of the error.", - "items": { - "$ref": "#/definitions/ErrorDetailsWithNestedDetails" - }, - "x-ms-identifiers": [] - } - } - }, - "ErrorResponseWithNestedDetails": { - "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.", - "type": "object", - "properties": { - "error": { - "description": "The details of the error.", - "$ref": "#/definitions/ErrorDetailsWithNestedDetails" - } - } - }, - "CostManagementOperation": { - "description": "A Cost management REST API operation.", - "type": "object", - "properties": { - "id": { - "description": "Operation id: {provider}/{resource}/{operation}.", - "type": "string", - "readOnly": true - } - }, - "allOf": [ - { - "$ref": "../../../../../../common-types/resource-management/v2/types.json#/definitions/Operation" - } - ] - }, - "OperationListResult": { - "description": "Result of listing cost management operations. It contains a list of operations and a URL link to get the next set of results.", - "type": "object", - "properties": { - "value": { - "description": "List of cost management operations supported by the Microsoft.CostManagement resource provider.", - "type": "array", - "readOnly": true, - "items": { - "$ref": "#/definitions/CostManagementOperation" - } - }, - "nextLink": { - "description": "URL to get the next set of operation list results if there are any.", - "type": "string", - "readOnly": true - } - } - }, - "CostManagementProxyResource": { - "description": "The Resource model definition.", - "type": "object", - "properties": { - "id": { - "readOnly": true, - "type": "string", - "description": "Resource Id." - }, - "name": { - "readOnly": true, - "type": "string", - "description": "Resource name." - }, - "type": { - "readOnly": true, - "type": "string", - "description": "Resource type." - }, - "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." - } - }, - "x-ms-azure-resource": true - }, - "DownloadURL": { - "description": "The URL to download the generated report.", - "type": "object", - "properties": { - "expiryTime": { - "description": "The time at which report URL becomes invalid/expires in UTC e.g. 2020-12-08T05:55:59.4394737Z.", - "type": "string", - "format": "date-time", - "readOnly": true - }, - "validTill": { - "description": "The time at which report URL becomes invalid/expires in UTC e.g. 2020-12-08T05:55:59.4394737Z.", - "type": "string", - "format": "date-time" - }, - "downloadUrl": { - "description": "The URL to download the generated report.", - "type": "string" - } - } - } - }, - "parameters": { - "billingAccountIdParameter": { - "description": "Billing account ID", - "in": "path", - "name": "billingAccountId", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "billingProfileIdParameter": { - "description": "Billing profile ID.", - "in": "path", - "name": "billingProfileId", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - } - } -} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/costallocation.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/costallocation.json deleted file mode 100644 index 1d8c41229582..000000000000 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/costallocation.json +++ /dev/null @@ -1,617 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "CostManagementClient", - "version": "2025-03-01" - }, - "tags": [ - { - "name": "CostAllocationRules", - "description": "An API for creating and managing cost allocation rules within a billing account or enterprise enrollment. These rules can be used to reallocate cost between resources, filtered by Resource Group, Subscription, or Tag." - } - ], - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ], - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Azure Active Directory OAuth2 Flow.", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "paths": { - "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.CostManagement/costAllocationRules": { - "get": { - "tags": [ - "CostAllocationRules" - ], - "operationId": "CostAllocationRules_List", - "description": "Get the list of all cost allocation rules for a billing account or enterprise enrollment.", - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "CostAllocationRulesList": { - "$ref": "./examples/CostAllocationRulesList.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/billingAccountIdParameter" - } - ], - "responses": { - "200": { - "description": "List of cost allocation rules for the billing account or enterprise enrollment.", - "schema": { - "$ref": "#/definitions/CostAllocationRuleList" - } - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.CostManagement/costAllocationRules/checkNameAvailability": { - "post": { - "tags": [ - "CostAllocationRules" - ], - "operationId": "CostAllocationRules_CheckNameAvailability", - "description": "Checks availability and correctness of a name for a cost allocation rule", - "x-ms-examples": { - "CostAllocationRuleCheckNameAvailability": { - "$ref": "./examples/CostAllocationRuleCheckNameAvailability.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/billingAccountIdParameter" - }, - { - "name": "costAllocationRuleCheckNameAvailabilityRequest", - "description": "Cost allocation rule to be created or updated", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/CostAllocationRuleCheckNameAvailabilityRequest" - } - } - ], - "responses": { - "200": { - "description": "Response of cost allocation rule name availability.", - "schema": { - "$ref": "#/definitions/CostAllocationRuleCheckNameAvailabilityResponse" - } - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.CostManagement/costAllocationRules/{ruleName}": { - "get": { - "tags": [ - "CostAllocationRules" - ], - "operationId": "CostAllocationRules_Get", - "description": "Get a cost allocation rule by rule name and billing account or enterprise enrollment.", - "x-ms-examples": { - "CostAllocationRules": { - "$ref": "./examples/CostAllocationRuleGet.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/billingAccountIdParameter" - }, - { - "$ref": "#/parameters/ruleNameParameter" - } - ], - "responses": { - "200": { - "description": "OK. The request has succeeded.", - "schema": { - "$ref": "#/definitions/CostAllocationRuleDefinition" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "put": { - "tags": [ - "CostAllocationRules" - ], - "operationId": "CostAllocationRules_CreateOrUpdate", - "description": "Create/Update a rule to allocate cost between different resources within a billing account or enterprise enrollment.", - "x-ms-examples": { - "CostAllocationRulesCreateResourceGroup": { - "$ref": "./examples/CostAllocationRuleCreate.json" - }, - "CostAllocationRulesCreateTag": { - "$ref": "./examples/CostAllocationRuleCreateTag.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/billingAccountIdParameter" - }, - { - "$ref": "#/parameters/ruleNameParameter" - }, - { - "name": "costAllocationRule", - "description": "Cost allocation rule to be created or updated", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/CostAllocationRuleDefinition" - } - } - ], - "responses": { - "200": { - "description": "OK. The update request has succeeded.", - "schema": { - "$ref": "#/definitions/CostAllocationRuleDefinition" - } - }, - "201": { - "description": "Created. The request has succeeded.", - "schema": { - "$ref": "#/definitions/CostAllocationRuleDefinition" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "CostAllocationRules" - ], - "operationId": "CostAllocationRules_Delete", - "description": "Delete cost allocation rule for billing account or enterprise enrollment.", - "x-ms-examples": { - "DeleteCostAllocationRule": { - "$ref": "./examples/CostAllocationRuleDelete.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/billingAccountIdParameter" - }, - { - "$ref": "#/parameters/ruleNameParameter" - } - ], - "responses": { - "200": { - "description": "OK. The request has succeeded." - }, - "204": { - "description": "NoContent. Rule did not exist." - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - } - }, - "definitions": { - "ErrorDetails": { - "description": "The details of the error.", - "type": "object", - "properties": { - "code": { - "description": "Error code.", - "type": "string", - "readOnly": true - }, - "message": { - "description": "Error message indicating why the operation failed.", - "type": "string", - "readOnly": true - } - } - }, - "ErrorResponse": { - "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.", - "type": "object", - "properties": { - "error": { - "description": "The details of the error.", - "$ref": "#/definitions/ErrorDetails" - } - } - }, - "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": { - "description": "The list of cost allocation rules.", - "type": "array", - "items": { - "$ref": "#/definitions/CostAllocationRuleDefinition" - }, - "x-ms-identifiers": [ - "id" - ] - }, - "nextLink": { - "description": "URL to get the next set of rule list results if there are any.", - "type": "string", - "readOnly": true - } - } - }, - "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" - } - } - }, - "Reason": { - "type": "string", - "description": "The reason this name is not available.", - "enum": [ - "Invalid", - "AlreadyExists", - "Valid" - ], - "x-ms-enum": { - "name": "Reason", - "modelAsString": true - } - }, - "CostAllocationRuleDefinition": { - "type": "object", - "description": "The cost allocation rule model definition", - "properties": { - "id": { - "type": "string", - "readOnly": true, - "description": "Azure Resource Manager Id for the rule. This is a read ony value." - }, - "name": { - "type": "string", - "readOnly": true, - "description": "Name of the rule. This is a read only value." - }, - "type": { - "type": "string", - "readOnly": true, - "description": "Resource type of the rule. This is a read only value of Microsoft.CostManagement/CostAllocationRule." - }, - "properties": { - "description": "Cost allocation rule properties", - "$ref": "#/definitions/CostAllocationRuleProperties" - } - }, - "x-ms-azure-resource": true - }, - "CostAllocationRuleProperties": { - "type": "object", - "description": "The properties of a cost allocation rule", - "additionalProperties": false, - "required": [ - "details", - "status" - ], - "properties": { - "description": { - "description": "Description of a cost allocation rule.", - "type": "string" - }, - "details": { - "description": "Resource information for the cost allocation rule", - "$ref": "#/definitions/CostAllocationRuleDetails" - }, - "status": { - "$ref": "#/definitions/RuleStatus", - "description": "Status of the rule" - }, - "createdDate": { - "type": "string", - "format": "date-time", - "readOnly": true, - "description": "Time at which the rule was created. Rules that change cost for the same resource are applied in order of creation." - }, - "updatedDate": { - "type": "string", - "format": "date-time", - "readOnly": true, - "description": "Time at which the rule was last updated." - } - } - }, - "RuleStatus": { - "type": "string", - "description": "Current status of the rule.", - "enum": [ - "NotActive", - "Active", - "Processing" - ], - "x-ms-enum": { - "name": "RuleStatus", - "modelAsString": true, - "values": [ - { - "value": "NotActive", - "description": "Rule is saved but not used to allocate costs.", - "name": "NotActive" - }, - { - "value": "Active", - "description": "Rule is saved and impacting cost allocation.", - "name": "Active" - }, - { - "value": "Processing", - "description": "Rule is saved and cost allocation is being updated. Readonly value that cannot be submitted in a put request.", - "name": "Processing" - } - ] - } - }, - "CostAllocationRuleDetails": { - "type": "object", - "description": "Resource details of the cost allocation rule", - "properties": { - "sourceResources": { - "description": "Source resources for cost allocation. At this time, this list can contain no more than one element.", - "type": "array", - "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" - ] - } - } - }, - "CostAllocationResource": { - "type": "object", - "description": "Common values for resources for cost allocation", - "required": [ - "resourceType", - "name" - ], - "properties": { - "resourceType": { - "description": "Type of resources contained in this cost allocation rule", - "$ref": "#/definitions/CostAllocationResourceType" - }, - "name": { - "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", - "type": "string" - } - } - }, - "SourceCostAllocationResource": { - "allOf": [ - { - "$ref": "#/definitions/CostAllocationResource" - }, - { - "type": "object", - "properties": { - "values": { - "description": "Source Resources for cost allocation. This list cannot contain more than 25 values.", - "type": "array", - "items": { - "description": "Source resource for cost allocation", - "type": "string" - }, - "x-ms-identifiers": [ - "name" - ] - } - }, - "required": [ - "values" - ] - } - ], - "description": "Source resources for cost allocation" - }, - "TargetCostAllocationResource": { - "description": "Target resources for cost allocation.", - "allOf": [ - { - "$ref": "#/definitions/CostAllocationResource" - }, - { - "type": "object", - "properties": { - "values": { - "description": "Target resources for cost allocation. This list cannot contain more than 25 values.", - "type": "array", - "items": { - "$ref": "#/definitions/CostAllocationProportion" - }, - "x-ms-identifiers": [ - "name" - ] - }, - "policyType": { - "description": "Method of cost allocation for the rule", - "$ref": "#/definitions/CostAllocationPolicyType" - } - }, - "required": [ - "values", - "policyType" - ] - } - ] - }, - "CostAllocationResourceType": { - "type": "string", - "description": "Category of resource to use for allocation.", - "enum": [ - "Dimension", - "Tag" - ], - "x-ms-enum": { - "name": "CostAllocationResourceType", - "modelAsString": true, - "values": [ - { - "value": "Dimension", - "description": "Indicates an Azure dimension such as a subscription id or resource group name is being used for allocation.", - "name": "Dimension" - }, - { - "value": "Tag", - "description": "Allocates cost based on Azure Tag key value pairs.", - "name": "Tag" - } - ] - } - }, - "CostAllocationProportion": { - "type": "object", - "description": "Target resources and allocation", - "required": [ - "percentage", - "name" - ], - "properties": { - "name": { - "description": "Target resource for cost allocation", - "type": "string" - }, - "percentage": { - "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.", - "type": "number" - } - } - }, - "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 - } - } - }, - "parameters": { - "billingAccountIdParameter": { - "name": "billingAccountId", - "in": "path", - "description": "BillingAccount ID", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "ruleNameParameter": { - "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", - "x-ms-parameter-location": "method", - "pattern": "[A-Za-z0-9\\-_]+" - } - } -} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/costmanagement.benefits.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/costmanagement.benefits.json deleted file mode 100644 index 604a312a50de..000000000000 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/costmanagement.benefits.json +++ /dev/null @@ -1,1481 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "CostManagementClient", - "description": "CostManagement management client provides access to CostManagement resources for Azure Enterprise Subscriptions.", - "version": "2025-03-01" - }, - "tags": [ - { - "name": "Benefits API", - "description": "APIs for getting benefit recommendations and benefit utilization summaries." - } - ], - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ], - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "description": "Azure Active Directory OAuth2 Flow.", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "paths": { - "/{billingScope}/providers/Microsoft.CostManagement/benefitRecommendations": { - "get": { - "tags": [ - "BenefitRecommendations" - ], - "description": "List of recommendations for purchasing savings plan.", - "externalDocs": { - "url": "https://docs.microsoft.com/en-us/rest/api/CostManagement/" - }, - "x-ms-examples": { - "BenefitRecommendationsBillingAccountList": { - "$ref": "./examples/BenefitRecommendationsByBillingAccount.json" - } - }, - "operationId": "BenefitRecommendations_List", - "parameters": [ - { - "$ref": "#/parameters/benefitRecommendationsFilterParameter" - }, - { - "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.", - "type": "string", - "x-ms-parameter-location": "method" - }, - { - "name": "$expand", - "in": "query", - "description": "May be used to expand the properties by: properties/usage, properties/allRecommendationDetails", - "type": "string", - "x-ms-parameter-location": "method" - }, - { - "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/billingScopeBenefitRecommendationParameter" - } - ], - "responses": { - "200": { - "description": "OK. The request has succeeded.", - "schema": { - "$ref": "#/definitions/benefitRecommendationsListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "common-types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.CostManagement/benefitUtilizationSummaries": { - "get": { - "tags": [ - "BenefitUtilizationSummaries" - ], - "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/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "common-types.json#/parameters/billingAccountIdParameter" - }, - { - "$ref": "#/parameters/grainParameter" - }, - { - "name": "filter", - "in": "query", - "description": "Supports filtering by properties/benefitId, properties/benefitOrderId and properties/usageDate.", - "required": false, - "type": "string", - "x-ms-parameter-location": "method" - } - ], - "responses": { - "200": { - "description": "OK. The request has succeeded.", - "schema": { - "$ref": "#/definitions/BenefitUtilizationSummariesListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "common-types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "SavingsPlanUtilizationSummaries-BillingAccount": { - "$ref": "./examples/BenefitUtilizationSummaries/SavingsPlan-BillingAccount.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/providers/Microsoft.CostManagement/benefitUtilizationSummaries": { - "get": { - "tags": [ - "BenefitUtilizationSummaries" - ], - "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/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "common-types.json#/parameters/billingAccountIdParameter" - }, - { - "$ref": "common-types.json#/parameters/billingProfileIdParameter" - }, - { - "$ref": "#/parameters/grainParameter" - }, - { - "name": "filter", - "in": "query", - "description": "Supports filtering by properties/benefitId, properties/benefitOrderId and properties/usageDate.", - "required": false, - "type": "string", - "x-ms-parameter-location": "method" - } - ], - "responses": { - "200": { - "description": "OK. The request has succeeded.", - "schema": { - "$ref": "#/definitions/BenefitUtilizationSummariesListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "common-types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "SavingsPlanUtilizationSummaries-BillingProfile": { - "$ref": "./examples/BenefitUtilizationSummaries/SavingsPlan-BillingProfile.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/providers/Microsoft.BillingBenefits/savingsPlanOrders/{savingsPlanOrderId}/providers/Microsoft.CostManagement/benefitUtilizationSummaries": { - "get": { - "tags": [ - "BenefitUtilizationSummaries" - ], - "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/" - }, - "x-ms-examples": { - "SavingsPlanUtilizationSummariesDaily": { - "$ref": "./examples/BenefitUtilizationSummaries/SavingsPlan-SavingsPlanOrderId-Daily.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "name": "$filter", - "description": "Supports filtering by properties/usageDate.", - "in": "query", - "required": false, - "type": "string" - }, - { - "$ref": "#/parameters/grainParameter" - }, - { - "$ref": "#/parameters/savingsPlanOrderIdParameter" - } - ], - "responses": { - "200": { - "description": "OK. The request has succeeded.", - "schema": { - "$ref": "#/definitions/BenefitUtilizationSummariesListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "common-types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/providers/Microsoft.BillingBenefits/savingsPlanOrders/{savingsPlanOrderId}/savingsPlans/{savingsPlanId}/providers/Microsoft.CostManagement/benefitUtilizationSummaries": { - "get": { - "tags": [ - "BenefitUtilizationSummaries" - ], - "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/" - }, - "x-ms-examples": { - "SavingsPlanUtilizationSummariesMonthlyWithSavingsPlanId": { - "$ref": "./examples/BenefitUtilizationSummaries/SavingsPlan-SavingsPlanId-Monthly.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "name": "$filter", - "description": "Supports filtering by properties/usageDate.", - "in": "query", - "required": false, - "type": "string" - }, - { - "$ref": "#/parameters/grainParameter" - }, - { - "$ref": "#/parameters/savingsPlanOrderIdParameter" - }, - { - "$ref": "#/parameters/savingsPlanIdParameter" - } - ], - "responses": { - "200": { - "description": "OK. The request has succeeded.", - "schema": { - "$ref": "#/definitions/BenefitUtilizationSummariesListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "common-types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.CostManagement/generateBenefitUtilizationSummariesReport": { - "post": { - "tags": [ - "BenefitUtilizationSummariesAsync" - ], - "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/" - }, - "x-ms-examples": { - "GenerateUtilizationSummariesReportByBillingAccount": { - "$ref": "./examples/BenefitUtilizationSummaries/Async/GenerateBenefitUtilizationSummariesReportByBillingAccount.json" - } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" - }, - "parameters": [ - { - "$ref": "common-types.json#/parameters/billingAccountIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "name": "benefitUtilizationSummariesRequest", - "description": "Async Benefit Utilization Summary report to be created.", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/BenefitUtilizationSummariesRequest" - } - } - ], - "responses": { - "200": { - "description": "The status of the generation of the benefit utilization summaries report. This could be in progress, failed, or completed.", - "schema": { - "$ref": "#/definitions/BenefitUtilizationSummariesOperationStatus" - } - }, - "202": { - "description": "Accepted. Request will be processed. Use the location header to check the status.", - "headers": { - "Location": { - "description": "The URL to check the status of the asynchronous operation.", - "type": "string" - }, - "Retry-After": { - "description": "The amount of delay to use while the status of the operation is checked. The value is expressed in seconds.", - "format": "int32", - "type": "integer" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - } - }, - "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/providers/Microsoft.CostManagement/generateBenefitUtilizationSummariesReport": { - "post": { - "tags": [ - "BenefitUtilizationSummariesAsync" - ], - "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/" - }, - "x-ms-examples": { - "GenerateUtilizationSummariesReportByBillingProfile": { - "$ref": "./examples/BenefitUtilizationSummaries/Async/GenerateBenefitUtilizationSummariesReportByBillingProfile.json" - } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" - }, - "parameters": [ - { - "$ref": "common-types.json#/parameters/billingAccountIdParameter" - }, - { - "$ref": "common-types.json#/parameters/billingProfileIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "name": "benefitUtilizationSummariesRequest", - "description": "Async Benefit Utilization Summary report to be created.", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/BenefitUtilizationSummariesRequest" - } - } - ], - "responses": { - "200": { - "description": "The status of the generation of the benefit utilization summaries report. This could be in progress, failed, or completed.", - "schema": { - "$ref": "#/definitions/BenefitUtilizationSummariesOperationStatus" - } - }, - "202": { - "description": "Accepted. Request will be processed. Use the location header to check the status.", - "headers": { - "Location": { - "description": "The URL to check the status of the asynchronous operation.", - "type": "string" - }, - "Retry-After": { - "description": "The amount of delay to use while the status of the operation is checked. The value is expressed in seconds.", - "format": "int32", - "type": "integer" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - } - }, - "/providers/Microsoft.Capacity/reservationorders/{reservationOrderId}/providers/Microsoft.CostManagement/generateBenefitUtilizationSummariesReport": { - "post": { - "tags": [ - "BenefitUtilizationSummariesAsync" - ], - "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/" - }, - "x-ms-examples": { - "GenerateUtilizationSummariesReportByReservationOrder": { - "$ref": "./examples/BenefitUtilizationSummaries/Async/GenerateBenefitUtilizationSummariesReportByReservationOrder.json" - } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" - }, - "parameters": [ - { - "$ref": "#/parameters/reservationOrderIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "name": "benefitUtilizationSummariesRequest", - "description": "Async Benefit Utilization Summary report to be created.", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/BenefitUtilizationSummariesRequest" - } - } - ], - "responses": { - "200": { - "description": "The status of the generation of the benefit utilization summaries report. This could be in progress, failed, or completed.", - "schema": { - "$ref": "#/definitions/BenefitUtilizationSummariesOperationStatus" - } - }, - "202": { - "description": "Accepted. Request will be processed. Use the location header to check the status.", - "headers": { - "Location": { - "description": "The URL to check the status of the asynchronous operation.", - "type": "string" - }, - "Retry-After": { - "description": "The amount of delay to use while the status of the operation is checked. The value is expressed in seconds.", - "format": "int32", - "type": "integer" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - } - }, - "/providers/Microsoft.Capacity/reservationorders/{reservationOrderId}/reservations/{reservationId}/providers/Microsoft.CostManagement/generateBenefitUtilizationSummariesReport": { - "post": { - "tags": [ - "BenefitUtilizationSummariesAsync" - ], - "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/" - }, - "x-ms-examples": { - "GenerateUtilizationSummariesReportByReservation": { - "$ref": "./examples/BenefitUtilizationSummaries/Async/GenerateBenefitUtilizationSummariesReportByReservation.json" - } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" - }, - "parameters": [ - { - "$ref": "#/parameters/reservationOrderIdParameter" - }, - { - "$ref": "#/parameters/reservationIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "name": "benefitUtilizationSummariesRequest", - "description": "Async Benefit Utilization Summary report to be created.", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/BenefitUtilizationSummariesRequest" - } - } - ], - "responses": { - "200": { - "description": "The status of the generation of the benefit utilization summaries report. This could be in progress, failed, or completed.", - "schema": { - "$ref": "#/definitions/BenefitUtilizationSummariesOperationStatus" - } - }, - "202": { - "description": "Accepted. Request will be processed. Use the location header to check the status.", - "headers": { - "Location": { - "description": "The URL to check the status of the asynchronous operation.", - "type": "string" - }, - "Retry-After": { - "description": "The amount of delay to use while the status of the operation is checked. The value is expressed in seconds.", - "format": "int32", - "type": "integer" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - } - }, - "/providers/Microsoft.BillingBenefits/savingsPlanOrders/{savingsPlanOrderId}/providers/Microsoft.CostManagement/generateBenefitUtilizationSummariesReport": { - "post": { - "tags": [ - "BenefitUtilizationSummariesAsync" - ], - "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/" - }, - "x-ms-examples": { - "GenerateUtilizationSummariesReportBySavingsPlanOrder": { - "$ref": "./examples/BenefitUtilizationSummaries/Async/GenerateBenefitUtilizationSummariesReportBySavingsPlanOrder.json" - } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" - }, - "parameters": [ - { - "$ref": "#/parameters/savingsPlanOrderIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "name": "benefitUtilizationSummariesRequest", - "description": "Async Benefit Utilization Summary report to be created.", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/BenefitUtilizationSummariesRequest" - } - } - ], - "responses": { - "200": { - "description": "The status of the generation of the benefit utilization summaries report. This could be in progress, failed, or completed.", - "schema": { - "$ref": "#/definitions/BenefitUtilizationSummariesOperationStatus" - } - }, - "202": { - "description": "Accepted. Request will be processed. Use the location header to check the status.", - "headers": { - "Location": { - "description": "The URL to check the status of the asynchronous operation.", - "type": "string" - }, - "Retry-After": { - "description": "The amount of delay to use while the status of the operation is checked. The value is expressed in seconds.", - "format": "int32", - "type": "integer" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - } - }, - "/providers/Microsoft.BillingBenefits/savingsPlanOrders/{savingsPlanOrderId}/savingsPlans/{savingsPlanId}/providers/Microsoft.CostManagement/generateBenefitUtilizationSummariesReport": { - "post": { - "tags": [ - "BenefitUtilizationSummariesAsync" - ], - "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/" - }, - "x-ms-examples": { - "GenerateUtilizationSummariesReportBySavingsPlan": { - "$ref": "./examples/BenefitUtilizationSummaries/Async/GenerateBenefitUtilizationSummariesReportBySavingsPlan.json" - } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" - }, - "parameters": [ - { - "$ref": "#/parameters/savingsPlanOrderIdParameter" - }, - { - "$ref": "#/parameters/savingsPlanIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "name": "benefitUtilizationSummariesRequest", - "description": "Async Benefit Utilization Summary report to be created.", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/BenefitUtilizationSummariesRequest" - } - } - ], - "responses": { - "200": { - "description": "The status of the generation of the benefit utilization summaries report. This could be in progress, failed, or completed.", - "schema": { - "$ref": "#/definitions/BenefitUtilizationSummariesOperationStatus" - } - }, - "202": { - "description": "Accepted. Request will be processed. Use the location header to check the status.", - "headers": { - "Location": { - "description": "The URL to check the status of the asynchronous operation.", - "type": "string" - }, - "Retry-After": { - "description": "The amount of delay to use while the status of the operation is checked. The value is expressed in seconds.", - "format": "int32", - "type": "integer" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - } - } - }, - "definitions": { - "benefitRecommendationsListResult": { - "type": "object", - "properties": { - "value": { - "type": "array", - "description": "The list of benefit recommendations.", - "readOnly": true, - "items": { - "$ref": "#/definitions/benefitRecommendationModel" - } - }, - "nextLink": { - "type": "string", - "description": "The link (URL) to the next page of results.", - "readOnly": true, - "format": "uri" - } - }, - "description": "Result of listing benefit recommendations." - }, - "benefitRecommendationModel": { - "type": "object", - "description": "benefit plan recommendation details.", - "allOf": [ - { - "$ref": "#/definitions/BenefitResource" - } - ], - "properties": { - "properties": { - "type": "object", - "$ref": "#/definitions/benefitRecommendationProperties" - } - } - }, - "benefitRecommendationProperties": { - "type": "object", - "description": "The properties of the benefit recommendations.", - "discriminator": "scope", - "properties": { - "firstConsumptionDate": { - "type": "string", - "description": "The first usage date used for looking back for computing the recommendations.", - "readOnly": true, - "format": "date-time" - }, - "lastConsumptionDate": { - "type": "string", - "description": "The last usage date used for looking back for computing the recommendations.", - "readOnly": true, - "format": "date-time" - }, - "lookBackPeriod": { - "description": "The number of days of usage evaluated for computing the recommendations.", - "$ref": "#/definitions/LookBackPeriod" - }, - "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": { - "type": "object", - "description": "On-demand charges between firstConsumptionDate and lastConsumptionDate that were used for computing benefit recommendations.", - "$ref": "#/definitions/recommendationUsageDetails" - }, - "armSkuName": { - "description": "ARM SKU name. 'Compute_Savings_Plan' for SavingsPlan.", - "type": "string", - "readOnly": true - }, - "term": { - "description": "Term period of the benefit. For example, P1Y or P3Y.", - "$ref": "#/definitions/Term" - }, - "commitmentGranularity": { - "description": "Grain of the proposed commitment amount. Supported values: 'Hourly'", - "$ref": "#/definitions/Grain" - }, - "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": { - "type": "object", - "description": "The details of the proposed recommendation.", - "$ref": "#/definitions/allSavingsBenefitDetails" - }, - "allRecommendationDetails": { - "type": "object", - "description": "The list of all benefit recommendations with the recommendation details.", - "readOnly": true, - "$ref": "#/definitions/allSavingsList" - }, - "scope": { - "description": "Benefit scope. For example, Single or Shared.", - "$ref": "#/definitions/RecommendationScope" - } - }, - "required": [ - "scope" - ] - }, - "singleScopeBenefitRecommendationProperties": { - "type": "object", - "description": "The properties of the benefit recommendations when scope is 'Single'.", - "x-ms-discriminator-value": "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" - } - ] - }, - "sharedScopeBenefitRecommendationProperties": { - "type": "object", - "description": "The properties of the benefit recommendation when scope is 'Shared'.", - "x-ms-discriminator-value": "Shared", - "allOf": [ - { - "$ref": "#/definitions/benefitRecommendationProperties" - } - ] - }, - "recommendationUsageDetails": { - "type": "object", - "description": "On-demand charges between firstConsumptionDate and lastConsumptionDate that were used for computing benefit recommendations.", - "properties": { - "usageGrain": { - "description": "The grain of the usage. Supported values: 'Hourly'", - "$ref": "#/definitions/Grain" - }, - "charges": { - "type": "array", - "description": "On-demand charges for each hour between firstConsumptionDate and lastConsumptionDate that were used for computing benefit recommendations.", - "readOnly": true, - "items": { - "type": "number", - "format": "decimal" - } - } - } - }, - "allSavingsList": { - "type": "object", - "properties": { - "value": { - "type": "array", - "description": "The list of benefit recommendations with the recommendation details..", - "readOnly": true, - "items": { - "$ref": "#/definitions/allSavingsBenefitDetails" - }, - "x-ms-identifiers": [] - }, - "nextLink": { - "type": "string", - "description": "The link (URL) to the next page of results.", - "readOnly": true, - "format": "uri" - } - }, - "description": "The list of all benefit recommendations with the recommendation details." - }, - "allSavingsBenefitDetails": { - "description": "Benefit recommendation details.", - "type": "object", - "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": { - "description": "Estimated benefit coverage percentage for the 'totalHours' in the look-back period, with this commitment.", - "type": "number", - "format": "decimal", - "readOnly": true - }, - "commitmentAmount": { - "description": "The commitment amount at the commitmentGranularity.", - "type": "number", - "format": "decimal", - "readOnly": true - }, - "averageUtilizationPercentage": { - "description": "Estimated average utilization percentage for the 'totalHours' in the look-back period, with this commitment.", - "type": "number", - "format": "decimal", - "readOnly": true - }, - "wastageCost": { - "description": "Estimated unused portion of the 'benefitCost'.", - "type": "number", - "format": "decimal", - "readOnly": true - } - } - }, - "BenefitKind": { - "type": "string", - "description": "Kind/type of the benefit.", - "enum": [ - "IncludedQuantity", - "Reservation", - "SavingsPlan" - ], - "x-ms-enum": { - "name": "benefitKind", - "modelAsString": true, - "values": [ - { - "value": "IncludedQuantity", - "description": "Benefit is IncludedQuantity.", - "name": "IncludedQuantity" - }, - { - "value": "Reservation", - "description": "Benefit is Reservation.", - "name": "Reservation" - }, - { - "value": "SavingsPlan", - "description": "Benefit is SavingsPlan.", - "name": "SavingsPlan" - } - ] - } - }, - "RecommendationScope": { - "type": "string", - "description": "Kind of the recommendation scope.", - "enum": [ - "Single", - "Shared" - ], - "x-ms-enum": { - "name": "scope", - "modelAsString": true, - "values": [ - { - "value": "Single", - "description": "Single scope recommendation.", - "name": "Single" - }, - { - "value": "Shared", - "description": "Shared scope recommendation.", - "name": "Shared" - } - ] - } - }, - "Grain": { - "type": "string", - "description": "Grain which corresponds to value.", - "enum": [ - "Hourly", - "Daily", - "Monthly" - ], - "x-ms-enum": { - "name": "grain", - "modelAsString": true, - "values": [ - { - "value": "Hourly", - "description": "Hourly grain corresponds to value per hour.", - "name": "Hourly" - }, - { - "value": "Daily", - "description": "Hourly grain corresponds to value per day.", - "name": "Daily" - }, - { - "value": "Monthly", - "description": "Hourly grain corresponds to value per month.", - "name": "Monthly" - } - ] - } - }, - "Term": { - "type": "string", - "description": "Grain which corresponds to value.", - "enum": [ - "P1Y", - "P3Y" - ], - "x-ms-enum": { - "name": "term", - "modelAsString": true, - "values": [ - { - "value": "P1Y", - "description": "Benefit term is 1 year.", - "name": "P1Y" - }, - { - "value": "P3Y", - "description": "Benefit term is 3 years.", - "name": "P3Y" - } - ] - } - }, - "LookBackPeriod": { - "type": "string", - "description": "The number of days used to look back.", - "enum": [ - "Last7Days", - "Last30Days", - "Last60Days" - ], - "x-ms-enum": { - "name": "lookBackPeriod", - "modelAsString": true, - "values": [ - { - "value": "Last7Days", - "description": "7 days used to look back.", - "name": "Last7Days" - }, - { - "value": "Last30Days", - "description": "30 days used to look back.", - "name": "Last30Days" - }, - { - "value": "Last60Days", - "description": "60 days used to look back.", - "name": "Last60Days" - } - ] - } - }, - "BenefitResource": { - "type": "object", - "description": "The benefit resource model definition.", - "allOf": [ - { - "$ref": "../../../../../../common-types/resource-management/v2/types.json#/definitions/Resource" - } - ], - "properties": { - "kind": { - "description": "Reservation or SavingsPlan.", - "$ref": "#/definitions/BenefitKind" - } - }, - "x-ms-azure-resource": true - }, - "BenefitUtilizationSummariesListResult": { - "description": "List of benefit utilization summaries.", - "type": "object", - "properties": { - "value": { - "description": "The list of benefit utilization summaries.", - "type": "array", - "readOnly": true, - "items": { - "$ref": "#/definitions/BenefitUtilizationSummary" - } - }, - "nextLink": { - "description": "The link (URL) to the next page of results.", - "type": "string", - "readOnly": true, - "format": "uri" - } - } - }, - "BenefitUtilizationSummary": { - "description": "Benefit utilization summary resource.", - "discriminator": "kind", - "type": "object", - "required": [ - "kind" - ], - "allOf": [ - { - "$ref": "../../../../../../common-types/resource-management/v2/types.json#/definitions/Resource" - } - ], - "properties": { - "kind": { - "description": "Supported values: 'SavingsPlan'.", - "$ref": "#/definitions/BenefitKind" - } - } - }, - "BenefitUtilizationSummaryProperties": { - "description": "The properties of a benefit utilization summary.", - "type": "object", - "properties": { - "armSkuName": { - "description": "ARM SKU name. For example, 'Compute_Savings_Plan' for savings plan.", - "type": "string", - "readOnly": true - }, - "benefitId": { - "description": "The benefit ID is the identifier of the benefit.", - "type": "string", - "readOnly": true - }, - "benefitOrderId": { - "description": "The benefit order ID is the identifier for a benefit purchase.", - "type": "string", - "readOnly": true - }, - "benefitType": { - "description": "The benefit type. Supported values: 'SavingsPlan'.", - "$ref": "#/definitions/BenefitKind" - }, - "usageDate": { - "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.", - "type": "string", - "format": "date-time", - "readOnly": true - } - } - }, - "IncludedQuantityUtilizationSummary": { - "description": "Included Quantity utilization summary resource.", - "x-ms-discriminator-value": "IncludedQuantity", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/BenefitUtilizationSummary" - } - ], - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/IncludedQuantityUtilizationSummaryProperties", - "title": "Benefit utilization summary for benefit kind Included Quantity." - } - } - }, - "IncludedQuantityUtilizationSummaryProperties": { - "type": "object", - "description": "Included Quantity utilization summary properties.", - "allOf": [ - { - "$ref": "#/definitions/BenefitUtilizationSummaryProperties" - } - ], - "properties": { - "utilizationPercentage": { - "description": "This is the utilized percentage for the benefit ID.", - "type": "number", - "format": "decimal", - "readOnly": true - } - } - }, - "SavingsPlanUtilizationSummary": { - "description": "Savings plan utilization summary resource.", - "x-ms-discriminator-value": "SavingsPlan", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/BenefitUtilizationSummary" - } - ], - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/SavingsPlanUtilizationSummaryProperties", - "title": "Benefit utilization Summary for benefit kind savings plan." - } - } - }, - "SavingsPlanUtilizationSummaryProperties": { - "type": "object", - "description": "Savings plan utilization summary properties.", - "allOf": [ - { - "$ref": "#/definitions/BenefitUtilizationSummaryProperties" - } - ], - "properties": { - "avgUtilizationPercentage": { - "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.", - "type": "number", - "format": "decimal", - "readOnly": true - }, - "minUtilizationPercentage": { - "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%.", - "type": "number", - "format": "decimal", - "readOnly": true - }, - "maxUtilizationPercentage": { - "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%.", - "type": "number", - "format": "decimal", - "readOnly": true - } - } - }, - "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": { - "description": "The status of the creation of the benefit utilization summaries report.", - "$ref": "#/definitions/AsyncOperationStatusEnum" - }, - "properties": { - "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", - "$ref": "#/definitions/AsyncOperationStatusProperties" - } - } - }, - "AsyncOperationStatusEnum": { - "description": "Enum representing the status of an async operation.", - "type": "string", - "enum": [ - "Running", - "Complete", - "Failed" - ], - "x-ms-enum": { - "name": "OperationStatusType", - "modelAsString": true - } - }, - "AsyncOperationStatusProperties": { - "description": "Object representing the report url and valid until date of the async report generated.", - "type": "object", - "properties": { - "reportUrl": { - "description": "Sas url to the async benefit utilization summaries report. Will be empty if the report is in Running or Failed state.", - "$ref": "#/definitions/BenefitUtilizationSummaryReportSchema", - "x-ms-secret": true - }, - "secondaryReportUrl": { - "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.", - "$ref": "#/definitions/BenefitUtilizationSummaryReportSchema", - "x-ms-secret": true - }, - "validUntil": { - "description": "The date that the sas url provided in reportUrl expires.", - "type": "string", - "format": "date-time" - } - } - }, - "BenefitUtilizationSummaryReportSchema": { - "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.", - "type": "string", - "enum": [ - "Kind", - "AvgUtilizationPercentage", - "BenefitOrderId", - "BenefitId", - "BenefitType", - "MaxUtilizationPercentage", - "MinUtilizationPercentage", - "UsageDate", - "UtilizedPercentage" - ], - "x-ms-enum": { - "name": "BenefitUtilizationSummaryReportSchema", - "modelAsString": true - } - }, - "BenefitUtilizationSummariesRequest": { - "description": "Properties of an async benefit utilization summaries request.", - "type": "object", - "required": [ - "startDate", - "endDate", - "grain" - ], - "properties": { - "billingAccountId": { - "description": "Billing account the benefit utilization summaries report is for. Required for billing account and billing profile scopes. Not supported for any benefit scopes.", - "type": "string" - }, - "billingProfileId": { - "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.", - "type": "string" - }, - "benefitOrderId": { - "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.", - "type": "string" - }, - "benefitId": { - "description": "Benefit id the benefit utilization summaries report is for. Required for benefit id scope. Not supported for benefit order or any billing scopes.", - "type": "string" - }, - "grain": { - "description": "The grain the summaries data is served at in the report. Accepted values are 'Daily' or 'Monthly'.", - "$ref": "#/definitions/Grain" - }, - "startDate": { - "description": "The start date of the summaries data that will be served in the report.", - "type": "string", - "format": "date-time" - }, - "endDate": { - "description": "The end date of the summaries data that will be served in the report.", - "type": "string", - "format": "date-time" - }, - "kind": { - "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", - "$ref": "#/definitions/BenefitKind" - } - } - } - }, - "parameters": { - "benefitAsyncOperationIdParameter": { - "description": "Operation id of the report being generated", - "in": "path", - "name": "operationId", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "benefitRecommendationsFilterParameter": { - "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", - "type": "string", - "x-ms-parameter-location": "method" - }, - "billingScopeBenefitRecommendationParameter": { - "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-parameter-location": "method", - "x-ms-skip-url-encoding": true - }, - "grainParameter": { - "description": "Grain.", - "in": "query", - "required": false, - "x-ms-parameter-location": "method", - "type": "string", - "name": "grainParameter", - "enum": [ - "Hourly", - "Daily", - "Monthly" - ], - "x-ms-enum": { - "name": "grainParameter", - "modelAsString": true, - "values": [ - { - "value": "Hourly", - "description": "Hourly grain corresponds to value per hour.", - "name": "Hourly" - }, - { - "value": "Daily", - "description": "Hourly grain corresponds to value per day.", - "name": "Daily" - }, - { - "value": "Monthly", - "description": "Hourly grain corresponds to value per month.", - "name": "Monthly" - } - ] - } - }, - "reservationIdParameter": { - "description": "Reservation ID", - "in": "path", - "name": "reservationId", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "reservationOrderIdParameter": { - "description": "Reservation Order ID", - "in": "path", - "name": "reservationOrderId", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "savingsPlanIdParameter": { - "description": "Savings plan ID.", - "in": "path", - "name": "savingsPlanId", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "savingsPlanOrderIdParameter": { - "description": "Savings plan order ID.", - "in": "path", - "name": "savingsPlanOrderId", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - } - } -} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/costmanagement.budgets.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/costmanagement.budgets.json deleted file mode 100644 index df16a3f19c23..000000000000 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/costmanagement.budgets.json +++ /dev/null @@ -1,768 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "CostManagementClient", - "description": "CostManagement management client provides access to CostManagement resources for Azure Enterprise Subscriptions.", - "version": "2025-03-01" - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ], - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "description": "Azure Active Directory OAuth2 Flow.", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "paths": { - "/{scope}/providers/Microsoft.CostManagement/budgets": { - "get": { - "tags": [ - "Budgets" - ], - "operationId": "Budgets_List", - "description": "Lists all budgets for the defined scope.", - "externalDocs": { - "url": "https://docs.microsoft.com/en-us/rest/api/CostManagement/" - }, - "x-ms-examples": { - "SubscriptionBudgetsList": { - "$ref": "./examples/Budgets/List/RBAC/SubscriptionBudgetsList.json" - }, - "ResourceGroupBudgetsList": { - "$ref": "./examples/Budgets/List/RBAC/ResourceGroupBudgetsList.json" - }, - "ManagementGroupBudgetsList": { - "$ref": "./examples/Budgets/List/RBAC/ManagementGroupBudgetsList.json" - }, - "BillingAccountBudgetsList-EA": { - "$ref": "./examples/Budgets/List/EA/BillingAccountBudgetsList-EA.json" - }, - "BillingAccountBudgetsList-EA-CategoryTypeFilter": { - "$ref": "./examples/Budgets/List/EA/BillingAccountBudgetsList-EA-CategoryTypeFilter.json" - }, - "DepartmentBudgetsList-EA": { - "$ref": "./examples/Budgets/List/EA/DepartmentBudgetsList.json" - }, - "EnrollmentAccountBudgetsList-EA": { - "$ref": "./examples/Budgets/List/EA/EnrollmentAccountBudgetsList.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" - }, - "InvoiceSectionBudgetsList-MCA": { - "$ref": "./examples/Budgets/List/MCA/InvoiceSectionBudgetsList.json" - }, - "CustomerBudgetsList-MCA-CSP": { - "$ref": "./examples/Budgets/List/MCA/CustomerBudgetsList.json" - }, - "CustomerBudgetsList-MCA-CSP-CategoryTypeFilter": { - "$ref": "./examples/Budgets/List/MCA/CustomerBudgetsList-CategoryTypeFilter.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/scopeBudgetParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/budgetCategoryFilterParameter" - } - ], - "responses": { - "200": { - "description": "OK. The request has succeeded.", - "schema": { - "$ref": "#/definitions/BudgetsListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "common-types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/{scope}/providers/Microsoft.CostManagement/budgets/{budgetName}": { - "get": { - "tags": [ - "Budgets" - ], - "operationId": "Budgets_Get", - "description": "Gets the budget for the scope by budget name.", - "externalDocs": { - "url": "https://docs.microsoft.com/en-us/rest/api/CostManagement/" - }, - "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" - } - }, - "parameters": [ - { - "$ref": "#/parameters/scopeBudgetParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/budgetNameParameter" - } - ], - "responses": { - "200": { - "description": "OK. The request has succeeded.", - "schema": { - "$ref": "#/definitions/Budget" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "common-types.json#/definitions/ErrorResponse" - } - } - } - }, - "put": { - "tags": [ - "Budgets" - ], - "operationId": "Budgets_CreateOrUpdate", - "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/" - }, - "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-ReservedResourceTypeFilter": { - "$ref": "./examples/Budgets/CreateOrUpdate/ReservationUtilization/EA/BillingAccountEA-AlertRule-ReservedResourceTypeFilter.json" - }, - "CreateOrUpdate-ReservationUtilization-BillingAccountEA-AlertRule-ReservationIdFilter": { - "$ref": "./examples/Budgets/CreateOrUpdate/ReservationUtilization/EA/BillingAccountEA-AlertRule-ReservationIdFilter.json" - }, - "CreateOrUpdate-ReservationUtilization-BillingProfileMCA-AlertRule.json": { - "$ref": "./examples/Budgets/CreateOrUpdate/ReservationUtilization/MCA/BillingProfile-AlertRule.json" - }, - "CreateOrUpdate-ReservationUtilization-BillingProfileMCA-AlertRule-ReservedResourceTypeFilter": { - "$ref": "./examples/Budgets/CreateOrUpdate/ReservationUtilization/MCA/BillingProfile-AlertRule-ReservedResourceTypeFilter.json" - }, - "CreateOrUpdate-ReservationUtilization-BillingProfileMCA-AlertRule-ReservationIdFilter": { - "$ref": "./examples/Budgets/CreateOrUpdate/ReservationUtilization/MCA/BillingProfile-AlertRule-ReservationIdFilter.json" - }, - "CreateOrUpdate-ReservationUtilization-CustomerCSP-AlertRule.json": { - "$ref": "./examples/Budgets/CreateOrUpdate/ReservationUtilization/MCA/Customer-AlertRule.json" - }, - "CreateOrUpdate-ReservationUtilization-CustomerCSP-AlertRule-ReservedResourceTypeFilter": { - "$ref": "./examples/Budgets/CreateOrUpdate/ReservationUtilization/MCA/Customer-AlertRule-ReservedResourceTypeFilter.json" - }, - "CreateOrUpdate-ReservationUtilization-CustomerCSP-AlertRule-ReservationIdFilter": { - "$ref": "./examples/Budgets/CreateOrUpdate/ReservationUtilization/MCA/Customer-AlertRule-ReservationIdFilter.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/scopeBudgetParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/budgetNameParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/Budget" - }, - "description": "Parameters supplied to the Create Budget operation." - } - ], - "responses": { - "200": { - "description": "OK. The request has succeeded and the Budget update is complete.", - "schema": { - "$ref": "#/definitions/Budget" - } - }, - "201": { - "description": "Created.", - "schema": { - "$ref": "#/definitions/Budget" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "common-types.json#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "Budgets" - ], - "operationId": "Budgets_Delete", - "description": "The operation to delete a budget.", - "externalDocs": { - "url": "https://docs.microsoft.com/en-us/rest/api/CostManagement/" - }, - "x-ms-examples": { - "DeleteBudget": { - "$ref": "./examples/Budgets/Delete/DeleteBudget.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/scopeBudgetParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/budgetNameParameter" - } - ], - "responses": { - "200": { - "description": "OK. The request has succeeded." - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "common-types.json#/definitions/ErrorResponse" - } - } - } - } - } - }, - "definitions": { - "BudgetsListResult": { - "description": "Result of listing budgets. It contains a list of available budgets in the scope provided.", - "type": "object", - "properties": { - "value": { - "description": "The list of budgets.", - "type": "array", - "readOnly": true, - "items": { - "$ref": "#/definitions/Budget" - } - }, - "nextLink": { - "description": "The link (url) to the next page of results.\r\nIt's null for now, added for future use.", - "type": "string", - "readOnly": true - } - } - }, - "Budget": { - "description": "A budget resource.", - "type": "object", - "allOf": [ - { - "$ref": "common-types.json#/definitions/CostManagementProxyResource" - } - ], - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/BudgetProperties", - "title": "Budget properties" - } - } - }, - "BudgetProperties": { - "description": "The properties of the budget.", - "type": "object", - "properties": { - "category": { - "description": "The category of the budget.\n- 'Cost' defines a Budget.\n- 'ReservationUtilization' defines a Reservation Utilization Alert Rule.", - "type": "string", - "enum": [ - "Cost", - "ReservationUtilization" - ], - "x-ms-enum": { - "name": "CategoryType", - "modelAsString": true, - "values": [ - { - "value": "Cost", - "description": "A Budget that evaluates monetary cost of Azure resources against an amount, and alerts based on a configured notification threshold.", - "name": "Cost" - }, - { - "value": "ReservationUtilization", - "description": "An Alert Rule that evaluates the utilization percentage of Azure Reservations, and alerts based on a configured notification threshold." - } - ] - } - }, - "amount": { - "description": "The total amount of cost to track with the budget.\n\n Supported for CategoryType(s): Cost.\n\n Required for CategoryType(s): Cost.", - "type": "number" - }, - "timeGrain": { - "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\n Supported 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\n Supported timeGrainTypes for **CategoryType: ReservationUtilization**\n- Last7Days\n- Last30Days\n\n Required for CategoryType(s): Cost, ReservationUtilization.", - "type": "string", - "enum": [ - "Monthly", - "Quarterly", - "Annually", - "BillingMonth", - "BillingQuarter", - "BillingAnnual", - "Last7Days", - "Last30Days" - ], - "x-ms-enum": { - "name": "TimeGrainType", - "modelAsString": true, - "values": [ - { - "value": "Monthly", - "description": "The budget will track costs in the current calendar month against the amount.\n\n Supported for CategoryType: Cost only.", - "name": "Monthly" - }, - { - "value": "Quarterly", - "description": "The budget will track costs in the current calendar quarter against the amount.\n\n Supported for CategoryType: Cost only.", - "name": "Quarterly" - }, - { - "value": "Annually", - "description": "The budget will track costs in the current calendar year against the amount.\n\n Supported for CategoryType: Cost only.", - "name": "Annually" - }, - { - "value": "BillingMonth", - "description": "The budget will track costs in the current billing month against the amount.\n\n Supported for CategoryType: Cost and Web Direct customers only.", - "name": "BillingMonth" - }, - { - "value": "BillingQuarter", - "description": "The budget will track costs in the current billing quarter against the amount.\n\n Supported for CategoryType: Cost and Web Direct customers only.", - "name": "BillingQuarter" - }, - { - "value": "BillingAnnual", - "description": "The budget will track costs in the current billing year against the amount.\n\n Supported for CategoryType: Cost and Web Direct customers only.", - "name": "BillingAnnual" - }, - { - "value": "Last7Days", - "description": "The Reservation Utilization Alert Rule will evaluate reservations based on their 7-Day utilization percentage.\n\n Supported for CategoryType: ReservationUtilization only.", - "name": "Last7Days" - }, - { - "value": "Last30Days", - "description": "The Reservation Utilization Alert Rule will evaluate reservations based on their 30-Day utilization percentage.\n\n Supported for CategoryType: ReservationUtilization only.", - "name": "Last30Days" - } - ] - } - }, - "timePeriod": { - "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\n Supported for CategoryType(s): Cost, ReservationUtilization.\n\n Required for CategoryType(s): Cost, ReservationUtilization.", - "type": "object", - "$ref": "#/definitions/BudgetTimePeriod" - }, - "filter": { - "description": "May be used to filter budgets by user-specified dimensions and/or tags.\n\n Supported for CategoryType(s): Cost, ReservationUtilization.", - "type": "object", - "$ref": "#/definitions/BudgetFilter" - }, - "currentSpend": { - "description": "The current amount of cost which is being tracked for a budget.\n\n Supported for CategoryType(s): Cost.", - "$ref": "#/definitions/CurrentSpend", - "readOnly": true - }, - "notifications": { - "type": "object", - "description": "Dictionary of notifications associated with the budget.\n\n Supported 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" - }, - "maxItems": 5 - }, - "forecastSpend": { - "description": "The forecasted cost which is being tracked for a budget.\n\n Supported for CategoryType(s): Cost.", - "$ref": "#/definitions/ForecastSpend", - "readOnly": true - } - }, - "required": [ - "category", - "timeGrain", - "timePeriod" - ] - }, - "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\n Supported for CategoryType(s): Cost, ReservationUtilization.\n\n Required for CategoryType(s): Cost, ReservationUtilization.", - "type": "object", - "properties": { - "startDate": { - "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.", - "type": "string", - "format": "date-time" - }, - "endDate": { - "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.", - "type": "string", - "format": "date-time" - } - }, - "required": [ - "startDate" - ] - }, - "BudgetFilter": { - "description": "May be used to filter budgets by user-specified dimensions and/or tags.\n\n Supported for CategoryType(s): Cost, ReservationUtilization.", - "type": "object", - "properties": { - "and": { - "description": "The logical \"AND\" expression. Must have at least 2 items.\n\n Supported for CategoryType(s): Cost.", - "type": "array", - "items": { - "$ref": "#/definitions/BudgetFilterProperties" - }, - "x-ms-identifiers": [], - "minItems": 0 - }, - "dimensions": { - "description": "Has comparison expression for a dimension.\n\n Supported for CategoryType(s): Cost, ReservationUtilization.\n\nSupported dimension names for **CategoryType: ReservationUtilization** \n- ReservationId\n- ReservedResourceType", - "$ref": "#/definitions/BudgetComparisonExpression" - }, - "tags": { - "description": "Has comparison expression for a tag.\n\n Supported for CategoryType(s): Cost.", - "$ref": "#/definitions/BudgetComparisonExpression" - } - } - }, - "BudgetFilterProperties": { - "description": "The Dimensions or Tags to filter a budget by.\n\n Supported for CategoryType(s): Cost, ReservationUtilization.", - "type": "object", - "properties": { - "dimensions": { - "description": "Has comparison expression for a dimension.\n\n Supported for CategoryType(s): Cost, ReservationUtilization.\n\nSupported dimension names for **CategoryType: ReservationUtilization** \n- ReservationId\n- ReservedResourceType", - "$ref": "#/definitions/BudgetComparisonExpression" - }, - "tags": { - "description": "Has comparison expression for a tag.\n\n Supported for CategoryType(s): Cost.", - "$ref": "#/definitions/BudgetComparisonExpression" - } - } - }, - "BudgetComparisonExpression": { - "description": "The comparison expression to be used in the budgets.", - "type": "object", - "properties": { - "name": { - "description": "The name of the column to use in comparison.", - "type": "string" - }, - "operator": { - "description": "The operator to use for comparison.", - "type": "string", - "enum": [ - "In" - ], - "x-ms-enum": { - "name": "BudgetOperatorType", - "modelAsString": true - } - }, - "values": { - "description": "Array of values to use for comparison", - "type": "array", - "items": { - "type": "string" - }, - "minItems": 0 - } - }, - "required": [ - "name", - "operator", - "values" - ] - }, - "CurrentSpend": { - "description": "The current amount of cost which is being tracked for a budget.\n\n Supported for CategoryType(s): Cost.", - "type": "object", - "properties": { - "amount": { - "description": "The total amount of cost which is being tracked by the budget.", - "type": "number", - "readOnly": true - }, - "unit": { - "description": "The unit of measure for the budget amount.", - "type": "string", - "readOnly": true - } - } - }, - "ForecastSpend": { - "description": "The forecasted cost which is being tracked for a budget.\n\n Supported for CategoryType(s): Cost.", - "type": "object", - "properties": { - "amount": { - "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.", - "type": "number", - "readOnly": true - }, - "unit": { - "description": "The unit of measure for the budget amount.", - "type": "string", - "readOnly": true - } - } - }, - "Notification": { - "description": "The notification associated with a budget.\n\n Supported for CategoryType(s): Cost, ReservationUtilization.", - "type": "object", - "properties": { - "enabled": { - "description": "The notification is enabled or not.\n\n Supported for CategoryType(s): Cost, ReservationUtilization.", - "type": "boolean" - }, - "operator": { - "description": "The comparison operator.\n\n Supported for CategoryType(s): Cost, ReservationUtilization.\n\n Supported operators for **CategoryType: Cost**\n- GreaterThan\n- GreaterThanOrEqualTo\n\n Supported operators for **CategoryType: ReservationUtilization**\n- LessThan", - "type": "string", - "enum": [ - "EqualTo", - "GreaterThan", - "GreaterThanOrEqualTo", - "LessThan" - ], - "x-ms-enum": { - "name": "BudgetNotificationOperatorType", - "modelAsString": true, - "values": [ - { - "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\n Supported for CategoryType(s): Cost.", - "name": "EqualTo" - }, - { - "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\n Supported for CategoryType(s): Cost.", - "name": "GreaterThan" - }, - { - "value": "GreaterThanOrEqualTo", - "description": "Notification will be triggered if the evaluated cost is greater than or equal to the threshold value.\n\n Supported for CategoryType(s): Cost.", - "name": "GreaterThanOrEqualTo" - }, - { - "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\n Supported for CategoryType(s): ReservationUtilization.", - "name": "LessThan" - } - ] - } - }, - "threshold": { - "description": "Threshold value associated with a notification. It is always percent with a maximum of 2 decimal places.\n\n Supported 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.", - "type": "number" - }, - "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\n Supported for CategoryType(s): ReservationUtilization.", - "type": "string", - "enum": [ - "Daily", - "Weekly", - "Monthly" - ], - "x-ms-enum": { - "name": "Frequency", - "modelAsString": true, - "values": [ - { - "value": "Daily", - "description": "After the threshold breaches and an Alert is fired, no further alerts will be sent until the next calendar day.", - "name": "Daily" - }, - { - "value": "Weekly", - "description": "After the threshold breaches and an Alert is fired, no further alerts will be sent for 7 calendar days.", - "name": "Weekly" - }, - { - "value": "Monthly", - "description": "After the threshold breaches and an Alert is fired, no further alerts will be sent for 30 calendar days.", - "name": "Monthly" - } - ] - } - }, - "contactEmails": { - "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\n Supported for CategoryType(s): Cost, ReservationUtilization.", - "type": "array", - "items": { - "type": "string" - }, - "minItems": 0, - "maxItems": 50 - }, - "contactRoles": { - "description": "Subscription or Resource Group scopes only. Contact roles to send the notification to when the threshold is breached.\n\n Supported for CategoryType(s): Cost.", - "type": "array", - "items": { - "type": "string" - } - }, - "contactGroups": { - "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\n Supported for CategoryType(s): Cost.", - "type": "array", - "items": { - "type": "string" - }, - "minItems": 0, - "maxItems": 50 - }, - "thresholdType": { - "description": "The type of threshold.\n\n Supported for CategoryType(s): Cost.", - "type": "string", - "enum": [ - "Actual", - "Forecasted" - ], - "x-ms-enum": { - "name": "ThresholdType", - "modelAsString": true, - "values": [ - { - "value": "Actual", - "description": "Actual costs budget alerts notify when the actual accrued cost exceeds the allocated budget.", - "name": "Actual" - }, - { - "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.", - "name": "Forecasted" - } - ] - }, - "default": "Actual" - }, - "locale": { - "description": "Language in which the recipient will receive the notification, \n\n Supported for CategoryType(s): Cost, ReservationUtilization.", - "type": "string", - "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 - } - } - }, - "required": [ - "enabled", - "operator", - "threshold", - "contactEmails" - ] - } - }, - "parameters": { - "scopeBudgetParameter": { - "name": "scope", - "in": "path", - "required": true, - "type": "string", - "description": "The scope associated with budget operations.\n\n Supported scopes for **CategoryType: Cost**\n\n Azure RBAC Scopes:\n- '/subscriptions/{subscriptionId}/' for subscription scope\n- '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope\n- '/providers/Microsoft.Management/managementGroups/{managementGroupId}' for Management Group scope\n\n EA (Enterprise Agreement) Scopes:\n\n- '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope\n- '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope\n- '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope\n\n MCA (Modern Customer Agreement) Scopes:\n- '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope\n- '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billingProfile scope\n- '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/invoiceSections/{invoiceSectionId}' for invoiceSection scope\n- '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/customers/{customerId}' for customer scope (CSP only)\n\n Supported scopes for **CategoryType: ReservationUtilization**\n\n EA (Enterprise Agreement) Scopes:\n- '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account Scope\n\nMCA (Modern Customer Agreement) Scopes:\n- '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billingProfile scope (non-CSP only)\n- '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/customers/{customerId}' for customer scope (CSP only)", - "x-ms-parameter-location": "method", - "x-ms-skip-url-encoding": true - }, - "budgetNameParameter": { - "name": "budgetName", - "in": "path", - "description": "Budget Name.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method", - "pattern": "^[a-zA-Z0-9_-]+$", - "minLength": 1, - "maxLength": 63 - }, - "budgetCategoryFilterParameter": { - "name": "$filter", - "description": "OData filter option. May be used to filter budgets by properties/category. The filter supports 'eq' only.", - "in": "query", - "required": false, - "type": "string", - "x-ms-parameter-location": "method" - } - } -} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/costmanagement.exports.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/costmanagement.exports.json deleted file mode 100644 index 6b3de8c29574..000000000000 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/costmanagement.exports.json +++ /dev/null @@ -1,974 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "version": "2025-03-01", - "title": "CostManagementClient" - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ], - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Azure Active Directory OAuth2 Flow.", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "paths": { - "/{scope}/providers/Microsoft.CostManagement/exports": { - "get": { - "tags": [ - "Exports" - ], - "operationId": "Exports_List", - "description": "The operation to list all exports at the given scope.", - "externalDocs": { - "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" - }, - "x-ms-examples": { - "ExportsGetBySubscription": { - "$ref": "./examples/ExportsGetBySubscription.json" - }, - "ExportsGetByResourceGroup": { - "$ref": "./examples/ExportsGetByResourceGroup.json" - }, - "ExportsGetByBillingAccount": { - "$ref": "./examples/ExportsGetByBillingAccount.json" - }, - "ExportsGetByDepartment": { - "$ref": "./examples/ExportsGetByDepartment.json" - }, - "ExportsGetByEnrollmentAccount": { - "$ref": "./examples/ExportsGetByEnrollmentAccount.json" - }, - "ExportsGetByManagementGroup": { - "$ref": "./examples/ExportsGetByManagementGroup.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/scopeExportParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "name": "$expand", - "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.", - "in": "query", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "OK. The request has succeeded.", - "schema": { - "$ref": "#/definitions/ExportListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "common-types.json#/definitions/ErrorResponse" - } - } - } - } - }, - "/{scope}/providers/Microsoft.CostManagement/exports/{exportName}": { - "get": { - "tags": [ - "Exports" - ], - "operationId": "Exports_Get", - "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/" - }, - "x-ms-examples": { - "ExportGetBySubscription": { - "$ref": "./examples/ExportGetBySubscription.json" - }, - "ExportGetByResourceGroup": { - "$ref": "./examples/ExportGetByResourceGroup.json" - }, - "ExportGetByBillingAccount": { - "$ref": "./examples/ExportGetByBillingAccount.json" - }, - "ExportGetByDepartment": { - "$ref": "./examples/ExportGetByDepartment.json" - }, - "ExportGetByEnrollmentAccount": { - "$ref": "./examples/ExportGetByEnrollmentAccount.json" - }, - "ExportGetByManagementGroup": { - "$ref": "./examples/ExportGetByManagementGroup.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/scopeExportParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/exportNameParameter" - }, - { - "name": "$expand", - "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.", - "in": "query", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "OK. The request has succeeded.", - "schema": { - "$ref": "#/definitions/Export" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "common-types.json#/definitions/ErrorResponse" - } - } - } - }, - "put": { - "tags": [ - "Exports" - ], - "operationId": "Exports_CreateOrUpdate", - "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/" - }, - "x-ms-examples": { - "ExportCreateOrUpdateBySubscription": { - "$ref": "./examples/ExportCreateOrUpdateBySubscription.json" - }, - "ExportCreateOrUpdateByResourceGroup": { - "$ref": "./examples/ExportCreateOrUpdateByResourceGroup.json" - }, - "ExportCreateOrUpdateByBillingAccount": { - "$ref": "./examples/ExportCreateOrUpdateByBillingAccount.json" - }, - "ExportCreateOrUpdateByBillingAccountMonthly": { - "$ref": "./examples/ExportCreateOrUpdateByBillingAccountMonthly.json" - }, - "ExportCreateOrUpdateByBillingAccountCustom": { - "$ref": "./examples/ExportCreateOrUpdateByBillingAccountCustom.json" - }, - "ExportCreateOrUpdateByDepartment": { - "$ref": "./examples/ExportCreateOrUpdateByDepartment.json" - }, - "ExportCreateOrUpdateByEnrollmentAccount": { - "$ref": "./examples/ExportCreateOrUpdateByEnrollmentAccount.json" - }, - "ExportCreateOrUpdateByManagementGroup": { - "$ref": "./examples/ExportCreateOrUpdateByManagementGroup.json" - }, - "ExportCreateOrUpdateByBillingAccountPricesheet": { - "$ref": "./examples/ExportCreateOrUpdateByBillingAccountPricesheet.json" - }, - "ExportCreateOrUpdateByBillingAccountReservationDetails": { - "$ref": "./examples/ExportCreateOrUpdateByBillingAccountReservationDetails.json" - }, - "ExportCreateOrUpdateByBillingAccountReservationRecommendation": { - "$ref": "./examples/ExportCreateOrUpdateByBillingAccountReservationRecommendation.json" - }, - "ExportCreateOrUpdateExportCreateOrUpdateByBillingAccountReservationTransactionsByBillingAccount": { - "$ref": "./examples/ExportCreateOrUpdateByBillingAccountReservationTransactions.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/scopeExportParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/exportNameParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/Export" - }, - "description": "Parameters supplied to the CreateOrUpdate Export operation." - } - ], - "responses": { - "200": { - "description": "OK. The request has succeeded.", - "schema": { - "$ref": "#/definitions/Export" - } - }, - "201": { - "description": "Created.", - "schema": { - "$ref": "#/definitions/Export" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "common-types.json#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "Exports" - ], - "operationId": "Exports_Delete", - "description": "The operation to delete a export.", - "externalDocs": { - "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" - }, - "x-ms-examples": { - "ExportDeleteBySubscription": { - "$ref": "./examples/ExportDeleteBySubscription.json" - }, - "ExportDeleteByResourceGroup": { - "$ref": "./examples/ExportDeleteByResourceGroup.json" - }, - "ExportDeleteByBillingAccount": { - "$ref": "./examples/ExportDeleteByBillingAccount.json" - }, - "ExportDeleteByEnrollmentAccount": { - "$ref": "./examples/ExportDeleteByEnrollmentAccount.json" - }, - "ExportDeleteByDepartment": { - "$ref": "./examples/ExportDeleteByDepartment.json" - }, - "ExportDeleteByManagementGroup": { - "$ref": "./examples/ExportDeleteByManagementGroup.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/scopeExportParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/exportNameParameter" - } - ], - "responses": { - "200": { - "description": "OK. The request has succeeded." - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "common-types.json#/definitions/ErrorResponse" - } - } - } - } - }, - "/{scope}/providers/Microsoft.CostManagement/exports/{exportName}/run": { - "post": { - "tags": [ - "Exports" - ], - "operationId": "Exports_Execute", - "description": "The operation to run an export.", - "externalDocs": { - "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" - }, - "x-ms-examples": { - "ExportRunBySubscription": { - "$ref": "./examples/ExportRunBySubscription.json" - }, - "ExportRunByResourceGroup": { - "$ref": "./examples/ExportRunByResourceGroup.json" - }, - "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" - } - }, - "parameters": [ - { - "$ref": "#/parameters/scopeExportParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/exportNameParameter" - }, - { - "name": "parameters", - "in": "body", - "required": false, - "schema": { - "$ref": "#/definitions/ExportRunRequest" - }, - "description": "Parameters supplied to the Execute Export operation." - } - ], - "responses": { - "200": { - "description": "OK. The request has succeeded." - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "common-types.json#/definitions/ErrorResponse" - } - } - } - } - }, - "/{scope}/providers/Microsoft.CostManagement/exports/{exportName}/runHistory": { - "get": { - "tags": [ - "Exports" - ], - "operationId": "Exports_GetExecutionHistory", - "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/" - }, - "x-ms-examples": { - "ExportRunHistoryGetBySubscription": { - "$ref": "./examples/ExportRunHistoryGetBySubscription.json" - }, - "ExportRunHistoryGetByResourceGroup": { - "$ref": "./examples/ExportRunHistoryGetByResourceGroup.json" - }, - "ExportRunHistoryGetByBillingAccount": { - "$ref": "./examples/ExportRunHistoryGetByBillingAccount.json" - }, - "ExportRunHistoryGetByDepartment": { - "$ref": "./examples/ExportRunHistoryGetByDepartment.json" - }, - "ExportRunHistoryGetByEnrollmentAccount": { - "$ref": "./examples/ExportRunHistoryGetByEnrollmentAccount.json" - }, - "ExportRunHistoryGetByManagementGroup": { - "$ref": "./examples/ExportRunHistoryGetByManagementGroup.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/scopeExportParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/exportNameParameter" - } - ], - "responses": { - "200": { - "description": "OK. The request has succeeded.", - "schema": { - "$ref": "#/definitions/ExportExecutionListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "common-types.json#/definitions/ErrorResponse" - } - } - } - } - } - }, - "definitions": { - "ExportListResult": { - "description": "Result of listing exports. It contains a list of available exports in the scope provided.", - "type": "object", - "properties": { - "value": { - "description": "The list of exports.", - "type": "array", - "readOnly": true, - "items": { - "$ref": "#/definitions/Export" - } - } - } - }, - "Export": { - "description": "An export resource.", - "type": "object", - "allOf": [ - { - "$ref": "common-types.json#/definitions/CostManagementProxyResource" - } - ], - "properties": { - "identity": { - "description": "The managed identity associated with Export", - "$ref": "../../../../../../common-types/resource-management/v5/managedidentity.json#/definitions/SystemAssignedServiceIdentity" - }, - "location": { - "type": "string", - "description": "The location of the Export's managed identity. Only required when utilizing managed identity.", - "x-ms-mutability": [ - "create", - "read" - ] - }, - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/ExportProperties", - "title": "Export properties" - } - } - }, - "ExportProperties": { - "description": "The properties of the export.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CommonExportProperties" - } - ], - "properties": { - "schedule": { - "description": "Has schedule information for the export.", - "$ref": "#/definitions/ExportSchedule" - } - } - }, - "CommonExportProperties": { - "description": "The common properties of the export.", - "type": "object", - "properties": { - "format": { - "description": "The format of the export being delivered.", - "type": "string", - "enum": [ - "Csv", - "Parquet" - ], - "x-ms-enum": { - "name": "FormatType", - "modelAsString": true - } - }, - "deliveryInfo": { - "description": "Has delivery information for the export.", - "$ref": "#/definitions/ExportDeliveryInfo" - }, - "definition": { - "description": "Has the definition for the export.", - "$ref": "#/definitions/ExportDefinition" - }, - "runHistory": { - "description": "If requested, has the most recent run history for the export.", - "$ref": "#/definitions/ExportExecutionListResult" - }, - "partitionData": { - "description": "If set to true, exported data will be partitioned by size and placed in a blob directory together with a manifest file.", - "type": "boolean" - }, - "dataOverwriteBehavior": { - "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.", - "type": "string", - "enum": [ - "OverwritePreviousReport", - "CreateNewReport" - ], - "x-ms-enum": { - "name": "DataOverwriteBehaviorType", - "modelAsString": true - } - }, - "compressionMode": { - "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.", - "type": "string", - "enum": [ - "gzip", - "snappy", - "none" - ], - "x-ms-enum": { - "name": "CompressionModeType", - "modelAsString": true - } - }, - "exportDescription": { - "description": "The export description set by customer at time of export creation/update.", - "type": "string" - }, - "nextRunTimeEstimate": { - "description": "If the export has an active schedule, provides an estimate of the next run time.", - "type": "string", - "format": "date-time", - "readOnly": true - }, - "systemSuspensionContext": { - "description": "The export suspension reason if export is in SystemSuspended state. This is not populated currently.", - "$ref": "#/definitions/ExportSuspensionContext", - "readOnly": true - } - }, - "required": [ - "deliveryInfo", - "definition" - ] - }, - "ExportSchedule": { - "description": "The schedule associated with the export.", - "type": "object", - "properties": { - "status": { - "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.", - "type": "string", - "enum": [ - "Active", - "Inactive" - ], - "x-ms-enum": { - "name": "StatusType", - "modelAsString": true - } - }, - "recurrence": { - "description": "The schedule recurrence.", - "type": "string", - "enum": [ - "Daily", - "Weekly", - "Monthly", - "Annually" - ], - "x-ms-enum": { - "name": "RecurrenceType", - "modelAsString": true - } - }, - "recurrencePeriod": { - "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.", - "$ref": "#/definitions/ExportRecurrencePeriod" - } - } - }, - "ExportDeliveryInfo": { - "description": "The delivery information associated with a export.", - "type": "object", - "properties": { - "destination": { - "description": "Has destination for the export being delivered.", - "$ref": "#/definitions/ExportDeliveryDestination" - } - }, - "required": [ - "destination" - ] - }, - "ExportRecurrencePeriod": { - "description": "The start and end date for recurrence schedule.", - "type": "object", - "properties": { - "from": { - "description": "The start date of recurrence.", - "type": "string", - "format": "date-time" - }, - "to": { - "description": "The end date of recurrence.", - "type": "string", - "format": "date-time" - } - }, - "required": [ - "from" - ] - }, - "ExportDeliveryDestination": { - "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 ).", - "type": "object", - "properties": { - "type": { - "description": "The export delivery destination type. Currently only 'AzureBlob' is supported.", - "type": "string", - "enum": [ - "AzureBlob" - ], - "x-ms-enum": { - "name": "DestinationType", - "modelAsString": true - } - }, - "resourceId": { - "description": "The resource id of the storage account where exports will be delivered. This is not required if a sasToken and storageAccount are specified.", - "type": "string" - }, - "container": { - "description": "The name of the container where exports will be uploaded. If the container does not exist it will be created.", - "type": "string" - }, - "rootFolderPath": { - "description": "The name of the directory where exports will be uploaded.", - "type": "string" - }, - "sasToken": { - "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.", - "type": "string", - "x-ms-secret": true - }, - "storageAccount": { - "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.", - "type": "string" - } - }, - "required": [ - "container" - ] - }, - "ExportDefinition": { - "description": "The definition of an export.", - "type": "object", - "properties": { - "type": { - "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.", - "type": "string", - "enum": [ - "Usage", - "ActualCost", - "AmortizedCost", - "FocusCost", - "PriceSheet", - "ReservationTransactions", - "ReservationRecommendations", - "ReservationDetails" - ], - "x-ms-enum": { - "name": "ExportType", - "modelAsString": true - } - }, - "timeframe": { - "description": "The time frame for pulling data for the export. If custom, then a specific time period must be provided.", - "type": "string", - "enum": [ - "MonthToDate", - "BillingMonthToDate", - "TheLastMonth", - "TheLastBillingMonth", - "WeekToDate", - "Custom", - "TheCurrentMonth" - ], - "x-ms-enum": { - "name": "TimeframeType", - "modelAsString": true - } - }, - "timePeriod": { - "description": "Has time period for pulling data for the export.", - "$ref": "#/definitions/ExportTimePeriod" - }, - "dataSet": { - "description": "The definition for data in the export.", - "$ref": "#/definitions/ExportDataset" - } - }, - "required": [ - "type", - "timeframe" - ] - }, - "ExportDataset": { - "description": "The definition for data in the export.", - "type": "object", - "properties": { - "granularity": { - "description": "The granularity of rows in the export. Currently 'Daily' is supported for most cases.", - "type": "string", - "enum": [ - "Daily", - "Monthly" - ], - "x-ms-enum": { - "name": "GranularityType", - "modelAsString": true - } - }, - "configuration": { - "description": "The export dataset configuration.", - "$ref": "#/definitions/ExportDatasetConfiguration" - } - } - }, - "ExportDatasetConfiguration": { - "description": "This is on path to deprecation and will not be supported going forward.", - "type": "object", - "properties": { - "columns": { - "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).", - "type": "array", - "items": { - "type": "string" - } - }, - "dataVersion": { - "description": "The data version for the selected for the export. If not provided then the export will default to latest data version.", - "type": "string" - }, - "filters": { - "description": "Filters associated with the data sets.", - "type": "array", - "items": { - "$ref": "#/definitions/FilterItems" - }, - "x-ms-identifiers": [ - "name" - ] - } - } - }, - "ExportTimePeriod": { - "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.", - "type": "object", - "properties": { - "from": { - "description": "The start date for export data.", - "type": "string", - "format": "date-time" - }, - "to": { - "description": "The end date for export data.", - "type": "string", - "format": "date-time" - } - }, - "required": [ - "from", - "to" - ] - }, - "ExportExecutionListResult": { - "description": "Result of listing the run history of an export.", - "type": "object", - "properties": { - "value": { - "description": "A list of export runs.", - "type": "array", - "readOnly": true, - "items": { - "$ref": "#/definitions/ExportRun" - } - } - } - }, - "ExportRun": { - "description": "An export run.", - "type": "object", - "allOf": [ - { - "$ref": "common-types.json#/definitions/CostManagementProxyResource" - } - ], - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/ExportRunProperties", - "title": "Export run properties" - } - } - }, - "ExportRunProperties": { - "description": "The properties of the export run.", - "type": "object", - "properties": { - "executionType": { - "description": "The type of the export run.", - "type": "string", - "enum": [ - "OnDemand", - "Scheduled" - ], - "x-ms-enum": { - "name": "ExecutionType", - "modelAsString": true - } - }, - "status": { - "description": "The last known status of the export run.", - "type": "string", - "enum": [ - "Queued", - "InProgress", - "Completed", - "Failed", - "Timeout", - "NewDataNotAvailable", - "DataNotAvailable" - ], - "x-ms-enum": { - "name": "ExecutionStatus", - "modelAsString": true - } - }, - "submittedBy": { - "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'.", - "type": "string" - }, - "submittedTime": { - "description": "The time when export was queued to be run.", - "type": "string", - "format": "date-time" - }, - "processingStartTime": { - "description": "The time when export was picked up to be run.", - "type": "string", - "format": "date-time" - }, - "processingEndTime": { - "description": "The time when the export run finished.", - "type": "string", - "format": "date-time" - }, - "startDate": { - "description": "The start datetime for the export.", - "type": "string", - "format": "date-time" - }, - "endDate": { - "description": "The end datetime for the export.", - "type": "string", - "format": "date-time" - }, - "fileName": { - "description": "The name of the exported file.", - "type": "string" - }, - "manifestFile": { - "description": "The manifest file location(URI location) for the exported files.", - "type": "string" - }, - "runSettings": { - "description": "The export settings that were in effect for this run.", - "$ref": "#/definitions/CommonExportProperties" - }, - "error": { - "description": "The details of any error.", - "$ref": "common-types.json#/definitions/ErrorDetails" - } - } - }, - "ExportSuspensionContext": { - "description": "The properties of the export run. This is not populated currently.", - "type": "object", - "properties": { - "suspensionCode": { - "description": "The code for export suspension.", - "type": "string" - }, - "suspensionReason": { - "description": "The detailed reason for export suspension.", - "type": "string" - }, - "suspensionTime": { - "description": "The time when the export was suspended.", - "type": "string", - "format": "date-time" - } - } - }, - "ExportRunRequest": { - "description": "The export run request.", - "type": "object", - "properties": { - "timePeriod": { - "description": "Has time period for pulling data for the export.", - "$ref": "#/definitions/ExportTimePeriod" - } - } - }, - "FilterItems": { - "description": "Will contain the filter name and value to operate on. This is currently only supported for Export Definition type of ReservationRecommendations.", - "type": "object", - "properties": { - "name": { - "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 - } - }, - "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']." - } - } - } - }, - "parameters": { - "scopeExportParameter": { - "name": "scope", - "in": "path", - "required": true, - "type": "string", - "description": "The scope associated with 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.", - "x-ms-parameter-location": "method", - "x-ms-skip-url-encoding": true - }, - "exportNameParameter": { - "name": "exportName", - "in": "path", - "description": "Export Name.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - } - } -} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/costmanagement.generatecostdetailsreport.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/costmanagement.generatecostdetailsreport.json deleted file mode 100644 index b036eb9903db..000000000000 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/costmanagement.generatecostdetailsreport.json +++ /dev/null @@ -1,405 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "version": "2025-03-01", - "title": "CostManagementClient" - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ], - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Azure Active Directory OAuth2 Flow.", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "paths": { - "/{scope}/providers/Microsoft.CostManagement/generateCostDetailsReport": { - "post": { - "tags": [ - "CostDetails" - ], - "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/" - }, - "x-ms-examples": { - "GenerateCostDetailsReportByBillingProfileAndInvoiceId": { - "$ref": "./examples/GenerateCostDetailsReportByBillingProfileAndInvoiceId.json" - }, - "GenerateCostDetailsReportBySubscriptionAndTimePeriod": { - "$ref": "./examples/GenerateCostDetailsReportBySubscriptionAndTimePeriod.json" - }, - "GenerateCostDetailsReportByCustomerAndTimePeriod": { - "$ref": "./examples/GenerateCostDetailsReportByCustomerAndTimePeriod.json" - }, - "GenerateCostDetailsReportByBillingProfileAndInvoiceIdAndCustomerId": { - "$ref": "./examples/GenerateCostDetailsReportByBillingProfileAndInvoiceIdAndCustomerId.json" - }, - "GenerateCostDetailsReportByBillingAccountEnterpriseAgreementCustomerAndBillingPeriod": { - "$ref": "./examples/GenerateCostDetailsReportByBillingAccountEnterpriseAgreementCustomerAndBillingPeriod.json" - }, - "GenerateCostDetailsReportByDepartmentsAndTimePeriod": { - "$ref": "./examples/GenerateCostDetailsReportByDepartmentsAndTimePeriod.json" - }, - "GenerateCostDetailsReportByEnrollmentAccountsAndTimePeriod": { - "$ref": "./examples/GenerateCostDetailsReportByEnrollmentAccountsAndTimePeriod.json" - } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" - }, - "parameters": [ - { - "$ref": "#/parameters/scopeUsageDetailsParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/GenerateCostDetailsReportRequestDefinition" - }, - "description": "Parameters supplied to the Create cost details operation." - } - ], - "responses": { - "200": { - "description": "Request processing completed.", - "schema": { - "$ref": "#/definitions/CostDetailsOperationResults" - } - }, - "202": { - "description": "Accepted. Request will be processed. Use the Location header to check the status.", - "headers": { - "Location": { - "description": "The URL to check the result of the asynchronous operation.", - "type": "string" - }, - "Retry-After": { - "description": "The amount of delay to use while the status of the operation is checked. The value is expressed in seconds.", - "format": "int32", - "type": "integer" - } - } - }, - "204": { - "description": "No Content. The request has succeeded but returned no results." - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/GenerateCostDetailsReportErrorResponse" - } - } - } - } - }, - "/{scope}/providers/Microsoft.CostManagement/costDetailsOperationResults/{operationId}": { - "get": { - "tags": [ - "CostDetails" - ], - "operationId": "GenerateCostDetailsReport_GetOperationResults", - "description": "Get the result of the specified operation. This link is provided in the CostDetails creation request response Location header.", - "x-ms-examples": { - "Get details of the operation result": { - "$ref": "./examples/CostDetailsOperationResultsBySubscriptionScope.json" - } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" - }, - "parameters": [ - { - "$ref": "#/parameters/scopeUsageDetailsParameter" - }, - { - "name": "operationId", - "in": "path", - "required": true, - "type": "string", - "description": "The target operation Id." - }, - { - "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK. The request has succeeded.", - "schema": { - "$ref": "#/definitions/CostDetailsOperationResults" - } - }, - "202": { - "description": "Accepted. The operation is ongoing." - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "common-types.json#/definitions/ErrorResponse" - } - } - } - } - } - }, - "definitions": { - "GenerateCostDetailsReportErrorResponse": { - "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.", - "type": "object", - "properties": { - "error": { - "description": "The details of the error.", - "$ref": "common-types.json#/definitions/ErrorDetails" - } - } - }, - "GenerateCostDetailsReportRequestDefinition": { - "description": "The definition of a cost detailed report.", - "type": "object", - "properties": { - "metric": { - "description": "The type of the detailed report. By default ActualCost is provided", - "type": "string", - "enum": [ - "ActualCost", - "AmortizedCost" - ], - "x-ms-enum": { - "name": "CostDetailsMetricType", - "modelAsString": true, - "values": [ - { - "value": "ActualCost", - "description": "Actual cost data.", - "name": "ActualCostCostDetailsMetricType" - }, - { - "value": "AmortizedCost", - "description": "Amortized cost data.", - "name": "AmortizedCostCostDetailsMetricType" - } - ] - } - }, - "timePeriod": { - "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", - "$ref": "#/definitions/CostDetailsTimePeriod" - }, - "billingPeriod": { - "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.", - "type": "string" - }, - "invoiceId": { - "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.", - "type": "string" - } - } - }, - "CostDetailsTimePeriod": { - "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.", - "type": "object", - "properties": { - "start": { - "description": "The start date to pull data from. example format 2020-03-15", - "type": "string" - }, - "end": { - "description": "The end date to pull data to. example format 2020-03-15", - "type": "string" - } - }, - "required": [ - "start", - "end" - ] - }, - "CostDetailsOperationResults": { - "description": "The result of the long running operation for cost details Api.", - "type": "object", - "properties": { - "id": { - "description": "The id of the long running operation.", - "type": "string" - }, - "name": { - "description": "The name of the long running operation.", - "type": "string" - }, - "type": { - "description": "The type of the long running operation.", - "type": "string" - }, - "status": { - "description": "The status of the cost details operation", - "type": "string", - "enum": [ - "Completed", - "NoDataFound", - "Failed" - ], - "x-ms-enum": { - "name": "CostDetailsStatusType", - "modelAsString": true, - "values": [ - { - "value": "Completed", - "description": "Operation is Completed.", - "name": "CompletedCostDetailsStatusType" - }, - { - "value": "NoDataFound", - "description": "Operation is Completed and no cost data found.", - "name": "NoDataFoundCostDetailsStatusType" - }, - { - "value": "Failed", - "description": "Operation Failed.", - "name": "FailedCostDetailsStatusType" - } - ] - } - }, - "manifest": { - "x-ms-client-flatten": true, - "description": "The manifest of the report generated by the operation.", - "$ref": "#/definitions/ReportManifest" - }, - "validTill": { - "description": "The time at which report URL becomes invalid/expires in UTC e.g. 2020-12-08T05:55:59.4394737Z.", - "type": "string", - "format": "date-time" - }, - "error": { - "description": "The details of the error.", - "$ref": "common-types.json#/definitions/ErrorDetails" - } - } - }, - "ReportManifest": { - "description": "The manifest of the report generated by the operation.", - "type": "object", - "properties": { - "manifestVersion": { - "description": "The Manifest version.", - "type": "string" - }, - "dataFormat": { - "description": "The data format of the report", - "type": "string", - "enum": [ - "Csv" - ], - "x-ms-enum": { - "name": "CostDetailsDataFormat", - "modelAsString": true, - "values": [ - { - "value": "Csv", - "description": "Csv data format.", - "name": "CsvCostDetailsDataFormat" - } - ] - } - }, - "byteCount": { - "description": "The total number of bytes in all blobs.", - "format": "int64", - "type": "integer" - }, - "blobCount": { - "description": "The total number of blobs.", - "format": "int32", - "type": "integer" - }, - "compressData": { - "description": "Is the data in compressed format.", - "type": "boolean" - }, - "requestContext": { - "x-ms-client-flatten": true, - "description": "The context of the Cost Details request.", - "$ref": "#/definitions/RequestContext" - }, - "blobs": { - "description": "List of blob information generated by this operation.", - "type": "array", - "items": { - "$ref": "#/definitions/BlobInfo" - }, - "x-ms-identifiers": [ - "blobLink" - ] - } - } - }, - "RequestContext": { - "description": "The context of the Cost Details request.", - "type": "object", - "properties": { - "requestScope": { - "description": "The request scope of the request.", - "type": "string" - }, - "requestBody": { - "description": "The request payload body provided in Cost Details call", - "$ref": "#/definitions/GenerateCostDetailsReportRequestDefinition" - } - } - }, - "BlobInfo": { - "description": "The blob information generated by this operation.", - "type": "object", - "properties": { - "blobLink": { - "description": "Link to the blob to download file.", - "type": "string" - }, - "byteCount": { - "description": "Bytes in the blob.", - "format": "int64", - "type": "integer" - } - } - } - }, - "parameters": { - "scopeUsageDetailsParameter": { - "name": "scope", - "in": "path", - "required": true, - "type": "string", - "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.", - "x-ms-parameter-location": "method", - "x-ms-skip-url-encoding": true - } - } -} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/costmanagement.generatedetailedcostreport.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/costmanagement.generatedetailedcostreport.json deleted file mode 100644 index cfcf40089d22..000000000000 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/costmanagement.generatedetailedcostreport.json +++ /dev/null @@ -1,368 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "version": "2025-03-01", - "title": "CostManagementClient" - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ], - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Azure Active Directory OAuth2 Flow.", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "paths": { - "/{scope}/providers/Microsoft.CostManagement/generateDetailedCostReport": { - "post": { - "tags": [ - "UsageDetails" - ], - "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/" - }, - "x-ms-examples": { - "GenerateDetailedCostReportByBillingProfileAndInvoiceId": { - "$ref": "./examples/GenerateDetailedCostReportByBillingProfileAndInvoiceId.json" - }, - "GenerateDetailedCostReportBySubscriptionAndTimePeriod": { - "$ref": "./examples/GenerateDetailedCostReportBySubscriptionAndTimePeriod.json" - }, - "GenerateDetailedCostReportByCustomerAndTimePeriod": { - "$ref": "./examples/GenerateDetailedCostReportByCustomerAndTimePeriod.json" - }, - "GenerateDetailedCostReportByBillingProfileAndInvoiceIdAndCustomerId": { - "$ref": "./examples/GenerateDetailedCostReportByBillingProfileAndInvoiceIdAndCustomerId.json" - }, - "GenerateDetailedCostReportByBillingAccountLegacyAndBillingPeriod": { - "$ref": "./examples/GenerateDetailedCostReportByBillingAccountLegacyAndBillingPeriod.json" - } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" - }, - "parameters": [ - { - "$ref": "#/parameters/scopeUsageDetailsParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/GenerateDetailedCostReportDefinition" - }, - "description": "Parameters supplied to the Create detailed cost report operation." - } - ], - "responses": { - "200": { - "description": "Request processing completed.", - "schema": { - "$ref": "#/definitions/GenerateDetailedCostReportOperationResult" - } - }, - "202": { - "description": "Accepted. Request will be processed. Use the Location header to check the status.", - "headers": { - "Location": { - "description": "The URL to check the result of the asynchronous operation.", - "type": "string" - }, - "Azure-Consumption-AsyncOperation": { - "description": "The URL to check the status of the asynchronous operation.", - "type": "string" - }, - "Azure-AsyncOperation": { - "description": "The URL to check the status of the asynchronous operation.", - "type": "string" - }, - "Retry-After": { - "description": "The amount of delay to use while the status of the operation is checked. The value is expressed in seconds.", - "format": "int32", - "type": "integer" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/GenerateDetailedCostReportErrorResponse" - } - } - } - } - }, - "/{scope}/providers/Microsoft.CostManagement/operationResults/{operationId}": { - "get": { - "tags": [ - "GenerateDetailedCostReportOperationResults" - ], - "operationId": "GenerateDetailedCostReportOperationResults_Get", - "description": "Gets the result of the specified operation. The link with this operationId is provided as a response header of the initial request.", - "x-ms-examples": { - "Get details of the operation result": { - "$ref": "./examples/GenerateDetailedCostReportOperationResultsBySubscriptionScope.json" - } - }, - "x-ms-long-running-operation": true, - "parameters": [ - { - "name": "operationId", - "in": "path", - "required": true, - "type": "string", - "description": "The target operation Id." - }, - { - "$ref": "#/parameters/scopeUsageDetailsParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK. The request has succeeded.", - "schema": { - "$ref": "#/definitions/GenerateDetailedCostReportOperationResult" - } - }, - "202": { - "description": "Accepted. The operation is ongoing." - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "common-types.json#/definitions/ErrorResponse" - } - } - } - } - }, - "/{scope}/providers/Microsoft.CostManagement/operationStatus/{operationId}": { - "get": { - "tags": [ - "GenerateDetailedCostReportOperationStatus" - ], - "operationId": "GenerateDetailedCostReportOperationStatus_Get", - "description": "Get the status of the specified operation. This link is provided in the GenerateDetailedCostReport creation request response header.", - "x-ms-examples": { - "Get details of the operation status": { - "$ref": "./examples/GenerateDetailedCostReportOperationStatusBySubscriptionScope.json" - } - }, - "parameters": [ - { - "name": "operationId", - "in": "path", - "required": true, - "type": "string", - "description": "The target operation Id." - }, - { - "$ref": "#/parameters/scopeUsageDetailsParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK. The request has succeeded.", - "schema": { - "$ref": "#/definitions/GenerateDetailedCostReportOperationStatuses" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "common-types.json#/definitions/ErrorResponse" - } - } - } - } - } - }, - "definitions": { - "GenerateDetailedCostReportErrorResponse": { - "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.", - "type": "object", - "properties": { - "error": { - "description": "The details of the error.", - "$ref": "common-types.json#/definitions/ErrorDetails" - } - } - }, - "GenerateDetailedCostReportDefinition": { - "description": "The definition of a cost detailed report.", - "properties": { - "metric": { - "description": "The type of the detailed report. By default ActualCost is provided", - "type": "string", - "enum": [ - "ActualCost", - "AmortizedCost" - ], - "x-ms-enum": { - "name": "GenerateDetailedCostReportMetricType", - "modelAsString": true - } - }, - "timePeriod": { - "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.", - "$ref": "#/definitions/GenerateDetailedCostReportTimePeriod" - }, - "billingPeriod": { - "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.", - "type": "string" - }, - "invoiceId": { - "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.", - "type": "string" - }, - "customerId": { - "description": "Customer ID for Microsoft Customer Agreement scopes (Invoice Id is also required for this).", - "type": "string" - } - } - }, - "GenerateDetailedCostReportTimePeriod": { - "description": "The start and end date for pulling data for the cost detailed report.", - "properties": { - "start": { - "description": "The start date to pull data from. example format 2020-03-15", - "type": "string" - }, - "end": { - "description": "The end date to pull data to. example format 2020-03-15", - "type": "string" - } - }, - "required": [ - "start", - "end" - ] - }, - "GenerateDetailedCostReportOperationStatuses": { - "description": "The status of the long running operation for cost detailed report.", - "properties": { - "id": { - "description": "The ID of the long running operation.", - "type": "string" - }, - "name": { - "description": "The name of the long running operation.", - "type": "string" - }, - "status": { - "description": "The status of the long running operation.", - "$ref": "#/definitions/Status" - }, - "startTime": { - "description": "The startTime of the operation.", - "type": "string" - }, - "endTime": { - "description": "The endTime of the operation.", - "type": "string" - }, - "type": { - "description": "The type of the long running operation.", - "type": "string" - }, - "error": { - "description": "The details of the error.", - "$ref": "common-types.json#/definitions/ErrorDetails" - }, - "properties": { - "x-ms-client-flatten": true, - "description": "The properties of the usage file generated.", - "$ref": "common-types.json#/definitions/DownloadURL" - } - } - }, - "GenerateDetailedCostReportOperationResult": { - "description": "The result of the long running operation for cost detailed report.", - "properties": { - "id": { - "description": "The ARM resource id of the long running operation.", - "type": "string" - }, - "name": { - "description": "The name of the long running operation.", - "type": "string" - }, - "type": { - "description": "The type of the long running operation.", - "type": "string" - }, - "properties": { - "x-ms-client-flatten": true, - "description": "The properties of the resource generated.", - "$ref": "common-types.json#/definitions/DownloadURL" - } - } - }, - "Status": { - "description": "The status of the long running operation.", - "properties": { - "status": { - "description": "The status of the long running operation.", - "type": "string", - "enum": [ - "InProgress", - "Completed", - "Failed", - "Queued", - "NoDataFound", - "ReadyToDownload", - "TimedOut" - ], - "x-ms-enum": { - "name": "ReportOperationStatusType", - "modelAsString": true - } - } - } - } - }, - "parameters": { - "scopeUsageDetailsParameter": { - "name": "scope", - "in": "path", - "required": true, - "type": "string", - "description": "The ARM Resource ID for subscription, resource group, billing account, or other billing scopes. For details, see https://aka.ms/costmgmt/scopes.", - "x-ms-parameter-location": "method", - "x-ms-skip-url-encoding": true - } - } -} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/costmanagement.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/costmanagement.json deleted file mode 100644 index 2aa679b5f2ff..000000000000 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/costmanagement.json +++ /dev/null @@ -1,2979 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "version": "2025-03-01", - "title": "CostManagementClient" - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ], - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Azure Active Directory OAuth2 Flow.", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "paths": { - "/providers/Microsoft.CostManagement/views": { - "get": { - "tags": [ - "Views" - ], - "operationId": "Views_List", - "description": "Lists all views by tenant and object.", - "externalDocs": { - "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" - }, - "x-ms-examples": { - "PrivateViewList": { - "$ref": "./examples/PrivateViewList.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK. The request has succeeded.", - "schema": { - "$ref": "#/definitions/ViewListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "common-types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/{scope}/providers/Microsoft.CostManagement/views": { - "get": { - "tags": [ - "Views" - ], - "operationId": "Views_ListByScope", - "description": "Lists all views at the given scope.", - "externalDocs": { - "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" - }, - "x-ms-examples": { - "ResourceGroupViewList": { - "$ref": "./examples/ViewListByResourceGroup.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/scopeViewParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK. The request has succeeded.", - "schema": { - "$ref": "#/definitions/ViewListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "common-types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/providers/Microsoft.CostManagement/views/{viewName}": { - "get": { - "tags": [ - "Views" - ], - "operationId": "Views_Get", - "description": "Gets the view by view name.", - "externalDocs": { - "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" - }, - "x-ms-examples": { - "PrivateView": { - "$ref": "./examples/PrivateView.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/viewNameParameter" - } - ], - "responses": { - "200": { - "description": "OK. The request has succeeded.", - "schema": { - "$ref": "#/definitions/View" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "common-types.json#/definitions/ErrorResponse" - } - } - } - }, - "put": { - "tags": [ - "Views" - ], - "operationId": "Views_CreateOrUpdate", - "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/" - }, - "x-ms-examples": { - "CreateOrUpdatePrivateView": { - "$ref": "./examples/PrivateViewCreateOrUpdate.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/viewNameParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/View" - }, - "description": "Parameters supplied to the CreateOrUpdate View operation." - } - ], - "responses": { - "200": { - "description": "OK. The request has succeeded.", - "schema": { - "$ref": "#/definitions/View" - } - }, - "201": { - "description": "Created.", - "schema": { - "$ref": "#/definitions/View" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "common-types.json#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "Views" - ], - "operationId": "Views_Delete", - "description": "The operation to delete a view.", - "externalDocs": { - "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" - }, - "x-ms-examples": { - "DeletePrivateView": { - "$ref": "./examples/PrivateViewDelete.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/viewNameParameter" - } - ], - "responses": { - "200": { - "description": "OK. The request has succeeded." - }, - "204": { - "description": "NoContent. Resource is not available." - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "common-types.json#/definitions/ErrorResponse" - } - } - } - } - }, - "/{scope}/providers/Microsoft.CostManagement/views/{viewName}": { - "get": { - "tags": [ - "Views" - ], - "operationId": "Views_GetByScope", - "description": "Gets the view for the defined scope by view name.", - "externalDocs": { - "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" - }, - "x-ms-examples": { - "ResourceGroupView": { - "$ref": "./examples/ViewByResourceGroup.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/scopeViewParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/viewNameParameter" - } - ], - "responses": { - "200": { - "description": "OK. The request has succeeded.", - "schema": { - "$ref": "#/definitions/View" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "common-types.json#/definitions/ErrorResponse" - } - } - } - }, - "put": { - "tags": [ - "Views" - ], - "operationId": "Views_CreateOrUpdateByScope", - "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/" - }, - "x-ms-examples": { - "ResourceGroupCreateOrUpdateView": { - "$ref": "./examples/ViewCreateOrUpdateByResourceGroup.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/scopeViewParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/viewNameParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/View" - }, - "description": "Parameters supplied to the CreateOrUpdate View operation." - } - ], - "responses": { - "200": { - "description": "OK. The request has succeeded.", - "schema": { - "$ref": "#/definitions/View" - } - }, - "201": { - "description": "Created.", - "schema": { - "$ref": "#/definitions/View" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "common-types.json#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "Views" - ], - "operationId": "Views_DeleteByScope", - "description": "The operation to delete a view.", - "externalDocs": { - "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" - }, - "x-ms-examples": { - "ResourceGroupDeleteView": { - "$ref": "./examples/ViewDeleteByResourceGroup.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/scopeViewParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/viewNameParameter" - } - ], - "responses": { - "200": { - "description": "OK. The request has succeeded." - }, - "204": { - "description": "NoContent. Resource is not available." - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "common-types.json#/definitions/ErrorResponse" - } - } - } - } - }, - "/{scope}/providers/Microsoft.CostManagement/alerts": { - "get": { - "tags": [ - "Alerts" - ], - "operationId": "Alerts_List", - "description": "Lists the alerts for scope defined.", - "externalDocs": { - "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" - }, - "x-ms-examples": { - "BillingAccountAlerts": { - "$ref": "./examples/BillingAccountAlerts.json" - }, - "BillingProfileAlerts": { - "$ref": "./examples/BillingProfileAlerts.json" - }, - "InvoiceSectionAlerts": { - "$ref": "./examples/InvoiceSectionAlerts.json" - }, - "EnrollmentAccountAlerts": { - "$ref": "./examples/EnrollmentAccountAlerts.json" - }, - "DepartmentAlerts": { - "$ref": "./examples/DepartmentAlerts.json" - }, - "SubscriptionAlerts": { - "$ref": "./examples/SubscriptionAlerts.json" - }, - "ResourceGroupAlerts": { - "$ref": "./examples/ResourceGroupAlerts.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/scopeAlertParameter" - } - ], - "responses": { - "200": { - "description": "OK. The request has succeeded.", - "schema": { - "$ref": "#/definitions/AlertsResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "common-types.json#/definitions/ErrorResponse" - } - } - } - } - }, - "/{scope}/providers/Microsoft.CostManagement/alerts/{alertId}": { - "get": { - "tags": [ - "Alerts" - ], - "operationId": "Alerts_Get", - "description": "Gets the alert for the scope by alert ID.", - "externalDocs": { - "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" - }, - "x-ms-examples": { - "SingleSubscriptionAlerts": { - "$ref": "./examples/SingleSubscriptionAlert.json" - }, - "SingleResourceGroupAlerts": { - "$ref": "./examples/SingleResourceGroupAlert.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/scopeAlertParameter" - }, - { - "$ref": "#/parameters/alertIdParameter" - } - ], - "responses": { - "200": { - "description": "OK. The request has succeeded.", - "schema": { - "$ref": "#/definitions/Alert" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "common-types.json#/definitions/ErrorResponse" - } - } - } - }, - "patch": { - "tags": [ - "Alerts" - ], - "operationId": "Alerts_Dismiss", - "description": "Dismisses the specified alert", - "externalDocs": { - "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" - }, - "x-ms-examples": { - "PatchSubscriptionAlerts": { - "$ref": "./examples/DismissSubscriptionAlerts.json" - }, - "PatchResourceGroupAlerts": { - "$ref": "./examples/DismissResourceGroupAlerts.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/scopeAlertParameter" - }, - { - "$ref": "#/parameters/alertIdParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/DismissAlertPayload" - }, - "description": "Parameters supplied to the Dismiss Alert operation." - } - ], - "responses": { - "200": { - "description": "OK. The request has succeeded.", - "schema": { - "$ref": "#/definitions/Alert" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "common-types.json#/definitions/ErrorResponse" - } - } - } - } - }, - "/providers/Microsoft.CostManagement/{externalCloudProviderType}/{externalCloudProviderId}/alerts": { - "get": { - "tags": [ - "Alerts" - ], - "operationId": "Alerts_ListExternal", - "description": "Lists the Alerts for external cloud provider type defined.", - "externalDocs": { - "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" - }, - "x-ms-examples": { - "ExternalBillingAccountAlerts": { - "$ref": "./examples/ExternalBillingAccountAlerts.json" - }, - "ExternalSubscriptionAlerts": { - "$ref": "./examples/ExternalSubscriptionAlerts.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/externalCloudProviderTypeParameter" - }, - { - "$ref": "#/parameters/externalCloudProviderIdParameter" - } - ], - "responses": { - "200": { - "description": "OK. The request has succeeded.", - "schema": { - "$ref": "#/definitions/AlertsResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "common-types.json#/definitions/ErrorResponse" - } - } - } - } - }, - "/{scope}/providers/Microsoft.CostManagement/forecast": { - "post": { - "tags": [ - "Forecast" - ], - "operationId": "Forecast_Usage", - "description": "Lists the forecast charges for scope defined.", - "externalDocs": { - "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" - }, - "x-ms-examples": { - "BillingAccountForecast": { - "$ref": "./examples/BillingAccountForecast.json" - }, - "BillingProfileForecast": { - "$ref": "./examples/BillingProfileForecast.json" - }, - "InvoiceSectionForecast": { - "$ref": "./examples/InvoiceSectionForecast.json" - }, - "EnrollmentAccountForecast": { - "$ref": "./examples/EnrollmentAccountForecast.json" - }, - "DepartmentForecast": { - "$ref": "./examples/DepartmentForecast.json" - }, - "SubscriptionForecast": { - "$ref": "./examples/SubscriptionForecast.json" - }, - "ResourceGroupForecast": { - "$ref": "./examples/ResourceGroupForecast.json" - } - }, - "parameters": [ - { - "name": "$filter", - "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'.", - "in": "query", - "required": false, - "type": "string" - }, - { - "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/scopeForecastParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ForecastDefinition" - }, - "description": "Parameters supplied to the CreateOrUpdate Forecast Config operation." - } - ], - "responses": { - "200": { - "description": "OK. The request has succeeded.", - "schema": { - "$ref": "#/definitions/ForecastResult" - } - }, - "204": { - "description": "No Content. Resource is not available." - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "common-types.json#/definitions/ErrorResponse" - } - } - } - } - }, - "/providers/Microsoft.CostManagement/{externalCloudProviderType}/{externalCloudProviderId}/forecast": { - "post": { - "tags": [ - "Forecast" - ], - "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/" - }, - "x-ms-examples": { - "ExternalBillingAccountForecast": { - "$ref": "./examples/ExternalBillingAccountForecast.json" - }, - "ExternalSubscriptionForecast": { - "$ref": "./examples/ExternalSubscriptionForecast.json" - } - }, - "parameters": [ - { - "name": "$filter", - "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'.", - "in": "query", - "required": false, - "type": "string" - }, - { - "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/externalCloudProviderTypeParameter" - }, - { - "$ref": "#/parameters/externalCloudProviderIdParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ForecastDefinition" - }, - "description": "Parameters supplied to the CreateOrUpdate Forecast Config operation." - } - ], - "responses": { - "200": { - "description": "OK. The request has succeeded.", - "schema": { - "$ref": "#/definitions/ForecastResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "common-types.json#/definitions/ErrorResponse" - } - } - } - } - }, - "/{scope}/providers/Microsoft.CostManagement/dimensions": { - "get": { - "tags": [ - "Dimensions" - ], - "x-ms-odata": "#/definitions/Dimension", - "operationId": "Dimensions_List", - "description": "Lists the dimensions by the defined scope.", - "externalDocs": { - "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" - }, - "x-ms-examples": { - "SubscriptionDimensionsList-Legacy": { - "$ref": "./examples/SubscriptionDimensionsList.json" - }, - "ResourceGroupDimensionsList-Legacy": { - "$ref": "./examples/ResourceGroupDimensionsList.json" - }, - "ManagementGroupDimensionsList-Legacy": { - "$ref": "./examples/ManagementGroupDimensionsList.json" - }, - "ManagementGroupDimensionsListExpandAndTop-Legacy": { - "$ref": "./examples/ManagementGroupDimensionsListExpandAndTop.json" - }, - "ManagementGroupDimensionsListWithFilter-Legacy": { - "$ref": "./examples/ManagementGroupDimensionsListWithFilter.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" - }, - "BillingAccountDimensionsList-Legacy": { - "$ref": "./examples/BillingAccountDimensionsList.json" - }, - "BillingAccountDimensionsListExpandAndTop-Legacy": { - "$ref": "./examples/BillingAccountDimensionsListExpandAndTop.json" - }, - "BillingAccountDimensionsListWithFilter-Legacy": { - "$ref": "./examples/BillingAccountDimensionsListWithFilter.json" - }, - "BillingAccountDimensionsList-MCA": { - "$ref": "./examples/MCABillingAccountDimensionsList.json" - }, - "BillingAccountDimensionsListExpandAndTop-MCA": { - "$ref": "./examples/MCABillingAccountDimensionsListExpandAndTop.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" - }, - "InvoiceSectionDimensionsList-MCA": { - "$ref": "./examples/MCAInvoiceSectionDimensionsList.json" - }, - "InvoiceSectionDimensionsListExpandAndTop-MCA": { - "$ref": "./examples/MCAInvoiceSectionDimensionsListExpandAndTop.json" - }, - "InvoiceSectionDimensionsListWithFilter-MCA": { - "$ref": "./examples/MCAInvoiceSectionDimensionsListWithFilter.json" - }, - "CustomerDimensionsList-MCA": { - "$ref": "./examples/MCACustomerDimensionsList.json" - }, - "CustomerDimensionsListExpandAndTop-MCA": { - "$ref": "./examples/MCACustomerDimensionsListExpandAndTop.json" - }, - "CustomerDimensionsListWithFilter-MCA": { - "$ref": "./examples/MCACustomerDimensionsListWithFilter.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/scopeDimensionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "name": "$filter", - "description": "May be used to filter dimensions by properties/category, properties/usageStart, properties/usageEnd. Supported operators are 'eq','lt', 'gt', 'le', 'ge'.", - "in": "query", - "required": false, - "type": "string" - }, - { - "name": "$expand", - "description": "May be used to expand the properties/data within a dimension category. By default, data is not included when listing dimensions.", - "in": "query", - "required": false, - "type": "string" - }, - { - "name": "$skiptoken", - "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.", - "in": "query", - "required": false, - "type": "string" - }, - { - "name": "$top", - "description": "May be used to limit the number of results to the most recent N dimension data.", - "in": "query", - "required": false, - "type": "integer", - "minimum": 1, - "maximum": 1000, - "format": "int32" - } - ], - "responses": { - "200": { - "description": "OK. The request has succeeded.", - "schema": { - "$ref": "#/definitions/DimensionsListResult" - } - }, - "204": { - "description": "No Content. Resource is not available." - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "common-types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": null - } - } - }, - "/providers/Microsoft.CostManagement/{externalCloudProviderType}/{externalCloudProviderId}/dimensions": { - "get": { - "tags": [ - "Dimensions" - ], - "x-ms-odata": "#/definitions/Dimension", - "operationId": "Dimensions_ByExternalCloudProviderType", - "description": "Lists the dimensions by the external cloud provider type.", - "externalDocs": { - "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" - }, - "x-ms-examples": { - "ExternalBillingAccountDimensionList": { - "$ref": "./examples/ExternalBillingAccountsDimensions.json" - }, - "ExternalSubscriptionDimensionList": { - "$ref": "./examples/ExternalSubscriptionsDimensions.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/externalCloudProviderTypeParameter" - }, - { - "$ref": "#/parameters/externalCloudProviderIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "name": "$filter", - "description": "May be used to filter dimensions by properties/category, properties/usageStart, properties/usageEnd. Supported operators are 'eq','lt', 'gt', 'le', 'ge'.", - "in": "query", - "required": false, - "type": "string" - }, - { - "name": "$expand", - "description": "May be used to expand the properties/data within a dimension category. By default, data is not included when listing dimensions.", - "in": "query", - "required": false, - "type": "string" - }, - { - "name": "$skiptoken", - "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.", - "in": "query", - "required": false, - "type": "string" - }, - { - "name": "$top", - "description": "May be used to limit the number of results to the most recent N dimension data.", - "in": "query", - "required": false, - "type": "integer", - "minimum": 1, - "maximum": 1000, - "format": "int32" - } - ], - "responses": { - "200": { - "description": "OK. The request has succeeded.", - "schema": { - "$ref": "#/definitions/DimensionsListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "common-types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": null - } - } - }, - "/{scope}/providers/Microsoft.CostManagement/query": { - "post": { - "tags": [ - "Query" - ], - "operationId": "Query_Usage", - "description": "Query the usage data for scope defined.", - "externalDocs": { - "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" - }, - "x-ms-examples": { - "SubscriptionQuery-Legacy": { - "$ref": "./examples/SubscriptionQuery.json" - }, - "SubscriptionQueryGrouping-Legacy": { - "$ref": "./examples/SubscriptionQueryGrouping.json" - }, - "ResourceGroupQuery-Legacy": { - "$ref": "./examples/ResourceGroupQuery.json" - }, - "ResourceGroupQueryGrouping-Legacy": { - "$ref": "./examples/ResourceGroupQueryGrouping.json" - }, - "BillingAccountQuery-Legacy": { - "$ref": "./examples/BillingAccountQuery.json" - }, - "BillingAccountQueryGrouping-Legacy": { - "$ref": "./examples/BillingAccountQueryGrouping.json" - }, - "EnrollmentAccountQuery-Legacy": { - "$ref": "./examples/EnrollmentAccountQuery.json" - }, - "EnrollmentAccountQueryGrouping-Legacy": { - "$ref": "./examples/EnrollmentAccountQueryGrouping.json" - }, - "DepartmentQuery-Legacy": { - "$ref": "./examples/DepartmentQuery.json" - }, - "DepartmentQueryGrouping-Legacy": { - "$ref": "./examples/DepartmentQueryGrouping.json" - }, - "ManagementGroupQuery-Legacy": { - "$ref": "./examples/ManagementGroupQuery.json" - }, - "ManagementGroupQueryGrouping-Legacy": { - "$ref": "./examples/ManagementGroupQueryGrouping.json" - }, - "BillingAccountQuery-MCA": { - "$ref": "./examples/MCABillingAccountQuery.json" - }, - "BillingAccountQueryGrouping-MCA": { - "$ref": "./examples/MCABillingAccountQueryGrouping.json" - }, - "BillingProfileQuery-MCA": { - "$ref": "./examples/MCABillingProfileQuery.json" - }, - "BillingProfileQueryGrouping-MCA": { - "$ref": "./examples/MCABillingProfileQueryGrouping.json" - }, - "InvoiceSectionQuery-MCA": { - "$ref": "./examples/MCAInvoiceSectionQuery.json" - }, - "InvoiceSectionQueryGrouping-MCA": { - "$ref": "./examples/MCAInvoiceSectionQueryGrouping.json" - }, - "CustomerQuery-MCA": { - "$ref": "./examples/MCACustomerQuery.json" - }, - "CustomerQueryGrouping-MCA": { - "$ref": "./examples/MCACustomerQueryGrouping.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/scopeQueryParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/QueryDefinition" - }, - "description": "Parameters supplied to the CreateOrUpdate Query Config operation." - } - ], - "responses": { - "200": { - "description": "OK. The request has succeeded.", - "schema": { - "$ref": "#/definitions/QueryResult" - } - }, - "204": { - "description": "No Content. Resource is not available." - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "common-types.json#/definitions/ErrorResponse" - } - } - } - } - }, - "/providers/Microsoft.CostManagement/{externalCloudProviderType}/{externalCloudProviderId}/query": { - "post": { - "tags": [ - "Query" - ], - "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/" - }, - "x-ms-examples": { - "ExternalBillingAccountQueryList": { - "$ref": "./examples/ExternalBillingAccountsQuery.json" - }, - "ExternalSubscriptionsQuery": { - "$ref": "./examples/ExternalSubscriptionsQuery.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/externalCloudProviderTypeParameter" - }, - { - "$ref": "#/parameters/externalCloudProviderIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/QueryDefinition" - }, - "description": "Parameters supplied to the CreateOrUpdate Query Config operation." - } - ], - "responses": { - "200": { - "description": "OK. The request has succeeded.", - "schema": { - "$ref": "#/definitions/QueryResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "common-types.json#/definitions/ErrorResponse" - } - } - } - } - }, - "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.CostManagement/generateReservationDetailsReport": { - "post": { - "tags": [ - "ReservedInstances" - ], - "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/" - }, - "x-ms-examples": { - "ReservationDetails": { - "$ref": "./examples/GenerateReservationDetailsReportByBillingAccount.json" - } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" - }, - "parameters": [ - { - "$ref": "#/parameters/enrollmentIdParameter" - }, - { - "$ref": "#/parameters/startDateParameter" - }, - { - "$ref": "#/parameters/endDateParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Request processing completed.", - "schema": { - "$ref": "#/definitions/OperationStatus" - } - }, - "202": { - "description": "Accepted. Request will be processed. Use the location header to check the status.", - "headers": { - "Location": { - "description": "The URL to check the status of the asynchronous operation.", - "type": "string" - }, - "Retry-After": { - "description": "The amount of delay to use while the status of the operation is checked. The value is expressed in seconds.", - "format": "int32", - "type": "integer" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "common-types.json#/definitions/ErrorResponse" - } - } - } - } - }, - "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/providers/Microsoft.CostManagement/generateReservationDetailsReport": { - "post": { - "tags": [ - "ReservedInstances" - ], - "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/" - }, - "x-ms-examples": { - "ReservationDetails": { - "$ref": "./examples/GenerateReservationDetailsReportByBillingProfile.json" - } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" - }, - "parameters": [ - { - "$ref": "common-types.json#/parameters/billingAccountIdParameter" - }, - { - "$ref": "common-types.json#/parameters/billingProfileIdParameter" - }, - { - "$ref": "#/parameters/startDateParameter" - }, - { - "$ref": "#/parameters/endDateParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Request processing completed.", - "schema": { - "$ref": "#/definitions/OperationStatus" - } - }, - "202": { - "description": "Accepted. Request will be processed. Use the Location header to check the status.", - "headers": { - "Location": { - "description": "The URL to check the status of the asynchronous operation.", - "type": "string" - }, - "Retry-After": { - "description": "The amount of delay to use while the status of the operation is checked. The value is expressed in seconds.", - "format": "int32", - "type": "integer" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "common-types.json#/definitions/ErrorResponse" - } - } - } - } - } - }, - "definitions": { - "ReportConfigDefinition": { - "description": "The definition of a report config.", - "type": "object", - "properties": { - "type": { - "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.", - "type": "string", - "enum": [ - "Usage" - ], - "x-ms-enum": { - "name": "ReportType", - "modelAsString": true - } - }, - "timeframe": { - "description": "The time frame for pulling data for the report. If custom, then a specific time period must be provided.", - "type": "string", - "enum": [ - "WeekToDate", - "MonthToDate", - "YearToDate", - "Custom" - ], - "x-ms-enum": { - "name": "ReportTimeframeType", - "modelAsString": true - } - }, - "timePeriod": { - "description": "Has time period for pulling data for the report.", - "$ref": "#/definitions/ReportConfigTimePeriod" - }, - "dataSet": { - "description": "Has definition for data in this report config.", - "$ref": "#/definitions/ReportConfigDataset" - }, - "includeMonetaryCommitment": { - "description": "If true, report includes monetary commitment.", - "type": "boolean" - } - }, - "required": [ - "type", - "timeframe" - ] - }, - "ReportConfigTimePeriod": { - "description": "The start and end date for pulling data for the report.", - "type": "object", - "properties": { - "from": { - "description": "The start date to pull data from.", - "type": "string", - "format": "date-time" - }, - "to": { - "description": "The end date to pull data to.", - "type": "string", - "format": "date-time" - } - }, - "required": [ - "from", - "to" - ] - }, - "ReportConfigDataset": { - "description": "The definition of data present in the report.", - "type": "object", - "properties": { - "granularity": { - "description": "The granularity of rows in the report.", - "type": "string", - "enum": [ - "Daily", - "Monthly" - ], - "x-ms-enum": { - "name": "ReportGranularityType", - "modelAsString": true - } - }, - "configuration": { - "description": "Has configuration information for the data in the report. The configuration will be ignored if aggregation and grouping are provided.", - "$ref": "#/definitions/ReportConfigDatasetConfiguration" - }, - "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" - }, - "x-ms-identifiers": [ - "name" - ], - "maxItems": 2 - }, - "grouping": { - "description": "Array of group by expression to use in the report. Report can have up to 2 group by clauses.", - "type": "array", - "items": { - "$ref": "#/definitions/ReportConfigGrouping" - }, - "x-ms-identifiers": [ - "name", - "type" - ], - "maxItems": 2 - }, - "sorting": { - "description": "Array of order by expression to use in the report.", - "type": "array", - "items": { - "$ref": "#/definitions/ReportConfigSorting" - }, - "x-ms-identifiers": [] - }, - "filter": { - "description": "Has filter expression to use in the report.", - "$ref": "#/definitions/ReportConfigFilter" - } - } - }, - "ReportConfigDatasetConfiguration": { - "description": "The configuration of dataset in the report.", - "type": "object", - "properties": { - "columns": { - "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.", - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "ReportConfigAggregation": { - "description": "The aggregation expression to be used in the report.", - "type": "object", - "properties": { - "name": { - "description": "The name of the column to aggregate.", - "type": "string" - }, - "function": { - "description": "The name of the aggregation function to use.", - "type": "string", - "enum": [ - "Sum" - ], - "x-ms-enum": { - "name": "FunctionType", - "modelAsString": true - } - } - }, - "required": [ - "name", - "function" - ] - }, - "ReportConfigSorting": { - "description": "The order by expression to be used in the report.", - "type": "object", - "properties": { - "direction": { - "description": "Direction of sort.", - "type": "string", - "enum": [ - "Ascending", - "Descending" - ], - "x-ms-enum": { - "name": "ReportConfigSortingType", - "modelAsString": true - } - }, - "name": { - "description": "The name of the column to sort.", - "type": "string" - } - }, - "required": [ - "name" - ] - }, - "ReportConfigGrouping": { - "description": "The group by expression to be used in the report.", - "type": "object", - "properties": { - "type": { - "description": "Has type of the column to group.", - "$ref": "#/definitions/ReportConfigColumnType" - }, - "name": { - "description": "The name of the column to group. This version supports subscription lowest possible grain.", - "type": "string" - } - }, - "required": [ - "type", - "name" - ] - }, - "ReportConfigFilter": { - "description": "The filter expression to be used in the report.", - "type": "object", - "properties": { - "and": { - "description": "The logical \"AND\" expression. Must have at least 2 items.", - "type": "array", - "items": { - "$ref": "#/definitions/ReportConfigFilter" - }, - "x-ms-identifiers": [], - "minItems": 2 - }, - "or": { - "description": "The logical \"OR\" expression. Must have at least 2 items.", - "type": "array", - "items": { - "$ref": "#/definitions/ReportConfigFilter" - }, - "x-ms-identifiers": [], - "minItems": 2 - }, - "dimensions": { - "description": "Has comparison expression for a dimension", - "$ref": "#/definitions/ReportConfigComparisonExpression" - }, - "tags": { - "description": "Has comparison expression for a tag", - "$ref": "#/definitions/ReportConfigComparisonExpression" - } - } - }, - "ReportConfigColumnType": { - "description": "The type of the column in the report.", - "type": "string", - "enum": [ - "TagKey", - "Dimension" - ], - "x-ms-enum": { - "name": "QueryColumnType", - "modelAsString": true, - "values": [ - { - "value": "TagKey", - "description": "The tag associated with the cost data." - }, - { - "value": "Dimension", - "description": "The dimension of cost data." - } - ] - } - }, - "ReportConfigComparisonExpression": { - "description": "The comparison expression to be used in the report.", - "type": "object", - "properties": { - "name": { - "description": "The name of the column to use in comparison.", - "type": "string" - }, - "operator": { - "description": "The operator to use for comparison.", - "type": "string", - "enum": [ - "In", - "Contains" - ], - "x-ms-enum": { - "name": "OperatorType", - "modelAsString": true - } - }, - "values": { - "description": "Array of values to use for comparison", - "type": "array", - "items": { - "type": "string" - }, - "minItems": 1 - } - }, - "required": [ - "name", - "operator", - "values" - ] - }, - "ViewListResult": { - "description": "Result of listing views. It contains a list of available views.", - "type": "object", - "properties": { - "value": { - "description": "The list of views.", - "type": "array", - "readOnly": true, - "items": { - "$ref": "#/definitions/View" - } - }, - "nextLink": { - "description": "The link (url) to the next page of results.", - "type": "string", - "readOnly": true - } - } - }, - "View": { - "description": "States and configurations of Cost Analysis.", - "type": "object", - "allOf": [ - { - "$ref": "common-types.json#/definitions/CostManagementProxyResource" - } - ], - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/ViewProperties", - "title": "View properties" - } - } - }, - "ViewProperties": { - "type": "object", - "description": "The properties of the view.", - "properties": { - "displayName": { - "description": "User input name of the view. Required.", - "type": "string" - }, - "scope": { - "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.", - "type": "string" - }, - "createdOn": { - "description": "Date the user created this view.", - "type": "string", - "format": "date-time", - "readOnly": true - }, - "modifiedOn": { - "description": "Date when the user last modified this view.", - "type": "string", - "format": "date-time", - "readOnly": false - }, - "dateRange": { - "description": "Date range of the current view.", - "type": "string", - "readOnly": false - }, - "currency": { - "description": "Currency of the current view.", - "type": "string", - "readOnly": true - }, - "query": { - "description": "Query body configuration. Required.", - "x-ms-client-flatten": true, - "$ref": "#/definitions/ReportConfigDefinition" - }, - "chart": { - "description": "Chart type of the main view in Cost Analysis. Required.", - "type": "string", - "enum": [ - "Area", - "Line", - "StackedColumn", - "GroupedColumn", - "Table" - ], - "x-ms-enum": { - "name": "ChartType", - "modelAsString": true - } - }, - "accumulated": { - "description": "Show costs accumulated over time.", - "type": "string", - "enum": [ - "true", - "false" - ], - "x-ms-enum": { - "name": "AccumulatedType", - "modelAsString": true - } - }, - "metric": { - "description": "Metric to use when displaying costs.", - "type": "string", - "enum": [ - "ActualCost", - "AmortizedCost", - "AHUB" - ], - "x-ms-enum": { - "name": "MetricType", - "modelAsString": true - } - }, - "kpis": { - "description": "List of KPIs to show in Cost Analysis UI.", - "type": "array", - "items": { - "$ref": "#/definitions/KpiProperties" - } - }, - "pivots": { - "description": "Configuration of 3 sub-views in the Cost Analysis UI.", - "type": "array", - "items": { - "$ref": "#/definitions/PivotProperties" - }, - "x-ms-identifiers": [ - "name" - ] - } - } - }, - "KpiProperties": { - "description": "Each KPI must contain a 'type' and 'enabled' key.", - "type": "object", - "properties": { - "type": { - "description": "KPI type (Forecast, Budget).", - "type": "string", - "enum": [ - "Forecast", - "Budget" - ], - "x-ms-enum": { - "name": "KpiTypeType", - "modelAsString": true - } - }, - "id": { - "description": "ID of resource related to metric (budget).", - "type": "string" - }, - "enabled": { - "description": "show the KPI in the UI?", - "type": "boolean" - } - } - }, - "PivotProperties": { - "description": "Each pivot must contain a 'type' and 'name'.", - "type": "object", - "properties": { - "type": { - "description": "Data type to show in view.", - "type": "string", - "enum": [ - "Dimension", - "TagKey" - ], - "x-ms-enum": { - "name": "PivotTypeType", - "modelAsString": true - } - }, - "name": { - "description": "Data field to show in view.", - "type": "string" - } - } - }, - "CostManagementResource": { - "description": "The Resource model definition.", - "type": "object", - "properties": { - "id": { - "readOnly": true, - "type": "string", - "description": "Resource Id." - }, - "name": { - "readOnly": true, - "type": "string", - "description": "Resource name." - }, - "type": { - "readOnly": true, - "type": "string", - "description": "Resource type." - }, - "location": { - "readOnly": true, - "type": "string", - "description": "Location of the resource." - }, - "sku": { - "readOnly": true, - "type": "string", - "description": "SKU of the resource." - }, - "eTag": { - "readOnly": true, - "type": "string", - "description": "ETag of the resource." - }, - "tags": { - "readOnly": true, - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Resource tags." - } - }, - "x-ms-azure-resource": true - }, - "DimensionsListResult": { - "description": "Result of listing dimensions. It contains a list of available dimensions.", - "type": "object", - "properties": { - "value": { - "description": "The list of dimensions.", - "type": "array", - "readOnly": true, - "items": { - "$ref": "#/definitions/Dimension" - } - } - } - }, - "Dimension": { - "description": "List of Dimension.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CostManagementResource" - } - ], - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/DimensionProperties", - "title": "Dimension properties" - } - } - }, - "DimensionProperties": { - "description": "Dimension properties.", - "type": "object", - "properties": { - "description": { - "description": "Dimension description.", - "type": "string", - "readOnly": true - }, - "filterEnabled": { - "description": "Filter enabled.", - "type": "boolean", - "readOnly": true - }, - "groupingEnabled": { - "description": "Grouping enabled.", - "type": "boolean", - "readOnly": true - }, - "data": { - "description": "Dimension data.", - "type": "array", - "items": { - "description": "Dimension data item.", - "type": "string", - "readOnly": true - } - }, - "total": { - "description": "Total number of data for the dimension.", - "format": "int32", - "type": "integer", - "readOnly": true - }, - "category": { - "description": "Dimension category.", - "type": "string", - "readOnly": true - }, - "usageStart": { - "description": "Usage start.", - "format": "date-time", - "type": "string", - "readOnly": true - }, - "usageEnd": { - "description": "Usage end.", - "format": "date-time", - "type": "string", - "readOnly": true - }, - "nextLink": { - "description": "The link (url) to the next page of results.", - "type": "string", - "readOnly": true - } - } - }, - "AlertsResult": { - "description": "Result of alerts.", - "type": "object", - "properties": { - "value": { - "description": "List of alerts.", - "type": "array", - "readOnly": true, - "items": { - "$ref": "#/definitions/Alert" - } - }, - "nextLink": { - "description": "URL to get the next set of alerts results if there are any.", - "type": "string", - "readOnly": true - } - } - }, - "Alert": { - "description": "An individual alert.", - "type": "object", - "allOf": [ - { - "$ref": "common-types.json#/definitions/CostManagementProxyResource" - } - ], - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/AlertProperties", - "title": "Alert properties" - } - } - }, - "AlertProperties": { - "description": "Alert properties.", - "type": "object", - "properties": { - "definition": { - "description": "defines the type of alert", - "type": "object", - "properties": { - "type": { - "description": "type of alert", - "type": "string", - "enum": [ - "Budget", - "Invoice", - "Credit", - "Quota", - "General", - "xCloud", - "BudgetForecast" - ], - "x-ms-enum": { - "name": "AlertType", - "modelAsString": true - } - }, - "category": { - "description": "Alert category", - "type": "string", - "enum": [ - "Cost", - "Usage", - "Billing", - "System" - ], - "x-ms-enum": { - "name": "AlertCategory", - "modelAsString": true - } - }, - "criteria": { - "description": "Criteria that triggered alert", - "type": "string", - "enum": [ - "CostThresholdExceeded", - "UsageThresholdExceeded", - "CreditThresholdApproaching", - "CreditThresholdReached", - "QuotaThresholdApproaching", - "QuotaThresholdReached", - "MultiCurrency", - "ForecastCostThresholdExceeded", - "ForecastUsageThresholdExceeded", - "InvoiceDueDateApproaching", - "InvoiceDueDateReached", - "CrossCloudNewDataAvailable", - "CrossCloudCollectionError", - "GeneralThresholdError" - ], - "x-ms-enum": { - "name": "AlertCriteria", - "modelAsString": true - } - } - } - }, - "description": { - "description": "Alert description", - "type": "string" - }, - "source": { - "description": "Source of alert", - "type": "string", - "enum": [ - "Preset", - "User" - ], - "x-ms-enum": { - "name": "AlertSource", - "modelAsString": true - } - }, - "details": { - "description": "Alert details", - "type": "object", - "properties": { - "timeGrainType": { - "description": "Type of timegrain cadence", - "type": "string", - "enum": [ - "None", - "Monthly", - "Quarterly", - "Annually", - "BillingMonth", - "BillingQuarter", - "BillingAnnual" - ], - "x-ms-enum": { - "name": "AlertTimeGrainType", - "modelAsString": true - } - }, - "periodStartDate": { - "description": "datetime of periodStartDate", - "type": "string" - }, - "triggeredBy": { - "description": "notificationId that triggered this alert", - "type": "string" - }, - "resourceGroupFilter": { - "description": "array of resourceGroups to filter by", - "type": "array", - "items": {}, - "x-ms-identifiers": [] - }, - "resourceFilter": { - "description": "array of resources to filter by", - "type": "array", - "items": {}, - "x-ms-identifiers": [] - }, - "meterFilter": { - "description": "array of meters to filter by", - "type": "array", - "items": {}, - "x-ms-identifiers": [] - }, - "tagFilter": { - "description": "tags to filter by", - "type": "object", - "properties": {} - }, - "threshold": { - "description": "notification threshold percentage as a decimal which activated this alert", - "type": "number", - "format": "decimal" - }, - "operator": { - "description": "operator used to compare currentSpend with amount", - "type": "string", - "enum": [ - "None", - "EqualTo", - "GreaterThan", - "GreaterThanOrEqualTo", - "LessThan", - "LessThanOrEqualTo" - ], - "x-ms-enum": { - "name": "AlertOperator", - "modelAsString": true - } - }, - "amount": { - "description": "budget threshold amount", - "type": "number", - "format": "decimal" - }, - "unit": { - "description": "unit of currency being used", - "type": "string" - }, - "currentSpend": { - "description": "current spend", - "type": "number", - "format": "decimal" - }, - "contactEmails": { - "description": "list of emails to contact", - "type": "array", - "items": { - "type": "string" - } - }, - "contactGroups": { - "description": "list of action groups to broadcast to", - "type": "array", - "items": { - "type": "string" - } - }, - "contactRoles": { - "description": "list of contact roles", - "type": "array", - "items": { - "type": "string" - } - }, - "overridingAlert": { - "description": "overriding alert", - "type": "string" - }, - "departmentName": { - "description": "department name", - "type": "string" - }, - "companyName": { - "description": "company name", - "type": "string" - }, - "enrollmentNumber": { - "description": "enrollment number", - "type": "string" - }, - "enrollmentStartDate": { - "description": "datetime of enrollmentStartDate", - "type": "string" - }, - "enrollmentEndDate": { - "description": "datetime of enrollmentEndDate", - "type": "string" - }, - "invoicingThreshold": { - "description": "invoicing threshold", - "type": "number", - "format": "decimal" - } - } - }, - "costEntityId": { - "description": "related budget", - "type": "string" - }, - "status": { - "description": "alert status", - "type": "string", - "enum": [ - "None", - "Active", - "Overridden", - "Resolved", - "Dismissed" - ], - "x-ms-enum": { - "name": "AlertStatus", - "modelAsString": true - } - }, - "creationTime": { - "description": "dateTime in which alert was created", - "type": "string" - }, - "closeTime": { - "description": "dateTime in which alert was closed", - "type": "string" - }, - "modificationTime": { - "description": "dateTime in which alert was last modified", - "type": "string" - }, - "statusModificationUserName": { - "description": "User who last modified the alert", - "type": "string" - }, - "statusModificationTime": { - "description": "dateTime in which the alert status was last modified", - "type": "string" - } - } - }, - "DismissAlertPayload": { - "description": "The request payload to update an alert", - "type": "object", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/AlertProperties", - "title": "Alert properties" - } - } - }, - "ForecastResult": { - "description": "Result of forecast. It contains all columns listed under groupings and aggregation.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CostManagementResource" - } - ], - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/ForecastProperties", - "title": "Forecast properties" - } - } - }, - "ForecastProperties": { - "description": "Forecast properties", - "type": "object", - "properties": { - "nextLink": { - "description": "The link (url) to the next page of results.", - "type": "string" - }, - "columns": { - "description": "Array of columns", - "type": "array", - "items": { - "$ref": "#/definitions/ForecastColumn" - }, - "x-ms-identifiers": [ - "name" - ] - }, - "rows": { - "description": "Array of rows", - "type": "array", - "items": { - "type": "array", - "items": {}, - "x-ms-identifiers": [] - }, - "x-ms-identifiers": [] - } - } - }, - "ForecastColumn": { - "description": "Forecast column properties", - "type": "object", - "properties": { - "name": { - "description": "The name of column.", - "type": "string" - }, - "type": { - "description": "The type of column.", - "type": "string" - } - } - }, - "QueryResult": { - "description": "Result of query. It contains all columns listed under groupings and aggregation.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CostManagementResource" - } - ], - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/QueryProperties", - "title": "Query properties" - } - } - }, - "QueryProperties": { - "description": "Query properties", - "type": "object", - "properties": { - "nextLink": { - "description": "The link (url) to the next page of results.", - "type": "string" - }, - "columns": { - "description": "Array of columns", - "type": "array", - "items": { - "$ref": "#/definitions/QueryColumn" - }, - "x-ms-identifiers": [ - "name" - ] - }, - "rows": { - "description": "Array of rows", - "type": "array", - "items": { - "type": "array", - "items": {}, - "x-ms-identifiers": [] - }, - "x-ms-identifiers": [] - } - } - }, - "QueryColumn": { - "description": "QueryColumn properties", - "type": "object", - "properties": { - "name": { - "description": "The name of column.", - "type": "string" - }, - "type": { - "description": "The type of column.", - "type": "string" - } - } - }, - "ForecastDefinition": { - "description": "The definition of a forecast.", - "type": "object", - "properties": { - "type": { - "description": "The type of the forecast.", - "$ref": "#/definitions/ForecastType" - }, - "timeframe": { - "description": "The time frame for pulling data for the forecast. If custom, then a specific time period must be provided.", - "$ref": "#/definitions/ForecastTimeframe" - }, - "timePeriod": { - "description": "Has time period for pulling data for the forecast.", - "$ref": "#/definitions/ForecastTimePeriod" - }, - "dataset": { - "description": "Has definition for data in this forecast.", - "$ref": "#/definitions/ForecastDataset" - }, - "includeActualCost": { - "description": "A boolean determining if actualCost will be included.", - "type": "boolean" - }, - "includeFreshPartialCost": { - "description": "A boolean determining if FreshPartialCost will be included.", - "type": "boolean" - } - }, - "required": [ - "type", - "timeframe", - "dataset" - ] - }, - "ForecastType": { - "description": "The type of the forecast.", - "type": "string", - "enum": [ - "Usage", - "ActualCost", - "AmortizedCost" - ], - "x-ms-enum": { - "name": "ForecastType", - "modelAsString": true - } - }, - "ForecastTimeframe": { - "description": "The time frame for pulling data for the forecast.", - "type": "string", - "enum": [ - "Custom" - ], - "x-ms-enum": { - "name": "ForecastTimeframe", - "modelAsString": true - } - }, - "ForecastTimePeriod": { - "description": "Has time period for pulling data for the forecast.", - "type": "object", - "properties": { - "from": { - "description": "The start date to pull data from.", - "type": "string", - "format": "date-time" - }, - "to": { - "description": "The end date to pull data to.", - "type": "string", - "format": "date-time" - } - }, - "required": [ - "from", - "to" - ] - }, - "ForecastDataset": { - "description": "The definition of data present in the forecast.", - "type": "object", - "properties": { - "granularity": { - "description": "The granularity of rows in the forecast.", - "$ref": "#/definitions/GranularityType" - }, - "configuration": { - "description": "Has configuration information for the data in the export. The configuration will be ignored if aggregation and grouping are provided.", - "$ref": "#/definitions/ForecastDatasetConfiguration" - }, - "aggregation": { - "description": "Dictionary of aggregation expression to use in the forecast. The key of each item in the dictionary is the alias for the aggregated column. forecast can have up to 2 aggregation clauses.", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/ForecastAggregation" - }, - "maxItems": 2 - }, - "filter": { - "description": "Has filter expression to use in the forecast.", - "$ref": "#/definitions/ForecastFilter" - } - }, - "required": [ - "aggregation" - ] - }, - "GranularityType": { - "description": "The granularity of rows in the forecast.", - "type": "string", - "enum": [ - "Daily" - ], - "x-ms-enum": { - "name": "GranularityType", - "modelAsString": true - } - }, - "ForecastDatasetConfiguration": { - "description": "The configuration of dataset in the forecast.", - "type": "object", - "properties": { - "columns": { - "description": "Array of column names to be included in the forecast. Any valid forecast column name is allowed. If not provided, then forecast includes all columns.", - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "ForecastAggregation": { - "description": "The aggregation expression to be used in the forecast.", - "type": "object", - "properties": { - "name": { - "description": "The name of the column to aggregate.", - "type": "string", - "enum": [ - "PreTaxCostUSD", - "Cost", - "CostUSD", - "PreTaxCost" - ], - "x-ms-enum": { - "name": "FunctionName", - "modelAsString": true - } - }, - "function": { - "description": "The name of the aggregation function to use.", - "type": "string", - "enum": [ - "Sum" - ], - "x-ms-enum": { - "name": "FunctionType", - "modelAsString": true - } - } - }, - "required": [ - "name", - "function" - ] - }, - "ForecastFilter": { - "description": "The filter expression to be used in the export.", - "type": "object", - "properties": { - "and": { - "description": "The logical \"AND\" expression. Must have at least 2 items.", - "type": "array", - "items": { - "$ref": "#/definitions/ForecastFilter" - }, - "x-ms-identifiers": [], - "minItems": 2 - }, - "or": { - "description": "The logical \"OR\" expression. Must have at least 2 items.", - "type": "array", - "items": { - "$ref": "#/definitions/ForecastFilter" - }, - "x-ms-identifiers": [], - "minItems": 2 - }, - "dimensions": { - "description": "Has comparison expression for a dimension", - "$ref": "#/definitions/ForecastComparisonExpression" - }, - "tags": { - "description": "Has comparison expression for a tag", - "$ref": "#/definitions/ForecastComparisonExpression" - } - } - }, - "ForecastComparisonExpression": { - "description": "The comparison expression to be used in the forecast.", - "type": "object", - "properties": { - "name": { - "description": "The name of the column to use in comparison.", - "type": "string" - }, - "operator": { - "description": "The operator to use for comparison.", - "type": "string", - "enum": [ - "In" - ], - "x-ms-enum": { - "name": "ForecastOperatorType", - "modelAsString": true - } - }, - "values": { - "description": "Array of values to use for comparison", - "type": "array", - "items": { - "type": "string" - }, - "minItems": 1 - } - }, - "required": [ - "name", - "operator", - "values" - ] - }, - "QueryDefinition": { - "description": "The definition of a query.", - "type": "object", - "properties": { - "type": { - "description": "The type of the query.", - "type": "string", - "enum": [ - "Usage", - "ActualCost", - "AmortizedCost" - ], - "x-ms-enum": { - "name": "ExportType", - "modelAsString": true - } - }, - "timeframe": { - "description": "The time frame for pulling data for the query. If custom, then a specific time period must be provided.", - "type": "string", - "enum": [ - "MonthToDate", - "BillingMonthToDate", - "TheLastMonth", - "TheLastBillingMonth", - "WeekToDate", - "Custom" - ], - "x-ms-enum": { - "name": "TimeframeType", - "modelAsString": true - } - }, - "timePeriod": { - "description": "Has time period for pulling data for the query.", - "$ref": "#/definitions/QueryTimePeriod" - }, - "dataset": { - "description": "Has definition for data in this query.", - "$ref": "#/definitions/QueryDataset" - } - }, - "required": [ - "type", - "timeframe", - "dataset" - ] - }, - "QueryTimePeriod": { - "description": "The start and end date for pulling data for the query.", - "type": "object", - "properties": { - "from": { - "description": "The start date to pull data from.", - "type": "string", - "format": "date-time" - }, - "to": { - "description": "The end date to pull data to.", - "type": "string", - "format": "date-time" - } - }, - "required": [ - "from", - "to" - ] - }, - "QueryDataset": { - "description": "The definition of data present in the query.", - "type": "object", - "properties": { - "granularity": { - "description": "The granularity of rows in the query.", - "type": "string", - "enum": [ - "Daily" - ], - "x-ms-enum": { - "name": "GranularityType", - "modelAsString": true - } - }, - "configuration": { - "description": "Has configuration information for the data in the export. The configuration will be ignored if aggregation and grouping are provided.", - "$ref": "#/definitions/QueryDatasetConfiguration" - }, - "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" - }, - "maxItems": 2 - }, - "grouping": { - "description": "Array of group by expression to use in the query. Query can have up to 2 group by clauses.", - "type": "array", - "items": { - "$ref": "#/definitions/QueryGrouping" - }, - "x-ms-identifiers": [ - "name", - "type" - ], - "maxItems": 2 - }, - "filter": { - "description": "The filter expression to use in the query. Please reference our Query API REST documentation for how to properly format the filter.", - "$ref": "#/definitions/QueryFilter" - } - } - }, - "OperationStatus": { - "description": "The status of the long running operation.", - "type": "object", - "properties": { - "status": { - "description": "The status of the long running operation.", - "type": "string", - "enum": [ - "Running", - "Completed", - "Failed" - ], - "x-ms-enum": { - "name": "OperationStatusType", - "modelAsString": true - } - }, - "properties": { - "x-ms-client-flatten": true, - "description": "The properties of the resource generated.", - "$ref": "#/definitions/ReportURL" - } - } - }, - "ReportURL": { - "description": "The URL to download the generated report.", - "type": "object", - "properties": { - "reportUrl": { - "description": "The CSV file from the reportUrl blob link consists of reservation usage data with the following schema at daily granularity", - "$ref": "#/definitions/ReservationReportSchema" - }, - "validUntil": { - "description": "The time at which report URL becomes invalid.", - "type": "string", - "format": "date-time" - } - } - }, - "QueryDatasetConfiguration": { - "description": "The configuration of dataset in the query.", - "type": "object", - "properties": { - "columns": { - "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.", - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "QueryAggregation": { - "description": "The aggregation expression to be used in the query.", - "type": "object", - "properties": { - "name": { - "description": "The name of the column to aggregate.", - "type": "string" - }, - "function": { - "description": "The name of the aggregation function to use.", - "type": "string", - "enum": [ - "Sum" - ], - "x-ms-enum": { - "name": "FunctionType", - "modelAsString": true - } - } - }, - "required": [ - "name", - "function" - ] - }, - "QueryGrouping": { - "description": "The group by expression to be used in the query.", - "type": "object", - "properties": { - "type": { - "description": "Has type of the column to group.", - "$ref": "#/definitions/QueryColumnType" - }, - "name": { - "description": "The name of the column to group.", - "type": "string" - } - }, - "required": [ - "type", - "name" - ] - }, - "QueryFilter": { - "description": "The filter expression to be used in the export.", - "type": "object", - "properties": { - "and": { - "description": "The logical \"AND\" expression. Must have at least 2 items.", - "type": "array", - "items": { - "$ref": "#/definitions/QueryFilter" - }, - "x-ms-identifiers": [], - "minItems": 2 - }, - "or": { - "description": "The logical \"OR\" expression. Must have at least 2 items.", - "type": "array", - "items": { - "$ref": "#/definitions/QueryFilter" - }, - "x-ms-identifiers": [], - "minItems": 2 - }, - "dimensions": { - "description": "Has comparison expression for a dimension", - "$ref": "#/definitions/QueryComparisonExpression" - }, - "tags": { - "description": "Has comparison expression for a tag", - "$ref": "#/definitions/QueryComparisonExpression" - } - } - }, - "QueryColumnType": { - "description": "The type of the column in the export.", - "type": "string", - "enum": [ - "TagKey", - "Dimension" - ], - "x-ms-enum": { - "name": "QueryColumnType", - "modelAsString": true, - "values": [ - { - "value": "TagKey", - "description": "The tag associated with the cost data." - }, - { - "value": "Dimension", - "description": "The dimension of cost data." - } - ] - } - }, - "QueryComparisonExpression": { - "description": "The comparison expression to be used in the query.", - "type": "object", - "properties": { - "name": { - "description": "The name of the column to use in comparison.", - "type": "string" - }, - "operator": { - "description": "The operator to use for comparison.", - "type": "string", - "enum": [ - "In" - ], - "x-ms-enum": { - "name": "QueryOperatorType", - "modelAsString": true - } - }, - "values": { - "description": "Array of values to use for comparison", - "type": "array", - "items": { - "type": "string" - }, - "minItems": 1 - } - }, - "required": [ - "name", - "operator", - "values" - ] - }, - "ReservationReportSchema": { - "description": "The CSV file from the reportUrl blob link consists of reservation usage data with the following schema at daily granularity", - "type": "string", - "enum": [ - "InstanceFlexibilityGroup", - "InstanceFlexibilityRatio", - "InstanceId", - "Kind", - "ReservationId", - "ReservationOrderId", - "ReservedHours", - "SkuName", - "TotalReservedQuantity", - "UsageDate", - "UsedHours" - ], - "x-ms-enum": { - "name": "ReservationReportSchema", - "modelAsString": true - } - } - }, - "parameters": { - "viewNameParameter": { - "name": "viewName", - "in": "path", - "description": "View name", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "scopeViewParameter": { - "name": "scope", - "in": "path", - "required": true, - "type": "string", - "description": "The scope associated with view 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.Management/managementGroups/{managementGroupId}' for Management Group scope, 'providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}' for External Billing Account scope and 'providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}' for External Subscription scope.", - "x-ms-parameter-location": "method" - }, - "scopeDimensionParameter": { - "name": "scope", - "in": "path", - "required": true, - "type": "string", - "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.", - "x-ms-parameter-location": "method", - "x-ms-skip-url-encoding": true - }, - "scopeAlertParameter": { - "name": "scope", - "in": "path", - "required": true, - "type": "string", - "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.", - "x-ms-parameter-location": "method", - "x-ms-skip-url-encoding": true - }, - "scopeForecastParameter": { - "name": "scope", - "in": "path", - "required": true, - "type": "string", - "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.", - "x-ms-parameter-location": "method", - "x-ms-skip-url-encoding": true - }, - "scopeQueryParameter": { - "name": "scope", - "in": "path", - "required": true, - "type": "string", - "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.", - "x-ms-parameter-location": "method", - "x-ms-skip-url-encoding": true - }, - "subscriptionIdParameter": { - "name": "subscriptionId", - "in": "path", - "description": "Azure Subscription ID.", - "required": true, - "type": "string" - }, - "resourceGroupNameParameter": { - "name": "resourceGroupName", - "in": "path", - "description": "Azure Resource Group Name.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "startDateParameter": { - "name": "startDate", - "in": "query", - "description": "Start Date", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "endDateParameter": { - "name": "endDate", - "in": "query", - "description": "End Date", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "enrollmentIdParameter": { - "name": "billingAccountId", - "in": "path", - "description": "Enrollment ID (Legacy BillingAccount ID)", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "managementGroupIdParameter": { - "name": "managementGroupId", - "in": "path", - "description": "ManagementGroup ID", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "departmentIdParameter": { - "name": "departmentId", - "in": "path", - "description": "Department ID", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "enrollmentAccountIdParameter": { - "name": "enrollmentAccountId", - "in": "path", - "description": "Enrollment Account ID", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "externalCloudProviderTypeParameter": { - "name": "externalCloudProviderType", - "in": "path", - "required": true, - "type": "string", - "enum": [ - "externalSubscriptions", - "externalBillingAccounts" - ], - "x-ms-enum": { - "name": "externalCloudProviderType", - "modelAsString": true - }, - "description": "The external cloud provider type associated with dimension/query operations. This includes 'externalSubscriptions' for linked account and 'externalBillingAccounts' for consolidated account.", - "x-ms-parameter-location": "method" - }, - "externalCloudProviderIdParameter": { - "name": "externalCloudProviderId", - "in": "path", - "required": true, - "type": "string", - "description": "This can be '{externalSubscriptionId}' for linked account or '{externalBillingAccountId}' for consolidated account used with dimension/query operations.", - "x-ms-parameter-location": "method" - }, - "alertIdParameter": { - "name": "alertId", - "in": "path", - "description": "Alert ID", - "required": true, - "type": "string", - "x-ms-parameter-location": "method", - "x-ms-skip-url-encoding": true - } - } -} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/costmanagement.pricesheets.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/costmanagement.pricesheets.json deleted file mode 100644 index b1faf9b6530b..000000000000 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/costmanagement.pricesheets.json +++ /dev/null @@ -1,592 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "version": "2025-03-01", - "title": "CostManagementClient" - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ], - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Azure Active Directory OAuth2 Flow.", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "paths": { - "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoices/{invoiceName}/providers/Microsoft.CostManagement/pricesheets/default/download": { - "post": { - "tags": [ - "PriceSheets" - ], - "x-ms-examples": { - "PricesheetDownload": { - "$ref": "./examples/PricesheetDownload.json" - } - }, - "operationId": "PriceSheet_DownloadByInvoice", - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" - }, - "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/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/billingAccountNameParameter" - }, - { - "$ref": "#/parameters/billingProfileNameParameter" - }, - { - "$ref": "#/parameters/invoiceNameParameter" - } - ], - "responses": { - "202": { - "description": "Accepted.", - "headers": { - "Location": { - "description": "GET this URL to retrieve the status of the asynchronous operation.", - "type": "string" - }, - "Retry-After": { - "description": "The amount of delay to use while the status of the operation is checked. The value is expressed in seconds.", - "type": "string" - }, - "OData-EntityId": { - "description": "The operation entity Id GUID.", - "type": "string" - } - } - }, - "200": { - "description": "OK. The request has succeeded.", - "schema": { - "$ref": "common-types.json#/definitions/DownloadURL" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "common-types.json#/definitions/ErrorResponse" - } - } - } - } - }, - "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/providers/Microsoft.CostManagement/pricesheets/default/download": { - "post": { - "tags": [ - "PriceSheets" - ], - "x-ms-examples": { - "PricesheetDownloadByBillingProfile": { - "$ref": "./examples/PricesheetDownloadByBillingProfile.json" - } - }, - "operationId": "PriceSheet_DownloadByBillingProfile", - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" - }, - "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 \n You 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 \n Due 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/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/billingAccountNameParameter" - }, - { - "$ref": "#/parameters/billingProfileNameParameter" - } - ], - "responses": { - "202": { - "description": "Accepted.", - "headers": { - "Location": { - "description": "GET this URL to retrieve the status of the asynchronous operation.", - "type": "string" - }, - "Retry-After": { - "description": "The amount of delay to use while the status of the operation is checked. The value is expressed in seconds.", - "type": "string" - }, - "OData-EntityId": { - "description": "The operation entity Id GUID.", - "type": "string" - } - } - }, - "200": { - "description": "OK. The request has succeeded.", - "schema": { - "$ref": "#/definitions/PricesheetDownloadProperties" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "common-types.json#/definitions/ErrorResponse" - } - } - } - } - }, - "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingPeriods/{billingPeriodName}/providers/Microsoft.CostManagement/pricesheets/default/download": { - "post": { - "tags": [ - "PriceSheets" - ], - "x-ms-examples": { - "EAPriceSheetForBillingPeriod": { - "$ref": "./examples/EAPriceSheetForBillingPeriod.json" - } - }, - "operationId": "PriceSheet_DownloadByBillingAccount", - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" - }, - "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\n You 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\n With 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\n The 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\n The 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\n All 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/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/billingAccountIdParameter" - }, - { - "$ref": "#/parameters/billingPeriodNameParameter" - } - ], - "responses": { - "202": { - "description": "Accepted.", - "headers": { - "Location": { - "description": "GET this URL to retrieve the status of the asynchronous operation.", - "type": "string" - }, - "Retry-After": { - "description": "The amount of delay to use while the status of the operation is checked. The value is expressed in seconds.", - "type": "string" - } - } - }, - "200": { - "description": "OK. The request has succeeded.", - "schema": { - "$ref": "#/definitions/OperationStatus" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" - } - } - } - } - } - }, - "definitions": { - "OperationStatus": { - "description": "The status of the long running operation.", - "type": "object", - "properties": { - "status": { - "description": "The status of the long running operation.", - "type": "string", - "enum": [ - "Running", - "Completed", - "Failed" - ], - "x-ms-enum": { - "name": "OperationStatusType", - "modelAsString": true - } - }, - "properties": { - "x-ms-client-flatten": true, - "description": "The properties of the resource generated.", - "$ref": "#/definitions/EAPricesheetDownloadProperties" - } - } - }, - "EAPricesheetDownloadProperties": { - "description": "The properties of the price sheet download.", - "type": "object", - "properties": { - "downloadUrl": { - "description": "The link (url) to download the pricesheet.", - "type": "string", - "readOnly": true - }, - "validTill": { - "description": "Download link validity.", - "type": "string", - "format": "date-time", - "readOnly": true - }, - "downloadFileProperties": { - "description": "The properties in downloaded file", - "type": "object", - "$ref": "#/definitions/EAPriceSheetProperties" - } - } - }, - "PricesheetDownloadProperties": { - "description": "The URL to download the generated report.", - "type": "object", - "properties": { - "expiryTime": { - "description": "The time at which report URL becomes invalid/expires in UTC e.g. 2020-12-08T05:55:59.4394737Z.", - "type": "string", - "format": "date-time", - "readOnly": true - }, - "downloadUrl": { - "description": "The URL to download the generated report.", - "type": "string" - }, - "downloadFileProperties": { - "description": "The properties in downloaded file", - "type": "object", - "$ref": "#/definitions/MCAPriceSheetProperties" - } - } - }, - "MCAPriceSheetProperties": { - "description": "The properties of the price sheet.", - "type": "object", - "properties": { - "billingAccountID": { - "description": "Unique identifier for the billing account.", - "type": "string", - "readOnly": true - }, - "billingAccountName": { - "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.", - "type": "string", - "readOnly": true - }, - "billingProfileId": { - "description": "Unique identifier for the billing profile.", - "type": "string", - "readOnly": true - }, - "billingProfileName": { - "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.", - "type": "string", - "readOnly": true - }, - "productOrderName": { - "description": "Name of the purchased product plan. Indicates if this pricing is standard Azure Plan pricing, Dev/Test pricing etc. \n\n Currently unavailable for Azure 3rd party and ReservedInstance meters.", - "type": "string", - "readOnly": true - }, - "serviceFamily": { - "description": "Type of Azure service. For example, Compute, Analytics, and Security.", - "type": "number", - "readOnly": true - }, - "product": { - "description": "Name of the product accruing the charges.", - "type": "string", - "readOnly": true - }, - "productId": { - "description": "Unique identifier for the product whose meter is consumed.", - "type": "string", - "readOnly": true - }, - "skuId": { - "description": "Unique identifier of the SKU", - "type": "string", - "readOnly": true - }, - "unitOfMeasure": { - "description": "How usage is measured for the service", - "type": "string", - "readOnly": true - }, - "meterId": { - "description": "Unique identifier of the meter ", - "type": "string", - "readOnly": true - }, - "meterName": { - "description": "Name of the meter. The meter represents the deployable resource of an Azure service.", - "type": "string", - "readOnly": true - }, - "meterType": { - "description": "Name of the meter type", - "type": "string", - "readOnly": true - }, - "meterCategory": { - "description": "Name of the classification category for the meter. For example, Cloud services, Networking, etc. ", - "type": "string", - "readOnly": true - }, - "meterSubCategory": { - "description": "Name of the meter subclassification category.", - "type": "string", - "readOnly": true - }, - "meterRegion": { - "description": "Name of the Azure region where the meter for the service is available.", - "type": "string", - "readOnly": true - }, - "tierMinimumUnits": { - "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.", - "type": "string", - "readOnly": true - }, - "effectiveStartDate": { - "description": "Effective start date of the Price Sheet billing period", - "type": "string", - "format": "date-time", - "readOnly": true - }, - "effectiveEndDate": { - "description": "Effective end date of the Price Sheet billing period", - "type": "string", - "format": "date-time", - "readOnly": true - }, - "unitPrice": { - "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\n For PriceType ReservedInstance, unit price reflects the total cost of the 1 or 3-year commitment including discounts.\n\n Note: The unit price isn't the same as the effective price in usage details downloads when services have differential prices across tiers.\n\n If 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).", - "type": "string", - "readOnly": true - }, - "basePrice": { - "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\n This is applicable for Enterprise Agreement users", - "type": "string", - "readOnly": true - }, - "marketPrice": { - "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\n For PriceType Consumption, market price is reflected as the pay-as-you-go price.\n\n For PriceType Savings Plan, market price reflects the Savings plan benefit on top of pay-as-you-go price for the corresponding commitment term.\n\n For PriceType ReservedInstance, market price reflects the total price of the 1 or 3-year commitment.", - "type": "string", - "readOnly": true - }, - "currency": { - "description": "Currency in which all the prices are reflected.", - "type": "string", - "readOnly": true - }, - "billingCurrency": { - "description": "Currency in which charges are posted.", - "type": "string", - "readOnly": true - }, - "term": { - "description": "Term length for Azure Savings Plan or Reservation term – one year or three years (P1Y or P3Y)", - "type": "string", - "readOnly": true - }, - "priceType": { - "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.", - "type": "string", - "readOnly": true - } - } - }, - "EAPriceSheetProperties": { - "description": "The properties of the EA price sheet. Properties supported with version 2025-03-01 are as below", - "type": "object", - "properties": { - "enrollmentNumber": { - "description": "Unique identifier for the EA billing account.", - "type": "string", - "readOnly": true - }, - "serviceFamily": { - "description": "Type of Azure service. For example, Compute, Analytics, and Security.", - "type": "number", - "readOnly": true - }, - "product": { - "description": "Name of the product accruing the charges.", - "type": "string", - "readOnly": true - }, - "productId": { - "description": "Unique identifier for the product whose meter is consumed.", - "type": "string", - "readOnly": true - }, - "skuId": { - "description": "Unique identifier of the SKU", - "type": "string", - "readOnly": true - }, - "unitOfMeasure": { - "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”. ", - "type": "string", - "readOnly": true - }, - "meterId": { - "description": "Unique identifier of the meter ", - "type": "string", - "readOnly": true - }, - "meterName": { - "description": "Name of the meter. The meter represents the deployable resource of an Azure service.", - "type": "string", - "readOnly": true - }, - "meterType": { - "description": "Name of the meter type", - "type": "string", - "readOnly": true - }, - "offerId": { - "description": "Determines the Azure offer associated with this meter. [Learn more about Azure offers] (https://azure.microsoft.com/en-us/support/legal/offer-details/)", - "type": "string", - "readOnly": true - }, - "meterCategory": { - "description": "Name of the classification category for the meter. For example, Cloud services, Networking, etc. ", - "type": "string", - "readOnly": true - }, - "meterSubCategory": { - "description": "Name of the meter subclassification category.", - "type": "string", - "readOnly": true - }, - "meterRegion": { - "description": "Name of the Azure region where the meter for the service is available.", - "type": "string", - "readOnly": true - }, - "effectiveStartDate": { - "description": "Effective start date of the Price Sheet billing period", - "type": "string", - "format": "date-time", - "readOnly": true - }, - "effectiveEndDate": { - "description": "Effective end date of the Price Sheet billing period", - "type": "string", - "format": "date-time", - "readOnly": true - }, - "unitPrice": { - "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\n For PriceType ReservedInstance, unit price reflects the total cost of the 1 or 3-year commitment including discounts.\n\n Note: The unit price isn't the same as the effective price in usage details downloads when services have differential prices across tiers.\n\n If 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).", - "type": "string", - "readOnly": true - }, - "basePrice": { - "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\n This is applicable for Enterprise Agreement users", - "type": "string", - "readOnly": true - }, - "marketPrice": { - "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\n For PriceType Consumption, market price is reflected as the pay-as-you-go price.\n\n For PriceType Savings Plan, market price reflects the Savings plan benefit on top of pay-as-you-go price for the corresponding commitment term.\n\n For PriceType ReservedInstance, market price reflects the total price of the 1 or 3-year commitment.\n\n Note: For EA customers with no negotiations, market price may appear rounded to a different decimal precision than unit price.", - "type": "string", - "readOnly": true - }, - "includedQuantity": { - "description": "Quantities of a specific service to which an EA customer is entitled to consume without incremental charges.", - "type": "string", - "readOnly": true - }, - "currencyCode": { - "description": "Currency in which the Enterprise Agreement was signed", - "type": "string", - "readOnly": true - }, - "term": { - "description": "Term length for Azure Savings Plan or Reservation term – one year or three years (P1Y or P3Y)", - "type": "string", - "readOnly": true - }, - "priceType": { - "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.", - "type": "string", - "readOnly": true - }, - "partNumber": { - "description": "Part number associated with the meter", - "type": "string", - "readOnly": true - } - } - } - }, - "parameters": { - "billingAccountNameParameter": { - "name": "billingAccountName", - "in": "path", - "description": "The ID that uniquely identifies a billing account.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method", - "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}" - }, - "billingProfileNameParameter": { - "name": "billingProfileName", - "in": "path", - "description": "The ID that uniquely identifies a billing profile.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method", - "pattern": "([A-Za-z0-9]+(-[A-Za-z0-9]+)+)" - }, - "invoiceNameParameter": { - "name": "invoiceName", - "in": "path", - "description": "The ID that uniquely identifies an invoice.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method", - "pattern": "[A-Za-z0-9]+" - }, - "billingAccountIdParameter": { - "name": "billingAccountId", - "in": "path", - "description": "BillingAccount ID", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "billingPeriodNameParameter": { - "name": "billingPeriodName", - "in": "path", - "description": "Billing Period Name.", - "required": true, - "type": "string", - "pattern": "^[0-9]*$", - "x-ms-parameter-location": "method" - } - } -} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/BenefitRecommendationsByBillingAccount.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/BenefitRecommendationsByBillingAccount.json index 2b4daa7e7345..54a381910860 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/BenefitRecommendationsByBillingAccount.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/BenefitRecommendationsByBillingAccount.json @@ -1,100 +1,28 @@ { "parameters": { - "api-version": "2025-03-01", - "billingScope": "providers/Microsoft.Billing/billingAccounts/123456", "$expand": "properties/usage,properties/allRecommendationDetails", - "$filter": "properties/lookBackPeriod eq 'Last7Days' AND properties/term eq 'P1Y'" + "$filter": "properties/lookBackPeriod eq 'Last7Days' AND properties/term eq 'P1Y'", + "api-version": "2025-03-01", + "billingScope": "providers/Microsoft.Billing/billingAccounts/123456" }, "responses": { "200": { "body": { "value": [ { - "id": "/providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/benefitRecommendations/00000000-0000-0000-0000-000000000000", "name": "00000000-0000-0000-0000-000000000000", "type": "Microsoft.CostManagement/benefitRecommendations", + "id": "/providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/benefitRecommendations/00000000-0000-0000-0000-000000000000", "kind": "SavingsPlan", "properties": { - "firstConsumptionDate": "2022-10-18T00:00:00Z", - "lastConsumptionDate": "2022-10-25T00:00:00Z", - "lookBackPeriod": "Last7Days", - "totalHours": 168, - "usage": { - "usageGrain": "Hourly", - "charges": [ - 1.0, - 1.0, - 0.0, - 1.0, - 1.0, - 1.0, - 1.0, - 1.0, - 1.0, - 1.0, - 1.0, - 1.0, - 1.0, - 1.0, - 1.0, - 1.0, - 1.0, - 1.0, - 1.0, - 1.0, - 1.0, - 1.0, - 1.0, - 1.0, - 1.0, - 1.0, - 1.0, - 1.0, - 1.0, - 1.0, - 1.0, - 1.0, - 1.0, - 1.0, - 1.0, - 1.0, - 1.0, - 1.0, - 1.0, - 1.0, - 1.0, - 1.0, - 2.0, - 2.0, - 2.0, - 2.0 - ] - }, - "armSkuName": "Compute_Savings_Plan", - "term": "P1Y", - "commitmentGranularity": "Hourly", - "currencyCode": "USD", - "costWithoutBenefit": 218.267, - "scope": "Shared", - "recommendationDetails": { - "averageUtilizationPercentage": 99.330, - "coveragePercentage": 54.609, - "commitmentAmount": 0.164, - "overageCost": 144.841, - "benefitCost": 52.002, - "savingsAmount": 21.424, - "savingsPercentage": 9.815, - "totalCost": 196.843, - "wastageCost": 0.035 - }, "allRecommendationDetails": { "value": [ { - "averageUtilizationPercentage": 99.330, - "coveragePercentage": 54.609, + "averageUtilizationPercentage": 99.33, + "benefitCost": 52.002, "commitmentAmount": 0.164, + "coveragePercentage": 54.609, "overageCost": 144.841, - "benefitCost": 52.002, "savingsAmount": 21.424, "savingsPercentage": 9.815, "totalCost": 196.843, @@ -102,21 +30,95 @@ }, { "averageUtilizationPercentage": 81.474, - "coveragePercentage": 56.748, + "benefitCost": 83.754, "commitmentAmount": 0.161, + "coveragePercentage": 56.748, "overageCost": 120.389, - "benefitCost": 83.754, "savingsAmount": 14.124, - "savingsPercentage": 6.470, + "savingsPercentage": 6.47, "totalCost": 204.143, - "wastageCost": 0.100 + "wastageCost": 0.1 } ] + }, + "armSkuName": "Compute_Savings_Plan", + "commitmentGranularity": "Hourly", + "costWithoutBenefit": 218.267, + "currencyCode": "USD", + "firstConsumptionDate": "2022-10-18T00:00:00Z", + "lastConsumptionDate": "2022-10-25T00:00:00Z", + "lookBackPeriod": "Last7Days", + "recommendationDetails": { + "averageUtilizationPercentage": 99.33, + "benefitCost": 52.002, + "commitmentAmount": 0.164, + "coveragePercentage": 54.609, + "overageCost": 144.841, + "savingsAmount": 21.424, + "savingsPercentage": 9.815, + "totalCost": 196.843, + "wastageCost": 0.035 + }, + "scope": "Shared", + "term": "P1Y", + "totalHours": 168, + "usage": { + "charges": [ + 1, + 1, + 0, + 1, + 1, + 1, + 1, + 1, + 1, + 1, + 1, + 1, + 1, + 1, + 1, + 1, + 1, + 1, + 1, + 1, + 1, + 1, + 1, + 1, + 1, + 1, + 1, + 1, + 1, + 1, + 1, + 1, + 1, + 1, + 1, + 1, + 1, + 1, + 1, + 1, + 1, + 1, + 2, + 2, + 2, + 2 + ], + "usageGrain": "Hourly" } } } ] } } - } + }, + "operationId": "BenefitRecommendations_List", + "title": "BenefitRecommendationsBillingAccountList" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/BenefitUtilizationSummaries/Async/GenerateBenefitUtilizationSummariesReportByBillingAccount.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/BenefitUtilizationSummaries/Async/GenerateBenefitUtilizationSummariesReportByBillingAccount.json index 04aa60897759..d10904aa1d15 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/BenefitUtilizationSummaries/Async/GenerateBenefitUtilizationSummariesReportByBillingAccount.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/BenefitUtilizationSummaries/Async/GenerateBenefitUtilizationSummariesReportByBillingAccount.json @@ -1,37 +1,39 @@ { "parameters": { "api-version": "2025-03-01", - "billingAccountId": "8099099", "benefitUtilizationSummariesRequest": { - "kind": "Reservation", "endDate": "2022-08-31T00:00:00Z", - "startDate": "2022-06-01T00:00:00Z", - "grain": "Daily" - } + "grain": "Daily", + "kind": "Reservation", + "startDate": "2022-06-01T00:00:00Z" + }, + "billingAccountId": "8099099" }, "responses": { - "202": { - "headers": { - "Location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/8099099/providers/Microsoft.CostManagement/benefitUtilizationSummariesOperationResults/cf9f95c9-af6b-41dd-a622-e6f4fc60c3ee?api-version=2025-03-01", - "Retry-After": "60" - } - }, "200": { "body": { "input": { - "grain": "Daily", "billingAccountId": "8099099", - "kind": "Reservation", "endDate": "2022-08-31T00:00:00Z", + "grain": "Daily", + "kind": "Reservation", "startDate": "2022-06-01T00:00:00Z" }, - "status": "Complete", "properties": { "reportUrl": "https://storage.blob.core.windows.net/details/20220611/00000000-0000-0000-0000-000000000000?sv=2016-05-31&sr=b&sig=jep8HT2aphfUkyERRZa5LRfd9RPzjXbzB%2F9TNiQ", "secondaryReportUrl": "https://storage-secondary.blob.core.windows.net/details/20220611/00000000-0000-0000-0000-000000000000?sv=2016-05-31&sr=b&sig=jep8HT2aphfUkyERRZa5LRfd9RPzjXbzB%2F9TNiQ", "validUntil": "2022-06-12T02:56:55.5021869Z" - } + }, + "status": "Complete" + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/8099099/providers/Microsoft.CostManagement/benefitUtilizationSummariesOperationResults/cf9f95c9-af6b-41dd-a622-e6f4fc60c3ee?api-version=2025-03-01", + "Retry-After": "60" } } - } + }, + "operationId": "GenerateBenefitUtilizationSummariesReport_GenerateByBillingAccount", + "title": "GenerateUtilizationSummariesReportByBillingAccount" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/BenefitUtilizationSummaries/Async/GenerateBenefitUtilizationSummariesReportByBillingProfile.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/BenefitUtilizationSummaries/Async/GenerateBenefitUtilizationSummariesReportByBillingProfile.json index 512d55aa694b..ca2bf5230bc2 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/BenefitUtilizationSummaries/Async/GenerateBenefitUtilizationSummariesReportByBillingProfile.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/BenefitUtilizationSummaries/Async/GenerateBenefitUtilizationSummariesReportByBillingProfile.json @@ -1,39 +1,41 @@ { "parameters": { "api-version": "2025-03-01", - "billingAccountId": "00000000-0000-0000-0000-000000000000", - "billingProfileId": "CZSFR-SDFXC-DSDF", "benefitUtilizationSummariesRequest": { - "kind": "Reservation", "endDate": "2022-08-31T00:00:00Z", - "startDate": "2022-06-01T00:00:00Z", - "grain": "Daily" - } + "grain": "Daily", + "kind": "Reservation", + "startDate": "2022-06-01T00:00:00Z" + }, + "billingAccountId": "00000000-0000-0000-0000-000000000000", + "billingProfileId": "CZSFR-SDFXC-DSDF" }, "responses": { - "202": { - "headers": { - "Location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000/billingProfiles/CZSFR-SDFXC-DSDF/providers/Microsoft.CostManagement/benefitUtilizationSummariesOperationResults/cf9f95c9-af6b-41dd-a622-e6f4fc60c3ee?api-version=2025-03-01", - "Retry-After": "60" - } - }, "200": { "body": { "input": { - "grain": "Daily", "billingAccountId": "00000000-0000-0000-0000-000000000000", "billingProfileId": "CZSFR-SDFXC-DSDF", - "kind": "Reservation", "endDate": "2022-08-31T00:00:00Z", + "grain": "Daily", + "kind": "Reservation", "startDate": "2022-06-01T00:00:00Z" }, - "status": "Complete", "properties": { "reportUrl": "https://storage.blob.core.windows.net/details/20220611/00000000-0000-0000-0000-000000000000?sv=2016-05-31&sr=b&sig=jep8HT2aphfUkyERRZa5LRfd9RPzjXbzB%2F9TNiQ", "secondaryReportUrl": "https://storage-secondary.blob.core.windows.net/details/20220611/00000000-0000-0000-0000-000000000000?sv=2016-05-31&sr=b&sig=jep8HT2aphfUkyERRZa5LRfd9RPzjXbzB%2F9TNiQ", "validUntil": "2022-06-12T02:56:55.5021869Z" - } + }, + "status": "Complete" + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000/billingProfiles/CZSFR-SDFXC-DSDF/providers/Microsoft.CostManagement/benefitUtilizationSummariesOperationResults/cf9f95c9-af6b-41dd-a622-e6f4fc60c3ee?api-version=2025-03-01", + "Retry-After": "60" } } - } + }, + "operationId": "GenerateBenefitUtilizationSummariesReport_GenerateByBillingProfile", + "title": "GenerateUtilizationSummariesReportByBillingProfile" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/BenefitUtilizationSummaries/Async/GenerateBenefitUtilizationSummariesReportByReservation.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/BenefitUtilizationSummaries/Async/GenerateBenefitUtilizationSummariesReportByReservation.json index c1673de57147..5e1cd9bee47a 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/BenefitUtilizationSummaries/Async/GenerateBenefitUtilizationSummariesReportByReservation.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/BenefitUtilizationSummaries/Async/GenerateBenefitUtilizationSummariesReportByReservation.json @@ -1,38 +1,40 @@ { "parameters": { "api-version": "2025-03-01", - "reservationOrderId": "00000000-0000-0000-0000-000000000000", - "reservationId": "00000000-0000-0000-0000-000000000000", "benefitUtilizationSummariesRequest": { "endDate": "2022-08-31T00:00:00Z", - "startDate": "2022-06-01T00:00:00Z", - "grain": "Daily" - } + "grain": "Daily", + "startDate": "2022-06-01T00:00:00Z" + }, + "reservationId": "00000000-0000-0000-0000-000000000000", + "reservationOrderId": "00000000-0000-0000-0000-000000000000" }, "responses": { - "202": { - "headers": { - "Location": "https://management.azure.com/providers/Microsoft.Capacity/reservationorders/00000000-0000-0000-0000-000000000000/reservations/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/benefitUtilizationSummariesOperationResults/cf9f95c9-af6b-41dd-a622-e6f4fc60c3ee?api-version=2025-03-01", - "Retry-After": "60" - } - }, "200": { "body": { "input": { - "grain": "Daily", - "benefitOrderId": "00000000-0000-0000-0000-000000000000", "benefitId": "00000000-0000-0000-0000-000000000000", - "kind": "Reservation", + "benefitOrderId": "00000000-0000-0000-0000-000000000000", "endDate": "2022-08-31T00:00:00Z", + "grain": "Daily", + "kind": "Reservation", "startDate": "2022-06-01T00:00:00Z" }, - "status": "Complete", "properties": { "reportUrl": "https://storage.blob.core.windows.net/details/20220611/00000000-0000-0000-0000-000000000000?sv=2016-05-31&sr=b&sig=jep8HT2aphfUkyERRZa5LRfd9RPzjXbzB%2F9TNiQ", "secondaryReportUrl": "https://storage-secondary.blob.core.windows.net/details/20220611/00000000-0000-0000-0000-000000000000?sv=2016-05-31&sr=b&sig=jep8HT2aphfUkyERRZa5LRfd9RPzjXbzB%2F9TNiQ", "validUntil": "2022-06-12T02:56:55.5021869Z" - } + }, + "status": "Complete" + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/providers/Microsoft.Capacity/reservationorders/00000000-0000-0000-0000-000000000000/reservations/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/benefitUtilizationSummariesOperationResults/cf9f95c9-af6b-41dd-a622-e6f4fc60c3ee?api-version=2025-03-01", + "Retry-After": "60" } } - } + }, + "operationId": "GenerateBenefitUtilizationSummariesReport_GenerateByReservationId", + "title": "GenerateUtilizationSummariesReportByReservation" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/BenefitUtilizationSummaries/Async/GenerateBenefitUtilizationSummariesReportByReservationOrder.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/BenefitUtilizationSummaries/Async/GenerateBenefitUtilizationSummariesReportByReservationOrder.json index 10624cde008f..78d8796421a1 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/BenefitUtilizationSummaries/Async/GenerateBenefitUtilizationSummariesReportByReservationOrder.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/BenefitUtilizationSummaries/Async/GenerateBenefitUtilizationSummariesReportByReservationOrder.json @@ -1,36 +1,38 @@ { "parameters": { "api-version": "2025-03-01", - "reservationOrderId": "00000000-0000-0000-0000-000000000000", "benefitUtilizationSummariesRequest": { "endDate": "2022-08-31T00:00:00Z", - "startDate": "2022-06-01T00:00:00Z", - "grain": "Daily" - } + "grain": "Daily", + "startDate": "2022-06-01T00:00:00Z" + }, + "reservationOrderId": "00000000-0000-0000-0000-000000000000" }, "responses": { - "202": { - "headers": { - "Location": "https://management.azure.com/providers/Microsoft.Capacity/reservationorders/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/benefitUtilizationSummariesOperationResults/cf9f95c9-af6b-41dd-a622-e6f4fc60c3ee?api-version=2025-03-01", - "Retry-After": "60" - } - }, "200": { "body": { "input": { - "grain": "Daily", "benefitOrderId": "00000000-0000-0000-0000-000000000000", - "kind": "Reservation", "endDate": "2022-08-31T00:00:00Z", + "grain": "Daily", + "kind": "Reservation", "startDate": "2022-06-01T00:00:00Z" }, - "status": "Complete", "properties": { "reportUrl": "https://storage.blob.core.windows.net/details/20220611/00000000-0000-0000-0000-000000000000?sv=2016-05-31&sr=b&sig=jep8HT2aphfUkyERRZa5LRfd9RPzjXbzB%2F9TNiQ", "secondaryReportUrl": "https://storage-secondary.blob.core.windows.net/details/20220611/00000000-0000-0000-0000-000000000000?sv=2016-05-31&sr=b&sig=jep8HT2aphfUkyERRZa5LRfd9RPzjXbzB%2F9TNiQ", "validUntil": "2022-06-12T02:56:55.5021869Z" - } + }, + "status": "Complete" + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/providers/Microsoft.Capacity/reservationorders/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/benefitUtilizationSummariesOperationResults/cf9f95c9-af6b-41dd-a622-e6f4fc60c3ee?api-version=2025-03-01", + "Retry-After": "60" } } - } + }, + "operationId": "GenerateBenefitUtilizationSummariesReport_GenerateByReservationOrderId", + "title": "GenerateUtilizationSummariesReportByReservationOrder" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/BenefitUtilizationSummaries/Async/GenerateBenefitUtilizationSummariesReportBySavingsPlan.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/BenefitUtilizationSummaries/Async/GenerateBenefitUtilizationSummariesReportBySavingsPlan.json index 67547b129387..953ebb99fc03 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/BenefitUtilizationSummaries/Async/GenerateBenefitUtilizationSummariesReportBySavingsPlan.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/BenefitUtilizationSummaries/Async/GenerateBenefitUtilizationSummariesReportBySavingsPlan.json @@ -1,38 +1,40 @@ { "parameters": { "api-version": "2025-03-01", - "savingsPlanOrderId": "00000000-0000-0000-0000-000000000000", - "savingsPlanId": "00000000-0000-0000-0000-000000000000", "benefitUtilizationSummariesRequest": { "endDate": "2022-08-31T00:00:00Z", - "startDate": "2022-06-01T00:00:00Z", - "grain": "Daily" - } + "grain": "Daily", + "startDate": "2022-06-01T00:00:00Z" + }, + "savingsPlanId": "00000000-0000-0000-0000-000000000000", + "savingsPlanOrderId": "00000000-0000-0000-0000-000000000000" }, "responses": { - "202": { - "headers": { - "Location": "https://management.azure.com/providers/Microsoft.Capacity/savingsPlanOrders/00000000-0000-0000-0000-000000000000/savingsPlans/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/benefitUtilizationSummariesOperationResults/cf9f95c9-af6b-41dd-a622-e6f4fc60c3ee?api-version=2025-03-01", - "Retry-After": "60" - } - }, "200": { "body": { "input": { - "grain": "Daily", - "benefitOrderId": "00000000-0000-0000-0000-000000000000", "benefitId": "00000000-0000-0000-0000-000000000000", - "kind": "SavingsPlan", + "benefitOrderId": "00000000-0000-0000-0000-000000000000", "endDate": "2022-08-31T00:00:00Z", + "grain": "Daily", + "kind": "SavingsPlan", "startDate": "2022-06-01T00:00:00Z" }, - "status": "Complete", "properties": { "reportUrl": "https://storage.blob.core.windows.net/details/20220611/00000000-0000-0000-0000-000000000000?sv=2016-05-31&sr=b&sig=jep8HT2aphfUkyERRZa5LRfd9RPzjXbzB%2F9TNiQ", "secondaryReportUrl": "https://storage-secondary.blob.core.windows.net/details/20220611/00000000-0000-0000-0000-000000000000?sv=2016-05-31&sr=b&sig=jep8HT2aphfUkyERRZa5LRfd9RPzjXbzB%2F9TNiQ", "validUntil": "2022-06-12T02:56:55.5021869Z" - } + }, + "status": "Complete" + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/providers/Microsoft.Capacity/savingsPlanOrders/00000000-0000-0000-0000-000000000000/savingsPlans/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/benefitUtilizationSummariesOperationResults/cf9f95c9-af6b-41dd-a622-e6f4fc60c3ee?api-version=2025-03-01", + "Retry-After": "60" } } - } + }, + "operationId": "GenerateBenefitUtilizationSummariesReport_GenerateBySavingsPlanId", + "title": "GenerateUtilizationSummariesReportBySavingsPlan" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/BenefitUtilizationSummaries/Async/GenerateBenefitUtilizationSummariesReportBySavingsPlanOrder.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/BenefitUtilizationSummaries/Async/GenerateBenefitUtilizationSummariesReportBySavingsPlanOrder.json index 1ef77265edc0..7458dfd3ce23 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/BenefitUtilizationSummaries/Async/GenerateBenefitUtilizationSummariesReportBySavingsPlanOrder.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/BenefitUtilizationSummaries/Async/GenerateBenefitUtilizationSummariesReportBySavingsPlanOrder.json @@ -1,36 +1,38 @@ { "parameters": { "api-version": "2025-03-01", - "savingsPlanOrderId": "00000000-0000-0000-0000-000000000000", "benefitUtilizationSummariesRequest": { "endDate": "2022-08-31T00:00:00Z", - "startDate": "2022-06-01T00:00:00Z", - "grain": "Daily" - } + "grain": "Daily", + "startDate": "2022-06-01T00:00:00Z" + }, + "savingsPlanOrderId": "00000000-0000-0000-0000-000000000000" }, "responses": { - "202": { - "headers": { - "Location": "https://management.azure.com/providers/Microsoft.BillingBenefits/savingsPlanOrders/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/benefitUtilizationSummariesOperationResults/cf9f95c9-af6b-41dd-a622-e6f4fc60c3ee?api-version=2025-03-01", - "Retry-After": "60" - } - }, "200": { "body": { "input": { - "grain": "Daily", "benefitOrderId": "00000000-0000-0000-0000-000000000000", - "kind": "SavingsPlan", "endDate": "2022-08-31T00:00:00Z", + "grain": "Daily", + "kind": "SavingsPlan", "startDate": "2022-06-01T00:00:00Z" }, - "status": "Complete", "properties": { "reportUrl": "https://storage.blob.core.windows.net/details/20220611/00000000-0000-0000-0000-000000000000?sv=2016-05-31&sr=b&sig=jep8HT2aphfUkyERRZa5LRfd9RPzjXbzB%2F9TNiQ", "secondaryReportUrl": "https://storage-secondary.blob.core.windows.net/details/20220611/00000000-0000-0000-0000-000000000000?sv=2016-05-31&sr=b&sig=jep8HT2aphfUkyERRZa5LRfd9RPzjXbzB%2F9TNiQ", "validUntil": "2022-06-12T02:56:55.5021869Z" - } + }, + "status": "Complete" + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/providers/Microsoft.BillingBenefits/savingsPlanOrders/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/benefitUtilizationSummariesOperationResults/cf9f95c9-af6b-41dd-a622-e6f4fc60c3ee?api-version=2025-03-01", + "Retry-After": "60" } } - } + }, + "operationId": "GenerateBenefitUtilizationSummariesReport_GenerateBySavingsPlanOrderId", + "title": "GenerateUtilizationSummariesReportBySavingsPlanOrder" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/BenefitUtilizationSummaries/SavingsPlan-BillingAccount.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/BenefitUtilizationSummaries/SavingsPlan-BillingAccount.json index 78576122447a..4ed3bcdcb7bc 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/BenefitUtilizationSummaries/SavingsPlan-BillingAccount.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/BenefitUtilizationSummaries/SavingsPlan-BillingAccount.json @@ -10,15 +10,15 @@ "body": { "value": [ { - "id": "/providers/Microsoft.Billing/billingAccounts/12345/providers/Microsoft.CostManagement/benefitUtilizationSummaries/66cccc66-6ccc-6c66-666c-66cc6c6c66c6_222d22dd-d2d2-2dd2-222d-2dd2222ddddd_20211116", - "kind": "SavingsPlan", "name": "66cccc66-6ccc-6c66-666c-66cc6c6c66c6_222d22dd-d2d2-2dd2-222d-2dd2222ddddd_20211116", "type": "Microsoft.CostManagement/benefitUtilizationSummaries", + "id": "/providers/Microsoft.Billing/billingAccounts/12345/providers/Microsoft.CostManagement/benefitUtilizationSummaries/66cccc66-6ccc-6c66-666c-66cc6c6c66c6_222d22dd-d2d2-2dd2-222d-2dd2222ddddd_20211116", + "kind": "SavingsPlan", "properties": { "armSkuName": "Compute_Savings_Plan", "avgUtilizationPercentage": 90, - "benefitOrderId": "/providers/Microsoft.BillingBenefits/savingsPlanOrders/66cccc66-6ccc-6c66-666c-66cc6c6c66c6", "benefitId": "/providers/Microsoft.BillingBenefits/savingsPlanOrders/66cccc66-6ccc-6c66-666c-66cc6c6c66c6/savingsPlans/222d22dd-d2d2-2dd2-222d-2dd2222ddddd", + "benefitOrderId": "/providers/Microsoft.BillingBenefits/savingsPlanOrders/66cccc66-6ccc-6c66-666c-66cc6c6c66c6", "benefitType": "SavingsPlan", "maxUtilizationPercentage": 100, "minUtilizationPercentage": 80, @@ -26,15 +26,15 @@ } }, { - "id": "/providers/Microsoft.Billing/billingAccounts/12345/providers/Microsoft.CostManagement/benefitUtilizationSummaries/88cccc88-8ccc-8c88-888c-88cc8c8c88c8_444d44dd-d4d4-4dd4-444d-4dd4444ddddd_20211117", - "kind": "SavingsPlan", "name": "88cccc88-8ccc-8c88-888c-88cc8c8c88c8_444d44dd-d4d4-4dd4-444d-4dd4444ddddd_20211117", "type": "Microsoft.CostManagement/benefitUtilizationSummaries", + "id": "/providers/Microsoft.Billing/billingAccounts/12345/providers/Microsoft.CostManagement/benefitUtilizationSummaries/88cccc88-8ccc-8c88-888c-88cc8c8c88c8_444d44dd-d4d4-4dd4-444d-4dd4444ddddd_20211117", + "kind": "SavingsPlan", "properties": { "armSkuName": "Compute_Savings_Plan", "avgUtilizationPercentage": 60, - "benefitOrderId": "/providers/Microsoft.BillingBenefits/savingsPlanOrders/88cccc88-8ccc-8c88-888c-88cc8c8c88c8", "benefitId": "/providers/Microsoft.BillingBenefits/savingsPlanOrders/88cccc88-8ccc-8c88-888c-88cc8c8c88c8/savingsPlans/444d44dd-d4d4-4dd4-444d-4dd4444ddddd", + "benefitOrderId": "/providers/Microsoft.BillingBenefits/savingsPlanOrders/88cccc88-8ccc-8c88-888c-88cc8c8c88c8", "benefitType": "SavingsPlan", "maxUtilizationPercentage": 70, "minUtilizationPercentage": 50, @@ -44,5 +44,7 @@ ] } } - } + }, + "operationId": "BenefitUtilizationSummaries_ListByBillingAccountId", + "title": "SavingsPlanUtilizationSummaries-BillingAccount" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/BenefitUtilizationSummaries/SavingsPlan-BillingProfile.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/BenefitUtilizationSummaries/SavingsPlan-BillingProfile.json index 260c59c36b10..99f01b89571a 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/BenefitUtilizationSummaries/SavingsPlan-BillingProfile.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/BenefitUtilizationSummaries/SavingsPlan-BillingProfile.json @@ -11,15 +11,15 @@ "body": { "value": [ { - "id": "/providers/Microsoft.Billing/billingAccounts/c0a00000-0e04-5ee3-000e-f0c6e00000ec:c0a00000-0e04-5ee3-000e-f0c6e00000ec/billingProfiles/200e5e90-000e-4960-8dcd-8d00a02db000/providers/Microsoft.CostManagement/benefitUtilizationSummaries/66cccc66-6ccc-6c66-666c-66cc6c6c66c6_222d22dd-d2d2-2dd2-222d-2dd2222ddddd_20211116", - "kind": "SavingsPlan", "name": "66cccc66-6ccc-6c66-666c-66cc6c6c66c6_222d22dd-d2d2-2dd2-222d-2dd2222ddddd_20211116", "type": "Microsoft.CostManagement/benefitUtilizationSummaries", + "id": "/providers/Microsoft.Billing/billingAccounts/c0a00000-0e04-5ee3-000e-f0c6e00000ec:c0a00000-0e04-5ee3-000e-f0c6e00000ec/billingProfiles/200e5e90-000e-4960-8dcd-8d00a02db000/providers/Microsoft.CostManagement/benefitUtilizationSummaries/66cccc66-6ccc-6c66-666c-66cc6c6c66c6_222d22dd-d2d2-2dd2-222d-2dd2222ddddd_20211116", + "kind": "SavingsPlan", "properties": { "armSkuName": "Compute_Savings_Plan", "avgUtilizationPercentage": 90, - "benefitOrderId": "/providers/Microsoft.BillingBenefits/savingsPlanOrders/66cccc66-6ccc-6c66-666c-66cc6c6c66c6", "benefitId": "/providers/Microsoft.BillingBenefits/savingsPlanOrders/66cccc66-6ccc-6c66-666c-66cc6c6c66c6/savingsPlans/222d22dd-d2d2-2dd2-222d-2dd2222ddddd", + "benefitOrderId": "/providers/Microsoft.BillingBenefits/savingsPlanOrders/66cccc66-6ccc-6c66-666c-66cc6c6c66c6", "benefitType": "SavingsPlan", "maxUtilizationPercentage": 100, "minUtilizationPercentage": 80, @@ -29,5 +29,7 @@ ] } } - } + }, + "operationId": "BenefitUtilizationSummaries_ListByBillingProfileId", + "title": "SavingsPlanUtilizationSummaries-BillingProfile" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/BenefitUtilizationSummaries/SavingsPlan-SavingsPlanId-Monthly.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/BenefitUtilizationSummaries/SavingsPlan-SavingsPlanId-Monthly.json index 7ea7a4699e3c..92b69a173255 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/BenefitUtilizationSummaries/SavingsPlan-SavingsPlanId-Monthly.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/BenefitUtilizationSummaries/SavingsPlan-SavingsPlanId-Monthly.json @@ -1,25 +1,25 @@ { "parameters": { "api-version": "2025-03-01", - "savingsPlanOrderId": "66cccc66-6ccc-6c66-666c-66cc6c6c66c6", - "savingsPlanId": "222d22dd-d2d2-2dd2-222d-2dd2222ddddd", "filter": "properties/usageDate ge 2022-10-15 and properties/usageDate le 2022-10-18", - "grain": "Monthly" + "grain": "Monthly", + "savingsPlanId": "222d22dd-d2d2-2dd2-222d-2dd2222ddddd", + "savingsPlanOrderId": "66cccc66-6ccc-6c66-666c-66cc6c6c66c6" }, "responses": { "200": { "body": { "value": [ { - "id": "/providers/Microsoft.BillingBenefits/savingsPlanOrders/66cccc66-6ccc-6c66-666c-66cc6c6c66c6/savingsPlans/222d22dd-d2d2-2dd2-222d-2dd2222ddddd/providers/Microsoft.CostManagement/benefitUtilizationSummaries/66cccc66-6ccc-6c66-666c-66cc6c6c66c6_222d22dd-d2d2-2dd2-222d-2dd2222ddddd_202111", - "kind": "SavingsPlan", "name": "66cccc66-6ccc-6c66-666c-66cc6c6c66c6_222d22dd-d2d2-2dd2-222d-2dd2222ddddd_202111", "type": "Microsoft.CostManagement/benefitUtilizationSummaries", + "id": "/providers/Microsoft.BillingBenefits/savingsPlanOrders/66cccc66-6ccc-6c66-666c-66cc6c6c66c6/savingsPlans/222d22dd-d2d2-2dd2-222d-2dd2222ddddd/providers/Microsoft.CostManagement/benefitUtilizationSummaries/66cccc66-6ccc-6c66-666c-66cc6c6c66c6_222d22dd-d2d2-2dd2-222d-2dd2222ddddd_202111", + "kind": "SavingsPlan", "properties": { "armSkuName": "Compute_Savings_Plan", "avgUtilizationPercentage": 90, - "benefitOrderId": "/providers/Microsoft.BillingBenefits/savingsPlanOrders/66cccc66-6ccc-6c66-666c-66cc6c6c66c6", "benefitId": "/providers/Microsoft.BillingBenefits/savingsPlanOrders/66cccc66-6ccc-6c66-666c-66cc6c6c66c6/savingsPlans/222d22dd-d2d2-2dd2-222d-2dd2222ddddd", + "benefitOrderId": "/providers/Microsoft.BillingBenefits/savingsPlanOrders/66cccc66-6ccc-6c66-666c-66cc6c6c66c6", "benefitType": "SavingsPlan", "maxUtilizationPercentage": 100, "minUtilizationPercentage": 80, @@ -27,15 +27,15 @@ } }, { - "id": "/providers/Microsoft.BillingBenefits/savingsPlanOrders/66cccc66-6ccc-6c66-666c-66cc6c6c66c6/savingsPlans/222d22dd-d2d2-2dd2-222d-2dd2222ddddd/providers/Microsoft.CostManagement/benefitUtilizationSummaries/66cccc66-6ccc-6c66-666c-66cc6c6c66c6_222d22dd-d2d2-2dd2-222d-2dd2222ddddd_202112", - "kind": "SavingsPlan", "name": "66cccc66-6ccc-6c66-666c-66cc6c6c66c6_222d22dd-d2d2-2dd2-222d-2dd2222ddddd_202112", "type": "Microsoft.CostManagement/benefitUtilizationSummaries", + "id": "/providers/Microsoft.BillingBenefits/savingsPlanOrders/66cccc66-6ccc-6c66-666c-66cc6c6c66c6/savingsPlans/222d22dd-d2d2-2dd2-222d-2dd2222ddddd/providers/Microsoft.CostManagement/benefitUtilizationSummaries/66cccc66-6ccc-6c66-666c-66cc6c6c66c6_222d22dd-d2d2-2dd2-222d-2dd2222ddddd_202112", + "kind": "SavingsPlan", "properties": { "armSkuName": "Compute_Savings_Plan", "avgUtilizationPercentage": 80, - "benefitOrderId": "/providers/Microsoft.BillingBenefits/savingsPlanOrders/66cccc66-6ccc-6c66-666c-66cc6c6c66c6", "benefitId": "/providers/Microsoft.BillingBenefits/savingsPlanOrders/66cccc66-6ccc-6c66-666c-66cc6c6c66c6/savingsPlans/222d22dd-d2d2-2dd2-222d-2dd2222ddddd", + "benefitOrderId": "/providers/Microsoft.BillingBenefits/savingsPlanOrders/66cccc66-6ccc-6c66-666c-66cc6c6c66c6", "benefitType": "SavingsPlan", "maxUtilizationPercentage": 90, "minUtilizationPercentage": 70, @@ -45,5 +45,7 @@ ] } } - } + }, + "operationId": "BenefitUtilizationSummaries_ListBySavingsPlanId", + "title": "SavingsPlanUtilizationSummariesMonthlyWithSavingsPlanId" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/BenefitUtilizationSummaries/SavingsPlan-SavingsPlanOrderId-Daily.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/BenefitUtilizationSummaries/SavingsPlan-SavingsPlanOrderId-Daily.json index 06244face573..ad1268c24451 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/BenefitUtilizationSummaries/SavingsPlan-SavingsPlanOrderId-Daily.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/BenefitUtilizationSummaries/SavingsPlan-SavingsPlanOrderId-Daily.json @@ -1,24 +1,24 @@ { "parameters": { "api-version": "2025-03-01", - "savingsPlanOrderId": "66cccc66-6ccc-6c66-666c-66cc6c6c66c6", "filter": "properties/usageDate ge 2022-10-15 and properties/usageDate le 2022-10-18", - "grain": "Daily" + "grain": "Daily", + "savingsPlanOrderId": "66cccc66-6ccc-6c66-666c-66cc6c6c66c6" }, "responses": { "200": { "body": { "value": [ { - "id": "/providers/Microsoft.BillingBenefits/savingsPlanOrders/66cccc66-6ccc-6c66-666c-66cc6c6c66c6/providers/Microsoft.CostManagement/benefitUtilizationSummaries/66cccc66-6ccc-6c66-666c-66cc6c6c66c6_222d22dd-d2d2-2dd2-222d-2dd2222ddddd_20211116", - "kind": "SavingsPlan", "name": "66cccc66-6ccc-6c66-666c-66cc6c6c66c6_222d22dd-d2d2-2dd2-222d-2dd2222ddddd_20211116", "type": "Microsoft.CostManagement/benefitUtilizationSummaries", + "id": "/providers/Microsoft.BillingBenefits/savingsPlanOrders/66cccc66-6ccc-6c66-666c-66cc6c6c66c6/providers/Microsoft.CostManagement/benefitUtilizationSummaries/66cccc66-6ccc-6c66-666c-66cc6c6c66c6_222d22dd-d2d2-2dd2-222d-2dd2222ddddd_20211116", + "kind": "SavingsPlan", "properties": { "armSkuName": "Compute_Savings_Plan", "avgUtilizationPercentage": 90, - "benefitOrderId": "/providers/Microsoft.BillingBenefits/savingsPlanOrders/66cccc66-6ccc-6c66-666c-66cc6c6c66c6", "benefitId": "/providers/Microsoft.BillingBenefits/savingsPlanOrders/66cccc66-6ccc-6c66-666c-66cc6c6c66c6/savingsPlans/222d22dd-d2d2-2dd2-222d-2dd2222ddddd", + "benefitOrderId": "/providers/Microsoft.BillingBenefits/savingsPlanOrders/66cccc66-6ccc-6c66-666c-66cc6c6c66c6", "benefitType": "SavingsPlan", "maxUtilizationPercentage": 100, "minUtilizationPercentage": 80, @@ -28,5 +28,7 @@ ] } } - } + }, + "operationId": "BenefitUtilizationSummaries_ListBySavingsPlanOrder", + "title": "SavingsPlanUtilizationSummariesDaily" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/BillingAccountAlerts.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/BillingAccountAlerts.json index 99d38ffeb52a..cc4717f9a569 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/BillingAccountAlerts.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/BillingAccountAlerts.json @@ -1,98 +1,100 @@ { "parameters": { "api-version": "2025-03-01", - "billingAccountId": "12345:6789", - "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789" + "billingAccountId": "12345-6789", + "scope": "providers/Microsoft.Billing/billingAccounts/12345-6789" }, "responses": { "200": { "body": { + "nextLink": null, "value": [ { - "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/providers/Microsoft.CostManagement/alerts/00000000-0000-0000-0000-000000000000", "name": "00000000-0000-0000-0000-000000000000", "type": "Microsoft.CostManagement/alerts", + "id": "/providers/Microsoft.Billing/billingAccounts/12345-6789/providers/Microsoft.CostManagement/alerts/00000000-0000-0000-0000-000000000000", "properties": { + "description": "", + "closeTime": "0001-01-01T00:00:00", + "costEntityId": "budget1", + "creationTime": "2020-04-27T11:07:52.7143901Z", "definition": { "type": "Budget", "category": "Cost", "criteria": "CostThresholdExceeded" }, - "description": "", + "modificationTime": "2020-04-28T11:06:02.8999373Z", "source": "Preset", + "status": "Active", + "statusModificationTime": "0001-01-01T00:00:00", + "statusModificationUserName": null, "details": { - "timeGrainType": "Quarterly", - "periodStartDate": "2020-03-01T00:00:00Z", - "triggeredBy": "00000000-0000-0000-0000-000000000000_1_01", - "resourceGroupFilter": [], - "resourceFilter": [], - "meterFilter": [], - "tagFilter": {}, - "threshold": 0.8, - "operator": "GreaterThan", - "amount": 200000.0, - "unit": "USD", - "currentSpend": 161000.12, + "amount": 200000, "contactEmails": [ "1234@contoso.com" ], "contactGroups": [], "contactRoles": [], - "overridingAlert": null - }, - "costEntityId": "budget1", - "status": "Active", - "creationTime": "2020-04-27T11:07:52.7143901Z", - "closeTime": "0001-01-01T00:00:00", - "modificationTime": "2020-04-28T11:06:02.8999373Z", - "statusModificationUserName": null, - "statusModificationTime": "0001-01-01T00:00:00" + "currentSpend": 161000.12, + "meterFilter": [], + "operator": "GreaterThan", + "overridingAlert": null, + "periodStartDate": "2020-03-01T00:00:00Z", + "resourceFilter": [], + "resourceGroupFilter": [], + "tagFilter": {}, + "threshold": 0.8, + "timeGrainType": "Quarterly", + "triggeredBy": "00000000-0000-0000-0000-000000000000_1_01", + "unit": "USD" + } } }, { - "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/providers/Microsoft.CostManagement/alerts/11111111-1111-1111-111111111111", "name": "11111111-1111-1111-111111111111", "type": "Microsoft.CostManagement/alerts", + "id": "/providers/Microsoft.Billing/billingAccounts/12345-6789/providers/Microsoft.CostManagement/alerts/11111111-1111-1111-111111111111", "properties": { + "description": "", + "closeTime": "0001-01-01T00:00:00", + "costEntityId": "budget1", + "creationTime": "2019-06-24T05:51:52.8713179Z", "definition": { "type": "Budget", "category": "Cost", "criteria": "CostThresholdExceeded" }, - "description": "", + "modificationTime": "2019-08-31T17:51:55.1808807Z", "source": "Preset", + "status": "Active", + "statusModificationTime": "0001-01-01T00:00:00", + "statusModificationUserName": null, "details": { - "timeGrainType": "Quarterly", - "periodStartDate": "2020-03-01T00:00:00Z", - "triggeredBy": "11111111-1111-1111-111111111111_1_01", - "resourceGroupFilter": [], - "resourceFilter": [], - "meterFilter": [], - "tagFilter": {}, - "threshold": 0.8, - "operator": "GreaterThan", - "amount": 200000.0, - "unit": "USD", - "currentSpend": 171000.32, + "amount": 200000, "contactEmails": [ "1234@contoso.com" ], "contactGroups": [], "contactRoles": [], - "overridingAlert": null - }, - "costEntityId": "budget1", - "status": "Active", - "creationTime": "2019-06-24T05:51:52.8713179Z", - "closeTime": "0001-01-01T00:00:00", - "modificationTime": "2019-08-31T17:51:55.1808807Z", - "statusModificationUserName": null, - "statusModificationTime": "0001-01-01T00:00:00" + "currentSpend": 171000.32, + "meterFilter": [], + "operator": "GreaterThan", + "overridingAlert": null, + "periodStartDate": "2020-03-01T00:00:00Z", + "resourceFilter": [], + "resourceGroupFilter": [], + "tagFilter": {}, + "threshold": 0.8, + "timeGrainType": "Quarterly", + "triggeredBy": "11111111-1111-1111-111111111111_1_01", + "unit": "USD" + } } } - ], - "nextLink": null + ] } } - } + }, + "operationId": "Alerts_List", + "title": "BillingAccountAlerts" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/BillingAccountDimensionsList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/BillingAccountDimensionsList.json index ca5236d7afd9..d294e1d84d54 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/BillingAccountDimensionsList.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/BillingAccountDimensionsList.json @@ -9,10 +9,12 @@ "body": { "value": [ { - "id": "providers/Microsoft.Billing/billingAccounts/100/providers/microsoft.CostManagement/dimensions_ResourceGroup_2018-05-01_2018-05-31", "name": "dimensions_ResourceGroup_2018-05-01_2018-05-31", "type": "microsoft.CostManagement/dimensions", + "id": "/providers/Microsoft.Billing/billingAccounts/100/providers/microsoft.CostManagement/dimensions_ResourceGroup_2018-05-01_2018-05-31", "properties": { + "description": "Resource group", + "category": "ResourceGroup", "data": [ "thoroetrg01", "default-notificationhubs-westus", @@ -20,20 +22,20 @@ "contosocodeflow8d4a", "noobaa" ], + "filterEnabled": true, + "groupingEnabled": true, "total": 377, - "category": "ResourceGroup", - "usageStart": "2018-05-01T00:00:00-07:00", "usageEnd": "2018-05-31T00:00:00-07:00", - "description": "Resource group", - "filterEnabled": true, - "groupingEnabled": true + "usageStart": "2018-05-01T00:00:00-07:00" } }, { - "id": "providers/Microsoft.Billing/billingAccounts/100/providers/microsoft.CostManagement/dimensions_ResourceType_2018-05-01_2018-05-31", "name": "dimensions_ResourceType_2018-05-01_2018-05-31", "type": "microsoft.CostManagement/dimensions", + "id": "/providers/Microsoft.Billing/billingAccounts/100/providers/microsoft.CostManagement/dimensions_ResourceType_2018-05-01_2018-05-31", "properties": { + "description": "Resource type", + "category": "ResourceType", "data": [ "thoroetrg01", "default-notificationhubs-westus", @@ -41,18 +43,18 @@ "contosocodeflow8d4a", "noobaa" ], + "filterEnabled": true, + "groupingEnabled": true, "total": 37, - "category": "ResourceType", - "usageStart": "2018-05-01T00:00:00-07:00", "usageEnd": "2018-05-31T00:00:00-07:00", - "description": "Resource type", - "filterEnabled": true, - "groupingEnabled": true + "usageStart": "2018-05-01T00:00:00-07:00" } } ] } }, "204": {} - } + }, + "operationId": "Dimensions_List", + "title": "BillingAccountDimensionsList-Legacy" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/BillingAccountDimensionsListExpandAndTop.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/BillingAccountDimensionsListExpandAndTop.json index 62040ab0f7a0..de01e5018f55 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/BillingAccountDimensionsListExpandAndTop.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/BillingAccountDimensionsListExpandAndTop.json @@ -1,9 +1,9 @@ { "parameters": { - "api-version": "2025-03-01", - "billingAccountId": "100", "$expand": "properties/data", "$top": 5, + "api-version": "2025-03-01", + "billingAccountId": "100", "scope": "providers/Microsoft.Billing/billingAccounts/100" }, "responses": { @@ -11,10 +11,12 @@ "body": { "value": [ { - "id": "providers/Microsoft.Billing/billingAccounts/100/providers/microsoft.CostManagement/dimensions_ResourceGroup_2018-05-01_2018-05-31_5", "name": "dimensions_ResourceGroup_2018-05-01_2018-05-31_5", "type": "microsoft.CostManagement/dimensions", + "id": "/providers/Microsoft.Billing/billingAccounts/100/providers/microsoft.CostManagement/dimensions_ResourceGroup_2018-05-01_2018-05-31_5", "properties": { + "description": "Resource group", + "category": "ResourceGroup", "data": [ "thoroetrg01", "default-notificationhubs-westus", @@ -22,20 +24,20 @@ "contosocodeflow8d4a", "noobaa" ], + "filterEnabled": true, + "groupingEnabled": true, "total": 377, - "category": "ResourceGroup", - "usageStart": "2018-05-01T00:00:00-07:00", "usageEnd": "2018-05-31T00:00:00-07:00", - "description": "Resource group", - "filterEnabled": true, - "groupingEnabled": true + "usageStart": "2018-05-01T00:00:00-07:00" } }, { - "id": "providers/Microsoft.Billing/billingAccounts/100/providers/microsoft.CostManagement/dimensions_ResourceType_2018-05-01_2018-05-31_5", "name": "dimensions_ResourceType_2018-05-01_2018-05-31_5", "type": "microsoft.CostManagement/dimensions", + "id": "/providers/Microsoft.Billing/billingAccounts/100/providers/microsoft.CostManagement/dimensions_ResourceType_2018-05-01_2018-05-31_5", "properties": { + "description": "Resource type", + "category": "ResourceType", "data": [ "microsoft.automation/automationaccounts", "microsoft.databricks/workspaces", @@ -43,18 +45,18 @@ "microsoft.containerregistry/registries", "microsoft.search/searchservices" ], + "filterEnabled": true, + "groupingEnabled": true, "total": 37, - "category": "ResourceType", - "usageStart": "2018-05-01T00:00:00-07:00", "usageEnd": "2018-05-31T00:00:00-07:00", - "description": "Resource type", - "filterEnabled": true, - "groupingEnabled": true + "usageStart": "2018-05-01T00:00:00-07:00" } } ] } }, "204": {} - } + }, + "operationId": "Dimensions_List", + "title": "BillingAccountDimensionsListExpandAndTop-Legacy" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/BillingAccountDimensionsListWithFilter.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/BillingAccountDimensionsListWithFilter.json index 473a4ad9e68e..974c36bbf34c 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/BillingAccountDimensionsListWithFilter.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/BillingAccountDimensionsListWithFilter.json @@ -1,10 +1,10 @@ { "parameters": { - "api-version": "2025-03-01", - "billingAccountId": "100", "$expand": "properties/data", - "$top": 5, "$filter": "properties/category eq 'resourceId'", + "$top": 5, + "api-version": "2025-03-01", + "billingAccountId": "100", "scope": "providers/Microsoft.Billing/billingAccounts/100" }, "responses": { @@ -12,10 +12,12 @@ "body": { "value": [ { - "id": "providers/Microsoft.Billing/billingAccounts/100/providers/microsoft.CostManagement/dimensions_ResourceId_2018-05-01_2018-05-31_5", "name": "dimensions_ResourceId_2018-05-01_2018-05-31_5", "type": "microsoft.CostManagement/dimensions", + "id": "/providers/Microsoft.Billing/billingAccounts/100/providers/microsoft.CostManagement/dimensions_ResourceId_2018-05-01_2018-05-31_5", "properties": { + "description": "Resource Id", + "category": "ResourceId", "data": [ "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/system.orlando/providers/microsoft.storage/storageaccounts/urphealthaccount", "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/system.orlando/providers/microsoft.storage/storageaccounts/srphytenaccount", @@ -23,19 +25,19 @@ "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg-sql-ha/providers/microsoft.compute/virtualmachines/sql-4qqp1", "/subscriptions/a98d6dc5-eb8f-46cf-8938-f1fb08f03706/resourcegroups/databricks-rg-testwsp-xijmsdubneexm/providers/microsoft.compute/disks/488cdb42bf74474a98075415be3f806c-containerrootvolume" ], - "total": 1409, - "category": "ResourceId", - "usageStart": "2018-05-01T00:00:00-07:00", - "usageEnd": "2018-05-31T00:00:00-07:00", - "description": "Resource Id", "filterEnabled": true, "groupingEnabled": true, - "nextLink": "http://management.azure.com/providers/Microsoft.Billing/billingAccounts/100/providers/Microsoft.CostManagement/Dimensions?$filter=properties/category eq 'resourceId'&$top=5&api-version=2019-10-01&$expand=properties/data&$skiptoken=AQAAAA%3D%3D" + "nextLink": "http://management.azure.com/providers/Microsoft.Billing/billingAccounts/100/providers/Microsoft.CostManagement/Dimensions?$filter=properties/category eq 'resourceId'&$top=5&api-version=2019-10-01&$expand=properties/data&$skiptoken=AQAAAA%3D%3D", + "total": 1409, + "usageEnd": "2018-05-31T00:00:00-07:00", + "usageStart": "2018-05-01T00:00:00-07:00" } } ] } }, "204": {} - } + }, + "operationId": "Dimensions_List", + "title": "BillingAccountDimensionsListWithFilter-Legacy" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/BillingAccountForecast.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/BillingAccountForecast.json index ee701ea0b29b..673b2507a4ec 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/BillingAccountForecast.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/BillingAccountForecast.json @@ -2,16 +2,9 @@ "parameters": { "api-version": "2025-03-01", "billingAccountId": "12345:6789", - "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789", "parameters": { "type": "Usage", - "timeframe": "Custom", - "timePeriod": { - "from": "2022-08-01T00:00:00+00:00", - "to": "2022-08-31T23:59:59+00:00" - }, "dataset": { - "granularity": "Daily", "aggregation": { "totalCost": { "name": "Cost", @@ -54,20 +47,26 @@ } } ] - } + }, + "granularity": "Daily" }, "includeActualCost": false, - "includeFreshPartialCost": false - } + "includeFreshPartialCost": false, + "timePeriod": { + "from": "2022-08-01T00:00:00+00:00", + "to": "2022-08-31T23:59:59+00:00" + }, + "timeframe": "Custom" + }, + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789" }, "responses": { "200": { "body": { - "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/providers/Microsoft.CostManagement/query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", "type": "Microsoft.CostManagement/query", + "id": "/providers/Microsoft.Billing/billingAccounts/12345:6789/providers/Microsoft.CostManagement/query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", "properties": { - "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/providers/Microsoft.CostManagement/Forecast?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", "columns": [ { "name": "PreTaxCost", @@ -86,6 +85,7 @@ "type": "String" } ], + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/providers/Microsoft.CostManagement/Forecast?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", "rows": [ [ 2.10333307059661, @@ -116,5 +116,7 @@ } }, "204": {} - } + }, + "operationId": "Forecast_Usage", + "title": "BillingAccountForecast" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/BillingAccountQuery.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/BillingAccountQuery.json index aae8477b8c4d..95abb5802322 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/BillingAccountQuery.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/BillingAccountQuery.json @@ -2,12 +2,9 @@ "parameters": { "api-version": "2025-03-01", "billingAccountId": "70664866", - "scope": "providers/Microsoft.Billing/billingAccounts/70664866", "parameters": { "type": "Usage", - "timeframe": "MonthToDate", "dataset": { - "granularity": "Daily", "filter": { "and": [ { @@ -44,18 +41,20 @@ } } ] - } - } - } + }, + "granularity": "Daily" + }, + "timeframe": "MonthToDate" + }, + "scope": "providers/Microsoft.Billing/billingAccounts/70664866" }, "responses": { "200": { "body": { - "id": "providers/Microsoft.Billing/billingAccounts/70664866/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", "type": "microsoft.costmanagement/Query", + "id": "/providers/Microsoft.Billing/billingAccounts/70664866/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", "properties": { - "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/70664866/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", "columns": [ { "name": "PreTaxCost", @@ -74,6 +73,7 @@ "type": "String" } ], + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/70664866/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", "rows": [ [ 19.545363672276512, @@ -88,7 +88,7 @@ "USD" ], [ - 20.359416562625452, + 20.35941656262545, "VSTSHOL-1595322048000", 20180331, "USD" @@ -104,5 +104,7 @@ } }, "204": {} - } + }, + "operationId": "Query_Usage", + "title": "BillingAccountQuery-Legacy" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/BillingAccountQueryGrouping.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/BillingAccountQueryGrouping.json index 3fae1d3fa203..8a60ea7ede90 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/BillingAccountQueryGrouping.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/BillingAccountQueryGrouping.json @@ -2,35 +2,34 @@ "parameters": { "api-version": "2025-03-01", "billingAccountId": "70664866", - "scope": "providers/Microsoft.Billing/billingAccounts/70664866", "parameters": { "type": "Usage", - "timeframe": "TheLastMonth", "dataset": { - "granularity": "None", "aggregation": { "totalCost": { "name": "PreTaxCost", "function": "Sum" } }, + "granularity": "None", "grouping": [ { - "type": "Dimension", - "name": "ResourceGroup" + "name": "ResourceGroup", + "type": "Dimension" } ] - } - } + }, + "timeframe": "TheLastMonth" + }, + "scope": "providers/Microsoft.Billing/billingAccounts/70664866" }, "responses": { "200": { "body": { - "id": "providers/Microsoft.Billing/billingAccounts/70664866/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", "type": "microsoft.costmanagement/Query", + "id": "/providers/Microsoft.Billing/billingAccounts/70664866/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", "properties": { - "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/70664866/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", "columns": [ { "name": "PreTaxCost", @@ -45,6 +44,7 @@ "type": "String" } ], + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/70664866/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", "rows": [ [ 19.545363672276512, @@ -57,7 +57,7 @@ "USD" ], [ - 20.359416562625452, + 20.35941656262545, "VSTSHOL-1595322048000", "USD" ] @@ -66,5 +66,7 @@ } }, "204": {} - } + }, + "operationId": "Query_Usage", + "title": "BillingAccountQueryGrouping-Legacy" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/BillingProfileAlerts.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/BillingProfileAlerts.json index b517952f5452..d5fe67fbd5d3 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/BillingProfileAlerts.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/BillingProfileAlerts.json @@ -1,99 +1,101 @@ { "parameters": { "api-version": "2025-03-01", - "billingAccountId": "12345:6789", + "billingAccountId": "12345-6789", "billingProfileId": "13579", - "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579" + "scope": "providers/Microsoft.Billing/billingAccounts/12345-6789/billingProfiles/13579" }, "responses": { "200": { "body": { + "nextLink": null, "value": [ { - "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/alerts/00000000-0000-0000-0000-000000000000", "name": "00000000-0000-0000-0000-000000000000", "type": "Microsoft.CostManagement/alerts", + "id": "/providers/Microsoft.Billing/billingAccounts/12345-6789/billingProfiles/13579/providers/Microsoft.CostManagement/alerts/00000000-0000-0000-0000-000000000000", "properties": { + "description": "", + "closeTime": "0001-01-01T00:00:00", + "costEntityId": "budget1", + "creationTime": "2020-04-27T11:07:52.7143901Z", "definition": { "type": "Budget", "category": "Cost", "criteria": "CostThresholdExceeded" }, - "description": "", + "modificationTime": "2020-04-28T11:06:02.8999373Z", "source": "Preset", + "status": "Active", + "statusModificationTime": "0001-01-01T00:00:00", + "statusModificationUserName": null, "details": { - "timeGrainType": "Quarterly", - "periodStartDate": "2020-03-01T00:00:00Z", - "triggeredBy": "00000000-0000-0000-0000-000000000000_1_01", - "resourceGroupFilter": [], - "resourceFilter": [], - "meterFilter": [], - "tagFilter": {}, - "threshold": 0.8, - "operator": "GreaterThan", - "amount": 200000.0, - "unit": "USD", - "currentSpend": 161000.12, + "amount": 200000, "contactEmails": [ "1234@contoso.com" ], "contactGroups": [], "contactRoles": [], - "overridingAlert": null - }, - "costEntityId": "budget1", - "status": "Active", - "creationTime": "2020-04-27T11:07:52.7143901Z", - "closeTime": "0001-01-01T00:00:00", - "modificationTime": "2020-04-28T11:06:02.8999373Z", - "statusModificationUserName": null, - "statusModificationTime": "0001-01-01T00:00:00" + "currentSpend": 161000.12, + "meterFilter": [], + "operator": "GreaterThan", + "overridingAlert": null, + "periodStartDate": "2020-03-01T00:00:00Z", + "resourceFilter": [], + "resourceGroupFilter": [], + "tagFilter": {}, + "threshold": 0.8, + "timeGrainType": "Quarterly", + "triggeredBy": "00000000-0000-0000-0000-000000000000_1_01", + "unit": "USD" + } } }, { - "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/alerts/11111111-1111-1111-111111111111", "name": "11111111-1111-1111-111111111111", "type": "Microsoft.CostManagement/alerts", + "id": "/providers/Microsoft.Billing/billingAccounts/12345-6789/billingProfiles/13579/providers/Microsoft.CostManagement/alerts/11111111-1111-1111-111111111111", "properties": { + "description": "", + "closeTime": "0001-01-01T00:00:00", + "costEntityId": "budget1", + "creationTime": "2019-06-24T05:51:52.8713179Z", "definition": { "type": "Budget", "category": "Cost", "criteria": "CostThresholdExceeded" }, - "description": "", + "modificationTime": "2019-08-31T17:51:55.1808807Z", "source": "Preset", + "status": "Active", + "statusModificationTime": "0001-01-01T00:00:00", + "statusModificationUserName": null, "details": { - "timeGrainType": "Quarterly", - "periodStartDate": "2020-03-01T00:00:00Z", - "triggeredBy": "11111111-1111-1111-111111111111_1_01", - "resourceGroupFilter": [], - "resourceFilter": [], - "meterFilter": [], - "tagFilter": {}, - "threshold": 0.8, - "operator": "GreaterThan", - "amount": 200000.0, - "unit": "USD", - "currentSpend": 171000.32, + "amount": 200000, "contactEmails": [ "1234@contoso.com" ], "contactGroups": [], "contactRoles": [], - "overridingAlert": null - }, - "costEntityId": "budget1", - "status": "Active", - "creationTime": "2019-06-24T05:51:52.8713179Z", - "closeTime": "0001-01-01T00:00:00", - "modificationTime": "2019-08-31T17:51:55.1808807Z", - "statusModificationUserName": null, - "statusModificationTime": "0001-01-01T00:00:00" + "currentSpend": 171000.32, + "meterFilter": [], + "operator": "GreaterThan", + "overridingAlert": null, + "periodStartDate": "2020-03-01T00:00:00Z", + "resourceFilter": [], + "resourceGroupFilter": [], + "tagFilter": {}, + "threshold": 0.8, + "timeGrainType": "Quarterly", + "triggeredBy": "11111111-1111-1111-111111111111_1_01", + "unit": "USD" + } } } - ], - "nextLink": null + ] } } - } + }, + "operationId": "Alerts_List", + "title": "BillingProfileAlerts" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/BillingProfileForecast.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/BillingProfileForecast.json index d97b40c6d0cd..fba5b66f290b 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/BillingProfileForecast.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/BillingProfileForecast.json @@ -3,16 +3,9 @@ "api-version": "2025-03-01", "billingAccountId": "12345:6789", "billingProfileId": "13579", - "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579", "parameters": { "type": "Usage", - "timeframe": "Custom", - "timePeriod": { - "from": "2022-08-01T00:00:00+00:00", - "to": "2022-08-31T23:59:59+00:00" - }, "dataset": { - "granularity": "Daily", "aggregation": { "totalCost": { "name": "Cost", @@ -55,20 +48,26 @@ } } ] - } + }, + "granularity": "Daily" }, "includeActualCost": false, - "includeFreshPartialCost": false - } + "includeFreshPartialCost": false, + "timePeriod": { + "from": "2022-08-01T00:00:00+00:00", + "to": "2022-08-31T23:59:59+00:00" + }, + "timeframe": "Custom" + }, + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579" }, "responses": { "200": { "body": { - "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", "type": "Microsoft.CostManagement/query", + "id": "/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", "properties": { - "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/Forecast?api-version=2019-10-01&$skiptoken=AQAAAA%3D%3D", "columns": [ { "name": "PreTaxCost", @@ -87,6 +86,7 @@ "type": "String" } ], + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/Forecast?api-version=2019-10-01&$skiptoken=AQAAAA%3D%3D", "rows": [ [ 2.10333307059661, @@ -117,5 +117,7 @@ } }, "204": {} - } + }, + "operationId": "Forecast_Usage", + "title": "BillingProfileForecast" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/Budgets/CreateOrUpdate/Cost/CreateOrUpdate-Cost-Subscription-Budget.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/Budgets/CreateOrUpdate/Cost/CreateOrUpdate-Cost-Subscription-Budget.json index 699a3b23d9a9..dcd0e65bff44 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/Budgets/CreateOrUpdate/Cost/CreateOrUpdate-Cost-Subscription-Budget.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/Budgets/CreateOrUpdate/Cost/CreateOrUpdate-Cost-Subscription-Budget.json @@ -1,20 +1,12 @@ { "parameters": { "api-version": "2025-03-01", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "MYDEVTESTRG", "budgetName": "TestBudget", - "scope": "subscriptions/00000000-0000-0000-0000-000000000000", "parameters": { "eTag": "\"1d34d016a593709\"", "properties": { - "category": "Cost", "amount": 100.65, - "timeGrain": "Monthly", - "timePeriod": { - "startDate": "2023-04-01T00:00:00Z", - "endDate": "2024-10-31T00:00:00Z" - }, + "category": "Cost", "filter": { "and": [ { @@ -51,41 +43,48 @@ }, "notifications": { "Actual_GreaterThan_80_Percent": { - "enabled": true, - "operator": "GreaterThan", - "threshold": 80, - "locale": "en-us", "contactEmails": [ "johndoe@contoso.com", "janesmith@contoso.com" ], + "contactGroups": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/microsoft.insights/actionGroups/SampleActionGroup" + ], "contactRoles": [ "Contributor", "Reader" ], - "contactGroups": [ - "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/microsoft.insights/actionGroups/SampleActionGroup" - ], + "enabled": true, + "locale": "en-us", + "operator": "GreaterThan", + "threshold": 80, "thresholdType": "Actual" } + }, + "timeGrain": "Monthly", + "timePeriod": { + "endDate": "2024-10-31T00:00:00Z", + "startDate": "2023-04-01T00:00:00Z" } } - } + }, + "resourceGroupName": "MYDEVTESTRG", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { - "201": { + "200": { "body": { - "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/budgets/TestBudget", "name": "TestBudget", "type": "Microsoft.CostManagement/budgets", "eTag": "\"1d34d012214157f\"", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/budgets/TestBudget", "properties": { - "category": "Cost", "amount": 100.65, - "timeGrain": "Monthly", - "timePeriod": { - "startDate": "2023-04-01T00:00:00Z", - "endDate": "2024-10-31T00:00:00Z" + "category": "Cost", + "currentSpend": { + "amount": 80.89, + "unit": "USD" }, "filter": { "and": [ @@ -121,46 +120,46 @@ } ] }, - "currentSpend": { - "amount": 80.89, - "unit": "USD" - }, "notifications": { "Actual_GreaterThan_80_Percent": { - "enabled": true, - "operator": "GreaterThan", - "threshold": 80, - "locale": "en-us", "contactEmails": [ "johndoe@contoso.com", "janesmith@contoso.com" ], + "contactGroups": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/microsoft.insights/actionGroups/SampleActionGroup" + ], "contactRoles": [ "Contributor", "Reader" ], - "contactGroups": [ - "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/microsoft.insights/actionGroups/SampleActionGroup" - ], + "enabled": true, + "locale": "en-us", + "operator": "GreaterThan", + "threshold": 80, "thresholdType": "Actual" } + }, + "timeGrain": "Monthly", + "timePeriod": { + "endDate": "2024-10-31T00:00:00Z", + "startDate": "2023-04-01T00:00:00Z" } } } }, - "200": { + "201": { "body": { - "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/budgets/TestBudget", "name": "TestBudget", "type": "Microsoft.CostManagement/budgets", "eTag": "\"1d34d012214157f\"", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/budgets/TestBudget", "properties": { - "category": "Cost", "amount": 100.65, - "timeGrain": "Monthly", - "timePeriod": { - "startDate": "2023-04-01T00:00:00Z", - "endDate": "2024-10-31T00:00:00Z" + "category": "Cost", + "currentSpend": { + "amount": 80.89, + "unit": "USD" }, "filter": { "and": [ @@ -196,32 +195,35 @@ } ] }, - "currentSpend": { - "amount": 80.89, - "unit": "USD" - }, "notifications": { "Actual_GreaterThan_80_Percent": { - "enabled": true, - "operator": "GreaterThan", - "threshold": 80, - "locale": "en-us", "contactEmails": [ "johndoe@contoso.com", "janesmith@contoso.com" ], + "contactGroups": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/microsoft.insights/actionGroups/SampleActionGroup" + ], "contactRoles": [ "Contributor", "Reader" ], - "contactGroups": [ - "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/microsoft.insights/actionGroups/SampleActionGroup" - ], + "enabled": true, + "locale": "en-us", + "operator": "GreaterThan", + "threshold": 80, "thresholdType": "Actual" } + }, + "timeGrain": "Monthly", + "timePeriod": { + "endDate": "2024-10-31T00:00:00Z", + "startDate": "2023-04-01T00:00:00Z" } } } } - } + }, + "operationId": "Budgets_CreateOrUpdate", + "title": "CreateOrUpdate-Cost-Subscription-Budget" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/Budgets/CreateOrUpdate/ReservationUtilization/EA/BillingAccountEA-AlertRule-ReservationIdFilter.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/Budgets/CreateOrUpdate/ReservationUtilization/EA/BillingAccountEA-AlertRule-ReservationIdFilter.json index 2fb468d52954..43802106ddf8 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/Budgets/CreateOrUpdate/ReservationUtilization/EA/BillingAccountEA-AlertRule-ReservationIdFilter.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/Budgets/CreateOrUpdate/ReservationUtilization/EA/BillingAccountEA-AlertRule-ReservationIdFilter.json @@ -3,16 +3,10 @@ "api-version": "2025-03-01", "billingAccountId": "123456", "budgetName": "TestAlertRule", - "scope": "providers/Microsoft.Billing/billingAccounts/123456", "parameters": { "eTag": "\"1d34d016a593709\"", "properties": { "category": "ReservationUtilization", - "timeGrain": "Last7Days", - "timePeriod": { - "startDate": "2023-04-01T00:00:00Z", - "endDate": "2025-04-01T00:00:00Z" - }, "filter": { "dimensions": { "name": "ReservationId", @@ -26,34 +20,35 @@ }, "notifications": { "Actual_LessThan_99_Percent": { - "enabled": true, - "operator": "LessThan", - "threshold": 99, - "frequency": "Weekly", - "locale": "en-us", "contactEmails": [ "johndoe@contoso.com", "janesmith@contoso.com" - ] + ], + "enabled": true, + "frequency": "Weekly", + "locale": "en-us", + "operator": "LessThan", + "threshold": 99 } + }, + "timeGrain": "Last7Days", + "timePeriod": { + "endDate": "2025-04-01T00:00:00Z", + "startDate": "2023-04-01T00:00:00Z" } } - } + }, + "scope": "providers/Microsoft.Billing/billingAccounts/123456" }, "responses": { - "201": { + "200": { "body": { - "id": "providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/budgets/TestAlertRule", "name": "TestAlertRule", "type": "Microsoft.CostManagement/budgets", "eTag": "\"1d34d012214157f\"", + "id": "/providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/budgets/TestAlertRule", "properties": { "category": "ReservationUtilization", - "timeGrain": "Last7Days", - "timePeriod": { - "startDate": "2023-04-01T00:00:00Z", - "endDate": "2025-04-01T00:00:00Z" - }, "filter": { "dimensions": { "name": "ReservationId", @@ -67,33 +62,33 @@ }, "notifications": { "Actual_LessThan_99_Percent": { - "enabled": true, - "operator": "LessThan", - "threshold": 99, - "frequency": "Weekly", - "locale": "en-us", "contactEmails": [ "johndoe@contoso.com", "janesmith@contoso.com" - ] + ], + "enabled": true, + "frequency": "Weekly", + "locale": "en-us", + "operator": "LessThan", + "threshold": 99 } + }, + "timeGrain": "Last7Days", + "timePeriod": { + "endDate": "2025-04-01T00:00:00Z", + "startDate": "2023-04-01T00:00:00Z" } } } }, - "200": { + "201": { "body": { - "id": "providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/budgets/TestAlertRule", "name": "TestAlertRule", "type": "Microsoft.CostManagement/budgets", "eTag": "\"1d34d012214157f\"", + "id": "/providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/budgets/TestAlertRule", "properties": { "category": "ReservationUtilization", - "timeGrain": "Last7Days", - "timePeriod": { - "startDate": "2023-04-01T00:00:00Z", - "endDate": "2025-04-01T00:00:00Z" - }, "filter": { "dimensions": { "name": "ReservationId", @@ -107,19 +102,26 @@ }, "notifications": { "Actual_LessThan_99_Percent": { - "enabled": true, - "operator": "LessThan", - "threshold": 99, - "frequency": "Weekly", - "locale": "en-us", "contactEmails": [ "johndoe@contoso.com", "janesmith@contoso.com" - ] + ], + "enabled": true, + "frequency": "Weekly", + "locale": "en-us", + "operator": "LessThan", + "threshold": 99 } + }, + "timeGrain": "Last7Days", + "timePeriod": { + "endDate": "2025-04-01T00:00:00Z", + "startDate": "2023-04-01T00:00:00Z" } } } } - } + }, + "operationId": "Budgets_CreateOrUpdate", + "title": "CreateOrUpdate-ReservationUtilization-BillingAccountEA-AlertRule-ReservationIdFilter" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/Budgets/CreateOrUpdate/ReservationUtilization/EA/BillingAccountEA-AlertRule-ReservedResourceTypeFilter.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/Budgets/CreateOrUpdate/ReservationUtilization/EA/BillingAccountEA-AlertRule-ReservedResourceTypeFilter.json index 52a8b210f5fb..d030f2ba6111 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/Budgets/CreateOrUpdate/ReservationUtilization/EA/BillingAccountEA-AlertRule-ReservedResourceTypeFilter.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/Budgets/CreateOrUpdate/ReservationUtilization/EA/BillingAccountEA-AlertRule-ReservedResourceTypeFilter.json @@ -3,16 +3,10 @@ "api-version": "2025-03-01", "billingAccountId": "123456", "budgetName": "TestAlertRule", - "scope": "providers/Microsoft.Billing/billingAccounts/123456", "parameters": { "eTag": "\"1d34d016a593709\"", "properties": { "category": "ReservationUtilization", - "timeGrain": "Last7Days", - "timePeriod": { - "startDate": "2023-04-01T00:00:00Z", - "endDate": "2025-04-01T00:00:00Z" - }, "filter": { "dimensions": { "name": "ReservedResourceType", @@ -26,34 +20,35 @@ }, "notifications": { "Actual_LessThan_99_Percent": { - "enabled": true, - "operator": "LessThan", - "threshold": 99, - "frequency": "Weekly", - "locale": "en-us", "contactEmails": [ "johndoe@contoso.com", "janesmith@contoso.com" - ] + ], + "enabled": true, + "frequency": "Weekly", + "locale": "en-us", + "operator": "LessThan", + "threshold": 99 } + }, + "timeGrain": "Last7Days", + "timePeriod": { + "endDate": "2025-04-01T00:00:00Z", + "startDate": "2023-04-01T00:00:00Z" } } - } + }, + "scope": "providers/Microsoft.Billing/billingAccounts/123456" }, "responses": { - "201": { + "200": { "body": { - "id": "providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/budgets/TestAlertRule", "name": "TestAlertRule", "type": "Microsoft.CostManagement/budgets", "eTag": "\"1d34d012214157f\"", + "id": "/providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/budgets/TestAlertRule", "properties": { "category": "ReservationUtilization", - "timeGrain": "Last7Days", - "timePeriod": { - "startDate": "2023-04-01T00:00:00Z", - "endDate": "2025-04-01T00:00:00Z" - }, "filter": { "dimensions": { "name": "ReservedResourceType", @@ -67,33 +62,33 @@ }, "notifications": { "Actual_LessThan_99_Percent": { - "enabled": true, - "operator": "LessThan", - "threshold": 99, - "frequency": "Weekly", - "locale": "en-us", "contactEmails": [ "johndoe@contoso.com", "janesmith@contoso.com" - ] + ], + "enabled": true, + "frequency": "Weekly", + "locale": "en-us", + "operator": "LessThan", + "threshold": 99 } + }, + "timeGrain": "Last7Days", + "timePeriod": { + "endDate": "2025-04-01T00:00:00Z", + "startDate": "2023-04-01T00:00:00Z" } } } }, - "200": { + "201": { "body": { - "id": "providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/budgets/TestAlertRule", "name": "TestAlertRule", "type": "Microsoft.CostManagement/budgets", "eTag": "\"1d34d012214157f\"", + "id": "/providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/budgets/TestAlertRule", "properties": { "category": "ReservationUtilization", - "timeGrain": "Last7Days", - "timePeriod": { - "startDate": "2023-04-01T00:00:00Z", - "endDate": "2025-04-01T00:00:00Z" - }, "filter": { "dimensions": { "name": "ReservedResourceType", @@ -107,19 +102,26 @@ }, "notifications": { "Actual_LessThan_99_Percent": { - "enabled": true, - "operator": "LessThan", - "threshold": 99, - "frequency": "Weekly", - "locale": "en-us", "contactEmails": [ "johndoe@contoso.com", "janesmith@contoso.com" - ] + ], + "enabled": true, + "frequency": "Weekly", + "locale": "en-us", + "operator": "LessThan", + "threshold": 99 } + }, + "timeGrain": "Last7Days", + "timePeriod": { + "endDate": "2025-04-01T00:00:00Z", + "startDate": "2023-04-01T00:00:00Z" } } } } - } + }, + "operationId": "Budgets_CreateOrUpdate", + "title": "CreateOrUpdate-ReservationUtilization-BillingAccountEA-AlertRule-ReservedResourceTypeFilter" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/Budgets/CreateOrUpdate/ReservationUtilization/EA/BillingAccountEA-AlertRule.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/Budgets/CreateOrUpdate/ReservationUtilization/EA/BillingAccountEA-AlertRule.json index 8648a80a294f..529f09fac6ae 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/Budgets/CreateOrUpdate/ReservationUtilization/EA/BillingAccountEA-AlertRule.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/Budgets/CreateOrUpdate/ReservationUtilization/EA/BillingAccountEA-AlertRule.json @@ -3,93 +3,95 @@ "api-version": "2025-03-01", "billingAccountId": "123456", "budgetName": "TestAlertRule", - "scope": "providers/Microsoft.Billing/billingAccounts/123456", "parameters": { "eTag": "\"1d34d016a593709\"", "properties": { "category": "ReservationUtilization", - "timeGrain": "Last7Days", - "timePeriod": { - "startDate": "2023-04-01T00:00:00Z", - "endDate": "2025-04-01T00:00:00Z" - }, "filter": {}, "notifications": { "Actual_LessThan_99_Percent": { - "enabled": true, - "operator": "LessThan", - "threshold": 99, - "frequency": "Weekly", - "locale": "en-us", "contactEmails": [ "johndoe@contoso.com", "janesmith@contoso.com" - ] + ], + "enabled": true, + "frequency": "Weekly", + "locale": "en-us", + "operator": "LessThan", + "threshold": 99 } + }, + "timeGrain": "Last7Days", + "timePeriod": { + "endDate": "2025-04-01T00:00:00Z", + "startDate": "2023-04-01T00:00:00Z" } } - } + }, + "scope": "providers/Microsoft.Billing/billingAccounts/123456" }, "responses": { - "201": { + "200": { "body": { - "id": "providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/budgets/TestAlertRule", "name": "TestAlertRule", "type": "Microsoft.CostManagement/budgets", "eTag": "\"1d34d012214157f\"", + "id": "/providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/budgets/TestAlertRule", "properties": { "category": "ReservationUtilization", - "timeGrain": "Last7Days", - "timePeriod": { - "startDate": "2023-04-01T00:00:00Z", - "endDate": "2025-04-01T00:00:00Z" - }, "filter": {}, "notifications": { "Actual_LessThan_99_Percent": { - "enabled": true, - "operator": "LessThan", - "threshold": 99, - "frequency": "Weekly", - "locale": "en-us", "contactEmails": [ "johndoe@contoso.com", "janesmith@contoso.com" - ] + ], + "enabled": true, + "frequency": "Weekly", + "locale": "en-us", + "operator": "LessThan", + "threshold": 99 } + }, + "timeGrain": "Last7Days", + "timePeriod": { + "endDate": "2025-04-01T00:00:00Z", + "startDate": "2023-04-01T00:00:00Z" } } } }, - "200": { + "201": { "body": { - "id": "providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/budgets/TestAlertRule", "name": "TestAlertRule", "type": "Microsoft.CostManagement/budgets", "eTag": "\"1d34d012214157f\"", + "id": "/providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/budgets/TestAlertRule", "properties": { "category": "ReservationUtilization", - "timeGrain": "Last7Days", - "timePeriod": { - "startDate": "2023-04-01T00:00:00Z", - "endDate": "2025-04-01T00:00:00Z" - }, "filter": {}, "notifications": { "Actual_LessThan_99_Percent": { - "enabled": true, - "operator": "LessThan", - "threshold": 99, - "frequency": "Weekly", - "locale": "en-us", "contactEmails": [ "johndoe@contoso.com", "janesmith@contoso.com" - ] + ], + "enabled": true, + "frequency": "Weekly", + "locale": "en-us", + "operator": "LessThan", + "threshold": 99 } + }, + "timeGrain": "Last7Days", + "timePeriod": { + "endDate": "2025-04-01T00:00:00Z", + "startDate": "2023-04-01T00:00:00Z" } } } } - } + }, + "operationId": "Budgets_CreateOrUpdate", + "title": "CreateOrUpdate-ReservationUtilization-BillingAccountEA-AlertRule" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/Budgets/CreateOrUpdate/ReservationUtilization/MCA/BillingProfile-AlertRule-ReservationIdFilter.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/Budgets/CreateOrUpdate/ReservationUtilization/MCA/BillingProfile-AlertRule-ReservationIdFilter.json index 6f272a3143c6..0bde1231be0c 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/Budgets/CreateOrUpdate/ReservationUtilization/MCA/BillingProfile-AlertRule-ReservationIdFilter.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/Budgets/CreateOrUpdate/ReservationUtilization/MCA/BillingProfile-AlertRule-ReservationIdFilter.json @@ -4,16 +4,10 @@ "billingAccountId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01", "billingProfileId": "KKKK-LLLL-MMM-NNN", "budgetName": "TestAlertRule", - "scope": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/billingProfiles/KKKK-LLLL-MMM-NNN", "parameters": { "eTag": "\"1d34d016a593709\"", "properties": { "category": "ReservationUtilization", - "timeGrain": "Last30Days", - "timePeriod": { - "startDate": "2023-04-01T00:00:00Z", - "endDate": "2025-04-01T00:00:00Z" - }, "filter": { "dimensions": { "name": "ReservationId", @@ -27,34 +21,35 @@ }, "notifications": { "Actual_LessThan_99_Percent": { - "enabled": true, - "operator": "LessThan", - "threshold": 99, - "frequency": "Daily", - "locale": "en-us", "contactEmails": [ "johndoe@contoso.com", "janesmith@contoso.com" - ] + ], + "enabled": true, + "frequency": "Daily", + "locale": "en-us", + "operator": "LessThan", + "threshold": 99 } + }, + "timeGrain": "Last30Days", + "timePeriod": { + "endDate": "2025-04-01T00:00:00Z", + "startDate": "2023-04-01T00:00:00Z" } } - } + }, + "scope": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/billingProfiles/KKKK-LLLL-MMM-NNN" }, "responses": { - "201": { + "200": { "body": { - "id": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/billingProfiles/KKKK-LLLL-MMM-NNN/providers/Microsoft.CostManagement/budgets/TestAlertRule", "name": "TestAlertRule", "type": "Microsoft.CostManagement/budgets", "eTag": "\"1d34d012214157f\"", + "id": "/providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/billingProfiles/KKKK-LLLL-MMM-NNN/providers/Microsoft.CostManagement/budgets/TestAlertRule", "properties": { "category": "ReservationUtilization", - "timeGrain": "Last30Days", - "timePeriod": { - "startDate": "2023-04-01T00:00:00Z", - "endDate": "2025-04-01T00:00:00Z" - }, "filter": { "dimensions": { "name": "ReservationId", @@ -68,33 +63,33 @@ }, "notifications": { "Actual_LessThan_99_Percent": { - "enabled": true, - "operator": "LessThan", - "threshold": 99, - "frequency": "Daily", - "locale": "en-us", "contactEmails": [ "johndoe@contoso.com", "janesmith@contoso.com" - ] + ], + "enabled": true, + "frequency": "Daily", + "locale": "en-us", + "operator": "LessThan", + "threshold": 99 } + }, + "timeGrain": "Last30Days", + "timePeriod": { + "endDate": "2025-04-01T00:00:00Z", + "startDate": "2023-04-01T00:00:00Z" } } } }, - "200": { + "201": { "body": { - "id": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/billingProfiles/KKKK-LLLL-MMM-NNN/providers/Microsoft.CostManagement/budgets/TestAlertRule", "name": "TestAlertRule", "type": "Microsoft.CostManagement/budgets", "eTag": "\"1d34d012214157f\"", + "id": "/providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/billingProfiles/KKKK-LLLL-MMM-NNN/providers/Microsoft.CostManagement/budgets/TestAlertRule", "properties": { "category": "ReservationUtilization", - "timeGrain": "Last30Days", - "timePeriod": { - "startDate": "2023-04-01T00:00:00Z", - "endDate": "2025-04-01T00:00:00Z" - }, "filter": { "dimensions": { "name": "ReservationId", @@ -108,19 +103,26 @@ }, "notifications": { "Actual_LessThan_99_Percent": { - "enabled": true, - "operator": "LessThan", - "threshold": 99, - "frequency": "Daily", - "locale": "en-us", "contactEmails": [ "johndoe@contoso.com", "janesmith@contoso.com" - ] + ], + "enabled": true, + "frequency": "Daily", + "locale": "en-us", + "operator": "LessThan", + "threshold": 99 } + }, + "timeGrain": "Last30Days", + "timePeriod": { + "endDate": "2025-04-01T00:00:00Z", + "startDate": "2023-04-01T00:00:00Z" } } } } - } + }, + "operationId": "Budgets_CreateOrUpdate", + "title": "CreateOrUpdate-ReservationUtilization-BillingProfileMCA-AlertRule-ReservationIdFilter" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/Budgets/CreateOrUpdate/ReservationUtilization/MCA/BillingProfile-AlertRule-ReservedResourceTypeFilter.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/Budgets/CreateOrUpdate/ReservationUtilization/MCA/BillingProfile-AlertRule-ReservedResourceTypeFilter.json index 820eb44c998b..b7cc90c26ab1 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/Budgets/CreateOrUpdate/ReservationUtilization/MCA/BillingProfile-AlertRule-ReservedResourceTypeFilter.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/Budgets/CreateOrUpdate/ReservationUtilization/MCA/BillingProfile-AlertRule-ReservedResourceTypeFilter.json @@ -4,16 +4,10 @@ "billingAccountId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01", "billingProfileId": "KKKK-LLLL-MMM-NNN", "budgetName": "TestAlertRule", - "scope": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/billingProfiles/KKKK-LLLL-MMM-NNN", "parameters": { "eTag": "\"1d34d016a593709\"", "properties": { "category": "ReservationUtilization", - "timeGrain": "Last30Days", - "timePeriod": { - "startDate": "2023-04-01T00:00:00Z", - "endDate": "2025-04-01T00:00:00Z" - }, "filter": { "dimensions": { "name": "ReservedResourceType", @@ -27,34 +21,35 @@ }, "notifications": { "Actual_LessThan_99_Percent": { - "enabled": true, - "operator": "LessThan", - "threshold": 99, - "frequency": "Daily", - "locale": "en-us", "contactEmails": [ "johndoe@contoso.com", "janesmith@contoso.com" - ] + ], + "enabled": true, + "frequency": "Daily", + "locale": "en-us", + "operator": "LessThan", + "threshold": 99 } + }, + "timeGrain": "Last30Days", + "timePeriod": { + "endDate": "2025-04-01T00:00:00Z", + "startDate": "2023-04-01T00:00:00Z" } } - } + }, + "scope": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/billingProfiles/KKKK-LLLL-MMM-NNN" }, "responses": { - "201": { + "200": { "body": { - "id": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/billingProfiles/KKKK-LLLL-MMM-NNN/providers/Microsoft.CostManagement/budgets/TestAlertRule", "name": "TestAlertRule", "type": "Microsoft.CostManagement/budgets", "eTag": "\"1d34d012214157f\"", + "id": "/providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/billingProfiles/KKKK-LLLL-MMM-NNN/providers/Microsoft.CostManagement/budgets/TestAlertRule", "properties": { "category": "ReservationUtilization", - "timeGrain": "Last30Days", - "timePeriod": { - "startDate": "2023-04-01T00:00:00Z", - "endDate": "2025-04-01T00:00:00Z" - }, "filter": { "dimensions": { "name": "ReservedResourceType", @@ -68,33 +63,33 @@ }, "notifications": { "Actual_LessThan_99_Percent": { - "enabled": true, - "operator": "LessThan", - "threshold": 99, - "frequency": "Daily", - "locale": "en-us", "contactEmails": [ "johndoe@contoso.com", "janesmith@contoso.com" - ] + ], + "enabled": true, + "frequency": "Daily", + "locale": "en-us", + "operator": "LessThan", + "threshold": 99 } + }, + "timeGrain": "Last30Days", + "timePeriod": { + "endDate": "2025-04-01T00:00:00Z", + "startDate": "2023-04-01T00:00:00Z" } } } }, - "200": { + "201": { "body": { - "id": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/billingProfiles/KKKK-LLLL-MMM-NNN/providers/Microsoft.CostManagement/budgets/TestAlertRule", "name": "TestAlertRule", "type": "Microsoft.CostManagement/budgets", "eTag": "\"1d34d012214157f\"", + "id": "/providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/billingProfiles/KKKK-LLLL-MMM-NNN/providers/Microsoft.CostManagement/budgets/TestAlertRule", "properties": { "category": "ReservationUtilization", - "timeGrain": "Last30Days", - "timePeriod": { - "startDate": "2023-04-01T00:00:00Z", - "endDate": "2025-04-01T00:00:00Z" - }, "filter": { "dimensions": { "name": "ReservedResourceType", @@ -108,19 +103,26 @@ }, "notifications": { "Actual_LessThan_99_Percent": { - "enabled": true, - "operator": "LessThan", - "threshold": 99, - "frequency": "Daily", - "locale": "en-us", "contactEmails": [ "johndoe@contoso.com", "janesmith@contoso.com" - ] + ], + "enabled": true, + "frequency": "Daily", + "locale": "en-us", + "operator": "LessThan", + "threshold": 99 } + }, + "timeGrain": "Last30Days", + "timePeriod": { + "endDate": "2025-04-01T00:00:00Z", + "startDate": "2023-04-01T00:00:00Z" } } } } - } + }, + "operationId": "Budgets_CreateOrUpdate", + "title": "CreateOrUpdate-ReservationUtilization-BillingProfileMCA-AlertRule-ReservedResourceTypeFilter" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/Budgets/CreateOrUpdate/ReservationUtilization/MCA/BillingProfile-AlertRule.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/Budgets/CreateOrUpdate/ReservationUtilization/MCA/BillingProfile-AlertRule.json index 42edf217bdba..4435cdfe6f0a 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/Budgets/CreateOrUpdate/ReservationUtilization/MCA/BillingProfile-AlertRule.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/Budgets/CreateOrUpdate/ReservationUtilization/MCA/BillingProfile-AlertRule.json @@ -4,93 +4,95 @@ "billingAccountId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01", "billingProfileId": "KKKK-LLLL-MMM-NNN", "budgetName": "TestAlertRule", - "scope": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/billingProfiles/KKKK-LLLL-MMM-NNN", "parameters": { "eTag": "\"1d34d016a593709\"", "properties": { "category": "ReservationUtilization", - "timeGrain": "Last30Days", - "timePeriod": { - "startDate": "2023-04-01T00:00:00Z", - "endDate": "2025-04-01T00:00:00Z" - }, "filter": {}, "notifications": { "Actual_LessThan_99_Percent": { - "enabled": true, - "operator": "LessThan", - "threshold": 99, - "frequency": "Daily", - "locale": "en-us", "contactEmails": [ "johndoe@contoso.com", "janesmith@contoso.com" - ] + ], + "enabled": true, + "frequency": "Daily", + "locale": "en-us", + "operator": "LessThan", + "threshold": 99 } + }, + "timeGrain": "Last30Days", + "timePeriod": { + "endDate": "2025-04-01T00:00:00Z", + "startDate": "2023-04-01T00:00:00Z" } } - } + }, + "scope": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/billingProfiles/KKKK-LLLL-MMM-NNN" }, "responses": { - "201": { + "200": { "body": { - "id": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/billingProfiles/KKKK-LLLL-MMM-NNN/providers/Microsoft.CostManagement/budgets/TestAlertRule", "name": "TestAlertRule", "type": "Microsoft.CostManagement/budgets", "eTag": "\"1d34d012214157f\"", + "id": "/providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/billingProfiles/KKKK-LLLL-MMM-NNN/providers/Microsoft.CostManagement/budgets/TestAlertRule", "properties": { "category": "ReservationUtilization", - "timeGrain": "Last30Days", - "timePeriod": { - "startDate": "2023-04-01T00:00:00Z", - "endDate": "2025-04-01T00:00:00Z" - }, "filter": {}, "notifications": { "Actual_LessThan_99_Percent": { - "enabled": true, - "operator": "LessThan", - "threshold": 99, - "frequency": "Daily", - "locale": "en-us", "contactEmails": [ "johndoe@contoso.com", "janesmith@contoso.com" - ] + ], + "enabled": true, + "frequency": "Daily", + "locale": "en-us", + "operator": "LessThan", + "threshold": 99 } + }, + "timeGrain": "Last30Days", + "timePeriod": { + "endDate": "2025-04-01T00:00:00Z", + "startDate": "2023-04-01T00:00:00Z" } } } }, - "200": { + "201": { "body": { - "id": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/billingProfiles/KKKK-LLLL-MMM-NNN/providers/Microsoft.CostManagement/budgets/TestAlertRule", "name": "TestAlertRule", "type": "Microsoft.CostManagement/budgets", "eTag": "\"1d34d012214157f\"", + "id": "/providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/billingProfiles/KKKK-LLLL-MMM-NNN/providers/Microsoft.CostManagement/budgets/TestAlertRule", "properties": { "category": "ReservationUtilization", - "timeGrain": "Last30Days", - "timePeriod": { - "startDate": "2023-04-01T00:00:00Z", - "endDate": "2025-04-01T00:00:00Z" - }, "filter": {}, "notifications": { "Actual_LessThan_99_Percent": { - "enabled": true, - "operator": "LessThan", - "threshold": 99, - "frequency": "Daily", - "locale": "en-us", "contactEmails": [ "johndoe@contoso.com", "janesmith@contoso.com" - ] + ], + "enabled": true, + "frequency": "Daily", + "locale": "en-us", + "operator": "LessThan", + "threshold": 99 } + }, + "timeGrain": "Last30Days", + "timePeriod": { + "endDate": "2025-04-01T00:00:00Z", + "startDate": "2023-04-01T00:00:00Z" } } } } - } + }, + "operationId": "Budgets_CreateOrUpdate", + "title": "CreateOrUpdate-ReservationUtilization-BillingProfileMCA-AlertRule.json" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/Budgets/CreateOrUpdate/ReservationUtilization/MCA/Customer-AlertRule-ReservationIdFilter.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/Budgets/CreateOrUpdate/ReservationUtilization/MCA/Customer-AlertRule-ReservationIdFilter.json index 044af539b29a..2d86b6d7e5f0 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/Budgets/CreateOrUpdate/ReservationUtilization/MCA/Customer-AlertRule-ReservationIdFilter.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/Budgets/CreateOrUpdate/ReservationUtilization/MCA/Customer-AlertRule-ReservationIdFilter.json @@ -2,18 +2,12 @@ "parameters": { "api-version": "2025-03-01", "billingAccountId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01", - "customerId": "000000-1111-2222-3333-444444444444", "budgetName": "TestAlertRule", - "scope": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/customers/000000-1111-2222-3333-444444444444", + "customerId": "000000-1111-2222-3333-444444444444", "parameters": { "eTag": "\"1d34d016a593709\"", "properties": { "category": "ReservationUtilization", - "timeGrain": "Last30Days", - "timePeriod": { - "startDate": "2023-04-01T00:00:00Z", - "endDate": "2025-04-01T00:00:00Z" - }, "filter": { "dimensions": { "name": "ReservationId", @@ -27,34 +21,35 @@ }, "notifications": { "Actual_LessThan_99_Percent": { - "enabled": true, - "operator": "LessThan", - "threshold": 99, - "frequency": "Daily", - "locale": "en-us", "contactEmails": [ "johndoe@contoso.com", "janesmith@contoso.com" - ] + ], + "enabled": true, + "frequency": "Daily", + "locale": "en-us", + "operator": "LessThan", + "threshold": 99 } + }, + "timeGrain": "Last30Days", + "timePeriod": { + "endDate": "2025-04-01T00:00:00Z", + "startDate": "2023-04-01T00:00:00Z" } } - } + }, + "scope": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/customers/000000-1111-2222-3333-444444444444" }, "responses": { - "201": { + "200": { "body": { - "id": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/customers/000000-1111-2222-3333-444444444444/providers/Microsoft.CostManagement/budgets/TestAlertRule", "name": "TestAlertRule", "type": "Microsoft.CostManagement/budgets", "eTag": "\"1d34d012214157f\"", + "id": "/providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/customers/000000-1111-2222-3333-444444444444/providers/Microsoft.CostManagement/budgets/TestAlertRule", "properties": { "category": "ReservationUtilization", - "timeGrain": "Last30Days", - "timePeriod": { - "startDate": "2023-04-01T00:00:00Z", - "endDate": "2025-04-01T00:00:00Z" - }, "filter": { "dimensions": { "name": "ReservationId", @@ -68,33 +63,33 @@ }, "notifications": { "Actual_LessThan_99_Percent": { - "enabled": true, - "operator": "LessThan", - "threshold": 99, - "frequency": "Daily", - "locale": "en-us", "contactEmails": [ "johndoe@contoso.com", "janesmith@contoso.com" - ] + ], + "enabled": true, + "frequency": "Daily", + "locale": "en-us", + "operator": "LessThan", + "threshold": 99 } + }, + "timeGrain": "Last30Days", + "timePeriod": { + "endDate": "2025-04-01T00:00:00Z", + "startDate": "2023-04-01T00:00:00Z" } } } }, - "200": { + "201": { "body": { - "id": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/customers/000000-1111-2222-3333-444444444444/providers/Microsoft.CostManagement/budgets/TestAlertRule", "name": "TestAlertRule", "type": "Microsoft.CostManagement/budgets", "eTag": "\"1d34d012214157f\"", + "id": "/providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/customers/000000-1111-2222-3333-444444444444/providers/Microsoft.CostManagement/budgets/TestAlertRule", "properties": { "category": "ReservationUtilization", - "timeGrain": "Last30Days", - "timePeriod": { - "startDate": "2023-04-01T00:00:00Z", - "endDate": "2025-04-01T00:00:00Z" - }, "filter": { "dimensions": { "name": "ReservationId", @@ -108,19 +103,26 @@ }, "notifications": { "Actual_LessThan_99_Percent": { - "enabled": true, - "operator": "LessThan", - "threshold": 99, - "frequency": "Daily", - "locale": "en-us", "contactEmails": [ "johndoe@contoso.com", "janesmith@contoso.com" - ] + ], + "enabled": true, + "frequency": "Daily", + "locale": "en-us", + "operator": "LessThan", + "threshold": 99 } + }, + "timeGrain": "Last30Days", + "timePeriod": { + "endDate": "2025-04-01T00:00:00Z", + "startDate": "2023-04-01T00:00:00Z" } } } } - } + }, + "operationId": "Budgets_CreateOrUpdate", + "title": "CreateOrUpdate-ReservationUtilization-CustomerCSP-AlertRule-ReservationIdFilter" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/Budgets/CreateOrUpdate/ReservationUtilization/MCA/Customer-AlertRule-ReservedResourceTypeFilter.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/Budgets/CreateOrUpdate/ReservationUtilization/MCA/Customer-AlertRule-ReservedResourceTypeFilter.json index 51e08af283ff..32eb6fe7c10e 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/Budgets/CreateOrUpdate/ReservationUtilization/MCA/Customer-AlertRule-ReservedResourceTypeFilter.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/Budgets/CreateOrUpdate/ReservationUtilization/MCA/Customer-AlertRule-ReservedResourceTypeFilter.json @@ -2,18 +2,12 @@ "parameters": { "api-version": "2025-03-01", "billingAccountId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01", - "customerId": "000000-1111-2222-3333-444444444444", "budgetName": "TestAlertRule", - "scope": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/customers/000000-1111-2222-3333-444444444444", + "customerId": "000000-1111-2222-3333-444444444444", "parameters": { "eTag": "\"1d34d016a593709\"", "properties": { "category": "ReservationUtilization", - "timeGrain": "Last30Days", - "timePeriod": { - "startDate": "2023-04-01T00:00:00Z", - "endDate": "2025-04-01T00:00:00Z" - }, "filter": { "dimensions": { "name": "ReservedResourceType", @@ -27,34 +21,35 @@ }, "notifications": { "Actual_LessThan_99_Percent": { - "enabled": true, - "operator": "LessThan", - "threshold": 99, - "frequency": "Daily", - "locale": "en-us", "contactEmails": [ "johndoe@contoso.com", "janesmith@contoso.com" - ] + ], + "enabled": true, + "frequency": "Daily", + "locale": "en-us", + "operator": "LessThan", + "threshold": 99 } + }, + "timeGrain": "Last30Days", + "timePeriod": { + "endDate": "2025-04-01T00:00:00Z", + "startDate": "2023-04-01T00:00:00Z" } } - } + }, + "scope": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/customers/000000-1111-2222-3333-444444444444" }, "responses": { - "201": { + "200": { "body": { - "id": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/customers/000000-1111-2222-3333-444444444444/providers/Microsoft.CostManagement/budgets/TestAlertRule", "name": "TestAlertRule", "type": "Microsoft.CostManagement/budgets", "eTag": "\"1d34d012214157f\"", + "id": "/providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/customers/000000-1111-2222-3333-444444444444/providers/Microsoft.CostManagement/budgets/TestAlertRule", "properties": { "category": "ReservationUtilization", - "timeGrain": "Last30Days", - "timePeriod": { - "startDate": "2023-04-01T00:00:00Z", - "endDate": "2025-04-01T00:00:00Z" - }, "filter": { "dimensions": { "name": "ReservedResourceType", @@ -68,33 +63,33 @@ }, "notifications": { "Actual_LessThan_99_Percent": { - "enabled": true, - "operator": "LessThan", - "threshold": 99, - "frequency": "Daily", - "locale": "en-us", "contactEmails": [ "johndoe@contoso.com", "janesmith@contoso.com" - ] + ], + "enabled": true, + "frequency": "Daily", + "locale": "en-us", + "operator": "LessThan", + "threshold": 99 } + }, + "timeGrain": "Last30Days", + "timePeriod": { + "endDate": "2025-04-01T00:00:00Z", + "startDate": "2023-04-01T00:00:00Z" } } } }, - "200": { + "201": { "body": { - "id": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/customers/000000-1111-2222-3333-444444444444/providers/Microsoft.CostManagement/budgets/TestAlertRule", "name": "TestAlertRule", "type": "Microsoft.CostManagement/budgets", "eTag": "\"1d34d012214157f\"", + "id": "/providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/customers/000000-1111-2222-3333-444444444444/providers/Microsoft.CostManagement/budgets/TestAlertRule", "properties": { "category": "ReservationUtilization", - "timeGrain": "Last30Days", - "timePeriod": { - "startDate": "2023-04-01T00:00:00Z", - "endDate": "2025-04-01T00:00:00Z" - }, "filter": { "dimensions": { "name": "ReservedResourceType", @@ -108,19 +103,26 @@ }, "notifications": { "Actual_LessThan_99_Percent": { - "enabled": true, - "operator": "LessThan", - "threshold": 99, - "frequency": "Daily", - "locale": "en-us", "contactEmails": [ "johndoe@contoso.com", "janesmith@contoso.com" - ] + ], + "enabled": true, + "frequency": "Daily", + "locale": "en-us", + "operator": "LessThan", + "threshold": 99 } + }, + "timeGrain": "Last30Days", + "timePeriod": { + "endDate": "2025-04-01T00:00:00Z", + "startDate": "2023-04-01T00:00:00Z" } } } } - } + }, + "operationId": "Budgets_CreateOrUpdate", + "title": "CreateOrUpdate-ReservationUtilization-CustomerCSP-AlertRule-ReservedResourceTypeFilter" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/Budgets/CreateOrUpdate/ReservationUtilization/MCA/Customer-AlertRule.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/Budgets/CreateOrUpdate/ReservationUtilization/MCA/Customer-AlertRule.json index 2c8bc90512f6..8c57381ff50e 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/Budgets/CreateOrUpdate/ReservationUtilization/MCA/Customer-AlertRule.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/Budgets/CreateOrUpdate/ReservationUtilization/MCA/Customer-AlertRule.json @@ -2,95 +2,97 @@ "parameters": { "api-version": "2025-03-01", "billingAccountId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01", - "customerId": "000000-1111-2222-3333-444444444444", "budgetName": "TestAlertRule", - "scope": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/customers/000000-1111-2222-3333-444444444444", + "customerId": "000000-1111-2222-3333-444444444444", "parameters": { "eTag": "\"1d34d016a593709\"", "properties": { "category": "ReservationUtilization", - "timeGrain": "Last30Days", - "timePeriod": { - "startDate": "2023-04-01T00:00:00Z", - "endDate": "2025-04-01T00:00:00Z" - }, "filter": {}, "notifications": { "Actual_LessThan_99_Percent": { - "enabled": true, - "operator": "LessThan", - "threshold": 99, - "frequency": "Daily", - "locale": "en-us", "contactEmails": [ "johndoe@contoso.com", "janesmith@contoso.com" - ] + ], + "enabled": true, + "frequency": "Daily", + "locale": "en-us", + "operator": "LessThan", + "threshold": 99 } + }, + "timeGrain": "Last30Days", + "timePeriod": { + "endDate": "2025-04-01T00:00:00Z", + "startDate": "2023-04-01T00:00:00Z" } } - } + }, + "scope": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/customers/000000-1111-2222-3333-444444444444" }, "responses": { - "201": { + "200": { "body": { - "id": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/customers/000000-1111-2222-3333-444444444444/providers/Microsoft.CostManagement/budgets/TestAlertRule", "name": "TestAlertRule", "type": "Microsoft.CostManagement/budgets", "eTag": "\"1d34d012214157f\"", + "id": "/providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/customers/000000-1111-2222-3333-444444444444/providers/Microsoft.CostManagement/budgets/TestAlertRule", "properties": { "category": "ReservationUtilization", - "timeGrain": "Last30Days", - "timePeriod": { - "startDate": "2023-04-01T00:00:00Z", - "endDate": "2025-04-01T00:00:00Z" - }, "filter": {}, "notifications": { "Actual_LessThan_99_Percent": { - "enabled": true, - "operator": "LessThan", - "threshold": 99, - "frequency": "Daily", - "locale": "en-us", "contactEmails": [ "johndoe@contoso.com", "janesmith@contoso.com" - ] + ], + "enabled": true, + "frequency": "Daily", + "locale": "en-us", + "operator": "LessThan", + "threshold": 99 } + }, + "timeGrain": "Last30Days", + "timePeriod": { + "endDate": "2025-04-01T00:00:00Z", + "startDate": "2023-04-01T00:00:00Z" } } } }, - "200": { + "201": { "body": { - "id": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/customers/000000-1111-2222-3333-444444444444/providers/Microsoft.CostManagement/budgets/TestAlertRule", "name": "TestAlertRule", "type": "Microsoft.CostManagement/budgets", "eTag": "\"1d34d012214157f\"", + "id": "/providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/customers/000000-1111-2222-3333-444444444444/providers/Microsoft.CostManagement/budgets/TestAlertRule", "properties": { "category": "ReservationUtilization", - "timeGrain": "Last30Days", - "timePeriod": { - "startDate": "2023-04-01T00:00:00Z", - "endDate": "2025-04-01T00:00:00Z" - }, "filter": {}, "notifications": { "Actual_LessThan_99_Percent": { - "enabled": true, - "operator": "LessThan", - "threshold": 99, - "frequency": "Daily", - "locale": "en-us", "contactEmails": [ "johndoe@contoso.com", "janesmith@contoso.com" - ] + ], + "enabled": true, + "frequency": "Daily", + "locale": "en-us", + "operator": "LessThan", + "threshold": 99 } + }, + "timeGrain": "Last30Days", + "timePeriod": { + "endDate": "2025-04-01T00:00:00Z", + "startDate": "2023-04-01T00:00:00Z" } } } } - } + }, + "operationId": "Budgets_CreateOrUpdate", + "title": "CreateOrUpdate-ReservationUtilization-CustomerCSP-AlertRule.json" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/Budgets/Delete/DeleteBudget.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/Budgets/Delete/DeleteBudget.json index 5b36a0eae29e..1b47afe55ec4 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/Budgets/Delete/DeleteBudget.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/Budgets/Delete/DeleteBudget.json @@ -1,12 +1,14 @@ { "parameters": { "api-version": "2025-03-01", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "MYDEVTESTRG", "budgetName": "TestBudget", - "scope": "subscriptions/00000000-0000-0000-0000-000000000000" + "resourceGroupName": "MYDEVTESTRG", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": {} - } + }, + "operationId": "Budgets_Delete", + "title": "DeleteBudget" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/Budgets/Get/Cost/Get-Cost-Budget.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/Budgets/Get/Cost/Get-Cost-Budget.json index e0e41f7a8cbf..7c4e859c698d 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/Budgets/Get/Cost/Get-Cost-Budget.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/Budgets/Get/Cost/Get-Cost-Budget.json @@ -1,25 +1,24 @@ { "parameters": { "api-version": "2025-03-01", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "MYDEVTESTRG", "budgetName": "TestBudget", - "scope": "subscriptions/00000000-0000-0000-0000-000000000000" + "resourceGroupName": "MYDEVTESTRG", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { - "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/budgets/TestBudget", "name": "TestBudget", "type": "Microsoft.CostManagement/budgets", "eTag": "\"1d34d012214157f\"", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/budgets/TestBudget", "properties": { - "category": "Cost", "amount": 100.65, - "timeGrain": "Monthly", - "timePeriod": { - "startDate": "2023-04-01T00:00:00Z", - "endDate": "2024-10-31T00:00:00Z" + "category": "Cost", + "currentSpend": { + "amount": 80.89, + "unit": "USD" }, "filter": { "and": [ @@ -55,31 +54,34 @@ } ] }, - "currentSpend": { - "amount": 80.89, - "unit": "USD" - }, "notifications": { "Actual_GreaterThan_80_Percent": { - "enabled": true, - "operator": "GreaterThan", - "threshold": 80, "contactEmails": [ "johndoe@contoso.com", "janesmith@contoso.com" ], + "contactGroups": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/microsoft.insights/actionGroups/SampleActionGroup" + ], "contactRoles": [ "Contributor", "Reader" ], - "contactGroups": [ - "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/microsoft.insights/actionGroups/SampleActionGroup" - ], + "enabled": true, + "operator": "GreaterThan", + "threshold": 80, "thresholdType": "Actual" } + }, + "timeGrain": "Monthly", + "timePeriod": { + "endDate": "2024-10-31T00:00:00Z", + "startDate": "2023-04-01T00:00:00Z" } } } } - } + }, + "operationId": "Budgets_Get", + "title": "Get-Cost-Budget" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/Budgets/Get/ReservationUtilization/Get-ReservationUtilization-AlertRule.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/Budgets/Get/ReservationUtilization/Get-ReservationUtilization-AlertRule.json index 5d722ce501e1..515296bff9af 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/Budgets/Get/ReservationUtilization/Get-ReservationUtilization-AlertRule.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/Budgets/Get/ReservationUtilization/Get-ReservationUtilization-AlertRule.json @@ -9,17 +9,12 @@ "responses": { "200": { "body": { - "id": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/billingProfiles/KKKK-LLLL-MMM-NNN/providers/Microsoft.CostManagement/budgets/TestAlertRule", "name": "TestAlertRule", "type": "Microsoft.CostManagement/budgets", "eTag": "\"1d34d012214157f\"", + "id": "/providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/billingProfiles/KKKK-LLLL-MMM-NNN/providers/Microsoft.CostManagement/budgets/TestAlertRule", "properties": { "category": "ReservationUtilization", - "timeGrain": "Last30Days", - "timePeriod": { - "startDate": "2023-04-01T00:00:00Z", - "endDate": "2025-04-01T00:00:00Z" - }, "filter": { "dimensions": { "name": "ReservedResourceType", @@ -33,19 +28,26 @@ }, "notifications": { "Actual_LessThan_99_Percent": { - "enabled": true, - "operator": "LessThan", - "threshold": 99, - "frequency": "Daily", - "locale": "en-us", "contactEmails": [ "johndoe@contoso.com", "janesmith@contoso.com" - ] + ], + "enabled": true, + "frequency": "Daily", + "locale": "en-us", + "operator": "LessThan", + "threshold": 99 } + }, + "timeGrain": "Last30Days", + "timePeriod": { + "endDate": "2025-04-01T00:00:00Z", + "startDate": "2023-04-01T00:00:00Z" } } } } - } + }, + "operationId": "Budgets_Get", + "title": "Get-ReservationUtilization-AlertRule" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/Budgets/List/EA/BillingAccountBudgetsList-EA-CategoryTypeFilter.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/Budgets/List/EA/BillingAccountBudgetsList-EA-CategoryTypeFilter.json index ed350e3ada1e..87d02eae3e99 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/Budgets/List/EA/BillingAccountBudgetsList-EA-CategoryTypeFilter.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/Budgets/List/EA/BillingAccountBudgetsList-EA-CategoryTypeFilter.json @@ -1,44 +1,46 @@ { "parameters": { + "$filter": "properties/category eq 'ReservationUtilization'", "api-version": "2025-03-01", "billingAccountId": "123456", - "scope": "providers/Microsoft.Billing/billingAccounts/123456", - "$filter": "properties/category eq 'ReservationUtilization'" + "scope": "providers/Microsoft.Billing/billingAccounts/123456" }, "responses": { "200": { "body": { "value": [ { - "id": "providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/budgets/TestRUAlert", "name": "TestRUAlert", "type": "Microsoft.CostManagement/budgets", "eTag": "\"1d34d012214157f\"", + "id": "/providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/budgets/TestRUAlert", "properties": { "category": "ReservationUtilization", - "timeGrain": "Last7Days", - "timePeriod": { - "startDate": "2023-04-01T00:00:00Z", - "endDate": "2025-04-01T00:00:00Z" - }, "filter": {}, "notifications": { "Actual_LessThan_99_Percent": { - "enabled": true, - "operator": "LessThan", - "threshold": 99, - "frequency": "Weekly", - "locale": "en-us", "contactEmails": [ "johndoe@contoso.com", "janesmith@contoso.com" - ] + ], + "enabled": true, + "frequency": "Weekly", + "locale": "en-us", + "operator": "LessThan", + "threshold": 99 } + }, + "timeGrain": "Last7Days", + "timePeriod": { + "endDate": "2025-04-01T00:00:00Z", + "startDate": "2023-04-01T00:00:00Z" } } } ] } } - } + }, + "operationId": "Budgets_List", + "title": "BillingAccountBudgetsList-EA-CategoryTypeFilter" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/Budgets/List/EA/BillingAccountBudgetsList-EA.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/Budgets/List/EA/BillingAccountBudgetsList-EA.json index a78920052f5b..90883764c7b9 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/Budgets/List/EA/BillingAccountBudgetsList-EA.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/Budgets/List/EA/BillingAccountBudgetsList-EA.json @@ -9,97 +9,99 @@ "body": { "value": [ { - "id": "providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/budgets/TestBudget1", "name": "TestBudget1", "type": "Microsoft.CostManagement/budgets", "eTag": "\"1d34d012214157c\"", + "id": "/providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/budgets/TestBudget1", "properties": { + "amount": 10000, "category": "Cost", - "amount": 10000.00, - "timeGrain": "Monthly", - "timePeriod": { - "startDate": "2023-04-01T00:00:00Z", - "endDate": "2024-10-31T00:00:00Z" - }, "currentSpend": { - "amount": 8000.00, + "amount": 8000, "unit": "USD" }, "notifications": { "Actual_GreaterThanOrEqualTo_80_Percent": { - "enabled": true, - "operator": "GreaterThanOrEqualTo", - "threshold": 80, "contactEmails": [ "johndoe@contoso.com", "janesmith@contoso.com" ], + "enabled": true, + "operator": "GreaterThanOrEqualTo", + "threshold": 80, "thresholdType": "Actual" } + }, + "timeGrain": "Monthly", + "timePeriod": { + "endDate": "2024-10-31T00:00:00Z", + "startDate": "2023-04-01T00:00:00Z" } } }, { - "id": "providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/budgets/TestBudget2", "name": "TestBudget2", "type": "Microsoft.CostManagement/budgets", "eTag": "\"1d34d012214157d\"", + "id": "/providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/budgets/TestBudget2", "properties": { + "amount": 15000, "category": "Cost", - "amount": 15000.00, - "timeGrain": "Monthly", - "timePeriod": { - "startDate": "2023-04-01T00:00:00Z", - "endDate": "2024-10-31T00:00:00Z" - }, "currentSpend": { - "amount": 12000.00, + "amount": 12000, "unit": "USD" }, "notifications": { "Actual_GreaterThanOrEqualTo_70_Percent": { - "enabled": true, - "operator": "GreaterThanOrEqualTo", - "threshold": 70, "contactEmails": [ "johndoe@contoso.com", "janesmith@contoso.com" ], + "enabled": true, + "operator": "GreaterThanOrEqualTo", + "threshold": 70, "thresholdType": "Actual" } + }, + "timeGrain": "Monthly", + "timePeriod": { + "endDate": "2024-10-31T00:00:00Z", + "startDate": "2023-04-01T00:00:00Z" } } }, { - "id": "providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/budgets/TestRUAlert", "name": "TestRUAlert", "type": "Microsoft.CostManagement/budgets", "eTag": "\"1d34d012214157f\"", + "id": "/providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/budgets/TestRUAlert", "properties": { "category": "ReservationUtilization", - "timeGrain": "Last7Days", - "timePeriod": { - "startDate": "2023-04-01T00:00:00Z", - "endDate": "2025-04-01T00:00:00Z" - }, "filter": {}, "notifications": { "Actual_LessThan_99_Percent": { - "enabled": true, - "operator": "LessThan", - "threshold": 99, - "frequency": "Weekly", - "locale": "en-us", "contactEmails": [ "johndoe@contoso.com", "janesmith@contoso.com" - ] + ], + "enabled": true, + "frequency": "Weekly", + "locale": "en-us", + "operator": "LessThan", + "threshold": 99 } + }, + "timeGrain": "Last7Days", + "timePeriod": { + "endDate": "2025-04-01T00:00:00Z", + "startDate": "2023-04-01T00:00:00Z" } } } ] } } - } + }, + "operationId": "Budgets_List", + "title": "BillingAccountBudgetsList-EA" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/Budgets/List/EA/DepartmentBudgetsList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/Budgets/List/EA/DepartmentBudgetsList.json index 624d3284357a..056e7f35fc06 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/Budgets/List/EA/DepartmentBudgetsList.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/Budgets/List/EA/DepartmentBudgetsList.json @@ -10,69 +10,71 @@ "body": { "value": [ { - "id": "providers/Microsoft.Billing/billingAccounts/123456/departments/789101/providers/Microsoft.CostManagement/budgets/DepartmentBudget1", "name": "DepartmentBudget1", "type": "Microsoft.CostManagement/budgets", "eTag": "\"1d34d012214157e\"", + "id": "/providers/Microsoft.Billing/billingAccounts/123456/departments/789101/providers/Microsoft.CostManagement/budgets/DepartmentBudget1", "properties": { + "amount": 5000, "category": "Cost", - "amount": 5000.00, - "timeGrain": "Monthly", - "timePeriod": { - "startDate": "2023-04-01T00:00:00Z", - "endDate": "2024-10-31T00:00:00Z" - }, "currentSpend": { - "amount": 3000.00, + "amount": 3000, "unit": "USD" }, "notifications": { "Actual_GreaterThanOrEqualTo_60_Percent": { - "enabled": true, - "operator": "GreaterThanOrEqualTo", - "threshold": 60, "contactEmails": [ "johndoe@contoso.com", "janesmith@contoso.com" ], + "enabled": true, + "operator": "GreaterThanOrEqualTo", + "threshold": 60, "thresholdType": "Actual" } + }, + "timeGrain": "Monthly", + "timePeriod": { + "endDate": "2024-10-31T00:00:00Z", + "startDate": "2023-04-01T00:00:00Z" } } }, { - "id": "providers/Microsoft.Billing/billingAccounts/123456/departments/789101/providers/Microsoft.CostManagement/budgets/DepartmentBudget2", "name": "DepartmentBudget2", "type": "Microsoft.CostManagement/budgets", "eTag": "\"1d34d012214157f\"", + "id": "/providers/Microsoft.Billing/billingAccounts/123456/departments/789101/providers/Microsoft.CostManagement/budgets/DepartmentBudget2", "properties": { + "amount": 8000, "category": "Cost", - "amount": 8000.00, - "timeGrain": "Monthly", - "timePeriod": { - "startDate": "2023-04-01T00:00:00Z", - "endDate": "2024-10-31T00:00:00Z" - }, "currentSpend": { - "amount": 6000.00, + "amount": 6000, "unit": "USD" }, "notifications": { "Actual_GreaterThanOrEqualTo_75_Percent": { - "enabled": true, - "operator": "GreaterThanOrEqualTo", - "threshold": 75, "contactEmails": [ "johndoe@contoso.com", "janesmith@contoso.com" ], + "enabled": true, + "operator": "GreaterThanOrEqualTo", + "threshold": 75, "thresholdType": "Actual" } + }, + "timeGrain": "Monthly", + "timePeriod": { + "endDate": "2024-10-31T00:00:00Z", + "startDate": "2023-04-01T00:00:00Z" } } } ] } } - } + }, + "operationId": "Budgets_List", + "title": "DepartmentBudgetsList-EA" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/Budgets/List/EA/EnrollmentAccountBudgetsList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/Budgets/List/EA/EnrollmentAccountBudgetsList.json index 0a67bf80812b..d8a3e906c5b0 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/Budgets/List/EA/EnrollmentAccountBudgetsList.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/Budgets/List/EA/EnrollmentAccountBudgetsList.json @@ -10,69 +10,71 @@ "body": { "value": [ { - "id": "providers/Microsoft.Billing/billingAccounts/123456/enrollmentAccounts/473845/providers/Microsoft.CostManagement/budgets/EnrollmentAccountBudget1", "name": "EnrollmentAccountBudget1", "type": "Microsoft.CostManagement/budgets", "eTag": "\"1d34d012214157e\"", + "id": "/providers/Microsoft.Billing/billingAccounts/123456/enrollmentAccounts/473845/providers/Microsoft.CostManagement/budgets/EnrollmentAccountBudget1", "properties": { + "amount": 5000, "category": "Cost", - "amount": 5000.00, - "timeGrain": "Monthly", - "timePeriod": { - "startDate": "2023-04-01T00:00:00Z", - "endDate": "2024-10-31T00:00:00Z" - }, "currentSpend": { - "amount": 3000.00, + "amount": 3000, "unit": "USD" }, "notifications": { "Actual_GreaterThanOrEqualTo_60_Percent": { - "enabled": true, - "operator": "GreaterThanOrEqualTo", - "threshold": 60, "contactEmails": [ "johndoe@contoso.com", "janesmith@contoso.com" ], + "enabled": true, + "operator": "GreaterThanOrEqualTo", + "threshold": 60, "thresholdType": "Actual" } + }, + "timeGrain": "Monthly", + "timePeriod": { + "endDate": "2024-10-31T00:00:00Z", + "startDate": "2023-04-01T00:00:00Z" } } }, { - "id": "providers/Microsoft.Billing/billingAccounts/123456/enrollmentAccounts/473845/providers/Microsoft.CostManagement/budgets/EnrollmentAccountBudget2", "name": "EnrollmentAccountBudget2", "type": "Microsoft.CostManagement/budgets", "eTag": "\"1d34d012214157f\"", + "id": "/providers/Microsoft.Billing/billingAccounts/123456/enrollmentAccounts/473845/providers/Microsoft.CostManagement/budgets/EnrollmentAccountBudget2", "properties": { + "amount": 8000, "category": "Cost", - "amount": 8000.00, - "timeGrain": "Monthly", - "timePeriod": { - "startDate": "2023-04-01T00:00:00Z", - "endDate": "2024-10-31T00:00:00Z" - }, "currentSpend": { - "amount": 6000.00, + "amount": 6000, "unit": "USD" }, "notifications": { "Actual_GreaterThanOrEqualTo_75_Percent": { - "enabled": true, - "operator": "GreaterThanOrEqualTo", - "threshold": 75, "contactEmails": [ "johndoe@contoso.com", "janesmith@contoso.com" ], + "enabled": true, + "operator": "GreaterThanOrEqualTo", + "threshold": 75, "thresholdType": "Actual" } + }, + "timeGrain": "Monthly", + "timePeriod": { + "endDate": "2024-10-31T00:00:00Z", + "startDate": "2023-04-01T00:00:00Z" } } } ] } } - } + }, + "operationId": "Budgets_List", + "title": "EnrollmentAccountBudgetsList-EA" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/Budgets/List/MCA/BillingAccountBudgetsList-MCA-CategoryTypeFilter.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/Budgets/List/MCA/BillingAccountBudgetsList-MCA-CategoryTypeFilter.json index d1d7a289bef0..1426cb98c39a 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/Budgets/List/MCA/BillingAccountBudgetsList-MCA-CategoryTypeFilter.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/Budgets/List/MCA/BillingAccountBudgetsList-MCA-CategoryTypeFilter.json @@ -1,44 +1,46 @@ { "parameters": { + "$filter": "properties/category eq 'ReservationUtilization'", "api-version": "2025-03-01", "billingAccountId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01", - "scope": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01", - "$filter": "properties/category eq 'ReservationUtilization'" + "scope": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01" }, "responses": { "200": { "body": { "value": [ { - "id": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/billingProfiles/KKKK-LLLL-MMM-NNN/providers/Microsoft.CostManagement/budgets/TestRUAlert", "name": "TestRUAlert", "type": "Microsoft.CostManagement/budgets", "eTag": "\"1d34d012214157f\"", + "id": "/providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/billingProfiles/KKKK-LLLL-MMM-NNN/providers/Microsoft.CostManagement/budgets/TestRUAlert", "properties": { "category": "ReservationUtilization", - "timeGrain": "Last30Days", - "timePeriod": { - "startDate": "2023-04-01T00:00:00Z", - "endDate": "2025-04-01T00:00:00Z" - }, "filter": {}, "notifications": { "Actual_LessThan_99_Percent": { - "enabled": true, - "operator": "LessThan", - "threshold": 99, - "frequency": "Daily", - "locale": "en-us", "contactEmails": [ "johndoe@contoso.com", "janesmith@contoso.com" - ] + ], + "enabled": true, + "frequency": "Daily", + "locale": "en-us", + "operator": "LessThan", + "threshold": 99 } + }, + "timeGrain": "Last30Days", + "timePeriod": { + "endDate": "2025-04-01T00:00:00Z", + "startDate": "2023-04-01T00:00:00Z" } } } ] } } - } + }, + "operationId": "Budgets_List", + "title": "BillingAccountBudgetsList-MCA-CategoryTypeFilter" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/Budgets/List/MCA/BillingAccountBudgetsList-MCA.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/Budgets/List/MCA/BillingAccountBudgetsList-MCA.json index e9b3bd4f84c7..cd4ee6effff2 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/Budgets/List/MCA/BillingAccountBudgetsList-MCA.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/Budgets/List/MCA/BillingAccountBudgetsList-MCA.json @@ -9,97 +9,99 @@ "body": { "value": [ { - "id": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/providers/Microsoft.CostManagement/budgets/TestBudget1", "name": "TestBudget1", "type": "Microsoft.CostManagement/budgets", "eTag": "\"1d34d012214157c\"", + "id": "/providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/providers/Microsoft.CostManagement/budgets/TestBudget1", "properties": { + "amount": 10000, "category": "Cost", - "amount": 10000.00, - "timeGrain": "Monthly", - "timePeriod": { - "startDate": "2023-04-01T00:00:00Z", - "endDate": "2024-10-31T00:00:00Z" - }, "currentSpend": { - "amount": 8000.00, + "amount": 8000, "unit": "USD" }, "notifications": { "Actual_GreaterThanOrEqualTo_80_Percent": { - "enabled": true, - "operator": "GreaterThanOrEqualTo", - "threshold": 80, "contactEmails": [ "johndoe@contoso.com", "janesmith@contoso.com" ], + "enabled": true, + "operator": "GreaterThanOrEqualTo", + "threshold": 80, "thresholdType": "Actual" } + }, + "timeGrain": "Monthly", + "timePeriod": { + "endDate": "2024-10-31T00:00:00Z", + "startDate": "2023-04-01T00:00:00Z" } } }, { - "id": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/providers/Microsoft.CostManagement/budgets/TestBudget2", "name": "TestBudget2", "type": "Microsoft.CostManagement/budgets", "eTag": "\"1d34d012214157d\"", + "id": "/providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/providers/Microsoft.CostManagement/budgets/TestBudget2", "properties": { + "amount": 15000, "category": "Cost", - "amount": 15000.00, - "timeGrain": "Monthly", - "timePeriod": { - "startDate": "2023-04-01T00:00:00Z", - "endDate": "2024-10-31T00:00:00Z" - }, "currentSpend": { - "amount": 12000.00, + "amount": 12000, "unit": "USD" }, "notifications": { "Actual_GreaterThanOrEqualTo_70_Percent": { - "enabled": true, - "operator": "GreaterThanOrEqualTo", - "threshold": 70, "contactEmails": [ "johndoe@contoso.com", "janesmith@contoso.com" ], + "enabled": true, + "operator": "GreaterThanOrEqualTo", + "threshold": 70, "thresholdType": "Actual" } + }, + "timeGrain": "Monthly", + "timePeriod": { + "endDate": "2024-10-31T00:00:00Z", + "startDate": "2023-04-01T00:00:00Z" } } }, { - "id": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/billingProfiles/KKKK-LLLL-MMM-NNN/providers/Microsoft.CostManagement/budgets/TestRUAlert", "name": "TestRUAlert", "type": "Microsoft.CostManagement/budgets", "eTag": "\"1d34d012214157f\"", + "id": "/providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/billingProfiles/KKKK-LLLL-MMM-NNN/providers/Microsoft.CostManagement/budgets/TestRUAlert", "properties": { "category": "ReservationUtilization", - "timeGrain": "Last30Days", - "timePeriod": { - "startDate": "2023-04-01T00:00:00Z", - "endDate": "2025-04-01T00:00:00Z" - }, "filter": {}, "notifications": { "Actual_LessThan_99_Percent": { - "enabled": true, - "operator": "LessThan", - "threshold": 99, - "frequency": "Daily", - "locale": "en-us", "contactEmails": [ "johndoe@contoso.com", "janesmith@contoso.com" - ] + ], + "enabled": true, + "frequency": "Daily", + "locale": "en-us", + "operator": "LessThan", + "threshold": 99 } + }, + "timeGrain": "Last30Days", + "timePeriod": { + "endDate": "2025-04-01T00:00:00Z", + "startDate": "2023-04-01T00:00:00Z" } } } ] } } - } + }, + "operationId": "Budgets_List", + "title": "BillingAccountBudgetsList-MCA" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/Budgets/List/MCA/BillingProfileBudgetsList-CategoryTypeFilter.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/Budgets/List/MCA/BillingProfileBudgetsList-CategoryTypeFilter.json index 773f996eadcb..83a789e315ce 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/Budgets/List/MCA/BillingProfileBudgetsList-CategoryTypeFilter.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/Budgets/List/MCA/BillingProfileBudgetsList-CategoryTypeFilter.json @@ -1,55 +1,50 @@ { "parameters": { + "$filter": "properties/category eq 'ReservationUtilization'", "api-version": "2025-03-01", "billingAccountId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01", "billingProfileId": "MYDEVTESTBP", - "scope": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/billingProfiles/MYDEVTESTBP", - "$filter": "properties/category eq 'ReservationUtilization'" + "scope": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/billingProfiles/MYDEVTESTBP" }, "responses": { "200": { "body": { "value": [ { - "id": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/billingProfiles/MYDEVTESTBP/providers/Microsoft.CostManagement/budgets/TestRUAlert1", "name": "TestRUAlert1", "type": "Microsoft.CostManagement/budgets", "eTag": "\"1d34d012214157f\"", + "id": "/providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/billingProfiles/MYDEVTESTBP/providers/Microsoft.CostManagement/budgets/TestRUAlert1", "properties": { "category": "ReservationUtilization", - "timeGrain": "Last30Days", - "timePeriod": { - "startDate": "2023-04-01T00:00:00Z", - "endDate": "2025-04-01T00:00:00Z" - }, "filter": {}, "notifications": { "Actual_LessThan_99_Percent": { - "enabled": true, - "operator": "LessThan", - "threshold": 99, - "frequency": "Daily", - "locale": "en-us", "contactEmails": [ "johndoe@contoso.com", "janesmith@contoso.com" - ] + ], + "enabled": true, + "frequency": "Daily", + "locale": "en-us", + "operator": "LessThan", + "threshold": 99 } + }, + "timeGrain": "Last30Days", + "timePeriod": { + "endDate": "2025-04-01T00:00:00Z", + "startDate": "2023-04-01T00:00:00Z" } } }, { - "id": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/billingProfiles/MYDEVTESTBP/providers/Microsoft.CostManagement/budgets/TestRUAlert2", "name": "TestRUAlert2", "type": "Microsoft.CostManagement/budgets", "eTag": "\"1d34d012214157f\"", + "id": "/providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/billingProfiles/MYDEVTESTBP/providers/Microsoft.CostManagement/budgets/TestRUAlert2", "properties": { "category": "ReservationUtilization", - "timeGrain": "Last7Days", - "timePeriod": { - "startDate": "2023-04-01T00:00:00Z", - "endDate": "2025-04-01T00:00:00Z" - }, "filter": { "dimensions": { "name": "ReservationId", @@ -63,21 +58,28 @@ }, "notifications": { "Actual_LessThan_99_Percent": { - "enabled": true, - "operator": "LessThan", - "threshold": 80, - "frequency": "Daily", - "locale": "en-us", "contactEmails": [ "johndoe@contoso.com", "janesmith@contoso.com" - ] + ], + "enabled": true, + "frequency": "Daily", + "locale": "en-us", + "operator": "LessThan", + "threshold": 80 } + }, + "timeGrain": "Last7Days", + "timePeriod": { + "endDate": "2025-04-01T00:00:00Z", + "startDate": "2023-04-01T00:00:00Z" } } } ] } } - } + }, + "operationId": "Budgets_List", + "title": "BillingProfileBudgetsList-MCA-CategoryTypeFilter" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/Budgets/List/MCA/BillingProfileBudgetsList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/Budgets/List/MCA/BillingProfileBudgetsList.json index ec0e7ab1aa5b..2ca71c58ae07 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/Budgets/List/MCA/BillingProfileBudgetsList.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/Budgets/List/MCA/BillingProfileBudgetsList.json @@ -10,107 +10,102 @@ "body": { "value": [ { - "id": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/billingProfiles/MYDEVTESTBP/providers/Microsoft.CostManagement/budgets/TestBudget1", "name": "TestBudget1", "type": "Microsoft.CostManagement/budgets", "eTag": "\"1d34d012214157c\"", + "id": "/providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/billingProfiles/MYDEVTESTBP/providers/Microsoft.CostManagement/budgets/TestBudget1", "properties": { + "amount": 200, "category": "Cost", - "amount": 200.00, - "timeGrain": "Monthly", - "timePeriod": { - "startDate": "2023-04-01T00:00:00Z", - "endDate": "2024-10-31T00:00:00Z" - }, "currentSpend": { - "amount": 30.00, + "amount": 30, "unit": "USD" }, "notifications": { "Actual_GreaterThanOrEqualTo_80_Percent": { - "enabled": true, - "operator": "GreaterThanOrEqualTo", - "threshold": 80, "contactEmails": [ "johndoe@contoso.com", "janesmith@contoso.com" ], + "enabled": true, + "operator": "GreaterThanOrEqualTo", + "threshold": 80, "thresholdType": "Actual" } + }, + "timeGrain": "Monthly", + "timePeriod": { + "endDate": "2024-10-31T00:00:00Z", + "startDate": "2023-04-01T00:00:00Z" } } }, { - "id": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/billingProfiles/MYDEVTESTBP/providers/Microsoft.CostManagement/budgets/TestBudget2", "name": "TestBudget2", "type": "Microsoft.CostManagement/budgets", "eTag": "\"1d34d012214157d\"", + "id": "/providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/billingProfiles/MYDEVTESTBP/providers/Microsoft.CostManagement/budgets/TestBudget2", "properties": { + "amount": 600, "category": "Cost", - "amount": 600.00, - "timeGrain": "Monthly", - "timePeriod": { - "startDate": "2023-04-01T00:00:00Z", - "endDate": "2024-10-31T00:00:00Z" - }, "currentSpend": { - "amount": 20.00, + "amount": 20, "unit": "USD" }, "notifications": { "Actual_GreaterThanOrEqualTo_70_Percent": { - "enabled": true, - "operator": "GreaterThanOrEqualTo", - "threshold": 70, "contactEmails": [ "johndoe@contoso.com", "janesmith@contoso.com" ], + "enabled": true, + "operator": "GreaterThanOrEqualTo", + "threshold": 70, "thresholdType": "Actual" } + }, + "timeGrain": "Monthly", + "timePeriod": { + "endDate": "2024-10-31T00:00:00Z", + "startDate": "2023-04-01T00:00:00Z" } } }, { - "id": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/billingProfiles/MYDEVTESTBP/providers/Microsoft.CostManagement/budgets/TestRUAlert1", "name": "TestRUAlert1", "type": "Microsoft.CostManagement/budgets", "eTag": "\"1d34d012214157f\"", + "id": "/providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/billingProfiles/MYDEVTESTBP/providers/Microsoft.CostManagement/budgets/TestRUAlert1", "properties": { "category": "ReservationUtilization", - "timeGrain": "Last30Days", - "timePeriod": { - "startDate": "2023-04-01T00:00:00Z", - "endDate": "2025-04-01T00:00:00Z" - }, "filter": {}, "notifications": { "Actual_LessThan_99_Percent": { - "enabled": true, - "operator": "LessThan", - "threshold": 99, - "frequency": "Daily", - "locale": "en-us", "contactEmails": [ "johndoe@contoso.com", "janesmith@contoso.com" - ] + ], + "enabled": true, + "frequency": "Daily", + "locale": "en-us", + "operator": "LessThan", + "threshold": 99 } + }, + "timeGrain": "Last30Days", + "timePeriod": { + "endDate": "2025-04-01T00:00:00Z", + "startDate": "2023-04-01T00:00:00Z" } } }, { - "id": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/billingProfiles/MYDEVTESTBP/providers/Microsoft.CostManagement/budgets/TestRUAlert2", "name": "TestRUAlert2", "type": "Microsoft.CostManagement/budgets", "eTag": "\"1d34d012214157f\"", + "id": "/providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/billingProfiles/MYDEVTESTBP/providers/Microsoft.CostManagement/budgets/TestRUAlert2", "properties": { "category": "ReservationUtilization", - "timeGrain": "Last7Days", - "timePeriod": { - "startDate": "2023-04-01T00:00:00Z", - "endDate": "2025-04-01T00:00:00Z" - }, "filter": { "dimensions": { "name": "ReservationId", @@ -124,21 +119,28 @@ }, "notifications": { "Actual_LessThan_99_Percent": { - "enabled": true, - "operator": "LessThan", - "threshold": 80, - "frequency": "Daily", - "locale": "en-us", "contactEmails": [ "johndoe@contoso.com", "janesmith@contoso.com" - ] + ], + "enabled": true, + "frequency": "Daily", + "locale": "en-us", + "operator": "LessThan", + "threshold": 80 } + }, + "timeGrain": "Last7Days", + "timePeriod": { + "endDate": "2025-04-01T00:00:00Z", + "startDate": "2023-04-01T00:00:00Z" } } } ] } } - } + }, + "operationId": "Budgets_List", + "title": "BillingProfileBudgetsList-MCA" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/Budgets/List/MCA/CustomerBudgetsList-CategoryTypeFilter.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/Budgets/List/MCA/CustomerBudgetsList-CategoryTypeFilter.json index a433ca6d829d..4ff91720b0b7 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/Budgets/List/MCA/CustomerBudgetsList-CategoryTypeFilter.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/Budgets/List/MCA/CustomerBudgetsList-CategoryTypeFilter.json @@ -1,55 +1,50 @@ { "parameters": { + "$filter": "properties/category eq 'ReservationUtilization'", "api-version": "2025-03-01", "billingAccountId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01", "customerId": "000000-1111-2222-3333-444444444444", - "scope": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/customers/000000-1111-2222-3333-444444444444", - "$filter": "properties/category eq 'ReservationUtilization'" + "scope": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/customers/000000-1111-2222-3333-444444444444" }, "responses": { "200": { "body": { "value": [ { - "id": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/customers/000000-1111-2222-3333-444444444444/providers/Microsoft.CostManagement/budgets/TestRUAlert1", "name": "TestRUAlert1", "type": "Microsoft.CostManagement/budgets", "eTag": "\"1d34d012214157f\"", + "id": "/providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/customers/000000-1111-2222-3333-444444444444/providers/Microsoft.CostManagement/budgets/TestRUAlert1", "properties": { "category": "ReservationUtilization", - "timeGrain": "Last30Days", - "timePeriod": { - "startDate": "2023-04-01T00:00:00Z", - "endDate": "2025-04-01T00:00:00Z" - }, "filter": {}, "notifications": { "Actual_LessThan_99_Percent": { - "enabled": true, - "operator": "LessThan", - "threshold": 99, - "frequency": "Daily", - "locale": "en-us", "contactEmails": [ "johndoe@contoso.com", "janesmith@contoso.com" - ] + ], + "enabled": true, + "frequency": "Daily", + "locale": "en-us", + "operator": "LessThan", + "threshold": 99 } + }, + "timeGrain": "Last30Days", + "timePeriod": { + "endDate": "2025-04-01T00:00:00Z", + "startDate": "2023-04-01T00:00:00Z" } } }, { - "id": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/customers/000000-1111-2222-3333-444444444444/providers/Microsoft.CostManagement/budgets/TestRUAlert2", "name": "TestRUAlert2", "type": "Microsoft.CostManagement/budgets", "eTag": "\"1d34d012214157f\"", + "id": "/providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/customers/000000-1111-2222-3333-444444444444/providers/Microsoft.CostManagement/budgets/TestRUAlert2", "properties": { "category": "ReservationUtilization", - "timeGrain": "Last7Days", - "timePeriod": { - "startDate": "2023-04-01T00:00:00Z", - "endDate": "2025-04-01T00:00:00Z" - }, "filter": { "dimensions": { "name": "ReservationId", @@ -63,21 +58,28 @@ }, "notifications": { "Actual_LessThan_99_Percent": { - "enabled": true, - "operator": "LessThan", - "threshold": 80, - "frequency": "Daily", - "locale": "en-us", "contactEmails": [ "johndoe@contoso.com", "janesmith@contoso.com" - ] + ], + "enabled": true, + "frequency": "Daily", + "locale": "en-us", + "operator": "LessThan", + "threshold": 80 } + }, + "timeGrain": "Last7Days", + "timePeriod": { + "endDate": "2025-04-01T00:00:00Z", + "startDate": "2023-04-01T00:00:00Z" } } } ] } } - } + }, + "operationId": "Budgets_List", + "title": "CustomerBudgetsList-MCA-CSP-CategoryTypeFilter" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/Budgets/List/MCA/CustomerBudgetsList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/Budgets/List/MCA/CustomerBudgetsList.json index 1c6a38ab7064..f13f583235b1 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/Budgets/List/MCA/CustomerBudgetsList.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/Budgets/List/MCA/CustomerBudgetsList.json @@ -10,107 +10,102 @@ "body": { "value": [ { - "id": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/customers/000000-1111-2222-3333-444444444444", "name": "TestBudget1", "type": "Microsoft.CostManagement/budgets", "eTag": "\"1d34d012214157c\"", + "id": "/providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/customers/000000-1111-2222-3333-444444444444", "properties": { + "amount": 200, "category": "Cost", - "amount": 200.00, - "timeGrain": "Monthly", - "timePeriod": { - "startDate": "2023-04-01T00:00:00Z", - "endDate": "2024-10-31T00:00:00Z" - }, "currentSpend": { - "amount": 30.00, + "amount": 30, "unit": "USD" }, "notifications": { "Actual_GreaterThanOrEqualTo_80_Percent": { - "enabled": true, - "operator": "GreaterThanOrEqualTo", - "threshold": 80, "contactEmails": [ "johndoe@contoso.com", "janesmith@contoso.com" ], + "enabled": true, + "operator": "GreaterThanOrEqualTo", + "threshold": 80, "thresholdType": "Actual" } + }, + "timeGrain": "Monthly", + "timePeriod": { + "endDate": "2024-10-31T00:00:00Z", + "startDate": "2023-04-01T00:00:00Z" } } }, { - "id": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/customers/000000-1111-2222-3333-444444444444/providers/Microsoft.CostManagement/budgets/TestBudget2", "name": "TestBudget2", "type": "Microsoft.CostManagement/budgets", "eTag": "\"1d34d012214157d\"", + "id": "/providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/customers/000000-1111-2222-3333-444444444444/providers/Microsoft.CostManagement/budgets/TestBudget2", "properties": { + "amount": 600, "category": "Cost", - "amount": 600.00, - "timeGrain": "Monthly", - "timePeriod": { - "startDate": "2023-04-01T00:00:00Z", - "endDate": "2024-10-31T00:00:00Z" - }, "currentSpend": { - "amount": 20.00, + "amount": 20, "unit": "USD" }, "notifications": { "Actual_GreaterThanOrEqualTo_70_Percent": { - "enabled": true, - "operator": "GreaterThanOrEqualTo", - "threshold": 70, "contactEmails": [ "johndoe@contoso.com", "janesmith@contoso.com" ], + "enabled": true, + "operator": "GreaterThanOrEqualTo", + "threshold": 70, "thresholdType": "Actual" } + }, + "timeGrain": "Monthly", + "timePeriod": { + "endDate": "2024-10-31T00:00:00Z", + "startDate": "2023-04-01T00:00:00Z" } } }, { - "id": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/customers/000000-1111-2222-3333-444444444444/providers/Microsoft.CostManagement/budgets/TestRUAlert1", "name": "TestRUAlert1", "type": "Microsoft.CostManagement/budgets", "eTag": "\"1d34d012214157f\"", + "id": "/providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/customers/000000-1111-2222-3333-444444444444/providers/Microsoft.CostManagement/budgets/TestRUAlert1", "properties": { "category": "ReservationUtilization", - "timeGrain": "Last30Days", - "timePeriod": { - "startDate": "2023-04-01T00:00:00Z", - "endDate": "2025-04-01T00:00:00Z" - }, "filter": {}, "notifications": { "Actual_LessThan_99_Percent": { - "enabled": true, - "operator": "LessThan", - "threshold": 99, - "frequency": "Daily", - "locale": "en-us", "contactEmails": [ "johndoe@contoso.com", "janesmith@contoso.com" - ] + ], + "enabled": true, + "frequency": "Daily", + "locale": "en-us", + "operator": "LessThan", + "threshold": 99 } + }, + "timeGrain": "Last30Days", + "timePeriod": { + "endDate": "2025-04-01T00:00:00Z", + "startDate": "2023-04-01T00:00:00Z" } } }, { - "id": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/customers/000000-1111-2222-3333-444444444444/providers/Microsoft.CostManagement/budgets/TestRUAlert2", "name": "TestRUAlert2", "type": "Microsoft.CostManagement/budgets", "eTag": "\"1d34d012214157f\"", + "id": "/providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/customers/000000-1111-2222-3333-444444444444/providers/Microsoft.CostManagement/budgets/TestRUAlert2", "properties": { "category": "ReservationUtilization", - "timeGrain": "Last7Days", - "timePeriod": { - "startDate": "2023-04-01T00:00:00Z", - "endDate": "2025-04-01T00:00:00Z" - }, "filter": { "dimensions": { "name": "ReservationId", @@ -124,21 +119,28 @@ }, "notifications": { "Actual_LessThan_99_Percent": { - "enabled": true, - "operator": "LessThan", - "threshold": 80, - "frequency": "Daily", - "locale": "en-us", "contactEmails": [ "johndoe@contoso.com", "janesmith@contoso.com" - ] + ], + "enabled": true, + "frequency": "Daily", + "locale": "en-us", + "operator": "LessThan", + "threshold": 80 } + }, + "timeGrain": "Last7Days", + "timePeriod": { + "endDate": "2025-04-01T00:00:00Z", + "startDate": "2023-04-01T00:00:00Z" } } } ] } } - } + }, + "operationId": "Budgets_List", + "title": "CustomerBudgetsList-MCA-CSP" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/Budgets/List/MCA/InvoiceSectionBudgetsList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/Budgets/List/MCA/InvoiceSectionBudgetsList.json index e27af5631949..d7faaa20e016 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/Budgets/List/MCA/InvoiceSectionBudgetsList.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/Budgets/List/MCA/InvoiceSectionBudgetsList.json @@ -11,69 +11,71 @@ "body": { "value": [ { - "id": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/billingProfiles/MYDEVTESTBP/invoiceSections/AAAA-BBBB-CCC-DDD/providers/Microsoft.CostManagement/budgets/TestBudget1", "name": "TestBudget1", "type": "Microsoft.CostManagement/budgets", "eTag": "\"1d34d012214157c\"", + "id": "/providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/billingProfiles/MYDEVTESTBP/invoiceSections/AAAA-BBBB-CCC-DDD/providers/Microsoft.CostManagement/budgets/TestBudget1", "properties": { + "amount": 20, "category": "Cost", - "amount": 20.00, - "timeGrain": "Monthly", - "timePeriod": { - "startDate": "2023-04-01T00:00:00Z", - "endDate": "2024-10-31T00:00:00Z" - }, "currentSpend": { - "amount": 5.00, + "amount": 5, "unit": "USD" }, "notifications": { "Actual_GreaterThanOrEqualTo_80_Percent": { - "enabled": true, - "operator": "GreaterThanOrEqualTo", - "threshold": 80, "contactEmails": [ "johndoe@contoso.com", "janesmith@contoso.com" ], + "enabled": true, + "operator": "GreaterThanOrEqualTo", + "threshold": 80, "thresholdType": "Actual" } + }, + "timeGrain": "Monthly", + "timePeriod": { + "endDate": "2024-10-31T00:00:00Z", + "startDate": "2023-04-01T00:00:00Z" } } }, { - "id": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/billingProfiles/MYDEVTESTBP/invoiceSections/AAAA-BBBB-CCC-DDD/providers/Microsoft.CostManagement/budgets/TestBudget2", "name": "TestBudget2", "type": "Microsoft.CostManagement/budgets", "eTag": "\"1d34d012214157d\"", + "id": "/providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/billingProfiles/MYDEVTESTBP/invoiceSections/AAAA-BBBB-CCC-DDD/providers/Microsoft.CostManagement/budgets/TestBudget2", "properties": { + "amount": 60, "category": "Cost", - "amount": 60.00, - "timeGrain": "Monthly", - "timePeriod": { - "startDate": "2023-04-01T00:00:00Z", - "endDate": "2024-10-31T00:00:00Z" - }, "currentSpend": { - "amount": 20.00, + "amount": 20, "unit": "USD" }, "notifications": { "Actual_GreaterThanOrEqualTo_70_Percent": { - "enabled": true, - "operator": "GreaterThanOrEqualTo", - "threshold": 70, "contactEmails": [ "johndoe@contoso.com", "janesmith@contoso.com" ], + "enabled": true, + "operator": "GreaterThanOrEqualTo", + "threshold": 70, "thresholdType": "Actual" } + }, + "timeGrain": "Monthly", + "timePeriod": { + "endDate": "2024-10-31T00:00:00Z", + "startDate": "2023-04-01T00:00:00Z" } } } ] } } - } + }, + "operationId": "Budgets_List", + "title": "InvoiceSectionBudgetsList-MCA" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/Budgets/List/RBAC/ManagementGroupBudgetsList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/Budgets/List/RBAC/ManagementGroupBudgetsList.json index 149554deb3c3..760d08da8d34 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/Budgets/List/RBAC/ManagementGroupBudgetsList.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/Budgets/List/RBAC/ManagementGroupBudgetsList.json @@ -1,95 +1,94 @@ { "parameters": { "api-version": "2025-03-01", - "subscriptionId": "MYDEVTESTMG", - "scope": "Microsoft.Management/managementGroups/MYDEVTESTMG" + "scope": "Microsoft.Management/managementGroups/MYDEVTESTMG", + "subscriptionId": "MYDEVTESTMG" }, "responses": { "200": { "body": { "value": [ { - "id": "Microsoft.Management/managementGroups/MYDEVTESTMG/Microsoft.CostManagement/budgets/TestBudget", "name": "TestBudget", "type": "Microsoft.CostManagement/budgets", "eTag": "\"1d34d012214157f\"", + "id": "/providers/Microsoft.Management/managementGroups/MYDEVTESTMG/providers/Microsoft.CostManagement/budgets/TestBudget", "properties": { + "amount": 10000, "category": "Cost", - "amount": 10000.00, - "timeGrain": "Monthly", - "timePeriod": { - "startDate": "2023-04-01T00:00:00Z", - "endDate": "2024-10-31T00:00:00Z" - }, - "filter": {}, "currentSpend": { "amount": 8000.89, "unit": "USD" }, + "filter": {}, "notifications": { "Actual_GreaterThanOrEqualTo_80_Percent": { - "enabled": true, - "operator": "GreaterThan", - "threshold": 80, "contactEmails": [ "managers@contoso.com" ], + "enabled": true, + "operator": "GreaterThan", + "threshold": 80, "thresholdType": "Actual" } + }, + "timeGrain": "Monthly", + "timePeriod": { + "endDate": "2024-10-31T00:00:00Z", + "startDate": "2023-04-01T00:00:00Z" } } }, { - "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/budgets/TestBudget", "name": "TestBudget", "type": "Microsoft.CostManagement/budgets", "eTag": "\"1d34d012214157f\"", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/budgets/TestBudget", "properties": { - "category": "Cost", "amount": 600.65, - "timeGrain": "Monthly", - "timePeriod": { - "startDate": "2023-04-01T00:00:00Z", - "endDate": "2024-10-31T00:00:00Z" - }, - "filter": {}, + "category": "Cost", "currentSpend": { "amount": 120.89, "unit": "USD" }, + "filter": {}, "notifications": { "Actual_GreaterThanOrEqualTo_60_Percent": { - "enabled": true, - "operator": "GreaterThanOrEqualTo", - "threshold": 60, "contactEmails": [ "johndoe@contoso.com", "janesmith@contoso.com" ], + "contactGroups": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/microsoft.insights/actionGroups/SampleActionGroup" + ], "contactRoles": [ "Contributor", "Reader" ], - "contactGroups": [ - "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/microsoft.insights/actionGroups/SampleActionGroup" - ], + "enabled": true, + "operator": "GreaterThanOrEqualTo", + "threshold": 60, "thresholdType": "Actual" } + }, + "timeGrain": "Monthly", + "timePeriod": { + "endDate": "2024-10-31T00:00:00Z", + "startDate": "2023-04-01T00:00:00Z" } } }, { - "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/budgets/TestBudget", "name": "TestBudget", "type": "Microsoft.CostManagement/budgets", "eTag": "\"1d34d012214157f\"", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/budgets/TestBudget", "properties": { - "category": "Cost", "amount": 100.65, - "timeGrain": "Monthly", - "timePeriod": { - "startDate": "2023-04-01T00:00:00Z", - "endDate": "2024-10-31T00:00:00Z" + "category": "Cost", + "currentSpend": { + "amount": 80.89, + "unit": "USD" }, "filter": { "and": [ @@ -125,28 +124,25 @@ } ] }, - "currentSpend": { - "amount": 80.89, - "unit": "USD" - }, "notifications": { - "Actual_GreaterThan_80_Percent": { - "enabled": true, - "operator": "GreaterThan", - "threshold": 80, + "Actual_GreaterThanOrEqualTo_90_Percent": { "contactEmails": [ "johndoe@contoso.com", "janesmith@contoso.com" ], + "contactGroups": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/microsoft.insights/actionGroups/SampleActionGroup" + ], "contactRoles": [ "Contributor", "Reader" - ] - }, - "Actual_GreaterThanOrEqualTo_90_Percent": { + ], "enabled": true, "operator": "GreaterThanOrEqualTo", "threshold": 90, + "thresholdType": "Actual" + }, + "Actual_GreaterThan_80_Percent": { "contactEmails": [ "johndoe@contoso.com", "janesmith@contoso.com" @@ -155,50 +151,50 @@ "Contributor", "Reader" ], - "contactGroups": [ - "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/microsoft.insights/actionGroups/SampleActionGroup" - ], - "thresholdType": "Actual" + "enabled": true, + "operator": "GreaterThan", + "threshold": 80 } + }, + "timeGrain": "Monthly", + "timePeriod": { + "endDate": "2024-10-31T00:00:00Z", + "startDate": "2023-04-01T00:00:00Z" } } }, { - "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/budgets/TestBudget1", "name": "TestBudget1", "type": "Microsoft.CostManagement/budgets", "eTag": "\"1d34d012214157f\"", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/budgets/TestBudget1", "properties": { - "category": "Cost", "amount": 200.65, - "timeGrain": "Monthly", - "timePeriod": { - "startDate": "2023-04-01T00:00:00Z", - "endDate": "2024-10-31T00:00:00Z" - }, - "filter": {}, + "category": "Cost", "currentSpend": { "amount": 120.89, "unit": "USD" }, + "filter": {}, "notifications": { - "Actual_GreaterThan_40_Percent": { - "enabled": true, - "operator": "GreaterThan", - "threshold": 40, + "Actual_GreaterThanOrEqualTo_60_Percent": { "contactEmails": [ "johndoe@contoso.com", "janesmith@contoso.com" ], + "contactGroups": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/microsoft.insights/actionGroups/SampleActionGroup" + ], "contactRoles": [ "Contributor", "Reader" - ] - }, - "Actual_GreaterThanOrEqualTo_60_Percent": { + ], "enabled": true, "operator": "GreaterThanOrEqualTo", "threshold": 60, + "thresholdType": "Actual" + }, + "Actual_GreaterThan_40_Percent": { "contactEmails": [ "johndoe@contoso.com", "janesmith@contoso.com" @@ -207,16 +203,22 @@ "Contributor", "Reader" ], - "contactGroups": [ - "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/microsoft.insights/actionGroups/SampleActionGroup" - ], - "thresholdType": "Actual" + "enabled": true, + "operator": "GreaterThan", + "threshold": 40 } + }, + "timeGrain": "Monthly", + "timePeriod": { + "endDate": "2024-10-31T00:00:00Z", + "startDate": "2023-04-01T00:00:00Z" } } } ] } } - } + }, + "operationId": "Budgets_List", + "title": "ManagementGroupBudgetsList" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/Budgets/List/RBAC/ResourceGroupBudgetsList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/Budgets/List/RBAC/ResourceGroupBudgetsList.json index 43113a42edc8..93661c384e36 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/Budgets/List/RBAC/ResourceGroupBudgetsList.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/Budgets/List/RBAC/ResourceGroupBudgetsList.json @@ -1,26 +1,25 @@ { "parameters": { "api-version": "2025-03-01", - "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MYDEVTESTRG", "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG", - "resourceGroupName": "MYDEVTESTRG" + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { "value": [ { - "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/budgets/TestBudget0", "name": "TestBudget0", "type": "Microsoft.CostManagement/budgets", "eTag": "\"1d34d012214157f\"", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/budgets/TestBudget0", "properties": { - "category": "Cost", "amount": 100.65, - "timeGrain": "Monthly", - "timePeriod": { - "startDate": "2023-04-01T00:00:00Z", - "endDate": "2024-10-31T00:00:00Z" + "category": "Cost", + "currentSpend": { + "amount": 80.89, + "unit": "USD" }, "filter": { "and": [ @@ -56,28 +55,25 @@ } ] }, - "currentSpend": { - "amount": 80.89, - "unit": "USD" - }, "notifications": { - "Actual_GreaterThan_80_Percent": { - "enabled": true, - "operator": "GreaterThan", - "threshold": 80, + "Actual_GreaterThanOrEqualTo_90_Percent": { "contactEmails": [ "johndoe@contoso.com", "janesmith@contoso.com" ], + "contactGroups": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/microsoft.insights/actionGroups/SampleActionGroup" + ], "contactRoles": [ "Contributor", "Reader" - ] - }, - "Actual_GreaterThanOrEqualTo_90_Percent": { + ], "enabled": true, "operator": "GreaterThanOrEqualTo", "threshold": 90, + "thresholdType": "Actual" + }, + "Actual_GreaterThan_80_Percent": { "contactEmails": [ "johndoe@contoso.com", "janesmith@contoso.com" @@ -86,50 +82,50 @@ "Contributor", "Reader" ], - "contactGroups": [ - "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/microsoft.insights/actionGroups/SampleActionGroup" - ], - "thresholdType": "Actual" + "enabled": true, + "operator": "GreaterThan", + "threshold": 80 } + }, + "timeGrain": "Monthly", + "timePeriod": { + "endDate": "2024-10-31T00:00:00Z", + "startDate": "2023-04-01T00:00:00Z" } } }, { - "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/budgets/TestBudget1", "name": "TestBudget1", "type": "Microsoft.CostManagement/budgets", "eTag": "\"1d34d012214157f\"", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/budgets/TestBudget1", "properties": { - "category": "Cost", "amount": 200.65, - "timeGrain": "Monthly", - "timePeriod": { - "startDate": "2023-04-01T00:00:00Z", - "endDate": "2024-10-31T00:00:00Z" - }, - "filter": {}, + "category": "Cost", "currentSpend": { "amount": 120.89, "unit": "USD" }, + "filter": {}, "notifications": { - "Actual_GreaterThan_40_Percent": { - "enabled": true, - "operator": "GreaterThan", - "threshold": 40, + "Actual_GreaterThanOrEqualTo_60_Percent": { "contactEmails": [ "johndoe@contoso.com", "janesmith@contoso.com" ], + "contactGroups": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/microsoft.insights/actionGroups/SampleActionGroup" + ], "contactRoles": [ "Contributor", "Reader" - ] - }, - "Actual_GreaterThanOrEqualTo_60_Percent": { + ], "enabled": true, "operator": "GreaterThanOrEqualTo", "threshold": 60, + "thresholdType": "Actual" + }, + "Actual_GreaterThan_40_Percent": { "contactEmails": [ "johndoe@contoso.com", "janesmith@contoso.com" @@ -138,16 +134,22 @@ "Contributor", "Reader" ], - "contactGroups": [ - "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/microsoft.insights/actionGroups/SampleActionGroup" - ], - "thresholdType": "Actual" + "enabled": true, + "operator": "GreaterThan", + "threshold": 40 } + }, + "timeGrain": "Monthly", + "timePeriod": { + "endDate": "2024-10-31T00:00:00Z", + "startDate": "2023-04-01T00:00:00Z" } } } ] } } - } + }, + "operationId": "Budgets_List", + "title": "ResourceGroupBudgetsList" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/Budgets/List/RBAC/SubscriptionBudgetsList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/Budgets/List/RBAC/SubscriptionBudgetsList.json index d217386cb34a..fd4b7da4b177 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/Budgets/List/RBAC/SubscriptionBudgetsList.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/Budgets/List/RBAC/SubscriptionBudgetsList.json @@ -1,64 +1,63 @@ { "parameters": { "api-version": "2025-03-01", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "scope": "subscriptions/00000000-0000-0000-0000-000000000000" + "scope": "subscriptions/00000000-0000-0000-0000-000000000000", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { "value": [ { - "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/budgets/TestBudget", "name": "TestBudget", "type": "Microsoft.CostManagement/budgets", "eTag": "\"1d34d012214157f\"", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/budgets/TestBudget", "properties": { - "category": "Cost", "amount": 600.65, - "timeGrain": "Monthly", - "timePeriod": { - "startDate": "2023-04-01T00:00:00Z", - "endDate": "2024-10-31T00:00:00Z" - }, - "filter": {}, + "category": "Cost", "currentSpend": { "amount": 120.89, "unit": "USD" }, + "filter": {}, "notifications": { "Actual_GreaterThanOrEqualTo_60_Percent": { - "enabled": true, - "operator": "GreaterThanOrEqualTo", - "threshold": 60, "contactEmails": [ "johndoe@contoso.com", "janesmith@contoso.com" ], + "contactGroups": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/microsoft.insights/actionGroups/SampleActionGroup" + ], "contactRoles": [ "Contributor", "Reader" ], - "contactGroups": [ - "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/microsoft.insights/actionGroups/SampleActionGroup" - ], + "enabled": true, + "operator": "GreaterThanOrEqualTo", + "threshold": 60, "thresholdType": "Actual" } + }, + "timeGrain": "Monthly", + "timePeriod": { + "endDate": "2024-10-31T00:00:00Z", + "startDate": "2023-04-01T00:00:00Z" } } }, { - "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/budgets/TestBudget", "name": "TestBudget", "type": "Microsoft.CostManagement/budgets", "eTag": "\"1d34d012214157f\"", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/budgets/TestBudget", "properties": { - "category": "Cost", "amount": 100.65, - "timeGrain": "Monthly", - "timePeriod": { - "startDate": "2023-04-01T00:00:00Z", - "endDate": "2024-10-31T00:00:00Z" + "category": "Cost", + "currentSpend": { + "amount": 80.89, + "unit": "USD" }, "filter": { "and": [ @@ -94,28 +93,25 @@ } ] }, - "currentSpend": { - "amount": 80.89, - "unit": "USD" - }, "notifications": { - "Actual_GreaterThan_80_Percent": { - "enabled": true, - "operator": "GreaterThan", - "threshold": 80, + "Actual_GreaterThanOrEqualTo_90_Percent": { "contactEmails": [ "johndoe@contoso.com", "janesmith@contoso.com" ], + "contactGroups": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/microsoft.insights/actionGroups/SampleActionGroup" + ], "contactRoles": [ "Contributor", "Reader" - ] - }, - "Actual_GreaterThanOrEqualTo_90_Percent": { + ], "enabled": true, "operator": "GreaterThanOrEqualTo", "threshold": 90, + "thresholdType": "Actual" + }, + "Actual_GreaterThan_80_Percent": { "contactEmails": [ "johndoe@contoso.com", "janesmith@contoso.com" @@ -124,50 +120,50 @@ "Contributor", "Reader" ], - "contactGroups": [ - "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/microsoft.insights/actionGroups/SampleActionGroup" - ], - "thresholdType": "Actual" + "enabled": true, + "operator": "GreaterThan", + "threshold": 80 } + }, + "timeGrain": "Monthly", + "timePeriod": { + "endDate": "2024-10-31T00:00:00Z", + "startDate": "2023-04-01T00:00:00Z" } } }, { - "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/budgets/TestBudget1", "name": "TestBudget1", "type": "Microsoft.CostManagement/budgets", "eTag": "\"1d34d012214157f\"", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/budgets/TestBudget1", "properties": { - "category": "Cost", "amount": 200.65, - "timeGrain": "Monthly", - "timePeriod": { - "startDate": "2023-04-01T00:00:00Z", - "endDate": "2024-10-31T00:00:00Z" - }, - "filter": {}, + "category": "Cost", "currentSpend": { "amount": 120.89, "unit": "USD" }, + "filter": {}, "notifications": { - "Actual_GreaterThan_40_Percent": { - "enabled": true, - "operator": "GreaterThan", - "threshold": 40, + "Actual_GreaterThanOrEqualTo_60_Percent": { "contactEmails": [ "johndoe@contoso.com", "janesmith@contoso.com" ], + "contactGroups": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/microsoft.insights/actionGroups/SampleActionGroup" + ], "contactRoles": [ "Contributor", "Reader" - ] - }, - "Actual_GreaterThanOrEqualTo_60_Percent": { + ], "enabled": true, "operator": "GreaterThanOrEqualTo", "threshold": 60, + "thresholdType": "Actual" + }, + "Actual_GreaterThan_40_Percent": { "contactEmails": [ "johndoe@contoso.com", "janesmith@contoso.com" @@ -176,16 +172,22 @@ "Contributor", "Reader" ], - "contactGroups": [ - "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/microsoft.insights/actionGroups/SampleActionGroup" - ], - "thresholdType": "Actual" + "enabled": true, + "operator": "GreaterThan", + "threshold": 40 } + }, + "timeGrain": "Monthly", + "timePeriod": { + "endDate": "2024-10-31T00:00:00Z", + "startDate": "2023-04-01T00:00:00Z" } } } ] } } - } + }, + "operationId": "Budgets_List", + "title": "SubscriptionBudgetsList" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/CostAllocationRuleCheckNameAvailability.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/CostAllocationRuleCheckNameAvailability.json index 2638ab84ab0c..72cf6baa94e1 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/CostAllocationRuleCheckNameAvailability.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/CostAllocationRuleCheckNameAvailability.json @@ -10,10 +10,12 @@ "responses": { "200": { "body": { + "message": "A cost allocation rule with name testRule is already present for the billing account 100. Please specify a differnt name.", "nameAvailable": false, - "reason": "AlreadyExists", - "message": "A cost allocation rule with name testRule is already present for the billing account 100. Please specify a differnt name." + "reason": "AlreadyExists" } } - } + }, + "operationId": "CostAllocationRules_CheckNameAvailability", + "title": "CostAllocationRuleCheckNameAvailability" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/CostAllocationRuleCreate.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/CostAllocationRuleCreate.json index a89c1b24e0ae..aa2e7e9e4964 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/CostAllocationRuleCreate.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/CostAllocationRuleCreate.json @@ -2,7 +2,6 @@ "parameters": { "api-version": "2025-03-01", "billingAccountId": "100", - "ruleName": "testRule", "costAllocationRule": { "properties": { "description": "This is a testRule", @@ -10,8 +9,8 @@ "details": { "sourceResources": [ { - "resourceType": "Dimension", "name": "ResourceGroupName", + "resourceType": "Dimension", "values": [ "sampleRG", "secondRG" @@ -20,9 +19,9 @@ ], "targetResources": [ { - "resourceType": "Dimension", - "policyType": "FixedProportion", "name": "ResourceGroupName", + "policyType": "FixedProportion", + "resourceType": "Dimension", "values": [ { "name": "destinationRG", @@ -37,24 +36,25 @@ ] } } - } + }, + "ruleName": "testRule" }, "responses": { "200": { "body": { - "id": "providers/Microsoft.Billing/billingAccounts/100/providers/Microsoft.CostManagement/costAllocationRules/testRule", "name": "testRule", "type": "Microsoft.CostManagement/costAllocationRules", + "id": "/providers/Microsoft.Billing/billingAccounts/100/providers/Microsoft.CostManagement/costAllocationRules/testRule", "properties": { "description": "This is a testRule", "createdDate": "2020-06-18T22:21:51.1287144Z", - "updatedDate": "2020-06-18T22:21:51.1287144Z", "status": "Creating", + "updatedDate": "2020-06-18T22:21:51.1287144Z", "details": { "sourceResources": [ { - "resourceType": "Dimension", "name": "ResourceGroupName", + "resourceType": "Dimension", "values": [ "sampleRG" ] @@ -62,9 +62,9 @@ ], "targetResources": [ { - "resourceType": "Dimension", - "policyType": "FixedProportion", "name": "ResourceGroupName", + "policyType": "FixedProportion", + "resourceType": "Dimension", "values": [ { "name": "destinationRG", @@ -83,19 +83,19 @@ }, "201": { "body": { - "id": "providers/Microsoft.Billing/billingAccounts/100/providers/Microsoft.CostManagement/costAllocationRules/testRule", "name": "testRule", "type": "Microsoft.CostManagement/costAllocationRules", + "id": "/providers/Microsoft.Billing/billingAccounts/100/providers/Microsoft.CostManagement/costAllocationRules/testRule", "properties": { "description": "This is a testRule", "createdDate": "2020-06-18T22:21:51.1287144Z", - "updatedDate": "2020-06-18T22:21:51.1287144Z", "status": "Creating", + "updatedDate": "2020-06-18T22:21:51.1287144Z", "details": { "sourceResources": [ { - "resourceType": "Dimension", "name": "ResourceGroupName", + "resourceType": "Dimension", "values": [ "sampleRG" ] @@ -103,9 +103,9 @@ ], "targetResources": [ { - "resourceType": "Dimension", - "policyType": "FixedProportion", "name": "ResourceGroupName", + "policyType": "FixedProportion", + "resourceType": "Dimension", "values": [ { "name": "destinationRG", @@ -122,5 +122,7 @@ } } } - } + }, + "operationId": "CostAllocationRules_CreateOrUpdate", + "title": "CostAllocationRulesCreateResourceGroup" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/CostAllocationRuleCreateTag.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/CostAllocationRuleCreateTag.json index 28f6e1d04ca4..1316efffee8f 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/CostAllocationRuleCreateTag.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/CostAllocationRuleCreateTag.json @@ -2,7 +2,6 @@ "parameters": { "api-version": "2025-03-01", "billingAccountId": "100", - "ruleName": "testRule", "costAllocationRule": { "properties": { "description": "This is a testRule", @@ -10,8 +9,8 @@ "details": { "sourceResources": [ { - "resourceType": "Tag", "name": "category", + "resourceType": "Tag", "values": [ "devops" ] @@ -19,9 +18,9 @@ ], "targetResources": [ { - "resourceType": "Dimension", - "policyType": "FixedProportion", "name": "ResourceGroupName", + "policyType": "FixedProportion", + "resourceType": "Dimension", "values": [ { "name": "destinationRG", @@ -40,24 +39,25 @@ ] } } - } + }, + "ruleName": "testRule" }, "responses": { "200": { "body": { - "id": "providers/Microsoft.Billing/billingAccounts/100/providers/Microsoft.CostManagement/costAllocationRules/testRule", "name": "testRule", "type": "Microsoft.CostManagement/costAllocationRules", + "id": "/providers/Microsoft.Billing/billingAccounts/100/providers/Microsoft.CostManagement/costAllocationRules/testRule", "properties": { "description": "This is a testRule", "createdDate": "2020-06-18T22:21:51.1287144Z", - "updatedDate": "2020-06-18T22:21:51.1287144Z", "status": "Creating", + "updatedDate": "2020-06-18T22:21:51.1287144Z", "details": { "sourceResources": [ { - "resourceType": "Dimension", "name": "ResourceGroupName", + "resourceType": "Dimension", "values": [ "sampleRG" ] @@ -65,9 +65,9 @@ ], "targetResources": [ { - "resourceType": "Dimension", - "policyType": "FixedProportion", "name": "ResourceGroupName", + "policyType": "FixedProportion", + "resourceType": "Dimension", "values": [ { "name": "destinationRG", @@ -86,19 +86,19 @@ }, "201": { "body": { - "id": "providers/Microsoft.Billing/billingAccounts/100/providers/Microsoft.CostManagement/costAllocationRules/testRule", "name": "testRule", "type": "Microsoft.CostManagement/costAllocationRules", + "id": "/providers/Microsoft.Billing/billingAccounts/100/providers/Microsoft.CostManagement/costAllocationRules/testRule", "properties": { "description": "This is a testRule", "createdDate": "2020-06-18T22:21:51.1287144Z", - "updatedDate": "2020-06-18T22:21:51.1287144Z", "status": "Creating", + "updatedDate": "2020-06-18T22:21:51.1287144Z", "details": { "sourceResources": [ { - "resourceType": "Dimension", "name": "ResourceGroupName", + "resourceType": "Dimension", "values": [ "sampleRG" ] @@ -106,9 +106,9 @@ ], "targetResources": [ { - "resourceType": "Dimension", - "policyType": "FixedProportion", "name": "ResourceGroupName", + "policyType": "FixedProportion", + "resourceType": "Dimension", "values": [ { "name": "destinationRG", @@ -125,5 +125,7 @@ } } } - } + }, + "operationId": "CostAllocationRules_CreateOrUpdate", + "title": "CostAllocationRulesCreateTag" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/CostAllocationRuleDelete.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/CostAllocationRuleDelete.json index 37d842305c2d..cf56e0154c3e 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/CostAllocationRuleDelete.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/CostAllocationRuleDelete.json @@ -7,5 +7,7 @@ "responses": { "200": {}, "204": {} - } + }, + "operationId": "CostAllocationRules_Delete", + "title": "DeleteCostAllocationRule" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/CostAllocationRuleGet.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/CostAllocationRuleGet.json index d5a3dca8a92f..6b606e4e630f 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/CostAllocationRuleGet.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/CostAllocationRuleGet.json @@ -7,19 +7,19 @@ "responses": { "200": { "body": { - "id": "providers/Microsoft.Billing/billingAccounts/100/providers/Microsoft.CostManagement/costAllocationRules/testRule", "name": "testRule", "type": "Microsoft.CostManagement/costAllocationRules", + "id": "/providers/Microsoft.Billing/billingAccounts/100/providers/Microsoft.CostManagement/costAllocationRules/testRule", "properties": { "description": "This is a testRule", "createdDate": "2020-06-18T22:21:51.1287144Z", - "updatedDate": "2020-06-18T22:21:51.1287144Z", "status": "NotActive", + "updatedDate": "2020-06-18T22:21:51.1287144Z", "details": { "sourceResources": [ { - "resourceType": "Dimension", "name": "ResourceGroupName", + "resourceType": "Dimension", "values": [ "sampleRG" ] @@ -27,9 +27,9 @@ ], "targetResources": [ { - "resourceType": "Dimension", - "policyType": "FixedProportion", "name": "ResourceGroupName", + "policyType": "FixedProportion", + "resourceType": "Dimension", "values": [ { "name": "destinationRG", @@ -46,5 +46,7 @@ } } } - } + }, + "operationId": "CostAllocationRules_Get", + "title": "CostAllocationRules" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/CostAllocationRulesList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/CostAllocationRulesList.json index 01585c18df71..1b299794ca3a 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/CostAllocationRulesList.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/CostAllocationRulesList.json @@ -6,21 +6,22 @@ "responses": { "200": { "body": { + "nextLink": null, "value": [ { - "id": "providers/Microsoft.Billing/billingAccounts/100/providers/Microsoft.CostManagement/costAllocationRules/testRule", "name": "testRule", "type": "Microsoft.CostManagement/costAllocationRules", + "id": "/providers/Microsoft.Billing/billingAccounts/100/providers/Microsoft.CostManagement/costAllocationRules/testRule", "properties": { "description": "This is a testRule", "createdDate": "2020-06-18T22:21:51.1287144Z", - "updatedDate": "2020-06-18T22:21:51.1287144Z", "status": "NotActive", + "updatedDate": "2020-06-18T22:21:51.1287144Z", "details": { "sourceResources": [ { - "resourceType": "Dimension", "name": "ResourceGroupName", + "resourceType": "Dimension", "values": [ "sampleRG" ] @@ -28,9 +29,9 @@ ], "targetResources": [ { - "resourceType": "Dimension", - "policyType": "FixedProportion", "name": "ResourceGroupName", + "policyType": "FixedProportion", + "resourceType": "Dimension", "values": [ { "name": "destinationRG", @@ -47,19 +48,19 @@ } }, { - "id": "providers/Microsoft.Billing/billingAccounts/100/providers/Microsoft.CostManagement/costAllocationRules/testRule2", "name": "testRule2", "type": "Microsoft.CostManagement/costAllocationRules", + "id": "/providers/Microsoft.Billing/billingAccounts/100/providers/Microsoft.CostManagement/costAllocationRules/testRule2", "properties": { "description": "This is a second test Rule", "createdDate": "2020-06-18T22:21:51.1287144Z", - "updatedDate": "2020-06-18T22:21:51.1287144Z", "status": "Active", + "updatedDate": "2020-06-18T22:21:51.1287144Z", "details": { "sourceResources": [ { - "resourceType": "Dimension", "name": "SubscriptionId", + "resourceType": "Dimension", "values": [ "2A002F2D-536F-4D7C-90DA-3D0BAE879B0E" ] @@ -67,9 +68,9 @@ ], "targetResources": [ { - "resourceType": "Tag", - "policyType": "FixedProportion", "name": "category", + "policyType": "FixedProportion", + "resourceType": "Tag", "values": [ { "name": "devops", @@ -82,19 +83,19 @@ } }, { - "id": "providers/Microsoft.Billing/billingAccounts/100/providers/Microsoft.CostManagement/costAllocationRules/testRule3", "name": "testRule3", "type": "Microsoft.CostManagement/costAllocationRules", + "id": "/providers/Microsoft.Billing/billingAccounts/100/providers/Microsoft.CostManagement/costAllocationRules/testRule3", "properties": { "description": "This is a third test Rule", "createdDate": "2020-06-18T22:21:51.1287144Z", - "updatedDate": "2020-06-18T22:21:51.1287144Z", "status": "Active", + "updatedDate": "2020-06-18T22:21:51.1287144Z", "details": { "sourceResources": [ { - "resourceType": "Tag", "name": "category", + "resourceType": "Tag", "values": [ "devops" ] @@ -102,9 +103,9 @@ ], "targetResources": [ { - "resourceType": "Dimension", - "policyType": "FixedProportion", "name": "ResourceGroupName", + "policyType": "FixedProportion", + "resourceType": "Dimension", "values": [ { "name": "ResourceGroup", @@ -120,9 +121,10 @@ } } } - ], - "nextLink": null + ] } } - } + }, + "operationId": "CostAllocationRules_List", + "title": "CostAllocationRulesList" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/CostDetailsOperationResultsBySubscriptionScope.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/CostDetailsOperationResultsBySubscriptionScope.json index eeb05d188332..04cecf827f37 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/CostDetailsOperationResultsBySubscriptionScope.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/CostDetailsOperationResultsBySubscriptionScope.json @@ -1,38 +1,38 @@ { "parameters": { - "api-version": "2025-03-01", "operationId": "00000000-0000-0000-0000-000000000000", + "api-version": "2025-03-01", "scope": "subscriptions/00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { - "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000", "name": "00000000-0000-0000-0000-000000000000", - "status": "Completed", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000", "manifest": { - "manifestVersion": "2025-03-01", - "dataFormat": "Csv", "blobCount": 1, + "blobs": [ + { + "blobLink": "https://ccmreportstorageeastus.blob.core.windows.net/armreports/00000/00000000-0000-0000-0000-000000000000?sv=2020-05-31&sr=b&sig=abcd", + "byteCount": 32741 + } + ], "byteCount": 32741, "compressData": false, + "dataFormat": "Csv", + "manifestVersion": "2025-03-01", "requestContext": { - "requestScope": "subscriptions/00000000-0000-0000-0000-000000000000", "requestBody": { "metric": "ActualCost", "timePeriod": { - "start": "2020-03-01", - "end": "2020-03-15" + "end": "2020-03-15", + "start": "2020-03-01" } - } - }, - "blobs": [ - { - "blobLink": "https://ccmreportstorageeastus.blob.core.windows.net/armreports/00000/00000000-0000-0000-0000-000000000000?sv=2020-05-31&sr=b&sig=abcd", - "byteCount": 32741 - } - ] + }, + "requestScope": "subscriptions/00000000-0000-0000-0000-000000000000" + } }, + "status": "Completed", "validTill": "2022-05-10T08:08:46.1973252Z" } }, @@ -42,5 +42,7 @@ "Retry-After": "60" } } - } + }, + "operationId": "GenerateCostDetailsReport_GetOperationResults", + "title": "Get details of the operation result" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/DepartmentAlerts.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/DepartmentAlerts.json index a17c90b53b85..246208304420 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/DepartmentAlerts.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/DepartmentAlerts.json @@ -8,92 +8,94 @@ "responses": { "200": { "body": { + "nextLink": null, "value": [ { - "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/departments/123/providers/Microsoft.CostManagement/alerts/00000000-0000-0000-0000-000000000000", "name": "00000000-0000-0000-0000-000000000000", "type": "Microsoft.CostManagement/alerts", + "id": "/providers/Microsoft.Billing/billingAccounts/12345:6789/departments/123/providers/Microsoft.CostManagement/alerts/00000000-0000-0000-0000-000000000000", "properties": { + "description": "", + "closeTime": "0001-01-01T00:00:00", + "costEntityId": "budget1", + "creationTime": "2020-04-27T11:07:52.7143901Z", "definition": { "type": "Budget", "category": "Cost", "criteria": "CostThresholdExceeded" }, - "description": "", + "modificationTime": "2020-04-28T11:06:02.8999373Z", "source": "Preset", + "status": "Active", + "statusModificationTime": "0001-01-01T00:00:00", + "statusModificationUserName": null, "details": { - "timeGrainType": "Quarterly", - "periodStartDate": "2020-03-01T00:00:00Z", - "triggeredBy": "00000000-0000-0000-0000-000000000000_1_01", - "resourceGroupFilter": [], - "resourceFilter": [], - "meterFilter": [], - "tagFilter": {}, - "threshold": 0.8, - "operator": "GreaterThan", - "amount": 200000.0, - "unit": "USD", - "currentSpend": 161000.12, + "amount": 200000, "contactEmails": [ "1234@contoso.com" ], "contactGroups": [], "contactRoles": [], - "overridingAlert": null - }, - "costEntityId": "budget1", - "status": "Active", - "creationTime": "2020-04-27T11:07:52.7143901Z", - "closeTime": "0001-01-01T00:00:00", - "modificationTime": "2020-04-28T11:06:02.8999373Z", - "statusModificationUserName": null, - "statusModificationTime": "0001-01-01T00:00:00" + "currentSpend": 161000.12, + "meterFilter": [], + "operator": "GreaterThan", + "overridingAlert": null, + "periodStartDate": "2020-03-01T00:00:00Z", + "resourceFilter": [], + "resourceGroupFilter": [], + "tagFilter": {}, + "threshold": 0.8, + "timeGrainType": "Quarterly", + "triggeredBy": "00000000-0000-0000-0000-000000000000_1_01", + "unit": "USD" + } } }, { - "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/departments/123/providers/Microsoft.CostManagement/alerts/11111111-1111-1111-111111111111", "name": "11111111-1111-1111-111111111111", "type": "Microsoft.CostManagement/alerts", + "id": "/providers/Microsoft.Billing/billingAccounts/12345:6789/departments/123/providers/Microsoft.CostManagement/alerts/11111111-1111-1111-111111111111", "properties": { + "description": "", + "closeTime": "0001-01-01T00:00:00", + "costEntityId": "budget1", + "creationTime": "2019-06-24T05:51:52.8713179Z", "definition": { "type": "Budget", "category": "Cost", "criteria": "CostThresholdExceeded" }, - "description": "", + "modificationTime": "2019-08-31T17:51:55.1808807Z", "source": "Preset", + "status": "Active", + "statusModificationTime": "0001-01-01T00:00:00", + "statusModificationUserName": null, "details": { - "timeGrainType": "Quarterly", - "periodStartDate": "2020-03-01T00:00:00Z", - "triggeredBy": "11111111-1111-1111-111111111111_1_01", - "resourceGroupFilter": [], - "resourceFilter": [], - "meterFilter": [], - "tagFilter": {}, - "threshold": 0.8, - "operator": "GreaterThan", - "amount": 200000.0, - "unit": "USD", - "currentSpend": 171000.32, + "amount": 200000, "contactEmails": [ "1234@contoso.com" ], "contactGroups": [], "contactRoles": [], - "overridingAlert": null - }, - "costEntityId": "budget1", - "status": "Active", - "creationTime": "2019-06-24T05:51:52.8713179Z", - "closeTime": "0001-01-01T00:00:00", - "modificationTime": "2019-08-31T17:51:55.1808807Z", - "statusModificationUserName": null, - "statusModificationTime": "0001-01-01T00:00:00" + "currentSpend": 171000.32, + "meterFilter": [], + "operator": "GreaterThan", + "overridingAlert": null, + "periodStartDate": "2020-03-01T00:00:00Z", + "resourceFilter": [], + "resourceGroupFilter": [], + "tagFilter": {}, + "threshold": 0.8, + "timeGrainType": "Quarterly", + "triggeredBy": "11111111-1111-1111-111111111111_1_01", + "unit": "USD" + } } } - ], - "nextLink": null + ] } } - } + }, + "operationId": "Alerts_List", + "title": "DepartmentAlerts" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/DepartmentDimensionsList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/DepartmentDimensionsList.json index fcbda3fc55be..8d7a11eb6a70 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/DepartmentDimensionsList.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/DepartmentDimensionsList.json @@ -10,10 +10,12 @@ "body": { "value": [ { - "id": "providers/Microsoft.Billing/billingAccounts/100/departments/123/providers/microsoft.CostManagement/dimensions_ResourceGroup_2018-05-01_2018-05-31", "name": "dimensions_ResourceGroup_2018-05-01_2018-05-31", "type": "microsoft.CostManagement/dimensions", + "id": "/providers/Microsoft.Billing/billingAccounts/100/departments/123/providers/microsoft.CostManagement/dimensions_ResourceGroup_2018-05-01_2018-05-31", "properties": { + "description": "Resource group", + "category": "ResourceGroup", "data": [ "thoroetrg01", "default-notificationhubs-westus", @@ -21,20 +23,20 @@ "contosocodeflow8d4a", "noobaa" ], + "filterEnabled": true, + "groupingEnabled": true, "total": 377, - "category": "ResourceGroup", - "usageStart": "2018-05-01T00:00:00-07:00", "usageEnd": "2018-05-31T00:00:00-07:00", - "description": "Resource group", - "filterEnabled": true, - "groupingEnabled": true + "usageStart": "2018-05-01T00:00:00-07:00" } }, { - "id": "providers/Microsoft.Billing/billingAccounts/100/departments/123/providers/microsoft.CostManagement/dimensions_ResourceType_2018-05-01_2018-05-31", "name": "dimensions_ResourceType_2018-05-01_2018-05-31", "type": "microsoft.CostManagement/dimensions", + "id": "/providers/Microsoft.Billing/billingAccounts/100/departments/123/providers/microsoft.CostManagement/dimensions_ResourceType_2018-05-01_2018-05-31", "properties": { + "description": "Resource type", + "category": "ResourceType", "data": [ "thoroetrg01", "default-notificationhubs-westus", @@ -42,18 +44,18 @@ "contosocodeflow8d4a", "noobaa" ], + "filterEnabled": true, + "groupingEnabled": true, "total": 37, - "category": "ResourceType", - "usageStart": "2018-05-01T00:00:00-07:00", "usageEnd": "2018-05-31T00:00:00-07:00", - "description": "Resource type", - "filterEnabled": true, - "groupingEnabled": true + "usageStart": "2018-05-01T00:00:00-07:00" } } ] } }, "204": {} - } + }, + "operationId": "Dimensions_List", + "title": "DepartmentDimensionsList-Legacy" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/DepartmentDimensionsListExpandAndTop.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/DepartmentDimensionsListExpandAndTop.json index a2cf29ce6e81..57550a666d2c 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/DepartmentDimensionsListExpandAndTop.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/DepartmentDimensionsListExpandAndTop.json @@ -1,10 +1,10 @@ { "parameters": { + "$expand": "properties/data", + "$top": 5, "api-version": "2025-03-01", "billingAccountId": "100", "departmentId": "123", - "$expand": "properties/data", - "$top": 5, "scope": "providers/Microsoft.Billing/billingAccounts/100/departments/123" }, "responses": { @@ -12,10 +12,12 @@ "body": { "value": [ { - "id": "providers/Microsoft.Billing/billingAccounts/100/departments/123/providers/microsoft.CostManagement/dimensions_ResourceGroup_2018-05-01_2018-05-31_5", "name": "dimensions_ResourceGroup_2018-05-01_2018-05-31_5", "type": "microsoft.CostManagement/dimensions", + "id": "/providers/Microsoft.Billing/billingAccounts/100/departments/123/providers/microsoft.CostManagement/dimensions_ResourceGroup_2018-05-01_2018-05-31_5", "properties": { + "description": "Resource group", + "category": "ResourceGroup", "data": [ "thoroetrg01", "default-notificationhubs-westus", @@ -23,20 +25,20 @@ "contosocodeflow8d4a", "noobaa" ], + "filterEnabled": true, + "groupingEnabled": true, "total": 377, - "category": "ResourceGroup", - "usageStart": "2018-05-01T00:00:00-07:00", "usageEnd": "2018-05-31T00:00:00-07:00", - "description": "Resource group", - "filterEnabled": true, - "groupingEnabled": true + "usageStart": "2018-05-01T00:00:00-07:00" } }, { - "id": "providers/Microsoft.Billing/billingAccounts/100/departments/123/providers/microsoft.CostManagement/dimensions_ResourceType_2018-05-01_2018-05-31_5", "name": "dimensions_ResourceType_2018-05-01_2018-05-31_5", "type": "microsoft.CostManagement/dimensions", + "id": "/providers/Microsoft.Billing/billingAccounts/100/departments/123/providers/microsoft.CostManagement/dimensions_ResourceType_2018-05-01_2018-05-31_5", "properties": { + "description": "Resource type", + "category": "ResourceType", "data": [ "microsoft.automation/automationaccounts", "microsoft.databricks/workspaces", @@ -44,18 +46,18 @@ "microsoft.containerregistry/registries", "microsoft.search/searchservices" ], + "filterEnabled": true, + "groupingEnabled": true, "total": 37, - "category": "ResourceType", - "usageStart": "2018-05-01T00:00:00-07:00", "usageEnd": "2018-05-31T00:00:00-07:00", - "description": "Resource type", - "filterEnabled": true, - "groupingEnabled": true + "usageStart": "2018-05-01T00:00:00-07:00" } } ] } }, "204": {} - } + }, + "operationId": "Dimensions_List", + "title": "DepartmentDimensionsListExpandAndTop-Legacy" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/DepartmentDimensionsListWithFilter.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/DepartmentDimensionsListWithFilter.json index f33199b9cf80..07b84367e200 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/DepartmentDimensionsListWithFilter.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/DepartmentDimensionsListWithFilter.json @@ -1,11 +1,11 @@ { "parameters": { + "$expand": "properties/data", + "$filter": "properties/category eq 'resourceId'", + "$top": 5, "api-version": "2025-03-01", "billingAccountId": "100", "departmentId": "123", - "$expand": "properties/data", - "$top": 5, - "$filter": "properties/category eq 'resourceId'", "scope": "providers/Microsoft.Billing/billingAccounts/100/departments/123" }, "responses": { @@ -13,10 +13,12 @@ "body": { "value": [ { - "id": "providers/Microsoft.Billing/billingAccounts/100/departments/123/providers/microsoft.CostManagement/dimensions_ResourceId_2018-05-01_2018-05-31_5", "name": "dimensions_ResourceId_2018-05-01_2018-05-31_5", "type": "microsoft.CostManagement/dimensions", + "id": "/providers/Microsoft.Billing/billingAccounts/100/departments/123/providers/microsoft.CostManagement/dimensions_ResourceId_2018-05-01_2018-05-31_5", "properties": { + "description": "Resource Id", + "category": "ResourceId", "data": [ "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/system.orlando/providers/microsoft.storage/storageaccounts/urphealthaccount", "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/system.orlando/providers/microsoft.storage/storageaccounts/srphytenaccount", @@ -24,19 +26,19 @@ "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg-sql-ha/providers/microsoft.compute/virtualmachines/sql-4qqp1", "/subscriptions/a98d6dc5-eb8f-46cf-8938-f1fb08f03706/resourcegroups/databricks-rg-testwsp-xijmsdubneexm/providers/microsoft.compute/disks/488cdb42bf74474a98075415be3f806c-containerrootvolume" ], - "total": 1409, - "category": "ResourceId", - "usageStart": "2018-05-01T00:00:00-07:00", - "usageEnd": "2018-05-31T00:00:00-07:00", - "description": "Resource Id", "filterEnabled": true, "groupingEnabled": true, - "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/100/departments/123/providers/Microsoft.CostManagement/Dimensions?$filter=properties/category eq 'resourceId'&$top=5&api-version=2019-10-01&$expand=properties/data&$skiptoken=AQAAAA%3D%3D" + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/100/departments/123/providers/Microsoft.CostManagement/Dimensions?$filter=properties/category eq 'resourceId'&$top=5&api-version=2019-10-01&$expand=properties/data&$skiptoken=AQAAAA%3D%3D", + "total": 1409, + "usageEnd": "2018-05-31T00:00:00-07:00", + "usageStart": "2018-05-01T00:00:00-07:00" } } ] } }, "204": {} - } + }, + "operationId": "Dimensions_List", + "title": "DepartmentDimensionsListWithFilter-Legacy" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/DepartmentForecast.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/DepartmentForecast.json index 794f5f61c9ff..b26f0e21cee1 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/DepartmentForecast.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/DepartmentForecast.json @@ -3,16 +3,9 @@ "api-version": "2025-03-01", "billingAccountId": "12345:6789", "departmentId": "123", - "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/departments/123", "parameters": { "type": "Usage", - "timeframe": "Custom", - "timePeriod": { - "from": "2022-08-01T00:00:00+00:00", - "to": "2022-08-31T23:59:59+00:00" - }, "dataset": { - "granularity": "Daily", "aggregation": { "totalCost": { "name": "Cost", @@ -55,20 +48,26 @@ } } ] - } + }, + "granularity": "Daily" }, "includeActualCost": false, - "includeFreshPartialCost": false - } + "includeFreshPartialCost": false, + "timePeriod": { + "from": "2022-08-01T00:00:00+00:00", + "to": "2022-08-31T23:59:59+00:00" + }, + "timeframe": "Custom" + }, + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/departments/123" }, "responses": { "200": { "body": { - "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/departments/123/providers/Microsoft.CostManagement/query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", "type": "Microsoft.CostManagement/query", + "id": "/providers/Microsoft.Billing/billingAccounts/12345:6789/departments/123/providers/Microsoft.CostManagement/query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", "properties": { - "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/departments/123/providers/Microsoft.CostManagement/Forecast?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", "columns": [ { "name": "PreTaxCost", @@ -87,6 +86,7 @@ "type": "String" } ], + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/departments/123/providers/Microsoft.CostManagement/Forecast?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", "rows": [ [ 2.10333307059661, @@ -117,5 +117,7 @@ } }, "204": {} - } + }, + "operationId": "Forecast_Usage", + "title": "DepartmentForecast" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/DepartmentQuery.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/DepartmentQuery.json index 0d9c9eaa994d..b91f04d9fb7f 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/DepartmentQuery.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/DepartmentQuery.json @@ -3,12 +3,9 @@ "api-version": "2025-03-01", "billingAccountId": "70664866", "departmentId": "123", - "scope": "providers/Microsoft.Billing/billingAccounts/100/departments/123", "parameters": { "type": "Usage", - "timeframe": "MonthToDate", "dataset": { - "granularity": "Daily", "filter": { "and": [ { @@ -45,18 +42,20 @@ } } ] - } - } - } + }, + "granularity": "Daily" + }, + "timeframe": "MonthToDate" + }, + "scope": "providers/Microsoft.Billing/billingAccounts/100/departments/123" }, "responses": { "200": { "body": { - "id": "providers/Microsoft.Billing/billingAccounts/70664866/departments/123/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", "type": "microsoft.costmanagement/Query", + "id": "/providers/Microsoft.Billing/billingAccounts/70664866/departments/123/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", "properties": { - "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/70664866/departments/123/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", "columns": [ { "name": "PreTaxCost", @@ -75,6 +74,7 @@ "type": "String" } ], + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/70664866/departments/123/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", "rows": [ [ 19.545363672276512, @@ -89,7 +89,7 @@ "USD" ], [ - 20.359416562625452, + 20.35941656262545, "VSTSHOL-1595322048000", 20180331, "USD" @@ -105,5 +105,7 @@ } }, "204": {} - } + }, + "operationId": "Query_Usage", + "title": "DepartmentQuery-Legacy" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/DepartmentQueryGrouping.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/DepartmentQueryGrouping.json index 0baa345a1a30..b0ee35674c1e 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/DepartmentQueryGrouping.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/DepartmentQueryGrouping.json @@ -3,35 +3,34 @@ "api-version": "2025-03-01", "billingAccountId": "70664866", "departmentId": "123", - "scope": "providers/Microsoft.Billing/billingAccounts/100/departments/123", "parameters": { "type": "Usage", - "timeframe": "TheLastMonth", "dataset": { - "granularity": "None", "aggregation": { "totalCost": { "name": "PreTaxCost", "function": "Sum" } }, + "granularity": "None", "grouping": [ { - "type": "Dimension", - "name": "ResourceGroup" + "name": "ResourceGroup", + "type": "Dimension" } ] - } - } + }, + "timeframe": "TheLastMonth" + }, + "scope": "providers/Microsoft.Billing/billingAccounts/100/departments/123" }, "responses": { "200": { "body": { - "id": "providers/Microsoft.Billing/billingAccounts/70664866/departments/123/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", "type": "microsoft.costmanagement/Query", + "id": "/providers/Microsoft.Billing/billingAccounts/70664866/departments/123/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", "properties": { - "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/70664866/departments/123/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", "columns": [ { "name": "PreTaxCost", @@ -46,6 +45,7 @@ "type": "String" } ], + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/70664866/departments/123/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", "rows": [ [ 19.545363672276512, @@ -58,7 +58,7 @@ "USD" ], [ - 20.359416562625452, + 20.35941656262545, "VSTSHOL-1595322048000", "USD" ] @@ -67,5 +67,7 @@ } }, "204": {} - } + }, + "operationId": "Query_Usage", + "title": "DepartmentQueryGrouping-Legacy" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/DismissResourceGroupAlerts.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/DismissResourceGroupAlerts.json index 77d10023d026..b40297584616 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/DismissResourceGroupAlerts.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/DismissResourceGroupAlerts.json @@ -1,59 +1,61 @@ { "parameters": { - "api-version": "2025-03-01", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "ScreenSharingTest-peer", - "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ScreenSharingTest-peer", "alertId": "22222222-2222-2222-2222-222222222222", + "api-version": "2025-03-01", "parameters": { "properties": { "status": "Dismissed" } - } + }, + "resourceGroupName": "ScreenSharingTest-peer", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ScreenSharingTest-peer", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { - "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ScreenSharingTest-peer/providers/Microsoft.CostManagement/alerts/22222222-2222-2222-2222-222222222222", "name": "22222222-2222-2222-2222-222222222222", "type": "Microsoft.CostManagement/alerts", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ScreenSharingTest-peer/providers/Microsoft.CostManagement/alerts/22222222-2222-2222-2222-222222222222", "properties": { + "description": "", + "closeTime": "0001-01-01T00:00:00", + "costEntityId": "budget1", + "creationTime": "2020-04-27T11:07:52.7143901Z", "definition": { "type": "Budget", "category": "Cost", "criteria": "CostThresholdExceeded" }, - "description": "", + "modificationTime": "2020-04-28T11:06:02.8999373Z", "source": "Preset", + "status": "Dismissed", + "statusModificationTime": "0001-01-01T00:00:00", + "statusModificationUserName": null, "details": { - "timeGrainType": "Quarterly", - "periodStartDate": "2020-03-01T00:00:00Z", - "triggeredBy": "22222222-2222-2222-2222-222222222222_1_01", - "resourceGroupFilter": [], - "resourceFilter": [], - "meterFilter": [], - "tagFilter": {}, - "threshold": 0.8, - "operator": "GreaterThan", - "amount": 200000.0, - "unit": "USD", - "currentSpend": 161000.12, + "amount": 200000, "contactEmails": [ "1234@contoso.com" ], "contactGroups": [], "contactRoles": [], - "overridingAlert": null - }, - "costEntityId": "budget1", - "status": "Dismissed", - "creationTime": "2020-04-27T11:07:52.7143901Z", - "closeTime": "0001-01-01T00:00:00", - "modificationTime": "2020-04-28T11:06:02.8999373Z", - "statusModificationUserName": null, - "statusModificationTime": "0001-01-01T00:00:00" + "currentSpend": 161000.12, + "meterFilter": [], + "operator": "GreaterThan", + "overridingAlert": null, + "periodStartDate": "2020-03-01T00:00:00Z", + "resourceFilter": [], + "resourceGroupFilter": [], + "tagFilter": {}, + "threshold": 0.8, + "timeGrainType": "Quarterly", + "triggeredBy": "22222222-2222-2222-2222-222222222222_1_01", + "unit": "USD" + } } } } - } + }, + "operationId": "Alerts_Dismiss", + "title": "PatchResourceGroupAlerts" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/DismissSubscriptionAlerts.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/DismissSubscriptionAlerts.json index 800b50259b93..1bd02f64c98b 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/DismissSubscriptionAlerts.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/DismissSubscriptionAlerts.json @@ -1,58 +1,60 @@ { "parameters": { - "api-version": "2025-03-01", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "scope": "subscriptions/00000000-0000-0000-0000-000000000000", "alertId": "22222222-2222-2222-2222-222222222222", + "api-version": "2025-03-01", "parameters": { "properties": { "status": "Dismissed" } - } + }, + "scope": "subscriptions/00000000-0000-0000-0000-000000000000", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { - "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/alerts/22222222-2222-2222-2222-222222222222", "name": "22222222-2222-2222-2222-222222222222", "type": "Microsoft.CostManagement/alerts", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/alerts/22222222-2222-2222-2222-222222222222", "properties": { + "description": "", + "closeTime": "0001-01-01T00:00:00", + "costEntityId": "budget1", + "creationTime": "2020-04-27T11:07:52.7143901Z", "definition": { "type": "Budget", "category": "Cost", "criteria": "CostThresholdExceeded" }, - "description": "", + "modificationTime": "2020-04-28T11:06:02.8999373Z", "source": "Preset", + "status": "Dismissed", + "statusModificationTime": "0001-01-01T00:00:00", + "statusModificationUserName": null, "details": { - "timeGrainType": "Quarterly", - "periodStartDate": "2020-03-01T00:00:00Z", - "triggeredBy": "22222222-2222-2222-2222-222222222222_1_01", - "resourceGroupFilter": [], - "resourceFilter": [], - "meterFilter": [], - "tagFilter": {}, - "threshold": 0.8, - "operator": "GreaterThan", - "amount": 200000.0, - "unit": "USD", - "currentSpend": 161000.12, + "amount": 200000, "contactEmails": [ "1234@contoso.com" ], "contactGroups": [], "contactRoles": [], - "overridingAlert": null - }, - "costEntityId": "budget1", - "status": "Dismissed", - "creationTime": "2020-04-27T11:07:52.7143901Z", - "closeTime": "0001-01-01T00:00:00", - "modificationTime": "2020-04-28T11:06:02.8999373Z", - "statusModificationUserName": null, - "statusModificationTime": "0001-01-01T00:00:00" + "currentSpend": 161000.12, + "meterFilter": [], + "operator": "GreaterThan", + "overridingAlert": null, + "periodStartDate": "2020-03-01T00:00:00Z", + "resourceFilter": [], + "resourceGroupFilter": [], + "tagFilter": {}, + "threshold": 0.8, + "timeGrainType": "Quarterly", + "triggeredBy": "22222222-2222-2222-2222-222222222222_1_01", + "unit": "USD" + } } } } - } + }, + "operationId": "Alerts_Dismiss", + "title": "PatchSubscriptionAlerts" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/EAPriceSheetForBillingPeriod.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/EAPriceSheetForBillingPeriod.json index 9695ceaa9384..deebadbb6b2c 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/EAPriceSheetForBillingPeriod.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/EAPriceSheetForBillingPeriod.json @@ -5,20 +5,22 @@ "billingPeriodName": "202311" }, "responses": { + "200": { + "body": { + "properties": { + "reportUrl": "https://myaccount.blob.core.windows.net/reportfile.csv?sv=2015-04-05&ss=bf&srt=s&st=2015-04-29T22%3A18%3A26Z&se=2015-04-30T02%3A23%3A26Z&sr=b&sp=rw&spr=https&sig=G%2TEST%4B", + "validUntil": "2023-09-30T17:32:28Z" + }, + "status": "Completed" + } + }, "202": { "headers": { "Location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/0000000/providers/Microsoft.CostManagement/operationResults/00000000-0000-0000-0000-000000000000?api-version=2023-09-01", "Retry-After": "60" } - }, - "200": { - "body": { - "status": "Completed", - "properties": { - "downloadUrl": "https://myaccount.blob.core.windows.net/?restype=service&comp=properties&sv=2015-04-05&ss=bf&srt=s&st=2015-04-29T22%3A18%3A26Z&se=2015-04-30T02%3A23%3A26Z&sr=b&sp=rw&spr=https&sig=G%2TEST%4B", - "validTill": "2023-09-30T17:32:28Z" - } - } } - } + }, + "operationId": "PriceSheet_DownloadByBillingAccount", + "title": "EAPriceSheetForBillingPeriod" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/EnrollmentAccountAlerts.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/EnrollmentAccountAlerts.json index f92ee454a0cc..edf3b1e16b5a 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/EnrollmentAccountAlerts.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/EnrollmentAccountAlerts.json @@ -8,92 +8,94 @@ "responses": { "200": { "body": { + "nextLink": null, "value": [ { - "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/enrollmentAccounts/456/providers/Microsoft.CostManagement/alerts/00000000-0000-0000-0000-000000000000", "name": "00000000-0000-0000-0000-000000000000", "type": "Microsoft.CostManagement/alerts", + "id": "/providers/Microsoft.Billing/billingAccounts/12345:6789/enrollmentAccounts/456/providers/Microsoft.CostManagement/alerts/00000000-0000-0000-0000-000000000000", "properties": { + "description": "", + "closeTime": "0001-01-01T00:00:00", + "costEntityId": "budget1", + "creationTime": "2020-04-27T11:07:52.7143901Z", "definition": { "type": "Budget", "category": "Cost", "criteria": "CostThresholdExceeded" }, - "description": "", + "modificationTime": "2020-04-28T11:06:02.8999373Z", "source": "Preset", + "status": "Active", + "statusModificationTime": "0001-01-01T00:00:00", + "statusModificationUserName": null, "details": { - "timeGrainType": "Quarterly", - "periodStartDate": "2020-03-01T00:00:00Z", - "triggeredBy": "00000000-0000-0000-0000-000000000000_1_01", - "resourceGroupFilter": [], - "resourceFilter": [], - "meterFilter": [], - "tagFilter": {}, - "threshold": 0.8, - "operator": "GreaterThan", - "amount": 200000.0, - "unit": "USD", - "currentSpend": 161000.12, + "amount": 200000, "contactEmails": [ "1234@contoso.com" ], "contactGroups": [], "contactRoles": [], - "overridingAlert": null - }, - "costEntityId": "budget1", - "status": "Active", - "creationTime": "2020-04-27T11:07:52.7143901Z", - "closeTime": "0001-01-01T00:00:00", - "modificationTime": "2020-04-28T11:06:02.8999373Z", - "statusModificationUserName": null, - "statusModificationTime": "0001-01-01T00:00:00" + "currentSpend": 161000.12, + "meterFilter": [], + "operator": "GreaterThan", + "overridingAlert": null, + "periodStartDate": "2020-03-01T00:00:00Z", + "resourceFilter": [], + "resourceGroupFilter": [], + "tagFilter": {}, + "threshold": 0.8, + "timeGrainType": "Quarterly", + "triggeredBy": "00000000-0000-0000-0000-000000000000_1_01", + "unit": "USD" + } } }, { - "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/enrollmentAccounts/456/providers/Microsoft.CostManagement/alerts/11111111-1111-1111-111111111111", "name": "11111111-1111-1111-111111111111", "type": "Microsoft.CostManagement/alerts", + "id": "/providers/Microsoft.Billing/billingAccounts/12345:6789/enrollmentAccounts/456/providers/Microsoft.CostManagement/alerts/11111111-1111-1111-111111111111", "properties": { + "description": "", + "closeTime": "0001-01-01T00:00:00", + "costEntityId": "budget1", + "creationTime": "2019-06-24T05:51:52.8713179Z", "definition": { "type": "Budget", "category": "Cost", "criteria": "CostThresholdExceeded" }, - "description": "", + "modificationTime": "2019-08-31T17:51:55.1808807Z", "source": "Preset", + "status": "Active", + "statusModificationTime": "0001-01-01T00:00:00", + "statusModificationUserName": null, "details": { - "timeGrainType": "Quarterly", - "periodStartDate": "2020-03-01T00:00:00Z", - "triggeredBy": "11111111-1111-1111-111111111111_1_01", - "resourceGroupFilter": [], - "resourceFilter": [], - "meterFilter": [], - "tagFilter": {}, - "threshold": 0.8, - "operator": "GreaterThan", - "amount": 200000.0, - "unit": "USD", - "currentSpend": 171000.32, + "amount": 200000, "contactEmails": [ "1234@contoso.com" ], "contactGroups": [], "contactRoles": [], - "overridingAlert": null - }, - "costEntityId": "budget1", - "status": "Active", - "creationTime": "2019-06-24T05:51:52.8713179Z", - "closeTime": "0001-01-01T00:00:00", - "modificationTime": "2019-08-31T17:51:55.1808807Z", - "statusModificationUserName": null, - "statusModificationTime": "0001-01-01T00:00:00" + "currentSpend": 171000.32, + "meterFilter": [], + "operator": "GreaterThan", + "overridingAlert": null, + "periodStartDate": "2020-03-01T00:00:00Z", + "resourceFilter": [], + "resourceGroupFilter": [], + "tagFilter": {}, + "threshold": 0.8, + "timeGrainType": "Quarterly", + "triggeredBy": "11111111-1111-1111-111111111111_1_01", + "unit": "USD" + } } } - ], - "nextLink": null + ] } } - } + }, + "operationId": "Alerts_List", + "title": "EnrollmentAccountAlerts" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/EnrollmentAccountDimensionsList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/EnrollmentAccountDimensionsList.json index 8aad52f6437a..78fbe03f6f6a 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/EnrollmentAccountDimensionsList.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/EnrollmentAccountDimensionsList.json @@ -10,38 +10,40 @@ "body": { "value": [ { - "id": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456/providers/microsoft.CostManagement/dimensions_ResourceGroup_2018-05-01_2018-05-31", "name": "dimensions_ResourceGroup_2018-05-01_2018-05-31", "type": "microsoft.CostManagement/dimensions", + "id": "/providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456/providers/microsoft.CostManagement/dimensions_ResourceGroup_2018-05-01_2018-05-31", "properties": { + "description": "Resource group", + "category": "ResourceGroup", "data": [], + "filterEnabled": true, + "groupingEnabled": true, "total": 377, - "category": "ResourceGroup", - "usageStart": "2018-05-01T00:00:00-07:00", "usageEnd": "2018-05-31T00:00:00-07:00", - "description": "Resource group", - "filterEnabled": true, - "groupingEnabled": true + "usageStart": "2018-05-01T00:00:00-07:00" } }, { - "id": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456/providers/microsoft.CostManagement/dimensions_ResourceType_2018-05-01_2018-05-31", "name": "dimensions_ResourceType_2018-05-01_2018-05-31", "type": "microsoft.CostManagement/dimensions", + "id": "/providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456/providers/microsoft.CostManagement/dimensions_ResourceType_2018-05-01_2018-05-31", "properties": { + "description": "Resource type", + "category": "ResourceType", "data": [], + "filterEnabled": true, + "groupingEnabled": true, "total": 37, - "category": "ResourceType", - "usageStart": "2018-05-01T00:00:00-07:00", "usageEnd": "2018-05-31T00:00:00-07:00", - "description": "Resource type", - "filterEnabled": true, - "groupingEnabled": true + "usageStart": "2018-05-01T00:00:00-07:00" } } ] } }, "204": {} - } + }, + "operationId": "Dimensions_List", + "title": "EnrollmentAccountDimensionsList-Legacy" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/EnrollmentAccountDimensionsListExpandAndTop.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/EnrollmentAccountDimensionsListExpandAndTop.json index 72befc83deff..2b7fe144534b 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/EnrollmentAccountDimensionsListExpandAndTop.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/EnrollmentAccountDimensionsListExpandAndTop.json @@ -1,10 +1,10 @@ { "parameters": { + "$expand": "properties/data", + "$top": 5, "api-version": "2025-03-01", "billingAccountId": "100", "enrollmentAccountId": "456", - "$expand": "properties/data", - "$top": 5, "scope": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456" }, "responses": { @@ -12,10 +12,12 @@ "body": { "value": [ { - "id": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456/providers/microsoft.CostManagement/dimensions_ResourceGroup_2018-05-01_2018-05-31_5", "name": "dimensions_ResourceGroup_2018-05-01_2018-05-31_5", "type": "microsoft.CostManagement/dimensions", + "id": "/providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456/providers/microsoft.CostManagement/dimensions_ResourceGroup_2018-05-01_2018-05-31_5", "properties": { + "description": "Resource group", + "category": "ResourceGroup", "data": [ "thoroetrg01", "default-notificationhubs-westus", @@ -23,20 +25,20 @@ "contosocodeflow8d4a", "noobaa" ], + "filterEnabled": true, + "groupingEnabled": true, "total": 377, - "category": "ResourceGroup", - "usageStart": "2018-05-01T00:00:00-07:00", "usageEnd": "2018-05-31T00:00:00-07:00", - "description": "Resource group", - "filterEnabled": true, - "groupingEnabled": true + "usageStart": "2018-05-01T00:00:00-07:00" } }, { - "id": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456/providers/microsoft.CostManagement/dimensions_ResourceType_2018-05-01_2018-05-31_5", "name": "dimensions_ResourceType_2018-05-01_2018-05-31_5", "type": "microsoft.CostManagement/dimensions", + "id": "/providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456/providers/microsoft.CostManagement/dimensions_ResourceType_2018-05-01_2018-05-31_5", "properties": { + "description": "Resource type", + "category": "ResourceType", "data": [ "microsoft.automation/automationaccounts", "microsoft.databricks/workspaces", @@ -44,18 +46,18 @@ "microsoft.containerregistry/registries", "microsoft.search/searchservices" ], + "filterEnabled": true, + "groupingEnabled": true, "total": 37, - "category": "ResourceType", - "usageStart": "2018-05-01T00:00:00-07:00", "usageEnd": "2018-05-31T00:00:00-07:00", - "description": "Resource type", - "filterEnabled": true, - "groupingEnabled": true + "usageStart": "2018-05-01T00:00:00-07:00" } } ] } }, "204": {} - } + }, + "operationId": "Dimensions_List", + "title": "EnrollmentAccountDimensionsListExpandAndTop-Legacy" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/EnrollmentAccountDimensionsListWithFilter.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/EnrollmentAccountDimensionsListWithFilter.json index 2eb64c8cc8f8..d3500d1eebbb 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/EnrollmentAccountDimensionsListWithFilter.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/EnrollmentAccountDimensionsListWithFilter.json @@ -1,11 +1,11 @@ { "parameters": { + "$expand": "properties/data", + "$filter": "properties/category eq 'resourceId'", + "$top": 5, "api-version": "2025-03-01", "billingAccountId": "100", "enrollmentAccountId": "456", - "$expand": "properties/data", - "$top": 5, - "$filter": "properties/category eq 'resourceId'", "scope": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456" }, "responses": { @@ -13,10 +13,12 @@ "body": { "value": [ { - "id": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456/providers/microsoft.CostManagement/dimensions_ResourceId_2018-05-01_2018-05-31_5", "name": "dimensions_ResourceId_2018-05-01_2018-05-31_5", "type": "microsoft.CostManagement/dimensions", + "id": "/providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456/providers/microsoft.CostManagement/dimensions_ResourceId_2018-05-01_2018-05-31_5", "properties": { + "description": "Resource Id", + "category": "ResourceId", "data": [ "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/system.orlando/providers/microsoft.storage/storageaccounts/urphealthaccount", "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/system.orlando/providers/microsoft.storage/storageaccounts/srphytenaccount", @@ -24,19 +26,19 @@ "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg-sql-ha/providers/microsoft.compute/virtualmachines/sql-4qqp1", "/subscriptions/a98d6dc5-eb8f-46cf-8938-f1fb08f03706/resourcegroups/databricks-rg-testwsp-xijmsdubneexm/providers/microsoft.compute/disks/488cdb42bf74474a98075415be3f806c-containerrootvolume" ], - "total": 1409, - "category": "ResourceId", - "usageStart": "2018-05-01T00:00:00-07:00", - "usageEnd": "2018-05-31T00:00:00-07:00", - "description": "Resource Id", "filterEnabled": true, "groupingEnabled": true, - "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456/providers/Microsoft.CostManagement/Dimensions?$filter=properties/category eq 'resourceId'&$top=5&api-version=2019-10-01&$expand=properties/data&$skiptoken=AQAAAA%3D%3D" + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456/providers/Microsoft.CostManagement/Dimensions?$filter=properties/category eq 'resourceId'&$top=5&api-version=2019-10-01&$expand=properties/data&$skiptoken=AQAAAA%3D%3D", + "total": 1409, + "usageEnd": "2018-05-31T00:00:00-07:00", + "usageStart": "2018-05-01T00:00:00-07:00" } } ] } }, "204": {} - } + }, + "operationId": "Dimensions_List", + "title": "EnrollmentAccountDimensionsListWithFilter-Legacy" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/EnrollmentAccountForecast.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/EnrollmentAccountForecast.json index afc877610b82..c739bf7f85c0 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/EnrollmentAccountForecast.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/EnrollmentAccountForecast.json @@ -3,16 +3,9 @@ "api-version": "2025-03-01", "billingAccountId": "12345:6789", "enrollmentAccountId": "456", - "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/enrollmentAccounts/456", "parameters": { "type": "Usage", - "timeframe": "Custom", - "timePeriod": { - "from": "2022-08-01T00:00:00+00:00", - "to": "2022-08-31T23:59:59+00:00" - }, "dataset": { - "granularity": "Daily", "aggregation": { "totalCost": { "name": "Cost", @@ -55,20 +48,26 @@ } } ] - } + }, + "granularity": "Daily" }, "includeActualCost": false, - "includeFreshPartialCost": false - } + "includeFreshPartialCost": false, + "timePeriod": { + "from": "2022-08-01T00:00:00+00:00", + "to": "2022-08-31T23:59:59+00:00" + }, + "timeframe": "Custom" + }, + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/enrollmentAccounts/456" }, "responses": { "200": { "body": { - "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/enrollmentAccounts/456/providers/Microsoft.CostManagement/query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", "type": "Microsoft.CostManagement/query", + "id": "/providers/Microsoft.Billing/billingAccounts/12345:6789/enrollmentAccounts/456/providers/Microsoft.CostManagement/query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", "properties": { - "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/enrollmentAccounts/456/providers/Microsoft.CostManagement/Forecast?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", "columns": [ { "name": "PreTaxCost", @@ -87,6 +86,7 @@ "type": "String" } ], + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/enrollmentAccounts/456/providers/Microsoft.CostManagement/Forecast?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", "rows": [ [ 2.10333307059661, @@ -117,5 +117,7 @@ } }, "204": {} - } + }, + "operationId": "Forecast_Usage", + "title": "EnrollmentAccountForecast" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/EnrollmentAccountQuery.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/EnrollmentAccountQuery.json index 90be923c0b0f..91f011463326 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/EnrollmentAccountQuery.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/EnrollmentAccountQuery.json @@ -3,12 +3,9 @@ "api-version": "2025-03-01", "billingAccountId": "70664866", "enrollmentAccountId": "456", - "scope": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456", "parameters": { "type": "Usage", - "timeframe": "MonthToDate", "dataset": { - "granularity": "Daily", "filter": { "and": [ { @@ -45,18 +42,20 @@ } } ] - } - } - } + }, + "granularity": "Daily" + }, + "timeframe": "MonthToDate" + }, + "scope": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456" }, "responses": { "200": { "body": { - "id": "providers/Microsoft.Billing/billingAccounts/70664866/enrollmentAccounts/456/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", "type": "microsoft.costmanagement/Query", + "id": "/providers/Microsoft.Billing/billingAccounts/70664866/enrollmentAccounts/456/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", "properties": { - "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/70664866/enrollmentAccounts/456/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", "columns": [ { "name": "PreTaxCost", @@ -75,6 +74,7 @@ "type": "String" } ], + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/70664866/enrollmentAccounts/456/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", "rows": [ [ 19.545363672276512, @@ -89,7 +89,7 @@ "USD" ], [ - 20.359416562625452, + 20.35941656262545, "VSTSHOL-1595322048000", 20180331, "USD" @@ -105,5 +105,7 @@ } }, "204": {} - } + }, + "operationId": "Query_Usage", + "title": "EnrollmentAccountQuery-Legacy" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/EnrollmentAccountQueryGrouping.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/EnrollmentAccountQueryGrouping.json index f209d4b1097a..5fe790a3dfbd 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/EnrollmentAccountQueryGrouping.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/EnrollmentAccountQueryGrouping.json @@ -3,35 +3,34 @@ "api-version": "2025-03-01", "billingAccountId": "70664866", "enrollmentAccountId": "456", - "scope": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456", "parameters": { "type": "Usage", - "timeframe": "TheLastMonth", "dataset": { - "granularity": "Daily", "aggregation": { "totalCost": { "name": "PreTaxCost", "function": "Sum" } }, + "granularity": "Daily", "grouping": [ { - "type": "Dimension", - "name": "ResourceGroup" + "name": "ResourceGroup", + "type": "Dimension" } ] - } - } + }, + "timeframe": "TheLastMonth" + }, + "scope": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456" }, "responses": { "200": { "body": { - "id": "providers/Microsoft.Billing/billingAccounts/70664866/enrollmentAccounts/456/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", "type": "microsoft.costmanagement/Query", + "id": "/providers/Microsoft.Billing/billingAccounts/70664866/enrollmentAccounts/456/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", "properties": { - "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/70664866/enrollmentAccounts/456/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", "columns": [ { "name": "PreTaxCost", @@ -50,6 +49,7 @@ "type": "String" } ], + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/70664866/enrollmentAccounts/456/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", "rows": [ [ 19.545363672276512, @@ -64,7 +64,7 @@ "USD" ], [ - 20.359416562625452, + 20.35941656262545, "VSTSHOL-1595322048000", 20180331, "USD" @@ -74,5 +74,7 @@ } }, "204": {} - } + }, + "operationId": "Query_Usage", + "title": "EnrollmentAccountQueryGrouping-Legacy" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportCreateOrUpdateByBillingAccount.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportCreateOrUpdateByBillingAccount.json index 475f7348c95c..18a4c7e40ade 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportCreateOrUpdateByBillingAccount.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportCreateOrUpdateByBillingAccount.json @@ -2,7 +2,6 @@ "parameters": { "api-version": "2025-03-01", "billingAccountId": "123456", - "scope": "providers/Microsoft.Billing/billingAccounts/123456", "exportName": "TestExport", "parameters": { "identity": { @@ -10,47 +9,48 @@ }, "location": "centralus", "properties": { - "schedule": { - "status": "Active", - "recurrence": "Daily", - "recurrencePeriod": { - "from": "2020-06-01T00:00:00Z", - "to": "2020-06-30T00:00:00Z" - } - }, "format": "Csv", - "deliveryInfo": { - "destination": { - "type": "AzureBlob", - "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", - "container": "exports", - "rootFolderPath": "ad-hoc" - } - }, + "compressionMode": "gzip", + "dataOverwriteBehavior": "OverwritePreviousReport", "definition": { "type": "ActualCost", - "timeframe": "MonthToDate", "dataSet": { - "granularity": "Daily", "configuration": { "dataVersion": "2023-05-01" - } + }, + "granularity": "Daily" + }, + "timeframe": "MonthToDate" + }, + "deliveryInfo": { + "destination": { + "type": "AzureBlob", + "container": "exports", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "rootFolderPath": "ad-hoc" } }, + "exportDescription": "This is a test export.", "partitionData": true, - "dataOverwriteBehavior": "OverwritePreviousReport", - "compressionMode": "gzip", - "exportDescription": "This is a test export." + "schedule": { + "recurrence": "Daily", + "recurrencePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-06-30T00:00:00Z" + }, + "status": "Active" + } } - } + }, + "scope": "providers/Microsoft.Billing/billingAccounts/123456" }, "responses": { - "201": { + "200": { "body": { - "id": "providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/exports/TestExport", "name": "TestExport", "type": "Microsoft.CostManagement/exports", "eTag": "\"00000000-0000-0000-0000-000000000000\"", + "id": "/providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/exports/TestExport", "identity": { "type": "SystemAssigned", "principalId": "00000000-0000-0000-0000-000000000000", @@ -58,46 +58,46 @@ }, "location": "centralus", "properties": { - "schedule": { - "status": "Active", - "recurrence": "Daily", - "recurrencePeriod": { - "from": "2020-06-01T00:00:00Z", - "to": "2020-06-30T00:00:00Z" - } - }, - "nextRunTimeEstimate": "2020-06-01T23:00:00Z", "format": "Csv", - "deliveryInfo": { - "destination": { - "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", - "container": "exports", - "rootFolderPath": "ad-hoc" - } - }, + "compressionMode": "gzip", + "dataOverwriteBehavior": "OverwritePreviousReport", "definition": { "type": "ActualCost", - "timeframe": "MonthToDate", "dataSet": { - "granularity": "Daily", "configuration": { "dataVersion": "2023-05-01" - } + }, + "granularity": "Daily" + }, + "timeframe": "MonthToDate" + }, + "deliveryInfo": { + "destination": { + "container": "exports", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "rootFolderPath": "ad-hoc" } }, + "exportDescription": "This is a test export.", + "nextRunTimeEstimate": "2020-06-01T23:00:00Z", "partitionData": true, - "dataOverwriteBehavior": "OverwritePreviousReport", - "compressionMode": "gzip", - "exportDescription": "This is a test export." + "schedule": { + "recurrence": "Daily", + "recurrencePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-06-30T00:00:00Z" + }, + "status": "Active" + } } } }, - "200": { + "201": { "body": { - "id": "providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/exports/TestExport", "name": "TestExport", "type": "Microsoft.CostManagement/exports", "eTag": "\"00000000-0000-0000-0000-000000000000\"", + "id": "/providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/exports/TestExport", "identity": { "type": "SystemAssigned", "principalId": "00000000-0000-0000-0000-000000000000", @@ -105,39 +105,41 @@ }, "location": "centralus", "properties": { - "schedule": { - "status": "Active", - "recurrence": "Daily", - "recurrencePeriod": { - "from": "2020-06-01T00:00:00Z", - "to": "2020-06-30T00:00:00Z" - } - }, - "nextRunTimeEstimate": "2020-06-01T23:00:00Z", "format": "Csv", - "deliveryInfo": { - "destination": { - "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", - "container": "exports", - "rootFolderPath": "ad-hoc" - } - }, + "compressionMode": "gzip", + "dataOverwriteBehavior": "OverwritePreviousReport", "definition": { "type": "ActualCost", - "timeframe": "MonthToDate", "dataSet": { - "granularity": "Daily", "configuration": { "dataVersion": "2023-05-01" - } + }, + "granularity": "Daily" + }, + "timeframe": "MonthToDate" + }, + "deliveryInfo": { + "destination": { + "container": "exports", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "rootFolderPath": "ad-hoc" } }, + "exportDescription": "This is a test export.", + "nextRunTimeEstimate": "2020-06-01T23:00:00Z", "partitionData": true, - "dataOverwriteBehavior": "OverwritePreviousReport", - "compressionMode": "gzip", - "exportDescription": "This is a test export." + "schedule": { + "recurrence": "Daily", + "recurrencePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-06-30T00:00:00Z" + }, + "status": "Active" + } } } } - } + }, + "operationId": "Exports_CreateOrUpdate", + "title": "ExportCreateOrUpdateByBillingAccount" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportCreateOrUpdateByBillingAccountCustom.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportCreateOrUpdateByBillingAccountCustom.json index 21dc096206d5..f73c7a7f5bbd 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportCreateOrUpdateByBillingAccountCustom.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportCreateOrUpdateByBillingAccountCustom.json @@ -2,7 +2,6 @@ "parameters": { "api-version": "2025-03-01", "billingAccountId": "123456", - "scope": "providers/Microsoft.Billing/billingAccounts/123456", "exportName": "TestExport", "parameters": { "identity": { @@ -10,46 +9,47 @@ }, "location": "centralus", "properties": { - "schedule": { - "status": "Inactive" - }, "format": "Csv", - "deliveryInfo": { - "destination": { - "type": "AzureBlob", - "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", - "container": "exports", - "rootFolderPath": "ad-hoc" - } - }, + "compressionMode": "gzip", + "dataOverwriteBehavior": "OverwritePreviousReport", "definition": { "type": "ActualCost", - "timeframe": "Custom", + "dataSet": { + "configuration": { + "dataVersion": "2023-05-01" + }, + "granularity": "Daily" + }, "timePeriod": { "from": "2025-04-03T00:00:00.000Z", "to": "2025-04-03T00:00:00.000Z" }, - "dataSet": { - "granularity": "Daily", - "configuration": { - "dataVersion": "2023-05-01" - } + "timeframe": "Custom" + }, + "deliveryInfo": { + "destination": { + "type": "AzureBlob", + "container": "exports", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "rootFolderPath": "ad-hoc" } }, + "exportDescription": "This is a test export.", "partitionData": true, - "dataOverwriteBehavior": "OverwritePreviousReport", - "compressionMode": "gzip", - "exportDescription": "This is a test export." + "schedule": { + "status": "Inactive" + } } - } + }, + "scope": "providers/Microsoft.Billing/billingAccounts/123456" }, "responses": { - "201": { + "200": { "body": { - "id": "providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/exports/TestExport", "name": "TestExport", "type": "Microsoft.CostManagement/exports", "eTag": "\"00000000-0000-0000-0000-000000000000\"", + "id": "/providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/exports/TestExport", "identity": { "type": "SystemAssigned", "principalId": "00000000-0000-0000-0000-000000000000", @@ -57,45 +57,45 @@ }, "location": "centralus", "properties": { - "schedule": { - "status": "Inactive", - "recurrence": "None" - }, "format": "Csv", - "deliveryInfo": { - "destination": { - "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", - "container": "exports", - "rootFolderPath": "ad-hoc" - } - }, + "compressionMode": "gzip", + "dataOverwriteBehavior": "OverwritePreviousReport", "definition": { "type": "ActualCost", - "timeframe": "Custom", + "dataSet": { + "configuration": { + "dataVersion": "2023-05-01" + }, + "granularity": "Daily" + }, "timePeriod": { "from": "2025-04-03T00:00:00Z", "to": "2025-04-03T00:00:00Z" }, - "dataSet": { - "granularity": "Daily", - "configuration": { - "dataVersion": "2023-05-01" - } + "timeframe": "Custom" + }, + "deliveryInfo": { + "destination": { + "container": "exports", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "rootFolderPath": "ad-hoc" } }, + "exportDescription": "This is a test export.", "partitionData": true, - "dataOverwriteBehavior": "OverwritePreviousReport", - "compressionMode": "gzip", - "exportDescription": "This is a test export." + "schedule": { + "recurrence": "None", + "status": "Inactive" + } } } }, - "200": { + "201": { "body": { - "id": "providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/exports/TestExport", "name": "TestExport", "type": "Microsoft.CostManagement/exports", "eTag": "\"00000000-0000-0000-0000-000000000000\"", + "id": "/providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/exports/TestExport", "identity": { "type": "SystemAssigned", "principalId": "00000000-0000-0000-0000-000000000000", @@ -103,38 +103,40 @@ }, "location": "centralus", "properties": { - "schedule": { - "status": "Inactive", - "recurrence": "None" - }, "format": "Csv", - "deliveryInfo": { - "destination": { - "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", - "container": "exports", - "rootFolderPath": "ad-hoc" - } - }, + "compressionMode": "gzip", + "dataOverwriteBehavior": "OverwritePreviousReport", "definition": { "type": "ActualCost", - "timeframe": "Custom", + "dataSet": { + "configuration": { + "dataVersion": "2023-05-01" + }, + "granularity": "Daily" + }, "timePeriod": { "from": "2025-04-03T00:00:00Z", "to": "2025-04-03T00:00:00Z" }, - "dataSet": { - "granularity": "Daily", - "configuration": { - "dataVersion": "2023-05-01" - } + "timeframe": "Custom" + }, + "deliveryInfo": { + "destination": { + "container": "exports", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "rootFolderPath": "ad-hoc" } }, + "exportDescription": "This is a test export.", "partitionData": true, - "dataOverwriteBehavior": "OverwritePreviousReport", - "compressionMode": "gzip", - "exportDescription": "This is a test export." + "schedule": { + "recurrence": "None", + "status": "Inactive" + } } } } - } + }, + "operationId": "Exports_CreateOrUpdate", + "title": "ExportCreateOrUpdateByBillingAccountCustom" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportCreateOrUpdateByBillingAccountMonthly.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportCreateOrUpdateByBillingAccountMonthly.json index 32d630100cce..54b0da11c7f6 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportCreateOrUpdateByBillingAccountMonthly.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportCreateOrUpdateByBillingAccountMonthly.json @@ -2,7 +2,6 @@ "parameters": { "api-version": "2025-03-01", "billingAccountId": "123456", - "scope": "providers/Microsoft.Billing/billingAccounts/123456", "exportName": "TestExport", "parameters": { "identity": { @@ -10,47 +9,48 @@ }, "location": "centralus", "properties": { - "schedule": { - "status": "Active", - "recurrence": "Monthly", - "recurrencePeriod": { - "from": "2020-06-05T00:00:00Z", - "to": "2030-06-30T00:00:00Z" - } - }, "format": "Csv", - "deliveryInfo": { - "destination": { - "type": "AzureBlob", - "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", - "container": "exports", - "rootFolderPath": "ad-hoc" - } - }, + "compressionMode": "gzip", + "dataOverwriteBehavior": "OverwritePreviousReport", "definition": { "type": "ActualCost", - "timeframe": "TheLastMonth", "dataSet": { - "granularity": "Daily", "configuration": { "dataVersion": "2023-05-01" - } + }, + "granularity": "Daily" + }, + "timeframe": "TheLastMonth" + }, + "deliveryInfo": { + "destination": { + "type": "AzureBlob", + "container": "exports", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "rootFolderPath": "ad-hoc" } }, + "exportDescription": "This is a test export.", "partitionData": true, - "dataOverwriteBehavior": "OverwritePreviousReport", - "compressionMode": "gzip", - "exportDescription": "This is a test export." + "schedule": { + "recurrence": "Monthly", + "recurrencePeriod": { + "from": "2020-06-05T00:00:00Z", + "to": "2030-06-30T00:00:00Z" + }, + "status": "Active" + } } - } + }, + "scope": "providers/Microsoft.Billing/billingAccounts/123456" }, "responses": { - "201": { + "200": { "body": { - "id": "providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/exports/TestExport", "name": "TestExport", "type": "Microsoft.CostManagement/exports", "eTag": "\"00000000-0000-0000-0000-000000000000\"", + "id": "/providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/exports/TestExport", "identity": { "type": "SystemAssigned", "principalId": "00000000-0000-0000-0000-000000000000", @@ -58,46 +58,46 @@ }, "location": "centralus", "properties": { - "schedule": { - "status": "Active", - "recurrence": "Monthly", - "recurrencePeriod": { - "from": "2020-06-05T00:00:00Z", - "to": "2030-06-30T00:00:00Z" - } - }, - "nextRunTimeEstimate": "2020-06-05T23:00:00Z", "format": "Csv", - "deliveryInfo": { - "destination": { - "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", - "container": "exports", - "rootFolderPath": "ad-hoc" - } - }, + "compressionMode": "gzip", + "dataOverwriteBehavior": "OverwritePreviousReport", "definition": { "type": "ActualCost", - "timeframe": "TheLastMonth", "dataSet": { - "granularity": "Daily", "configuration": { "dataVersion": "2023-05-01" - } + }, + "granularity": "Daily" + }, + "timeframe": "TheLastMonth" + }, + "deliveryInfo": { + "destination": { + "container": "exports", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "rootFolderPath": "ad-hoc" } }, + "exportDescription": "This is a test export.", + "nextRunTimeEstimate": "2020-06-05T23:00:00Z", "partitionData": true, - "dataOverwriteBehavior": "OverwritePreviousReport", - "compressionMode": "gzip", - "exportDescription": "This is a test export." + "schedule": { + "recurrence": "Monthly", + "recurrencePeriod": { + "from": "2020-06-05T00:00:00Z", + "to": "2030-06-30T00:00:00Z" + }, + "status": "Active" + } } } }, - "200": { + "201": { "body": { - "id": "providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/exports/TestExport", "name": "TestExport", "type": "Microsoft.CostManagement/exports", "eTag": "\"00000000-0000-0000-0000-000000000000\"", + "id": "/providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/exports/TestExport", "identity": { "type": "SystemAssigned", "principalId": "00000000-0000-0000-0000-000000000000", @@ -105,39 +105,41 @@ }, "location": "centralus", "properties": { - "schedule": { - "status": "Active", - "recurrence": "Monthly", - "recurrencePeriod": { - "from": "2020-06-05T00:00:00Z", - "to": "2030-06-30T00:00:00Z" - } - }, - "nextRunTimeEstimate": "2020-06-05T23:00:00Z", "format": "Csv", - "deliveryInfo": { - "destination": { - "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", - "container": "exports", - "rootFolderPath": "ad-hoc" - } - }, + "compressionMode": "gzip", + "dataOverwriteBehavior": "OverwritePreviousReport", "definition": { "type": "ActualCost", - "timeframe": "TheLastMonth", "dataSet": { - "granularity": "Daily", "configuration": { "dataVersion": "2023-05-01" - } + }, + "granularity": "Daily" + }, + "timeframe": "TheLastMonth" + }, + "deliveryInfo": { + "destination": { + "container": "exports", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "rootFolderPath": "ad-hoc" } }, + "exportDescription": "This is a test export.", + "nextRunTimeEstimate": "2020-06-05T23:00:00Z", "partitionData": true, - "dataOverwriteBehavior": "OverwritePreviousReport", - "compressionMode": "gzip", - "exportDescription": "This is a test export." + "schedule": { + "recurrence": "Monthly", + "recurrencePeriod": { + "from": "2020-06-05T00:00:00Z", + "to": "2030-06-30T00:00:00Z" + }, + "status": "Active" + } } } } - } + }, + "operationId": "Exports_CreateOrUpdate", + "title": "ExportCreateOrUpdateByBillingAccountMonthly" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportCreateOrUpdateByBillingAccountPricesheet.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportCreateOrUpdateByBillingAccountPricesheet.json index 0e45f3d8ed63..e46e98534f11 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportCreateOrUpdateByBillingAccountPricesheet.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportCreateOrUpdateByBillingAccountPricesheet.json @@ -2,7 +2,6 @@ "parameters": { "api-version": "2025-03-01", "billingAccountId": "123456", - "scope": "providers/Microsoft.Billing/billingAccounts/123456", "exportName": "TestExport", "parameters": { "identity": { @@ -10,47 +9,48 @@ }, "location": "centralus", "properties": { - "schedule": { - "status": "Active", - "recurrence": "Daily", - "recurrencePeriod": { - "from": "2023-06-01T00:00:00Z", - "to": "2023-06-30T00:00:00Z" - } - }, "format": "Csv", - "deliveryInfo": { - "destination": { - "type": "AzureBlob", - "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", - "container": "exports", - "rootFolderPath": "ad-hoc" - } - }, + "compressionMode": "gzip", + "dataOverwriteBehavior": "OverwritePreviousReport", "definition": { "type": "PriceSheet", - "timeframe": "TheCurrentMonth", "dataSet": { - "granularity": "Daily", "configuration": { "dataVersion": "2023-05-01" - } + }, + "granularity": "Daily" + }, + "timeframe": "TheCurrentMonth" + }, + "deliveryInfo": { + "destination": { + "type": "AzureBlob", + "container": "exports", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "rootFolderPath": "ad-hoc" } }, + "exportDescription": "This is a test export.", "partitionData": true, - "dataOverwriteBehavior": "OverwritePreviousReport", - "compressionMode": "gzip", - "exportDescription": "This is a test export." + "schedule": { + "recurrence": "Daily", + "recurrencePeriod": { + "from": "2023-06-01T00:00:00Z", + "to": "2023-06-30T00:00:00Z" + }, + "status": "Active" + } } - } + }, + "scope": "providers/Microsoft.Billing/billingAccounts/123456" }, "responses": { - "201": { + "200": { "body": { - "id": "providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/exports/TestExport", "name": "TestExport", "type": "Microsoft.CostManagement/exports", "eTag": "\"00000000-0000-0000-0000-000000000000\"", + "id": "/providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/exports/TestExport", "identity": { "type": "SystemAssigned", "principalId": "00000000-0000-0000-0000-000000000000", @@ -58,46 +58,46 @@ }, "location": "centralus", "properties": { - "schedule": { - "status": "Active", - "recurrence": "Daily", - "recurrencePeriod": { - "from": "2023-06-01T00:00:00Z", - "to": "2023-06-30T00:00:00Z" - } - }, - "nextRunTimeEstimate": "2023-06-01T23:00:00Z", "format": "Csv", - "deliveryInfo": { - "destination": { - "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", - "container": "exports", - "rootFolderPath": "ad-hoc" - } - }, + "compressionMode": "gzip", + "dataOverwriteBehavior": "OverwritePreviousReport", "definition": { "type": "PriceSheet", - "timeframe": "TheCurrentMonth", "dataSet": { - "granularity": "Daily", "configuration": { "dataVersion": "2023-05-01" - } + }, + "granularity": "Daily" + }, + "timeframe": "TheCurrentMonth" + }, + "deliveryInfo": { + "destination": { + "container": "exports", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "rootFolderPath": "ad-hoc" } }, + "exportDescription": "This is a test export.", + "nextRunTimeEstimate": "2023-06-01T23:00:00Z", "partitionData": true, - "dataOverwriteBehavior": "OverwritePreviousReport", - "compressionMode": "gzip", - "exportDescription": "This is a test export." + "schedule": { + "recurrence": "Daily", + "recurrencePeriod": { + "from": "2023-06-01T00:00:00Z", + "to": "2023-06-30T00:00:00Z" + }, + "status": "Active" + } } } }, - "200": { + "201": { "body": { - "id": "providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/exports/TestExport", "name": "TestExport", "type": "Microsoft.CostManagement/exports", "eTag": "\"00000000-0000-0000-0000-000000000000\"", + "id": "/providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/exports/TestExport", "identity": { "type": "SystemAssigned", "principalId": "00000000-0000-0000-0000-000000000000", @@ -105,39 +105,41 @@ }, "location": "centralus", "properties": { - "schedule": { - "status": "Active", - "recurrence": "Daily", - "recurrencePeriod": { - "from": "2023-06-01T00:00:00Z", - "to": "2023-06-30T00:00:00Z" - } - }, - "nextRunTimeEstimate": "2023-06-01T23:00:00Z", "format": "Csv", - "deliveryInfo": { - "destination": { - "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", - "container": "exports", - "rootFolderPath": "ad-hoc" - } - }, + "compressionMode": "gzip", + "dataOverwriteBehavior": "OverwritePreviousReport", "definition": { "type": "PriceSheet", - "timeframe": "TheCurrentMonth", "dataSet": { - "granularity": "Daily", "configuration": { "dataVersion": "2023-05-01" - } + }, + "granularity": "Daily" + }, + "timeframe": "TheCurrentMonth" + }, + "deliveryInfo": { + "destination": { + "container": "exports", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "rootFolderPath": "ad-hoc" } }, + "exportDescription": "This is a test export.", + "nextRunTimeEstimate": "2023-06-01T23:00:00Z", "partitionData": true, - "dataOverwriteBehavior": "OverwritePreviousReport", - "compressionMode": "gzip", - "exportDescription": "This is a test export." + "schedule": { + "recurrence": "Daily", + "recurrencePeriod": { + "from": "2023-06-01T00:00:00Z", + "to": "2023-06-30T00:00:00Z" + }, + "status": "Active" + } } } } - } + }, + "operationId": "Exports_CreateOrUpdate", + "title": "ExportCreateOrUpdateByBillingAccountPricesheet" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportCreateOrUpdateByBillingAccountReservationDetails.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportCreateOrUpdateByBillingAccountReservationDetails.json index 390db44fda39..a6168c245276 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportCreateOrUpdateByBillingAccountReservationDetails.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportCreateOrUpdateByBillingAccountReservationDetails.json @@ -2,7 +2,6 @@ "parameters": { "api-version": "2025-03-01", "billingAccountId": "123456", - "scope": "providers/Microsoft.Billing/billingAccounts/123456", "exportName": "TestExport", "parameters": { "identity": { @@ -10,47 +9,48 @@ }, "location": "centralus", "properties": { - "schedule": { - "status": "Active", - "recurrence": "Daily", - "recurrencePeriod": { - "from": "2023-06-01T00:00:00Z", - "to": "2023-06-30T00:00:00Z" - } - }, "format": "Csv", - "deliveryInfo": { - "destination": { - "type": "AzureBlob", - "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", - "container": "exports", - "rootFolderPath": "ad-hoc" - } - }, + "compressionMode": "gzip", + "dataOverwriteBehavior": "OverwritePreviousReport", "definition": { + "type": "ReservationDetails", "dataSet": { "configuration": { "dataVersion": "2023-03-01" }, "granularity": "Daily" }, - "timeframe": "MonthToDate", - "type": "ReservationDetails" + "timeframe": "MonthToDate" + }, + "deliveryInfo": { + "destination": { + "type": "AzureBlob", + "container": "exports", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "rootFolderPath": "ad-hoc" + } }, + "exportDescription": "This is a test export.", "partitionData": true, - "dataOverwriteBehavior": "OverwritePreviousReport", - "compressionMode": "gzip", - "exportDescription": "This is a test export." + "schedule": { + "recurrence": "Daily", + "recurrencePeriod": { + "from": "2023-06-01T00:00:00Z", + "to": "2023-06-30T00:00:00Z" + }, + "status": "Active" + } } - } + }, + "scope": "providers/Microsoft.Billing/billingAccounts/123456" }, "responses": { - "201": { + "200": { "body": { - "id": "providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/exports/TestExport", "name": "TestExport", "type": "Microsoft.CostManagement/exports", "eTag": "\"00000000-0000-0000-0000-000000000000\"", + "id": "/providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/exports/TestExport", "identity": { "type": "SystemAssigned", "principalId": "00000000-0000-0000-0000-000000000000", @@ -58,26 +58,11 @@ }, "location": "centralus", "properties": { - "schedule": { - "status": "Active", - "recurrence": "Daily", - "recurrencePeriod": { - "from": "2023-06-01T00:00:00Z", - "to": "2023-06-30T00:00:00Z" - } - }, - "nextRunTimeEstimate": "2023-06-01T23:00:00Z", "format": "Csv", - "deliveryInfo": { - "destination": { - "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", - "container": "exports", - "rootFolderPath": "ad-hoc" - } - }, + "compressionMode": "gzip", + "dataOverwriteBehavior": "OverwritePreviousReport", "definition": { "type": "ReservationDetails", - "timeframe": "MonthToDate", "dataSet": { "configuration": { "columns": [], @@ -85,21 +70,36 @@ "filters": [] }, "granularity": "Daily" + }, + "timeframe": "MonthToDate" + }, + "deliveryInfo": { + "destination": { + "container": "exports", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "rootFolderPath": "ad-hoc" } }, + "exportDescription": "This is a test export.", + "nextRunTimeEstimate": "2023-06-01T23:00:00Z", "partitionData": true, - "dataOverwriteBehavior": "OverwritePreviousReport", - "compressionMode": "gzip", - "exportDescription": "This is a test export." + "schedule": { + "recurrence": "Daily", + "recurrencePeriod": { + "from": "2023-06-01T00:00:00Z", + "to": "2023-06-30T00:00:00Z" + }, + "status": "Active" + } } } }, - "200": { + "201": { "body": { - "id": "providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/exports/TestExport", "name": "TestExport", "type": "Microsoft.CostManagement/exports", "eTag": "\"00000000-0000-0000-0000-000000000000\"", + "id": "/providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/exports/TestExport", "identity": { "type": "SystemAssigned", "principalId": "00000000-0000-0000-0000-000000000000", @@ -107,26 +107,11 @@ }, "location": "centralus", "properties": { - "schedule": { - "status": "Active", - "recurrence": "Daily", - "recurrencePeriod": { - "from": "2023-06-01T00:00:00Z", - "to": "2023-06-30T00:00:00Z" - } - }, - "nextRunTimeEstimate": "2023-06-01T23:00:00Z", "format": "Csv", - "deliveryInfo": { - "destination": { - "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", - "container": "exports", - "rootFolderPath": "ad-hoc" - } - }, + "compressionMode": "gzip", + "dataOverwriteBehavior": "OverwritePreviousReport", "definition": { "type": "ReservationDetails", - "timeframe": "MonthToDate", "dataSet": { "configuration": { "columns": [], @@ -134,14 +119,31 @@ "filters": [] }, "granularity": "Daily" + }, + "timeframe": "MonthToDate" + }, + "deliveryInfo": { + "destination": { + "container": "exports", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "rootFolderPath": "ad-hoc" } }, + "exportDescription": "This is a test export.", + "nextRunTimeEstimate": "2023-06-01T23:00:00Z", "partitionData": true, - "dataOverwriteBehavior": "OverwritePreviousReport", - "compressionMode": "gzip", - "exportDescription": "This is a test export." + "schedule": { + "recurrence": "Daily", + "recurrencePeriod": { + "from": "2023-06-01T00:00:00Z", + "to": "2023-06-30T00:00:00Z" + }, + "status": "Active" + } } } } - } + }, + "operationId": "Exports_CreateOrUpdate", + "title": "ExportCreateOrUpdateByBillingAccountReservationDetails" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportCreateOrUpdateByBillingAccountReservationRecommendation.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportCreateOrUpdateByBillingAccountReservationRecommendation.json index 4fc700fc835d..f536a04b6411 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportCreateOrUpdateByBillingAccountReservationRecommendation.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportCreateOrUpdateByBillingAccountReservationRecommendation.json @@ -2,7 +2,6 @@ "parameters": { "api-version": "2025-03-01", "billingAccountId": "123456", - "scope": "providers/Microsoft.Billing/billingAccounts/123456", "exportName": "TestExport", "parameters": { "identity": { @@ -10,24 +9,11 @@ }, "location": "centralus", "properties": { - "schedule": { - "status": "Active", - "recurrence": "Daily", - "recurrencePeriod": { - "from": "2023-06-01T00:00:00Z", - "to": "2023-06-30T00:00:00Z" - } - }, "format": "Csv", - "deliveryInfo": { - "destination": { - "type": "AzureBlob", - "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", - "container": "exports", - "rootFolderPath": "ad-hoc" - } - }, + "compressionMode": "gzip", + "dataOverwriteBehavior": "OverwritePreviousReport", "definition": { + "type": "ReservationRecommendations", "dataSet": { "configuration": { "dataVersion": "2023-05-01", @@ -47,23 +33,37 @@ ] } }, - "timeframe": "MonthToDate", - "type": "ReservationRecommendations" + "timeframe": "MonthToDate" }, + "deliveryInfo": { + "destination": { + "type": "AzureBlob", + "container": "exports", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "rootFolderPath": "ad-hoc" + } + }, + "exportDescription": "This is a test export.", "partitionData": true, - "dataOverwriteBehavior": "OverwritePreviousReport", - "compressionMode": "gzip", - "exportDescription": "This is a test export." + "schedule": { + "recurrence": "Daily", + "recurrencePeriod": { + "from": "2023-06-01T00:00:00Z", + "to": "2023-06-30T00:00:00Z" + }, + "status": "Active" + } } - } + }, + "scope": "providers/Microsoft.Billing/billingAccounts/123456" }, "responses": { - "201": { + "200": { "body": { - "id": "providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/exports/TestExport", "name": "TestExport", "type": "Microsoft.CostManagement/exports", "eTag": "\"00000000-0000-0000-0000-000000000000\"", + "id": "/providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/exports/TestExport", "identity": { "type": "SystemAssigned", "principalId": "00000000-0000-0000-0000-000000000000", @@ -71,26 +71,11 @@ }, "location": "centralus", "properties": { - "schedule": { - "status": "Active", - "recurrence": "Daily", - "recurrencePeriod": { - "from": "2023-06-01T00:00:00Z", - "to": "2023-06-30T00:00:00Z" - } - }, - "nextRunTimeEstimate": "2023-06-01T23:00:00Z", "format": "Csv", - "deliveryInfo": { - "destination": { - "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", - "container": "exports", - "rootFolderPath": "ad-hoc" - } - }, + "compressionMode": "gzip", + "dataOverwriteBehavior": "OverwritePreviousReport", "definition": { "type": "ReservationRecommendations", - "timeframe": "MonthToDate", "dataSet": { "configuration": { "columns": [], @@ -111,21 +96,36 @@ ] }, "granularity": null + }, + "timeframe": "MonthToDate" + }, + "deliveryInfo": { + "destination": { + "container": "exports", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "rootFolderPath": "ad-hoc" } }, + "exportDescription": "This is a test export.", + "nextRunTimeEstimate": "2023-06-01T23:00:00Z", "partitionData": true, - "dataOverwriteBehavior": "OverwritePreviousReport", - "compressionMode": "gzip", - "exportDescription": "This is a test export." + "schedule": { + "recurrence": "Daily", + "recurrencePeriod": { + "from": "2023-06-01T00:00:00Z", + "to": "2023-06-30T00:00:00Z" + }, + "status": "Active" + } } } }, - "200": { + "201": { "body": { - "id": "providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/exports/TestExport", "name": "TestExport", "type": "Microsoft.CostManagement/exports", "eTag": "\"00000000-0000-0000-0000-000000000000\"", + "id": "/providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/exports/TestExport", "identity": { "type": "SystemAssigned", "principalId": "00000000-0000-0000-0000-000000000000", @@ -133,26 +133,11 @@ }, "location": "centralus", "properties": { - "schedule": { - "status": "Active", - "recurrence": "Daily", - "recurrencePeriod": { - "from": "2023-06-01T00:00:00Z", - "to": "2023-06-30T00:00:00Z" - } - }, - "nextRunTimeEstimate": "2023-06-01T23:00:00Z", "format": "Csv", - "deliveryInfo": { - "destination": { - "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", - "container": "exports", - "rootFolderPath": "ad-hoc" - } - }, + "compressionMode": "gzip", + "dataOverwriteBehavior": "OverwritePreviousReport", "definition": { "type": "ReservationRecommendations", - "timeframe": "MonthToDate", "dataSet": { "configuration": { "columns": [], @@ -173,14 +158,31 @@ ] }, "granularity": null + }, + "timeframe": "MonthToDate" + }, + "deliveryInfo": { + "destination": { + "container": "exports", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "rootFolderPath": "ad-hoc" } }, + "exportDescription": "This is a test export.", + "nextRunTimeEstimate": "2023-06-01T23:00:00Z", "partitionData": true, - "dataOverwriteBehavior": "OverwritePreviousReport", - "compressionMode": "gzip", - "exportDescription": "This is a test export." + "schedule": { + "recurrence": "Daily", + "recurrencePeriod": { + "from": "2023-06-01T00:00:00Z", + "to": "2023-06-30T00:00:00Z" + }, + "status": "Active" + } } } } - } + }, + "operationId": "Exports_CreateOrUpdate", + "title": "ExportCreateOrUpdateByBillingAccountReservationRecommendation" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportCreateOrUpdateByBillingAccountReservationTransactions.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportCreateOrUpdateByBillingAccountReservationTransactions.json index 918d429cc803..f5bfdbd19e0f 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportCreateOrUpdateByBillingAccountReservationTransactions.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportCreateOrUpdateByBillingAccountReservationTransactions.json @@ -2,7 +2,6 @@ "parameters": { "api-version": "2025-03-01", "billingAccountId": "123456", - "scope": "providers/Microsoft.Billing/billingAccounts/123456", "exportName": "TestExport", "parameters": { "identity": { @@ -10,46 +9,47 @@ }, "location": "centralus", "properties": { - "schedule": { - "status": "Active", - "recurrence": "Daily", - "recurrencePeriod": { - "from": "2023-06-01T00:00:00Z", - "to": "2023-06-30T00:00:00Z" - } - }, "format": "Csv", - "deliveryInfo": { - "destination": { - "type": "AzureBlob", - "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", - "container": "exports", - "rootFolderPath": "ad-hoc" - } - }, + "compressionMode": "gzip", + "dataOverwriteBehavior": "OverwritePreviousReport", "definition": { + "type": "ReservationTransactions", "dataSet": { "configuration": { "dataVersion": "2023-05-01" } }, - "timeframe": "MonthToDate", - "type": "ReservationTransactions" + "timeframe": "MonthToDate" }, + "deliveryInfo": { + "destination": { + "type": "AzureBlob", + "container": "exports", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "rootFolderPath": "ad-hoc" + } + }, + "exportDescription": "This is a test export.", "partitionData": true, - "dataOverwriteBehavior": "OverwritePreviousReport", - "compressionMode": "gzip", - "exportDescription": "This is a test export." + "schedule": { + "recurrence": "Daily", + "recurrencePeriod": { + "from": "2023-06-01T00:00:00Z", + "to": "2023-06-30T00:00:00Z" + }, + "status": "Active" + } } - } + }, + "scope": "providers/Microsoft.Billing/billingAccounts/123456" }, "responses": { - "201": { + "200": { "body": { - "id": "providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/exports/TestExport", "name": "TestExport", "type": "Microsoft.CostManagement/exports", "eTag": "\"00000000-0000-0000-0000-000000000000\"", + "id": "/providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/exports/TestExport", "identity": { "type": "SystemAssigned", "principalId": "00000000-0000-0000-0000-000000000000", @@ -57,26 +57,11 @@ }, "location": "centralus", "properties": { - "schedule": { - "status": "Active", - "recurrence": "Daily", - "recurrencePeriod": { - "from": "2023-06-01T00:00:00Z", - "to": "2023-06-30T00:00:00Z" - } - }, - "nextRunTimeEstimate": "2023-06-01T23:00:00Z", "format": "Csv", - "deliveryInfo": { - "destination": { - "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", - "container": "exports", - "rootFolderPath": "ad-hoc" - } - }, + "compressionMode": "gzip", + "dataOverwriteBehavior": "OverwritePreviousReport", "definition": { "type": "ReservationTransactions", - "timeframe": "MonthToDate", "dataSet": { "configuration": { "columns": [], @@ -84,21 +69,36 @@ "filters": [] }, "granularity": null + }, + "timeframe": "MonthToDate" + }, + "deliveryInfo": { + "destination": { + "container": "exports", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "rootFolderPath": "ad-hoc" } }, + "exportDescription": "This is a test export.", + "nextRunTimeEstimate": "2023-06-01T23:00:00Z", "partitionData": true, - "dataOverwriteBehavior": "OverwritePreviousReport", - "compressionMode": "gzip", - "exportDescription": "This is a test export." + "schedule": { + "recurrence": "Daily", + "recurrencePeriod": { + "from": "2023-06-01T00:00:00Z", + "to": "2023-06-30T00:00:00Z" + }, + "status": "Active" + } } } }, - "200": { + "201": { "body": { - "id": "providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/exports/TestExport", "name": "TestExport", "type": "Microsoft.CostManagement/exports", "eTag": "\"00000000-0000-0000-0000-000000000000\"", + "id": "/providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/exports/TestExport", "identity": { "type": "SystemAssigned", "principalId": "00000000-0000-0000-0000-000000000000", @@ -106,26 +106,11 @@ }, "location": "centralus", "properties": { - "schedule": { - "status": "Active", - "recurrence": "Daily", - "recurrencePeriod": { - "from": "2023-06-01T00:00:00Z", - "to": "2023-06-30T00:00:00Z" - } - }, - "nextRunTimeEstimate": "2023-06-01T23:00:00Z", "format": "Csv", - "deliveryInfo": { - "destination": { - "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", - "container": "exports", - "rootFolderPath": "ad-hoc" - } - }, + "compressionMode": "gzip", + "dataOverwriteBehavior": "OverwritePreviousReport", "definition": { "type": "ReservationTransactions", - "timeframe": "MonthToDate", "dataSet": { "configuration": { "columns": [], @@ -133,14 +118,31 @@ "filters": [] }, "granularity": null + }, + "timeframe": "MonthToDate" + }, + "deliveryInfo": { + "destination": { + "container": "exports", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "rootFolderPath": "ad-hoc" } }, + "exportDescription": "This is a test export.", + "nextRunTimeEstimate": "2023-06-01T23:00:00Z", "partitionData": true, - "dataOverwriteBehavior": "OverwritePreviousReport", - "compressionMode": "gzip", - "exportDescription": "This is a test export." + "schedule": { + "recurrence": "Daily", + "recurrencePeriod": { + "from": "2023-06-01T00:00:00Z", + "to": "2023-06-30T00:00:00Z" + }, + "status": "Active" + } } } } - } + }, + "operationId": "Exports_CreateOrUpdate", + "title": "ExportCreateOrUpdateExportCreateOrUpdateByBillingAccountReservationTransactionsByBillingAccount" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportCreateOrUpdateByDepartment.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportCreateOrUpdateByDepartment.json index 529bdb66990f..a3772d0e8c20 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportCreateOrUpdateByDepartment.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportCreateOrUpdateByDepartment.json @@ -3,7 +3,6 @@ "api-version": "2025-03-01", "billingAccountId": "12", "departmentId": "1234", - "scope": "providers/Microsoft.Billing/billingAccounts/12/departments/1234", "exportName": "TestExport", "parameters": { "identity": { @@ -11,47 +10,48 @@ }, "location": "centralus", "properties": { - "schedule": { - "status": "Active", - "recurrence": "Daily", - "recurrencePeriod": { - "from": "2020-06-01T00:00:00Z", - "to": "2020-06-30T00:00:00Z" - } - }, "format": "Parquet", - "deliveryInfo": { - "destination": { - "type": "AzureBlob", - "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", - "container": "exports", - "rootFolderPath": "ad-hoc" - } - }, + "compressionMode": "snappy", + "dataOverwriteBehavior": "OverwritePreviousReport", "definition": { "type": "ActualCost", - "timeframe": "MonthToDate", "dataSet": { - "granularity": "Daily", "configuration": { "dataVersion": "2023-05-01" - } + }, + "granularity": "Daily" + }, + "timeframe": "MonthToDate" + }, + "deliveryInfo": { + "destination": { + "type": "AzureBlob", + "container": "exports", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "rootFolderPath": "ad-hoc" } }, + "exportDescription": "This is a test export.", "partitionData": true, - "dataOverwriteBehavior": "OverwritePreviousReport", - "compressionMode": "snappy", - "exportDescription": "This is a test export." + "schedule": { + "recurrence": "Daily", + "recurrencePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-06-30T00:00:00Z" + }, + "status": "Active" + } } - } + }, + "scope": "providers/Microsoft.Billing/billingAccounts/12/departments/1234" }, "responses": { - "201": { + "200": { "body": { - "id": "providers/Microsoft.Billing/billingAccounts/12/departments/1234/providers/Microsoft.CostManagement/exports/TestExport", "name": "TestExport", "type": "Microsoft.CostManagement/exports", "eTag": "\"00000000-0000-0000-0000-000000000000\"", + "id": "/providers/Microsoft.Billing/billingAccounts/12/departments/1234/providers/Microsoft.CostManagement/exports/TestExport", "identity": { "type": "SystemAssigned", "principalId": "00000000-0000-0000-0000-000000000000", @@ -59,46 +59,46 @@ }, "location": "centralus", "properties": { - "schedule": { - "status": "Active", - "recurrence": "Daily", - "recurrencePeriod": { - "from": "2020-06-01T00:00:00Z", - "to": "2020-06-30T00:00:00Z" - } - }, - "nextRunTimeEstimate": "2020-06-01T23:00:00Z", "format": "Parquet", - "deliveryInfo": { - "destination": { - "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", - "container": "exports", - "rootFolderPath": "ad-hoc" - } - }, + "compressionMode": "snappy", + "dataOverwriteBehavior": "OverwritePreviousReport", "definition": { "type": "ActualCost", - "timeframe": "MonthToDate", "dataSet": { - "granularity": "Daily", "configuration": { "dataVersion": "2023-05-01" - } + }, + "granularity": "Daily" + }, + "timeframe": "MonthToDate" + }, + "deliveryInfo": { + "destination": { + "container": "exports", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "rootFolderPath": "ad-hoc" } }, + "exportDescription": "This is a test export.", + "nextRunTimeEstimate": "2020-06-01T23:00:00Z", "partitionData": true, - "dataOverwriteBehavior": "OverwritePreviousReport", - "compressionMode": "snappy", - "exportDescription": "This is a test export." + "schedule": { + "recurrence": "Daily", + "recurrencePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-06-30T00:00:00Z" + }, + "status": "Active" + } } } }, - "200": { + "201": { "body": { - "id": "providers/Microsoft.Billing/billingAccounts/12/departments/1234/providers/Microsoft.CostManagement/exports/TestExport", "name": "TestExport", "type": "Microsoft.CostManagement/exports", "eTag": "\"00000000-0000-0000-0000-000000000000\"", + "id": "/providers/Microsoft.Billing/billingAccounts/12/departments/1234/providers/Microsoft.CostManagement/exports/TestExport", "identity": { "type": "SystemAssigned", "principalId": "00000000-0000-0000-0000-000000000000", @@ -106,39 +106,41 @@ }, "location": "centralus", "properties": { - "schedule": { - "status": "Active", - "recurrence": "Daily", - "recurrencePeriod": { - "from": "2020-06-01T00:00:00Z", - "to": "2020-06-30T00:00:00Z" - } - }, - "nextRunTimeEstimate": "2020-06-01T23:00:00Z", "format": "Parquet", - "deliveryInfo": { - "destination": { - "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", - "container": "exports", - "rootFolderPath": "ad-hoc" - } - }, + "compressionMode": "snappy", + "dataOverwriteBehavior": "OverwritePreviousReport", "definition": { "type": "ActualCost", - "timeframe": "MonthToDate", "dataSet": { - "granularity": "Daily", "configuration": { "dataVersion": "2023-05-01" - } + }, + "granularity": "Daily" + }, + "timeframe": "MonthToDate" + }, + "deliveryInfo": { + "destination": { + "container": "exports", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "rootFolderPath": "ad-hoc" } }, + "exportDescription": "This is a test export.", + "nextRunTimeEstimate": "2020-06-01T23:00:00Z", "partitionData": true, - "dataOverwriteBehavior": "OverwritePreviousReport", - "compressionMode": "snappy", - "exportDescription": "This is a test export." + "schedule": { + "recurrence": "Daily", + "recurrencePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-06-30T00:00:00Z" + }, + "status": "Active" + } } } } - } + }, + "operationId": "Exports_CreateOrUpdate", + "title": "ExportCreateOrUpdateByDepartment" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportCreateOrUpdateByEnrollmentAccount.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportCreateOrUpdateByEnrollmentAccount.json index 035780829ee4..cda44651df30 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportCreateOrUpdateByEnrollmentAccount.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportCreateOrUpdateByEnrollmentAccount.json @@ -3,7 +3,6 @@ "api-version": "2025-03-01", "billingAccountId": "100", "enrollmentAccountId": "456", - "scope": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456", "exportName": "TestExport", "parameters": { "identity": { @@ -11,47 +10,48 @@ }, "location": "centralus", "properties": { - "schedule": { - "status": "Active", - "recurrence": "Daily", - "recurrencePeriod": { - "from": "2020-06-01T00:00:00Z", - "to": "2020-06-30T00:00:00Z" - } - }, "format": "Csv", - "deliveryInfo": { - "destination": { - "type": "AzureBlob", - "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", - "container": "exports", - "rootFolderPath": "ad-hoc" - } - }, + "compressionMode": "gzip", + "dataOverwriteBehavior": "OverwritePreviousReport", "definition": { "type": "ActualCost", - "timeframe": "MonthToDate", "dataSet": { - "granularity": "Daily", "configuration": { "dataVersion": "2023-05-01" - } + }, + "granularity": "Daily" + }, + "timeframe": "MonthToDate" + }, + "deliveryInfo": { + "destination": { + "type": "AzureBlob", + "container": "exports", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "rootFolderPath": "ad-hoc" } }, + "exportDescription": "This is a test export.", "partitionData": true, - "dataOverwriteBehavior": "OverwritePreviousReport", - "compressionMode": "gzip", - "exportDescription": "This is a test export." + "schedule": { + "recurrence": "Daily", + "recurrencePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-06-30T00:00:00Z" + }, + "status": "Active" + } } - } + }, + "scope": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456" }, "responses": { - "201": { + "200": { "body": { - "id": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456/providers/Microsoft.CostManagement/exports/TestExport", "name": "TestExport", "type": "Microsoft.CostManagement/exports", "eTag": "\"00000000-0000-0000-0000-000000000000\"", + "id": "/providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456/providers/Microsoft.CostManagement/exports/TestExport", "identity": { "type": "SystemAssigned", "principalId": "00000000-0000-0000-0000-000000000000", @@ -59,46 +59,46 @@ }, "location": "centralus", "properties": { - "schedule": { - "status": "Active", - "recurrence": "Daily", - "recurrencePeriod": { - "from": "2020-06-01T00:00:00Z", - "to": "2020-06-30T00:00:00Z" - } - }, - "nextRunTimeEstimate": "2020-06-01T23:00:00Z", "format": "Csv", - "deliveryInfo": { - "destination": { - "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", - "container": "exports", - "rootFolderPath": "ad-hoc" - } - }, + "compressionMode": "gzip", + "dataOverwriteBehavior": "OverwritePreviousReport", "definition": { "type": "ActualCost", - "timeframe": "MonthToDate", "dataSet": { - "granularity": "Daily", "configuration": { "dataVersion": "2023-05-01" - } + }, + "granularity": "Daily" + }, + "timeframe": "MonthToDate" + }, + "deliveryInfo": { + "destination": { + "container": "exports", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "rootFolderPath": "ad-hoc" } }, + "exportDescription": "This is a test export.", + "nextRunTimeEstimate": "2020-06-01T23:00:00Z", "partitionData": true, - "dataOverwriteBehavior": "OverwritePreviousReport", - "compressionMode": "gzip", - "exportDescription": "This is a test export." + "schedule": { + "recurrence": "Daily", + "recurrencePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-06-30T00:00:00Z" + }, + "status": "Active" + } } } }, - "200": { + "201": { "body": { - "id": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456/providers/Microsoft.CostManagement/exports/TestExport", "name": "TestExport", "type": "Microsoft.CostManagement/exports", "eTag": "\"00000000-0000-0000-0000-000000000000\"", + "id": "/providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456/providers/Microsoft.CostManagement/exports/TestExport", "identity": { "type": "SystemAssigned", "principalId": "00000000-0000-0000-0000-000000000000", @@ -106,39 +106,41 @@ }, "location": "centralus", "properties": { - "schedule": { - "status": "Active", - "recurrence": "Daily", - "recurrencePeriod": { - "from": "2020-06-01T00:00:00Z", - "to": "2020-06-30T00:00:00Z" - } - }, - "nextRunTimeEstimate": "2020-06-01T23:00:00Z", "format": "Csv", - "deliveryInfo": { - "destination": { - "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", - "container": "exports", - "rootFolderPath": "ad-hoc" - } - }, + "compressionMode": "gzip", + "dataOverwriteBehavior": "OverwritePreviousReport", "definition": { "type": "ActualCost", - "timeframe": "MonthToDate", "dataSet": { - "granularity": "Daily", "configuration": { "dataVersion": "2023-05-01" - } + }, + "granularity": "Daily" + }, + "timeframe": "MonthToDate" + }, + "deliveryInfo": { + "destination": { + "container": "exports", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "rootFolderPath": "ad-hoc" } }, + "exportDescription": "This is a test export.", + "nextRunTimeEstimate": "2020-06-01T23:00:00Z", "partitionData": true, - "dataOverwriteBehavior": "OverwritePreviousReport", - "compressionMode": "gzip", - "exportDescription": "This is a test export." + "schedule": { + "recurrence": "Daily", + "recurrencePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-06-30T00:00:00Z" + }, + "status": "Active" + } } } } - } + }, + "operationId": "Exports_CreateOrUpdate", + "title": "ExportCreateOrUpdateByEnrollmentAccount" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportCreateOrUpdateByManagementGroup.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportCreateOrUpdateByManagementGroup.json index b88dea6c01bc..da7535f5aaa8 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportCreateOrUpdateByManagementGroup.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportCreateOrUpdateByManagementGroup.json @@ -1,56 +1,56 @@ { "parameters": { "api-version": "2025-03-01", - "managementGroupId": "TestMG", - "scope": "providers/Microsoft.Management/managementGroups/TestMG", "exportName": "TestExport", + "managementGroupId": "TestMG", "parameters": { "identity": { "type": "SystemAssigned" }, "location": "centralus", "properties": { - "schedule": { - "status": "Active", - "recurrence": "Daily", - "recurrencePeriod": { - "from": "2020-06-01T00:00:00Z", - "to": "2020-06-30T00:00:00Z" - } - }, "format": "Csv", - "deliveryInfo": { - "destination": { - "type": "AzureBlob", - "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", - "container": "exports", - "rootFolderPath": "ad-hoc" - } - }, + "compressionMode": "gzip", + "dataOverwriteBehavior": "OverwritePreviousReport", "definition": { "type": "ActualCost", - "timeframe": "MonthToDate", "dataSet": { - "granularity": "Daily", "configuration": { "dataVersion": "2023-05-01" - } + }, + "granularity": "Daily" + }, + "timeframe": "MonthToDate" + }, + "deliveryInfo": { + "destination": { + "type": "AzureBlob", + "container": "exports", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "rootFolderPath": "ad-hoc" } }, + "exportDescription": "This is a test export.", "partitionData": true, - "dataOverwriteBehavior": "OverwritePreviousReport", - "compressionMode": "gzip", - "exportDescription": "This is a test export." + "schedule": { + "recurrence": "Daily", + "recurrencePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-06-30T00:00:00Z" + }, + "status": "Active" + } } - } + }, + "scope": "providers/Microsoft.Management/managementGroups/TestMG" }, "responses": { - "201": { + "200": { "body": { - "id": "providers/Microsoft.Management/managementGroups/TestMG/providers/Microsoft.CostManagement/exports/TestExport", "name": "TestExport", "type": "Microsoft.CostManagement/exports", "eTag": "\"00000000-0000-0000-0000-000000000000\"", + "id": "/providers/Microsoft.Management/managementGroups/TestMG/providers/Microsoft.CostManagement/exports/TestExport", "identity": { "type": "SystemAssigned", "principalId": "00000000-0000-0000-0000-000000000000", @@ -58,46 +58,46 @@ }, "location": "centralus", "properties": { - "schedule": { - "status": "Active", - "recurrence": "Daily", - "recurrencePeriod": { - "from": "2020-06-01T00:00:00Z", - "to": "2020-06-30T00:00:00Z" - } - }, - "nextRunTimeEstimate": "2020-06-01T23:00:00Z", "format": "Csv", - "deliveryInfo": { - "destination": { - "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", - "container": "exports", - "rootFolderPath": "ad-hoc" - } - }, + "compressionMode": "gzip", + "dataOverwriteBehavior": "OverwritePreviousReport", "definition": { "type": "ActualCost", - "timeframe": "MonthToDate", "dataSet": { - "granularity": "Daily", "configuration": { "dataVersion": "2023-05-01" - } + }, + "granularity": "Daily" + }, + "timeframe": "MonthToDate" + }, + "deliveryInfo": { + "destination": { + "container": "exports", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "rootFolderPath": "ad-hoc" } }, + "exportDescription": "This is a test export.", + "nextRunTimeEstimate": "2020-06-01T23:00:00Z", "partitionData": true, - "dataOverwriteBehavior": "OverwritePreviousReport", - "compressionMode": "gzip", - "exportDescription": "This is a test export." + "schedule": { + "recurrence": "Daily", + "recurrencePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-06-30T00:00:00Z" + }, + "status": "Active" + } } } }, - "200": { + "201": { "body": { - "id": "providers/Microsoft.Management/managementGroups/TestMG/providers/Microsoft.CostManagement/exports/TestExport", "name": "TestExport", "type": "Microsoft.CostManagement/exports", "eTag": "\"00000000-0000-0000-0000-000000000000\"", + "id": "/providers/Microsoft.Management/managementGroups/TestMG/providers/Microsoft.CostManagement/exports/TestExport", "identity": { "type": "SystemAssigned", "principalId": "00000000-0000-0000-0000-000000000000", @@ -105,39 +105,41 @@ }, "location": "centralus", "properties": { - "schedule": { - "status": "Active", - "recurrence": "Daily", - "recurrencePeriod": { - "from": "2020-06-01T00:00:00Z", - "to": "2020-06-30T00:00:00Z" - } - }, - "nextRunTimeEstimate": "2020-06-01T23:00:00Z", "format": "Csv", - "deliveryInfo": { - "destination": { - "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", - "container": "exports", - "rootFolderPath": "ad-hoc" - } - }, + "compressionMode": "gzip", + "dataOverwriteBehavior": "OverwritePreviousReport", "definition": { "type": "ActualCost", - "timeframe": "MonthToDate", "dataSet": { - "granularity": "Daily", "configuration": { "dataVersion": "2023-05-01" - } + }, + "granularity": "Daily" + }, + "timeframe": "MonthToDate" + }, + "deliveryInfo": { + "destination": { + "container": "exports", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "rootFolderPath": "ad-hoc" } }, + "exportDescription": "This is a test export.", + "nextRunTimeEstimate": "2020-06-01T23:00:00Z", "partitionData": true, - "dataOverwriteBehavior": "OverwritePreviousReport", - "compressionMode": "gzip", - "exportDescription": "This is a test export." + "schedule": { + "recurrence": "Daily", + "recurrencePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-06-30T00:00:00Z" + }, + "status": "Active" + } } } } - } + }, + "operationId": "Exports_CreateOrUpdate", + "title": "ExportCreateOrUpdateByManagementGroup" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportCreateOrUpdateByResourceGroup.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportCreateOrUpdateByResourceGroup.json index 09661cd4a9ab..4e251c440f6e 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportCreateOrUpdateByResourceGroup.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportCreateOrUpdateByResourceGroup.json @@ -1,9 +1,6 @@ { "parameters": { "api-version": "2025-03-01", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "MYDEVTESTRG", - "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG", "exportName": "TestExport", "parameters": { "identity": { @@ -11,47 +8,50 @@ }, "location": "centralus", "properties": { - "schedule": { - "status": "Active", - "recurrence": "Daily", - "recurrencePeriod": { - "from": "2020-06-01T00:00:00Z", - "to": "2020-06-30T00:00:00Z" - } - }, "format": "Csv", - "deliveryInfo": { - "destination": { - "type": "AzureBlob", - "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", - "container": "exports", - "rootFolderPath": "ad-hoc" - } - }, + "compressionMode": "gzip", + "dataOverwriteBehavior": "OverwritePreviousReport", "definition": { "type": "ActualCost", - "timeframe": "MonthToDate", "dataSet": { - "granularity": "Daily", "configuration": { "dataVersion": "2023-05-01" - } + }, + "granularity": "Daily" + }, + "timeframe": "MonthToDate" + }, + "deliveryInfo": { + "destination": { + "type": "AzureBlob", + "container": "exports", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "rootFolderPath": "ad-hoc" } }, + "exportDescription": "This is a test export.", "partitionData": true, - "dataOverwriteBehavior": "OverwritePreviousReport", - "compressionMode": "gzip", - "exportDescription": "This is a test export." + "schedule": { + "recurrence": "Daily", + "recurrencePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-06-30T00:00:00Z" + }, + "status": "Active" + } } - } + }, + "resourceGroupName": "MYDEVTESTRG", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { - "201": { + "200": { "body": { - "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/exports/TestExport", "name": "TestExport", "type": "Microsoft.CostManagement/exports", "eTag": "\"00000000-0000-0000-0000-000000000000\"", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/exports/TestExport", "identity": { "type": "SystemAssigned", "principalId": "00000000-0000-0000-0000-000000000000", @@ -59,46 +59,46 @@ }, "location": "centralus", "properties": { - "schedule": { - "status": "Active", - "recurrence": "Daily", - "recurrencePeriod": { - "from": "2020-06-01T00:00:00Z", - "to": "2020-06-30T00:00:00Z" - } - }, - "nextRunTimeEstimate": "2020-06-01T23:00:00Z", "format": "Csv", - "deliveryInfo": { - "destination": { - "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", - "container": "exports", - "rootFolderPath": "ad-hoc" - } - }, + "compressionMode": "gzip", + "dataOverwriteBehavior": "OverwritePreviousReport", "definition": { "type": "ActualCost", - "timeframe": "MonthToDate", "dataSet": { - "granularity": "Daily", "configuration": { "dataVersion": "2023-05-01" - } + }, + "granularity": "Daily" + }, + "timeframe": "MonthToDate" + }, + "deliveryInfo": { + "destination": { + "container": "exports", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "rootFolderPath": "ad-hoc" } }, + "exportDescription": "This is a test export.", + "nextRunTimeEstimate": "2020-06-01T23:00:00Z", "partitionData": true, - "dataOverwriteBehavior": "OverwritePreviousReport", - "compressionMode": "gzip", - "exportDescription": "This is a test export." + "schedule": { + "recurrence": "Daily", + "recurrencePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-06-30T00:00:00Z" + }, + "status": "Active" + } } } }, - "200": { + "201": { "body": { - "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/exports/TestExport", "name": "TestExport", "type": "Microsoft.CostManagement/exports", "eTag": "\"00000000-0000-0000-0000-000000000000\"", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/exports/TestExport", "identity": { "type": "SystemAssigned", "principalId": "00000000-0000-0000-0000-000000000000", @@ -106,39 +106,41 @@ }, "location": "centralus", "properties": { - "schedule": { - "status": "Active", - "recurrence": "Daily", - "recurrencePeriod": { - "from": "2020-06-01T00:00:00Z", - "to": "2020-06-30T00:00:00Z" - } - }, - "nextRunTimeEstimate": "2020-06-01T23:00:00Z", "format": "Csv", - "deliveryInfo": { - "destination": { - "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", - "container": "exports", - "rootFolderPath": "ad-hoc" - } - }, + "compressionMode": "gzip", + "dataOverwriteBehavior": "OverwritePreviousReport", "definition": { "type": "ActualCost", - "timeframe": "MonthToDate", "dataSet": { - "granularity": "Daily", "configuration": { "dataVersion": "2023-05-01" - } + }, + "granularity": "Daily" + }, + "timeframe": "MonthToDate" + }, + "deliveryInfo": { + "destination": { + "container": "exports", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "rootFolderPath": "ad-hoc" } }, + "exportDescription": "This is a test export.", + "nextRunTimeEstimate": "2020-06-01T23:00:00Z", "partitionData": true, - "dataOverwriteBehavior": "OverwritePreviousReport", - "compressionMode": "gzip", - "exportDescription": "This is a test export." + "schedule": { + "recurrence": "Daily", + "recurrencePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-06-30T00:00:00Z" + }, + "status": "Active" + } } } } - } + }, + "operationId": "Exports_CreateOrUpdate", + "title": "ExportCreateOrUpdateByResourceGroup" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportCreateOrUpdateBySubscription.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportCreateOrUpdateBySubscription.json index c1aae0356b94..6994ba94a112 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportCreateOrUpdateBySubscription.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportCreateOrUpdateBySubscription.json @@ -1,8 +1,6 @@ { "parameters": { "api-version": "2025-03-01", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "scope": "subscriptions/00000000-0000-0000-0000-000000000000", "exportName": "TestExport", "parameters": { "identity": { @@ -10,47 +8,49 @@ }, "location": "centralus", "properties": { - "schedule": { - "status": "Active", - "recurrence": "Daily", - "recurrencePeriod": { - "from": "2020-06-01T00:00:00Z", - "to": "2020-06-30T00:00:00Z" - } - }, "format": "Csv", - "deliveryInfo": { - "destination": { - "type": "AzureBlob", - "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", - "container": "exports", - "rootFolderPath": "ad-hoc" - } - }, + "compressionMode": "gzip", + "dataOverwriteBehavior": "OverwritePreviousReport", "definition": { "type": "ActualCost", - "timeframe": "MonthToDate", "dataSet": { - "granularity": "Daily", "configuration": { "dataVersion": "2023-05-01" - } + }, + "granularity": "Daily" + }, + "timeframe": "MonthToDate" + }, + "deliveryInfo": { + "destination": { + "type": "AzureBlob", + "container": "exports", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "rootFolderPath": "ad-hoc" } }, + "exportDescription": "This is a test export.", "partitionData": true, - "dataOverwriteBehavior": "OverwritePreviousReport", - "compressionMode": "gzip", - "exportDescription": "This is a test export." + "schedule": { + "recurrence": "Daily", + "recurrencePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-06-30T00:00:00Z" + }, + "status": "Active" + } } - } + }, + "scope": "subscriptions/00000000-0000-0000-0000-000000000000", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { - "201": { + "200": { "body": { - "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/exports/TestExport", "name": "TestExport", "type": "Microsoft.CostManagement/exports", "eTag": "\"00000000-0000-0000-0000-000000000000\"", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/exports/TestExport", "identity": { "type": "SystemAssigned", "principalId": "00000000-0000-0000-0000-000000000000", @@ -58,46 +58,46 @@ }, "location": "centralus", "properties": { - "schedule": { - "status": "Active", - "recurrence": "Daily", - "recurrencePeriod": { - "from": "2020-06-01T00:00:00Z", - "to": "2020-06-30T00:00:00Z" - } - }, - "nextRunTimeEstimate": "2020-06-01T23:00:00Z", "format": "Csv", - "deliveryInfo": { - "destination": { - "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", - "container": "exports", - "rootFolderPath": "ad-hoc" - } - }, + "compressionMode": "gzip", + "dataOverwriteBehavior": "OverwritePreviousReport", "definition": { "type": "ActualCost", - "timeframe": "MonthToDate", "dataSet": { - "granularity": "Daily", "configuration": { "dataVersion": "2023-05-01" - } + }, + "granularity": "Daily" + }, + "timeframe": "MonthToDate" + }, + "deliveryInfo": { + "destination": { + "container": "exports", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "rootFolderPath": "ad-hoc" } }, + "exportDescription": "This is a test export.", + "nextRunTimeEstimate": "2020-06-01T23:00:00Z", "partitionData": true, - "dataOverwriteBehavior": "OverwritePreviousReport", - "compressionMode": "gzip", - "exportDescription": "This is a test export." + "schedule": { + "recurrence": "Daily", + "recurrencePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-06-30T00:00:00Z" + }, + "status": "Active" + } } } }, - "200": { + "201": { "body": { - "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/exports/TestExport", "name": "TestExport", "type": "Microsoft.CostManagement/exports", "eTag": "\"00000000-0000-0000-0000-000000000000\"", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/exports/TestExport", "identity": { "type": "SystemAssigned", "principalId": "00000000-0000-0000-0000-000000000000", @@ -105,39 +105,41 @@ }, "location": "centralus", "properties": { - "schedule": { - "status": "Active", - "recurrence": "Daily", - "recurrencePeriod": { - "from": "2020-06-01T00:00:00Z", - "to": "2020-06-30T00:00:00Z" - } - }, - "nextRunTimeEstimate": "2020-06-01T23:00:00Z", "format": "Csv", - "deliveryInfo": { - "destination": { - "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", - "container": "exports", - "rootFolderPath": "ad-hoc" - } - }, + "compressionMode": "gzip", + "dataOverwriteBehavior": "OverwritePreviousReport", "definition": { "type": "ActualCost", - "timeframe": "MonthToDate", "dataSet": { - "granularity": "Daily", "configuration": { "dataVersion": "2023-05-01" - } + }, + "granularity": "Daily" + }, + "timeframe": "MonthToDate" + }, + "deliveryInfo": { + "destination": { + "container": "exports", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "rootFolderPath": "ad-hoc" } }, + "exportDescription": "This is a test export.", + "nextRunTimeEstimate": "2020-06-01T23:00:00Z", "partitionData": true, - "dataOverwriteBehavior": "OverwritePreviousReport", - "compressionMode": "gzip", - "exportDescription": "This is a test export." + "schedule": { + "recurrence": "Daily", + "recurrencePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-06-30T00:00:00Z" + }, + "status": "Active" + } } } } - } + }, + "operationId": "Exports_CreateOrUpdate", + "title": "ExportCreateOrUpdateBySubscription" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportDeleteByBillingAccount.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportDeleteByBillingAccount.json index cc022b12dab8..68620fd7e88d 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportDeleteByBillingAccount.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportDeleteByBillingAccount.json @@ -2,10 +2,12 @@ "parameters": { "api-version": "2025-03-01", "billingAccountId": "123456", - "scope": "providers/Microsoft.Billing/billingAccounts/123456", - "exportName": "TestExport" + "exportName": "TestExport", + "scope": "providers/Microsoft.Billing/billingAccounts/123456" }, "responses": { "200": {} - } + }, + "operationId": "Exports_Delete", + "title": "ExportDeleteByBillingAccount" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportDeleteByDepartment.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportDeleteByDepartment.json index 966970db65be..37ed28910456 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportDeleteByDepartment.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportDeleteByDepartment.json @@ -3,10 +3,12 @@ "api-version": "2025-03-01", "billingAccountId": "12", "departmentId": "1234", - "scope": "providers/Microsoft.Billing/billingAccounts/12/departments/1234", - "exportName": "TestExport" + "exportName": "TestExport", + "scope": "providers/Microsoft.Billing/billingAccounts/12/departments/1234" }, "responses": { "200": {} - } + }, + "operationId": "Exports_Delete", + "title": "ExportDeleteByDepartment" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportDeleteByEnrollmentAccount.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportDeleteByEnrollmentAccount.json index 8fa70fb5f43c..661c01691200 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportDeleteByEnrollmentAccount.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportDeleteByEnrollmentAccount.json @@ -3,10 +3,12 @@ "api-version": "2025-03-01", "billingAccountId": "100", "enrollmentAccountId": "456", - "scope": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456", - "exportName": "TestExport" + "exportName": "TestExport", + "scope": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456" }, "responses": { "200": {} - } + }, + "operationId": "Exports_Delete", + "title": "ExportDeleteByEnrollmentAccount" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportDeleteByManagementGroup.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportDeleteByManagementGroup.json index c6ba37485039..804ba311eed7 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportDeleteByManagementGroup.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportDeleteByManagementGroup.json @@ -1,11 +1,13 @@ { "parameters": { "api-version": "2025-03-01", + "exportName": "TestExport", "managementGroupId": "TestMG", - "scope": "providers/Microsoft.Management/managementGroups/TestMG", - "exportName": "TestExport" + "scope": "providers/Microsoft.Management/managementGroups/TestMG" }, "responses": { "200": {} - } + }, + "operationId": "Exports_Delete", + "title": "ExportDeleteByManagementGroup" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportDeleteByResourceGroup.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportDeleteByResourceGroup.json index ff66c6474dab..6a825e1a6b9d 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportDeleteByResourceGroup.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportDeleteByResourceGroup.json @@ -1,12 +1,14 @@ { "parameters": { "api-version": "2025-03-01", - "subscriptionId": "00000000-0000-0000-0000-000000000000", + "exportName": "TestExport", "resourceGroupName": "MYDEVTESTRG", "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG", - "exportName": "TestExport" + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": {} - } + }, + "operationId": "Exports_Delete", + "title": "ExportDeleteByResourceGroup" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportDeleteBySubscription.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportDeleteBySubscription.json index 797ed0601577..2eac873a6ee6 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportDeleteBySubscription.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportDeleteBySubscription.json @@ -1,11 +1,13 @@ { "parameters": { "api-version": "2025-03-01", - "subscriptionId": "00000000-0000-0000-0000-000000000000", + "exportName": "TestExport", "scope": "subscriptions/00000000-0000-0000-0000-000000000000", - "exportName": "TestExport" + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": {} - } + }, + "operationId": "Exports_Delete", + "title": "ExportDeleteBySubscription" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportGetByBillingAccount.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportGetByBillingAccount.json index cf792680fca2..4bdf7b545b9f 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportGetByBillingAccount.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportGetByBillingAccount.json @@ -2,16 +2,16 @@ "parameters": { "api-version": "2025-03-01", "billingAccountId": "123456", - "scope": "providers/Microsoft.Billing/billingAccounts/123456", - "exportName": "TestExport" + "exportName": "TestExport", + "scope": "providers/Microsoft.Billing/billingAccounts/123456" }, "responses": { "200": { "body": { - "id": "providers/Microsoft.Billing/billingAccounts/{billingAccount-Id}/providers/Microsoft.CostManagement/exports/TestExport", "name": "TestExport", "type": "Microsoft.CostManagement/exports", "eTag": "\"00000000-0000-0000-0000-000000000000\"", + "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccount-Id}/providers/Microsoft.CostManagement/exports/TestExport", "identity": { "type": "SystemAssigned", "principalId": "00000000-0000-0000-0000-000000000000", @@ -20,33 +20,35 @@ "location": "centralus", "properties": { "format": "Csv", - "deliveryInfo": { - "destination": { - "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", - "container": "exports", - "rootFolderPath": "ad-hoc" - } - }, + "compressionMode": "gzip", + "dataOverwriteBehavior": "OverwritePreviousReport", "definition": { "type": "ActualCost", - "timeframe": "Custom", + "dataSet": { + "configuration": { + "dataVersion": "2023-05-01" + }, + "granularity": "Daily" + }, "timePeriod": { "from": "2020-05-01T00:00:00Z", "to": "2020-05-31T00:00:00Z" }, - "dataSet": { - "granularity": "Daily", - "configuration": { - "dataVersion": "2023-05-01" - } + "timeframe": "Custom" + }, + "deliveryInfo": { + "destination": { + "container": "exports", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "rootFolderPath": "ad-hoc" } }, - "partitionData": true, - "dataOverwriteBehavior": "OverwritePreviousReport", - "compressionMode": "gzip", - "exportDescription": "This is a test export." + "exportDescription": "This is a test export.", + "partitionData": true } } } - } + }, + "operationId": "Exports_Get", + "title": "ExportGetByBillingAccount" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportGetByDepartment.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportGetByDepartment.json index 2381d5bf9713..6c1531d1557f 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportGetByDepartment.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportGetByDepartment.json @@ -3,16 +3,16 @@ "api-version": "2025-03-01", "billingAccountId": "12", "departmentId": "1234", - "scope": "providers/Microsoft.Billing/billingAccounts/12/departments/1234", - "exportName": "TestExport" + "exportName": "TestExport", + "scope": "providers/Microsoft.Billing/billingAccounts/12/departments/1234" }, "responses": { "200": { "body": { - "id": "providers/Microsoft.Billing/billingAccounts/12/departments/1234/providers/Microsoft.CostManagement/exports/TestExport", "name": "TestExport", "type": "Microsoft.CostManagement/exports", "eTag": "\"00000000-0000-0000-0000-000000000000\"", + "id": "/providers/Microsoft.Billing/billingAccounts/12/departments/1234/providers/Microsoft.CostManagement/exports/TestExport", "identity": { "type": "SystemAssigned", "principalId": "00000000-0000-0000-0000-000000000000", @@ -21,33 +21,35 @@ "location": "centralus", "properties": { "format": "Csv", - "deliveryInfo": { - "destination": { - "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", - "container": "exports", - "rootFolderPath": "ad-hoc" - } - }, + "compressionMode": "gzip", + "dataOverwriteBehavior": "OverwritePreviousReport", "definition": { "type": "ActualCost", - "timeframe": "Custom", + "dataSet": { + "configuration": { + "dataVersion": "2023-05-01" + }, + "granularity": "Daily" + }, "timePeriod": { "from": "2020-06-01T00:00:00Z", "to": "2020-06-30T00:00:00Z" }, - "dataSet": { - "granularity": "Daily", - "configuration": { - "dataVersion": "2023-05-01" - } + "timeframe": "Custom" + }, + "deliveryInfo": { + "destination": { + "container": "exports", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "rootFolderPath": "ad-hoc" } }, - "partitionData": true, - "dataOverwriteBehavior": "OverwritePreviousReport", - "compressionMode": "gzip", - "exportDescription": "This is a test export." + "exportDescription": "This is a test export.", + "partitionData": true } } } - } + }, + "operationId": "Exports_Get", + "title": "ExportGetByDepartment" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportGetByEnrollmentAccount.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportGetByEnrollmentAccount.json index 16544dbff7b3..70149fd4ad01 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportGetByEnrollmentAccount.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportGetByEnrollmentAccount.json @@ -3,16 +3,16 @@ "api-version": "2025-03-01", "billingAccountId": "100", "enrollmentAccountId": "456", - "scope": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456", - "exportName": "TestExport" + "exportName": "TestExport", + "scope": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456" }, "responses": { "200": { "body": { - "id": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456/providers/Microsoft.CostManagement/exports/TestExport", "name": "TestExport", "type": "Microsoft.CostManagement/exports", "eTag": "\"00000000-0000-0000-0000-000000000000\"", + "id": "/providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456/providers/Microsoft.CostManagement/exports/TestExport", "identity": { "type": "SystemAssigned", "principalId": "00000000-0000-0000-0000-000000000000", @@ -21,33 +21,35 @@ "location": "centralus", "properties": { "format": "Csv", - "deliveryInfo": { - "destination": { - "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", - "container": "exports", - "rootFolderPath": "ad-hoc" - } - }, + "compressionMode": "gzip", + "dataOverwriteBehavior": "OverwritePreviousReport", "definition": { "type": "ActualCost", - "timeframe": "Custom", + "dataSet": { + "configuration": { + "dataVersion": "2023-05-01" + }, + "granularity": "Daily" + }, "timePeriod": { "from": "2019-09-01T00:00:00Z", "to": "2019-09-30T00:00:00Z" }, - "dataSet": { - "granularity": "Daily", - "configuration": { - "dataVersion": "2023-05-01" - } + "timeframe": "Custom" + }, + "deliveryInfo": { + "destination": { + "container": "exports", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "rootFolderPath": "ad-hoc" } }, - "partitionData": true, - "dataOverwriteBehavior": "OverwritePreviousReport", - "compressionMode": "gzip", - "exportDescription": "This is a test export." + "exportDescription": "This is a test export.", + "partitionData": true } } } - } + }, + "operationId": "Exports_Get", + "title": "ExportGetByEnrollmentAccount" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportGetByManagementGroup.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportGetByManagementGroup.json index a34e42c5c416..996503810e27 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportGetByManagementGroup.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportGetByManagementGroup.json @@ -1,17 +1,17 @@ { "parameters": { "api-version": "2025-03-01", + "exportName": "TestExport", "managementGroupId": "TestMG", - "scope": "providers/Microsoft.Management/managementGroups/TestMG", - "exportName": "TestExport" + "scope": "providers/Microsoft.Management/managementGroups/TestMG" }, "responses": { "200": { "body": { - "id": "providers/Microsoft.Management/managementGroups/TestMG/providers/Microsoft.CostManagement/exports/TestExport", "name": "TestExport", "type": "Microsoft.CostManagement/exports", "eTag": "\"00000000-0000-0000-0000-000000000000\"", + "id": "/providers/Microsoft.Management/managementGroups/TestMG/providers/Microsoft.CostManagement/exports/TestExport", "identity": { "type": "SystemAssigned", "principalId": "00000000-0000-0000-0000-000000000000", @@ -20,33 +20,35 @@ "location": "centralus", "properties": { "format": "Csv", - "deliveryInfo": { - "destination": { - "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", - "container": "exports", - "rootFolderPath": "ad-hoc" - } - }, + "compressionMode": "gzip", + "dataOverwriteBehavior": "OverwritePreviousReport", "definition": { "type": "ActualCost", - "timeframe": "Custom", + "dataSet": { + "configuration": { + "dataVersion": "2023-05-01" + }, + "granularity": "Daily" + }, "timePeriod": { "from": "2019-09-01T00:00:00Z", "to": "2020-09-30T00:00:00Z" }, - "dataSet": { - "granularity": "Daily", - "configuration": { - "dataVersion": "2023-05-01" - } + "timeframe": "Custom" + }, + "deliveryInfo": { + "destination": { + "container": "exports", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "rootFolderPath": "ad-hoc" } }, - "partitionData": true, - "dataOverwriteBehavior": "OverwritePreviousReport", - "compressionMode": "gzip", - "exportDescription": "This is a test export." + "exportDescription": "This is a test export.", + "partitionData": true } } } - } + }, + "operationId": "Exports_Get", + "title": "ExportGetByManagementGroup" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportGetByResourceGroup.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportGetByResourceGroup.json index 144c70caeacc..16bcdc3e1b4b 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportGetByResourceGroup.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportGetByResourceGroup.json @@ -1,18 +1,18 @@ { "parameters": { "api-version": "2025-03-01", - "subscriptionId": "00000000-0000-0000-0000-000000000000", + "exportName": "TestExport", "resourceGroupName": "MYDEVTESTRG", "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG", - "exportName": "TestExport" + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { - "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/exports/TestExport", "name": "TestExport", "type": "Microsoft.CostManagement/exports", "eTag": "\"00000000-0000-0000-0000-000000000000\"", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/exports/TestExport", "identity": { "type": "SystemAssigned", "principalId": "00000000-0000-0000-0000-000000000000", @@ -21,33 +21,35 @@ "location": "centralus", "properties": { "format": "Csv", - "deliveryInfo": { - "destination": { - "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", - "container": "exports", - "rootFolderPath": "ad-hoc" - } - }, + "compressionMode": "gzip", + "dataOverwriteBehavior": "OverwritePreviousReport", "definition": { "type": "ActualCost", - "timeframe": "Custom", + "dataSet": { + "configuration": { + "dataVersion": "2023-05-01" + }, + "granularity": "Daily" + }, "timePeriod": { "from": "2020-06-01T00:00:00Z", "to": "2020-06-30T00:00:00Z" }, - "dataSet": { - "granularity": "Daily", - "configuration": { - "dataVersion": "2023-05-01" - } + "timeframe": "Custom" + }, + "deliveryInfo": { + "destination": { + "container": "exports", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "rootFolderPath": "ad-hoc" } }, - "partitionData": true, - "dataOverwriteBehavior": "OverwritePreviousReport", - "compressionMode": "gzip", - "exportDescription": "This is a test export." + "exportDescription": "This is a test export.", + "partitionData": true } } } - } + }, + "operationId": "Exports_Get", + "title": "ExportGetByResourceGroup" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportGetBySubscription.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportGetBySubscription.json index 7acfb1f41226..09b8f355512f 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportGetBySubscription.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportGetBySubscription.json @@ -1,17 +1,17 @@ { "parameters": { "api-version": "2025-03-01", - "subscriptionId": "00000000-0000-0000-0000-000000000000", + "exportName": "TestExport", "scope": "subscriptions/00000000-0000-0000-0000-000000000000", - "exportName": "TestExport" + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { - "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/exports/TestExport", "name": "TestExport", "type": "Microsoft.CostManagement/exports", "eTag": "\"00000000-0000-0000-0000-000000000000\"", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/exports/TestExport", "identity": { "type": "SystemAssigned", "principalId": "00000000-0000-0000-0000-000000000000", @@ -20,33 +20,35 @@ "location": "centralus", "properties": { "format": "Csv", - "deliveryInfo": { - "destination": { - "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", - "container": "exports", - "rootFolderPath": "ad-hoc" - } - }, + "compressionMode": "gzip", + "dataOverwriteBehavior": "OverwritePreviousReport", "definition": { "type": "ActualCost", - "timeframe": "Custom", + "dataSet": { + "configuration": { + "dataVersion": "2023-05-01" + }, + "granularity": "Daily" + }, "timePeriod": { "from": "2019-06-01T00:00:00Z", "to": "2019-06-30T00:00:00Z" }, - "dataSet": { - "granularity": "Daily", - "configuration": { - "dataVersion": "2023-05-01" - } + "timeframe": "Custom" + }, + "deliveryInfo": { + "destination": { + "container": "exports", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "rootFolderPath": "ad-hoc" } }, - "partitionData": true, - "dataOverwriteBehavior": "OverwritePreviousReport", - "compressionMode": "gzip", - "exportDescription": "This is a test export." + "exportDescription": "This is a test export.", + "partitionData": true } } } - } + }, + "operationId": "Exports_Get", + "title": "ExportGetBySubscription" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportRunByBillingAccount.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportRunByBillingAccount.json index cc022b12dab8..12ddb952cc91 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportRunByBillingAccount.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportRunByBillingAccount.json @@ -2,10 +2,12 @@ "parameters": { "api-version": "2025-03-01", "billingAccountId": "123456", - "scope": "providers/Microsoft.Billing/billingAccounts/123456", - "exportName": "TestExport" + "exportName": "TestExport", + "scope": "providers/Microsoft.Billing/billingAccounts/123456" }, "responses": { "200": {} - } + }, + "operationId": "Exports_Execute", + "title": "ExportRunByBillingAccount" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportRunByBillingAccountWithOptionalRequestBody.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportRunByBillingAccountWithOptionalRequestBody.json index f40f054c8b0d..7a0f00b0baea 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportRunByBillingAccountWithOptionalRequestBody.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportRunByBillingAccountWithOptionalRequestBody.json @@ -2,16 +2,18 @@ "parameters": { "api-version": "2025-03-01", "billingAccountId": "123456", - "scope": "providers/Microsoft.Billing/billingAccounts/123456", "exportName": "TestExport", "exportRunRequest": { "timePeriod": { "from": "2023-12-01T00:00:00.000Z", "to": "2023-12-31T00:00:00.000Z" } - } + }, + "scope": "providers/Microsoft.Billing/billingAccounts/123456" }, "responses": { "200": {} - } + }, + "operationId": "Exports_Execute", + "title": "ExportRunByBillingAccountWithOptionalRequestBody" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportRunByDepartment.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportRunByDepartment.json index 966970db65be..157a354bbb41 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportRunByDepartment.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportRunByDepartment.json @@ -3,10 +3,12 @@ "api-version": "2025-03-01", "billingAccountId": "12", "departmentId": "1234", - "scope": "providers/Microsoft.Billing/billingAccounts/12/departments/1234", - "exportName": "TestExport" + "exportName": "TestExport", + "scope": "providers/Microsoft.Billing/billingAccounts/12/departments/1234" }, "responses": { "200": {} - } + }, + "operationId": "Exports_Execute", + "title": "ExportRunByDepartment" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportRunByEnrollmentAccount.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportRunByEnrollmentAccount.json index 8fa70fb5f43c..6594094184c2 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportRunByEnrollmentAccount.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportRunByEnrollmentAccount.json @@ -3,10 +3,12 @@ "api-version": "2025-03-01", "billingAccountId": "100", "enrollmentAccountId": "456", - "scope": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456", - "exportName": "TestExport" + "exportName": "TestExport", + "scope": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456" }, "responses": { "200": {} - } + }, + "operationId": "Exports_Execute", + "title": "ExportRunByEnrollmentAccount" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportRunByManagementGroup.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportRunByManagementGroup.json index c6ba37485039..0759e67eb5d9 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportRunByManagementGroup.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportRunByManagementGroup.json @@ -1,11 +1,13 @@ { "parameters": { "api-version": "2025-03-01", + "exportName": "TestExport", "managementGroupId": "TestMG", - "scope": "providers/Microsoft.Management/managementGroups/TestMG", - "exportName": "TestExport" + "scope": "providers/Microsoft.Management/managementGroups/TestMG" }, "responses": { "200": {} - } + }, + "operationId": "Exports_Execute", + "title": "ExportRunByManagementGroup" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportRunByResourceGroup.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportRunByResourceGroup.json index ff66c6474dab..325bd21eef83 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportRunByResourceGroup.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportRunByResourceGroup.json @@ -1,12 +1,14 @@ { "parameters": { "api-version": "2025-03-01", - "subscriptionId": "00000000-0000-0000-0000-000000000000", + "exportName": "TestExport", "resourceGroupName": "MYDEVTESTRG", "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG", - "exportName": "TestExport" + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": {} - } + }, + "operationId": "Exports_Execute", + "title": "ExportRunByResourceGroup" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportRunBySubscription.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportRunBySubscription.json index 797ed0601577..e0e5a286f772 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportRunBySubscription.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportRunBySubscription.json @@ -1,11 +1,13 @@ { "parameters": { "api-version": "2025-03-01", - "subscriptionId": "00000000-0000-0000-0000-000000000000", + "exportName": "TestExport", "scope": "subscriptions/00000000-0000-0000-0000-000000000000", - "exportName": "TestExport" + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": {} - } + }, + "operationId": "Exports_Execute", + "title": "ExportRunBySubscription" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportRunHistoryGetByBillingAccount.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportRunHistoryGetByBillingAccount.json index 071522026811..5dd3d6bef307 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportRunHistoryGetByBillingAccount.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportRunHistoryGetByBillingAccount.json @@ -2,101 +2,103 @@ "parameters": { "api-version": "2025-03-01", "billingAccountId": "123456", - "scope": "providers/Microsoft.Billing/billingAccounts/123456", - "exportName": "TestExport" + "exportName": "TestExport", + "scope": "providers/Microsoft.Billing/billingAccounts/123456" }, "responses": { "200": { "body": { "value": [ { - "id": "providers/Microsoft.Billing/billingAccounts/{billingAccount-id}/providers/Microsoft.CostManagement/exports/JohnDoeSchedule/Run/1e25d58a-a3b0-4916-9542-6e04a89bc100", + "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccount-id}/providers/Microsoft.CostManagement/exports/JohnDoeSchedule/Run/1e25d58a-a3b0-4916-9542-6e04a89bc100", "properties": { - "executionType": "OnDemand", - "status": "Completed", - "submittedBy": "john.doe@gmail.com", - "submittedTime": "2018-08-03T07:52:15.6016681Z", - "processingStartTime": "2018-08-03T07:52:16.9123797Z", - "processingEndTime": "2018-08-03T07:52:28.0373318Z", - "startDate": "2020-06-01T00:00:00Z", "endDate": "2020-06-30T00:00:00Z", - "manifestFile": "ScheduledTestsForJohnDoe/JohnDoeSchedule/20180729-20180804/manifestfile", + "executionType": "OnDemand", "fileName": "ScheduledTestsForJohnDoe/JohnDoeSchedule/20180729-20180804/JohnDoeSchedule_1e25d58a-a3b0-4916-9542-6e04a89bc100.csv", + "manifestFile": "ScheduledTestsForJohnDoe/JohnDoeSchedule/20180729-20180804/manifestfile", + "processingEndTime": "2018-08-03T07:52:28.0373318Z", + "processingStartTime": "2018-08-03T07:52:16.9123797Z", "runSettings": { "format": "Csv", - "deliveryInfo": { - "destination": { - "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", - "container": "exports", - "rootFolderPath": "ScheduledTestsForJohnDoe" - } - }, + "compressionMode": "gzip", + "dataOverwriteBehavior": "OverwritePreviousReport", "definition": { "type": "ActualCost", - "timeframe": "Custom", + "dataSet": { + "configuration": { + "dataVersion": "2023-05-01" + }, + "granularity": "Daily" + }, "timePeriod": { "from": "2020-06-01T00:00:00Z", "to": "2020-06-30T00:00:00Z" }, - "dataSet": { - "granularity": "Daily", - "configuration": { - "dataVersion": "2023-05-01" - } + "timeframe": "Custom" + }, + "deliveryInfo": { + "destination": { + "container": "exports", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "rootFolderPath": "ScheduledTestsForJohnDoe" } }, - "partitionData": true, - "dataOverwriteBehavior": "OverwritePreviousReport", - "compressionMode": "gzip", - "exportDescription": "This is a test export." - } + "exportDescription": "This is a test export.", + "partitionData": true + }, + "startDate": "2020-06-01T00:00:00Z", + "status": "Completed", + "submittedBy": "john.doe@gmail.com", + "submittedTime": "2018-08-03T07:52:15.6016681Z" } }, { - "id": "providers/Microsoft.Billing/billingAccounts/{billingAccount-id}/providers/Microsoft.CostManagement/exports/JohnDoeSchedule/Run/11ac6811-dca3-46ad-b326-4704cf0c58ef", + "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccount-id}/providers/Microsoft.CostManagement/exports/JohnDoeSchedule/Run/11ac6811-dca3-46ad-b326-4704cf0c58ef", "properties": { - "executionType": "Scheduled", - "status": "Completed", - "submittedBy": "System", - "submittedTime": "2018-08-03T09:03:58.5710244Z", - "processingStartTime": "2018-08-03T09:03:58.5710244Z", - "processingEndTime": "2018-08-03T09:04:19.7223808Z", - "startDate": "2020-06-01T00:00:00Z", "endDate": "2020-06-30T00:00:00Z", - "manifestFile": "ScheduledTestsForJohnDoe/JohnDoeSchedule/20180729-20180804/manifestfile", + "executionType": "Scheduled", "fileName": "ScheduledTestsForJohnDoe/JohnDoeSchedule/20180729-20180804/JohnDoeSchedule_11ac6811-dca3-46ad-b326-4704cf0c58ef.csv", + "manifestFile": "ScheduledTestsForJohnDoe/JohnDoeSchedule/20180729-20180804/manifestfile", + "processingEndTime": "2018-08-03T09:04:19.7223808Z", + "processingStartTime": "2018-08-03T09:03:58.5710244Z", "runSettings": { "format": "Csv", - "deliveryInfo": { - "destination": { - "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", - "container": "exports", - "rootFolderPath": "ScheduledTestsForJohnDoe" - } - }, + "compressionMode": "gzip", + "dataOverwriteBehavior": "OverwritePreviousReport", "definition": { "type": "ActualCost", - "timeframe": "Custom", + "dataSet": { + "configuration": { + "dataVersion": "2023-05-01" + }, + "granularity": "Daily" + }, "timePeriod": { "from": "2020-06-01T00:00:00Z", "to": "2020-06-30T00:00:00Z" }, - "dataSet": { - "granularity": "Daily", - "configuration": { - "dataVersion": "2023-05-01" - } + "timeframe": "Custom" + }, + "deliveryInfo": { + "destination": { + "container": "exports", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "rootFolderPath": "ScheduledTestsForJohnDoe" } }, - "partitionData": true, - "dataOverwriteBehavior": "OverwritePreviousReport", - "compressionMode": "gzip", - "exportDescription": "This is a test export." - } + "exportDescription": "This is a test export.", + "partitionData": true + }, + "startDate": "2020-06-01T00:00:00Z", + "status": "Completed", + "submittedBy": "System", + "submittedTime": "2018-08-03T09:03:58.5710244Z" } } ] } } - } + }, + "operationId": "Exports_GetExecutionHistory", + "title": "ExportRunHistoryGetByBillingAccount" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportRunHistoryGetByDepartment.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportRunHistoryGetByDepartment.json index 68bd4245371e..36a439baaf27 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportRunHistoryGetByDepartment.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportRunHistoryGetByDepartment.json @@ -3,101 +3,103 @@ "api-version": "2025-03-01", "billingAccountId": "12", "departmentId": "1234", - "scope": "providers/Microsoft.Billing/billingAccounts/12/departments/1234", - "exportName": "TestExport" + "exportName": "TestExport", + "scope": "providers/Microsoft.Billing/billingAccounts/12/departments/1234" }, "responses": { "200": { "body": { "value": [ { - "id": "providers/Microsoft.Billing/billingAccounts/12/departments/1234/providers/Microsoft.CostManagement/exports/JohnDoeSchedule/Run/1e25d58a-a3b0-4916-9542-6e04a89bc100", + "id": "/providers/Microsoft.Billing/billingAccounts/12/departments/1234/providers/Microsoft.CostManagement/exports/JohnDoeSchedule/Run/1e25d58a-a3b0-4916-9542-6e04a89bc100", "properties": { - "executionType": "OnDemand", - "status": "Completed", - "submittedBy": "john.doe@gmail.com", - "submittedTime": "2018-08-03T07:52:15.6016681Z", - "processingStartTime": "2018-08-03T07:52:16.9123797Z", - "processingEndTime": "2018-08-03T07:52:28.0373318Z", - "startDate": "2020-06-01T00:00:00Z", "endDate": "2020-06-30T00:00:00Z", - "manifestFile": "ScheduledTestsForJohnDoe/JohnDoeSchedule/20180729-20180804/manifestfile", + "executionType": "OnDemand", "fileName": "ScheduledTestsForJohnDoe/JohnDoeSchedule/20180729-20180804/JohnDoeSchedule_1e25d58a-a3b0-4916-9542-6e04a89bc100.csv", + "manifestFile": "ScheduledTestsForJohnDoe/JohnDoeSchedule/20180729-20180804/manifestfile", + "processingEndTime": "2018-08-03T07:52:28.0373318Z", + "processingStartTime": "2018-08-03T07:52:16.9123797Z", "runSettings": { "format": "Csv", - "deliveryInfo": { - "destination": { - "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", - "container": "exports", - "rootFolderPath": "ScheduledTestsForJohnDoe" - } - }, + "compressionMode": "gzip", + "dataOverwriteBehavior": "OverwritePreviousReport", "definition": { "type": "ActualCost", - "timeframe": "Custom", + "dataSet": { + "configuration": { + "dataVersion": "2023-05-01" + }, + "granularity": "Daily" + }, "timePeriod": { "from": "2020-06-01T00:00:00Z", "to": "2020-06-30T00:00:00Z" }, - "dataSet": { - "granularity": "Daily", - "configuration": { - "dataVersion": "2023-05-01" - } + "timeframe": "Custom" + }, + "deliveryInfo": { + "destination": { + "container": "exports", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "rootFolderPath": "ScheduledTestsForJohnDoe" } }, - "partitionData": true, - "dataOverwriteBehavior": "OverwritePreviousReport", - "compressionMode": "gzip", - "exportDescription": "This is a test export." - } + "exportDescription": "This is a test export.", + "partitionData": true + }, + "startDate": "2020-06-01T00:00:00Z", + "status": "Completed", + "submittedBy": "john.doe@gmail.com", + "submittedTime": "2018-08-03T07:52:15.6016681Z" } }, { - "id": "providers/Microsoft.Billing/billingAccounts/12/departments/1234/providers/Microsoft.CostManagement/exports/JohnDoeSchedule/Run/11ac6811-dca3-46ad-b326-4704cf0c58ef", + "id": "/providers/Microsoft.Billing/billingAccounts/12/departments/1234/providers/Microsoft.CostManagement/exports/JohnDoeSchedule/Run/11ac6811-dca3-46ad-b326-4704cf0c58ef", "properties": { - "executionType": "Scheduled", - "status": "Completed", - "submittedBy": "System", - "submittedTime": "2018-08-03T09:03:58.5710244Z", - "processingStartTime": "2018-08-03T09:03:58.5710244Z", - "processingEndTime": "2018-08-03T09:04:19.7223808Z", - "startDate": "2020-06-01T00:00:00Z", "endDate": "2020-06-30T00:00:00Z", - "manifestFile": "ScheduledTestsForJohnDoe/JohnDoeSchedule/20180729-20180804/manifestfile", + "executionType": "Scheduled", "fileName": "ScheduledTestsForJohnDoe/JohnDoeSchedule/20180729-20180804/JohnDoeSchedule_11ac6811-dca3-46ad-b326-4704cf0c58ef.csv", + "manifestFile": "ScheduledTestsForJohnDoe/JohnDoeSchedule/20180729-20180804/manifestfile", + "processingEndTime": "2018-08-03T09:04:19.7223808Z", + "processingStartTime": "2018-08-03T09:03:58.5710244Z", "runSettings": { "format": "Csv", - "deliveryInfo": { - "destination": { - "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", - "container": "exports", - "rootFolderPath": "ScheduledTestsForJohnDoe" - } - }, + "compressionMode": "gzip", + "dataOverwriteBehavior": "OverwritePreviousReport", "definition": { "type": "ActualCost", - "timeframe": "Custom", + "dataSet": { + "configuration": { + "dataVersion": "2023-05-01" + }, + "granularity": "Daily" + }, "timePeriod": { "from": "2020-06-01T00:00:00Z", "to": "2020-06-30T00:00:00Z" }, - "dataSet": { - "granularity": "Daily", - "configuration": { - "dataVersion": "2023-05-01" - } + "timeframe": "Custom" + }, + "deliveryInfo": { + "destination": { + "container": "exports", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "rootFolderPath": "ScheduledTestsForJohnDoe" } }, - "partitionData": true, - "dataOverwriteBehavior": "OverwritePreviousReport", - "compressionMode": "gzip", - "exportDescription": "This is a test export." - } + "exportDescription": "This is a test export.", + "partitionData": true + }, + "startDate": "2020-06-01T00:00:00Z", + "status": "Completed", + "submittedBy": "System", + "submittedTime": "2018-08-03T09:03:58.5710244Z" } } ] } } - } + }, + "operationId": "Exports_GetExecutionHistory", + "title": "ExportRunHistoryGetByDepartment" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportRunHistoryGetByEnrollmentAccount.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportRunHistoryGetByEnrollmentAccount.json index 7151472dfe4c..fa7195608b58 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportRunHistoryGetByEnrollmentAccount.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportRunHistoryGetByEnrollmentAccount.json @@ -3,101 +3,103 @@ "api-version": "2025-03-01", "billingAccountId": "100", "enrollmentAccountId": "456", - "scope": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456", - "exportName": "TestExport" + "exportName": "TestExport", + "scope": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456" }, "responses": { "200": { "body": { "value": [ { - "id": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456/providers/Microsoft.CostManagement/exports/JohnDoeSchedule/Run/1e25d58a-a3b0-4916-9542-6e04a89bc100", + "id": "/providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456/providers/Microsoft.CostManagement/exports/JohnDoeSchedule/Run/1e25d58a-a3b0-4916-9542-6e04a89bc100", "properties": { - "executionType": "OnDemand", - "status": "Completed", - "submittedBy": "john.doe@gmail.com", - "submittedTime": "2018-08-03T07:52:15.6016681Z", - "processingStartTime": "2018-08-03T07:52:16.9123797Z", - "processingEndTime": "2018-08-03T07:52:28.0373318Z", - "startDate": "2020-06-01T00:00:00Z", "endDate": "2020-06-30T00:00:00Z", - "manifestFile": "ScheduledTestsForJohnDoe/JohnDoeSchedule/20180729-20180804/manifestfile", + "executionType": "OnDemand", "fileName": "ScheduledTestsForJohnDoe/JohnDoeSchedule/20180729-20180804/JohnDoeSchedule_1e25d58a-a3b0-4916-9542-6e04a89bc100.csv", + "manifestFile": "ScheduledTestsForJohnDoe/JohnDoeSchedule/20180729-20180804/manifestfile", + "processingEndTime": "2018-08-03T07:52:28.0373318Z", + "processingStartTime": "2018-08-03T07:52:16.9123797Z", "runSettings": { "format": "Csv", - "deliveryInfo": { - "destination": { - "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", - "container": "exports", - "rootFolderPath": "ScheduledTestsForJohnDoe" - } - }, + "compressionMode": "gzip", + "dataOverwriteBehavior": "OverwritePreviousReport", "definition": { "type": "ActualCost", - "timeframe": "Custom", + "dataSet": { + "configuration": { + "dataVersion": "2023-05-01" + }, + "granularity": "Daily" + }, "timePeriod": { "from": "2020-06-01T00:00:00Z", "to": "2020-06-30T00:00:00Z" }, - "dataSet": { - "granularity": "Daily", - "configuration": { - "dataVersion": "2023-05-01" - } + "timeframe": "Custom" + }, + "deliveryInfo": { + "destination": { + "container": "exports", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "rootFolderPath": "ScheduledTestsForJohnDoe" } }, - "partitionData": true, - "dataOverwriteBehavior": "OverwritePreviousReport", - "compressionMode": "gzip", - "exportDescription": "This is a test export." - } + "exportDescription": "This is a test export.", + "partitionData": true + }, + "startDate": "2020-06-01T00:00:00Z", + "status": "Completed", + "submittedBy": "john.doe@gmail.com", + "submittedTime": "2018-08-03T07:52:15.6016681Z" } }, { - "id": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456/providers/Microsoft.CostManagement/exports/JohnDoeSchedule/Run/11ac6811-dca3-46ad-b326-4704cf0c58ef", + "id": "/providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456/providers/Microsoft.CostManagement/exports/JohnDoeSchedule/Run/11ac6811-dca3-46ad-b326-4704cf0c58ef", "properties": { - "executionType": "Scheduled", - "status": "Completed", - "submittedBy": "System", - "submittedTime": "2018-08-03T09:03:58.5710244Z", - "processingStartTime": "2018-08-03T09:03:58.5710244Z", - "processingEndTime": "2018-08-03T09:04:19.7223808Z", - "startDate": "2020-06-01T00:00:00Z", "endDate": "2020-06-30T00:00:00Z", - "manifestFile": "ScheduledTestsForJohnDoe/JohnDoeSchedule/20180729-20180804/manifestfile", + "executionType": "Scheduled", "fileName": "ScheduledTestsForJohnDoe/JohnDoeSchedule/20180729-20180804/JohnDoeSchedule_11ac6811-dca3-46ad-b326-4704cf0c58ef.csv", + "manifestFile": "ScheduledTestsForJohnDoe/JohnDoeSchedule/20180729-20180804/manifestfile", + "processingEndTime": "2018-08-03T09:04:19.7223808Z", + "processingStartTime": "2018-08-03T09:03:58.5710244Z", "runSettings": { "format": "Csv", - "deliveryInfo": { - "destination": { - "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", - "container": "exports", - "rootFolderPath": "ScheduledTestsForJohnDoe" - } - }, + "compressionMode": "gzip", + "dataOverwriteBehavior": "OverwritePreviousReport", "definition": { "type": "ActualCost", - "timeframe": "Custom", + "dataSet": { + "configuration": { + "dataVersion": "2023-05-01" + }, + "granularity": "Daily" + }, "timePeriod": { "from": "2020-06-01T00:00:00Z", "to": "2020-06-30T00:00:00Z" }, - "dataSet": { - "granularity": "Daily", - "configuration": { - "dataVersion": "2023-05-01" - } + "timeframe": "Custom" + }, + "deliveryInfo": { + "destination": { + "container": "exports", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "rootFolderPath": "ScheduledTestsForJohnDoe" } }, - "partitionData": true, - "dataOverwriteBehavior": "OverwritePreviousReport", - "compressionMode": "gzip", - "exportDescription": "This is a test export." - } + "exportDescription": "This is a test export.", + "partitionData": true + }, + "startDate": "2020-06-01T00:00:00Z", + "status": "Completed", + "submittedBy": "System", + "submittedTime": "2018-08-03T09:03:58.5710244Z" } } ] } } - } + }, + "operationId": "Exports_GetExecutionHistory", + "title": "ExportRunHistoryGetByEnrollmentAccount" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportRunHistoryGetByManagementGroup.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportRunHistoryGetByManagementGroup.json index b1c1babe6d96..47a5205c2d09 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportRunHistoryGetByManagementGroup.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportRunHistoryGetByManagementGroup.json @@ -1,102 +1,104 @@ { "parameters": { "api-version": "2025-03-01", + "exportName": "TestExport", "managementGroupId": "TestMG", - "scope": "providers/Microsoft.Management/managementGroups/TestMG", - "exportName": "TestExport" + "scope": "providers/Microsoft.Management/managementGroups/TestMG" }, "responses": { "200": { "body": { "value": [ { - "id": "providers/Microsoft.Management/managementGroups/TestMG/providers/Microsoft.CostManagement/exports/TestExport/Run/1e25d58a-a3b0-4916-9542-6e04a89bc100", + "id": "/providers/Microsoft.Management/managementGroups/TestMG/providers/Microsoft.CostManagement/exports/TestExport/Run/1e25d58a-a3b0-4916-9542-6e04a89bc100", "properties": { - "executionType": "OnDemand", - "status": "Completed", - "submittedBy": "john.doe@gmail.com", - "submittedTime": "2018-08-03T07:52:15.6016681Z", - "processingStartTime": "2018-08-03T07:52:16.9123797Z", - "processingEndTime": "2018-08-03T07:52:28.0373318Z", - "startDate": "2020-06-01T00:00:00Z", "endDate": "2020-06-30T00:00:00Z", - "manifestFile": "ScheduledTestsForJohnDoe/JohnDoeSchedule/20180729-20180804/manifestfile", + "executionType": "OnDemand", "fileName": "ScheduledForTestExport/TestExportSchedule/20180729-20180804/TestExportSchedule_1e25d58a-a3b0-4916-9542-6e04a89bc100.csv", + "manifestFile": "ScheduledTestsForJohnDoe/JohnDoeSchedule/20180729-20180804/manifestfile", + "processingEndTime": "2018-08-03T07:52:28.0373318Z", + "processingStartTime": "2018-08-03T07:52:16.9123797Z", "runSettings": { "format": "Csv", - "deliveryInfo": { - "destination": { - "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", - "container": "exports", - "rootFolderPath": "ScheduledTestsForJohnDoe" - } - }, + "compressionMode": "gzip", + "dataOverwriteBehavior": "OverwritePreviousReport", "definition": { "type": "ActualCost", - "timeframe": "Custom", + "dataSet": { + "configuration": { + "dataVersion": "2023-05-01" + }, + "granularity": "Daily" + }, "timePeriod": { "from": "2020-06-01T00:00:00Z", "to": "2020-06-30T00:00:00Z" }, - "dataSet": { - "granularity": "Daily", - "configuration": { - "dataVersion": "2023-05-01" - } + "timeframe": "Custom" + }, + "deliveryInfo": { + "destination": { + "container": "exports", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "rootFolderPath": "ScheduledTestsForJohnDoe" } }, - "partitionData": true, - "dataOverwriteBehavior": "OverwritePreviousReport", - "compressionMode": "gzip", - "exportDescription": "This is a test export." - } + "exportDescription": "This is a test export.", + "partitionData": true + }, + "startDate": "2020-06-01T00:00:00Z", + "status": "Completed", + "submittedBy": "john.doe@gmail.com", + "submittedTime": "2018-08-03T07:52:15.6016681Z" } }, { - "id": "providers/Microsoft.Management/managementGroups/TestMG/providers/Microsoft.CostManagement/exports/TestExport/Run/11ac6811-dca3-46ad-b326-4704cf0c58ef", + "id": "/providers/Microsoft.Management/managementGroups/TestMG/providers/Microsoft.CostManagement/exports/TestExport/Run/11ac6811-dca3-46ad-b326-4704cf0c58ef", "properties": { - "executionType": "Scheduled", - "status": "Completed", - "submittedBy": "System", - "submittedTime": "2018-08-03T09:03:58.5710244Z", - "processingStartTime": "2018-08-03T09:03:58.5710244Z", - "processingEndTime": "2018-08-03T09:04:19.7223808Z", - "startDate": "2020-06-01T00:00:00Z", "endDate": "2020-06-30T00:00:00Z", - "manifestFile": "ScheduledTestsForJohnDoe/JohnDoeSchedule/20180729-20180804/manifestfile", + "executionType": "Scheduled", "fileName": "ScheduledForTestExport/TestExportSchedule/20180729-20180804/TestExportSchedule_11ac6811-dca3-46ad-b326-4704cf0c58ef.csv", + "manifestFile": "ScheduledTestsForJohnDoe/JohnDoeSchedule/20180729-20180804/manifestfile", + "processingEndTime": "2018-08-03T09:04:19.7223808Z", + "processingStartTime": "2018-08-03T09:03:58.5710244Z", "runSettings": { "format": "Csv", - "deliveryInfo": { - "destination": { - "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", - "container": "exports", - "rootFolderPath": "ScheduledTestsForJohnDoe" - } - }, + "compressionMode": "gzip", + "dataOverwriteBehavior": "OverwritePreviousReport", "definition": { "type": "ActualCost", - "timeframe": "Custom", + "dataSet": { + "configuration": { + "dataVersion": "2023-05-01" + }, + "granularity": "Daily" + }, "timePeriod": { "from": "2020-06-01T00:00:00Z", "to": "2020-06-30T00:00:00Z" }, - "dataSet": { - "granularity": "Daily", - "configuration": { - "dataVersion": "2023-05-01" - } + "timeframe": "Custom" + }, + "deliveryInfo": { + "destination": { + "container": "exports", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "rootFolderPath": "ScheduledTestsForJohnDoe" } }, - "partitionData": true, - "dataOverwriteBehavior": "OverwritePreviousReport", - "compressionMode": "gzip", - "exportDescription": "This is a test export." - } + "exportDescription": "This is a test export.", + "partitionData": true + }, + "startDate": "2020-06-01T00:00:00Z", + "status": "Completed", + "submittedBy": "System", + "submittedTime": "2018-08-03T09:03:58.5710244Z" } } ] } } - } + }, + "operationId": "Exports_GetExecutionHistory", + "title": "ExportRunHistoryGetByManagementGroup" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportRunHistoryGetByResourceGroup.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportRunHistoryGetByResourceGroup.json index 88ff1569a653..13b58f3461d2 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportRunHistoryGetByResourceGroup.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportRunHistoryGetByResourceGroup.json @@ -1,103 +1,105 @@ { "parameters": { "api-version": "2025-03-01", - "subscriptionId": "00000000-0000-0000-0000-000000000000", + "exportName": "TestExport", "resourceGroupName": "MYDEVTESTRG", "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG", - "exportName": "TestExport" + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { "value": [ { - "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/exports/JohnDoeSchedule/Run/1e25d58a-a3b0-4916-9542-6e04a89bc100", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/exports/JohnDoeSchedule/Run/1e25d58a-a3b0-4916-9542-6e04a89bc100", "properties": { - "executionType": "OnDemand", - "status": "Completed", - "submittedBy": "john.doe@gmail.com", - "submittedTime": "2018-08-03T07:52:15.6016681Z", - "processingStartTime": "2018-08-03T07:52:16.9123797Z", - "processingEndTime": "2018-08-03T07:52:28.0373318Z", - "startDate": "2020-06-01T00:00:00Z", "endDate": "2020-06-30T00:00:00Z", - "manifestFile": "ScheduledTestsForJohnDoe/JohnDoeSchedule/20180729-20180804/manifestfile", + "executionType": "OnDemand", "fileName": "ScheduledTestsForJohnDoe/JohnDoeSchedule/20180729-20180804/JohnDoeSchedule_1e25d58a-a3b0-4916-9542-6e04a89bc100.csv", + "manifestFile": "ScheduledTestsForJohnDoe/JohnDoeSchedule/20180729-20180804/manifestfile", + "processingEndTime": "2018-08-03T07:52:28.0373318Z", + "processingStartTime": "2018-08-03T07:52:16.9123797Z", "runSettings": { "format": "Csv", - "deliveryInfo": { - "destination": { - "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", - "container": "exports", - "rootFolderPath": "ScheduledTestsForJohnDoe" - } - }, + "compressionMode": "gzip", + "dataOverwriteBehavior": "OverwritePreviousReport", "definition": { "type": "ActualCost", - "timeframe": "Custom", + "dataSet": { + "configuration": { + "dataVersion": "2023-05-01" + }, + "granularity": "Daily" + }, "timePeriod": { "from": "2020-06-01T00:00:00Z", "to": "2020-06-30T00:00:00Z" }, - "dataSet": { - "granularity": "Daily", - "configuration": { - "dataVersion": "2023-05-01" - } + "timeframe": "Custom" + }, + "deliveryInfo": { + "destination": { + "container": "exports", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "rootFolderPath": "ScheduledTestsForJohnDoe" } }, - "partitionData": true, - "dataOverwriteBehavior": "OverwritePreviousReport", - "compressionMode": "gzip", - "exportDescription": "This is a test export." - } + "exportDescription": "This is a test export.", + "partitionData": true + }, + "startDate": "2020-06-01T00:00:00Z", + "status": "Completed", + "submittedBy": "john.doe@gmail.com", + "submittedTime": "2018-08-03T07:52:15.6016681Z" } }, { - "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/exports/JohnDoeSchedule/Run/11ac6811-dca3-46ad-b326-4704cf0c58ef", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/exports/JohnDoeSchedule/Run/11ac6811-dca3-46ad-b326-4704cf0c58ef", "properties": { - "executionType": "Scheduled", - "status": "Completed", - "submittedBy": "System", - "submittedTime": "2018-08-03T09:03:58.5710244Z", - "processingStartTime": "2018-08-03T09:03:58.5710244Z", - "processingEndTime": "2018-08-03T09:04:19.7223808Z", - "startDate": "2020-06-01T00:00:00Z", "endDate": "2020-06-30T00:00:00Z", - "manifestFile": "ScheduledTestsForJohnDoe/JohnDoeSchedule/20180729-20180804/manifestfile", + "executionType": "Scheduled", "fileName": "ScheduledTestsForJohnDoe/JohnDoeSchedule/20180729-20180804/JohnDoeSchedule_11ac6811-dca3-46ad-b326-4704cf0c58ef.csv", + "manifestFile": "ScheduledTestsForJohnDoe/JohnDoeSchedule/20180729-20180804/manifestfile", + "processingEndTime": "2018-08-03T09:04:19.7223808Z", + "processingStartTime": "2018-08-03T09:03:58.5710244Z", "runSettings": { "format": "Csv", - "deliveryInfo": { - "destination": { - "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", - "container": "exports", - "rootFolderPath": "ScheduledTestsForJohnDoe" - } - }, + "compressionMode": "gzip", + "dataOverwriteBehavior": "OverwritePreviousReport", "definition": { "type": "ActualCost", - "timeframe": "Custom", + "dataSet": { + "configuration": { + "dataVersion": "2023-05-01" + }, + "granularity": "Daily" + }, "timePeriod": { "from": "2020-06-01T00:00:00Z", "to": "2020-06-30T00:00:00Z" }, - "dataSet": { - "granularity": "Daily", - "configuration": { - "dataVersion": "2023-05-01" - } + "timeframe": "Custom" + }, + "deliveryInfo": { + "destination": { + "container": "exports", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "rootFolderPath": "ScheduledTestsForJohnDoe" } }, - "partitionData": true, - "dataOverwriteBehavior": "OverwritePreviousReport", - "compressionMode": "gzip", - "exportDescription": "This is a test export." - } + "exportDescription": "This is a test export.", + "partitionData": true + }, + "startDate": "2020-06-01T00:00:00Z", + "status": "Completed", + "submittedBy": "System", + "submittedTime": "2018-08-03T09:03:58.5710244Z" } } ] } } - } + }, + "operationId": "Exports_GetExecutionHistory", + "title": "ExportRunHistoryGetByResourceGroup" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportRunHistoryGetBySubscription.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportRunHistoryGetBySubscription.json index a4b90a0981a9..3a6b11e8d7a3 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportRunHistoryGetBySubscription.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportRunHistoryGetBySubscription.json @@ -1,102 +1,104 @@ { "parameters": { "api-version": "2025-03-01", - "subscriptionId": "00000000-0000-0000-0000-000000000000", + "exportName": "TestExport", "scope": "subscriptions/00000000-0000-0000-0000-000000000000", - "exportName": "TestExport" + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { "value": [ { - "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/exports/JohnDoeSchedule/Run/1e25d58a-a3b0-4916-9542-6e04a89bc100", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/exports/JohnDoeSchedule/Run/1e25d58a-a3b0-4916-9542-6e04a89bc100", "properties": { - "executionType": "OnDemand", - "status": "Completed", - "submittedBy": "john.doe@gmail.com", - "submittedTime": "2018-08-03T07:52:15.6016681Z", - "processingStartTime": "2018-08-03T07:52:16.9123797Z", - "processingEndTime": "2018-08-03T07:52:28.0373318Z", - "startDate": "2020-06-01T00:00:00Z", "endDate": "2020-06-30T00:00:00Z", - "manifestFile": "ScheduledTestsForJohnDoe/JohnDoeSchedule/20180729-20180804/manifestfile", + "executionType": "OnDemand", "fileName": "ScheduledTestsForJohnDoe/JohnDoeSchedule/20180729-20180804/JohnDoeSchedule_1e25d58a-a3b0-4916-9542-6e04a89bc100.csv", + "manifestFile": "ScheduledTestsForJohnDoe/JohnDoeSchedule/20180729-20180804/manifestfile", + "processingEndTime": "2018-08-03T07:52:28.0373318Z", + "processingStartTime": "2018-08-03T07:52:16.9123797Z", "runSettings": { "format": "Csv", - "deliveryInfo": { - "destination": { - "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", - "container": "exports", - "rootFolderPath": "ScheduledTestsForJohnDoe" - } - }, + "compressionMode": "gzip", + "dataOverwriteBehavior": "OverwritePreviousReport", "definition": { "type": "ActualCost", - "timeframe": "Custom", + "dataSet": { + "configuration": { + "dataVersion": "2023-05-01" + }, + "granularity": "Daily" + }, "timePeriod": { "from": "2020-06-01T00:00:00Z", "to": "2020-06-30T00:00:00Z" }, - "dataSet": { - "granularity": "Daily", - "configuration": { - "dataVersion": "2023-05-01" - } + "timeframe": "Custom" + }, + "deliveryInfo": { + "destination": { + "container": "exports", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "rootFolderPath": "ScheduledTestsForJohnDoe" } }, - "partitionData": true, - "dataOverwriteBehavior": "OverwritePreviousReport", - "compressionMode": "gzip", - "exportDescription": "This is a test export." - } + "exportDescription": "This is a test export.", + "partitionData": true + }, + "startDate": "2020-06-01T00:00:00Z", + "status": "Completed", + "submittedBy": "john.doe@gmail.com", + "submittedTime": "2018-08-03T07:52:15.6016681Z" } }, { - "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/exports/JohnDoeSchedule/Run/11ac6811-dca3-46ad-b326-4704cf0c58ef", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/exports/JohnDoeSchedule/Run/11ac6811-dca3-46ad-b326-4704cf0c58ef", "properties": { - "executionType": "Scheduled", - "status": "Completed", - "submittedBy": "System", - "submittedTime": "2018-08-03T09:03:58.5710244Z", - "processingStartTime": "2018-08-03T09:03:58.5710244Z", - "processingEndTime": "2018-08-03T09:04:19.7223808Z", - "startDate": "2020-06-01T00:00:00Z", "endDate": "2020-06-30T00:00:00Z", - "manifestFile": "ScheduledTestsForJohnDoe/JohnDoeSchedule/20180729-20180804/manifestfile", + "executionType": "Scheduled", "fileName": "ScheduledTestsForJohnDoe/JohnDoeSchedule/20180729-20180804/JohnDoeSchedule_11ac6811-dca3-46ad-b326-4704cf0c58ef.csv", + "manifestFile": "ScheduledTestsForJohnDoe/JohnDoeSchedule/20180729-20180804/manifestfile", + "processingEndTime": "2018-08-03T09:04:19.7223808Z", + "processingStartTime": "2018-08-03T09:03:58.5710244Z", "runSettings": { "format": "Csv", - "deliveryInfo": { - "destination": { - "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", - "container": "exports", - "rootFolderPath": "ScheduledTestsForJohnDoe" - } - }, + "compressionMode": "gzip", + "dataOverwriteBehavior": "OverwritePreviousReport", "definition": { "type": "ActualCost", - "timeframe": "Custom", + "dataSet": { + "configuration": { + "dataVersion": "2023-05-01" + }, + "granularity": "Daily" + }, "timePeriod": { "from": "2020-06-01T00:00:00Z", "to": "2020-06-30T00:00:00Z" }, - "dataSet": { - "granularity": "Daily", - "configuration": { - "dataVersion": "2023-05-01" - } + "timeframe": "Custom" + }, + "deliveryInfo": { + "destination": { + "container": "exports", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "rootFolderPath": "ScheduledTestsForJohnDoe" } }, - "partitionData": true, - "dataOverwriteBehavior": "OverwritePreviousReport", - "compressionMode": "gzip", - "exportDescription": "This is a test export." - } + "exportDescription": "This is a test export.", + "partitionData": true + }, + "startDate": "2020-06-01T00:00:00Z", + "status": "Completed", + "submittedBy": "System", + "submittedTime": "2018-08-03T09:03:58.5710244Z" } } ] } } - } + }, + "operationId": "Exports_GetExecutionHistory", + "title": "ExportRunHistoryGetBySubscription" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportsGetByBillingAccount.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportsGetByBillingAccount.json index da6c1a501a15..6885e697d359 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportsGetByBillingAccount.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportsGetByBillingAccount.json @@ -9,9 +9,9 @@ "body": { "value": [ { - "id": "providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/exports/TestExport1", "name": "TestExport1", "type": "Microsoft.CostManagement/exports", + "id": "/providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/exports/TestExport1", "identity": { "type": "SystemAssigned", "principalId": "00000000-0000-0000-0000-000000000000", @@ -20,37 +20,37 @@ "location": "centralus", "properties": { "format": "Csv", - "deliveryInfo": { - "destination": { - "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", - "container": "exports", - "rootFolderPath": "ad-hoc" - } - }, + "compressionMode": "gzip", + "dataOverwriteBehavior": "OverwritePreviousReport", "definition": { "type": "ActualCost", - "timeframe": "Custom", + "dataSet": { + "configuration": { + "dataVersion": "2023-05-01" + }, + "granularity": "Daily" + }, "timePeriod": { "from": "2020-06-01T00:00:00Z", "to": "2020-06-30T00:00:00Z" }, - "dataSet": { - "granularity": "Daily", - "configuration": { - "dataVersion": "2023-05-01" - } + "timeframe": "Custom" + }, + "deliveryInfo": { + "destination": { + "container": "exports", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "rootFolderPath": "ad-hoc" } }, - "partitionData": true, - "dataOverwriteBehavior": "OverwritePreviousReport", - "compressionMode": "gzip", - "exportDescription": "This is a test export." + "exportDescription": "This is a test export.", + "partitionData": true } }, { - "id": "providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/exports/TestExport2", "name": "TestExport2", "type": "Microsoft.CostManagement/exports", + "id": "/providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/exports/TestExport2", "identity": { "type": "SystemAssigned", "principalId": "00000000-0000-0000-0000-000000000000", @@ -58,40 +58,42 @@ }, "location": "centralus", "properties": { - "schedule": { - "status": "Active", - "recurrence": "Weekly", - "recurrencePeriod": { - "from": "2020-06-01T00:00:00Z", - "to": "2020-06-30T00:00:00Z" - } - }, "format": "Csv", - "deliveryInfo": { - "destination": { - "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", - "container": "exports", - "rootFolderPath": "ad-hoc" - } - }, + "compressionMode": "gzip", + "dataOverwriteBehavior": "OverwritePreviousReport", "definition": { "type": "ActualCost", - "timeframe": "WeekToDate", "dataSet": { - "granularity": "Daily", "configuration": { "dataVersion": "2023-05-01" - } + }, + "granularity": "Daily" + }, + "timeframe": "WeekToDate" + }, + "deliveryInfo": { + "destination": { + "container": "exports", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "rootFolderPath": "ad-hoc" } }, + "exportDescription": "This is a test export.", "partitionData": true, - "dataOverwriteBehavior": "OverwritePreviousReport", - "compressionMode": "gzip", - "exportDescription": "This is a test export." + "schedule": { + "recurrence": "Weekly", + "recurrencePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-06-30T00:00:00Z" + }, + "status": "Active" + } } } ] } } - } + }, + "operationId": "Exports_List", + "title": "ExportsGetByBillingAccount" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportsGetByDepartment.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportsGetByDepartment.json index 2f378772dbc4..782cb74eb6d2 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportsGetByDepartment.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportsGetByDepartment.json @@ -10,9 +10,9 @@ "body": { "value": [ { - "id": "providers/Microsoft.Billing/billingAccounts/12/departments/1234/providers/Microsoft.CostManagement/exports/TestExport1", "name": "TestExport1", "type": "Microsoft.CostManagement/exports", + "id": "/providers/Microsoft.Billing/billingAccounts/12/departments/1234/providers/Microsoft.CostManagement/exports/TestExport1", "identity": { "type": "SystemAssigned", "principalId": "00000000-0000-0000-0000-000000000000", @@ -21,37 +21,37 @@ "location": "centralus", "properties": { "format": "Csv", - "deliveryInfo": { - "destination": { - "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", - "container": "exports", - "rootFolderPath": "ad-hoc" - } - }, + "compressionMode": "gzip", + "dataOverwriteBehavior": "OverwritePreviousReport", "definition": { "type": "ActualCost", - "timeframe": "Custom", + "dataSet": { + "configuration": { + "dataVersion": "2023-05-01" + }, + "granularity": "Daily" + }, "timePeriod": { "from": "2020-06-01T00:00:00Z", "to": "2020-06-30T00:00:00Z" }, - "dataSet": { - "granularity": "Daily", - "configuration": { - "dataVersion": "2023-05-01" - } + "timeframe": "Custom" + }, + "deliveryInfo": { + "destination": { + "container": "exports", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "rootFolderPath": "ad-hoc" } }, - "partitionData": true, - "dataOverwriteBehavior": "OverwritePreviousReport", - "compressionMode": "gzip", - "exportDescription": "This is a test export." + "exportDescription": "This is a test export.", + "partitionData": true } }, { - "id": "providers/Microsoft.Billing/billingAccounts/12/departments/1234/providers/Microsoft.CostManagement/exports/TestExport2", "name": "TestExport2", "type": "Microsoft.CostManagement/exports", + "id": "/providers/Microsoft.Billing/billingAccounts/12/departments/1234/providers/Microsoft.CostManagement/exports/TestExport2", "identity": { "type": "SystemAssigned", "principalId": "00000000-0000-0000-0000-000000000000", @@ -59,44 +59,46 @@ }, "location": "centralus", "properties": { - "schedule": { - "status": "Active", - "recurrence": "Weekly", - "recurrencePeriod": { + "format": "Csv", + "compressionMode": "gzip", + "dataOverwriteBehavior": "OverwritePreviousReport", + "definition": { + "type": "ActualCost", + "dataSet": { + "configuration": { + "dataVersion": "2023-05-01" + }, + "granularity": "Daily" + }, + "timePeriod": { "from": "2020-06-01T00:00:00Z", "to": "2020-06-30T00:00:00Z" - } + }, + "timeframe": "Custom" }, - "format": "Csv", "deliveryInfo": { "destination": { - "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", "container": "exports", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", "rootFolderPath": "ad-hoc" } }, - "definition": { - "type": "ActualCost", - "timeframe": "Custom", - "timePeriod": { + "exportDescription": "This is a test export.", + "partitionData": true, + "schedule": { + "recurrence": "Weekly", + "recurrencePeriod": { "from": "2020-06-01T00:00:00Z", "to": "2020-06-30T00:00:00Z" }, - "dataSet": { - "granularity": "Daily", - "configuration": { - "dataVersion": "2023-05-01" - } - } - }, - "partitionData": true, - "dataOverwriteBehavior": "OverwritePreviousReport", - "compressionMode": "gzip", - "exportDescription": "This is a test export." + "status": "Active" + } } } ] } } - } + }, + "operationId": "Exports_List", + "title": "ExportsGetByDepartment" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportsGetByEnrollmentAccount.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportsGetByEnrollmentAccount.json index d0e95888bfae..cbb6d8b37515 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportsGetByEnrollmentAccount.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportsGetByEnrollmentAccount.json @@ -10,9 +10,9 @@ "body": { "value": [ { - "id": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456/providers/Microsoft.CostManagement/exports/TestExport1", "name": "TestExport1", "type": "Microsoft.CostManagement/exports", + "id": "/providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456/providers/Microsoft.CostManagement/exports/TestExport1", "identity": { "type": "SystemAssigned", "principalId": "00000000-0000-0000-0000-000000000000", @@ -21,37 +21,37 @@ "location": "centralus", "properties": { "format": "Csv", - "deliveryInfo": { - "destination": { - "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", - "container": "exports", - "rootFolderPath": "ad-hoc" - } - }, + "compressionMode": "gzip", + "dataOverwriteBehavior": "OverwritePreviousReport", "definition": { "type": "ActualCost", - "timeframe": "Custom", + "dataSet": { + "configuration": { + "dataVersion": "2023-05-01" + }, + "granularity": "Daily" + }, "timePeriod": { "from": "2020-06-01T00:00:00Z", "to": "2020-06-30T00:00:00Z" }, - "dataSet": { - "granularity": "Daily", - "configuration": { - "dataVersion": "2023-05-01" - } + "timeframe": "Custom" + }, + "deliveryInfo": { + "destination": { + "container": "exports", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "rootFolderPath": "ad-hoc" } }, - "partitionData": true, - "dataOverwriteBehavior": "OverwritePreviousReport", - "compressionMode": "gzip", - "exportDescription": "This is a test export." + "exportDescription": "This is a test export.", + "partitionData": true } }, { - "id": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456/providers/Microsoft.CostManagement/exports/TestExport2", "name": "TestExport2", "type": "Microsoft.CostManagement/exports", + "id": "/providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456/providers/Microsoft.CostManagement/exports/TestExport2", "identity": { "type": "SystemAssigned", "principalId": "00000000-0000-0000-0000-000000000000", @@ -59,44 +59,46 @@ }, "location": "centralus", "properties": { - "schedule": { - "status": "Active", - "recurrence": "Weekly", - "recurrencePeriod": { + "format": "Csv", + "compressionMode": "gzip", + "dataOverwriteBehavior": "OverwritePreviousReport", + "definition": { + "type": "ActualCost", + "dataSet": { + "configuration": { + "dataVersion": "2023-05-01" + }, + "granularity": "Daily" + }, + "timePeriod": { "from": "2020-06-01T00:00:00Z", "to": "2020-06-30T00:00:00Z" - } + }, + "timeframe": "Custom" }, - "format": "Csv", "deliveryInfo": { "destination": { - "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", "container": "exports", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", "rootFolderPath": "ad-hoc" } }, - "definition": { - "type": "ActualCost", - "timeframe": "Custom", - "timePeriod": { + "exportDescription": "This is a test export.", + "partitionData": true, + "schedule": { + "recurrence": "Weekly", + "recurrencePeriod": { "from": "2020-06-01T00:00:00Z", "to": "2020-06-30T00:00:00Z" }, - "dataSet": { - "granularity": "Daily", - "configuration": { - "dataVersion": "2023-05-01" - } - } - }, - "partitionData": true, - "dataOverwriteBehavior": "OverwritePreviousReport", - "compressionMode": "gzip", - "exportDescription": "This is a test export." + "status": "Active" + } } } ] } } - } + }, + "operationId": "Exports_List", + "title": "ExportsGetByEnrollmentAccount" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportsGetByManagementGroup.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportsGetByManagementGroup.json index 0d670b13be5a..0553c672736e 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportsGetByManagementGroup.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportsGetByManagementGroup.json @@ -9,9 +9,9 @@ "body": { "value": [ { - "id": "providers/Microsoft.Management/managementGroups/TestMG/providers/Microsoft.CostManagement/exports/TestExport1", "name": "TestExport1", "type": "Microsoft.CostManagement/exports", + "id": "/providers/Microsoft.Management/managementGroups/TestMG/providers/Microsoft.CostManagement/exports/TestExport1", "identity": { "type": "SystemAssigned", "principalId": "00000000-0000-0000-0000-000000000000", @@ -20,37 +20,37 @@ "location": "centralus", "properties": { "format": "Csv", - "deliveryInfo": { - "destination": { - "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", - "container": "exports", - "rootFolderPath": "ad-hoc" - } - }, + "compressionMode": "gzip", + "dataOverwriteBehavior": "OverwritePreviousReport", "definition": { "type": "ActualCost", - "timeframe": "Custom", + "dataSet": { + "configuration": { + "dataVersion": "2023-05-01" + }, + "granularity": "Daily" + }, "timePeriod": { "from": "2020-06-01T00:00:00Z", "to": "2020-06-30T00:00:00Z" }, - "dataSet": { - "granularity": "Daily", - "configuration": { - "dataVersion": "2023-05-01" - } + "timeframe": "Custom" + }, + "deliveryInfo": { + "destination": { + "container": "exports", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "rootFolderPath": "ad-hoc" } }, - "partitionData": true, - "dataOverwriteBehavior": "OverwritePreviousReport", - "compressionMode": "gzip", - "exportDescription": "This is a test export." + "exportDescription": "This is a test export.", + "partitionData": true } }, { - "id": "providers/Microsoft.Management/managementGroups/TestMG/providers/Microsoft.CostManagement/exports/TestExport2", "name": "TestExport2", "type": "Microsoft.CostManagement/exports", + "id": "/providers/Microsoft.Management/managementGroups/TestMG/providers/Microsoft.CostManagement/exports/TestExport2", "identity": { "type": "SystemAssigned", "principalId": "00000000-0000-0000-0000-000000000000", @@ -58,44 +58,46 @@ }, "location": "centralus", "properties": { - "schedule": { - "status": "Active", - "recurrence": "Weekly", - "recurrencePeriod": { + "format": "Csv", + "compressionMode": "gzip", + "dataOverwriteBehavior": "OverwritePreviousReport", + "definition": { + "type": "ActualCost", + "dataSet": { + "configuration": { + "dataVersion": "2023-05-01" + }, + "granularity": "Daily" + }, + "timePeriod": { "from": "2020-06-01T00:00:00Z", "to": "2020-06-30T00:00:00Z" - } + }, + "timeframe": "Custom" }, - "format": "Csv", "deliveryInfo": { "destination": { - "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", "container": "exports", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", "rootFolderPath": "ad-hoc" } }, - "definition": { - "type": "ActualCost", - "timeframe": "Custom", - "timePeriod": { + "exportDescription": "This is a test export.", + "partitionData": true, + "schedule": { + "recurrence": "Weekly", + "recurrencePeriod": { "from": "2020-06-01T00:00:00Z", "to": "2020-06-30T00:00:00Z" }, - "dataSet": { - "granularity": "Daily", - "configuration": { - "dataVersion": "2023-05-01" - } - } - }, - "partitionData": true, - "dataOverwriteBehavior": "OverwritePreviousReport", - "compressionMode": "gzip", - "exportDescription": "This is a test export." + "status": "Active" + } } } ] } } - } + }, + "operationId": "Exports_List", + "title": "ExportsGetByManagementGroup" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportsGetByResourceGroup.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportsGetByResourceGroup.json index f68f3dfe5e16..df4b1d5942c5 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportsGetByResourceGroup.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportsGetByResourceGroup.json @@ -1,18 +1,18 @@ { "parameters": { "api-version": "2025-03-01", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "MYDEVTESTRG", - "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG" + "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { "value": [ { - "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/exports/TestExport1", "name": "TestExport1", "type": "Microsoft.CostManagement/exports", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/exports/TestExport1", "identity": { "type": "SystemAssigned", "principalId": "00000000-0000-0000-0000-000000000000", @@ -21,37 +21,37 @@ "location": "centralus", "properties": { "format": "Csv", - "deliveryInfo": { - "destination": { - "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", - "container": "exports", - "rootFolderPath": "ad-hoc" - } - }, + "compressionMode": "gzip", + "dataOverwriteBehavior": "OverwritePreviousReport", "definition": { "type": "ActualCost", - "timeframe": "Custom", + "dataSet": { + "configuration": { + "dataVersion": "2023-05-01" + }, + "granularity": "Daily" + }, "timePeriod": { "from": "2020-06-01T00:00:00Z", "to": "2020-06-30T00:00:00Z" }, - "dataSet": { - "granularity": "Daily", - "configuration": { - "dataVersion": "2023-05-01" - } + "timeframe": "Custom" + }, + "deliveryInfo": { + "destination": { + "container": "exports", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "rootFolderPath": "ad-hoc" } }, - "partitionData": true, - "dataOverwriteBehavior": "OverwritePreviousReport", - "compressionMode": "gzip", - "exportDescription": "This is a test export." + "exportDescription": "This is a test export.", + "partitionData": true } }, { - "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/exports/TestExport2", "name": "TestExport2", "type": "Microsoft.CostManagement/exports", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/exports/TestExport2", "identity": { "type": "SystemAssigned", "principalId": "00000000-0000-0000-0000-000000000000", @@ -59,44 +59,46 @@ }, "location": "centralus", "properties": { - "schedule": { - "status": "Active", - "recurrence": "Weekly", - "recurrencePeriod": { + "format": "Csv", + "compressionMode": "gzip", + "dataOverwriteBehavior": "OverwritePreviousReport", + "definition": { + "type": "ActualCost", + "dataSet": { + "configuration": { + "dataVersion": "2023-05-01" + }, + "granularity": "Daily" + }, + "timePeriod": { "from": "2020-06-01T00:00:00Z", "to": "2020-06-30T00:00:00Z" - } + }, + "timeframe": "Custom" }, - "format": "Csv", "deliveryInfo": { "destination": { - "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", "container": "exports", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", "rootFolderPath": "ad-hoc" } }, - "definition": { - "type": "ActualCost", - "timeframe": "Custom", - "timePeriod": { + "exportDescription": "This is a test export.", + "partitionData": true, + "schedule": { + "recurrence": "Weekly", + "recurrencePeriod": { "from": "2020-06-01T00:00:00Z", "to": "2020-06-30T00:00:00Z" }, - "dataSet": { - "granularity": "Daily", - "configuration": { - "dataVersion": "2023-05-01" - } - } - }, - "partitionData": true, - "dataOverwriteBehavior": "OverwritePreviousReport", - "compressionMode": "gzip", - "exportDescription": "This is a test export." + "status": "Active" + } } } ] } } - } + }, + "operationId": "Exports_List", + "title": "ExportsGetByResourceGroup" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportsGetBySubscription.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportsGetBySubscription.json index c6e36b70679a..96aac6905443 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportsGetBySubscription.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExportsGetBySubscription.json @@ -1,17 +1,17 @@ { "parameters": { "api-version": "2025-03-01", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "scope": "subscriptions/00000000-0000-0000-0000-000000000000" + "scope": "subscriptions/00000000-0000-0000-0000-000000000000", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { "value": [ { - "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/exports/TestExport1", "name": "TestExport1", "type": "Microsoft.CostManagement/exports", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/exports/TestExport1", "identity": { "type": "SystemAssigned", "principalId": "00000000-0000-0000-0000-000000000000", @@ -20,37 +20,37 @@ "location": "centralus", "properties": { "format": "Csv", - "deliveryInfo": { - "destination": { - "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", - "container": "exports", - "rootFolderPath": "ad-hoc" - } - }, + "compressionMode": "gzip", + "dataOverwriteBehavior": "OverwritePreviousReport", "definition": { "type": "ActualCost", - "timeframe": "Custom", + "dataSet": { + "configuration": { + "dataVersion": "2023-05-01" + }, + "granularity": "Daily" + }, "timePeriod": { "from": "2020-06-01T00:00:00Z", "to": "2020-06-30T00:00:00Z" }, - "dataSet": { - "granularity": "Daily", - "configuration": { - "dataVersion": "2023-05-01" - } + "timeframe": "Custom" + }, + "deliveryInfo": { + "destination": { + "container": "exports", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "rootFolderPath": "ad-hoc" } }, - "partitionData": true, - "dataOverwriteBehavior": "OverwritePreviousReport", - "compressionMode": "gzip", - "exportDescription": "This is a test export." + "exportDescription": "This is a test export.", + "partitionData": true } }, { - "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/exports/TestExport2", "name": "TestExport2", "type": "Microsoft.CostManagement/exports", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/exports/TestExport2", "identity": { "type": "SystemAssigned", "principalId": "00000000-0000-0000-0000-000000000000", @@ -58,44 +58,46 @@ }, "location": "centralus", "properties": { - "schedule": { - "status": "Active", - "recurrence": "Weekly", - "recurrencePeriod": { + "format": "Csv", + "compressionMode": "gzip", + "dataOverwriteBehavior": "OverwritePreviousReport", + "definition": { + "type": "ActualCost", + "dataSet": { + "configuration": { + "dataVersion": "2023-05-01" + }, + "granularity": "Daily" + }, + "timePeriod": { "from": "2020-06-01T00:00:00Z", "to": "2020-06-30T00:00:00Z" - } + }, + "timeframe": "Custom" }, - "format": "Csv", "deliveryInfo": { "destination": { - "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", "container": "exports", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", "rootFolderPath": "ad-hoc" } }, - "definition": { - "type": "ActualCost", - "timeframe": "Custom", - "timePeriod": { + "exportDescription": "This is a test export.", + "partitionData": true, + "schedule": { + "recurrence": "Weekly", + "recurrencePeriod": { "from": "2020-06-01T00:00:00Z", "to": "2020-06-30T00:00:00Z" }, - "dataSet": { - "granularity": "Daily", - "configuration": { - "dataVersion": "2023-05-01" - } - } - }, - "partitionData": true, - "dataOverwriteBehavior": "OverwritePreviousReport", - "compressionMode": "gzip", - "exportDescription": "This is a test export." + "status": "Active" + } } } ] } } - } + }, + "operationId": "Exports_List", + "title": "ExportsGetBySubscription" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExternalBillingAccountAlerts.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExternalBillingAccountAlerts.json index f5280d4099d2..3f17e2817793 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExternalBillingAccountAlerts.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExternalBillingAccountAlerts.json @@ -7,92 +7,94 @@ "responses": { "200": { "body": { + "nextLink": null, "value": [ { - "id": "providers/Microsoft.CostManagement/externalBillingAccounts/100/providers/Microsoft.CostManagement/alerts/00000000-0000-0000-0000-000000000000", "name": "00000000-0000-0000-0000-000000000000", "type": "Microsoft.CostManagement/alerts", + "id": "/providers/Microsoft.CostManagement/externalBillingAccounts/100/providers/Microsoft.CostManagement/alerts/00000000-0000-0000-0000-000000000000", "properties": { + "description": "", + "closeTime": "0001-01-01T00:00:00", + "costEntityId": "budget1", + "creationTime": "2020-04-27T11:07:52.7143901Z", "definition": { "type": "Budget", "category": "Cost", "criteria": "CostThresholdExceeded" }, - "description": "", + "modificationTime": "2020-04-28T11:06:02.8999373Z", "source": "Preset", + "status": "Active", + "statusModificationTime": "0001-01-01T00:00:00", + "statusModificationUserName": null, "details": { - "timeGrainType": "Quarterly", - "periodStartDate": "2020-03-01T00:00:00Z", - "triggeredBy": "00000000-0000-0000-0000-000000000000_1_01", - "resourceGroupFilter": [], - "resourceFilter": [], - "meterFilter": [], - "tagFilter": {}, - "threshold": 0.8, - "operator": "GreaterThan", - "amount": 200000.0, - "unit": "USD", - "currentSpend": 161000.12, + "amount": 200000, "contactEmails": [ "1234@contoso.com" ], "contactGroups": [], "contactRoles": [], - "overridingAlert": null - }, - "costEntityId": "budget1", - "status": "Active", - "creationTime": "2020-04-27T11:07:52.7143901Z", - "closeTime": "0001-01-01T00:00:00", - "modificationTime": "2020-04-28T11:06:02.8999373Z", - "statusModificationUserName": null, - "statusModificationTime": "0001-01-01T00:00:00" + "currentSpend": 161000.12, + "meterFilter": [], + "operator": "GreaterThan", + "overridingAlert": null, + "periodStartDate": "2020-03-01T00:00:00Z", + "resourceFilter": [], + "resourceGroupFilter": [], + "tagFilter": {}, + "threshold": 0.8, + "timeGrainType": "Quarterly", + "triggeredBy": "00000000-0000-0000-0000-000000000000_1_01", + "unit": "USD" + } } }, { - "id": "providers/Microsoft.CostManagement/externalBillingAccounts/100/providers/Microsoft.CostManagement/alerts/11111111-1111-1111-111111111111", "name": "11111111-1111-1111-111111111111", "type": "Microsoft.CostManagement/alerts", + "id": "/providers/Microsoft.CostManagement/externalBillingAccounts/100/providers/Microsoft.CostManagement/alerts/11111111-1111-1111-111111111111", "properties": { + "description": "", + "closeTime": "0001-01-01T00:00:00", + "costEntityId": "budget1", + "creationTime": "2019-06-24T05:51:52.8713179Z", "definition": { "type": "Budget", "category": "Cost", "criteria": "CostThresholdExceeded" }, - "description": "", + "modificationTime": "2019-08-31T17:51:55.1808807Z", "source": "Preset", + "status": "Active", + "statusModificationTime": "0001-01-01T00:00:00", + "statusModificationUserName": null, "details": { - "timeGrainType": "Quarterly", - "periodStartDate": "2020-03-01T00:00:00Z", - "triggeredBy": "11111111-1111-1111-111111111111_1_01", - "resourceGroupFilter": [], - "resourceFilter": [], - "meterFilter": [], - "tagFilter": {}, - "threshold": 0.8, - "operator": "GreaterThan", - "amount": 200000.0, - "unit": "USD", - "currentSpend": 171000.32, + "amount": 200000, "contactEmails": [ "1234@contoso.com" ], "contactGroups": [], "contactRoles": [], - "overridingAlert": null - }, - "costEntityId": "budget1", - "status": "Active", - "creationTime": "2019-06-24T05:51:52.8713179Z", - "closeTime": "0001-01-01T00:00:00", - "modificationTime": "2019-08-31T17:51:55.1808807Z", - "statusModificationUserName": null, - "statusModificationTime": "0001-01-01T00:00:00" + "currentSpend": 171000.32, + "meterFilter": [], + "operator": "GreaterThan", + "overridingAlert": null, + "periodStartDate": "2020-03-01T00:00:00Z", + "resourceFilter": [], + "resourceGroupFilter": [], + "tagFilter": {}, + "threshold": 0.8, + "timeGrainType": "Quarterly", + "triggeredBy": "11111111-1111-1111-111111111111_1_01", + "unit": "USD" + } } } - ], - "nextLink": null + ] } } - } + }, + "operationId": "Alerts_ListExternal", + "title": "ExternalBillingAccountAlerts" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExternalBillingAccountForecast.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExternalBillingAccountForecast.json index 0de36d4ba2b5..51472ba6a1dd 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExternalBillingAccountForecast.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExternalBillingAccountForecast.json @@ -5,13 +5,7 @@ "externalCloudProviderType": "externalBillingAccounts", "parameters": { "type": "Usage", - "timeframe": "Custom", - "timePeriod": { - "from": "2022-08-01T00:00:00+00:00", - "to": "2022-08-31T23:59:59+00:00" - }, "dataset": { - "granularity": "Daily", "aggregation": { "totalCost": { "name": "Cost", @@ -54,18 +48,23 @@ } } ] - } - } + }, + "granularity": "Daily" + }, + "timePeriod": { + "from": "2022-08-01T00:00:00+00:00", + "to": "2022-08-31T23:59:59+00:00" + }, + "timeframe": "Custom" } }, "responses": { "200": { "body": { - "id": "providers/Microsoft.CostManagement/externalBillingAccounts/100/query/6dc7b06a-d90a-4df5-b655-ce6cf1c0814d", "name": "6dc7b06a-d90a-4df5-b655-ce6cf1c0814d", "type": "Microsoft.CostManagement/query", + "id": "/providers/Microsoft.CostManagement/externalBillingAccounts/100/query/6dc7b06a-d90a-4df5-b655-ce6cf1c0814d", "properties": { - "nextLink": null, "columns": [ { "name": "PreTaxCost", @@ -80,9 +79,10 @@ "type": "String" } ], + "nextLink": null, "rows": [ [ - 0.0, + 0, "Forecast", "USD" ], @@ -92,12 +92,12 @@ "USD" ], [ - 0.076757602000000022, + 0.07675760200000002, "Forecast", "USD" ], [ - 50.430964190400012, + 50.43096419040001, "Forecast", "USD" ] @@ -105,5 +105,7 @@ } } } - } + }, + "operationId": "Forecast_ExternalCloudProviderUsage", + "title": "ExternalBillingAccountForecast" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExternalBillingAccountsDimensions.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExternalBillingAccountsDimensions.json index 39a45007dbd0..42097259c48f 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExternalBillingAccountsDimensions.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExternalBillingAccountsDimensions.json @@ -9,10 +9,12 @@ "body": { "value": [ { - "id": "providers/Microsoft.CostManagement/externalBillingAccounts/100/dimensions_ResourceType_2019-12-01_2019-12-31", "name": "dimensions_ResourceType_2019-12-01_2019-12-31", "type": "microsoft.consumption/dimensions", + "id": "/providers/Microsoft.CostManagement/externalBillingAccounts/100/dimensions_ResourceType_2019-12-01_2019-12-31", "properties": { + "description": "Resource type", + "category": "ResourceType", "data": [ "thoroetrg01", "default-notificationhubs-westus", @@ -20,20 +22,20 @@ "contosocodeflow8d4a", "noobaa" ], + "filterEnabled": true, + "groupingEnabled": true, "total": 0, - "category": "ResourceType", - "description": "Resource type", - "usageStart": "2019-12-01T00:00:00Z", "usageEnd": "2019-12-31T00:00:00Z", - "filterEnabled": true, - "groupingEnabled": true + "usageStart": "2019-12-01T00:00:00Z" } }, { - "id": "providers/Microsoft.CostManagement/externalBillingAccounts/100/dimensions_ResourceId_2019-12-01_2019-12-31", "name": "dimensions_ResourceId_2019-12-01_2019-12-31", "type": "microsoft.consumption/dimensions", + "id": "/providers/Microsoft.CostManagement/externalBillingAccounts/100/dimensions_ResourceId_2019-12-01_2019-12-31", "properties": { + "description": "Resource ID", + "category": "ResourceId", "data": [ "thoroetrg01", "default-notificationhubs-westus", @@ -41,17 +43,17 @@ "contosocodeflow8d4a", "noobaa" ], + "filterEnabled": true, + "groupingEnabled": true, "total": 0, - "category": "ResourceId", - "description": "Resource ID", - "usageStart": "2019-12-01T00:00:00Z", "usageEnd": "2019-12-31T00:00:00Z", - "filterEnabled": true, - "groupingEnabled": true + "usageStart": "2019-12-01T00:00:00Z" } } ] } } - } + }, + "operationId": "Dimensions_ByExternalCloudProviderType", + "title": "ExternalBillingAccountDimensionList" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExternalBillingAccountsQuery.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExternalBillingAccountsQuery.json index 29bb7123c074..27088513dbe1 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExternalBillingAccountsQuery.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExternalBillingAccountsQuery.json @@ -5,9 +5,7 @@ "externalCloudProviderType": "externalBillingAccounts", "parameters": { "type": "Usage", - "timeframe": "MonthToDate", "dataset": { - "granularity": "Daily", "filter": { "and": [ { @@ -44,18 +42,19 @@ } } ] - } - } + }, + "granularity": "Daily" + }, + "timeframe": "MonthToDate" } }, "responses": { "200": { "body": { - "id": "providers/Microsoft.CostManagement/externalBillingAccounts/100/query/6dc7b06a-d90a-4df5-b655-ce6cf1c0814d", "name": "6dc7b06a-d90a-4df5-b655-ce6cf1c0814d", "type": "Microsoft.CostManagement/query", + "id": "/providers/Microsoft.CostManagement/externalBillingAccounts/100/query/6dc7b06a-d90a-4df5-b655-ce6cf1c0814d", "properties": { - "nextLink": null, "columns": [ { "name": "PreTaxCost", @@ -70,9 +69,10 @@ "type": "String" } ], + "nextLink": null, "rows": [ [ - 0.0, + 0, "abc db", "USD" ], @@ -82,12 +82,12 @@ "USD" ], [ - 0.076757602000000022, + 0.07675760200000002, "abc file system", "USD" ], [ - 50.430964190400012, + 50.43096419040001, "abc elasticache", "USD" ] @@ -95,5 +95,7 @@ } } } - } + }, + "operationId": "Query_UsageByExternalCloudProviderType", + "title": "ExternalBillingAccountQueryList" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExternalSubscriptionAlerts.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExternalSubscriptionAlerts.json index 01467a0f5000..5aa2c4476ab6 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExternalSubscriptionAlerts.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExternalSubscriptionAlerts.json @@ -7,92 +7,94 @@ "responses": { "200": { "body": { + "nextLink": null, "value": [ { - "id": "providers/Microsoft.CostManagement/externalSubscriptions/100/providers/Microsoft.CostManagement/alerts/00000000-0000-0000-0000-000000000000", "name": "00000000-0000-0000-0000-000000000000", "type": "Microsoft.CostManagement/alerts", + "id": "/providers/Microsoft.CostManagement/externalSubscriptions/100/providers/Microsoft.CostManagement/alerts/00000000-0000-0000-0000-000000000000", "properties": { + "description": "", + "closeTime": "0001-01-01T00:00:00", + "costEntityId": "budget1", + "creationTime": "2020-04-27T11:07:52.7143901Z", "definition": { "type": "Budget", "category": "Cost", "criteria": "CostThresholdExceeded" }, - "description": "", + "modificationTime": "2020-04-28T11:06:02.8999373Z", "source": "Preset", + "status": "Active", + "statusModificationTime": "0001-01-01T00:00:00", + "statusModificationUserName": null, "details": { - "timeGrainType": "Quarterly", - "periodStartDate": "2020-03-01T00:00:00Z", - "triggeredBy": "00000000-0000-0000-0000-000000000000_1_01", - "resourceGroupFilter": [], - "resourceFilter": [], - "meterFilter": [], - "tagFilter": {}, - "threshold": 0.8, - "operator": "GreaterThan", - "amount": 200000.0, - "unit": "USD", - "currentSpend": 161000.12, + "amount": 200000, "contactEmails": [ "1234@contoso.com" ], "contactGroups": [], "contactRoles": [], - "overridingAlert": null - }, - "costEntityId": "budget1", - "status": "Active", - "creationTime": "2020-04-27T11:07:52.7143901Z", - "closeTime": "0001-01-01T00:00:00", - "modificationTime": "2020-04-28T11:06:02.8999373Z", - "statusModificationUserName": null, - "statusModificationTime": "0001-01-01T00:00:00" + "currentSpend": 161000.12, + "meterFilter": [], + "operator": "GreaterThan", + "overridingAlert": null, + "periodStartDate": "2020-03-01T00:00:00Z", + "resourceFilter": [], + "resourceGroupFilter": [], + "tagFilter": {}, + "threshold": 0.8, + "timeGrainType": "Quarterly", + "triggeredBy": "00000000-0000-0000-0000-000000000000_1_01", + "unit": "USD" + } } }, { - "id": "providers/Microsoft.CostManagement/externalSubscriptions/100/providers/Microsoft.CostManagement/alerts/11111111-1111-1111-111111111111", "name": "11111111-1111-1111-111111111111", "type": "Microsoft.CostManagement/alerts", + "id": "/providers/Microsoft.CostManagement/externalSubscriptions/100/providers/Microsoft.CostManagement/alerts/11111111-1111-1111-111111111111", "properties": { + "description": "", + "closeTime": "0001-01-01T00:00:00", + "costEntityId": "budget1", + "creationTime": "2019-06-24T05:51:52.8713179Z", "definition": { "type": "Budget", "category": "Cost", "criteria": "CostThresholdExceeded" }, - "description": "", + "modificationTime": "2019-08-31T17:51:55.1808807Z", "source": "Preset", + "status": "Active", + "statusModificationTime": "0001-01-01T00:00:00", + "statusModificationUserName": null, "details": { - "timeGrainType": "Quarterly", - "periodStartDate": "2020-03-01T00:00:00Z", - "triggeredBy": "11111111-1111-1111-111111111111_1_01", - "resourceGroupFilter": [], - "resourceFilter": [], - "meterFilter": [], - "tagFilter": {}, - "threshold": 0.8, - "operator": "GreaterThan", - "amount": 200000.0, - "unit": "USD", - "currentSpend": 171000.32, + "amount": 200000, "contactEmails": [ "1234@contoso.com" ], "contactGroups": [], "contactRoles": [], - "overridingAlert": null - }, - "costEntityId": "budget1", - "status": "Active", - "creationTime": "2019-06-24T05:51:52.8713179Z", - "closeTime": "0001-01-01T00:00:00", - "modificationTime": "2019-08-31T17:51:55.1808807Z", - "statusModificationUserName": null, - "statusModificationTime": "0001-01-01T00:00:00" + "currentSpend": 171000.32, + "meterFilter": [], + "operator": "GreaterThan", + "overridingAlert": null, + "periodStartDate": "2020-03-01T00:00:00Z", + "resourceFilter": [], + "resourceGroupFilter": [], + "tagFilter": {}, + "threshold": 0.8, + "timeGrainType": "Quarterly", + "triggeredBy": "11111111-1111-1111-111111111111_1_01", + "unit": "USD" + } } } - ], - "nextLink": null + ] } } - } + }, + "operationId": "Alerts_ListExternal", + "title": "ExternalSubscriptionAlerts" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExternalSubscriptionForecast.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExternalSubscriptionForecast.json index 9bc2b222fe2a..4aa83bbbd370 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExternalSubscriptionForecast.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExternalSubscriptionForecast.json @@ -5,13 +5,7 @@ "externalCloudProviderType": "externalSubscriptions", "parameters": { "type": "Usage", - "timeframe": "Custom", - "timePeriod": { - "from": "2022-08-01T00:00:00+00:00", - "to": "2022-08-31T23:59:59+00:00" - }, "dataset": { - "granularity": "Daily", "aggregation": { "totalCost": { "name": "Cost", @@ -54,18 +48,23 @@ } } ] - } - } + }, + "granularity": "Daily" + }, + "timePeriod": { + "from": "2022-08-01T00:00:00+00:00", + "to": "2022-08-31T23:59:59+00:00" + }, + "timeframe": "Custom" } }, "responses": { "200": { "body": { - "id": "providers/Microsoft.CostManagement/externalSubscriptions/100/query/d99477af-7510-40ee-aca2-e59bdca0d10d", "name": "d99477af-7510-40ee-aca2-e59bdca0d10d", "type": "Microsoft.CostManagement/query", + "id": "/providers/Microsoft.CostManagement/externalSubscriptions/100/query/d99477af-7510-40ee-aca2-e59bdca0d10d", "properties": { - "nextLink": null, "columns": [ { "name": "PreTaxCost", @@ -84,9 +83,12 @@ "type": "String" } ], + "nextLink": null, "rows": [] } } } - } + }, + "operationId": "Forecast_ExternalCloudProviderUsage", + "title": "ExternalSubscriptionForecast" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExternalSubscriptionsDimensions.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExternalSubscriptionsDimensions.json index ac39e060828e..fe865e2a9b3d 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExternalSubscriptionsDimensions.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExternalSubscriptionsDimensions.json @@ -9,10 +9,12 @@ "body": { "value": [ { - "id": "providers/Microsoft.CostManagement/externalSubscriptions/123/dimensions_ResourceType_2019-12-01_2019-12-31", "name": "dimensions_ResourceType_2019-12-01_2019-12-31", "type": "microsoft.consumption/dimensions", + "id": "/providers/Microsoft.CostManagement/externalSubscriptions/123/dimensions_ResourceType_2019-12-01_2019-12-31", "properties": { + "description": "Resource type", + "category": "ResourceType", "data": [ "thoroetrg01", "default-notificationhubs-westus", @@ -20,20 +22,20 @@ "contosocodeflow8d4a", "noobaa" ], + "filterEnabled": true, + "groupingEnabled": true, "total": 0, - "category": "ResourceType", - "description": "Resource type", - "usageStart": "2019-12-01T00:00:00Z", "usageEnd": "2019-12-31T00:00:00Z", - "filterEnabled": true, - "groupingEnabled": true + "usageStart": "2019-12-01T00:00:00Z" } }, { - "id": "providers/Microsoft.CostManagement/externalSubscriptions/123/dimensions_ResourceId_2019-12-01_2019-12-31", "name": "dimensions_ResourceId_2019-12-01_2019-12-31", "type": "microsoft.consumption/dimensions", + "id": "/providers/Microsoft.CostManagement/externalSubscriptions/123/dimensions_ResourceId_2019-12-01_2019-12-31", "properties": { + "description": "Resource ID", + "category": "ResourceId", "data": [ "thoroetrg01", "default-notificationhubs-westus", @@ -41,17 +43,17 @@ "contosocodeflow8d4a", "noobaa" ], + "filterEnabled": true, + "groupingEnabled": true, "total": 0, - "category": "ResourceId", - "description": "Resource ID", - "usageStart": "2019-12-01T00:00:00Z", "usageEnd": "2019-12-31T00:00:00Z", - "filterEnabled": true, - "groupingEnabled": true + "usageStart": "2019-12-01T00:00:00Z" } } ] } } - } + }, + "operationId": "Dimensions_ByExternalCloudProviderType", + "title": "ExternalSubscriptionDimensionList" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExternalSubscriptionsQuery.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExternalSubscriptionsQuery.json index 3720a19a91d6..d45465bd5742 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExternalSubscriptionsQuery.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ExternalSubscriptionsQuery.json @@ -5,9 +5,7 @@ "externalCloudProviderType": "externalSubscriptions", "parameters": { "type": "Usage", - "timeframe": "MonthToDate", "dataset": { - "granularity": "Daily", "filter": { "and": [ { @@ -44,18 +42,19 @@ } } ] - } - } + }, + "granularity": "Daily" + }, + "timeframe": "MonthToDate" } }, "responses": { "200": { "body": { - "id": "providers/Microsoft.CostManagement/externalSubscriptions/100/query/d99477af-7510-40ee-aca2-e59bdca0d10d", "name": "d99477af-7510-40ee-aca2-e59bdca0d10d", "type": "Microsoft.CostManagement/query", + "id": "/providers/Microsoft.CostManagement/externalSubscriptions/100/query/d99477af-7510-40ee-aca2-e59bdca0d10d", "properties": { - "nextLink": null, "columns": [ { "name": "PreTaxCost", @@ -70,9 +69,12 @@ "type": "String" } ], + "nextLink": null, "rows": [] } } } - } + }, + "operationId": "Query_UsageByExternalCloudProviderType", + "title": "ExternalSubscriptionsQuery" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/GenerateCostDetailsReportByBillingAccountEnterpriseAgreementCustomerAndBillingPeriod.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/GenerateCostDetailsReportByBillingAccountEnterpriseAgreementCustomerAndBillingPeriod.json index d0f23d18cf17..696d017784ab 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/GenerateCostDetailsReportByBillingAccountEnterpriseAgreementCustomerAndBillingPeriod.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/GenerateCostDetailsReportByBillingAccountEnterpriseAgreementCustomerAndBillingPeriod.json @@ -1,38 +1,38 @@ { "parameters": { "api-version": "2025-03-01", - "scope": "providers/Microsoft.Billing/billingAccounts/12345", "parameters": { - "metric": "ActualCost", - "billingPeriod": "202205" - } + "billingPeriod": "202205", + "metric": "ActualCost" + }, + "scope": "providers/Microsoft.Billing/billingAccounts/12345" }, "responses": { "200": { "body": { - "id": "providers/Microsoft.Billing/billingAccounts/12345/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000", "name": "00000000-0000-0000-0000-000000000000", - "status": "Completed", + "id": "/providers/Microsoft.Billing/billingAccounts/12345/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000", "manifest": { - "manifestVersion": "2025-03-01", - "dataFormat": "Csv", "blobCount": 1, - "byteCount": 32741, - "compressData": false, - "requestContext": { - "requestScope": "providers/Microsoft.Billing/billingAccounts/12345", - "requestBody": { - "metric": "ActualCost", - "billingPeriod": "202205" - } - }, "blobs": [ { "blobLink": "https://ccmreportstorageeastus.blob.core.windows.net/armreports/00000/00000000-0000-0000-0000-000000000000?sv=2020-05-31&sr=b&sig=abcd", "byteCount": 32741 } - ] + ], + "byteCount": 32741, + "compressData": false, + "dataFormat": "Csv", + "manifestVersion": "2025-03-01", + "requestContext": { + "requestBody": { + "billingPeriod": "202205", + "metric": "ActualCost" + }, + "requestScope": "providers/Microsoft.Billing/billingAccounts/12345" + } }, + "status": "Completed", "validTill": "2022-05-10T08:08:46.1973252Z" } }, @@ -43,5 +43,7 @@ } }, "204": {} - } + }, + "operationId": "GenerateCostDetailsReport_CreateOperation", + "title": "GenerateCostDetailsReportByBillingAccountEnterpriseAgreementCustomerAndBillingPeriod" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/GenerateCostDetailsReportByBillingProfileAndInvoiceId.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/GenerateCostDetailsReportByBillingProfileAndInvoiceId.json index 296fe5ddf706..92d17f0512fb 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/GenerateCostDetailsReportByBillingProfileAndInvoiceId.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/GenerateCostDetailsReportByBillingProfileAndInvoiceId.json @@ -1,38 +1,38 @@ { "parameters": { "api-version": "2025-03-01", - "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579", "parameters": { - "metric": "ActualCost", - "invoiceId": "M1234567" - } + "invoiceId": "M1234567", + "metric": "ActualCost" + }, + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579" }, "responses": { "200": { "body": { - "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000", "name": "00000000-0000-0000-0000-000000000000", - "status": "Completed", + "id": "/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000", "manifest": { - "manifestVersion": "2025-03-01", - "dataFormat": "Csv", "blobCount": 1, - "byteCount": 32741, - "compressData": false, - "requestContext": { - "requestScope": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579", - "requestBody": { - "metric": "ActualCost", - "billingPeriod": "202205" - } - }, "blobs": [ { "blobLink": "https://ccmreportstorageeastus.blob.core.windows.net/armreports/00000/00000000-0000-0000-0000-000000000000?sv=2020-05-31&sr=b&sig=abcd", "byteCount": 32741 } - ] + ], + "byteCount": 32741, + "compressData": false, + "dataFormat": "Csv", + "manifestVersion": "2025-03-01", + "requestContext": { + "requestBody": { + "billingPeriod": "202205", + "metric": "ActualCost" + }, + "requestScope": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579" + } }, + "status": "Completed", "validTill": "2022-05-10T08:08:46.1973252Z" } }, @@ -43,5 +43,7 @@ } }, "204": {} - } + }, + "operationId": "GenerateCostDetailsReport_CreateOperation", + "title": "GenerateCostDetailsReportByBillingProfileAndInvoiceId" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/GenerateCostDetailsReportByBillingProfileAndInvoiceIdAndCustomerId.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/GenerateCostDetailsReportByBillingProfileAndInvoiceIdAndCustomerId.json index a262bd612b79..3b04e313d4f1 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/GenerateCostDetailsReportByBillingProfileAndInvoiceIdAndCustomerId.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/GenerateCostDetailsReportByBillingProfileAndInvoiceIdAndCustomerId.json @@ -1,38 +1,38 @@ { "parameters": { "api-version": "2025-03-01", - "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/13579", "parameters": { - "metric": "ActualCost", - "invoiceId": "M1234567" - } + "invoiceId": "M1234567", + "metric": "ActualCost" + }, + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/13579" }, "responses": { "200": { "body": { - "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/13579/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000", "name": "00000000-0000-0000-0000-000000000000", - "status": "Completed", + "id": "/providers/Microsoft.Billing/billingAccounts/12345:6789/customers/13579/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000", "manifest": { - "manifestVersion": "2025-03-01", - "dataFormat": "Csv", "blobCount": 1, - "byteCount": 32741, - "compressData": false, - "requestContext": { - "requestScope": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/13579", - "requestBody": { - "metric": "ActualCost", - "billingPeriod": "202205" - } - }, "blobs": [ { "blobLink": "https://ccmreportstorageeastus.blob.core.windows.net/armreports/00000/00000000-0000-0000-0000-000000000000?sv=2020-05-31&sr=b&sig=abcd", "byteCount": 32741 } - ] + ], + "byteCount": 32741, + "compressData": false, + "dataFormat": "Csv", + "manifestVersion": "2025-03-01", + "requestContext": { + "requestBody": { + "billingPeriod": "202205", + "metric": "ActualCost" + }, + "requestScope": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/13579" + } }, + "status": "Completed", "validTill": "2022-05-10T08:08:46.1973252Z" } }, @@ -43,5 +43,7 @@ } }, "204": {} - } + }, + "operationId": "GenerateCostDetailsReport_CreateOperation", + "title": "GenerateCostDetailsReportByBillingProfileAndInvoiceIdAndCustomerId" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/GenerateCostDetailsReportByCustomerAndTimePeriod.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/GenerateCostDetailsReportByCustomerAndTimePeriod.json index ff81657742ed..aa85991500e3 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/GenerateCostDetailsReportByCustomerAndTimePeriod.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/GenerateCostDetailsReportByCustomerAndTimePeriod.json @@ -1,44 +1,44 @@ { "parameters": { "api-version": "2025-03-01", - "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/13579", "parameters": { "metric": "ActualCost", "timePeriod": { - "start": "2020-03-01", - "end": "2020-03-15" + "end": "2020-03-15", + "start": "2020-03-01" } - } + }, + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/13579" }, "responses": { "200": { "body": { - "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/13579/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000", "name": "00000000-0000-0000-0000-000000000000", - "status": "Completed", + "id": "/providers/Microsoft.Billing/billingAccounts/12345:6789/customers/13579/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000", "manifest": { - "manifestVersion": "2025-03-01", - "dataFormat": "Csv", "blobCount": 1, + "blobs": [ + { + "blobLink": "https://ccmreportstorageeastus.blob.core.windows.net/armreports/00000/00000000-0000-0000-0000-000000000000?sv=2020-05-31&sr=b&sig=abcd", + "byteCount": 32741 + } + ], "byteCount": 32741, "compressData": false, + "dataFormat": "Csv", + "manifestVersion": "2025-03-01", "requestContext": { - "requestScope": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/13579", "requestBody": { "metric": "ActualCost", "timePeriod": { - "start": "2020-03-01", - "end": "2020-03-15" + "end": "2020-03-15", + "start": "2020-03-01" } - } - }, - "blobs": [ - { - "blobLink": "https://ccmreportstorageeastus.blob.core.windows.net/armreports/00000/00000000-0000-0000-0000-000000000000?sv=2020-05-31&sr=b&sig=abcd", - "byteCount": 32741 - } - ] + }, + "requestScope": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/13579" + } }, + "status": "Completed", "validTill": "2022-05-10T08:08:46.1973252Z" } }, @@ -49,5 +49,7 @@ } }, "204": {} - } + }, + "operationId": "GenerateCostDetailsReport_CreateOperation", + "title": "GenerateCostDetailsReportByCustomerAndTimePeriod" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/GenerateCostDetailsReportByDepartmentsAndTimePeriod.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/GenerateCostDetailsReportByDepartmentsAndTimePeriod.json index 61a496dc76b6..1bf8f5af711b 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/GenerateCostDetailsReportByDepartmentsAndTimePeriod.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/GenerateCostDetailsReportByDepartmentsAndTimePeriod.json @@ -1,44 +1,44 @@ { "parameters": { "api-version": "2025-03-01", - "scope": "providers/Microsoft.Billing/departments/12345", "parameters": { "metric": "ActualCost", "timePeriod": { - "start": "2020-03-01", - "end": "2020-03-15" + "end": "2020-03-15", + "start": "2020-03-01" } - } + }, + "scope": "providers/Microsoft.Billing/departments/12345" }, "responses": { "200": { "body": { - "id": "providers/Microsoft.Billing/departments/12345/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000", "name": "00000000-0000-0000-0000-000000000000", - "status": "Completed", + "id": "/providers/Microsoft.Billing/departments/12345/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000", "manifest": { - "manifestVersion": "2025-03-01", - "dataFormat": "Csv", "blobCount": 1, + "blobs": [ + { + "blobLink": "https://ccmreportstorageeastus.blob.core.windows.net/armreports/00000/00000000-0000-0000-0000-000000000000?sv=2020-05-31&sr=b&sig=abcd", + "byteCount": 32741 + } + ], "byteCount": 32741, "compressData": false, + "dataFormat": "Csv", + "manifestVersion": "2025-03-01", "requestContext": { - "requestScope": "providers/Microsoft.Billing/departments/12345", "requestBody": { "metric": "ActualCost", "timePeriod": { - "start": "2020-03-01", - "end": "2020-03-15" + "end": "2020-03-15", + "start": "2020-03-01" } - } - }, - "blobs": [ - { - "blobLink": "https://ccmreportstorageeastus.blob.core.windows.net/armreports/00000/00000000-0000-0000-0000-000000000000?sv=2020-05-31&sr=b&sig=abcd", - "byteCount": 32741 - } - ] + }, + "requestScope": "providers/Microsoft.Billing/departments/12345" + } }, + "status": "Completed", "validTill": "2022-05-10T08:08:46.1973252Z" } }, @@ -49,5 +49,7 @@ } }, "204": {} - } + }, + "operationId": "GenerateCostDetailsReport_CreateOperation", + "title": "GenerateCostDetailsReportByDepartmentsAndTimePeriod" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/GenerateCostDetailsReportByEnrollmentAccountsAndTimePeriod.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/GenerateCostDetailsReportByEnrollmentAccountsAndTimePeriod.json index 7b829692aa20..45de492986f4 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/GenerateCostDetailsReportByEnrollmentAccountsAndTimePeriod.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/GenerateCostDetailsReportByEnrollmentAccountsAndTimePeriod.json @@ -1,44 +1,44 @@ { "parameters": { "api-version": "2025-03-01", - "scope": "providers/Microsoft.Billing/enrollmentAccounts/1234", "parameters": { "metric": "ActualCost", "timePeriod": { - "start": "2020-03-01", - "end": "2020-03-15" + "end": "2020-03-15", + "start": "2020-03-01" } - } + }, + "scope": "providers/Microsoft.Billing/enrollmentAccounts/1234" }, "responses": { "200": { "body": { - "id": "providers/Microsoft.Billing/enrollmentAccounts/1234/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000", "name": "00000000-0000-0000-0000-000000000000", - "status": "Completed", + "id": "/providers/Microsoft.Billing/enrollmentAccounts/1234/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000", "manifest": { - "manifestVersion": "2025-03-01", - "dataFormat": "Csv", "blobCount": 1, + "blobs": [ + { + "blobLink": "https://ccmreportstorageeastus.blob.core.windows.net/armreports/00000/00000000-0000-0000-0000-000000000000?sv=2020-05-31&sr=b&sig=abcd", + "byteCount": 32741 + } + ], "byteCount": 32741, "compressData": false, + "dataFormat": "Csv", + "manifestVersion": "2025-03-01", "requestContext": { - "requestScope": "providers/Microsoft.Billing/enrollmentAccounts/1234", "requestBody": { "metric": "ActualCost", "timePeriod": { - "start": "2020-03-01", - "end": "2020-03-15" + "end": "2020-03-15", + "start": "2020-03-01" } - } - }, - "blobs": [ - { - "blobLink": "https://ccmreportstorageeastus.blob.core.windows.net/armreports/00000/00000000-0000-0000-0000-000000000000?sv=2020-05-31&sr=b&sig=abcd", - "byteCount": 32741 - } - ] + }, + "requestScope": "providers/Microsoft.Billing/enrollmentAccounts/1234" + } }, + "status": "Completed", "validTill": "2022-05-10T08:08:46.1973252Z" } }, @@ -49,5 +49,7 @@ } }, "204": {} - } + }, + "operationId": "GenerateCostDetailsReport_CreateOperation", + "title": "GenerateCostDetailsReportByEnrollmentAccountsAndTimePeriod" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/GenerateCostDetailsReportBySubscriptionAndTimePeriod.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/GenerateCostDetailsReportBySubscriptionAndTimePeriod.json index 34a65e42bc99..3f454ffc3319 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/GenerateCostDetailsReportBySubscriptionAndTimePeriod.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/GenerateCostDetailsReportBySubscriptionAndTimePeriod.json @@ -1,44 +1,44 @@ { "parameters": { "api-version": "2025-03-01", - "scope": "subscriptions/00000000-0000-0000-0000-000000000000", "parameters": { "metric": "ActualCost", "timePeriod": { - "start": "2020-03-01", - "end": "2020-03-15" + "end": "2020-03-15", + "start": "2020-03-01" } - } + }, + "scope": "subscriptions/00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { - "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000", "name": "00000000-0000-0000-0000-000000000000", - "status": "Completed", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000", "manifest": { - "manifestVersion": "2025-03-01", - "dataFormat": "Csv", "blobCount": 1, + "blobs": [ + { + "blobLink": "https://ccmreportstorageeastus.blob.core.windows.net/armreports/00000/00000000-0000-0000-0000-000000000000?sv=2020-05-31&sr=b&sig=abcd", + "byteCount": 32741 + } + ], "byteCount": 32741, "compressData": false, + "dataFormat": "Csv", + "manifestVersion": "2025-03-01", "requestContext": { - "requestScope": "subscriptions/00000000-0000-0000-0000-000000000000", "requestBody": { "metric": "ActualCost", "timePeriod": { - "start": "2020-03-01", - "end": "2020-03-15" + "end": "2020-03-15", + "start": "2020-03-01" } - } - }, - "blobs": [ - { - "blobLink": "https://ccmreportstorageeastus.blob.core.windows.net/armreports/00000/00000000-0000-0000-0000-000000000000?sv=2020-05-31&sr=b&sig=abcd", - "byteCount": 32741 - } - ] + }, + "requestScope": "subscriptions/00000000-0000-0000-0000-000000000000" + } }, + "status": "Completed", "validTill": "2022-05-10T08:08:46.1973252Z" } }, @@ -49,5 +49,7 @@ } }, "204": {} - } + }, + "operationId": "GenerateCostDetailsReport_CreateOperation", + "title": "GenerateCostDetailsReportBySubscriptionAndTimePeriod" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/GenerateDetailedCostReportByBillingAccountLegacyAndBillingPeriod.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/GenerateDetailedCostReportByBillingAccountLegacyAndBillingPeriod.json index 6c1938b05f71..a15e4195b84e 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/GenerateDetailedCostReportByBillingAccountLegacyAndBillingPeriod.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/GenerateDetailedCostReportByBillingAccountLegacyAndBillingPeriod.json @@ -1,18 +1,18 @@ { "parameters": { "api-version": "2025-03-01", - "scope": "providers/Microsoft.Billing/billingAccounts/12345", "parameters": { - "metric": "ActualCost", - "billingPeriod": "202008" - } + "billingPeriod": "202008", + "metric": "ActualCost" + }, + "scope": "providers/Microsoft.Billing/billingAccounts/12345" }, "responses": { "200": { "body": { - "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/operationResults/00000000-0000-0000-0000-000000000000", "name": "00000000-0000-0000-0000-000000000000", "type": "Microsoft.Consumption/operationResult", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/operationResults/00000000-0000-0000-0000-000000000000", "properties": { "downloadUrl": "https://ccmreportstorageeastus.blob.core.windows.net/armreports/20201207/00000000-0000-0000-0000-000000000000?sv=2020-05-31&sr=b&sig=abcd", "validTill": "2020-12-08T05:55:59.4394737Z" @@ -21,10 +21,12 @@ }, "202": { "headers": { - "Location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345/providers/Microsoft.CostManagement/operationResults/ad0d632f-1186-41fe-89f9-ae29e198d223?api-version=2021-10-01", "Azure-Consumption-AsyncOperation": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345/providers/Microsoft.CostManagement/operationStatus/ad0d632f-1186-41fe-89f9-ae29e198d223?api-version=2021-10-01", + "Location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345/providers/Microsoft.CostManagement/operationResults/ad0d632f-1186-41fe-89f9-ae29e198d223?api-version=2021-10-01", "Retry-After": "60" } } - } + }, + "operationId": "GenerateDetailedCostReport_CreateOperation", + "title": "GenerateDetailedCostReportByBillingAccountLegacyAndBillingPeriod" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/GenerateDetailedCostReportByBillingProfileAndInvoiceId.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/GenerateDetailedCostReportByBillingProfileAndInvoiceId.json index dc6b6b42dffa..10444fed51bf 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/GenerateDetailedCostReportByBillingProfileAndInvoiceId.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/GenerateDetailedCostReportByBillingProfileAndInvoiceId.json @@ -1,18 +1,18 @@ { "parameters": { "api-version": "2025-03-01", - "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579", "parameters": { - "metric": "ActualCost", - "invoiceId": "M1234567" - } + "invoiceId": "M1234567", + "metric": "ActualCost" + }, + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579" }, "responses": { "200": { "body": { - "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/operationResults/00000000-0000-0000-0000-000000000000", "name": "00000000-0000-0000-0000-000000000000", "type": "Microsoft.Consumption/operationResult", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/operationResults/00000000-0000-0000-0000-000000000000", "properties": { "downloadUrl": "https://ccmreportstorageeastus.blob.core.windows.net/armreports/20201207/00000000-0000-0000-0000-000000000000?sv=2020-05-31&sr=b&sig=abcd", "validTill": "2020-12-08T05:55:59.4394737Z" @@ -21,10 +21,12 @@ }, "202": { "headers": { - "Location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/operationResults/ad0d632f-1186-41fe-89f9-ae29e198d223?api-version=2021-10-01", "Azure-Consumption-AsyncOperation": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/operationStatus/ad0d632f-1186-41fe-89f9-ae29e198d223?api-version=2021-10-01", + "Location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/operationResults/ad0d632f-1186-41fe-89f9-ae29e198d223?api-version=2021-10-01", "Retry-After": "60" } } - } + }, + "operationId": "GenerateDetailedCostReport_CreateOperation", + "title": "GenerateDetailedCostReportByBillingProfileAndInvoiceId" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/GenerateDetailedCostReportByBillingProfileAndInvoiceIdAndCustomerId.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/GenerateDetailedCostReportByBillingProfileAndInvoiceIdAndCustomerId.json index e314b788f6cd..08ff4ecf1f7c 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/GenerateDetailedCostReportByBillingProfileAndInvoiceIdAndCustomerId.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/GenerateDetailedCostReportByBillingProfileAndInvoiceIdAndCustomerId.json @@ -1,19 +1,19 @@ { "parameters": { "api-version": "2025-03-01", - "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579", "parameters": { - "metric": "ActualCost", + "customerId": "456789", "invoiceId": "M1234567", - "customerId": "456789" - } + "metric": "ActualCost" + }, + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579" }, "responses": { "200": { "body": { - "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/operationResults/00000000-0000-0000-0000-000000000000", "name": "00000000-0000-0000-0000-000000000000", "type": "Microsoft.Consumption/operationResult", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/operationResults/00000000-0000-0000-0000-000000000000", "properties": { "downloadUrl": "https://ccmreportstorageeastus.blob.core.windows.net/armreports/20201207/00000000-0000-0000-0000-000000000000?sv=2020-05-31&sr=b&sig=abcd", "validTill": "2020-12-08T05:55:59.4394737Z" @@ -22,10 +22,12 @@ }, "202": { "headers": { - "Location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/operationResults/ad0d632f-1186-41fe-89f9-ae29e198d223?api-version=2021-10-01", "Azure-Consumption-AsyncOperation": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/operationStatus/ad0d632f-1186-41fe-89f9-ae29e198d223?api-version=2021-10-01", + "Location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/operationResults/ad0d632f-1186-41fe-89f9-ae29e198d223?api-version=2021-10-01", "Retry-After": "60" } } - } + }, + "operationId": "GenerateDetailedCostReport_CreateOperation", + "title": "GenerateDetailedCostReportByBillingProfileAndInvoiceIdAndCustomerId" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/GenerateDetailedCostReportByCustomerAndTimePeriod.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/GenerateDetailedCostReportByCustomerAndTimePeriod.json index fb7f5f99aab1..703cc6d3f3a6 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/GenerateDetailedCostReportByCustomerAndTimePeriod.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/GenerateDetailedCostReportByCustomerAndTimePeriod.json @@ -1,21 +1,21 @@ { "parameters": { "api-version": "2025-03-01", - "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/13579", "parameters": { "metric": "ActualCost", "timePeriod": { - "start": "2020-03-01", - "end": "2020-03-15" + "end": "2020-03-15", + "start": "2020-03-01" } - } + }, + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/13579" }, "responses": { "200": { "body": { - "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/operationResults/00000000-0000-0000-0000-000000000000", "name": "00000000-0000-0000-0000-000000000000", "type": "Microsoft.Consumption/operationResult", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/operationResults/00000000-0000-0000-0000-000000000000", "properties": { "downloadUrl": "https://ccmreportstorageeastus.blob.core.windows.net/armreports/20201207/00000000-0000-0000-0000-000000000000?sv=2020-05-31&sr=b&sig=abcd", "validTill": "2020-12-08T05:55:59.4394737Z" @@ -24,10 +24,12 @@ }, "202": { "headers": { - "Location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/customers/13579/providers/Microsoft.CostManagement/operationResults/ad0d632f-1186-41fe-89f9-ae29e198d223?api-version=2021-10-01", "Azure-Consumption-AsyncOperation": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/customers/13579/providers/Microsoft.CostManagement/operationStatus/ad0d632f-1186-41fe-89f9-ae29e198d223?api-version=2021-10-01", + "Location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/customers/13579/providers/Microsoft.CostManagement/operationResults/ad0d632f-1186-41fe-89f9-ae29e198d223?api-version=2021-10-01", "Retry-After": "60" } } - } + }, + "operationId": "GenerateDetailedCostReport_CreateOperation", + "title": "GenerateDetailedCostReportByCustomerAndTimePeriod" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/GenerateDetailedCostReportBySubscriptionAndTimePeriod.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/GenerateDetailedCostReportBySubscriptionAndTimePeriod.json index 6be5bc7d1313..9122133cb07b 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/GenerateDetailedCostReportBySubscriptionAndTimePeriod.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/GenerateDetailedCostReportBySubscriptionAndTimePeriod.json @@ -1,21 +1,21 @@ { "parameters": { "api-version": "2025-03-01", - "scope": "subscriptions/00000000-0000-0000-0000-000000000000", "parameters": { "metric": "ActualCost", "timePeriod": { - "start": "2020-03-01", - "end": "2020-03-15" + "end": "2020-03-15", + "start": "2020-03-01" } - } + }, + "scope": "subscriptions/00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { - "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/operationResults/00000000-0000-0000-0000-000000000000", "name": "00000000-0000-0000-0000-000000000000", "type": "Microsoft.Consumption/operationResult", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/operationResults/00000000-0000-0000-0000-000000000000", "properties": { "downloadUrl": "https://ccmreportstorageeastus.blob.core.windows.net/armreports/20201207/00000000-0000-0000-0000-000000000000?sv=2020-05-31&sr=b&sig=abcd", "validTill": "2020-12-08T05:55:59.4394737Z" @@ -24,10 +24,12 @@ }, "202": { "headers": { - "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/operationResults/00000000-0000-0000-0000-000000000000?api-version=2021-10-01", "Azure-Consumption-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/operationStatus/00000000-0000-0000-0000-000000000000?api-version=2021-10-01", + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/operationResults/00000000-0000-0000-0000-000000000000?api-version=2021-10-01", "Retry-After": "60" } } - } + }, + "operationId": "GenerateDetailedCostReport_CreateOperation", + "title": "GenerateDetailedCostReportBySubscriptionAndTimePeriod" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/GenerateDetailedCostReportOperationResultsBySubscriptionScope.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/GenerateDetailedCostReportOperationResultsBySubscriptionScope.json index 366d54db62c9..a4f2b416030e 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/GenerateDetailedCostReportOperationResultsBySubscriptionScope.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/GenerateDetailedCostReportOperationResultsBySubscriptionScope.json @@ -1,15 +1,15 @@ { "parameters": { - "api-version": "2025-03-01", "operationId": "00000000-0000-0000-0000-000000000000", + "api-version": "2025-03-01", "scope": "subscriptions/00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { - "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/operationResults/00000000-0000-0000-0000-000000000000", "name": "00000000-0000-0000-0000-000000000000", "type": "Microsoft.Consumption/operationResult", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/operationResults/00000000-0000-0000-0000-000000000000", "properties": { "downloadUrl": "https://ccmreportstorageeastus.blob.core.windows.net/armreports/20201207/00000000-0000-0000-0000-000000000000?sv=2020-05-31&sr=b&sig=abcd", "validTill": "2020-12-08T05:55:59.4394737Z" @@ -18,10 +18,12 @@ }, "202": { "headers": { - "Location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345/providers/Microsoft.CostManagement/operationResults/ad0d632f-1186-41fe-89f9-ae29e198d223?api-version=2021-10-01", "Azure-Consumption-AsyncOperation": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345/providers/Microsoft.CostManagement/operationStatus/ad0d632f-1186-41fe-89f9-ae29e198d223?api-version=2021-10-01", + "Location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345/providers/Microsoft.CostManagement/operationResults/ad0d632f-1186-41fe-89f9-ae29e198d223?api-version=2021-10-01", "Retry-After": "60" } } - } + }, + "operationId": "GenerateDetailedCostReportOperationResults_Get", + "title": "Get details of the operation result" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/GenerateDetailedCostReportOperationStatusBySubscriptionScope.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/GenerateDetailedCostReportOperationStatusBySubscriptionScope.json index c7113081b5ae..ff936acad223 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/GenerateDetailedCostReportOperationStatusBySubscriptionScope.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/GenerateDetailedCostReportOperationStatusBySubscriptionScope.json @@ -1,25 +1,29 @@ { "parameters": { - "api-version": "2025-03-01", "operationId": "00000000-0000-0000-0000-000000000000", + "api-version": "2025-03-01", "scope": "subscriptions/00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { - "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/operationStatus/00000000-0000-0000-0000-000000000000", "name": "00000000-0000-0000-0000-000000000000", - "status": "Completed", "type": "Microsoft.Consumption/operationStatus", + "error": { + "code": "0", + "message": null + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/operationStatus/00000000-0000-0000-0000-000000000000", "properties": { "downloadUrl": "https://ccmreportstorageeastus.blob.core.windows.net/armreports/20201207/00000000-0000-0000-0000-000000000000?sv=2020-05-31&sr=b&sig=abcd", "validTill": "2020-12-08T05:55:59.4394737Z" }, - "error": { - "code": "0", - "message": null + "status": { + "status": "Completed" } } } - } + }, + "operationId": "GenerateDetailedCostReportOperationStatus_Get", + "title": "Get details of the operation status" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/GenerateReservationDetailsReportByBillingAccount.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/GenerateReservationDetailsReportByBillingAccount.json index 310252950714..b6a60849c2b9 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/GenerateReservationDetailsReportByBillingAccount.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/GenerateReservationDetailsReportByBillingAccount.json @@ -1,25 +1,27 @@ { "parameters": { + "api-version": "2025-03-01", "billingAccountId": "9845612", - "startDate": "2020-01-01", "endDate": "2020-01-30", - "api-version": "2025-03-01" + "startDate": "2020-01-01" }, "responses": { - "202": { - "headers": { - "Location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/9845612/providers/Microsoft.CostManagement/reservationDetailsOperationResults/cf9f95c9-af6b-41dd-a622-e6f4fc60c3ee?api-version=2019-11-01", - "Retry-After": "60" - } - }, "200": { "body": { - "status": "Completed", "properties": { "reportUrl": "https://storage.blob.core.windows.net/details/20200911/00000000-0000-0000-0000-000000000000?sv=2016-05-31&sr=b&sig=jep8HT2aphfUkyERRZa5LRfd9RPzjXbzB%2F9TNiQ", "validUntil": "2020-09-12T02:56:55.5021869Z" - } + }, + "status": "Completed" + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/9845612/providers/Microsoft.CostManagement/reservationDetailsOperationResults/cf9f95c9-af6b-41dd-a622-e6f4fc60c3ee?api-version=2019-11-01", + "Retry-After": "60" } } - } + }, + "operationId": "GenerateReservationDetailsReport_ByBillingAccountId", + "title": "ReservationDetails" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/GenerateReservationDetailsReportByBillingProfile.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/GenerateReservationDetailsReportByBillingProfile.json index 29ad90da3372..e79a1c7066ec 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/GenerateReservationDetailsReportByBillingProfile.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/GenerateReservationDetailsReportByBillingProfile.json @@ -1,26 +1,28 @@ { "parameters": { + "api-version": "2025-03-01", "billingAccountId": "00000000-0000-0000-0000-000000000000", "billingProfileId": "CZSFR-SDFXC-DSDF", - "startDate": "2020-01-01", "endDate": "2020-01-30", - "api-version": "2025-03-01" + "startDate": "2020-01-01" }, "responses": { - "202": { - "headers": { - "Location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000/billingProfiles/CZSFR-SDFXC-DSDF/providers/Microsoft.CostManagement/reservationDetailsOperationResults/cf9f95c9-af6b-41dd-a622-e6f4fc60c3ee?api-version=2019-11-01", - "Retry-After": "60" - } - }, "200": { "body": { - "status": "Completed", "properties": { "reportUrl": "https://storage.blob.core.windows.net/details/20200911/00000000-0000-0000-0000-000000000000?sv=2016-05-31&sr=b&sig=jep8HT2aphfUkyERRZa5LRfd9RPzjXbzB%2F9TNiQ", "validUntil": "2020-09-12T02:56:55.5021869Z" - } + }, + "status": "Completed" + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000/billingProfiles/CZSFR-SDFXC-DSDF/providers/Microsoft.CostManagement/reservationDetailsOperationResults/cf9f95c9-af6b-41dd-a622-e6f4fc60c3ee?api-version=2019-11-01", + "Retry-After": "60" } } - } + }, + "operationId": "GenerateReservationDetailsReport_ByBillingProfileId", + "title": "ReservationDetails" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/InvoiceSectionAlerts.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/InvoiceSectionAlerts.json index 2dd2ae450609..0afd232f3c7d 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/InvoiceSectionAlerts.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/InvoiceSectionAlerts.json @@ -9,92 +9,94 @@ "responses": { "200": { "body": { + "nextLink": null, "value": [ { - "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/Microsoft.CostManagement/alerts/00000000-0000-0000-0000-000000000000", "name": "00000000-0000-0000-0000-000000000000", "type": "Microsoft.CostManagement/alerts", + "id": "/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/Microsoft.CostManagement/alerts/00000000-0000-0000-0000-000000000000", "properties": { + "description": "", + "closeTime": "0001-01-01T00:00:00", + "costEntityId": "budget1", + "creationTime": "2020-04-27T11:07:52.7143901Z", "definition": { "type": "Budget", "category": "Cost", "criteria": "CostThresholdExceeded" }, - "description": "", + "modificationTime": "2020-04-28T11:06:02.8999373Z", "source": "Preset", + "status": "Active", + "statusModificationTime": "0001-01-01T00:00:00", + "statusModificationUserName": null, "details": { - "timeGrainType": "Quarterly", - "periodStartDate": "2020-03-01T00:00:00Z", - "triggeredBy": "00000000-0000-0000-0000-000000000000_1_01", - "resourceGroupFilter": [], - "resourceFilter": [], - "meterFilter": [], - "tagFilter": {}, - "threshold": 0.8, - "operator": "GreaterThan", - "amount": 200000.0, - "unit": "USD", - "currentSpend": 161000.12, + "amount": 200000, "contactEmails": [ "1234@contoso.com" ], "contactGroups": [], "contactRoles": [], - "overridingAlert": null - }, - "costEntityId": "budget1", - "status": "Active", - "creationTime": "2020-04-27T11:07:52.7143901Z", - "closeTime": "0001-01-01T00:00:00", - "modificationTime": "2020-04-28T11:06:02.8999373Z", - "statusModificationUserName": null, - "statusModificationTime": "0001-01-01T00:00:00" + "currentSpend": 161000.12, + "meterFilter": [], + "operator": "GreaterThan", + "overridingAlert": null, + "periodStartDate": "2020-03-01T00:00:00Z", + "resourceFilter": [], + "resourceGroupFilter": [], + "tagFilter": {}, + "threshold": 0.8, + "timeGrainType": "Quarterly", + "triggeredBy": "00000000-0000-0000-0000-000000000000_1_01", + "unit": "USD" + } } }, { - "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/Microsoft.CostManagement/alerts/11111111-1111-1111-111111111111", "name": "11111111-1111-1111-111111111111", "type": "Microsoft.CostManagement/alerts", + "id": "/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/Microsoft.CostManagement/alerts/11111111-1111-1111-111111111111", "properties": { + "description": "", + "closeTime": "0001-01-01T00:00:00", + "costEntityId": "budget1", + "creationTime": "2019-06-24T05:51:52.8713179Z", "definition": { "type": "Budget", "category": "Cost", "criteria": "CostThresholdExceeded" }, - "description": "", + "modificationTime": "2019-08-31T17:51:55.1808807Z", "source": "Preset", + "status": "Active", + "statusModificationTime": "0001-01-01T00:00:00", + "statusModificationUserName": null, "details": { - "timeGrainType": "Quarterly", - "periodStartDate": "2020-03-01T00:00:00Z", - "triggeredBy": "11111111-1111-1111-111111111111_1_01", - "resourceGroupFilter": [], - "resourceFilter": [], - "meterFilter": [], - "tagFilter": {}, - "threshold": 0.8, - "operator": "GreaterThan", - "amount": 200000.0, - "unit": "USD", - "currentSpend": 171000.32, + "amount": 200000, "contactEmails": [ "1234@contoso.com" ], "contactGroups": [], "contactRoles": [], - "overridingAlert": null - }, - "costEntityId": "budget1", - "status": "Active", - "creationTime": "2019-06-24T05:51:52.8713179Z", - "closeTime": "0001-01-01T00:00:00", - "modificationTime": "2019-08-31T17:51:55.1808807Z", - "statusModificationUserName": null, - "statusModificationTime": "0001-01-01T00:00:00" + "currentSpend": 171000.32, + "meterFilter": [], + "operator": "GreaterThan", + "overridingAlert": null, + "periodStartDate": "2020-03-01T00:00:00Z", + "resourceFilter": [], + "resourceGroupFilter": [], + "tagFilter": {}, + "threshold": 0.8, + "timeGrainType": "Quarterly", + "triggeredBy": "11111111-1111-1111-111111111111_1_01", + "unit": "USD" + } } } - ], - "nextLink": null + ] } } - } + }, + "operationId": "Alerts_List", + "title": "InvoiceSectionAlerts" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/InvoiceSectionForecast.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/InvoiceSectionForecast.json index 9f175a32899f..d9b22b111bb2 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/InvoiceSectionForecast.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/InvoiceSectionForecast.json @@ -4,16 +4,9 @@ "billingAccountId": "12345:6789", "billingProfileId": "13579", "invoiceSectionId": "9876", - "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876", "parameters": { "type": "Usage", - "timeframe": "Custom", - "timePeriod": { - "from": "2022-08-01T00:00:00+00:00", - "to": "2022-08-31T23:59:59+00:00" - }, "dataset": { - "granularity": "Daily", "aggregation": { "totalCost": { "name": "Cost", @@ -56,20 +49,26 @@ } } ] - } + }, + "granularity": "Daily" }, "includeActualCost": false, - "includeFreshPartialCost": false - } + "includeFreshPartialCost": false, + "timePeriod": { + "from": "2022-08-01T00:00:00+00:00", + "to": "2022-08-31T23:59:59+00:00" + }, + "timeframe": "Custom" + }, + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876" }, "responses": { "200": { "body": { - "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/Microsoft.CostManagement/query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", "type": "Microsoft.CostManagement/query", + "id": "/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/Microsoft.CostManagement/query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", "properties": { - "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/Microsoft.CostManagement/Forecast?api-version=2019-10-01&$skiptoken=AQAAAA%3D%3D", "columns": [ { "name": "PreTaxCost", @@ -88,6 +87,7 @@ "type": "String" } ], + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/Microsoft.CostManagement/Forecast?api-version=2019-10-01&$skiptoken=AQAAAA%3D%3D", "rows": [ [ 2.10333307059661, @@ -118,5 +118,7 @@ } }, "204": {} - } + }, + "operationId": "Forecast_Usage", + "title": "InvoiceSectionForecast" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/MCABillingAccountDimensionsList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/MCABillingAccountDimensionsList.json index 7492033b4c66..120d93d89506 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/MCABillingAccountDimensionsList.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/MCABillingAccountDimensionsList.json @@ -9,38 +9,40 @@ "body": { "value": [ { - "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/providers/microsoft.CostManagement/dimensions_ResourceGroup_2019-10-01_2019-10-31", "name": "dimensions_ResourceGroup_2019-10-01_2019-10-31", "type": "microsoft.CostManagement/dimensions", + "id": "/providers/Microsoft.Billing/billingAccounts/12345:6789/providers/microsoft.CostManagement/dimensions_ResourceGroup_2019-10-01_2019-10-31", "properties": { + "description": "Resource group", + "category": "ResourceGroup", "data": [], + "filterEnabled": true, + "groupingEnabled": true, "total": 377, - "category": "ResourceGroup", - "usageStart": "2019-10-01T00:00:00-07:00", "usageEnd": "2019-10-31T00:00:00-07:00", - "description": "Resource group", - "filterEnabled": true, - "groupingEnabled": true + "usageStart": "2019-10-01T00:00:00-07:00" } }, { - "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/providers/microsoft.CostManagement/dimensions_ResourceType_2019-10-01_2019-10-31", "name": "dimensions_ResourceType_2019-10-01_2019-10-31", "type": "microsoft.CostManagement/dimensions", + "id": "/providers/Microsoft.Billing/billingAccounts/12345:6789/providers/microsoft.CostManagement/dimensions_ResourceType_2019-10-01_2019-10-31", "properties": { + "description": "Resource type", + "category": "ResourceType", "data": [], + "filterEnabled": true, + "groupingEnabled": true, "total": 37, - "category": "ResourceType", - "usageStart": "2019-10-01T00:00:00-07:00", "usageEnd": "2019-10-31T00:00:00-07:00", - "description": "Resource type", - "filterEnabled": true, - "groupingEnabled": true + "usageStart": "2019-10-01T00:00:00-07:00" } } ] } }, "204": {} - } + }, + "operationId": "Dimensions_List", + "title": "BillingAccountDimensionsList-MCA" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/MCABillingAccountDimensionsListExpandAndTop.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/MCABillingAccountDimensionsListExpandAndTop.json index 839de24169ea..627dcfb2e214 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/MCABillingAccountDimensionsListExpandAndTop.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/MCABillingAccountDimensionsListExpandAndTop.json @@ -1,9 +1,9 @@ { "parameters": { - "api-version": "2025-03-01", - "billingAccountId": "12345:6789", "$expand": "properties/data", "$top": 5, + "api-version": "2025-03-01", + "billingAccountId": "12345:6789", "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789" }, "responses": { @@ -11,10 +11,12 @@ "body": { "value": [ { - "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/providers/microsoft.CostManagement/dimensions_ResourceGroup_2019-10-01_2019-10-31", "name": "dimensions_ResourceGroup_2019-10-01_2019-10-31", "type": "microsoft.CostManagement/dimensions", + "id": "/providers/Microsoft.Billing/billingAccounts/12345:6789/providers/microsoft.CostManagement/dimensions_ResourceGroup_2019-10-01_2019-10-31", "properties": { + "description": "Resource group", + "category": "ResourceGroup", "data": [ "thoroetrg01", "default-notificationhubs-westus", @@ -22,20 +24,20 @@ "contosocodeflow8d4a", "noobaa" ], + "filterEnabled": true, + "groupingEnabled": true, "total": 377, - "category": "ResourceGroup", - "usageStart": "2019-10-01T00:00:00-07:00", "usageEnd": "2019-10-31T00:00:00-07:00", - "description": "Resource group", - "filterEnabled": true, - "groupingEnabled": true + "usageStart": "2019-10-01T00:00:00-07:00" } }, { - "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/providers/microsoft.CostManagement/dimensions_ResourceType_2019-10-01_2019-10-31", "name": "dimensions_ResourceType_2019-10-01_2019-10-31", "type": "microsoft.CostManagement/dimensions", + "id": "/providers/Microsoft.Billing/billingAccounts/12345:6789/providers/microsoft.CostManagement/dimensions_ResourceType_2019-10-01_2019-10-31", "properties": { + "description": "Resource type", + "category": "ResourceType", "data": [ "microsoft.automation/automationaccounts", "microsoft.databricks/workspaces", @@ -43,18 +45,18 @@ "microsoft.containerregistry/registries", "microsoft.search/searchservices" ], + "filterEnabled": true, + "groupingEnabled": true, "total": 37, - "category": "ResourceType", - "usageStart": "2019-10-01T00:00:00-07:00", "usageEnd": "2019-10-31T00:00:00-07:00", - "description": "Resource type", - "filterEnabled": true, - "groupingEnabled": true + "usageStart": "2019-10-01T00:00:00-07:00" } } ] } }, "204": {} - } + }, + "operationId": "Dimensions_List", + "title": "BillingAccountDimensionsListExpandAndTop-MCA" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/MCABillingAccountDimensionsListWithFilter.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/MCABillingAccountDimensionsListWithFilter.json index 666c0db188a9..537fa5d9b565 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/MCABillingAccountDimensionsListWithFilter.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/MCABillingAccountDimensionsListWithFilter.json @@ -1,10 +1,10 @@ { "parameters": { - "api-version": "2025-03-01", - "billingAccountId": "12345:6789", "$expand": "properties/data", - "$top": 5, "$filter": "properties/category eq 'resourceId'", + "$top": 5, + "api-version": "2025-03-01", + "billingAccountId": "12345:6789", "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789" }, "responses": { @@ -12,10 +12,12 @@ "body": { "value": [ { - "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/providers/microsoft.CostManagement/dimensions_ResourceId_2019-10-01_2019-10-31", "name": "dimensions_ResourceId_2019-10-01_2019-10-31", "type": "microsoft.CostManagement/dimensions", + "id": "/providers/Microsoft.Billing/billingAccounts/12345:6789/providers/microsoft.CostManagement/dimensions_ResourceId_2019-10-01_2019-10-31", "properties": { + "description": "Resource Id", + "category": "ResourceId", "data": [ "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/system.orlando/providers/microsoft.storage/storageaccounts/urphealthaccount", "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/system.orlando/providers/microsoft.storage/storageaccounts/srphytenaccount", @@ -23,19 +25,19 @@ "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg-sql-ha/providers/microsoft.compute/virtualmachines/sql-4qqp1", "/subscriptions/a98d6dc5-eb8f-46cf-8938-f1fb08f03706/resourcegroups/databricks-rg-testwsp-xijmsdubneexm/providers/microsoft.compute/disks/488cdb42bf74474a98075415be3f806c-containerrootvolume" ], - "total": 1409, - "category": "ResourceId", - "usageStart": "2019-10-01T00:00:00-07:00", - "usageEnd": "2019-10-31T00:00:00-07:00", - "description": "Resource Id", "filterEnabled": true, "groupingEnabled": true, - "nextLink": "http://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/providers/Microsoft.CostManagement/Dimensions?$filter=properties/category eq 'resourceId'&$top=5&api-version=2019-10-01&$expand=properties/data&$skiptoken=AQAAAA%3D%3D" + "nextLink": "http://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/providers/Microsoft.CostManagement/Dimensions?$filter=properties/category eq 'resourceId'&$top=5&api-version=2019-10-01&$expand=properties/data&$skiptoken=AQAAAA%3D%3D", + "total": 1409, + "usageEnd": "2019-10-31T00:00:00-07:00", + "usageStart": "2019-10-01T00:00:00-07:00" } } ] } }, "204": {} - } + }, + "operationId": "Dimensions_List", + "title": "BillingAccountDimensionsListWithFilter-MCA" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/MCABillingAccountQuery.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/MCABillingAccountQuery.json index a1ae3fcd9c95..fe392f70d889 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/MCABillingAccountQuery.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/MCABillingAccountQuery.json @@ -2,12 +2,9 @@ "parameters": { "api-version": "2025-03-01", "billingAccountId": "12345:6789", - "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789", "parameters": { "type": "Usage", - "timeframe": "MonthToDate", "dataset": { - "granularity": "Daily", "filter": { "and": [ { @@ -44,18 +41,20 @@ } } ] - } - } - } + }, + "granularity": "Daily" + }, + "timeframe": "MonthToDate" + }, + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789" }, "responses": { "200": { "body": { - "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", "type": "microsoft.costmanagement/Query", + "id": "/providers/Microsoft.Billing/billingAccounts/12345:6789/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", "properties": { - "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", "columns": [ { "name": "PreTaxCost", @@ -74,6 +73,7 @@ "type": "String" } ], + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", "rows": [ [ 19.545363672276512, @@ -88,7 +88,7 @@ "USD" ], [ - 20.359416562625452, + 20.35941656262545, "VSTSHOL-1595322048000", 20180331, "USD" @@ -104,5 +104,7 @@ } }, "204": {} - } + }, + "operationId": "Query_Usage", + "title": "BillingAccountQuery-MCA" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/MCABillingAccountQueryGrouping.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/MCABillingAccountQueryGrouping.json index 14660c0cd836..398f03d4ac81 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/MCABillingAccountQueryGrouping.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/MCABillingAccountQueryGrouping.json @@ -2,35 +2,34 @@ "parameters": { "api-version": "2025-03-01", "billingAccountId": "12345:6789", - "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789", "parameters": { "type": "Usage", - "timeframe": "TheLastMonth", "dataset": { - "granularity": "None", "aggregation": { "totalCost": { "name": "PreTaxCost", "function": "Sum" } }, + "granularity": "None", "grouping": [ { - "type": "Dimension", - "name": "ResourceGroup" + "name": "ResourceGroup", + "type": "Dimension" } ] - } - } + }, + "timeframe": "TheLastMonth" + }, + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789" }, "responses": { "200": { "body": { - "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", "type": "microsoft.costmanagement/Query", + "id": "/providers/Microsoft.Billing/billingAccounts/12345:6789/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", "properties": { - "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", "columns": [ { "name": "PreTaxCost", @@ -45,6 +44,7 @@ "type": "String" } ], + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", "rows": [ [ 19.545363672276512, @@ -57,7 +57,7 @@ "USD" ], [ - 20.359416562625452, + 20.35941656262545, "VSTSHOL-1595322048000", "USD" ] @@ -66,5 +66,7 @@ } }, "204": {} - } + }, + "operationId": "Query_Usage", + "title": "BillingAccountQueryGrouping-MCA" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/MCABillingProfileDimensionsList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/MCABillingProfileDimensionsList.json index f6c2d0ecea34..79489c4dc236 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/MCABillingProfileDimensionsList.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/MCABillingProfileDimensionsList.json @@ -10,38 +10,40 @@ "body": { "value": [ { - "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/microsoft.CostManagement/dimensions_ResourceGroup_2019-10-01_2019-10-31", "name": "dimensions_ResourceGroup_2019-10-01_2019-10-31", "type": "microsoft.CostManagement/dimensions", + "id": "/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/microsoft.CostManagement/dimensions_ResourceGroup_2019-10-01_2019-10-31", "properties": { + "description": "Resource group", + "category": "ResourceGroup", "data": [], + "filterEnabled": true, + "groupingEnabled": true, "total": 377, - "category": "ResourceGroup", - "usageStart": "2019-10-01T00:00:00-07:00", "usageEnd": "2019-10-31T00:00:00-07:00", - "description": "Resource group", - "filterEnabled": true, - "groupingEnabled": true + "usageStart": "2019-10-01T00:00:00-07:00" } }, { - "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/microsoft.CostManagement/dimensions_ResourceType_2019-10-01_2019-10-31", "name": "dimensions_ResourceType_2019-10-01_2019-10-31", "type": "microsoft.CostManagement/dimensions", + "id": "/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/microsoft.CostManagement/dimensions_ResourceType_2019-10-01_2019-10-31", "properties": { + "description": "Resource type", + "category": "ResourceType", "data": [], + "filterEnabled": true, + "groupingEnabled": true, "total": 37, - "category": "ResourceType", - "usageStart": "2019-10-01T00:00:00-07:00", "usageEnd": "2019-10-31T00:00:00-07:00", - "description": "Resource type", - "filterEnabled": true, - "groupingEnabled": true + "usageStart": "2019-10-01T00:00:00-07:00" } } ] } }, "204": {} - } + }, + "operationId": "Dimensions_List", + "title": "BillingProfileDimensionsList-MCA" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/MCABillingProfileDimensionsListExpandAndTop.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/MCABillingProfileDimensionsListExpandAndTop.json index b062f246294f..e1057e5c1b32 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/MCABillingProfileDimensionsListExpandAndTop.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/MCABillingProfileDimensionsListExpandAndTop.json @@ -1,10 +1,10 @@ { "parameters": { + "$expand": "properties/data", + "$top": 5, "api-version": "2025-03-01", "billingAccountId": "12345:6789", "billingProfileId": "13579", - "$expand": "properties/data", - "$top": 5, "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579" }, "responses": { @@ -12,10 +12,12 @@ "body": { "value": [ { - "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/microsoft.CostManagement/dimensions_ResourceGroup_2019-10-01_2019-10-31", "name": "dimensions_ResourceGroup_2019-10-01_2019-10-31", "type": "microsoft.CostManagement/dimensions", + "id": "/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/microsoft.CostManagement/dimensions_ResourceGroup_2019-10-01_2019-10-31", "properties": { + "description": "Resource group", + "category": "ResourceGroup", "data": [ "thoroetrg01", "default-notificationhubs-westus", @@ -23,20 +25,20 @@ "contosocodeflow8d4a", "noobaa" ], + "filterEnabled": true, + "groupingEnabled": true, "total": 377, - "category": "ResourceGroup", - "usageStart": "2019-10-01T00:00:00-07:00", "usageEnd": "2019-10-31T00:00:00-07:00", - "description": "Resource group", - "filterEnabled": true, - "groupingEnabled": true + "usageStart": "2019-10-01T00:00:00-07:00" } }, { - "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/microsoft.CostManagement/dimensions_ResourceType_2019-10-01_2019-10-31", "name": "dimensions_ResourceType_2019-10-01_2019-10-31", "type": "microsoft.CostManagement/dimensions", + "id": "/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/microsoft.CostManagement/dimensions_ResourceType_2019-10-01_2019-10-31", "properties": { + "description": "Resource type", + "category": "ResourceType", "data": [ "microsoft.automation/automationaccounts", "microsoft.databricks/workspaces", @@ -44,18 +46,18 @@ "microsoft.containerregistry/registries", "microsoft.search/searchservices" ], + "filterEnabled": true, + "groupingEnabled": true, "total": 37, - "category": "ResourceType", - "usageStart": "2019-10-01T00:00:00-07:00", "usageEnd": "2019-10-31T00:00:00-07:00", - "description": "Resource type", - "filterEnabled": true, - "groupingEnabled": true + "usageStart": "2019-10-01T00:00:00-07:00" } } ] } }, "204": {} - } + }, + "operationId": "Dimensions_List", + "title": "BillingProfileDimensionsListExpandAndTop-MCA" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/MCABillingProfileDimensionsListWithFilter.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/MCABillingProfileDimensionsListWithFilter.json index 44f2fef4863c..1c33525244e7 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/MCABillingProfileDimensionsListWithFilter.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/MCABillingProfileDimensionsListWithFilter.json @@ -1,11 +1,11 @@ { "parameters": { + "$expand": "properties/data", + "$filter": "properties/category eq 'resourceId'", + "$top": 5, "api-version": "2025-03-01", "billingAccountId": "12345:6789", "billingProfileId": "13579", - "$expand": "properties/data", - "$top": 5, - "$filter": "properties/category eq 'resourceId'", "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579" }, "responses": { @@ -13,10 +13,12 @@ "body": { "value": [ { - "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/microsoft.CostManagement/dimensions_ResourceId_2019-10-01_2019-10-31", "name": "dimensions_ResourceId_2019-10-01_2019-10-31", "type": "microsoft.CostManagement/dimensions", + "id": "/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/microsoft.CostManagement/dimensions_ResourceId_2019-10-01_2019-10-31", "properties": { + "description": "Resource Id", + "category": "ResourceId", "data": [ "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/system.orlando/providers/microsoft.storage/storageaccounts/urphealthaccount", "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/system.orlando/providers/microsoft.storage/storageaccounts/srphytenaccount", @@ -24,19 +26,19 @@ "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg-sql-ha/providers/microsoft.compute/virtualmachines/sql-4qqp1", "/subscriptions/a98d6dc5-eb8f-46cf-8938-f1fb08f03706/resourcegroups/databricks-rg-testwsp-xijmsdubneexm/providers/microsoft.compute/disks/488cdb42bf74474a98075415be3f806c-containerrootvolume" ], - "total": 1409, - "category": "ResourceId", - "usageStart": "2019-10-01T00:00:00-07:00", - "usageEnd": "2019-10-31T00:00:00-07:00", - "description": "Resource Id", "filterEnabled": true, "groupingEnabled": true, - "nextLink": "http://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/Dimensions?$filter=properties/category eq 'resourceId'&$top=5&api-version=2019-10-01&$expand=properties/data&$skiptoken=AQAAAA%3D%3D" + "nextLink": "http://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/Dimensions?$filter=properties/category eq 'resourceId'&$top=5&api-version=2019-10-01&$expand=properties/data&$skiptoken=AQAAAA%3D%3D", + "total": 1409, + "usageEnd": "2019-10-31T00:00:00-07:00", + "usageStart": "2019-10-01T00:00:00-07:00" } } ] } }, "204": {} - } + }, + "operationId": "Dimensions_List", + "title": "BillingProfileDimensionsListWithFilter-MCA" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/MCABillingProfileQuery.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/MCABillingProfileQuery.json index 030772bd2692..06b65795172a 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/MCABillingProfileQuery.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/MCABillingProfileQuery.json @@ -3,12 +3,9 @@ "api-version": "2025-03-01", "billingAccountId": "12345:6789", "billingProfileId": "13579", - "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579", "parameters": { "type": "Usage", - "timeframe": "MonthToDate", "dataset": { - "granularity": "Daily", "filter": { "and": [ { @@ -45,18 +42,20 @@ } } ] - } - } - } + }, + "granularity": "Daily" + }, + "timeframe": "MonthToDate" + }, + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579" }, "responses": { "200": { "body": { - "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", "type": "microsoft.costmanagement/Query", + "id": "/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", "properties": { - "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", "columns": [ { "name": "PreTaxCost", @@ -75,6 +74,7 @@ "type": "String" } ], + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", "rows": [ [ 19.545363672276512, @@ -89,7 +89,7 @@ "USD" ], [ - 20.359416562625452, + 20.35941656262545, "VSTSHOL-1595322048000", 20180331, "USD" @@ -105,5 +105,7 @@ } }, "204": {} - } + }, + "operationId": "Query_Usage", + "title": "BillingProfileQuery-MCA" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/MCABillingProfileQueryGrouping.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/MCABillingProfileQueryGrouping.json index 7c74add30631..f8665fcb799b 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/MCABillingProfileQueryGrouping.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/MCABillingProfileQueryGrouping.json @@ -3,35 +3,34 @@ "api-version": "2025-03-01", "billingAccountId": "12345:6789", "billingProfileId": "13579", - "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579", "parameters": { "type": "Usage", - "timeframe": "TheLastMonth", "dataset": { - "granularity": "None", "aggregation": { "totalCost": { "name": "PreTaxCost", "function": "Sum" } }, + "granularity": "None", "grouping": [ { - "type": "Dimension", - "name": "ResourceGroup" + "name": "ResourceGroup", + "type": "Dimension" } ] - } - } + }, + "timeframe": "TheLastMonth" + }, + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579" }, "responses": { "200": { "body": { - "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", "type": "microsoft.costmanagement/Query", + "id": "/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", "properties": { - "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", "columns": [ { "name": "PreTaxCost", @@ -46,6 +45,7 @@ "type": "String" } ], + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", "rows": [ [ 19.545363672276512, @@ -58,7 +58,7 @@ "USD" ], [ - 20.359416562625452, + 20.35941656262545, "VSTSHOL-1595322048000", "USD" ] @@ -67,5 +67,7 @@ } }, "204": {} - } + }, + "operationId": "Query_Usage", + "title": "BillingProfileQueryGrouping-MCA" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/MCACustomerDimensionsList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/MCACustomerDimensionsList.json index 57edbba22469..fcec34a4b793 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/MCACustomerDimensionsList.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/MCACustomerDimensionsList.json @@ -10,38 +10,40 @@ "body": { "value": [ { - "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678/providers/microsoft.CostManagement/dimensions_ResourceGroup_2019-10-01_2019-10-31", "name": "dimensions_ResourceGroup_2019-10-01_2019-10-31", "type": "microsoft.CostManagement/dimensions", + "id": "/providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678/providers/microsoft.CostManagement/dimensions_ResourceGroup_2019-10-01_2019-10-31", "properties": { + "description": "Resource group", + "category": "ResourceGroup", "data": [], + "filterEnabled": true, + "groupingEnabled": true, "total": 377, - "category": "ResourceGroup", - "usageStart": "2019-10-01T00:00:00-07:00", "usageEnd": "2019-10-31T00:00:00-07:00", - "description": "Resource group", - "filterEnabled": true, - "groupingEnabled": true + "usageStart": "2019-10-01T00:00:00-07:00" } }, { - "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678/providers/microsoft.CostManagement/dimensions_ResourceType_2019-10-01_2019-10-31", "name": "dimensions_ResourceType_2019-10-01_2019-10-31", "type": "microsoft.CostManagement/dimensions", + "id": "/providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678/providers/microsoft.CostManagement/dimensions_ResourceType_2019-10-01_2019-10-31", "properties": { + "description": "Resource type", + "category": "ResourceType", "data": [], + "filterEnabled": true, + "groupingEnabled": true, "total": 37, - "category": "ResourceType", - "usageStart": "2019-10-01T00:00:00-07:00", "usageEnd": "2019-10-31T00:00:00-07:00", - "description": "Resource type", - "filterEnabled": true, - "groupingEnabled": true + "usageStart": "2019-10-01T00:00:00-07:00" } } ] } }, "204": {} - } + }, + "operationId": "Dimensions_List", + "title": "CustomerDimensionsList-MCA" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/MCACustomerDimensionsListExpandAndTop.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/MCACustomerDimensionsListExpandAndTop.json index 1471c11dc46f..49c24b189f62 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/MCACustomerDimensionsListExpandAndTop.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/MCACustomerDimensionsListExpandAndTop.json @@ -1,10 +1,10 @@ { "parameters": { + "$expand": "properties/data", + "$top": 5, "api-version": "2025-03-01", "billingAccountId": "12345:6789", "customerId": "5678", - "$expand": "properties/data", - "$top": 5, "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678" }, "responses": { @@ -12,10 +12,12 @@ "body": { "value": [ { - "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678/providers/microsoft.CostManagement/dimensions_ResourceGroup_2019-10-01_2019-10-31", "name": "dimensions_ResourceGroup_2019-10-01_2019-10-31", "type": "microsoft.CostManagement/dimensions", + "id": "/providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678/providers/microsoft.CostManagement/dimensions_ResourceGroup_2019-10-01_2019-10-31", "properties": { + "description": "Resource group", + "category": "ResourceGroup", "data": [ "thoroetrg01", "default-notificationhubs-westus", @@ -23,20 +25,20 @@ "contosocodeflow8d4a", "noobaa" ], + "filterEnabled": true, + "groupingEnabled": true, "total": 377, - "category": "ResourceGroup", - "usageStart": "2019-10-01T00:00:00-07:00", "usageEnd": "2019-10-31T00:00:00-07:00", - "description": "Resource group", - "filterEnabled": true, - "groupingEnabled": true + "usageStart": "2019-10-01T00:00:00-07:00" } }, { - "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678/providers/microsoft.CostManagement/dimensions_ResourceType_2019-10-01_2019-10-31", "name": "dimensions_ResourceType_2019-10-01_2019-10-31", "type": "microsoft.CostManagement/dimensions", + "id": "/providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678/providers/microsoft.CostManagement/dimensions_ResourceType_2019-10-01_2019-10-31", "properties": { + "description": "Resource type", + "category": "ResourceType", "data": [ "microsoft.automation/automationaccounts", "microsoft.databricks/workspaces", @@ -44,18 +46,18 @@ "microsoft.containerregistry/registries", "microsoft.search/searchservices" ], + "filterEnabled": true, + "groupingEnabled": true, "total": 37, - "category": "ResourceType", - "usageStart": "2019-10-01T00:00:00-07:00", "usageEnd": "2019-10-31T00:00:00-07:00", - "description": "Resource type", - "filterEnabled": true, - "groupingEnabled": true + "usageStart": "2019-10-01T00:00:00-07:00" } } ] } }, "204": {} - } + }, + "operationId": "Dimensions_List", + "title": "CustomerDimensionsListExpandAndTop-MCA" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/MCACustomerDimensionsListWithFilter.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/MCACustomerDimensionsListWithFilter.json index 3065b2884207..0f8a72cc4bf5 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/MCACustomerDimensionsListWithFilter.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/MCACustomerDimensionsListWithFilter.json @@ -1,11 +1,11 @@ { "parameters": { + "$expand": "properties/data", + "$filter": "properties/category eq 'resourceId'", + "$top": 5, "api-version": "2025-03-01", "billingAccountId": "12345:6789", "customerId": "13579", - "$expand": "properties/data", - "$top": 5, - "$filter": "properties/category eq 'resourceId'", "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678" }, "responses": { @@ -13,10 +13,12 @@ "body": { "value": [ { - "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678/providers/microsoft.CostManagement/dimensions_ResourceId_2019-10-01_2019-10-31", "name": "dimensions_ResourceId_2019-10-01_2019-10-31", "type": "microsoft.CostManagement/dimensions", + "id": "/providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678/providers/microsoft.CostManagement/dimensions_ResourceId_2019-10-01_2019-10-31", "properties": { + "description": "Resource Id", + "category": "ResourceId", "data": [ "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/system.orlando/providers/microsoft.storage/storageaccounts/urphealthaccount", "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/system.orlando/providers/microsoft.storage/storageaccounts/srphytenaccount", @@ -24,19 +26,19 @@ "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg-sql-ha/providers/microsoft.compute/virtualmachines/sql-4qqp1", "/subscriptions/a98d6dc5-eb8f-46cf-8938-f1fb08f03706/resourcegroups/databricks-rg-testwsp-xijmsdubneexm/providers/microsoft.compute/disks/488cdb42bf74474a98075415be3f806c-containerrootvolume" ], - "total": 1409, - "category": "ResourceId", - "usageStart": "2019-10-01T00:00:00-07:00", - "usageEnd": "2019-10-31T00:00:00-07:00", - "description": "Resource Id", "filterEnabled": true, "groupingEnabled": true, - "nextLink": "http://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678/providers/Microsoft.CostManagement/Dimensions?$filter=properties/category eq 'resourceId'&$top=5&api-version=2019-10-01&$expand=properties/data&$skiptoken=AQAAAA%3D%3D" + "nextLink": "http://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678/providers/Microsoft.CostManagement/Dimensions?$filter=properties/category eq 'resourceId'&$top=5&api-version=2019-10-01&$expand=properties/data&$skiptoken=AQAAAA%3D%3D", + "total": 1409, + "usageEnd": "2019-10-31T00:00:00-07:00", + "usageStart": "2019-10-01T00:00:00-07:00" } } ] } }, "204": {} - } + }, + "operationId": "Dimensions_List", + "title": "CustomerDimensionsListWithFilter-MCA" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/MCACustomerQuery.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/MCACustomerQuery.json index b020c95793dd..8c41f16f4073 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/MCACustomerQuery.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/MCACustomerQuery.json @@ -3,12 +3,9 @@ "api-version": "2025-03-01", "billingAccountId": "12345:6789", "customerId": "5678", - "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678", "parameters": { "type": "Usage", - "timeframe": "MonthToDate", "dataset": { - "granularity": "Daily", "filter": { "and": [ { @@ -45,18 +42,20 @@ } } ] - } - } - } + }, + "granularity": "Daily" + }, + "timeframe": "MonthToDate" + }, + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678" }, "responses": { "200": { "body": { - "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", "type": "microsoft.costmanagement/Query", + "id": "/providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", "properties": { - "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", "columns": [ { "name": "PreTaxCost", @@ -75,6 +74,7 @@ "type": "String" } ], + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", "rows": [ [ 19.545363672276512, @@ -89,7 +89,7 @@ "USD" ], [ - 20.359416562625452, + 20.35941656262545, "VSTSHOL-1595322048000", 20180331, "USD" @@ -105,5 +105,7 @@ } }, "204": {} - } + }, + "operationId": "Query_Usage", + "title": "CustomerQuery-MCA" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/MCACustomerQueryGrouping.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/MCACustomerQueryGrouping.json index e59d6e53fbdd..323958965b5a 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/MCACustomerQueryGrouping.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/MCACustomerQueryGrouping.json @@ -3,35 +3,34 @@ "api-version": "2025-03-01", "billingAccountId": "12345:6789", "customerId": "5678", - "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678", "parameters": { "type": "Usage", - "timeframe": "TheLastMonth", "dataset": { - "granularity": "None", "aggregation": { "totalCost": { "name": "PreTaxCost", "function": "Sum" } }, + "granularity": "None", "grouping": [ { - "type": "Dimension", - "name": "ResourceGroup" + "name": "ResourceGroup", + "type": "Dimension" } ] - } - } + }, + "timeframe": "TheLastMonth" + }, + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678" }, "responses": { "200": { "body": { - "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", "type": "microsoft.costmanagement/Query", + "id": "/providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", "properties": { - "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", "columns": [ { "name": "PreTaxCost", @@ -46,6 +45,7 @@ "type": "String" } ], + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", "rows": [ [ 19.545363672276512, @@ -58,7 +58,7 @@ "USD" ], [ - 20.359416562625452, + 20.35941656262545, "VSTSHOL-1595322048000", "USD" ] @@ -67,5 +67,7 @@ } }, "204": {} - } + }, + "operationId": "Query_Usage", + "title": "CustomerQueryGrouping-MCA" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/MCAInvoiceSectionDimensionsList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/MCAInvoiceSectionDimensionsList.json index 8f745b30de2e..3c8a901cc668 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/MCAInvoiceSectionDimensionsList.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/MCAInvoiceSectionDimensionsList.json @@ -11,38 +11,40 @@ "body": { "value": [ { - "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/microsoft.CostManagement/dimensions_ResourceGroup_2019-10-01_2019-10-31", "name": "dimensions_ResourceGroup_2019-10-01_2019-10-31", "type": "microsoft.CostManagement/dimensions", + "id": "/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/microsoft.CostManagement/dimensions_ResourceGroup_2019-10-01_2019-10-31", "properties": { + "description": "Resource group", + "category": "ResourceGroup", "data": [], + "filterEnabled": true, + "groupingEnabled": true, "total": 377, - "category": "ResourceGroup", - "usageStart": "2019-10-01T00:00:00-07:00", "usageEnd": "2019-10-31T00:00:00-07:00", - "description": "Resource group", - "filterEnabled": true, - "groupingEnabled": true + "usageStart": "2019-10-01T00:00:00-07:00" } }, { - "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/microsoft.CostManagement/dimensions_ResourceType_2019-10-01_2019-10-31", "name": "dimensions_ResourceType_2019-10-01_2019-10-31", "type": "microsoft.CostManagement/dimensions", + "id": "/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/microsoft.CostManagement/dimensions_ResourceType_2019-10-01_2019-10-31", "properties": { + "description": "Resource type", + "category": "ResourceType", "data": [], + "filterEnabled": true, + "groupingEnabled": true, "total": 37, - "category": "ResourceType", - "usageStart": "2019-10-01T00:00:00-07:00", "usageEnd": "2019-10-31T00:00:00-07:00", - "description": "Resource type", - "filterEnabled": true, - "groupingEnabled": true + "usageStart": "2019-10-01T00:00:00-07:00" } } ] } }, "204": {} - } + }, + "operationId": "Dimensions_List", + "title": "InvoiceSectionDimensionsList-MCA" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/MCAInvoiceSectionDimensionsListExpandAndTop.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/MCAInvoiceSectionDimensionsListExpandAndTop.json index 84825852994e..5211f494b0e8 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/MCAInvoiceSectionDimensionsListExpandAndTop.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/MCAInvoiceSectionDimensionsListExpandAndTop.json @@ -1,11 +1,11 @@ { "parameters": { + "$expand": "properties/data", + "$top": 5, "api-version": "2025-03-01", "billingAccountId": "12345:6789", "billingProfileId": "13579", "invoiceSectionId": "9876", - "$expand": "properties/data", - "$top": 5, "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876" }, "responses": { @@ -13,10 +13,12 @@ "body": { "value": [ { - "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/microsoft.CostManagement/dimensions_ResourceGroup_2019-10-01_2019-10-31", "name": "dimensions_ResourceGroup_2019-10-01_2019-10-31", "type": "microsoft.CostManagement/dimensions", + "id": "/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/microsoft.CostManagement/dimensions_ResourceGroup_2019-10-01_2019-10-31", "properties": { + "description": "Resource group", + "category": "ResourceGroup", "data": [ "thoroetrg01", "default-notificationhubs-westus", @@ -24,20 +26,20 @@ "contosocodeflow8d4a", "noobaa" ], + "filterEnabled": true, + "groupingEnabled": true, "total": 377, - "category": "ResourceGroup", - "usageStart": "2019-10-01T00:00:00-07:00", "usageEnd": "2019-10-31T00:00:00-07:00", - "description": "Resource group", - "filterEnabled": true, - "groupingEnabled": true + "usageStart": "2019-10-01T00:00:00-07:00" } }, { - "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/microsoft.CostManagement/dimensions_ResourceType_2019-10-01_2019-10-31", "name": "dimensions_ResourceType_2019-10-01_2019-10-31", "type": "microsoft.CostManagement/dimensions", + "id": "/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/microsoft.CostManagement/dimensions_ResourceType_2019-10-01_2019-10-31", "properties": { + "description": "Resource type", + "category": "ResourceType", "data": [ "microsoft.automation/automationaccounts", "microsoft.databricks/workspaces", @@ -45,18 +47,18 @@ "microsoft.containerregistry/registries", "microsoft.search/searchservices" ], + "filterEnabled": true, + "groupingEnabled": true, "total": 37, - "category": "ResourceType", - "usageStart": "2019-10-01T00:00:00-07:00", "usageEnd": "2019-10-31T00:00:00-07:00", - "description": "Resource type", - "filterEnabled": true, - "groupingEnabled": true + "usageStart": "2019-10-01T00:00:00-07:00" } } ] } }, "204": {} - } + }, + "operationId": "Dimensions_List", + "title": "InvoiceSectionDimensionsListExpandAndTop-MCA" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/MCAInvoiceSectionDimensionsListWithFilter.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/MCAInvoiceSectionDimensionsListWithFilter.json index 0aca7e4ad9a8..b9c7e43ee039 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/MCAInvoiceSectionDimensionsListWithFilter.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/MCAInvoiceSectionDimensionsListWithFilter.json @@ -1,12 +1,12 @@ { "parameters": { + "$expand": "properties/data", + "$filter": "properties/category eq 'resourceId'", + "$top": 5, "api-version": "2025-03-01", "billingAccountId": "12345:6789", "billingProfileId": "13579", "invoiceSectionId": "9876", - "$expand": "properties/data", - "$top": 5, - "$filter": "properties/category eq 'resourceId'", "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876" }, "responses": { @@ -14,10 +14,12 @@ "body": { "value": [ { - "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/microsoft.CostManagement/dimensions_ResourceId_2019-10-01_2019-10-31", "name": "dimensions_ResourceId_2019-10-01_2019-10-31", "type": "microsoft.CostManagement/dimensions", + "id": "/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/microsoft.CostManagement/dimensions_ResourceId_2019-10-01_2019-10-31", "properties": { + "description": "Resource Id", + "category": "ResourceId", "data": [ "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/system.orlando/providers/microsoft.storage/storageaccounts/urphealthaccount", "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/system.orlando/providers/microsoft.storage/storageaccounts/srphytenaccount", @@ -25,19 +27,19 @@ "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg-sql-ha/providers/microsoft.compute/virtualmachines/sql-4qqp1", "/subscriptions/a98d6dc5-eb8f-46cf-8938-f1fb08f03706/resourcegroups/databricks-rg-testwsp-xijmsdubneexm/providers/microsoft.compute/disks/488cdb42bf74474a98075415be3f806c-containerrootvolume" ], - "total": 1409, - "category": "ResourceId", - "usageStart": "2019-10-01T00:00:00-07:00", - "usageEnd": "2019-10-31T00:00:00-07:00", - "description": "Resource Id", "filterEnabled": true, "groupingEnabled": true, - "nextLink": "http://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/Microsoft.CostManagement/Dimensions?$filter=properties/category eq 'resourceId'&$top=5&api-version=2019-10-01&$expand=properties/data&$skiptoken=AQAAAA%3D%3D" + "nextLink": "http://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/Microsoft.CostManagement/Dimensions?$filter=properties/category eq 'resourceId'&$top=5&api-version=2019-10-01&$expand=properties/data&$skiptoken=AQAAAA%3D%3D", + "total": 1409, + "usageEnd": "2019-10-31T00:00:00-07:00", + "usageStart": "2019-10-01T00:00:00-07:00" } } ] } }, "204": {} - } + }, + "operationId": "Dimensions_List", + "title": "InvoiceSectionDimensionsListWithFilter-MCA" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/MCAInvoiceSectionQuery.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/MCAInvoiceSectionQuery.json index 230b9ef8377d..bc001067ccf3 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/MCAInvoiceSectionQuery.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/MCAInvoiceSectionQuery.json @@ -4,12 +4,9 @@ "billingAccountId": "12345:6789", "billingProfileId": "13579", "invoiceSectionId": "9876", - "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876", "parameters": { "type": "Usage", - "timeframe": "MonthToDate", "dataset": { - "granularity": "Daily", "filter": { "and": [ { @@ -46,18 +43,20 @@ } } ] - } - } - } + }, + "granularity": "Daily" + }, + "timeframe": "MonthToDate" + }, + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876" }, "responses": { "200": { "body": { - "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", "type": "microsoft.costmanagement/Query", + "id": "/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", "properties": { - "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", "columns": [ { "name": "PreTaxCost", @@ -76,6 +75,7 @@ "type": "String" } ], + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", "rows": [ [ 19.545363672276512, @@ -90,7 +90,7 @@ "USD" ], [ - 20.359416562625452, + 20.35941656262545, "VSTSHOL-1595322048000", 20180331, "USD" @@ -106,5 +106,7 @@ } }, "204": {} - } + }, + "operationId": "Query_Usage", + "title": "InvoiceSectionQuery-MCA" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/MCAInvoiceSectionQueryGrouping.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/MCAInvoiceSectionQueryGrouping.json index 781cdbed3776..f4337cd3786e 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/MCAInvoiceSectionQueryGrouping.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/MCAInvoiceSectionQueryGrouping.json @@ -4,35 +4,34 @@ "billingAccountId": "12345:6789", "billingProfileId": "13579", "invoiceSectionId": "9876", - "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876", "parameters": { "type": "Usage", - "timeframe": "TheLastMonth", "dataset": { - "granularity": "None", "aggregation": { "totalCost": { "name": "PreTaxCost", "function": "Sum" } }, + "granularity": "None", "grouping": [ { - "type": "Dimension", - "name": "ResourceGroup" + "name": "ResourceGroup", + "type": "Dimension" } ] - } - } + }, + "timeframe": "TheLastMonth" + }, + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876" }, "responses": { "200": { "body": { - "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", "type": "microsoft.costmanagement/Query", + "id": "/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", "properties": { - "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", "columns": [ { "name": "PreTaxCost", @@ -47,6 +46,7 @@ "type": "String" } ], + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", "rows": [ [ 19.545363672276512, @@ -59,7 +59,7 @@ "USD" ], [ - 20.359416562625452, + 20.35941656262545, "VSTSHOL-1595322048000", "USD" ] @@ -68,5 +68,7 @@ } }, "204": {} - } + }, + "operationId": "Query_Usage", + "title": "InvoiceSectionQueryGrouping-MCA" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ManagementGroupDimensionsList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ManagementGroupDimensionsList.json index 066673a8d2c1..a939f3e82006 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ManagementGroupDimensionsList.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ManagementGroupDimensionsList.json @@ -9,38 +9,40 @@ "body": { "value": [ { - "id": "providers/Microsoft.Management/managementGroups/MyMgId/providers/microsoft.CostManagement/dimensions_ResourceGroup_2018-05-01_2018-05-31", "name": "dimensions_ResourceGroup_2018-05-01_2018-05-31", "type": "microsoft.CostManagement/dimensions", + "id": "/providers/Microsoft.Management/managementGroups/MyMgId/providers/microsoft.CostManagement/dimensions_ResourceGroup_2018-05-01_2018-05-31", "properties": { + "description": "Resource group", + "category": "ResourceGroup", "data": [], + "filterEnabled": true, + "groupingEnabled": true, "total": 377, - "category": "ResourceGroup", - "usageStart": "2018-05-01T00:00:00-07:00", "usageEnd": "2018-05-31T00:00:00-07:00", - "description": "Resource group", - "filterEnabled": true, - "groupingEnabled": true + "usageStart": "2018-05-01T00:00:00-07:00" } }, { - "id": "providers/Microsoft.Management/managementGroups/MyMgId/providers/microsoft.CostManagement/dimensions_ResourceType_2018-05-01_2018-05-31", "name": "dimensions_ResourceType_2018-05-01_2018-05-31", "type": "microsoft.CostManagement/dimensions", + "id": "/providers/Microsoft.Management/managementGroups/MyMgId/providers/microsoft.CostManagement/dimensions_ResourceType_2018-05-01_2018-05-31", "properties": { + "description": "Resource type", + "category": "ResourceType", "data": [], + "filterEnabled": true, + "groupingEnabled": true, "total": 37, - "category": "ResourceType", - "usageStart": "2018-05-01T00:00:00-07:00", "usageEnd": "2018-05-31T00:00:00-07:00", - "description": "Resource type", - "filterEnabled": true, - "groupingEnabled": true + "usageStart": "2018-05-01T00:00:00-07:00" } } ] } }, "204": {} - } + }, + "operationId": "Dimensions_List", + "title": "ManagementGroupDimensionsList-Legacy" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ManagementGroupDimensionsListExpandAndTop.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ManagementGroupDimensionsListExpandAndTop.json index bc70b329eccb..4f9edc2c24e0 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ManagementGroupDimensionsListExpandAndTop.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ManagementGroupDimensionsListExpandAndTop.json @@ -1,9 +1,9 @@ { "parameters": { - "api-version": "2025-03-01", - "managementGroupId": "MyMgId", "$expand": "properties/data", "$top": 5, + "api-version": "2025-03-01", + "managementGroupId": "MyMgId", "scope": "providers/Microsoft.Management/managementGroups/MyMgId" }, "responses": { @@ -11,10 +11,12 @@ "body": { "value": [ { - "id": "providers/Microsoft.Management/managementGroups/MyMgId/providers/microsoft.CostManagement/dimensions_ResourceGroup_2018-05-01_2018-05-31_5", "name": "dimensions_ResourceGroup_2018-05-01_2018-05-31_5", "type": "microsoft.CostManagement/dimensions", + "id": "/providers/Microsoft.Management/managementGroups/MyMgId/providers/microsoft.CostManagement/dimensions_ResourceGroup_2018-05-01_2018-05-31_5", "properties": { + "description": "Resource group", + "category": "ResourceGroup", "data": [ "thoroetrg01", "default-notificationhubs-westus", @@ -22,20 +24,20 @@ "contosocodeflow8d4a", "noobaa" ], + "filterEnabled": true, + "groupingEnabled": true, "total": 377, - "category": "ResourceGroup", - "usageStart": "2018-05-01T00:00:00-07:00", "usageEnd": "2018-05-31T00:00:00-07:00", - "description": "Resource group", - "filterEnabled": true, - "groupingEnabled": true + "usageStart": "2018-05-01T00:00:00-07:00" } }, { - "id": "providers/Microsoft.Management/managementGroups/MyMgId/providers/microsoft.CostManagement/dimensions_ResourceType_2018-05-01_2018-05-31_5", "name": "dimensions_ResourceType_2018-05-01_2018-05-31_5", "type": "microsoft.CostManagement/dimensions", + "id": "/providers/Microsoft.Management/managementGroups/MyMgId/providers/microsoft.CostManagement/dimensions_ResourceType_2018-05-01_2018-05-31_5", "properties": { + "description": "Resource type", + "category": "ResourceType", "data": [ "microsoft.automation/automationaccounts", "microsoft.databricks/workspaces", @@ -43,18 +45,18 @@ "microsoft.containerregistry/registries", "microsoft.search/searchservices" ], + "filterEnabled": true, + "groupingEnabled": true, "total": 37, - "category": "ResourceType", - "usageStart": "2018-05-01T00:00:00-07:00", "usageEnd": "2018-05-31T00:00:00-07:00", - "description": "Resource type", - "filterEnabled": true, - "groupingEnabled": true + "usageStart": "2018-05-01T00:00:00-07:00" } } ] } }, "204": {} - } + }, + "operationId": "Dimensions_List", + "title": "ManagementGroupDimensionsListExpandAndTop-Legacy" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ManagementGroupDimensionsListWithFilter.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ManagementGroupDimensionsListWithFilter.json index dd94d5e325be..922052bfdd30 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ManagementGroupDimensionsListWithFilter.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ManagementGroupDimensionsListWithFilter.json @@ -1,10 +1,10 @@ { "parameters": { - "api-version": "2025-03-01", - "managementGroupId": "MyMgId", "$expand": "properties/data", - "$top": 5, "$filter": "properties/category eq 'resourceId'", + "$top": 5, + "api-version": "2025-03-01", + "managementGroupId": "MyMgId", "scope": "providers/Microsoft.Management/managementGroups/MyMgId" }, "responses": { @@ -12,10 +12,12 @@ "body": { "value": [ { - "id": "providers/Microsoft.Management/managementGroups/MyMgId/providers/microsoft.CostManagement/dimensions_ResourceId_2018-05-01_2018-05-31_5", "name": "dimensions_ResourceId_2018-05-01_2018-05-31_5", "type": "microsoft.CostManagement/dimensions", + "id": "/providers/Microsoft.Management/managementGroups/MyMgId/providers/microsoft.CostManagement/dimensions_ResourceId_2018-05-01_2018-05-31_5", "properties": { + "description": "Resource Id", + "category": "ResourceId", "data": [ "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/system.orlando/providers/microsoft.storage/storageaccounts/urphealthaccount", "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/system.orlando/providers/microsoft.storage/storageaccounts/srphytenaccount", @@ -23,19 +25,19 @@ "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg-sql-ha/providers/microsoft.compute/virtualmachines/sql-4qqp1", "/subscriptions/a98d6dc5-eb8f-46cf-8938-f1fb08f03706/resourcegroups/databricks-rg-testwsp-xijmsdubneexm/providers/microsoft.compute/disks/488cdb42bf74474a98075415be3f806c-containerrootvolume" ], - "total": 1409, - "category": "ResourceId", - "usageStart": "2018-05-01T00:00:00-07:00", - "usageEnd": "2018-05-31T00:00:00-07:00", - "description": "Resource Id", "filterEnabled": true, "groupingEnabled": true, - "nextLink": "http://management.azure.com/providers/Microsoft.Management/managementGroups/MyMgId/providers/Microsoft.CostManagement/Dimensions?$filter=properties/category eq 'resourceId'&$top=5&api-version=2019-10-01&$expand=properties/data&$skiptoken=AQAAAA%3D%3D" + "nextLink": "http://management.azure.com/providers/Microsoft.Management/managementGroups/MyMgId/providers/Microsoft.CostManagement/Dimensions?$filter=properties/category eq 'resourceId'&$top=5&api-version=2019-10-01&$expand=properties/data&$skiptoken=AQAAAA%3D%3D", + "total": 1409, + "usageEnd": "2018-05-31T00:00:00-07:00", + "usageStart": "2018-05-01T00:00:00-07:00" } } ] } }, "204": {} - } + }, + "operationId": "Dimensions_List", + "title": "ManagementGroupDimensionsListWithFilter-Legacy" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ManagementGroupQuery.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ManagementGroupQuery.json index e27e4187b7b1..47b38a83c8da 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ManagementGroupQuery.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ManagementGroupQuery.json @@ -2,12 +2,9 @@ "parameters": { "api-version": "2025-03-01", "managementGroupId": "MyMgId", - "scope": "providers/Microsoft.Management/managementGroups/MyMgId", "parameters": { "type": "Usage", - "timeframe": "MonthToDate", "dataset": { - "granularity": "Daily", "filter": { "and": [ { @@ -44,18 +41,20 @@ } } ] - } - } - } + }, + "granularity": "Daily" + }, + "timeframe": "MonthToDate" + }, + "scope": "providers/Microsoft.Management/managementGroups/MyMgId" }, "responses": { "200": { "body": { - "id": "providers/Microsoft.Management/managementGroups/MyMgId/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", "type": "microsoft.costmanagement/Query", + "id": "/providers/Microsoft.Management/managementGroups/MyMgId/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", "properties": { - "nextLink": "https://management.azure.com/providers/Microsoft.Management/managementGroups/MyMgId/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", "columns": [ { "name": "PreTaxCost", @@ -74,6 +73,7 @@ "type": "String" } ], + "nextLink": "https://management.azure.com/providers/Microsoft.Management/managementGroups/MyMgId/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", "rows": [ [ 19.545363672276512, @@ -88,7 +88,7 @@ "USD" ], [ - 20.359416562625452, + 20.35941656262545, "VSTSHOL-1595322048000", 20180331, "USD" @@ -104,5 +104,7 @@ } }, "204": {} - } + }, + "operationId": "Query_Usage", + "title": "ManagementGroupQuery-Legacy" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ManagementGroupQueryGrouping.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ManagementGroupQueryGrouping.json index 2a9e7b6183d2..900ed7fc8094 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ManagementGroupQueryGrouping.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ManagementGroupQueryGrouping.json @@ -2,35 +2,34 @@ "parameters": { "api-version": "2025-03-01", "managementGroupId": "MyMgId", - "scope": "providers/Microsoft.Management/managementGroups/MyMgId", "parameters": { "type": "Usage", - "timeframe": "TheLastMonth", "dataset": { - "granularity": "None", "aggregation": { "totalCost": { "name": "PreTaxCost", "function": "Sum" } }, + "granularity": "None", "grouping": [ { - "type": "Dimension", - "name": "ResourceGroup" + "name": "ResourceGroup", + "type": "Dimension" } ] - } - } + }, + "timeframe": "TheLastMonth" + }, + "scope": "providers/Microsoft.Management/managementGroups/MyMgId" }, "responses": { "200": { "body": { - "id": "providers/Microsoft.Management/managementGroups/MyMgId/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", "type": "microsoft.costmanagement/Query", + "id": "/providers/Microsoft.Management/managementGroups/MyMgId/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", "properties": { - "nextLink": "https://management.azure.com/providers/Microsoft.Management/managementGroups/MyMgId/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", "columns": [ { "name": "PreTaxCost", @@ -49,9 +48,10 @@ "type": "String" } ], + "nextLink": "https://management.azure.com/providers/Microsoft.Management/managementGroups/MyMgId/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", "rows": [ [ - 20.359416562625452, + 20.35941656262545, "VSTSHOL-1595322048000", 20180331, "USD" @@ -73,5 +73,7 @@ } }, "204": {} - } + }, + "operationId": "Query_Usage", + "title": "ManagementGroupQueryGrouping-Legacy" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/OperationList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/OperationList.json index bd5ddb22567f..9f1222c1074a 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/OperationList.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/OperationList.json @@ -7,107 +7,109 @@ "body": { "value": [ { - "id": "Microsoft.CostManagement/budgets/read", "name": "Microsoft.CostManagement/budgets/read", "display": { - "provider": "Microsoft.CostManagement", - "resource": "Budgets", + "description": "List the budgets by a subscription or a management group.", "operation": "List budgets", - "description": "List the budgets by a subscription or a management group." - } + "provider": "Microsoft.CostManagement", + "resource": "Budgets" + }, + "id": "Microsoft.CostManagement/budgets/read" }, { - "id": "Microsoft.CostManagement/query/action", "name": "Microsoft.CostManagement/query/action", "display": { - "provider": "Microsoft.CostManagement", - "resource": "Query", + "description": "Query usage data by a scope.", "operation": "Query usage data", - "description": "Query usage data by a scope." - } + "provider": "Microsoft.CostManagement", + "resource": "Query" + }, + "id": "Microsoft.CostManagement/query/action" }, { - "id": "Microsoft.CostManagement/exports/read", "name": "Microsoft.CostManagement/exports/read", "display": { - "provider": "Microsoft.CostManagement", - "resource": "Exports", + "description": "List the exports by scope.", "operation": "List exports", - "description": "List the exports by scope." - } + "provider": "Microsoft.CostManagement", + "resource": "Exports" + }, + "id": "Microsoft.CostManagement/exports/read" }, { - "id": "Microsoft.CostManagement/exports/write", "name": "Microsoft.CostManagement/exports/write", "display": { - "provider": "Microsoft.CostManagement", - "resource": "Exports", + "description": "Create or update the specified export.", "operation": "Create and update export", - "description": "Create or update the specified export." - } + "provider": "Microsoft.CostManagement", + "resource": "Exports" + }, + "id": "Microsoft.CostManagement/exports/write" }, { - "id": "Microsoft.CostManagement/exports/action", "name": "Microsoft.CostManagement/exports/action", "display": { - "provider": "Microsoft.CostManagement", - "resource": "Exports", + "description": "Run the specified export.", "operation": "Run export", - "description": "Run the specified export." - } + "provider": "Microsoft.CostManagement", + "resource": "Exports" + }, + "id": "Microsoft.CostManagement/exports/action" }, { - "id": "Microsoft.CostManagement/exports/run/action", "name": "Microsoft.CostManagement/exports/run/action", "display": { - "provider": "Microsoft.CostManagement", - "resource": "exports/run", + "description": "Run exports.", "operation": "Run exports", - "description": "Run exports." - } + "provider": "Microsoft.CostManagement", + "resource": "exports/run" + }, + "id": "Microsoft.CostManagement/exports/run/action" }, { - "id": "Microsoft.CostManagement/alerts/read", "name": "Microsoft.CostManagement/alerts/read", "display": { - "provider": "Microsoft.CostManagement", - "resource": "Alerts", + "description": "List alerts.", "operation": "List Alerts", - "description": "List alerts." - } + "provider": "Microsoft.CostManagement", + "resource": "Alerts" + }, + "id": "Microsoft.CostManagement/alerts/read" }, { - "id": "Microsoft.CostManagement/operations/read", "name": "Microsoft.CostManagement/operations/read", "display": { - "provider": "Microsoft.CostManagement", - "resource": "Operations", + "description": "List all supported operations by Microsoft.CostManagement resource provider.", "operation": "List supported operations", - "description": "List all supported operations by Microsoft.CostManagement resource provider." - } + "provider": "Microsoft.CostManagement", + "resource": "Operations" + }, + "id": "Microsoft.CostManagement/operations/read" }, { - "id": "Microsoft.CostManagement/views/action", "name": "Microsoft.CostManagement/views/action", "display": { - "provider": "Microsoft.CostManagement", - "resource": "Views", + "description": "Create view.", "operation": "Create views", - "description": "Create view." - } + "provider": "Microsoft.CostManagement", + "resource": "Views" + }, + "id": "Microsoft.CostManagement/views/action" }, { - "id": "Microsoft.CostManagement/views/write", "name": "Microsoft.CostManagement/views/write", "display": { - "provider": "Microsoft.CostManagement", - "resource": "Views", + "description": "Update view.", "operation": "Update views", - "description": "Update view." - } + "provider": "Microsoft.CostManagement", + "resource": "Views" + }, + "id": "Microsoft.CostManagement/views/write" } ] } } - } + }, + "operationId": "Operations_List", + "title": "OperationList" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/PricesheetDownload.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/PricesheetDownload.json index 340c87ce2279..f5aee427e5b6 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/PricesheetDownload.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/PricesheetDownload.json @@ -6,18 +6,20 @@ "invoiceName": "T000940677" }, "responses": { - "202": { - "headers": { - "Location": "https://management.azure.com:443/providers/Microsoft.Billing/billingAccounts/7c05a543-80ff-571e-9f98-1063b3b53cf2:99ad03ad-2d1b-4889-a452-090ad407d25f_2019-05-31/billingProfiles/2USN-TPCD-BG7-TGB/providers/Microsoft.CostManagement/operationResults/45000000-0000-0000-0000-000000000000?sessiontoken=0:000000&api-version=2025-03-01&OperationType=PriceSheet", - "Retry-After": "60", - "OData-EntityId": "45000000-0000-0000-0000-000000000000" - } - }, "200": { "body": { "downloadUrl": "https://myaccount.blob.core.windows.net/?restype=service&comp=properties&sv=2015-04-05&ss=bf&srt=s&st=2015-04-29T22%3A18%3A26Z&se=2015-04-30T02%3A23%3A26Z&sr=b&sp=rw&spr=https&sig=G%2TEST%4B", "expiryTime": "2022-09-30T17:32:28Z" } + }, + "202": { + "headers": { + "Location": "https://management.azure.com:443/providers/Microsoft.Billing/billingAccounts/7c05a543-80ff-571e-9f98-1063b3b53cf2:99ad03ad-2d1b-4889-a452-090ad407d25f_2019-05-31/billingProfiles/2USN-TPCD-BG7-TGB/providers/Microsoft.CostManagement/operationResults/45000000-0000-0000-0000-000000000000?sessiontoken=0:000000&api-version=2025-03-01&OperationType=PriceSheet", + "OData-EntityId": "45000000-0000-0000-0000-000000000000", + "Retry-After": "60" + } } - } + }, + "operationId": "PriceSheet_DownloadByInvoice", + "title": "PricesheetDownload" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/PricesheetDownloadByBillingProfile.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/PricesheetDownloadByBillingProfile.json index d2c9bdb8fdf3..0a5fdc8420ea 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/PricesheetDownloadByBillingProfile.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/PricesheetDownloadByBillingProfile.json @@ -5,18 +5,20 @@ "billingProfileName": "2USN-TPCD-BG7-TGB" }, "responses": { - "202": { - "headers": { - "Location": "https://management.azure.com:443/providers/Microsoft.Billing/billingAccounts/7c05a543-80ff-571e-9f98-1063b3b53cf2:99ad03ad-2d1b-4889-a452-090ad407d25f_2019-05-31/billingProfiles/2USN-TPCD-BG7-TGB/providers/Microsoft.CostManagement/operationResults/45000000-0000-0000-0000-000000000000?sessiontoken=0:000000&api-version=2025-03-01&OperationType=PriceSheet", - "Retry-After": "60", - "OData-EntityId": "45000000-0000-0000-0000-000000000000" - } - }, "200": { "body": { "downloadUrl": "https://myaccount.blob.core.windows.net/?restype=service&comp=properties&sv=2015-04-05&ss=bf&srt=s&st=2015-04-29T22%3A18%3A26Z&se=2015-04-30T02%3A23%3A26Z&sr=b&sp=rw&spr=https&sig=G%2TEST%4B", "expiryTime": "2018-07-21T17:32:28Z" } + }, + "202": { + "headers": { + "Location": "https://management.azure.com:443/providers/Microsoft.Billing/billingAccounts/7c05a543-80ff-571e-9f98-1063b3b53cf2:99ad03ad-2d1b-4889-a452-090ad407d25f_2019-05-31/billingProfiles/2USN-TPCD-BG7-TGB/providers/Microsoft.CostManagement/operationResults/45000000-0000-0000-0000-000000000000?sessiontoken=0:000000&api-version=2025-03-01&OperationType=PriceSheet", + "OData-EntityId": "45000000-0000-0000-0000-000000000000", + "Retry-After": "60" + } } - } + }, + "operationId": "PriceSheet_DownloadByBillingProfile", + "title": "PricesheetDownloadByBillingProfile" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/PrivateView.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/PrivateView.json index 753f3ee949f2..d22e14fc41f0 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/PrivateView.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/PrivateView.json @@ -6,64 +6,66 @@ "responses": { "200": { "body": { - "id": "/providers/Microsoft.CostManagement/views/swaggerExample", "name": "swaggerExample", "type": "Microsoft.CostManagement/Views", "eTag": "\"1d4ff9fe66f1d10\"", + "id": "/providers/Microsoft.CostManagement/views/swaggerExample", "properties": { - "displayName": "swagger Example", - "scope": "", - "query": { - "type": "Usage", - "timeframe": "MonthToDate", - "dataSet": { - "granularity": "Daily", - "aggregation": { - "totalCost": { - "name": "PreTaxCost", - "function": "Sum" - } - }, - "grouping": [], - "sorting": [ - { - "direction": "Ascending", - "name": "UsageDate" - } - ] - } - }, - "chart": "Table", "accumulated": "true", - "metric": "ActualCost", + "chart": "Table", + "displayName": "swagger Example", "kpis": [ { "type": "Forecast", - "id": null, - "enabled": true + "enabled": true, + "id": null }, { "type": "Budget", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Consumption/budgets/swaggerDemo", - "enabled": true + "enabled": true, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Consumption/budgets/swaggerDemo" } ], + "metric": "ActualCost", "pivots": [ { - "type": "Dimension", - "name": "ServiceName" + "name": "ServiceName", + "type": "Dimension" }, { - "type": "Dimension", - "name": "MeterCategory" + "name": "MeterCategory", + "type": "Dimension" }, { - "type": "TagKey", - "name": "swaggerTagKey" + "name": "swaggerTagKey", + "type": "TagKey" } - ] + ], + "query": { + "type": "Usage", + "dataSet": { + "aggregation": { + "totalCost": { + "name": "PreTaxCost", + "function": "Sum" + } + }, + "granularity": "Daily", + "grouping": [], + "sorting": [ + { + "name": "UsageDate", + "direction": "Ascending" + } + ] + }, + "timeframe": "MonthToDate" + }, + "scope": "" } } } - } + }, + "operationId": "Views_Get", + "title": "PrivateView" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/PrivateViewCreateOrUpdate.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/PrivateViewCreateOrUpdate.json index c2b3190c04e5..4ceda637895e 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/PrivateViewCreateOrUpdate.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/PrivateViewCreateOrUpdate.json @@ -1,185 +1,187 @@ { "parameters": { "api-version": "2025-03-01", - "viewName": "swaggerExample", "parameters": { "eTag": "\"1d4ff9fe66f1d10\"", "properties": { - "displayName": "swagger Example", - "query": { - "type": "Usage", - "timeframe": "MonthToDate", - "dataSet": { - "granularity": "Daily", - "aggregation": { - "totalCost": { - "name": "PreTaxCost", - "function": "Sum" - } - }, - "grouping": [], - "sorting": [ - { - "direction": "Ascending", - "name": "UsageDate" - } - ] - } - }, - "chart": "Table", "accumulated": "true", - "metric": "ActualCost", + "chart": "Table", + "displayName": "swagger Example", "kpis": [ { "type": "Forecast", - "id": null, - "enabled": true + "enabled": true, + "id": null }, { "type": "Budget", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Consumption/budgets/swaggerDemo", - "enabled": true + "enabled": true, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Consumption/budgets/swaggerDemo" } ], + "metric": "ActualCost", "pivots": [ { - "type": "Dimension", - "name": "ServiceName" + "name": "ServiceName", + "type": "Dimension" }, { - "type": "Dimension", - "name": "MeterCategory" + "name": "MeterCategory", + "type": "Dimension" }, { - "type": "TagKey", - "name": "swaggerTagKey" + "name": "swaggerTagKey", + "type": "TagKey" } - ] + ], + "query": { + "type": "Usage", + "dataSet": { + "aggregation": { + "totalCost": { + "name": "PreTaxCost", + "function": "Sum" + } + }, + "granularity": "Daily", + "grouping": [], + "sorting": [ + { + "name": "UsageDate", + "direction": "Ascending" + } + ] + }, + "timeframe": "MonthToDate" + } } - } + }, + "viewName": "swaggerExample" }, "responses": { - "201": { + "200": { "body": { - "id": "/providers/Microsoft.CostManagement/views/swaggerExample", "name": "swaggerExample", "type": "Microsoft.CostManagement/Views", "eTag": "\"1d4ffa5a9c2430c\"", + "id": "/providers/Microsoft.CostManagement/views/swaggerExample", "properties": { - "displayName": "swagger Example", - "scope": "", - "query": { - "type": "Usage", - "timeframe": "MonthToDate", - "dataSet": { - "granularity": "Daily", - "aggregation": { - "totalCost": { - "name": "PreTaxCost", - "function": "Sum" - } - }, - "grouping": [], - "sorting": [ - { - "direction": "Ascending", - "name": "UsageDate" - } - ] - } - }, - "chart": "Table", "accumulated": "true", - "metric": "ActualCost", + "chart": "Table", + "displayName": "swagger Example", "kpis": [ { "type": "Forecast", - "id": null, - "enabled": true + "enabled": true, + "id": null }, { "type": "Budget", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Consumption/budgets/swaggerDemo", - "enabled": true + "enabled": true, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Consumption/budgets/swaggerDemo" } ], + "metric": "ActualCost", "pivots": [ { - "type": "Dimension", - "name": "ServiceName" + "name": "ServiceName", + "type": "Dimension" }, { - "type": "Dimension", - "name": "MeterCategory" + "name": "MeterCategory", + "type": "Dimension" }, { - "type": "TagKey", - "name": "swaggerTagKey" + "name": "swaggerTagKey", + "type": "TagKey" } - ] - } - } - }, - "200": { - "body": { - "id": "/providers/Microsoft.CostManagement/views/swaggerExample", - "name": "swaggerExample", - "type": "Microsoft.CostManagement/Views", - "eTag": "\"1d4ffa5a9c2430c\"", - "properties": { - "displayName": "swagger Example", - "scope": "", + ], "query": { "type": "Usage", - "timeframe": "MonthToDate", "dataSet": { - "granularity": "Daily", "aggregation": { "totalCost": { "name": "PreTaxCost", "function": "Sum" } }, + "granularity": "Daily", "grouping": [], "sorting": [ { - "direction": "Ascending", - "name": "UsageDate" + "name": "UsageDate", + "direction": "Ascending" } ] - } + }, + "timeframe": "MonthToDate" }, - "chart": "Table", + "scope": "" + } + } + }, + "201": { + "body": { + "name": "swaggerExample", + "type": "Microsoft.CostManagement/Views", + "eTag": "\"1d4ffa5a9c2430c\"", + "id": "/providers/Microsoft.CostManagement/views/swaggerExample", + "properties": { "accumulated": "true", - "metric": "ActualCost", + "chart": "Table", + "displayName": "swagger Example", "kpis": [ { "type": "Forecast", - "id": null, - "enabled": true + "enabled": true, + "id": null }, { "type": "Budget", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Consumption/budgets/swaggerDemo", - "enabled": true + "enabled": true, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Consumption/budgets/swaggerDemo" } ], + "metric": "ActualCost", "pivots": [ { - "type": "Dimension", - "name": "ServiceName" + "name": "ServiceName", + "type": "Dimension" }, { - "type": "Dimension", - "name": "MeterCategory" + "name": "MeterCategory", + "type": "Dimension" }, { - "type": "TagKey", - "name": "swaggerTagKey" + "name": "swaggerTagKey", + "type": "TagKey" } - ] + ], + "query": { + "type": "Usage", + "dataSet": { + "aggregation": { + "totalCost": { + "name": "PreTaxCost", + "function": "Sum" + } + }, + "granularity": "Daily", + "grouping": [], + "sorting": [ + { + "name": "UsageDate", + "direction": "Ascending" + } + ] + }, + "timeframe": "MonthToDate" + }, + "scope": "" } } } - } + }, + "operationId": "Views_CreateOrUpdate", + "title": "CreateOrUpdatePrivateView" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/PrivateViewDelete.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/PrivateViewDelete.json index 58c6bb88ee3f..81ad15abaab5 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/PrivateViewDelete.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/PrivateViewDelete.json @@ -6,5 +6,7 @@ "responses": { "200": {}, "204": {} - } + }, + "operationId": "Views_Delete", + "title": "DeletePrivateView" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/PrivateViewList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/PrivateViewList.json index d465b503ddfa..adce1dda4c87 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/PrivateViewList.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/PrivateViewList.json @@ -7,125 +7,127 @@ "body": { "value": [ { - "id": "/providers/Microsoft.CostManagement/views/swaggerExample", "name": "swaggerExample", "type": "Microsoft.CostManagement/Views", "eTag": "\"1d4ff9fe66f1d10\"", + "id": "/providers/Microsoft.CostManagement/views/swaggerExample", "properties": { - "displayName": "swagger Example", - "scope": "", - "query": { - "type": "Usage", - "timeframe": "MonthToDate", - "dataSet": { - "granularity": "Daily", - "aggregation": { - "totalCost": { - "name": "PreTaxCost", - "function": "Sum" - } - }, - "grouping": [], - "sorting": [ - { - "direction": "Ascending", - "name": "UsageDate" - } - ] - } - }, - "chart": "Table", "accumulated": "true", - "metric": "ActualCost", + "chart": "Table", + "displayName": "swagger Example", "kpis": [ { "type": "Forecast", - "id": null, - "enabled": true + "enabled": true, + "id": null }, { "type": "Budget", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Consumption/budgets/swaggerDemo", - "enabled": true + "enabled": true, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Consumption/budgets/swaggerDemo" } ], + "metric": "ActualCost", "pivots": [ { - "type": "Dimension", - "name": "ServiceName" + "name": "ServiceName", + "type": "Dimension" }, { - "type": "Dimension", - "name": "MeterCategory" + "name": "MeterCategory", + "type": "Dimension" }, { - "type": "TagKey", - "name": "swaggerTagKey" + "name": "swaggerTagKey", + "type": "TagKey" } - ] - } - }, - { - "id": "/providers/Microsoft.CostManagement/views/swaggerExample2", - "name": "swaggerExample2", - "type": "Microsoft.CostManagement/Views", - "eTag": "\"1d4ffa5a9c2430c\"", - "properties": { - "displayName": "swagger Example 2", - "scope": "", + ], "query": { "type": "Usage", - "timeframe": "LastMonthToDate", "dataSet": { - "granularity": "Daily", "aggregation": { "totalCost": { "name": "PreTaxCost", "function": "Sum" } }, + "granularity": "Daily", "grouping": [], "sorting": [ { - "direction": "Ascending", - "name": "UsageDate" + "name": "UsageDate", + "direction": "Ascending" } ] - } + }, + "timeframe": "MonthToDate" }, - "chart": "GroupedColumn", + "scope": "" + } + }, + { + "name": "swaggerExample2", + "type": "Microsoft.CostManagement/Views", + "eTag": "\"1d4ffa5a9c2430c\"", + "id": "/providers/Microsoft.CostManagement/views/swaggerExample2", + "properties": { "accumulated": "true", - "metric": "ActualCost", + "chart": "GroupedColumn", + "displayName": "swagger Example 2", "kpis": [ { "type": "Forecast", - "id": null, - "enabled": true + "enabled": true, + "id": null }, { "type": "Budget", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Consumption/budgets/swaggerDemo", - "enabled": true + "enabled": true, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Consumption/budgets/swaggerDemo" } ], + "metric": "ActualCost", "pivots": [ { - "type": "Dimension", - "name": "ServiceName" + "name": "ServiceName", + "type": "Dimension" }, { - "type": "Dimension", - "name": "MeterCategory" + "name": "MeterCategory", + "type": "Dimension" }, { - "type": "TagKey", - "name": "swaggerTagKey" + "name": "swaggerTagKey", + "type": "TagKey" } - ] + ], + "query": { + "type": "Usage", + "dataSet": { + "aggregation": { + "totalCost": { + "name": "PreTaxCost", + "function": "Sum" + } + }, + "granularity": "Daily", + "grouping": [], + "sorting": [ + { + "name": "UsageDate", + "direction": "Ascending" + } + ] + }, + "timeframe": "LastMonthToDate" + }, + "scope": "" } } ] } } - } + }, + "operationId": "Views_List", + "title": "PrivateViewList" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ResourceGroupAlerts.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ResourceGroupAlerts.json index b9c0ebdc139b..bc87167a4c52 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ResourceGroupAlerts.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ResourceGroupAlerts.json @@ -1,99 +1,101 @@ { "parameters": { "api-version": "2025-03-01", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "ScreenSharingTest-peer", - "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ScreenSharingTest-peer" + "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ScreenSharingTest-peer", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { + "nextLink": null, "value": [ { - "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ScreenSharingTest-peer/providers/Microsoft.CostManagement/alerts/00000000-0000-0000-0000-000000000000", "name": "00000000-0000-0000-0000-000000000000", "type": "Microsoft.CostManagement/alerts", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ScreenSharingTest-peer/providers/Microsoft.CostManagement/alerts/00000000-0000-0000-0000-000000000000", "properties": { + "description": "", + "closeTime": "0001-01-01T00:00:00", + "costEntityId": "budget1", + "creationTime": "2020-04-27T11:07:52.7143901Z", "definition": { "type": "Budget", "category": "Cost", "criteria": "CostThresholdExceeded" }, - "description": "", + "modificationTime": "2020-04-28T11:06:02.8999373Z", "source": "Preset", + "status": "Active", + "statusModificationTime": "0001-01-01T00:00:00", + "statusModificationUserName": null, "details": { - "timeGrainType": "Quarterly", - "periodStartDate": "2020-03-01T00:00:00Z", - "triggeredBy": "00000000-0000-0000-0000-000000000000_1_01", - "resourceGroupFilter": [], - "resourceFilter": [], - "meterFilter": [], - "tagFilter": {}, - "threshold": 0.8, - "operator": "GreaterThan", - "amount": 200000.0, - "unit": "USD", - "currentSpend": 161000.12, + "amount": 200000, "contactEmails": [ "1234@contoso.com" ], "contactGroups": [], "contactRoles": [], - "overridingAlert": null - }, - "costEntityId": "budget1", - "status": "Active", - "creationTime": "2020-04-27T11:07:52.7143901Z", - "closeTime": "0001-01-01T00:00:00", - "modificationTime": "2020-04-28T11:06:02.8999373Z", - "statusModificationUserName": null, - "statusModificationTime": "0001-01-01T00:00:00" + "currentSpend": 161000.12, + "meterFilter": [], + "operator": "GreaterThan", + "overridingAlert": null, + "periodStartDate": "2020-03-01T00:00:00Z", + "resourceFilter": [], + "resourceGroupFilter": [], + "tagFilter": {}, + "threshold": 0.8, + "timeGrainType": "Quarterly", + "triggeredBy": "00000000-0000-0000-0000-000000000000_1_01", + "unit": "USD" + } } }, { - "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ScreenSharingTest-peer/providers/Microsoft.CostManagement/alerts/11111111-1111-1111-111111111111", "name": "11111111-1111-1111-111111111111", "type": "Microsoft.CostManagement/alerts", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ScreenSharingTest-peer/providers/Microsoft.CostManagement/alerts/11111111-1111-1111-111111111111", "properties": { + "description": "", + "closeTime": "0001-01-01T00:00:00", + "costEntityId": "budget1", + "creationTime": "2019-06-24T05:51:52.8713179Z", "definition": { "type": "Budget", "category": "Cost", "criteria": "CostThresholdExceeded" }, - "description": "", + "modificationTime": "2019-08-31T17:51:55.1808807Z", "source": "Preset", + "status": "Active", + "statusModificationTime": "0001-01-01T00:00:00", + "statusModificationUserName": null, "details": { - "timeGrainType": "Quarterly", - "periodStartDate": "2020-03-01T00:00:00Z", - "triggeredBy": "11111111-1111-1111-111111111111_1_01", - "resourceGroupFilter": [], - "resourceFilter": [], - "meterFilter": [], - "tagFilter": {}, - "threshold": 0.8, - "operator": "GreaterThan", - "amount": 200000.0, - "unit": "USD", - "currentSpend": 171000.32, + "amount": 200000, "contactEmails": [ "1234@contoso.com" ], "contactGroups": [], "contactRoles": [], - "overridingAlert": null - }, - "costEntityId": "budget1", - "status": "Active", - "creationTime": "2019-06-24T05:51:52.8713179Z", - "closeTime": "0001-01-01T00:00:00", - "modificationTime": "2019-08-31T17:51:55.1808807Z", - "statusModificationUserName": null, - "statusModificationTime": "0001-01-01T00:00:00" + "currentSpend": 171000.32, + "meterFilter": [], + "operator": "GreaterThan", + "overridingAlert": null, + "periodStartDate": "2020-03-01T00:00:00Z", + "resourceFilter": [], + "resourceGroupFilter": [], + "tagFilter": {}, + "threshold": 0.8, + "timeGrainType": "Quarterly", + "triggeredBy": "11111111-1111-1111-111111111111_1_01", + "unit": "USD" + } } } - ], - "nextLink": null + ] } } - } + }, + "operationId": "Alerts_List", + "title": "ResourceGroupAlerts" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ResourceGroupDimensionsList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ResourceGroupDimensionsList.json index 1df053d5508a..f3429a873503 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ResourceGroupDimensionsList.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ResourceGroupDimensionsList.json @@ -1,38 +1,40 @@ { "parameters": { - "api-version": "2025-03-01", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "system.orlando", "$expand": "properties/data", "$top": 5, - "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/system.orlando" + "api-version": "2025-03-01", + "resourceGroupName": "system.orlando", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/system.orlando", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { "value": [ { - "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/system.orlando/providers/microsoft.CostManagement/dimensions_ResourceType_2018-05-01_2018-05-31_5", "name": "dimensions_ResourceType_2018-05-01_2018-05-31_5", "type": "microsoft.CostManagement/dimensions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/system.orlando/providers/microsoft.CostManagement/dimensions_ResourceType_2018-05-01_2018-05-31_5", "properties": { + "description": "Resource type", + "category": "ResourceType", "data": [ "microsoft.storage/storageaccounts" ], + "filterEnabled": true, + "groupingEnabled": true, "total": 1, - "category": "ResourceType", - "usageStart": "2018-05-01T00:00:00-07:00", "usageEnd": "2018-05-31T00:00:00-07:00", - "description": "Resource type", - "filterEnabled": true, - "groupingEnabled": true + "usageStart": "2018-05-01T00:00:00-07:00" } }, { - "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/system.orlando/providers/microsoft.CostManagement/dimensions_ResourceId_2018-05-01_2018-05-31_5", "name": "dimensions_ResourceId_2018-05-01_2018-05-31_5", "type": "microsoft.CostManagement/dimensions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/system.orlando/providers/microsoft.CostManagement/dimensions_ResourceId_2018-05-01_2018-05-31_5", "properties": { + "description": "Resource Id", + "category": "ResourceId", "data": [ "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/system.orlando/providers/microsoft.storage/storageaccounts/authprod", "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/system.orlando/providers/microsoft.storage/storageaccounts/systemevents", @@ -40,18 +42,18 @@ "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/system.orlando/providers/microsoft.storage/storageaccounts/srphytenaccount", "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/system.orlando/providers/microsoft.storage/storageaccounts/publicsystemportal" ], + "filterEnabled": true, + "groupingEnabled": true, "total": 27, - "category": "ResourceId", - "usageStart": "2018-05-01T00:00:00-07:00", "usageEnd": "2018-05-31T00:00:00-07:00", - "description": "Resource Id", - "filterEnabled": true, - "groupingEnabled": true + "usageStart": "2018-05-01T00:00:00-07:00" } } ] } }, "204": {} - } + }, + "operationId": "Dimensions_List", + "title": "ResourceGroupDimensionsList-Legacy" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ResourceGroupForecast.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ResourceGroupForecast.json index 39e866165d23..e14c8a8dfe61 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ResourceGroupForecast.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ResourceGroupForecast.json @@ -1,18 +1,9 @@ { "parameters": { "api-version": "2025-03-01", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "ScreenSharingTest-peer", - "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ScreenSharingTest-peer", "parameters": { "type": "Usage", - "timeframe": "Custom", - "timePeriod": { - "from": "2022-08-01T00:00:00+00:00", - "to": "2022-08-31T23:59:59+00:00" - }, "dataset": { - "granularity": "Daily", "aggregation": { "totalCost": { "name": "Cost", @@ -55,20 +46,28 @@ } } ] - } + }, + "granularity": "Daily" }, "includeActualCost": false, - "includeFreshPartialCost": false - } + "includeFreshPartialCost": false, + "timePeriod": { + "from": "2022-08-01T00:00:00+00:00", + "to": "2022-08-31T23:59:59+00:00" + }, + "timeframe": "Custom" + }, + "resourceGroupName": "ScreenSharingTest-peer", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ScreenSharingTest-peer", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { - "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ScreenSharingTest-peer/providers/Microsoft.CostManagement/query/00000000-0000-0000-0000-000000000000", "name": "55312978-ba1b-415c-9304-cfd9c43c0481", "type": "Microsoft.CostManagement/query", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ScreenSharingTest-peer/providers/Microsoft.CostManagement/query/00000000-0000-0000-0000-000000000000", "properties": { - "nextLink": null, "columns": [ { "name": "PreTaxCost", @@ -87,6 +86,7 @@ "type": "String" } ], + "nextLink": null, "rows": [ [ 2.10333307059661, @@ -99,5 +99,7 @@ } }, "204": {} - } + }, + "operationId": "Forecast_Usage", + "title": "ResourceGroupForecast" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ResourceGroupQuery.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ResourceGroupQuery.json index 18f194b1f0b5..0afe919888f0 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ResourceGroupQuery.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ResourceGroupQuery.json @@ -1,14 +1,9 @@ { "parameters": { "api-version": "2025-03-01", - "subscriptionId": "55312978-ba1b-415c-9304-c4b9c43c0481", - "resourceGroupName": "ScreenSharingTest-peer", - "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ScreenSharingTest-peer", "parameters": { "type": "Usage", - "timeframe": "MonthToDate", "dataset": { - "granularity": "Daily", "filter": { "and": [ { @@ -45,18 +40,22 @@ } } ] - } - } - } + }, + "granularity": "Daily" + }, + "timeframe": "MonthToDate" + }, + "resourceGroupName": "ScreenSharingTest-peer", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ScreenSharingTest-peer", + "subscriptionId": "55312978-ba1b-415c-9304-c4b9c43c0481" }, "responses": { "200": { "body": { - "id": "subscriptions/55312978-ba1b-415c-9304-c4b9c43c0481/resourcegroups/ScreenSharingTest-peer/providers/Microsoft.CostManagement/Query/9af9459d-441d-4055-9ed0-83d4c4a363fb", "name": "9af9459d-441d-4055-9ed0-83d4c4a363fb", "type": "microsoft.costmanagement/Query", + "id": "/subscriptions/55312978-ba1b-415c-9304-c4b9c43c0481/resourcegroups/ScreenSharingTest-peer/providers/Microsoft.CostManagement/Query/9af9459d-441d-4055-9ed0-83d4c4a363fb", "properties": { - "nextLink": null, "columns": [ { "name": "PreTaxCost", @@ -75,6 +74,7 @@ "type": "String" } ], + "nextLink": null, "rows": [ [ 2.10333307059661, @@ -93,5 +93,7 @@ } }, "204": {} - } + }, + "operationId": "Query_Usage", + "title": "ResourceGroupQuery-Legacy" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ResourceGroupQueryGrouping.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ResourceGroupQueryGrouping.json index 171f6773c4c0..c7e3a47659d1 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ResourceGroupQueryGrouping.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ResourceGroupQueryGrouping.json @@ -1,37 +1,36 @@ { "parameters": { "api-version": "2025-03-01", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "ScreenSharingTest-peer", - "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ScreenSharingTest-peer", "parameters": { "type": "Usage", - "timeframe": "TheLastMonth", "dataset": { - "granularity": "Daily", "aggregation": { "totalCost": { "name": "PreTaxCost", "function": "Sum" } }, + "granularity": "Daily", "grouping": [ { - "type": "Dimension", - "name": "ResourceType" + "name": "ResourceType", + "type": "Dimension" } ] - } - } + }, + "timeframe": "TheLastMonth" + }, + "resourceGroupName": "ScreenSharingTest-peer", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ScreenSharingTest-peer", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { - "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/ScreenSharingTest-peer/providers/Microsoft.CostManagement/Query/9af9459d-441d-4055-9ed0-83d4c4a363fb", "name": "9af9459d-441d-4055-9ed0-83d4c4a363fb", "type": "microsoft.costmanagement/Query", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/ScreenSharingTest-peer/providers/Microsoft.CostManagement/Query/9af9459d-441d-4055-9ed0-83d4c4a363fb", "properties": { - "nextLink": null, "columns": [ { "name": "PreTaxCost", @@ -50,6 +49,7 @@ "type": "String" } ], + "nextLink": null, "rows": [ [ 2.10333307059661, @@ -68,5 +68,7 @@ } }, "204": {} - } + }, + "operationId": "Query_Usage", + "title": "ResourceGroupQueryGrouping-Legacy" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/SingleResourceGroupAlert.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/SingleResourceGroupAlert.json index d1ee39c4b283..b54eb542ddf7 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/SingleResourceGroupAlert.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/SingleResourceGroupAlert.json @@ -1,54 +1,56 @@ { "parameters": { + "alertId": "22222222-2222-2222-2222-222222222222", "api-version": "2025-03-01", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "ScreenSharingTest-peer", "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ScreenSharingTest-peer", - "alertId": "22222222-2222-2222-2222-222222222222" + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { - "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ScreenSharingTest-peer/providers/Microsoft.CostManagement/alerts/22222222-2222-2222-2222-222222222222", "name": "22222222-2222-2222-2222-222222222222", "type": "Microsoft.CostManagement/alerts", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ScreenSharingTest-peer/providers/Microsoft.CostManagement/alerts/22222222-2222-2222-2222-222222222222", "properties": { + "description": "", + "closeTime": "0001-01-01T00:00:00", + "costEntityId": "budget1", + "creationTime": "2020-04-27T11:07:52.7143901Z", "definition": { "type": "Budget", "category": "Cost", "criteria": "CostThresholdExceeded" }, - "description": "", + "modificationTime": "2020-04-28T11:06:02.8999373Z", "source": "Preset", + "status": "Active", + "statusModificationTime": "0001-01-01T00:00:00", + "statusModificationUserName": null, "details": { - "timeGrainType": "Quarterly", - "periodStartDate": "2020-03-01T00:00:00Z", - "triggeredBy": "22222222-2222-2222-2222-222222222222_1_01", - "resourceGroupFilter": [], - "resourceFilter": [], - "meterFilter": [], - "tagFilter": {}, - "threshold": 0.8, - "operator": "GreaterThan", - "amount": 200000.0, - "unit": "USD", - "currentSpend": 161000.12, + "amount": 200000, "contactEmails": [ "1234@contoso.com" ], "contactGroups": [], "contactRoles": [], - "overridingAlert": null - }, - "costEntityId": "budget1", - "status": "Active", - "creationTime": "2020-04-27T11:07:52.7143901Z", - "closeTime": "0001-01-01T00:00:00", - "modificationTime": "2020-04-28T11:06:02.8999373Z", - "statusModificationUserName": null, - "statusModificationTime": "0001-01-01T00:00:00" + "currentSpend": 161000.12, + "meterFilter": [], + "operator": "GreaterThan", + "overridingAlert": null, + "periodStartDate": "2020-03-01T00:00:00Z", + "resourceFilter": [], + "resourceGroupFilter": [], + "tagFilter": {}, + "threshold": 0.8, + "timeGrainType": "Quarterly", + "triggeredBy": "22222222-2222-2222-2222-222222222222_1_01", + "unit": "USD" + } } } } - } + }, + "operationId": "Alerts_Get", + "title": "SingleResourceGroupAlerts" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/SingleSubscriptionAlert.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/SingleSubscriptionAlert.json index 35abf1617271..2980a69ecb27 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/SingleSubscriptionAlert.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/SingleSubscriptionAlert.json @@ -1,53 +1,55 @@ { "parameters": { + "alertId": "22222222-2222-2222-2222-222222222222", "api-version": "2025-03-01", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "scope": "subscriptions/00000000-0000-0000-0000-000000000000", - "alertId": "22222222-2222-2222-2222-222222222222" + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { - "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/alerts/22222222-2222-2222-2222-222222222222", "name": "22222222-2222-2222-2222-222222222222", "type": "Microsoft.CostManagement/alerts", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/alerts/22222222-2222-2222-2222-222222222222", "properties": { + "description": "", + "closeTime": "0001-01-01T00:00:00", + "costEntityId": "budget1", + "creationTime": "2020-04-27T11:07:52.7143901Z", "definition": { "type": "Budget", "category": "Cost", "criteria": "CostThresholdExceeded" }, - "description": "", + "modificationTime": "2020-04-28T11:06:02.8999373Z", "source": "Preset", + "status": "Active", + "statusModificationTime": "0001-01-01T00:00:00", + "statusModificationUserName": null, "details": { - "timeGrainType": "Quarterly", - "periodStartDate": "2020-03-01T00:00:00Z", - "triggeredBy": "22222222-2222-2222-2222-222222222222_1_01", - "resourceGroupFilter": [], - "resourceFilter": [], - "meterFilter": [], - "tagFilter": {}, - "threshold": 0.8, - "operator": "GreaterThan", - "amount": 200000.0, - "unit": "USD", - "currentSpend": 161000.12, + "amount": 200000, "contactEmails": [ "1234@contoso.com" ], "contactGroups": [], "contactRoles": [], - "overridingAlert": null - }, - "costEntityId": "budget1", - "status": "Active", - "creationTime": "2020-04-27T11:07:52.7143901Z", - "closeTime": "0001-01-01T00:00:00", - "modificationTime": "2020-04-28T11:06:02.8999373Z", - "statusModificationUserName": null, - "statusModificationTime": "0001-01-01T00:00:00" + "currentSpend": 161000.12, + "meterFilter": [], + "operator": "GreaterThan", + "overridingAlert": null, + "periodStartDate": "2020-03-01T00:00:00Z", + "resourceFilter": [], + "resourceGroupFilter": [], + "tagFilter": {}, + "threshold": 0.8, + "timeGrainType": "Quarterly", + "triggeredBy": "22222222-2222-2222-2222-222222222222_1_01", + "unit": "USD" + } } } } - } + }, + "operationId": "Alerts_Get", + "title": "SingleSubscriptionAlerts" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/SubscriptionAlerts.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/SubscriptionAlerts.json index 8d2dd8f6a776..efa696816277 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/SubscriptionAlerts.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/SubscriptionAlerts.json @@ -1,98 +1,100 @@ { "parameters": { "api-version": "2025-03-01", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "scope": "subscriptions/00000000-0000-0000-0000-000000000000" + "scope": "subscriptions/00000000-0000-0000-0000-000000000000", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { + "nextLink": null, "value": [ { - "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/alerts/00000000-0000-0000-0000-000000000000", "name": "00000000-0000-0000-0000-000000000000", "type": "Microsoft.CostManagement/alerts", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/alerts/00000000-0000-0000-0000-000000000000", "properties": { + "description": "", + "closeTime": "0001-01-01T00:00:00", + "costEntityId": "budget1", + "creationTime": "2020-04-27T11:07:52.7143901Z", "definition": { "type": "Budget", "category": "Cost", "criteria": "CostThresholdExceeded" }, - "description": "", + "modificationTime": "2020-04-28T11:06:02.8999373Z", "source": "Preset", + "status": "Active", + "statusModificationTime": "0001-01-01T00:00:00", + "statusModificationUserName": null, "details": { - "timeGrainType": "Quarterly", - "periodStartDate": "2020-03-01T00:00:00Z", - "triggeredBy": "00000000-0000-0000-0000-000000000000_1_01", - "resourceGroupFilter": [], - "resourceFilter": [], - "meterFilter": [], - "tagFilter": {}, - "threshold": 0.8, - "operator": "GreaterThan", - "amount": 200000.0, - "unit": "USD", - "currentSpend": 161000.12, + "amount": 200000, "contactEmails": [ "1234@contoso.com" ], "contactGroups": [], "contactRoles": [], - "overridingAlert": null - }, - "costEntityId": "budget1", - "status": "Active", - "creationTime": "2020-04-27T11:07:52.7143901Z", - "closeTime": "0001-01-01T00:00:00", - "modificationTime": "2020-04-28T11:06:02.8999373Z", - "statusModificationUserName": null, - "statusModificationTime": "0001-01-01T00:00:00" + "currentSpend": 161000.12, + "meterFilter": [], + "operator": "GreaterThan", + "overridingAlert": null, + "periodStartDate": "2020-03-01T00:00:00Z", + "resourceFilter": [], + "resourceGroupFilter": [], + "tagFilter": {}, + "threshold": 0.8, + "timeGrainType": "Quarterly", + "triggeredBy": "00000000-0000-0000-0000-000000000000_1_01", + "unit": "USD" + } } }, { - "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/alerts/11111111-1111-1111-111111111111", "name": "11111111-1111-1111-111111111111", "type": "Microsoft.CostManagement/alerts", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/alerts/11111111-1111-1111-111111111111", "properties": { + "description": "", + "closeTime": "0001-01-01T00:00:00", + "costEntityId": "budget1", + "creationTime": "2019-06-24T05:51:52.8713179Z", "definition": { "type": "Budget", "category": "Cost", "criteria": "CostThresholdExceeded" }, - "description": "", + "modificationTime": "2019-08-31T17:51:55.1808807Z", "source": "Preset", + "status": "Active", + "statusModificationTime": "0001-01-01T00:00:00", + "statusModificationUserName": null, "details": { - "timeGrainType": "Quarterly", - "periodStartDate": "2020-03-01T00:00:00Z", - "triggeredBy": "11111111-1111-1111-111111111111_1_01", - "resourceGroupFilter": [], - "resourceFilter": [], - "meterFilter": [], - "tagFilter": {}, - "threshold": 0.8, - "operator": "GreaterThan", - "amount": 200000.0, - "unit": "USD", - "currentSpend": 171000.32, + "amount": 200000, "contactEmails": [ "1234@contoso.com" ], "contactGroups": [], "contactRoles": [], - "overridingAlert": null - }, - "costEntityId": "budget1", - "status": "Active", - "creationTime": "2019-06-24T05:51:52.8713179Z", - "closeTime": "0001-01-01T00:00:00", - "modificationTime": "2019-08-31T17:51:55.1808807Z", - "statusModificationUserName": null, - "statusModificationTime": "0001-01-01T00:00:00" + "currentSpend": 171000.32, + "meterFilter": [], + "operator": "GreaterThan", + "overridingAlert": null, + "periodStartDate": "2020-03-01T00:00:00Z", + "resourceFilter": [], + "resourceGroupFilter": [], + "tagFilter": {}, + "threshold": 0.8, + "timeGrainType": "Quarterly", + "triggeredBy": "11111111-1111-1111-111111111111_1_01", + "unit": "USD" + } } } - ], - "nextLink": null + ] } } - } + }, + "operationId": "Alerts_List", + "title": "SubscriptionAlerts" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/SubscriptionDimensionsList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/SubscriptionDimensionsList.json index 010d48058b37..766cce45284f 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/SubscriptionDimensionsList.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/SubscriptionDimensionsList.json @@ -1,20 +1,22 @@ { "parameters": { - "api-version": "2025-03-01", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "$top": 5, "$expand": "properties/data", - "scope": "subscriptions/00000000-0000-0000-0000-000000000000" + "$top": 5, + "api-version": "2025-03-01", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { "value": [ { - "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/dimensions_ResourceGroup_2018-05-01_2018-05-31_5", "name": "dimensions_ResourceGroup_2018-05-01_2018-05-31_5", "type": "microsoft.CostManagement/dimensions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/dimensions_ResourceGroup_2018-05-01_2018-05-31_5", "properties": { + "description": "Resource group", + "category": "ResourceGroup", "data": [ "dcrg", "rg", @@ -22,38 +24,38 @@ "system.orlando.adminkeyvault", "system.orlando.keyvault" ], + "filterEnabled": true, + "groupingEnabled": true, "total": 68, - "category": "ResourceGroup", - "usageStart": "2018-05-01T00:00:00-07:00", "usageEnd": "2018-05-31T00:00:00-07:00", - "description": "Resource group", - "filterEnabled": true, - "groupingEnabled": true + "usageStart": "2018-05-01T00:00:00-07:00" } }, { - "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/dimensions_ResourceType_2018-05-01_2018-05-31_5", "name": "dimensions_ResourceType_2018-05-01_2018-05-31_5", "type": "microsoft.CostManagement/dimensions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/dimensions_ResourceType_2018-05-01_2018-05-31_5", "properties": { + "description": "Resource type", + "category": "ResourceType", "data": [ "microsoft.storage/storageaccounts", "microsoft.web.admin/role", "microsoft.sql/servers", "microsoft.compute/virtualmachines" ], + "filterEnabled": true, + "groupingEnabled": true, "total": 4, - "category": "ResourceType", - "usageStart": "2018-05-01T00:00:00-07:00", "usageEnd": "2018-05-31T00:00:00-07:00", - "description": "Resource type", - "filterEnabled": true, - "groupingEnabled": true + "usageStart": "2018-05-01T00:00:00-07:00" } } ] } }, "204": {} - } + }, + "operationId": "Dimensions_List", + "title": "SubscriptionDimensionsList-Legacy" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/SubscriptionForecast.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/SubscriptionForecast.json index 55e916a5b402..2f8717565a64 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/SubscriptionForecast.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/SubscriptionForecast.json @@ -1,17 +1,9 @@ { "parameters": { "api-version": "2025-03-01", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "scope": "subscriptions/00000000-0000-0000-0000-000000000000", "parameters": { "type": "Usage", - "timeframe": "Custom", - "timePeriod": { - "from": "2022-08-01T00:00:00+00:00", - "to": "2022-08-31T23:59:59+00:00" - }, "dataset": { - "granularity": "Daily", "aggregation": { "totalCost": { "name": "Cost", @@ -54,20 +46,27 @@ } } ] - } + }, + "granularity": "Daily" }, "includeActualCost": false, - "includeFreshPartialCost": false - } + "includeFreshPartialCost": false, + "timePeriod": { + "from": "2022-08-01T00:00:00+00:00", + "to": "2022-08-31T23:59:59+00:00" + }, + "timeframe": "Custom" + }, + "scope": "subscriptions/00000000-0000-0000-0000-000000000000", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { - "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/query/00000000-0000-0000-0000-000000000000", "name": "55312978-ba1b-415c-9304-cfd9c43c0481", "type": "Microsoft.CostManagement/query", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/query/00000000-0000-0000-0000-000000000000", "properties": { - "nextLink": null, "columns": [ { "name": "PreTaxCost", @@ -86,6 +85,7 @@ "type": "String" } ], + "nextLink": null, "rows": [ [ 2.10333307059661, @@ -116,5 +116,7 @@ } }, "204": {} - } + }, + "operationId": "Forecast_Usage", + "title": "SubscriptionForecast" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/SubscriptionQuery.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/SubscriptionQuery.json index d33f4592d124..510b4ccacfe6 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/SubscriptionQuery.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/SubscriptionQuery.json @@ -1,13 +1,9 @@ { "parameters": { "api-version": "2025-03-01", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "scope": "subscriptions/00000000-0000-0000-0000-000000000000", "parameters": { "type": "Usage", - "timeframe": "MonthToDate", "dataset": { - "granularity": "Daily", "filter": { "and": [ { @@ -44,18 +40,21 @@ } } ] - } - } - } + }, + "granularity": "Daily" + }, + "timeframe": "MonthToDate" + }, + "scope": "subscriptions/00000000-0000-0000-0000-000000000000", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { - "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/Query/00000000-0000-0000-0000-000000000000", "name": "55312978-ba1b-415c-9304-cfd9c43c0481", "type": "microsoft.costmanagement/Query", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/Query/00000000-0000-0000-0000-000000000000", "properties": { - "nextLink": null, "columns": [ { "name": "PreTaxCost", @@ -74,6 +73,7 @@ "type": "String" } ], + "nextLink": null, "rows": [ [ 2.10333307059661, @@ -104,5 +104,7 @@ } }, "204": {} - } + }, + "operationId": "Query_Usage", + "title": "SubscriptionQuery-Legacy" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/SubscriptionQueryGrouping.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/SubscriptionQueryGrouping.json index cf1a794e9758..6b3672181d99 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/SubscriptionQueryGrouping.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/SubscriptionQueryGrouping.json @@ -1,36 +1,35 @@ { "parameters": { "api-version": "2025-03-01", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "scope": "subscriptions/00000000-0000-0000-0000-000000000000", "parameters": { "type": "Usage", - "timeframe": "TheLastMonth", "dataset": { - "granularity": "None", "aggregation": { "totalCost": { "name": "PreTaxCost", "function": "Sum" } }, + "granularity": "None", "grouping": [ { - "type": "Dimension", - "name": "ResourceGroup" + "name": "ResourceGroup", + "type": "Dimension" } ] - } - } + }, + "timeframe": "TheLastMonth" + }, + "scope": "subscriptions/00000000-0000-0000-0000-000000000000", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { - "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/Query/00000000-0000-0000-0000-000000000000", "name": "55312978-ba1b-415c-9304-cfd9c43c0481", "type": "microsoft.costmanagement/Query", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/Query/00000000-0000-0000-0000-000000000000", "properties": { - "nextLink": null, "columns": [ { "name": "PreTaxCost", @@ -45,6 +44,7 @@ "type": "String" } ], + "nextLink": null, "rows": [ [ 0.009865586851323632, @@ -71,5 +71,7 @@ } }, "204": {} - } + }, + "operationId": "Query_Usage", + "title": "SubscriptionQueryGrouping-Legacy" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ViewByResourceGroup.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ViewByResourceGroup.json index 429431fd64d0..a29498f439cc 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ViewByResourceGroup.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ViewByResourceGroup.json @@ -1,70 +1,72 @@ { "parameters": { "api-version": "2025-03-01", - "viewName": "swaggerExample", - "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG" + "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG", + "viewName": "swaggerExample" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/views/swaggerExample", "name": "swaggerExample", "type": "Microsoft.CostManagement/Views", "eTag": "\"1d4ff9fe66f1d10\"", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/views/swaggerExample", "properties": { - "displayName": "swagger Example", - "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG", - "query": { - "type": "Usage", - "timeframe": "MonthToDate", - "dataSet": { - "granularity": "Daily", - "aggregation": { - "totalCost": { - "name": "PreTaxCost", - "function": "Sum" - } - }, - "grouping": [], - "sorting": [ - { - "direction": "Ascending", - "name": "UsageDate" - } - ] - } - }, - "chart": "Table", "accumulated": "true", - "metric": "ActualCost", + "chart": "Table", + "displayName": "swagger Example", "kpis": [ { "type": "Forecast", - "id": null, - "enabled": true + "enabled": true, + "id": null }, { "type": "Budget", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Consumption/budgets/swaggerDemo", - "enabled": true + "enabled": true, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Consumption/budgets/swaggerDemo" } ], + "metric": "ActualCost", "pivots": [ { - "type": "Dimension", - "name": "ServiceName" + "name": "ServiceName", + "type": "Dimension" }, { - "type": "Dimension", - "name": "MeterCategory" + "name": "MeterCategory", + "type": "Dimension" }, { - "type": "TagKey", - "name": "swaggerTagKey" + "name": "swaggerTagKey", + "type": "TagKey" } - ] + ], + "query": { + "type": "Usage", + "dataSet": { + "aggregation": { + "totalCost": { + "name": "PreTaxCost", + "function": "Sum" + } + }, + "granularity": "Daily", + "grouping": [], + "sorting": [ + { + "name": "UsageDate", + "direction": "Ascending" + } + ] + }, + "timeframe": "MonthToDate" + }, + "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG" } } } - } + }, + "operationId": "Views_GetByScope", + "title": "ResourceGroupView" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ViewCreateOrUpdateByResourceGroup.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ViewCreateOrUpdateByResourceGroup.json index 5ce348e086a4..f4a025cb74f8 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ViewCreateOrUpdateByResourceGroup.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ViewCreateOrUpdateByResourceGroup.json @@ -1,186 +1,188 @@ { "parameters": { "api-version": "2025-03-01", - "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG", - "viewName": "swaggerExample", "parameters": { "eTag": "\"1d4ff9fe66f1d10\"", "properties": { - "displayName": "swagger Example", - "query": { - "type": "Usage", - "timeframe": "MonthToDate", - "dataSet": { - "granularity": "Daily", - "aggregation": { - "totalCost": { - "name": "PreTaxCost", - "function": "Sum" - } - }, - "grouping": [], - "sorting": [ - { - "direction": "Ascending", - "name": "UsageDate" - } - ] - } - }, - "chart": "Table", "accumulated": "true", - "metric": "ActualCost", + "chart": "Table", + "displayName": "swagger Example", "kpis": [ { "type": "Forecast", - "id": null, - "enabled": true + "enabled": true, + "id": null }, { "type": "Budget", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Consumption/budgets/swaggerDemo", - "enabled": true + "enabled": true, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Consumption/budgets/swaggerDemo" } ], + "metric": "ActualCost", "pivots": [ { - "type": "Dimension", - "name": "ServiceName" + "name": "ServiceName", + "type": "Dimension" }, { - "type": "Dimension", - "name": "MeterCategory" + "name": "MeterCategory", + "type": "Dimension" }, { - "type": "TagKey", - "name": "swaggerTagKey" + "name": "swaggerTagKey", + "type": "TagKey" } - ] + ], + "query": { + "type": "Usage", + "dataSet": { + "aggregation": { + "totalCost": { + "name": "PreTaxCost", + "function": "Sum" + } + }, + "granularity": "Daily", + "grouping": [], + "sorting": [ + { + "name": "UsageDate", + "direction": "Ascending" + } + ] + }, + "timeframe": "MonthToDate" + } } - } + }, + "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG", + "viewName": "swaggerExample" }, "responses": { - "201": { + "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/views/swaggerExample", "name": "swaggerExample", "type": "Microsoft.CostManagement/Views", "eTag": "\"1d4ffa5a9c2430c\"", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/views/swaggerExample", "properties": { - "displayName": "swagger Example", - "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG", - "query": { - "type": "Usage", - "timeframe": "MonthToDate", - "dataSet": { - "granularity": "Daily", - "aggregation": { - "totalCost": { - "name": "PreTaxCost", - "function": "Sum" - } - }, - "grouping": [], - "sorting": [ - { - "direction": "Ascending", - "name": "UsageDate" - } - ] - } - }, - "chart": "Table", "accumulated": "true", - "metric": "ActualCost", + "chart": "Table", + "displayName": "swagger Example", "kpis": [ { "type": "Forecast", - "id": null, - "enabled": true + "enabled": true, + "id": null }, { "type": "Budget", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Consumption/budgets/swaggerDemo", - "enabled": true + "enabled": true, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Consumption/budgets/swaggerDemo" } ], + "metric": "ActualCost", "pivots": [ { - "type": "Dimension", - "name": "ServiceName" + "name": "ServiceName", + "type": "Dimension" }, { - "type": "Dimension", - "name": "MeterCategory" + "name": "MeterCategory", + "type": "Dimension" }, { - "type": "TagKey", - "name": "swaggerTagKey" + "name": "swaggerTagKey", + "type": "TagKey" } - ] - } - } - }, - "200": { - "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/views/swaggerExample", - "name": "swaggerExample", - "type": "Microsoft.CostManagement/Views", - "eTag": "\"1d4ffa5a9c2430c\"", - "properties": { - "displayName": "swagger Example", - "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG", + ], "query": { "type": "Usage", - "timeframe": "MonthToDate", "dataSet": { - "granularity": "Daily", "aggregation": { "totalCost": { "name": "PreTaxCost", "function": "Sum" } }, + "granularity": "Daily", "grouping": [], "sorting": [ { - "direction": "Ascending", - "name": "UsageDate" + "name": "UsageDate", + "direction": "Ascending" } ] - } + }, + "timeframe": "MonthToDate" }, - "chart": "Table", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG" + } + } + }, + "201": { + "body": { + "name": "swaggerExample", + "type": "Microsoft.CostManagement/Views", + "eTag": "\"1d4ffa5a9c2430c\"", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/views/swaggerExample", + "properties": { "accumulated": "true", - "metric": "ActualCost", + "chart": "Table", + "displayName": "swagger Example", "kpis": [ { "type": "Forecast", - "id": null, - "enabled": true + "enabled": true, + "id": null }, { "type": "Budget", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Consumption/budgets/swaggerDemo", - "enabled": true + "enabled": true, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Consumption/budgets/swaggerDemo" } ], + "metric": "ActualCost", "pivots": [ { - "type": "Dimension", - "name": "ServiceName" + "name": "ServiceName", + "type": "Dimension" }, { - "type": "Dimension", - "name": "MeterCategory" + "name": "MeterCategory", + "type": "Dimension" }, { - "type": "TagKey", - "name": "swaggerTagKey" + "name": "swaggerTagKey", + "type": "TagKey" } - ] + ], + "query": { + "type": "Usage", + "dataSet": { + "aggregation": { + "totalCost": { + "name": "PreTaxCost", + "function": "Sum" + } + }, + "granularity": "Daily", + "grouping": [], + "sorting": [ + { + "name": "UsageDate", + "direction": "Ascending" + } + ] + }, + "timeframe": "MonthToDate" + }, + "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG" } } } - } + }, + "operationId": "Views_CreateOrUpdateByScope", + "title": "ResourceGroupCreateOrUpdateView" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ViewDeleteByResourceGroup.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ViewDeleteByResourceGroup.json index b5426ef72a43..d42216abe104 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ViewDeleteByResourceGroup.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ViewDeleteByResourceGroup.json @@ -7,5 +7,7 @@ "responses": { "200": {}, "204": {} - } + }, + "operationId": "Views_DeleteByScope", + "title": "ResourceGroupDeleteView" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ViewListByResourceGroup.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ViewListByResourceGroup.json index 037df9813038..083410a792a2 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ViewListByResourceGroup.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/ViewListByResourceGroup.json @@ -14,7 +14,7 @@ "eTag": "\"1d4ff9fe66f1d10\"", "properties": { "displayName": "swagger Example", - "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG", "query": { "type": "Usage", "timeframe": "MonthToDate", @@ -73,7 +73,7 @@ "eTag": "\"1d4ffa5a9c2430c\"", "properties": { "displayName": "swagger Example 2", - "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG", "query": { "type": "Usage", "timeframe": "LastMonthToDate", @@ -128,5 +128,7 @@ ] } } - } + }, + "operationId": "Views_ListByScope", + "title": "ResourceGroupViewList" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/scheduledActions/checkNameAvailability-private-scheduledAction.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/scheduledActions/checkNameAvailability-private-scheduledAction.json index 3754641aec04..595efbdd6fc3 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/scheduledActions/checkNameAvailability-private-scheduledAction.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/scheduledActions/checkNameAvailability-private-scheduledAction.json @@ -9,10 +9,12 @@ "responses": { "200": { "body": { + "message": "A private scheduled action with name 'testName' is already present. Please specify a differnt name.", "nameAvailable": false, - "reason": "AlreadyExists", - "message": "A private scheduled action with name 'testName' is already present. Please specify a differnt name." + "reason": "AlreadyExists" } } - } + }, + "operationId": "ScheduledActions_CheckNameAvailability", + "title": "ScheduledActionCheckNameAvailability" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/scheduledActions/checkNameAvailability-shared-scheduledAction.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/scheduledActions/checkNameAvailability-shared-scheduledAction.json index ca444bf75f90..0142bce2aa83 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/scheduledActions/checkNameAvailability-shared-scheduledAction.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/scheduledActions/checkNameAvailability-shared-scheduledAction.json @@ -1,11 +1,11 @@ { "parameters": { "api-version": "2025-03-01", - "scope": "subscriptions/00000000-0000-0000-0000-000000000000", "checkNameAvailabilityRequest": { "name": "testName", "type": "Microsoft.CostManagement/ScheduledActions" - } + }, + "scope": "subscriptions/00000000-0000-0000-0000-000000000000" }, "responses": { "200": { @@ -13,5 +13,7 @@ "nameAvailable": true } } - } + }, + "operationId": "ScheduledActions_CheckNameAvailabilityByScope", + "title": "ScheduledActionCheckNameAvailabilityByScope" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/scheduledActions/scheduledAction-createOrUpdate-private.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/scheduledActions/scheduledAction-createOrUpdate-private.json index b8266577c31e..8455b591e0fd 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/scheduledActions/scheduledAction-createOrUpdate-private.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/scheduledActions/scheduledAction-createOrUpdate-private.json @@ -1,31 +1,31 @@ { "parameters": { - "api-version": "2025-03-01", "name": "monthlyCostByResource", "If-Match": "", + "api-version": "2025-03-01", "scheduledAction": { "kind": "Email", "properties": { "displayName": "Monthly Cost By Resource", "notification": { + "subject": "Cost by resource this month", "to": [ "user@gmail.com", "team@gmail.com" - ], - "subject": "Cost by resource this month" + ] }, "schedule": { - "frequency": "Monthly", - "weeksOfMonth": [ - "First", - "Third" - ], "daysOfWeek": [ "Monday" ], + "endDate": "2021-06-19T22:21:51.1287144Z", + "frequency": "Monthly", "hourOfDay": 10, "startDate": "2020-06-19T22:21:51.1287144Z", - "endDate": "2021-06-19T22:21:51.1287144Z" + "weeksOfMonth": [ + "First", + "Third" + ] }, "status": "Enabled", "viewId": "/providers/Microsoft.CostManagement/views/swaggerExample" @@ -33,95 +33,97 @@ } }, "responses": { - "201": { + "200": { "body": { - "id": "providers/Microsoft.CostManagement/scheduledActions/monthlyCostByResource", "name": "monthlyCostByResource", "type": "Microsoft.CostManagement/ScheduledActions", - "kind": "Email", "eTag": "\"1d4ff9fe66f1d10\"", - "systemData": { - "createdBy": "testuser", - "createdByType": "User", - "createdAt": "2020-06-18T22:21:51.1287144Z", - "lastModifiedBy": "testuser", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-06-18T22:21:51.1287144Z" - }, + "id": "/providers/Microsoft.CostManagement/scheduledActions/monthlyCostByResource", + "kind": "Email", "properties": { "displayName": "Monthly Cost By Resource", "notification": { - "language": "fr", "regionalFormat": "fr", + "subject": "Cost by resource this month", "to": [ "user@gmail.com", "team@gmail.com" ], - "subject": "Cost by resource this month" + "language": "fr" }, "schedule": { - "frequency": "Monthly", - "weeksOfMonth": [ - "First", - "Third" - ], "daysOfWeek": [ "Monday" ], + "endDate": "2021-06-19T22:21:51.1287144Z", + "frequency": "Monthly", "hourOfDay": 10, "startDate": "2020-06-19T22:21:51.1287144Z", - "endDate": "2021-06-19T22:21:51.1287144Z" + "weeksOfMonth": [ + "First", + "Third" + ] }, "scope": "", "status": "Enabled", "viewId": "/providers/Microsoft.CostManagement/views/swaggerExample" + }, + "systemData": { + "createdAt": "2020-06-18T22:21:51.1287144Z", + "createdBy": "testuser", + "createdByType": "User", + "lastModifiedAt": "2020-06-19T22:21:51.1287144Z", + "lastModifiedBy": "testuser", + "lastModifiedByType": "User" } } }, - "200": { + "201": { "body": { - "id": "providers/Microsoft.CostManagement/scheduledActions/monthlyCostByResource", "name": "monthlyCostByResource", "type": "Microsoft.CostManagement/ScheduledActions", - "kind": "Email", "eTag": "\"1d4ff9fe66f1d10\"", - "systemData": { - "createdBy": "testuser", - "createdByType": "User", - "createdAt": "2020-06-18T22:21:51.1287144Z", - "lastModifiedBy": "testuser", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-06-19T22:21:51.1287144Z" - }, + "id": "/providers/Microsoft.CostManagement/scheduledActions/monthlyCostByResource", + "kind": "Email", "properties": { "displayName": "Monthly Cost By Resource", "notification": { - "language": "fr", "regionalFormat": "fr", + "subject": "Cost by resource this month", "to": [ "user@gmail.com", "team@gmail.com" ], - "subject": "Cost by resource this month" + "language": "fr" }, - "scope": "", - "status": "Enabled", "schedule": { - "frequency": "Monthly", - "weeksOfMonth": [ - "First", - "Third" - ], "daysOfWeek": [ "Monday" ], + "endDate": "2021-06-19T22:21:51.1287144Z", + "frequency": "Monthly", "hourOfDay": 10, "startDate": "2020-06-19T22:21:51.1287144Z", - "endDate": "2021-06-19T22:21:51.1287144Z" + "weeksOfMonth": [ + "First", + "Third" + ] }, + "scope": "", + "status": "Enabled", "viewId": "/providers/Microsoft.CostManagement/views/swaggerExample" + }, + "systemData": { + "createdAt": "2020-06-18T22:21:51.1287144Z", + "createdBy": "testuser", + "createdByType": "User", + "lastModifiedAt": "2020-06-18T22:21:51.1287144Z", + "lastModifiedBy": "testuser", + "lastModifiedByType": "User" } } } - } + }, + "operationId": "ScheduledActions_CreateOrUpdate", + "title": "CreateOrUpdatePrivateScheduledAction" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/scheduledActions/scheduledAction-createOrUpdate-shared.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/scheduledActions/scheduledAction-createOrUpdate-shared.json index 6a9a47eca15a..8907ec730eb2 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/scheduledActions/scheduledAction-createOrUpdate-shared.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/scheduledActions/scheduledAction-createOrUpdate-shared.json @@ -1,9 +1,8 @@ { "parameters": { - "api-version": "2025-03-01", - "scope": "subscriptions/00000000-0000-0000-0000-000000000000", "name": "monthlyCostByResource", "If-Match": "", + "api-version": "2025-03-01", "scheduledAction": { "kind": "Email", "properties": { @@ -14,121 +13,124 @@ ] }, "notification": { + "subject": "Cost by resource this month", "to": [ "user@gmail.com", "team@gmail.com" - ], - "subject": "Cost by resource this month" + ] }, "schedule": { - "frequency": "Monthly", - "weeksOfMonth": [ - "First", - "Third" - ], "daysOfWeek": [ "Monday" ], + "endDate": "2021-06-19T22:21:51.1287144Z", + "frequency": "Monthly", "hourOfDay": 10, "startDate": "2020-06-19T22:21:51.1287144Z", - "endDate": "2021-06-19T22:21:51.1287144Z" + "weeksOfMonth": [ + "First", + "Third" + ] }, "status": "Enabled", "viewId": "/providers/Microsoft.CostManagement/views/swaggerExample" } - } + }, + "scope": "subscriptions/00000000-0000-0000-0000-000000000000" }, "responses": { - "201": { + "200": { "body": { - "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/scheduledActions/monthlyCostByResource", "name": "monthlyCostByResource", "type": "Microsoft.CostManagement/ScheduledActions", - "kind": "Email", "eTag": "\"1d4ff9fe66f1d10\"", - "systemData": { - "createdBy": "testuser", - "createdByType": "User", - "createdAt": "2020-06-18T22:21:51.1287144Z", - "lastModifiedBy": "testuser", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-06-18T22:21:51.1287144Z" - }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/scheduledActions/monthlyCostByResource", + "kind": "Email", "properties": { "displayName": "Monthly Cost By Resource", - "fileDestination": { - "fileFormats": [ - "Csv" - ] - }, "notification": { + "subject": "Cost by resource this month", "to": [ "user@gmail.com", "team@gmail.com" - ], - "subject": "Cost by resource this month" + ] }, "schedule": { - "frequency": "Monthly", - "weeksOfMonth": [ - "First", - "Third" - ], "daysOfWeek": [ "Monday" ], + "endDate": "2021-06-19T22:21:51.1287144Z", + "frequency": "Monthly", "hourOfDay": 10, "startDate": "2020-06-19T22:21:51.1287144Z", - "endDate": "2021-06-19T22:21:51.1287144Z" + "weeksOfMonth": [ + "First", + "Third" + ] }, "scope": "subscriptions/00000000-0000-0000-0000-000000000000", "status": "Enabled", "viewId": "/providers/Microsoft.CostManagement/views/swaggerExample" + }, + "systemData": { + "createdAt": "2020-06-18T22:21:51.1287144Z", + "createdBy": "testuser", + "createdByType": "User", + "lastModifiedAt": "2020-06-19T22:21:51.1287144Z", + "lastModifiedBy": "testuser", + "lastModifiedByType": "User" } } }, - "200": { + "201": { "body": { - "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/scheduledActions/monthlyCostByResource", "name": "monthlyCostByResource", "type": "Microsoft.CostManagement/ScheduledActions", - "kind": "Email", "eTag": "\"1d4ff9fe66f1d10\"", - "systemData": { - "createdBy": "testuser", - "createdByType": "User", - "createdAt": "2020-06-18T22:21:51.1287144Z", - "lastModifiedBy": "testuser", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-06-19T22:21:51.1287144Z" - }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/scheduledActions/monthlyCostByResource", + "kind": "Email", "properties": { "displayName": "Monthly Cost By Resource", + "fileDestination": { + "fileFormats": [ + "Csv" + ] + }, "notification": { + "subject": "Cost by resource this month", "to": [ "user@gmail.com", "team@gmail.com" - ], - "subject": "Cost by resource this month" + ] }, - "scope": "subscriptions/00000000-0000-0000-0000-000000000000", "schedule": { - "frequency": "Monthly", - "weeksOfMonth": [ - "First", - "Third" - ], "daysOfWeek": [ "Monday" ], + "endDate": "2021-06-19T22:21:51.1287144Z", + "frequency": "Monthly", "hourOfDay": 10, "startDate": "2020-06-19T22:21:51.1287144Z", - "endDate": "2021-06-19T22:21:51.1287144Z" + "weeksOfMonth": [ + "First", + "Third" + ] }, + "scope": "subscriptions/00000000-0000-0000-0000-000000000000", "status": "Enabled", "viewId": "/providers/Microsoft.CostManagement/views/swaggerExample" + }, + "systemData": { + "createdAt": "2020-06-18T22:21:51.1287144Z", + "createdBy": "testuser", + "createdByType": "User", + "lastModifiedAt": "2020-06-18T22:21:51.1287144Z", + "lastModifiedBy": "testuser", + "lastModifiedByType": "User" } } } - } + }, + "operationId": "ScheduledActions_CreateOrUpdateByScope", + "title": "CreateOrUpdateScheduledActionByScope" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/scheduledActions/scheduledAction-delete-private.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/scheduledActions/scheduledAction-delete-private.json index 5ada2e954b01..8acaef929837 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/scheduledActions/scheduledAction-delete-private.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/scheduledActions/scheduledAction-delete-private.json @@ -1,10 +1,12 @@ { "parameters": { - "api-version": "2025-03-01", - "name": "monthlyCostByResource" + "name": "monthlyCostByResource", + "api-version": "2025-03-01" }, "responses": { "200": {}, "204": {} - } + }, + "operationId": "ScheduledActions_Delete", + "title": "PrivateScheduledActionDelete" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/scheduledActions/scheduledAction-delete-shared.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/scheduledActions/scheduledAction-delete-shared.json index f125e1178942..b58965e6b22f 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/scheduledActions/scheduledAction-delete-shared.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/scheduledActions/scheduledAction-delete-shared.json @@ -1,11 +1,13 @@ { "parameters": { + "name": "monthlyCostByResource", "api-version": "2025-03-01", - "scope": "subscriptions/00000000-0000-0000-0000-000000000000", - "name": "monthlyCostByResource" + "scope": "subscriptions/00000000-0000-0000-0000-000000000000" }, "responses": { "200": {}, "204": {} - } + }, + "operationId": "ScheduledActions_DeleteByScope", + "title": "ScheduledActionDeleteByScope" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/scheduledActions/scheduledAction-get-private.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/scheduledActions/scheduledAction-get-private.json index 85fdd6aa2e96..94e9bba45d45 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/scheduledActions/scheduledAction-get-private.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/scheduledActions/scheduledAction-get-private.json @@ -1,51 +1,53 @@ { "parameters": { - "api-version": "2025-03-01", - "name": "monthlyCostByResource" + "name": "monthlyCostByResource", + "api-version": "2025-03-01" }, "responses": { "200": { "body": { - "id": "providers/Microsoft.CostManagement/scheduledActions/monthlyCostByResource", "name": "monthlyCostByResource", "type": "Microsoft.CostManagement/ScheduledActions", - "kind": "Email", "eTag": "\"1d4ff9fe66f1d10\"", - "systemData": { - "createdBy": "testuser", - "createdByType": "User", - "createdAt": "2020-06-18T22:21:51.1287144Z", - "lastModifiedBy": "testuser", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-06-18T22:21:51.1287144Z" - }, + "id": "/providers/Microsoft.CostManagement/scheduledActions/monthlyCostByResource", + "kind": "Email", "properties": { "displayName": "Monthly Cost By Resource", - "scope": "", - "status": "Enabled", - "viewId": "/providers/Microsoft.CostManagement/views/swaggerExample", + "notification": { + "subject": "Cost by resource this month", + "to": [ + "user@gmail.com", + "team@gmail.com" + ] + }, "schedule": { - "frequency": "Monthly", - "weeksOfMonth": [ - "First", - "Third" - ], "daysOfWeek": [ "Monday" ], + "endDate": "2021-06-19T22:21:51.1287144Z", + "frequency": "Monthly", "hourOfDay": 10, "startDate": "2020-06-19T22:21:51.1287144Z", - "endDate": "2021-06-19T22:21:51.1287144Z" + "weeksOfMonth": [ + "First", + "Third" + ] }, - "notification": { - "to": [ - "user@gmail.com", - "team@gmail.com" - ], - "subject": "Cost by resource this month" - } + "scope": "", + "status": "Enabled", + "viewId": "/providers/Microsoft.CostManagement/views/swaggerExample" + }, + "systemData": { + "createdAt": "2020-06-18T22:21:51.1287144Z", + "createdBy": "testuser", + "createdByType": "User", + "lastModifiedAt": "2020-06-18T22:21:51.1287144Z", + "lastModifiedBy": "testuser", + "lastModifiedByType": "User" } } } - } + }, + "operationId": "ScheduledActions_Get", + "title": "PrivateScheduledAction" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/scheduledActions/scheduledAction-get-shared.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/scheduledActions/scheduledAction-get-shared.json index d7325eca45b4..f5247adf2375 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/scheduledActions/scheduledAction-get-shared.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/scheduledActions/scheduledAction-get-shared.json @@ -1,52 +1,54 @@ { "parameters": { + "name": "monthlyCostByResource", "api-version": "2025-03-01", - "scope": "subscriptions/00000000-0000-0000-0000-000000000000", - "name": "monthlyCostByResource" + "scope": "subscriptions/00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { - "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/scheduledActions/monthlyCostByResource", "name": "monthlyCostByResource", "type": "Microsoft.CostManagement/ScheduledActions", - "kind": "Email", "eTag": "\"1d4ff9fe66f1d10\"", - "systemData": { - "createdBy": "testuser", - "createdByType": "User", - "createdAt": "2020-06-18T22:21:51.1287144Z", - "lastModifiedBy": "testuser", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-06-18T22:21:51.1287144Z" - }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/scheduledActions/monthlyCostByResource", + "kind": "Email", "properties": { "displayName": "Monthly Cost By Resource", - "scope": "subscriptions/00000000-0000-0000-0000-000000000000", - "status": "Enabled", - "viewId": "/providers/Microsoft.CostManagement/views/swaggerExample", + "notification": { + "subject": "Cost by resource this month", + "to": [ + "user@gmail.com", + "team@gmail.com" + ] + }, "schedule": { - "frequency": "Monthly", - "weeksOfMonth": [ - "First", - "Third" - ], "daysOfWeek": [ "Monday" ], + "endDate": "2021-06-19T22:21:51.1287144Z", + "frequency": "Monthly", "hourOfDay": 10, "startDate": "2020-06-19T22:21:51.1287144Z", - "endDate": "2021-06-19T22:21:51.1287144Z" + "weeksOfMonth": [ + "First", + "Third" + ] }, - "notification": { - "to": [ - "user@gmail.com", - "team@gmail.com" - ], - "subject": "Cost by resource this month" - } + "scope": "subscriptions/00000000-0000-0000-0000-000000000000", + "status": "Enabled", + "viewId": "/providers/Microsoft.CostManagement/views/swaggerExample" + }, + "systemData": { + "createdAt": "2020-06-18T22:21:51.1287144Z", + "createdBy": "testuser", + "createdByType": "User", + "lastModifiedAt": "2020-06-18T22:21:51.1287144Z", + "lastModifiedBy": "testuser", + "lastModifiedByType": "User" } } } - } + }, + "operationId": "ScheduledActions_GetByScope", + "title": "ScheduledActionByScope" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/scheduledActions/scheduledAction-insightAlert-createOrUpdate-shared.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/scheduledActions/scheduledAction-insightAlert-createOrUpdate-shared.json index cf66b2f518d1..f39baba5ab1c 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/scheduledActions/scheduledAction-insightAlert-createOrUpdate-shared.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/scheduledActions/scheduledAction-insightAlert-createOrUpdate-shared.json @@ -1,106 +1,108 @@ { "parameters": { - "api-version": "2025-03-01", - "scope": "subscriptions/00000000-0000-0000-0000-000000000000", "name": "dailyAnomalyByResource", "If-Match": "", + "api-version": "2025-03-01", "scheduledAction": { "kind": "InsightAlert", "properties": { "displayName": "Daily anomaly by resource", "notification": { + "subject": "Cost anomaly detected in the resource", "to": [ "user@gmail.com", "team@gmail.com" - ], - "subject": "Cost anomaly detected in the resource" + ] }, "schedule": { + "endDate": "2021-06-19T22:21:51.1287144Z", "frequency": "Daily", - "startDate": "2020-06-19T22:21:51.1287144Z", - "endDate": "2021-06-19T22:21:51.1287144Z" + "startDate": "2020-06-19T22:21:51.1287144Z" }, "status": "Enabled", "viewId": "/providers/Microsoft.CostManagement/views/swaggerExample" } - } + }, + "scope": "subscriptions/00000000-0000-0000-0000-000000000000" }, "responses": { - "201": { + "200": { "body": { - "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/scheduledActions/dailyAnomalyByResource", "name": "dailyAnomalyByResource", "type": "Microsoft.CostManagement/ScheduledActions", - "kind": "InsightAlert", "eTag": "\"1d4ff9fe66f1d10\"", - "systemData": { - "createdBy": "testuser", - "createdByType": "User", - "createdAt": "2020-06-18T22:21:51.1287144Z", - "lastModifiedBy": "testuser", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-06-18T22:21:51.1287144Z" - }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/scheduledActions/dailyAnomalyByResource", + "kind": "InsightAlert", "properties": { "displayName": "Daily anomaly by resource", "fileDestination": { "fileFormats": [] }, "notification": { + "subject": "Cost anomaly detected in the resource", "to": [ "user@gmail.com", "team@gmail.com" - ], - "subject": "Cost anomaly detected in the resource" + ] }, "schedule": { + "endDate": "2021-06-19T22:21:51.1287144Z", "frequency": "Daily", - "startDate": "2020-06-19T22:21:51.1287144Z", - "endDate": "2021-06-19T22:21:51.1287144Z" + "startDate": "2020-06-19T22:21:51.1287144Z" }, "scope": "subscriptions/00000000-0000-0000-0000-000000000000", "status": "Enabled", "viewId": "/providers/Microsoft.CostManagement/views/swaggerExample" + }, + "systemData": { + "createdAt": "2020-06-18T22:21:51.1287144Z", + "createdBy": "testuser", + "createdByType": "User", + "lastModifiedAt": "2020-06-19T22:21:51.1287144Z", + "lastModifiedBy": "testuser", + "lastModifiedByType": "User" } } }, - "200": { + "201": { "body": { - "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/scheduledActions/dailyAnomalyByResource", "name": "dailyAnomalyByResource", "type": "Microsoft.CostManagement/ScheduledActions", - "kind": "InsightAlert", "eTag": "\"1d4ff9fe66f1d10\"", - "systemData": { - "createdBy": "testuser", - "createdByType": "User", - "createdAt": "2020-06-18T22:21:51.1287144Z", - "lastModifiedBy": "testuser", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-06-19T22:21:51.1287144Z" - }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/scheduledActions/dailyAnomalyByResource", + "kind": "InsightAlert", "properties": { "displayName": "Daily anomaly by resource", "fileDestination": { "fileFormats": [] }, "notification": { + "subject": "Cost anomaly detected in the resource", "to": [ "user@gmail.com", "team@gmail.com" - ], - "subject": "Cost anomaly detected in the resource" + ] }, - "scope": "subscriptions/00000000-0000-0000-0000-000000000000", "schedule": { + "endDate": "2021-06-19T22:21:51.1287144Z", "frequency": "Daily", - "startDate": "2020-06-19T22:21:51.1287144Z", - "endDate": "2021-06-19T22:21:51.1287144Z" + "startDate": "2020-06-19T22:21:51.1287144Z" }, + "scope": "subscriptions/00000000-0000-0000-0000-000000000000", "status": "Enabled", "viewId": "/providers/Microsoft.CostManagement/views/swaggerExample" + }, + "systemData": { + "createdAt": "2020-06-18T22:21:51.1287144Z", + "createdBy": "testuser", + "createdByType": "User", + "lastModifiedAt": "2020-06-18T22:21:51.1287144Z", + "lastModifiedBy": "testuser", + "lastModifiedByType": "User" } } } - } + }, + "operationId": "ScheduledActions_CreateOrUpdateByScope", + "title": "CreateOrUpdateInsightAlertScheduledActionByScope" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/scheduledActions/scheduledAction-sendNow-private.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/scheduledActions/scheduledAction-sendNow-private.json index 7abe73b7fb34..a323a9f881d8 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/scheduledActions/scheduledAction-sendNow-private.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/scheduledActions/scheduledAction-sendNow-private.json @@ -1,9 +1,11 @@ { "parameters": { - "api-version": "2025-03-01", - "name": "monthlyCostByResource" + "name": "monthlyCostByResource", + "api-version": "2025-03-01" }, "responses": { "200": {} - } + }, + "operationId": "ScheduledActions_Run", + "title": "ScheduledActionSendNow" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/scheduledActions/scheduledAction-sendNow-shared.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/scheduledActions/scheduledAction-sendNow-shared.json index 7dfaa731e58e..0bf9ac7dd58b 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/scheduledActions/scheduledAction-sendNow-shared.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/scheduledActions/scheduledAction-sendNow-shared.json @@ -1,10 +1,12 @@ { "parameters": { + "name": "monthlyCostByResource", "api-version": "2025-03-01", - "scope": "subscriptions/00000000-0000-0000-0000-000000000000", - "name": "monthlyCostByResource" + "scope": "subscriptions/00000000-0000-0000-0000-000000000000" }, "responses": { "200": {} - } + }, + "operationId": "ScheduledActions_RunByScope", + "title": "ScheduledActionRunByScope" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/scheduledActions/scheduledActions-list-private.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/scheduledActions/scheduledActions-list-private.json index 0498dd302cd1..5c5fc7996b77 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/scheduledActions/scheduledActions-list-private.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/scheduledActions/scheduledActions-list-private.json @@ -5,85 +5,87 @@ "responses": { "200": { "body": { + "nextLink": null, "value": [ { - "id": "providers/Microsoft.CostManagement/scheduledActions/monthlyCostByResource", "name": "monthlyCostByResource", "type": "Microsoft.CostManagement/ScheduledActions", - "kind": "Email", "eTag": "\"1d4ff9fe66f1d10\"", - "systemData": { - "createdBy": "testuser", - "createdByType": "User", - "createdAt": "2020-06-18T22:21:51.1287144Z", - "lastModifiedBy": "testuser", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-06-18T22:21:51.1287144Z" - }, + "id": "/providers/Microsoft.CostManagement/scheduledActions/monthlyCostByResource", + "kind": "Email", "properties": { "displayName": "Monthly Cost By Resource", - "scope": "", - "status": "Enabled", - "viewId": "/providers/Microsoft.CostManagement/views/swaggerExample", + "notification": { + "subject": "Cost by resource this month", + "to": [ + "user@gmail.com", + "team@gmail.com" + ] + }, "schedule": { - "frequency": "Monthly", - "weeksOfMonth": [ - "First", - "Third" - ], "daysOfWeek": [ "Monday" ], + "endDate": "2021-06-19T22:21:51.1287144Z", + "frequency": "Monthly", "hourOfDay": 10, "startDate": "2020-06-19T22:21:51.1287144Z", - "endDate": "2021-06-19T22:21:51.1287144Z" + "weeksOfMonth": [ + "First", + "Third" + ] }, - "notification": { - "to": [ - "user@gmail.com", - "team@gmail.com" - ], - "subject": "Cost by resource this month" - } + "scope": "", + "status": "Enabled", + "viewId": "/providers/Microsoft.CostManagement/views/swaggerExample" + }, + "systemData": { + "createdAt": "2020-06-18T22:21:51.1287144Z", + "createdBy": "testuser", + "createdByType": "User", + "lastModifiedAt": "2020-06-18T22:21:51.1287144Z", + "lastModifiedBy": "testuser", + "lastModifiedByType": "User" } }, { - "id": "providers/Microsoft.CostManagement/scheduledActions/dailyCostByResource", "name": "dailyCostByResource", "type": "Microsoft.CostManagement/ScheduledActions", - "kind": "Email", "eTag": "\"1d4ff9fe66f1d15\"", - "systemData": { - "createdBy": "testuser", - "createdByType": "User", - "createdAt": "2020-06-18T22:21:51.1287144Z", - "lastModifiedBy": "testuser", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-06-18T22:21:51.1287144Z" - }, + "id": "/providers/Microsoft.CostManagement/scheduledActions/dailyCostByResource", + "kind": "Email", "properties": { "displayName": "Daily Cost By Resource", - "scope": "", - "status": "Disabled", - "viewId": "/providers/Microsoft.CostManagement/views/swaggerExample", - "schedule": { - "frequency": "Daily", - "hourOfDay": 12, - "startDate": "2020-06-19T22:21:51.1287144Z", - "endDate": "2021-06-19T22:21:51.1287144Z" - }, "notification": { + "subject": "Daily Cost By Resource", "to": [ "user@gmail.com", "team@gmail.com" - ], - "subject": "Daily Cost By Resource" - } + ] + }, + "schedule": { + "endDate": "2021-06-19T22:21:51.1287144Z", + "frequency": "Daily", + "hourOfDay": 12, + "startDate": "2020-06-19T22:21:51.1287144Z" + }, + "scope": "", + "status": "Disabled", + "viewId": "/providers/Microsoft.CostManagement/views/swaggerExample" + }, + "systemData": { + "createdAt": "2020-06-18T22:21:51.1287144Z", + "createdBy": "testuser", + "createdByType": "User", + "lastModifiedAt": "2020-06-18T22:21:51.1287144Z", + "lastModifiedBy": "testuser", + "lastModifiedByType": "User" } } - ], - "nextLink": null + ] } } - } + }, + "operationId": "ScheduledActions_List", + "title": "PrivateScheduledActionsList" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/scheduledActions/scheduledActions-list-shared.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/scheduledActions/scheduledActions-list-shared.json index 82b9c3e16a43..33616467254a 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/scheduledActions/scheduledActions-list-shared.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/scheduledActions/scheduledActions-list-shared.json @@ -8,7 +8,7 @@ "body": { "value": [ { - "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/scheduledActions/monthlyCostByResource", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/scheduledActions/monthlyCostByResource", "name": "monthlyCostByResource", "type": "Microsoft.CostManagement/ScheduledActions", "kind": "Email", @@ -49,7 +49,7 @@ } }, { - "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/scheduledActions/dailyCostByResource", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/scheduledActions/dailyCostByResource", "name": "dailyCostByResource", "type": "Microsoft.CostManagement/ScheduledActions", "kind": "Email", @@ -86,5 +86,7 @@ "nextLink": null } } - } + }, + "operationId": "ScheduledActions_ListByScope", + "title": "ScheduledActionsListByScope" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/scheduledActions/scheduledActions-listWithFilter-private.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/scheduledActions/scheduledActions-listWithFilter-private.json index 7f21f3057345..00bd7ca2e9c8 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/scheduledActions/scheduledActions-listWithFilter-private.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/scheduledActions/scheduledActions-listWithFilter-private.json @@ -1,90 +1,92 @@ { "parameters": { - "api-version": "2025-03-01", - "$filter": "properties/viewId eq '/providers/Microsoft.CostManagement/views/swaggerExample'" + "$filter": "properties/viewId eq '/providers/Microsoft.CostManagement/views/swaggerExample'", + "api-version": "2025-03-01" }, "responses": { "200": { "body": { + "nextLink": null, "value": [ { - "id": "providers/Microsoft.CostManagement/scheduledActions/monthlyCostByResource", "name": "monthlyCostByResource", "type": "Microsoft.CostManagement/ScheduledActions", - "kind": "Email", "eTag": "\"1d4ff9fe66f1d10\"", - "systemData": { - "createdBy": "testuser", - "createdByType": "User", - "createdAt": "2020-06-18T22:21:51.1287144Z", - "lastModifiedBy": "testuser", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-06-18T22:21:51.1287144Z" - }, + "id": "/providers/Microsoft.CostManagement/scheduledActions/monthlyCostByResource", + "kind": "Email", "properties": { "displayName": "Monthly Cost By Resource", - "scope": "", - "status": "Enabled", - "viewId": "/providers/Microsoft.CostManagement/views/swaggerExample", + "notification": { + "subject": "Cost by resource this month", + "to": [ + "user@gmail.com", + "team@gmail.com" + ] + }, "schedule": { - "frequency": "Monthly", - "weeksOfMonth": [ - "First", - "Third" - ], "daysOfWeek": [ "Monday" ], + "endDate": "2021-06-19T22:21:51.1287144Z", + "frequency": "Monthly", "hourOfDay": 10, "startDate": "2020-06-19T22:21:51.1287144Z", - "endDate": "2021-06-19T22:21:51.1287144Z" + "weeksOfMonth": [ + "First", + "Third" + ] }, - "notification": { - "to": [ - "user@gmail.com", - "team@gmail.com" - ], - "subject": "Cost by resource this month" - } + "scope": "", + "status": "Enabled", + "viewId": "/providers/Microsoft.CostManagement/views/swaggerExample" + }, + "systemData": { + "createdAt": "2020-06-18T22:21:51.1287144Z", + "createdBy": "testuser", + "createdByType": "User", + "lastModifiedAt": "2020-06-18T22:21:51.1287144Z", + "lastModifiedBy": "testuser", + "lastModifiedByType": "User" } }, { - "id": "providers/Microsoft.CostManagement/scheduledActions/dailyCostByResource", "name": "dailyCostByResource", "type": "Microsoft.CostManagement/ScheduledActions", - "kind": "Email", "eTag": "\"1d4ff9fe66f1d15\"", - "systemData": { - "createdBy": "testuser", - "createdByType": "User", - "createdAt": "2020-06-18T22:21:51.1287144Z", - "lastModifiedBy": "testuser", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-06-18T22:21:51.1287144Z" - }, + "id": "/providers/Microsoft.CostManagement/scheduledActions/dailyCostByResource", + "kind": "Email", "properties": { "displayName": "Daily Cost By Resource", - "scope": "", - "status": "Disabled", - "viewId": "/providers/Microsoft.CostManagement/views/swaggerExample", - "schedule": { - "frequency": "Daily", - "hourOfDay": 12, - "startDate": "2020-06-19T22:21:51.1287144Z", - "endDate": "2021-06-19T22:21:51.1287144Z" - }, "notification": { + "subject": "Daily Cost By Resource", "to": [ "user@gmail.com", "team@gmail.com" - ], - "subject": "Daily Cost By Resource" - } + ] + }, + "schedule": { + "endDate": "2021-06-19T22:21:51.1287144Z", + "frequency": "Daily", + "hourOfDay": 12, + "startDate": "2020-06-19T22:21:51.1287144Z" + }, + "scope": "", + "status": "Disabled", + "viewId": "/providers/Microsoft.CostManagement/views/swaggerExample" + }, + "systemData": { + "createdAt": "2020-06-18T22:21:51.1287144Z", + "createdBy": "testuser", + "createdByType": "User", + "lastModifiedAt": "2020-06-18T22:21:51.1287144Z", + "lastModifiedBy": "testuser", + "lastModifiedByType": "User" } } - ], - "nextLink": null + ] } } - } + }, + "operationId": "ScheduledActions_List", + "title": "PrivateScheduledActionsListFilterByViewId" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/scheduledActions/scheduledActions-listWithFilter-shared.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/scheduledActions/scheduledActions-listWithFilter-shared.json index 8c1045bc3c55..e13be2c9ffa8 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/scheduledActions/scheduledActions-listWithFilter-shared.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/scheduledActions/scheduledActions-listWithFilter-shared.json @@ -9,7 +9,7 @@ "body": { "value": [ { - "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/scheduledActions/monthlyCostByResource", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/scheduledActions/monthlyCostByResource", "name": "monthlyCostByResource", "type": "Microsoft.CostManagement/ScheduledActions", "kind": "Email", @@ -50,7 +50,7 @@ } }, { - "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/scheduledActions/dailyCostByResource", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/scheduledActions/dailyCostByResource", "name": "dailyCostByResource", "type": "Microsoft.CostManagement/ScheduledActions", "kind": "Email", @@ -87,5 +87,7 @@ "nextLink": null } } - } + }, + "operationId": "ScheduledActions_ListByScope", + "title": "ScheduledActionsListByScopeFilterByViewId" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/setting-delete.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/setting-delete.json index 1bb8a6b7ba81..58ed1b269af9 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/setting-delete.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/setting-delete.json @@ -1,11 +1,13 @@ { "parameters": { + "type": "taginheritance", "api-version": "2025-03-01", - "scope": "subscriptions/00000000-0000-0000-0000-000000000000", - "type": "taginheritance" + "scope": "subscriptions/00000000-0000-0000-0000-000000000000" }, "responses": { "200": {}, "204": {} - } + }, + "operationId": "Settings_DeleteByScope", + "title": "SettingDeleteByScope" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/setting-get.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/setting-get.json index 9269e475e015..e4cea79dd5fe 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/setting-get.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/setting-get.json @@ -1,20 +1,22 @@ { "parameters": { + "type": "taginheritance", "api-version": "2025-03-01", - "scope": "subscriptions/00000000-0000-0000-0000-000000000000", - "type": "taginheritance" + "scope": "subscriptions/00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/settings/taginheritance", "name": "taginheritance", "type": "Microsoft.CostManagement/Settings", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/settings/taginheritance", "kind": "taginheritance", "properties": { "preferContainerTags": false } } } - } + }, + "operationId": "Settings_GetByScope", + "title": "SettingByScope" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/settings-createOrUpdate.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/settings-createOrUpdate.json index 35b8910f58aa..e2ed25e1f11b 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/settings-createOrUpdate.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/settings-createOrUpdate.json @@ -1,8 +1,8 @@ { "parameters": { + "type": "taginheritance", "api-version": "2025-03-01", "scope": "subscriptions/00000000-0000-0000-0000-000000000000", - "type": "taginheritance", "setting": { "kind": "taginheritance", "properties": { @@ -11,27 +11,29 @@ } }, "responses": { - "201": { + "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/settings/taginheritance", "name": "taginheritance", "type": "Microsoft.CostManagement/Settings", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/settings/taginheritance", "kind": "taginheritance", "properties": { "preferContainerTags": false } } }, - "200": { + "201": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/settings/taginheritance", "name": "taginheritance", "type": "Microsoft.CostManagement/Settings", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/settings/taginheritance", "kind": "taginheritance", "properties": { "preferContainerTags": false } } } - } + }, + "operationId": "Settings_CreateOrUpdateByScope", + "title": "CreateOrUpdateSettingByScope" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/settingsList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/settingsList.json index 79513f5bc54b..f59ce3fd2377 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/settingsList.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/examples/settingsList.json @@ -8,9 +8,9 @@ "body": { "value": [ { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/settings/taginheritance", "name": "taginheritance", "type": "Microsoft.CostManagement/Settings", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/settings/taginheritance", "kind": "taginheritance", "properties": { "preferContainerTags": false @@ -19,5 +19,7 @@ ] } } - } + }, + "operationId": "Settings_List", + "title": "SettingsList" } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/openapi.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/openapi.json new file mode 100644 index 000000000000..763770106da9 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/openapi.json @@ -0,0 +1,10541 @@ +{ + "swagger": "2.0", + "info": { + "title": "CostManagementClient", + "version": "2025-03-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": "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" + } + }, + "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.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 + } + } + }, + "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 + } + } + }, + "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" + ], + "x-ms-enum": { + "name": "Scope", + "modelAsString": true, + "values": [ + { + "name": "Single", + "value": "Single", + "description": "Single scope recommendation." + }, + { + "name": "Shared", + "value": "Shared", + "description": "Shared 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." + } + }, + "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." + } + } + }, + "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": {} +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/scheduledActions.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/scheduledActions.json deleted file mode 100644 index 90ec9b4e74bd..000000000000 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/scheduledActions.json +++ /dev/null @@ -1,932 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "CostManagementClient", - "version": "2025-03-01" - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ], - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Azure Active Directory OAuth2 Flow.", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "paths": { - "/providers/Microsoft.CostManagement/scheduledActions": { - "get": { - "tags": [ - "ScheduledActions" - ], - "operationId": "ScheduledActions_List", - "description": "List all private scheduled actions.", - "externalDocs": { - "url": "https://docs.microsoft.com/rest/api/cost-management/" - }, - "x-ms-examples": { - "PrivateScheduledActionsList": { - "$ref": "./examples/scheduledActions/scheduledActions-list-private.json" - }, - "PrivateScheduledActionsListFilterByViewId": { - "$ref": "./examples/scheduledActions/scheduledActions-listWithFilter-private.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "name": "$filter", - "description": "May be used to filter scheduled actions by properties/viewId. Supported operator is 'eq'.", - "in": "query", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "OK. The request has succeeded.", - "schema": { - "$ref": "#/definitions/ScheduledActionListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "common-types.json#/definitions/ErrorResponseWithNestedDetails" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/{scope}/providers/Microsoft.CostManagement/scheduledActions": { - "get": { - "tags": [ - "ScheduledActions" - ], - "operationId": "ScheduledActions_ListByScope", - "description": "List all shared scheduled actions within the given scope.", - "externalDocs": { - "url": "https://docs.microsoft.com/rest/api/cost-management/" - }, - "x-ms-examples": { - "ScheduledActionsListByScope": { - "$ref": "./examples/scheduledActions/scheduledActions-list-shared.json" - }, - "ScheduledActionsListByScopeFilterByViewId": { - "$ref": "./examples/scheduledActions/scheduledActions-listWithFilter-shared.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/scopeParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "name": "$filter", - "description": "May be used to filter scheduled actions by properties/viewId. Supported operator is 'eq'.", - "in": "query", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "OK. The request has succeeded.", - "schema": { - "$ref": "#/definitions/ScheduledActionListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "common-types.json#/definitions/ErrorResponseWithNestedDetails" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/providers/Microsoft.CostManagement/scheduledActions/{name}": { - "put": { - "tags": [ - "ScheduledActions" - ], - "operationId": "ScheduledActions_CreateOrUpdate", - "description": "Create or update a private scheduled action.", - "x-ms-examples": { - "CreateOrUpdatePrivateScheduledAction": { - "$ref": "./examples/scheduledActions/scheduledAction-createOrUpdate-private.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/scheduledActionNameParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "name": "scheduledAction", - "description": "Scheduled action to be created or updated.", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ScheduledAction" - } - }, - { - "$ref": "#/parameters/IfMatchOptionalParameter" - } - ], - "responses": { - "200": { - "description": "OK. The request has succeeded.", - "schema": { - "$ref": "#/definitions/ScheduledAction" - } - }, - "201": { - "description": "Created.", - "schema": { - "$ref": "#/definitions/ScheduledAction" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "common-types.json#/definitions/ErrorResponseWithNestedDetails" - } - } - } - }, - "get": { - "tags": [ - "ScheduledActions" - ], - "operationId": "ScheduledActions_Get", - "description": "Get the private scheduled action by name.", - "externalDocs": { - "url": "https://docs.microsoft.com/rest/api/cost-management/" - }, - "x-ms-examples": { - "PrivateScheduledAction": { - "$ref": "./examples/scheduledActions/scheduledAction-get-private.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/scheduledActionNameParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK. The request has succeeded.", - "schema": { - "$ref": "#/definitions/ScheduledAction" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "common-types.json#/definitions/ErrorResponseWithNestedDetails" - } - } - } - }, - "delete": { - "tags": [ - "ScheduledActions" - ], - "operationId": "ScheduledActions_Delete", - "description": "Delete a private scheduled action.", - "externalDocs": { - "url": "https://docs.microsoft.com/rest/api/cost-management/" - }, - "x-ms-examples": { - "PrivateScheduledActionDelete": { - "$ref": "./examples/scheduledActions/scheduledAction-delete-private.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/scheduledActionNameParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK. The request has succeeded." - }, - "204": { - "description": "NoContent. Resource is not available." - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "common-types.json#/definitions/ErrorResponseWithNestedDetails" - } - } - } - } - }, - "/{scope}/providers/Microsoft.CostManagement/scheduledActions/{name}": { - "put": { - "tags": [ - "ScheduledActions" - ], - "operationId": "ScheduledActions_CreateOrUpdateByScope", - "description": "Create or update a shared scheduled action within the given scope.", - "x-ms-examples": { - "CreateOrUpdateScheduledActionByScope": { - "$ref": "./examples/scheduledActions/scheduledAction-createOrUpdate-shared.json" - }, - "CreateOrUpdateInsightAlertScheduledActionByScope": { - "$ref": "./examples/scheduledActions/scheduledAction-insightAlert-createOrUpdate-shared.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/scopeParameter" - }, - { - "$ref": "#/parameters/scheduledActionNameParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "name": "scheduledAction", - "description": "Scheduled action to be created or updated.", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ScheduledAction" - } - }, - { - "$ref": "#/parameters/IfMatchOptionalParameter" - } - ], - "responses": { - "200": { - "description": "OK. The request has succeeded.", - "schema": { - "$ref": "#/definitions/ScheduledAction" - } - }, - "201": { - "description": "Created.", - "schema": { - "$ref": "#/definitions/ScheduledAction" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "common-types.json#/definitions/ErrorResponseWithNestedDetails" - } - } - } - }, - "get": { - "tags": [ - "ScheduledActions" - ], - "operationId": "ScheduledActions_GetByScope", - "description": "Get the shared scheduled action from the given scope by name.", - "externalDocs": { - "url": "https://docs.microsoft.com/rest/api/cost-management/" - }, - "x-ms-examples": { - "ScheduledActionByScope": { - "$ref": "./examples/scheduledActions/scheduledAction-get-shared.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/scopeParameter" - }, - { - "$ref": "#/parameters/scheduledActionNameParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK. The request has succeeded.", - "schema": { - "$ref": "#/definitions/ScheduledAction" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "common-types.json#/definitions/ErrorResponseWithNestedDetails" - } - } - } - }, - "delete": { - "tags": [ - "ScheduledActions" - ], - "operationId": "ScheduledActions_DeleteByScope", - "description": "Delete a scheduled action within the given scope.", - "externalDocs": { - "url": "https://docs.microsoft.com/rest/api/cost-management/" - }, - "x-ms-examples": { - "ScheduledActionDeleteByScope": { - "$ref": "./examples/scheduledActions/scheduledAction-delete-shared.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/scopeParameter" - }, - { - "$ref": "#/parameters/scheduledActionNameParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK. The request has succeeded." - }, - "204": { - "description": "NoContent. Resource is not available." - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "common-types.json#/definitions/ErrorResponseWithNestedDetails" - } - } - } - } - }, - "/providers/Microsoft.CostManagement/scheduledActions/{name}/execute": { - "post": { - "tags": [ - "ScheduledActions" - ], - "operationId": "ScheduledActions_Run", - "description": "Processes a private scheduled action.", - "x-ms-examples": { - "ScheduledActionSendNow": { - "$ref": "./examples/scheduledActions/scheduledAction-sendNow-private.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/scheduledActionNameParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK. The request has succeeded. It might take up to an hour to receive the email." - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "common-types.json#/definitions/ErrorResponseWithNestedDetails" - } - } - } - } - }, - "/{scope}/providers/Microsoft.CostManagement/scheduledActions/{name}/execute": { - "post": { - "tags": [ - "ScheduledActions" - ], - "operationId": "ScheduledActions_RunByScope", - "description": "Runs a shared scheduled action within the given scope.", - "x-ms-examples": { - "ScheduledActionRunByScope": { - "$ref": "./examples/scheduledActions/scheduledAction-sendNow-shared.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/scopeParameter" - }, - { - "$ref": "#/parameters/scheduledActionNameParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK. The request has succeeded. It might take up to an hour to receive cost analysis information." - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "common-types.json#/definitions/ErrorResponseWithNestedDetails" - } - } - } - } - }, - "/providers/Microsoft.CostManagement/checkNameAvailability": { - "post": { - "tags": [ - "ScheduledActions" - ], - "operationId": "ScheduledActions_CheckNameAvailability", - "description": "Checks availability and correctness of the name for a scheduled action.", - "x-ms-examples": { - "ScheduledActionCheckNameAvailability": { - "$ref": "./examples/scheduledActions/checkNameAvailability-private-scheduledAction.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "name": "checkNameAvailabilityRequest", - "description": "Scheduled action to be created or updated.", - "in": "body", - "required": true, - "schema": { - "$ref": "../../../../../../common-types/resource-management/v2/types.json#/definitions/CheckNameAvailabilityRequest" - } - } - ], - "responses": { - "200": { - "description": "Response of scheduled action name availability.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v2/types.json#/definitions/CheckNameAvailabilityResponse" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "common-types.json#/definitions/ErrorResponseWithNestedDetails" - } - } - } - } - }, - "/{scope}/providers/Microsoft.CostManagement/checkNameAvailability": { - "post": { - "tags": [ - "ScheduledActions" - ], - "operationId": "ScheduledActions_CheckNameAvailabilityByScope", - "description": "Checks availability and correctness of the name for a scheduled action within the given scope.", - "x-ms-examples": { - "ScheduledActionCheckNameAvailabilityByScope": { - "$ref": "./examples/scheduledActions/checkNameAvailability-shared-scheduledAction.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/scopeParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "name": "checkNameAvailabilityRequest", - "description": "Scheduled action to be created or updated.", - "in": "body", - "required": true, - "schema": { - "$ref": "../../../../../../common-types/resource-management/v2/types.json#/definitions/CheckNameAvailabilityRequest" - } - } - ], - "responses": { - "200": { - "description": "Response of scheduled action name availability.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v2/types.json#/definitions/CheckNameAvailabilityResponse" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "common-types.json#/definitions/ErrorResponseWithNestedDetails" - } - } - } - } - } - }, - "definitions": { - "DaysOfWeek": { - "type": "string", - "description": "Days of Week.", - "enum": [ - "Monday", - "Tuesday", - "Wednesday", - "Thursday", - "Friday", - "Saturday", - "Sunday" - ], - "x-ms-enum": { - "name": "DaysOfWeek", - "modelAsString": true - } - }, - "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 - } - }, - "Language": { - "type": "string", - "description": "Language in which the email is localized, for ex: 'Fr'. When the specified language is not supported, email will be in english. The supported languages are cs (Czech), da (Danish), de (German), en (English), es (Spanish), fr (French), hu (Hungarian), id (Indonesian), it (Lithuanian), ja (Japanese), ko (Korean), nb (Norwegian Bokmål), nl (Dutch), pl (Polish), pt (Portuguese), ru (Russian), sv (Swedish), tr (Turkish), zh (Chinese) " - }, - "NotificationEmail": { - "type": "string", - "description": "Email address of the point of contact that should get the unsubscribe requests and notification emails." - }, - "NotificationProperties": { - "type": "object", - "description": "The properties of the scheduled action notification.", - "required": [ - "to", - "subject" - ], - "properties": { - "to": { - "description": "Array of email addresses.", - "type": "array", - "items": { - "type": "string", - "pattern": "^[A-Za-z0-9._%+-]+@(?:[A-Za-z0-9-]+\\.)+[A-Za-z]{2,}$" - }, - "minItems": 1, - "maxItems": 20 - }, - "language": { - "description": "Locale of the email.", - "$ref": "#/definitions/Language" - }, - "message": { - "description": "Optional message to be added in the email. Length is limited to 250 characters.", - "type": "string" - }, - "regionalFormat": { - "description": "Regional format used for formatting date/time and currency values in the email.", - "$ref": "#/definitions/RegionalFormat" - }, - "subject": { - "description": "Subject of the email. Length is limited to 70 characters.", - "type": "string" - } - } - }, - "RegionalFormat": { - "type": "string", - "description": "Language for formatting the date/time and currency values in the email. For ex: 'fr'. Defaulted to English, when the specified regional format is not supported. " - }, - "ScheduledActionProxyResource": { - "description": "The Resource model definition.", - "properties": { - "eTag": { - "type": "string", - "readOnly": true, - "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." - }, - "systemData": { - "$ref": "../../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", - "description": "Kind of the scheduled action." - } - }, - "allOf": [ - { - "$ref": "../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" - } - ], - "type": "object", - "x-ms-azure-resource": true - }, - "ScheduledAction": { - "description": "Scheduled action definition.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ScheduledActionProxyResource" - } - ], - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/ScheduledActionProperties", - "title": "Scheduled action properties" - } - } - }, - "ScheduledActionKind": { - "type": "string", - "description": "Kind of the scheduled action.", - "enum": [ - "Email", - "InsightAlert" - ], - "x-ms-enum": { - "name": "ScheduledActionKind", - "modelAsString": true, - "values": [ - { - "value": "Email", - "description": "Cost analysis data will be emailed.", - "name": "Email" - }, - { - "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.", - "name": "InsightAlert" - } - ] - } - }, - "ScheduledActionListResult": { - "description": "Scheduled actions list result. It contains a list of scheduled actions.", - "type": "object", - "properties": { - "value": { - "description": "The list of scheduled actions.", - "type": "array", - "readOnly": true, - "items": { - "$ref": "#/definitions/ScheduledAction" - } - }, - "nextLink": { - "description": "The link (url) to the next page of results.", - "type": "string", - "readOnly": true - } - } - }, - "ScheduledActionProperties": { - "type": "object", - "description": "The properties of the scheduled action.", - "required": [ - "displayName", - "notification", - "schedule", - "status", - "viewId" - ], - "properties": { - "displayName": { - "description": "Scheduled action name.", - "type": "string" - }, - "fileDestination": { - "description": "Destination format of the view data. This is optional.", - "$ref": "#/definitions/FileDestination" - }, - "notification": { - "description": "Notification properties based on scheduled action kind.", - "$ref": "#/definitions/NotificationProperties" - }, - "notificationEmail": { - "description": "Email address of the point of contact that should get the unsubscribe requests and notification emails.", - "$ref": "#/definitions/NotificationEmail" - }, - "schedule": { - "description": "Schedule of the scheduled action.", - "$ref": "#/definitions/ScheduleProperties" - }, - "scope": { - "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.", - "type": "string" - }, - "status": { - "$ref": "#/definitions/ScheduledActionStatus", - "description": "Status of the scheduled action." - }, - "viewId": { - "description": "Cost analysis viewId used for scheduled action. For example, '/providers/Microsoft.CostManagement/views/swaggerExample'", - "type": "string" - } - } - }, - "ScheduledActionStatus": { - "type": "string", - "description": "Status of the scheduled action.", - "enum": [ - "Enabled", - "Expired", - "Disabled" - ], - "x-ms-enum": { - "name": "ScheduledActionStatus", - "modelAsString": true, - "values": [ - { - "value": "Disabled", - "description": "Scheduled action is saved but will not be run.", - "name": "Disabled" - }, - { - "value": "Enabled", - "description": "Scheduled action is saved and will be run.", - "name": "Enabled" - }, - { - "value": "Expired", - "description": "Scheduled action is expired.", - "name": "Expired" - } - ] - } - }, - "ScheduleFrequency": { - "type": "string", - "description": "Frequency of the schedule.", - "enum": [ - "Daily", - "Weekly", - "Monthly" - ], - "x-ms-enum": { - "name": "ScheduleFrequency", - "modelAsString": true, - "values": [ - { - "value": "Daily", - "description": "Cost analysis data will be emailed every day.", - "name": "Daily" - }, - { - "value": "Weekly", - "description": "Cost analysis data will be emailed every week.", - "name": "Weekly" - }, - { - "value": "Monthly", - "description": "Cost analysis data will be emailed every month.", - "name": "Monthly" - } - ] - } - }, - "ScheduleProperties": { - "type": "object", - "description": "The properties of the schedule.", - "required": [ - "endDate", - "frequency", - "startDate" - ], - "properties": { - "frequency": { - "$ref": "#/definitions/ScheduleFrequency", - "description": "Frequency of the schedule." - }, - "hourOfDay": { - "type": "integer", - "description": "UTC time at which cost analysis data will be emailed.", - "format": "int32" - }, - "daysOfWeek": { - "description": "Day names in english on which cost analysis data will be emailed. This property is applicable when frequency is Weekly or Monthly.", - "type": "array", - "items": { - "$ref": "#/definitions/DaysOfWeek" - } - }, - "weeksOfMonth": { - "description": "Weeks in which cost analysis data will be emailed. This property is applicable when frequency is Monthly and used in combination with daysOfWeek.", - "type": "array", - "items": { - "$ref": "#/definitions/WeeksOfMonth" - } - }, - "dayOfMonth": { - "type": "integer", - "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.", - "format": "int32" - }, - "startDate": { - "description": "The start date and time of the scheduled action (UTC).", - "type": "string", - "format": "date-time" - }, - "endDate": { - "description": "The end date and time of the scheduled action (UTC).", - "type": "string", - "format": "date-time" - } - } - }, - "WeeksOfMonth": { - "type": "string", - "description": "Weeks of month.", - "enum": [ - "First", - "Second", - "Third", - "Fourth", - "Last" - ], - "x-ms-enum": { - "name": "WeeksOfMonth", - "modelAsString": true - } - } - }, - "parameters": { - "scopeParameter": { - "name": "scope", - "in": "path", - "required": true, - "type": "string", - "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.", - "x-ms-parameter-location": "method" - }, - "scheduledActionNameParameter": { - "name": "name", - "in": "path", - "description": "Scheduled action name.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "IfMatchOptionalParameter": { - "name": "If-Match", - "in": "header", - "required": false, - "description": "ETag of the Entity. Not required when creating an entity. Optional when updating an entity and can be specified to achieve optimistic concurrency.", - "type": "string", - "x-ms-parameter-location": "method" - } - } -} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/settings.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/settings.json deleted file mode 100644 index 3b2d721741cc..000000000000 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/stable/2025-03-01/settings.json +++ /dev/null @@ -1,316 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "CostManagementClient", - "version": "2025-03-01" - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ], - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Azure Active Directory OAuth2 Flow.", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "paths": { - "/{scope}/providers/Microsoft.CostManagement/settings": { - "get": { - "tags": [ - "Settings" - ], - "operationId": "Settings_List", - "description": "List all cost management settings in the requested scope.", - "externalDocs": { - "url": "https://docs.microsoft.com/rest/api/cost-management/" - }, - "x-ms-examples": { - "SettingsList": { - "$ref": "./examples/settingsList.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/scopeSettingParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK. The request has succeeded.", - "schema": { - "$ref": "#/definitions/SettingsListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "common-types.json#/definitions/ErrorResponse" - } - } - } - } - }, - "/{scope}/providers/Microsoft.CostManagement/settings/{type}": { - "put": { - "tags": [ - "Settings" - ], - "operationId": "Settings_CreateOrUpdateByScope", - "description": "Create or update a setting within the given scope.", - "x-ms-examples": { - "CreateOrUpdateSettingByScope": { - "$ref": "./examples/settings-createOrUpdate.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/scopeSettingParameter" - }, - { - "$ref": "#/parameters/settingTypeParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "name": "setting", - "description": "Setting to be created or updated.", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/Setting" - } - } - ], - "responses": { - "201": { - "description": "Setting Created.", - "schema": { - "$ref": "#/definitions/Setting" - } - }, - "200": { - "description": "Setting Updated.", - "schema": { - "$ref": "#/definitions/Setting" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "common-types.json#/definitions/ErrorResponse" - } - } - } - }, - "get": { - "tags": [ - "Settings" - ], - "operationId": "Settings_GetByScope", - "description": "Get the setting from the given scope by name.", - "externalDocs": { - "url": "https://docs.microsoft.com/rest/api/cost-management/" - }, - "x-ms-examples": { - "SettingByScope": { - "$ref": "./examples/setting-get.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/scopeSettingParameter" - }, - { - "$ref": "#/parameters/settingTypeParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/Setting" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "common-types.json#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "Settings" - ], - "operationId": "Settings_DeleteByScope", - "description": "Delete a setting within the given scope.", - "externalDocs": { - "url": "https://docs.microsoft.com/rest/api/cost-management/" - }, - "x-ms-examples": { - "SettingDeleteByScope": { - "$ref": "./examples/setting-delete.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/scopeSettingParameter" - }, - { - "$ref": "#/parameters/settingTypeParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Setting deleted successfully." - }, - "204": { - "description": "Setting is already deleted or not found." - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "common-types.json#/definitions/ErrorResponse" - } - } - } - } - } - }, - "definitions": { - "Setting": { - "description": "Setting definition.", - "discriminator": "kind", - "type": "object", - "x-ms-azure-resource": true, - "allOf": [ - { - "$ref": "../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" - } - ], - "properties": { - "kind": { - "type": "string", - "description": "Specifies the kind of settings.", - "enum": [ - "taginheritance" - ], - "x-ms-enum": { - "name": "SettingsKind", - "modelAsString": true - } - } - }, - "required": [ - "kind" - ] - }, - "TagInheritanceSetting": { - "description": "Tag Inheritance Setting definition.", - "type": "object", - "x-ms-discriminator-value": "taginheritance", - "allOf": [ - { - "$ref": "#/definitions/Setting" - } - ], - "properties": { - "properties": { - "$ref": "#/definitions/TagInheritanceProperties" - } - } - }, - "SettingsListResult": { - "description": "Setting list result. It contains a list of settings.", - "type": "object", - "properties": { - "value": { - "description": "The list of settings.", - "type": "array", - "readOnly": true, - "items": { - "$ref": "#/definitions/Setting" - }, - "x-ms-identifiers": [ - "id" - ] - } - } - }, - "TagInheritanceProperties": { - "type": "object", - "description": "The properties of the tag inheritance setting.", - "required": [ - "preferContainerTags" - ], - "properties": { - "preferContainerTags": { - "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).", - "type": "boolean" - } - } - } - }, - "parameters": { - "scopeSettingParameter": { - "name": "scope", - "in": "path", - "required": true, - "type": "string", - "description": "The scope associated with this setting. This includes 'subscriptions/{subscriptionId}' for subscription scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billing profile scope.", - "x-ms-parameter-location": "method" - }, - "settingTypeParameter": { - "name": "type", - "in": "path", - "description": "Setting type.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method", - "enum": [ - "taginheritance" - ], - "x-ms-enum": { - "name": "SettingType", - "modelAsString": true, - "values": [ - { - "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": "taginheritance" - } - ] - } - } - } -} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/suppressions.yaml b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/suppressions.yaml index cd87f9745b5b..ad7d8cb83598 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/suppressions.yaml +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/suppressions.yaml @@ -96,7 +96,4 @@ reason: Brownfield service not ready to migrate - tool: TypeSpecRequirement path: ./stable/2024-08-01/*.json - reason: Brownfield service not ready to migrate -- tool: TypeSpecRequirement - path: ./stable/2025-03-01/*.json reason: Brownfield service not ready to migrate \ No newline at end of file diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/tspconfig.yaml b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/tspconfig.yaml new file mode 100644 index 000000000000..24aa95b6e550 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/CostManagement/tspconfig.yaml @@ -0,0 +1,46 @@ +parameters: + "service-dir": + default: "sdk/costmanagement" +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + emitter-output-dir: "{project-root}" + azure-resource-provider-folder: "resource-manager" + output-file: "{version-status}/{version}/openapi.json" + arm-types-dir: "{project-root}/../../../../common-types/resource-management" + emit-lro-options: "all" + examples-dir: "{project-root}/examples" + "@azure-tools/typespec-python": + emitter-output-dir: "{output-dir}/{service-dir}/azure-mgmt-costmanagement" + namespace: "azure.mgmt.costmanagement" + generate-test: true + generate-sample: true + flavor: "azure" + "@azure-tools/typespec-java": + emitter-output-dir: "{output-dir}/{service-dir}/azure-resourcemanager-costmanagement" + namespace: "com.azure.resourcemanager.costmanagement" + service-name: "CostManagement" # human-readable service name, whitespace allowed + flavor: azure + use-object-for-unknown: true + "@azure-tools/typespec-ts": + service-dir: "sdk/cost-management" + emitter-output-dir: "{output-dir}/{service-dir}/arm-costmanagement" + is-modular-library: true + flavor: "azure" + experimental-extensible-enums: true + package-details: + name: "@azure/arm-costmanagement" + "@azure-tools/typespec-go": + service-dir: "sdk/resourcemanager/costmanagement" + emitter-output-dir: "{output-dir}/{service-dir}/armcostmanagement" + module: "github.com/Azure/azure-sdk-for-go/{service-dir}/armcostmanagement" + fix-const-stuttering: true + flavor: "azure" + generate-samples: true + generate-fakes: true + head-as-boolean: true + inject-spans: true +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager"