Alerts - Get

Referência

Serviço:: Cost Management

Versão da API:: 2024-08-01

Obtém o alerta para o escopo por ID de alerta.

GET https://management.azure.com/{scope}/providers/Microsoft.CostManagement/alerts/{alertId}?api-version=2024-08-01

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
alertId	path	True	string	ID do alerta
scope	path	True	string	O escopo associado às operações de alerta. 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 e '/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.Management/managementGroups/{managementGroupId} para o escopo do Grupo de Gerenciamento, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' para o escopo do billingProfile, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/invoiceSections/{invoiceSectionId}' para o escopo invoiceSection e '/providers/Microsoft. Billing/billingAccounts/{billingAccountId}/customers/{customerId}' específico para parceiros.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.

Respostas

Name	Tipo	Description
200 OK	Alert	OK. O pedido foi bem-sucedido.
Other Status Codes	ErrorResponse	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

SingleResourceGroupAlerts

SingleSubscriptionAlerts

SingleResourceGroupAlerts

Pedido de amostra

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ScreenSharingTest-peer/providers/Microsoft.CostManagement/alerts/22222222-2222-2222-2222-222222222222?api-version=2024-08-01

Resposta da amostra

Código de estado:: 200

{
  "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ScreenSharingTest-peer/providers/Microsoft.CostManagement/alerts/22222222-2222-2222-2222-222222222222",
  "name": "22222222-2222-2222-2222-222222222222",
  "type": "Microsoft.CostManagement/alerts",
  "properties": {
    "definition": {
      "type": "Budget",
      "category": "Cost",
      "criteria": "CostThresholdExceeded"
    },
    "description": "",
    "source": "Preset",
    "details": {
      "timeGrainType": "Quarterly",
      "periodStartDate": "2020-03-01T00:00:00Z",
      "triggeredBy": "22222222-2222-2222-2222-222222222222_1_01",
      "resourceGroupFilter": [],
      "resourceFilter": [],
      "meterFilter": [],
      "tagFilter": {},
      "threshold": 0.8,
      "operator": "GreaterThan",
      "amount": 200000,
      "unit": "USD",
      "currentSpend": 161000.12,
      "contactEmails": [
        "1234@contoso.com"
      ],
      "contactGroups": [],
      "contactRoles": [],
      "overridingAlert": null
    },
    "costEntityId": "budget1",
    "status": "Active",
    "creationTime": "2020-04-27T11:07:52.7143901Z",
    "closeTime": "0001-01-01T00:00:00",
    "modificationTime": "2020-04-28T11:06:02.8999373Z",
    "statusModificationUserName": null,
    "statusModificationTime": "0001-01-01T00:00:00"
  }
}

SingleSubscriptionAlerts

Pedido de amostra

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/alerts/22222222-2222-2222-2222-222222222222?api-version=2024-08-01

Resposta da amostra

Código de estado:: 200

{
  "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/alerts/22222222-2222-2222-2222-222222222222",
  "name": "22222222-2222-2222-2222-222222222222",
  "type": "Microsoft.CostManagement/alerts",
  "properties": {
    "definition": {
      "type": "Budget",
      "category": "Cost",
      "criteria": "CostThresholdExceeded"
    },
    "description": "",
    "source": "Preset",
    "details": {
      "timeGrainType": "Quarterly",
      "periodStartDate": "2020-03-01T00:00:00Z",
      "triggeredBy": "22222222-2222-2222-2222-222222222222_1_01",
      "resourceGroupFilter": [],
      "resourceFilter": [],
      "meterFilter": [],
      "tagFilter": {},
      "threshold": 0.8,
      "operator": "GreaterThan",
      "amount": 200000,
      "unit": "USD",
      "currentSpend": 161000.12,
      "contactEmails": [
        "1234@contoso.com"
      ],
      "contactGroups": [],
      "contactRoles": [],
      "overridingAlert": null
    },
    "costEntityId": "budget1",
    "status": "Active",
    "creationTime": "2020-04-27T11:07:52.7143901Z",
    "closeTime": "0001-01-01T00:00:00",
    "modificationTime": "2020-04-28T11:06:02.8999373Z",
    "statusModificationUserName": null,
    "statusModificationTime": "0001-01-01T00:00:00"
  }
}

Definições

Name	Description
Alert	Um alerta individual.
AlertCategory	Categoria de alerta
AlertCriteria	Critérios que dispararam o alerta
AlertOperator	operador usado para comparar currentSpend com o montante
AlertSource	Fonte de alerta
AlertStatus	Estado de alerta
AlertTimeGrainType	Tipo de cadência timegrain
AlertType	Tipo de alerta
Definition	define o tipo de alerta
Details	Detalhes do alerta
ErrorDetails	Os detalhes do erro.
ErrorResponse	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".
TagFilter	tags para filtrar por

Alert

Object

Um alerta individual.

