{ "swagger": "2.0", "info": { "title": "Billing benefits RP", "version": "2026-06-01", "description": "Azure Benefits RP let users create and manage benefits.", "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": "SavingsPlanOrderAliasModels" }, { "name": "SavingsPlanOrderModels" }, { "name": "SavingsPlanModels" }, { "name": "ReservationOrderAliasResponses" }, { "name": "Discounts" }, { "name": "Contributors" }, { "name": "Credits" }, { "name": "ConditionalCredits" }, { "name": "ConditionalCreditContributors" }, { "name": "Maccs" }, { "name": "CreditSources" }, { "name": "FreeServicesOperations" }, { "name": "CreditTransactions" }, { "name": "MaccTransactions" }, { "name": "ConditionalCreditTransactions" }, { "name": "SubscriptionCatalogGroupsOps" }, { "name": "BillingAccountCatalogGroupsOps" }, { "name": "BillingProfileCatalogGroupsOps" } ], "paths": { "/{scope}/providers/Microsoft.BillingBenefits/applicableConditionalCredits": { "get": { "operationId": "ConditionalCredits_ScopeList", "description": "List conditional credits that are applicable for a given scope. Currently supported scopes: billing accounts", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "name": "scope", "in": "path", "description": "The scope at which the benefits are listed.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ConditionalCreditList" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "ConditionalCreditScopeList": { "$ref": "./examples/ApplicableConditionalCreditList.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/{scope}/providers/Microsoft.BillingBenefits/applicableCredits": { "get": { "operationId": "Credits_ListApplicable", "description": "List applicable credits for the provided scope. Currently supported scopes: BillingAccountResourceId", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "name": "scope", "in": "path", "description": "The scope at which the benefits are listed.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/CreditsList" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "CreditSourcesListByCredit": { "$ref": "./examples/CreditListApplicableCredits.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/{scope}/providers/Microsoft.BillingBenefits/applicableDiscounts": { "get": { "operationId": "Discounts_ScopeList", "description": "List discounts that are applicable for a given scope. Currently supported scopes: billing accounts", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "name": "scope", "in": "path", "description": "The scope at which the benefits are listed.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/DiscountList" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "DiscountScopeList": { "$ref": "./examples/ApplicableDiscountsList.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/providers/Microsoft.BillingBenefits/catalogGroups": { "get": { "operationId": "BillingProfileCatalogGroupsOps_List", "tags": [ "BillingProfileCatalogGroupsOps" ], "description": "List catalog groups at the target scope.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The name of the billing account.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9_\\-\\.:]+$" }, { "name": "billingProfileName", "in": "path", "description": "The name of the billing profile.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9_\\-\\.]+$" }, { "$ref": "#/parameters/CatalogGroupsListParameters" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/CatalogGroupListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "BillingProfileCatalogGroupsList": { "$ref": "./examples/CatalogGroupsBillingProfileList.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/providers/Microsoft.BillingBenefits/catalogGroups/{catalogGroupName}": { "get": { "operationId": "BillingProfileCatalogGroupsOps_Get", "tags": [ "BillingProfileCatalogGroupsOps" ], "description": "Get a specific catalog group at the target scope.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The name of the billing account.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9_\\-\\.:]+$" }, { "name": "billingProfileName", "in": "path", "description": "The name of the billing profile.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9_\\-\\.]+$" }, { "name": "catalogGroupName", "in": "path", "description": "The name of the CatalogGroup", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9_\\-\\.]+$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/CatalogGroup" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "BillingProfileCatalogGroupsGet": { "$ref": "./examples/CatalogGroupsBillingProfileGet.json" } } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/providers/Microsoft.BillingBenefits/catalogGroups": { "get": { "operationId": "BillingAccountCatalogGroupsOps_List", "tags": [ "BillingAccountCatalogGroupsOps" ], "description": "List catalog groups at the target scope.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The name of the billing account.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9_\\-\\.:]+$" }, { "$ref": "#/parameters/CatalogGroupsListParameters" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/CatalogGroupListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "BillingAccountCatalogGroupsList": { "$ref": "./examples/CatalogGroupsBillingAccountList.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/providers/Microsoft.BillingBenefits/catalogGroups/{catalogGroupName}": { "get": { "operationId": "BillingAccountCatalogGroupsOps_Get", "tags": [ "BillingAccountCatalogGroupsOps" ], "description": "Get a specific catalog group at the target scope.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountName", "in": "path", "description": "The name of the billing account.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9_\\-\\.:]+$" }, { "name": "catalogGroupName", "in": "path", "description": "The name of the CatalogGroup", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9_\\-\\.]+$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/CatalogGroup" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "BillingAccountCatalogGroupsGet": { "$ref": "./examples/CatalogGroupsBillingAccountGet.json" } } } }, "/providers/Microsoft.BillingBenefits/listSellerResources": { "post": { "operationId": "SellerResource_List", "description": "List maccs by billing account", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "name": "body", "in": "body", "description": "The request body", "required": true, "schema": { "$ref": "#/definitions/SellerResourceListRequest" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "type": "array", "items": { "$ref": "#/definitions/Macc" } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "SellerViewContributors": { "$ref": "./examples/MaccSellerViewContributors.json" }, "SellerViewContributorsWithMilestones": { "$ref": "./examples/MaccSellerViewContributorsWithMilestones.json" }, "SellerViewContributorsWithMilestonesAndShortfall": { "$ref": "./examples/MaccSellerViewContributorsWithMilestonesAndShortfall.json" }, "SellerViewNoContributors": { "$ref": "./examples/MaccSellerViewNoContributors.json" }, "SellerViewWithMilestonesNoContributors": { "$ref": "./examples/MaccSellerViewWithMilestonesNoContributors.json" } } } }, "/providers/Microsoft.BillingBenefits/operations": { "get": { "operationId": "Operations_List", "tags": [ "Operations" ], "description": "List the operations for the provider", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/OperationListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "OperationsGet": { "$ref": "./examples/OperationsGet.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.BillingBenefits/reservationOrderAliases/{reservationOrderAliasName}": { "get": { "operationId": "ReservationOrderAlias_Get", "tags": [ "ReservationOrderAliasResponses" ], "description": "Get a reservation order alias.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "name": "reservationOrderAliasName", "in": "path", "description": "Name of the reservation order alias", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9_\\-\\.]+$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ReservationOrderAliasResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "ReservationOrderAliasGet": { "$ref": "./examples/ReservationOrderAliasGet.json" }, "ReservationOrderAliasGetWithRenewProperties": { "$ref": "./examples/ReservationOrderAliasGetWithRenewProperties.json" } } }, "put": { "operationId": "ReservationOrderAlias_Create", "tags": [ "ReservationOrderAliasResponses" ], "description": "Create a reservation order alias.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "name": "reservationOrderAliasName", "in": "path", "description": "Name of the reservation order alias", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9_\\-\\.]+$" }, { "name": "body", "in": "body", "description": "Request body for creating a reservation order alias", "required": true, "schema": { "$ref": "#/definitions/ReservationOrderAliasRequest" } } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/ReservationOrderAliasResponse" } }, "201": { "description": "Resource 'ReservationOrderAliasResponse' create operation succeeded", "schema": { "$ref": "#/definitions/ReservationOrderAliasResponse" }, "headers": { "Azure-AsyncOperation": { "type": "string", "description": "URL for checking the ongoing status of the operation." }, "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": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "ReservationOrderAliasCreate": { "$ref": "./examples/ReservationOrderAliasCreate.json" }, "ReservationOrderAliasCreateWithRenewProperties": { "$ref": "./examples/ReservationOrderAliasCreateWithRenewProperties.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation", "final-state-schema": "#/definitions/ReservationOrderAliasResponse" }, "x-ms-long-running-operation": true } }, "/providers/Microsoft.BillingBenefits/savingsPlanOrderAliases/{savingsPlanOrderAliasName}": { "get": { "operationId": "SavingsPlanOrderAlias_Get", "tags": [ "SavingsPlanOrderAliasModels" ], "description": "Get a savings plan.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "name": "savingsPlanOrderAliasName", "in": "path", "description": "Name of the savings plan order alias", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9_\\-\\.]+$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/SavingsPlanOrderAliasModel" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "SavingsPlanOrderAliasGet": { "$ref": "./examples/SavingsPlanOrderAliasGet.json" } } }, "put": { "operationId": "SavingsPlanOrderAlias_Create", "tags": [ "SavingsPlanOrderAliasModels" ], "description": "Create a savings plan. Learn more about permissions needed at https://go.microsoft.com/fwlink/?linkid=2215851", "externalDocs": { "url": "https://go.microsoft.com/fwlink/?linkid=2215851/" }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "name": "savingsPlanOrderAliasName", "in": "path", "description": "Name of the savings plan order alias", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9_\\-\\.]+$" }, { "name": "body", "in": "body", "description": "Request body for creating a savings plan order alias", "required": true, "schema": { "$ref": "#/definitions/SavingsPlanOrderAliasModel" } } ], "responses": { "200": { "description": "Resource 'SavingsPlanOrderAliasModel' update operation succeeded", "schema": { "$ref": "#/definitions/SavingsPlanOrderAliasModel" } }, "201": { "description": "Resource 'SavingsPlanOrderAliasModel' create operation succeeded", "schema": { "$ref": "#/definitions/SavingsPlanOrderAliasModel" }, "headers": { "Azure-AsyncOperation": { "type": "string", "description": "URL for checking the ongoing status of the operation." }, "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": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "SavingsPlanOrderAliasCreate": { "$ref": "./examples/SavingsPlanOrderAliasCreate.json" }, "SavingsPlanOrderAliasCreateSingleScope": { "$ref": "./examples/SavingsPlanOrderAliasCreateSingleScope.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation", "final-state-schema": "#/definitions/SavingsPlanOrderAliasModel" }, "x-ms-long-running-operation": true } }, "/providers/Microsoft.BillingBenefits/savingsPlanOrders": { "get": { "operationId": "SavingsPlanOrder_List", "tags": [ "SavingsPlanOrderModels" ], "description": "List all Savings plan orders.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/SavingsPlanOrderModelList" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "SavingsPlanOrderList": { "$ref": "./examples/SavingsPlanOrderList.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.BillingBenefits/savingsPlanOrders/{savingsPlanOrderId}": { "get": { "operationId": "SavingsPlanOrder_Get", "tags": [ "SavingsPlanOrderModels" ], "description": "Get a savings plan order.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "name": "savingsPlanOrderId", "in": "path", "description": "Order ID of the savings plan", "required": true, "type": "string" }, { "name": "$expand", "in": "query", "description": "May be used to expand the detail information of some properties.", "required": false, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/SavingsPlanOrderModel" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "SavingsPlanOrderGet": { "$ref": "./examples/SavingsPlanOrderGet.json" }, "SavingsPlanOrderWithExpandedPaymentsGet": { "$ref": "./examples/SavingsPlanOrderExpandedGet.json" } } } }, "/providers/Microsoft.BillingBenefits/savingsPlanOrders/{savingsPlanOrderId}/elevate": { "post": { "operationId": "SavingsPlanOrder_Elevate", "tags": [ "SavingsPlanOrderModels" ], "description": "Elevate as owner on savings plan order based on billing permissions.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "name": "savingsPlanOrderId", "in": "path", "description": "Order ID of the savings plan", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/RoleAssignmentEntity" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "SavingsPlanOrderElevate": { "$ref": "./examples/SavingsPlanOrderElevate.json" } } } }, "/providers/Microsoft.BillingBenefits/savingsPlanOrders/{savingsPlanOrderId}/savingsPlans": { "get": { "operationId": "SavingsPlan_List", "tags": [ "SavingsPlanModels" ], "description": "List savings plans in an order.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "name": "savingsPlanOrderId", "in": "path", "description": "Order ID of the savings plan", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/SavingsPlanModelList" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "SavingsPlansInOrderList": { "$ref": "./examples/SavingsPlansInOrderList.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.BillingBenefits/savingsPlanOrders/{savingsPlanOrderId}/savingsPlans/{savingsPlanId}": { "get": { "operationId": "SavingsPlan_Get", "tags": [ "SavingsPlanModels" ], "description": "Get savings plan.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "name": "savingsPlanOrderId", "in": "path", "description": "Order ID of the savings plan", "required": true, "type": "string" }, { "name": "savingsPlanId", "in": "path", "description": "ID of the savings plan", "required": true, "type": "string" }, { "name": "$expand", "in": "query", "description": "May be used to expand the detail information of some properties.", "required": false, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/SavingsPlanModel" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "SavingsPlanItemGet": { "$ref": "./examples/SavingsPlanItemGet.json" }, "SavingsPlanItemWithExpandedRenewPropertiesGet": { "$ref": "./examples/SavingsPlanItemExpandedGet.json" } } }, "patch": { "operationId": "SavingsPlan_Update", "tags": [ "SavingsPlanModels" ], "description": "Update savings plan.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "name": "savingsPlanOrderId", "in": "path", "description": "Order ID of the savings plan", "required": true, "type": "string" }, { "name": "savingsPlanId", "in": "path", "description": "ID of the savings plan", "required": true, "type": "string" }, { "name": "body", "in": "body", "description": "Request body for patching a savings plan order alias", "required": true, "schema": { "$ref": "#/definitions/SavingsPlanUpdateRequest" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/SavingsPlanModel" } }, "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." } } }, "404": { "description": "ARM not found response", "x-ms-error-response": true }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "SavingsPlanUpdate": { "$ref": "./examples/SavingsPlanUpdate.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/SavingsPlanModel" }, "x-ms-long-running-operation": true } }, "/providers/Microsoft.BillingBenefits/savingsPlanOrders/{savingsPlanOrderId}/savingsPlans/{savingsPlanId}/validate": { "post": { "operationId": "SavingsPlan_ValidateUpdate", "tags": [ "SavingsPlanModels" ], "description": "Validate savings plan patch.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "name": "savingsPlanOrderId", "in": "path", "description": "Order ID of the savings plan", "required": true, "type": "string" }, { "name": "savingsPlanId", "in": "path", "description": "ID of the savings plan", "required": true, "type": "string" }, { "name": "body", "in": "body", "description": "Request body for validating a savings plan patch request", "required": true, "schema": { "$ref": "#/definitions/SavingsPlanUpdateValidateRequest" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/SavingsPlanValidateResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "SavingsPlanValidateUpdate": { "$ref": "./examples/SavingsPlanValidateUpdate.json" } } } }, "/providers/Microsoft.BillingBenefits/savingsPlans": { "get": { "operationId": "SavingsPlan_ListAll", "description": "List savings plans.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "name": "$filter", "in": "query", "description": "May be used to filter by reservation properties. The filter supports 'eq', 'or', and 'and'. It does not currently support 'ne', 'gt', 'le', 'ge', or 'not'. Reservation properties include sku/name, properties/{appliedScopeType, archived, displayName, displayProvisioningState, effectiveDateTime, expiryDate, provisioningState, quantity, renew, reservedResourceType, term, userFriendlyAppliedScopeType, userFriendlyRenewState}", "required": false, "type": "string" }, { "name": "$orderby", "in": "query", "description": "May be used to sort order by reservation properties.", "required": false, "type": "string" }, { "name": "refreshSummary", "in": "query", "description": "To indicate whether to refresh the roll up counts of the savings plans group by provisioning states", "required": false, "type": "string" }, { "name": "$skiptoken", "in": "query", "description": "The number of savings plans to skip from the list before returning results", "required": false, "type": "number", "format": "float" }, { "name": "selectedState", "in": "query", "description": "The selected provisioning state", "required": false, "type": "string" }, { "name": "take", "in": "query", "description": "To number of savings plans to return", "required": false, "type": "number", "format": "float" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/SavingsPlanModelListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "SavingsPlansList": { "$ref": "./examples/SavingsPlansList.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.BillingBenefits/validate": { "post": { "operationId": "Benefit_Validate", "description": "Validate savings plan purchase.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "name": "body", "in": "body", "description": "The request body", "required": true, "schema": { "$ref": "#/definitions/BenefitValidateRequest" } } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/BenefitValidateResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "ConditionalCreditValidateCancel": { "$ref": "./examples/ConditionalCreditValidateCancel.json" }, "ConditionalCreditValidateCreate": { "$ref": "./examples/ConditionalCreditValidateCreate.json" }, "ConditionalCreditValidateCreateContributor": { "$ref": "./examples/ConditionalCreditValidateCreateContributor.json" }, "ConditionalCreditValidateCreateError": { "$ref": "./examples/ConditionalCreditValidateCreateError.json" }, "ConditionalCreditValidateCreateMultiple": { "$ref": "./examples/ConditionalCreditValidateCreateMultiple.json" }, "ConditionalCreditValidateUpdate": { "$ref": "./examples/ConditionalCreditValidateUpdate.json" }, "ConditionalCreditValidateUpdateRemoveMilestone": { "$ref": "./examples/ConditionalCreditValidateUpdateRemoveMilestone.json" }, "CreditsValidateCreate": { "$ref": "./examples/CreditsValidateCreate.json" }, "DiscountsValidateCreate": { "$ref": "./examples/DiscountsValidateCreate.json" }, "MaccValidateCancel": { "$ref": "./examples/MaccValidateCancel.json" }, "MaccValidateCancelWithMilestones": { "$ref": "./examples/MaccValidateCancelWithMilestones.json" }, "MaccValidateCreate": { "$ref": "./examples/MaccValidateCreate.json" }, "MaccValidateCreateBackfilledMacc": { "$ref": "./examples/MaccValidateCreateBackfilledMacc.json" }, "MaccValidateCreateContributor": { "$ref": "./examples/MaccValidateCreateContributor.json" }, "MaccValidateCreateMilestonesOnExistingMacc": { "$ref": "./examples/MaccValidateCreateMilestonesOnExistingMacc.json" }, "MaccValidateCreateMultiEntity": { "$ref": "./examples/MaccValidateCreateMultiEntity.json" }, "MaccValidateCreateNewMaccWithMilestone": { "$ref": "./examples/MaccValidateCreateNewMaccWithMilestone.json" }, "MaccValidateUpdate": { "$ref": "./examples/MaccValidateUpdate.json" }, "MaccValidateUpdateCommitment": { "$ref": "./examples/MaccValidateUpdateCommitment.json" }, "MaccValidateUpdateCommitmentEndAtContributorRule": { "$ref": "./examples/MaccValidateUpdateCommitmentEndAtContributorRule.json" }, "MaccValidateUpdateContributor": { "$ref": "./examples/MaccValidateUpdateContributor.json" }, "MaccValidateUpdateContributorRule": { "$ref": "./examples/MaccValidateUpdateContributorRule.json" }, "MaccValidateUpdateDisplayName": { "$ref": "./examples/MaccValidateUpdateDisplayName.json" }, "MaccValidateUpdateEndAt": { "$ref": "./examples/MaccValidateUpdateEndAt.json" }, "MaccValidateUpdateMaccAndMilestoneCommitment": { "$ref": "./examples/MaccValidateUpdateMaccAndMilestoneCommitment.json" }, "MaccValidateUpdateMaccAndMilestoneEndDate": { "$ref": "./examples/MaccValidateUpdateMaccAndMilestoneEndDate.json" }, "MaccValidateUpdateMilestoneCommitment": { "$ref": "./examples/MaccValidateUpdateMilestoneCommitment.json" }, "MaccValidateUpdateMilestoneEndDate": { "$ref": "./examples/MaccValidateUpdateMilestoneEndDate.json" }, "MaccValidateUpdateRemoveMilestones": { "$ref": "./examples/MaccValidateUpdateRemoveMilestones.json" }, "MaccValidateUpdateSuppressShortfall": { "$ref": "./examples/MaccValidateUpdateSuppressShortfall.json" }, "MaccValidateUpdateSuppressShortfallOnMilestone": { "$ref": "./examples/MaccValidateUpdateSuppressShortfallOnMilestone.json" }, "MaccValidateUpdateUnsuppressShortfall": { "$ref": "./examples/MaccValidateUpdateUnsuppressShortfall.json" }, "MaccValidateUpdateUnsuppressShortfallOnMilestone": { "$ref": "./examples/MaccValidateUpdateUnsuppressShortfallOnMilestone.json" }, "MaccValidateWriteOffWithMilestones": { "$ref": "./examples/MaccValidateWriteOffWithMilestones.json" }, "MaccsValidateCreate": { "$ref": "./examples/MaccsValidateCreate.json" }, "SSCacoFlexibleValidateCreate": { "$ref": "./examples/SSCacoFlexibleValidateCreate.json" }, "SSCacoFlexibleValidateCreateMultipleInvalidOverlap": { "$ref": "./examples/SSCacoFlexibleValidateCreateMultipleInvalidOverlap.json" }, "SSCacoFlexibleValidateCreateMultipleValidOverlap": { "$ref": "./examples/SSCacoFlexibleValidateCreateMultipleValidOverlap.json" }, "SSCacoFlexibleValidateUpdate": { "$ref": "./examples/SSCacoFlexibleValidateUpdate.json" }, "SavingsPlanValidatePurchase": { "$ref": "./examples/SavingsPlanValidatePurchase.json" }, "SavingsPlansValidateCreate": { "$ref": "./examples/SavingsPlansValidateCreate.json" } } } }, "/providers/microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.BillingBenefits/applicableConditionalCredits/{systemId}/providers/microsoft.BillingBenefits/applicableContributors": { "get": { "operationId": "ConditionalCreditContributors_ListFromApplicableConditionalCredit", "description": "List contributors under applicable conditional credits for a given billing account.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountId", "in": "path", "description": "The billing account Id at which the benefits are listed. Accepted format is: {rootId:orgId}.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9_\\-\\.:]+$" }, { "name": "systemId", "in": "path", "description": "System ID of the primary MACC.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9_\\-\\.]+$" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/ConditionalCreditContributorList" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "ConditionalCreditContributorsScopeList": { "$ref": "./examples/ConditionalCreditContributorsListFromApplicableConditionalCredit.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.BillingBenefits/applicableMaccs": { "get": { "operationId": "ApplicableMaccs_List", "description": "List maccs that are applicable for a given billing account.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountId", "in": "path", "description": "The billing account Id at which the benefits are listed. Accepted format is: {rootId:orgId}.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9_\\-\\.:]+$" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/ApplicableMaccList" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "DiscountScopeList": { "$ref": "./examples/ApplicableMaccsList.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.BillingBenefits/applicableMaccs/{systemId}/providers/microsoft.BillingBenefits/applicableContributors": { "get": { "operationId": "Contributors_ListFromApplicableMacc", "description": "List contributors under applicable MACCs for a given billing account.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "name": "billingAccountId", "in": "path", "description": "The billing account Id at which the benefits are listed. Accepted format is: {rootId:orgId}.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9_\\-\\.:]+$" }, { "name": "systemId", "in": "path", "description": "System ID of the primary MACC.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9_\\-\\.]+$" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/ContributorList" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "ContributorsScopeList": { "$ref": "./examples/ContributorsListFromApplicableMacc.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.BillingBenefits/catalogGroups": { "get": { "operationId": "SubscriptionCatalogGroupsOps_List", "tags": [ "SubscriptionCatalogGroupsOps" ], "description": "List catalog groups at the target scope.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "#/parameters/CatalogGroupsListParameters" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/CatalogGroupListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "SubscriptionCatalogGroupsList": { "$ref": "./examples/CatalogGroupsSubscriptionList.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.BillingBenefits/catalogGroups/{catalogGroupName}": { "get": { "operationId": "SubscriptionCatalogGroupsOps_Get", "tags": [ "SubscriptionCatalogGroupsOps" ], "description": "Get a specific catalog group at the target scope.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "name": "catalogGroupName", "in": "path", "description": "The name of the CatalogGroup", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9_\\-\\.]+$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/CatalogGroup" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "SubscriptionCatalogGroupsGet": { "$ref": "./examples/CatalogGroupsSubscriptionGet.json" } } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.BillingBenefits/conditionalCredits": { "get": { "operationId": "ConditionalCredits_ListBySubscription", "tags": [ "ConditionalCredits" ], "description": "List conditional credits by subscription.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ConditionalCreditList" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "ConditionalCreditsListBySubscription": { "$ref": "./examples/ConditionalCreditsListBySubscription.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.BillingBenefits/credits": { "get": { "operationId": "Credits_ListBySubscription", "tags": [ "Credits" ], "description": "List credits under a subscription from primary service tenant.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/CreditsList" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "CreditsListBySubscription": { "$ref": "./examples/CreditsListBySubscription.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.BillingBenefits/discounts": { "get": { "operationId": "Discounts_SubscriptionList", "tags": [ "Discounts" ], "description": "List discounts at subscription level", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/DiscountList" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "DiscountSubscriptionList": { "$ref": "./examples/DiscountList.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.BillingBenefits/freeServices": { "get": { "operationId": "FreeServices_ListBySubscription", "tags": [ "FreeServicesOperations" ], "description": "This operation lists free services that are available under the specified subscription.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/FreeServicesList" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "FreeServicesListBySubscription": { "$ref": "./examples/FreeServicesListBySubscription.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.BillingBenefits/maccs": { "get": { "operationId": "Maccs_ListBySubscription", "tags": [ "Maccs" ], "description": "List MACCs under a subscription from primary service tenant.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/MaccList" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "MaccsWithMilestones_ListBySubscription": { "$ref": "./examples/MaccsWithMilestonesListBySubscription.json" }, "Maccs_ListBySubscription": { "$ref": "./examples/MaccsListBySubscription.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/conditionalCredits": { "get": { "operationId": "ConditionalCredits_ListByResourceGroup", "tags": [ "ConditionalCredits" ], "description": "List conditional credits by resource group.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ConditionalCreditList" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "ConditionalCreditsListByResourceGroup": { "$ref": "./examples/ConditionalCreditsListByResourceGroup.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/conditionalCredits/{conditionalCreditName}": { "get": { "operationId": "ConditionalCredits_Get", "tags": [ "ConditionalCredits" ], "description": "Get a conditional credit.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "conditionalCreditName", "in": "path", "description": "Name of the conditional credit", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9_\\-\\.]+$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ConditionalCredit" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "ConditionalCreditGet": { "$ref": "./examples/ConditionalCreditGet.json" } } }, "put": { "operationId": "ConditionalCredits_CreateOrUpdate", "tags": [ "ConditionalCredits" ], "description": "Create or update a conditional credit.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "conditionalCreditName", "in": "path", "description": "Name of the conditional credit", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9_\\-\\.]+$" }, { "name": "body", "in": "body", "description": "Request body for creating a conditional credit", "required": true, "schema": { "$ref": "#/definitions/ConditionalCredit" } } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/ConditionalCredit" }, "headers": { "Azure-AsyncOperation": { "type": "string", "description": "URL for checking the ongoing status of the operation." } } }, "201": { "description": "The request has succeeded and a new resource has been created as a result.", "schema": { "$ref": "#/definitions/ConditionalCredit" }, "headers": { "Azure-AsyncOperation": { "type": "string", "description": "URL for checking the ongoing status of the operation." }, "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": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "ConditionalCreditCreateContributor": { "$ref": "./examples/ConditionalCreditCreateContributor.json" }, "ConditionalCreditCreatePrimary": { "$ref": "./examples/ConditionalCreditCreatePrimary.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation", "final-state-schema": "#/definitions/ConditionalCredit" }, "x-ms-long-running-operation": true }, "patch": { "operationId": "ConditionalCredits_Update", "tags": [ "ConditionalCredits" ], "description": "Update a conditional credit.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "conditionalCreditName", "in": "path", "description": "Name of the conditional credit", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9_\\-\\.]+$" }, { "name": "body", "in": "body", "description": "Request body for updating a conditional credit", "required": true, "schema": { "$ref": "#/definitions/ConditionalCreditPatchRequest" } } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/ConditionalCredit" }, "headers": { "Azure-AsyncOperation": { "type": "string", "description": "URL for checking the ongoing status of the operation." } } }, "202": { "description": "The request has been accepted for processing, but processing has not yet completed.", "headers": { "Azure-AsyncOperation": { "type": "string", "format": "uri", "description": "URL for checking the ongoing status of the operation." }, "Location": { "type": "string", "description": "Location URI to poll for result." }, "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": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "ConditionalCreditUpdate": { "$ref": "./examples/ConditionalCreditUpdate.json" }, "ConditionalCreditUpdateContributor": { "$ref": "./examples/ConditionalCreditUpdateContributor.json" }, "ConditionalCreditUpdateLastMilestoneEndDate": { "$ref": "./examples/ConditionalCreditUpdateLastMilestoneEndDate.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation", "final-state-schema": "#/definitions/ConditionalCredit" }, "x-ms-long-running-operation": true }, "delete": { "operationId": "ConditionalCredits_Delete", "tags": [ "ConditionalCredits" ], "description": "Delete a conditional credit.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "conditionalCreditName", "in": "path", "description": "Name of the conditional credit", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9_\\-\\.]+$" } ], "responses": { "202": { "description": "The request has been accepted for processing, but processing has not yet completed.", "headers": { "Azure-AsyncOperation": { "type": "string", "format": "uri", "description": "URL for checking the ongoing status of the operation." }, "Location": { "type": "string", "description": "Location URI to poll for result." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "204": { "description": "There is no content to send for this request, but the headers may be useful. ", "headers": { "Azure-AsyncOperation": { "type": "string", "description": "URL for checking the ongoing status of the operation." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "ConditionalCreditDelete": { "$ref": "./examples/ConditionalCreditDelete.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/conditionalCredits/{conditionalCreditName}/cancel": { "post": { "operationId": "ConditionalCredits_Cancel", "tags": [ "ConditionalCredits" ], "description": "Cancel conditional credit. Stops applying the benefit.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "conditionalCreditName", "in": "path", "description": "Name of the conditional credit", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9_\\-\\.]+$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ConditionalCredit" } }, "202": { "description": "The request has been accepted for processing, but processing has not yet completed.", "headers": { "Azure-AsyncOperation": { "type": "string", "format": "uri", "description": "URL for checking the ongoing status of the operation." }, "Location": { "type": "string", "description": "Location URI to poll for result." }, "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": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "ConditionalCreditCancel": { "$ref": "./examples/ConditionalCreditCancel.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation", "final-state-schema": "#/definitions/ConditionalCredit" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/conditionalCredits/{conditionalCreditName}/contributors": { "get": { "operationId": "ConditionalCreditContributors_ListFromPrimary", "tags": [ "ConditionalCreditContributors" ], "description": "List contributors under a primary conditional credit for primary service admin", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "conditionalCreditName", "in": "path", "description": "Name of the conditional credit", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9_\\-\\.]+$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ConditionalCreditContributorList" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "ConditionalCreditContributors_ListFromPrimary": { "$ref": "./examples/ConditionalCreditContributorsListFromPrimary.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/conditionalCredits/{conditionalCreditName}/contributors/{contributorName}": { "get": { "operationId": "ConditionalCreditContributors_GetFromPrimary", "tags": [ "ConditionalCreditContributors" ], "description": "Get a conditional credit contributor for primary service admin", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "conditionalCreditName", "in": "path", "description": "Name of the conditional credit", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9_\\-\\.]+$" }, { "name": "contributorName", "in": "path", "description": "Unique name of contributor in the format {contributorCloudSubId}_{resourceGroupName}_{nameInContributorTenant}.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9_\\-\\.]+$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ConditionalCreditContributor" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "ConditionalCreditContributor_GetFromPrimary": { "$ref": "./examples/ConditionalCreditContributorGetFromPrimary.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/conditionalCredits/{conditionalCreditName}/transactions": { "get": { "operationId": "ConditionalCreditTransactions_ListByParent", "tags": [ "ConditionalCreditTransactions" ], "description": "List all transactions for a conditional credit.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "conditionalCreditName", "in": "path", "description": "Name of the conditional credit", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9_\\-\\.]+$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ConditionalCreditTransactionsList" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "ConditionalCreditTransactionsList": { "$ref": "./examples/ConditionalCreditTransactionsList.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/conditionalCredits/{conditionalCreditName}/transactions/{transactionName}": { "get": { "operationId": "ConditionalCreditTransactions_Get", "tags": [ "ConditionalCreditTransactions" ], "description": "Get a specific transaction for a conditional credit.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "conditionalCreditName", "in": "path", "description": "Name of the conditional credit", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9_\\-\\.]+$" }, { "name": "transactionName", "in": "path", "description": "Name of the transaction", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9_\\-\\.]+$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ConditionalCreditTransaction" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "ConditionalCreditTransactionGet": { "$ref": "./examples/ConditionalCreditTransactionGet.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/credits": { "get": { "operationId": "Credits_ListByResourceGroup", "tags": [ "Credits" ], "description": "List Credits under a resource group from primary service admin.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/CreditsList" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "CreditsListByResourceGroup": { "$ref": "./examples/CreditsListByResourceGroup.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/credits/{creditName}": { "get": { "operationId": "Credits_Get", "tags": [ "Credits" ], "description": "Get a credit.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "creditName", "in": "path", "description": "Name of the credit", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9_\\-\\.]+$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Credit" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "CreditGet": { "$ref": "./examples/CreditGet.json" } } }, "put": { "operationId": "Credits_Create", "tags": [ "Credits" ], "description": "Create a credit.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "creditName", "in": "path", "description": "Name of the credit", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9_\\-\\.]+$" }, { "name": "body", "in": "body", "description": "Credit create request", "required": true, "schema": { "$ref": "#/definitions/Credit" } } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/Credit" }, "headers": { "Azure-AsyncOperation": { "type": "string", "description": "URL for checking the ongoing status of the operation." } } }, "201": { "description": "The request has succeeded and a new resource has been created as a result.", "schema": { "$ref": "#/definitions/Credit" }, "headers": { "Azure-AsyncOperation": { "type": "string", "format": "uri", "description": "URL for checking the ongoing status of the operation." }, "Location": { "type": "string", "description": "Location URI to poll for result." }, "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": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "CreditCreate": { "$ref": "./examples/CreditCreate.json" }, "CreditCreateWithInvitation": { "$ref": "./examples/CreditCreateWithInvitation.json" }, "CreditTransferCreditCreate": { "$ref": "./examples/CreditTransferCreditCreate.json" }, "EndCustomerInvestmentFundCreditCreate": { "$ref": "./examples/EndCustomerInvestmentFundCreditCreate.json" }, "PromotionalCreditCreate": { "$ref": "./examples/PromotionalCreditCreate.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "original-uri", "final-state-schema": "#/definitions/Credit" }, "x-ms-long-running-operation": true }, "patch": { "operationId": "Credits_Update", "tags": [ "Credits" ], "description": "Update a credit.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "creditName", "in": "path", "description": "Name of the credit", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9_\\-\\.]+$" }, { "name": "body", "in": "body", "description": "Credit patch request", "required": true, "schema": { "$ref": "#/definitions/CreditPatchRequest" } } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/Credit" }, "headers": { "Azure-AsyncOperation": { "type": "string", "description": "URL for checking the ongoing status of the operation." } } }, "202": { "description": "The request has been accepted for processing, but processing has not yet completed.", "headers": { "Azure-AsyncOperation": { "type": "string", "format": "uri", "description": "URL for checking the ongoing status of the operation." }, "Location": { "type": "string", "description": "Location URI to poll for result." }, "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": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "CreditTagsUpdate": { "$ref": "./examples/CreditTagsUpdate.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation", "final-state-schema": "#/definitions/Credit" }, "x-ms-long-running-operation": true }, "delete": { "operationId": "Credits_Delete", "tags": [ "Credits" ], "description": "Delete a credit.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "creditName", "in": "path", "description": "Name of the credit", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9_\\-\\.]+$" } ], "responses": { "202": { "description": "The request has been accepted for processing, but processing has not yet completed.", "headers": { "Azure-AsyncOperation": { "type": "string", "format": "uri", "description": "URL for checking the ongoing status of the operation." }, "Location": { "type": "string", "description": "Location URI to poll for result." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "204": { "description": "There is no content to send for this request, but the headers may be useful. ", "headers": { "Azure-AsyncOperation": { "type": "string", "description": "URL for checking the ongoing status of the operation." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "CreditDelete": { "$ref": "./examples/CreditDelete.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/credits/{creditName}/cancel": { "post": { "operationId": "Credits_Cancel", "tags": [ "Credits" ], "description": "Cancels a credit.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "creditName", "in": "path", "description": "Name of the credit", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9_\\-\\.]+$" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/Credit" }, "headers": { "Azure-AsyncOperation": { "type": "string", "description": "URL for checking the ongoing status of the operation." } } }, "202": { "description": "Resource operation accepted.", "headers": { "Azure-AsyncOperation": { "type": "string", "format": "uri", "description": "URL for checking the ongoing status of the operation." }, "Location": { "type": "string", "description": "Location URI to poll for result." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "CreditCancel": { "$ref": "./examples/CreditCancel.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/Credit" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/credits/{creditName}/changeSponsor": { "post": { "operationId": "Credits_ChangeSponsor", "tags": [ "Credits" ], "description": "Change the sponsor of a credit.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "creditName", "in": "path", "description": "Name of the credit", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9_\\-\\.]+$" }, { "name": "body", "in": "body", "description": "The content of the action request", "required": true, "schema": { "$ref": "#/definitions/ChangeSponsorRequest" } } ], "responses": { "202": { "description": "Resource operation accepted.", "headers": { "Azure-AsyncOperation": { "type": "string", "format": "uri", "description": "URL for checking the ongoing status of the operation." }, "Location": { "type": "string", "description": "Location URI to poll for result." } } }, "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": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "CreditChangeSponsor": { "$ref": "./examples/CreditChangeSponsor.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/credits/{creditName}/sources": { "get": { "operationId": "Sources_ListByCredit", "tags": [ "CreditSources" ], "description": "List credit sources for a credit under a resource group from primary service admin.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "creditName", "in": "path", "description": "Name of the credit", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9_\\-\\.]+$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/CreditSourcesList" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "CreditSourcesListByCredit": { "$ref": "./examples/CreditSourcesListByCredit.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/credits/{creditName}/sources/{sourceName}": { "get": { "operationId": "Sources_Get", "tags": [ "CreditSources" ], "description": "Get a credit source.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "creditName", "in": "path", "description": "Name of the credit", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9_\\-\\.]+$" }, { "name": "sourceName", "in": "path", "description": "Name of the credit source", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9_\\-\\.]+$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/CreditSource" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "CreditSourceGet": { "$ref": "./examples/CreditSourceGet.json" } } }, "put": { "operationId": "Sources_Create", "tags": [ "CreditSources" ], "description": "Create a credit source.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "creditName", "in": "path", "description": "Name of the credit", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9_\\-\\.]+$" }, { "name": "sourceName", "in": "path", "description": "Name of the credit source", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9_\\-\\.]+$" }, { "name": "body", "in": "body", "description": "Credit source create request", "required": true, "schema": { "$ref": "#/definitions/CreditSource" } } ], "responses": { "200": { "description": "Resource 'CreditSource' update operation succeeded", "schema": { "$ref": "#/definitions/CreditSource" } }, "201": { "description": "Resource 'CreditSource' create operation succeeded", "schema": { "$ref": "#/definitions/CreditSource" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "CreditSourceCreate": { "$ref": "./examples/CreditSourceCreate.json" } } }, "patch": { "operationId": "Sources_Update", "tags": [ "CreditSources" ], "description": "Update a credit source.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "creditName", "in": "path", "description": "Name of the credit", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9_\\-\\.]+$" }, { "name": "sourceName", "in": "path", "description": "Name of the credit source", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9_\\-\\.]+$" }, { "name": "body", "in": "body", "description": "Credit source patch request", "required": true, "schema": { "$ref": "#/definitions/CreditSourcePatchRequest" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/CreditSource" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "CreditSourceTagsUpdate": { "$ref": "./examples/CreditSourceTagsUpdate.json" } } }, "delete": { "operationId": "Sources_Delete", "tags": [ "CreditSources" ], "description": "Delete a credit source.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "creditName", "in": "path", "description": "Name of the credit", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9_\\-\\.]+$" }, { "name": "sourceName", "in": "path", "description": "Name of the credit source", "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": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "CreditSourceDelete": { "$ref": "./examples/CreditSourceDelete.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/credits/{creditName}/transactions": { "get": { "operationId": "CreditTransactions_ListByParent", "tags": [ "CreditTransactions" ], "description": "List all transactions for a credit.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "creditName", "in": "path", "description": "Name of the credit", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9_\\-\\.]+$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/TransactionsList" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "CreditTransactionsList": { "$ref": "./examples/CreditTransactionsList.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/credits/{creditName}/transactions/{transactionName}": { "get": { "operationId": "CreditTransactions_Get", "tags": [ "CreditTransactions" ], "description": "Get a specific transaction for a credit.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "creditName", "in": "path", "description": "Name of the credit", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9_\\-\\.]+$" }, { "name": "transactionName", "in": "path", "description": "Name of the transaction", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9_\\-\\.]+$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/CreditTransaction" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "CreditTransactionGet": { "$ref": "./examples/CreditTransactionGet.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/discounts": { "get": { "operationId": "Discounts_ResourceGroupList", "tags": [ "Discounts" ], "description": "List discounts at resource group level", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/DiscountList" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "DiscountResourceGroupList": { "$ref": "./examples/DiscountResourceGroupList.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/discounts/{discountName}": { "get": { "operationId": "Discount_Get", "tags": [ "Discounts" ], "description": "Get discount at resource group level", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "discountName", "in": "path", "description": "Name of the discount", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9_\\-\\.]+$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Discount" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "DiscountGet": { "$ref": "./examples/DiscountGet.json" } } }, "put": { "operationId": "Discounts_Create", "tags": [ "Discounts" ], "description": "Create discount.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "discountName", "in": "path", "description": "Name of the discount", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9_\\-\\.]+$" }, { "name": "body", "in": "body", "description": "Request body for creating a discount.", "required": true, "schema": { "$ref": "#/definitions/Discount" } } ], "responses": { "200": { "description": "Resource 'Discount' update operation succeeded", "schema": { "$ref": "#/definitions/Discount" } }, "201": { "description": "Resource 'Discount' create operation succeeded", "schema": { "$ref": "#/definitions/Discount" }, "headers": { "Azure-AsyncOperation": { "type": "string", "description": "URL for checking the ongoing status of the operation." }, "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": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "DiscountsCreateAffiliate": { "$ref": "./examples/DiscountsCreateAffiliate.json" }, "DiscountsCreatePrimary": { "$ref": "./examples/DiscountsCreatePrimary.json" }, "DiscountsCreatePrimaryBackfill": { "$ref": "./examples/DiscountsCreatePrimaryBackfill.json" }, "DiscountsCreatePrimaryWithAzurePromotion": { "$ref": "./examples/DiscountsCreatePrimaryWithAzurePromotion.json" }, "DiscountsCreatePrimaryWithCustomPrice": { "$ref": "./examples/DiscountsCreatePrimaryWithCustomPrice.json" }, "DiscountsCreatePrimaryWithCustomPriceMultiCurrency": { "$ref": "./examples/DiscountsCreatePrimaryWithCustomPriceMultiCurrency.json" }, "DiscountsCreatePrimaryWithPriceGuarantee": { "$ref": "./examples/DiscountsCreatePrimaryWithPriceGuarantee.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation", "final-state-schema": "#/definitions/Discount" }, "x-ms-long-running-operation": true }, "patch": { "operationId": "Discount_Update", "tags": [ "Discounts" ], "description": "Update discounts", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "discountName", "in": "path", "description": "Name of the discount", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9_\\-\\.]+$" }, { "name": "body", "in": "body", "description": "Request body for updating discounts", "required": true, "schema": { "$ref": "#/definitions/DiscountPatchRequest" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Discount" } }, "202": { "description": "Resource operation accepted.", "headers": { "Azure-AsyncOperation": { "type": "string", "format": "uri", "description": "URL for checking the ongoing status of the operation." }, "Location": { "type": "string", "description": "Location URI to poll for result." }, "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": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "DiscountGet": { "$ref": "./examples/DiscountsUpdate.json" }, "DiscountsUpdateEndAt": { "$ref": "./examples/DiscountsUpdateEndAt.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation", "final-state-schema": "#/definitions/Discount" }, "x-ms-long-running-operation": true }, "delete": { "operationId": "Discounts_Delete", "tags": [ "Discounts" ], "description": "Delete discount. Clears the metadata from the user's view.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "discountName", "in": "path", "description": "Name of the discount", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9_\\-\\.]+$" } ], "responses": { "202": { "description": "Resource operation accepted.", "headers": { "Azure-AsyncOperation": { "type": "string", "format": "uri", "description": "URL for checking the ongoing status of the operation." }, "Location": { "type": "string", "description": "Location URI to poll for result." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "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": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "ReservationOrderAliasCreate": { "$ref": "./examples/DiscountsDelete.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/discounts/{discountName}/cancel": { "post": { "operationId": "Discounts_Cancel", "tags": [ "Discounts" ], "description": "Cancel discount. Stops applying the benefit.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "discountName", "in": "path", "description": "Name of the discount", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9_\\-\\.]+$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Discount" } }, "202": { "description": "Resource operation accepted.", "headers": { "Azure-AsyncOperation": { "type": "string", "format": "uri", "description": "URL for checking the ongoing status of the operation." }, "Location": { "type": "string", "description": "Location URI to poll for result." }, "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": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "DiscountCancel": { "$ref": "./examples/DiscountCancel.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation", "final-state-schema": "#/definitions/Discount" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/freeServices": { "get": { "operationId": "FreeServices_ListByResourceGroup", "tags": [ "FreeServicesOperations" ], "description": "This operation lists the free services that are available under the specified resource group.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/FreeServicesList" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "FreeServicesListByResourceGroup": { "$ref": "./examples/FreeServicesListByResourceGroup.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/freeServices/{freeServiceName}": { "get": { "operationId": "FreeServices_Get", "tags": [ "FreeServicesOperations" ], "description": "This operation retrieves properties for free services.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "freeServiceName", "in": "path", "description": "Name of the free service", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9_\\-\\.]+$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/FreeServices" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "FreeServicesGet": { "$ref": "./examples/FreeServicesGet.json" } } }, "put": { "operationId": "FreeServices_Create", "tags": [ "FreeServicesOperations" ], "description": "This operation creates or updates free services in Azure", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "freeServiceName", "in": "path", "description": "Name of the free service", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9_\\-\\.]+$" }, { "name": "body", "in": "body", "description": "Free services create request", "required": true, "schema": { "$ref": "#/definitions/FreeServices" } } ], "responses": { "200": { "description": "Resource 'FreeServices' update operation succeeded", "schema": { "$ref": "#/definitions/FreeServices" } }, "201": { "description": "Resource 'FreeServices' create operation succeeded", "schema": { "$ref": "#/definitions/FreeServices" }, "headers": { "Azure-AsyncOperation": { "type": "string", "description": "URL for checking the ongoing status of the operation." }, "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": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "FreeServicesCreate": { "$ref": "./examples/FreeServicesCreate.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation", "final-state-schema": "#/definitions/FreeServices" }, "x-ms-long-running-operation": true }, "patch": { "operationId": "FreeServices_Update", "tags": [ "FreeServicesOperations" ], "description": "This operation updates free services in Azure.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "freeServiceName", "in": "path", "description": "Name of the free service", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9_\\-\\.]+$" }, { "name": "body", "in": "body", "description": "Free services patch request", "required": true, "schema": { "$ref": "#/definitions/FreeServicesPatchRequest" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/FreeServices" } }, "202": { "description": "Resource operation accepted.", "headers": { "Azure-AsyncOperation": { "type": "string", "format": "uri", "description": "URL for checking the ongoing status of the operation." }, "Location": { "type": "string", "description": "Location URI to poll for result." }, "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": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "FreeServicesUpdate": { "$ref": "./examples/FreeServicesUpdate.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation", "final-state-schema": "#/definitions/FreeServices" }, "x-ms-long-running-operation": true }, "delete": { "operationId": "FreeServices_Delete", "tags": [ "FreeServicesOperations" ], "description": "This operation deletes free services from the subscription. Only free services that are in an expired or cancelled states can be deleted.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "freeServiceName", "in": "path", "description": "Name of the free service", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9_\\-\\.]+$" } ], "responses": { "202": { "description": "The request has been accepted for processing, but processing has not yet completed.", "headers": { "Azure-AsyncOperation": { "type": "string", "format": "uri", "description": "URL for checking the ongoing status of the operation." }, "Location": { "type": "string", "description": "Location URI to poll for result." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "204": { "description": "There is no content to send for this request, but the headers may be useful. ", "headers": { "Azure-AsyncOperation": { "type": "string", "description": "URL for checking the ongoing status of the operation." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "FreeServicesDelete": { "$ref": "./examples/FreeServicesDelete.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/maccs": { "get": { "operationId": "Maccs_ListByResourceGroup", "tags": [ "Maccs" ], "description": "List MACCs under a resource group for primary service admin.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/MaccList" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "MaccsWithMilestones_ListByResourceGroup": { "$ref": "./examples/MaccsWithMilestonesListByResourceGroup.json" }, "Maccs_ListByResourceGroup": { "$ref": "./examples/MaccsListByResourceGroup.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/maccs/{maccName}": { "get": { "operationId": "Maccs_Get", "tags": [ "Maccs" ], "description": "Get a MACC.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "maccName", "in": "path", "description": "Name of primary MACC.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9_\\-\\.]+$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Macc" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "ContributorWithMilestonesAndShortfall_GetFromPrimary": { "$ref": "./examples/ContributorWithMilestonesAndShortfallGet.json" }, "ContributorWithMilestones_GetFromPrimary": { "$ref": "./examples/ContributorWithMilestonesGet.json" }, "Contributor_Get": { "$ref": "./examples/ContributorGet.json" }, "MaccWithMilestonesAndShortfall_Get": { "$ref": "./examples/MaccWithMilestonesAndShortfallGet.json" }, "MaccWithMilestones_Get": { "$ref": "./examples/MaccWithMilestonesGet.json" }, "MaccWithShortfall_Get": { "$ref": "./examples/MaccWithShortfallGet.json" }, "Macc_Get": { "$ref": "./examples/MaccGet.json" } } }, "put": { "operationId": "Maccs_Create", "tags": [ "Maccs" ], "description": "Create MACC.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "maccName", "in": "path", "description": "Name of primary MACC.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9_\\-\\.]+$" }, { "name": "body", "in": "body", "description": "Request body for creating MACC.", "required": true, "schema": { "$ref": "#/definitions/Macc" } } ], "responses": { "200": { "description": "Resource 'Macc' update operation succeeded", "schema": { "$ref": "#/definitions/Macc" } }, "201": { "description": "Resource 'Macc' create operation succeeded", "schema": { "$ref": "#/definitions/Macc" }, "headers": { "Azure-AsyncOperation": { "type": "string", "description": "URL for checking the ongoing status of the operation." }, "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": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Contributor_Create": { "$ref": "./examples/ContributorCreate.json" }, "MaccWithMilestones_Create": { "$ref": "./examples/MaccWithMilestonesCreate.json" }, "Macc_Create": { "$ref": "./examples/MaccCreate.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation", "final-state-schema": "#/definitions/Macc" }, "x-ms-long-running-operation": true }, "patch": { "operationId": "Maccs_Update", "tags": [ "Maccs" ], "description": "Update MACC.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "maccName", "in": "path", "description": "Name of primary MACC.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9_\\-\\.]+$" }, { "name": "body", "in": "body", "description": "Request body for updating MACC.", "required": true, "schema": { "$ref": "#/definitions/MaccPatchRequest" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Macc" } }, "202": { "description": "Resource operation accepted.", "headers": { "Azure-AsyncOperation": { "type": "string", "format": "uri", "description": "URL for checking the ongoing status of the operation." }, "Location": { "type": "string", "description": "Location URI to poll for result." }, "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": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Contributor_UpdateEndDate": { "$ref": "./examples/ContributorEndDateUpdate.json" }, "MaccAndMilestoneCommitment_Update": { "$ref": "./examples/MaccAndMilestoneCommitmentUpdate.json" }, "MaccAndMilestoneEndDate_Update": { "$ref": "./examples/MaccAndMilestoneEndDateUpdate.json" }, "MaccAndMilestoneMultiProperty_Update": { "$ref": "./examples/MaccAndMilestoneMultiPropertyUpdate.json" }, "MaccCommitment_Update": { "$ref": "./examples/MaccNoMilestonesCommitmentUpdate.json" }, "MaccDisplayName_Update": { "$ref": "./examples/MaccDisplayNameUpdate.json" }, "MaccEndContributorRule_Update": { "$ref": "./examples/MaccContributorRuleUpdate.json" }, "MaccEndDate_Update": { "$ref": "./examples/MaccNoMilestonesEndDateUpdate.json" }, "MaccMilestoneSuppressAutomaticShortfall": { "$ref": "./examples/MaccMilestoneSuppressAutomaticShortfall.json" }, "MaccMilestoneUnsuppressAutomaticShortfall": { "$ref": "./examples/MaccMilestoneUnsuppressAutomaticShortfall.json" }, "MaccMultiProperty_Update": { "$ref": "./examples/MaccMultiPropertyUpdate.json" }, "MaccSuppressAutomaticShortfall": { "$ref": "./examples/MaccSuppressAutomaticShortfall.json" }, "MaccTags_Update": { "$ref": "./examples/MaccTagsUpdate.json" }, "MaccUnsuppressAutomaticShortfall": { "$ref": "./examples/MaccUnsuppressAutomaticShortfall.json" }, "MaccWithMilestonesUpdateLastMilestoneEndDate": { "$ref": "./examples/MaccWithMilestonesUpdateLastMilestoneEndDate.json" }, "MilestonesCreate_OnExistingMacc": { "$ref": "./examples/MilestonesCreateOnExistingMacc.json" }, "MilestonesRemove_FromMacc": { "$ref": "./examples/MilestonesRemoveFromMacc.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation", "final-state-schema": "#/definitions/Macc" }, "x-ms-long-running-operation": true }, "delete": { "operationId": "Maccs_Delete", "tags": [ "Maccs" ], "description": "Delete MACC.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "maccName", "in": "path", "description": "Name of primary MACC.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9_\\-\\.]+$" } ], "responses": { "202": { "description": "Resource operation accepted.", "headers": { "Azure-AsyncOperation": { "type": "string", "format": "uri", "description": "URL for checking the ongoing status of the operation." }, "Location": { "type": "string", "description": "Location URI to poll for result." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "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": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "ServiceSpecificIncentives_Delete": { "$ref": "./examples/MaccDelete.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/maccs/{maccName}/cancel": { "post": { "operationId": "Maccs_Cancel", "tags": [ "Maccs" ], "description": "Represents an operation to cancel MACC contract. This operation does not indicate deletion of the MACC, but rather stops applying the benefit to the account.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "maccName", "in": "path", "description": "Name of primary MACC.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9_\\-\\.]+$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Macc" } }, "202": { "description": "Resource operation accepted.", "headers": { "Azure-AsyncOperation": { "type": "string", "format": "uri", "description": "URL for checking the ongoing status of the operation." }, "Location": { "type": "string", "description": "Location URI to poll for result." }, "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": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "MaccWithMilestones_Cancel": { "$ref": "./examples/MaccWithMilestonesCancel.json" }, "Macc_Cancel": { "$ref": "./examples/MaccCancel.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation", "final-state-schema": "#/definitions/Macc" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/maccs/{maccName}/chargeShortfall": { "post": { "operationId": "Maccs_ChargeShortfall", "tags": [ "Maccs" ], "description": "Operation to charge shortfall to a customer's account, ensuring they are charged for the outstanding amount of MACC credit.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "maccName", "in": "path", "description": "Name of primary MACC.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9_\\-\\.]+$" }, { "name": "body", "in": "body", "description": "Request body for charging shortfall.", "required": true, "schema": { "$ref": "#/definitions/ChargeShortfallRequest" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Macc" } }, "202": { "description": "Resource operation accepted.", "headers": { "Azure-AsyncOperation": { "type": "string", "format": "uri", "description": "URL for checking the ongoing status of the operation." }, "Location": { "type": "string", "description": "Location URI to poll for result." }, "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": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Maccs_ChargeShortfall": { "$ref": "./examples/MaccChargeShortfall.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation", "final-state-schema": "#/definitions/Macc" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/maccs/{maccName}/contributors": { "get": { "operationId": "Contributors_ListFromPrimary", "tags": [ "Contributors" ], "description": "List contributors under a MACC for primary service admin", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "maccName", "in": "path", "description": "Name of primary MACC.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9_\\-\\.]+$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ContributorList" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "ContributorsWithMilestonesAndShortfall_ListFromPrimary": { "$ref": "./examples/ContributorsWithMilestonesAndShortfallListFromPrimary.json" }, "ContributorsWithMilestones_ListFromPrimary": { "$ref": "./examples/ContributorsWithMilestonesListFromPrimary.json" }, "Contributors_ListFromPrimary": { "$ref": "./examples/ContributorsListFromPrimary.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/maccs/{maccName}/contributors/{contributorName}": { "get": { "operationId": "Contributors_GetFromPrimary", "tags": [ "Contributors" ], "description": "Get a contributor for primary service admin", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "maccName", "in": "path", "description": "Name of primary MACC.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9_\\-\\.]+$" }, { "name": "contributorName", "in": "path", "description": "Unique name of contributor in the format {contributorCloudSubId}_{resourceGroupName}_{nameInContributorTenant}.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9_\\-\\.]+$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Contributor" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Contributor_GetFromPrimary": { "$ref": "./examples/ContributorGetFromPrimary.json" }, "Contributor_GetFromPrimary_WithMilestones": { "$ref": "./examples/ContributorWithMilestonesGetFromPrimary.json" }, "Contributor_GetFromPrimary_WithMilestonesAndShortfall": { "$ref": "./examples/ContributorWithMilestonesAndShortfallGetFromPrimary.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/maccs/{maccName}/transactions": { "get": { "operationId": "MaccTransactions_ListByParent", "tags": [ "MaccTransactions" ], "description": "List all transactions for a MACC.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "maccName", "in": "path", "description": "Name of primary MACC.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9_\\-\\.]+$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/MaccTransactionsList" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "MaccTransactionsList": { "$ref": "./examples/MaccTransactionsList.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/maccs/{maccName}/transactions/{transactionName}": { "get": { "operationId": "MaccTransactions_Get", "tags": [ "MaccTransactions" ], "description": "Get a specific transaction for a MACC.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "maccName", "in": "path", "description": "Name of primary MACC.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9_\\-\\.]+$" }, { "name": "transactionName", "in": "path", "description": "Name of the transaction", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9_\\-\\.]+$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/MaccTransaction" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "MaccTransactionGet": { "$ref": "./examples/MaccTransactionGet.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/maccs/{maccName}/writeOff": { "post": { "operationId": "Maccs_WriteOff", "tags": [ "Maccs" ], "description": "Operation to waive a customer's pending MACC balance (Shortfall) from their account, ensuring they are not charged for the outstanding amount.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "maccName", "in": "path", "description": "Name of primary MACC.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9_\\-\\.]+$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Macc" } }, "202": { "description": "Resource operation accepted.", "headers": { "Azure-AsyncOperation": { "type": "string", "format": "uri", "description": "URL for checking the ongoing status of the operation." }, "Location": { "type": "string", "description": "Location URI to poll for result." }, "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": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "MaccWithMilestones_WriteOff": { "$ref": "./examples/MaccWithMilestonesWriteOff.json" }, "Macc_WriteOff": { "$ref": "./examples/MaccWriteOff.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation", "final-state-schema": "#/definitions/Macc" }, "x-ms-long-running-operation": true } } }, "definitions": { "ApplicableMacc": { "type": "object", "description": "Applicable MACC.", "properties": { "properties": { "$ref": "#/definitions/MaccModelProperties", "description": "Applicable MACC properties", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" } ] }, "ApplicableMaccList": { "type": "object", "description": "Applicable MACC list", "properties": { "value": { "type": "array", "description": "List Applicable MACCs.", "items": { "$ref": "#/definitions/ApplicableMacc" }, "x-ms-identifiers": [] }, "nextLink": { "type": "string", "description": "Url to get the next page." } } }, "AppliedOn": { "type": "string", "description": "Indicates where the credit benefit is applied", "enum": [ "Consumption", "Invoice", "External" ], "x-ms-enum": { "name": "AppliedOn", "modelAsString": true, "values": [ { "name": "Consumption", "value": "Consumption", "description": "Applied on consume charges" }, { "name": "Invoice", "value": "Invoice", "description": "Applied on invoice" }, { "name": "External", "value": "External", "description": "Applied externally" } ] } }, "AppliedScopeProperties": { "type": "object", "description": "Properties specific to applied scope type. Not required if not applicable.", "properties": { "tenantId": { "type": "string", "description": "Tenant ID where the benefit is applied." }, "managementGroupId": { "type": "string", "description": "Fully-qualified identifier of the management group where the benefit must be applied." }, "subscriptionId": { "type": "string", "description": "Fully-qualified identifier of the subscription." }, "resourceGroupId": { "type": "string", "description": "Fully-qualified identifier of the resource group." }, "displayName": { "type": "string", "description": "Display name" }, "benefitFilter": { "type": "string", "description": "A filter string passed to downstream services to categorize and apply usage benefits to specific resource models. Expected format: \"key/value\" (e.g., \"contractId/2025 H2CPU\"). The value is not validated by BillingBenefits and is forwarded as-is.", "example": "clusterId/2025 H2CPU" } } }, "AppliedScopeType": { "type": "string", "description": "Type of the Applied Scope.", "enum": [ "Single", "Shared", "ManagementGroup" ], "x-ms-enum": { "name": "AppliedScopeType", "modelAsString": true, "values": [ { "name": "Single", "value": "Single" }, { "name": "Shared", "value": "Shared" }, { "name": "ManagementGroup", "value": "ManagementGroup" } ] } }, "ApplyDiscountOn": { "type": "string", "description": "The customer action on which the discount is applied. Supported values are Purchase, Consume, and Renew. Validation: Required, one of supported values.", "enum": [ "Purchase", "Consume", "Renew" ], "x-ms-enum": { "name": "ApplyDiscountOn", "modelAsString": true, "values": [ { "name": "Purchase", "value": "Purchase" }, { "name": "Consume", "value": "Consume" }, { "name": "Renew", "value": "Renew" } ] } }, "AutomaticShortfallSuppressReason": { "type": "object", "description": "Optional field to record suppression reason for automatic shortfall.", "properties": { "code": { "type": "string", "description": "Code for the suppression reason." }, "message": { "type": "string", "description": "Message for suppression reason." } } }, "Award": { "type": "object", "description": "Award details for milestone completion", "properties": { "credit": { "$ref": "#/definitions/Commitment", "description": "Credit amount to be awarded" }, "startAt": { "type": "string", "format": "date-time", "description": "Start date when the credit becomes effective" }, "endAt": { "type": "string", "format": "date-time", "description": "End date when the credit expires" }, "resourceId": { "type": "string", "format": "arm-id", "description": "Resource ID for the awarded credit.", "readOnly": true }, "systemId": { "type": "string", "description": "This is the globally unique identifier of the credit which will not change for its lifetime.", "readOnly": true }, "balanceVersion": { "type": "number", "format": "float", "description": "Points to BalanceVersion document that indicates the remaining commitment balance when the credit was created.", "readOnly": true }, "duration": { "$ref": "#/definitions/Term", "description": "Duration for which the benefit is active. Will be in format P{int}M or P{int}Y. Any values representing up to 12 years are valid. Upper limit examples: P144M, P12Y." } } }, "Azure.Core.armResourceType": { "type": "string", "description": "Represents an Azure Resource Type." }, "BenefitAppliedScopeType": { "type": "string", "description": "List of applied scope types supported for benefit resources.", "enum": [ "BillingAccount", "BillingProfile", "Customer" ], "x-ms-enum": { "name": "BenefitAppliedScopeType", "modelAsString": true, "values": [ { "name": "BillingAccount", "value": "BillingAccount" }, { "name": "BillingProfile", "value": "BillingProfile" }, { "name": "Customer", "value": "Customer" } ] } }, "BenefitProvisioningState": { "type": "string", "description": "Provisioning state for billing benefit resources. Includes the standard terminal states\n(Succeeded, Failed, Canceled) plus benefit-specific transition states.", "enum": [ "Succeeded", "Failed", "Canceled", "Pending" ], "x-ms-enum": { "name": "BenefitProvisioningState", "modelAsString": true, "values": [ { "name": "Succeeded", "value": "Succeeded", "description": "Resource has been created." }, { "name": "Failed", "value": "Failed", "description": "Resource creation failed." }, { "name": "Canceled", "value": "Canceled", "description": "Resource creation was canceled." }, { "name": "Pending", "value": "Pending", "description": "The resource provisioning request has been accepted but processing has not yet started." } ] }, "readOnly": true }, "BenefitType": { "type": "string", "description": "Represents benefit model type for validation. Includes all resource types\nplus legacy singular-form values used by the validate API.", "enum": [ "Maccs", "Credits", "ConditionalCredits", "Discounts", "FreeServices", "SavingsPlans", "Reservations", "SavingsPlan", "MACC" ], "x-ms-enum": { "name": "BenefitType", "modelAsString": true, "values": [ { "name": "Maccs", "value": "Maccs", "description": "Microsoft Azure Consumption Commitments" }, { "name": "Credits", "value": "Credits", "description": "Credits applied to the customer's billing account" }, { "name": "ConditionalCredits", "value": "ConditionalCredits", "description": "Conditional Credits" }, { "name": "Discounts", "value": "Discounts", "description": "Discounts that reduce charges on eligible services" }, { "name": "FreeServices", "value": "FreeServices", "description": "Services provided at no charge under the billing agreement" }, { "name": "SavingsPlans", "value": "SavingsPlans", "description": "Savings Plan" }, { "name": "Reservations", "value": "Reservations", "description": "Reserved capacity or reserved instances" }, { "name": "SavingsPlan", "value": "SavingsPlan", "description": "Savings Plan (singular form, used by validate API)" }, { "name": "MACC", "value": "MACC", "description": "MACC (legacy form, used by validate API)" } ] } }, "BenefitValidateModel": { "type": "object", "description": "Abstract benefit model to validate.", "properties": { "benefitType": { "$ref": "#/definitions/BenefitType", "description": "Type of benefit to validate. This is used to determine the model type for validation." } }, "discriminator": "benefitType", "required": [ "benefitType" ] }, "BenefitValidateRequest": { "type": "object", "description": "Request to validate any benefit.", "properties": { "benefits": { "type": "array", "description": "Defines benefits for validation.", "items": { "$ref": "#/definitions/BenefitValidateModel" }, "x-ms-identifiers": [] } } }, "BenefitValidateResponse": { "type": "object", "description": "Benefit validate response.", "properties": { "benefits": { "type": "array", "description": "Defines benefit validation response for benefits.", "items": { "$ref": "#/definitions/BenefitValidateResponseProperty" }, "x-ms-identifiers": [] }, "nextLink": { "type": "string", "description": "Url to get the next page." } } }, "BenefitValidateResponseProperty": { "type": "object", "description": "Benefit validate response property", "properties": { "valid": { "type": "boolean", "description": "Indicates if the provided input was valid" }, "reasonCode": { "type": "string", "description": "Failure reason code if the provided input was invalid" }, "reason": { "type": "string", "description": "Failure reason if the provided input was invalid" }, "resourceId": { "type": "string", "format": "arm-id", "description": "Resource identifier of the benefit that was validated.", "x-ms-arm-id-details": { "allowedResources": [ { "scopes": [ "ResourceGroup" ], "type": "Microsoft.BillingBenefits/maccs" } ] } } } }, "BillingPlan": { "type": "string", "description": "Represents the billing plan in ISO 8601 format. Required only for monthly billing plans.", "enum": [ "P1M" ], "x-ms-enum": { "name": "BillingPlan", "modelAsString": true, "values": [ { "name": "P1M", "value": "P1M" } ] } }, "BillingPlanInformation": { "type": "object", "description": "Information describing the type of billing plan for this savings plan.", "properties": { "pricingCurrencyTotal": { "$ref": "#/definitions/Price", "description": "Amount of money to be paid for the Order. Tax is not included." }, "startDate": { "type": "string", "format": "date", "description": "Date when the billing plan has started." }, "nextPaymentDueDate": { "type": "string", "format": "date", "description": "For recurring billing plans, indicates the date when next payment will be processed. Null when total is paid off." }, "transactions": { "type": "array", "items": { "$ref": "#/definitions/PaymentDetail" }, "x-ms-identifiers": [] } } }, "CatalogClaimsItem": { "type": "object", "description": "Catalog claim for a discount.", "properties": { "catalogClaimsItemType": { "type": "string" }, "value": { "type": "string" } } }, "CatalogGroup": { "type": "object", "description": "A catalog group represents a BenefitResourceType + Namespace grouping used for benefit SKU discovery.", "properties": { "properties": { "$ref": "#/definitions/CatalogGroupProperties", "description": "The resource-specific properties for this resource." } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" } ] }, "CatalogGroupCapability": { "type": "object", "description": "A key-value pair representing a capability of the catalog group (for example, exchange or renewal support).", "properties": { "name": { "type": "string", "description": "The capability name (e.g., SelfServiceExchange, Renewability)." }, "value": { "type": "string", "description": "The capability value (e.g., Supported, Not Supported)." } }, "required": [ "name", "value" ] }, "CatalogGroupListResult": { "type": "object", "description": "The response of a CatalogGroup list operation.", "properties": { "value": { "type": "array", "description": "The CatalogGroup items on this page", "items": { "$ref": "#/definitions/CatalogGroup" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "CatalogGroupProperties": { "type": "object", "description": "Properties of a catalog group.", "properties": { "benefitResourceType": { "$ref": "#/definitions/ResourceType", "description": "The top-level benefit resource type (e.g., maccs, credits, conditionalCredits, discounts, savingsPlans, reservations)." }, "displayName": { "type": "string", "description": "Display name for the catalog group." }, "shortDescription": { "type": "string", "description": "Short description of the catalog group." }, "longDescription": { "type": "string", "description": "Long description of the catalog group." }, "learnMoreLink": { "type": "string", "format": "uri", "description": "Link to learn more about this catalog group. Uses the forward-link format https://go.microsoft.com/fwlink/?linkid=." }, "keywords": { "type": "array", "description": "Manifest-sourced array of search terms for this catalog group. Omitted when empty.", "items": { "type": "string" } }, "icon": { "type": "string", "description": "The benefit type's icon as JSON-escaped SVG markup. After parsing, the value is a complete `…` element.", "example": "" }, "capabilities": { "type": "array", "description": "Capabilities of the catalog group as key-value pairs. Omitted when a benefit type has no defined capabilities.", "items": { "$ref": "#/definitions/CatalogGroupCapability" }, "x-ms-identifiers": [] }, "disclaimers": { "type": "array", "description": "Optional disclaimers (legal or eligibility caveats) for the catalog group. Included only when caveats apply.", "items": { "type": "string" } } }, "required": [ "benefitResourceType" ] }, "ChangeSponsorRequest": { "type": "object", "description": "Request body for the changeSponsor action on a credit.", "properties": { "sponsorId": { "type": "string", "description": "Financial code identifying the new sponsor. This is an alphanumeric identifier assigned by the billing system, for example P20567384.", "example": "P30000001" } } }, "ChargeShortfallRequest": { "type": "object", "description": "Charge shortfall request", "properties": { "properties": { "$ref": "#/definitions/Shortfall", "description": "Charge shortfall request properties", "x-ms-client-flatten": true } } }, "Commitment": { "type": "object", "description": "Commitment towards the benefit.", "properties": { "grain": { "$ref": "#/definitions/CommitmentGrain", "description": "The grain of the commitment." } }, "allOf": [ { "$ref": "#/definitions/Price" } ] }, "CommitmentGrain": { "type": "string", "description": "Grain.", "enum": [ "Hourly", "FullTerm", "Unknown" ], "x-ms-enum": { "name": "CommitmentGrain", "modelAsString": true, "values": [ { "name": "Hourly", "value": "Hourly" }, { "name": "FullTerm", "value": "FullTerm" }, { "name": "Unknown", "value": "Unknown" } ] } }, "ConditionalCredit": { "type": "object", "description": "Resource definition for Conditional Credits.", "properties": { "properties": { "$ref": "#/definitions/ConditionalCreditProperties", "description": "Conditional credit properties" }, "managedBy": { "type": "string", "description": "The fully qualified resource ID of the resource that manages this resource. Indicates if this resource is managed by another Azure resource. If this is present, complete mode deployment will not delete the resource if it is removed from the template since it is managed by another resource.", "x-ms-mutability": [ "read", "update", "create" ] }, "kind": { "type": "string", "description": "Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type. E.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value.", "pattern": "^[-\\w\\._,\\(\\)]+$", "x-ms-mutability": [ "read", "create" ] }, "etag": { "type": "string", "description": "The etag field is *not* required. If it is provided in the response body, it must also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.", "readOnly": true }, "identity": { "$ref": "../../../../../../common-types/resource-management/v6/managedidentity.json#/definitions/ManagedServiceIdentity", "description": "Managed service identity (system assigned and/or user assigned identities)" }, "sku": { "$ref": "#/definitions/Sku", "description": "The resource model definition representing SKU" }, "plan": { "$ref": "#/definitions/Plan", "description": "Plan for the resource." } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/TrackedResource" } ] }, "ConditionalCreditContributor": { "type": "object", "description": "Conditional credit contributor", "properties": { "properties": { "$ref": "#/definitions/ContributorConditionalCreditProperties", "description": "Conditional credit contributor properties", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" } ] }, "ConditionalCreditContributorList": { "type": "object", "description": "Conditional credit contributor list", "properties": { "value": { "type": "array", "description": "The ConditionalCreditContributor items on this page", "items": { "$ref": "#/definitions/ConditionalCreditContributor" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "ConditionalCreditEntityType": { "type": "string", "description": "Type of conditional credit entity", "enum": [ "Primary", "Contributor" ], "x-ms-enum": { "name": "ConditionalCreditEntityType", "modelAsString": true, "values": [ { "name": "Primary", "value": "Primary" }, { "name": "Contributor", "value": "Contributor" } ] } }, "ConditionalCreditList": { "type": "object", "description": "List of applicable conditional credits", "properties": { "value": { "type": "array", "description": "The ConditionalCredit items on this page", "items": { "$ref": "#/definitions/ConditionalCredit" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "ConditionalCreditMilestone": { "type": "object", "description": "Milestone definition within a conditional credit", "properties": { "award": { "$ref": "#/definitions/Award", "description": "Award details for this milestone" } }, "allOf": [ { "$ref": "#/definitions/ConditionalCreditMilestoneBase" } ] }, "ConditionalCreditMilestoneBase": { "type": "object", "description": "Base milestone definition for conditional credits", "properties": { "milestoneId": { "type": "string", "description": "Unique identifier for the milestone" }, "name": { "type": "string", "description": "Display name for the milestone" }, "status": { "$ref": "#/definitions/MilestoneStatus", "description": "Current status of the milestone" }, "endAt": { "type": "string", "format": "date-time", "description": "End date for this milestone" }, "spendTarget": { "$ref": "#/definitions/Price", "description": "Spend target for this milestone" }, "award": { "$ref": "#/definitions/Award", "description": "Award details for this milestone (only present for primary conditional credits)" } } }, "ConditionalCreditPatchRequest": { "type": "object", "description": "Conditional credit patch request", "properties": { "properties": { "$ref": "#/definitions/ConditionalCreditPatchRequestProperties", "description": "Conditional credit patch request properties", "x-ms-client-flatten": true }, "tags": { "type": "object", "description": "Resource tags.", "additionalProperties": { "type": "string" } } } }, "ConditionalCreditPatchRequestProperties": { "type": "object", "description": "Conditional credit patch request properties", "properties": { "displayName": { "type": "string", "description": "Display name for the conditional credit" }, "endAt": { "type": "string", "format": "date-time", "description": "End DateTime in UTC." }, "allowContributors": { "$ref": "#/definitions/EnablementMode", "description": "Whether this conditional credit allows contributor billing accounts" }, "milestones": { "type": "array", "description": "Updated milestones list (only applicable for primary conditional credits)", "items": { "$ref": "#/definitions/ConditionalCreditMilestone" } } } }, "ConditionalCreditProperties": { "type": "object", "description": "Properties belonging to conditional credits.", "properties": { "entityType": { "$ref": "#/definitions/ConditionalCreditEntityType", "description": "Type of conditional credit entity" }, "displayName": { "type": "string", "description": "Display name for the conditional credit" }, "billingAccountResourceId": { "type": "string", "format": "arm-id", "description": "The billing account resource ID", "x-ms-arm-id-details": { "allowedResources": [ { "scopes": [ "Tenant" ], "type": "Microsoft.Billing/billingAccounts" } ] } }, "provisioningState": { "$ref": "#/definitions/BenefitProvisioningState", "description": "The provisioning state of the resource", "readOnly": true }, "status": { "$ref": "#/definitions/ConditionalCreditStatus", "description": "The status of the conditional credit" }, "startAt": { "type": "string", "format": "date-time", "description": "Start date of the conditional credit" }, "endAt": { "type": "string", "format": "date-time", "description": "End date of the conditional credit (derived from last milestone)" }, "productCode": { "type": "string", "description": "Product code for the conditional credit" }, "benefitResourceId": { "type": "string", "format": "arm-id", "description": "Fully-qualified identifier of the benefit under applicable benefit list.", "readOnly": true, "x-ms-arm-id-details": { "allowedResources": [ { "scopes": [ "ResourceGroup" ], "type": "Microsoft.BillingBenefits/*" } ] } }, "resourceId": { "type": "string", "format": "arm-id", "description": "Fully-qualified resource identifier of the resource. Format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/{benefitType}/{benefitName}." }, "productDetails": { "$ref": "#/definitions/ProductDetailsBase", "description": "Product details including SKU title, product family, and product type.", "readOnly": true }, "appliedScopeType": { "$ref": "#/definitions/BenefitAppliedScopeType", "description": "Type of the applied scope for the conditional credit." }, "invitationId": { "type": "string", "description": "Invitation identifier", "x-ms-mutability": [ "read", "create" ] }, "consumed": { "$ref": "#/definitions/Price", "description": "Amount of benefit that has been consumed", "readOnly": true } }, "discriminator": "entityType", "required": [ "entityType" ] }, "ConditionalCreditStatus": { "type": "string", "description": "The status of the conditional credit", "enum": [ "Unknown", "Scheduled", "Active", "Pending", "Failed", "Canceled", "Completed", "Stopped", "PendingSettlement" ], "x-ms-enum": { "name": "ConditionalCreditStatus", "modelAsString": true, "values": [ { "name": "Unknown", "value": "Unknown" }, { "name": "Scheduled", "value": "Scheduled" }, { "name": "Active", "value": "Active" }, { "name": "Pending", "value": "Pending" }, { "name": "Failed", "value": "Failed" }, { "name": "Canceled", "value": "Canceled" }, { "name": "Completed", "value": "Completed" }, { "name": "Stopped", "value": "Stopped" }, { "name": "PendingSettlement", "value": "PendingSettlement" } ] } }, "ConditionalCreditTransaction": { "type": "object", "description": "Transaction resource definition for ConditionalCredits", "properties": { "properties": { "$ref": "#/definitions/TransactionProperties", "description": "Transaction properties" } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" } ] }, "ConditionalCreditTransactionsList": { "type": "object", "description": "List of conditional credit transactions", "properties": { "value": { "type": "array", "description": "The ConditionalCreditTransaction items on this page", "items": { "$ref": "#/definitions/ConditionalCreditTransaction" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "ConditionalCreditsValidateModel": { "type": "object", "description": "Conditional Credits validate model", "properties": { "properties": { "$ref": "#/definitions/ConditionalCreditProperties", "description": "Conditional Credits validate properties" } }, "allOf": [ { "$ref": "#/definitions/BenefitValidateModel" } ], "x-ms-discriminator-value": "ConditionalCredits" }, "ConditionsItem": { "type": "object", "description": "Condition for a discount.", "properties": { "conditionName": { "type": "string" }, "value": { "type": "array", "description": "These items are open-ended strings.", "items": { "type": "string" } }, "type": { "type": "string" } } }, "Contributor": { "type": "object", "description": "MACC contributor", "properties": { "properties": { "$ref": "#/definitions/MaccModelProperties", "description": "MACC contributor properties", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" } ] }, "ContributorConditionalCreditMilestone": { "type": "object", "description": "Milestone definition for contributor conditional credit (excludes award details)", "allOf": [ { "$ref": "#/definitions/ConditionalCreditMilestoneBase" } ] }, "ContributorConditionalCreditProperties": { "type": "object", "description": "Properties for contributor conditional credit.", "properties": { "primaryResourceId": { "type": "string", "format": "arm-id", "description": "Resource ID of the primary conditional credit (required for contributors)", "x-ms-arm-id-details": { "allowedResources": [ { "scopes": [ "ResourceGroup" ], "type": "Microsoft.BillingBenefits/conditionalCredits" } ] } }, "systemId": { "type": "string", "description": "System identifier shared between primary and contributor conditional credits representing the same conditional credit program" }, "productCode": { "type": "string", "description": "Product code for the contributor conditional credit" }, "startAt": { "type": "string", "format": "date-time", "description": "Start date for the contributor conditional credit" }, "milestones": { "type": "array", "description": "List of milestones copied from primary conditional credit (excludes award details)", "items": { "$ref": "#/definitions/ContributorConditionalCreditMilestone" }, "readOnly": true }, "primaryBillingAccountResourceId": { "type": "string", "format": "arm-id", "description": "Fully-qualified billing account resource identifier of the primary CACO. Format must be Azure Resource ID: /providers/Microsoft.Billing/billingAccounts/{acctId:orgId}.", "x-ms-arm-id-details": { "allowedResources": [ { "scopes": [ "Tenant" ], "type": "Microsoft.Billing/billingAccounts" } ] } } }, "allOf": [ { "$ref": "#/definitions/ConditionalCreditProperties" } ], "x-ms-discriminator-value": "Contributor" }, "ContributorList": { "type": "object", "description": "Contributor list", "properties": { "value": { "type": "array", "description": "The Contributor items on this page", "items": { "$ref": "#/definitions/Contributor" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "Credit": { "type": "object", "description": "Credit resource definition", "properties": { "properties": { "$ref": "#/definitions/CreditProperties", "description": "Credit properties", "x-ms-client-flatten": true }, "managedBy": { "type": "string", "description": "The fully qualified resource ID of the resource that manages this resource. Indicates if this resource is managed by another Azure resource. If this is present, complete mode deployment will not delete the resource if it is removed from the template since it is managed by another resource.", "x-ms-mutability": [ "read", "update", "create" ] }, "kind": { "type": "string", "description": "Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type. E.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value.", "pattern": "^[-\\w\\._,\\(\\)]+$", "x-ms-mutability": [ "read", "create" ] }, "etag": { "type": "string", "description": "The etag field is *not* required. If it is provided in the response body, it must also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.", "readOnly": true }, "identity": { "$ref": "../../../../../../common-types/resource-management/v6/managedidentity.json#/definitions/ManagedServiceIdentity", "description": "Managed service identity (system assigned and/or user assigned identities)" }, "sku": { "$ref": "#/definitions/Sku", "description": "The resource model definition representing SKU" }, "plan": { "$ref": "#/definitions/Plan", "description": "Plan for the resource." } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/TrackedResource" } ] }, "CreditBreakdownItem": { "type": "object", "description": "Credit breakdown item representing a milestone, line-item, or no-charge service", "properties": { "allocation": { "$ref": "#/definitions/Commitment", "description": "Allocation details including currency and amount for this breakdown item" }, "startAt": { "type": "string", "format": "date-time", "description": "Start DateTime." }, "endAt": { "type": "string", "format": "date-time", "description": "End DateTime in UTC." }, "dimensions": { "type": "array", "description": "Key-value pairs for additional parameters and metadata", "items": { "$ref": "#/definitions/CreditDimension" } } } }, "CreditDimension": { "type": "object", "description": "Key-value pair for additional credit parameters and metadata", "properties": { "key": { "type": "string", "description": "The dimension key (e.g., productFamily, description, creditType)" }, "value": { "type": "string", "description": "The dimension value" } }, "required": [ "key", "value" ] }, "CreditExpirationPolicy": { "type": "string", "description": "Expiration policy of the Credit", "enum": [ "None", "SuspendBillingProfile" ], "x-ms-enum": { "name": "CreditExpirationPolicy", "modelAsString": true, "values": [ { "name": "None", "value": "None", "description": "No policy applied to the expiration of this credit" }, { "name": "SuspendBillingProfile", "value": "SuspendBillingProfile", "description": "Billing profile is suspended when the credit expires" } ] } }, "CreditPatchProperties": { "type": "object", "description": "Credit patch properties", "properties": { "credit": { "$ref": "#/definitions/Commitment", "description": "The entire investment amount for the credit contract, including currency and amount. Only amount can be modified." }, "endAt": { "type": "string", "format": "date-time", "description": "End DateTime in UTC." }, "breakdown": { "type": "array", "description": "Credit line-items/milestones/no-charge services breakdown. Entire breakdown will be replaced in a PATCH operation.", "items": { "$ref": "#/definitions/CreditBreakdownItem" } } } }, "CreditPatchRequest": { "type": "object", "description": "Credit patch request", "properties": { "tags": { "type": "object", "description": "Resource tags", "additionalProperties": { "type": "string" } }, "properties": { "$ref": "#/definitions/CreditPatchProperties", "description": "Credit patch properties", "x-ms-client-flatten": true } } }, "CreditPolicies": { "type": "object", "description": "Credit breakdown item representing a milestone, line-item, or no-charge service", "properties": { "redemption": { "$ref": "#/definitions/CreditRedemptionPolicy", "description": "Redemption policy of the Credit" }, "expiration": { "$ref": "#/definitions/CreditExpirationPolicy", "description": "Expiration policy of the Credit" } } }, "CreditProductDetails": { "type": "object", "description": "Product details for a credit", "properties": { "skuTitle": { "type": "string", "description": "SKU title of the product" }, "productFamily": { "type": "string", "description": "The product family, for example \"Azure\" or \"M365\"." }, "productType": { "type": "string", "description": "The type of the product." }, "appliedOn": { "type": "array", "description": "Indicates where the credit benefit is applied (e.g., consume, invoice, or external application).", "items": { "$ref": "#/definitions/AppliedOn" } }, "appliedPrice": { "type": "string", "description": "Specifies which price point is used when applying the credit. Known values include \"MarketPrice\", \"UnitPrice\", and \"BenefitGroupPrice:\" where identifies the benefit group." } } }, "CreditProperties": { "type": "object", "description": "Properties of a credit", "properties": { "status": { "$ref": "#/definitions/CreditStatus", "description": "Status of the credit" }, "productCode": { "type": "string", "description": "Product UPN for the credit type" }, "displayName": { "type": "string", "description": "Display name" }, "reason": { "$ref": "#/definitions/CreditReason", "description": "The reason for the credit. Not required if not applicable." }, "credit": { "$ref": "#/definitions/Commitment", "description": "The entire investment amount for the credit contract, including currency and amount" }, "startAt": { "type": "string", "format": "date-time", "description": "Start DateTime." }, "endAt": { "type": "string", "format": "date-time", "description": "End DateTime in UTC." }, "policies": { "$ref": "#/definitions/CreditPolicies", "description": "Credit breakdown item representing a milestone, line-item, or no-charge service" }, "billingAccountResourceId": { "type": "string", "format": "arm-id", "description": "Fully-qualified identifier of the billing account where the benefit is applied. Present only for Enterprise Agreement customers.", "x-ms-arm-id-details": { "allowedResources": [ { "scopes": [ "Tenant" ], "type": "Microsoft.Billing/billingAccounts" } ] } }, "billingProfileResourceId": { "type": "string", "format": "arm-id", "description": "Fully-qualified identifier of the billing profile where the benefit is applied. Present only for Field-led or Customer-led customers.", "readOnly": true, "x-ms-arm-id-details": { "allowedResources": [ { "scopes": [ "Tenant" ], "type": "Microsoft.Billing/billingAccounts/billingProfiles" } ] } }, "customerResourceId": { "type": "string", "format": "arm-id", "description": "Customer resource id where the benefit is scoped to.", "readOnly": true, "x-ms-arm-id-details": { "allowedResources": [ { "scopes": [ "Tenant" ], "type": "Microsoft.Billing/billingAccounts/customers" } ] } }, "breakdown": { "type": "array", "description": "Credit line-items/milestones/no-charge services breakdown", "items": { "$ref": "#/definitions/CreditBreakdownItem" } }, "provisioningState": { "$ref": "#/definitions/BenefitProvisioningState", "description": "Provisioning state", "readOnly": true }, "systemId": { "type": "string", "description": "System identifier" }, "orderId": { "type": "string", "description": "Identifier of the $0 transaction created during credit acquisition.", "readOnly": true }, "fundingSystemId": { "type": "string", "description": "Unique identifier (UUID) of the funding lot assigned by the benefit publisher. Used in credit transfer scenarios to trace the originating credit lot.", "x-ms-mutability": [ "read", "create" ] }, "resourceId": { "type": "string", "format": "arm-id", "description": "Fully-qualified resource identifier of the resource. Format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/{benefitType}/{benefitName}." }, "invitationId": { "type": "string", "description": "Invitation identifier", "x-ms-mutability": [ "read", "create" ] }, "consumed": { "$ref": "#/definitions/Price", "description": "Amount of benefit that has been consumed", "readOnly": true }, "productDetails": { "$ref": "#/definitions/CreditProductDetails", "description": "Product details including SKU title, product kind, offer type, and application details", "readOnly": true }, "appliedScopeType": { "$ref": "#/definitions/BenefitAppliedScopeType", "description": "Type of the applied scope for the credit." } } }, "CreditReason": { "type": "object", "description": "The reason for the credit. Not required if not applicable.", "properties": { "code": { "type": "string", "description": "The reason code for credit." }, "description": { "type": "string", "description": "The free string description of the credit." } } }, "CreditRedemptionPolicy": { "type": "string", "description": "Redemption policy of the Credit", "enum": [ "NotApplicable", "AutoRedeem", "ManualRedeem" ], "x-ms-enum": { "name": "CreditRedemptionPolicy", "modelAsString": true, "values": [ { "name": "NotApplicable", "value": "NotApplicable", "description": "Redemption policy is not applicable for this credit" }, { "name": "AutoRedeem", "value": "AutoRedeem", "description": "Credit is automatically redeemed" }, { "name": "ManualRedeem", "value": "ManualRedeem", "description": "Credit is manually redeemed" } ] } }, "CreditSource": { "type": "object", "description": "Credit source resource definition", "properties": { "properties": { "$ref": "#/definitions/CreditSourceProperties", "description": "Credit source properties", "x-ms-client-flatten": true }, "managedBy": { "type": "string", "description": "The fully qualified resource ID of the resource that manages this resource. Indicates if this resource is managed by another Azure resource. If this is present, complete mode deployment will not delete the resource if it is removed from the template since it is managed by another resource.", "x-ms-mutability": [ "read", "update", "create" ] }, "kind": { "type": "string", "description": "Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type. E.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value.", "pattern": "^[-\\w\\._,\\(\\)]+$", "x-ms-mutability": [ "read", "create" ] }, "etag": { "type": "string", "description": "The etag field is *not* required. If it is provided in the response body, it must also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.", "readOnly": true }, "identity": { "$ref": "../../../../../../common-types/resource-management/v6/managedidentity.json#/definitions/ManagedServiceIdentity", "description": "Managed service identity (system assigned and/or user assigned identities)" }, "sku": { "$ref": "#/definitions/Sku", "description": "The resource model definition representing SKU" }, "plan": { "$ref": "#/definitions/Plan", "description": "Plan for the resource." } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/TrackedResource" } ] }, "CreditSourcePatchRequest": { "type": "object", "description": "Credit patch request", "properties": { "tags": { "type": "object", "description": "Resource Tags", "additionalProperties": { "type": "string" }, "x-ms-mutability": [ "read", "update", "create" ] } } }, "CreditSourceProperties": { "type": "object", "description": "Properties of a credit source", "properties": { "status": { "$ref": "#/definitions/CreditStatus", "description": "Status of the credit" }, "sourceResourceId": { "type": "string", "format": "arm-id", "description": "The uri of the resource impacted which lead to the grant of the credit.", "x-ms-arm-id-details": { "allowedResources": [ { "scopes": [ "ResourceGroup" ], "type": "Microsoft.BillingBenefits/credits" } ] } }, "impactedBillingPeriod": { "type": "string", "description": "The billing period of the impact for the resource. Format YYYYMM" }, "credit": { "$ref": "#/definitions/Commitment", "description": "Commitment towards the benefit." } } }, "CreditSourcesList": { "type": "object", "description": "List of credit sources", "properties": { "value": { "type": "array", "description": "The CreditSource items on this page", "items": { "$ref": "#/definitions/CreditSource" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "CreditStatus": { "type": "string", "description": "Status of the credit", "enum": [ "Unknown", "Pending", "Active", "Succeeded", "Canceled", "Failed", "Expired", "Exhausted", "NotStarted" ], "x-ms-enum": { "name": "CreditStatus", "modelAsString": true, "values": [ { "name": "Unknown", "value": "Unknown", "description": "Credit status is unknown" }, { "name": "Pending", "value": "Pending", "description": "Credit is pending activation" }, { "name": "Active", "value": "Active", "description": "Credit is active and available for use" }, { "name": "Succeeded", "value": "Succeeded", "description": "Credit operation succeeded" }, { "name": "Canceled", "value": "Canceled", "description": "Credit has been cancelled" }, { "name": "Failed", "value": "Failed", "description": "Credit operation failed" }, { "name": "Expired", "value": "Expired", "description": "Credit has expired" }, { "name": "Exhausted", "value": "Exhausted", "description": "Credit has been fully consumed" }, { "name": "NotStarted", "value": "NotStarted", "description": "Credit application has not started yet" } ] }, "readOnly": true }, "CreditTransaction": { "type": "object", "description": "Transaction resource definition for Credits", "properties": { "properties": { "$ref": "#/definitions/TransactionProperties", "description": "Transaction properties" } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" } ] }, "CreditsList": { "type": "object", "description": "List of credits", "properties": { "value": { "type": "array", "description": "The Credit items on this page", "items": { "$ref": "#/definitions/Credit" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "CreditsValidateModel": { "type": "object", "description": "Credits validate model", "properties": { "properties": { "$ref": "#/definitions/Credit", "description": "Credits validate properties", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "#/definitions/BenefitValidateModel" } ], "x-ms-discriminator-value": "Credits" }, "CustomPriceProperties": { "type": "object", "description": "Custom price properties for a given discount.", "properties": { "ruleType": { "$ref": "#/definitions/DiscountRuleType", "description": "The type of the priceable node pricing rule. Validation: Required. Supported values are fixedPriceLock, fixedListPrice, and priceCeiling." }, "catalogId": { "type": "string", "description": "The catalog instance where the priceable node lives. Validation: Required. No defined format, will vary per team." }, "catalogClaims": { "type": "array", "description": "The set of BigCat claims. Validation: Required. Must contain AgreementType, NationalCloud, and PricingAudience claims. Additionally requires AccessPass claim when creating custom price with action == consume on the pricing instructions.", "items": { "$ref": "#/definitions/CatalogClaimsItem" } }, "termUnits": { "type": "string", "description": "The term units for the priceable node. Validation: Optional, Maximum length 128 characters. Must be present if and only if the availability derived by market, product, sku, and claims has terms." }, "billingPeriod": { "type": "string", "description": "The billing period of the priceable node. Validation: Optional, Maximum length 128 characters. Only allowed if the availability derived by market, product, sku, and claims has terms and at least one of those terms has a billing period. When specified, termUnits must be specified." }, "meterType": { "type": "string", "description": "Must be present if the market, product, sku, and claims, and optional term information resolves to multiple availabilities that only differ by meter type. Validation: Maximum length 128 characters." }, "marketSetPrices": { "type": "array", "description": "The set of market set prices of the priceable node. Validation: Required. Must contain at least one element.", "items": { "$ref": "#/definitions/MarketSetPricesItems" } } }, "required": [ "ruleType", "catalogId", "catalogClaims", "marketSetPrices" ] }, "Discount": { "type": "object", "description": "Resource definition for Discounts.", "properties": { "properties": { "$ref": "#/definitions/DiscountProperties", "description": "Discount properties" }, "managedBy": { "type": "string", "description": "The fully qualified resource ID of the resource that manages this resource. Indicates if this resource is managed by another Azure resource. If this is present, complete mode deployment will not delete the resource if it is removed from the template since it is managed by another resource.", "x-ms-mutability": [ "read", "update", "create" ] }, "kind": { "type": "string", "description": "Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type. E.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value.", "pattern": "^[-\\w\\._,\\(\\)]+$", "x-ms-mutability": [ "read", "create" ] }, "etag": { "type": "string", "description": "The etag field is *not* required. If it is provided in the response body, it must also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.", "readOnly": true }, "identity": { "$ref": "#/definitions/ManagedServiceIdentity", "description": "Managed service identity (system assigned and/or user assigned identities)" }, "sku": { "$ref": "#/definitions/Sku", "description": "The resource model definition representing SKU" }, "plan": { "$ref": "#/definitions/Plan", "description": "Plan for the resource." } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/TrackedResource" } ] }, "DiscountCombinationRule": { "type": "string", "description": "The discount combination rule when there are multiple applicable custom prices. Validation: Required. Supported values are Stackable and BestOf.", "enum": [ "BestOf", "Stackable" ], "x-ms-enum": { "name": "DiscountCombinationRule", "modelAsString": true, "values": [ { "name": "BestOf", "value": "BestOf" }, { "name": "Stackable", "value": "Stackable" } ] } }, "DiscountEntityType": { "type": "string", "description": "This defines whether the entity being created is primary or affiliate. Supported values: primary, affiliate. Validation: Required, must match one of the 2 values.", "enum": [ "Primary", "Affiliate" ], "x-ms-enum": { "name": "DiscountEntityType", "modelAsString": true, "values": [ { "name": "Primary", "value": "Primary" }, { "name": "Affiliate", "value": "Affiliate" } ] } }, "DiscountList": { "type": "object", "description": "Discount list", "properties": { "value": { "type": "array", "description": "The Discount items on this page", "items": { "$ref": "#/definitions/Discount" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "DiscountPatchRequest": { "type": "object", "description": "Discounts patch request", "properties": { "properties": { "$ref": "#/definitions/DiscountPatchRequestProperties", "description": "Discounts patch request properties", "x-ms-client-flatten": true }, "tags": { "type": "object", "description": "Resource tags.", "additionalProperties": { "type": "string" } } } }, "DiscountPatchRequestProperties": { "type": "object", "description": "Discounts patch request properties", "properties": { "displayName": { "type": "string", "description": "Display name" }, "endAt": { "type": "string", "format": "date-time", "description": "End date of the discount. No duration will be supported. Allowed value is any date greater than or equal to startDate." } } }, "DiscountProperties": { "type": "object", "description": "Properties belonging to discounts.", "properties": { "entityType": { "$ref": "#/definitions/DiscountEntityType", "description": "This defines whether the entity being created is primary or affiliate. Supported values: primary, affiliate. Validation: Required, must match one of the 2 values." }, "productCode": { "type": "string", "description": "This is the catalog UPN for the product." }, "startAt": { "type": "string", "format": "date-time", "description": "Start date of the discount. Value is the date the discount started or will start in the future." }, "endAt": { "type": "string", "format": "date-time", "description": "End date of the discount. No duration will be supported. Allowed value is any date greater than or equal to startDate." }, "systemId": { "type": "string", "description": "This is the globally unique identifier of the Discount which will not change for the lifetime of the Discount." }, "provisioningState": { "$ref": "#/definitions/BenefitProvisioningState", "description": "The state of the resource. Supported values are Pending, Failed, Succeeded, Canceled.", "readOnly": true }, "billingAccountResourceId": { "type": "string", "format": "arm-id", "description": "Fully-qualified identifier of the billing account where the benefit is applied.", "readOnly": true, "x-ms-arm-id-details": { "allowedResources": [ { "scopes": [ "Tenant" ], "type": "Microsoft.Billing/billingAccounts" } ] } }, "billingProfileResourceId": { "type": "string", "format": "arm-id", "description": "Fully-qualified identifier of the billing profile where the benefit is applied.", "readOnly": true, "x-ms-arm-id-details": { "allowedResources": [ { "scopes": [ "Tenant" ], "type": "Microsoft.Billing/billingAccounts/billingProfiles" } ] } }, "customerResourceId": { "type": "string", "format": "arm-id", "description": "Customer resource id where the benefit is scoped to.", "readOnly": true, "x-ms-arm-id-details": { "allowedResources": [ { "scopes": [ "Tenant" ], "type": "Microsoft.Billing/billingAccounts/customers" } ] } }, "invitationId": { "type": "string", "description": "Invitation identifier", "x-ms-mutability": [ "read", "create" ] }, "displayName": { "type": "string", "description": "This defines a user friendly display name for the discount." }, "status": { "$ref": "#/definitions/DiscountStatus", "description": "Represents the current status of the discount.", "readOnly": true }, "benefitResourceId": { "type": "string", "format": "arm-id", "description": "Fully-qualified identifier of the benefit under applicable benefit list.", "readOnly": true, "x-ms-arm-id-details": { "allowedResources": [ { "scopes": [ "ResourceGroup" ], "type": "Microsoft.BillingBenefits/*" } ] } }, "appliedScopeType": { "$ref": "#/definitions/BenefitAppliedScopeType", "description": "List of applied scopes supported for discounts." }, "productDetails": { "$ref": "#/definitions/ProductDetailsBase", "description": "Product details including SKU title, product family, and product type.", "readOnly": true } }, "discriminator": "entityType", "required": [ "entityType", "productCode", "startAt" ] }, "DiscountRuleType": { "type": "string", "description": "The type of the priceable node pricing rule. Validation: Required. Supported values are fixedPriceLock, fixedListPrice, and priceCeiling.", "enum": [ "FixedPriceLock", "FixedListPrice", "PriceCeiling" ], "x-ms-enum": { "name": "DiscountRuleType", "modelAsString": true, "values": [ { "name": "FixedPriceLock", "value": "FixedPriceLock" }, { "name": "FixedListPrice", "value": "FixedListPrice" }, { "name": "PriceCeiling", "value": "PriceCeiling" } ] } }, "DiscountStatus": { "type": "string", "description": "Represents the current status of the discount.", "enum": [ "Active", "Pending", "Failed", "Canceled", "Expired" ], "x-ms-enum": { "name": "DiscountStatus", "modelAsString": true, "values": [ { "name": "Active", "value": "Active" }, { "name": "Pending", "value": "Pending" }, { "name": "Failed", "value": "Failed" }, { "name": "Canceled", "value": "Canceled" }, { "name": "Expired", "value": "Expired" } ] } }, "DiscountType": { "type": "string", "description": "Defines the type of discount. Supported values are ProductFamily, Product, Sku, CustomPrice, and CustomPriceMultiCurrency.", "enum": [ "ProductFamily", "Product", "Sku", "CustomPrice", "CustomPriceMultiCurrency", "AzurePromotion" ], "x-ms-enum": { "name": "DiscountType", "modelAsString": true, "values": [ { "name": "ProductFamily", "value": "ProductFamily" }, { "name": "Product", "value": "Product" }, { "name": "Sku", "value": "Sku" }, { "name": "CustomPrice", "value": "CustomPrice" }, { "name": "CustomPriceMultiCurrency", "value": "CustomPriceMultiCurrency" }, { "name": "AzurePromotion", "value": "AzurePromotion", "description": "Azure promotion discount type." } ] } }, "DiscountTypeAzurePromotion": { "type": "object", "description": "Discount type properties for Azure promotion discounts.", "properties": { "productFamilyName": { "type": "string", "description": "Product family for which the discount is given. Validation: Optional" } }, "allOf": [ { "$ref": "#/definitions/DiscountTypeProperties" } ], "x-ms-discriminator-value": "AzurePromotion" }, "DiscountTypeCustomPrice": { "type": "object", "description": "Discount type properties including product family name, product id, sku, and custom price properties. Allows a single entry in marketSetPrices.", "properties": { "productFamilyName": { "type": "string", "description": "Product family for which the discount is given. Validation: Optional" }, "productId": { "type": "string", "description": "Product ID for which the discount is given. Validation: Optional. No specific format, example: DZH318Z09V6F" }, "skuId": { "type": "string", "description": "ResourceSku for the given discount. Validation: Optional." }, "customPriceProperties": { "$ref": "#/definitions/CustomPriceProperties", "description": "Custom price properties for a given discount." } }, "allOf": [ { "$ref": "#/definitions/DiscountTypeProperties" } ], "x-ms-discriminator-value": "CustomPrice" }, "DiscountTypeCustomPriceMultiCurrency": { "type": "object", "description": "Discount type properties including product family name, product id, sku, and custom price properties. Allows multiple entries in marketSetPrices.", "allOf": [ { "$ref": "#/definitions/DiscountTypeCustomPrice" } ], "x-ms-discriminator-value": "CustomPriceMultiCurrency" }, "DiscountTypeProduct": { "type": "object", "description": "Discount type properties including product family name and product id.", "properties": { "productFamilyName": { "type": "string", "description": "Product family for which the discount is given. Validation: Optional" }, "productId": { "type": "string", "description": "Product ID for which the discount is given. Validation: Optional. No specific format, example: DZH318Z09V6F" } }, "allOf": [ { "$ref": "#/definitions/DiscountTypeProperties" } ], "x-ms-discriminator-value": "Product" }, "DiscountTypeProductFamily": { "type": "object", "description": "Discount type properties including product family name", "properties": { "productFamilyName": { "type": "string", "description": "Product family for which the discount is given. Validation: Optional" } }, "allOf": [ { "$ref": "#/definitions/DiscountTypeProperties" } ], "x-ms-discriminator-value": "ProductFamily" }, "DiscountTypeProductSku": { "type": "object", "description": "Discount type properties including product family name, product id, and sku id.", "properties": { "productFamilyName": { "type": "string", "description": "Product family for which the discount is given. Validation: Optional" }, "productId": { "type": "string", "description": "Product ID for which the discount is given. Validation: Optional. No specific format, example: DZH318Z09V6F" }, "skuId": { "type": "string", "description": "ResourceSku for the given discount. Validation: Optional." } }, "allOf": [ { "$ref": "#/definitions/DiscountTypeProperties" } ], "x-ms-discriminator-value": "Sku" }, "DiscountTypeProperties": { "type": "object", "description": "This defines the conditions for a given discount type.", "properties": { "discountType": { "$ref": "#/definitions/DiscountType", "description": "Defines the type of discount. Supported values are ProductFamily, Product, Sku, CustomPrice, and CustomPriceMultiCurrency." }, "applyDiscountOn": { "$ref": "#/definitions/ApplyDiscountOn", "description": "The customer action on which the discount is applied. Supported values are Purchase, Consume, and Renew. Validation: Required, one of supported values." }, "discountPercentage": { "type": "number", "format": "double", "description": "Discount percentage provided for the customer. Validation: Required unless this is a price rule.", "minimum": 0, "maximum": 100 }, "discountCombinationRule": { "$ref": "#/definitions/DiscountCombinationRule", "description": "The discount combination rule when there are multiple applicable custom prices. Validation: Required. Supported values are Stackable and BestOf." }, "priceGuaranteeProperties": { "$ref": "#/definitions/PriceGuaranteeProperties", "description": "Set only in price guarantee scenario." }, "conditions": { "type": "array", "description": "Array of conditions for the discount. Validation: Optional. Maximum length is 1000.", "items": { "$ref": "#/definitions/ConditionsItem" } } }, "discriminator": "discountType", "required": [ "discountType", "applyDiscountOn" ] }, "DiscountValidateModel": { "type": "object", "description": "Discount validate model", "properties": { "properties": { "$ref": "#/definitions/DiscountProperties", "description": "Discount validate properties" } }, "allOf": [ { "$ref": "#/definitions/BenefitValidateModel" } ], "x-ms-discriminator-value": "Discounts" }, "EnablementMode": { "type": "string", "description": "Represents the enablement status of a feature or settings.", "enum": [ "Unknown", "Enabled", "Disabled" ], "x-ms-enum": { "name": "EnablementMode", "modelAsString": true, "values": [ { "name": "Unknown", "value": "Unknown" }, { "name": "Enabled", "value": "Enabled" }, { "name": "Disabled", "value": "Disabled" } ] } }, "EntityTypeAffiliateDiscount": { "type": "object", "description": "Entity type for affiliate discounts", "properties": { "primaryResourceId": { "type": "string", "format": "arm-id", "description": "This will be present in the response if the primary has a resource ID", "readOnly": true, "x-ms-arm-id-details": { "allowedResources": [ { "scopes": [ "ResourceGroup" ], "type": "Microsoft.BillingBenefits/discounts" } ] } }, "endAt": { "type": "string", "format": "date-time", "description": "End date of the discount. No duration will be supported. Allowed value is any date greater than or equal to startDate.", "readOnly": true } }, "allOf": [ { "$ref": "#/definitions/DiscountProperties" } ], "x-ms-discriminator-value": "Affiliate" }, "EntityTypePrimaryDiscount": { "type": "object", "description": "Entity type for primary discounts", "properties": { "discountTypeProperties": { "$ref": "#/definitions/DiscountTypeProperties", "description": "This defines the conditions for a given discount type." }, "endAt": { "type": "string", "format": "date-time", "description": "End date of the discount. No duration will be supported. Allowed value is any date greater than or equal to startDate." } }, "required": [ "endAt" ], "allOf": [ { "$ref": "#/definitions/DiscountProperties" } ], "x-ms-discriminator-value": "Primary" }, "ExtendedStatusInfo": { "type": "object", "properties": { "statusCode": { "type": "string", "description": "Status code providing additional information." }, "message": { "type": "string", "description": "The message giving detailed information about the status code." } } }, "FreeServices": { "type": "object", "description": "Free Services resource definition", "properties": { "properties": { "$ref": "#/definitions/FreeServicesProperties", "description": "Free services properties", "x-ms-client-flatten": true }, "managedBy": { "type": "string", "description": "The fully qualified resource ID of the resource that manages this resource. Indicates if this resource is managed by another Azure resource. If this is present, complete mode deployment will not delete the resource if it is removed from the template since it is managed by another resource.", "x-ms-mutability": [ "read", "update", "create" ] }, "kind": { "type": "string", "description": "Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type. E.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value.", "pattern": "^[-\\w\\._,\\(\\)]+$", "x-ms-mutability": [ "read", "create" ] }, "etag": { "type": "string", "description": "The etag field is *not* required. If it is provided in the response body, it must also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.", "readOnly": true }, "identity": { "$ref": "../../../../../../common-types/resource-management/v6/managedidentity.json#/definitions/ManagedServiceIdentity", "description": "Managed service identity (system assigned and/or user assigned identities)" }, "sku": { "$ref": "#/definitions/Sku", "description": "The resource model definition representing SKU" }, "plan": { "$ref": "#/definitions/Plan", "description": "Plan for the resource." } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/TrackedResource" } ] }, "FreeServicesList": { "type": "object", "description": "This operation lists the free services that are available under the specified subscription.", "properties": { "value": { "type": "array", "description": "The list of free services", "items": { "$ref": "#/definitions/FreeServices" } }, "nextLink": { "type": "string", "description": "The URL to get the next set of results", "readOnly": true } } }, "FreeServicesPatchRequest": { "type": "object", "description": "Free services patch request", "properties": { "properties": { "$ref": "#/definitions/FreeServicesPatchRequestProperties", "description": "Free services patch request properties", "x-ms-client-flatten": true }, "tags": { "type": "object", "description": "Resource tags.", "additionalProperties": { "type": "string" } } } }, "FreeServicesPatchRequestProperties": { "type": "object", "description": "Free services patch request properties", "properties": { "endAt": { "type": "string", "format": "date-time", "description": "Updated expiration date and time of the free services" } } }, "FreeServicesProperties": { "type": "object", "description": "Properties of free services", "properties": { "productCode": { "type": "string", "description": "This is the catalog UPN for the product." }, "displayName": { "type": "string", "description": "Display name" }, "status": { "$ref": "#/definitions/FreeServicesStatus", "description": "Current status of the free services" }, "startAt": { "type": "string", "format": "date-time", "description": "Date and time when the free services become active" }, "endAt": { "type": "string", "format": "date-time", "description": "Expiration date and time of the free services" }, "provisioningState": { "$ref": "#/definitions/BenefitProvisioningState", "description": "Provisioning state of Free Services as assigned by RPaaS. This indicates the last operation's status. For all practical purposes, this can be ignored. For current status of Free Services resource, refer to FreeServicesStatus.", "readOnly": true }, "billingAccountResourceId": { "type": "string", "format": "arm-id", "description": "Fully-qualified identifier of the billing account where the benefit is applied.", "readOnly": true, "x-ms-arm-id-details": { "allowedResources": [ { "scopes": [ "Tenant" ], "type": "Microsoft.Billing/billingAccounts" } ] } }, "billingProfileResourceId": { "type": "string", "format": "arm-id", "description": "Fully-qualified identifier of the billing profile where the benefit is applied.", "readOnly": true, "x-ms-arm-id-details": { "allowedResources": [ { "scopes": [ "Tenant" ], "type": "Microsoft.Billing/billingAccounts/billingProfiles" } ] } }, "customerResourceId": { "type": "string", "format": "arm-id", "description": "Customer resource id where the benefit is scoped to.", "readOnly": true, "x-ms-arm-id-details": { "allowedResources": [ { "scopes": [ "Tenant" ], "type": "Microsoft.Billing/billingAccounts/customers" } ] } }, "invitationId": { "type": "string", "description": "Invitation identifier", "x-ms-mutability": [ "read", "create" ] }, "systemId": { "type": "string", "description": "This is the globally unique identifier of the free services which will not change for its lifetime. Generated by the benefit publisher." }, "productDetails": { "$ref": "#/definitions/ProductDetailsBase", "description": "Product details including SKU title, product family, and product type.", "readOnly": true } } }, "FreeServicesStatus": { "type": "string", "description": "Status of the free services", "enum": [ "Unknown", "Pending", "Active", "Canceled", "Completed" ], "x-ms-enum": { "name": "FreeServicesStatus", "modelAsString": true, "values": [ { "name": "Unknown", "value": "Unknown", "description": "Free services status is unknown" }, { "name": "Pending", "value": "Pending", "description": "Free services are pending activation" }, { "name": "Active", "value": "Active", "description": "Free services are active" }, { "name": "Canceled", "value": "Canceled", "description": "Free services have been canceled" }, { "name": "Completed", "value": "Completed", "description": "Free services have been fully consumed or completed" } ] } }, "InstanceFlexibility": { "type": "string", "description": "Turning this on will apply the reservation discount to other VMs in the same VM size group.", "enum": [ "On", "Off" ], "x-ms-enum": { "name": "InstanceFlexibility", "modelAsString": true, "values": [ { "name": "On", "value": "On" }, { "name": "Off", "value": "Off" } ] } }, "Macc": { "type": "object", "description": "Microsoft Azure Consumption Commitment.", "properties": { "properties": { "$ref": "#/definitions/MaccModelProperties", "description": "MACC properties", "x-ms-client-flatten": true }, "managedBy": { "type": "string", "description": "The fully qualified resource ID of the resource that manages this resource. Indicates if this resource is managed by another Azure resource. If this is present, complete mode deployment will not delete the resource if it is removed from the template since it is managed by another resource.", "x-ms-mutability": [ "read", "update", "create" ] }, "kind": { "type": "string", "description": "Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type. E.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value.", "pattern": "^[-\\w\\._,\\(\\)]+$", "x-ms-mutability": [ "read", "create" ] }, "etag": { "type": "string", "description": "The etag field is *not* required. If it is provided in the response body, it must also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.", "readOnly": true }, "identity": { "$ref": "../../../../../../common-types/resource-management/v6/managedidentity.json#/definitions/ManagedServiceIdentity", "description": "Managed service identity (system assigned and/or user assigned identities)" }, "sku": { "$ref": "#/definitions/Sku", "description": "The resource model definition representing SKU" }, "plan": { "$ref": "#/definitions/Plan", "description": "Plan for the resource." } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/TrackedResource" } ] }, "MaccEntityType": { "type": "string", "description": "Represents type of the object being operated on. Possible values are primary or contributor.", "enum": [ "Primary", "Contributor" ], "x-ms-enum": { "name": "MaccEntityType", "modelAsString": true, "values": [ { "name": "Primary", "value": "Primary" }, { "name": "Contributor", "value": "Contributor" } ] } }, "MaccList": { "type": "object", "description": "MACC list", "properties": { "value": { "type": "array", "description": "The Macc items on this page", "items": { "$ref": "#/definitions/Macc" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "MaccMilestone": { "type": "object", "description": "MACC milestone represents interim targets within the period of MACC.", "properties": { "milestoneId": { "type": "string", "description": "Globally unique identifier for the milestone. Format: {guid}", "x-ms-mutability": [ "read", "create" ] }, "commitment": { "$ref": "#/definitions/Price", "description": "Commitment associated with this milestone." }, "endAt": { "type": "string", "format": "date-time", "description": "End date time for the milestone. Timestamp must be in the ISO date format YYYY-MM-DDT23:59:59Z." }, "automaticShortfall": { "$ref": "#/definitions/EnablementMode", "description": "Setting this to 'Enable' enables automatic shortfall invoicing when milestone commitment is not met." }, "automaticShortfallSuppressReason": { "$ref": "#/definitions/AutomaticShortfallSuppressReason", "description": "Optional field to record suppression reason for automatic shortfall." }, "status": { "$ref": "#/definitions/MaccMilestoneStatus", "description": "Represents the current status of the Milestone." }, "shortfall": { "$ref": "#/definitions/Shortfall", "description": "Details of the shortfall associated with this milestone." } } }, "MaccMilestoneStatus": { "type": "string", "description": "Represents the current status of the Milestone.", "enum": [ "Unknown", "Scheduled", "Active", "Pending", "Failed", "Completed", "Canceled", "Removed", "PendingSettlement", "ShortfallCharged", "ShortfallWaived" ], "x-ms-enum": { "name": "MaccMilestoneStatus", "modelAsString": true, "values": [ { "name": "Unknown", "value": "Unknown" }, { "name": "Scheduled", "value": "Scheduled" }, { "name": "Active", "value": "Active" }, { "name": "Pending", "value": "Pending" }, { "name": "Failed", "value": "Failed" }, { "name": "Completed", "value": "Completed" }, { "name": "Canceled", "value": "Canceled" }, { "name": "Removed", "value": "Removed" }, { "name": "PendingSettlement", "value": "PendingSettlement" }, { "name": "ShortfallCharged", "value": "ShortfallCharged" }, { "name": "ShortfallWaived", "value": "ShortfallWaived" } ] } }, "MaccModelProperties": { "type": "object", "description": "MACC properties", "properties": { "provisioningState": { "$ref": "#/definitions/BenefitProvisioningState", "description": "Provisioning state of MACC as assigned by RPaaS. This indicates the last operation's status. For all practical purposes, this can be ignored. For current status of MACC resource, refer to MaccStatus.", "readOnly": true }, "status": { "$ref": "#/definitions/MaccStatus", "description": "Represents the current status of the MACC." }, "entityType": { "$ref": "#/definitions/MaccEntityType", "description": "Represents type of the object being operated on. Possible values are primary or contributor.", "x-ms-mutability": [ "read", "create" ] }, "displayName": { "type": "string", "description": "Display name" }, "productCode": { "type": "string", "description": "Represents catalog UPN.", "x-ms-mutability": [ "read", "create" ] }, "billingAccountResourceId": { "type": "string", "format": "arm-id", "description": "Fully-qualified identifier of the billing account where the MACC is applied. Present only for Enterprise Agreement customers. Format must be Azure Resource ID: /providers/Microsoft.Billing/billingAccounts/{acctId:orgId}", "x-ms-arm-id-details": { "allowedResources": [ { "scopes": [ "Tenant" ], "type": "Microsoft.Billing/billingAccounts" } ] } }, "commitment": { "$ref": "#/definitions/Commitment", "description": "Commitment towards the benefit." }, "startAt": { "type": "string", "format": "date-time", "description": "Must be start of month. Timestamp must be in the ISO date format YYYY-MM-DDT00:00:00Z." }, "endAt": { "type": "string", "format": "date-time", "description": "Must be end of month. Timestamp must be in the ISO date format YYYY-MM-DDT23:59:59Z." }, "systemId": { "type": "string", "description": "This is the globally unique identifier of the MACC which will not change for the lifetime of the MACC.", "x-ms-mutability": [ "read", "create" ] }, "automaticShortfall": { "$ref": "#/definitions/EnablementMode", "description": "Setting this to 'Enable' enables automatic shortfall charging when commitment is not met." }, "automaticShortfallSuppressReason": { "$ref": "#/definitions/AutomaticShortfallSuppressReason", "description": "Optional field to record suppression reason for automatic shortfall." }, "shortfall": { "$ref": "#/definitions/Shortfall", "description": "MACC shortfall" }, "milestones": { "type": "array", "description": "List of milestones associated with this MACC.", "items": { "$ref": "#/definitions/MaccMilestone" } }, "resourceId": { "type": "string", "format": "arm-id", "description": "This is the resource identifier of either the primary MACC or the contributor. Format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/maccs/{maccName}.", "x-ms-arm-id-details": { "allowedResources": [ { "scopes": [ "ResourceGroup" ], "type": "Microsoft.BillingBenefits/maccs" } ] } }, "allowContributors": { "type": "boolean", "description": "Setting this to true means multi-entity.", "default": false }, "primaryResourceId": { "type": "string", "format": "arm-id", "description": "Fully-qualified resource identifier of the primary MACC. Format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/maccs/{maccName}.", "x-ms-arm-id-details": { "allowedResources": [ { "scopes": [ "ResourceGroup" ], "type": "Microsoft.BillingBenefits/maccs" } ] } }, "primaryBillingAccountResourceId": { "type": "string", "format": "arm-id", "description": "Fully-qualified billing account resource identifier of the primary MACC. Format must be Azure Resource ID: /providers/Microsoft.Billing/billingAccounts/{acctId:orgId}.", "x-ms-arm-id-details": { "allowedResources": [ { "scopes": [ "Tenant" ], "type": "Microsoft.Billing/billingAccounts" } ] } }, "productDetails": { "$ref": "#/definitions/ProductDetailsBase", "description": "Product details including SKU title, product family, and product type.", "readOnly": true }, "appliedScopeType": { "$ref": "#/definitions/BenefitAppliedScopeType", "description": "Type of the applied scope for the MACC." }, "invitationId": { "type": "string", "description": "Invitation identifier", "x-ms-mutability": [ "read", "create" ] }, "consumed": { "$ref": "#/definitions/Price", "description": "Amount of benefit that has been consumed", "readOnly": true } }, "required": [ "entityType" ] }, "MaccPatchRequest": { "type": "object", "description": "Macc patch request", "properties": { "properties": { "$ref": "#/definitions/MaccPatchRequestProperties", "description": "Macc patch request properties", "x-ms-client-flatten": true }, "tags": { "type": "object", "description": "Resource tags.", "additionalProperties": { "type": "string" } } } }, "MaccPatchRequestProperties": { "type": "object", "description": "Macc patch request properties", "properties": { "commitment": { "$ref": "#/definitions/Commitment", "description": "Commitment towards the benefit." }, "endAt": { "type": "string", "format": "date-time", "description": "End DateTime in UTC." }, "allowContributors": { "type": "boolean", "description": "Setting this to true means multi-entity.", "default": false }, "automaticShortfall": { "$ref": "#/definitions/EnablementMode", "description": "Represents the enablement status of a feature or settings." }, "automaticShortfallSuppressReason": { "$ref": "#/definitions/AutomaticShortfallSuppressReason", "description": "Optional field to record suppression reason for automatic shortfall." }, "displayName": { "type": "string", "description": "Display name" }, "status": { "$ref": "#/definitions/MaccMilestoneStatus", "description": "Represents the current status of the Milestone." }, "milestones": { "type": "array", "description": "List of milestones to update or add.", "items": { "$ref": "#/definitions/MaccMilestone" } }, "primaryResourceId": { "type": "string", "format": "arm-id", "description": "Fully-qualified resource identifier of the primary MACC. Format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/maccs/{maccName}.", "x-ms-arm-id-details": { "allowedResources": [ { "scopes": [ "ResourceGroup" ], "type": "Microsoft.BillingBenefits/maccs" } ] } }, "primaryBillingAccountResourceId": { "type": "string", "format": "arm-id", "description": "Fully-qualified billing account resource identifier of the primary MACC. Format must be Azure Resource ID: /providers/Microsoft.Billing/billingAccounts/{acctId:orgId}.", "x-ms-arm-id-details": { "allowedResources": [ { "scopes": [ "Tenant" ], "type": "Microsoft.Billing/billingAccounts" } ] } } } }, "MaccStatus": { "type": "string", "description": "Represents the current status of the MACC.", "enum": [ "Unknown", "Scheduled", "Active", "Pending", "Failed", "Canceled", "Completed", "Stopped", "PendingSettlement", "ShortfallCharged", "ShortfallWaived" ], "x-ms-enum": { "name": "MaccStatus", "modelAsString": true, "values": [ { "name": "Unknown", "value": "Unknown" }, { "name": "Scheduled", "value": "Scheduled" }, { "name": "Active", "value": "Active" }, { "name": "Pending", "value": "Pending" }, { "name": "Failed", "value": "Failed" }, { "name": "Canceled", "value": "Canceled" }, { "name": "Completed", "value": "Completed" }, { "name": "Stopped", "value": "Stopped" }, { "name": "PendingSettlement", "value": "PendingSettlement" }, { "name": "ShortfallCharged", "value": "ShortfallCharged" }, { "name": "ShortfallWaived", "value": "ShortfallWaived" } ] } }, "MaccTransaction": { "type": "object", "description": "Transaction resource definition for Maccs", "properties": { "properties": { "$ref": "#/definitions/TransactionProperties", "description": "Transaction properties" } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" } ] }, "MaccTransactionsList": { "type": "object", "description": "List of Macc transactions", "properties": { "value": { "type": "array", "description": "The MaccTransaction items on this page", "items": { "$ref": "#/definitions/MaccTransaction" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "MaccValidateModel": { "type": "object", "description": "MACC validate model", "properties": { "properties": { "$ref": "#/definitions/MaccModelProperties", "description": "MACC validate properties", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "#/definitions/BenefitValidateModel" } ], "x-ms-discriminator-value": "MACC" }, "MaccsValidateModel": { "type": "object", "description": "Maccs validate model", "properties": { "properties": { "$ref": "#/definitions/MaccModelProperties", "description": "MACC validate properties" } }, "allOf": [ { "$ref": "#/definitions/BenefitValidateModel" } ], "x-ms-discriminator-value": "Maccs" }, "ManagedServiceIdentity": { "type": "object", "description": "Managed service identity (system assigned and/or user assigned identities)", "properties": { "principalId": { "type": "string", "format": "uuid", "description": "The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.", "readOnly": true }, "tenantId": { "type": "string", "format": "uuid", "description": "The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.", "readOnly": true }, "type": { "$ref": "#/definitions/ManagedServiceIdentityType", "description": "Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed)." }, "userAssignedIdentities": { "type": "object", "description": "The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.", "additionalProperties": { "$ref": "../../../../../../common-types/resource-management/v6/managedidentity.json#/definitions/UserAssignedIdentity" } } }, "required": [ "type" ] }, "ManagedServiceIdentityType": { "type": "string", "description": "Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).", "enum": [ "None", "SystemAssigned", "UserAssigned", "SystemAssigned,UserAssigned" ], "x-ms-enum": { "name": "ManagedServiceIdentityType", "modelAsString": true, "values": [ { "name": "None", "value": "None" }, { "name": "SystemAssigned", "value": "SystemAssigned" }, { "name": "UserAssigned", "value": "UserAssigned" }, { "name": "SystemAssigned,UserAssigned", "value": "SystemAssigned,UserAssigned" } ] } }, "MarketSetPricesItems": { "type": "object", "description": "Items in the MarketSetPrices array.", "properties": { "markets": { "type": "array", "items": { "type": "string" } }, "value": { "type": "number", "format": "float", "description": "The locked price for the priceable node. Validation: Required. Must be greater than or equal to 0. If the case of billing plans. This represents the price for each cycle charge." }, "currency": { "type": "string", "description": "The currency of the locked price value. Validation: Required. Must be a valid ISO 4217 3-letter currency code." } }, "required": [ "markets", "value", "currency" ] }, "MilestoneStatus": { "type": "string", "description": "Current status of the milestone", "enum": [ "Unknown", "Scheduled", "Active", "Pending", "Failed", "Completed", "Canceled", "Removed", "PendingSettlement", "Missed" ], "x-ms-enum": { "name": "MilestoneStatus", "modelAsString": true, "values": [ { "name": "Unknown", "value": "Unknown" }, { "name": "Scheduled", "value": "Scheduled" }, { "name": "Active", "value": "Active" }, { "name": "Pending", "value": "Pending" }, { "name": "Failed", "value": "Failed" }, { "name": "Completed", "value": "Completed" }, { "name": "Canceled", "value": "Canceled" }, { "name": "Removed", "value": "Removed" }, { "name": "PendingSettlement", "value": "PendingSettlement" }, { "name": "Missed", "value": "Missed" } ] } }, "PaymentDetail": { "type": "object", "description": "Information about payment related to a savings plan order.", "properties": { "dueDate": { "type": "string", "format": "date", "description": "Date when the payment needs to be done." }, "paymentDate": { "type": "string", "format": "date", "description": "Date when the transaction is completed. Is null when it is scheduled." }, "pricingCurrencyTotal": { "$ref": "#/definitions/Price", "description": "Amount in pricing currency. Tax not included." }, "billingCurrencyTotal": { "$ref": "#/definitions/Price", "description": "Amount charged in Billing currency. Tax not included. Is null for future payments" }, "status": { "$ref": "#/definitions/PaymentStatus", "description": "Describes whether the payment is completed, failed, cancelled or scheduled in the future." }, "extendedStatusInfo": { "$ref": "#/definitions/ExtendedStatusInfo", "readOnly": true }, "billingAccount": { "type": "string", "description": "Billing account" } } }, "PaymentStatus": { "type": "string", "description": "Describes whether the payment is completed, failed, cancelled or scheduled in the future.", "enum": [ "Succeeded", "Failed", "Scheduled", "Cancelled" ], "x-ms-enum": { "name": "PaymentStatus", "modelAsString": true, "values": [ { "name": "Succeeded", "value": "Succeeded" }, { "name": "Failed", "value": "Failed" }, { "name": "Scheduled", "value": "Scheduled" }, { "name": "Cancelled", "value": "Cancelled" } ] }, "readOnly": true }, "Plan": { "type": "object", "description": "Plan for the resource.", "properties": { "name": { "type": "string", "description": "A user defined name of the 3rd Party Artifact that is being procured." }, "publisher": { "type": "string", "description": "The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic" }, "product": { "type": "string", "description": "The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding." }, "promotionCode": { "type": "string", "description": "A publisher provided promotion code as provisioned in Data Market for the said product/artifact." }, "version": { "type": "string", "description": "The version of the desired product/artifact." } }, "required": [ "name", "publisher", "product" ] }, "Price": { "type": "object", "properties": { "currencyCode": { "type": "string", "description": "The ISO 4217 3-letter currency code for the currency used by this purchase record." }, "amount": { "type": "number", "format": "double" } } }, "PriceGuaranteeProperties": { "type": "object", "description": "Set only in price guarantee scenario.", "properties": { "pricingPolicy": { "$ref": "#/definitions/PricingPolicy", "description": "Supported values: Protected, Locked" }, "priceGuaranteeDate": { "type": "string", "format": "date-time", "description": "The date on which prices are to be used for guarantee calculation. Validation: expected to be 00 hours, Format: 2024-09-30T00:00:00Z. Must be in UTC." } } }, "PricingCurrencyDuration": { "type": "string", "description": "Represents either billing plan or savings plan term in ISO 8601 format.", "enum": [ "P1M", "P1Y", "P3Y" ], "x-ms-enum": { "name": "PricingCurrencyDuration", "modelAsString": true, "values": [ { "name": "P1M", "value": "P1M" }, { "name": "P1Y", "value": "P1Y" }, { "name": "P3Y", "value": "P3Y" } ] } }, "PricingCurrencyTotal": { "type": "object", "properties": { "duration": { "$ref": "#/definitions/PricingCurrencyDuration", "description": "Represents either billing plan or savings plan term in ISO 8601 format." } }, "allOf": [ { "$ref": "#/definitions/Price" } ] }, "PricingPolicy": { "type": "string", "description": "Supported values: Protected, Locked", "enum": [ "Protected", "Locked" ], "x-ms-enum": { "name": "PricingPolicy", "modelAsString": true, "values": [ { "name": "Protected", "value": "Protected" }, { "name": "Locked", "value": "Locked" } ] } }, "PrimaryConditionalCreditProperties": { "type": "object", "description": "Properties for primary conditional credit.", "properties": { "systemId": { "type": "string", "description": "System identifier shared between primary and contributor conditional credits representing the same conditional credit program" }, "allowContributors": { "$ref": "#/definitions/EnablementMode", "description": "Whether this conditional credit allows contributor billing accounts" }, "milestones": { "type": "array", "description": "List of milestones for this conditional credit (must include awards)", "items": { "$ref": "#/definitions/ConditionalCreditMilestone" } } }, "allOf": [ { "$ref": "#/definitions/ConditionalCreditProperties" } ], "x-ms-discriminator-value": "Primary" }, "ProductDetailsBase": { "type": "object", "description": "Common product detail properties shared across all benefit resources", "properties": { "skuTitle": { "type": "string", "description": "SKU title of the product" }, "productFamily": { "type": "string", "description": "The product family, for example \"Azure\" or \"M365\"." }, "productType": { "type": "string", "description": "The type of the product." } } }, "ProvisioningState": { "type": "string", "description": "Provisioning state", "enum": [ "Creating", "PendingBilling", "ConfirmedBilling", "Created", "Succeeded", "Cancelled", "Expired", "Failed" ], "x-ms-enum": { "name": "ProvisioningState", "modelAsString": true, "values": [ { "name": "Creating", "value": "Creating" }, { "name": "PendingBilling", "value": "PendingBilling" }, { "name": "ConfirmedBilling", "value": "ConfirmedBilling" }, { "name": "Created", "value": "Created" }, { "name": "Succeeded", "value": "Succeeded" }, { "name": "Cancelled", "value": "Cancelled" }, { "name": "Expired", "value": "Expired" }, { "name": "Failed", "value": "Failed" } ] }, "readOnly": true }, "PurchaseRequest": { "type": "object", "properties": { "sku": { "$ref": "#/definitions/ResourceSku", "description": "The SKU to be applied for this resource" }, "properties": { "$ref": "#/definitions/PurchaseRequestProperties", "x-ms-client-flatten": true } } }, "PurchaseRequestProperties": { "type": "object", "properties": { "displayName": { "type": "string", "description": "Friendly name of the savings plan" }, "billingScopeId": { "type": "string", "description": "Subscription that will be charged for purchasing the benefit" }, "term": { "$ref": "#/definitions/Term", "description": "Represent benefit term in ISO 8601 format." }, "billingPlan": { "$ref": "#/definitions/BillingPlan", "description": "Represents the billing plan in ISO 8601 format. Required only for monthly billing plans." }, "appliedScopeType": { "$ref": "#/definitions/AppliedScopeType", "description": "Type of the Applied Scope." }, "commitment": { "$ref": "#/definitions/Commitment", "description": "Commitment towards the benefit." }, "effectiveDateTime": { "type": "string", "format": "date-time", "description": "DateTime of the savings plan starts providing benefit from.", "readOnly": true }, "renew": { "type": "boolean", "description": "Setting this to true will automatically purchase a new benefit on the expiration date time.", "default": false }, "renewAction": { "$ref": "#/definitions/RenewAction", "description": "Represents the renewal action for a reservation to be a new purchase or existing renewal." }, "appliedScopeProperties": { "$ref": "#/definitions/AppliedScopeProperties", "description": "Properties specific to applied scope type. Not required if not applicable." } } }, "RenewAction": { "type": "string", "description": "Represents the renewal action for a reservation to be a new purchase or existing renewal.", "enum": [ "CreateNew", "RenewExisting" ], "x-ms-enum": { "name": "RenewAction", "modelAsString": true, "values": [ { "name": "CreateNew", "value": "CreateNew", "description": "Represents a new purchase renewal action." }, { "name": "RenewExisting", "value": "RenewExisting", "description": "Represents renewal of an existing reservation." } ] } }, "RenewProperties": { "type": "object", "properties": { "purchaseProperties": { "$ref": "#/definitions/PurchaseRequest" } } }, "ReservationOrderAliasRequest": { "type": "object", "description": "Reservation order alias", "properties": { "sku": { "$ref": "#/definitions/ResourceSku", "description": "Reservation order SKU" }, "location": { "type": "string", "description": "The Azure Region where the reservation benefits are applied to." }, "properties": { "$ref": "#/definitions/ReservationOrderAliasRequestProperties", "description": "Reservation order alias request properties", "x-ms-client-flatten": true } }, "required": [ "sku" ], "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/Resource" } ] }, "ReservationOrderAliasRequestProperties": { "type": "object", "description": "Reservation properties", "properties": { "displayName": { "type": "string", "description": "Display name" }, "billingScopeId": { "type": "string", "description": "Subscription that will be charged for purchasing the benefit" }, "term": { "$ref": "#/definitions/Term", "description": "Represent benefit term in ISO 8601 format." }, "billingPlan": { "$ref": "#/definitions/BillingPlan", "description": "Represents the billing plan in ISO 8601 format. Required only for monthly billing plans." }, "appliedScopeType": { "$ref": "#/definitions/AppliedScopeType", "description": "Type of the Applied Scope." }, "appliedScopeProperties": { "$ref": "#/definitions/AppliedScopeProperties", "description": "Properties specific to applied scope type. Not required if not applicable." }, "quantity": { "type": "integer", "format": "int32", "description": "Total Quantity of the SKUs purchased in the Reservation.", "minimum": 1 }, "renew": { "type": "boolean", "description": "Setting this to true will automatically purchase a new benefit on the expiration date time.", "default": false }, "renewAction": { "$ref": "#/definitions/RenewAction", "description": "Represents the renewal action for a reservation to be a new purchase or existing renewal." }, "reservedResourceType": { "$ref": "#/definitions/ReservedResourceType", "description": "The type of the resource that is being reserved." }, "reviewDateTime": { "type": "string", "format": "date-time", "description": "This is the date-time when the Azure Hybrid Benefit needs to be reviewed." }, "benefitStartTime": { "type": "string", "format": "date-time", "description": "This is the DateTime when the reservation benefit started." }, "reservedResourceProperties": { "$ref": "#/definitions/ReservationOrderAliasRequestPropertiesReservedResourceProperties", "description": "Properties specific to each reserved resource type. Not required if not applicable." } } }, "ReservationOrderAliasRequestPropertiesReservedResourceProperties": { "type": "object", "description": "Properties specific to each reserved resource type. Not required if not applicable.", "properties": { "instanceFlexibility": { "$ref": "#/definitions/InstanceFlexibility", "description": "Turning this on will apply the reservation discount to other VMs in the same VM size group." } } }, "ReservationOrderAliasResponse": { "type": "object", "description": "Reservation order alias", "properties": { "properties": { "$ref": "#/definitions/ReservationOrderAliasResponseProperties", "description": "Reservation order alias response properties", "x-ms-client-flatten": true }, "sku": { "$ref": "#/definitions/ResourceSku", "description": "Reservation order SKU" }, "location": { "type": "string", "description": "The Azure Region where the reserved resource lives." } }, "required": [ "sku" ], "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" } ] }, "ReservationOrderAliasResponseProperties": { "type": "object", "description": "Reservation properties", "properties": { "displayName": { "type": "string", "description": "Display name" }, "reservationOrderId": { "type": "string", "description": "Identifier of the reservation order created", "readOnly": true }, "provisioningState": { "$ref": "#/definitions/ProvisioningState", "description": "Provisioning state", "readOnly": true }, "billingScopeId": { "type": "string", "description": "Subscription that will be charged for purchasing the benefit" }, "term": { "$ref": "#/definitions/Term", "description": "Represent benefit term in ISO 8601 format." }, "billingPlan": { "$ref": "#/definitions/BillingPlan", "description": "Represents the billing plan in ISO 8601 format. Required only for monthly billing plans." }, "appliedScopeType": { "$ref": "#/definitions/AppliedScopeType", "description": "Type of the Applied Scope." }, "appliedScopeProperties": { "$ref": "#/definitions/AppliedScopeProperties", "description": "Properties specific to applied scope type. Not required if not applicable." }, "quantity": { "type": "integer", "format": "int32", "description": "Total Quantity of the SKUs purchased in the Reservation." }, "renew": { "type": "boolean", "description": "Setting this to true will automatically purchase a new benefit on the expiration date time.", "default": false }, "renewAction": { "$ref": "#/definitions/RenewAction", "description": "Represents the renewal action for a reservation to be a new purchase or existing renewal." }, "renewalPurchaseDateTime": { "type": "string", "format": "date-time", "description": "This is the date-time when the reservation was renewed.", "readOnly": true }, "reservedResourceType": { "$ref": "#/definitions/ReservedResourceType", "description": "The type of the resource that is being reserved." }, "reviewDateTime": { "type": "string", "format": "date-time", "description": "This is the date-time when the Reservation needs to be reviewed." }, "benefitStartTime": { "type": "string", "format": "date-time", "description": "This is the DateTime when the reservation benefit started." }, "reservedResourceProperties": { "$ref": "#/definitions/ReservationOrderAliasResponsePropertiesReservedResourceProperties", "description": "Properties specific to each reserved resource type. Not required if not applicable." } } }, "ReservationOrderAliasResponsePropertiesReservedResourceProperties": { "type": "object", "description": "Properties specific to each reserved resource type. Not required if not applicable.", "properties": { "instanceFlexibility": { "$ref": "#/definitions/InstanceFlexibility", "description": "Turning this on will apply the reservation discount to other VMs in the same VM size group." } } }, "ReservedResourceType": { "type": "string", "description": "The type of the resource that is being reserved.", "enum": [ "VirtualMachines", "SqlDatabases", "SuseLinux", "CosmosDb", "RedHat", "SqlDataWarehouse", "VMwareCloudSimple", "RedHatOsa", "Databricks", "AppService", "ManagedDisk", "BlockBlob", "RedisCache", "AzureDataExplorer", "MySql", "MariaDb", "PostgreSql", "DedicatedHost", "SapHana", "SqlAzureHybridBenefit", "AVS", "DataFactory", "NetAppStorage", "AzureFiles", "SqlEdge", "VirtualMachineSoftware" ], "x-ms-enum": { "name": "ReservedResourceType", "modelAsString": true, "values": [ { "name": "VirtualMachines", "value": "VirtualMachines" }, { "name": "SqlDatabases", "value": "SqlDatabases" }, { "name": "SuseLinux", "value": "SuseLinux" }, { "name": "CosmosDb", "value": "CosmosDb" }, { "name": "RedHat", "value": "RedHat" }, { "name": "SqlDataWarehouse", "value": "SqlDataWarehouse" }, { "name": "VMwareCloudSimple", "value": "VMwareCloudSimple" }, { "name": "RedHatOsa", "value": "RedHatOsa" }, { "name": "Databricks", "value": "Databricks" }, { "name": "AppService", "value": "AppService" }, { "name": "ManagedDisk", "value": "ManagedDisk" }, { "name": "BlockBlob", "value": "BlockBlob" }, { "name": "RedisCache", "value": "RedisCache" }, { "name": "AzureDataExplorer", "value": "AzureDataExplorer" }, { "name": "MySql", "value": "MySql" }, { "name": "MariaDb", "value": "MariaDb" }, { "name": "PostgreSql", "value": "PostgreSql" }, { "name": "DedicatedHost", "value": "DedicatedHost" }, { "name": "SapHana", "value": "SapHana" }, { "name": "SqlAzureHybridBenefit", "value": "SqlAzureHybridBenefit" }, { "name": "AVS", "value": "AVS" }, { "name": "DataFactory", "value": "DataFactory" }, { "name": "NetAppStorage", "value": "NetAppStorage" }, { "name": "AzureFiles", "value": "AzureFiles" }, { "name": "SqlEdge", "value": "SqlEdge" }, { "name": "VirtualMachineSoftware", "value": "VirtualMachineSoftware" } ] } }, "ResourceSku": { "type": "object", "properties": { "name": { "type": "string" } } }, "ResourceType": { "type": "string", "description": "The top-level ARM resource type for a billing benefit (e.g., maccs, credits, savingsPlans, reservations).", "enum": [ "Maccs", "Credits", "ConditionalCredits", "Discounts", "FreeServices", "SavingsPlans", "Reservations" ], "x-ms-enum": { "name": "ResourceType", "modelAsString": true, "values": [ { "name": "Maccs", "value": "Maccs", "description": "Microsoft Azure Consumption Commitments" }, { "name": "Credits", "value": "Credits", "description": "Credits applied to the customer's billing account" }, { "name": "ConditionalCredits", "value": "ConditionalCredits", "description": "Conditional Credits" }, { "name": "Discounts", "value": "Discounts", "description": "Discounts that reduce charges on eligible services" }, { "name": "FreeServices", "value": "FreeServices", "description": "Services provided at no charge under the billing agreement" }, { "name": "SavingsPlans", "value": "SavingsPlans", "description": "Savings Plan" }, { "name": "Reservations", "value": "Reservations", "description": "Reserved capacity or reserved instances" } ] } }, "RoleAssignmentEntity": { "type": "object", "description": "Role assignment entity", "properties": { "id": { "type": "string", "description": "Role assignment entity id" }, "name": { "type": "string", "description": "Role assignment entity name" }, "properties": { "$ref": "#/definitions/RoleAssignmentEntityProperties", "description": "Role assignment entity properties", "x-ms-client-flatten": true } } }, "RoleAssignmentEntityProperties": { "type": "object", "description": "Role assignment entity properties", "properties": { "principalId": { "type": "string", "description": "Principal Id" }, "roleDefinitionId": { "type": "string", "description": "Role definition id" }, "scope": { "type": "string", "description": "Scope of the role assignment entity" } } }, "SavingsPlanModel": { "type": "object", "description": "Savings plan", "properties": { "properties": { "$ref": "#/definitions/SavingsPlanModelProperties", "description": "Savings plan properties", "x-ms-client-flatten": true }, "sku": { "$ref": "#/definitions/ResourceSku", "description": "Savings plan SKU" } }, "required": [ "sku" ], "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" } ] }, "SavingsPlanModelList": { "type": "object", "description": "Paged collection of SavingsPlanModel items", "properties": { "value": { "type": "array", "description": "The SavingsPlanModel items on this page", "items": { "$ref": "#/definitions/SavingsPlanModel" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "SavingsPlanModelListResult": { "type": "object", "description": "Represents the result of listing savings plan models", "properties": { "value": { "type": "array", "description": "The list of savings plans.", "items": { "$ref": "#/definitions/SavingsPlanModel" }, "readOnly": true }, "nextLink": { "type": "string", "description": "Url to get the next page.", "readOnly": true }, "additionalProperties": { "type": "array", "description": "The roll out count summary of the savings plans", "items": { "$ref": "#/definitions/SavingsPlanSummary" }, "readOnly": true } } }, "SavingsPlanModelProperties": { "type": "object", "description": "Savings plan properties", "properties": { "displayName": { "type": "string", "description": "Display name" }, "provisioningState": { "$ref": "#/definitions/ProvisioningState", "description": "Provisioning state", "readOnly": true }, "displayProvisioningState": { "type": "string", "description": "The provisioning state of the savings plan for display, e.g. Succeeded", "readOnly": true }, "billingScopeId": { "type": "string", "description": "Subscription that will be charged for purchasing the benefit" }, "billingProfileId": { "type": "string", "format": "arm-id", "description": "Fully-qualified identifier of the billing profile where the benefit is applied. Present only for Field-led or Customer-led customers.", "readOnly": true, "x-ms-arm-id-details": { "allowedResources": [ { "scopes": [ "Tenant" ], "type": "Microsoft.Billing/billingAccounts/billingProfiles" } ] } }, "customerId": { "type": "string", "format": "arm-id", "description": "Fully-qualified identifier of the customer where the savings plan is applied. Present only for Partner-led customers.", "readOnly": true, "x-ms-arm-id-details": { "allowedResources": [ { "scopes": [ "Tenant" ], "type": "Microsoft.Billing/billingAccounts/customers" } ] } }, "billingAccountId": { "type": "string", "format": "arm-id", "description": "Fully-qualified identifier of the billing account where the benefit is applied. Present only for Enterprise Agreement customers.", "readOnly": true, "x-ms-arm-id-details": { "allowedResources": [ { "scopes": [ "Tenant" ], "type": "Microsoft.Billing/billingAccounts" } ] } }, "term": { "$ref": "#/definitions/Term", "description": "Represent benefit term in ISO 8601 format." }, "billingPlan": { "$ref": "#/definitions/BillingPlan", "description": "Represents the billing plan in ISO 8601 format. Required only for monthly billing plans." }, "appliedScopeType": { "$ref": "#/definitions/AppliedScopeType", "description": "Type of the Applied Scope." }, "userFriendlyAppliedScopeType": { "type": "string", "description": "The applied scope type of the savings plan for display, e.g. Shared", "readOnly": true }, "appliedScopeProperties": { "$ref": "#/definitions/AppliedScopeProperties", "description": "Properties specific to applied scope type. Not required if not applicable." }, "commitment": { "$ref": "#/definitions/Commitment", "description": "Commitment towards the benefit." }, "effectiveDateTime": { "type": "string", "format": "date-time", "description": "DateTime of the savings plan starts providing benefit from.", "readOnly": true }, "expiryDateTime": { "type": "string", "format": "date-time", "description": "Expiry date time", "readOnly": true }, "purchaseDateTime": { "type": "string", "format": "date-time", "description": "Date time when the savings plan was purchased", "readOnly": true }, "benefitStartTime": { "type": "string", "format": "date-time", "description": "This is the DateTime when the savings plan benefit started." }, "extendedStatusInfo": { "$ref": "#/definitions/ExtendedStatusInfo", "readOnly": true }, "renew": { "type": "boolean", "description": "Setting this to true will automatically purchase a new benefit on the expiration date time.", "default": false }, "utilization": { "$ref": "#/definitions/Utilization", "description": "Savings plan utilization", "readOnly": true }, "renewSource": { "type": "string", "description": "SavingsPlan Id of the SavingsPlan from which this SavingsPlan is renewed." }, "renewDestination": { "type": "string", "description": "SavingsPlan Id of the SavingsPlan which is purchased because of renew." }, "renewProperties": { "$ref": "#/definitions/RenewProperties" } } }, "SavingsPlanOrderAliasModel": { "type": "object", "description": "Savings plan order alias", "properties": { "properties": { "$ref": "#/definitions/SavingsPlanOrderAliasProperties", "description": "Savings plan order alias properties", "x-ms-client-flatten": true }, "sku": { "$ref": "#/definitions/ResourceSku", "description": "Savings plan SKU" }, "kind": { "type": "string", "description": "Resource provider kind" } }, "required": [ "sku" ], "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" } ] }, "SavingsPlanOrderAliasProperties": { "type": "object", "description": "Savings plan properties", "properties": { "displayName": { "type": "string", "description": "Display name" }, "savingsPlanOrderId": { "type": "string", "description": "Identifier of the savings plan created", "readOnly": true }, "provisioningState": { "$ref": "#/definitions/ProvisioningState", "description": "Provisioning state", "readOnly": true }, "billingScopeId": { "type": "string", "description": "Subscription that will be charged for purchasing the benefit" }, "term": { "$ref": "#/definitions/Term", "description": "Represent benefit term in ISO 8601 format." }, "billingPlan": { "$ref": "#/definitions/BillingPlan", "description": "Represents the billing plan in ISO 8601 format. Required only for monthly billing plans." }, "appliedScopeType": { "$ref": "#/definitions/AppliedScopeType", "description": "Type of the Applied Scope." }, "appliedScopeProperties": { "$ref": "#/definitions/AppliedScopeProperties", "description": "Properties specific to applied scope type. Not required if not applicable." }, "commitment": { "$ref": "#/definitions/Commitment", "description": "Commitment towards the benefit." }, "renew": { "type": "boolean", "description": "Setting this to true will automatically purchase a new benefit on the expiration date time.", "default": false } } }, "SavingsPlanOrderModel": { "type": "object", "description": "Savings plan order", "properties": { "properties": { "$ref": "#/definitions/SavingsPlanOrderModelProperties", "description": "Savings plan order properties", "x-ms-client-flatten": true }, "sku": { "$ref": "#/definitions/ResourceSku", "description": "Savings plan SKU" } }, "required": [ "sku" ], "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" } ] }, "SavingsPlanOrderModelList": { "type": "object", "description": "Paged collection of SavingsPlanOrderModel items", "properties": { "value": { "type": "array", "description": "The SavingsPlanOrderModel items on this page", "items": { "$ref": "#/definitions/SavingsPlanOrderModel" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "SavingsPlanOrderModelProperties": { "type": "object", "description": "Savings plan order properties", "properties": { "displayName": { "type": "string", "description": "Display name" }, "provisioningState": { "$ref": "#/definitions/ProvisioningState", "description": "Provisioning state", "readOnly": true }, "billingScopeId": { "type": "string", "description": "Subscription that will be charged for purchasing the benefit" }, "billingProfileId": { "type": "string", "format": "arm-id", "description": "Fully-qualified identifier of the billing profile where the benefit is applied. Present only for Field-led or Customer-led customers.", "readOnly": true, "x-ms-arm-id-details": { "allowedResources": [ { "scopes": [ "Tenant" ], "type": "Microsoft.Billing/billingAccounts/billingProfiles" } ] } }, "customerId": { "type": "string", "format": "arm-id", "description": "Fully-qualified identifier of the customer where the savings plan is applied. Present only for Partner-led customers.", "readOnly": true, "x-ms-arm-id-details": { "allowedResources": [ { "scopes": [ "Tenant" ], "type": "Microsoft.Billing/billingAccounts/customers" } ] } }, "billingAccountId": { "type": "string", "format": "arm-id", "description": "Fully-qualified identifier of the billing account where the benefit is applied. Present only for Enterprise Agreement customers.", "readOnly": true, "x-ms-arm-id-details": { "allowedResources": [ { "scopes": [ "Tenant" ], "type": "Microsoft.Billing/billingAccounts" } ] } }, "term": { "$ref": "#/definitions/Term", "description": "Represent benefit term in ISO 8601 format." }, "billingPlan": { "$ref": "#/definitions/BillingPlan", "description": "Represents the billing plan in ISO 8601 format. Required only for monthly billing plans." }, "expiryDateTime": { "type": "string", "format": "date-time", "description": "Expiry date time", "readOnly": true }, "benefitStartTime": { "type": "string", "format": "date-time", "description": "This is the DateTime when the savings plan benefit started." }, "planInformation": { "$ref": "#/definitions/BillingPlanInformation", "description": "Information describing the type of billing plan for this savings plan." }, "savingsPlans": { "type": "array", "items": { "type": "string" } }, "extendedStatusInfo": { "$ref": "#/definitions/ExtendedStatusInfo", "readOnly": true } } }, "SavingsPlanSummary": { "type": "object", "description": "Savings plans list summary", "properties": { "name": { "type": "string", "description": "This property has value 'summary'", "readOnly": true }, "value": { "$ref": "#/definitions/SavingsPlanSummaryCount", "description": "The roll up count summary of savings plans in each state" } } }, "SavingsPlanSummaryCount": { "type": "object", "description": "The roll up count summary of savings plans in each state", "properties": { "succeededCount": { "type": "number", "format": "float", "description": "The number of savings plans in Succeeded state", "readOnly": true }, "failedCount": { "type": "number", "format": "float", "description": "The number of savings plans in Failed state", "readOnly": true }, "expiringCount": { "type": "number", "format": "float", "description": "The number of savings plans in Expiring state", "readOnly": true }, "expiredCount": { "type": "number", "format": "float", "description": "The number of savings plans in Expired state", "readOnly": true }, "pendingCount": { "type": "number", "format": "float", "description": "The number of savings plans in Pending state", "readOnly": true }, "cancelledCount": { "type": "number", "format": "float", "description": "The number of savings plans in Cancelled state", "readOnly": true }, "processingCount": { "type": "number", "format": "float", "description": "The number of savings plans in Processing state", "readOnly": true }, "noBenefitCount": { "type": "number", "format": "float", "description": "The number of savings plans in No Benefit state", "readOnly": true }, "warningCount": { "type": "number", "format": "float", "description": "The number of savings plans in Warning state", "readOnly": true } } }, "SavingsPlanUpdateRequest": { "type": "object", "description": "Savings plan patch request", "properties": { "properties": { "$ref": "#/definitions/SavingsPlanUpdateRequestProperties", "description": "Savings plan patch request" } } }, "SavingsPlanUpdateRequestProperties": { "type": "object", "description": "Savings plan patch request", "properties": { "displayName": { "type": "string", "description": "Display name" }, "appliedScopeType": { "$ref": "#/definitions/AppliedScopeType", "description": "Type of the Applied Scope." }, "appliedScopeProperties": { "$ref": "#/definitions/AppliedScopeProperties", "description": "Properties specific to applied scope type. Not required if not applicable." }, "renew": { "type": "boolean", "description": "Setting this to true will automatically purchase a new benefit on the expiration date time.", "default": false }, "renewProperties": { "$ref": "#/definitions/RenewProperties" } } }, "SavingsPlanUpdateValidateRequest": { "type": "object", "properties": { "benefits": { "type": "array", "items": { "$ref": "#/definitions/SavingsPlanUpdateRequestProperties" }, "x-ms-identifiers": [] } } }, "SavingsPlanValidResponseProperty": { "type": "object", "description": "Benefit scope response property", "properties": { "valid": { "type": "boolean", "description": "Indicates if the provided input was valid" }, "reasonCode": { "type": "string", "description": "Failure reason code if the provided input was invalid" }, "reason": { "type": "string", "description": "Failure reason if the provided input was invalid" } } }, "SavingsPlanValidateModel": { "type": "object", "description": "Savings plan validate model", "properties": { "properties": { "$ref": "#/definitions/SavingsPlanOrderAliasProperties", "description": "Savings plan order alias properties", "x-ms-client-flatten": true }, "id": { "type": "string", "format": "arm-id", "description": "Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}", "readOnly": true }, "name": { "type": "string", "description": "The name of the resource", "readOnly": true }, "type": { "$ref": "#/definitions/Azure.Core.armResourceType", "description": "The type of the resource. E.g. \"Microsoft.Compute/virtualMachines\" or \"Microsoft.Storage/storageAccounts\"", "readOnly": true }, "systemData": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/systemData", "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information.", "readOnly": true }, "sku": { "$ref": "#/definitions/ResourceSku", "description": "Savings plan SKU" }, "kind": { "type": "string", "description": "Resource provider kind" } }, "required": [ "sku" ], "allOf": [ { "$ref": "#/definitions/BenefitValidateModel" } ], "x-ms-discriminator-value": "SavingsPlan" }, "SavingsPlanValidateResponse": { "type": "object", "properties": { "benefits": { "type": "array", "items": { "$ref": "#/definitions/SavingsPlanValidResponseProperty" }, "x-ms-identifiers": [] }, "nextLink": { "type": "string", "description": "Url to get the next page." } } }, "SavingsPlansValidateModel": { "type": "object", "description": "Savings Plans validate model", "properties": { "properties": { "$ref": "#/definitions/SavingsPlanOrderAliasProperties", "description": "Savings plan order alias properties" }, "id": { "type": "string", "format": "arm-id", "description": "Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}", "readOnly": true }, "name": { "type": "string", "description": "The name of the resource", "readOnly": true }, "type": { "$ref": "#/definitions/Azure.Core.armResourceType", "description": "The type of the resource. E.g. \"Microsoft.Compute/virtualMachines\" or \"Microsoft.Storage/storageAccounts\"", "readOnly": true }, "systemData": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/systemData", "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information.", "readOnly": true }, "sku": { "$ref": "#/definitions/ResourceSku", "description": "Savings plan SKU" }, "kind": { "type": "string", "description": "Resource provider kind" } }, "required": [ "sku" ], "allOf": [ { "$ref": "#/definitions/BenefitValidateModel" } ], "x-ms-discriminator-value": "SavingsPlans" }, "SellerResourceListRequest": { "type": "object", "description": "List MACCs under a billing account", "properties": { "properties": { "$ref": "#/definitions/SellerResourceListRequestProperties", "description": "Request properties to list maccs under a billing account", "x-ms-client-flatten": true } } }, "SellerResourceListRequestProperties": { "type": "object", "description": "Request properties to list maccs under a billing account", "properties": { "billingAccountResourceId": { "type": "string", "format": "arm-id", "description": "Fully-qualified billing account resource identifier where the benefit is applied. Present only for Enterprise Agreement customers.", "x-ms-arm-id-details": { "allowedResources": [ { "scopes": [ "Tenant" ], "type": "Microsoft.Billing/billingAccounts" } ] } }, "$filter": { "type": "string", "description": "This is an OData expresssion to filter the list of MACCs based on the properties of MACC passed in the filter." }, "contributors": { "type": "boolean", "description": "Setting it to true will return the list of contributors associated with the MACC." }, "milestones": { "type": "boolean", "description": "Setting it to true will return the list of milestones associated with the MACC." }, "primaryResourceId": { "type": "string", "format": "arm-id", "description": "Fully-qualified resource identifier of the primary MACC. Format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/maccs/{maccName}.", "x-ms-arm-id-details": { "allowedResources": [ { "scopes": [ "ResourceGroup" ], "type": "Microsoft.BillingBenefits/maccs" } ] } } }, "required": [ "billingAccountResourceId" ] }, "Shortfall": { "type": "object", "description": "MACC shortfall", "properties": { "productCode": { "type": "string", "description": "Represents catalog UPN.", "x-ms-mutability": [ "read", "create" ] }, "charge": { "$ref": "#/definitions/Commitment", "description": "Shortfall amount with grain." }, "startAt": { "type": "string", "format": "date-time", "description": "Start DateTime." }, "endAt": { "type": "string", "format": "date-time", "description": "End DateTime in UTC." }, "resourceId": { "type": "string", "format": "arm-id", "description": "Fully-qualified resource identifier of the credits associated with the shortfall." }, "balanceVersion": { "type": "number", "format": "float", "description": "Points to BalanceVersion document that indicates the remaining commitment balance when the credit was created." }, "systemId": { "type": "string", "description": "This is an identifier of the shortfall which will not change for its lifetime.", "x-ms-mutability": [ "read", "create" ] } } }, "Sku": { "type": "object", "description": "The resource model definition representing SKU", "properties": { "name": { "type": "string", "description": "The name of the SKU. E.g. P3. It is typically a letter+number code" }, "tier": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/SkuTier", "description": "This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT." }, "size": { "type": "string", "description": "The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code." }, "family": { "type": "string", "description": "If the service has different generations of hardware, for the same SKU, then that can be captured here." }, "capacity": { "type": "integer", "format": "int32", "description": "If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted." } }, "required": [ "name" ] }, "Term": { "type": "string", "description": "Represent benefit term in ISO 8601 format.", "enum": [ "P1M", "P1Y", "P3Y", "P5Y" ], "x-ms-enum": { "name": "Term", "modelAsString": true, "values": [ { "name": "P1M", "value": "P1M" }, { "name": "P1Y", "value": "P1Y" }, { "name": "P3Y", "value": "P3Y" }, { "name": "P5Y", "value": "P5Y" } ] } }, "TransactionBillingStatus": { "type": "string", "description": "Billing lifecycle status of a transaction.", "enum": [ "Open", "Closed" ], "x-ms-enum": { "name": "TransactionBillingStatus", "modelAsString": true, "values": [ { "name": "Open", "value": "Open", "description": "Charge may still change." }, { "name": "Closed", "value": "Closed", "description": "Charge is finalized." } ] } }, "TransactionChargeType": { "type": "string", "description": "The type of charge for a transaction.", "enum": [ "Usage", "Purchase", "Refund" ], "x-ms-enum": { "name": "TransactionChargeType", "modelAsString": true, "values": [ { "name": "Usage", "value": "Usage", "description": "Usage charge. Applicable to all benefits." }, { "name": "Purchase", "value": "Purchase", "description": "Purchase charge. Applicable to MACC, CACO, ACO, MC only." }, { "name": "Refund", "value": "Refund", "description": "Refund charge. Applicable to all benefits." } ] } }, "TransactionProductDetails": { "type": "object", "description": "Product details for a transaction", "properties": { "skuTitle": { "type": "string", "description": "SKU title of the product" }, "productFamily": { "type": "string", "description": "The product family, for example \"Azure\" or \"M365\"." }, "productType": { "type": "string", "description": "The type of the product." }, "serviceFamily": { "type": "string", "description": "Grouping of Azure services by core function (e.g., Compute, Databases)." }, "publisherType": { "type": "string", "description": "The publisher type of the product, for example \"Microsoft\" for first-party or a third-party publisher name. Additional values may be introduced in the future." } } }, "TransactionProperties": { "type": "object", "description": "Properties of a transaction", "properties": { "provisioningState": { "$ref": "#/definitions/BenefitProvisioningState", "description": "Provisioning state of the transaction as assigned by RPaaS. This indicates the last operation's status.", "readOnly": true }, "date": { "type": "string", "format": "date-time", "description": "This is the DateTime when the transaction occurred." }, "chargeType": { "$ref": "#/definitions/TransactionChargeType", "description": "The type of charge for this transaction." }, "billingStatus": { "$ref": "#/definitions/TransactionBillingStatus", "description": "Billing lifecycle status of this transaction." }, "invoiceResourceId": { "type": "string", "format": "arm-id", "description": "Fully-qualified identifier of the invoice.", "x-ms-arm-id-details": { "allowedResources": [ { "scopes": [ "Tenant" ], "type": "Microsoft.Billing/billingAccounts" } ] } }, "amountInBillingCurrency": { "$ref": "#/definitions/Price", "description": "Transaction amount in billing currency." }, "amountInPricingCurrency": { "$ref": "#/definitions/Price", "description": "Transaction amount in pricing currency." }, "productCode": { "type": "string", "description": "Catalog UPN for the product associated with this transaction." }, "productDetails": { "$ref": "#/definitions/TransactionProductDetails", "description": "Product details including SKU title, SKU properties, product family, type, and publisher type." } } }, "TransactionsList": { "type": "object", "description": "List of transactions", "properties": { "value": { "type": "array", "description": "The CreditTransaction items on this page", "items": { "$ref": "#/definitions/CreditTransaction" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "Utilization": { "type": "object", "description": "Savings plan utilization", "properties": { "trend": { "type": "string", "description": "The number of days trend for a savings plan", "readOnly": true }, "aggregates": { "type": "array", "description": "The array of aggregates of a savings plan's utilization", "items": { "$ref": "#/definitions/UtilizationAggregates" }, "x-ms-identifiers": [] } } }, "UtilizationAggregates": { "type": "object", "description": "The aggregate values of savings plan utilization", "properties": { "grain": { "type": "number", "format": "float", "description": "The grain of the aggregate", "readOnly": true }, "grainUnit": { "type": "string", "description": "The grain unit of the aggregate", "readOnly": true }, "value": { "type": "number", "format": "float", "description": "The aggregate value", "readOnly": true }, "valueUnit": { "type": "string", "description": "The aggregate value unit", "readOnly": true } } } }, "parameters": { "CatalogGroupsListParameters": { "name": "$filter", "in": "query", "description": "OData filter expression to narrow the list of catalog groups.", "required": false, "type": "string", "x-ms-parameter-location": "method" } } }