Notification - Create Or Update

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=2021-08-01

Parameter URI

Name In Required Type Description
notificationName
path True

Pengidentifikasi Nama Pemberitahuan.

resourceGroupName
path True
  • string

Nama grup sumber daya.

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

Info masuk langganan yang secara unik mengidentifikasi langganan Microsoft Azure. ID langganan membentuk bagian dari URI untuk setiap panggilan layanan.

api-version
query True
  • string

Versi API yang akan digunakan dengan permintaan klien.

Header Permintaan

Name Required Type Description
If-Match
  • string

ETag Entitas. Tidak diperlukan saat membuat entitas, tetapi diperlukan saat memperbarui entitas.

Respons

Name Type Description
200 OK

Pemberitahuan berhasil diperbarui.

Other Status Codes

Respons kesalahan yang menjelaskan mengapa operasi gagal.

Keamanan

azure_auth

Azure Active Directory Flow OAuth2.

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

Scopes

Name Description
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=2021-08-01

Sample Response

{
  "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

ErrorFieldContract

Kontrak Bidang Kesalahan.

ErrorResponse

Respons Kesalahan.

NotificationContract

Detail pemberitahuan.

NotificationName

Pengidentifikasi Nama Pemberitahuan.

RecipientsContractProperties

Kontrak Parameter Pemberitahuan.

ErrorFieldContract

Kontrak Bidang Kesalahan.

Name Type Description
code
  • string

Kode kesalahan tingkat properti.

message
  • string

Representasi kesalahan tingkat properti yang dapat dibaca manusia.

target
  • string

Nama properti.

ErrorResponse

Respons Kesalahan.

Name Type Description
error.code
  • string

Kode kesalahan yang ditentukan layanan. Kode ini berfungsi sebagai sub-status untuk kode kesalahan HTTP yang ditentukan dalam respons.

error.details

Daftar bidang yang tidak valid dikirim dalam permintaan, jika terjadi kesalahan validasi.

error.message
  • string

Representasi kesalahan yang dapat dibaca manusia.

NotificationContract

Detail pemberitahuan.

Name Type Description
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

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.

Name Type Description
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.

Name Type Description
emails
  • string[]

Daftar Email yang berlangganan pemberitahuan.

users
  • string[]

Daftar Pengguna yang berlangganan pemberitahuan.