Scheduled Actions - Create Or Update By Scope

  • Referência
Service:
Cost Management
API Version:
2023-11-01

Criar ou atualizar uma ação agendada partilhada dentro do âmbito especificado.

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

Parâmetros do URI

Name Em Necessário Tipo Description
name
 path True

string

Nome da ação agendada.
scope
 path True

string

O âmbito associado às operações de ação agendadas. Isto inclui "subscriptions/{subscriptionId}" para o âmbito da subscrição, "subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}" para o âmbito resourceGroup, "providers/Microsoft.Billing/billingAccounts/{billingAccountId}" para o âmbito da Conta de Faturação, "providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}" para o âmbito do Departamento, "providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{ enrollmentAccountId}" para o âmbito EnrollmentAccount, "providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}" para o âmbito BillingProfile, "providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}" para o âmbito InvoiceSection, "providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}" para o âmbito da Conta de Faturação Externa e "fornecedores/Microsoft. CostManagement/externalSubscriptions/{externalSubscriptionName}' para o âmbito da Subscrição Externa. Nota: os Alertas de Informações só estão disponíveis no âmbito da subscrição.
api-version
 query True

string

A versão da API a utilizar para esta operação.

Cabeçalho do Pedido

Name Necessário Tipo Description
If-Match

string

ETag da Entidade. Não é necessário ao criar uma entidade. Opcional ao atualizar uma entidade e pode ser especificado para obter simultaneidade otimista.

Corpo do Pedido

Name Necessário Tipo Description
properties.displayName True

string

Nome da ação agendada.
properties.notification True

NotificationProperties

Propriedades de notificação com base no tipo de ação agendada.
properties.schedule True

ScheduleProperties

Agenda da ação agendada.
properties.status True

ScheduledActionStatus

Estado da ação agendada.
properties.viewId True

string

Vista análise de custosId utilizado para a ação agendada. Por exemplo, "/providers/Microsoft.CostManagement/views/swaggerExample"
kind

ScheduledActionKind

Tipo de ação agendada.
properties.fileDestination

FileDestination

Formato de destino dos dados da vista. Isto é opcional.
properties.notificationEmail

string

Email endereço do ponto de contacto que deve receber os pedidos de anulação da subscrição e os e-mails de notificação.
properties.scope

string

Para a ação agendada privada (Criar ou Atualizar), o âmbito estará vazio.
Para a ação agendada partilhada (Criar ou Atualizar Por Âmbito), o âmbito do Cost Management pode ser "subscrições/{subscriptionId}" para o âmbito da subscrição, "subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}" para o âmbito resourceGroup, "providers/Microsoft.Billing/billingAccounts/{billingAccountId}" para o âmbito da Conta de Faturação, "providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}" para o âmbito do Departamento, "fornecedores/Microsoft. Faturação/faturaçãoAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}" para o âmbito EnrollmentAccount, "providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}" para o âmbito BillingProfile, "providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}" para o âmbito InvoiceSection, "/providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}" para Âmbito ExternalBillingAccount e "/providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}" para o âmbito ExternalSubscription.

Respostas

Name Tipo Description
200 OK

ScheduledAction

OK. O pedido foi efetuada com êxito.
201 Created

ScheduledAction

Criado.
Other Status Codes

ErrorResponseWithNestedDetails

Resposta de erro que descreve o motivo pela qual a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

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

Scopes

Name Description
user_impersonation representar a sua conta de utilizador

Exemplos

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

Definições

Name Description
createdByType

O tipo de identidade que criou o recurso.
DaysOfWeek

Dias da Semana.
ErrorDetailsWithNestedDetails

Os detalhes do erro.
ErrorResponseWithNestedDetails

A resposta a erros indica que o serviço não consegue processar o pedido recebido. O motivo é fornecido na mensagem de erro.

