text stringlengths 0 3.99k | embedding listlengths 768 768 | metadata dict |
|---|---|---|
Points essentiels :
La commande terraform plan crée un plan d’exécution, mais ne l’exécute pas. Au lieu de
cela, elle détermine les actions nécessaires pour créer la configuration spécifiée dans vos
fichiers de configuration. Ce modèle vous permet de vérifier si le plan d’exécution répond
à vos attentes avant d’apporter des modifications aux ressources réelles.
Le paramètre facultatif -out vous permet de spécifier un fichier de sortie pour le plan.
L’utilisation du paramètre -out garantit que le plan que vous avez examiné correspond
exactement à ce qui est appliqué.
Exécutez terraform apply
pour appliquer le plan d’exécution à votre infrastructure cloud.
Console
Points essentiels :
La commande exemple terraform apply part du principe que vous avez préalablement
exécuté terraform plan -out main.tfplan .
Si vous avez spécifié un autre nom de fichier pour le paramètre -out , utilisez ce même
nom dans l’appel à terraform apply .
Si vous n’avez pas utilisé le paramètre -out , appelez terraform apply sans aucun
paramètre.
1. Obtenez le nom du groupe de ressources Azure.
Console
Appliquer un plan d’exécution Terraform
terraform apply main.tfplan
7 Notes
La création et l’activation d’un service de gestion des API peuvent prendre 30 à 40
minutes.
Vérifier les résultats
Azure CLI | [
0.020107822492718697,
-0.013112974353134632,
-0.027046116068959236,
-0.0349886454641819,
0.07157321274280548,
0.06777295470237732,
0.01673116348683834,
0.020201301202178,
-0.002976810559630394,
-0.06270810216665268,
-0.05636481195688248,
-0.012902154587209225,
-0.04579472169280052,
0.02589... | {
"azure_component": "network",
"chunk_index": 300,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "165",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
2. Obtenez le nom du service.
Console
3. Exécutez az apim show pour afficher des informations sur le nouveau service.
Azure CLI
Quand vous n’avez plus besoin des ressources créées par le biais de Terraform, effectuez les
étapes suivantes :
1. Exécutez le plan Terraform
et spécifiez l’indicateur destroy .
Console
Points essentiels :
La commande terraform plan crée un plan d’exécution, mais ne l’exécute pas. Au
lieu de cela, elle détermine les actions nécessaires pour créer la configuration
spécifiée dans vos fichiers de configuration. Ce modèle vous permet de vérifier si le
plan d’exécution répond à vos attentes avant d’apporter des modifications aux
ressources réelles.
Le paramètre facultatif -out vous permet de spécifier un fichier de sortie pour le
plan. L’utilisation du paramètre -out garantit que le plan que vous avez examiné
correspond exactement à ce qui est appliqué.
2. Exécutez terraform apply
pour appliquer le plan d’exécution.
Console
resource_group_name=$(terraform output -raw resource_group_name)
api_management_service_name=$(terraform output -raw
api_management_service_name)
az apim show --resource-group $resource_group_name \
--name $api_management_service_name
Nettoyer les ressources
terraform plan -destroy -out main.destroy.tfplan | [
-0.0030256547033786774,
0.02606384828686714,
-0.05112456902861595,
-0.04289872199296951,
0.06283847987651825,
0.048577722162008286,
0.03219199925661087,
0.041494276374578476,
-0.008073068223893642,
-0.06173311173915863,
-0.04836607351899147,
0.0031061817426234484,
-0.06066186726093292,
0.0... | {
"azure_component": "network",
"chunk_index": 301,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "166",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
Résoudre les problèmes courants liés à l’utilisation de Terraform sur Azure
) Remarque : L’auteur a créé cet article avec l’aide de l’IA. En savoir plus
terraform apply main.destroy.tfplan
Résoudre les problèmes liés à Terraform sur Azure
Étapes suivantes
Tutoriel : Importer et publier votre première API | [
0.011305340565741062,
-0.021961789578199387,
-0.012511193752288818,
0.020598154515028,
0.06047018989920616,
0.043756306171417236,
0.011661483906209469,
0.044127460569143295,
-0.01311430986970663,
-0.059975240379571915,
-0.031764522194862366,
-0.0011883660918101668,
-0.07487291097640991,
0.... | {
"azure_component": "network",
"chunk_index": 302,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "167",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
Tutoriel : Importer et publier votre
première API
Article • 03/03/2025
S’APPLIQUE À : tous les niveaux de Gestion des API
Ce tutoriel montre comment importer une API back-end de la spécification OpenAPI au
format JSON dans Gestion des API Azure. Pour cet exemple, vous importez l’API
Petstore
open source.
Une fois que vous avez importé l’API back-end dans Gestion des API, votre API du
service Gestion des API devient une façade pour l’API back-end. Vous pouvez
personnaliser la façade selon vos besoins dans Gestion des API sans toucher à l’API
back-end. Pour plus d’informations, consultez Transformer et protéger votre API.
Dans ce tutoriel, vous allez apprendre à :
Après l’importation, vous pouvez gérer l’API dans le portail Azure.
Conseil
Les équipes d’API peuvent utiliser cette fonctionnalité dans des espaces de travail.
Les espaces de travail fournissent un accès d’administration isolé aux API et à leurs
propres environnements d’exécution d’API.
Importer une API dans Gestion des API
"
Tester l’API dans le portail Azure
"
| [
-0.019480306655168533,
-0.006729864049702883,
-0.02412373386323452,
-0.0065321181900799274,
0.014690391719341278,
0.02392416074872017,
0.046088624745607376,
0.0521383173763752,
-0.03619071841239929,
-0.02524641901254654,
-0.035827286541461945,
-0.05747928097844124,
-0.06752253323793411,
0.... | {
"azure_component": "network",
"chunk_index": 303,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "168",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
Comprendre la terminologie relative au service Gestion des API Azure
Créer une instance du service Gestion des API Azure.
1. Dans le Portail
Azure, recherchez et sélectionnez Services API Management.
2. Dans la page Services Gestion des API, sélectionnez votre instance Gestion des
API.
Cette section montre comment importer et publier une API de serveur principal à la
spécification OpenAPI.
Prérequis
Accéder à votre instance Gestion des API
Importer et publier une API back-end | [
-0.04934833571314812,
0.006374811287969351,
-0.0027496383991092443,
-0.0036102035082876682,
0.01931367628276348,
0.020499752834439278,
0.03854145482182503,
0.03386503458023071,
-0.03735173121094704,
-0.027300402522087097,
-0.023689983412623405,
-0.053724255412817,
-0.05606631934642792,
0.0... | {
"azure_component": "network",
"chunk_index": 304,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "169",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
1. Dans le volet de navigation gauche de votre instance du service Gestion des API,
sélectionnez API.
2. Sélectionnez la vignette OpenAPI.
3. Dans la fenêtre Créer à partir de la spécification OpenAPI, sélectionnez Complet.
4. Entrez les valeurs du tableau suivant.
Vous pouvez définir les valeurs de l’API au moment de la création, ou un peu plus
tard en accédant à l’onglet Paramètres.
Paramètre
valeur
Description
Spécification
OpenAPI
https://petstore3.swagger.io/api/v3/openapi.json
Spécifie le service
back-end
implémentant l’API et
les opérations que
l’API prend en charge.
L’URL du service
principal apparaît
ノ
Agrandir le tableau | [
-0.040528178215026855,
-0.007469125557690859,
0.026009904220700264,
-0.010143199935555458,
0.0236995667219162,
0.03962903842329979,
0.009554139338433743,
0.03866982460021973,
-0.05195179581642151,
-0.04882723465561867,
-0.025131260976195335,
-0.03379915654659271,
-0.05126982927322388,
0.01... | {
"azure_component": "network",
"chunk_index": 305,
"contains_sku": true,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "170",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
Paramètre
valeur
Description
ultérieurement en tant
qu’URL du service
Web dans la page
Paramètres de l’API.
Après l’importation,
vous pouvez ajouter,
modifier, renommer ou
supprimer des
opérations dans la
spécification.
Inclure des
paramètres
de requête
dans les
modèles
d’opération
Activée (par défaut)
Spécifie s’il faut
importer les
paramètres de requête
requis dans la
spécification en tant
que paramètres de
modèle dans Gestion
des API.
Nom complet
Une fois que vous avez entré l’URL de
spécification OpenAPI, Gestion des API remplit
ce champ en fonction du contenu JSON.
Nom affiché dans le
portail des
développeurs.
Nom
Une fois que vous avez entré l’URL de
spécification OpenAPI, Gestion des API remplit
ce champ en fonction du contenu JSON.
Nom unique de l’API.
Description
Une fois que vous avez entré l’URL de
spécification OpenAPI, Gestion des API remplit
ce champ en fonction du contenu JSON.
Description facultative
de l’API.
Modèle
d’URL
HTTPS
Protocoles pouvant
accéder à l’API.
Suffixe de
l’URL de l’API
petstore
Suffixe ajouté à l’URL
de base du service
Gestion des API. Le
service Gestion des API
distingue les API par
leur suffixe. Ainsi, ce
dernier doit être
unique pour chaque
API d’un éditeur
donné.
Balises
Étiquettes permettant
d’organiser les API | [
-0.023913707584142685,
-0.010895523242652416,
-0.020198378711938858,
-0.04762233793735504,
0.010990778915584087,
0.03790782019495964,
0.036139730364084244,
0.03680375963449478,
-0.04253242164850235,
-0.03969796746969223,
-0.04110509157180786,
-0.054386209696531296,
-0.048771459609270096,
0... | {
"azure_component": "network",
"chunk_index": 306,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "171",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
Paramètre
valeur
Description
pour la recherche, le
regroupement ou le
filtrage.
Produits
Illimité
Association d’une ou
de plusieurs API. Dans
certains niveaux,
l’instance Gestion des
API est fournie avec
deux exemples de
produits : Starter et
Unlimited. Vous
publiez une API dans le
portail des
développeurs en
associant l’API à un
produit.
Vous pouvez inclure
plusieurs API dans un
produit et proposer
des abonnements aux
développeurs via le
portail des
développeurs. Pour
ajouter cette API à un
autre produit, tapez ou
sélectionnez le nom du
produit. Répétez cette
étape pour ajouter
l’API à plusieurs
produits. Vous pouvez
également ajouter des
API aux produits plus
tard à partir de la page
Paramètres.
Pour plus
d’informations sur les
produits, consultez
Créer et publier un
produit.
Passerelles
Managé
La ou les passerelles
API qui exposent l’API.
Ce champ est
disponible uniquement
dans les services des | [
0.015179558657109737,
0.011235198006033897,
-0.016040850430727005,
-0.00914820097386837,
0.048612888902425766,
0.07684637606143951,
0.018903113901615143,
-0.005815861746668816,
-0.031347211450338364,
-0.007203533314168453,
-0.0184464268386364,
-0.04780528321862221,
-0.06637006998062134,
0.... | {
"azure_component": "network",
"chunk_index": 307,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "172",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
Paramètre
valeur
Description
niveaux Développeur
et Premium.
Managée indique la
passerelle intégrée au
service Gestion des API
et hébergée par
Microsoft dans Azure.
Les passerelles auto-
hébergées sont
disponibles seulement
dans les niveaux de
service Premium et
Développeur. Vous
pouvez les déployer
localement ou dans
d’autres clouds.
Si aucune passerelle
n’est sélectionnée, l’API
n’est pas disponible et
vos demandes d’API
n’aboutissent pas.
Créer une
version pour
cette API ?
Sélectionner ou désélectionner
Pour plus
d’informations,
consultez Publier
plusieurs versions
d’une API de manière
prévisible.
5. Sélectionnez Créer pour créer votre API.
Si vous rencontrez des problèmes au moment de l’importation d’une définition d’API,
consultez la liste des problèmes et restrictions connus.
Vous pouvez appeler les opérations d’API directement à partir du portail Azure, qui offre
un moyen pratique de voir et de tester les opérations. Dans la console de test du portail,
par défaut, les API sont appelées à l’aide d’une clé de l’abonnement tout accès intégré.
Vous pouvez également tester les appels d’API à l’aide d’une clé d’abonnement limitée à
un produit.
Tester la nouvelle API dans le Portail Azure | [
-0.005555777344852686,
0.025361914187669754,
-0.01962815783917904,
0.0021385785657912493,
0.04018304869532585,
0.04734453186392784,
0.027219900861382484,
0.02388681285083294,
-0.034696124494075775,
-0.06110454723238945,
-0.037008319050073624,
-0.05552462860941887,
-0.04760205000638962,
0.0... | {
"azure_component": "network",
"chunk_index": 308,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "173",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
1. Dans le volet de navigation de gauche de votre instance Gestion des API,
sélectionnez API>Swagger Petstore.
2. Sélectionnez l’onglet Test, puis Finds Pets by status (Recherche d’animaux par
disponibilité). La page affiche le paramètre de requêtestatus. Sélectionnez l’une
des valeurs disponibles, telles que pending (en attente). Vous pouvez également
ajouter des paramètres de requête et des en-têtes ici.
Dans la section requête HTTP, l’en-tête Ocp-Apim-Subscription-Key est renseigné
automatiquement pour vous, ce que vous pouvez voir si vous sélectionnez l’icône
« œil ».
3. Sélectionnez Envoyer.
Le back-end répond avec 200 OK et des données.
Dans ce didacticiel, vous avez appris à :
Étapes suivantes
Importer votre première API
" | [
-0.046159595251083374,
-0.07203909009695053,
0.007295512594282627,
0.001835931558161974,
0.031298790127038956,
0.05020666867494583,
0.0270862877368927,
0.039345212280750275,
-0.028928004205226898,
-0.05726812407374382,
-0.0400986522436142,
-0.00806503277271986,
-0.053715988993644714,
-0.02... | {
"azure_component": "network",
"chunk_index": 309,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "174",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
Commentaires
Cette page a-t-elle été utile ?
Indiquer des commentaires sur le produit
| Obtenir de l’aide sur Microsoft Q&A
Passez au tutoriel suivant pour découvrir comment créer et publier un produit :
Tester l’API dans le portail Azure
"
Créer et publier un produit
Yes
No | [
0.05193116143345833,
0.0023315041325986385,
0.021095070987939835,
0.02790258638560772,
0.0472903847694397,
0.04246010631322861,
0.014368737116456032,
0.05032260715961456,
0.00005955820233793929,
-0.03732721135020256,
-0.007726954761892557,
-0.0278047863394022,
-0.06475953757762909,
0.03138... | {
"azure_component": "network",
"chunk_index": 310,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "175",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
Tutoriel : Créer et publier un produit
Article • 28/10/2024
S’APPLIQUE À : Tous les niveaux de Gestion des API
Dans Gestion des API Azure, un produit contient une ou plusieurs API, un quota et des
conditions d’utilisation. Une fois le produit publié, les développeurs peuvent s’y abonner
et commencer à utiliser ses API.
Dans ce tutoriel, vous allez apprendre à :
Apprenez la terminologie relative à Gestion des API Azure.
Suivez le guide de démarrage rapide suivant : Créer une instance du service
Gestion des API Azure.
Effectuez également toutes les étapes du tutoriel suivant : Importer et publier votre
première API.
Créer et publier un produit
"
Ajouter une API au produit
"
Accéder aux API du produit
"
Prérequis
Créer et publier un produit
Portail | [
0.02806774713099003,
0.002736571477726102,
0.002041600411757827,
-0.0014111611526459455,
0.04128872603178024,
0.05261562764644623,
0.01929287239909172,
0.04216844588518143,
-0.00987344142049551,
-0.017132451757788658,
-0.02690778858959675,
-0.06318177282810211,
-0.05462932586669922,
0.0371... | {
"azure_component": "network",
"chunk_index": 311,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "176",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
1. Connectez-vous au portail Azure et accédez à votre instance de Gestion des
API.
2. Dans le volet de navigation gauche, sélectionnez Produits>+ Ajouter.
3. Dans la fenêtre Ajouter un produit, entrez les valeurs décrites dans le tableau
suivant pour créer votre produit. | [
0.0015558863524347544,
0.007630265783518553,
0.003892535110935569,
0.017101621255278587,
0.061170730739831924,
0.0497908741235733,
0.028011510148644447,
0.033289648592472076,
-0.017000550404191017,
-0.06435452401638031,
-0.013506184332072735,
-0.026620186865329742,
-0.04510710388422012,
0.... | {
"azure_component": "network",
"chunk_index": 312,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "177",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
Nom
Description
Nom complet
Le nom qui doit apparaître dans le portail des développeurs.
ノ
Agrandir le tableau | [
-0.05891498550772667,
0.01821165159344673,
-0.013380053453147411,
0.011679958552122116,
0.06491657346487045,
0.06203693524003029,
-0.04152452573180199,
0.040361300110816956,
-0.0811835527420044,
-0.04997466132044792,
-0.024373453110456467,
0.009852695278823376,
-0.04488970339298248,
0.0364... | {
"azure_component": "network",
"chunk_index": 313,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "178",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
Nom
Description
Description
Spécifiez des informations sur le produit, comme son objectif, les
API auxquelles il donne accès ainsi que d’autres informations
détaillées.
État
Sélectionnez Publié si vous voulez publier le produit sur le portail
des développeurs. Avant que les développeurs puissent découvrir
les API d’un produit, ce produit doit être publié. Par défaut, les
nouveaux produits ne sont pas publiés.
Nécessite un
abonnement
Sélectionnez si un utilisateur doit s’abonner pour utiliser le
produit (le produit est protégé) et si une clé d’abonnement doit
être utilisée pour accéder aux API du produit. Si un abonnement
n’est pas obligatoire (le produit est ouvert), une clé d’abonnement
n’est pas nécessaire pour accéder aux API du produit. Voir Accès
aux API du produit plus loin dans cet article.
Nécessite une
approbation
Sélectionnez cette option si vous voulez qu’un administrateur
révise et accepte ou refuse les tentatives d’abonnement à ce
produit. Si cette option n’est pas sélectionnée, les tentatives
d’abonnement sont automatiquement approuvées.
Limite du nombre
d’abonnements
Si vous le souhaitez, limitez le nombre d’abonnements simultanés.
Conditions
légales
Vous pouvez inclure les conditions d’utilisation que les abonnés
doivent accepter pour pouvoir utiliser le produit.
API
Sélectionnez une ou plusieurs API. Vous pouvez aussi ajouter des
API après avoir créé le produit. Pour plus d’informations,
consultez Ajouter des API à un produit plus loin dans cet article.
Si le produit est ouvert (ne nécessite pas d’abonnement), vous
pouvez uniquement ajouter une API qui n’est pas associée à un
autre produit ouvert.
4. Sélectionnez Créer pour créer votre produit.
U Attention
Faites attention lors de la configuration d’un produit qui ne nécessite | [
-0.00480326171964407,
0.007961188443005085,
-0.02881767600774765,
-0.005802336148917675,
0.06186075508594513,
0.07071492820978165,
-0.002465168246999383,
0.02958575077354908,
-0.0316036194562912,
-0.02917090803384781,
-0.03497476875782013,
-0.002821829868480563,
-0.053777843713760376,
0.03... | {
"azure_component": "network",
"chunk_index": 314,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "179",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
Pour plus d’informations,
consultez Ajouter des API à un produit plus loin dans cet article.
Si le produit est ouvert (ne nécessite pas d’abonnement), vous
pouvez uniquement ajouter une API qui n’est pas associée à un
autre produit ouvert.
4. Sélectionnez Créer pour créer votre produit.
U Attention
Faites attention lors de la configuration d’un produit qui ne nécessite pas
d’abonnement. Cette configuration peut être trop permissive et rendre les API
du produit plus vulnérables à certaines menaces de sécurité des API.
Ajouter des configurations | [
-0.007090463303029537,
0.0017739349277690053,
-0.0047141374088823795,
-0.009230409748852253,
0.06747755408287048,
0.06491502374410629,
0.024547690525650978,
-0.00568972947075963,
-0.010578895919024944,
-0.007046736776828766,
-0.02211831510066986,
-0.028342412784695625,
-0.07912440598011017,
... | {
"azure_component": "network",
"chunk_index": 315,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "179",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
Poursuivez la configuration du produit après l’avoir enregistré. Dans votre instance
Gestion des API, sélectionnez le produit dans la fenêtre Produits. Ajouter ou mettre à
jour :
Élément
Description
Paramètres
Métadonnées et état du produit
API
API associées au produit
Stratégies
Stratégies appliquées aux API du produit
Contrôle d’accès
Visibilité du produit pour les développeurs ou les invités
Abonnements
Abonnés au produit
Les produits sont des associations d’une ou de plusieurs API. Vous pouvez inclure de
nombreuses API et les proposer aux développeurs dans le portail des développeurs. Lors
de la création du produit, vous pouvez ajouter une ou plusieurs API existantes. Vous
pouvez aussi ajouter des API au produit ultérieurement, à partir de la page Paramètres
des produits ou lors de la création d’une API.
1. Dans le volet de navigation gauche de votre instance du service Gestion des
API, sélectionnez Produits.
2. Sélectionnez un produit, puis sélectionnez API.
3. Sélectionnez + Ajouter API.
4. Sélectionnez une ou plusieurs API, puis Sélectionner.
ノ
Agrandir le tableau
Ajout d’API à un produit
Ajouter une API à un produit existant
Portail | [
-0.007704886142164469,
0.009557764045894146,
-0.01266431249678135,
-0.021561231464147568,
0.05369492992758751,
0.07977995276451111,
0.025878606364130974,
0.01812472939491272,
-0.02611071802675724,
-0.03241860121488571,
-0.02584526315331459,
-0.02150961197912693,
-0.05301763489842415,
0.031... | {
"azure_component": "network",
"chunk_index": 316,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "180",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
Une fois que vous avez publié un produit, les développeurs peuvent accéder aux API.
Selon la configuration du produit, ils devront peut-être s’abonner au produit pour y
accéder.
Produit protégé : Les développeurs doivent d’abord s’abonner à un produit
protégé pour avoir accès aux API de ce produit. Quand ils s’abonnent, ils
obtiennent une clé d’abonnement qui leur permet d’accéder à toutes les API de ce
produit. Si vous avez créé l’instance Gestion des API, vous êtes abonné à chaque
produit par défaut, car vous êtes déjà administrateur. Pour plus d’informations,
consultez Abonnements dans Gestion des API Azure.
Lorsqu’un client effectue une demande d’API avec une clé d’abonnement de
produit valide, Gestion des API traite la demande et autorise l’accès dans le
contexte du produit. Les stratégies et les règles de contrôle d’accès configurées
pour le produit peuvent être appliquées.
Produit ouvert : Les développeurs peuvent accéder aux API d’un produit ouvert
sans clé d’abonnement. Toutefois, vous pouvez configurer d’autres mécanismes
pour sécuriser l’accès client aux API, notamment OAuth 2.0, des certificats clients et
la restriction des adresses IP des appelants.
Accès aux API du produit
Conseil
Vous pouvez créer ou mettre à jour l’abonnement de l’utilisateur à un produit
avec des clés d’abonnement personnalisées via une API REST ou une
commande PowerShell. | [
0.013287277892231941,
0.008257364854216576,
-0.027457542717456818,
0.0004983553080819547,
0.06782544404268265,
0.05588608607649803,
0.023529335856437683,
0.031154690310359,
-0.008354083634912968,
-0.032120268791913986,
-0.03645478934049606,
-0.023742636665701866,
-0.059687159955501556,
0.0... | {
"azure_component": "network",
"chunk_index": 317,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "181",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
Commentaires
Cette page a-t-elle été utile ?
Indiquer des commentaires sur le produit
| Obtenir de l’aide sur Microsoft Q&A
Lorsqu’un client effectue une demande d’API sans clé d’abonnement :
Gestion des API vérifie si l’API est associée à un produit ouvert. Une API peut
être associée au maximum à un produit ouvert.
Si le produit ouvert existe, il traite ensuite la demande dans le contexte de ce
produit ouvert. Les stratégies et les règles de contrôle d’accès configurées pour
le produit ouvert peuvent être appliquées.
Pour plus d’informations, consultez Traitement des requêtes par Gestion des API avec ou
sans clé d’abonnement.
Dans ce didacticiel, vous avez appris à :
Passez au tutoriel suivant :
7 Notes
Les produits ouverts ne sont pas listés dans le portail des développeurs. Les
développeurs ne peuvent donc pas s’informer sur ces produits, ni s’y abonner.
Ils ne sont visibles que par le groupe Administrateurs. Vous devez utiliser un
autre mécanisme pour informer les développeurs sur les API accessibles sans
clé d’abonnement.
Étapes suivantes
Créer et publier un produit
"
Ajouter une API au produit
"
Accéder aux API du produit
"
Créer une API vide et simuler des réponses de l’API
Yes
No | [
0.025319237262010574,
0.013411064632236958,
0.009143014438450336,
-0.004105775151401758,
0.04659520089626312,
0.051369551569223404,
0.013657049275934696,
0.06497638672590256,
-0.0270211361348629,
-0.019603926688432693,
-0.026963507756590843,
-0.022217387333512306,
-0.04299149289727211,
0.0... | {
"azure_component": "network",
"chunk_index": 318,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "182",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
Tutoriel : Simuler des réponses de l’API
Article • 22/04/2025
S’APPLIQUE À : tous les niveaux de Gestion des API
Les API principales sont importées dans une API Gestion des API Azure ou créées et gérées
manuellement. Les étapes décrites dans ce tutoriel décrivent comment :
Utilisez Gestion des API pour créer une API HTTP vide.
Gérez manuellement une API HTTP.
Définissez une stratégie sur une API afin qu’elle retourne une réponse fictive.
Cette méthode permet aux développeurs de poursuivre l’implémentation et le test de
l’instance Gestion des API, même si le back-end n’est pas disponible pour envoyer des
réponses réelles.
La possibilité de créer des réponses fictifs est utile dans de nombreux scénarios :
Lorsque la façade de l’API est conçue en premier et que l’implémentation du back-end se
produit ultérieurement, ou lorsque le serveur principal est développé en parallèle.
Lorsque le back-end est temporairement non opérationnel ou n’est pas en mesure de
s'adapter à la charge.
Dans ce tutoriel, vous allez apprendre à :
Conseil
Les équipes d’API peuvent utiliser cette fonctionnalité dans des espaces de travail. Les
espaces de travail fournissent un accès d’administration isolé aux API et à leurs propres
environnements d’exécution d’API.
Créer une API de test
"
Ajouter une opération à l’API de test
"
Activer la simulation de réponse
"
Tester l’API simulée
" | [
0.005421691108494997,
-0.01818642020225525,
-0.01041744090616703,
0.0011007946450263262,
0.01626558229327202,
0.04057561606168747,
0.03453517332673073,
0.0463656447827816,
-0.06728455424308777,
-0.041226886212825775,
-0.008205162361264229,
-0.05244739353656769,
-0.062131185084581375,
0.028... | {
"azure_component": "network",
"chunk_index": 319,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "183",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
Découvrez la terminologie gestion des API.
Comprendre le concept de stratégies dans Gestion des API.
Terminez le démarrage rapide Créer une instance Azure API Management.
Cette section montre comment créer une API HTTP sans back-end.
1. Connectez-vous au portail Azure et accédez à votre instance de Gestion des API.
2. Sélectionnez la vignette API>+ Ajouter une API>HTTP :
Prérequis
Créer une API de test
| [
-0.01866854913532734,
0.0009727368014864624,
-0.003793206298723817,
-0.005751896649599075,
0.028461961075663567,
0.0052865054458379745,
0.03217596188187599,
0.0376972034573555,
-0.030176052823662758,
-0.033970318734645844,
-0.016266370192170143,
-0.023588892072439194,
-0.05678974464535713,
... | {
"azure_component": "network",
"chunk_index": 320,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "184",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
3. Dans la fenêtre Créer une API HTTP, sélectionnez Complète.
4. Dans le nom d’affichage, entrez l’API test.
5. Dans Produits, sélectionnez Illimité, si cette valeur est disponible. Cette valeur est
disponible uniquement dans certains niveaux. Vous pouvez laisser la valeur vide pour ce
didacticiel, mais vous devez associer l’API à un produit pour le publier. Pour plus
d’informations, consultez Importer et publier votre première API.
6. Dans les passerelles, sélectionnez Managed si cette option est disponible. (Cette option
est avaiable uniquement dans certains niveaux de service.)
7. Sélectionnez Create (Créer).
Une API expose une ou plusieurs opérations. Dans cette section, vous ajoutez une opération à
l’API HTTP que vous avez créée. Appeler cette opération après avoir terminé les étapes de cette
section déclenche une erreur. Une fois que vous avez effectué les étapes de la section Activer la
simulation de réponse , vous ne recevez pas d’erreur.
Ajouter une opération à l’API de test
Portail | [
0.03578394651412964,
-0.011854421347379684,
-0.008487801998853683,
-0.022542623803019524,
0.048210661858320236,
0.038707293570041656,
-0.0100500313565135,
0.0355193056166172,
-0.042933087795972824,
-0.04029976949095726,
-0.03141753375530243,
-0.009361032396554947,
-0.08044127374887466,
0.0... | {
"azure_component": "network",
"chunk_index": 321,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "185",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
1. Sélectionnez l’API que vous avez créée à l’étape précédente.
2. Sélectionnez + Ajouter une opération.
3. Dans la fenêtre frontend , entrez les valeurs suivantes :
Paramètre
Valeur
Description
Nom complet
Appel de
test
Nom affiché dans le portail des développeurs.
URL (première
zone)
GET
Sélectionnez un des verbes HTTP prédéfinis.
URL (deuxième
boîte)
/test
Chemin d’URL de l’API.
Description
Description facultative de l’opération. Il fournit de la
documentation dans le portail des développeurs aux
développeurs qui utilisent l’API.
4. Sélectionnez l’onglet Réponses , qui se trouve sous l’URL, le nom d’affichage et les
zones Description . Vous entrez des valeurs sous cet onglet pour définir des codes
d’état de réponse, des types de contenu, des exemples et des schémas.
5. Sélectionnez + Ajouter une réponse, puis sélectionnez 200 OK dans la liste.
ノ
Agrandir le tableau
| [
-0.0271192267537117,
-0.01959279179573059,
0.0027956399135291576,
-0.024212326854467392,
0.06303861737251282,
0.050435952842235565,
-0.0176719818264246,
0.0544729046523571,
-0.05634298548102379,
-0.06671178340911865,
-0.04166293516755104,
-0.017312074080109596,
-0.054091643542051315,
0.000... | {
"azure_component": "network",
"chunk_index": 322,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "186",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
6. Dans la section Représentations , sélectionnez + Ajouter une représentation.
7. Entrez application/json dans la zone de recherche, puis sélectionnez le type de
contenu application/json .
8. Dans la zone Exemple , entrez { "sampleField" : "test" } .
9. Sélectionnez Enregistrer.
Bien qu’il ne soit pas nécessaire pour cet exemple, vous pouvez configurer d’autres
paramètres pour une opération d’API sous d’autres onglets, comme décrit dans le tableau
suivant :
ノ
Agrandir le tableau | [
-0.004282952286303043,
-0.006264228839427233,
-0.029375873506069183,
0.0177522674202919,
0.08382043987512589,
0.017229773104190826,
-0.0007513121818192303,
0.03405240923166275,
-0.06796615570783615,
-0.06111226603388786,
-0.04914205148816109,
-0.054310038685798645,
-0.053958211094141006,
0... | {
"azure_component": "network",
"chunk_index": 323,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "187",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
Onglet
Description
Requête
Ajoutez des paramètres de requête. Outre un nom et une description, vous pouvez
fournir des valeurs à affecter à un paramètre de requête. Vous pouvez marquer l’une de
ces valeurs comme valeur par défaut (facultatif).
Requête
Définissez des types de contenu de demande, des exemples et des schémas.
1. Sélectionnez l’API que vous avez créée dans Créer une API de test.
2. Vérifiez que l’onglet Création est sélectionné.
3. Sélectionnez l’opération de test que vous avez ajoutée.
4. Dans la section Traitement entrant, sélectionnez + Ajouter une stratégie.
5. Sélectionnez la vignette Réponses fictifs dans la galerie :
Activer la simulation de réponse
| [
0.0006965837674215436,
-0.03616597130894661,
0.014162185601890087,
-0.0006277992506511509,
0.02483358420431614,
0.0689687430858612,
0.002310456708073616,
0.025272781029343605,
-0.03008239157497883,
-0.06338905543088913,
-0.014750915579497814,
-0.003979068715125322,
-0.08016560226678848,
-0... | {
"azure_component": "network",
"chunk_index": 324,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "188",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
6. Vérifiez que 200 OK, application/json s’affiche dans la zone de réponse Gestion des API .
Cette sélection indique que votre API doit retourner l’exemple de réponse que vous avez
défini dans la section précédente.
7. Sélectionnez Enregistrer.
1. Sélectionnez l’API que vous avez créée dans Créer une API de test.
Conseil
Une barre jaune affichant le texte La simulation est activée s’affiche. Ce message
indique que les réponses retournées par Gestion des API sont simulées par la
stratégie de simulation et ne sont pas produites par le serveur principal.
Tester l’API simulée | [
-0.01046833023428917,
-0.005568724125623703,
-0.005143351387232542,
0.008000843226909637,
0.050447043031454086,
0.049993231892585754,
0.03181767836213112,
0.02817525342106819,
-0.09011919051408768,
-0.04744938015937805,
-0.01836024411022663,
-0.02916913852095604,
-0.0580480620265007,
0.001... | {
"azure_component": "network",
"chunk_index": 325,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "189",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
2. Sous l’onglet Test , vérifiez que l’API d’appel de test est sélectionnée, puis sélectionnez
Envoyer pour effectuer un appel de test :
3. La réponse HTTP affiche le JSON fourni en tant qu’exemple dans la première section du
didacticiel :
| [
0.0009572970448061824,
-0.002478375332430005,
0.02081272564828396,
0.019049253314733505,
0.023978961631655693,
0.012015493586659431,
0.03359358385205269,
0.044526923447847366,
-0.043969109654426575,
-0.05567045509815216,
0.003277903189882636,
-0.0005152582307346165,
-0.06255048513412476,
-... | {
"azure_component": "network",
"chunk_index": 326,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "190",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
Accédez au tutoriel suivant :
(Transformer et protéger votre API)
Étape suivante
Transform and protect your API | [
-0.012249493971467018,
-0.07276741415262222,
0.028685996308922768,
0.013434597291052341,
0.002308272523805499,
0.03806956112384796,
0.04693129286170006,
0.009721741080284119,
-0.06289494782686234,
-0.020682886242866516,
-0.03398113325238228,
0.0074614305049180984,
-0.02875981107354164,
-0.... | {
"azure_component": "network",
"chunk_index": 327,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "191",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
Tutoriel : Transformer et protéger votre API
05/06/2025
S’APPLIQUE À : Tous les niveaux de Gestion des API
Dans ce tutoriel, vous allez découvrir comment configurer des stratégies pour protéger ou
transformer votre API. Les stratégies sont un ensemble d’instructions qui sont exécutées de
manière séquentielle sur la requête ou la réponse d’une API et qui en modifient le
comportement.
Par exemple, vous pourriez vouloir définir un en-tête de réponse personnalisé. Vous pouvez
également protéger votre API back-end en configurant une stratégie de limite de débit, de
sorte que celle-ci ne soit pas utilisée de manière excessive par les développeurs. Ces exemples
ne sont qu’une simple introduction aux stratégies de Gestion des API. Pour plus d’options de
stratégie, consultez les stratégies de la Gestion des API.
Dans ce tutoriel, vous allez apprendre à :
Conseil
Les équipes d’API peuvent utiliser cette fonctionnalité dans des espaces de travail. Les
espaces de travail fournissent un accès d’administration isolé aux API et à leurs propres
environnements d’exécution d’API.
7 Notes
Par défaut, la Gestion des API configure une stratégie forward-request globale. La
stratégie forward-request est nécessaire pour que la passerelle termine une demande
adressée à un service principal.
Transformer une API pour définir un en-tête de réponse personnalisé
"
Protéger une API en ajoutant une politique de limitation de débit (gestion du trafic)
"
Tester les transformations
" | [
-0.00011724532669177279,
-0.038383856415748596,
-0.0013541505904868245,
-0.025897594168782234,
0.0065339053981006145,
0.034190692007541656,
0.03874673321843147,
0.035820282995700836,
-0.07240882515907288,
-0.015527329407632351,
-0.0549466647207737,
-0.00890273880213499,
-0.03468623012304306,... | {
"azure_component": "network",
"chunk_index": 328,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": true,
"service_name": "API Management",
"source": "192",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
Apprenez la terminologie relative à Gestion des API Azure.
Comprendre le concept des stratégies dans Gestion des API Azure.
Suivez ce guide de démarrage rapide : Créer une instance du service Gestion des API
Azure. Pour ce tutoriel, nous vous recommandons d’utiliser l’un des niveaux classiques ou
v2, par exemple le niveau Développeur ou le niveau Essentiel v2. Le niveau
Consommation ne prend pas en charge toutes les stratégies utilisées dans ce tutoriel.
Effectuez également toutes les étapes du tutoriel suivant : Importer et publier votre
première API.
1. Dans le portail
Azure, recherchez et sélectionnez Services de gestion des API :
Prérequis
Accéder à votre instance Gestion des API | [
-0.023724306374788284,
-0.015972338616847992,
-0.0127249201759696,
0.004613535478711128,
0.03613410145044327,
0.0202142596244812,
0.032395146787166595,
0.03495189920067787,
-0.04186036437749863,
-0.04018866643309593,
-0.018490111455321312,
-0.04668068140745163,
-0.03714578598737717,
0.0351... | {
"azure_component": "network",
"chunk_index": 329,
"contains_sku": true,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "193",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
2. Sur la page des services de gestion des API, sélectionnez votre instance de gestion des
API :
Pour consulter la réponse d’origine :
1. Dans votre instance du service Gestion des API, sélectionnez API.
2. Dans votre liste d’API, sélectionnez Animalerie Swagger.
3. Sélectionnez l’onglet Test, en haut de l’écran.
4. Sélectionnez l’opération GET Recherche des animaux de compagnie par État, puis
sélectionnez facultativement une valeur différente pour l’état du paramètre de Requête.
Sélectionnez Envoyer.
La réponse d’API d’origine doit être similaire à la réponse suivante :
Tester la réponse d’origine | [
-0.026572750881314278,
-0.019257551059126854,
-0.03419819846749306,
-0.016824504360556602,
0.014850765466690063,
0.04530264437198639,
0.02028004638850689,
0.034211091697216034,
-0.05744123086333275,
-0.04594474658370018,
-0.02986263297498226,
-0.032642267644405365,
-0.05381302163004875,
0.... | {
"azure_component": "network",
"chunk_index": 330,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "194",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
La Gestion des API inclut plusieurs stratégies de transformation que vous pouvez utiliser pour
modifier les charges utiles des requêtes ou des réponses, les en-têtes ou les codes d’état. Dans
cet exemple, vous définissez un en-tête de réponse personnalisé dans la réponse de l’API.
Cette section vous montre comment configurer un en-tête de réponse personnalisé à l’aide de
la stratégie set-header . Ici, vous utilisez un éditeur de stratégie basé sur des formulaires qui
simplifie la configuration de la stratégie.
1. Sélectionnez Animalerie Swagger>Conception>Toutes les opérations.
2. Dans la section Traitement entrant, sélectionnez + Ajouter une stratégie.
Transformer une API pour ajouter un en-tête de
réponse personnalisé
Définir la stratégie de transformation | [
-0.025682752951979637,
-0.02764810062944889,
-0.021598652005195618,
-0.024261632934212685,
0.0353415384888649,
0.040292106568813324,
0.01216741930693388,
0.02639628015458584,
-0.055461324751377106,
-0.05175046622753143,
-0.03295000270009041,
-0.02009207010269165,
-0.03174764662981033,
-0.0... | {
"azure_component": "network",
"chunk_index": 331,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "195",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
3. Dans la fenêtre Ajouter une stratégie sortante, sélectionnez Définir les en-têtes.
4. Pour configurer la stratégie Définir les en-têtes, procédez comme suit :
a. Sous Nom, saisissez personnalisé.
b. Sous Valeur, sélectionnez + Ajouter une valeur. Saisissez « Ma valeur personnalisée ».
c. Cliquez sur Enregistrer.
5. Après la configuration, un élément de stratégie set-header s’affiche dans la section
traitement des flux sortants.
| [
-0.018994038924574852,
-0.0105371605604887,
0.00790701899677515,
-0.02843094989657402,
0.030503643676638603,
0.027050700038671494,
-0.007365756202489138,
0.010733582079410553,
-0.041181523352861404,
-0.08309254795312881,
-0.010254518128931522,
-0.01591034233570099,
-0.02663625031709671,
0.... | {
"azure_component": "network",
"chunk_index": 332,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "196",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
Cette section montre comment ajouter une protection à votre API back-end en configurant des
limites de débit, afin que l’API ne soit pas sur-utilisée par les développeurs. Cet exemple
montre comment configurer la stratégie rate-limit-by-key à l’aide de l’éditeur de code. Dans
cet exemple, la limite est fixée à trois appels par 15 secondes. Après 15 secondes, un
développeur peut de nouveau tenter d’appeler l’API.
1. Sélectionnez Animalerie Swagger>Conception>Toutes les opérations.
2. Dans la section Traitement entrant, sélectionnez l’icône Éditeur de code (</>).
Protéger une API en ajoutant une politique de
limitation du débit (régulation)
7 Notes
Cette stratégie n’est pas prise en charge dans le niveau Consommation. | [
-0.017135128378868103,
-0.036830153316259384,
-0.012861322611570358,
-0.02496352419257164,
0.028733575716614723,
0.01068904809653759,
0.02022673189640045,
0.022358447313308716,
-0.04439392685890198,
-0.036064233630895615,
-0.034648582339286804,
-0.011102118529379368,
-0.043226391077041626,
... | {
"azure_component": "network",
"chunk_index": 333,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "197",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
3. Placez le curseur à l’intérieur de l’élément <inbound> sur une ligne vide. Sélectionnez
ensuite Afficher les extraits de code en haut à droite de l’écran.
4. Dans la fenêtre de droite, sous Stratégies de restriction des accès, sélectionnez Limite le
débit des appels par clé.
L’élément <rate-limit-by-key /> est ajouté au curseur.
| [
-0.047122880816459656,
-0.007734674494713545,
-0.026168741285800934,
-0.004173874389380217,
0.030417300760746002,
-0.014998058788478374,
0.01982528157532215,
0.005732064135372639,
-0.015339863486588001,
-0.03249497711658478,
-0.06366071850061417,
0.00740284938365221,
-0.05088887736201286,
... | {
"azure_component": "network",
"chunk_index": 334,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "198",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
5. Remplacez votre code <rate-limit-by-key /> dans l’élément <inbound> par le code
suivant : Ensuite, sélectionnez Enregistrer.
XML
À ce stade, si vous examinez le code dans l’éditeur de code, vos stratégies se présentent
comme le code suivant :
XML
<rate-limit-by-key calls="3" renewal-period="15" counter-
key="@(context.Subscription.Id)" />
Tester les transformations
<policies>
<inbound>
<rate-limit calls="3" renewal-period="15" counter-
key="@(context.Subscription.Id)" />
<base />
</inbound>
<outbound>
<set-header name="Custom" exists-action="override">
<value>"My custom value"</value>
</set-header>
<base />
</outbound> | [
-0.022276395931839943,
-0.050731997936964035,
0.020937256515026093,
-0.005262644495815039,
0.033180542290210724,
0.013382707722485065,
0.060166724026203156,
0.0012405188754200935,
-0.006049830932170153,
-0.057552237063646317,
-0.032685957849025726,
0.00928837712854147,
-0.024798907339572906,... | {
"azure_component": "network",
"chunk_index": 335,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "199",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
Le reste de cette section est dédié au test des transformations de stratégies définies dans cet
article.
1. Sélectionnez le test>Swagger Petstore.
2. Sélectionnez l’opération GET Recherche des animaux de compagnie par État, puis
sélectionnez facultativement une valeur différente pour l’état du paramètre de Requête.
Sélectionnez Envoyer.
Comme vous pouvez le voir, l’en-tête de réponse personnalisé est ajouté :
<on-error>
<base />
</on-error>
</policies>
Tester l’en-tête de réponse personnalisé | [
-0.04038233682513237,
-0.04406384751200676,
-0.012523223645985126,
0.030986346304416656,
0.06722120195627213,
0.02406904846429825,
0.05086987465620041,
0.008441146463155746,
-0.012081393040716648,
-0.055074065923690796,
-0.0328780934214592,
-0.010154224000871181,
-0.02297821268439293,
-0.0... | {
"azure_component": "network",
"chunk_index": 336,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "200",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
1. Sélectionnez le test>Swagger Petstore.
2. Sélectionnez l’opération GET Recherche des animaux de compagnie par État.
Sélectionnez Envoyer plusieurs fois de suite.
Après avoir envoyé trop de requêtes au cours de la période configurée, vous obtenez la
réponse 429 Trop de requêtes.
Tester la limite de débit (limitation) | [
-0.04098435863852501,
-0.06548440456390381,
-0.00413371529430151,
0.025838933885097504,
0.060322634875774384,
0.018186798319220543,
0.033921923488378525,
0.011686597019433975,
-0.015646472573280334,
-0.06461799889802933,
-0.04283067211508751,
-0.000018859422198147513,
-0.018147261813282967,
... | {
"azure_component": "network",
"chunk_index": 337,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "201",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
3. Attendez 15 secondes ou plus, puis resélectionnez Envoyer. Cette fois, vous devriez
obtenir une réponse 200 OK.
Vous pouvez obtenir de l'aide de Copilot basé sur l'IA pour créer et modifier vos définitions de
stratégie de gestion des API. Vous pouvez utiliser Copilot pour créer et mettre à jour des
stratégies qui correspondent à vos besoins spécifiques sans avoir à connaître la syntaxe XML.
Vous pouvez également obtenir des explications sur les stratégies existantes. Et Copilot peut
vous aider à traduire des stratégies que vous avez peut-être configurées dans d’autres
solutions de gestion des API.
Microsoft Copilot dans Azure fournit une assistance en matière de création de stratégies
avec des invites en langage naturel dans le portail Azure. Vous pouvez créer des
stratégies dans l’éditeur de stratégie Gestion des API et demander à Copilot d’expliquer
les sections de stratégie.
GitHub Copilot pour Azure dans Visual Studio Code fournit une assistance de création de
stratégie dans Visual Studio Code, et vous pouvez utiliser l’extension Gestion des API
Azure pour Visual Studio Code
pour accélérer la configuration de la stratégie. Vous
pouvez inviter Copilot Chat ou Copilot Edits avec le langage naturel pour créer et affiner
les définitions de stratégie en place.
Exemple d'invite :
Invite Copilot
Obtenir de l’aide de Copilot | [
-0.014369807206094265,
0.004929159302264452,
-0.014823625795543194,
0.01675211638212204,
0.032606691122055054,
0.06190907955169678,
0.011301073245704174,
0.059879060834646225,
-0.030905257910490036,
-0.09514021128416061,
-0.03332962840795517,
-0.03289438784122467,
-0.0683983862400055,
0.00... | {
"azure_component": "network",
"chunk_index": 338,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "202",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
Copilot est alimenté par l’IA, donc les surprises et les erreurs sont possibles. Pour plus
d’informations, consultez les FAQ sur l’utilisation générale de Copilot
.
Dans ce didacticiel, vous avez appris à :
Passez au tutoriel suivant :
Generate a policy that adds an Authorization header to the request with a Bearer
token.
Résumé
Transformer une API pour définir un en-tête de réponse personnalisé
"
Protéger une API en ajoutant une politique de limitation de débit (gestion du trafic)
"
Tester les transformations
"
Étapes suivantes
Surveiller votre API | [
0.0026699125301092863,
0.0052708410657942295,
-0.016062816604971886,
0.03140338510274887,
0.02639211155474186,
0.00861496664583683,
0.005001431796699762,
0.033215075731277466,
-0.02830040454864502,
-0.05136893689632416,
-0.026856081560254097,
-0.028682660311460495,
-0.0627281591296196,
0.0... | {
"azure_component": "network",
"chunk_index": 339,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "203",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
Tutoriel : Surveiller les API publiées
20/05/2025
S’APPLIQUE À : Tous les niveaux de Gestion des API
Avec Azure Monitor, vous pouvez visualiser, interroger, router, archiver et exploiter les
métriques ou les journaux provenant de votre service Gestion des API Azure. Pour obtenir une
vue d’ensemble d’Azure Monitor pour Gestion des API, consultez Surveiller Gestion des API.
Dans ce tutoriel, vous allez apprendre à :
Apprenez la terminologie relative à Gestion des API Azure.
Suivez le guide de démarrage rapide suivant : Créer une instance du service Gestion des
API Azure.
Effectuez également toutes les étapes du tutoriel suivant : Importer et publier votre
première API.
Conseil
Les équipes d’API peuvent utiliser cette fonctionnalité dans des espaces de travail. Les
espaces de travail fournissent un accès d’administration isolé aux API et à leurs propres
environnements d’exécution d’API.
Afficher les métriques de votre API
"
Configurer une règle d’alerte
"
Afficher les journaux d’activité
"
Activer et afficher les journaux de ressources
"
7 Notes
Gestion des API prend en charge une gamme d’outils supplémentaires pour observer les
API, notamment l’analytique intégrée et l’intégration à Application Insights. En savoir
plus
Prérequis
Afficher les métriques de vos API | [
0.037272483110427856,
-0.014406454749405384,
-0.014054802246391773,
-0.02427385374903679,
0.013256147503852844,
0.0086758928373456,
0.037228405475616455,
0.04802095890045166,
-0.03410403057932854,
-0.046798188239336014,
-0.003708949778228998,
-0.029486747458577156,
-0.08121778070926666,
0.... | {
"azure_component": "network",
"chunk_index": 340,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "204",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
Le service Gestion des API émet des métriques chaque minute, pour une visibilité en quasi
temps réel de l’intégrité de vos API. Vous trouverez ci-après les métriques les plus
fréquemment utilisées. Pour obtenir la liste de toutes les métriques disponibles, consultez
Mesures.
Capacité : vous aide à prendre des décisions concernant la mise à niveau/le passage à
une version antérieure de vos services Gestion des API. La métrique est émise chaque
minute et reflète l’estimation de la capacité de la passerelle au moment de la création du
rapport. Le calcul de cette métrique, dont la valeur est comprise entre 0 et 100, repose sur
les ressources de la passerelle, telles que l’utilisation du processeur et de la mémoire,
ainsi que d’autres facteurs.
Demandes : vous aide à analyser le trafic d’API transitant par vos services Gestion des API.
Cette métrique est émise à une fréquence d’une minute. Elle indique le nombre de
demandes de passerelle avec les dimensions. Vous pouvez filtrer les demandes par codes
de réponse, emplacement, nom d’hôte et erreurs.
Conseil
Dans les niveaux de service v2 et dans les passerelles d’espace de travail, Gestion
des API a remplacé la métrique de capacité de passerelle par des métriques
d’utilisation distinctes du processeur et de la mémoire. Ces métriques peuvent être
également utilisées pour prendre des décisions de mise à l’échelle et résoudre des
problèmes. En savoir plus
7 Notes
La métrique Demandes n’est pas disponible dans les espaces de travail.
) Important
Les métriques suivantes ont été retirées : Nombre total de demandes de la passerelle,
Demandes de la passerelle ayant abouti, Demandes de la passerelle non autorisées,
Demandes de la passerelle ayant échoué, Autres demandes de la passerelle. Migrez vers la
mesure | [
-0.0018756542121991515,
-0.009141519665718079,
-0.02932976931333542,
-0.030528659000992775,
0.022253384813666344,
0.04454687237739563,
0.024793356657028198,
0.06312847882509232,
-0.08391191810369492,
-0.031148571521043777,
0.0012657280312851071,
-0.020372051745653152,
-0.06012364476919174,
... | {
"azure_component": "network",
"chunk_index": 341,
"contains_sku": true,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "205",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
savoir plus
7 Notes
La métrique Demandes n’est pas disponible dans les espaces de travail.
) Important
Les métriques suivantes ont été retirées : Nombre total de demandes de la passerelle,
Demandes de la passerelle ayant abouti, Demandes de la passerelle non autorisées,
Demandes de la passerelle ayant échoué, Autres demandes de la passerelle. Migrez vers la
mesure Requêtes, qui fournit des fonctionnalités quasi similaires. | [
0.0005268176319077611,
-0.023365018889307976,
0.03958643227815628,
-0.026690827682614326,
0.06310248374938965,
0.025214431807398796,
0.03694998100399971,
0.027046723291277885,
-0.06838919222354889,
-0.04831278324127197,
-0.01624714583158493,
0.016862865537405014,
-0.037885040044784546,
0.0... | {
"azure_component": "network",
"chunk_index": 342,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "205",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
Pour accéder aux métriques :
1. Dans le portail Azure
, accédez à votre instance APIM. Dans la page Vue d’ensemble,
sous l’onglet Monitorer, passez en revue les principales métriques de vos API.
2. Pour investiguer des métriques en détail, sélectionnez Surveillance>Mesures dans le
menu de gauche.
Conseil | [
0.021278148517012596,
-0.004161056596785784,
-0.0009546994115225971,
-0.009642321616411209,
0.0289490707218647,
0.023034384474158287,
0.05128037929534912,
0.05022070184350014,
-0.03975335508584976,
-0.021590489894151688,
0.04317199066281319,
-0.01968545839190483,
-0.06831301748752594,
0.01... | {
"azure_component": "network",
"chunk_index": 343,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "206",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
3. Dans la liste déroulante, sélectionnez les métriques qui vous intéressent. Par exemple,
Demandes.
4. Le graphique affiche le nombre total d’appels d’API. Ajustez l’intervalle de temps pour
vous concentrer sur les périodes qui vous intéressent.
5. Vous pouvez filtrer le graphique en utilisant les dimensions de la métrique Demandes. Par
exemple, sélectionnez Ajouter un filtre, sélectionnez Catégorie de code de réponse de
back-end et entrez 500 comme valeur. Le graphique montre le nombre de demandes qui
ont échoué dans le back-end d’API.
Vous pouvez recevoir des alertes en fonction des métriques et des journaux d’activité. Dans
Azure Monitor, configurez une règle d’alerte pour effectuer une action quand elle se
déclenche. Les actions courantes sont les suivantes :
Envoyer un e-mail de notification
Appeler un webhook
Appeler une application logique Azure
Pour configurer un exemple de règle d’alerte basée sur une métrique de demande :
1. Dans le portail Azure
, accédez à votre instance APIM.
2. Sélectionnez Surveillance>Alertes dans le menu de gauche.
Dans un espace de travail, vous pouvez afficher les métriques de capacité associées à
une passerelle de l'espace de travail. Accédez à Surveillance>Métriques dans le
menu de gauche d'une passerelle d'espace de travail.
Configurer une règle d’alerte | [
0.026743315160274506,
-0.003109703538939357,
-0.006319623906165361,
-0.021183455362915993,
0.04555141180753708,
0.03241298720240593,
0.03531819209456444,
0.05030352249741554,
-0.036597929894924164,
-0.06830180436372757,
-0.0032511234749108553,
-0.02112608216702938,
-0.08739780634641647,
0.... | {
"azure_component": "network",
"chunk_index": 344,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "207",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
3. Sélectionnez + Créer>Règle d’alerte.
4. Dans l’onglet Conditions :
a. Dans Nom du signal, sélectionnez Demandes.
b. Dans Logique d’alerte, passez en revue ou modifiez les valeurs par défaut pour l’alerte.
Par exemple, mettez à jour le Seuil statique, qui est le nombre d’occurrences après
lesquelles l’alerte doit être déclenchée.
c. Dans Diviser par dimensions, dans Nom de la dimension, sélectionnez Catégorie de
codes de réponse de passerelle.
d. Dans Valeurs de dimension, sélectionnez 4xx pour les erreurs de client telles que les
demandes non autorisées ou non valides. Si la valeur de dimension n’apparaît pas,
sélectionnez Ajouter une valeur personnalisée et entrez 4xx.
e. Dans Quand évaluer, acceptez les paramètres par défaut ou sélectionnez d’autres
paramètres pour configurer la fréquence d’exécution de la règle. Sélectionnez Suivant. | [
-0.02403842844069004,
0.009346256963908672,
0.01378905400633812,
-0.04548708721995354,
0.04882732033729553,
0.017631417140364647,
0.018396582454442978,
0.02316182851791382,
-0.032174065709114075,
-0.0556383840739727,
-0.036659352481365204,
0.043551914393901825,
-0.0686921700835228,
-0.0098... | {
"azure_component": "network",
"chunk_index": 345,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "208",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
5. Sous l’onglet Actions, sélectionnez ou créez un ou plusieurs groupes d’actions pour
informer les utilisateurs de l’alerte et effectuer une action. Par exemple, créez un groupe
d’actions pour envoyer un e-mail de notification à admin@contoso.com . Pour le détail des
étapes, consultez Créer et gérer des groupes d’actions dans le portail Azure. | [
0.029179349541664124,
-0.034282006323337555,
0.037234269082546234,
-0.023361200466752052,
0.018034443259239197,
0.001859320909716189,
0.01688997820019722,
0.04907672107219696,
0.00040768139297142625,
-0.04461304098367691,
-0.03248195722699165,
-0.004079737700521946,
-0.07175695896148682,
0... | {
"azure_component": "network",
"chunk_index": 346,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "209",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
6. Sous l’onglet Détails de Créer une règle d’alerte, entrez un nom et une description de la
règle d’alerte, puis sélectionnez le niveau de gravité.
7. Configurez les paramètres restants (facultatif). Sous l’onglet Vérifier + créer, sélectionnez
Créer.
8. Testez éventuellement la règle d’alerte en utilisant un client HTTP pour simuler une
requête qui déclenche l’alerte. Par exemple, exécutez la commande suivante dans un
terminal, en remplaçant le nom d’hôte de Gestion des API par le nom d’hôte de votre
instance Gestion des API :
Bash
Une alerte est déclenchée en fonction de la période d’évaluation, et un e-mail est envoyé
à admin@contoso.com.
Les alertes s’affichent également dans la page Alertes pour l’instance de Gestion des API.
curl GET https://contoso.azure-api.net/non-existent-endpoint HTTP/1.1 | [
-0.00970429927110672,
-0.00743394810706377,
0.01977367140352726,
-0.03209110349416733,
0.030889064073562622,
-0.009310351684689522,
0.026169519871473312,
0.06643322110176086,
-0.04069298878312111,
-0.014989732764661312,
-0.021632760763168335,
0.008585806004703045,
-0.07055217027664185,
0.0... | {
"azure_component": "network",
"chunk_index": 347,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "210",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
Les journaux d’activité fournissent des insights sur les opérations effectuées sur les services
Gestion des API. Avec les journaux d’activité, vous pouvez déterminer « qui, quand et quoi »
pour toutes les opérations d’écriture (PUT, POST, DELETE) sur vos services de Gestion des API.
Vous pouvez accéder aux journaux d’activité dans votre service de Gestion des API, ou accéder
aux journaux d’activité de toutes vos ressources Azure dans Azure Monitor.
Journaux d’activité
7 Notes
Les journaux d’activité n’incluent pas les opérations de lecture (GET) ou les opérations
effectuées dans le portail Azure. | [
0.018799159675836563,
-0.01914612203836441,
0.007719275541603565,
-0.04036514833569527,
0.03339509665966034,
0.024183528497815132,
0.04604632407426834,
0.05308327078819275,
-0.04497548192739487,
-0.003430519951507449,
-0.010354219004511833,
-0.01352109108120203,
-0.08355693519115448,
0.004... | {
"azure_component": "network",
"chunk_index": 348,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "211",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
Pour afficher le journal d’activité :
1. Dans le portail Azure
, accédez à votre instance APIM.
2. Sélectionnez Journal d’activité.
3. Sélectionnez l’étendue de filtrage souhaitée, puis Appliquer.
Journaux d’activité de ressources | [
0.004493362735956907,
-0.026784060522913933,
-0.0007339373114518821,
-0.028314964845776558,
0.046782542020082474,
0.038572851568460464,
0.04630794748663902,
0.0035241402219980955,
-0.03656448796391487,
-0.02820690907537937,
-0.008499950170516968,
-0.03365673869848251,
-0.07087449729442596,
... | {
"azure_component": "network",
"chunk_index": 349,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "212",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
Les journaux de ressources (les journaux Azure Monitor) offrent des informations détaillées sur
les opérations et les erreurs de Gestion des API qui sont importantes pour l’audit et la
résolution des problèmes. Lorsqu’ils sont activés via un paramètre de diagnostic, les journaux
collectent des informations sur les demandes d’API reçues et traitées par la passerelle Gestion
des API.
Pour configurer un paramètre de diagnostic pour la collecte des journaux d’activité de
ressources :
1. Dans le portail Azure
, accédez à votre instance APIM.
2. Dans le menu de gauche, sous Supervision, sélectionnez Paramètres de
diagnostic>Ajouter un paramètre de diagnostic.
7 Notes
Le niveau Consommation ne prend pas en charge la collection de journaux de ressources.
Conseil
Dans les instances gestion des API avec des espaces de travail, les journaux fédérés sur le
service Gestion des API sont accessibles par l’équipe de plateforme d’API pour la
supervision centralisée des API, tandis que les équipes d’espace de travail peuvent accéder
aux journaux spécifiques aux API de leur espace de travail. Découvrir plus d’informations
sur la journalisation Azure Monitor avec des espaces de travail | [
-0.005418615881353617,
0.01253847312182188,
-0.01675376668572426,
-0.0528138168156147,
0.030450399965047836,
0.031471237540245056,
0.029711253941059113,
0.04913764074444771,
-0.017547927796840668,
-0.014823969453573227,
-0.004623910877853632,
0.0012900280999019742,
-0.09506986290216446,
0.... | {
"azure_component": "network",
"chunk_index": 350,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "213",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
3. Dans la page Paramètre de diagnostic, entrez ou sélectionnez les détails du paramètre :
a. Nom du paramètre de diagnostic : entrez un nom descriptif.
b. Groupes de catégories : effectuez éventuellement une sélection pour votre scénario.
c. Sous Catégories : sélectionnez une ou plusieurs catégories. Par exemple, sélectionnez
Journaux liés à la passerelle ApiManagement pour collecter les journaux pour la
plupart des demandes adressées à la passerelle Gestion des API.
d. Sous Détails de la destination, sélectionnez une ou plusieurs options et spécifiez les
détails de la destination. Par exemple, envoyez des journaux à un espace de travail
Azure Log Analytics, archivez les journaux dans un compte de stockage ou diffusez-les
en continu vers un hub d’événements. Pour plus d’informations, consultez Paramètres
de diagnostic dans Azure Monitor.
e. Sélectionnez Enregistrer.
Conseil
Si vous sélectionnez un espace de travail Log Analytics, vous pouvez choisir de
stocker les données dans une table spécifique à une ressource (par exemple, une
table ApiManagementGatewayLogs) ou de stocker dans la table AzureDiagnostics
générale. Nous vous recommandons d’utiliser la table propre à la ressource pour les
destinations de journal qui la prennent en charge. En savoir plus | [
-0.029087373986840248,
0.025036750361323357,
-0.03306352347135544,
-0.029500989243388176,
0.06269709765911102,
0.0603225938975811,
-0.0014157212572172284,
0.004759619012475014,
-0.02961939014494419,
-0.06186699867248535,
-0.022081958130002022,
-0.0029998261015862226,
-0.0414767786860466,
0... | {
"azure_component": "network",
"chunk_index": 351,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "214",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
4. Après avoir configuré les détails de la ou des destinations du journal, sélectionnez
Enregistrer.
Si vous activez la collecte des journaux ou des métriques dans un espace de travail Log
Analytics, les données peuvent prendre quelques minutes pour s’afficher dans Azure Monitor.
Pour visualiser les données :
1. Dans le portail Azure
, accédez à votre instance APIM.
2. Dans le menu de gauche, sous Surveillance, sélectionnez Journaux.
3. Exécutez des requêtes pour afficher les données. Plusieurs exemples de requêtes sont
fournis, ou exécutez les vôtres. Par exemple, la requête suivante récupère les données des
dernières 24 heures dans la table ApiManagementGatewayLogs :
Kusto
7 Notes
L’ajout d’un objet de paramètre de diagnostic peut entraîner un échec si la propriété
MinApiVersion de votre service Gestion des API est définie sur une version d’API
supérieure à 2022-09-01-preview.
7 Notes
Pour activer les paramètres de diagnostic pour les espaces de travail Gestion des API,
consultez Créer et gérer un espace de travail.
Afficher les journaux et les métriques dans Azure
Log Analytics
ApiManagementGatewayLogs
| where TimeGenerated > ago(1d) | [
0.00014536608068738133,
0.02111002430319786,
-0.013604667969048023,
-0.05559835955500603,
0.046818334609270096,
0.0341874361038208,
0.04220697283744812,
0.028165781870484352,
-0.03802511468529701,
-0.05401888117194176,
-0.026250161230564117,
-0.00924067385494709,
-0.06334100663661957,
0.01... | {
"azure_component": "network",
"chunk_index": 352,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "215",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
Pour plus d’informations sur l’utilisation des journaux de ressources pour Gestion des API,
consultez :
Tutoriel Log Analytics.
Vue d’ensemble des requêtes de journal dans Azure Monitor.
Lorsque vous utilisez le portail pour créer un paramètre de diagnostic afin d'activer la collecte
des journaux de la passerelle de gestion des API ou de la passerelle d'IA générative (LLM), la
journalisation est activée avec les paramètres par défaut. Les paramètres par défaut n’incluent
pas les détails des demandes ou des réponses telles que les corps de requête ou de réponse.
Vous pouvez ajuster les paramètres de journalisation pour toutes les API ou les remplacer pour
des API individuelles. Par exemple, ajustez le taux d’échantillonnage ou la verbosité des
données du journal de passerelle, activez la consignation des messages de requête ou de
réponse LLM, ou désactivez la consignation pour certaines API.
Pour plus d’informations sur les paramètres de journalisation, consultez les pages de référence
de l'API Diagnostic - Créer ou Mettre à Jour et de l'Diagnostic - Créer ou Mettre à Jour de l'API
REST.
Pour configurer les paramètres de journalisation pour toutes les API :
1. Dans le menu de gauche de votre instance Gestion des API, sélectionnez API>API>Toutes
les API.
2. Sélectionnez l’onglet Paramètres dans la barre supérieure.
Modifier les paramètres de journalisation d’API | [
0.024710681289434433,
0.002438920782878995,
-0.01625969260931015,
-0.073517806828022,
0.046503547579050064,
0.03940620645880699,
0.021231485530734062,
0.037268247455358505,
-0.03892131894826889,
-0.014805014245212078,
-0.013426186516880989,
-0.014451919123530388,
-0.07540669292211533,
0.02... | {
"azure_component": "network",
"chunk_index": 353,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "216",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
3. Faites défiler jusqu’à la section Journaux de diagnostic et sélectionnez l’onglet Azure
Monitor.
4. Passez en revue les paramètres et changez-les si nécessaire. Sélectionnez Enregistrer.
Pour configurer les paramètres de journalisation pour une API donnée :
1. Dans le menu de gauche de votre instance Gestion des API, sélectionnez API>API, puis le
nom de l’API.
2. Sélectionnez l’onglet Paramètres dans la barre supérieure.
3. Faites défiler jusqu’à la section Journaux de diagnostic et sélectionnez l’onglet Azure
Monitor.
4. Passez en revue les paramètres et changez-les si nécessaire. Sélectionnez Enregistrer.
Dans ce didacticiel, vous avez appris à :
) Important
Gestion des API applique une limite de 32 Ko pour la taille des entrées de journal
envoyées à Azure Monitor. Le comportement lorsqu’une entrée de journal dépasse la
limite dépend de la catégorie de journal et des attributs de données enregistrés :
Journaux de la passerelle Gestion des API : les charges utiles de demande ou de
réponse enregistrées dans une entrée de journal, si elles sont collectées, peuvent
atteindre jusqu’à 8 192 octets chacune. Si la taille combinée des attributs d’une
entrée dépasse 32 Ko, Gestion des API supprime l’entrée en supprimant tout le corps
et le contenu de trace.
Journaux de passerelle IA générative : les messages de demande ou de réponse
LLM jusqu’à 32 Ko de taille, s’ils sont collectés, sont envoyés dans une seule entrée.
Les messages de plus de 32 Ko sont fractionnés et enregistrés en morceaux de 32 Ko
avec des numéros de séquence pour permettre une reconstruction ultérieure. Les
messages de demande et les messages de réponse ne peuvent pas dépasser 2 Mo
chacun.
Étapes suivantes
Afficher les métriques de votre API
"
Configurer | [
-0.011955248191952705,
0.00867622159421444,
-0.011028477922081947,
-0.02771783620119095,
0.044216837733983994,
0.0361814983189106,
0.03577734902501106,
0.05064854398369789,
-0.008102821186184883,
-0.04588431492447853,
0.037019599229097366,
0.027888894081115723,
-0.06676580756902695,
0.0334... | {
"azure_component": "network",
"chunk_index": 354,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "217",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
sont envoyés dans une seule entrée.
Les messages de plus de 32 Ko sont fractionnés et enregistrés en morceaux de 32 Ko
avec des numéros de séquence pour permettre une reconstruction ultérieure. Les
messages de demande et les messages de réponse ne peuvent pas dépasser 2 Mo
chacun.
Étapes suivantes
Afficher les métriques de votre API
"
Configurer une règle d’alerte
"
Afficher les journaux d’activité
"
Activer et afficher les journaux de ressources
" | [
-0.022228287532925606,
-0.02598406746983528,
-0.0409369133412838,
-0.012395638972520828,
0.021255705505609512,
0.02477223612368107,
0.02811560593545437,
0.0067280735820531845,
-0.052918609231710434,
-0.03775818645954132,
-0.010447559878230095,
0.01315813884139061,
-0.045821625739336014,
0.... | {
"azure_component": "network",
"chunk_index": 355,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "217",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
Passez au tutoriel suivant :
Suivre des appels | [
-0.008419443853199482,
0.0030131619423627853,
0.00473097013309598,
0.013340882956981659,
0.04579737037420273,
0.04879380017518997,
0.0392828993499279,
0.027799617499113083,
-0.013614133931696415,
-0.0510842464864254,
-0.043911635875701904,
0.0012083117617294192,
-0.005747707560658455,
-0.0... | {
"azure_component": "network",
"chunk_index": 356,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "218",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
Tutoriel : Déboguer vos API à l’aide du
suivi des demandes
Article • 26/02/2025
S’APPLIQUE À : Tous les niveaux de Gestion des API
Ce tutoriel explique comment inspecter (tracer) le traitement des requêtes dans le
service Gestion des API Azure. Le traçage vous aide à résoudre les bogues et les
problèmes liés à votre API.
Dans ce tutoriel, vous allez apprendre à :
Conseil
Les équipes d’API peuvent utiliser cette fonctionnalité dans des espaces de travail.
Les espaces de travail fournissent un accès d’administration isolé aux API et à leurs
propres environnements d’exécution d’API.
Tracer un exemple d’appel dans la console de test
"
Passer en revue les étapes du traitement des demandes
"
Activer le traçage pour une API
"
| [
0.020442906767129898,
-0.020358573645353317,
0.009124843403697014,
-0.02269246056675911,
0.014020774513483047,
0.002428697422146797,
0.05157393962144852,
0.04730730503797531,
-0.06948137283325195,
-0.041668254882097244,
-0.025769099593162537,
-0.0328221395611763,
-0.07326149940490723,
0.01... | {
"azure_component": "network",
"chunk_index": 357,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "219",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
Apprenez la terminologie relative à Gestion des API Azure.
Suivez le guide de démarrage rapide suivant : Créer une instance du service
Gestion des API Azure.
Effectuez toutes les étapes du tutoriel suivant : Importer et publier votre première
API.
Suivez ces étapes pour suivre une demande d’API dans la console de test dans le portail.
Cet exemple suppose que vous avez importé un exemple d’API dans un précédent
didacticiel. Vous pouvez suivre des étapes similaires avec une autre API que vous avez
importée.
1. Connectez-vous au portail Azure
et accédez à votre instance de Gestion des API.
2. Sélectionnez APIs>APIs.
3. Sélectionnez Petstore API dans votre liste d’API.
4. Sélectionnez l’onglet Test.
5. Sélectionnez l’opération Find pet by ID.
6. Pour petId, dans le paramètre de requête, entrez 1.
7. Si vous le souhaitez, vérifiez la valeur de l’en-tête Ocp-Apim-Subscription-Key
utilisé dans la demande en sélectionnant l’icône « œil ».
Prérequis
) Important
Le service Gestion des API ne prend plus en charge les abonnements pour le
suivi ou l’en-tête Ocp-Apim-Trace.
Pour améliorer la sécurité, le traçage peut désormais être activé au niveau de
chaque API par l’obtention d’un jeton à durée limitée avec l’API REST de
Gestion des API. Le jeton est alors transmis à la passerelle dans une requête.
Pour plus d’informations, consultez Activer le traçage d’une API.
Soyez prudent quand vous activez le traçage, car il peut exposer des
informations sensibles dans les données de traçage. Veillez à mettre en place
les mesures de sécurité appropriées pour protéger les données de trace.
Tracer un appel dans le portail | [
-0.031636450439691544,
-0.012304210104048252,
-0.015896456316113472,
-0.014897632412612438,
0.032087042927742004,
0.027655692771077156,
0.03300435468554497,
0.050775472074747086,
-0.031724411994218826,
-0.05338181182742119,
-0.022123824805021286,
-0.050333257764577866,
-0.06493151187896729,
... | {
"azure_component": "network",
"chunk_index": 358,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "220",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
8. Sélectionnez Trace.
1. Une fois l’appel terminé, accédez à l’onglet Trace dans la réponse HTTP.
2. Sélectionnez les liens suivants pour accéder aux informations de suivi détaillées :
Entrant, Principal, Sortant, En cas d’erreur.
Conseil
Vous pouvez remplacer la valeur Ocp-Apim-Subscription-Key en récupérant
une clé pour un autre abonnement dans le portail. Sélectionnez
Abonnements, puis ouvrez le menu contextuel (...) pour un autre
abonnement. Sélectionnez Afficher/masquer les clés et copiez l’une des clés.
Vous pouvez également regénérer les clés si nécessaire. Ensuite, dans la
console de test, sélectionnez + Ajouter un en-tête pour ajouter un en-tête
Ocp-Apim-Subscription-Key avec la nouvelle valeur de clé.
Examiner les informations de suivi | [
-0.057860665023326874,
-0.03276846557855606,
0.009348557330667973,
-0.01855759136378765,
0.06877616792917252,
0.036123305559158325,
-0.0016590898158028722,
0.028829656541347504,
-0.05153612047433853,
-0.07629142701625824,
-0.024700826033949852,
-0.005937350448220968,
-0.04209966957569122,
... | {
"azure_component": "network",
"chunk_index": 359,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "221",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
Entrant : affiche la demande d’origine reçue par le service Gestion des API de
l’appelant et les stratégies appliquées à la demande. Par exemple, si vous
avez ajouté des stratégies dans le Tutoriel : Transformer et protéger votre API,
ces stratégies s’affichent ici.
Principal : affiche les demandes envoyées par le service Gestion des API au
backend d’API et la réponse qu’il a reçue.
Sortant : affiche toutes les stratégies appliquées à la réponse avant son envoi
à l’appelant.
En cas d’erreur : affiche les erreurs qui se sont produites pendant le
traitement de la demande et les stratégies appliquées aux erreurs. | [
-0.02511170506477356,
-0.05160009488463402,
-0.01295566838234663,
-0.02054736390709877,
0.02100241929292679,
0.07242727279663086,
0.036587707698345184,
0.04570751637220383,
-0.04798828065395355,
-0.03695981204509735,
-0.03304027393460274,
-0.010651187039911747,
-0.03279898688197136,
-0.004... | {
"azure_component": "network",
"chunk_index": 360,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "222",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
Les étapes générales suivantes sont requises pour activer le traçage d’une requête au
service Gestion des API à l’aide de curl , d’un client REST tel que Visual Studio Code
avec l’extension Client REST ou d’une application cliente. Actuellement, vous devez
suivre ces étapes à l’aide de l’API REST Gestion des API :
1. Obtenez un jeton de débogage pour le suivi.
2. Ajoutez la valeur du jeton dans un en-tête de demande Apim-Debug-Authorization
auprès de la passerelle Gestion des API.
3. Obtenez un ID de trace dans l’en-tête de réponse Apim-Trace-Id .
4. Récupérez la trace correspondant à l’ID de trace.
Voici les étapes détaillées.
1. Obtenir un jeton de débogage : appelez l’API Lister les informations
d’identification de débogage de la passerelle Gestion des API. Dans l’URI, entrez «
managed » pour la passerelle managée de l’instance dans le cloud ou l’ID de
passerelle pour une passerelle auto-hébergée. Par exemple, pour obtenir les
informations d’identification de trace de la passerelle managée de l'instance,
utilisez une requête semblable à ce qui suit :
HTTP
Conseil
Chaque étape indique également le temps écoulé depuis la réception de la
demande par le service Gestion des API.
Activer le traçage pour une API
7 Notes
Ces étapes nécessitent l’API REST Gestion des API version 2023-05-01-preview
ou ultérieure. Vous devez disposer du rôle Contributeur ou d’un rôle supérieur
sur l’instance de Gestion des API pour appeler l’API REST.
Pour plus d’informations sur l’authentification auprès de l’API REST, consultez
Référence de l'API REST Azure.
POST | [
-0.018339816480875015,
-0.058184027671813965,
0.019989922642707825,
-0.025295400992035866,
-0.01040059793740511,
0.019838770851492882,
0.046517472714185715,
0.06545508652925491,
-0.07816208899021149,
-0.06191452965140343,
-0.042091842740774155,
-0.028520992025732994,
-0.06642133742570877,
... | {
"azure_component": "network",
"chunk_index": 361,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "223",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
nécessitent l’API REST Gestion des API version 2023-05-01-preview
ou ultérieure. Vous devez disposer du rôle Contributeur ou d’un rôle supérieur
sur l’instance de Gestion des API pour appeler l’API REST.
Pour plus d’informations sur l’authentification auprès de l’API REST, consultez
Référence de l'API REST Azure.
POST
https://management.azure.com/subscriptions/{subscriptionId}/resourceGro
ups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serv | [
-0.03195862099528313,
-0.015555113554000854,
-0.007034989073872566,
0.018893586471676826,
0.04189248010516167,
0.04578094184398651,
0.03693501278758049,
0.030673164874315262,
-0.0731939896941185,
-0.010175745002925396,
-0.013148928992450237,
-0.03398881107568741,
-0.0432489849627018,
0.044... | {
"azure_component": "network",
"chunk_index": 362,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "223",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
Dans le corps de la requête, passez l’ID de ressource complet de l’API dont vous
souhaitez effectuer le traçage, puis spécifiez purposes en tant que tracing . Par
défaut, les informations d’identification de jeton retournées dans la réponse
expirent au bout d’une heure, mais vous pouvez spécifier une autre valeur dans la
charge utile. Par exemple :
JSON
Obtenir apiId :
Azure CLI
Les informations d’identification de débogage sont retournées dans la réponse,
d’une façon similaire à ceci :
JSON
2. Ajouter la valeur du jeton dans un en-tête de demande : pour activer le traçage
d’une requête adressée à la passerelle du service Gestion des API, envoyez la
valeur du jeton dans un en-tête Apim-Debug-Authorization . Par exemple, pour
iceName}/gateways/managed/listDebugCredentials?api-version=2023-05-01-
preview
{
"credentialsExpireAfter": PT1H,
"apiId":
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/pro
viders/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}",
"purposes": ["tracing"]
}
7 Notes
Le apiId peut être extrait seulement de l’ID de ressource complet et non pas
du nom affiché dans le portail.
az apim api list --resource-group <resource-group> --service-name
<service-name> -o table
{
"token": "aid=api-name&......."
} | [
-0.01912190020084381,
-0.013432467356324196,
-0.005446185357868671,
0.01010340079665184,
0.03233112767338753,
0.023189889267086983,
0.03926236554980278,
0.05620144307613373,
-0.05032188817858696,
-0.06228054687380791,
-0.0010767608182504773,
-0.059573594480752945,
-0.0533076710999012,
0.01... | {
"azure_component": "network",
"chunk_index": 363,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "224",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
suivre un appel à l’API Petstore que vous avez importée dans un précédent
didacticiel, vous pouvez utiliser une requête semblable à ce qui suit :
Bash
3. Évaluer la réponse : la réponse peut contenir un des en-têtes suivants, selon l’état
du jeton de débogage :
Si le jeton de débogage est valide, la réponse comprend un en-tête Apim-
Trace-Id dont la valeur est l’ID de trace, comme suit :
HTTP
Si le jeton de débogage a expiré, la réponse comprend un en-tête Apim-
Debug-Authorization-Expired avec des informations sur la date d’expiration.
Si le jeton de débogage a été obtenu pour une autre API, la réponse
comprend un en-tête Apim-Debug-Authorization-WrongAPI avec un message
d’erreur.
4. Récupérer la trace : passez l’ID de trace obtenu à l’étape précédente à l’API List
trace de la passerelle. Par exemple, pour récupérer la trace de la passerelle
managée, utilisez une requête semblable à ce qui suit :
HTTP
Dans le corps de la requête, passez l’ID de trace obtenu à l’étape précédente.
JSON
curl -v https://apim-hello-world.azure-api.net/pet/1 HTTP/1.1 \
-H "Ocp-Apim-Subscription-Key: <subscription-key>" \
-H "Apim-Debug-Authorization: aid=api-name&......."
Apim-Trace-Id: 0123456789abcdef....
POST
https://management.azure.com/subscriptions/{subscriptionId}/resourceGro
ups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serv
iceName}/gateways/managed/listTrace?api-version=2023-05-01-preview
{
"traceId": "0123456789abcdef...."
} | [
-0.028902973979711533,
-0.04218347743153572,
-0.017045659944415092,
0.021980730816721916,
0.0449380949139595,
0.019277464598417282,
0.05809381604194641,
0.0469827838242054,
-0.02831193245947361,
-0.04837607964873314,
-0.011632655747234821,
-0.05035912245512009,
-0.06851707398891449,
0.0209... | {
"azure_component": "network",
"chunk_index": 364,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "225",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
Le corps de la réponse contient les données de trace de la requête d’API
précédente envoyée à la passerelle. La trace est similaire à celle que vous pouvez
consulter en traçant un appel dans la console de test du portail.
Pour automatiser ces étapes avec l’extension Client REST Visual Studio Code
, vous
pouvez utiliser l’exemple de fichier .http suivant :
HTTP
Exemple de fichier .http pour l’extension Client REST VS
Code
@subscriptionId = // Your subscription ID
@resourceGroup = // Your resource group
@apimName = // Your API Management service name
@clientId = // Client ID from an app registration for authentication
@clientSecret = // Client secret from app registration
@externalHost = // The host name of the App Gateway or the fully qualified
gateway URL
@subscriptionKey = // API Management subscription key
@apiEndPoint = // API URL
@requestBody = // Data to send
@tenantId = // Tenant ID
POST https://login.microsoftonline.com/{{tenandId}}/oauth2/token
content-type: application/x-www-form-urlencoded
grant_type=client_credentials&client_id={{clientId}}&client_secret=
{{clientSecret}}&resource=https%3A%2F%2Fmanagement.azure.com%2F
###
@authToken = {{login.response.body.$.access_token}}
###
# @name listDebugCredentials
POST
https://management.azure.com/subscriptions/{{subscriptionId}}/resourceGroups
/{{resourceGroup}}/providers/Microsoft.ApiManagement/service/{{apimName}}/ga
teways/managed/listDebugCredentials?api-version=2023-05-01-preview
Authorization: Bearer {{authToken}}
Content-Type: application/json
{
"credentialsExpireAfter": "PT1H",
"apiId":
"/subscriptions/{{subscriptionId}}/resourceGroups/{{resourceGroup}}/provider
s/Microsoft.ApiManagement/service/{{apimName}}/apis/{{apiId}}",
"purposes": ["tracing"]
}
###
@debugToken = {{listDebugCredentials.response.body.$.token}} | [
-0.0018990422831848264,
-0.023253658786416054,
-0.0032943137921392918,
-0.03178482875227928,
0.04814281314611435,
0.022337662056088448,
0.06437314301729202,
0.02858821488916874,
-0.03146129846572876,
-0.08513704687356949,
-0.018692685291171074,
-0.056862782686948776,
-0.04785989224910736,
... | {
"azure_component": "network",
"chunk_index": 365,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "226",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
Commentaires
Cette page a-t-elle été utile ?
Indiquer des commentaires sur le produit
| Obtenir de l’aide sur Microsoft Q&A
Pour plus d’informations sur la personnalisation des informations de suivi, consultez la
stratégie trace.
Dans ce didacticiel, vous avez appris à :
Passez au tutoriel suivant :
###
# @name callApi
curl -k -H "Apim-Debug-Authorization: {{debugToken}}" -H 'Host:
{{externalHost}}' -H 'Ocp-Apim-Subscription-Key: {{subscriptionKey}}' -H
'Content-Type: application/json' '{{apiEndPoint}}' -d '{{requestBody}}'
###
@traceId = {{callApi.response.headers.Apim-Trace-Id}}
###
# @name getTrace
POST
https://management.azure.com/subscriptions/{{subscriptionId}}/resourceGroups
/{{resourceGroup}}/providers/Microsoft.ApiManagement/service/{{apimName}}/ga
teways/managed/listTrace?api-version=2024-06-01-preview
Authorization: Bearer {{authToken}}
Content-Type: application/json
{
"traceId": "{{traceId}}"
}
Étapes suivantes
Tracer un exemple d’appel dans la console de test
"
Passer en revue les étapes du traitement des demandes
"
Activer le traçage pour une API
"
Utiliser des révisions
Yes
No | [
0.02570774406194687,
-0.00483310129493475,
0.018976422026753426,
-0.023288151249289513,
0.02313147485256195,
0.025443073362112045,
0.05255196616053581,
0.06297630071640015,
-0.025888070464134216,
-0.04414266720414162,
-0.0056639802642166615,
-0.050224583595991135,
-0.04442218318581581,
-0.... | {
"azure_component": "network",
"chunk_index": 366,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "227",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
Tutoriel : Utiliser des révisions pour
apporter en toute sécurité des
modifications d’API non cassantes
Article • 04/01/2025
S’APPLIQUE À : Tous les niveaux de Gestion des API
Une fois que votre API est prête et est utilisée par les développeurs, vous devez finir par
lui apporter des modifications sans interrompre les appelants de l’API. Il est également
utile d’informer les développeurs des modifications apportées.
Dans Gestion des API Azure, utilisez des révisions pour apporter des modifications d’API
non cassantes afin de pouvoir modéliser et tester ces modifications de manière
sécurisée. Quand vous êtes prêt, vous pouvez rendre actuelle une révision et remplacer
votre API actuelle.
Pour plus d’informations, consultez Versions et Révisions.
Dans ce tutoriel, vous allez apprendre à :
Apprenez la terminologie relative à Gestion des API Azure.
Ajouter une révision
"
Apporter des modifications non cassantes à votre révision
"
Rendre cette révision actuelle et ajouter une entrée au journal des modifications
"
Parcourir le portail des développeurs pour voir les modifications et le journal des
modifications
"
Accéder à une révision d’API
"
Prérequis | [
0.0011314335279166698,
-0.027839617803692818,
-0.010204466059803963,
0.006745346821844578,
0.056081708520650864,
0.03921413794159889,
0.04129355773329735,
0.025043928995728493,
-0.09243345260620117,
-0.06570113450288773,
-0.01080587599426508,
-0.03340611234307289,
-0.06794131547212601,
0.0... | {
"azure_component": "network",
"chunk_index": 367,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "228",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
Suivez le guide de démarrage rapide suivant : Créer une instance du service
Gestion des API Azure.
Suivez également le didacticiel suivant : Importer et publier votre première API.
1. Connectez-vous au portail Azure
et accédez à votre instance de Gestion des API.
2. Dans le menu de gauche, sous API, sélectionnez API.
3. Dans la liste des API, sélectionnez Swagger Petstore (ou une autre API à laquelle
vous souhaitez ajouter des révisions).
4. Sélectionnez l’onglet Révisions.
5. Sélectionnez + Ajouter une révision.
6. Indiquez une description pour votre nouvelle révision, ce qui vous aidera à vous
souvenir à quoi elle sert.
7. Sélectionnez Créer.
8. Vous venez de créer une nouvelle révision.
Ajouter une révision
Conseil
Vous pouvez également sélectionner Ajouter une révision dans le menu
contextuel ( ... ) de l’API.
7 Notes | [
-0.02048833854496479,
-0.05346948280930519,
-0.018616080284118652,
-0.003940478432923555,
0.019371185451745987,
0.04722807928919792,
0.03596871346235275,
0.045201368629932404,
-0.026171069592237473,
-0.052927255630493164,
-0.025971675291657448,
-0.030235344544053078,
-0.06122943013906479,
... | {
"azure_component": "network",
"chunk_index": 368,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "229",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
1. Sélectionnez Swagger Petstore dans la liste des API.
2. Sélectionnez l’onglet Conception situé près du haut de l’écran.
3. Notez que dans le sélecteur de révision (juste au-dessus de l’onglet Conception),
Revision 2 est sélectionné.
4. Sélectionnez + Ajouter une opération.
5. Définissez votre nouvelle opération sur POST, puis les champs Nom d’affichage,
Nom et URL de l’opération sur la valeur test.
6. Enregistrez votre nouvelle opération.
7. Vous avez modifié Revision 2. Utilisez le sélecteur de révision situé près du haut
de la page pour revenir à Revision 1.
8. Notez que votre nouvelle opération n’apparaît pas dans Revision 1.
Votre API d’origine reste dans Revision 1. Il s’agit de la révision que vos
utilisateurs continuent à appeler, jusqu’à ce que vous choisissiez d’actualiser
une autre révision.
Apporter des modifications non cassantes à
votre révision
Conseil
Utilisez le sélecteur de révision pour basculer entre les révisions sur lesquelles
vous souhaitez travailler. | [
-0.013633886352181435,
-0.047435592859983444,
0.007225431501865387,
-0.014287697151303291,
0.049643222242593765,
0.04081672057509422,
0.018859179690480232,
0.03904624655842781,
-0.059811484068632126,
-0.0735819861292839,
-0.03846060484647751,
0.02728198654949665,
-0.03324398398399353,
-0.0... | {
"azure_component": "network",
"chunk_index": 369,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "230",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
1. Sélectionnez l’onglet Révisions dans le menu situé en haut de la page.
2. Ouvrez le menu contextuel (...) pour Revision 2.
3. Sélectionnez Rendre actuel.
4. Cochez la case Publier sur le journal des modifications public de cette API, si
vous souhaitez publier les remarques relatives à cette modification. Fournissez
une description de votre modification destinée aux développeurs, par exemple
: Test des révisions. Nouvelle opération « test » ajoutée.
5. Revision 2 est maintenant la révision actuelle.
Si vous avez essayé le portail des développeurs, vous pouvez passer en revue les
modifications apportées à l’API et y changer le journal.
1. Dans le portail Azure, accédez à votre instance APIM.
2. Dans le menu de gauche, sous API, sélectionnez API.
3. Sélectionnez Portail des développeurs dans le menu supérieur.
Rendre cette révision actuelle et ajouter une
entrée au journal des modifications
Portail
Parcourir le portail des développeurs pour voir
les modifications et le journal des
modifications | [
-0.013254278339445591,
-0.0068978541530668736,
-0.01180919911712408,
-0.017222769558429718,
0.06510118395090103,
0.01959710195660591,
0.015428689308464527,
0.04985973611474037,
-0.06159088388085365,
-0.0851721465587616,
-0.012078455649316311,
0.034268397837877274,
-0.02429264970123768,
0.0... | {
"azure_component": "network",
"chunk_index": 370,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "231",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
4. Dans le portail des développeurs, sélectionnez API, puis Swagger Petstore.
5. Notez que votre nouvelle opération test est désormais disponible.
6. Sélectionnez Journal des modifications en regard du nom de l’API.
7. Notez que l’entrée du journal des modifications apparaît dans cette liste.
Chaque révision de votre API est accessible à l’aide d’une URL spécialement formée.
Ajoutez ;rev={revisionNumber} à la fin de votre chemin d’URL d’API, avant la chaîne de
requête, pour accéder à une révision spécifique de cette API. Par exemple, vous pouvez
utiliser une URL semblable à la suivante pour accéder à la révision 2 de l’API Swagger
Petstore :
https://apim-hello-world.azure-api.net/store/pet/1;rev=2/
Vous trouverez les chemins d’URL des révisions de votre API sous l’onglet Révisions sur
le Portail Azure.
Dans ce didacticiel, vous avez appris à :
Accéder à une révision d’API
Conseil
Vous pouvez accéder à la révision actuelle de votre API à l’aide du chemin d’accès
de l’API sans la chaîne ;rev , en plus de l’URL complète qui ajoute ;rev=
{revisionNumber} à votre chemin d’API.
Résumé
Ajouter une révision
"
Apporter des modifications non cassantes à votre révision
"
Rendre cette révision actuelle et ajouter une entrée au journal des modifications
"
Parcourir le portail des développeurs pour voir les modifications et le journal des
modifications
" | [
-0.007761453744024038,
-0.04189363867044449,
-0.021331695839762688,
0.01316132303327322,
0.0637001320719719,
0.011052034795284271,
0.044986143708229065,
0.045218419283628464,
-0.044546857476234436,
-0.052451882511377335,
-0.03666304796934128,
-0.019061045721173286,
-0.05088166147470474,
-0... | {
"azure_component": "network",
"chunk_index": 371,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "232",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
Commentaires
Cette page a-t-elle été utile ?
Indiquer des commentaires sur le produit
| Obtenir de l’aide sur Microsoft Q&A
Passez au tutoriel suivant :
Accéder à une révision d’API
"
Étapes suivantes
Publier plusieurs versions de votre API
Yes
No | [
0.037979304790496826,
-0.021467512473464012,
0.028806466609239578,
0.024899622425436974,
0.028695732355117798,
0.04391204193234444,
0.026935303583741188,
0.04848339408636093,
-0.04025967791676521,
-0.03403758630156517,
-0.01714644394814968,
-0.006113304756581783,
-0.07894611358642578,
0.00... | {
"azure_component": "network",
"chunk_index": 372,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "233",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
Tutoriel : Publier plusieurs versions de votre
API
23/06/2025
S’APPLIQUE À : Tous les niveaux de Gestion des API
Il existe des situations où il est difficile pour tous les consommateurs d’API d’utiliser la même
version. Lorsque les consommateurs sont prêts à effectuer une mise à niveau vers une version
plus récente, ils préfèrent une approche simple et compréhensible. Comme illustré dans ce
tutoriel, Gestion des API Azure prend en charge l’exposition de plusieurs versions d’API pour
répondre à ce besoin.
Pour plus d’informations, consultez Versions et Révisions.
Dans ce tutoriel, vous allez apprendre à :
Conseil
Les équipes d’API peuvent utiliser cette fonctionnalité dans des espaces de travail. Les
espaces de travail fournissent un accès d’administration isolé aux API et à leurs propres
environnements d’exécution d’API.
Ajouter une nouvelle version à une API existante
"
Choisir un schéma de version
"
Ajouter la version à un produit
"
Afficher la version dans le portail des développeurs
" | [
0.030321011319756508,
-0.01056689489632845,
0.0028404290787875652,
-0.01895846612751484,
0.04942477494478226,
0.04422149062156677,
0.042329221963882446,
0.0307639017701149,
-0.0792773887515068,
-0.03677419200539589,
-0.0318756178021431,
-0.04452482610940933,
-0.08492611348628998,
0.0267959... | {
"azure_component": "network",
"chunk_index": 373,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "234",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
Découvrez la terminologie gestion des API Azure.
Terminez le démarrage rapide Créer une instance Azure API Management.
Suivez le tutoriel Importer et publier votre première API.
1. Dans le portail Azure
, accédez à votre instance APIM.
2. Dans le menu de gauche, dans la section API , sélectionnez API.
3. Recherchez Swagger Petstore - OpenAPI 3.0 dans la liste des API. Sélectionnez les points
de suspension (...) à côté de Swagger Petstore - OpenAPI 3.0, puis sélectionnez Ajouter
une version. Vous allez ajouter des valeurs à la fenêtre résultante dans la section suivante.
Prérequis
Ajouter une nouvelle version | [
-0.037874311208724976,
-0.036777086555957794,
-0.017534790560603142,
0.011653197929263115,
0.03923488035798073,
0.006003393325954676,
0.05053480714559555,
0.029686199501156807,
-0.005277473945170641,
-0.05029579624533653,
-0.026130827143788338,
-0.017050817608833313,
-0.0572943389415741,
0... | {
"azure_component": "network",
"chunk_index": 374,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "235",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
Dans Gestion des API, vous choisissez la façon dont les appelants spécifient la version de l’API
en sélectionnant un schéma de contrôle de version : chemin d’accès, en-tête ou chaîne de
requête. Dans l’exemple suivant, Path est utilisé comme schéma de contrôle de version.
Dans la fenêtre Créer une nouvelle API en tant que version, entrez les valeurs du tableau
suivant. Sélectionnez ensuite Créer pour créer votre version.
Paramètre
valeur
Descriptif
Identificateur de
version
v1
Indicateur de la version lié au schéma. Pour Chemin d’accès, le
suffixe du chemin de l’URL de l’API.
Conseil
Vous pouvez également activer les versions lorsque vous créez une API. Dans l’écran
Ajouter l’API, sélectionnez Créer une version pour cette API ? .
Choisissez un schéma de contrôle de version
ノ
Agrandir le tableau | [
-0.05152192339301109,
0.036583252251148224,
-0.01349793653935194,
-0.03558998182415962,
0.06258659064769745,
0.004659377038478851,
0.0033103623427450657,
0.03512733057141304,
-0.051594119518995285,
-0.040723081678152084,
-0.015222358517348766,
-0.03624888136982918,
-0.08437902480363846,
0.... | {
"azure_component": "network",
"chunk_index": 375,
"contains_sku": true,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "236",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
Paramètre
valeur
Descriptif
Schéma de
gestion de version
Chemin d’accès
Façon dont les appelants spécifient la version de l’API.
Si vous sélectionnez En-tête ou chaîne de requête, entrez une
autre valeur : le nom du paramètre d’en-tête ou de chaîne de
requête.
Un exemple d’utilisation est affiché.
Nom complet de
la version de l’API
swagger-petstore-
openapi-3-0-v1
Nom unique dans votre instance Gestion des API.
Étant donné qu’une version est en fait une nouvelle API basée
sur la révision d’une API, cette valeur est le nom de la nouvelle
API.
Produits
Illimité (fourni
dans certains
niveaux de
service)
Éventuellement, un ou plusieurs produits auxquels la version
de l’API est associée. Pour publier l’API, vous devez l’associer à
un produit. Vous pouvez également ajouter la version à un
produit ultérieurement.
Après avoir créé la version, elle apparaît sous Swagger Petstore - OpenAPI 3.0 dans la liste des
API. Vous voyez maintenant deux API : Original et v1 :
7 Notes | [
-0.03580138459801674,
-0.015723513439297676,
0.012412217445671558,
-0.0165642611682415,
0.03755296766757965,
0.06450901925563812,
0.02507878467440605,
0.011238249950110912,
-0.03695168346166611,
-0.030974838882684708,
-0.02163601666688919,
-0.04641784355044365,
-0.06795451790094376,
0.0113... | {
"azure_component": "network",
"chunk_index": 376,
"contains_sku": true,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "237",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
Après avoir ajouté la version, vous pouvez la modifier et la configurer en tant qu’API distincte
de l’original. Les modifications apportées à une version n’affectent pas une autre version (par
exemple, si vous ajoutez ou supprimez des opérations d’API, ou modifiez la spécification
OpenAPI). Pour plus d’informations, consultez Modifier une API.
Pour que les appelants puissent voir la nouvelle version, il doit être ajouté à un produit. Si vous
n’avez pas déjà ajouté la version à un produit, vous pouvez le faire à tout moment.
Pour ajouter la version à un produit :
1. Dans le portail Azure, accédez à votre instance APIM.
2. Sous API dans le volet gauche, sélectionnez Produits.
3. Sélectionnez le produit, puis sélectionnez LES API dans le volet gauche.
4. Sélectionnez + Ajouter.
5. Sélectionnez l’API.
6. Cliquez sur Sélectionner.
Si vous ajoutez une version à une API non versionnée, une version d’origine est également
créée automatiquement. Cette version répond sur l’URL par défaut. La version d’origine
garantit que les appels des appelants existants fonctionnent toujours après l’ajout de la
version. Si vous créez une API avec des versions activées au début, un original n’est pas
créé.
Modifier une version
Ajouter la version à un produit
Utiliser des ensembles de versions | [
-0.009745974093675613,
-0.009319741278886795,
-0.011219946667551994,
-0.032245151698589325,
0.05197649821639061,
0.045302942395210266,
0.03348782658576965,
0.02142966166138649,
-0.03310299292206764,
-0.06858653575181961,
-0.04549749195575714,
-0.03873954340815544,
-0.09749263525009155,
0.0... | {
"azure_component": "network",
"chunk_index": 377,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "238",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
Lorsque vous créez plusieurs versions, le portail Azure crée un ensemble de versions, qui
représente un ensemble de versions pour une API logique unique. Si vous sélectionnez le nom
d’une API avec plusieurs versions, le portail affiche son jeu de versions. Vous pouvez
personnaliser le nom et la description d’un ensemble de versions.
Vous pouvez interagir directement avec les ensembles de versions à l’aide de l’interface Azure
CLI :
Utilisez l’environnement Bash dans Azure Cloud Shell. Pour obtenir plus d’informations,
consultez Démarrage d’Azure Cloud Shell.
Si vous préférez exécuter les commandes de référence de l’interface de ligne de
commande localement, installez l’interface Azure CLI. Si vous exécutez sur Windows ou
macOS, envisagez d’exécuter Azure CLI dans un conteneur Docker. Pour plus
d’informations, consultez Guide pratique pour exécuter Azure CLI dans un conteneur
Docker.
Si vous utilisez une installation locale, connectez-vous à Azure CLI à l’aide de la
commande az login. Pour finir le processus d’authentification, suivez les étapes
affichées dans votre terminal. Pour obtenir d’autres options de connexion, consultez
S’authentifier auprès d’Azure à l’aide d’Azure CLI.
Lorsque vous y êtes invité, installez l’extension Azure CLI lors de la première utilisation.
Pour plus d’informations sur les extensions, consultez Utiliser et gérer des extensions
avec Azure CLI.
Exécutez az version pour rechercher la version et les bibliothèques dépendantes
installées. Pour effectuer une mise à niveau vers la dernière version, exécutez az
upgrade.
Pour afficher tous vos ensembles de versions, exécutez la commande az apim api versionset
list :
Azure CLI
Lorsque le portail Azure crée un ensemble de versions pour vous, il attribue un nom
alphanumérique, qui apparaît dans la colonne Nom de la liste. Utilisez | [
-0.03011094406247139,
0.026408469304442406,
-0.02390194870531559,
-0.02580990456044674,
0.09992079436779022,
0.05649135261774063,
0.009524847380816936,
0.048278771340847015,
-0.029030462726950645,
-0.06688939034938812,
-0.02508796937763691,
-0.01153367105871439,
-0.08921899646520615,
0.006... | {
"azure_component": "network",
"chunk_index": 378,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "239",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
Pour effectuer une mise à niveau vers la dernière version, exécutez az
upgrade.
Pour afficher tous vos ensembles de versions, exécutez la commande az apim api versionset
list :
Azure CLI
Lorsque le portail Azure crée un ensemble de versions pour vous, il attribue un nom
alphanumérique, qui apparaît dans la colonne Nom de la liste. Utilisez ce nom dans les autres
commandes Azure CLI.
az apim api versionset list --resource-group <resource-group-name> \
--service-name <API-Management-service-name> --output table | [
-0.02795783430337906,
0.04260091483592987,
-0.010027729906141758,
-0.021120183169841766,
0.0772189199924469,
0.029090316966176033,
0.029977431520819664,
0.02918780781328678,
-0.022681983187794685,
-0.04549913480877876,
-0.030931975692510605,
0.009025088511407375,
-0.09021269530057907,
0.00... | {
"azure_component": "network",
"chunk_index": 379,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "239",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
Pour afficher les détails d’un ensemble de versions, exécutez la commande az apim api
versionset show :
Azure CLI
Pour plus d’informations sur les ensembles de versions, consultez Versions dans Gestion des
API Azure.
Si vous utilisez le portail des développeurs, vous pouvez y voir les versions de l’API.
1. Sélectionnez Le portail des développeurs en haut de la fenêtre.
2. Sélectionnez API, puis Swagger Petstore.
3. Vous devez voir une liste déroulante qui répertorie plusieurs versions en regard du nom
de l’API.
4. Sélectionnez v1.
5. Notez l’URL de la demande de la première opération de la liste. Il indique que le chemin
d’accès de l’URL de l’API inclut v1.
Accédez au tutoriel suivant :
az apim api versionset show --resource-group <resource-group-name> \
--service-name <API-Management-service-name> --version-set-id <ID from the
Name column>
Afficher la version dans le portail des développeurs
Étape suivante
Personnaliser le style des pages du portail des développeurs | [
-0.03142068162560463,
0.03861759230494499,
-0.023554056882858276,
-0.018352970480918884,
0.07167702168226242,
0.010122113861143589,
0.015235178172588348,
0.037951476871967316,
-0.03546829894185066,
-0.047759875655174255,
-0.023090481758117676,
0.00871160626411438,
-0.08046533167362213,
0.0... | {
"azure_component": "network",
"chunk_index": 380,
"contains_sku": true,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "240",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
Tutoriel : Accéder et personnaliser le portail
des développeurs
28/05/2025
S’APPLIQUE À : Développeur | Essentiel | Essentiel v2 | Standard | Standard v2 | Premium |
Premium v2
Le portail des développeurs est un site web automatiquement généré et entièrement
personnalisable avec la documentation de vos API. C’est là que les consommateurs d’API
peuvent découvrir vos API, apprendre à les utiliser et y demander l’accès.
Dans ce tutoriel, vous allez apprendre à :
Pour plus d’informations sur les fonctionnalités et options du portail des développeurs,
consultez la vue d’ensemble du portail des développeurs Gestion des API Azure.
Suivez le guide de démarrage rapide suivant : Créer une instance Gestion des API Azure.
Accéder à la version managée du portail des développeurs
"
Parcourir son interface d’administration
"
Personnaliser le contenu
"
Publier les modifications
"
Afficher le portail publié
"
Prérequis | [
0.005812180694192648,
0.004121378064155579,
0.00547245005145669,
-0.00864503625780344,
0.02760041318833828,
0.020041923969984055,
0.03083963133394718,
0.012373076751828194,
-0.068446584045887,
-0.060855213552713394,
-0.02709963731467724,
-0.06100820004940033,
-0.07519981265068054,
0.025508... | {
"azure_component": "network",
"chunk_index": 381,
"contains_sku": true,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "241",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
Importez et publiez une API.
Suivez les étapes ci-dessous pour accéder à la version managée du portail.
1. Dans le portail Azure
, accédez à votre instance Gestion des API.
2. Si vous avez créé votre instance dans un niveau de service v2, activez d'abord le portail
des développeurs.
a. Dans le menu de gauche, sous portail des développeurs, sélectionnez Paramètres du
portail.
b. Dans la fenêtre paramètres du portail , sélectionnez Activé. Sélectionnez Enregistrer.
L'activation du portail des développeurs peut prendre quelques minutes.
3. Dans le menu de gauche, sous Portail des développeurs, sélectionnez Vue d’ensemble
du portail. Sélectionnez ensuite le bouton Du portail des développeurs dans la barre de
navigation supérieure. Un nouvel onglet de navigateur s’ouvre, en affichant une version
d’administration du portail.
En tant qu’administrateur, vous pouvez personnaliser le contenu du portail à l’aide de l’éditeur
visuel.
Accéder au portail en tant qu’administrateur
7 Notes
Nous améliorons le portail des développeurs avec Fluent UI Web Components dans
l’infrastructure React. Nous actualisons également le contenu de l’espace réservé
affiché lors de la première ouverture du portail. L’apparence de votre portail peut
différer légèrement des captures d’écran de cet article, mais la fonctionnalité reste
cohérente.
Si vous utilisez une version du portail basée sur les composants précédents, vous
verrez un nouveau paramètre de conception d’interface utilisateur en préversion en
bas du menu à gauche. Activez ce paramètre pour essayer la dernière expérience.
Comprendre l’interface d’administration du portail | [
-0.06876714527606964,
0.016798503696918488,
-0.02546951174736023,
-0.0288410522043705,
0.03949059545993805,
0.04025376960635185,
0.014746582135558128,
0.0506456233561039,
-0.04436901584267616,
-0.09373797476291656,
0.005273329094052315,
-0.05084017291665077,
-0.07915962487459183,
0.0280187... | {
"azure_component": "network",
"chunk_index": 382,
"contains_sku": true,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "242",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
Utilisez les options de menu à gauche pour créer ou modifier des pages, des médias, des
dispositions, des menus, des styles ou des paramètres de site web.
En haut, basculez entre les fenêtres d’affichage (pour les écrans de différentes tailles) ou
affichez les éléments du portail visibles par les utilisateurs dans différents groupes. Par
exemple, vous souhaitez peut-être afficher certaines pages uniquement pour des groupes
associés à des produits particuliers ou pour des utilisateurs qui peuvent accéder à des API
spécifiques.
En outre, enregistrez ou annulez les modifications que vous apportez ou publiez le site
web.
Vous souhaiterez utiliser vos propres images et d’autres contenus multimédias dans le portail
des développeurs pour refléter la personnalisation de votre organisation. Si une image que
vous souhaitez utiliser n’est pas déjà dans la bibliothèque multimédia du portail, ajoutez-la
dans le portail des développeurs :
Conseil
Pour une plus grande flexibilité dans la personnalisation du portail, vous pouvez utiliser un
plug-in du portail des développeurs open source pour WordPress. Tirez parti des
fonctionnalités du site WordPress pour localiser le contenu, personnaliser les menus,
appliquer des feuilles de style personnalisées, et bien plus encore.
Ajouter une image à la bibliothèque multimédia | [
-0.003736258717253804,
0.02820034697651863,
-0.007710854988545179,
-0.005115591920912266,
0.03982102498412132,
0.03890879824757576,
-0.0004459576157387346,
0.05901462957262993,
-0.07030906528234482,
-0.07067707180976868,
-0.03806637227535248,
-0.015336510725319386,
-0.037178684026002884,
-... | {
"azure_component": "network",
"chunk_index": 383,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "243",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
1. Dans le menu de gauche de l’éditeur visuel, sélectionnez Média.
2. Effectuez l’une des actions suivantes :
Sélectionnez Charger un fichier et sélectionnez un fichier image local sur votre
ordinateur.
Sélectionnez Fichier de liens. Entrez une URL de référence au fichier image et
d’autres détails. Sélectionnez Ensuite Télécharger.
3. Sélectionnez Fermer pour quitter la bibliothèque multimédia.
Un logo d’espace réservé est fourni dans le coin supérieur gauche de la barre de navigation.
Vous pouvez le remplacer par votre propre logo pour qu’il corresponde à la marque de votre
organisation.
1. Dans le portail des développeurs, sélectionnez le logo par défaut en haut à gauche de la
barre de navigation.
2. Sélectionnez Modifier.
3. Dans la fenêtre contextuelle Image , sous Main, sélectionnez Source.
4. Dans la fenêtre contextuelle Media , sélectionnez l’une des options suivantes :
Image déjà chargée dans votre bibliothèque multimédia
Charger un fichier pour charger un nouveau fichier image dans votre bibliothèque
multimédia
Aucun si vous ne souhaitez pas utiliser de logo
5. Le logo est mis à jour en temps réel.
6. Cliquez en dehors des fenêtres contextuelles pour quitter la bibliothèque multimédia.
7. Dans la barre supérieure, sélectionnez Enregistrer.
La page d’accueil par défaut et d’autres pages sont fournies avec du texte d’espace réservé et
d’autres images. Vous pouvez soit supprimer des sections entières comportant ce contenu, soit
Conseil
Vous pouvez également ajouter une image à la bibliothèque multimédia en le faisant
glisser-déplacer directement dans la fenêtre de l’éditeur visuel.
Remplacer le logo par défaut sur la page d’accueil
Modifier le contenu sur la page d’accueil | [
-0.017773274332284927,
-0.016132032498717308,
-0.018922045826911926,
-0.004505593795329332,
0.023777496069669724,
0.008821135386824608,
-0.021597160026431084,
0.04633530229330063,
-0.03471798077225685,
-0.07841869443655014,
-0.06491204351186752,
0.04283696785569191,
-0.043890006840229034,
... | {
"azure_component": "network",
"chunk_index": 384,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "244",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
conserver la structure et ajuster les éléments un par un. Remplacez le texte et les images
générés par les vôtres en veillant à ce que les liens pointent vers les emplacements souhaités.
Modifiez la structure et le contenu des pages générées de plusieurs façons. Par exemple :
Sélection des éléments de texte et d’en-tête existants pour modifier et mettre en forme le
contenu.
Ajoutez une section à une page en pointant sur une zone vide, puis cliquez sur l’icône
bleue contenant un signe plus. Choisissez parmi plusieurs dispositions de section.
Ajoutez un widget (par exemple, du texte, une image, un widget personnalisé ou une liste
d’API) en pointant sur une zone vide, puis cliquez sur l’icône grise contenant un signe
plus.
Réorganiser les éléments d’une page en faisant glisser-déplacer.
Pour modifier les couleurs, les dégradés, la typographie, les boutons et d’autres éléments
d’interface utilisateur dans le portail des développeurs, modifiez les styles de site. Par exemple,
modifiez la couleur principale utilisée dans la barre de navigation, les boutons et d’autres
éléments pour qu’ils correspondent à la personnalisation de votre organisation.
1. Dans le portail des développeurs, dans le menu de gauche de l’éditeur visuel,
sélectionnez Styles.
2. Dans la section Couleurs , sélectionnez l’élément de style de couleur que vous souhaitez
modifier. Par exemple, sélectionnez Primary.
3. Sélectionnez Modifier la couleur.
4. Sélectionnez la couleur dans le sélecteur de couleurs ou saisissez le code de couleur
hexadécimal.
5. Dans la barre supérieure, sélectionnez Enregistrer.
Modifier la couleur principale du site | [
-0.023716963827610016,
0.016160117462277412,
-0.03639325127005577,
-0.014980586245656013,
0.023058876395225525,
0.0032835612073540688,
0.012929096817970276,
0.03490188717842102,
-0.054354097694158554,
-0.07519415766000748,
-0.046752795577049255,
-0.006059048697352409,
-0.05166254937648773,
... | {
"azure_component": "network",
"chunk_index": 385,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "245",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
La couleur mise à jour est appliquée au site en temps réel.
Vous pouvez modifier l’arrière-plan de la page d’accueil de votre portail en une image ou une
couleur qui correspond à la personnalisation de votre organisation. Si vous n’avez pas déjà
chargé d’image différente dans la bibliothèque multimédia, vous pouvez le charger avant de
modifier l’image d’arrière-plan ou lorsque vous la modifiez.
1. Dans la page d’accueil du portail des développeurs, cliquez dans le coin supérieur droit
pour que la section supérieure soit mise en surbrillance dans les coins et qu’un menu
contextuel s’affiche.
2. À droite de Modifier l’article dans le menu contextuel, sélectionnez la flèche haut et bas
(Basculer vers le parent).
3. Sélectionnez Modifier la section.
4. Dans la fenêtre contextuelle Section , sous Arrière-plan, sélectionnez l’une des icônes :
Conseil
Si vous le souhaitez, ajoutez et nommez un autre élément de couleur en sélectionnant +
Ajouter une couleur dans la page Styles .
Modifier l’image d’arrière-plan sur la page
d’accueil | [
-0.04723161831498146,
0.0018927446799352765,
-0.03578847646713257,
-0.04790317639708519,
0.025506315752863884,
0.017390957102179527,
-0.010530338622629642,
0.020100653171539307,
-0.0635976642370224,
-0.03385550528764725,
-0.07235307991504669,
-0.0060455952771008015,
-0.03894134610891342,
-... | {
"azure_component": "network",
"chunk_index": 386,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "246",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
Effacer l’arrière-plan pour supprimer une image d’arrière-plan
Image d’arrière-plan, pour sélectionner une image à partir de la bibliothèque
multimédia ou pour charger une nouvelle image
Couleur d’arrière-plan, pour sélectionner une couleur dans le sélecteur de couleurs
ou pour effacer une couleur
Dégradé d’arrière-plan, pour sélectionner un dégradé à partir de votre page styles
de site ou pour effacer un dégradé
5. Sous Dimensionnement en arrière-plan, effectuez une sélection appropriée pour votre
arrière-plan.
6. Dans la barre supérieure, sélectionnez Enregistrer.
Le portail des développeurs utilise des mises en page pour définir des éléments de contenu
courants tels que des barres de navigation et des pieds de page dans des groupes de pages
associées. Chaque page est automatiquement mise en correspondance avec une mise en page
basée sur un modèle d’URL.
Par défaut, le portail des développeurs est fourni avec deux mises en page :
Accueil - utilisé pour la page d’accueil (modèle / d’URL)
Modifier la mise en page par défaut | [
-0.04025380313396454,
-0.018929598852992058,
-0.02811400592327118,
-0.04016627371311188,
0.039645612239837646,
-0.0048055388033390045,
-0.014621753245592117,
0.011042471043765545,
-0.04937230050563812,
-0.05714356526732445,
-0.031155413016676903,
-0.01973223313689232,
-0.022813301533460617,
... | {
"azure_component": "network",
"chunk_index": 387,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "247",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
Valeur par défaut : utilisée pour toutes les autres pages (modèle /* d’URL).
Vous pouvez modifier la mise en page de n’importe quelle page dans le portail des
développeurs et définir de nouvelles mises en page à appliquer aux pages qui correspondent à
d’autres modèles d’URL.
Par exemple, pour modifier le logo utilisé dans la barre de navigation de la mise en page par
défaut pour correspondre à la personnalisation de votre organisation :
1. Dans le menu de gauche de l’éditeur visuel, sélectionnez Pages.
2. Sélectionnez l’onglet Dispositions , puis sélectionnez Par défaut.
3. Sélectionnez l’image du logo dans le coin supérieur gauche, puis sélectionnez Modifier.
4. Sous Main, sélectionnez Source.
5. Dans les fenêtres contextuelles media , sélectionnez l’une des options suivantes :
Image déjà chargée dans votre bibliothèque multimédia
Charger un fichier pour charger un nouveau fichier image dans votre fichier
multimédia que vous pouvez sélectionner
Aucun si vous ne souhaitez pas utiliser de logo | [
-0.007711284328252077,
0.012601716443896294,
-0.03538168966770172,
0.0016879712929949164,
0.020139697939157486,
0.024820556864142418,
0.02472579851746559,
0.07197847962379456,
-0.061142753809690475,
-0.032212093472480774,
-0.04244023561477661,
-0.01792100816965103,
-0.04955095797777176,
-0... | {
"azure_component": "network",
"chunk_index": 388,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "248",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
6. Le logo est mis à jour en temps réel.
7. Cliquez en dehors des fenêtres contextuelles pour quitter la bibliothèque multimédia.
8. Dans la barre supérieure, sélectionnez Enregistrer.
Vous pouvez modifier les menus de navigation en haut des pages du portail des développeurs
pour modifier l’ordre des éléments de menu, ajouter des éléments ou supprimer des éléments.
Vous pouvez également modifier le nom des éléments de menu et l’URL ou tout autre contenu
vers lequel ils pointent.
Par exemple, les dispositions Par défaut et Accueil du portail des développeurs affichent deux
menus pour les utilisateurs invités du portail des développeurs :
un menu principal avec des liens vers la page d’accueil, les API et les produits
un menu utilisateur anonyme avec des liens vers les pages de connexion et d’inscription .
Toutefois, vous souhaiterez peut-être les personnaliser. Par exemple, si vous souhaitez inviter
des utilisateurs indépendamment à votre site, vous pouvez désactiver le lien d’inscription dans
le menu utilisateur anonyme.
1. Dans le menu de gauche de l’éditeur visuel, sélectionnez menu Site.
2. Sur la gauche, développez le menu Utilisateur anonyme.
3. Sélectionnez les paramètres (icône engrenage) à côté de S’inscrire, puis sélectionnez
Supprimer.
4. Sélectionnez Enregistrer.
Modifiez les paramètres du site pour le portail des développeurs pour modifier le nom, la
description et d’autres détails du site.
1. Dans le menu de gauche de l’éditeur visuel, sélectionnez Paramètres.
2. Dans la fenêtre contextuelle Paramètres , entrez les métadonnées du site que vous
souhaitez modifier. Si vous le souhaitez, configurez un favicon pour le site à partir d’une
image dans votre bibliothèque multimédia.
Modifier les menus de navigation
Modifier les paramètres du site | [
-0.006013920065015554,
0.04535140469670296,
-0.051144521683454514,
-0.03465668857097626,
0.03575460985302925,
0.011873389594256878,
-0.021156005561351776,
0.05760832130908966,
-0.06661666929721832,
-0.0662919208407402,
-0.06250202655792236,
0.037318743765354156,
-0.0015132977860048413,
0.0... | {
"azure_component": "network",
"chunk_index": 389,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "249",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
3. Dans la barre supérieure, Enregistrez.
Pour rendre votre portail et ses dernières modifications disponibles pour les visiteurs, vous
devez le publier .
Pour publier à partir de l’interface administrative du portail des développeurs :
1. Veillez à enregistrer vos modifications en sélectionnant le bouton Enregistrer .
2. Dans le menu en haut, sélectionnez Publier le site. Cette opération peut prendre
quelques minutes.
Pour afficher vos modifications après avoir publié le portail, accédez-y à la même URL que le
panneau d’administration, par exemple https://contoso-api.developer.azure-api.net .
Affichez-le dans une session de navigateur distincte (par le biais du mode de navigation
incognito ou privée) en tant que visiteur externe.
Pour permettre aux visiteurs de votre portail de tester les API via la console interactive intégrée,
activez CORS (partage des ressources Cross-Origin) sur vos API, si ce n’est déjà fait. Dans la
Conseil
Si vous souhaitez modifier le nom de domaine du site, vous devez d’abord configurer un
domaine personnalisé dans votre instance Gestion des API. En savoir plus sur les noms de
domaine personnalisés dans Gestion des API.
Publier le portail
Conseil
Une autre option consiste à publier le site à partir du Portail Azure. Dans la page vue
d’ensemble du portail de votre instance Gestion des API dans le portail Azure,
sélectionnez Publier.
Consulter le portail publié
Appliquer la stratégie CORS sur les API | [
-0.030819155275821686,
0.0037740583065897226,
-0.03517227619886398,
-0.038169872015714645,
0.03682935982942581,
0.01454891823232174,
0.03606967628002167,
0.017534317448735237,
-0.04981695115566254,
-0.06773201376199722,
-0.021828781813383102,
-0.037819020450115204,
-0.04875338450074196,
0.... | {
"azure_component": "network",
"chunk_index": 390,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "250",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
page vue d’ensemble du portail de votre instance Gestion des API dans le portail Azure,
sélectionnez Activer CORS. En savoir plus.
Dans ce didacticiel, vous avez appris à :
Passez au tutoriel suivant :
Consultez le contenu associé sur le portail des développeurs :
Vue d’ensemble du portail des développeurs Gestion des API Azure
Configurez l’authentification sur le portail des développeurs avec des noms d’utilisateur
et des mots de passe, un ID Microsoft Entra ou un ID externe Microsoft Entra.
En savoir plus sur la personnalisation et l’extension des fonctionnalités du portail des
développeurs.
Étapes suivantes
Accéder à la version managée du portail des développeurs
"
Parcourir son interface d’administration
"
Personnaliser le contenu
"
Publier les modifications
"
Afficher le portail publié
"
Importer et gérer des API à l’aide de Visual Studio Code | [
-0.016071580350399017,
0.001994092483073473,
-0.02972228452563286,
0.00011357151379343122,
0.04394910857081413,
0.004670208785682917,
0.02474241331219673,
0.034344397485256195,
-0.029408959671854973,
-0.05349169671535492,
-0.043785419315099716,
-0.051937125623226166,
-0.08756347000598907,
... | {
"azure_component": "network",
"chunk_index": 391,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "251",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
Tutoriel : Utiliser l'extension Gestion des
API Azure pour Visual Studio Code pour
importer et gérer des API
Article • 20/02/2025
S’APPLIQUE À : Consommation | Développeur | De base | Standard | Premium
Dans ce didacticiel, vous apprendrez à utiliser l'extension Gestion des API pour Visual
Studio Code pour les opérations courantes dans Gestion des API. Vous utiliserez
l’environnement familier de Visual Studio Code pour importer, mettre à jour, tester et
gérer des API.
Vous allez apprendre à effectuer les actions suivantes :
Pour obtenir une présentation d’autres fonctionnalités de l’extension Gestion des API,
consultez les tutoriels Gestion des API dans le portail Azure.
Comprendre la terminologie relative au service Gestion des API Azure
7 Notes
Actuellement, cette fonctionnalité n’est pas disponible dans les espaces de travail.
Importer une API dans Gestion des API
"
Modifier l’API
"
Appliquer des stratégies Gestion des API
"
Tester l’API
"
Prérequis | [
0.026034822687506676,
-0.018915846943855286,
-0.025122469291090965,
-0.010982319712638855,
0.05195575952529907,
0.017937736585736275,
0.05014181137084961,
0.05253288149833679,
-0.04327418655157089,
-0.06921295821666718,
-0.04451533406972885,
-0.051945704966783524,
-0.06900734454393387,
0.0... | {
"azure_component": "network",
"chunk_index": 392,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "252",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
Assurez-vous d'avoir installé Visual Studio Code
et la dernière extension Gestion
des API Azure pour Visual Studio Code
.
Créer une instance de Gestion des API.
L’exemple suivant importe une spécification OpenAPI au format JSON dans Gestion des
API. Pour cet exemple, vous importez l’API Petstore
open source.
1. Dans Visual Studio Code, sélectionnez l’icône Azure dans la barre d’activités.
2. Dans le volet de l’Explorateur, développez l’instance Gestion des API que vous avez
créée.
3. Cliquez avec le bouton droit sur API, puis sélectionnez Importer à partir d’un lien
OpenAPI.
4. Quand vous y êtes invité, entrez les valeurs suivantes :
a. Un lien OpenAPI pour du contenu au format JSON. Pour cet exemple :
https://petstore.swagger.io/v2/swagger.json .
Ce fichier spécifie le service back-end qui implémente l’exemple de l’API et les
opérations qu’elle prend en charge.
b. Un nom d’API, par exemple petstore, qui est unique dans l’instance Gestion des
API. Ce nom ne peut contenir que des lettres, des chiffres et des traits d’union.
Le premier et le dernier caractères doivent être alphanumériques. Ce nom est
utilisé dans le chemin pour appeler l’API.
Une fois l’API importée, elle apparaît dans le volet de l’Explorateur et les opérations
d’API disponibles sont listées sous le nœud Opérations.
Importer une API | [
-0.0164541807025671,
-0.01866116002202034,
-0.028844302520155907,
0.014216898940503597,
0.03089177794754505,
0.019647959619760513,
0.06153485178947449,
0.05119485408067703,
-0.014995149336755276,
-0.05747769773006439,
-0.06774137169122696,
-0.061415158212184906,
-0.08034560829401016,
0.010... | {
"azure_component": "network",
"chunk_index": 393,
"contains_sku": true,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "253",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
Vous pouvez modifier l’API dans Visual Studio Code. Par exemple, modifiez la
description JSON Resource Manager de l’API dans la fenêtre de l’éditeur pour supprimer
le protocole http utilisé pour accéder à l’API, qui est mis en évidence dans la capture
suivante :
Pour modifier le format OpenAPI, cliquez avec le bouton droit sur le nom de l’API dans
le volet de l’Explorateur, puis sélectionnez Modifier OpenAPI. Apportez vos
Modifier l’API | [
0.006249592173844576,
-0.004187635611742735,
-0.008948944509029388,
-0.01698632538318634,
0.03095201589167118,
0.04282025247812271,
0.02812640741467476,
0.028015488758683205,
-0.08739177137613297,
-0.07388493418693542,
-0.043880440294742584,
-0.024911407381296158,
-0.07677790522575378,
0.0... | {
"azure_component": "network",
"chunk_index": 394,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "254",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
modifications, puis sélectionnez Fichier>Enregistrer.
Gestion des API fournit des stratégies que vous pouvez configurer pour vos API. Les
stratégies sont un ensemble d’instructions. Ces instructions sont exécutées de manière
séquentielle sur demande ou sur réponse d’une API. Les stratégies peuvent être soit
globales (c’est-à-dire qu’elles s’appliquent à toutes les API de votre instance Gestion des
API), soit propres à un produit, une API ou une opération d’API.
Cette section montre comment appliquer des stratégies entrantes et sortantes
courantes à votre API.
1. Dans le volet de l’Explorateur, sélectionnez Stratégie sous l’API petstore que vous
avez importée. Le fichier de stratégie s’ouvre dans la fenêtre de l’éditeur. Ce fichier
configure des stratégies pour toutes les opérations dans l’API.
2. Mettez à jour le fichier avec le contenu suivant :
XML
La stratégie rate-limit dans la section inbound limite à 3 toutes les 15
secondes le nombre d’appels à l’API.
La stratégie set-header dans la section outbound ajoute un en-tête de
réponse personnalisé à des fins de démonstration.
3. Enregistrez le fichier . Si vous y êtes invité, sélectionnez Charger pour charger le
fichier dans le cloud.
Appliquer des stratégies à l’API
<policies>
<inbound>
<rate-limit calls="3" renewal-period="15" />
<base />
</inbound>
<outbound>
<set-header name="Custom" exists-action="override">
<value>"My custom value"</value>
</set-header>
<base />
</outbound>
<on-error>
<base />
</on-error>
</policies> | [
-0.016544677317142487,
-0.01012988667935133,
0.010317068547010422,
-0.04216177016496658,
0.04122984781861305,
0.04902946576476097,
0.013129395432770252,
0.007474166806787252,
-0.051501475274562836,
-0.050421953201293945,
-0.024835843592882156,
-0.012883313931524754,
-0.042054321616888046,
... | {
"azure_component": "network",
"chunk_index": 395,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "255",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
Pour tester l'API, obtenez une clé de la souscription puis faites une requête à la
passerelle de Gestion des API.
Vous avez besoin d’une clé d’abonnement pour permettre à votre instance Gestion des
API de tester l’API importée et les stratégies appliquées.
1. Dans le volet de l’Explorateur, cliquez avec le bouton droit sur le nom de votre
instance Gestion des API.
2. Sélectionnez Copier la clé d’abonnement. Cette clé concerne l'abonnement à
accès illimité intégré créé lorsque vous créez une instance de Gestion des API.
1. Dans le volet de l’Explorateur, développez le nœud Opérations sous l’API petstore
que vous avez importée.
Tester l’API
Obtenir la clé d’abonnement
U Attention
La souscription à accès illimité permet d'accéder à chaque API de cette
instance de Gestion des API et ne doit être utilisé que par les utilisateurs
autorisés. Ne l'utilisez jamais pour un accès de routine à l'API et n'intégrez
jamais la clé d'accès complet dans les applications clientes.
Tester une opération d’API | [
0.011408189311623573,
-0.0042176865972578526,
-0.00376480002887547,
-0.01766960695385933,
0.028077030554413795,
0.007983129471540451,
0.02275664545595646,
0.03911099582910538,
-0.05974053964018822,
-0.029576003551483154,
-0.026392832398414612,
-0.0248869676142931,
-0.0776967853307724,
0.00... | {
"azure_component": "network",
"chunk_index": 396,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "256",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
2. Sélectionnez une opération comme [GET] Find pet by ID (Trouver un animal de
compagnie par ID), puis cliquez avec le bouton droit sur l’opération et sélectionnez
Opération de test.
3. Dans la fenêtre de l’éditeur, remplacez 5 pour le paramètre petId dans l’URL de
requête.
4. Dans la fenêtre de l’éditeur, en regard d’Ocp-Apim-Subscription-Key, copiez la clé
d’abonnement que vous avez copiée.
5. Sélectionnez Envoyer une demande.
Quand la demande réussit, le back-end répond avec 200 OK et des données. | [
-0.03832496702671051,
-0.029253782704472542,
-0.014160334132611752,
-0.0031828354112803936,
0.07718244940042496,
0.04006187245249748,
0.02170158363878727,
0.023752303794026375,
-0.026322055608034134,
-0.05034082382917404,
-0.01736481674015522,
0.021717755123972893,
-0.043597206473350525,
-... | {
"azure_component": "network",
"chunk_index": 397,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "257",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
Notez le détail suivant dans la réponse :
L’en-tête Custom est ajouté à la réponse.
Testez maintenant la stratégie de limitation de débit. Sélectionnez Envoyer une requête
plusieurs fois dans une ligne. Après l’envoi d’un nombre trop important de requêtes
dans la période configurée, vous obtenez la réponse 429 Too Many Requests .
Vous pouvez éventuellement obtenir des informations détaillées sur le suivi des
requêtes pour vous aider à déboguer et dépanner l'API.
Traitement des requêtes de trace | [
0.00019889225950464606,
-0.07122883945703506,
0.0013812249526381493,
0.015549895353615284,
0.06072921305894852,
0.06923890113830566,
0.011374489404261112,
0.018920786678791046,
-0.04114395007491112,
-0.06325121968984604,
-0.015341036021709442,
-0.014287128113210201,
-0.04380512237548828,
0... | {
"azure_component": "network",
"chunk_index": 398,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "258",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
Pour connaître les étapes permettant d’activer le suivi pour une API, consultez Activer le
suivi pour une API. Pour limiter la divulgation involontaire d’informations sensibles, le
traçage n’est autorisé que pendant 1 heure par défaut.
Quand vous n’en avez plus besoin, enlevez l’instance Gestion des API en cliquant avec le
bouton droit et en sélectionnant Ouvrir dans le portail pour supprimer le service
Gestion des API et son groupe de ressources.
Vous pouvez également sélectionner Supprimer Gestion des API pour supprimer
uniquement l’instance Gestion des API (cette opération ne supprime pas son groupe de
ressources).
Ce didacticiel a présenté plusieurs fonctionnalités de l'extension Gestion des API pour
Visual Studio Code. Vous pouvez utiliser ces fonctionnalités pour importer et gérer des
API. Vous avez appris à :
L'extension Gestion des API fournit plus de fonctionnalités pour travailler avec vos API.
Vous pouvez par exemple déboguer des stratégies (disponibles dans le niveau de
Nettoyer les ressources
Contenu connexe
Importer une API dans Gestion des API
"
Modifier l’API
"
Appliquer des stratégies Gestion des API
"
Tester l’API
" | [
0.0035893458407372236,
-0.030833154916763306,
-0.013532467186450958,
-0.025885391980409622,
0.008024998009204865,
0.02539300173521042,
0.04167114570736885,
0.03715752810239792,
-0.063123419880867,
-0.0488593615591526,
-0.028573263436555862,
-0.02693026512861252,
-0.08609209209680557,
0.018... | {
"azure_component": "network",
"chunk_index": 399,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "259",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.