Scheduled Actions - Create Or Update By Scope

Serviço:

Cost Management

Versão da API:

2024-08-01

Crie ou atualize uma ação agendada compartilhada dentro do escopo determinado.

PUT https://management.azure.com/{scope}/providers/Microsoft.CostManagement/scheduledActions/{name}?api-version=2024-08-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 escopo associado às operações de ação agendadas. Isso inclui 'subscriptions/{subscriptionId}' para o escopo da assinatura, 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' para o escopo resourceGroup, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}' para o escopo da Conta de Cobrança, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' para o escopo do Departamento, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{ enrollmentAccountId}' para o escopo EnrollmentAccount, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' para o escopo BillingProfile, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' para o escopo InvoiceSection, 'providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}' para o escopo da Conta de Cobrança Externa e 'providers/Microsoft. CostManagement/externalSubscriptions/{externalSubscriptionName}' para o âmbito da Subscrição Externa. Observação: os alertas do Insight só estão disponíveis no escopo da assinatura.
api-version	query	True	string	A versão da API a ser usada 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 alcançar uma 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	Cronograma da ação programada.
properties.status	True	ScheduledActionStatus	Status da ação agendada.
properties.viewId	True	string	ViewId de análise de custos usado para ação agendada. Por exemplo, '/providers/Microsoft.CostManagement/views/swaggerExample'
kind		ScheduledActionKind	Tipo de ação programada.
properties.fileDestination		FileDestination	Formato de destino dos dados de visualização. Isso é opcional.
properties.notificationEmail		string	Endereço de e-mail do ponto de contato que deve receber os pedidos de cancelamento de inscrição e e-mails de notificação.
properties.scope		string	Para a ação agendada privada (Criar ou Atualizar), o escopo estará vazio. Para ação agendada compartilhada (Criar ou Atualizar por Escopo), o escopo do Gerenciamento de Custos pode ser 'subscriptions/{subscriptionId}' para escopo de assinatura, 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' para escopo resourceGroup, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}' para escopo de Conta de Cobrança, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' para escopo de Departamento, 'providers/Microsoft. Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' para o escopo EnrollmentAccount, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' para o escopo BillingProfile, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' para o escopo InvoiceSection, '/providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}' para Escopo ExternalBillingAccount e '/providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}' para o escopo ExternalSubscription.

Respostas

Name	Tipo	Description
200 OK	ScheduledAction	OK. O pedido foi bem-sucedido.
201 Created	ScheduledAction	Criado.
Other Status Codes	ErrorResponseWithNestedDetails	Resposta de erro descrevendo por que a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Ative Directory.

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name	Description
user_impersonation	personificar a sua conta de utilizador

Exemplos

CreateOrUpdateInsightAlertScheduledActionByScope

CreateOrUpdateScheduledActionByScope

CreateOrUpdateInsightAlertScheduledActionByScope

Pedido de amostra

HTTP

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

Resposta da amostra

Código de estado:

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

Código de estado:

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

Pedido de amostra

HTTP

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

Resposta da amostra

Código de estado:

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

Código de estado:

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 de erro indica que o serviço não é capaz de processar a solicitação de entrada. O motivo é fornecido na mensagem de erro. Algumas respostas de erro: 429 TooManyRequests - A solicitação está limitada. Tente novamente depois de aguardar o tempo especificado no cabeçalho "x-ms-ratelimit-microsoft.consumption-retry-after". 503 ServiçoIndisponível - O serviço está temporariamente indisponível. Tente novamente depois de aguardar o tempo especificado no cabeçalho "Retry-After".
FileDestination	Destino dos dados de visualização. Isso é 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 programada.
ScheduledActionStatus	Status da ação agendada.
ScheduleFrequency	Frequência do horário.
ScheduleProperties	As propriedades da agenda.
systemData	Metadados referentes à 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 indicando por que a operação falhou.

ErrorResponseWithNestedDetails

A resposta de erro indica que o serviço não é capaz de processar a solicitação de entrada. O motivo é fornecido na mensagem de erro.

Algumas respostas de erro:

• 429 TooManyRequests - A solicitação está limitada. Tente novamente depois de aguardar o tempo especificado no cabeçalho "x-ms-ratelimit-microsoft.consumption-retry-after".

• 503 ServiçoIndisponível - O serviço está temporariamente indisponível. Tente novamente depois de aguardar o tempo especificado no cabeçalho "Retry-After".

Name	Tipo	Description
error	ErrorDetailsWithNestedDetails	Os detalhes do erro.

FileDestination

Destino dos dados de visualização. Isso é 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	Localidade do e-mail.
message	string	Mensagem opcional a ser adicionada no e-mail. O comprimento é limitado a 250 caracteres.
regionalFormat	string	Formato regional usado para formatar valores de data/hora e moeda no e-mail.
subject	string	Assunto do e-mail. O comprimento é limitado a 70 caracteres.
to	string[]	Matriz de endereços de e-mail.

ScheduledAction

Definição de ação agendada.

Name	Tipo	Description
eTag	string	Etag de recurso. Para chamadas de atualização, o eTag é opcional e pode ser especificado para alcançar uma simultaneidade otimista. Procure a eTag do recurso fazendo uma chamada 'GET' primeiro e, em seguida, incluindo a eTag mais recente como parte do corpo da solicitação ou do 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 totalmente qualificado para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
kind	ScheduledActionKind	Tipo de ação programada.
name	string	O nome do recurso
properties.displayName	string	Nome da ação agendada.
properties.fileDestination	FileDestination	Formato de destino dos dados de visualização. Isso é opcional.
properties.notification	NotificationProperties	Propriedades de notificação com base no tipo de ação agendada.
properties.notificationEmail	string	Endereço de e-mail do ponto de contato que deve receber os pedidos de cancelamento de inscrição e e-mails de notificação.
properties.schedule	ScheduleProperties	Cronograma da ação programada.
properties.scope	string	Para a ação agendada privada (Criar ou Atualizar), o escopo estará vazio. Para ação agendada compartilhada (Criar ou Atualizar por Escopo), o escopo do Gerenciamento de Custos pode ser 'subscriptions/{subscriptionId}' para escopo de assinatura, 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' para escopo resourceGroup, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}' para escopo de Conta de Cobrança, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' para escopo de Departamento, 'providers/Microsoft. Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' para o escopo EnrollmentAccount, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' para o escopo BillingProfile, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' para o escopo InvoiceSection, '/providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}' para Escopo ExternalBillingAccount e '/providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}' para o escopo ExternalSubscription.
properties.status	ScheduledActionStatus	Status da ação agendada.
properties.viewId	string	ViewId de análise de custos usado para ação agendada. Por exemplo, '/providers/Microsoft.CostManagement/views/swaggerExample'
systemData	systemData	Tipo de ação programada.
type	string	O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

ScheduledActionKind

Tipo de ação programada.

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

ScheduledActionStatus

Status da ação agendada.

Name	Tipo	Description
Disabled	string	A ação agendada é salva, mas não será executada.
Enabled	string	A ação agendada é salva e será executada.
Expired	string	A ação agendada expirou.

ScheduleFrequency

Frequência do horário.

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. Deve ter entre 1 e 31. Esta propriedade é aplicável quando a frequência é Mensal e substitui weeksOfMonth ou daysOfWeek.
daysOfWeek	DaysOfWeek[]	Nomes de dias em inglês sobre os 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 término da ação agendada (UTC).
frequency	ScheduleFrequency	Frequência do horário.
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 usada em combinação com daysOfWeek.

systemData

Metadados referentes à 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