Notification Rule Administration - List Notification Rule

Servizio:: Azure App Testing

Versione API:: 2025-03-01-preview

Modello di operazione dell'elenco di risorse.

GET https://{endpoint}/notification-rules?api-version=2025-03-01-preview

Con parametri facoltativi:

GET https://{endpoint}/notification-rules?api-version=2025-03-01-preview&testIds={testIds}&scopes={scopes}&lastModifiedStartTime={lastModifiedStartTime}&lastModifiedEndTime={lastModifiedEndTime}&maxpagesize={maxpagesize}

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
endpoint	path	True	string
api-version	query	True	string minLength: 1	La versione dell'API da utilizzare per questa operazione.
lastModifiedEndTime	query		string (date-time)	Fine DateTime (formato letterale RFC 3339) dell'intervallo di tempo dell'ultimo aggiornamento per filtrare le regole di notifica.
lastModifiedStartTime	query		string (date-time)	Start DateTime (formato letterale RFC 3339) dell'intervallo di tempo dell'ultimo aggiornamento per filtrare le regole di notifica.
maxpagesize	query		integer (int32)	Numero di risultati in risposta. La dimensione predefinita della pagina è 50.
scopes	query		string	Ricerca in base alle regole di notifica per gli ambiti forniti.
testIds	query		string	Ricerca in base alle regole di notifica associate agli ID di test forniti.

Risposte

Nome	Tipo	Descrizione
200 OK	PagedNotificationRule	La richiesta è andata a buon fine.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Risposta di errore imprevista. Intestazioni x-ms-error-code: string

Nome

Tipo

Descrizione

200 OK

PagedNotificationRule

La richiesta è andata a buon fine.

Other Status Codes

Azure.Core.Foundations.ErrorResponse

Risposta di errore imprevista.

Intestazioni

x-ms-error-code: string

Sicurezza

Oauth2

Flusso OAuth 2.0 con MICROSOFT Entra ID.

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Ambiti

Nome	Descrizione
https://cnt-prod.loadtesting.azure.com/.default

Esempio

Get all notification rules for the specified filters.

Esempio di richiesta

HTTP

GET https://{endpoint}/notification-rules?api-version=2025-03-01-preview&lastModifiedStartTime=2024-05-01T16:00:46.072Z&lastModifiedEndTime=2024-05-01T16:50:46.072Z

Risposta di esempio

Codice di stato:: 200

{
  "value": [
    {
      "notificationRuleId": "12345678-1234-1234-1234-123456789012",
      "displayName": "Sample_Notification_Rule1",
      "actionGroupIds": [
        "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/sampleRG/providers/microsoft.insights/actionGroups/sampleActionGroup1",
        "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/sampleRG/providers/microsoft.insights/actionGroups/sampleActionGroup2"
      ],
      "scope": "Tests",
      "testIds": [
        "12345678-1234-1234-1234-123456789012",
        "12345678-1234-1234-1234-123456789013"
      ],
      "eventFilters": {
        "eventfilter1": {
          "kind": "TestRunEnded",
          "condition": {
            "testRunStatuses": [
              "FAILED",
              "DONE"
            ],
            "testRunResults": [
              "PASSED",
              "FAILED"
            ]
          }
        },
        "eventfilter2": {
          "kind": "TestRunStarted"
        },
        "eventfilter3": {
          "kind": "TriggerCompleted"
        },
        "eventfilter4": {
          "kind": "TriggerDisabled"
        }
      },
      "createdDateTime": "2024-05-01T16:43:46.072Z",
      "createdBy": "user@contoso.com",
      "lastModifiedDateTime": "2024-05-01T16:43:46.072Z",
      "lastModifiedBy": "user@contoso.com"
    },
    {
      "notificationRuleId": "12345678-1234-1234-1234-123456789013",
      "displayName": "Sample_Notification_Rule2",
      "actionGroupIds": [
        "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/sampleRG/providers/microsoft.insights/actionGroups/sampleActionGroup2"
      ],
      "scope": "Tests",
      "testIds": [
        "12345678-1234-1234-1234-123456789012"
      ],
      "eventFilters": {
        "eventfilter1": {
          "kind": "TestRunEnded",
          "condition": {
            "testRunStatuses": [
              "FAILED"
            ],
            "testRunResults": [
              "FAILED"
            ]
          }
        }
      },
      "createdDateTime": "2024-05-01T16:43:46.072Z",
      "createdBy": "user@contoso.com",
      "lastModifiedDateTime": "2024-05-01T16:43:46.072Z",
      "lastModifiedBy": "user@contoso.com"
    }
  ]
}

