Budgets Microsoft.Consumption 2022-09-01
Définition de ressource Bicep
Le type de ressource budgets peut être déployé avec des opérations qui ciblent :
Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.
Format de ressource
Pour créer une ressource Microsoft.Consumption/budgets, ajoutez le bicep suivant à votre modèle.
resource symbolicname 'Microsoft.Consumption/budgets@2022-09-01' = {
scope: resourceSymbolicName or scope
eTag: 'string'
name: 'string'
properties: {
amount: int
category: 'string'
filter: {
and: [
{
dimensions: {
name: 'string'
operator: 'string'
values: [
'string'
]
}
tags: {
name: 'string'
operator: 'string'
values: [
'string'
]
}
}
]
dimensions: {
name: 'string'
operator: 'string'
values: [
'string'
]
}
tags: {
name: 'string'
operator: 'string'
values: [
'string'
]
}
}
notifications: {
{customized property}: {
contactEmails: [
'string'
]
contactGroups: [
'string'
]
contactRoles: [
'string'
]
enabled: bool
locale: 'string'
operator: 'string'
threshold: int
thresholdType: 'string'
}
}
timeGrain: 'string'
timePeriod: {
endDate: 'string'
startDate: 'string'
}
}
}
Valeurs de propriété
BudgetComparisonExpression
Nom | Description | Valeur |
---|---|---|
nom | Nom de la colonne à utiliser en comparaison. | chaîne (obligatoire) |
opérateur | Opérateur à utiliser pour la comparaison. | 'In' (obligatoire) |
Valeurs | Tableau de valeurs à utiliser pour la comparaison | string[] (obligatoire) |
BudgetFilter
Nom | Description | Valeur |
---|---|---|
et | Expression logique « AND ». Doit avoir au moins 2 éléments. | BudgetFilterProperties[] |
taille | A une expression de comparaison pour une dimension | BudgetComparisonExpression |
étiquettes | A une expression de comparaison pour une balise | BudgetComparisonExpression |
BudgetFilterProperties
Nom | Description | Valeur |
---|---|---|
taille | A une expression de comparaison pour une dimension | BudgetComparisonExpression |
étiquettes | A une expression de comparaison pour une balise | BudgetComparisonExpression |
BudgetProperties
Nom | Description | Valeur |
---|---|---|
quantité | Montant total du coût à suivre avec le budget | int (obligatoire) |
catégorie | Catégorie du budget, que le budget effectue le suivi du coût ou de l’utilisation. | 'Coût' (obligatoire) |
filtre | Peut être utilisé pour filtrer les budgets par dimensions et/ou balises spécifiées par l’utilisateur. | BudgetFilter |
Notifications | Dictionnaire de notifications associées au budget. Le budget peut avoir jusqu’à cinq notifications. | BudgetPropertiesNotifications |
timeGrain | Temps couvert par un budget. Le suivi de la quantité sera réinitialisé en fonction du grain de temps. BillingMonth, BillingQuarter et BillingAnnual ne sont pris en charge que par les clients WD | « Annuellement » 'BillingAnnual' 'BillingMonth' 'BillingQuarter' 'Mensuel' 'Quarterly' (obligatoire) |
timePeriod | A la date de début et de fin du budget. La date de début doit être la première du mois et doit être inférieure à la date de fin. La date de début du budget doit être le 1er juin 2017 ou le 1er juin 2017. La date de début future ne doit pas dépasser douze mois. La date de début passée doit être sélectionnée au cours de la période de temps. Il n’existe aucune restriction à la date de fin. | BudgetTimePeriod (obligatoire) |
BudgetPropertiesNotifications
Nom | Description | Valeur |
---|
BudgetTimePeriod
Nom | Description | Valeur |
---|---|---|
endDate | Date de fin du budget. S’il n’est pas fourni, nous définissons cette valeur par défaut sur 10 ans à partir de la date de début. | corde |
startDate | Date de début du budget. | chaîne (obligatoire) |
Microsoft.Consumption/budgets
Nom | Description | Valeur |
---|---|---|
eTag | eTag de la ressource. Pour gérer le scénario de mise à jour simultanée, ce champ sera utilisé pour déterminer si l’utilisateur met à jour la dernière version ou non. | corde |
nom | Nom de la ressource | chaîne (obligatoire) |
Propriétés | Propriétés du budget. | BudgetProperties |
portée | Utilisez-la lors de la création d’une ressource dans une étendue différente de l’étendue de déploiement. | Définissez cette propriété sur le nom symbolique d’une ressource pour appliquer la ressource d’extension . |
Notification
Nom | Description | Valeur |
---|---|---|
contactEmails | Adresses e-mail à laquelle envoyer la notification budgétaire lorsque le seuil est dépassé. Doit avoir au moins un e-mail de contact ou un groupe de contacts spécifié dans les étendues Abonnement ou Groupe de ressources. Toutes les autres étendues doivent avoir au moins un e-mail de contact spécifié. | string[] (obligatoire) |
contactGroups | Groupes d’actions auxquels envoyer la notification budgétaire lorsque le seuil est dépassé. Doit être fourni en tant qu’ID de ressource Azure complet. Uniquement pris en charge dans les étendues d’abonnement ou de groupe de ressources. | string[] |
contactRoles | Contactez les rôles pour envoyer la notification budgétaire au moment où le seuil est dépassé. | string[] |
Activé | La notification est activée ou non. | bool (obligatoire) |
paramètres régionaux | Langue dans laquelle le destinataire recevra la notification | 'cs-cz' 'da-dk' 'de-de' 'en-gb' 'en-us' 'es-es' 'fr-fr' 'hu-hu' 'it-it' 'ja-jp' 'ko-kr' 'nb-no' 'nl-nl' 'pl-pl' 'pt-br' 'pt-pt' 'ru-ru' 'sv-se' 'tr-tr' 'zh-cn' 'zh-tw' |
opérateur | Opérateur de comparaison. | 'EqualTo' 'GreaterThan' 'GreaterThanOrEqualTo' (obligatoire) |
seuil | Valeur de seuil associée à une notification. La notification est envoyée lorsque le coût a dépassé le seuil. Il est toujours pourcentage et doit être compris entre 0 et 1000. | int (obligatoire) |
thresholdType | Type de seuil | 'Réel' 'Prévu' |
Exemples de démarrage rapide
Les exemples de démarrage rapide suivants déploient ce type de ressource.
Fichier Bicep | Description |
---|---|
créer un budgétaire | Ce modèle montre comment créer un budget sous un abonnement. |
Créer un budget avec de filtre | Ce modèle montre comment créer un budget sous un abonnement. |
créer un budget simple | Ce modèle montre comment créer un budget sous un abonnement. |
Définition de ressource de modèle ARM
Le type de ressource budgets peut être déployé avec des opérations qui ciblent :
Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.
Format de ressource
Pour créer une ressource Microsoft.Consumption/budgets, ajoutez le code JSON suivant à votre modèle.
{
"type": "Microsoft.Consumption/budgets",
"apiVersion": "2022-09-01",
"name": "string",
"eTag": "string",
"properties": {
"amount": "int",
"category": "string",
"filter": {
"and": [
{
"dimensions": {
"name": "string",
"operator": "string",
"values": [ "string" ]
},
"tags": {
"name": "string",
"operator": "string",
"values": [ "string" ]
}
}
],
"dimensions": {
"name": "string",
"operator": "string",
"values": [ "string" ]
},
"tags": {
"name": "string",
"operator": "string",
"values": [ "string" ]
}
},
"notifications": {
"{customized property}": {
"contactEmails": [ "string" ],
"contactGroups": [ "string" ],
"contactRoles": [ "string" ],
"enabled": "bool",
"locale": "string",
"operator": "string",
"threshold": "int",
"thresholdType": "string"
}
},
"timeGrain": "string",
"timePeriod": {
"endDate": "string",
"startDate": "string"
}
}
}
Valeurs de propriété
BudgetComparisonExpression
Nom | Description | Valeur |
---|---|---|
nom | Nom de la colonne à utiliser en comparaison. | chaîne (obligatoire) |
opérateur | Opérateur à utiliser pour la comparaison. | 'In' (obligatoire) |
Valeurs | Tableau de valeurs à utiliser pour la comparaison | string[] (obligatoire) |
BudgetFilter
Nom | Description | Valeur |
---|---|---|
et | Expression logique « AND ». Doit avoir au moins 2 éléments. | BudgetFilterProperties[] |
taille | A une expression de comparaison pour une dimension | BudgetComparisonExpression |
étiquettes | A une expression de comparaison pour une balise | BudgetComparisonExpression |
BudgetFilterProperties
Nom | Description | Valeur |
---|---|---|
taille | A une expression de comparaison pour une dimension | BudgetComparisonExpression |
étiquettes | A une expression de comparaison pour une balise | BudgetComparisonExpression |
BudgetProperties
Nom | Description | Valeur |
---|---|---|
quantité | Montant total du coût à suivre avec le budget | int (obligatoire) |
catégorie | Catégorie du budget, que le budget effectue le suivi du coût ou de l’utilisation. | 'Coût' (obligatoire) |
filtre | Peut être utilisé pour filtrer les budgets par dimensions et/ou balises spécifiées par l’utilisateur. | BudgetFilter |
Notifications | Dictionnaire de notifications associées au budget. Le budget peut avoir jusqu’à cinq notifications. | BudgetPropertiesNotifications |
timeGrain | Temps couvert par un budget. Le suivi de la quantité sera réinitialisé en fonction du grain de temps. BillingMonth, BillingQuarter et BillingAnnual ne sont pris en charge que par les clients WD | « Annuellement » 'BillingAnnual' 'BillingMonth' 'BillingQuarter' 'Mensuel' 'Quarterly' (obligatoire) |
timePeriod | A la date de début et de fin du budget. La date de début doit être la première du mois et doit être inférieure à la date de fin. La date de début du budget doit être le 1er juin 2017 ou le 1er juin 2017. La date de début future ne doit pas dépasser douze mois. La date de début passée doit être sélectionnée au cours de la période de temps. Il n’existe aucune restriction à la date de fin. | BudgetTimePeriod (obligatoire) |
BudgetPropertiesNotifications
Nom | Description | Valeur |
---|
BudgetTimePeriod
Nom | Description | Valeur |
---|---|---|
endDate | Date de fin du budget. S’il n’est pas fourni, nous définissons cette valeur par défaut sur 10 ans à partir de la date de début. | corde |
startDate | Date de début du budget. | chaîne (obligatoire) |
Microsoft.Consumption/budgets
Nom | Description | Valeur |
---|---|---|
apiVersion | Version de l’API | '2022-09-01' |
eTag | eTag de la ressource. Pour gérer le scénario de mise à jour simultanée, ce champ sera utilisé pour déterminer si l’utilisateur met à jour la dernière version ou non. | corde |
nom | Nom de la ressource | chaîne (obligatoire) |
Propriétés | Propriétés du budget. | BudgetProperties |
type | Type de ressource | 'Microsoft.Consumption/budgets' |
Notification
Nom | Description | Valeur |
---|---|---|
contactEmails | Adresses e-mail à laquelle envoyer la notification budgétaire lorsque le seuil est dépassé. Doit avoir au moins un e-mail de contact ou un groupe de contacts spécifié dans les étendues Abonnement ou Groupe de ressources. Toutes les autres étendues doivent avoir au moins un e-mail de contact spécifié. | string[] (obligatoire) |
contactGroups | Groupes d’actions auxquels envoyer la notification budgétaire lorsque le seuil est dépassé. Doit être fourni en tant qu’ID de ressource Azure complet. Uniquement pris en charge dans les étendues d’abonnement ou de groupe de ressources. | string[] |
contactRoles | Contactez les rôles pour envoyer la notification budgétaire au moment où le seuil est dépassé. | string[] |
Activé | La notification est activée ou non. | bool (obligatoire) |
paramètres régionaux | Langue dans laquelle le destinataire recevra la notification | 'cs-cz' 'da-dk' 'de-de' 'en-gb' 'en-us' 'es-es' 'fr-fr' 'hu-hu' 'it-it' 'ja-jp' 'ko-kr' 'nb-no' 'nl-nl' 'pl-pl' 'pt-br' 'pt-pt' 'ru-ru' 'sv-se' 'tr-tr' 'zh-cn' 'zh-tw' |
opérateur | Opérateur de comparaison. | 'EqualTo' 'GreaterThan' 'GreaterThanOrEqualTo' (obligatoire) |
seuil | Valeur de seuil associée à une notification. La notification est envoyée lorsque le coût a dépassé le seuil. Il est toujours pourcentage et doit être compris entre 0 et 1000. | int (obligatoire) |
thresholdType | Type de seuil | 'Réel' 'Prévu' |
Modèles de démarrage rapide
Les modèles de démarrage rapide suivants déploient ce type de ressource.
Modèle | Description |
---|---|
créer un budgétaire |
Ce modèle montre comment créer un budget sous un abonnement. |
Créer un budget avec de filtre |
Ce modèle montre comment créer un budget sous un abonnement. |
créer un budget simple |
Ce modèle montre comment créer un budget sous un abonnement. |
Définition de ressource Terraform (fournisseur AzAPI)
Le type de ressource budgets peut être déployé avec des opérations qui ciblent :
Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.
Format de ressource
Pour créer une ressource Microsoft.Consumption/budgets, ajoutez la terraform suivante à votre modèle.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Consumption/budgets@2022-09-01"
name = "string"
parent_id = "string"
eTag = "string"
body = jsonencode({
properties = {
amount = int
category = "string"
filter = {
and = [
{
dimensions = {
name = "string"
operator = "string"
values = [
"string"
]
}
tags = {
name = "string"
operator = "string"
values = [
"string"
]
}
}
]
dimensions = {
name = "string"
operator = "string"
values = [
"string"
]
}
tags = {
name = "string"
operator = "string"
values = [
"string"
]
}
}
notifications = {
{customized property} = {
contactEmails = [
"string"
]
contactGroups = [
"string"
]
contactRoles = [
"string"
]
enabled = bool
locale = "string"
operator = "string"
threshold = int
thresholdType = "string"
}
}
timeGrain = "string"
timePeriod = {
endDate = "string"
startDate = "string"
}
}
})
}
Valeurs de propriété
BudgetComparisonExpression
Nom | Description | Valeur |
---|---|---|
nom | Nom de la colonne à utiliser en comparaison. | chaîne (obligatoire) |
opérateur | Opérateur à utiliser pour la comparaison. | 'In' (obligatoire) |
Valeurs | Tableau de valeurs à utiliser pour la comparaison | string[] (obligatoire) |
BudgetFilter
Nom | Description | Valeur |
---|---|---|
et | Expression logique « AND ». Doit avoir au moins 2 éléments. | BudgetFilterProperties[] |
taille | A une expression de comparaison pour une dimension | BudgetComparisonExpression |
étiquettes | A une expression de comparaison pour une balise | BudgetComparisonExpression |
BudgetFilterProperties
Nom | Description | Valeur |
---|---|---|
taille | A une expression de comparaison pour une dimension | BudgetComparisonExpression |
étiquettes | A une expression de comparaison pour une balise | BudgetComparisonExpression |
BudgetProperties
Nom | Description | Valeur |
---|---|---|
quantité | Montant total du coût à suivre avec le budget | int (obligatoire) |
catégorie | Catégorie du budget, que le budget effectue le suivi du coût ou de l’utilisation. | 'Coût' (obligatoire) |
filtre | Peut être utilisé pour filtrer les budgets par dimensions et/ou balises spécifiées par l’utilisateur. | BudgetFilter |
Notifications | Dictionnaire de notifications associées au budget. Le budget peut avoir jusqu’à cinq notifications. | BudgetPropertiesNotifications |
timeGrain | Temps couvert par un budget. Le suivi de la quantité sera réinitialisé en fonction du grain de temps. BillingMonth, BillingQuarter et BillingAnnual ne sont pris en charge que par les clients WD | « Annuellement » 'BillingAnnual' 'BillingMonth' 'BillingQuarter' 'Mensuel' 'Quarterly' (obligatoire) |
timePeriod | A la date de début et de fin du budget. La date de début doit être la première du mois et doit être inférieure à la date de fin. La date de début du budget doit être le 1er juin 2017 ou le 1er juin 2017. La date de début future ne doit pas dépasser douze mois. La date de début passée doit être sélectionnée au cours de la période de temps. Il n’existe aucune restriction à la date de fin. | BudgetTimePeriod (obligatoire) |
BudgetPropertiesNotifications
Nom | Description | Valeur |
---|
BudgetTimePeriod
Nom | Description | Valeur |
---|---|---|
endDate | Date de fin du budget. S’il n’est pas fourni, nous définissons cette valeur par défaut sur 10 ans à partir de la date de début. | corde |
startDate | Date de début du budget. | chaîne (obligatoire) |
Microsoft.Consumption/budgets
Nom | Description | Valeur |
---|---|---|
eTag | eTag de la ressource. Pour gérer le scénario de mise à jour simultanée, ce champ sera utilisé pour déterminer si l’utilisateur met à jour la dernière version ou non. | corde |
nom | Nom de la ressource | chaîne (obligatoire) |
parent_id | ID de la ressource à laquelle appliquer cette ressource d’extension. | chaîne (obligatoire) |
Propriétés | Propriétés du budget. | BudgetProperties |
type | Type de ressource | « Microsoft.Consumption/budgets@2022-09-01 » |
Notification
Nom | Description | Valeur |
---|---|---|
contactEmails | Adresses e-mail à laquelle envoyer la notification budgétaire lorsque le seuil est dépassé. Doit avoir au moins un e-mail de contact ou un groupe de contacts spécifié dans les étendues Abonnement ou Groupe de ressources. Toutes les autres étendues doivent avoir au moins un e-mail de contact spécifié. | string[] (obligatoire) |
contactGroups | Groupes d’actions auxquels envoyer la notification budgétaire lorsque le seuil est dépassé. Doit être fourni en tant qu’ID de ressource Azure complet. Uniquement pris en charge dans les étendues d’abonnement ou de groupe de ressources. | string[] |
contactRoles | Contactez les rôles pour envoyer la notification budgétaire au moment où le seuil est dépassé. | string[] |
Activé | La notification est activée ou non. | bool (obligatoire) |
paramètres régionaux | Langue dans laquelle le destinataire recevra la notification | 'cs-cz' 'da-dk' 'de-de' 'en-gb' 'en-us' 'es-es' 'fr-fr' 'hu-hu' 'it-it' 'ja-jp' 'ko-kr' 'nb-no' 'nl-nl' 'pl-pl' 'pt-br' 'pt-pt' 'ru-ru' 'sv-se' 'tr-tr' 'zh-cn' 'zh-tw' |
opérateur | Opérateur de comparaison. | 'EqualTo' 'GreaterThan' 'GreaterThanOrEqualTo' (obligatoire) |
seuil | Valeur de seuil associée à une notification. La notification est envoyée lorsque le coût a dépassé le seuil. Il est toujours pourcentage et doit être compris entre 0 et 1000. | int (obligatoire) |
thresholdType | Type de seuil | 'Réel' 'Prévu' |