Notification - Create Or Update

Crea o actualiza la notificación del publicador de API Management.

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

Parámetros de identificador URI

Name In Required Type Description
notificationName
path True

Identificador de nombre de notificación.

resourceGroupName
path True
  • string

Nombre del grupo de recursos.

serviceName
path True
  • string

Nombre del servicio API Management.

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

subscriptionId
path True
  • string

Credenciales de suscripción que identifican de forma única Microsoft Azure suscripción. El identificador de suscripción forma parte del URI para cada llamada al servicio.

api-version
query True
  • string

Versión de la API que se va a usar con la solicitud de cliente.

Encabezado de la solicitud

Name Required Type Description
If-Match
  • string

ETag de la entidad. No es necesario al crear una entidad, pero es necesario al actualizar una entidad.

Respuestas

Name Type Description
200 OK

La notificación se actualizó correctamente.

Other Status Codes

Respuesta de error que describe el motivo del error de la operación.

Seguridad

azure_auth

Azure Active Directory Flow OAuth2.

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

Scopes

Name Description
user_impersonation suplantar la cuenta de usuario

Ejemplos

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

Definiciones

ErrorFieldContract

Contrato de campo de error.

ErrorResponse

Respuesta de error.

NotificationContract

Detalles de la notificación.

NotificationName

Identificador de nombre de notificación.

RecipientsContractProperties

Contrato de parámetro de notificación.

ErrorFieldContract

Contrato de campo de error.

Name Type Description
code
  • string

Código de error de nivel de propiedad.

message
  • string

Representación legible del error de nivel de propiedad.

target
  • string

Nombre de propiedad.

ErrorResponse

Respuesta de error.

Name Type Description
error.code
  • string

Código del error definido por el servicio. Este código funciona como estado secundario del código de error HTTP especificado en la respuesta.

error.details

La lista de campos no válidos que se envían en la solicitud, en caso de error de validación.

error.message
  • string

Representación legible del error.

NotificationContract

Detalles de la notificación.

Name Type Description
id
  • string

Identificador de recurso completo del recurso. Por ejemplo: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name
  • string

Nombre del recurso.

properties.description
  • string

Descripción de la notificación.

properties.recipients

Valores de parámetro del destinatario.

properties.title
  • string

Título de la notificación.

type
  • string

Tipo de recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft. Storage/storageAccounts"

NotificationName

Identificador de nombre de notificación.

Name Type Description
AccountClosedPublisher
  • string

Los siguientes destinatarios de correo electrónico y usuarios recibirán notificaciones por correo electrónico cuando el desarrollador cierre su cuenta.

BCC
  • string

Los siguientes destinatarios recibirán copias de carbono ciegas de todos los correos electrónicos enviados a los desarrolladores.

NewApplicationNotificationMessage
  • string

Los siguientes destinatarios de correo electrónico y usuarios recibirán notificaciones por correo electrónico cuando se envíen nuevas aplicaciones a la galería de aplicaciones.

NewIssuePublisherNotificationMessage
  • string

Los siguientes destinatarios de correo electrónico y usuarios recibirán notificaciones por correo electrónico cuando se envíe un nuevo problema o comentario en el portal para desarrolladores.

PurchasePublisherNotificationMessage
  • string

Los siguientes destinatarios de correo electrónico y usuarios recibirán notificaciones por correo electrónico sobre las nuevas suscripciones de producto de API.

QuotaLimitApproachingPublisherNotificationMessage
  • string

Los siguientes destinatarios de correo electrónico y usuarios recibirán notificaciones por correo electrónico cuando el uso de la suscripción se acerque a la cuota de uso.

RequestPublisherNotificationMessage
  • string

Los siguientes destinatarios de correo electrónico y usuarios recibirán notificaciones por correo electrónico sobre las solicitudes de suscripción para los productos de API que requieren aprobación.

RecipientsContractProperties

Contrato de parámetro de notificación.

Name Type Description
emails
  • string[]

Lista de correos electrónicos suscritos para la notificación.

users
  • string[]

Lista de usuarios suscritos para la notificación.