Partager via

Scheduled Actions - Create Or Update By Scope

  • Référence
Service:
Cost Management
Version d'API:
2023-11-01

Créez ou mettez à jour une action planifiée partagée dans l’étendue donnée.

PUT https://management.azure.com/{scope}/providers/Microsoft.CostManagement/scheduledActions/{name}?api-version=2023-11-01

Paramètres URI

Nom Dans Obligatoire Type Description
name
 path True

string

Nom de l’action planifiée.
scope
 path True

string

Étendue associée aux opérations d’action planifiées. 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.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' pour l’étendue BillingProfile, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' pour l’étendue InvoiceSection, 'providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}' pour l’étendue du compte de facturation externe et 'providers/Microsoft. CostManagement/externalSubscriptions/{externalSubscriptionName}' pour l’étendue de l’abonnement externe. Remarque : Les alertes d’insight sont uniquement disponibles sur l’étendue de l’abonnement.
api-version
 query True

string

Version de l’API à utiliser pour cette opération.

En-tête de la demande

Nom Obligatoire Type Description
If-Match

string

ETag de l’entité. Non obligatoire lors de la création d’une entité. Facultatif lors de la mise à jour d’une entité et peut être spécifié pour obtenir une concurrence optimiste.

Corps de la demande

Nom Obligatoire Type Description
properties.displayName True

string

Nom de l’action planifiée.
properties.notification True

NotificationProperties

Propriétés de notification basées sur le type d’action planifiée.
properties.schedule True

ScheduleProperties

Planification de l’action planifiée.
properties.status True

ScheduledActionStatus

État de l’action planifiée.
properties.viewId True

string

ViewId d’analyse des coûts utilisé pour l’action planifiée. Par exemple, « /providers/Microsoft.CostManagement/views/swaggerExample »
kind

ScheduledActionKind

Type de l’action planifiée.
properties.fileDestination

FileDestination

Format de destination des données d’affichage. Ce paramètre est facultatif.
properties.notificationEmail

string

Email adresse du point de contact qui doit recevoir les demandes de désinscription et les e-mails de notification.
properties.scope

string

Pour l’action planifiée privée (Créer ou Mettre à jour), l’étendue est vide.
Pour l’action planifiée partagée (Créer ou mettre à jour par étendue), l’étendue Cost Management peut être « 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.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' pour l’étendue BillingProfile, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' pour l’étendue InvoiceSection, '/providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}' pour Étendue ExternalBillingAccount et « /providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName} » pour l’étendue ExternalSubscription.

Réponses

Nom Type Description
200 OK

ScheduledAction

OK. La demande a réussi.
201 Created

ScheduledAction

Créé.
Other Status Codes

ErrorResponseWithNestedDetails

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
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

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

Exemples

CreateOrUpdateInsightAlertScheduledActionByScope
CreateOrUpdateScheduledActionByScope

CreateOrUpdateInsightAlertScheduledActionByScope

Exemple de requête

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/scheduledActions/dailyAnomalyByResource?api-version=2023-11-01


{
  "kind": "InsightAlert",
  "properties": {
    "displayName": "Daily anomaly by resource",
    "notification": {
      "to": [
        "user@gmail.com",
        "team@gmail.com"
      ],
      "subject": "Cost anomaly detected in the resource"
    },
    "schedule": {
      "frequency": "Daily",
      "startDate": "2020-06-19T22:21:51.1287144Z",
      "endDate": "2021-06-19T22:21:51.1287144Z"
    },
    "status": "Enabled",
    "viewId": "/providers/Microsoft.CostManagement/views/swaggerExample"
  }
}

Exemple de réponse

