Workspace Notification - Create Or Update

Referenz

Dienst:: API Management

API-Version:: 2024-05-01

Erstellen oder Aktualisieren der Benachrichtigung des Herausgebers der API-Verwaltung für den Arbeitsbereich.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/notifications/{notificationName}?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.
workspaceId	path	True	string minLength: 1 maxLength: 80 pattern: ^[^*#&+:<>?]+$	Arbeitsbereichsbezeichner. Muss in der aktuellen API-Verwaltungsdienstinstanz eindeutig sein.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang 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, 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

ApiManagementCreateWorkspaceNotification

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

Statuscode:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/notifications/RequestPublisherNotificationMessage",
  "type": "Microsoft.ApiManagement/service/workspaces/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/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/notifications/RequestPublisherNotificationMessage/recipientEmails/contoso@live.com",
        "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/notifications/RequestPublisherNotificationMessage/recipientEmails/foobar!live",
        "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/notifications/RequestPublisherNotificationMessage/recipientEmails/foobar@live.com"
      ],
      "users": [
        "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/576823d0a40f7e74ec07d642"
      ]
    }
  }
}

Definitionen

Name	Beschreibung
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
NotificationContract	Benachrichtigungsdetails.
NotificationName	Benachrichtigungsname-ID.
RecipientsContractProperties	Benachrichtigungsparameter-Vertrag.

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.

NotificationContract

Objekt

Benachrichtigungsdetails.

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.description	string	Beschreibung der Benachrichtigung.
properties.recipients	RecipientsContractProperties	Empfängerparameterwerte.
properties.title	string minLength: 1 maxLength: 1000	Titel der Benachrichtigung.
type	string	Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

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.

RecipientsContractProperties

Objekt

Benachrichtigungsparameter-Vertrag.

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.

Freigeben über

Workspace Notification - Create Or Update

URI-Parameter

Anforderungsheader

Antworten

Sicherheit

azure_auth

Bereiche

Beispiele

ApiManagementCreateWorkspaceNotification

Beispielanforderung

Beispiel für eine Antwort

Definitionen

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

NotificationContract

NotificationName

RecipientsContractProperties

Zusätzliche Ressourcen