Alerts - List External

Referência

Service:: Cost Management

API Version:: 2023-11-01

Listas definido o tipo alertas para fornecedores de cloud externos.

GET https://management.azure.com/providers/Microsoft.CostManagement/{externalCloudProviderType}/{externalCloudProviderId}/alerts?api-version=2023-11-01

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
externalCloudProviderId	path	True	string	Pode ser "{externalSubscriptionId}" para a conta associada ou "{externalBillingAccountId}" para a conta consolidada utilizada com operações de dimensão/consulta.
externalCloudProviderType	path	True	externalCloudProviderType	O tipo de fornecedor de cloud externo associado às operações de dimensão/consulta. Isto inclui "externalSubscriptions" para a conta associada e "externalBillingAccounts" para a conta consolidada.
api-version	query	True	string	A versão da API a utilizar para esta operação.

Respostas

Name	Tipo	Description
200 OK	AlertsResult	OK. O pedido foi efetuada com êxito.
Other Status Codes	ErrorResponse	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

ExternalBillingAccountAlerts

ExternalSubscriptionAlerts

ExternalBillingAccountAlerts

Sample Request

HTTP

GET https://management.azure.com/providers/Microsoft.CostManagement/externalBillingAccounts/100/alerts?api-version=2023-11-01

Sample Response

Status code:: 200

{
  "value": [
    {
      "id": "providers/Microsoft.CostManagement/externalBillingAccounts/100/providers/Microsoft.CostManagement/alerts/00000000-0000-0000-0000-000000000000",
      "name": "00000000-0000-0000-0000-000000000000",
      "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": "00000000-0000-0000-0000-000000000000_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"
      }
    },
    {
      "id": "providers/Microsoft.CostManagement/externalBillingAccounts/100/providers/Microsoft.CostManagement/alerts/11111111-1111-1111-111111111111",
      "name": "11111111-1111-1111-111111111111",
      "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": "11111111-1111-1111-111111111111_1_01",
          "resourceGroupFilter": [],
          "resourceFilter": [],
          "meterFilter": [],
          "tagFilter": {},
          "threshold": 0.8,
          "operator": "GreaterThan",
          "amount": 200000,
          "unit": "USD",
          "currentSpend": 171000.32,
          "contactEmails": [
            "1234@contoso.com"
          ],
          "contactGroups": [],
          "contactRoles": [],
          "overridingAlert": null
        },
        "costEntityId": "budget1",
        "status": "Active",
        "creationTime": "2019-06-24T05:51:52.8713179Z",
        "closeTime": "0001-01-01T00:00:00",
        "modificationTime": "2019-08-31T17:51:55.1808807Z",
        "statusModificationUserName": null,
        "statusModificationTime": "0001-01-01T00:00:00"
      }
    }
  ],
  "nextLink": null
}

ExternalSubscriptionAlerts

Sample Request

HTTP

GET https://management.azure.com/providers/Microsoft.CostManagement/externalSubscriptions/100/alerts?api-version=2023-11-01

Sample Response

Status code:: 200

{
  "value": [
    {
      "id": "providers/Microsoft.CostManagement/externalSubscriptions/100/providers/Microsoft.CostManagement/alerts/00000000-0000-0000-0000-000000000000",
      "name": "00000000-0000-0000-0000-000000000000",
      "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": "00000000-0000-0000-0000-000000000000_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"
      }
    },
    {
      "id": "providers/Microsoft.CostManagement/externalSubscriptions/100/providers/Microsoft.CostManagement/alerts/11111111-1111-1111-111111111111",
      "name": "11111111-1111-1111-111111111111",
      "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": "11111111-1111-1111-111111111111_1_01",
          "resourceGroupFilter": [],
          "resourceFilter": [],
          "meterFilter": [],
          "tagFilter": {},
          "threshold": 0.8,
          "operator": "GreaterThan",
          "amount": 200000,
          "unit": "USD",
          "currentSpend": 171000.32,
          "contactEmails": [
            "1234@contoso.com"
          ],
          "contactGroups": [],
          "contactRoles": [],
          "overridingAlert": null
        },
        "costEntityId": "budget1",
        "status": "Active",
        "creationTime": "2019-06-24T05:51:52.8713179Z",
        "closeTime": "0001-01-01T00:00:00",
        "modificationTime": "2019-08-31T17:51:55.1808807Z",
        "statusModificationUserName": null,
        "statusModificationTime": "0001-01-01T00:00:00"
      }
    }
  ],
  "nextLink": null
}

