Scheduled Actions - Create Or Update By Scope

  • Referencia
Service:
Cost Management
API Version:
2023-11-01

Cree o actualice una acción programada compartida dentro del ámbito especificado.

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

Parámetros de identificador URI

Nombre En Requerido Tipo Description
name
 path True

string

Nombre de la acción programada.
scope
 path True

string

Ámbito asociado a las operaciones de acción programadas. Esto incluye "subscriptions/{subscriptionId}" para el ámbito de la suscripción, 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' para el ámbito resourceGroup, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}' para el ámbito de la cuenta de facturación, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' para el ámbito department, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{ enrollmentAccountId}' para el ámbito EnrollmentAccount, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' para el ámbito BillingProfile, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' para el ámbito invoiceSection, 'providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}' para el ámbito de la cuenta de facturación externa y 'providers/Microsoft. CostManagement/externalSubscriptions/{externalSubscriptionName}' para el ámbito de la suscripción externa. Nota: Las alertas de información solo están disponibles en el ámbito de la suscripción.
api-version
 query True

string

Versión de API que se usará para la operación.

Encabezado de la solicitud

Nombre Requerido Tipo Description
If-Match

string

ETag de la entidad. No es necesario al crear una entidad. Opcional al actualizar una entidad y se puede especificar para lograr la simultaneidad optimista.

Cuerpo de la solicitud

Nombre Requerido Tipo Description
properties.displayName True

string

Nombre de la acción programada.
properties.notification True

NotificationProperties

Propiedades de notificación basadas en el tipo de acción programada.
properties.schedule True

ScheduleProperties

Programación de la acción programada.
properties.status True

ScheduledActionStatus

Estado de la acción programada.
properties.viewId True

string

ViewId de análisis de costos usado para la acción programada. Por ejemplo, "/providers/Microsoft.CostManagement/views/swaggerExample"
kind

ScheduledActionKind

Tipo de acción programada.
properties.fileDestination

FileDestination

Formato de destino de los datos de vista. Esto es opcional.
properties.notificationEmail

string

Email dirección del punto de contacto que debe obtener las solicitudes de cancelación de suscripción y los correos electrónicos de notificación.
properties.scope

string

En el caso de la acción programada privada (Crear o actualizar), el ámbito estará vacío.
Para acciones programadas compartidas (Crear o actualizar por ámbito), el ámbito de Cost Management puede ser "subscriptions/{subscriptionId}" para el ámbito de la suscripción, "subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}" para el ámbito de resourceGroup, "providers/Microsoft.Billing/billingAccountId}" para el ámbito de la cuenta de facturación, "providers/Microsoft.Billing/billingAccounts/{billingAccountId}" para el ámbito del departamento, "providers/Microsoft. Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' para el ámbito EnrollmentAccount, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' para el ámbito BillingProfile, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' para el ámbito InvoiceSection, '/providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}' para Ámbito ExternalBillingAccount y "/providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}" para el ámbito ExternalSubscription.

Respuestas

Nombre Tipo Description
200 OK

ScheduledAction

Aceptar. La solicitud se ha realizado correctamente.
201 Created

ScheduledAction

Creado.
Other Status Codes

ErrorResponseWithNestedDetails

Respuesta de error que describe el motivo del error de la operación.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory.

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

Scopes

Nombre Description
user_impersonation suplantación de su cuenta de usuario

Ejemplos

CreateOrUpdateInsightAlertScheduledActionByScope
CreateOrUpdateScheduledActionByScope

CreateOrUpdateInsightAlertScheduledActionByScope

Sample Request

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"
  }
}

Sample Response

Status code:
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"
  }
}
Status code:
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

Sample Request

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"
  }
}

Sample Response

Status code:
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"
  }
}
Status code:
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"
  }
}

Definiciones

Nombre Description
createdByType

Tipo de identidad que creó el recurso.
DaysOfWeek

Días de la semana.
ErrorDetailsWithNestedDetails

Detalles del error.
ErrorResponseWithNestedDetails

La respuesta de error indica que el servicio no puede procesar la solicitud entrante. El motivo se proporciona en el mensaje de error.