Name	Tipo	Description
eTag	string	eTag do recurso. Para lidar com o cenário de atualização simultânea, esse campo será usado para determinar se o usuário está atualizando a versão mais recente ou não.
id	string	Id do recurso.
name	string	Nome do recurso.
properties.closeTime	string	dateHora em que o alerta foi fechado
properties.costEntityId	string	Orçamento conexo
properties.creationTime	string	dateTime em que o alerta foi criado
properties.definition	Definition	define o tipo de alerta
properties.description	string	Descrição do alerta
properties.details	Details	Detalhes do alerta
properties.modificationTime	string	dateTime em que o alerta foi modificado pela última vez
properties.source	AlertSource	Fonte de alerta
properties.status	AlertStatus	Estado de alerta
properties.statusModificationTime	string	dateTime em que o estado de alerta foi modificado pela última vez
properties.statusModificationUserName	string	Usuário que modificou o alerta pela última vez
type	string	Tipo de recurso.

AlertCategory

Enumeração

Categoria de alerta

Valor	Description
Billing
Cost
System
Usage

AlertCriteria

Enumeração

Critérios que dispararam o alerta

Valor	Description
CostThresholdExceeded
CreditThresholdApproaching
CreditThresholdReached
CrossCloudCollectionError
CrossCloudNewDataAvailable
ForecastCostThresholdExceeded
ForecastUsageThresholdExceeded
GeneralThresholdError
InvoiceDueDateApproaching
InvoiceDueDateReached
MultiCurrency
QuotaThresholdApproaching
QuotaThresholdReached
UsageThresholdExceeded

AlertOperator

Enumeração

operador usado para comparar currentSpend com o montante

Valor	Description
EqualTo
GreaterThan
GreaterThanOrEqualTo
LessThan
LessThanOrEqualTo
None

AlertSource

Enumeração

Fonte de alerta

Valor	Description
Preset
User

AlertStatus

Enumeração

Estado de alerta

Valor	Description
Active
Dismissed
None
Overridden
Resolved

AlertTimeGrainType

Enumeração

Tipo de cadência timegrain

Valor	Description
Annually
BillingAnnual
BillingMonth
BillingQuarter
Monthly
None
Quarterly

AlertType

Enumeração

Tipo de alerta

Valor	Description
Budget
BudgetForecast
Credit
General
Invoice
Quota
xCloud

Definition

Object

define o tipo de alerta

Name	Tipo	Description
category	AlertCategory	Categoria de alerta
criteria	AlertCriteria	Critérios que dispararam o alerta
type	AlertType	Tipo de alerta

Details

Object

Detalhes do alerta

Name	Tipo	Description
amount	number (decimal)	Montante do limiar orçamental
companyName	string	nome da empresa
contactEmails	string[]	Lista de e-mails a contactar
contactGroups	string[]	Lista de grupos de ação para os quais transmitir
contactRoles	string[]	Lista de funções de contato
currentSpend	number (decimal)	Despesas correntes
departmentName	string	Nome do departamento
enrollmentEndDate	string	datetime da inscriçãoEndDate
enrollmentNumber	string	número de inscrição
enrollmentStartDate	string	datetime da inscriçãoStartDate
invoicingThreshold	number (decimal)	limiar de faturação
meterFilter	AlertProperties.details.MeterFilter[]	Matriz de medidores para filtrar por
operator	AlertOperator	operador usado para comparar currentSpend com o montante
overridingAlert	string	Alerta de substituição
periodStartDate	string	datetime do períodoStartDate
resourceFilter	AlertProperties.details.ResourceFilter[]	Matriz de recursos para filtrar por
resourceGroupFilter	AlertProperties.details.ResourceGroupFilter[]	matriz de resourceGroups para filtrar por
tagFilter	TagFilter	tags para filtrar por
threshold	number (decimal)	Percentagem do limiar de notificação como decimal que ativou este alerta
timeGrainType	AlertTimeGrainType	Tipo de cadência timegrain
triggeredBy	string	notificationId que disparou este alerta
unit	string	unidade monetária utilizada

ErrorDetails

Object

Os detalhes do erro.

Name	Tipo	Description
code	string	Código de erro.
message	string	Mensagem de erro indicando por que a operação falhou.

ErrorResponse

Object

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	ErrorDetails	Os detalhes do erro.

TagFilter

Object

tags para filtrar por

Partilhar via

Alerts - Get

Parâmetros do URI

Respostas

Segurança

azure_auth

Âmbitos

Exemplos

SingleResourceGroupAlerts

Pedido de amostra

Resposta da amostra

SingleSubscriptionAlerts

Pedido de amostra

Resposta da amostra

Definições

Alert

AlertCategory

AlertCriteria

AlertOperator

AlertSource

AlertStatus

AlertTimeGrainType

AlertType

Definition

Details

ErrorDetails

ErrorResponse

TagFilter

Recursos adicionais