Scheduled Actions - Create Or Update

Référence

Service:: Cost Management

Version d'API:: 2024-08-01

Créez ou mettez à jour une action planifiée privée.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
name	path	True	string	Nom de l’action planifiée.
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 requis 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é.
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 d’action planifiée.
properties.fileDestination		FileDestination	Format de destination des données d’affichage. Cela est facultatif.
properties.notificationEmail		string	Adresse e-mail du point de contact qui doit recevoir les demandes de désabonnement 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 « abonnements/{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}/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	D’ACCORD. La demande a réussi.
201 Created	ScheduledAction	Créé.
Other Status Codes	ErrorResponseWithNestedDetails	Réponse d’erreur décrivant pourquoi l’opération a échoué.

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

CreateOrUpdatePrivateScheduledAction

Exemple de requête

HTTP

PUT https://management.azure.com/providers/Microsoft.CostManagement/scheduledActions/monthlyCostByResource?api-version=2024-08-01


{
  "kind": "Email",
  "properties": {
    "displayName": "Monthly Cost By Resource",
    "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": "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",
    "notification": {
      "language": "fr",
      "regionalFormat": "fr",
      "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": "",
    "status": "Enabled",
    "viewId": "/providers/Microsoft.CostManagement/views/swaggerExample"
  }
}

Code d’état:: 200

{
  "id": "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": {
      "language": "fr",
      "regionalFormat": "fr",
      "to": [
        "user@gmail.com",
        "team@gmail.com"
      ],
      "subject": "Cost by resource this month"
    },
    "scope": "",
    "status": "Enabled",
    "schedule": {
      "frequency": "Monthly",
      "weeksOfMonth": [
        "First",
        "Third"
      ],
      "daysOfWeek": [
        "Monday"
      ],
      "hourOfDay": 10,
      "startDate": "2020-06-19T22:21:51.1287144Z",
      "endDate": "2021-06-19T22:21:51.1287144Z"
    },
    "viewId": "/providers/Microsoft.CostManagement/views/swaggerExample"
  }
}

Définitions

Nom	Description
createdByType	Type d’identité qui a créé la ressource.
DaysOfWeek	Jours de 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. Réponses d’erreur : 429 TooManyRequests : la requête 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 l’heure spécifiée dans l’en-tête « Retry-After ».
FileDestination	Destination des données d’affichage. Cela 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 d’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 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 pourquoi l’opération a échoué.

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.

Réponses d’erreur :

429 TooManyRequests : la requête 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 l’heure spécifiée dans l’en-tête « Retry-After ».

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

FileDestination

Destination des données d’affichage. Cela 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 mettre en forme les 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.