Notification Recipient Email - List By Notification

Serviço:

API Management

Versão da API:

2021-08-01

Obtém a lista dos E-mails do Destinatário da Notificação subscritos a uma notificação.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
notificationName	path	True	NotificationName	Identificador de Nome da Notificação.
resourceGroupName	path	True	string	O nome do grupo de recursos.
serviceName	path	True	string	O nome do serviço Gestão de API. Padrão Regex: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
subscriptionId	path	True	string	Credenciais de subscrição que identificam exclusivamente a subscrição do Microsoft Azure. O ID da subscrição faz parte do URI para cada chamada de serviço.
api-version	query	True	string	Versão da API a utilizar com o pedido de cliente.

Respostas

Name	Tipo	Description
200 OK	RecipientEmailCollection	O corpo da resposta contém a coleção Email destinatário subscrito à notificação.
Other Status Codes	ErrorResponse	Resposta de erro que descreve a razão pela qual a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name	Description
user_impersonation	representar a sua conta de utilizador

Exemplos

ApiManagementListNotificationRecipientEmails

Pedido de amostra

HTTP

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

Java

import com.azure.core.util.Context;
import com.azure.resourcemanager.apimanagement.models.NotificationName;

/** Samples for NotificationRecipientEmail ListByNotification. */
public final class Main {
    /*
     * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementListNotificationRecipientEmails.json
     */
    /**
     * Sample code: ApiManagementListNotificationRecipientEmails.
     *
     * @param manager Entry point to ApiManagementManager.
     */
    public static void apiManagementListNotificationRecipientEmails(
        com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        manager
            .notificationRecipientEmails()
            .listByNotificationWithResponse(
                "rg1", "apimService1", NotificationName.REQUEST_PUBLISHER_NOTIFICATION_MESSAGE, Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.apimanagement import ApiManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-apimanagement
# USAGE
    python api_management_list_notification_recipient_emails.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = ApiManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.notification_recipient_email.list_by_notification(
        resource_group_name="rg1",
        service_name="apimService1",
        notification_name="RequestPublisherNotificationMessage",
    )
    print(response)


# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementListNotificationRecipientEmails.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armapimanagement_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/apimanagement/armapimanagement"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/c767823fdfd9d5e96bad245e3ea4d14d94a716bb/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementListNotificationRecipientEmails.json
func ExampleNotificationRecipientEmailClient_ListByNotification() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armapimanagement.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewNotificationRecipientEmailClient().ListByNotification(ctx, "rg1", "apimService1", armapimanagement.NotificationNameRequestPublisherNotificationMessage, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.RecipientEmailCollection = armapimanagement.RecipientEmailCollection{
	// 	Count: to.Ptr[int64](3),
	// 	Value: []*armapimanagement.RecipientEmailContract{
	// 		{
	// 			Name: to.Ptr("contoso@live.com"),
	// 			Type: to.Ptr("Microsoft.ApiManagement/service/notifications/recipientEmails"),
	// 			ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/RequestPublisherNotificationMessage/recipientEmails/contoso@live.com"),
	// 			Properties: &armapimanagement.RecipientEmailContractProperties{
	// 				Email: to.Ptr("contoso@live.com"),
	// 			},
	// 		},
	// 		{
	// 			Name: to.Ptr("foobar!live"),
	// 			Type: to.Ptr("Microsoft.ApiManagement/service/notifications/recipientEmails"),
	// 			ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/RequestPublisherNotificationMessage/recipientEmails/foobar!live"),
	// 			Properties: &armapimanagement.RecipientEmailContractProperties{
	// 				Email: to.Ptr("foobar!live"),
	// 			},
	// 		},
	// 		{
	// 			Name: to.Ptr("foobar@live.com"),
	// 			Type: to.Ptr("Microsoft.ApiManagement/service/notifications/recipientEmails"),
	// 			ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/RequestPublisherNotificationMessage/recipientEmails/foobar@live.com"),
	// 			Properties: &armapimanagement.RecipientEmailContractProperties{
	// 				Email: to.Ptr("foobar@live.com"),
	// 			},
	// 	}},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { ApiManagementClient } = require("@azure/arm-apimanagement");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Gets the list of the Notification Recipient Emails subscribed to a notification.
 *
 * @summary Gets the list of the Notification Recipient Emails subscribed to a notification.
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementListNotificationRecipientEmails.json
 */
async function apiManagementListNotificationRecipientEmails() {
  const subscriptionId = process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
  const serviceName = "apimService1";
  const notificationName = "RequestPublisherNotificationMessage";
  const credential = new DefaultAzureCredential();
  const client = new ApiManagementClient(credential, subscriptionId);
  const result = await client.notificationRecipientEmail.listByNotification(
    resourceGroupName,
    serviceName,
    notificationName
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.ApiManagement;
using Azure.ResourceManager.ApiManagement.Models;

// Generated from example definition: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementListNotificationRecipientEmails.json
// this example is just showing the usage of "NotificationRecipientEmail_ListByNotification" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ApiManagementNotificationResource created on azure
// for more information of creating ApiManagementNotificationResource, please refer to the document of ApiManagementNotificationResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string serviceName = "apimService1";
NotificationName notificationName = NotificationName.RequestPublisherNotificationMessage;
ResourceIdentifier apiManagementNotificationResourceId = ApiManagementNotificationResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serviceName, notificationName);
ApiManagementNotificationResource apiManagementNotification = client.GetApiManagementNotificationResource(apiManagementNotificationResourceId);

// invoke the operation and iterate over the result
await foreach (RecipientEmailContract item in apiManagementNotification.GetNotificationRecipientEmailsAsync())
{
    Console.WriteLine($"Succeeded: {item}");
}

Console.WriteLine($"Succeeded");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Resposta da amostra

Código de estado:

200

{
  "value": [
    {
      "id": "/subscriptions/subid/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/subid/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/subid/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": ""
}

Definições

Name	Description
ErrorFieldContract	Contrato de campo de erro.
ErrorResponse	Resposta a Erros.
NotificationName	Identificador de Nome da Notificação.
RecipientEmailCollection	Representação da lista de Utilizadores de Destinatários Paginados.
RecipientEmailContract	O destinatário Email detalhes.

ErrorFieldContract

Contrato de campo de erro.

Name	Tipo	Description
code	string	Código de erro ao nível da propriedade.
message	string	Representação legível por humanos do erro ao nível da propriedade.
target	string	Nome da propriedade.

ErrorResponse

Resposta a Erros.

Name	Tipo	Description
error.code	string	Código de erro definido pelo serviço. Este código serve como um sub-estado para o código de erro HTTP especificado na resposta.
error.details	ErrorFieldContract[]	A lista de campos inválidos enviados a pedido, em caso de erro de validação.
error.message	string	Representação legível por humanos do erro.

NotificationName

Identificador de Nome da Notificação.

Name	Tipo	Description
AccountClosedPublisher	string	Os seguintes destinatários e utilizadores de e-mail receberão notificações por e-mail quando o programador fechar a sua conta.
BCC	string	Os seguintes destinatários receberão cópias de carbono cegas de todos os e-mails enviados aos programadores.
NewApplicationNotificationMessage	string	Os seguintes destinatários e utilizadores de e-mail receberão notificações por e-mail quando forem submetidas novas aplicações à galeria de aplicações.
NewIssuePublisherNotificationMessage	string	Os seguintes destinatários e utilizadores de e-mail receberão notificações por e-mail quando um novo problema ou comentário for submetido no portal do programador.
PurchasePublisherNotificationMessage	string	Os seguintes destinatários e utilizadores de e-mail receberão notificações por e-mail sobre novas subscrições de produtos da API.
QuotaLimitApproachingPublisherNotificationMessage	string	Os seguintes destinatários e utilizadores de e-mail receberão notificações por e-mail quando a utilização da subscrição estiver próxima da quota de utilização.
RequestPublisherNotificationMessage	string	Os seguintes destinatários e utilizadores de e-mail receberão notificações por e-mail sobre pedidos de subscrição para produtos de API que necessitam de aprovação.

RecipientEmailCollection

Representação da lista de Utilizadores de Destinatários Paginados.

Name	Tipo	Description
count	integer	Número total de contagem de registos em todas as páginas.
nextLink	string	Ligação da página seguinte, se existir.
value	RecipientEmailContract[]	Valores de página.

RecipientEmailContract

O destinatário Email detalhes.

Name	Tipo	Description
id	string	ID de recurso completamente qualificado para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	O nome do recurso
properties.email	string	O utilizador Email subscrito à notificação.
type	string	O tipo de recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"