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

Nome	Em	Obrigatório	Tipo	Description
alertId	path	True	string	ID do alerta
scope	path	True	string	O escopo associado às operações de alertas. Isso inclui '/subscriptions/{subscriptionId}/' para escopo de assinatura, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' para escopo resourceGroup, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' para escopo da Conta de Cobrança e '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' para escopo do Departamento, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{ enrollmentAccountId}' para escopo EnrollmentAccount, '/providers/Microsoft.Management/managementGroups/{managementGroupId} for Management Group scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' para o escopo 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	A versão da API a ser usada para esta operação.

Respostas

Nome	Tipo	Description
200 OK	Alert	OKEY. A solicitação foi bem-sucedida.
Other Status Codes	ErrorResponse	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

SingleResourceGroupAlerts

SingleSubscriptionAlerts

SingleResourceGroupAlerts

Solicitação de exemplo

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

Código de status:: 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

Solicitação de exemplo

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

Código de status:: 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

Nome	Description
Alert	Um alerta individual.
AlertCategory	Categoria de alerta
AlertCriteria	Critérios que dispararam alerta
AlertOperator	operador usado para comparar currentSpend com quantidade
AlertSource	Origem do alerta
AlertStatus	status do alerta
AlertTimeGrainType	Tipo de cadência de 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 é 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".
TagFilter	marcas a serem filtradas por

Alert

Um alerta individual.

Nome	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	dateTime em que o alerta foi fechado
properties.costEntityId	string	orçamento relacionado
properties.creationTime	string	dateTime no qual 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	Origem do alerta
properties.status	AlertStatus	status do alerta
properties.statusModificationTime	string	dateTime em que o status do alerta foi modificado pela última vez
properties.statusModificationUserName	string	Usuário que modificou o alerta pela última vez
type	string	Tipo de recurso.

AlertCategory

Categoria de alerta

Nome	Tipo	Description
Billing	string
Cost	string
System	string
Usage	string

AlertCriteria

Critérios que dispararam alerta

Nome	Tipo	Description
CostThresholdExceeded	string
CreditThresholdApproaching	string
CreditThresholdReached	string
CrossCloudCollectionError	string
CrossCloudNewDataAvailable	string
ForecastCostThresholdExceeded	string
ForecastUsageThresholdExceeded	string
GeneralThresholdError	string
InvoiceDueDateApproaching	string
InvoiceDueDateReached	string
MultiCurrency	string
QuotaThresholdApproaching	string
QuotaThresholdReached	string
UsageThresholdExceeded	string

AlertOperator

operador usado para comparar currentSpend com quantidade

Nome	Tipo	Description
EqualTo	string
GreaterThan	string
GreaterThanOrEqualTo	string
LessThan	string
LessThanOrEqualTo	string
None	string

AlertSource

Origem do alerta

Nome	Tipo	Description
Preset	string
User	string

AlertStatus

status do alerta

Nome	Tipo	Description
Active	string
Dismissed	string
None	string
Overridden	string
Resolved	string

AlertTimeGrainType

Tipo de cadência de timegrain

Nome	Tipo	Description
Annually	string
BillingAnnual	string
BillingMonth	string
BillingQuarter	string
Monthly	string
None	string
Quarterly	string

AlertType

tipo de alerta

Nome	Tipo	Description
Budget	string
BudgetForecast	string
Credit	string
General	string
Invoice	string
Quota	string
xCloud	string

Definition

define o tipo de alerta

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

Details

Detalhes do alerta

Nome	Tipo	Description
amount	number	valor do limite de orçamento
companyName	string	nome da empresa
contactEmails	string[]	lista de emails a serem contatados
contactGroups	string[]	lista de grupos de ações para o qual difundir
contactRoles	string[]	lista de funções de contato
currentSpend	number	gastos atuais
departmentName	string	nome do departamento
enrollmentEndDate	string	datetime de enrollmentEndDate
enrollmentNumber	string	número de registro
enrollmentStartDate	string	datetime de enrollmentStartDate
invoicingThreshold	number	limite de faturamento
meterFilter	AlertProperties.details.MeterFilter[]	matriz de medidores para filtrar por
operator	AlertOperator	operador usado para comparar currentSpend com quantidade
overridingAlert	string	alerta de substituição
periodStartDate	string	datetime de periodStartDate
resourceFilter	AlertProperties.details.ResourceFilter[]	matriz de recursos a serem filtrados por
resourceGroupFilter	AlertProperties.details.ResourceGroupFilter[]	matriz de resourceGroups para filtrar por
tagFilter	TagFilter	marcas a serem filtradas por
threshold	number	percentual de limite de notificação como uma decimal que ativou este alerta
timeGrainType	AlertTimeGrainType	Tipo de cadência de timegrain
triggeredBy	string	notificationId que disparou esse alerta
unit	string	unidade de moeda sendo usada

ErrorDetails

Os detalhes do erro.

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

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

TagFilter

marcas a serem filtradas por

Compartilhar via

Alerts - Get

Parâmetros de URI

Respostas

Segurança

azure_auth

Escopos

Exemplos

SingleResourceGroupAlerts

Solicitação de exemplo

Resposta de exemplo

SingleSubscriptionAlerts

Solicitação de exemplo

Resposta de exemplo

Definições

Alert

AlertCategory

AlertCriteria

AlertOperator

AlertSource

AlertStatus

AlertTimeGrainType

AlertType

Definition

Details

ErrorDetails

ErrorResponse

TagFilter

Recursos adicionais