Code d’état:
201 
{
  "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/scheduledActions/dailyAnomalyByResource",
  "name": "dailyAnomalyByResource",
  "type": "Microsoft.CostManagement/ScheduledActions",
  "kind": "InsightAlert",
  "eTag": "\"1d4ff9fe66f1d10\"",
  "systemData": {
    "createdBy": "testuser",
    "createdByType": "User",
    "createdAt": "2020-06-18T22:21:51.1287144Z",
    "lastModifiedBy": "testuser",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2020-06-18T22:21:51.1287144Z"
  },
  "properties": {
    "displayName": "Daily anomaly by resource",
    "fileDestination": {
      "fileFormats": []
    },
    "notification": {
      "to": [
        "user@gmail.com",
        "team@gmail.com"
      ],
      "subject": "Cost anomaly detected in the resource"
    },
    "schedule": {
      "frequency": "Daily",
      "startDate": "2020-06-19T22:21:51.1287144Z",
      "endDate": "2021-06-19T22:21:51.1287144Z"
    },
    "scope": "subscriptions/00000000-0000-0000-0000-000000000000",
    "status": "Enabled",
    "viewId": "/providers/Microsoft.CostManagement/views/swaggerExample"
  }
}
Code d’état:
200 
{
  "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/scheduledActions/dailyAnomalyByResource",
  "name": "dailyAnomalyByResource",
  "type": "Microsoft.CostManagement/ScheduledActions",
  "kind": "InsightAlert",
  "eTag": "\"1d4ff9fe66f1d10\"",
  "systemData": {
    "createdBy": "testuser",
    "createdByType": "User",
    "createdAt": "2020-06-18T22:21:51.1287144Z",
    "lastModifiedBy": "testuser",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2020-06-19T22:21:51.1287144Z"
  },
  "properties": {
    "displayName": "Daily anomaly by resource",
    "fileDestination": {
      "fileFormats": []
    },
    "notification": {
      "to": [
        "user@gmail.com",
        "team@gmail.com"
      ],
      "subject": "Cost anomaly detected in the resource"
    },
    "scope": "subscriptions/00000000-0000-0000-0000-000000000000",
    "schedule": {
      "frequency": "Daily",
      "startDate": "2020-06-19T22:21:51.1287144Z",
      "endDate": "2021-06-19T22:21:51.1287144Z"
    },
    "status": "Enabled",
    "viewId": "/providers/Microsoft.CostManagement/views/swaggerExample"
  }
}

CreateOrUpdateScheduledActionByScope

Exemple de requête

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/scheduledActions/monthlyCostByResource?api-version=2023-11-01


{
  "kind": "Email",
  "properties": {
    "displayName": "Monthly Cost By Resource",
    "fileDestination": {
      "fileFormats": [
        "Csv"
      ]
    },
    "notification": {
      "to": [
        "user@gmail.com",
        "team@gmail.com"
      ],
      "subject": "Cost by resource this month"
    },
    "schedule": {
      "frequency": "Monthly",
      "weeksOfMonth": [
        "First",
        "Third"
      ],
      "daysOfWeek": [
        "Monday"
      ],
      "hourOfDay": 10,
      "startDate": "2020-06-19T22:21:51.1287144Z",
      "endDate": "2021-06-19T22:21:51.1287144Z"
    },
    "status": "Enabled",
    "viewId": "/providers/Microsoft.CostManagement/views/swaggerExample"
  }
}

Exemple de réponse

Code d’état:
201 
{
  "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/scheduledActions/monthlyCostByResource",
  "name": "monthlyCostByResource",
  "type": "Microsoft.CostManagement/ScheduledActions",
  "kind": "Email",
  "eTag": "\"1d4ff9fe66f1d10\"",
  "systemData": {
    "createdBy": "testuser",
    "createdByType": "User",
    "createdAt": "2020-06-18T22:21:51.1287144Z",
    "lastModifiedBy": "testuser",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2020-06-18T22:21:51.1287144Z"
  },
  "properties": {
    "displayName": "Monthly Cost By Resource",
    "fileDestination": {
      "fileFormats": [
        "Csv"
      ]
    },
    "notification": {
      "to": [
        "user@gmail.com",
        "team@gmail.com"
      ],
      "subject": "Cost by resource this month"
    },
    "schedule": {
      "frequency": "Monthly",
      "weeksOfMonth": [
        "First",
        "Third"
      ],
      "daysOfWeek": [
        "Monday"
      ],
      "hourOfDay": 10,
      "startDate": "2020-06-19T22:21:51.1287144Z",
      "endDate": "2021-06-19T22:21:51.1287144Z"
    },
    "scope": "subscriptions/00000000-0000-0000-0000-000000000000",
    "status": "Enabled",
    "viewId": "/providers/Microsoft.CostManagement/views/swaggerExample"
  }
}
Code d’état:
200 
{
  "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/scheduledActions/monthlyCostByResource",
  "name": "monthlyCostByResource",
  "type": "Microsoft.CostManagement/ScheduledActions",
  "kind": "Email",
  "eTag": "\"1d4ff9fe66f1d10\"",
  "systemData": {
    "createdBy": "testuser",
    "createdByType": "User",
    "createdAt": "2020-06-18T22:21:51.1287144Z",
    "lastModifiedBy": "testuser",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2020-06-19T22:21:51.1287144Z"
  },
  "properties": {
    "displayName": "Monthly Cost By Resource",
    "notification": {
      "to": [
        "user@gmail.com",
        "team@gmail.com"
      ],
      "subject": "Cost by resource this month"
    },
    "scope": "subscriptions/00000000-0000-0000-0000-000000000000",
    "schedule": {
      "frequency": "Monthly",
      "weeksOfMonth": [
        "First",
        "Third"
      ],
      "daysOfWeek": [
        "Monday"
      ],
      "hourOfDay": 10,
      "startDate": "2020-06-19T22:21:51.1287144Z",
      "endDate": "2021-06-19T22:21:51.1287144Z"
    },
    "status": "Enabled",
    "viewId": "/providers/Microsoft.CostManagement/views/swaggerExample"
  }
}

