Condividi tramite

Scheduled Actions - Create Or Update By Scope

  • Riferimento
Servizio:
Cost Management
Versione API:
2024-08-01

Creare o aggiornare un'azione pianificata condivisa all'interno dell'ambito specificato.

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

Parametri dell'URI

Nome In Necessario Tipo Descrizione
name
 path True

string

Nome dell'azione pianificata.
scope
 path True

string

Ambito associato alle operazioni di azione pianificate. Sono inclusi 'subscriptions/{subscriptionId}' per l'ambito della sottoscrizione, 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' per ambito resourceGroup, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}' per ambito account di fatturazione, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' per ambito reparto, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{ enrollmentAccountId}' per l'ambito EnrollmentAccount, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' per ambito BillingProfile, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' per ambito InvoiceSection, 'providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}' per l'ambito dell'account di fatturazione esterno e 'providers/Microsoft. CostManagement/externalSubscriptions/{externalSubscriptionName}' per l'ambito della sottoscrizione esterna. Nota: gli avvisi di informazioni dettagliate sono disponibili solo nell'ambito della sottoscrizione.
api-version
 query True

string

minLength: 1

Versione dell'API da usare per questa operazione.

Intestazione della richiesta

Nome Necessario Tipo Descrizione
If-Match

string

ETag dell'entità. Non obbligatorio durante la creazione di un'entità. Facoltativo durante l'aggiornamento di un'entità e può essere specificato per ottenere la concorrenza ottimistica.

Corpo della richiesta

Nome Necessario Tipo Descrizione
properties.displayName True

string

Nome dell'azione pianificata.
properties.notification True

NotificationProperties

Proprietà di notifica basate sul tipo di azione pianificato.
properties.schedule True

ScheduleProperties

Pianificazione dell'azione pianificata.
properties.status True

ScheduledActionStatus

Stato dell'azione pianificata.
properties.viewId True

string

ViewId dell'analisi dei costi usato per l'azione pianificata. Ad esempio, '/providers/Microsoft.CostManagement/views/swaggerExample'
kind

ScheduledActionKind

Tipo di azione pianificata.
properties.fileDestination

FileDestination

Formato di destinazione dei dati della visualizzazione. Questa opzione è facoltativa.
properties.notificationEmail

string

Indirizzo di posta elettronica del punto di contatto che deve ricevere le richieste di annullamento della sottoscrizione e i messaggi di posta elettronica di notifica.
properties.scope

string

Per l'azione pianificata privata (Crea o Aggiorna), l'ambito sarà vuoto.
Per un'azione pianificata condivisa(Crea o Aggiorna per ambito), l'ambito di Gestione costi può essere 'subscriptions/{subscriptionId}' per l'ambito della sottoscrizione, 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' per ambito resourceGroup, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}' per ambito account di fatturazione, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' per ambito reparto, 'providers/Microsoft. Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' per ambito BillingProfile, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' per l'ambito InvoiceSection, '/providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}' per Ambito ExternalBillingAccount e '/providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}' per l'ambito ExternalSubscription.

Risposte

Nome Tipo Descrizione
200 OK

ScheduledAction

OK. La richiesta ha avuto esito positivo.
201 Created

ScheduledAction

Creato.
Other Status Codes

ErrorResponseWithNestedDetails

Risposta di errore che descrive il motivo per cui l'operazione non è riuscita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome Descrizione
user_impersonation rappresentare l'account utente

Esempio

CreateOrUpdateInsightAlertScheduledActionByScope
CreateOrUpdateScheduledActionByScope

CreateOrUpdateInsightAlertScheduledActionByScope

Esempio di richiesta

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/scheduledActions/dailyAnomalyByResource?api-version=2024-08-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"
  }
}

Risposta di esempio

Codice di stato:
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"
  }
}
Codice di stato:
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

Esempio di richiesta

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/scheduledActions/monthlyCostByResource?api-version=2024-08-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"
  }
}

Risposta di esempio

Codice di stato:
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"
  }
}
Codice di stato:
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"
  }
}

Definizioni

Nome Descrizione
createdByType

Tipo di identità che ha creato la risorsa.
DaysOfWeek

Giorni della settimana.
ErrorDetailsWithNestedDetails

Dettagli dell'errore.
ErrorResponseWithNestedDetails

La risposta di errore indica che il servizio non è in grado di elaborare la richiesta in ingresso. Il motivo viene fornito nel messaggio di errore.

