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 labs/costs 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.DevTestLab/labs/costs resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.DevTestLab/labs/costs@2018-09-15' = {
parent: resourceSymbolicName
location: 'string'
name: 'string'
properties: {
createdDate: 'string'
currencyCode: 'string'
endDateTime: 'string'
startDateTime: 'string'
targetCost: {
costThresholds: [
{
displayOnChart: 'string'
notificationSent: 'string'
percentageThreshold: {
thresholdValue: int
}
sendNotificationWhenExceeded: 'string'
thresholdId: 'string'
}
]
cycleEndDateTime: 'string'
cycleStartDateTime: 'string'
cycleType: 'string'
status: 'string'
target: int
}
}
tags: {
{customized property}: 'string'
}
}
Property Values
Microsoft.DevTestLab/labs/costs
| Name | Description | Value |
|---|---|---|
| location | The geo-location where the resource lives | string |
| name | The resource name | string (required) |
| 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: labs |
| properties | The properties of the resource. | LabCostProperties (required) |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
CostThresholdProperties
| Name | Description | Value |
|---|---|---|
| displayOnChart | Indicates whether this threshold will be displayed on cost charts. | 'Disabled' 'Enabled' |
| notificationSent | Indicates the datetime when notifications were last sent for this threshold. | string |
| percentageThreshold | The value of the percentage cost threshold. | PercentageCostThresholdProperties |
| sendNotificationWhenExceeded | Indicates whether notifications will be sent when this threshold is exceeded. | 'Disabled' 'Enabled' |
| thresholdId | The ID of the cost threshold item. | string |
LabCostProperties
| Name | Description | Value |
|---|---|---|
| createdDate | The creation date of the cost. | string |
| currencyCode | The currency code of the cost. | string |
| endDateTime | The end time of the cost data. | string |
| startDateTime | The start time of the cost data. | string |
| targetCost | The target cost properties | TargetCostProperties |
LabCostTags
| Name | Description | Value |
|---|
PercentageCostThresholdProperties
| Name | Description | Value |
|---|---|---|
| thresholdValue | The cost threshold value. | int |
TargetCostProperties
| Name | Description | Value |
|---|---|---|
| costThresholds | Cost thresholds. | CostThresholdProperties[] |
| cycleEndDateTime | Reporting cycle end date. | string |
| cycleStartDateTime | Reporting cycle start date. | string |
| cycleType | Reporting cycle type. | 'CalendarMonth' 'Custom' |
| status | Target cost status | 'Disabled' 'Enabled' |
| target | Lab target cost | int |
ARM template resource definition
The labs/costs 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.DevTestLab/labs/costs resource, add the following JSON to your template.
{
"type": "Microsoft.DevTestLab/labs/costs",
"apiVersion": "2018-09-15",
"name": "string",
"location": "string",
"properties": {
"createdDate": "string",
"currencyCode": "string",
"endDateTime": "string",
"startDateTime": "string",
"targetCost": {
"costThresholds": [
{
"displayOnChart": "string",
"notificationSent": "string",
"percentageThreshold": {
"thresholdValue": "int"
},
"sendNotificationWhenExceeded": "string",
"thresholdId": "string"
}
],
"cycleEndDateTime": "string",
"cycleStartDateTime": "string",
"cycleType": "string",
"status": "string",
"target": "int"
}
},
"tags": {
"{customized property}": "string"
}
}
Property Values
Microsoft.DevTestLab/labs/costs
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2018-09-15' |
| location | The geo-location where the resource lives | string |
| name | The resource name | string (required) |
| properties | The properties of the resource. | LabCostProperties (required) |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
| type | The resource type | 'Microsoft.DevTestLab/labs/costs' |
CostThresholdProperties
| Name | Description | Value |
|---|---|---|
| displayOnChart | Indicates whether this threshold will be displayed on cost charts. | 'Disabled' 'Enabled' |
| notificationSent | Indicates the datetime when notifications were last sent for this threshold. | string |
| percentageThreshold | The value of the percentage cost threshold. | PercentageCostThresholdProperties |
| sendNotificationWhenExceeded | Indicates whether notifications will be sent when this threshold is exceeded. | 'Disabled' 'Enabled' |
| thresholdId | The ID of the cost threshold item. | string |
LabCostProperties
| Name | Description | Value |
|---|---|---|
| createdDate | The creation date of the cost. | string |
| currencyCode | The currency code of the cost. | string |
| endDateTime | The end time of the cost data. | string |
| startDateTime | The start time of the cost data. | string |
| targetCost | The target cost properties | TargetCostProperties |
LabCostTags
| Name | Description | Value |
|---|
PercentageCostThresholdProperties
| Name | Description | Value |
|---|---|---|
| thresholdValue | The cost threshold value. | int |
TargetCostProperties
| Name | Description | Value |
|---|---|---|
| costThresholds | Cost thresholds. | CostThresholdProperties[] |
| cycleEndDateTime | Reporting cycle end date. | string |
| cycleStartDateTime | Reporting cycle start date. | string |
| cycleType | Reporting cycle type. | 'CalendarMonth' 'Custom' |
| status | Target cost status | 'Disabled' 'Enabled' |
| target | Lab target cost | int |
Usage Examples
Terraform (AzAPI provider) resource definition
The labs/costs 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.DevTestLab/labs/costs resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DevTestLab/labs/costs@2018-09-15"
name = "string"
parent_id = "string"
location = "string"
tags = {
{customized property} = "string"
}
body = {
properties = {
createdDate = "string"
currencyCode = "string"
endDateTime = "string"
startDateTime = "string"
targetCost = {
costThresholds = [
{
displayOnChart = "string"
notificationSent = "string"
percentageThreshold = {
thresholdValue = int
}
sendNotificationWhenExceeded = "string"
thresholdId = "string"
}
]
cycleEndDateTime = "string"
cycleStartDateTime = "string"
cycleType = "string"
status = "string"
target = int
}
}
}
}
Property Values
Microsoft.DevTestLab/labs/costs
| Name | Description | Value |
|---|---|---|
| location | The geo-location where the resource lives | string |
| name | The resource name | string (required) |
| parent_id | The ID of the resource that is the parent for this resource. | ID for resource of type: labs |
| properties | The properties of the resource. | LabCostProperties (required) |
| tags | Resource tags | Dictionary of tag names and values. |
| type | The resource type | "Microsoft.DevTestLab/labs/costs@2018-09-15" |
CostThresholdProperties
| Name | Description | Value |
|---|---|---|
| displayOnChart | Indicates whether this threshold will be displayed on cost charts. | 'Disabled' 'Enabled' |
| notificationSent | Indicates the datetime when notifications were last sent for this threshold. | string |
| percentageThreshold | The value of the percentage cost threshold. | PercentageCostThresholdProperties |
| sendNotificationWhenExceeded | Indicates whether notifications will be sent when this threshold is exceeded. | 'Disabled' 'Enabled' |
| thresholdId | The ID of the cost threshold item. | string |
LabCostProperties
| Name | Description | Value |
|---|---|---|
| createdDate | The creation date of the cost. | string |
| currencyCode | The currency code of the cost. | string |
| endDateTime | The end time of the cost data. | string |
| startDateTime | The start time of the cost data. | string |
| targetCost | The target cost properties | TargetCostProperties |
LabCostTags
| Name | Description | Value |
|---|
PercentageCostThresholdProperties
| Name | Description | Value |
|---|---|---|
| thresholdValue | The cost threshold value. | int |
TargetCostProperties
| Name | Description | Value |
|---|---|---|
| costThresholds | Cost thresholds. | CostThresholdProperties[] |
| cycleEndDateTime | Reporting cycle end date. | string |
| cycleStartDateTime | Reporting cycle start date. | string |
| cycleType | Reporting cycle type. | 'CalendarMonth' 'Custom' |
| status | Target cost status | 'Disabled' 'Enabled' |
| target | Lab target cost | int |