Notification Recipient User - Check Entity Exists

Dienst:

API Management

API-Version:

2022-08-01

Ermitteln Sie, ob der Benachrichtigungsempfängerbenutzer die Benachrichtigung abonniert hat.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
notificationName	path	True	NotificationName	Benachrichtigungsname-ID.
resourceGroupName	path	True	string	Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.
serviceName	path	True	string	Der Name des API Management-Diensts. RegEx-Muster: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
subscriptionId	path	True	string	Hierbei handelt es sich um die ID des Zielabonnements.
userId	path	True	string	Benutzer-ID. Muss im aktuellen API Management-Dienst instance eindeutig sein.
api-version	query	True	string	Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.

Antworten

Name	Typ	Beschreibung
204 No Content		Der Benutzer ist abonniert, um die Benachrichtigung zu erhalten.
404 Not Found		Die Entität ist nicht vorhanden.
Other Status Codes	ErrorResponse	Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Flow.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Beispiele

ApiManagementHeadNotificationRecipientUser

Beispielanforderung

HTTP

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

Java

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

/** Samples for NotificationRecipientUser CheckEntityExists. */
public final class Main {
    /*
     * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementHeadNotificationRecipientUser.json
     */
    /**
     * Sample code: ApiManagementHeadNotificationRecipientUser.
     *
     * @param manager Entry point to ApiManagementManager.
     */
    public static void apiManagementHeadNotificationRecipientUser(
        com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        manager
            .notificationRecipientUsers()
            .checkEntityExistsWithResponse(
                "rg1",
                "apimService1",
                NotificationName.REQUEST_PUBLISHER_NOTIFICATION_MESSAGE,
                "576823d0a40f7e74ec07d642",
                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_head_notification_recipient_user.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.check_entity_exists(
        resource_group_name="rg1",
        service_name="apimService1",
        notification_name="RequestPublisherNotificationMessage",
        user_id="576823d0a40f7e74ec07d642",
    )
    print(response)


# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementHeadNotificationRecipientUser.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/ApiManagementHeadNotificationRecipientUser.json
func ExampleNotificationRecipientUserClient_CheckEntityExists() {
	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)
	}
	_, err = clientFactory.NewNotificationRecipientUserClient().CheckEntityExists(ctx, "rg1", "apimService1", armapimanagement.NotificationNameRequestPublisherNotificationMessage, "576823d0a40f7e74ec07d642", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
}

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 Determine if the Notification Recipient User is subscribed to the notification.
 *
 * @summary Determine if the Notification Recipient User is subscribed to the notification.
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementHeadNotificationRecipientUser.json
 */
async function apiManagementHeadNotificationRecipientUser() {
  const subscriptionId = process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
  const serviceName = "apimService1";
  const notificationName = "RequestPublisherNotificationMessage";
  const userId = "576823d0a40f7e74ec07d642";
  const credential = new DefaultAzureCredential();
  const client = new ApiManagementClient(credential, subscriptionId);
  const result = await client.notificationRecipientUser.checkEntityExists(
    resourceGroupName,
    serviceName,
    notificationName,
    userId
  );
  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

Beispiel für eine Antwort

Statuscode:

204

Statuscode:

404

Definitionen

Name	Beschreibung
ErrorFieldContract	Fehler Feldvertrag.
ErrorResponse	Fehlerantwort.
NotificationName	Benachrichtigungsname-ID.

ErrorFieldContract

Fehler Feldvertrag.

Name	Typ	Beschreibung
code	string	Fehlercode auf Eigenschaftsebene.
message	string	Für Menschen lesbare Darstellung eines Fehlers auf Eigenschaftsebene.
target	string	Der Eigenschaftsname.

ErrorResponse

Fehlerantwort.

Name	Typ	Beschreibung
error.code	string	Der vom Dienst definierte Fehlercode. Dieser Code dient als Unterstatus für den in der Antwort angegebenen HTTP-Fehlercode.
error.details	ErrorFieldContract[]	Die Liste der ungültigen Felder, die in der Anforderung gesendet werden, im Falle eines Validierungsfehlers.
error.message	string	Lesbare Darstellung des Fehlers.

NotificationName

Benachrichtigungsname-ID.

Name	Typ	Beschreibung
AccountClosedPublisher	string	Die folgenden E-Mail-Empfänger und Benutzer erhalten E-Mail-Benachrichtigungen, wenn entwickler sein Konto schließen.
BCC	string	Die folgenden Empfänger erhalten blinde Kopien aller E-Mails, die an Entwickler gesendet werden.
NewApplicationNotificationMessage	string	Die folgenden E-Mail-Empfänger und Benutzer erhalten E-Mail-Benachrichtigungen, wenn neue Anwendungen an den Anwendungskatalog übermittelt werden.
NewIssuePublisherNotificationMessage	string	Die folgenden E-Mail-Empfänger und Benutzer erhalten E-Mail-Benachrichtigungen, wenn ein neues Problem oder ein neuer Kommentar im Entwicklerportal übermittelt wird.
PurchasePublisherNotificationMessage	string	Die folgenden E-Mail-Empfänger und Benutzer erhalten E-Mail-Benachrichtigungen zu neuen API-Produktabonnements.
QuotaLimitApproachingPublisherNotificationMessage	string	Die folgenden E-Mail-Empfänger und Benutzer erhalten E-Mail-Benachrichtigungen, wenn die Abonnementnutzung dem Nutzungskontingent nahe kommt.
RequestPublisherNotificationMessage	string	Die folgenden E-Mail-Empfänger und Benutzer erhalten E-Mail-Benachrichtigungen zu Abonnementanforderungen für API-Produkte, die eine Genehmigung erfordern.