Ce document explique comment créer un abonnement push. Vous pouvez utiliser la console Google Cloud, la Google Cloud CLI, la bibliothèque cliente ou l'API Pub/Sub pour créer un abonnement push.
Avant de commencer
- En savoir plus sur les abonnements
- Découvrez le fonctionnement des abonnements push.
Rôles et autorisations requis
Pour créer un abonnement, vous devez configurer le contrôle des accès au niveau du projet. Vous avez également besoin d'autorisations au niveau des ressources si vos abonnements et vos sujets se trouvent dans des projets différents, comme expliqué plus loin dans cette section.
Pour obtenir les autorisations nécessaires pour créer des abonnements push, demandez à votre administrateur de vous attribuer le rôle IAM Éditeur Pub/Sub (roles/pubsub.editor
) sur le projet.
Pour en savoir plus sur l'attribution de rôles, consultez la section Gérer les accès.
Ce rôle prédéfini contient les autorisations requises pour créer des abonnements push. Pour connaître les autorisations exactes requises, développez la section Autorisations requises :
Autorisations requises
Les autorisations suivantes sont requises pour créer des abonnements push:
-
Créer un abonnement :
pubsub.subscriptions.create
-
Supprimer un abonnement :
pubsub.subscriptions.delete
-
Obtenir un abonnement :
pubsub.subscriptions.get
-
Répertorier un abonnement :
pubsub.subscriptions.list
-
Mettre à jour un abonnement :
pubsub.subscriptions.update
-
Associer un abonnement à un sujet :
pubsub.topics.attachSubscription
-
Obtenez la stratégie IAM d'un abonnement :
pubsub.subscriptions.getIamPolicy
-
Configurez la stratégie IAM pour un abonnement :
pubsub.subscriptions.setIamPolicy
Vous pouvez également obtenir ces autorisations avec des rôles personnalisés ou d'autres rôles prédéfinis.
Si vous devez créer des abonnements push dans un projet qui sont associés à un sujet d'un autre projet, demandez à l'administrateur du sujet de vous accorder également le rôle IAM (roles/pubsub.editor)
Éditeur Pub/Sub sur le sujet.
Propriétés d'abonnement push
Lorsque vous configurez un abonnement push, vous pouvez spécifier les propriétés suivantes.
Propriétés communes
Découvrez les propriétés d'abonnement communes que vous pouvez définir pour tous les abonnements.
Points de terminaison
URL du point de terminaison (obligatoire). Adresse HTTPS accessible publiquement. Le serveur du point de terminaison push doit disposer d'un certificat SSL valide signé par une autorité de certification. Le service Pub/Sub envoie les messages aux points de terminaison push situés dans la région Google Cloud où le service stocke les messages. Le service Pub/Sub distribue les messages provenant de la même région Google Cloud de la manière la plus optimale possible.
Pub/Sub n'a plus besoin de preuve de propriété pour les domaines d'URL d'abonnement push. Si votre domaine reçoit des requêtes POST inattendues de la part de Pub/Sub, vous pouvez signaler un abus présumé.
Authentification
Activez l'authentification. Lorsque cette option est activée, les messages distribués par Pub/Sub au point de terminaison push incluent un en-tête d'autorisation pour permettre au point de terminaison d'authentifier la requête. Des mécanismes d'authentification et d'autorisation automatiques sont disponibles pour les points de terminaison de l'environnement standard App Engine et de Cloud Functions hébergés dans le même projet que l'abonnement.
La configuration de l'authentification pour un abonnement push authentifié se compose d'un compte de service géré par l'utilisateur et des paramètres d'audience spécifiés dans un appel create, patch ou ModifyPushConfig. Vous devez également attribuer un rôle spécifique à un agent de service, comme indiqué dans la section suivante.
Compte de service géré par l'utilisateur (obligatoire). Compte de service associé à l'abonnement push. Ce compte est utilisé comme revendication
email
du jeton Web JSON (JWT) généré. Voici la liste des conditions requises pour le compte de service:Ce compte de service doit se trouver dans le même projet que l'abonnement push.
Le compte principal qui crée ou modifie l'abonnement push doit disposer de l'autorisation
iam.serviceAccounts.actAs
sur le compte de service. Vous pouvez accorder un rôle doté de cette autorisation sur le projet, le dossier ou l'organisation pour permettre à l'appelant d'emprunter l'identité de plusieurs comptes de service, ou attribuer un rôle disposant de cette autorisation sur le compte de service pour permettre à l'appelant d'emprunter uniquement l'identité de ce compte de service.
Audience : Chaîne unique non sensible à la casse, utilisée par le webhook pour valider l'audience visée par ce jeton particulier.
Agent de service (obligatoire).
Pub/Sub crée automatiquement un compte de service au format
service-{PROJECT_NUMBER}@gcp-sa-pubsub.iam.gserviceaccount.com
.Cet agent de service doit disposer de l'autorisation
iam.serviceAccounts.getOpenIdToken
(incluse dans le rôleroles/iam.serviceAccountTokenCreator
) pour permettre à Pub/Sub de créer des jetons JWT pour les requêtes push authentifiées.
Désencapsulation de la charge utile
L'option Enable payload unwrapping (Activer la désencapsulation de la charge utile) supprime les messages Pub/Sub de toutes les métadonnées des messages, à l'exception de leurs données. Avec la désencapsulation de la charge utile, les données du message sont transmises directement en tant que corps HTTP.
- Écrire des métadonnées Il ajoute les métadonnées de message précédemment supprimées dans l'en-tête de requête.
VPC Service Controls
Pour un projet protégé par VPC Service Controls, tenez compte des limites suivantes concernant les abonnements push:
Vous ne pouvez créer que des abonnements push pour lesquels le point de terminaison push est défini sur un service Cloud Run avec une URL
run.app
par défaut ou une exécution de Workflows. Les domaines personnalisés ne fonctionnent pas.Lorsque vous acheminez des événements via Eventarc vers des destinations Workflows pour lesquelles le point de terminaison push est défini sur une exécution de Workflows, vous ne pouvez créer des abonnements push que via Eventarc.
Vous ne pouvez pas mettre à jour les abonnements push existants. Ces abonnements push continuent de fonctionner, bien qu'ils ne soient pas protégés par VPC Service Controls.
Créer un abonnement push
Les exemples suivants montrent comment créer un abonnement avec distribution push à l'aide des paramètres par défaut fournis.
Par défaut, les abonnements utilisent la distribution pull, sauf si vous définissez explicitement une configuration push, comme illustré dans les exemples suivants.
Console
Pour créer un abonnement push, procédez comme suit:
- Dans la console Google Cloud, accédez à la page Abonnements.
- Cliquez sur Créer un abonnement.
- Dans le champ ID d'abonnement, saisissez un nom.
Pour savoir comment nommer un abonnement, consultez Consignes pour nommer un sujet ou un abonnement.
- Choisissez ou créez un sujet dans le menu déroulant. L'abonnement reçoit les messages du sujet.
- Sélectionnez Push dans le champ Type de distribution.
- Spécifiez une URL de point de terminaison.
- Conservez toutes les autres valeurs par défaut.
- Cliquez sur Créer.
Vous pouvez également créer un abonnement à partir de la section Sujets. Ce raccourci est utile pour associer des sujets à des abonnements.
- Dans la console Google Cloud, accédez à la page Sujets.
- Cliquez sur more_vert à côté du sujet pour lequel vous souhaitez créer un abonnement.
- Dans le menu contextuel, sélectionnez Créer un abonnement.
- Saisissez l'ID de l'abonnement.
Pour savoir comment nommer un abonnement, consultez Consignes pour nommer un sujet ou un abonnement.
- Sélectionnez Push dans le champ Type de distribution.
- Spécifiez une URL de point de terminaison.
- Conservez toutes les autres valeurs par défaut.
- Cliquez sur Créer.
gcloud
-
Dans la console Google Cloud, activez Cloud Shell.
En bas de la fenêtre de la console Google Cloud, une session Cloud Shell démarre et affiche une invite de ligne de commande. Cloud Shell est un environnement shell dans lequel Google Cloud CLI est déjà installé, et dans lequel des valeurs sont déjà définies pour votre projet actuel. L'initialisation de la session peut prendre quelques secondes.
-
Pour créer un abonnement push, exécutez la commande
gcloud pubsub subscriptions create
.gcloud pubsub subscriptions create SUBSCRIPTION_ID \ --topic=TOPIC_ID \ --push-endpoint=PUSH_ENDPOINT
Remplacez les éléments suivants :
SUBSCRIPTION_ID
: nom ou ID de votre nouvel abonnement push.TOPIC_ID
: nom ou ID de votre thème.- PUSH_ENDPOINT: URL à utiliser comme point de terminaison pour cet abonnement.
Exemple :
https://myproject.appspot.com/myhandler
REST
Pour créer un abonnement push, utilisez la méthode projects.subscriptions.create
:
Requête :
La demande doit être authentifiée à l'aide d'un jeton d'accès dans l'en-tête Authorization
. Pour obtenir un jeton d'accès pour les identifiants par défaut actuels de l'application, exécutez la commande suivante : gcloud auth application-default print-access-token.
PUT https://pubsub.googleapis.com/v1/projects/PROJECT_ID/subscriptions/SUBSCRIPTION_ID Authorization: Bearer ACCESS_TOKEN
Corps de la requête :
{ "topic": "projects/PROJECT_ID/topics/TOPIC_ID", // Only needed if you are using push delivery "pushConfig": { "pushEndpoint": "PUSH_ENDPOINT" } }
Où :
https://myproject.appspot.com/myhandler
Solution :
{ "name": "projects/PROJECT_ID/subscriptions/SUBSCRIPTION_ID", "topic": "projects/PROJECT_ID/topics/TOPIC_ID", "pushConfig": { "pushEndpoint": "https://PROJECT_ID.appspot.com/myhandler", "attributes": { "x-goog-version": "v1" } }, "ackDeadlineSeconds": 10, "messageRetentionDuration": "604800s", "expirationPolicy": { "ttl": "2678400s" } }
C++
Avant d'essayer cet exemple, suivez les instructions d'installation dans le langage C++ qui se trouvent sur la page Démarrage rapide : utiliser des bibliothèques clientes. Pour en savoir plus, consultez la documentation de référence sur l'API Pub/Sub pour C++.
C#
Avant d'essayer cet exemple, suivez les instructions de configuration de C# dans le guide de démarrage rapide de Pub/Sub avec des bibliothèques clientes. Pour en savoir plus, consultez la documentation de référence de l'API Pub/Sub C#.
Pour vous authentifier auprès de Pub/Sub, configurez les Identifiants par défaut de l'application. Pour en savoir plus, consultez la page Configurer l'authentification pour les bibliothèques clientes.
Go
Avant d'essayer cet exemple, suivez les instructions de configuration de Go dans le guide de démarrage rapide de Pub/Sub avec des bibliothèques clientes. Pour en savoir plus, consultez la documentation de référence de l'API Pub/Sub Go.
Pour vous authentifier auprès de Pub/Sub, configurez les Identifiants par défaut de l'application. Pour en savoir plus, consultez la page Configurer l'authentification pour les bibliothèques clientes.
Java
Avant d'essayer cet exemple, suivez les instructions de configuration de Java dans le guide de démarrage rapide de Pub/Sub avec des bibliothèques clientes. Pour en savoir plus, consultez la documentation de référence de l'API Pub/Sub Java.
Pour vous authentifier auprès de Pub/Sub, configurez les Identifiants par défaut de l'application. Pour en savoir plus, consultez la page Configurer l'authentification pour les bibliothèques clientes.
Node.js
Node.js
PHP
Avant d'essayer cet exemple, suivez les instructions de configuration de PHP dans le guide de démarrage rapide de Pub/Sub avec des bibliothèques clientes. Pour en savoir plus, consultez la documentation de référence de l'API Pub/Sub PHP.
Pour vous authentifier auprès de Pub/Sub, configurez les Identifiants par défaut de l'application. Pour en savoir plus, consultez la page Configurer l'authentification pour les bibliothèques clientes.
Python
Avant d'essayer cet exemple, suivez les instructions de configuration de Python dans le guide de démarrage rapide de Pub/Sub avec des bibliothèques clientes. Pour en savoir plus, consultez la documentation de référence de l'API Pub/Sub Python.
Pour vous authentifier auprès de Pub/Sub, configurez les Identifiants par défaut de l'application. Pour en savoir plus, consultez la page Configurer l'authentification pour les bibliothèques clientes.
Ruby
Avant d'essayer cet exemple, suivez les instructions de configuration de Ruby dans le guide de démarrage rapide de Pub/Sub avec des bibliothèques clientes. Pour en savoir plus, consultez la documentation de référence de l'API Pub/Sub Ruby.
Pour vous authentifier auprès de Pub/Sub, configurez les Identifiants par défaut de l'application. Pour en savoir plus, consultez la page Configurer l'authentification pour les bibliothèques clientes.
Étapes suivantes
- Créer ou modifier un abonnement à l'aide de commandes
gcloud
- créer ou modifier un abonnement à l'aide des API REST ;