Compartir a través de

Notification Recipient Email - List By Notification

  • Referencia
Servicio:
API Management
Versión de la API:
2024-05-01

Obtiene la lista de los correos electrónicos de destinatarios de notificación suscritos a una notificación.

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

Parámetros de identificador URI

Nombre En Requerido Tipo Description
notificationName
 path True

NotificationName

Identificador de nombre de notificación.
resourceGroupName
 path True

string

minLength: 1
maxLength: 90

Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.
serviceName
 path True

string

minLength: 1
maxLength: 50
pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

Nombre del servicio API Management.
subscriptionId
 path True

string (uuid)

Identificador de la suscripción de destino. El valor debe ser un UUID.
api-version
 query True

string

minLength: 1

Versión de la API que se va a usar para esta operación.

Respuestas

Nombre Tipo Description
200 OK

RecipientEmailCollection

El cuerpo de la respuesta contiene la colección Correo electrónico de destinatario suscrito a la notificación.
Other Status Codes

ErrorResponse

Respuesta de error que describe por qué se produjo un error en la operación.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre Description
user_impersonation suplantar la cuenta de usuario

Ejemplos

ApiManagementListNotificationRecipientEmails

Solicitud de ejemplo

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

Respuesta de muestra

status code:
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": ""
}

Definiciones

Nombre Description
ErrorAdditionalInfo

Información adicional sobre el error de administración de recursos.
ErrorDetail

Detalle del error.
ErrorResponse

Respuesta de error
NotificationName

Identificador de nombre de notificación.
RecipientEmailCollection

Representación de la lista de usuarios destinatarios paginados.
RecipientEmailContract

Detalles del correo electrónico del destinatario.

ErrorAdditionalInfo

Object

Información adicional sobre el error de administración de recursos.

Nombre Tipo Description
info

object

Información adicional.
type

string

Tipo de información adicional.

ErrorDetail

Object

Detalle del error.

Nombre Tipo Description
additionalInfo

ErrorAdditionalInfo[]

Información adicional del error.
code

string

Código de error.
details

ErrorDetail[]

Detalles del error.
message

string

Mensaje de error.
target

string

Destino del error.

ErrorResponse

Object

Respuesta de error

Nombre Tipo Description
error

ErrorDetail

Objeto de error.

NotificationName

Enumeración

Identificador de nombre de notificación.

Valor Description
AccountClosedPublisher

Los siguientes destinatarios de correo electrónico y usuarios recibirán notificaciones por correo electrónico cuando el desarrollador cierre su cuenta.
BCC

Los siguientes destinatarios recibirán copias de carbono ciegas de todos los correos electrónicos enviados a los desarrolladores.
NewApplicationNotificationMessage

Los siguientes destinatarios de correo electrónico y usuarios recibirán notificaciones por correo electrónico cuando se envíen nuevas aplicaciones a la galería de aplicaciones.
NewIssuePublisherNotificationMessage

Los siguientes destinatarios de correo electrónico y usuarios recibirán notificaciones por correo electrónico cuando se envíe un nuevo problema o comentario en el portal para desarrolladores.
PurchasePublisherNotificationMessage

Los siguientes destinatarios de correo electrónico y usuarios recibirán notificaciones por correo electrónico sobre las nuevas suscripciones de producto de API.
QuotaLimitApproachingPublisherNotificationMessage

Los siguientes destinatarios de correo electrónico y usuarios recibirán notificaciones por correo electrónico cuando el uso de la suscripción esté cerca de la cuota de uso.
RequestPublisherNotificationMessage

Los siguientes destinatarios de correo electrónico y usuarios recibirán notificaciones por correo electrónico sobre las solicitudes de suscripción para los productos de API que requieren aprobación.

RecipientEmailCollection

Object

Representación de la lista de usuarios destinatarios paginados.

Nombre Tipo Description
count

integer (int64)

Número total de recuento de registros en todas las páginas.
nextLink

string

Vínculo de página siguiente si existe.
value

RecipientEmailContract[]

Valores de página.

RecipientEmailContract

Object

Detalles del correo electrónico del destinatario.

Nombre Tipo Description
id

string

Identificador de recurso completo para el recurso. Por ejemplo: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name

string

Nombre del recurso
properties.email

string

Correo electrónico de usuario suscrito a la notificación.
type

string

Tipo del recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"