Notification - Create Or Update

yayımcı bildirimini API Management oluşturun veya güncelleştirin.

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

URI Parametreleri

Name In Required Type Description
notificationName
path True

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

resourceGroupName
path True
  • string

Kaynak grubunun adı.

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

Microsoft Azure aboneliği benzersiz olarak tanımlayan abonelik kimlik bilgileri. Abonelik kimliği, her hizmet çağrısı için URI'nin bir parçasını oluşturur.

api-version
query True
  • string

İstemci isteğiyle kullanılacak API sürümü.

İstek Başlığı

Name Required Type Description
If-Match
  • string

Varlığın ETag'i. Varlık oluştururken gerekli değildir, ancak varlığı güncelleştirirken gereklidir.

Yanıtlar

Name Type Description
200 OK

Bildirim başarıyla güncelleştirildi.

Other Status Codes

İşlemin neden başarısız olduğunu açıklayan hata yanıtı.

Güvenlik

azure_auth

OAuth2 Flow Azure Active Directory.

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

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"
      ]
    }
  }
}

Tanımlar

ErrorFieldContract

Hata Alanı sözleşmesi.

ErrorResponse

Hata Yanıtı.

NotificationContract

Bildirim ayrıntıları.

NotificationName

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

RecipientsContractProperties

Bildirim Parametresi sözleşmesi.

ErrorFieldContract

Hata Alanı sözleşmesi.

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

Doğrulama hatası durumunda istekte gönderilen geçersiz alanların listesi.

error.message
  • string

Hatanın insan tarafından okunabilir gösterimi.

NotificationContract

Bildirim ayrıntıları.

Name Type Description
id
  • string

Kaynağın tam kaynak kimliği. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name
  • string

Kaynağın adı

properties.description
  • string

Bildirimin açıklaması.

properties.recipients

Alıcı Parametresi değerleri.

properties.title
  • string

Bildirimin başlığı.

type
  • string

Kaynağın türü. Örneğin, "Microsoft.Compute/virtualMachines" veya "Microsoft. Depolama/storageAccounts"

NotificationName

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

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

RecipientsContractProperties

Bildirim Parametresi sözleşmesi.

Name Type Description
emails
  • string[]

Bildirim için abone olunan E-postaların listesi.

users
  • string[]

Bildirim için abone olan Kullanıcıların listesi.