Microsoft.CognitiveServices accounts/commitmentPlans

Bicep resource definition

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

resource symbolicname 'Microsoft.CognitiveServices/accounts/commitmentPlans@2023-05-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  sku: {
    capacity: int
    family: 'string'
    name: 'string'
    size: 'string'
    tier: 'string'
  }
  kind: 'string'
  parent: resourceSymbolicName
  properties: {
    autoRenew: bool
    commitmentPlanGuid: 'string'
    current: {
      count: int
      tier: 'string'
    }
    hostingModel: 'string'
    next: {
      count: int
      tier: 'string'
    }
    planType: 'string'
  }
}

Property values

accounts/commitmentPlans

Name Description Value
name The resource name

See how to set names and types for child resources in Bicep.
string (required)
location The geo-location where the resource lives string
tags Resource tags. Dictionary of tag names and values. See Tags in templates
sku The resource model definition representing SKU Sku
kind The Kind of the resource. string
parent In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource.

For more information, see Child resource outside parent resource.
Symbolic name for resource of type: accounts
properties Properties of Cognitive Services account commitment plan. CommitmentPlanProperties

CommitmentPlanProperties

Name Description Value
autoRenew AutoRenew commitment plan. bool
commitmentPlanGuid Commitment plan guid. string
current Cognitive Services account commitment period. CommitmentPeriod
hostingModel Account hosting model. 'ConnectedContainer'
'DisconnectedContainer'
'ProvisionedWeb'
'Web'
next Cognitive Services account commitment period. CommitmentPeriod
planType Commitment plan type. string

CommitmentPeriod

Name Description Value
count Commitment period commitment count. int
tier Commitment period commitment tier. string

Sku

Name Description Value
capacity 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. int
family If the service has different generations of hardware, for the same SKU, then that can be captured here. string
name The name of the SKU. Ex - P3. It is typically a letter+number code string (required)
size The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. string
tier 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. 'Basic'
'Enterprise'
'Free'
'Premium'
'Standard'

ARM template resource definition

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

{
  "type": "Microsoft.CognitiveServices/accounts/commitmentPlans",
  "apiVersion": "2023-05-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "sku": {
    "capacity": "int",
    "family": "string",
    "name": "string",
    "size": "string",
    "tier": "string"
  },
  "kind": "string",
  "properties": {
    "autoRenew": "bool",
    "commitmentPlanGuid": "string",
    "current": {
      "count": "int",
      "tier": "string"
    },
    "hostingModel": "string",
    "next": {
      "count": "int",
      "tier": "string"
    },
    "planType": "string"
  }
}

Property values

accounts/commitmentPlans

Name Description Value
type The resource type 'Microsoft.CognitiveServices/accounts/commitmentPlans'
apiVersion The resource api version '2023-05-01'
name The resource name

See how to set names and types for child resources in JSON ARM templates.
string (required)
location The geo-location where the resource lives string
tags Resource tags. Dictionary of tag names and values. See Tags in templates
sku The resource model definition representing SKU Sku
kind The Kind of the resource. string
properties Properties of Cognitive Services account commitment plan. CommitmentPlanProperties

CommitmentPlanProperties

Name Description Value
autoRenew AutoRenew commitment plan. bool
commitmentPlanGuid Commitment plan guid. string
current Cognitive Services account commitment period. CommitmentPeriod
hostingModel Account hosting model. 'ConnectedContainer'
'DisconnectedContainer'
'ProvisionedWeb'
'Web'
next Cognitive Services account commitment period. CommitmentPeriod
planType Commitment plan type. string

CommitmentPeriod

Name Description Value
count Commitment period commitment count. int
tier Commitment period commitment tier. string

Sku

Name Description Value
capacity 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. int
family If the service has different generations of hardware, for the same SKU, then that can be captured here. string
name The name of the SKU. Ex - P3. It is typically a letter+number code string (required)
size The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. string
tier 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. 'Basic'
'Enterprise'
'Free'
'Premium'
'Standard'

Terraform (AzAPI provider) resource definition

The accounts/commitmentPlans resource type can be deployed with operations that target:

  • Resource groups

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

Resource format

To create a Microsoft.CognitiveServices/accounts/commitmentPlans resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.CognitiveServices/accounts/commitmentPlans@2023-05-01"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      autoRenew = bool
      commitmentPlanGuid = "string"
      current = {
        count = int
        tier = "string"
      }
      hostingModel = "string"
      next = {
        count = int
        tier = "string"
      }
      planType = "string"
    }
    sku = {
      capacity = int
      family = "string"
      name = "string"
      size = "string"
      tier = "string"
    }
    kind = "string"
  })
}

Property values

accounts/commitmentPlans

Name Description Value
type The resource type "Microsoft.CognitiveServices/accounts/commitmentPlans@2023-05-01"
name The resource name string (required)
location The geo-location where the resource lives string
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: accounts
tags Resource tags. Dictionary of tag names and values.
sku The resource model definition representing SKU Sku
kind The Kind of the resource. string
properties Properties of Cognitive Services account commitment plan. CommitmentPlanProperties

CommitmentPlanProperties

Name Description Value
autoRenew AutoRenew commitment plan. bool
commitmentPlanGuid Commitment plan guid. string
current Cognitive Services account commitment period. CommitmentPeriod
hostingModel Account hosting model. "ConnectedContainer"
"DisconnectedContainer"
"ProvisionedWeb"
"Web"
next Cognitive Services account commitment period. CommitmentPeriod
planType Commitment plan type. string

CommitmentPeriod

Name Description Value
count Commitment period commitment count. int
tier Commitment period commitment tier. string

Sku

Name Description Value
capacity 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. int
family If the service has different generations of hardware, for the same SKU, then that can be captured here. string
name The name of the SKU. Ex - P3. It is typically a letter+number code string (required)
size The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. string
tier 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. "Basic"
"Enterprise"
"Free"
"Premium"
"Standard"