Notification - Create Or Update

  • Ссылка
Service:
API Management
API Version:
2022-08-01

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

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

Параметры URI

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

NotificationName

Идентификатор имени уведомления.
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

Идентификатор целевой подписки.
api-version
 query True

string

Версия API, используемая для данной операции.

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

Имя Обязательно Тип Описание
If-Match

string

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

Ответы

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

NotificationContract

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

ErrorResponse

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

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

azure_auth

Поток OAuth2 в Azure Active Directory.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

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

Примеры

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

Status code:
200 
{
  "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

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

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

string

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

string

Понятное представление ошибки на уровне свойств.
target

string

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

ErrorResponse

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

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

string

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

ErrorFieldContract[]

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

string

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

NotificationContract

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

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

string

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

string

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

string

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

RecipientsContractProperties

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

string

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

string

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

NotificationName

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

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

string

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

string

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

string

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

string

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

string

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

string

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

string

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

RecipientsContractProperties

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

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

string[]

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

string[]

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