Notification Rule Administration - List Notification Rules

Tjänst:: Azure App Testing

API-version:: 2026-04-01

Få alla notifikationsregler för de angivna filtren.

GET https://{endpoint}/notification-rules?api-version=2026-04-01

Med valfria parametrar:

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
endpoint	path	True	string (uri)
api-version	query	True	string minLength: 1	Den API-version som ska användas för den här åtgärden.
lastModifiedEndTime	query		string (date-time)	End DateTime (RFC 3339 literalformat) för det senast uppdaterade tidsintervallet för att filtrera meddelanderegler.
lastModifiedStartTime	query		string (date-time)	Start DateTime (RFC 3339 literalformat) för det senast uppdaterade tidsintervallet för att filtrera meddelanderegler.
maxpagesize	query		integer (int32)	Antal resultat som svar. Standardsidstorleken är 50.
scopes	query		string	Sök baserat på meddelanderegler för de angivna omfången.
testIds	query		string	Sök baserat på meddelanderegler som är associerade med de angivna test-ID:t.

Svar

Name	Typ	Description
200 OK	PagedNotificationRule	Begäran har slutförts.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Ett oväntat felsvar. Sidhuvuden x-ms-error-code: string

Name

Typ

Description

200 OK

PagedNotificationRule

Begäran har slutförts.

Other Status Codes

Azure.Core.Foundations.ErrorResponse

Ett oväntat felsvar.

Sidhuvuden

x-ms-error-code: string

Säkerhet

Oauth2

OAuth 2.0 Flow med Microsoft Entra-ID.

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Omfattningar

Name	Description
https://cnt-prod.loadtesting.azure.com/.default

Exempel

Get all notification rules for the specified filters.

Exempelbegäran

HTTP

GET https://{endpoint}/notification-rules?api-version=2026-04-01&lastModifiedStartTime=2024-05-01T16:00:46.072Z&lastModifiedEndTime=2024-05-01T16:50:46.072Z&maxpagesize=30

Exempelsvar

Statuskod:: 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"
    }
  ]
}

Definitioner

Name	Description
Azure.Core.Foundations.Error	Felobjektet.
Azure.Core.Foundations.ErrorResponse	Ett svar som innehåller felinformation.
Azure.Core.Foundations.InnerError	Ett objekt som innehåller mer specifik information om felet. Enligt Azure riktlinjer för REST API – https://aka.ms/AzureRestApiGuidelines#handling-errors.
NotificationEventType	Typ av meddelandehändelse.
NotificationScopeType	Omfångstyp för en meddelanderegel.
PagedNotificationRule	Sidad samling av NotificationRule-objekt
PassFailTestResult	Testresultat baserat på villkor för pass/fail.
TestRunEndedEventCondition	Villkor för TestRunEnded-händelse.
TestRunEndedNotificationEventFilter	Filtret för meddelandehändelser när händelsetypen är TestRunEnded och omfånget är Tester.
TestRunStartedNotificationEventFilter	Filtret för meddelandehändelser när händelsetypen är TestRunStarted och omfånget är Tester.
TestRunStatus	Testkörningsstatus.
TestsNotificationRule	Testar regelmodellen för meddelanden.
TriggerCompletedNotificationEventFilter	Filtret för meddelandehändelser när händelsetypen är TriggerCompleted.
TriggerDisabledNotificationEventFilter	Filtret för meddelandehändelser när händelsetypen är TriggerDisabled.

Azure.Core.Foundations.Error

Objekt

Felobjektet.

Name	Typ	Description
code	string	En av en serverdefinierad uppsättning felkoder.
details	Azure.Core.Foundations.Error[]	En matris med information om specifika fel som ledde till det rapporterade felet.
innererror	Azure.Core.Foundations.InnerError	Ett objekt som innehåller mer specifik information än det aktuella objektet om felet.
message	string	En mänsklig läsbar representation av felet.
target	string	Målet för felet.

Azure.Core.Foundations.ErrorResponse

Objekt

Ett svar som innehåller felinformation.

Name	Typ	Description
error	Azure.Core.Foundations.Error	Felobjektet.

Azure.Core.Foundations.InnerError

Objekt

Ett objekt som innehåller mer specifik information om felet. Enligt Azure riktlinjer för REST API – https://aka.ms/AzureRestApiGuidelines#handling-errors.

Name	Typ	Description
code	string	En av en serverdefinierad uppsättning felkoder.
innererror	Azure.Core.Foundations.InnerError	Inre fel.

NotificationEventType

Uppräkning

Typ av meddelandehändelse.