Definições

Name	Description
Alert	Um alerta individual.
AlertCategory	Categoria do alerta
AlertCriteria	Critérios que acionaram o alerta
AlertOperator	operador utilizado para comparar currentSpend com o montante
AlertSource	Origem do alerta
AlertsResult	Resultado de alertas.
AlertStatus	estado 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 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”.
externalCloudProviderType	O tipo de fornecedor de cloud externo associado às operações de dimensão/consulta. Isto inclui "externalSubscriptions" para a conta associada e "externalBillingAccounts" para a conta consolidada.
TagFilter	etiquetas a filtrar por

Alert

Um alerta individual.

Name	Tipo	Description
eTag	string	eTag do recurso. Para lidar com o cenário de atualização simultânea, este campo será utilizado para determinar se o utilizador está ou não a atualizar a versão mais recente.
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 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	Origem do alerta
properties.status	AlertStatus	estado do alerta
properties.statusModificationTime	string	dateTime em que o estado do alerta foi modificado pela última vez
properties.statusModificationUserName	string	Utilizador que modificou o alerta pela última vez
type	string	Tipo de recurso.

AlertCategory

Categoria do alerta

Name	Tipo	Description
Billing	string
Cost	string
System	string
Usage	string

AlertCriteria

Critérios que acionaram o alerta

Name	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 utilizado para comparar currentSpend com o montante

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

AlertSource

Origem do alerta

Name	Tipo	Description
Preset	string
User	string

AlertsResult

Resultado de alertas.

Name	Tipo	Description
nextLink	string	URL para obter o próximo conjunto de resultados de alertas, se existirem.
value	Alert[]	Lista de alertas.

AlertStatus

estado do alerta

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

AlertTimeGrainType

Tipo de cadência de timegrain

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

AlertType

tipo de alerta

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

Definition

define o tipo de alerta

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

Details

Detalhes do alerta

Name	Tipo	Description
amount	number	montante do limiar do orçamento
companyName	string	nome da empresa
contactEmails	string[]	lista de e-mails a contactar
contactGroups	string[]	lista de grupos de ações a difundir para
contactRoles	string[]	lista de funções de contacto
currentSpend	number	gastos atuais
departmentName	string	nome do departamento
enrollmentEndDate	string	datetime of enrollmentEndDate
enrollmentNumber	string	número de inscrição
enrollmentStartDate	string	datetime de enrollmentStartDate
invoicingThreshold	number	limiar de faturação
meterFilter	AlertProperties.details.MeterFilter[]	matriz de medidores a filtrar por
operator	AlertOperator	operador utilizado para comparar currentSpend com o montante
overridingAlert	string	alerta de substituição
periodStartDate	string	datetime of periodStartDate
resourceFilter	AlertProperties.details.ResourceFilter[]	matriz de recursos a filtrar por
resourceGroupFilter	AlertProperties.details.ResourceGroupFilter[]	matriz de resourceGroups para filtrar por
tagFilter	TagFilter	etiquetas a filtrar por
threshold	number	percentagem do limiar de notificação como um decimal que ativou este alerta
timeGrainType	AlertTimeGrainType	Tipo de cadência de timegrain
triggeredBy	string	notificationId que acionou este alerta
unit	string	unidade de moeda a ser utilizada

ErrorDetails

Os detalhes do erro.

Name	Tipo	Description
code	string	Código de erro.
message	string	Mensagem de erro a indicar o motivo pela qual a operação falhou.

ErrorResponse

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

externalCloudProviderType

O tipo de fornecedor de cloud externo associado às operações de dimensão/consulta. Isto inclui "externalSubscriptions" para a conta associada e "externalBillingAccounts" para a conta consolidada.

Name	Tipo	Description
externalBillingAccounts	string
externalSubscriptions	string

TagFilter

etiquetas a filtrar por

Share via

Alerts - List External

Parâmetros do URI

Respostas

Segurança

azure_auth

Scopes

Exemplos

ExternalBillingAccountAlerts

Sample Request

Sample Response

ExternalSubscriptionAlerts

Sample Request

Sample Response

Definições

Alert

AlertCategory

AlertCriteria

AlertOperator

AlertSource

AlertsResult

AlertStatus

AlertTimeGrainType

AlertType

Definition

Details

ErrorDetails

ErrorResponse

externalCloudProviderType

TagFilter

Recursos adicionais