Notification - Create Or Update

Referensi

Service:: API Management

API Version:: 2022-08-01

Membuat atau Perbarui pemberitahuan penerbit API Management.

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
notificationName	path	True	NotificationName	Pengidentifikasi Nama Pemberitahuan.
resourceGroupName	path	True	string	Nama grup sumber daya. Nama tidak peka huruf besar/kecil.
serviceName	path	True	string	Nama layanan API Management. Regex pattern: `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$`
subscriptionId	path	True	string	ID langganan target.
api-version	query	True	string	Versi API yang digunakan untuk operasi ini.

Header Permintaan

Nama	Diperlukan	Jenis	Deskripsi
If-Match		string	ETag Entitas. Tidak diperlukan saat membuat entitas, tetapi diperlukan saat memperbarui entitas.

Respons

Nama	Jenis	Deskripsi
200 OK	NotificationContract	Pemberitahuan berhasil diperbarui.
Other Status Codes	ErrorResponse	Respons kesalahan yang menjelaskan mengapa operasi gagal.

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory.

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

Scopes

Nama	Deskripsi
user_impersonation	meniru akun pengguna Anda

Contoh

ApiManagementCreateNotification

Sample Request

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

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

/** Samples for Notification CreateOrUpdate. */
public final class Main {
    /*
     * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementCreateNotification.json
     */
    /**
     * Sample code: ApiManagementCreateNotification.
     *
     * @param manager Entry point to ApiManagementManager.
     */
    public static void apiManagementCreateNotification(
        com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        manager
            .notifications()
            .createOrUpdateWithResponse(
                "rg1",
                "apimService1",
                NotificationName.REQUEST_PUBLISHER_NOTIFICATION_MESSAGE,
                null,
                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

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_create_notification.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.create_or_update(
        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/ApiManagementCreateNotification.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

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/ApiManagementCreateNotification.json
func ExampleNotificationClient_CreateOrUpdate() {
	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.NewNotificationClient().CreateOrUpdate(ctx, "rg1", "apimService1", armapimanagement.NotificationNameRequestPublisherNotificationMessage, &armapimanagement.NotificationClientCreateOrUpdateOptions{IfMatch: 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.NotificationContract = armapimanagement.NotificationContract{
	// 	Name: to.Ptr("RequestPublisherNotificationMessage"),
	// 	Type: to.Ptr("Microsoft.ApiManagement/service/notifications"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/RequestPublisherNotificationMessage"),
	// 	Properties: &armapimanagement.NotificationContractProperties{
	// 		Description: to.Ptr("The following email recipients and users will receive email notifications about subscription requests for API products requiring approval."),
	// 		Recipients: &armapimanagement.RecipientsContractProperties{
	// 			Emails: []*string{
	// 				to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/recipientEmails/contoso@live.com"),
	// 				to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/recipientEmails/foobar!live"),
	// 				to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/recipientEmails/foobar@live.com")},
	// 				Users: []*string{
	// 					to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/576823d0a40f7e74ec07d642")},
	// 				},
	// 				Title: to.Ptr("Subscription requests (requiring approval)"),
	// 			},
	// 		}
}

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

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

/**
 * This sample demonstrates how to Create or Update API Management publisher notification.
 *
 * @summary Create or Update API Management publisher notification.
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementCreateNotification.json
 */
async function apiManagementCreateNotification() {
  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.notification.createOrUpdate(
    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

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/RequestPublisherNotificationMessage",
  "type": "Microsoft.ApiManagement/service/notifications",
  "name": "RequestPublisherNotificationMessage",
  "properties": {
    "title": "Subscription requests (requiring approval)",
    "description": "The following email recipients and users will receive email notifications about subscription requests for API products requiring approval.",
    "recipients": {
      "emails": [
        "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/recipientEmails/contoso@live.com",
        "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/recipientEmails/foobar!live",
        "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/recipientEmails/foobar@live.com"
      ],
      "users": [
        "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/576823d0a40f7e74ec07d642"
      ]
    }
  }
}

Definisi

Nama	Deskripsi
ErrorFieldContract	Kontrak Bidang Kesalahan.
ErrorResponse	Respons Kesalahan.
NotificationContract	Detail pemberitahuan.
NotificationName	Pengidentifikasi Nama Pemberitahuan.
RecipientsContractProperties	Kontrak Parameter Pemberitahuan.

ErrorFieldContract

Kontrak Bidang Kesalahan.

Nama	Jenis	Deskripsi
code	string	Kode kesalahan tingkat properti.
message	string	Representasi kesalahan tingkat properti yang dapat dibaca manusia.
target	string	Nama properti.

ErrorResponse

Respons Kesalahan.

Nama	Jenis	Deskripsi
error.code	string	Kode kesalahan yang ditentukan layanan. Kode ini berfungsi sebagai sub-status untuk kode kesalahan HTTP yang ditentukan dalam respons.
error.details	ErrorFieldContract[]	Daftar bidang yang tidak valid dikirim dalam permintaan, jika terjadi kesalahan validasi.
error.message	string	Representasi kesalahan yang dapat dibaca manusia.

NotificationContract

Detail pemberitahuan.

Nama	Jenis	Deskripsi
id	string	ID sumber daya yang sepenuhnya memenuhi syarat untuk sumber daya. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Nama sumber daya.
properties.description	string	Deskripsi Pemberitahuan.
properties.recipients	RecipientsContractProperties	Nilai Parameter Penerima.
properties.title	string	Judul Pemberitahuan.
type	string	Jenis sumber daya. Misalnya "Microsoft.Compute/virtualMachines" atau "Microsoft.Storage/storageAccounts"

NotificationName

Pengidentifikasi Nama Pemberitahuan.

Nama	Jenis	Deskripsi
AccountClosedPublisher	string	Penerima email dan pengguna berikut akan menerima pemberitahuan email saat pengembang menutup akunnya.
BCC	string	Penerima berikut akan menerima salinan karbon buta dari semua email yang dikirim ke pengembang.
NewApplicationNotificationMessage	string	Penerima email dan pengguna berikut akan menerima pemberitahuan email saat aplikasi baru dikirimkan ke galeri aplikasi.
NewIssuePublisherNotificationMessage	string	Penerima email dan pengguna berikut akan menerima pemberitahuan email saat masalah atau komentar baru dikirimkan di portal pengembang.
PurchasePublisherNotificationMessage	string	Penerima email dan pengguna berikut akan menerima pemberitahuan email tentang langganan produk API baru.
QuotaLimitApproachingPublisherNotificationMessage	string	Penerima email dan pengguna berikut akan menerima pemberitahuan email saat penggunaan langganan mendekati kuota penggunaan.
RequestPublisherNotificationMessage	string	Penerima email dan pengguna berikut akan menerima pemberitahuan email tentang permintaan langganan untuk produk API yang memerlukan persetujuan.

RecipientsContractProperties

Kontrak Parameter Pemberitahuan.

Nama	Jenis	Deskripsi
emails	string[]	Daftar Email yang berlangganan pemberitahuan.
users	string[]	Daftar Pengguna yang berlangganan pemberitahuan.

Notification - Create Or Update

Parameter URI

Header Permintaan

Respons

Keamanan

azure_auth

Scopes

Contoh

ApiManagementCreateNotification

Sample Request

Sample Response

Definisi

ErrorFieldContract

ErrorResponse

NotificationContract

NotificationName

RecipientsContractProperties

Sumber Daya Tambahan: