Share via

Microsoft.Subscription subscriptionDefinitions

  • Article

Bicep resource definition

The subscriptionDefinitions 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.Subscription/subscriptionDefinitions resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.Subscription/subscriptionDefinitions@2017-11-01-preview' = {
  name: 'string'
  properties: {
    etag: 'string'
    offerType: 'string'
    subscriptionDisplayName: 'string'
  }
}

Property values

subscriptionDefinitions

Name Description Value
name The resource name string (required)
properties the subscription definition properties SubscriptionDefinitionProperties

SubscriptionDefinitionProperties

Name Description Value
etag The etag the subscription definition. string
offerType The offer type of the subscription. For example, MS-AZR-0017P (EnterpriseAgreement) and MS-AZR-0148P (EnterpriseAgreement devTest) are available. string
subscriptionDisplayName The display name of the subscription. string

ARM template resource definition

The subscriptionDefinitions 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.Subscription/subscriptionDefinitions resource, add the following JSON to your template.

{
  "type": "Microsoft.Subscription/subscriptionDefinitions",
  "apiVersion": "2017-11-01-preview",
  "name": "string",
  "properties": {
    "etag": "string",
    "offerType": "string",
    "subscriptionDisplayName": "string"
  }
}

Property values

subscriptionDefinitions

Name Description Value
type The resource type 'Microsoft.Subscription/subscriptionDefinitions'
apiVersion The resource api version '2017-11-01-preview'
name The resource name string (required)
properties the subscription definition properties SubscriptionDefinitionProperties

SubscriptionDefinitionProperties

Name Description Value
etag The etag the subscription definition. string
offerType The offer type of the subscription. For example, MS-AZR-0017P (EnterpriseAgreement) and MS-AZR-0148P (EnterpriseAgreement devTest) are available. string
subscriptionDisplayName The display name of the subscription. string

Terraform (AzAPI provider) resource definition

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

  • Tenants

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

Resource format

To create a Microsoft.Subscription/subscriptionDefinitions resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Subscription/subscriptionDefinitions@2017-11-01-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      etag = "string"
      offerType = "string"
      subscriptionDisplayName = "string"
    }
  })
}

Property values

subscriptionDefinitions

Name Description Value
type The resource type "Microsoft.Subscription/subscriptionDefinitions@2017-11-01-preview"
name The resource name string (required)
parent_id To deploy to a tenant, use /. string (required)
properties the subscription definition properties SubscriptionDefinitionProperties

SubscriptionDefinitionProperties

Name Description Value
etag The etag the subscription definition. string
offerType The offer type of the subscription. For example, MS-AZR-0017P (EnterpriseAgreement) and MS-AZR-0148P (EnterpriseAgreement devTest) are available. string
subscriptionDisplayName The display name of the subscription. string