Budgets - Get

Référence

Service:: Consumption

API Version:: 2023-05-01

Obtient le budget de l’étendue par nom de budget.

GET https://management.azure.com/{scope}/providers/Microsoft.Consumption/budgets/{budgetName}?api-version=2023-05-01

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
budgetName	path	True	string	Nom du budget.
scope	path	True	string	Étendue associée aux opérations budgétaires. Cela inclut « /subscriptions/{subscriptionId}/ » pour l’étendue de l’abonnement, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' pour l’étendue resourceGroup, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' pour l’étendue du compte de facturation, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' pour l’étendue du service, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{ enrollmentAccountId}' pour l’étendue EnrollmentAccount, '/providers/Microsoft.Management/managementGroups/{managementGroupId}' pour l’étendue du groupe d’administration, '/providers/Microsoft.BillingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' pour l’étendue billingProfile, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' pour l’étendue invoiceSection.
api-version	query	True	string	Version de l’API à utiliser avec la demande cliente. La version actuelle est 01/03/2023.

Réponses

Nom	Type	Description
200 OK	Budget	OK. La demande a réussi.
Other Status Codes	ErrorResponse	Réponse d’erreur décrivant la raison de l’échec de l’opération.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nom	Description
user_impersonation	Emprunter l’identité de votre compte d’utilisateur

Exemples

Budget

Sample Request

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Consumption/budgets/TestBudget?api-version=2023-05-01

Sample Response

Status code:: 200

{
  "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Consumption/budgets/TestBudget",
  "name": "TestBudget",
  "type": "Microsoft.Consumption/budgets",
  "eTag": "\"1d34d012214157f\"",
  "properties": {
    "category": "Cost",
    "amount": 100.65,
    "timeGrain": "Monthly",
    "timePeriod": {
      "startDate": "2017-10-01T00:00:00Z",
      "endDate": "2018-10-31T00:00:00Z"
    },
    "filter": {
      "and": [
        {
          "dimensions": {
            "name": "ResourceId",
            "operator": "In",
            "values": [
              "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/MSVM2",
              "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/platformcloudplatformGeneric1"
            ]
          }
        },
        {
          "tags": {
            "name": "category",
            "operator": "In",
            "values": [
              "Dev",
              "Prod"
            ]
          }
        },
        {
          "tags": {
            "name": "department",
            "operator": "In",
            "values": [
              "engineering",
              "sales"
            ]
          }
        }
      ]
    },
    "currentSpend": {
      "amount": 80.89,
      "unit": "USD"
    },
    "notifications": {
      "Actual_GreaterThan_80_Percent": {
        "enabled": true,
        "operator": "GreaterThan",
        "threshold": 80,
        "contactEmails": [
          "johndoe@contoso.com",
          "janesmith@contoso.com"
        ],
        "contactRoles": [
          "Contributor",
          "Reader"
        ],
        "contactGroups": [
          "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/microsoft.insights/actionGroups/SampleActionGroup"
        ],
        "thresholdType": "Actual"
      }
    }
  }
}

Définitions

Nom	Description
Budget	Ressource budgétaire.
BudgetComparisonExpression	Expression de comparaison à utiliser dans les budgets.
BudgetFilter	Peut être utilisé pour filtrer les budgets par groupe de ressources, ressource ou compteur.
BudgetFilterProperties	Dimensions ou Balises par lesquelles filtrer un budget.
BudgetOperatorType	Opérateur à utiliser pour la comparaison.
BudgetTimePeriod	Date de début et de fin d’un budget.
CategoryType	Catégorie du budget, si le budget suit le coût ou l’utilisation.
CultureCode	Langue dans laquelle le destinataire recevra la notification
CurrentSpend	Montant actuel du coût qui fait l’objet d’un suivi pour un budget.
ErrorDetails	Détails de l’erreur.
ErrorResponse	La réponse d’erreur indique que le service n’est pas en mesure de traiter la requête entrante. La raison est fournie dans le message d’erreur. Quelques réponses d’erreur : 429 TooManyRequests - La demande est limitée. Réessayez après avoir attendu l’heure spécifiée dans l’en-tête « x-ms-ratelimit-microsoft.consumption-retry-after ». 503 ServiceUnavailable - Le service est temporairement indisponible. Réessayez après avoir attendu le temps spécifié dans l’en-tête « Retry-After ».
ForecastSpend	Coût prévu qui fait l’objet d’un suivi pour un budget.
Notification	Notification associée à un budget.
OperatorType	Opérateur de comparaison.
ThresholdType	Type de seuil
TimeGrainType	Temps couvert par un budget. Le suivi de la quantité sera réinitialisé en fonction du grain de temps. BillingMonth, BillingQuarter et BillingAnnual sont uniquement pris en charge par les clients WD