Alcune risposte di errore:

  • 429 TooManyRequests - La richiesta è limitata. Riprovare dopo aver aspettato il tempo specificato nell'intestazione "x-ms-ratelimit-microsoft.consumption-retry-after".

  • 503 ServiceUnavailable - Il servizio non è temporaneamente disponibile. Riprovare dopo aver aspettato il tempo specificato nell'intestazione "Retry-After".
FileDestination

Destinazione dei dati della visualizzazione. Questa opzione è facoltativa. Attualmente è supportato solo il formato CSV.
FileFormat

Destinazione dei dati della visualizzazione. Attualmente è supportato solo il formato CSV.
NotificationProperties

Proprietà della notifica dell'azione pianificata.
ScheduledAction

Definizione di azione pianificata.
ScheduledActionKind

Tipo di azione pianificata.
ScheduledActionStatus

Stato dell'azione pianificata.
ScheduleFrequency

Frequenza della pianificazione.
ScheduleProperties

Proprietà della pianificazione.
systemData

Metadati relativi alla creazione e all'ultima modifica della risorsa.
WeeksOfMonth

Settimane del mese.

createdByType

Enumerazione

Tipo di identità che ha creato la risorsa.

Valore Descrizione
Application
Key
ManagedIdentity
User

DaysOfWeek

Enumerazione

Giorni della settimana.

Valore Descrizione
Friday
Monday
Saturday
Sunday
Thursday
Tuesday
Wednesday

ErrorDetailsWithNestedDetails

Object

Dettagli dell'errore.

Nome Tipo Descrizione
code

string

Codice di errore.
details

ErrorDetailsWithNestedDetails[]

Dettagli aggiuntivi dell'errore.
message

string

Messaggio di errore che indica il motivo per cui l'operazione non è riuscita.

ErrorResponseWithNestedDetails

Object

La risposta di errore indica che il servizio non è in grado di elaborare la richiesta in ingresso. Il motivo viene fornito nel messaggio di errore.

Alcune risposte di errore:

  • 429 TooManyRequests - La richiesta è limitata. Riprovare dopo aver aspettato il tempo specificato nell'intestazione "x-ms-ratelimit-microsoft.consumption-retry-after".

  • 503 ServiceUnavailable - Il servizio non è temporaneamente disponibile. Riprovare dopo aver aspettato il tempo specificato nell'intestazione "Retry-After".

Nome Tipo Descrizione
error

ErrorDetailsWithNestedDetails

Dettagli dell'errore.

FileDestination

Object

Destinazione dei dati della visualizzazione. Questa opzione è facoltativa. Attualmente è supportato solo il formato CSV.

Nome Tipo Descrizione
fileFormats

FileFormat[]

Destinazione dei dati della visualizzazione. Attualmente è supportato solo il formato CSV.

FileFormat

Enumerazione

Destinazione dei dati della visualizzazione. Attualmente è supportato solo il formato CSV.

Valore Descrizione
Csv

NotificationProperties

Object

Proprietà della notifica dell'azione pianificata.

Nome Tipo Descrizione
language

string

Impostazioni locali del messaggio di posta elettronica.
message

string

Messaggio facoltativo da aggiungere nel messaggio di posta elettronica. La lunghezza è limitata a 250 caratteri.
regionalFormat

string

Formato a livello di area usato per la formattazione dei valori di data/ora e valuta nel messaggio di posta elettronica.
subject

string

Oggetto del messaggio di posta elettronica. La lunghezza è limitata a 70 caratteri.
to

string[]

pattern: ^[A-Za-z0-9._%+-]+@(?:[A-Za-z0-9-]+\.)+[A-Za-z]{2,}$

Matrice di indirizzi di posta elettronica.

ScheduledAction

Object

Definizione di azione pianificata.

Nome Tipo Descrizione
eTag

string

Etag risorsa. Per le chiamate di aggiornamento, eTag è facoltativo e può essere specificato per ottenere la concorrenza ottimistica. Recuperare prima l'eTag della risorsa eseguendo una chiamata "GET" e quindi includendo l'eTag più recente come parte del corpo della richiesta o dell'intestazione "If-Match" durante l'esecuzione dell'aggiornamento. Per le chiamate create, eTag non è obbligatorio.
id

string

ID risorsa completo per la risorsa. Ad esempio - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
kind

ScheduledActionKind

Tipo di azione pianificata.
name

string

Nome della risorsa
properties.displayName

string

Nome dell'azione pianificata.
properties.fileDestination

FileDestination