Definizioni

Nome	Descrizione
Azure.Core.Foundations.Error	L'oggetto errore.
Azure.Core.Foundations.ErrorResponse	Una risposta contenente i dettagli dell'errore.
Azure.Core.Foundations.InnerError	Oggetto contenente informazioni più specifiche sull'errore. In base alle linee guida dell'API REST di Azure - https://aka.ms/AzureRestApiGuidelines#handling-errors.
NotificationEventType	Tipo di evento di notifica.
NotificationScopeType	Tipo di ambito di una regola di notifica.
PagedNotificationRule	Raccolta di paging di elementi NotificationRule
PassFailTestResult	Risultato del test basato su criteri di superamento/non superamento.
TestRunEndedEventCondition	Condizione dell'evento TestRunEnded.
TestRunEndedNotificationEventFilter	Il filtro degli eventi di notifica quando il tipo di evento è TestRunEnded e l'ambito è Tests.
TestRunStartedNotificationEventFilter	Il filtro degli eventi di notifica quando il tipo di evento è TestRunStarted e l'ambito è Test.
TestRunStatus	Stato di esecuzione dei test.
TestsNotificationRule	Test del modello di regola di notifica.
TriggerCompletedNotificationEventFilter	Filtro degli eventi di notifica quando il tipo di evento è TriggerCompleted.
TriggerDisabledNotificationEventFilter	Filtro degli eventi di notifica quando il tipo di evento è TriggerDisabled.

Azure.Core.Foundations.Error

Object

L'oggetto errore.

Nome	Tipo	Descrizione
code	string	Uno di un set di codici di errore definito dal server.
details	Azure.Core.Foundations.Error[]	Una serie di dettagli su errori specifici che hanno portato a questo errore segnalato.
innererror	Azure.Core.Foundations.InnerError	Oggetto contenente informazioni più specifiche rispetto all'oggetto corrente sull'errore.
message	string	Una rappresentazione leggibile dell'errore.
target	string	Destinazione dell'errore.

Azure.Core.Foundations.ErrorResponse

Object

Una risposta contenente i dettagli dell'errore.

Nome	Tipo	Descrizione
error	Azure.Core.Foundations.Error	L'oggetto errore.

Azure.Core.Foundations.InnerError

Object

Oggetto contenente informazioni più specifiche sull'errore. In base alle linee guida dell'API REST di Azure - https://aka.ms/AzureRestApiGuidelines#handling-errors.

Nome	Tipo	Descrizione
code	string	Uno di un set di codici di errore definito dal server.
innererror	Azure.Core.Foundations.InnerError	Errore interiore.

NotificationEventType

Enumerazione

Tipo di evento di notifica.

Valore	Descrizione
TestRunEnded	Evento di test terminato. Questo evento si verifica quando un'esecuzione dei test raggiunge lo stato terminale.
TestRunStarted	Evento di esecuzione del test avviata. Questo evento si verifica quando viene attivata una nuova esecuzione dei test.
TriggerCompleted	Attiva l'evento completato. Questo evento si verifica al completamento di un trigger.
TriggerDisabled	Attiva l'evento disabilitato. Questo evento si verifica quando un trigger è disabilitato.

NotificationScopeType

Enumerazione

Tipo di ambito di una regola di notifica.

Valore	Descrizione
Tests	La regola di notifica è per i test.

PagedNotificationRule

Object

Raccolta di paging di elementi NotificationRule

Nome	Tipo	Descrizione
nextLink	string (uri)	Il link alla pagina successiva degli elementi
value	NotificationRule[]: TestsNotificationRule[]	Elementi NotificationRule in questa pagina

PassFailTestResult

Enumerazione

Risultato del test basato su criteri di superamento/non superamento.

Valore	Descrizione
PASSED	I criteri di superamento/rifiuto sono stati superati.
NOT_APPLICABLE	I criteri di accettazione/rifiuto non sono applicabili.
FAILED	I criteri di accettazione/rifiuto non sono riusciti.

TestRunEndedEventCondition

Object

Condizione dell'evento TestRunEnded.

