Notification - List By Service

  • Başvuru
Service:
API Management
API Version:
2022-08-01

Bir hizmet örneği içinde tanımlanan özellikler koleksiyonunu listeler.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/notifications?api-version=2022-08-01
With optional parameters: 
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/notifications?$top={$top}&$skip={$skip}&api-version=2022-08-01

URI Parametreleri

Name İçinde Gerekli Tür Description
resourceGroupName
 path True

string

Kaynak grubunun adı. Ad büyük/küçük harfe duyarlı değildir.
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

Hedef aboneliğin kimliği.
api-version
 query True

string

Bu işlem için kullanılacak API sürümü.
$skip
 query

integer

int32

Atacak kayıt sayısı.
$top
 query

integer

int32

Döndürülecek kayıt sayısı.

Yanıtlar

Name Tür Description
200 OK

NotificationCollection

Belirtilen API Management hizmet örneği için Bildirim Koleksiyonu.
Other Status Codes

ErrorResponse

İş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

ApiManagementListNotifications

Sample Request

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

Sample Response

Status code:
200 
{
  "value": [
    {
      "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/notifications/RequestPublisherNotificationMessage/recipientEmails/contoso@live.com",
            "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/RequestPublisherNotificationMessage/recipientEmails/foobar!live",
            "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/RequestPublisherNotificationMessage/recipientEmails/foobar@live.com"
          ],
          "users": [
            "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/576823d0a40f7e74ec07d642"
          ]
        }
      }
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/PurchasePublisherNotificationMessage",
      "type": "Microsoft.ApiManagement/service/notifications",
      "name": "PurchasePublisherNotificationMessage",
      "properties": {
        "title": "New subscriptions",
        "description": "The following email recipients and users will receive email notifications about new API product subscriptions.",
        "recipients": {
          "emails": [
            "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/RequestPublisherNotificationMessage/recipientEmails/contoso@live.com"
          ],
          "users": [
            "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1"
          ]
        }
      }
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/NewApplicationNotificationMessage",
      "type": "Microsoft.ApiManagement/service/notifications",
      "name": "NewApplicationNotificationMessage",
      "properties": {
        "title": "Application gallery requests",
        "description": "The following email recipients and users will receive email notifications when new applications are submitted to the application gallery.",
        "recipients": {
          "emails": [
            "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/RequestPublisherNotificationMessage/recipientEmails/contoso@live.com"
          ],
          "users": []
        }
      }
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/BCC",
      "type": "Microsoft.ApiManagement/service/notifications",
      "name": "BCC",
      "properties": {
        "title": "BCC",
        "description": "The following recipients will receive blind carbon copies of all emails sent to developers.",
        "recipients": {
          "emails": [],
          "users": []
        }
      }
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/NewIssuePublisherNotificationMessage",
      "type": "Microsoft.ApiManagement/service/notifications",
      "name": "NewIssuePublisherNotificationMessage",
      "properties": {
        "title": "New issue or comment",
        "description": "The following email recipients and users will receive email notifications when a new issue or comment is submitted on the developer portal.",
        "recipients": {
          "emails": [],
          "users": [
            "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1"
          ]
        }
      }
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/AccountClosedPublisher",
      "type": "Microsoft.ApiManagement/service/notifications",
      "name": "AccountClosedPublisher",
      "properties": {
        "title": "Close account message",
        "description": "The following email recipients and users will receive email notifications when developer closes his account",
        "recipients": {
          "emails": [
            "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/RequestPublisherNotificationMessage/recipientEmails/contoso@live.com"
          ],
          "users": []
        }
      }
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/QuotaLimitApproachingPublisherNotificationMessage",
      "type": "Microsoft.ApiManagement/service/notifications",
      "name": "QuotaLimitApproachingPublisherNotificationMessage",
      "properties": {
        "title": "Approaching subscription quota limit",
        "description": "The following email recipients and users will receive email notifications when subscription usage gets close to usage quota.",
        "recipients": {
          "emails": [],
          "users": [
            "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1"
          ]
        }
      }
    }
  ],
  "count": 7,
  "nextLink": ""
}

Tanımlar

Name Description
ErrorFieldContract

Hata Alanı sözleşmesi.
ErrorResponse

Hata Yanıtı.
NotificationCollection

Sayfalanmış Bildirim listesi gösterimi.
NotificationContract

Bildirim ayrıntıları.
RecipientsContractProperties

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

ErrorFieldContract[]

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

string

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

NotificationCollection

Sayfalanmış Bildirim listesi gösterimi.

Name Tür Description
count

integer

Tüm sayfalardaki toplam kayıt sayısı.
nextLink

string

Varsa sonraki sayfa bağlantısı.
value

NotificationContract[]

Sayfa değerleri.

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

RecipientsContractProperties

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"

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 olan Kullanıcıların listesi.