Notification - Create Or Update

Erstellt oder aktualisiert eine API Management-Benachrichtigung für Herausgeber

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/notifications/{notificationName}?api-version=2021-08-01

URI-Parameter

Name In Erforderlich Typ Beschreibung
notificationName
path True

NotificationName

Benachrichtigungsname-Id.

resourceGroupName
path True

string

Der Name der Ressourcengruppe.

serviceName
path True

string

Der Name des API Management-Diensts.

RegEx-Muster: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
path True

string

Abonnementanmeldeinformationen, die das Microsoft Azure-Abonnement eindeutig identifizieren. Die Abonnement-ID ist Teil des URI für jeden Dienstaufruf.

api-version
query True

string

Version der API, die mit der Clientanforderung verwendet werden soll.

Anforderungsheader

Name Erforderlich Typ Beschreibung
If-Match

string

ETag der Entität. Beim Erstellen einer Entität nicht erforderlich, aber beim Aktualisieren einer Entität erforderlich.

Antworten

Name Typ Beschreibung
200 OK

NotificationContract

Die Benachrichtigung wurde erfolgreich aktualisiert.

Other Status Codes

ErrorResponse

Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Sicherheit

azure_auth

Azure Active Directory OAuth2 Flow.

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

Bereiche

Name Beschreibung
user_impersonation Identitätswechsel Ihres Benutzerkontos

Beispiele

ApiManagementCreateNotification

Beispielanforderung

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/RequestPublisherNotificationMessage?api-version=2021-08-01

Beispiel für eine Antwort

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/RequestPublisherNotificationMessage",
  "type": "Microsoft.ApiManagement/service/notifications",
  "name": "RequestPublisherNotificationMessage",
  "properties": {
    "title": "Subscription requests (requiring approval)",
    "description": "The following email recipients and users will receive email notifications about subscription requests for API products requiring approval.",
    "recipients": {
      "emails": [
        "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/recipientEmails/contoso@live.com",
        "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/recipientEmails/foobar!live",
        "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/recipientEmails/foobar@live.com"
      ],
      "users": [
        "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/576823d0a40f7e74ec07d642"
      ]
    }
  }
}

Definitionen

Name Beschreibung
ErrorFieldContract

Fehlerfeldvertrag.

ErrorResponse

Fehlerantwort.

NotificationContract

Benachrichtigungsdetails.

NotificationName

Benachrichtigungsname-Id.

RecipientsContractProperties

Benachrichtigungsparametervertrag.

ErrorFieldContract

Fehlerfeldvertrag.

Name Typ Beschreibung
code

string

Fehlercode auf Eigenschaftsebene.

message

string

Für Menschen lesbare Darstellung eines Fehlers auf Eigenschaftsebene.

target

string

Der Eigenschaftsname.

ErrorResponse

Fehlerantwort.

Name Typ Beschreibung
error.code

string

Der vom Dienst definierte Fehlercode. Dieser Code dient als Unterstatus für den in der Antwort angegebenen HTTP-Fehlercode.

error.details

ErrorFieldContract[]

Die Liste der ungültigen Felder, die im Falle eines Überprüfungsfehlers gesendet werden.

error.message

string

Lesbare Darstellung des Fehlers.

NotificationContract

Benachrichtigungsdetails.

Name Typ Beschreibung
id

string

Vollqualifizierte Ressourcen-ID für die Ressource. Beispiel: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

Der Name der Ressource

properties.description

string

Beschreibung der Benachrichtigung.

properties.recipients

RecipientsContractProperties

Empfängerparameterwerte.

properties.title

string

Titel der Benachrichtigung.

type

string

Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

NotificationName

Benachrichtigungsname-Id.

Name Typ Beschreibung
AccountClosedPublisher

string

Die folgenden E-Mail-Empfänger und Benutzer erhalten E-Mail-Benachrichtigungen, wenn der Entwickler sein Konto schließt.

BCC

string

Die folgenden Empfänger erhalten blinde Kopien aller E-Mails, die an Entwickler gesendet werden.

NewApplicationNotificationMessage

string

Die folgenden E-Mail-Empfänger und Benutzer erhalten E-Mail-Benachrichtigungen, wenn neue Anwendungen an den Anwendungskatalog übermittelt werden.

NewIssuePublisherNotificationMessage

string

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

string

Die folgenden E-Mail-Empfänger und Benutzer erhalten E-Mail-Benachrichtigungen zu neuen API-Produktabonnements.

QuotaLimitApproachingPublisherNotificationMessage

string

Die folgenden E-Mail-Empfänger und Benutzer erhalten E-Mail-Benachrichtigungen, wenn die Abonnementnutzung dem Nutzungskontingent nahe kommt.

RequestPublisherNotificationMessage

string

Die folgenden E-Mail-Empfänger und Benutzer erhalten E-Mail-Benachrichtigungen zu Abonnementanforderungen für API-Produkte, die eine Genehmigung erfordern.

RecipientsContractProperties

Benachrichtigungsparametervertrag.

Name Typ Beschreibung
emails

string[]

Liste der E-Mails, die für die Benachrichtigung abonniert wurden.

users

string[]

Liste der Benutzer, die für die Benachrichtigung abonniert wurden.