Notification - Create Or Update
Yayımcı bildirimi 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=2022-08-01
URI Parametreleri
Name | İçinde | Gerekli | Tür | Description |
---|---|---|---|---|
notification
|
path | True |
Bildirim Adı Tanımlayıcısı. |
|
resource
|
path | True |
string |
Kaynak grubunun adı. Ad büyük/küçük harfe duyarlı değildir. |
service
|
path | True |
string |
API Management hizmetinin adı. Regex pattern: |
subscription
|
path | True |
string |
Hedef aboneliğin kimliği. |
api-version
|
query | True |
string |
Bu işlem için kullanılacak API sürümü. |
İstek Başlığı
Name | Gerekli | Tür | Description |
---|---|---|---|
If-Match |
string |
Varlığın ETag'i. Varlık oluştururken gerekli değildir, ancak varlığı güncelleştirirken gereklidir. |
Yanıtlar
Name | Tür | 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
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
ApiManagementCreateNotification
Sample Request
PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/RequestPublisherNotificationMessage?api-version=2022-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
Name | Description |
---|---|
Error |
Hata Alanı sözleşmesi. |
Error |
Hata Yanıtı. |
Notification |
Bildirim ayrıntıları. |
Notification |
Bildirim Adı Tanımlayıcısı. |
Recipients |
Bildirim Parametresi sözleşmesi. |
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 |
Doğrulama hatası durumunda istekte gönderilen geçersiz alanların listesi. |
|
error.message |
string |
Hatanın insan tarafından okunabilen gösterimi. |
NotificationContract
Bildirim 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.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.Storage/storageAccounts" |
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. |
RecipientsContractProperties
Bildirim Parametresi sözleşmesi.
Name | Tür | Description |
---|---|---|
emails |
string[] |
Bildirim için abone olunan e-postaların listesi. |
users |
string[] |
Bildirim için abone olunan kullanıcıların listesi. |