Поделиться через

Notification - List By Service

  • Ссылка
Служба:
API Management
Версия API:
2021-08-01

Перечисляет коллекцию свойств, определенных в экземпляре службы.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/notifications?api-version=2021-08-01
С использованием необязательных параметров: 
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/notifications?$top={$top}&$skip={$skip}&api-version=2021-08-01

Параметры URI

Имя В Обязательно Тип Описание
resourceGroupName
 path True

string

Имя группы ресурсов.
serviceName
 path True

string

minLength: 1
maxLength: 50
pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

Имя службы управления API.
subscriptionId
 path True

string

Учетные данные подписки, которые однозначно определяют подписку Microsoft Azure. Идентификатор подписки входит в состав URI для каждого вызова службы.
api-version
 query True

string

Версия API для использования с клиентским запросом.
$skip
 query

integer (int32)

minimum: 0

Количество пропускаемых записей.
$top
 query

integer (int32)

minimum: 1

Количество возвращаемых записей.

Ответы

Имя Тип Описание
200 OK

NotificationCollection

Коллекция уведомлений для указанного экземпляра службы управления API.
Other Status Codes

ErrorResponse

Ответ на ошибку, описывающий причину сбоя операции.

Безопасность

azure_auth

Поток OAuth2 Azure Active Directory.

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя Описание
user_impersonation олицетворения учетной записи пользователя

Примеры

ApiManagementListNotifications

Образец запроса

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

Пример ответа

Код состояния:
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": ""
}

Определения

Имя Описание
ErrorFieldContract

Контракт поля ошибки.
ErrorResponse

Ответ на ошибку.
NotificationCollection

Представление списка уведомлений на странице.
NotificationContract

Сведения о уведомлении.
RecipientsContractProperties

Контракт параметра уведомления.

ErrorFieldContract

Object

Контракт поля ошибки.

Имя Тип Описание
code

string

Код ошибки уровня свойств.
message

string

Удобочитаемое пользователем представление ошибки уровня свойств.
target

string

Имя свойства.

ErrorResponse

Object

Ответ на ошибку.

Имя Тип Описание
error.code

string

Код ошибки, определенный службой. Этот код служит вложенным состоянием для кода ошибки HTTP, указанного в ответе.
error.details

ErrorFieldContract[]

Список недопустимых полей, отправляемых в запросе, в случае ошибки проверки.
error.message

string

Читаемое человеком представление ошибки.

NotificationCollection

Object

Представление списка уведомлений на странице.

Имя Тип Описание
count

integer (int64)

Общее число записей на всех страницах.
nextLink

string

Следующая ссылка на страницу, если она есть.
value

NotificationContract[]

Значения страницы.

NotificationContract

Object

Сведения о уведомлении.

Имя Тип Описание
id

string

Полный идентификатор ресурса для ресурса. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name

string

Имя ресурса
properties.description

string

Описание уведомления.
properties.recipients

RecipientsContractProperties

Значения параметров получателя.
properties.title

string

minLength: 1
maxLength: 1000

Заголовок уведомления.
type

string

Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts"

RecipientsContractProperties

Object

Контракт параметра уведомления.

Имя Тип Описание
emails

string[]

Список сообщений электронной почты, подписанных на уведомление.
users

string[]

Список пользователей, подписанных на уведомление.