Share via

Microsoft.Billing promotions

  • Article
Choose a deployment language

Bicep resource definition

The promotions resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Billing/promotions resource, add the following Bicep to your template.

Bicep 
resource symbolicname 'Microsoft.Billing/promotions@2020-11-01-preview' = {
  name: 'string'
  properties: {
    appliedScopes: [
      'string'
    ]
    displayName: 'string'
    orderId: 'string'
  }
  sku: {
    name: 'string'
  }
}

Property Values

Microsoft.Billing/promotions

Name Description Value
name The resource name string (required)
properties PromotionCreateRequestPropertiesOrPromotionResponseProperties
sku PromotionCreateSkuNameRequestProperties

PromotionCreateRequestPropertiesOrPromotionResponseProperties

Name Description Value
appliedScopes List of subscriptions getting the benefit of the promotion. string[]
displayName Friendly name for user to easily identified the promotion. string
orderId Unique Id for the promotion order. string

PromotionCreateSkuNameRequestProperties

Name Description Value
name SKU Name of the promotion to activate string

ARM template resource definition

The promotions resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Billing/promotions resource, add the following JSON to your template.

JSON 
{
  "type": "Microsoft.Billing/promotions",
  "apiVersion": "2020-11-01-preview",
  "name": "string",
  "properties": {
    "appliedScopes": [ "string" ],
    "displayName": "string",
    "orderId": "string"
  },
  "sku": {
    "name": "string"
  }
}

Property Values

Microsoft.Billing/promotions

Name Description Value
apiVersion The api version '2020-11-01-preview'
name The resource name string (required)
properties PromotionCreateRequestPropertiesOrPromotionResponseProperties
sku PromotionCreateSkuNameRequestProperties
type The resource type 'Microsoft.Billing/promotions'

PromotionCreateRequestPropertiesOrPromotionResponseProperties

Name Description Value
appliedScopes List of subscriptions getting the benefit of the promotion. string[]
displayName Friendly name for user to easily identified the promotion. string
orderId Unique Id for the promotion order. string

PromotionCreateSkuNameRequestProperties

Name Description Value
name SKU Name of the promotion to activate string

Usage Examples

Terraform (AzAPI provider) resource definition

The promotions resource type can be deployed with operations that target:

  • Tenant

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Billing/promotions resource, add the following Terraform to your template.

Terraform 
resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Billing/promotions@2020-11-01-preview"
  name = "string"
  sku = {
    name = "string"
  }
  body = jsonencode({
    properties = {
      appliedScopes = [
        "string"
      ]
      displayName = "string"
      orderId = "string"
    }
  })
}

Property Values

Microsoft.Billing/promotions

Name Description Value
name The resource name string (required)
properties PromotionCreateRequestPropertiesOrPromotionResponseProperties
sku PromotionCreateSkuNameRequestProperties
type The resource type "Microsoft.Billing/promotions@2020-11-01-preview"

PromotionCreateRequestPropertiesOrPromotionResponseProperties

Name Description Value
appliedScopes List of subscriptions getting the benefit of the promotion. string[]
displayName Friendly name for user to easily identified the promotion. string
orderId Unique Id for the promotion order. string

PromotionCreateSkuNameRequestProperties

Name Description Value
name SKU Name of the promotion to activate string