Alerts - Get

Referencia

Service:: Cost Management

API Version:: 2023-11-01

Obtiene la alerta para el ámbito por identificador de alerta.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
alertId	path	True	string	Id. de alerta
scope	path	True	string	Ámbito asociado a las operaciones de alertas. Esto incluye "/subscriptions/{subscriptionId}/" para el ámbito de la suscripción, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' para el ámbito resourceGroup, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' para el ámbito de la cuenta de facturación y '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' para el ámbito del departamento, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{ enrollmentAccountId}' para el ámbito EnrollmentAccount, '/providers/Microsoft.Management/managementGroups/{managementGroupId} para el ámbito del grupo de administración, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' para el ámbito billingProfile, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/invoiceSections/{invoiceSectionId}' para el ámbito invoiceSection y '/providers/Microsoft. Billing/billingAccounts/{billingAccountId}/customers/{customerId}' específico para los partners.
api-version	query	True	string	Versión de API que se usará para la operación.

Respuestas

Nombre	Tipo	Description
200 OK	Alert	Aceptar. La solicitud se ha realizado correctamente.
Other Status Codes	ErrorResponse	Respuesta de error que describe el motivo del error de la operación.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nombre	Description
user_impersonation	suplantación de su cuenta de usuario

Ejemplos

SingleResourceGroupAlerts

SingleSubscriptionAlerts

SingleResourceGroupAlerts

Sample Request

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=2023-11-01

Sample Response

Status code:: 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

Sample Request

HTTP

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

Sample Response

Status code:: 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"
  }
}

Definiciones

Nombre	Description
Alert	Una alerta individual.
AlertCategory	Categoría de alertas
AlertCriteria	Criterios que desencadenaron la alerta
AlertOperator	operador usado para comparar currentSpend con la cantidad
AlertSource	Origen de la alerta
AlertStatus	estado de alerta
AlertTimeGrainType	Tipo de cadencia de tiempo
AlertType	tipo de alerta
Definition	define el tipo de alerta
Details	Detalles de alertas
ErrorDetails	Detalles del error.
ErrorResponse	La respuesta de error indica que el servicio no puede procesar la solicitud entrante. El motivo se proporciona en el mensaje de error. Algunas respuestas de error: 429 TooManyRequests: la solicitud está limitada. Vuelva a intentarlo después de esperar el tiempo especificado en el encabezado "x-ms-ratelimit-microsoft.consumption-retry-after". 503 ServiceUnavailable: el servicio no está disponible temporalmente. Vuelva a intentarlo después de esperar el tiempo especificado en el encabezado "Vuelva a intentarlo después de".
TagFilter	etiquetas que se van a filtrar por

Alert

Una alerta individual.

Nombre	Tipo	Description
eTag	string	eTag del recurso. Para controlar el escenario de actualización simultánea, este campo se usará para determinar si el usuario está actualizando la versión más reciente o no.
id	string	Id. de recurso.
name	string	Nombre del recurso.
properties.closeTime	string	dateTime en el que se cerró la alerta
properties.costEntityId	string	presupuesto relacionado
properties.creationTime	string	dateTime en el que se creó la alerta
properties.definition	Definition	define el tipo de alerta
properties.description	string	Descripción de alerta
properties.details	Details	Detalles de alertas
properties.modificationTime	string	dateTime en el que se modificó por última vez la alerta
properties.source	AlertSource	Origen de la alerta
properties.status	AlertStatus	estado de alerta
properties.statusModificationTime	string	dateTime en el que se modificó por última vez el estado de la alerta
properties.statusModificationUserName	string	Usuario que modificó por última vez la alerta
type	string	Tipo de recurso.

AlertCategory

Categoría de alertas

Nombre	Tipo	Description
Billing	string
Cost	string
System	string
Usage	string

AlertCriteria

Criterios que desencadenaron la alerta

Nombre	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 con la cantidad

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

AlertSource

Origen de la alerta

Nombre	Tipo	Description
Preset	string
User	string

AlertStatus

estado de alerta

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

AlertTimeGrainType

Tipo de cadencia de tiempo

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

AlertType

tipo de alerta

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

Definition

define el tipo de alerta

Nombre	Tipo	Description
category	AlertCategory	Categoría de alertas
criteria	AlertCriteria	Criterios que desencadenaron la alerta
type	AlertType	tipo de alerta

Details

Detalles de alertas

Nombre	Tipo	Description
amount	number	importe del umbral presupuestado
companyName	string	Nombre de la empresa
contactEmails	string[]	lista de correos electrónicos para ponerse en contacto
contactGroups	string[]	lista de grupos de acciones a los que se va a difundir
contactRoles	string[]	lista de roles de contacto
currentSpend	number	gasto actual
departmentName	string	nombre del departamento
enrollmentEndDate	string	datetime de enrollmentEndDate
enrollmentNumber	string	número de inscripción
enrollmentStartDate	string	datetime de enrollmentStartDate
invoicingThreshold	number	umbral de facturación
meterFilter	AlertProperties.details.MeterFilter[]	matriz de medidores que se van a filtrar por
operator	AlertOperator	operador usado para comparar currentSpend con la cantidad
overridingAlert	string	invalidación de alertas
periodStartDate	string	datetime de periodStartDate
resourceFilter	AlertProperties.details.ResourceFilter[]	matriz de recursos que se van a filtrar por
resourceGroupFilter	AlertProperties.details.ResourceGroupFilter[]	matriz de resourceGroups por la que se va a filtrar
tagFilter	TagFilter	etiquetas que se van a filtrar por
threshold	number	porcentaje de umbral de notificación como decimal que activó esta alerta
timeGrainType	AlertTimeGrainType	Tipo de cadencia de tiempo
triggeredBy	string	notificationId que desencadenó esta alerta
unit	string	unidad de moneda que se usa

ErrorDetails

Detalles del error.

Nombre	Tipo	Description
code	string	Código de error.
message	string	Mensaje de error que indica por qué se produjo un error en la operación.

ErrorResponse

La respuesta de error indica que el servicio no puede procesar la solicitud entrante. El motivo se proporciona en el mensaje de error.

Algunas respuestas de error:

429 TooManyRequests: la solicitud está limitada. Vuelva a intentarlo después de esperar el tiempo especificado en el encabezado "x-ms-ratelimit-microsoft.consumption-retry-after".
503 ServiceUnavailable: el servicio no está disponible temporalmente. Vuelva a intentarlo después de esperar el tiempo especificado en el encabezado "Vuelva a intentarlo después de".

Nombre	Tipo	Description
error	ErrorDetails	Detalles del error.

TagFilter

etiquetas que se van a filtrar por

Compartir a través de

Alerts - Get

Parámetros de identificador URI

Respuestas

Seguridad

azure_auth

Scopes

Ejemplos

SingleResourceGroupAlerts

Sample Request

Sample Response

SingleSubscriptionAlerts

Sample Request

Sample Response

Definiciones

Alert

AlertCategory

AlertCriteria

AlertOperator

AlertSource

AlertStatus

AlertTimeGrainType

AlertType

Definition

Details

ErrorDetails

ErrorResponse

TagFilter

Recursos adicionales