Notification Recipient Email - List By Notification

Dienst:

API Management

API-Version:

2024-05-01

Ruft die Liste der Benachrichtigungsempfänger-E-Mails ab, die eine Benachrichtigung abonniert haben.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/notifications/{notificationName}/recipientEmails?api-version=2024-05-01

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
notificationName	path	True	NotificationName	Benachrichtigungsname-ID.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Der Name des API-Verwaltungsdiensts.
subscriptionId	path	True	string (uuid)	Die ID des Zielabonnements. Der Wert muss eine UUID sein.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

Antworten

Name	Typ	Beschreibung
200 OK	RecipientEmailCollection	Der Antworttext enthält die Empfänger-E-Mail-Sammlung, die die Benachrichtigung abonniert hat.
Other Status Codes	ErrorResponse	Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

ApiManagementListNotificationRecipientEmails

Beispielanforderung

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/RequestPublisherNotificationMessage/recipientEmails?api-version=2024-05-01

Beispiel für eine Antwort

Statuscode:

200

{
  "value": [
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/RequestPublisherNotificationMessage/recipientEmails/contoso@live.com",
      "type": "Microsoft.ApiManagement/service/notifications/recipientEmails",
      "name": "contoso@live.com",
      "properties": {
        "email": "contoso@live.com"
      }
    },
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/RequestPublisherNotificationMessage/recipientEmails/foobar!live",
      "type": "Microsoft.ApiManagement/service/notifications/recipientEmails",
      "name": "foobar!live",
      "properties": {
        "email": "foobar!live"
      }
    },
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/RequestPublisherNotificationMessage/recipientEmails/foobar@live.com",
      "type": "Microsoft.ApiManagement/service/notifications/recipientEmails",
      "name": "foobar@live.com",
      "properties": {
        "email": "foobar@live.com"
      }
    }
  ],
  "count": 3,
  "nextLink": ""
}

Definitionen

Name	Beschreibung
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
NotificationName	Benachrichtigungsname-ID.
RecipientEmailCollection	Paged Recipient User list representation.
RecipientEmailContract	E-Mail-Details des Empfängers.

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Objekt

Das Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Objekt

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

NotificationName

Enumeration

Benachrichtigungsname-ID.

Wert	Beschreibung
AccountClosedPublisher	Die folgenden E-Mail-Empfänger und Benutzer erhalten E-Mail-Benachrichtigungen, wenn Der Entwickler sein Konto schließt.
BCC	Die folgenden Empfänger erhalten blinde Kopien aller E-Mails, die an Entwickler gesendet werden.
NewApplicationNotificationMessage	Die folgenden E-Mail-Empfänger und Benutzer erhalten E-Mail-Benachrichtigungen, wenn neue Anwendungen an den Anwendungskatalog übermittelt werden.
NewIssuePublisherNotificationMessage	Die folgenden E-Mail-Empfänger und Benutzer erhalten E-Mail-Benachrichtigungen, wenn ein neues Problem oder ein neuer Kommentar im Entwicklerportal übermittelt wird.
PurchasePublisherNotificationMessage	Die folgenden E-Mail-Empfänger und Benutzer erhalten E-Mail-Benachrichtigungen zu neuen API-Produktabonnements.
QuotaLimitApproachingPublisherNotificationMessage	Die folgenden E-Mail-Empfänger und Benutzer erhalten E-Mail-Benachrichtigungen, wenn die Abonnementnutzung in der Nähe des Nutzungskontingents liegt.
RequestPublisherNotificationMessage	Die folgenden E-Mail-Empfänger und Benutzer erhalten E-Mail-Benachrichtigungen zu Abonnementanforderungen für API-Produkte, die eine Genehmigung erfordern.

RecipientEmailCollection

Objekt

Paged Recipient User list representation.

Name	Typ	Beschreibung
count	integer (int64)	Gesamtzahl der Datensätze auf allen Seiten.
nextLink	string	Link zur nächsten Seite, falls vorhanden.
value	RecipientEmailContract[]	Seitenwerte.

RecipientEmailContract

Objekt

E-Mail-Details des Empfängers.

Name	Typ	Beschreibung
id	string	Vollqualifizierte Ressourcen-ID für die Ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Der Name der Ressource
properties.email	string	Benutzer-E-Mail abonniert Benachrichtigung.
type	string	Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"