Algunas respuestas de error:

  • 429 TooManyRequests: la solicitud está limitada. Vuelva a intentarlo después de esperar el tiempo especificado en el encabezado "x-ms-ratelimit-microsoft.consumption-retry-after".

  • 503 ServiceUnavailable: el servicio no está disponible temporalmente. Vuelva a intentarlo después de esperar el tiempo especificado en el encabezado "Vuelva a intentarlo después de".
FileDestination

Destino de los datos de vista. Esto es opcional. Actualmente solo se admite el formato CSV.
FileFormat

Destino de los datos de vista. Actualmente solo se admite el formato CSV.
NotificationProperties

Propiedades de la notificación de acción programada.
ScheduledAction

Definición de acción programada.
ScheduledActionKind

Tipo de acción programada.
ScheduledActionStatus

Estado de la acción programada.
ScheduleFrequency

Frecuencia de la programación.
ScheduleProperties

Propiedades de la programación.
systemData

Metadatos relacionados con la creación y la última modificación del recurso.
WeeksOfMonth

Semanas del mes.

createdByType

Tipo de identidad que creó el recurso.

Nombre Tipo Description
Application

string

Key

string

ManagedIdentity

string

User

string

DaysOfWeek

Días de la semana.

Nombre Tipo Description
Friday

string

Monday

string

Saturday

string

Sunday

string

Thursday

string

Tuesday

string

Wednesday

string

ErrorDetailsWithNestedDetails

Detalles del error.

Nombre Tipo Description
code

string

Código de error.
details

ErrorDetailsWithNestedDetails[]

Detalles adicionales del error.
message

string

Mensaje de error que indica por qué se produjo un error en la operación.

ErrorResponseWithNestedDetails

La respuesta de error indica que el servicio no puede procesar la solicitud entrante. El motivo se proporciona en el mensaje de error.

Algunas respuestas de error:

  • 429 TooManyRequests: la solicitud está limitada. Vuelva a intentarlo después de esperar el tiempo especificado en el encabezado "x-ms-ratelimit-microsoft.consumption-retry-after".

  • 503 ServiceUnavailable: el servicio no está disponible temporalmente. Vuelva a intentarlo después de esperar el tiempo especificado en el encabezado "Vuelva a intentarlo después de".

Nombre Tipo Description
error

ErrorDetailsWithNestedDetails

Detalles del error.

FileDestination

Destino de los datos de vista. Esto es opcional. Actualmente solo se admite el formato CSV.

Nombre Tipo Description
fileFormats

FileFormat[]

Destino de los datos de vista. Actualmente solo se admite el formato CSV.

FileFormat

Destino de los datos de vista. Actualmente solo se admite el formato CSV.

Nombre Tipo Description
Csv

string

NotificationProperties

Propiedades de la notificación de acción programada.

Nombre Tipo Description
language

string

Configuración regional del correo electrónico.
message

string

Mensaje opcional que se va a agregar en el correo electrónico. La longitud está limitada a 250 caracteres.
regionalFormat

string

Formato regional utilizado para dar formato a los valores de fecha y hora y moneda en el correo electrónico.
subject

string

Asunto del correo electrónico. La longitud está limitada a 70 caracteres.
to

string[]

Matriz de direcciones de correo electrónico.

ScheduledAction

Definición de acción programada.

Nombre Tipo Description
eTag

string

Etag de recursos. Para las llamadas de actualización, eTag es opcional y se puede especificar para lograr la simultaneidad optimista. Para capturar la eTag del recurso, realice primero una llamada "GET" y, a continuación, incluya la eTag más reciente como parte del cuerpo de la solicitud o el encabezado "If-Match" mientras realiza la actualización. Para las llamadas de creación, no se requiere eTag.
id

string

Identificador de recurso completo del recurso. Por ejemplo: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
kind

ScheduledActionKind

Tipo de acción programada.
name

string

Nombre del recurso.
properties.displayName

string

Nombre de la acción programada.
properties.fileDestination

FileDestination

Formato de destino de los datos de vista. Esto es opcional.
properties.notification

NotificationProperties

Propiedades de notificación basadas en el tipo de acción programada.
properties.notificationEmail

