Scheduled Actions - Get By Scope

Service:: Cost Management

Version de l’API:: 2025-03-01

Obtenez l’action planifiée partagée à partir de l’étendue donnée par nom.

GET https://management.azure.com/{scope}/providers/Microsoft.CostManagement/scheduledActions/{name}?api-version=2025-03-01

Paramètres d’URI

Nom	Dans	Obligatoire	Type	Description
name	path	True	string	Nom de l’action planifiée.
scope	path	True	string	non défini
api-version	query	True	string minLength: 1	Version de l’API à utiliser pour cette opération.

Réponses

Nom	Type	Description
200 OK	ScheduledAction	L’opération Azure s’est terminée avec succès.
Other Status Codes	ErrorResponseWithNestedDetails	Réponse d’erreur inattendue.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory.

Type: oauth2
Couler: 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

ScheduledActionByScope

Demande d’échantillon

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/scheduledActions/monthlyCostByResource?api-version=2025-03-01

Exemple de réponse

Code d’état:: 200

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

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

Énumération

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

Valeur	Description
User
Application
ManagedIdentity
Key

DaysOfWeek

Énumération

Jours de semaine.

Valeur	Description
Monday
Tuesday
Wednesday
Thursday
Friday
Saturday
Sunday

ErrorDetailsWithNestedDetails

Objet

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

Objet

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

Objet

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

Énumération

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

Valeur	Description
Csv

NotificationProperties

Objet

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'email. La longueur est limitée à 70 caractères.
to	string[]	Tableau d’adresses e-mail.