Nome	Tipo	Descrizione
testRunResults	PassFailTestResult[]	Risultati dell'esecuzione dei test per i quali inviare la notifica.
testRunStatuses	TestRunStatus[]	Gli stati di esecuzione dei test per i quali inviare la notifica.

TestRunEndedNotificationEventFilter

Object

Il filtro degli eventi di notifica quando il tipo di evento è TestRunEnded e l'ambito è Tests.

Nome	Tipo	Descrizione
condition	TestRunEndedEventCondition	Condizione di filtraggio degli eventi.
kind	string: TestRunEnded	Il tipo di evento

TestRunStartedNotificationEventFilter

Object

Il filtro degli eventi di notifica quando il tipo di evento è TestRunStarted e l'ambito è Test.

Nome	Tipo	Descrizione
kind	string: TestRunStarted	Il tipo di evento

TestRunStatus

Enumerazione

Stato di esecuzione dei test.

Valore	Descrizione
ACCEPTED	La richiesta di esecuzione dei test viene accettata.
NOTSTARTED	L'esecuzione del test non è ancora iniziata.
PROVISIONING	L'esecuzione dei test è in fase di provisioning.
PROVISIONED	Viene effettuato il provisioning dell'esecuzione dei test.
CONFIGURING	L'esecuzione del test è in fase di configurazione.
CONFIGURED	La configurazione dell'esecuzione dei test è stata completata.
EXECUTING	L'esecuzione del test è stata avviata.
EXECUTED	L'esecuzione dei test è stata completata.
DEPROVISIONING	È in corso il deprovisioning dell'esecuzione dei test.
DEPROVISIONED	L'esecuzione dei test è stata sottoposta a deprovisioning.
DONE	L'esecuzione del test è stata completata.
CANCELLING	L'esecuzione del test è stata annullata.
CANCELLED	La richiesta di esecuzione dei test viene annullata.
FAILED	La richiesta di esecuzione dei test non è riuscita.
VALIDATION_SUCCESS	Il file JMX eseguito dal test è convalidato.
VALIDATION_FAILURE	La convalida del file JMX non è riuscita.

TestsNotificationRule

Object

Test del modello di regola di notifica.

Nome	Tipo	Descrizione
actionGroupIds	string[]	I gruppi di azione da notificare.
createdBy	string	Utente che ha creato.
createdDateTime	string (date-time)	Data/ora di creazione(formato letterale RFC 3339).
displayName	string minLength: 2 maxLength: 50	Nome della regola di notifica.
eventFilters	object	L'evento per cui ricevere le notifiche insieme alle condizioni di filtraggio. Key è un identificatore assegnato dall'utente per il filtro eventi.
lastModifiedBy	string	L'utente che ha modificato l'ultima volta.
lastModifiedDateTime	string (date-time)	Ultimo formato letterale modificato datetime(RFC 3339).
notificationRuleId	string minLength: 2 maxLength: 50 pattern: ^[a-z0-9_-]*$	Identificatore univoco della regola di notifica.
scope	string: Tests	Ambito della regola di notifica.
testIds	string[]	Gli ID del test da includere. Se non viene fornito, verrà inviata una notifica per tutti i testID.

TriggerCompletedNotificationEventFilter

Object

Filtro degli eventi di notifica quando il tipo di evento è TriggerCompleted.

Nome	Tipo	Descrizione
kind	string: TriggerCompleted	Il tipo di evento

TriggerDisabledNotificationEventFilter

Object

Filtro degli eventi di notifica quando il tipo di evento è TriggerDisabled.

Nome	Tipo	Descrizione
kind	string: TriggerDisabled	Il tipo di evento

Condividi tramite

Notification Rule Administration - List Notification Rule

Parametri dell'URI

Risposte

Sicurezza

Oauth2

Ambiti

Esempio

Get all notification rules for the specified filters.

Esempio di richiesta

Risposta di esempio

Definizioni

Azure.Core.Foundations.Error

Azure.Core.Foundations.ErrorResponse

Azure.Core.Foundations.InnerError

NotificationEventType

NotificationScopeType

PagedNotificationRule

PassFailTestResult

TestRunEndedEventCondition

TestRunEndedNotificationEventFilter

TestRunStartedNotificationEventFilter

TestRunStatus

TestsNotificationRule

TriggerCompletedNotificationEventFilter

TriggerDisabledNotificationEventFilter