string

Email dirección del punto de contacto que debe obtener las solicitudes de cancelación de suscripción y los correos electrónicos de notificación.
properties.schedule

ScheduleProperties

Programación de la acción programada.
properties.scope

string

En el caso de la acción programada privada (Crear o actualizar), el ámbito estará vacío.
Para acciones programadas compartidas (Crear o actualizar por ámbito), el ámbito de Cost Management puede ser "subscriptions/{subscriptionId}" para el ámbito de la suscripción, "subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}" para el ámbito de resourceGroup, "providers/Microsoft.Billing/billingAccountId}" para el ámbito de la cuenta de facturación, "providers/Microsoft.Billing/billingAccounts/{billingAccountId}" para el ámbito del departamento, "providers/Microsoft. Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' para el ámbito EnrollmentAccount, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' para el ámbito BillingProfile, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' para el ámbito InvoiceSection, '/providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}' para Ámbito ExternalBillingAccount y "/providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}" para el ámbito ExternalSubscription.
properties.status

ScheduledActionStatus

Estado de la acción programada.
properties.viewId

string

ViewId de análisis de costos usado para la acción programada. Por ejemplo, "/providers/Microsoft.CostManagement/views/swaggerExample"
systemData

systemData

Tipo de acción programada.
type

string

Tipo de recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

ScheduledActionKind

Tipo de acción programada.

Nombre Tipo Description
Email

string

Los datos de análisis de costos se enviarán por correo electrónico.
InsightAlert

string

La información de anomalías de costos se enviará por correo electrónico. Solo está disponible en el ámbito de la suscripción con frecuencia diaria. Si no se detecta ninguna anomalía en el recurso, no se enviará un correo electrónico.

ScheduledActionStatus

Estado de la acción programada.

Nombre Tipo Description
Disabled

string

La acción programada se guarda, pero no se ejecutará.
Enabled

string

La acción programada se guarda y se ejecutará.
Expired

string

La acción programada ha expirado.

ScheduleFrequency

Frecuencia de la programación.

Nombre Tipo Description
Daily

string

Los datos de análisis de costos se enviarán por correo electrónico todos los días.
Monthly

string

Los datos de análisis de costos se enviarán por correo electrónico cada mes.
Weekly

string

Los datos de análisis de costos se enviarán por correo electrónico cada semana.

ScheduleProperties

Propiedades de la programación.

Nombre Tipo Description
dayOfMonth

integer

Día UTC en el que se enviarán por correo electrónico los datos de análisis de costos. Debe estar entre 1 y 31. Esta propiedad es aplicable cuando frequency es Monthly e invalida weeksOfMonth o daysOfWeek.
daysOfWeek

DaysOfWeek[]

Nombres de día en inglés en los que se enviarán por correo electrónico los datos de análisis de costos. Esta propiedad es aplicable cuando la frecuencia es Semanal o Mensual.
endDate

string

Fecha y hora de finalización de la acción programada (UTC).
frequency

ScheduleFrequency

Frecuencia de la programación.
hourOfDay

integer

Hora UTC a la que se enviarán por correo electrónico los datos de análisis de costos.
startDate

string

Fecha y hora de inicio de la acción programada (UTC).
weeksOfMonth

WeeksOfMonth[]

Semanas en las que se enviarán por correo electrónico los datos de análisis de costos. Esta propiedad es aplicable cuando la frecuencia es Mensual y se usa en combinación con daysOfWeek.

systemData

Metadatos relacionados con la creación y la última modificación del recurso.

Nombre Tipo Description
createdAt

string

Marca de tiempo de creación de recursos (UTC).
createdBy

string

Identidad que creó el recurso.
createdByType

createdByType

Tipo de identidad que creó el recurso.
lastModifiedAt

string

Marca de tiempo de la última modificación del recurso (UTC)
lastModifiedBy

string

Identidad que modificó por última vez el recurso.
lastModifiedByType

createdByType

Tipo de identidad que modificó por última vez el recurso.

WeeksOfMonth

Semanas del mes.

Nombre Tipo Description
First

string

Fourth

string

Last

string

Second

string

Third

string