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

Workspace Notification Recipient User - Create Or Update

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

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

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/notifications/{notificationName}/recipientUsers/{userId}?api-version=2024-05-01

Параметры URI

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

NotificationName

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

string

minLength: 1
maxLength: 90

Имя группы ресурсов. Имя не учитывает регистр.
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 (uuid)

Идентификатор целевой подписки. Значение должно быть UUID.
userId
 path True

string

minLength: 1
maxLength: 80

Идентификатор пользователя. Должен быть уникальным в текущем экземпляре службы управления API.
workspaceId
 path True

string

minLength: 1
maxLength: 80
pattern: ^[^*#&+:<>?]+$

Идентификатор рабочей области. Должен быть уникальным в текущем экземпляре службы управления API.
api-version
 query True

string

minLength: 1

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

Ответы

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

RecipientUserContract

Пользователь-получатель уже входит в список уведомлений.
201 Created

RecipientUserContract

Пользователь получателя успешно добавлен в список уведомлений.
Other Status Codes

ErrorResponse

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

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

azure_auth

Поток OAuth2 Azure Active Directory.

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

Области

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

Примеры

ApiManagementCreateWorkspaceNotificationRecipientUser

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

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/notifications/RequestPublisherNotificationMessage/recipientUsers/576823d0a40f7e74ec07d642?api-version=2024-05-01

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

Код состояния:
201 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/notifications/RequestPublisherNotificationMessage/recipientUsers/576823d0a40f7e74ec07d642",
  "type": "Microsoft.ApiManagement/service/workspaces/notifications/recipientUsers",
  "name": "576823d0a40f7e74ec07d642",
  "properties": {
    "userId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/576823d0a40f7e74ec07d642"
  }
}
Код состояния:
200 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/notifications/RequestPublisherNotificationMessage/recipientUsers/576823d0a40f7e74ec07d642",
  "type": "Microsoft.ApiManagement/service/workspaces/notifications/recipientUsers",
  "name": "576823d0a40f7e74ec07d642",
  "properties": {
    "userId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/576823d0a40f7e74ec07d642"
  }
}

Определения

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

Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail

Сведения об ошибке.
ErrorResponse

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

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

Сведения о пользователе получателя.

ErrorAdditionalInfo

Object

Дополнительные сведения об ошибке управления ресурсами.

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

object

Дополнительные сведения.
type

string

Дополнительный тип сведений.

ErrorDetail

Object

Сведения об ошибке.

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

ErrorAdditionalInfo[]

Дополнительные сведения об ошибке.
code

string

Код ошибки.
details

ErrorDetail[]

Сведения об ошибке.
message

string

Сообщение об ошибке.
target

string

Целевой объект ошибки.

ErrorResponse

Object

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

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

ErrorDetail

Объект ошибки.

NotificationName

Перечисление

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

Значение Описание
AccountClosedPublisher

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

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

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

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

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

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

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

RecipientUserContract

Object

Сведения о пользователе получателя.

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

string

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

string

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

string

UserId управления API подписан на уведомление.
type

string

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