Budget

Ressource budgétaire.

Nom	Type	Description
eTag	string	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.
id	string	ID de ressource.
name	string	Nom de la ressource.
properties.amount	number	Montant total du coût à suivre avec le budget
properties.category	CategoryType	Catégorie du budget, si le budget suit le coût ou l’utilisation.
properties.currentSpend	CurrentSpend	Montant actuel du coût qui fait l’objet d’un suivi pour un budget.
properties.filter	BudgetFilter	Peut être utilisé pour filtrer les budgets par dimensions et/ou balises spécifiées par l’utilisateur.
properties.forecastSpend	ForecastSpend	Coût prévu qui fait l’objet d’un suivi pour un budget.
properties.notifications	<string, Notification>	Dictionnaire des notifications associées au budget. Budget peut comporter jusqu’à cinq notifications.
properties.timeGrain	TimeGrainType	Temps couvert par un budget. Le suivi de la quantité sera réinitialisé en fonction du grain de temps. BillingMonth, BillingQuarter et BillingAnnual sont uniquement pris en charge par les clients WD
properties.timePeriod	BudgetTimePeriod	A les dates de début et de fin du budget. La date de début doit être le premier 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 après cette date. La date de début future ne devrait pas dépasser douze mois. La date de début passée doit être sélectionnée dans la période timegrain. Il n’existe aucune restriction sur la date de fin.
type	string	Type de ressource.

BudgetComparisonExpression

Expression de comparaison à utiliser dans les budgets.

Nom	Type	Description
name	string	Nom de la colonne à utiliser en comparaison.
operator	BudgetOperatorType	Opérateur à utiliser pour la comparaison.
values	string[]	Tableau de valeurs à utiliser pour la comparaison

BudgetFilter

Peut être utilisé pour filtrer les budgets par groupe de ressources, ressource ou compteur.

Nom	Type	Description
and	BudgetFilterProperties[]	Expression logique « AND ». Doit avoir au moins 2 éléments.
dimensions	BudgetComparisonExpression	A l’expression de comparaison pour une dimension
tags	BudgetComparisonExpression	A l’expression de comparaison pour une balise

BudgetFilterProperties

Dimensions ou Balises par lesquelles filtrer un budget.

Nom	Type	Description
dimensions	BudgetComparisonExpression	A l’expression de comparaison pour une dimension
tags	BudgetComparisonExpression	A l’expression de comparaison pour une balise

BudgetOperatorType

Opérateur à utiliser pour la comparaison.

Nom	Type	Description
In	string

BudgetTimePeriod

Date de début et de fin d’un budget.

Nom	Type	Description
endDate	string	Date de fin du budget. S’il n’est pas fourni, nous avons par défaut la valeur 10 ans à compter de la date de début.
startDate	string	Date de début du budget.

CategoryType

Catégorie du budget, si le budget suit le coût ou l’utilisation.

Nom	Type	Description
Cost	string

CultureCode

Langue dans laquelle le destinataire recevra la notification

Nom	Type	Description
cs-cz	string
da-dk	string
de-de	string
en-gb	string
en-us	string
es-es	string
fr-fr	string
hu-hu	string
it-it	string
ja-jp	string
ko-kr	string
nb-no	string
nl-nl	string
pl-pl	string
pt-br	string
pt-pt	string
ru-ru	string
sv-se	string
tr-tr	string
zh-cn	string
zh-tw	string