Algumas Respostas de erro:

  • 429 TooManyRequests - O pedido é limitado. Repita depois de aguardar o tempo especificado no cabeçalho "x-ms-ratelimit-microsoft.consumption-retry-after".

  • 503 ServiceUnavailable - O serviço está temporariamente indisponível. Tente novamente após aguardar durante o tempo especificado no cabeçalho “Tentar novamente após”.
FileDestination

Destino dos dados de visualização. Isto é opcional. Atualmente, apenas o formato CSV é suportado.
FileFormat

Destino dos dados de visualização. Atualmente, apenas o formato CSV é suportado.
NotificationProperties

As propriedades da notificação de ação agendada.
ScheduledAction

Definição de ação agendada.
ScheduledActionKind

Tipo de ação agendada.
ScheduledActionStatus

Estado da ação agendada.
ScheduleFrequency

Frequência da agenda.
ScheduleProperties

As propriedades da agenda.
systemData

Metadados relativos à criação e última modificação do recurso.
WeeksOfMonth

Semanas do mês.

createdByType

O tipo de identidade que criou o recurso.

Name Tipo Description
Application

string

Key

string

ManagedIdentity

string

User

string

DaysOfWeek

Dias da Semana.

Name Tipo Description
Friday

string

Monday

string

Saturday

string

Sunday

string

Thursday

string

Tuesday

string

Wednesday

string

ErrorDetailsWithNestedDetails

Os detalhes do erro.

Name Tipo Description
code

string

Código de erro.
details

ErrorDetailsWithNestedDetails[]

Os detalhes adicionais do erro.
message

string

Mensagem de erro a indicar por que motivo a operação falhou.

ErrorResponseWithNestedDetails

A resposta a erros indica que o serviço não consegue processar o pedido recebido. O motivo é fornecido na mensagem de erro.

Algumas Respostas de erro:

  • 429 TooManyRequests - O pedido é limitado. Repita depois de aguardar o tempo especificado no cabeçalho "x-ms-ratelimit-microsoft.consumption-retry-after".

  • 503 ServiceUnavailable - O serviço está temporariamente indisponível. Tente novamente após aguardar durante o tempo especificado no cabeçalho “Tentar novamente após”.

Name Tipo Description
error

ErrorDetailsWithNestedDetails

Os detalhes do erro.

FileDestination

Destino dos dados de visualização. Isto é opcional. Atualmente, apenas o formato CSV é suportado.

Name Tipo Description
fileFormats

FileFormat[]

Destino dos dados de visualização. Atualmente, apenas o formato CSV é suportado.

FileFormat

Destino dos dados de visualização. Atualmente, apenas o formato CSV é suportado.

Name Tipo Description
Csv

string

NotificationProperties

As propriedades da notificação de ação agendada.

Name Tipo Description
language

string

Região do e-mail.
message

string

Mensagem opcional a adicionar no e-mail. O comprimento está limitado a 250 carateres.
regionalFormat

string

Formato regional utilizado para formatar valores de data/hora e moeda no e-mail.
subject

string

Assunto do e-mail. O comprimento está limitado a 70 carateres.
to

string[]

Matriz de endereços de e-mail.

ScheduledAction

Definição de ação agendada.

Name Tipo Description
eTag

string

Resource Etag. Para chamadas de atualização, o eTag é opcional e pode ser especificado para alcançar simultaneidade otimista. Obtenha o eTag do recurso ao fazer primeiro uma chamada "GET" e, em seguida, incluindo o eTag mais recente como parte do corpo do pedido ou o cabeçalho "If-Match" durante a execução da atualização. Para criar chamadas, o eTag não é necessário.
id

string

ID de recurso completamente qualificado para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
kind

ScheduledActionKind

Tipo de ação agendada.
name

string

O nome do recurso
properties.displayName

string

Nome da ação agendada.
properties.fileDestination

FileDestination

Formato de destino dos dados da vista. Isto é opcional.
properties.notification

NotificationProperties

Propriedades de notificação com base no tipo de ação agendada.
properties.notificationEmail

