Notification - Create Or Update

Создание или обновление уведомления издателя управления API.

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

Параметры URI

Name In Required Type Description
notificationName
path True

Идентификатор имени уведомления.

resourceGroupName
path True
  • string

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

serviceName
path True
  • string

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

Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
path True
  • string

Учетные данные подписки, которые однозначно идентифицируют Microsoft Azure подписке. Идентификатор подписки формирует часть URI для каждого вызова службы.

api-version
query True
  • string

Версия API, используемая с клиентским запросом.

Заголовок запроса

Name Required Type Description
If-Match
  • string

ETag сущности. Не требуется при создании сущности, но требуется при обновлении сущности.

Ответы

Name Type Description
200 OK

Уведомление было успешно обновлено.

Other Status Codes

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

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

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 олицетворения учетной записи пользователя

Примеры

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

Определения

ErrorFieldContract

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

ErrorResponse

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

NotificationContract

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

NotificationName

Идентификатор имени уведомления.

RecipientsContractProperties

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

ErrorFieldContract

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

Name Type Description
code
  • string

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

message
  • string

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

target
  • string

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

ErrorResponse

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

Name Type Description
error.code
  • string

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

error.details

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

error.message
  • string

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

NotificationContract

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

Name Type Description
id
  • string

Полный идентификатор ресурса. Например, /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name
  • string

Имя ресурса.

properties.description
  • string

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

properties.recipients

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

properties.title
  • string

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

type
  • string

Тип ресурса. Например, Microsoft.Compute/virtualMachines или Microsoft. служба хранилища/storageAccounts"

NotificationName

Идентификатор имени уведомления.

Name Type Description
AccountClosedPublisher
  • string

Следующие получатели электронной почты и пользователи получат уведомления по электронной почте, когда разработчик закрывает свою учетную запись.

BCC
  • string

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

NewApplicationNotificationMessage
  • string

Следующие получатели электронной почты и пользователи получат уведомления по электронной почте при отправке новых приложений в коллекцию приложений.

NewIssuePublisherNotificationMessage
  • string

Следующие получатели электронной почты и пользователи получат уведомления по электронной почте при отправке нового сообщения или комментария на портале разработчика.

PurchasePublisherNotificationMessage
  • string

Следующие получатели электронной почты и пользователи получат уведомления по электронной почте о новых подписках на продукты API.

QuotaLimitApproachingPublisherNotificationMessage
  • string

Следующие получатели электронной почты и пользователи будут получать уведомления по электронной почте, когда использование подписки приближается к квоте использования.

RequestPublisherNotificationMessage
  • string

Следующие получатели электронной почты и пользователи получат уведомления по электронной почте о запросах на подписку для продуктов API, требующих утверждения.

RecipientsContractProperties

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

Name Type Description
emails
  • string[]

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

users
  • string[]

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