Värde	Description
TestRunEnded	Testkörningen har avslutats händelsen. Den här händelsen inträffar när en testkörning når slutligt tillstånd.
TestRunStarted	Testkörningen har startats av händelsen. Den här händelsen inträffar när en ny testkörning utlöses.
TriggerCompleted	Utlösa slutförd händelse. Den här händelsen inträffar när en utlösare har slutförts.
TriggerDisabled	Utlösa inaktiverad händelse. Den här händelsen inträffar när en utlösare inaktiveras.

NotificationScopeType

Uppräkning

Omfångstyp för en meddelanderegel.

Värde	Description
Tests	Aviseringsregeln är för tester.

PagedNotificationRule

Objekt

Sidad samling av NotificationRule-objekt

Name	Typ	Description
nextLink	string (uri)	Länken till nästa sida med objekt
value	NotificationRule[]: TestsNotificationRule[]	NotificationRule-objekten på den här sidan

PassFailTestResult

Uppräkning

Testresultat baserat på villkor för pass/fail.

Värde	Description
PASSED	Villkor för pass/fail har godkänts.
NOT_APPLICABLE	Villkor för pass/fail är inte tillämpligt.
FAILED	Villkoret för pass/fail misslyckades.

TestRunEndedEventCondition

Objekt

Villkor för TestRunEnded-händelse.

Name	Typ	Description
testRunResults	PassFailTestResult[]	Testkörningsresultaten som ska skickas ett meddelande om.
testRunStatuses	TestRunStatus[]	Testkörningsstatusarna som ska skickas ett meddelande om.

TestRunEndedNotificationEventFilter

Objekt

Filtret för meddelandehändelser när händelsetypen är TestRunEnded och omfånget är Tester.

Name	Typ	Description
condition	TestRunEndedEventCondition	Villkor för händelsefiltrering.
kind	string: TestRunEnded	Typ av händelse

TestRunStartedNotificationEventFilter

Objekt

Filtret för meddelandehändelser när händelsetypen är TestRunStarted och omfånget är Tester.

Name	Typ	Description
kind	string: TestRunStarted	Typ av händelse

TestRunStatus

Uppräkning

Testkörningsstatus.

Värde	Description
ACCEPTED	Testkörningsbegäran godkänns.
NOTSTARTED	Testkörningen har inte startats ännu.
PROVISIONING	Testkörningen etableras.
PROVISIONED	Testkörningen etableras.
CONFIGURING	Testkörningen konfigureras.
CONFIGURED	Testkörningskonfigurationen är klar.
EXECUTING	Testkörningen har börjat köras.
EXECUTED	Testkörningen har slutförts.
DEPROVISIONING	Testkörningen avetableras.
DEPROVISIONED	Testkörningen avetableras.
DONE	Testkörningen har slutförts.
CANCELLING	Testkörningen avbryts.
CANCELLED	Testkörningsbegäran avbryts.
FAILED	Testkörningsbegäran misslyckades.
VALIDATION_SUCCESS	JMX-filen för testkörning verifieras.
VALIDATION_FAILURE	Testkörningen av JMX-filverifieringen misslyckades.

TestsNotificationRule

Objekt

Testar regelmodellen för meddelanden.

Name	Typ	Description
actionGroupIds	string[]	De åtgärdsgrupper som ska meddelas.
createdBy	string	Användaren som skapade.
createdDateTime	string (date-time)	Skapandedatumtid (RFC 3339-literalformat).
displayName	string minLength: 2 maxLength: 50	Namnet på meddelanderegeln.
eventFilters	object	Händelsen som du vill ta emot meddelanden för tillsammans med filtreringsvillkor. Nyckel är en användartilldelad identifierare för händelsefiltret.
lastModifiedBy	string	Användaren som senast ändrades.
lastModifiedDateTime	string (date-time)	Den senast ändrade datetime(RFC 3339 literal format).
notificationRuleId	string minLength: 2 maxLength: 50 pattern: ^[a-z0-9_-]*$	Den unika identifieraren för meddelanderegeln.
scope	string: Tests	Omfånget för meddelanderegeln.
testIds	string[]	Test-ID:t som ska inkluderas. Om det inte anges skickas ett meddelande för alla testIds.

TriggerCompletedNotificationEventFilter

Objekt

Filtret för meddelandehändelser när händelsetypen är TriggerCompleted.

Name	Typ	Description
kind	string: TriggerCompleted	Typ av händelse

TriggerDisabledNotificationEventFilter

Objekt

Filtret för meddelandehändelser när händelsetypen är TriggerDisabled.

Name	Typ	Description
kind	string: TriggerDisabled	Typ av händelse