string

Email endereço do ponto de contacto que deve receber os pedidos de anulação da subscrição e os e-mails de notificação.
properties.schedule

ScheduleProperties

Agenda da ação agendada.
properties.scope

string

Para a ação agendada privada (Criar ou Atualizar), o âmbito estará vazio.
Para a ação agendada partilhada (Criar ou Atualizar Por Âmbito), o âmbito do Cost Management pode ser "subscrições/{subscriptionId}" para o âmbito da subscrição, "subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}" para o âmbito resourceGroup, "providers/Microsoft.Billing/billingAccounts/{billingAccountId}" para o âmbito da Conta de Faturação, "providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}" para o âmbito do Departamento, "fornecedores/Microsoft. Faturação/faturaçãoAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}" para o âmbito EnrollmentAccount, "providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}" para o âmbito BillingProfile, "providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}" para o âmbito InvoiceSection, "/providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}" para Âmbito ExternalBillingAccount e "/providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}" para o âmbito ExternalSubscription.
properties.status

ScheduledActionStatus

Estado da ação agendada.
properties.viewId

string

Vista análise de custosId utilizado para a ação agendada. Por exemplo, "/providers/Microsoft.CostManagement/views/swaggerExample"
systemData

systemData

Tipo de ação agendada.
type

string

O tipo de recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

ScheduledActionKind

Tipo de ação agendada.

Name Tipo Description
Email

string

Os dados de análise de custos serão enviados por e-mail.
InsightAlert

string

As informações sobre anomalias de custos serão enviados por e-mail. Disponível apenas no âmbito da subscrição com frequência diária. Se não for detetada nenhuma anomalia no recurso, não será enviado um e-mail.

ScheduledActionStatus

Estado da ação agendada.

Name Tipo Description
Disabled

string

A ação agendada é guardada, mas não será executada.
Enabled

string

A ação agendada é guardada e será executada.
Expired

string

A ação agendada expirou.

ScheduleFrequency

Frequência da agenda.

Name Tipo Description
Daily

string

Os dados de análise de custos serão enviados por e-mail todos os dias.
Monthly

string

Os dados de análise de custos serão enviados por e-mail todos os meses.
Weekly

string

Os dados de análise de custos serão enviados por e-mail todas as semanas.

ScheduleProperties

As propriedades da agenda.

Name Tipo Description
dayOfMonth

integer

Dia UTC em que os dados de análise de custos serão enviados por e-mail. Tem de estar entre 1 e 31. Esta propriedade é aplicável quando a frequência é Mensal e substitui weeksOfMonth ou daysOfWeek.
daysOfWeek

DaysOfWeek[]

Nomes de dia em inglês nos quais os dados de análise de custos serão enviados por e-mail. Esta propriedade é aplicável quando a frequência é Semanal ou Mensal.
endDate

string

A data e hora de fim da ação agendada (UTC).
frequency

ScheduleFrequency

Frequência da agenda.
hourOfDay

integer

Hora UTC em que os dados de análise de custos serão enviados por e-mail.
startDate

string

A data e hora de início da ação agendada (UTC).
weeksOfMonth

WeeksOfMonth[]

Semanas em que os dados de análise de custos serão enviados por e-mail. Esta propriedade é aplicável quando a frequência é Mensal e é utilizada em combinação com daysOfWeek.

systemData

Metadados relativos à criação e última modificação do recurso.

Name Tipo Description
createdAt

string

O carimbo de data/hora da criação de recursos (UTC).
createdBy

string

A identidade que criou o recurso.
createdByType

createdByType

O tipo de identidade que criou o recurso.
lastModifiedAt

string

O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy

string

A identidade que modificou o recurso pela última vez.
lastModifiedByType

createdByType

O tipo de identidade que modificou o recurso pela última vez.

WeeksOfMonth

Semanas do mês.

Name Tipo Description
First

string

Fourth

string

Last

string

Second

string

Third

string