Notification Recipient User - List By Notification

Service:

API Management

API Version:

2022-08-01

Bildirime abone olan Bildirim Alıcısı Kullanıcısının listesini alır.

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
notificationName	path	True	NotificationName	Bildirim Adı Tanımlayıcısı.
resourceGroupName	path	True	string	Kaynak grubunun adı. Ad büyük/küçük harfe duyarlı değildir.
serviceName	path	True	string	API Management hizmetinin adı. Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
subscriptionId	path	True	string	Hedef aboneliğin kimliği.
api-version	query	True	string	Bu işlem için kullanılacak API sürümü.

Yanıtlar

Name	Tür	Description
200 OK	RecipientUserCollection	Yanıt gövdesi, bildirim için Alıcı Kullanıcısı koleksiyonunu içerir.
Other Status Codes	ErrorResponse	İşlemin neden başarısız olduğunu açıklayan hata yanıtı.

Güvenlik

azure_auth

Azure Active Directory OAuth2 Flow.

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

Scopes

Name	Description
user_impersonation	kullanıcı hesabınızın kimliğine bürünme

Örnekler

ApiManagementListNotificationRecipientUsers

Sample Request

HTTP

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

Java

import com.azure.resourcemanager.apimanagement.models.NotificationName;

/** Samples for NotificationRecipientUser ListByNotification. */
public final class Main {
    /*
     * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementListNotificationRecipientUsers.json
     */
    /**
     * Sample code: ApiManagementListNotificationRecipientUsers.
     *
     * @param manager Entry point to ApiManagementManager.
     */
    public static void apiManagementListNotificationRecipientUsers(
        com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        manager
            .notificationRecipientUsers()
            .listByNotificationWithResponse(
                "rg1",
                "apimService1",
                NotificationName.REQUEST_PUBLISHER_NOTIFICATION_MESSAGE,
                com.azure.core.util.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 typing import TYPE_CHECKING, Union

from azure.identity import DefaultAzureCredential

from azure.mgmt.apimanagement import ApiManagementClient

if TYPE_CHECKING:
    # pylint: disable=unused-import,ungrouped-imports
    from .. import models as _models
"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-apimanagement
# USAGE
    python api_management_list_notification_recipient_users.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_user.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/2022-08-01/examples/ApiManagementListNotificationRecipientUsers.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/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/4cd95123fb961c68740565a1efcaa5e43bd35802/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementListNotificationRecipientUsers.json
func ExampleNotificationRecipientUserClient_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.NewNotificationRecipientUserClient().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.RecipientUserCollection = armapimanagement.RecipientUserCollection{
	// 	Count: to.Ptr[int64](1),
	// 	Value: []*armapimanagement.RecipientUserContract{
	// 		{
	// 			Name: to.Ptr("576823d0a40f7e74ec07d642"),
	// 			Type: to.Ptr("Microsoft.ApiManagement/service/notifications/recipientUsers"),
	// 			ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/RequestPublisherNotificationMessage/recipientUsers/576823d0a40f7e74ec07d642"),
	// 			Properties: &armapimanagement.RecipientUsersContractProperties{
	// 				UserID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/576823d0a40f7e74ec07d642"),
	// 			},
	// 	}},
	// }
}

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 User subscribed to the notification.
 *
 * @summary Gets the list of the Notification Recipient User subscribed to the notification.
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementListNotificationRecipientUsers.json
 */
async function apiManagementListNotificationRecipientUsers() {
  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.notificationRecipientUser.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

Sample Response

Status code:

200

{
  "value": [
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/RequestPublisherNotificationMessage/recipientUsers/576823d0a40f7e74ec07d642",
      "type": "Microsoft.ApiManagement/service/notifications/recipientUsers",
      "name": "576823d0a40f7e74ec07d642",
      "properties": {
        "userId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/576823d0a40f7e74ec07d642"
      }
    }
  ],
  "count": 1,
  "nextLink": ""
}

Tanımlar

Name	Description
ErrorFieldContract	Hata Alanı sözleşmesi.
ErrorResponse	Hata Yanıtı.
NotificationName	Bildirim Adı Tanımlayıcısı.
RecipientUserCollection	Sayfalanan Alıcı Kullanıcı listesi gösterimi.
RecipientUserContract	Alıcı Kullanıcı ayrıntıları.

ErrorFieldContract

Hata Alanı sözleşmesi.

Name	Tür	Description
code	string	Özellik düzeyi hata kodu.
message	string	Özellik düzeyi hatanın insan tarafından okunabilir gösterimi.
target	string	Özellik adı.

ErrorResponse

Hata Yanıtı.

Name	Tür	Description
error.code	string	Hizmet tanımlı hata kodu. Bu kod, yanıtta belirtilen HTTP hata kodu için bir alt durum görevi görür.
error.details	ErrorFieldContract[]	Doğrulama hatası durumunda istekte gönderilen geçersiz alanların listesi.
error.message	string	Hatanın insan tarafından okunabilir gösterimi.

NotificationName

Bildirim Adı Tanımlayıcısı.

Name	Tür	Description
AccountClosedPublisher	string	Geliştirici hesabını kapattığında aşağıdaki e-posta alıcıları ve kullanıcıları e-posta bildirimleri alır.
BCC	string	Aşağıdaki alıcılar, geliştiricilere gönderilen tüm e-postaların gizli kopyalarını alır.
NewApplicationNotificationMessage	string	Aşağıdaki e-posta alıcıları ve kullanıcıları, uygulama galerisine yeni uygulamalar gönderildiğinde e-posta bildirimleri alır.
NewIssuePublisherNotificationMessage	string	Geliştirici portalında yeni bir sorun veya açıklama gönderildiğinde aşağıdaki e-posta alıcıları ve kullanıcıları e-posta bildirimleri alır.
PurchasePublisherNotificationMessage	string	Aşağıdaki e-posta alıcıları ve kullanıcıları yeni API ürün abonelikleri hakkında e-posta bildirimleri alır.
QuotaLimitApproachingPublisherNotificationMessage	string	Abonelik kullanımı kullanım kotasına yaklaştığında aşağıdaki e-posta alıcıları ve kullanıcılar e-posta bildirimleri alır.
RequestPublisherNotificationMessage	string	Aşağıdaki e-posta alıcıları ve kullanıcıları, onay gerektiren API ürünleri için abonelik istekleri hakkında e-posta bildirimleri alır.

RecipientUserCollection

Sayfalanan Alıcı Kullanıcı listesi gösterimi.

Name	Tür	Description
count	integer	Tüm sayfalardaki toplam kayıt sayısı.
nextLink	string	Varsa sonraki sayfa bağlantısı.
value	RecipientUserContract[]	Sayfa değerleri.

RecipientUserContract

Alıcı Kullanıcı ayrıntıları.

Name	Tür	Description
id	string	Kaynağın tam kaynak kimliği. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Kaynağın adı
properties.userId	string	API Management UserId bildirimine abone oldu.
type	string	Kaynağın türü. Örneğin, "Microsoft.Compute/virtualMachines" veya "Microsoft.Storage/storageAccounts"