Notification - Create Or Update

Creare o aggiornare Gestione API notifica dell'editore.

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

Parametri dell'URI

Name In Required Type Description
notificationName
path True

Identificatore del nome della notifica.

resourceGroupName
path True
  • string

Nome del gruppo di risorse.

serviceName
path True
  • string

Nome del servizio di Gestione API.

Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
path True
  • string

Credenziali di sottoscrizione che identificano in modo univoco Microsoft Azure sottoscrizione. L'ID sottoscrizione fa parte dell'URI per ogni chiamata di servizio.

api-version
query True
  • string

Versione dell'API da usare con la richiesta client.

Intestazione della richiesta

Name Required Type Description
If-Match
  • string

ETag dell'entità. Non obbligatorio durante la creazione di un'entità, ma necessario durante l'aggiornamento di un'entità.

Risposte

Name Type Description
200 OK

La notifica è stata aggiornata correttamente.

Other Status Codes

Risposta di errore che descrive il motivo per cui l'operazione non è riuscita.

Sicurezza

azure_auth

Azure Active Directory Flow OAuth2.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation rappresentare l'account utente

Esempio

ApiManagementCreateNotification

Sample Request

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

Sample Response

{
  "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"
      ]
    }
  }
}

Definizioni

ErrorFieldContract

Contratto campo di errore.

ErrorResponse

Risposta errore.

NotificationContract

Dettagli notifica.

NotificationName

Identificatore del nome della notifica.

RecipientsContractProperties

Contratto del parametro di notifica.

ErrorFieldContract

Contratto campo di errore.

Name Type Description
code
  • string

Codice di errore a livello di proprietà.

message
  • string

Rappresentazione leggibile dell'errore a livello di proprietà.

target
  • string

Nome della proprietà.

ErrorResponse

Risposta errore.

Name Type Description
error.code
  • string

Codice di errore definito dal servizio. Questo codice svolge la funzione di stato secondario per il codice di errore HTTP specificato nella risposta.

error.details

Elenco di campi non validi inviati nella richiesta, in caso di errore di convalida.

error.message
  • string

Rappresentazione leggibile dell'errore.

NotificationContract

Dettagli notifica.

Name Type Description
id
  • string

ID di risorsa completo per la risorsa. Ad esempio - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name
  • string

nome della risorsa.

properties.description
  • string

Descrizione della notifica.

properties.recipients

Valori dei parametri del destinatario.

properties.title
  • string

Titolo della notifica.

type
  • string

Tipo di risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft. Archiviazione/storageAccounts"

NotificationName

Identificatore del nome della notifica.

Name Type Description
AccountClosedPublisher
  • string

I destinatari e gli utenti di posta elettronica seguenti riceveranno notifiche tramite posta elettronica quando lo sviluppatore chiude il proprio account.

BCC
  • string

I destinatari seguenti riceveranno copie in carbonio cieco di tutti i messaggi di posta elettronica inviati agli sviluppatori.

NewApplicationNotificationMessage
  • string

I destinatari e gli utenti di posta elettronica seguenti riceveranno notifiche tramite posta elettronica quando le nuove applicazioni vengono inviate alla raccolta di applicazioni.

NewIssuePublisherNotificationMessage
  • string

I destinatari e gli utenti di posta elettronica seguenti riceveranno notifiche tramite posta elettronica quando viene inviato un nuovo problema o commento nel portale per sviluppatori.

PurchasePublisherNotificationMessage
  • string

I destinatari e gli utenti di posta elettronica seguenti riceveranno notifiche tramite posta elettronica relative alle nuove sottoscrizioni del prodotto API.

QuotaLimitApproachingPublisherNotificationMessage
  • string

I destinatari e gli utenti di posta elettronica seguenti riceveranno notifiche tramite posta elettronica quando l'utilizzo della sottoscrizione raggiunge la quota di utilizzo.

RequestPublisherNotificationMessage
  • string

I destinatari e gli utenti di posta elettronica seguenti riceveranno notifiche tramite posta elettronica sulle richieste di sottoscrizione per i prodotti API che richiedono l'approvazione.

RecipientsContractProperties

Contratto del parametro di notifica.

Name Type Description
emails
  • string[]

Elenco di messaggi di posta elettronica sottoscritti per la notifica.

users
  • string[]

Elenco di utenti sottoscritti per la notifica.