CurrentSpend

Montant actuel du coût qui fait l’objet d’un suivi pour un budget.

Nom	Type	Description
amount	number	Montant total du coût suivi par le budget.
unit	string	Unité de mesure du montant budgétaire.

ErrorDetails

Détails de l’erreur.

Nom	Type	Description
code	string	Code d’erreur.
message	string	Message d’erreur indiquant la raison de l’échec de l’opération.

ErrorResponse

La réponse d’erreur indique que le service n’est pas en mesure de traiter la requête entrante. La raison est fournie dans le message d’erreur.

Quelques réponses d’erreur :

429 TooManyRequests - La demande est limitée. Réessayez après avoir attendu l’heure spécifiée dans l’en-tête « x-ms-ratelimit-microsoft.consumption-retry-after ».
503 ServiceUnavailable - Le service est temporairement indisponible. Réessayez après avoir attendu le temps spécifié dans l’en-tête « Retry-After ».

Nom	Type	Description
error	ErrorDetails	Détails de l’erreur.

ForecastSpend

Coût prévu qui fait l’objet d’un suivi pour un budget.

Nom	Type	Description
amount	number	Coût prévu pour la période totale suivie par le budget. Cette valeur est fournie uniquement si le budget contient un type d’alerte de prévision.
unit	string	Unité de mesure du montant budgétaire.

Notification

Notification associée à un budget.

Nom	Type	Valeur par défaut	Description
contactEmails	string[]		Email adresses à 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é.
contactGroups	string[]		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. Pris en charge uniquement dans les étendues Abonnement ou Groupe de ressources.
contactRoles	string[]		Contactez les rôles auxquels envoyer la notification budgétaire lorsque le seuil est dépassé.
enabled	boolean		La notification est activée ou non.
locale	CultureCode		Langue dans laquelle le destinataire recevra la notification
operator	OperatorType		Opérateur de comparaison.
threshold	number		Valeur de seuil associée à une notification. Une 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.
thresholdType	ThresholdType	Actual	Type de seuil

OperatorType

Opérateur de comparaison.

Nom	Type	Description
EqualTo	string	L’alerte est déclenchée si le coût évalué est identique à la valeur de seuil. Remarque : Il n’est pas recommandé d’utiliser cet OpérateurType, car il y a peu de chances que le coût soit exactement le même que la valeur de seuil, ce qui entraîne l’absence de votre alerte. Ce type d’opérateur sera déprécié à l’avenir.
GreaterThan	string	L’alerte est déclenchée si le coût évalué est supérieur à la valeur de seuil. Remarque : Il s’agit du type d’opérateur recommandé lors de la configuration de l’alerte budget.
GreaterThanOrEqualTo	string	L’alerte est déclenchée si le coût évalué est supérieur ou égal à la valeur de seuil.

ThresholdType

Type de seuil

Nom	Type	Description
Actual	string	Les alertes de budget des coûts réels informent lorsque le coût cumulé réel dépasse le budget alloué.
Forecasted	string	Les alertes de budget des coûts prévus fournissent une notification avancée indiquant que vos tendances de dépenses sont susceptibles de dépasser votre budget alloué, car elles s’appuient sur des prédictions de coûts prévues.

TimeGrainType

Temps couvert par un budget. Le suivi de la quantité sera réinitialisé en fonction du grain de temps. BillingMonth, BillingQuarter et BillingAnnual sont uniquement pris en charge par les clients WD

Nom	Type	Description
Annually	string
BillingAnnual	string
BillingMonth	string
BillingQuarter	string
Monthly	string
Quarterly	string

Budgets - Get

Paramètres URI

Réponses

Sécurité

azure_auth

Scopes

Exemples

Budget

Sample Request

Sample Response

Définitions

Budget

BudgetComparisonExpression

BudgetFilter

BudgetFilterProperties

BudgetOperatorType

BudgetTimePeriod

CategoryType

CultureCode

CurrentSpend

ErrorDetails

ErrorResponse

ForecastSpend

Notification

OperatorType

ThresholdType

TimeGrainType

Ressources supplémentaires