Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Bicep resource definition
The commitmentPlans resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.CognitiveServices/commitmentPlans resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.CognitiveServices/commitmentPlans@2025-12-01' = {
kind: 'string'
location: 'string'
name: 'string'
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'
}
tags: {
{customized property}: 'string'
}
}
Property Values
Microsoft.CognitiveServices/commitmentPlans
| Name | Description | Value |
|---|---|---|
| kind | The kind (type) of cognitive service account. | string |
| location | The geo-location where the resource lives | string |
| name | The resource name | string Constraints: Pattern = ^[a-zA-Z0-9][a-zA-Z0-9_.-]*$ (required) |
| properties | Properties of Cognitive Services account commitment plan. | CommitmentPlanProperties |
| sku | The resource model definition representing SKU | Sku |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
CommitmentPeriod
| Name | Description | Value |
|---|---|---|
| count | Commitment period commitment count. | int |
| tier | Commitment period commitment tier. | string |
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 |
CommitmentPlanTags
| Name | Description | Value |
|---|
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 commitmentPlans resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.CognitiveServices/commitmentPlans resource, add the following JSON to your template.
{
"type": "Microsoft.CognitiveServices/commitmentPlans",
"apiVersion": "2025-12-01",
"name": "string",
"kind": "string",
"location": "string",
"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"
},
"tags": {
"{customized property}": "string"
}
}
Property Values
Microsoft.CognitiveServices/commitmentPlans
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2025-12-01' |
| kind | The kind (type) of cognitive service account. | string |
| location | The geo-location where the resource lives | string |
| name | The resource name | string Constraints: Pattern = ^[a-zA-Z0-9][a-zA-Z0-9_.-]*$ (required) |
| properties | Properties of Cognitive Services account commitment plan. | CommitmentPlanProperties |
| sku | The resource model definition representing SKU | Sku |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
| type | The resource type | 'Microsoft.CognitiveServices/commitmentPlans' |
CommitmentPeriod
| Name | Description | Value |
|---|---|---|
| count | Commitment period commitment count. | int |
| tier | Commitment period commitment tier. | string |
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 |
CommitmentPlanTags
| Name | Description | Value |
|---|
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' |
Usage Examples
Terraform (AzAPI provider) resource definition
The 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/commitmentPlans resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.CognitiveServices/commitmentPlans@2025-12-01"
name = "string"
parent_id = "string"
location = "string"
tags = {
{customized property} = "string"
}
body = {
kind = "string"
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"
}
}
}
Property Values
Microsoft.CognitiveServices/commitmentPlans
| Name | Description | Value |
|---|---|---|
| kind | The kind (type) of cognitive service account. | string |
| location | The geo-location where the resource lives | string |
| name | The resource name | string Constraints: Pattern = ^[a-zA-Z0-9][a-zA-Z0-9_.-]*$ (required) |
| properties | Properties of Cognitive Services account commitment plan. | CommitmentPlanProperties |
| sku | The resource model definition representing SKU | Sku |
| tags | Resource tags | Dictionary of tag names and values. |
| type | The resource type | "Microsoft.CognitiveServices/commitmentPlans@2025-12-01" |
CommitmentPeriod
| Name | Description | Value |
|---|---|---|
| count | Commitment period commitment count. | int |
| tier | Commitment period commitment tier. | string |
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 |
CommitmentPlanTags
| Name | Description | Value |
|---|
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' |