Notification - Create Or Update

Crée ou met à jour une notification de l’éditeur Gestion des API.

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

Paramètres URI

Name In Required Type Description
notificationName
path True

Identificateur de nom de notification.

resourceGroupName
path True
  • string

Nom du groupe de ressources.

serviceName
path True
  • string

Nom du service Gestion des API.

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

subscriptionId
path True
  • string

Informations d’identification de l’abonnement qui identifient de manière unique Microsoft Azure abonnement. L’ID d’abonnement fait partie de l’URI pour chaque appel de service.

api-version
query True
  • string

Version de l’API à utiliser avec la demande cliente.

En-tête de la demande

Name Required Type Description
If-Match
  • string

ETag de l’entité. Non obligatoire lors de la création d’une entité, mais obligatoire lors de la mise à jour d’une entité.

Réponses

Name Type Description
200 OK

La notification a été correctement mise à jour.

Other Status Codes

Réponse d’erreur décrivant la raison de l’échec de l’opération.

Sécurité

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 emprunt d’identité de votre compte d’utilisateur

Exemples

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

Définitions

ErrorFieldContract

Contrat de champ d’erreur.

ErrorResponse

Réponse d’erreur.

NotificationContract

Détails de notification.

NotificationName

Identificateur de nom de notification.

RecipientsContractProperties

Contrat de paramètre de notification.

ErrorFieldContract

Contrat de champ d’erreur.

Name Type Description
code
  • string

Code d'erreur de niveau propriété.

message
  • string

Représentation lisible humaine de l’erreur au niveau de la propriété.

target
  • string

Nom de propriété.

ErrorResponse

Réponse d’erreur.

Name Type Description
error.code
  • string

Code d'erreur défini par le service. Ce code sert de sous-état pour le code d'erreur HTTP spécifié dans la réponse.

error.details

Liste des champs non valides envoyés dans la demande, en cas d’erreur de validation.

error.message
  • string

Représentation contrôlable de visu de l’erreur.

NotificationContract

Détails de notification.

Name Type Description
id
  • string

ID de ressource complet pour la ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name
  • string

nom de la ressource.

properties.description
  • string

Description de la notification.

properties.recipients

Valeurs de paramètre du destinataire.

properties.title
  • string

Titre de la notification.

type
  • string

Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft ». Stockage/storageAccounts »

NotificationName

Identificateur de nom de notification.

Name Type Description
AccountClosedPublisher
  • string

Les destinataires et les utilisateurs suivants recevront des notifications par e-mail lorsque le développeur ferme son compte.

BCC
  • string

Les destinataires suivants recevront des copies carbone aveugles de tous les e-mails envoyés aux développeurs.

NewApplicationNotificationMessage
  • string

Les destinataires et les utilisateurs suivants recevront des notifications par e-mail lorsque de nouvelles applications sont envoyées à la galerie d’applications.

NewIssuePublisherNotificationMessage
  • string

Les destinataires et les utilisateurs suivants recevront des notifications par e-mail lorsqu’un nouveau problème ou commentaire est envoyé sur le portail des développeurs.

PurchasePublisherNotificationMessage
  • string

Les destinataires de courrier et les utilisateurs suivants recevront des notifications par e-mail sur les nouveaux abonnements de produit API.

QuotaLimitApproachingPublisherNotificationMessage
  • string

Les destinataires et les utilisateurs suivants recevront des notifications par e-mail lorsque l’utilisation de l’abonnement se rapproche du quota d’utilisation.

RequestPublisherNotificationMessage
  • string

Les destinataires et les utilisateurs suivants recevront des notifications par e-mail sur les demandes d’abonnement pour les produits API nécessitant une approbation.

RecipientsContractProperties

Contrat de paramètre de notification.

Name Type Description
emails
  • string[]

Liste des e-mails abonnés pour la notification.

users
  • string[]

Liste des utilisateurs abonnés à la notification.