Workspace Notification Recipient Email - Create Or Update

Servizio:

API Management

Versione API:

2024-05-01

Aggiunge l'indirizzo di posta elettronica all'elenco dei destinatari per la notifica.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
email	path	True	string	Identificatore di posta elettronica.
notificationName	path	True	NotificationName	Identificatore del nome della notifica.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nome del gruppo di risorse. Il nome non fa distinzione tra maiuscole e minuscole.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Nome del servizio Gestione API.
subscriptionId	path	True	string (uuid)	ID della sottoscrizione di destinazione. Il valore deve essere un UUID.
workspaceId	path	True	string minLength: 1 maxLength: 80 pattern: ^[^*#&+:<>?]+$	Identificatore dell'area di lavoro. Deve essere univoco nell'istanza corrente del servizio Gestione API.
api-version	query	True	string minLength: 1	Versione dell'API da usare per questa operazione.

Risposte

Nome	Tipo	Descrizione
200 OK	RecipientEmailContract	Messaggio di posta elettronica destinatario fa già parte dell'elenco di notifiche.
201 Created	RecipientEmailContract	Messaggio di posta elettronica destinatario aggiunto correttamente all'elenco di notifiche.
Other Status Codes	ErrorResponse	Risposta di errore che descrive il motivo per cui l'operazione non è riuscita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

ApiManagementCreateWorkspaceNotificationRecipientEmail

Esempio di richiesta

HTTP

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

Risposta di esempio

Codice di stato:

201

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/notifications/RequestPublisherNotificationMessage/recipientEmails/foobar@live.com",
  "type": "Microsoft.ApiManagement/service/workspaces/notifications/recipientEmails",
  "name": "foobar@live.com",
  "properties": {
    "email": "foobar@live.com"
  }
}

Codice di stato:

200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/notifications/RequestPublisherNotificationMessage/recipientEmails/foobar@live.com",
  "type": "Microsoft.ApiManagement/service/workspaces/notifications/recipientEmails",
  "name": "foobar@live.com",
  "properties": {
    "email": "foobar@live.com"
  }
}

Definizioni

Nome	Descrizione
ErrorAdditionalInfo	Informazioni aggiuntive sull'errore di gestione delle risorse.
ErrorDetail	Dettagli dell'errore.
ErrorResponse	Risposta di errore
NotificationName	Identificatore del nome della notifica.
RecipientEmailContract	Dettagli dell'indirizzo di posta elettronica del destinatario.

ErrorAdditionalInfo

Object

Informazioni aggiuntive sull'errore di gestione delle risorse.

Nome	Tipo	Descrizione
info	object	Informazioni aggiuntive.
type	string	Tipo di informazioni aggiuntive.

ErrorDetail

Object

Dettagli dell'errore.

Nome	Tipo	Descrizione
additionalInfo	ErrorAdditionalInfo[]	Informazioni aggiuntive sull'errore.
code	string	Codice di errore.
details	ErrorDetail[]	Dettagli dell'errore.
message	string	Messaggio di errore.
target	string	Destinazione dell'errore.

ErrorResponse

Object

Risposta di errore

Nome	Tipo	Descrizione
error	ErrorDetail	Oggetto error.

NotificationName

Enumerazione

Identificatore del nome della notifica.

Valore	Descrizione
AccountClosedPublisher	I destinatari e gli utenti di posta elettronica seguenti riceveranno notifiche tramite posta elettronica quando lo sviluppatore chiude il proprio account.
BCC	I destinatari seguenti riceveranno copie in carbonio cieco di tutti i messaggi di posta elettronica inviati agli sviluppatori.
NewApplicationNotificationMessage	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	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	I destinatari e gli utenti di posta elettronica seguenti riceveranno notifiche tramite posta elettronica sulle nuove sottoscrizioni del prodotto API.
QuotaLimitApproachingPublisherNotificationMessage	I destinatari e gli utenti di posta elettronica seguenti riceveranno notifiche tramite posta elettronica quando l'utilizzo della sottoscrizione si avvicina alla quota di utilizzo.
RequestPublisherNotificationMessage	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.

RecipientEmailContract

Object

Dettagli dell'indirizzo di posta elettronica del destinatario.

Nome	Tipo	Descrizione
id	string	ID risorsa completo per la risorsa. Ad esempio - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Nome della risorsa
properties.email	string	Messaggio di posta elettronica dell'utente sottoscritto per la notifica.
type	string	Tipo della risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"