Microsoft.BillingBenefits (preview:2024-11-01)

2025/08/15 • 15 updated methods

Discounts_ScopeList (updated)
Description :  List discounts that are applicable for a given scope. Currently supported scopes: billing accounts
Reference :  Link ¶

⚶ Changes

{
  "#id": "Discounts_ScopeList",
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The Discount items on this page",
            "old": "List of discounts."
          },
          "Required": {
            "new": true,
            "old": false
          },
          "$items": {
            "$properties": {
              "@added_264b99cd850f4e9493504bf966314338": {
                "#name": "managedBy",
                "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.",
                "Required": false,
                "Type": "string"
              },
              "@added_358ab10eed764c1e9eae537fab02c86b": {
                "#name": "kind",
                "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.",
                "Required": false,
                "Type": "string"
              },
              "@added_26099eeba39c43d58d6ee30619b33a3c": {
                "#name": "etag",
                "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.",
                "Required": false,
                "Type": "string"
              },
              "@added_3db7e4672639431787e535f522068a61": {
                "#name": "identity",
                "Description": "Managed service identity (system assigned and/or user assigned identities)",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "principalId",
                    "Description": "The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.",
                    "Format": "uuid",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "tenantId",
                    "Description": "The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.",
                    "Format": "uuid",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "type",
                    "Description": "Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).",
                    "Enum": [
                      [
                        "None",
                        ""
                      ],
                      [
                        "SystemAssigned",
                        ""
                      ],
                      [
                        "UserAssigned",
                        ""
                      ],
                      [
                        "SystemAssigned,UserAssigned",
                        ""
                      ]
                    ],
                    "Required": true,
                    "Type": "string"
                  },
                  {
                    "#name": "userAssignedIdentities",
                    "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.",
                    "Required": false,
                    "Type": "object"
                  }
                ]
              },
              "@added_7e2cb2d79e1e46e49bd03a7e3bacb6bd": {
                "#name": "sku",
                "Description": "The resource model definition representing SKU",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "name",
                    "Description": "The name of the SKU. E.g. P3. It is typically a letter+number code",
                    "Required": true,
                    "Type": "string"
                  },
                  {
                    "#name": "tier",
                    "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.",
                    "Enum": [
                      [
                        "Free",
                        ""
                      ],
                      [
                        "Basic",
                        ""
                      ],
                      [
                        "Standard",
                        ""
                      ],
                      [
                        "Premium",
                        ""
                      ]
                    ],
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "size",
                    "Description": "The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "family",
                    "Description": "If the service has different generations of hardware, for the same SKU, then that can be captured here.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "capacity",
                    "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.",
                    "Format": "int32",
                    "Required": false,
                    "Type": "integer"
                  }
                ]
              },
              "@added_9714e4287d9945e69a9fd40e7cdc6780": {
                "#name": "plan",
                "Description": "Plan for the resource.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "name",
                    "Description": "A user defined name of the 3rd Party Artifact that is being procured.",
                    "Required": true,
                    "Type": "string"
                  },
                  {
                    "#name": "publisher",
                    "Description": "The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic",
                    "Required": true,
                    "Type": "string"
                  },
                  {
                    "#name": "product",
                    "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.",
                    "Required": true,
                    "Type": "string"
                  },
                  {
                    "#name": "promotionCode",
                    "Description": "A publisher provided promotion code as provisioned in Data Market for the said product/artifact.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "version",
                    "Description": "The version of the desired product/artifact.",
                    "Required": false,
                    "Type": "string"
                  }
                ]
              }
            }
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "Url to get the next page."
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /{scope}/providers/Microsoft.BillingBenefits/applicableDiscounts
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
scope:
{
Description: The scope at which the benefits are listed. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Discount items on this page ,
Required: True ,
}
[
{
properties:
{
Description: Discount properties ,
Required: False ,
}
{
entityType:
{
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: No description available. ,
Affiliate: No description available. ,
}
,
Required: True ,
}
enum ,
productCode:
{
Description: This is the catalog UPN for the product. ,
Required: True ,
}
string ,
startAt:
{
Description: Start date of the discount. Value is the date the discount started or will start in the future. ,
Format: date-time ,
Required: True ,
}
string ,
systemId:
{
Description: This is the globally unique identifier of the Discount which will not change for the lifetime of the Discount. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The state of the resource. Supported values are Pending, Failed, Succeeded, Canceled. ,
Enum:
{
Unknown: No description available. ,
Pending: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
billingAccountResourceId:
{
Description: Billing account resource id where the discount metadata is present. ,
Format: arm-id ,
Required: False ,
}
string ,
billingProfileResourceId:
{
Description: Billing profile resource id where the discount is scoped to. ,
Format: arm-id ,
Required: False ,
}
string ,
customerResourceId:
{
Description: Customer resource id where the discount is scoped to. ,
Format: arm-id ,
Required: False ,
}
string ,
displayName:
{
Description: This defines a user friendly display name for the discount. ,
Required: False ,
}
string ,
status:
{
Description: Represents the current status of the discount. ,
Enum:
{
Active: No description available. ,
Pending: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Expired: No description available. ,
}
,
Required: False ,
}
enum ,
benefitResourceId:
{
Description: Fully-qualified identifier of the benefit under applicable benefit list. ,
Format: arm-id ,
Required: False ,
}
string ,
appliedScopeType:
{
Description: List of applied scopes supported for discounts. ,
Enum:
{
BillingAccount: No description available. ,
BillingProfile: No description available. ,
Customer: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
managedBy:
{
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. ,
Required: False ,
}
string ,
kind:
{
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. ,
Required: False ,
}
string ,
etag:
{
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. ,
Required: False ,
}
string ,
identity:
{
Description: Managed service identity (system assigned and/or user assigned identities) ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
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. ,
Required: False ,
}
object ,
}
,
sku:
{
Description: The resource model definition representing SKU ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. E.g. P3. It is typically a letter+number code ,
Required: True ,
}
string ,
tier:
{
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. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
plan:
{
Description: Plan for the resource. ,
Required: False ,
}
{
name:
{
Description: A user defined name of the 3rd Party Artifact that is being procured. ,
Required: True ,
}
string ,
publisher:
{
Description: The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic ,
Required: True ,
}
string ,
product:
{
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. ,
Required: True ,
}
string ,
promotionCode:
{
Description: A publisher provided promotion code as provisioned in Data Market for the said product/artifact. ,
Required: False ,
}
string ,
version:
{
Description: The version of the desired product/artifact. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Operations_List (updated)
Description :  List the operations for the provider
Reference :  Link ¶

⚶ Changes

{
  "#id": "Operations_List",
  "Description": {
    "new": "List the operations for the provider",
    "old": "List all the operations."
  }
}

⚼ Request

GET:  /providers/Microsoft.BillingBenefits/operations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of operations supported by the resource provider ,
Required: False ,
}
[
{
name:
{
Description: The name of the operation, as per Resource-Based Access Control (RBAC). Examples: "Microsoft.Compute/virtualMachines/write", "Microsoft.Compute/virtualMachines/capture/action" ,
Required: False ,
}
string ,
isDataAction:
{
Description: Whether the operation applies to data-plane. This is "true" for data-plane operations and "false" for ARM/control-plane operations. ,
Required: False ,
}
boolean ,
display:
{
Description: Localized display information for this particular operation. ,
Required: False ,
}
{
provider:
{
Description: The localized friendly form of the resource provider name, e.g. "Microsoft Monitoring Insights" or "Microsoft Compute". ,
Required: False ,
}
string ,
resource:
{
Description: The localized friendly name of the resource type related to this operation. E.g. "Virtual Machines" or "Job Schedule Collections". ,
Required: False ,
}
string ,
operation:
{
Description: The concise, localized friendly name for the operation; suitable for dropdowns. E.g. "Create or Update Virtual Machine", "Restart Virtual Machine". ,
Required: False ,
}
string ,
description:
{
Description: The short, localized friendly description of the operation; suitable for tool tips and detailed views. ,
Required: False ,
}
string ,
}
,
origin:
{
Description: The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" ,
Enum:
{
user: No description available. ,
system: No description available. ,
user,system: No description available. ,
}
,
Required: False ,
}
enum ,
actionType:
{
Description: Enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. ,
Enum:
{
Internal: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results (if there are any). ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ReservationOrderAlias_Create (updated)
Description :  Create a reservation order alias.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ReservationOrderAlias_Create",
  "$responses": {
    "201": [
      {
        "#name": "azure-asyncoperation",
        "Description": {
          "new": "A link to the status monitor",
          "old": "URL for checking the ongoing status of the operation."
        }
      },
      {
        "#name": "retry-after",
        "Description": {
          "new": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
          "old": "Clients should wait for the Retry-After interval before polling again"
        }
      }
    ]
  }
}

⚼ Request

PUT:  /providers/Microsoft.BillingBenefits/reservationOrderAliases/{reservationOrderAliasName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
reservationOrderAliasName:
{
Description: Name of the reservation order alias ,
Required: True ,
}
string ,
body:
{
Description: Request body for creating a reservation order alias ,
Required: True ,
}
{
sku:
{
Description: Reservation order SKU ,
Required: True ,
}
{
name:
{
Required: False ,
}
string ,
}
,
location:
{
Description: The Azure Region where the reservation benefits are applied to. ,
Required: False ,
}
string ,
properties:
{
Description: Reservation order alias request properties ,
Required: False ,
}
{
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
billingScopeId:
{
Description: Subscription that will be charged for purchasing the benefit ,
Required: False ,
}
string ,
term:
{
Description: Represent benefit term in ISO 8601 format. ,
Enum:
{
P1Y: No description available. ,
P3Y: No description available. ,
P5Y: No description available. ,
}
,
Required: False ,
}
enum ,
billingPlan:
{
Description: Represents the billing plan in ISO 8601 format. Required only for monthly billing plans. ,
Enum:
{
P1M: No description available. ,
}
,
Required: False ,
}
enum ,
appliedScopeType:
{
Description: Type of the Applied Scope. ,
Enum:
{
Single: No description available. ,
Shared: No description available. ,
ManagementGroup: No description available. ,
}
,
Required: False ,
}
enum ,
appliedScopeProperties:
{
Description: Properties specific to applied scope type. Not required if not applicable. ,
Required: False ,
}
{
tenantId:
{
Description: Tenant ID where the benefit is applied. ,
Required: False ,
}
string ,
managementGroupId:
{
Description: Fully-qualified identifier of the management group where the benefit must be applied. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Fully-qualified identifier of the subscription. ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: Fully-qualified identifier of the resource group. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
}
,
quantity:
{
Description: Total Quantity of the SKUs purchased in the Reservation. ,
Format: int32 ,
Required: False ,
}
integer ,
renew:
{
Description: Setting this to true will automatically purchase a new benefit on the expiration date time. ,
Required: False ,
}
boolean ,
reservedResourceType:
{
Description: The type of the resource that is being reserved. ,
Enum:
{
VirtualMachines: No description available. ,
SqlDatabases: No description available. ,
SuseLinux: No description available. ,
CosmosDb: No description available. ,
RedHat: No description available. ,
SqlDataWarehouse: No description available. ,
VMwareCloudSimple: No description available. ,
RedHatOsa: No description available. ,
Databricks: No description available. ,
AppService: No description available. ,
ManagedDisk: No description available. ,
BlockBlob: No description available. ,
RedisCache: No description available. ,
AzureDataExplorer: No description available. ,
MySql: No description available. ,
MariaDb: No description available. ,
PostgreSql: No description available. ,
DedicatedHost: No description available. ,
SapHana: No description available. ,
SqlAzureHybridBenefit: No description available. ,
AVS: No description available. ,
DataFactory: No description available. ,
NetAppStorage: No description available. ,
AzureFiles: No description available. ,
SqlEdge: No description available. ,
VirtualMachineSoftware: No description available. ,
}
,
Required: False ,
}
enum ,
reviewDateTime:
{
Description: This is the date-time when the Azure Hybrid Benefit needs to be reviewed. ,
Format: date-time ,
Required: False ,
}
string ,
reservedResourceProperties:
{
Description: Properties specific to each reserved resource type. Not required if not applicable. ,
Required: False ,
}
{
instanceFlexibility:
{
Description: Turning this on will apply the reservation discount to other VMs in the same VM size group. ,
Enum:
{
On: No description available. ,
Off: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
}

⚐ Response (200)

{
sku:
{
Description: Reservation order SKU ,
Required: True ,
}
{
name:
{
Required: False ,
}
string ,
}
,
location:
{
Description: The Azure Region where the reserved resource lives. ,
Required: False ,
}
string ,
properties:
{
Description: Reservation order alias response properties ,
Required: False ,
}
{
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
reservationOrderId:
{
Description: Identifier of the reservation order created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state ,
Enum:
{
Creating: No description available. ,
PendingBilling: No description available. ,
ConfirmedBilling: No description available. ,
Created: No description available. ,
Succeeded: No description available. ,
Cancelled: No description available. ,
Expired: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
billingScopeId:
{
Description: Subscription that will be charged for purchasing the benefit ,
Required: False ,
}
string ,
term:
{
Description: Represent benefit term in ISO 8601 format. ,
Enum:
{
P1Y: No description available. ,
P3Y: No description available. ,
P5Y: No description available. ,
}
,
Required: False ,
}
enum ,
billingPlan:
{
Description: Represents the billing plan in ISO 8601 format. Required only for monthly billing plans. ,
Enum:
{
P1M: No description available. ,
}
,
Required: False ,
}
enum ,
appliedScopeType:
{
Description: Type of the Applied Scope. ,
Enum:
{
Single: No description available. ,
Shared: No description available. ,
ManagementGroup: No description available. ,
}
,
Required: False ,
}
enum ,
appliedScopeProperties:
{
Description: Properties specific to applied scope type. Not required if not applicable. ,
Required: False ,
}
{
tenantId:
{
Description: Tenant ID where the benefit is applied. ,
Required: False ,
}
string ,
managementGroupId:
{
Description: Fully-qualified identifier of the management group where the benefit must be applied. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Fully-qualified identifier of the subscription. ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: Fully-qualified identifier of the resource group. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
}
,
quantity:
{
Description: Total Quantity of the SKUs purchased in the Reservation. ,
Format: int32 ,
Required: False ,
}
integer ,
renew:
{
Description: Setting this to true will automatically purchase a new benefit on the expiration date time. ,
Required: False ,
}
boolean ,
reservedResourceType:
{
Description: The type of the resource that is being reserved. ,
Enum:
{
VirtualMachines: No description available. ,
SqlDatabases: No description available. ,
SuseLinux: No description available. ,
CosmosDb: No description available. ,
RedHat: No description available. ,
SqlDataWarehouse: No description available. ,
VMwareCloudSimple: No description available. ,
RedHatOsa: No description available. ,
Databricks: No description available. ,
AppService: No description available. ,
ManagedDisk: No description available. ,
BlockBlob: No description available. ,
RedisCache: No description available. ,
AzureDataExplorer: No description available. ,
MySql: No description available. ,
MariaDb: No description available. ,
PostgreSql: No description available. ,
DedicatedHost: No description available. ,
SapHana: No description available. ,
SqlAzureHybridBenefit: No description available. ,
AVS: No description available. ,
DataFactory: No description available. ,
NetAppStorage: No description available. ,
AzureFiles: No description available. ,
SqlEdge: No description available. ,
VirtualMachineSoftware: No description available. ,
}
,
Required: False ,
}
enum ,
reviewDateTime:
{
Description: This is the date-time when the Reservation needs to be reviewed. ,
Format: date-time ,
Required: False ,
}
string ,
reservedResourceProperties:
{
Description: Properties specific to each reserved resource type. Not required if not applicable. ,
Required: False ,
}
{
instanceFlexibility:
{
Description: Turning this on will apply the reservation discount to other VMs in the same VM size group. ,
Enum:
{
On: No description available. ,
Off: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: Reservation order alias ,
}
{
sku:
{
Description: Reservation order SKU ,
Required: True ,
}
{
name:
{
Required: False ,
}
string ,
}
,
location:
{
Description: The Azure Region where the reserved resource lives. ,
Required: False ,
}
string ,
properties:
{
Description: Reservation order alias response properties ,
Required: False ,
}
{
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
reservationOrderId:
{
Description: Identifier of the reservation order created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state ,
Enum:
{
Creating: No description available. ,
PendingBilling: No description available. ,
ConfirmedBilling: No description available. ,
Created: No description available. ,
Succeeded: No description available. ,
Cancelled: No description available. ,
Expired: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
billingScopeId:
{
Description: Subscription that will be charged for purchasing the benefit ,
Required: False ,
}
string ,
term:
{
Description: Represent benefit term in ISO 8601 format. ,
Enum:
{
P1Y: No description available. ,
P3Y: No description available. ,
P5Y: No description available. ,
}
,
Required: False ,
}
enum ,
billingPlan:
{
Description: Represents the billing plan in ISO 8601 format. Required only for monthly billing plans. ,
Enum:
{
P1M: No description available. ,
}
,
Required: False ,
}
enum ,
appliedScopeType:
{
Description: Type of the Applied Scope. ,
Enum:
{
Single: No description available. ,
Shared: No description available. ,
ManagementGroup: No description available. ,
}
,
Required: False ,
}
enum ,
appliedScopeProperties:
{
Description: Properties specific to applied scope type. Not required if not applicable. ,
Required: False ,
}
{
tenantId:
{
Description: Tenant ID where the benefit is applied. ,
Required: False ,
}
string ,
managementGroupId:
{
Description: Fully-qualified identifier of the management group where the benefit must be applied. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Fully-qualified identifier of the subscription. ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: Fully-qualified identifier of the resource group. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
}
,
quantity:
{
Description: Total Quantity of the SKUs purchased in the Reservation. ,
Format: int32 ,
Required: False ,
}
integer ,
renew:
{
Description: Setting this to true will automatically purchase a new benefit on the expiration date time. ,
Required: False ,
}
boolean ,
reservedResourceType:
{
Description: The type of the resource that is being reserved. ,
Enum:
{
VirtualMachines: No description available. ,
SqlDatabases: No description available. ,
SuseLinux: No description available. ,
CosmosDb: No description available. ,
RedHat: No description available. ,
SqlDataWarehouse: No description available. ,
VMwareCloudSimple: No description available. ,
RedHatOsa: No description available. ,
Databricks: No description available. ,
AppService: No description available. ,
ManagedDisk: No description available. ,
BlockBlob: No description available. ,
RedisCache: No description available. ,
AzureDataExplorer: No description available. ,
MySql: No description available. ,
MariaDb: No description available. ,
PostgreSql: No description available. ,
DedicatedHost: No description available. ,
SapHana: No description available. ,
SqlAzureHybridBenefit: No description available. ,
AVS: No description available. ,
DataFactory: No description available. ,
NetAppStorage: No description available. ,
AzureFiles: No description available. ,
SqlEdge: No description available. ,
VirtualMachineSoftware: No description available. ,
}
,
Required: False ,
}
enum ,
reviewDateTime:
{
Description: This is the date-time when the Reservation needs to be reviewed. ,
Format: date-time ,
Required: False ,
}
string ,
reservedResourceProperties:
{
Description: Properties specific to each reserved resource type. Not required if not applicable. ,
Required: False ,
}
{
instanceFlexibility:
{
Description: Turning this on will apply the reservation discount to other VMs in the same VM size group. ,
Enum:
{
On: No description available. ,
Off: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SavingsPlanOrderAlias_Create (updated)
Description :  Create a savings plan. Learn more about permissions needed at https://go.microsoft.com/fwlink/?linkid=2215851
Reference :  Link ¶

⚶ Changes

{
  "#id": "SavingsPlanOrderAlias_Create",
  "$responses": {
    "201": [
      {
        "#name": "azure-asyncoperation",
        "Description": {
          "new": "A link to the status monitor",
          "old": "URL for checking the ongoing status of the operation."
        }
      },
      {
        "#name": "retry-after",
        "Description": {
          "new": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
          "old": "Clients should wait for the Retry-After interval before polling again"
        }
      }
    ]
  }
}

⚼ Request

PUT:  /providers/Microsoft.BillingBenefits/savingsPlanOrderAliases/{savingsPlanOrderAliasName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
savingsPlanOrderAliasName:
{
Description: Name of the savings plan order alias ,
Required: True ,
}
string ,
body:
{
Description: Request body for creating a savings plan order alias ,
Required: True ,
}
{
sku:
{
Description: Savings plan SKU ,
Required: True ,
}
{
name:
{
Required: False ,
}
string ,
}
,
kind:
{
Description: Resource provider kind ,
Required: False ,
}
string ,
properties:
{
Description: Savings plan order alias properties ,
Required: False ,
}
{
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
savingsPlanOrderId:
{
Description: Identifier of the savings plan created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state ,
Enum:
{
Creating: No description available. ,
PendingBilling: No description available. ,
ConfirmedBilling: No description available. ,
Created: No description available. ,
Succeeded: No description available. ,
Cancelled: No description available. ,
Expired: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
billingScopeId:
{
Description: Subscription that will be charged for purchasing the benefit ,
Required: False ,
}
string ,
term:
{
Description: Represent benefit term in ISO 8601 format. ,
Enum:
{
P1Y: No description available. ,
P3Y: No description available. ,
P5Y: No description available. ,
}
,
Required: False ,
}
enum ,
billingPlan:
{
Description: Represents the billing plan in ISO 8601 format. Required only for monthly billing plans. ,
Enum:
{
P1M: No description available. ,
}
,
Required: False ,
}
enum ,
appliedScopeType:
{
Description: Type of the Applied Scope. ,
Enum:
{
Single: No description available. ,
Shared: No description available. ,
ManagementGroup: No description available. ,
}
,
Required: False ,
}
enum ,
appliedScopeProperties:
{
Description: Properties specific to applied scope type. Not required if not applicable. ,
Required: False ,
}
{
tenantId:
{
Description: Tenant ID where the benefit is applied. ,
Required: False ,
}
string ,
managementGroupId:
{
Description: Fully-qualified identifier of the management group where the benefit must be applied. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Fully-qualified identifier of the subscription. ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: Fully-qualified identifier of the resource group. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
}
,
commitment:
{
Description: Commitment towards the benefit. ,
Required: False ,
}
{
grain:
{
Description: Commitment grain. ,
Enum:
{
Hourly: No description available. ,
FullTerm: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
renew:
{
Description: Setting this to true will automatically purchase a new benefit on the expiration date time. ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ Response (200)

{
sku:
{
Description: Savings plan SKU ,
Required: True ,
}
{
name:
{
Required: False ,
}
string ,
}
,
kind:
{
Description: Resource provider kind ,
Required: False ,
}
string ,
properties:
{
Description: Savings plan order alias properties ,
Required: False ,
}
{
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
savingsPlanOrderId:
{
Description: Identifier of the savings plan created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state ,
Enum:
{
Creating: No description available. ,
PendingBilling: No description available. ,
ConfirmedBilling: No description available. ,
Created: No description available. ,
Succeeded: No description available. ,
Cancelled: No description available. ,
Expired: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
billingScopeId:
{
Description: Subscription that will be charged for purchasing the benefit ,
Required: False ,
}
string ,
term:
{
Description: Represent benefit term in ISO 8601 format. ,
Enum:
{
P1Y: No description available. ,
P3Y: No description available. ,
P5Y: No description available. ,
}
,
Required: False ,
}
enum ,
billingPlan:
{
Description: Represents the billing plan in ISO 8601 format. Required only for monthly billing plans. ,
Enum:
{
P1M: No description available. ,
}
,
Required: False ,
}
enum ,
appliedScopeType:
{
Description: Type of the Applied Scope. ,
Enum:
{
Single: No description available. ,
Shared: No description available. ,
ManagementGroup: No description available. ,
}
,
Required: False ,
}
enum ,
appliedScopeProperties:
{
Description: Properties specific to applied scope type. Not required if not applicable. ,
Required: False ,
}
{
tenantId:
{
Description: Tenant ID where the benefit is applied. ,
Required: False ,
}
string ,
managementGroupId:
{
Description: Fully-qualified identifier of the management group where the benefit must be applied. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Fully-qualified identifier of the subscription. ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: Fully-qualified identifier of the resource group. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
}
,
commitment:
{
Description: Commitment towards the benefit. ,
Required: False ,
}
{
grain:
{
Description: Commitment grain. ,
Enum:
{
Hourly: No description available. ,
FullTerm: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
renew:
{
Description: Setting this to true will automatically purchase a new benefit on the expiration date time. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: Savings plan order alias ,
}
{
sku:
{
Description: Savings plan SKU ,
Required: True ,
}
{
name:
{
Required: False ,
}
string ,
}
,
kind:
{
Description: Resource provider kind ,
Required: False ,
}
string ,
properties:
{
Description: Savings plan order alias properties ,
Required: False ,
}
{
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
savingsPlanOrderId:
{
Description: Identifier of the savings plan created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state ,
Enum:
{
Creating: No description available. ,
PendingBilling: No description available. ,
ConfirmedBilling: No description available. ,
Created: No description available. ,
Succeeded: No description available. ,
Cancelled: No description available. ,
Expired: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
billingScopeId:
{
Description: Subscription that will be charged for purchasing the benefit ,
Required: False ,
}
string ,
term:
{
Description: Represent benefit term in ISO 8601 format. ,
Enum:
{
P1Y: No description available. ,
P3Y: No description available. ,
P5Y: No description available. ,
}
,
Required: False ,
}
enum ,
billingPlan:
{
Description: Represents the billing plan in ISO 8601 format. Required only for monthly billing plans. ,
Enum:
{
P1M: No description available. ,
}
,
Required: False ,
}
enum ,
appliedScopeType:
{
Description: Type of the Applied Scope. ,
Enum:
{
Single: No description available. ,
Shared: No description available. ,
ManagementGroup: No description available. ,
}
,
Required: False ,
}
enum ,
appliedScopeProperties:
{
Description: Properties specific to applied scope type. Not required if not applicable. ,
Required: False ,
}
{
tenantId:
{
Description: Tenant ID where the benefit is applied. ,
Required: False ,
}
string ,
managementGroupId:
{
Description: Fully-qualified identifier of the management group where the benefit must be applied. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Fully-qualified identifier of the subscription. ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: Fully-qualified identifier of the resource group. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
}
,
commitment:
{
Description: Commitment towards the benefit. ,
Required: False ,
}
{
grain:
{
Description: Commitment grain. ,
Enum:
{
Hourly: No description available. ,
FullTerm: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
renew:
{
Description: Setting this to true will automatically purchase a new benefit on the expiration date time. ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SavingsPlanOrder_List (updated)
Description :  List all Savings plan orders.
Reference :  Link ¶

⚶ Changes

{
  "#id": "SavingsPlanOrder_List",
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "value",
          "Required": {
            "new": true,
            "old": false
          },
          "$items": {
            "$properties": {
              "properties": [
                {
                  "planInformation": [
                    {
                      "#name": "startDate",
                      "Format": {
                        "new": "date-time-rfc7231",
                        "old": "date"
                      }
                    },
                    {
                      "#name": "nextPaymentDueDate",
                      "Format": {
                        "new": "date-time-rfc7231",
                        "old": "date"
                      }
                    },
                    {
                      "transactions": {
                        "$properties": [
                          {
                            "#name": "dueDate",
                            "Format": {
                              "new": "date-time-rfc7231",
                              "old": "date"
                            }
                          },
                          {
                            "#name": "paymentDate",
                            "Format": {
                              "new": "date-time-rfc7231",
                              "old": "date"
                            }
                          }
                        ]
                      }
                    }
                  ]
                }
              ]
            }
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "Url to get the next page."
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /providers/Microsoft.BillingBenefits/savingsPlanOrders
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The SavingsPlanOrderModel items on this page ,
Required: True ,
}
[
{
sku:
{
Description: Savings plan SKU ,
Required: True ,
}
{
name:
{
Required: False ,
}
string ,
}
,
properties:
{
Description: Savings plan order properties ,
Required: False ,
}
{
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state ,
Enum:
{
Creating: No description available. ,
PendingBilling: No description available. ,
ConfirmedBilling: No description available. ,
Created: No description available. ,
Succeeded: No description available. ,
Cancelled: No description available. ,
Expired: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
billingScopeId:
{
Description: Subscription that will be charged for purchasing the benefit ,
Required: False ,
}
string ,
billingProfileId:
{
Description: Fully-qualified identifier of the billing profile where the savings plan is applied. Present only for Field-led or Customer-led customers. ,
Format: arm-id ,
Required: False ,
}
string ,
customerId:
{
Description: Fully-qualified identifier of the customer where the savings plan is applied. Present only for Partner-led customers. ,
Format: arm-id ,
Required: False ,
}
string ,
billingAccountId:
{
Description: Fully-qualified identifier of the billing account where the savings plan is applied. Present only for Enterprise Agreement customers. ,
Format: arm-id ,
Required: False ,
}
string ,
term:
{
Description: Represent benefit term in ISO 8601 format. ,
Enum:
{
P1Y: No description available. ,
P3Y: No description available. ,
P5Y: No description available. ,
}
,
Required: False ,
}
enum ,
billingPlan:
{
Description: Represents the billing plan in ISO 8601 format. Required only for monthly billing plans. ,
Enum:
{
P1M: No description available. ,
}
,
Required: False ,
}
enum ,
expiryDateTime:
{
Description: Expiry date time ,
Format: date-time ,
Required: False ,
}
string ,
benefitStartTime:
{
Description: This is the DateTime when the savings plan benefit started. ,
Format: date-time ,
Required: False ,
}
string ,
planInformation:
{
Description: Information describing the type of billing plan for this savings plan. ,
Required: False ,
}
{
pricingCurrencyTotal:
{
Description: Amount of money to be paid for the Order. Tax is not included. ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Format: double ,
Required: False ,
}
number ,
}
,
startDate:
{
Description: Date when the billing plan has started. ,
Format: date-time-rfc7231 ,
Required: False ,
}
string ,
nextPaymentDueDate:
{
Description: For recurring billing plans, indicates the date when next payment will be processed. Null when total is paid off. ,
Format: date-time-rfc7231 ,
Required: False ,
}
string ,
transactions:
{
Required: False ,
}
[
{
dueDate:
{
Description: Date when the payment needs to be done. ,
Format: date-time-rfc7231 ,
Required: False ,
}
string ,
paymentDate:
{
Description: Date when the transaction is completed. Is null when it is scheduled. ,
Format: date-time-rfc7231 ,
Required: False ,
}
string ,
pricingCurrencyTotal:
{
Description: Amount in pricing currency. Tax not included. ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Format: double ,
Required: False ,
}
number ,
}
,
billingCurrencyTotal:
{
Description: Amount charged in Billing currency. Tax not included. Is null for future payments ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Format: double ,
Required: False ,
}
number ,
}
,
status:
{
Description: Describes whether the payment is completed, failed, cancelled or scheduled in the future. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Scheduled: No description available. ,
Cancelled: No description available. ,
}
,
Required: False ,
}
enum ,
extendedStatusInfo:
{
Required: False ,
}
{
statusCode:
{
Description: Status code providing additional information. ,
Required: False ,
}
string ,
message:
{
Description: The message giving detailed information about the status code. ,
Required: False ,
}
string ,
}
,
billingAccount:
{
Description: Billing account ,
Required: False ,
}
string ,
}
,
]
,
}
,
savingsPlans:
{
Required: False ,
}
[
string ,
]
,
extendedStatusInfo:
{
Required: False ,
}
{
statusCode:
{
Description: Status code providing additional information. ,
Required: False ,
}
string ,
message:
{
Description: The message giving detailed information about the status code. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SavingsPlanOrder_Get (updated)
Description :  Get a savings plan order.
Reference :  Link ¶

⚶ Changes

{
  "#id": "SavingsPlanOrder_Get",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "planInformation": [
              {
                "#name": "startDate",
                "Format": {
                  "new": "date-time-rfc7231",
                  "old": "date"
                }
              },
              {
                "#name": "nextPaymentDueDate",
                "Format": {
                  "new": "date-time-rfc7231",
                  "old": "date"
                }
              },
              {
                "transactions": {
                  "$properties": [
                    {
                      "#name": "dueDate",
                      "Format": {
                        "new": "date-time-rfc7231",
                        "old": "date"
                      }
                    },
                    {
                      "#name": "paymentDate",
                      "Format": {
                        "new": "date-time-rfc7231",
                        "old": "date"
                      }
                    }
                  ]
                }
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /providers/Microsoft.BillingBenefits/savingsPlanOrders/{savingsPlanOrderId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
savingsPlanOrderId:
{
Description: Order ID of the savings plan ,
Required: True ,
}
string ,
$expand:
{
Description: May be used to expand the detail information of some properties. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
sku:
{
Description: Savings plan SKU ,
Required: True ,
}
{
name:
{
Required: False ,
}
string ,
}
,
properties:
{
Description: Savings plan order properties ,
Required: False ,
}
{
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state ,
Enum:
{
Creating: No description available. ,
PendingBilling: No description available. ,
ConfirmedBilling: No description available. ,
Created: No description available. ,
Succeeded: No description available. ,
Cancelled: No description available. ,
Expired: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
billingScopeId:
{
Description: Subscription that will be charged for purchasing the benefit ,
Required: False ,
}
string ,
billingProfileId:
{
Description: Fully-qualified identifier of the billing profile where the savings plan is applied. Present only for Field-led or Customer-led customers. ,
Format: arm-id ,
Required: False ,
}
string ,
customerId:
{
Description: Fully-qualified identifier of the customer where the savings plan is applied. Present only for Partner-led customers. ,
Format: arm-id ,
Required: False ,
}
string ,
billingAccountId:
{
Description: Fully-qualified identifier of the billing account where the savings plan is applied. Present only for Enterprise Agreement customers. ,
Format: arm-id ,
Required: False ,
}
string ,
term:
{
Description: Represent benefit term in ISO 8601 format. ,
Enum:
{
P1Y: No description available. ,
P3Y: No description available. ,
P5Y: No description available. ,
}
,
Required: False ,
}
enum ,
billingPlan:
{
Description: Represents the billing plan in ISO 8601 format. Required only for monthly billing plans. ,
Enum:
{
P1M: No description available. ,
}
,
Required: False ,
}
enum ,
expiryDateTime:
{
Description: Expiry date time ,
Format: date-time ,
Required: False ,
}
string ,
benefitStartTime:
{
Description: This is the DateTime when the savings plan benefit started. ,
Format: date-time ,
Required: False ,
}
string ,
planInformation:
{
Description: Information describing the type of billing plan for this savings plan. ,
Required: False ,
}
{
pricingCurrencyTotal:
{
Description: Amount of money to be paid for the Order. Tax is not included. ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Format: double ,
Required: False ,
}
number ,
}
,
startDate:
{
Description: Date when the billing plan has started. ,
Format: date-time-rfc7231 ,
Required: False ,
}
string ,
nextPaymentDueDate:
{
Description: For recurring billing plans, indicates the date when next payment will be processed. Null when total is paid off. ,
Format: date-time-rfc7231 ,
Required: False ,
}
string ,
transactions:
{
Required: False ,
}
[
{
dueDate:
{
Description: Date when the payment needs to be done. ,
Format: date-time-rfc7231 ,
Required: False ,
}
string ,
paymentDate:
{
Description: Date when the transaction is completed. Is null when it is scheduled. ,
Format: date-time-rfc7231 ,
Required: False ,
}
string ,
pricingCurrencyTotal:
{
Description: Amount in pricing currency. Tax not included. ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Format: double ,
Required: False ,
}
number ,
}
,
billingCurrencyTotal:
{
Description: Amount charged in Billing currency. Tax not included. Is null for future payments ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Format: double ,
Required: False ,
}
number ,
}
,
status:
{
Description: Describes whether the payment is completed, failed, cancelled or scheduled in the future. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Scheduled: No description available. ,
Cancelled: No description available. ,
}
,
Required: False ,
}
enum ,
extendedStatusInfo:
{
Required: False ,
}
{
statusCode:
{
Description: Status code providing additional information. ,
Required: False ,
}
string ,
message:
{
Description: The message giving detailed information about the status code. ,
Required: False ,
}
string ,
}
,
billingAccount:
{
Description: Billing account ,
Required: False ,
}
string ,
}
,
]
,
}
,
savingsPlans:
{
Required: False ,
}
[
string ,
]
,
extendedStatusInfo:
{
Required: False ,
}
{
statusCode:
{
Description: Status code providing additional information. ,
Required: False ,
}
string ,
message:
{
Description: The message giving detailed information about the status code. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SavingsPlan_List (updated)
Description :  List savings plans in an order.
Reference :  Link ¶

⚶ Changes

{
  "#id": "SavingsPlan_List",
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "value",
          "Required": {
            "new": true,
            "old": false
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "Url to get the next page."
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /providers/Microsoft.BillingBenefits/savingsPlanOrders/{savingsPlanOrderId}/savingsPlans
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
savingsPlanOrderId:
{
Description: Order ID of the savings plan ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The SavingsPlanModel items on this page ,
Required: True ,
}
[
{
sku:
{
Description: Savings plan SKU ,
Required: True ,
}
{
name:
{
Required: False ,
}
string ,
}
,
properties:
{
Description: Savings plan properties ,
Required: False ,
}
{
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state ,
Enum:
{
Creating: No description available. ,
PendingBilling: No description available. ,
ConfirmedBilling: No description available. ,
Created: No description available. ,
Succeeded: No description available. ,
Cancelled: No description available. ,
Expired: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
displayProvisioningState:
{
Description: The provisioning state of the savings plan for display, e.g. Succeeded ,
Required: False ,
}
string ,
billingScopeId:
{
Description: Subscription that will be charged for purchasing the benefit ,
Required: False ,
}
string ,
billingProfileId:
{
Description: Fully-qualified identifier of the billing profile where the savings plan is applied. Present only for Field-led or Customer-led customers. ,
Format: arm-id ,
Required: False ,
}
string ,
customerId:
{
Description: Fully-qualified identifier of the customer where the savings plan is applied. Present only for Partner-led customers. ,
Format: arm-id ,
Required: False ,
}
string ,
billingAccountId:
{
Description: Fully-qualified identifier of the billing account where the savings plan is applied. Present only for Enterprise Agreement customers. ,
Format: arm-id ,
Required: False ,
}
string ,
term:
{
Description: Represent benefit term in ISO 8601 format. ,
Enum:
{
P1Y: No description available. ,
P3Y: No description available. ,
P5Y: No description available. ,
}
,
Required: False ,
}
enum ,
billingPlan:
{
Description: Represents the billing plan in ISO 8601 format. Required only for monthly billing plans. ,
Enum:
{
P1M: No description available. ,
}
,
Required: False ,
}
enum ,
appliedScopeType:
{
Description: Type of the Applied Scope. ,
Enum:
{
Single: No description available. ,
Shared: No description available. ,
ManagementGroup: No description available. ,
}
,
Required: False ,
}
enum ,
userFriendlyAppliedScopeType:
{
Description: The applied scope type of the savings plan for display, e.g. Shared ,
Required: False ,
}
string ,
appliedScopeProperties:
{
Description: Properties specific to applied scope type. Not required if not applicable. ,
Required: False ,
}
{
tenantId:
{
Description: Tenant ID where the benefit is applied. ,
Required: False ,
}
string ,
managementGroupId:
{
Description: Fully-qualified identifier of the management group where the benefit must be applied. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Fully-qualified identifier of the subscription. ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: Fully-qualified identifier of the resource group. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
}
,
commitment:
{
Description: Commitment towards the benefit. ,
Required: False ,
}
{
grain:
{
Description: Commitment grain. ,
Enum:
{
Hourly: No description available. ,
FullTerm: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
effectiveDateTime:
{
Description: DateTime of the savings plan starts providing benefit from. ,
Format: date-time ,
Required: False ,
}
string ,
expiryDateTime:
{
Description: Expiry date time ,
Format: date-time ,
Required: False ,
}
string ,
purchaseDateTime:
{
Description: Date time when the savings plan was purchased ,
Format: date-time ,
Required: False ,
}
string ,
benefitStartTime:
{
Description: This is the DateTime when the savings plan benefit started. ,
Format: date-time ,
Required: False ,
}
string ,
extendedStatusInfo:
{
Required: False ,
}
{
statusCode:
{
Description: Status code providing additional information. ,
Required: False ,
}
string ,
message:
{
Description: The message giving detailed information about the status code. ,
Required: False ,
}
string ,
}
,
renew:
{
Description: Setting this to true will automatically purchase a new benefit on the expiration date time. ,
Required: False ,
}
boolean ,
utilization:
{
Description: Savings plan utilization ,
Required: False ,
}
{
trend:
{
Description: The number of days trend for a savings plan ,
Required: False ,
}
string ,
aggregates:
{
Description: The array of aggregates of a savings plan's utilization ,
Required: False ,
}
[
{
grain:
{
Description: The grain of the aggregate ,
Format: float ,
Required: False ,
}
number ,
grainUnit:
{
Description: The grain unit of the aggregate ,
Required: False ,
}
string ,
value:
{
Description: The aggregate value ,
Format: float ,
Required: False ,
}
number ,
valueUnit:
{
Description: The aggregate value unit ,
Required: False ,
}
string ,
}
,
]
,
}
,
renewSource:
{
Description: SavingsPlan Id of the SavingsPlan from which this SavingsPlan is renewed. ,
Required: False ,
}
string ,
renewDestination:
{
Description: SavingsPlan Id of the SavingsPlan which is purchased because of renew. ,
Required: False ,
}
string ,
renewProperties:
{
Required: False ,
}
{
purchaseProperties:
{
Required: False ,
}
{
sku:
{
Description: The SKU to be applied for this resource ,
Required: False ,
}
{
name:
{
Required: False ,
}
string ,
}
,
properties:
{
Required: False ,
}
{
displayName:
{
Description: Friendly name of the savings plan ,
Required: False ,
}
string ,
billingScopeId:
{
Description: Subscription that will be charged for purchasing the benefit ,
Required: False ,
}
string ,
term:
{
Description: Represent benefit term in ISO 8601 format. ,
Enum:
{
P1Y: No description available. ,
P3Y: No description available. ,
P5Y: No description available. ,
}
,
Required: False ,
}
enum ,
billingPlan:
{
Description: Represents the billing plan in ISO 8601 format. Required only for monthly billing plans. ,
Enum:
{
P1M: No description available. ,
}
,
Required: False ,
}
enum ,
appliedScopeType:
{
Description: Type of the Applied Scope. ,
Enum:
{
Single: No description available. ,
Shared: No description available. ,
ManagementGroup: No description available. ,
}
,
Required: False ,
}
enum ,
commitment:
{
Description: Commitment towards the benefit. ,
Required: False ,
}
{
grain:
{
Description: Commitment grain. ,
Enum:
{
Hourly: No description available. ,
FullTerm: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
effectiveDateTime:
{
Description: DateTime of the savings plan starts providing benefit from. ,
Format: date-time ,
Required: False ,
}
string ,
renew:
{
Description: Setting this to true will automatically purchase a new benefit on the expiration date time. ,
Required: False ,
}
boolean ,
appliedScopeProperties:
{
Description: Properties specific to applied scope type. Not required if not applicable. ,
Required: False ,
}
{
tenantId:
{
Description: Tenant ID where the benefit is applied. ,
Required: False ,
}
string ,
managementGroupId:
{
Description: Fully-qualified identifier of the management group where the benefit must be applied. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Fully-qualified identifier of the subscription. ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: Fully-qualified identifier of the resource group. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ValidatePurchase (updated)
Description :  Validate savings plan purchase.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ValidatePurchase",
  "$parameters": [
    {
      "#name": "body",
      "Description": {
        "new": "The request body",
        "old": "Request body for validating the purchase of a savings plan"
      }
    }
  ]
}

⚼ Request

POST:  /providers/Microsoft.BillingBenefits/validate
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: The request body ,
Required: True ,
}
{
benefits:
{
Required: False ,
}
[
{
sku:
{
Description: Savings plan SKU ,
Required: True ,
}
{
name:
{
Required: False ,
}
string ,
}
,
kind:
{
Description: Resource provider kind ,
Required: False ,
}
string ,
properties:
{
Description: Savings plan order alias properties ,
Required: False ,
}
{
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
savingsPlanOrderId:
{
Description: Identifier of the savings plan created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state ,
Enum:
{
Creating: No description available. ,
PendingBilling: No description available. ,
ConfirmedBilling: No description available. ,
Created: No description available. ,
Succeeded: No description available. ,
Cancelled: No description available. ,
Expired: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
billingScopeId:
{
Description: Subscription that will be charged for purchasing the benefit ,
Required: False ,
}
string ,
term:
{
Description: Represent benefit term in ISO 8601 format. ,
Enum:
{
P1Y: No description available. ,
P3Y: No description available. ,
P5Y: No description available. ,
}
,
Required: False ,
}
enum ,
billingPlan:
{
Description: Represents the billing plan in ISO 8601 format. Required only for monthly billing plans. ,
Enum:
{
P1M: No description available. ,
}
,
Required: False ,
}
enum ,
appliedScopeType:
{
Description: Type of the Applied Scope. ,
Enum:
{
Single: No description available. ,
Shared: No description available. ,
ManagementGroup: No description available. ,
}
,
Required: False ,
}
enum ,
appliedScopeProperties:
{
Description: Properties specific to applied scope type. Not required if not applicable. ,
Required: False ,
}
{
tenantId:
{
Description: Tenant ID where the benefit is applied. ,
Required: False ,
}
string ,
managementGroupId:
{
Description: Fully-qualified identifier of the management group where the benefit must be applied. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Fully-qualified identifier of the subscription. ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: Fully-qualified identifier of the resource group. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
}
,
commitment:
{
Description: Commitment towards the benefit. ,
Required: False ,
}
{
grain:
{
Description: Commitment grain. ,
Enum:
{
Hourly: No description available. ,
FullTerm: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
renew:
{
Description: Setting this to true will automatically purchase a new benefit on the expiration date time. ,
Required: False ,
}
boolean ,
}
,
}
,
]
,
}
,
}

⚐ Response (200)

{
benefits:
{
Required: False ,
}
[
{
valid:
{
Description: Indicates if the provided input was valid ,
Required: False ,
}
boolean ,
reasonCode:
{
Description: Failure reason code if the provided input was invalid ,
Required: False ,
}
string ,
reason:
{
Description: Failure reason if the provided input was invalid ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: Url to get the next page. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Discounts_SubscriptionList (updated)
Description :  List discounts at subscription level
Reference :  Link ¶

⚶ Changes

{
  "#id": "Discounts_SubscriptionList",
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The Discount items on this page",
            "old": "List of discounts."
          },
          "Required": {
            "new": true,
            "old": false
          },
          "$items": {
            "$properties": {
              "@added_2375047ccec142e38d8a7b72cfef9d16": {
                "#name": "managedBy",
                "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.",
                "Required": false,
                "Type": "string"
              },
              "@added_21476efba41c4e6299a74d46258278ca": {
                "#name": "kind",
                "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.",
                "Required": false,
                "Type": "string"
              },
              "@added_1eb255c7d9034991a3cb7a3c841241f1": {
                "#name": "etag",
                "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.",
                "Required": false,
                "Type": "string"
              },
              "@added_2239d8f7b95d4941854d9e983cbe9887": {
                "#name": "identity",
                "Description": "Managed service identity (system assigned and/or user assigned identities)",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "principalId",
                    "Description": "The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.",
                    "Format": "uuid",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "tenantId",
                    "Description": "The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.",
                    "Format": "uuid",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "type",
                    "Description": "Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).",
                    "Enum": [
                      [
                        "None",
                        ""
                      ],
                      [
                        "SystemAssigned",
                        ""
                      ],
                      [
                        "UserAssigned",
                        ""
                      ],
                      [
                        "SystemAssigned,UserAssigned",
                        ""
                      ]
                    ],
                    "Required": true,
                    "Type": "string"
                  },
                  {
                    "#name": "userAssignedIdentities",
                    "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.",
                    "Required": false,
                    "Type": "object"
                  }
                ]
              },
              "@added_815350532984456c839dfad29dd442b3": {
                "#name": "sku",
                "Description": "The resource model definition representing SKU",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "name",
                    "Description": "The name of the SKU. E.g. P3. It is typically a letter+number code",
                    "Required": true,
                    "Type": "string"
                  },
                  {
                    "#name": "tier",
                    "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.",
                    "Enum": [
                      [
                        "Free",
                        ""
                      ],
                      [
                        "Basic",
                        ""
                      ],
                      [
                        "Standard",
                        ""
                      ],
                      [
                        "Premium",
                        ""
                      ]
                    ],
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "size",
                    "Description": "The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "family",
                    "Description": "If the service has different generations of hardware, for the same SKU, then that can be captured here.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "capacity",
                    "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.",
                    "Format": "int32",
                    "Required": false,
                    "Type": "integer"
                  }
                ]
              },
              "@added_da08529aaf5a463190635f67b9c8d2ba": {
                "#name": "plan",
                "Description": "Plan for the resource.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "name",
                    "Description": "A user defined name of the 3rd Party Artifact that is being procured.",
                    "Required": true,
                    "Type": "string"
                  },
                  {
                    "#name": "publisher",
                    "Description": "The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic",
                    "Required": true,
                    "Type": "string"
                  },
                  {
                    "#name": "product",
                    "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.",
                    "Required": true,
                    "Type": "string"
                  },
                  {
                    "#name": "promotionCode",
                    "Description": "A publisher provided promotion code as provisioned in Data Market for the said product/artifact.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "version",
                    "Description": "The version of the desired product/artifact.",
                    "Required": false,
                    "Type": "string"
                  }
                ]
              }
            }
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "Url to get the next page."
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.BillingBenefits/discounts
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Discount items on this page ,
Required: True ,
}
[
{
properties:
{
Description: Discount properties ,
Required: False ,
}
{
entityType:
{
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: No description available. ,
Affiliate: No description available. ,
}
,
Required: True ,
}
enum ,
productCode:
{
Description: This is the catalog UPN for the product. ,
Required: True ,
}
string ,
startAt:
{
Description: Start date of the discount. Value is the date the discount started or will start in the future. ,
Format: date-time ,
Required: True ,
}
string ,
systemId:
{
Description: This is the globally unique identifier of the Discount which will not change for the lifetime of the Discount. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The state of the resource. Supported values are Pending, Failed, Succeeded, Canceled. ,
Enum:
{
Unknown: No description available. ,
Pending: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
billingAccountResourceId:
{
Description: Billing account resource id where the discount metadata is present. ,
Format: arm-id ,
Required: False ,
}
string ,
billingProfileResourceId:
{
Description: Billing profile resource id where the discount is scoped to. ,
Format: arm-id ,
Required: False ,
}
string ,
customerResourceId:
{
Description: Customer resource id where the discount is scoped to. ,
Format: arm-id ,
Required: False ,
}
string ,
displayName:
{
Description: This defines a user friendly display name for the discount. ,
Required: False ,
}
string ,
status:
{
Description: Represents the current status of the discount. ,
Enum:
{
Active: No description available. ,
Pending: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Expired: No description available. ,
}
,
Required: False ,
}
enum ,
benefitResourceId:
{
Description: Fully-qualified identifier of the benefit under applicable benefit list. ,
Format: arm-id ,
Required: False ,
}
string ,
appliedScopeType:
{
Description: List of applied scopes supported for discounts. ,
Enum:
{
BillingAccount: No description available. ,
BillingProfile: No description available. ,
Customer: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
managedBy:
{
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. ,
Required: False ,
}
string ,
kind:
{
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. ,
Required: False ,
}
string ,
etag:
{
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. ,
Required: False ,
}
string ,
identity:
{
Description: Managed service identity (system assigned and/or user assigned identities) ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
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. ,
Required: False ,
}
object ,
}
,
sku:
{
Description: The resource model definition representing SKU ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. E.g. P3. It is typically a letter+number code ,
Required: True ,
}
string ,
tier:
{
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. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
plan:
{
Description: Plan for the resource. ,
Required: False ,
}
{
name:
{
Description: A user defined name of the 3rd Party Artifact that is being procured. ,
Required: True ,
}
string ,
publisher:
{
Description: The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic ,
Required: True ,
}
string ,
product:
{
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. ,
Required: True ,
}
string ,
promotionCode:
{
Description: A publisher provided promotion code as provisioned in Data Market for the said product/artifact. ,
Required: False ,
}
string ,
version:
{
Description: The version of the desired product/artifact. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Discounts_ResourceGroupList (updated)
Description :  List discounts at resource group level
Reference :  Link ¶

⚶ Changes

{
  "#id": "Discounts_ResourceGroupList",
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The Discount items on this page",
            "old": "List of discounts."
          },
          "Required": {
            "new": true,
            "old": false
          },
          "$items": {
            "$properties": {
              "@added_8c0bbbd940664813b0aed114f681bed8": {
                "#name": "managedBy",
                "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.",
                "Required": false,
                "Type": "string"
              },
              "@added_da2cc65a4c31402795c463e1d414ec49": {
                "#name": "kind",
                "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.",
                "Required": false,
                "Type": "string"
              },
              "@added_194a2b41abc848bdbb6ce8f55bf424f6": {
                "#name": "etag",
                "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.",
                "Required": false,
                "Type": "string"
              },
              "@added_0cfe806409984067830af49349361482": {
                "#name": "identity",
                "Description": "Managed service identity (system assigned and/or user assigned identities)",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "principalId",
                    "Description": "The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.",
                    "Format": "uuid",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "tenantId",
                    "Description": "The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.",
                    "Format": "uuid",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "type",
                    "Description": "Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).",
                    "Enum": [
                      [
                        "None",
                        ""
                      ],
                      [
                        "SystemAssigned",
                        ""
                      ],
                      [
                        "UserAssigned",
                        ""
                      ],
                      [
                        "SystemAssigned,UserAssigned",
                        ""
                      ]
                    ],
                    "Required": true,
                    "Type": "string"
                  },
                  {
                    "#name": "userAssignedIdentities",
                    "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.",
                    "Required": false,
                    "Type": "object"
                  }
                ]
              },
              "@added_3afc51bfbe094a4cb1ecb04ca73ed99c": {
                "#name": "sku",
                "Description": "The resource model definition representing SKU",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "name",
                    "Description": "The name of the SKU. E.g. P3. It is typically a letter+number code",
                    "Required": true,
                    "Type": "string"
                  },
                  {
                    "#name": "tier",
                    "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.",
                    "Enum": [
                      [
                        "Free",
                        ""
                      ],
                      [
                        "Basic",
                        ""
                      ],
                      [
                        "Standard",
                        ""
                      ],
                      [
                        "Premium",
                        ""
                      ]
                    ],
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "size",
                    "Description": "The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "family",
                    "Description": "If the service has different generations of hardware, for the same SKU, then that can be captured here.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "capacity",
                    "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.",
                    "Format": "int32",
                    "Required": false,
                    "Type": "integer"
                  }
                ]
              },
              "@added_ad2032e040734e36b4d07c77cdc78d2b": {
                "#name": "plan",
                "Description": "Plan for the resource.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "name",
                    "Description": "A user defined name of the 3rd Party Artifact that is being procured.",
                    "Required": true,
                    "Type": "string"
                  },
                  {
                    "#name": "publisher",
                    "Description": "The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic",
                    "Required": true,
                    "Type": "string"
                  },
                  {
                    "#name": "product",
                    "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.",
                    "Required": true,
                    "Type": "string"
                  },
                  {
                    "#name": "promotionCode",
                    "Description": "A publisher provided promotion code as provisioned in Data Market for the said product/artifact.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "version",
                    "Description": "The version of the desired product/artifact.",
                    "Required": false,
                    "Type": "string"
                  }
                ]
              }
            }
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "Url to get the next page."
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/discounts
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Discount items on this page ,
Required: True ,
}
[
{
properties:
{
Description: Discount properties ,
Required: False ,
}
{
entityType:
{
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: No description available. ,
Affiliate: No description available. ,
}
,
Required: True ,
}
enum ,
productCode:
{
Description: This is the catalog UPN for the product. ,
Required: True ,
}
string ,
startAt:
{
Description: Start date of the discount. Value is the date the discount started or will start in the future. ,
Format: date-time ,
Required: True ,
}
string ,
systemId:
{
Description: This is the globally unique identifier of the Discount which will not change for the lifetime of the Discount. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The state of the resource. Supported values are Pending, Failed, Succeeded, Canceled. ,
Enum:
{
Unknown: No description available. ,
Pending: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
billingAccountResourceId:
{
Description: Billing account resource id where the discount metadata is present. ,
Format: arm-id ,
Required: False ,
}
string ,
billingProfileResourceId:
{
Description: Billing profile resource id where the discount is scoped to. ,
Format: arm-id ,
Required: False ,
}
string ,
customerResourceId:
{
Description: Customer resource id where the discount is scoped to. ,
Format: arm-id ,
Required: False ,
}
string ,
displayName:
{
Description: This defines a user friendly display name for the discount. ,
Required: False ,
}
string ,
status:
{
Description: Represents the current status of the discount. ,
Enum:
{
Active: No description available. ,
Pending: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Expired: No description available. ,
}
,
Required: False ,
}
enum ,
benefitResourceId:
{
Description: Fully-qualified identifier of the benefit under applicable benefit list. ,
Format: arm-id ,
Required: False ,
}
string ,
appliedScopeType:
{
Description: List of applied scopes supported for discounts. ,
Enum:
{
BillingAccount: No description available. ,
BillingProfile: No description available. ,
Customer: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
managedBy:
{
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. ,
Required: False ,
}
string ,
kind:
{
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. ,
Required: False ,
}
string ,
etag:
{
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. ,
Required: False ,
}
string ,
identity:
{
Description: Managed service identity (system assigned and/or user assigned identities) ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
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. ,
Required: False ,
}
object ,
}
,
sku:
{
Description: The resource model definition representing SKU ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. E.g. P3. It is typically a letter+number code ,
Required: True ,
}
string ,
tier:
{
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. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
plan:
{
Description: Plan for the resource. ,
Required: False ,
}
{
name:
{
Description: A user defined name of the 3rd Party Artifact that is being procured. ,
Required: True ,
}
string ,
publisher:
{
Description: The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic ,
Required: True ,
}
string ,
product:
{
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. ,
Required: True ,
}
string ,
promotionCode:
{
Description: A publisher provided promotion code as provisioned in Data Market for the said product/artifact. ,
Required: False ,
}
string ,
version:
{
Description: The version of the desired product/artifact. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Discount_Get (updated)
Description :  Get discount at resource group level
Reference :  Link ¶

⚶ Changes

{
  "#id": "Discount_Get",
  "$responses": {
    "200": {
      "$properties": {
        "@added_4ab94ceec8b1482294e20725f59b587f": {
          "#name": "managedBy",
          "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.",
          "Required": false,
          "Type": "string"
        },
        "@added_9c7f5661e7a84701b362287fd8543d2e": {
          "#name": "kind",
          "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.",
          "Required": false,
          "Type": "string"
        },
        "@added_744f72e60a024c66b4147260855c17f3": {
          "#name": "etag",
          "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.",
          "Required": false,
          "Type": "string"
        },
        "@added_c5a82b053e8e474ca517200e767f8ce8": {
          "#name": "identity",
          "Description": "Managed service identity (system assigned and/or user assigned identities)",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "principalId",
              "Description": "The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.",
              "Format": "uuid",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "tenantId",
              "Description": "The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.",
              "Format": "uuid",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "type",
              "Description": "Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).",
              "Enum": [
                [
                  "None",
                  ""
                ],
                [
                  "SystemAssigned",
                  ""
                ],
                [
                  "UserAssigned",
                  ""
                ],
                [
                  "SystemAssigned,UserAssigned",
                  ""
                ]
              ],
              "Required": true,
              "Type": "string"
            },
            {
              "#name": "userAssignedIdentities",
              "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.",
              "Required": false,
              "Type": "object"
            }
          ]
        },
        "@added_1263c0dc4e09482ebaa803feec640bd7": {
          "#name": "sku",
          "Description": "The resource model definition representing SKU",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "name",
              "Description": "The name of the SKU. E.g. P3. It is typically a letter+number code",
              "Required": true,
              "Type": "string"
            },
            {
              "#name": "tier",
              "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.",
              "Enum": [
                [
                  "Free",
                  ""
                ],
                [
                  "Basic",
                  ""
                ],
                [
                  "Standard",
                  ""
                ],
                [
                  "Premium",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "size",
              "Description": "The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "family",
              "Description": "If the service has different generations of hardware, for the same SKU, then that can be captured here.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "capacity",
              "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.",
              "Format": "int32",
              "Required": false,
              "Type": "integer"
            }
          ]
        },
        "@added_ce165ee1ebde4b78b3fd11be265d3e05": {
          "#name": "plan",
          "Description": "Plan for the resource.",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "name",
              "Description": "A user defined name of the 3rd Party Artifact that is being procured.",
              "Required": true,
              "Type": "string"
            },
            {
              "#name": "publisher",
              "Description": "The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic",
              "Required": true,
              "Type": "string"
            },
            {
              "#name": "product",
              "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.",
              "Required": true,
              "Type": "string"
            },
            {
              "#name": "promotionCode",
              "Description": "A publisher provided promotion code as provisioned in Data Market for the said product/artifact.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "version",
              "Description": "The version of the desired product/artifact.",
              "Required": false,
              "Type": "string"
            }
          ]
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/discounts/{discountName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
discountName:
{
Description: Name of the discount ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Discount properties ,
Required: False ,
}
{
entityType:
{
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: No description available. ,
Affiliate: No description available. ,
}
,
Required: True ,
}
enum ,
productCode:
{
Description: This is the catalog UPN for the product. ,
Required: True ,
}
string ,
startAt:
{
Description: Start date of the discount. Value is the date the discount started or will start in the future. ,
Format: date-time ,
Required: True ,
}
string ,
systemId:
{
Description: This is the globally unique identifier of the Discount which will not change for the lifetime of the Discount. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The state of the resource. Supported values are Pending, Failed, Succeeded, Canceled. ,
Enum:
{
Unknown: No description available. ,
Pending: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
billingAccountResourceId:
{
Description: Billing account resource id where the discount metadata is present. ,
Format: arm-id ,
Required: False ,
}
string ,
billingProfileResourceId:
{
Description: Billing profile resource id where the discount is scoped to. ,
Format: arm-id ,
Required: False ,
}
string ,
customerResourceId:
{
Description: Customer resource id where the discount is scoped to. ,
Format: arm-id ,
Required: False ,
}
string ,
displayName:
{
Description: This defines a user friendly display name for the discount. ,
Required: False ,
}
string ,
status:
{
Description: Represents the current status of the discount. ,
Enum:
{
Active: No description available. ,
Pending: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Expired: No description available. ,
}
,
Required: False ,
}
enum ,
benefitResourceId:
{
Description: Fully-qualified identifier of the benefit under applicable benefit list. ,
Format: arm-id ,
Required: False ,
}
string ,
appliedScopeType:
{
Description: List of applied scopes supported for discounts. ,
Enum:
{
BillingAccount: No description available. ,
BillingProfile: No description available. ,
Customer: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
managedBy:
{
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. ,
Required: False ,
}
string ,
kind:
{
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. ,
Required: False ,
}
string ,
etag:
{
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. ,
Required: False ,
}
string ,
identity:
{
Description: Managed service identity (system assigned and/or user assigned identities) ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
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. ,
Required: False ,
}
object ,
}
,
sku:
{
Description: The resource model definition representing SKU ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. E.g. P3. It is typically a letter+number code ,
Required: True ,
}
string ,
tier:
{
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. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
plan:
{
Description: Plan for the resource. ,
Required: False ,
}
{
name:
{
Description: A user defined name of the 3rd Party Artifact that is being procured. ,
Required: True ,
}
string ,
publisher:
{
Description: The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic ,
Required: True ,
}
string ,
product:
{
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. ,
Required: True ,
}
string ,
promotionCode:
{
Description: A publisher provided promotion code as provisioned in Data Market for the said product/artifact. ,
Required: False ,
}
string ,
version:
{
Description: The version of the desired product/artifact. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Discounts_Create (updated)
Description :  Create discount.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Discounts_Create",
  "$parameters": {
    "body": {
      "$properties": {
        "@added_501a71892f9f480fbf1146c126e29fc4": {
          "#name": "managedBy",
          "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.",
          "Required": false,
          "Type": "string"
        },
        "@added_43bd0fe64c294b44945d5c8a07f5d8cd": {
          "#name": "kind",
          "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.",
          "Required": false,
          "Type": "string"
        },
        "@added_3fa6257485184955b80df8b8b368cdb1": {
          "#name": "etag",
          "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.",
          "Required": false,
          "Type": "string"
        },
        "@added_950d54bf57da4af99f4981e71759672e": {
          "#name": "identity",
          "Description": "Managed service identity (system assigned and/or user assigned identities)",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "principalId",
              "Description": "The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.",
              "Format": "uuid",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "tenantId",
              "Description": "The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.",
              "Format": "uuid",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "type",
              "Description": "Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).",
              "Enum": [
                [
                  "None",
                  ""
                ],
                [
                  "SystemAssigned",
                  ""
                ],
                [
                  "UserAssigned",
                  ""
                ],
                [
                  "SystemAssigned,UserAssigned",
                  ""
                ]
              ],
              "Required": true,
              "Type": "string"
            },
            {
              "#name": "userAssignedIdentities",
              "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.",
              "Required": false,
              "Type": "object"
            }
          ]
        },
        "@added_c9187fa0c8c046cbadf797d2e36953ba": {
          "#name": "sku",
          "Description": "The resource model definition representing SKU",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "name",
              "Description": "The name of the SKU. E.g. P3. It is typically a letter+number code",
              "Required": true,
              "Type": "string"
            },
            {
              "#name": "tier",
              "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.",
              "Enum": [
                [
                  "Free",
                  ""
                ],
                [
                  "Basic",
                  ""
                ],
                [
                  "Standard",
                  ""
                ],
                [
                  "Premium",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "size",
              "Description": "The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "family",
              "Description": "If the service has different generations of hardware, for the same SKU, then that can be captured here.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "capacity",
              "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.",
              "Format": "int32",
              "Required": false,
              "Type": "integer"
            }
          ]
        },
        "@added_afe9ef4b2b704d4586556f6de2344c47": {
          "#name": "plan",
          "Description": "Plan for the resource.",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "name",
              "Description": "A user defined name of the 3rd Party Artifact that is being procured.",
              "Required": true,
              "Type": "string"
            },
            {
              "#name": "publisher",
              "Description": "The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic",
              "Required": true,
              "Type": "string"
            },
            {
              "#name": "product",
              "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.",
              "Required": true,
              "Type": "string"
            },
            {
              "#name": "promotionCode",
              "Description": "A publisher provided promotion code as provisioned in Data Market for the said product/artifact.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "version",
              "Description": "The version of the desired product/artifact.",
              "Required": false,
              "Type": "string"
            }
          ]
        }
      }
    }
  },
  "$responses": [
    {
      "200": {
        "$properties": {
          "@added_ceb494559aba4989b90e616bc1aaaf8c": {
            "#name": "managedBy",
            "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.",
            "Required": false,
            "Type": "string"
          },
          "@added_295e90549e0f4ab49afec478944db2ab": {
            "#name": "kind",
            "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.",
            "Required": false,
            "Type": "string"
          },
          "@added_d26c1999f45c460f939a1153343a5e74": {
            "#name": "etag",
            "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.",
            "Required": false,
            "Type": "string"
          },
          "@added_8cad643880364c1bb40f7e7e165889a9": {
            "#name": "identity",
            "Description": "Managed service identity (system assigned and/or user assigned identities)",
            "Required": false,
            "Type": "object",
            "$properties": [
              {
                "#name": "principalId",
                "Description": "The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.",
                "Format": "uuid",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "tenantId",
                "Description": "The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.",
                "Format": "uuid",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "type",
                "Description": "Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).",
                "Enum": [
                  [
                    "None",
                    ""
                  ],
                  [
                    "SystemAssigned",
                    ""
                  ],
                  [
                    "UserAssigned",
                    ""
                  ],
                  [
                    "SystemAssigned,UserAssigned",
                    ""
                  ]
                ],
                "Required": true,
                "Type": "string"
              },
              {
                "#name": "userAssignedIdentities",
                "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.",
                "Required": false,
                "Type": "object"
              }
            ]
          },
          "@added_042c7b42a0f449bbb8551f24a9884809": {
            "#name": "sku",
            "Description": "The resource model definition representing SKU",
            "Required": false,
            "Type": "object",
            "$properties": [
              {
                "#name": "name",
                "Description": "The name of the SKU. E.g. P3. It is typically a letter+number code",
                "Required": true,
                "Type": "string"
              },
              {
                "#name": "tier",
                "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.",
                "Enum": [
                  [
                    "Free",
                    ""
                  ],
                  [
                    "Basic",
                    ""
                  ],
                  [
                    "Standard",
                    ""
                  ],
                  [
                    "Premium",
                    ""
                  ]
                ],
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "size",
                "Description": "The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "family",
                "Description": "If the service has different generations of hardware, for the same SKU, then that can be captured here.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "capacity",
                "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.",
                "Format": "int32",
                "Required": false,
                "Type": "integer"
              }
            ]
          },
          "@added_723022b8dcd14947ae6249d2f11f31f3": {
            "#name": "plan",
            "Description": "Plan for the resource.",
            "Required": false,
            "Type": "object",
            "$properties": [
              {
                "#name": "name",
                "Description": "A user defined name of the 3rd Party Artifact that is being procured.",
                "Required": true,
                "Type": "string"
              },
              {
                "#name": "publisher",
                "Description": "The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic",
                "Required": true,
                "Type": "string"
              },
              {
                "#name": "product",
                "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.",
                "Required": true,
                "Type": "string"
              },
              {
                "#name": "promotionCode",
                "Description": "A publisher provided promotion code as provisioned in Data Market for the said product/artifact.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "version",
                "Description": "The version of the desired product/artifact.",
                "Required": false,
                "Type": "string"
              }
            ]
          }
        }
      }
    },
    {
      "#status": "201",
      "$headers": [
        {
          "#name": "azure-asyncoperation",
          "Description": {
            "new": "A link to the status monitor",
            "old": "URL for checking the ongoing status of the operation."
          }
        },
        {
          "#name": "retry-after",
          "Description": {
            "new": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
            "old": "Clients should wait for the Retry-After interval before polling again"
          }
        }
      ],
      "$schema": {
        "$properties": {
          "@added_bcb19d979fd1417abf4dce3c0115329f": {
            "#name": "managedBy",
            "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.",
            "Required": false,
            "Type": "string"
          },
          "@added_7aa1863ebbd843dca4a38aff49963bcc": {
            "#name": "kind",
            "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.",
            "Required": false,
            "Type": "string"
          },
          "@added_3f860b0d405941a0a87b8738b7236b9e": {
            "#name": "etag",
            "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.",
            "Required": false,
            "Type": "string"
          },
          "@added_d6637f1b39fc4a54a504799db04e1fb8": {
            "#name": "identity",
            "Description": "Managed service identity (system assigned and/or user assigned identities)",
            "Required": false,
            "Type": "object",
            "$properties": [
              {
                "#name": "principalId",
                "Description": "The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.",
                "Format": "uuid",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "tenantId",
                "Description": "The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.",
                "Format": "uuid",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "type",
                "Description": "Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).",
                "Enum": [
                  [
                    "None",
                    ""
                  ],
                  [
                    "SystemAssigned",
                    ""
                  ],
                  [
                    "UserAssigned",
                    ""
                  ],
                  [
                    "SystemAssigned,UserAssigned",
                    ""
                  ]
                ],
                "Required": true,
                "Type": "string"
              },
              {
                "#name": "userAssignedIdentities",
                "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.",
                "Required": false,
                "Type": "object"
              }
            ]
          },
          "@added_eede0448fac64519952c2726244c09f9": {
            "#name": "sku",
            "Description": "The resource model definition representing SKU",
            "Required": false,
            "Type": "object",
            "$properties": [
              {
                "#name": "name",
                "Description": "The name of the SKU. E.g. P3. It is typically a letter+number code",
                "Required": true,
                "Type": "string"
              },
              {
                "#name": "tier",
                "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.",
                "Enum": [
                  [
                    "Free",
                    ""
                  ],
                  [
                    "Basic",
                    ""
                  ],
                  [
                    "Standard",
                    ""
                  ],
                  [
                    "Premium",
                    ""
                  ]
                ],
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "size",
                "Description": "The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "family",
                "Description": "If the service has different generations of hardware, for the same SKU, then that can be captured here.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "capacity",
                "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.",
                "Format": "int32",
                "Required": false,
                "Type": "integer"
              }
            ]
          },
          "@added_a1427756a492491290ac4bfc0b597947": {
            "#name": "plan",
            "Description": "Plan for the resource.",
            "Required": false,
            "Type": "object",
            "$properties": [
              {
                "#name": "name",
                "Description": "A user defined name of the 3rd Party Artifact that is being procured.",
                "Required": true,
                "Type": "string"
              },
              {
                "#name": "publisher",
                "Description": "The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic",
                "Required": true,
                "Type": "string"
              },
              {
                "#name": "product",
                "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.",
                "Required": true,
                "Type": "string"
              },
              {
                "#name": "promotionCode",
                "Description": "A publisher provided promotion code as provisioned in Data Market for the said product/artifact.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "version",
                "Description": "The version of the desired product/artifact.",
                "Required": false,
                "Type": "string"
              }
            ]
          }
        }
      }
    }
  ]
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/discounts/{discountName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
discountName:
{
Description: Name of the discount ,
Required: True ,
}
string ,
body:
{
Description: Request body for creating a discount. ,
Required: True ,
}
{
properties:
{
Description: Discount properties ,
Required: False ,
}
{
entityType:
{
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: No description available. ,
Affiliate: No description available. ,
}
,
Required: True ,
}
enum ,
productCode:
{
Description: This is the catalog UPN for the product. ,
Required: True ,
}
string ,
startAt:
{
Description: Start date of the discount. Value is the date the discount started or will start in the future. ,
Format: date-time ,
Required: True ,
}
string ,
systemId:
{
Description: This is the globally unique identifier of the Discount which will not change for the lifetime of the Discount. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The state of the resource. Supported values are Pending, Failed, Succeeded, Canceled. ,
Enum:
{
Unknown: No description available. ,
Pending: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
billingAccountResourceId:
{
Description: Billing account resource id where the discount metadata is present. ,
Format: arm-id ,
Required: False ,
}
string ,
billingProfileResourceId:
{
Description: Billing profile resource id where the discount is scoped to. ,
Format: arm-id ,
Required: False ,
}
string ,
customerResourceId:
{
Description: Customer resource id where the discount is scoped to. ,
Format: arm-id ,
Required: False ,
}
string ,
displayName:
{
Description: This defines a user friendly display name for the discount. ,
Required: False ,
}
string ,
status:
{
Description: Represents the current status of the discount. ,
Enum:
{
Active: No description available. ,
Pending: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Expired: No description available. ,
}
,
Required: False ,
}
enum ,
benefitResourceId:
{
Description: Fully-qualified identifier of the benefit under applicable benefit list. ,
Format: arm-id ,
Required: False ,
}
string ,
appliedScopeType:
{
Description: List of applied scopes supported for discounts. ,
Enum:
{
BillingAccount: No description available. ,
BillingProfile: No description available. ,
Customer: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
managedBy:
{
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. ,
Required: False ,
}
string ,
kind:
{
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. ,
Required: False ,
}
string ,
etag:
{
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. ,
Required: False ,
}
string ,
identity:
{
Description: Managed service identity (system assigned and/or user assigned identities) ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
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. ,
Required: False ,
}
object ,
}
,
sku:
{
Description: The resource model definition representing SKU ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. E.g. P3. It is typically a letter+number code ,
Required: True ,
}
string ,
tier:
{
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. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
plan:
{
Description: Plan for the resource. ,
Required: False ,
}
{
name:
{
Description: A user defined name of the 3rd Party Artifact that is being procured. ,
Required: True ,
}
string ,
publisher:
{
Description: The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic ,
Required: True ,
}
string ,
product:
{
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. ,
Required: True ,
}
string ,
promotionCode:
{
Description: A publisher provided promotion code as provisioned in Data Market for the said product/artifact. ,
Required: False ,
}
string ,
version:
{
Description: The version of the desired product/artifact. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Discount properties ,
Required: False ,
}
{
entityType:
{
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: No description available. ,
Affiliate: No description available. ,
}
,
Required: True ,
}
enum ,
productCode:
{
Description: This is the catalog UPN for the product. ,
Required: True ,
}
string ,
startAt:
{
Description: Start date of the discount. Value is the date the discount started or will start in the future. ,
Format: date-time ,
Required: True ,
}
string ,
systemId:
{
Description: This is the globally unique identifier of the Discount which will not change for the lifetime of the Discount. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The state of the resource. Supported values are Pending, Failed, Succeeded, Canceled. ,
Enum:
{
Unknown: No description available. ,
Pending: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
billingAccountResourceId:
{
Description: Billing account resource id where the discount metadata is present. ,
Format: arm-id ,
Required: False ,
}
string ,
billingProfileResourceId:
{
Description: Billing profile resource id where the discount is scoped to. ,
Format: arm-id ,
Required: False ,
}
string ,
customerResourceId:
{
Description: Customer resource id where the discount is scoped to. ,
Format: arm-id ,
Required: False ,
}
string ,
displayName:
{
Description: This defines a user friendly display name for the discount. ,
Required: False ,
}
string ,
status:
{
Description: Represents the current status of the discount. ,
Enum:
{
Active: No description available. ,
Pending: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Expired: No description available. ,
}
,
Required: False ,
}
enum ,
benefitResourceId:
{
Description: Fully-qualified identifier of the benefit under applicable benefit list. ,
Format: arm-id ,
Required: False ,
}
string ,
appliedScopeType:
{
Description: List of applied scopes supported for discounts. ,
Enum:
{
BillingAccount: No description available. ,
BillingProfile: No description available. ,
Customer: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
managedBy:
{
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. ,
Required: False ,
}
string ,
kind:
{
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. ,
Required: False ,
}
string ,
etag:
{
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. ,
Required: False ,
}
string ,
identity:
{
Description: Managed service identity (system assigned and/or user assigned identities) ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
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. ,
Required: False ,
}
object ,
}
,
sku:
{
Description: The resource model definition representing SKU ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. E.g. P3. It is typically a letter+number code ,
Required: True ,
}
string ,
tier:
{
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. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
plan:
{
Description: Plan for the resource. ,
Required: False ,
}
{
name:
{
Description: A user defined name of the 3rd Party Artifact that is being procured. ,
Required: True ,
}
string ,
publisher:
{
Description: The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic ,
Required: True ,
}
string ,
product:
{
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. ,
Required: True ,
}
string ,
promotionCode:
{
Description: A publisher provided promotion code as provisioned in Data Market for the said product/artifact. ,
Required: False ,
}
string ,
version:
{
Description: The version of the desired product/artifact. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: Resource definition for Discounts. ,
}
{
properties:
{
Description: Discount properties ,
Required: False ,
}
{
entityType:
{
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: No description available. ,
Affiliate: No description available. ,
}
,
Required: True ,
}
enum ,
productCode:
{
Description: This is the catalog UPN for the product. ,
Required: True ,
}
string ,
startAt:
{
Description: Start date of the discount. Value is the date the discount started or will start in the future. ,
Format: date-time ,
Required: True ,
}
string ,
systemId:
{
Description: This is the globally unique identifier of the Discount which will not change for the lifetime of the Discount. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The state of the resource. Supported values are Pending, Failed, Succeeded, Canceled. ,
Enum:
{
Unknown: No description available. ,
Pending: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
billingAccountResourceId:
{
Description: Billing account resource id where the discount metadata is present. ,
Format: arm-id ,
Required: False ,
}
string ,
billingProfileResourceId:
{
Description: Billing profile resource id where the discount is scoped to. ,
Format: arm-id ,
Required: False ,
}
string ,
customerResourceId:
{
Description: Customer resource id where the discount is scoped to. ,
Format: arm-id ,
Required: False ,
}
string ,
displayName:
{
Description: This defines a user friendly display name for the discount. ,
Required: False ,
}
string ,
status:
{
Description: Represents the current status of the discount. ,
Enum:
{
Active: No description available. ,
Pending: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Expired: No description available. ,
}
,
Required: False ,
}
enum ,
benefitResourceId:
{
Description: Fully-qualified identifier of the benefit under applicable benefit list. ,
Format: arm-id ,
Required: False ,
}
string ,
appliedScopeType:
{
Description: List of applied scopes supported for discounts. ,
Enum:
{
BillingAccount: No description available. ,
BillingProfile: No description available. ,
Customer: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
managedBy:
{
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. ,
Required: False ,
}
string ,
kind:
{
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. ,
Required: False ,
}
string ,
etag:
{
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. ,
Required: False ,
}
string ,
identity:
{
Description: Managed service identity (system assigned and/or user assigned identities) ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
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. ,
Required: False ,
}
object ,
}
,
sku:
{
Description: The resource model definition representing SKU ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. E.g. P3. It is typically a letter+number code ,
Required: True ,
}
string ,
tier:
{
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. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
plan:
{
Description: Plan for the resource. ,
Required: False ,
}
{
name:
{
Description: A user defined name of the 3rd Party Artifact that is being procured. ,
Required: True ,
}
string ,
publisher:
{
Description: The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic ,
Required: True ,
}
string ,
product:
{
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. ,
Required: True ,
}
string ,
promotionCode:
{
Description: A publisher provided promotion code as provisioned in Data Market for the said product/artifact. ,
Required: False ,
}
string ,
version:
{
Description: The version of the desired product/artifact. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Discount_Update (updated)
Description :  Update discounts
Reference :  Link ¶

⚶ Changes

{
  "#id": "Discount_Update",
  "$responses": {
    "200": {
      "$properties": {
        "@added_34b5ce8e40c64a47a7b5eb42cb31a26d": {
          "#name": "managedBy",
          "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.",
          "Required": false,
          "Type": "string"
        },
        "@added_eea0fbf2feca400eb185c465522b87d8": {
          "#name": "kind",
          "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.",
          "Required": false,
          "Type": "string"
        },
        "@added_7957178f6aa643649467d8afac17fa9d": {
          "#name": "etag",
          "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.",
          "Required": false,
          "Type": "string"
        },
        "@added_9b827b7ab44f4db084ec230ab43d0954": {
          "#name": "identity",
          "Description": "Managed service identity (system assigned and/or user assigned identities)",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "principalId",
              "Description": "The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.",
              "Format": "uuid",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "tenantId",
              "Description": "The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.",
              "Format": "uuid",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "type",
              "Description": "Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).",
              "Enum": [
                [
                  "None",
                  ""
                ],
                [
                  "SystemAssigned",
                  ""
                ],
                [
                  "UserAssigned",
                  ""
                ],
                [
                  "SystemAssigned,UserAssigned",
                  ""
                ]
              ],
              "Required": true,
              "Type": "string"
            },
            {
              "#name": "userAssignedIdentities",
              "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.",
              "Required": false,
              "Type": "object"
            }
          ]
        },
        "@added_f62cf2b57c1f4a2b97372d39b99c3361": {
          "#name": "sku",
          "Description": "The resource model definition representing SKU",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "name",
              "Description": "The name of the SKU. E.g. P3. It is typically a letter+number code",
              "Required": true,
              "Type": "string"
            },
            {
              "#name": "tier",
              "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.",
              "Enum": [
                [
                  "Free",
                  ""
                ],
                [
                  "Basic",
                  ""
                ],
                [
                  "Standard",
                  ""
                ],
                [
                  "Premium",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "size",
              "Description": "The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "family",
              "Description": "If the service has different generations of hardware, for the same SKU, then that can be captured here.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "capacity",
              "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.",
              "Format": "int32",
              "Required": false,
              "Type": "integer"
            }
          ]
        },
        "@added_c60ddeb3214746eda960dbb672d67b30": {
          "#name": "plan",
          "Description": "Plan for the resource.",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "name",
              "Description": "A user defined name of the 3rd Party Artifact that is being procured.",
              "Required": true,
              "Type": "string"
            },
            {
              "#name": "publisher",
              "Description": "The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic",
              "Required": true,
              "Type": "string"
            },
            {
              "#name": "product",
              "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.",
              "Required": true,
              "Type": "string"
            },
            {
              "#name": "promotionCode",
              "Description": "A publisher provided promotion code as provisioned in Data Market for the said product/artifact.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "version",
              "Description": "The version of the desired product/artifact.",
              "Required": false,
              "Type": "string"
            }
          ]
        }
      }
    },
    "202": [
      {
        "#name": "azure-asyncoperation",
        "Description": {
          "new": "A link to the status monitor",
          "old": "URL for checking the ongoing status of the operation."
        }
      },
      {
        "#name": "retry-after",
        "Description": {
          "new": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
          "old": "Clients should wait for the Retry-After interval before polling again"
        }
      },
      {
        "@removed_3fad697aa3974f76b7feeb4e9e019f90": {
          "#name": "location",
          "Description": "Location URI to poll for result.",
          "Type": "string"
        }
      }
    ]
  }
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/discounts/{discountName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
discountName:
{
Description: Name of the discount ,
Required: True ,
}
string ,
body:
{
Description: Request body for updating discounts ,
Required: True ,
}
{
properties:
{
Description: Discounts patch request properties ,
Required: False ,
}
{
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Discount properties ,
Required: False ,
}
{
entityType:
{
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: No description available. ,
Affiliate: No description available. ,
}
,
Required: True ,
}
enum ,
productCode:
{
Description: This is the catalog UPN for the product. ,
Required: True ,
}
string ,
startAt:
{
Description: Start date of the discount. Value is the date the discount started or will start in the future. ,
Format: date-time ,
Required: True ,
}
string ,
systemId:
{
Description: This is the globally unique identifier of the Discount which will not change for the lifetime of the Discount. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The state of the resource. Supported values are Pending, Failed, Succeeded, Canceled. ,
Enum:
{
Unknown: No description available. ,
Pending: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
billingAccountResourceId:
{
Description: Billing account resource id where the discount metadata is present. ,
Format: arm-id ,
Required: False ,
}
string ,
billingProfileResourceId:
{
Description: Billing profile resource id where the discount is scoped to. ,
Format: arm-id ,
Required: False ,
}
string ,
customerResourceId:
{
Description: Customer resource id where the discount is scoped to. ,
Format: arm-id ,
Required: False ,
}
string ,
displayName:
{
Description: This defines a user friendly display name for the discount. ,
Required: False ,
}
string ,
status:
{
Description: Represents the current status of the discount. ,
Enum:
{
Active: No description available. ,
Pending: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Expired: No description available. ,
}
,
Required: False ,
}
enum ,
benefitResourceId:
{
Description: Fully-qualified identifier of the benefit under applicable benefit list. ,
Format: arm-id ,
Required: False ,
}
string ,
appliedScopeType:
{
Description: List of applied scopes supported for discounts. ,
Enum:
{
BillingAccount: No description available. ,
BillingProfile: No description available. ,
Customer: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
managedBy:
{
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. ,
Required: False ,
}
string ,
kind:
{
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. ,
Required: False ,
}
string ,
etag:
{
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. ,
Required: False ,
}
string ,
identity:
{
Description: Managed service identity (system assigned and/or user assigned identities) ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
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. ,
Required: False ,
}
object ,
}
,
sku:
{
Description: The resource model definition representing SKU ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. E.g. P3. It is typically a letter+number code ,
Required: True ,
}
string ,
tier:
{
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. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
plan:
{
Description: Plan for the resource. ,
Required: False ,
}
{
name:
{
Description: A user defined name of the 3rd Party Artifact that is being procured. ,
Required: True ,
}
string ,
publisher:
{
Description: The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic ,
Required: True ,
}
string ,
product:
{
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. ,
Required: True ,
}
string ,
promotionCode:
{
Description: A publisher provided promotion code as provisioned in Data Market for the said product/artifact. ,
Required: False ,
}
string ,
version:
{
Description: The version of the desired product/artifact. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Discounts_Delete (updated)
Description :  Delete discount. Clears the metadata from the user's view.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Discounts_Delete",
  "$responses": {
    "202": [
      {
        "#name": "azure-asyncoperation",
        "Description": {
          "new": "A link to the status monitor",
          "old": "URL for checking the ongoing status of the operation."
        }
      },
      {
        "#name": "retry-after",
        "Description": {
          "new": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
          "old": "Clients should wait for the Retry-After interval before polling again"
        }
      },
      {
        "@removed_c56a540f97d945619bdcc3a84b4661d0": {
          "#name": "location",
          "Description": "Location URI to poll for result.",
          "Type": "string"
        }
      }
    ]
  }
}

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/discounts/{discountName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
discountName:
{
Description: Name of the discount ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Discounts_Cancel (updated)
Description :  Cancel discount. Stops applying the benefit.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Discounts_Cancel",
  "$responses": {
    "200": {
      "$properties": {
        "@added_932ab79f8f2c4faf9adbd8b21dc6f232": {
          "#name": "managedBy",
          "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.",
          "Required": false,
          "Type": "string"
        },
        "@added_67e31a122fd24135b92ad6194423fc1a": {
          "#name": "kind",
          "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.",
          "Required": false,
          "Type": "string"
        },
        "@added_c7a371daed504c6fa228db479f738a64": {
          "#name": "etag",
          "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.",
          "Required": false,
          "Type": "string"
        },
        "@added_4879d33b39094aa2b0bb8eebdd5f3e5c": {
          "#name": "identity",
          "Description": "Managed service identity (system assigned and/or user assigned identities)",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "principalId",
              "Description": "The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.",
              "Format": "uuid",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "tenantId",
              "Description": "The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.",
              "Format": "uuid",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "type",
              "Description": "Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).",
              "Enum": [
                [
                  "None",
                  ""
                ],
                [
                  "SystemAssigned",
                  ""
                ],
                [
                  "UserAssigned",
                  ""
                ],
                [
                  "SystemAssigned,UserAssigned",
                  ""
                ]
              ],
              "Required": true,
              "Type": "string"
            },
            {
              "#name": "userAssignedIdentities",
              "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.",
              "Required": false,
              "Type": "object"
            }
          ]
        },
        "@added_f62bd651b6b946ef9588163521a2a43d": {
          "#name": "sku",
          "Description": "The resource model definition representing SKU",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "name",
              "Description": "The name of the SKU. E.g. P3. It is typically a letter+number code",
              "Required": true,
              "Type": "string"
            },
            {
              "#name": "tier",
              "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.",
              "Enum": [
                [
                  "Free",
                  ""
                ],
                [
                  "Basic",
                  ""
                ],
                [
                  "Standard",
                  ""
                ],
                [
                  "Premium",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "size",
              "Description": "The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "family",
              "Description": "If the service has different generations of hardware, for the same SKU, then that can be captured here.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "capacity",
              "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.",
              "Format": "int32",
              "Required": false,
              "Type": "integer"
            }
          ]
        },
        "@added_69fe78ed12774e769cd1b8f3c31927dd": {
          "#name": "plan",
          "Description": "Plan for the resource.",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "name",
              "Description": "A user defined name of the 3rd Party Artifact that is being procured.",
              "Required": true,
              "Type": "string"
            },
            {
              "#name": "publisher",
              "Description": "The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic",
              "Required": true,
              "Type": "string"
            },
            {
              "#name": "product",
              "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.",
              "Required": true,
              "Type": "string"
            },
            {
              "#name": "promotionCode",
              "Description": "A publisher provided promotion code as provisioned in Data Market for the said product/artifact.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "version",
              "Description": "The version of the desired product/artifact.",
              "Required": false,
              "Type": "string"
            }
          ]
        }
      }
    },
    "202": [
      {
        "#name": "azure-asyncoperation",
        "Description": {
          "new": "A link to the status monitor",
          "old": "URL for checking the ongoing status of the operation."
        }
      },
      {
        "#name": "retry-after",
        "Description": {
          "new": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
          "old": "Clients should wait for the Retry-After interval before polling again"
        }
      },
      {
        "@removed_bdcef1ff84514c4d9e88220333ca3436": {
          "#name": "location",
          "Description": "Location URI to poll for result.",
          "Type": "string"
        }
      }
    ]
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/discounts/{discountName}/cancel
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
discountName:
{
Description: Name of the discount ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Discount properties ,
Required: False ,
}
{
entityType:
{
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: No description available. ,
Affiliate: No description available. ,
}
,
Required: True ,
}
enum ,
productCode:
{
Description: This is the catalog UPN for the product. ,
Required: True ,
}
string ,
startAt:
{
Description: Start date of the discount. Value is the date the discount started or will start in the future. ,
Format: date-time ,
Required: True ,
}
string ,
systemId:
{
Description: This is the globally unique identifier of the Discount which will not change for the lifetime of the Discount. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The state of the resource. Supported values are Pending, Failed, Succeeded, Canceled. ,
Enum:
{
Unknown: No description available. ,
Pending: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
billingAccountResourceId:
{
Description: Billing account resource id where the discount metadata is present. ,
Format: arm-id ,
Required: False ,
}
string ,
billingProfileResourceId:
{
Description: Billing profile resource id where the discount is scoped to. ,
Format: arm-id ,
Required: False ,
}
string ,
customerResourceId:
{
Description: Customer resource id where the discount is scoped to. ,
Format: arm-id ,
Required: False ,
}
string ,
displayName:
{
Description: This defines a user friendly display name for the discount. ,
Required: False ,
}
string ,
status:
{
Description: Represents the current status of the discount. ,
Enum:
{
Active: No description available. ,
Pending: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Expired: No description available. ,
}
,
Required: False ,
}
enum ,
benefitResourceId:
{
Description: Fully-qualified identifier of the benefit under applicable benefit list. ,
Format: arm-id ,
Required: False ,
}
string ,
appliedScopeType:
{
Description: List of applied scopes supported for discounts. ,
Enum:
{
BillingAccount: No description available. ,
BillingProfile: No description available. ,
Customer: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
managedBy:
{
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. ,
Required: False ,
}
string ,
kind:
{
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. ,
Required: False ,
}
string ,
etag:
{
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. ,
Required: False ,
}
string ,
identity:
{
Description: Managed service identity (system assigned and/or user assigned identities) ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
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. ,
Required: False ,
}
object ,
}
,
sku:
{
Description: The resource model definition representing SKU ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. E.g. P3. It is typically a letter+number code ,
Required: True ,
}
string ,
tier:
{
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. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
plan:
{
Description: Plan for the resource. ,
Required: False ,
}
{
name:
{
Description: A user defined name of the 3rd Party Artifact that is being procured. ,
Required: True ,
}
string ,
publisher:
{
Description: The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic ,
Required: True ,
}
string ,
product:
{
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. ,
Required: True ,
}
string ,
promotionCode:
{
Description: A publisher provided promotion code as provisioned in Data Market for the said product/artifact. ,
Required: False ,
}
string ,
version:
{
Description: The version of the desired product/artifact. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}