Définitions

Nom Description
createdByType

Type d’identité qui a créé la ressource.
DaysOfWeek

Jours de la semaine.
ErrorDetailsWithNestedDetails

Détails de l’erreur.
ErrorResponseWithNestedDetails

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 ».
FileDestination

Destination des données d’affichage. Ce paramètre est facultatif. Actuellement, seul le format CSV est pris en charge.
FileFormat

Destination des données d’affichage. Actuellement, seul le format CSV est pris en charge.
NotificationProperties

Propriétés de la notification d’action planifiée.
ScheduledAction

Définition d’action planifiée.
ScheduledActionKind

Type de l’action planifiée.
ScheduledActionStatus

État de l’action planifiée.
ScheduleFrequency

Fréquence de la planification.
ScheduleProperties

Propriétés de la planification.
systemData

Métadonnées relatives à la création et à la dernière modification de la ressource.
WeeksOfMonth

Semaines du mois.

createdByType

Type d’identité qui a créé la ressource.

Nom Type Description
Application

string

Key

string

ManagedIdentity

string

User

string

DaysOfWeek

Jours de la semaine.

Nom Type Description
Friday

string

Monday

string

Saturday

string

Sunday

string

Thursday

string

Tuesday

string

Wednesday

string

ErrorDetailsWithNestedDetails

Détails de l’erreur.

Nom Type Description
code

string

Code d’erreur.
details

ErrorDetailsWithNestedDetails[]

Détails supplémentaires de l’erreur.
message

string

Message d’erreur indiquant la raison de l’échec de l’opération.

ErrorResponseWithNestedDetails

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

ErrorDetailsWithNestedDetails

Détails de l’erreur.

FileDestination

Destination des données d’affichage. Ce paramètre est facultatif. Actuellement, seul le format CSV est pris en charge.

Nom Type Description
fileFormats

FileFormat[]

Destination des données d’affichage. Actuellement, seul le format CSV est pris en charge.

FileFormat

Destination des données d’affichage. Actuellement, seul le format CSV est pris en charge.

Nom Type Description
Csv

string

NotificationProperties

Propriétés de la notification d’action planifiée.

Nom Type Description
language

string

Paramètres régionaux de l’e-mail.
message

string

Message facultatif à ajouter dans l’e-mail. La longueur est limitée à 250 caractères.
regionalFormat

string

Format régional utilisé pour la mise en forme des valeurs de date/heure et de devise dans l’e-mail.
subject

string

Objet de l’e-mail. La longueur est limitée à 70 caractères.
to

string[]

Tableau d’adresses e-mail.

ScheduledAction

Définition d’action planifiée.

Nom Type Description
eTag

string

Etag de ressources. Pour les appels de mise à jour, eTag est facultatif et peut être spécifié pour obtenir une concurrence optimiste. Récupérez l’eTag de la ressource en effectuant d’abord un appel « GET », puis en incluant le dernier eTag dans le corps de la demande ou l’en-tête « If-Match » lors de l’exécution de la mise à jour. Pour créer des appels, eTag n’est pas obligatoire.
id