Formato di destinazione dei dati della visualizzazione. Questa opzione è facoltativa.
properties.notification

NotificationProperties

Proprietà di notifica basate sul tipo di azione pianificato.
properties.notificationEmail

string

Indirizzo di posta elettronica del punto di contatto che deve ricevere le richieste di annullamento della sottoscrizione e i messaggi di posta elettronica di notifica.
properties.schedule

ScheduleProperties

Pianificazione dell'azione pianificata.
properties.scope

string

Per l'azione pianificata privata (Crea o Aggiorna), l'ambito sarà vuoto.
Per un'azione pianificata condivisa(Crea o Aggiorna per ambito), l'ambito di Gestione costi può essere 'subscriptions/{subscriptionId}' per l'ambito della sottoscrizione, 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' per ambito resourceGroup, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}' per ambito account di fatturazione, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' per ambito reparto, 'providers/Microsoft. Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' per ambito BillingProfile, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' per l'ambito InvoiceSection, '/providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}' per Ambito ExternalBillingAccount e '/providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}' per l'ambito ExternalSubscription.
properties.status

ScheduledActionStatus

Stato dell'azione pianificata.
properties.viewId

string

ViewId dell'analisi dei costi usato per l'azione pianificata. Ad esempio, '/providers/Microsoft.CostManagement/views/swaggerExample'
systemData

systemData

Tipo di azione pianificata.
type

string

Tipo della risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

ScheduledActionKind

Enumerazione

Tipo di azione pianificata.

Valore Descrizione
Email

I dati di analisi dei costi verranno e-mail.
InsightAlert

Le informazioni sulle anomalie dei costi verranno inviate tramite posta elettronica. Disponibile solo nell'ambito della sottoscrizione con frequenza giornaliera. Se non viene rilevata alcuna anomalia nella risorsa, non verrà inviato alcun messaggio di posta elettronica.

ScheduledActionStatus

Enumerazione

Stato dell'azione pianificata.

Valore Descrizione
Disabled

L'azione pianificata viene salvata ma non verrà eseguita.
Enabled

L'azione pianificata viene salvata e verrà eseguita.
Expired

L'azione pianificata è scaduta.

ScheduleFrequency

Enumerazione

Frequenza della pianificazione.

Valore Descrizione
Daily

I dati di analisi dei costi verranno e-mail ogni giorno.
Monthly

I dati di analisi dei costi verranno inviate tramite posta elettronica ogni mese.
Weekly

I dati di analisi dei costi verranno inviate tramite posta elettronica ogni settimana.

ScheduleProperties

Object

Proprietà della pianificazione.

Nome Tipo Descrizione
dayOfMonth

integer (int32)

Giorno UTC in cui i dati di analisi dei costi verranno visualizzati tramite posta elettronica. Deve essere compreso tra 1 e 31. Questa proprietà è applicabile quando frequency è Monthly ed esegue l'override di weeksOfMonth o daysOfWeek.
daysOfWeek

DaysOfWeek[]

Nomi dei giorni in inglese in cui verranno visualizzati i dati di analisi dei costi. Questa proprietà è applicabile quando la frequenza è Settimanale o Mensile.
endDate

string (date-time)

Data e ora di fine dell'azione pianificata (UTC).
frequency

ScheduleFrequency

Frequenza della pianificazione.
hourOfDay

integer (int32)

Ora UTC in cui i dati di analisi dei costi verranno inviate tramite posta elettronica.
startDate

string (date-time)

Data e ora di inizio dell'azione pianificata (UTC).
weeksOfMonth

WeeksOfMonth[]

Settimane in cui i dati di analisi dei costi verranno inviate tramite posta elettronica. Questa proprietà è applicabile quando la frequenza è Mensile e utilizzata in combinazione con daysOfWeek.

systemData

Object

Metadati relativi alla creazione e all'ultima modifica della risorsa.

Nome Tipo Descrizione
createdAt

string (date-time)

Timestamp della creazione della risorsa (UTC).
createdBy

string

Identità che ha creato la risorsa.
createdByType

createdByType

Tipo di identità che ha creato la risorsa.
lastModifiedAt

string (date-time)

Timestamp dell'ultima modifica della risorsa (UTC)
lastModifiedBy

string

Identità che ha modificato l'ultima volta la risorsa.
lastModifiedByType

createdByType

Tipo di identità che ha modificato l'ultima volta la risorsa.

WeeksOfMonth

Enumerazione

Settimane del mese.

Valore Descrizione
First
Fourth
Last
Second
Third