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 especificado.

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

Parâmetros de URI

Nome	Em	Obrigató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 escopo de assinatura, 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' para 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 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 da Conta de Cobrança Externa e 'providers/Microsoft. CostManagement/externalSubscriptions/{externalSubscriptionName}' para escopo de Assinatura 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 da solicitação

Nome	Obrigató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 da solicitação

Nome	Obrigató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	Agendamento da ação agendada.
properties.status	True	ScheduledActionStatus	Status da ação agendada.
properties.viewId	True	string	ViewId de análise de custo usada 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 de exibição. Isso é opcional.
properties.notificationEmail		string	Endereço de email do ponto de contato que deve receber as solicitações de cancelamento de assinatura e emails de notificação.
properties.scope		string	Para ação agendada privada (Criar ou Atualizar), o escopo estará vazio. Para ações agendadas compartilhadas (Criar ou Atualizar por Escopo), o escopo do Gerenciamento de Custos pode ser 'subscriptions/{subscriptionId}' para o escopo da assinatura, 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' para escopo do resourceGroup, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}' para o escopo da Conta de Cobrança, 'providers/Microsoft.Billing/billingAccountId/{billingAccountId}/departments/{departmentId}' para 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 Escopo ExternalBillingAccount e '/providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}' para escopo ExternalSubscription.

Respostas

Nome	Tipo	Description
200 OK	ScheduledAction	OKEY. A solicitação foi bem-sucedida.
201 Created	ScheduledAction	Criado.
Other Status Codes	ErrorResponseWithNestedDetails	Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

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

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

CreateOrUpdateInsightAlertScheduledActionByScope

CreateOrUpdateScheduledActionByScope

CreateOrUpdateInsightAlertScheduledActionByScope

Solicitação de exemplo

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 de exemplo

Código de status:

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 status:

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

Solicitação de exemplo

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 de exemplo

Código de status:

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 status:

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

Nome	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 é limitada. Tente novamente 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 depois de aguardar o tempo especificado no cabeçalho "Retry-After".
FileDestination	Destino dos dados de exibição. Isso é opcional. Atualmente, há suporte apenas para o formato CSV.
FileFormat	Destino dos dados de exibição. Atualmente, há suporte apenas para o formato CSV.
NotificationProperties	As propriedades da notificação de ação agendada.
ScheduledAction	Definição de ação agendada.
ScheduledActionKind	Tipo de ação agendada.
ScheduledActionStatus	Status da ação agendada.
ScheduleFrequency	Frequência da agenda.
ScheduleProperties	As propriedades do agendamento.
systemData	Metadados relativos à criação e última modificação do recurso.
WeeksOfMonth	Semanas de mês.

createdByType

O tipo de identidade que criou o recurso.

Nome	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

DaysOfWeek

Dias da semana.

Nome	Tipo	Description
Friday	string
Monday	string
Saturday	string
Sunday	string
Thursday	string
Tuesday	string
Wednesday	string

ErrorDetailsWithNestedDetails

Os detalhes do erro.

Nome	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 é limitada. Tente novamente 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 depois de aguardar o tempo especificado no cabeçalho "Retry-After".

Nome	Tipo	Description
error	ErrorDetailsWithNestedDetails	Os detalhes do erro.

FileDestination

Destino dos dados de exibição. Isso é opcional. Atualmente, há suporte apenas para o formato CSV.

Nome	Tipo	Description
fileFormats	FileFormat[]	Destino dos dados de exibição. Atualmente, há suporte apenas para o formato CSV.

FileFormat

Destino dos dados de exibição. Atualmente, há suporte apenas para o formato CSV.

Nome	Tipo	Description
Csv	string

NotificationProperties

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

Nome	Tipo	Description
language	string	Localidade do email.
message	string	Mensagem opcional a ser adicionada no email. O comprimento é limitado a 250 caracteres.
regionalFormat	string	Formato regional usado para formatar valores de data/hora e moeda no email.
subject	string	Assunto do email. O comprimento é limitado a 70 caracteres.
to	string[]	Matriz de endereços de email.

ScheduledAction

Definição de ação agendada.

Nome	Tipo	Description
eTag	string	Etag de recurso. Para chamadas de atualização, a eTag é opcional e pode ser especificada para obter simultaneidade otimista. Busque 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 cabeçalho 'If-Match' ao executar a atualização. Para criar chamadas, a eTag não é necessária.
id	string	ID de recurso totalmente qualificada 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 de exibição. Isso é opcional.
properties.notification	NotificationProperties	Propriedades de notificação com base no tipo de ação agendada.
properties.notificationEmail	string	Endereço de email do ponto de contato que deve receber as solicitações de cancelamento de assinatura e emails de notificação.
properties.schedule	ScheduleProperties	Agendamento da ação agendada.
properties.scope	string	Para ação agendada privada (Criar ou Atualizar), o escopo estará vazio. Para ações agendadas compartilhadas (Criar ou Atualizar por Escopo), o escopo do Gerenciamento de Custos pode ser 'subscriptions/{subscriptionId}' para o escopo da assinatura, 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' para escopo do resourceGroup, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}' para o escopo da Conta de Cobrança, 'providers/Microsoft.Billing/billingAccountId/{billingAccountId}/departments/{departmentId}' para 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 Escopo ExternalBillingAccount e '/providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}' para escopo ExternalSubscription.
properties.status	ScheduledActionStatus	Status da ação agendada.
properties.viewId	string	ViewId de análise de custo usada para a ação agendada. Por exemplo, '/providers/Microsoft.CostManagement/views/swaggerExample'
systemData	systemData	Tipo de ação agendada.
type	string	O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

ScheduledActionKind

Tipo de ação agendada.

Nome	Tipo	Description
Email	string	Os dados de análise de custo serão enviados por email.
InsightAlert	string	Informações sobre anomalias de custo serão enviadas por email. Disponível apenas no escopo da assinatura em frequência diária. Se nenhuma anomalia for detectada no recurso, um email não será enviado.

ScheduledActionStatus

Status da ação agendada.

Nome	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 da agenda.

Nome	Tipo	Description
Daily	string	Os dados de análise de custo serão enviados por email todos os dias.
Monthly	string	Os dados de análise de custo serão enviados por email todos os meses.
Weekly	string	Os dados de análise de custo serão enviados por email toda semana.

ScheduleProperties

As propriedades do agendamento.

Nome	Tipo	Description
dayOfMonth	integer	Dia UTC no qual os dados de análise de custo serão enviados por email. Deve estar entre 1 e 31. Essa 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 custo serão enviados por email. Essa propriedade é aplicável quando a frequência é Semanal ou Mensal.
endDate	string	A data e a hora de término da ação agendada (UTC).
frequency	ScheduleFrequency	Frequência da agenda.
hourOfDay	integer	Hora UTC na qual os dados de análise de custo serão enviados por email.
startDate	string	A data e a hora de início da ação agendada (UTC).
weeksOfMonth	WeeksOfMonth[]	Semanas em que os dados de análise de custo serão enviados por email. Essa propriedade é aplicável quando a frequência é Mensal e usada em combinação com daysOfWeek.

systemData

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

Nome	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 de mês.

Nome	Tipo	Description
First	string
Fourth	string
Last	string
Second	string
Third	string