string

ID de ressource complet pour la ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
kind

ScheduledActionKind

Type de l’action planifiée.
name

string

nom de la ressource.
properties.displayName

string

Nom de l’action planifiée.
properties.fileDestination

FileDestination

Format de destination des données d’affichage. Ce paramètre est facultatif.
properties.notification

NotificationProperties

Propriétés de notification basées sur le type d’action planifiée.
properties.notificationEmail

string

Email adresse du point de contact qui doit recevoir les demandes de désinscription et les e-mails de notification.
properties.schedule

ScheduleProperties

Planification de l’action planifiée.
properties.scope

string

Pour l’action planifiée privée (Créer ou Mettre à jour), l’étendue est vide.
Pour l’action planifiée partagée (Créer ou mettre à jour par étendue), l’étendue Cost Management peut être « 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.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' pour l’étendue BillingProfile, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' pour l’étendue InvoiceSection, '/providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}' pour Étendue ExternalBillingAccount et « /providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName} » pour l’étendue ExternalSubscription.
properties.status

ScheduledActionStatus

État de l’action planifiée.
properties.viewId

string

ViewId d’analyse des coûts utilisé pour l’action planifiée. Par exemple, « /providers/Microsoft.CostManagement/views/swaggerExample »
systemData

systemData

Type de l’action planifiée.
type

string

Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

ScheduledActionKind

Type de l’action planifiée.

Nom Type Description
Email

string

Les données d’analyse des coûts seront envoyées par e-mail.
InsightAlert

string

Les informations sur l’anomalie de coût seront envoyées par e-mail. Disponible uniquement sur l’étendue de l’abonnement à la fréquence quotidienne. Si aucune anomalie n’est détectée sur la ressource, aucun e-mail n’est envoyé.

ScheduledActionStatus

État de l’action planifiée.

Nom Type Description
Disabled

string

L’action planifiée est enregistrée, mais ne sera pas exécutée.
Enabled

string

L’action planifiée est enregistrée et sera exécutée.
Expired

string

L’action planifiée a expiré.

ScheduleFrequency

Fréquence de la planification.

Nom Type Description
Daily

string

Les données d’analyse des coûts seront envoyées par e-mail chaque jour.
Monthly

string

Les données d’analyse des coûts seront envoyées par e-mail chaque mois.
Weekly

string

Les données d’analyse des coûts seront envoyées par e-mail chaque semaine.

ScheduleProperties

Propriétés de la planification.

Nom Type Description
dayOfMonth

integer

Jour UTC auquel les données d’analyse des coûts seront envoyées par e-mail. Doit être compris entre 1 et 31. Cette propriété s’applique lorsque la fréquence est Mensuelle et remplace weeksOfMonth ou daysOfWeek.
daysOfWeek

DaysOfWeek[]

Noms des jours en anglais sur lesquels les données d’analyse des coûts seront envoyées par e-mail. Cette propriété s’applique lorsque la fréquence est Hebdomadaire ou Mensuelle.
endDate

string

Date et heure de fin de l’action planifiée (UTC).
frequency

ScheduleFrequency

Fréquence de la planification.
hourOfDay

integer

Heure UTC à laquelle les données d’analyse des coûts seront envoyées par e-mail.
startDate

string

Date et heure de début de l’action planifiée (UTC).
weeksOfMonth

WeeksOfMonth[]

Semaines au cours desquelles les données d’analyse des coûts seront envoyées par e-mail. Cette propriété s’applique lorsque la fréquence est Mensuelle et utilisée en combinaison avec daysOfWeek.

systemData

Métadonnées relatives à la création et à la dernière modification de la ressource.

Nom Type Description
createdAt

string

Horodatage de la création de ressources (UTC).
createdBy

string

Identité qui a créé la ressource.
createdByType

createdByType

Type d’identité qui a créé la ressource.
lastModifiedAt

string

Horodatage de la dernière modification de la ressource (UTC)
lastModifiedBy

string

Identité qui a modifié la dernière ressource.
lastModifiedByType

createdByType

Type d’identité qui a modifié la dernière ressource.

WeeksOfMonth

Semaines du mois.

Nom Type Description
First

string

Fourth

string

Last

string

Second

string

Third

string