text stringlengths 0 3.99k | embedding listlengths 768 768 | metadata dict |
|---|---|---|
Dans les exemples suivants :
Une instance Gestion des API nommée myapim est restaurée à partir de l’objet blob
de sauvegarde nommé ContosoBackup.apimbackup dans le compte de stockage
backupstorageaccount.
L’objet blob de sauvegarde se trouve dans un conteneur nommé sauvegardes.
Définir des variables dans PowerShell :
PowerShell
PowerShell
U Attention
Évitez de modifier la configuration de service (par exemple, API, stratégies, apparence du
portail des développeurs) pendant qu’une opération de restauration est en cours. Les
modifications peuvent être remplacées.
PowerShell
$apiManagementName="myapim";
$apiManagementResourceGroup="apimresourcegroup";
$storageAccountName="backupstorageaccount";
$storageResourceGroup="storageresourcegroup";
$containerName="backups";
$blobName="ContosoBackup.apimbackup"
Accès à l’aide de la clé d’accès de stockage
$storageKey = (Get-AzStorageAccountKey -ResourceGroupName
$storageResourceGroup -StorageAccountName $storageAccountName)[0].Value
$storageContext = New-AzStorageContext -StorageAccountName $storageAccountName
-StorageAccountKey $storageKey
Restore-AzApiManagement -ResourceGroupName $apiManagementResourceGroup -Name
$apiManagementName `
-StorageContext $storageContext -SourceContainerName $containerName -
SourceBlobName $blobName
Accès à l’aide de l’identité managée | [
-0.04701116681098938,
-0.021905578672885895,
0.00721666170284152,
-0.0032810054253786802,
0.06458184123039246,
0.04092135280370712,
-0.002615127479657531,
0.04805027320981026,
-0.06430036574602127,
-0.049738723784685135,
-0.03494523465633392,
-0.01662888564169407,
-0.04214153066277504,
0.0... | {
"azure_component": "network",
"chunk_index": 700,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "490",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
Pour configurer une identité managée dans votre instance de Gestion des API afin
d’accéder au compte de stockage, consultez Configurer une identité managée, plus haut
dans cet article.
PowerShell
Dans cet exemple, une identité managée affectée par l’utilisateur nommée myidentity se
trouve dans le groupe de ressources identityresourcegroup.
PowerShell
La restauration d’une sauvegarde n’est garantie que pendant 30 jours à partir du
moment de sa création.
Pendant la sauvegarde, évitez toutes les modifications de gestion dans le service,
comme augmenter ou baisser un niveau tarifaire, changer un nom de domaine, etc.
Accès à l’aide d’une identité managée affectée par le système
$storageContext = New-AzStorageContext -StorageAccountName $storageAccountName
Restore-AzApiManagement -ResourceGroupName $apiManagementResourceGroup -Name
$apiManagementName `
-StorageContext $storageContext -SourceContainerName $containerName `
-SourceBlobName $blobName -AccessType "SystemAssignedManagedIdentity"
Accès à l’aide d’une identité managée affectée par l’utilisateur
$identityName = "myidentity";
$identityResourceGroup = "identityresourcegroup";
$identityId = (Get-AzUserAssignedIdentity -Name $identityName -
ResourceGroupName $identityResourceGroup).ClientId
$storageContext = New-AzStorageContext -StorageAccountName $storageAccountName
Restore-AzApiManagement -ResourceGroupName $apiManagementResourceGroup -Name
$apiManagementName `
-StorageContext $storageContext -SourceContainerName $containerName `
-SourceBlobName $blobName -AccessType "UserAssignedManagedIdentity" ` -
identityClientId $identityid
Contraintes | [
-0.03968381881713867,
0.0019318736158311367,
-0.023135462775826454,
-0.008781406097114086,
0.06674627959728241,
0.01350388117134571,
0.028265919536352158,
0.03288882598280907,
-0.030816368758678436,
-0.03556487336754799,
-0.029086707159876823,
-0.018639130517840385,
-0.04444213584065437,
0... | {
"azure_component": "network",
"chunk_index": 701,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "491",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
Les changements de configuration du service (par exemple, les API, les stratégies et
l’apparence du portail des développeurs) pendant une opération de sauvegarde peuvent
être exclus de la sauvegarde et être perdus.
La sauvegarde ne capture pas les données de journaux préagrégées qui sont utilisées
dans les rapports affichés dans la fenêtre Analytics du portail Microsoft Azure.
Le partage des ressources Cross-Origin (CORS) ne doit pas être activé sur le service BLOB
dans le compte de stockage.
Le niveau tarifaire du service à restaurer doit correspondre à celui du service sauvegardé
utilisé pour la restauration.
Si le compte de stockage est pare-feu activé, il est recommandé d’utiliser l’identité managée
affectée par le système de l’instance Gestion des API pour l’accès au compte. Vérifiez que le
compte de stockage accorde l’accès aux services Azure approuvés.
Les données d’utilisation servant à la création des rapports analytiques ne sont pas
incluses dans la sauvegarde. Utilisez l'API REST de Gestion des API Azure pour récupérer
régulièrement les rapports d'analyse et les conserver en toute sécurité.
Certificats TLS/SSL de domaine personnalisé.
Certificats d’autorité de certification personnalisé qui incluent des certificats
intermédiaires ou racines chargés par le client.
Paramètres d’intégration du réseau virtuel.
Configuration d’une identité managée.
Configuration des diagnostics Azure Monitor.
Paramètres des protocoles et des chiffrements .
Contenu du portail des développeurs.
La fréquence à laquelle vous effectuez les sauvegardes du service affecte votre objectif de
point de récupération. Pour la réduire, nous vous conseillons d’implémenter des sauvegardes
régulières et d’effectuer des sauvegardes à la demande quand vous apportez des changements
à votre service Gestion des API.
Consultez les | [
-0.007422569673508406,
-0.024799879640340805,
-0.03501979261636734,
-0.008333185687661171,
0.07261992245912552,
0.017170879989862442,
0.036451321095228195,
0.04467720538377762,
-0.022942552343010902,
-0.06409884989261627,
-0.03217940032482147,
-0.04557916894555092,
-0.08425808697938919,
0.... | {
"azure_component": "network",
"chunk_index": 702,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "492",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
du portail des développeurs.
La fréquence à laquelle vous effectuez les sauvegardes du service affecte votre objectif de
point de récupération. Pour la réduire, nous vous conseillons d’implémenter des sauvegardes
régulières et d’effectuer des sauvegardes à la demande quand vous apportez des changements
à votre service Gestion des API.
Consultez les ressources connexes suivantes pour en savoir plus sur le processus de
sauvegarde/restauration :
Contraintes de mise en réseau du stockage
Éléments non sauvegardés
Contenu connexe | [
-0.020748421549797058,
-0.052828606218099594,
-0.03590890020132065,
-0.00602441793307662,
0.06426259130239487,
0.031347665935754776,
0.025524457916617393,
0.05341828614473343,
-0.0520947240293026,
-0.07162804156541824,
-0.035447344183921814,
0.012925669550895691,
-0.049120381474494934,
0.0... | {
"azure_component": "network",
"chunk_index": 703,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "492",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
Automating API Management Backup and Restore with Logic Apps
(Automatiser la
sauvegarde et la restauration avec Gestion des API avec Logic Apps)
Comment migrer une instance Gestion des API Azure d'une région vers une autre
Le niveau Premium de Gestion des API prend également en charge la redondance de
zone, qui offre résilience et haute disponibilité à une instance de service dans une région
(emplacement) Azure spécifique. | [
-0.02085455134510994,
-0.005394694395363331,
0.0008994147647172213,
0.04379640147089958,
0.08405492454767227,
0.02970479615032673,
0.02950543910264969,
0.019339557737112045,
-0.028144823387265205,
-0.041287463158369064,
-0.03333351016044617,
-0.025422673672437668,
-0.036921314895153046,
0.... | {
"azure_component": "network",
"chunk_index": 704,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "493",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
Contrôles de conformité réglementaire
Azure Policy pour Gestion des API Azure
Article • 18/03/2024
S’APPLIQUE À : Tous les niveaux de Gestion des API
La Conformité réglementaire d’Azure Policy fournit des définitions d’initiatives créées et
gérées par Microsoft, qui sont dites intégrées, pour les domaines de conformité et les
contrôles de sécurité associés à différents standards de conformité. Cette page liste les
domaines de conformité et les contrôles de sécurité pour Gestion des API Azure. Vous
pouvez affecter les composants intégrés pour un contrôle de sécurité individuellement,
afin de rendre vos ressources Azure conformes au standard spécifique.
Le titre de chaque définition de stratégie intégrée est un lien vers la définition de la
stratégie dans le portail Azure. Utilisez le lien de la colonne Version de la stratégie pour
voir la source dans le dépôt GitHub Azure Policy
.
Pour voir le mappage entre les composants intégrés Azure Policy disponibles pour tous
les services Azure et cette norme de conformité, consultez Conformité réglementaire
d’Azure Policy – FedRAMP High. Pour plus d’informations sur cette norme de
conformité, consultez FedRAMP High
.
) Important
Chaque contrôle est associé à une ou plusieurs définitions Azure Policy. Ces
stratégies peuvent vous aider à évaluer la conformité avec le contrôle. Toutefois, il
n’existe pas souvent de correspondance un-à-un ou parfaite entre un contrôle et
une ou plusieurs stratégies. En tant que tel, Conforme dans Azure Policy fait
seulement référence aux stratégies elles-même. Cela ne garantit pas que vous êtes
entièrement conforme à toutes les exigences d’un contrôle. En outre, la norme de
conformité comprend des contrôles qui ne sont traités par aucune définition Azure
Policy pour l’instant. Par conséquent, la conformité dans Azure Policy n’est | [
-0.0005089915357530117,
-0.000973052519839257,
0.003228354500606656,
-0.021618572995066643,
0.049587495625019073,
-0.010121434926986694,
0.058096837252378464,
0.002585058333352208,
-0.02654174715280533,
-0.06971820443868637,
-0.011382493190467358,
-0.0701138898730278,
-0.051912885159254074,
... | {
"azure_component": "network",
"chunk_index": 705,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "494",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
En tant que tel, Conforme dans Azure Policy fait
seulement référence aux stratégies elles-même. Cela ne garantit pas que vous êtes
entièrement conforme à toutes les exigences d’un contrôle. En outre, la norme de
conformité comprend des contrôles qui ne sont traités par aucune définition Azure
Policy pour l’instant. Par conséquent, la conformité dans Azure Policy n’est qu’une
vue partielle de l’état de conformité global. Les associations entre les contrôles et
les définitions de conformité réglementaire Azure Policy pour ces normes de
conformité peuvent changer au fil du temps.
FedRAMP Niveau élevé | [
0.0013396318536251783,
-0.016882697120308876,
-0.01101185567677021,
-0.004269273020327091,
0.052763160318136215,
-0.010097887367010117,
0.040105920284986496,
0.018856478855013847,
-0.008213368244469166,
-0.041068628430366516,
-0.02031601592898369,
-0.045868776738643646,
-0.05471545085310936,... | {
"azure_component": "network",
"chunk_index": 706,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "494",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
Domain
ID du
contrôle
Titre du contrôle
Policy
Version de
la stratégie
Contrôle d’accès
AC-4
Application du flux
d’informations
Les services Gestion
des API doivent
utiliser un réseau
virtuel
1.0.2
Protection du système
et des communications
SC-7
Protection de la
limite
Les services Gestion
des API doivent
utiliser un réseau
virtuel
1.0.2
Protection du système
et des communications
SC-7 (3)
Points d’accès
Les services Gestion
des API doivent
utiliser un réseau
virtuel
1.0.2
Pour voir le mappage entre les composants intégrés Azure Policy disponibles pour tous
les services Azure et cette norme de conformité, consultez Conformité réglementaire
d’Azure Policy – FedRAMP Moderate. Pour plus d’informations sur cette norme de
conformité, consultez FedRAMP Moderate
.
Domain
ID du
contrôle
Titre du contrôle
Policy
Version de
la stratégie
Contrôle d’accès
AC-4
Application du flux
d’informations
Les services Gestion
des API doivent
utiliser un réseau
virtuel
1.0.2
Protection du système
et des communications
SC-7
Protection de la
limite
Les services Gestion
des API doivent
utiliser un réseau
virtuel
1.0.2
Protection du système
et des communications
SC-7 (3)
Points d’accès
Les services Gestion
des API doivent
1.0.2
ノ
Agrandir le tableau
(Portail Azure)
(GitHub)
FedRAMP Niveau modéré
ノ
Agrandir le tableau
(Portail Azure)
(GitHub) | [
-0.027261966839432716,
-0.009181290864944458,
0.020796068012714386,
0.005703606177121401,
0.03205114230513573,
-0.00303595676086843,
0.06243879348039627,
-0.0020373419392853975,
-0.03424878045916557,
-0.06311172991991043,
-0.0029496534261852503,
-0.04909327253699303,
-0.056390807032585144,
... | {
"azure_component": "network",
"chunk_index": 707,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "495",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
Domain
ID du
contrôle
Titre du contrôle
Policy
Version de
la stratégie
utiliser un réseau
virtuel
Le point de référence de sécurité du cloud Microsoft fournit des recommandations sur
la façon dont vous pouvez sécuriser vos solutions cloud sur Azure. Pour voir comment
ce service correspond totalement au point de référence de sécurité du cloud Microsoft,
consultez les fichiers de correspondance Azure Security Benchmark
.
Pour voir comment les composants intégrés Azure Policy disponibles pour tous les
services Azure correspondent à cette norme de conformité, consultez l’article
Conformité réglementaire Azure Policy – Point de référence de sécurité du cloud
Microsoft.
Domain
ID du
contrôle
Titre du contrôle
Policy
Version
de la
stratégie
Sécurité réseau
NS-2
Sécuriser les services
cloud avec des
contrôles réseau
Les services Gestion des API
doivent utiliser un réseau
virtuel
1.0.2
Sécurité réseau
NS-2
Sécuriser les services
cloud avec des
contrôles réseau
Gestion des API doit
désactiver l’accès réseau
public aux points de
terminaison de
configuration de service
1.0.1
Gestion des
identités
IM-4
Authentifier le
serveur et les
services
Les points de terminaison
d’API dans Gestion des API
Azure doivent être
authentifiés
1.0.1
Gestion des
identités
IM-4
Authentifier le
serveur et les
services
Les appels de Gestion des
API aux back-ends d’API
doivent être authentifiés
1.0.1
Gestion des
identités
IM-4
Authentifier le
serveur et les
Les appels de Gestion des
API aux back-ends d’API ne
1.0.2
(Portail Azure)
(GitHub)
Benchmark de sécurité cloud Microsoft
ノ
Agrandir le tableau
(Portail Azure)
(GitHub) | [
-0.034438278526067734,
-0.0014365862589329481,
0.002396835945546627,
0.0105265649035573,
0.04749568551778793,
0.03685088828206062,
0.06416210532188416,
-0.010062748566269875,
-0.025420784950256348,
-0.057693757116794586,
-0.005721142515540123,
-0.0529780350625515,
-0.03935583680868149,
0.0... | {
"azure_component": "network",
"chunk_index": 708,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "496",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
Domain
ID du
contrôle
Titre du contrôle
Policy
Version
de la
stratégie
services
doivent pas contourner
l’empreinte numérique du
certificat ou la validation du
nom
Gestion des
identités
IM-8
Restreindre
l’exposition des
informations
d’identification et
des secrets
La version minimale de
Gestion des API doit être
définie le 01/12/2019 ou une
version ultérieure.
1.0.1
Gestion des
identités
IM-8
Restreindre
l’exposition des
informations
d’identification et
des secrets
Les valeurs nommées des
secrets de Gestion des API
doivent être stockées dans
Azure Key Vault
1.0.2
Accès privilégié
PA-7
Suivre le principe
Just Enough
Administration
(privilège minimum)
Les abonnements à Gestion
des API ne doivent pas être
étendus à toutes les API
1.1.0
Protection des
données
DP-3
Chiffrer les données
sensibles en transit
Les API Gestion des API
doivent utiliser uniquement
des protocoles chiffrés
2.0.2
Protection des
données
DP-6
Utiliser un processus
de gestion de clés
sécurisé
Les valeurs nommées des
secrets de Gestion des API
doivent être stockées dans
Azure Key Vault
1.0.2
Gestion des
actifs
AM-2
Utiliser uniquement
des services
approuvés
La version de la plateforme
Gestion des API Azure doit
être stv2
1.0.0
Gestion des
actifs
AM-3
Garantir la sécurité
de la gestion du
cycle de vie des actifs
Les points de terminaison
d’API inutilisés doivent être
désactivés et supprimés du
service Gestion des API
Azure
1.0.1
Gestion de la
posture et | [
-0.04907327890396118,
0.01724744588136673,
-0.020806439220905304,
0.008833163417875767,
0.04596789926290512,
0.015395977534353733,
0.06692676246166229,
-0.0019487644312903285,
-0.026387251913547516,
-0.033062517642974854,
0.000722586817573756,
-0.05369415134191513,
-0.038630396127700806,
0... | {
"azure_component": "network",
"chunk_index": 709,
"contains_sku": true,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "497",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
des API Azure doit
être stv2
1.0.0
Gestion des
actifs
AM-3
Garantir la sécurité
de la gestion du
cycle de vie des actifs
Les points de terminaison
d’API inutilisés doivent être
désactivés et supprimés du
service Gestion des API
Azure
1.0.1
Gestion de la
posture et des
vulnérabilités
PV-2
Auditer et appliquer
les configurations
sécurisées
Le point de terminaison
direct de Gestion des API ne
doit pas être activé
1.0.2
(Portail Azure)
(GitHub) | [
0.016213810071349144,
0.010479448363184929,
-0.02086958847939968,
-0.025138678029179573,
0.020667267963290215,
0.005418124608695507,
0.0778157114982605,
0.003813415765762329,
-0.020369186997413635,
-0.059473250061273575,
0.007300776895135641,
-0.05814901366829872,
-0.06086941808462143,
0.0... | {
"azure_component": "network",
"chunk_index": 710,
"contains_sku": true,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "497",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
Domain
ID du
contrôle
Titre du contrôle
Policy
Version
de la
stratégie
Gestion de la
posture et des
vulnérabilités
PV-2
Auditer et appliquer
les configurations
sécurisées
La version minimale de
Gestion des API doit être
définie le 01/12/2019 ou une
version ultérieure.
1.0.1
Gestion de la
posture et des
vulnérabilités
PV-2
Auditer et appliquer
les configurations
sécurisées
La version de la plateforme
Gestion des API Azure doit
être stv2
1.0.0
Pour voir comment les composants intégrés Azure Policy disponibles pour tous les
services Azure correspondent à ce standard de conformité, consultez Conformité
réglementaire Azure Policy – NIST SP 800-171 R2. Pour plus d’informations sur cette
norme de conformité, consultez NIST SP 800-171 R2
.
Domain
ID du
contrôle
Titre du contrôle
Policy
Version
de la
stratégie
Contrôle d’accès
3.1.3
Contrôler le flux de CUI
conformément aux autorisations
approuvées.
Les services
Gestion des
API doivent
utiliser un
réseau virtuel
1.0.2
Protection du
système et des
communications
3.13.1
Superviser, contrôler et protéger
les communications (c’est-à-dire
les informations transmises ou
reçues par les systèmes de
l’organisation) aux limites externes
et aux limites internes clés des
systèmes de l’organisation.
Les services
Gestion des
API doivent
utiliser un
réseau virtuel
1.0.2
Protection du
système et des
communications
3.13.2
Utiliser les conceptions
architecturales, les techniques de
développement de logiciels et les
principes | [
-0.010882481932640076,
-0.0013027965323999524,
-0.03600843623280525,
-0.007553021423518658,
0.037036873400211334,
0.002774713560938835,
0.048090334981679916,
-0.018875908106565475,
-0.023935673758387566,
-0.05400629714131355,
-0.0010942785302177072,
-0.03448314219713211,
-0.05034830421209335... | {
"azure_component": "network",
"chunk_index": 711,
"contains_sku": true,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "498",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
aux limites externes
et aux limites internes clés des
systèmes de l’organisation.
Les services
Gestion des
API doivent
utiliser un
réseau virtuel
1.0.2
Protection du
système et des
communications
3.13.2
Utiliser les conceptions
architecturales, les techniques de
développement de logiciels et les
principes d’ingénierie des
systèmes qui favorisent la sécurité
Les services
Gestion des
API doivent
utiliser un
réseau virtuel
1.0.2
(Portail Azure)
(GitHub)
NIST SP 800-171 R2
ノ
Agrandir le tableau
(Portail Azure)
(GitHub) | [
-0.010993092320859432,
0.005767274182289839,
0.012322247959673405,
0.013345238752663136,
0.05215619504451752,
0.018025778234004974,
0.04454338550567627,
0.00649936031550169,
-0.07156314700841904,
-0.058144304901361465,
-0.012821615673601627,
-0.05016690120100975,
-0.06468014419078827,
0.02... | {
"azure_component": "network",
"chunk_index": 712,
"contains_sku": true,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "498",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
Domain
ID du
contrôle
Titre du contrôle
Policy
Version
de la
stratégie
des informations au sein des
systèmes d’entreprise.
Protection du
système et des
communications
3.13.5
Implémenter des sous-réseaux
pour les composants système
accessibles publiquement qui sont
physiquement ou logiquement
séparés des réseaux internes.
Les services
Gestion des
API doivent
utiliser un
réseau virtuel
1.0.2
Pour voir comment les composants intégrés Azure Policy disponibles pour tous les
services Azure correspondent à cette norme de conformité, consultez Conformité
réglementaire Azure Policy – NIST SP 800-53 Rév. 4. Pour plus d’informations sur cette
norme de conformité, consultez NIST SP 800-53 Rév. 4
.
Domain
ID du
contrôle
Titre du contrôle
Policy
Version de
la stratégie
Contrôle d’accès
AC-4
Application du flux
d’informations
Les services Gestion
des API doivent
utiliser un réseau
virtuel
1.0.2
Protection du système
et des communications
SC-7
Protection de la
limite
Les services Gestion
des API doivent
utiliser un réseau
virtuel
1.0.2
Protection du système
et des communications
SC-7 (3)
Points d’accès
Les services Gestion
des API doivent
utiliser un réseau
virtuel
1.0.2
Pour voir le mappage entre les composants intégrés Azure Policy disponibles pour tous
les services Azure et cette norme de conformité, consultez Conformité réglementaire
(Portail Azure)
(GitHub)
NIST SP 800-53 Rev. 4
ノ
Agrandir le tableau
(Portail Azure)
(GitHub)
NIST SP 800-53 Rev. 5 | [
-0.018337348476052284,
-0.0025323224253952503,
-0.023093508556485176,
0.010370595380663872,
0.05388282611966133,
0.0020261744502931833,
0.06285352259874344,
-0.01728568598628044,
-0.020877981558442116,
-0.07461274415254593,
-0.013734294101595879,
-0.0619090236723423,
-0.05839032307267189,
... | {
"azure_component": "network",
"chunk_index": 713,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "499",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
d’Azure Policy – NIST SP 800-53 Rev. 5. Pour plus d’informations sur cette norme de
conformité, consultez NIST SP 800-53 Rev. 5
.
Domain
ID du
contrôle
Titre du contrôle
Policy
Version de
la stratégie
Contrôle d’accès
AC-4
Application du flux
d’informations
Les services Gestion
des API doivent
utiliser un réseau
virtuel
1.0.2
Protection du système
et des communications
SC-7
Protection de la
limite
Les services Gestion
des API doivent
utiliser un réseau
virtuel
1.0.2
Protection du système
et des communications
SC-7 (3)
Points d’accès
Les services Gestion
des API doivent
utiliser un réseau
virtuel
1.0.2
Pour évaluer comment les composants intégrés Azure Policy disponibles pour tous les
services Azure répondent à cette norme de conformité, consultez Détails de la
conformité réglementaire Azure Policy pour le thème cloud BIO NL. Pour plus
d’informations sur cette norme de conformité, consultez Cybersécurité du
gouvernement de la sécurité des informations de référence - Digital Government
(digitaleoverheid.nl)
.
Domain
ID du
contrôle
Titre du contrôle
Policy
Version de
la
stratégie
U.07.1 Séparation
des données : isolé
U.07.1
L’isolation permanente des
données est une
architecture multi-tenant.
Les correctifs sont réalisés
de manière contrôlée.
Les services
Gestion des API
doivent utiliser
un réseau virtuel
1.0.2
ノ
Agrandir le tableau
(Portail Azure)
(GitHub)
Thème cloud BIO NL
ノ
Agrandir le tableau
(Portail Azure)
(GitHub) | [
0.0059479461051523685,
-0.010551117360591888,
-0.005682959221303463,
-0.002535911975428462,
0.047450121492147446,
0.007527119945734739,
0.05241710692644119,
-0.01768568716943264,
-0.014015745371580124,
-0.061190661042928696,
-0.011071475222706795,
-0.04879374802112579,
-0.06956493854522705,
... | {
"azure_component": "network",
"chunk_index": 714,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "500",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
Pour voir comment les composants intégrés Azure Policy disponibles pour tous les
services Azure répondent à cette norme de conformité, consultez Conformité
réglementaire Azure Policy - RBI ITF Banks v2016. Pour plus d’informations sur cette
norme de conformité, consultez RBI ITF Banks v2016 (PDF)
.
Domain
ID du
contrôle
Titre du contrôle
Policy
Version
de la
stratégie
Gestion des
correctifs/vulnérabilités et
des changements
Gestion des
correctifs/vulnérabilités et
des changements-7.7
Les services
Gestion des
API doivent
utiliser un
réseau virtuel
1.0.2
Pour voir comment les composants intégrés Azure Policy disponibles de tous les services
Azure répondent à cette norme de conformité, consultez Conformité réglementaire
Azure Policy – RMIT Malaysia. Pour plus d’informations sur cette norme de conformité,
consultez RMIT Malaysia
.
Domain
ID du
contrôle
Titre du
contrôle
Policy
Version de la
stratégie
Résilience
réseau
10.33
Résilience
réseau - 10.33
Les services Gestion des API
doivent utiliser un réseau
virtuel
1.0.2
Apprenez-en davantage sur la Conformité réglementaire d’Azure Policy.
Consultez les définitions intégrées dans le dépôt Azure Policy de GitHub
.
Banque de réserve de l’Inde – Infrastructure
informatique pour les banques v2016
ノ
Agrandir le tableau
(Portail Azure)
(GitHub)
RMIT Malaysia
ノ
Agrandir le tableau
(Portail Azure)
(GitHub)
Étapes suivantes | [
0.007954142987728119,
-0.050831105560064316,
0.000339106802130118,
0.015888366848230362,
0.07842649519443512,
0.027160633355379105,
0.03218938037753105,
-0.011549237184226513,
-0.02796718291938305,
-0.039519302546978,
-0.0007710577338002622,
-0.07137420773506165,
-0.061961863189935684,
0.0... | {
"azure_component": "network",
"chunk_index": 715,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "501",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
Base de référence sur la sécurité Azure
pour la Gestion des API
Article • 25/02/2025
Cette base de référence de sécurité applique les conseils du benchmark de sécurité
cloud Microsoft version 1.0 à Gestion des API. Le Benchmark de sécurité Microsoft
Cloud fournit des recommandations sur la façon dont vous pouvez sécuriser vos
solutions cloud sur Azure. Le contenu est regroupé selon les contrôles de sécurité
définis par le benchmark de sécurité cloud Microsoft et les conseils associés applicables
aux Gestion des API.
Vous pouvez superviser cette base de référence de la sécurité et ses recommandations
en utilisant Microsoft Defender pour le cloud. Azure Policy définitions sont répertoriées
dans la section Conformité réglementaire de la page Microsoft Defender pour le portail
cloud.
Lorsqu’une fonctionnalité a des définitions de Azure Policy pertinentes, elles sont
répertoriées dans cette base de référence pour vous aider à mesurer la conformité avec
les contrôles et recommandations du benchmark de sécurité cloud Microsoft. Certaines
recommandations peuvent nécessiter un plan de Microsoft Defender payant pour
activer certains scénarios de sécurité.
Le profil de sécurité résume les comportements à fort impact de Gestion des API, ce qui
peut entraîner des considérations de sécurité accrues.
Attribut de comportement du service
Valeur
Catégorie de produit
Web
7 Notes
Les fonctionnalités non applicables à Gestion des API ont été exclues. Pour voir
comment Gestion des API est entièrement mappé au benchmark de sécurité cloud
Microsoft, consultez le fichier de mappage complet de la base de référence de
sécurité Gestion des API
.
Profil de sécurité
ノ
Agrandir le tableau | [
-0.003943878225982189,
0.012406062334775925,
0.007400622125715017,
0.023834366351366043,
0.05059187114238739,
0.005063776858150959,
0.04500937834382057,
0.03320179507136345,
-0.009931065142154694,
-0.05908195674419403,
-0.019618405029177666,
-0.060614049434661865,
-0.0579298734664917,
0.02... | {
"azure_component": "network",
"chunk_index": 716,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "502",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
Attribut de comportement du service
Valeur
Le client peut accéder à HOST/OS
Aucun accès
Le service peut être déployé dans le réseau virtuel du client
True
Stocke le contenu client au repos
Faux
Pour plus d’informations, consultez le benchmark de sécurité cloud Microsoft : Sécurité
réseau.
Description : Le service prend en charge le déploiement dans le Réseau virtuel privé
(VNet) du client. Plus d’informations
Prise en charge
Activé par défaut
Responsabilité de la configuration
True
Faux
Client
Conseils de configuration : Déployez Azure Gestion des API à l’intérieur d’un Réseau
virtuel Azure (VNET), afin qu’il puisse accéder aux services principaux au sein du réseau.
Le portail des développeurs et la passerelle Gestion des API peuvent être configurés
pour être accessibles à partir d’Internet (externe) ou uniquement au sein du réseau
virtuel (interne).
Externe : la passerelle Gestion des API et le portail des développeurs sont
accessibles à partir de l’Internet public via un équilibreur de charge externe. La
passerelle peut accéder aux ressources au sein du réseau virtuel.
Configuration des Réseau virtuel externes
Interne : la passerelle Gestion des API et le portail des développeurs sont
accessibles uniquement au sein du réseau virtuel via un équilibreur de charge
interne. La passerelle peut accéder aux ressources au sein du réseau virtuel.
Configuration Réseau virtuel interne
Sécurité du réseau
NS-1 : Établir des limites de segmentation réseau
Fonctionnalités
Intégration du réseau virtuel
ノ
Agrandir le tableau | [
-0.0032601424027234316,
-0.047905854880809784,
-0.0013339101569727063,
0.03361023962497711,
0.037543799728155136,
0.044815436005592346,
0.06645351648330688,
0.01330452598631382,
-0.04028281942009926,
-0.04589061811566353,
-0.03976713493466377,
-0.03494253754615784,
-0.04307573661208153,
0.... | {
"azure_component": "network",
"chunk_index": 717,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "503",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
Référence : Utiliser un réseau virtuel avec Azure Gestion des API
Description : Le trafic réseau de service respecte l’attribution de règles groupes de
sécurité réseau sur ses sous-réseaux. Plus d’informations
Prise en charge
Activé par défaut
Responsabilité de la configuration
True
Faux
Client
Conseils de configuration : Déployez des groupes de sécurité réseau (NSG) sur vos
sous-réseaux Gestion des API pour restreindre ou surveiller le trafic par port, protocole,
adresse IP source ou adresse IP de destination. Créez des règles NSG pour restreindre
les ports ouverts de votre service (par exemple, pour empêcher l’accès aux ports de
gestion à partir de réseaux non approuvés). N’oubliez pas que par défaut, les groupes
de sécurité réseau refusent tout le trafic entrant, mais autorisent le trafic provenant du
réseau virtuel et d’équilibreurs de charge Azure.
Attention : Lorsque vous configurez un groupe de sécurité réseau sur le sous-réseau de
gestion des API, certains ports doivent rester ouverts. Si ces ports ne sont pas
disponibles, la gestion des API risque de ne pas fonctionner correctement et d’être
inaccessible.
Remarque : Configurer des règles de groupe de sécurité réseau pour Gestion des API
Référence : Informations de référence sur la configuration de réseau virtuel : Gestion des
API
Description : Fonctionnalité de filtrage IP native du service pour le filtrage du trafic
réseau (à ne pas confondre avec le groupe de sécurité réseau ou Pare-feu Azure). Plus
d’informations
Prise en charge des groupes de sécurité réseau
ノ
Agrandir le tableau
NS-2 : Sécuriser les services cloud avec des contrôles
réseau
Fonctionnalités
Azure Private Link | [
-0.030996933579444885,
-0.029956413432955742,
0.006086835637688637,
0.008182312361896038,
0.03282330557703972,
0.012885971926152706,
0.05699574947357178,
0.02078886702656746,
-0.023449402302503586,
-0.06328557431697845,
-0.026927903294563293,
-0.0351998470723629,
-0.0545646958053112,
0.023... | {
"azure_component": "network",
"chunk_index": 718,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "504",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
Prise en charge
Activé par défaut
Responsabilité de la configuration
True
Faux
Client
Conseils de configuration : Dans les cas où vous ne parvenez pas à déployer Gestion
des API instances dans un réseau virtuel, vous devez à la place déployer un point de
terminaison privé pour établir un point d’accès privé pour ces ressources.
Remarque : Pour activer les points de terminaison privés, le Gestion des API instance ne
peut pas déjà être configuré avec un réseau virtuel externe ou interne. Une connexion
de point de terminaison privé prend en charge uniquement le trafic entrant vers
l’instance Gestion des API.
Référence : Se connecter en privé à Gestion des API à l’aide d’un point de terminaison
privé
Description : le service prend en charge la désactivation de l’accès au réseau public à
l’aide d’une règle de filtrage de liste de contrôle d’accès IP au niveau du service (pas de
groupe de sécurité réseau ou de Pare-feu Azure) ou à l’aide d’un commutateur bascule «
Désactiver l’accès réseau public ». Plus d’informations
Prise en charge
Activé par défaut
Responsabilité de la configuration
True
Faux
Client
Conseils de configuration : Désactivez l’accès au réseau public à l’aide de la règle de
filtrage ACL IP sur les groupes de sécurité réseau affectés aux sous-réseaux du service
ou un commutateur bascule pour l’accès au réseau public.
Remarque : Gestion des API prend en charge les déploiements dans un réseau virtuel,
ainsi que le verrouillage des déploiements non basés sur le réseau avec un point de
terminaison privé et la désactivation de l’accès au réseau public.
Référence : Désactiver l’accès réseau public
Azure Policy définitions intégrées - Microsoft.ApiManagement :
ノ
Agrandir le tableau
Désactiver l’accès public au réseau
ノ
Agrandir le | [
-0.014166216365993023,
-0.05778547748923302,
-0.020728813484311104,
0.0011944660218432546,
0.022840555757284164,
-0.0019882405176758766,
0.04063808172941208,
0.005968195386230946,
0.0021618108730763197,
-0.042744338512420654,
-0.04966994374990463,
-0.04505990073084831,
-0.05657793581485748,
... | {
"azure_component": "network",
"chunk_index": 719,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "505",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
réseau virtuel,
ainsi que le verrouillage des déploiements non basés sur le réseau avec un point de
terminaison privé et la désactivation de l’accès au réseau public.
Référence : Désactiver l’accès réseau public
Azure Policy définitions intégrées - Microsoft.ApiManagement :
ノ
Agrandir le tableau
Désactiver l’accès public au réseau
ノ
Agrandir le tableau
Surveillance de Microsoft Defender pour le cloud | [
0.003065314842388034,
-0.019447898492217064,
0.017688071355223656,
-0.013421927578747272,
0.03697917237877846,
0.014470133930444717,
0.03441137075424194,
0.020497096702456474,
-0.032102834433317184,
-0.03527330979704857,
-0.01304683182388544,
-0.0403873547911644,
-0.05955376848578453,
0.04... | {
"azure_component": "network",
"chunk_index": 720,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "505",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
Nom
Description
Effet(s)
Version
Les services
Gestion des
API doivent
utiliser un
réseau
virtuel
Le déploiement d’un réseau virtuel Azure offre une
sécurité renforcée et une isolation, et vous permet de
placer votre service Gestion des API dans un réseau
routable non-Internet auquel vous contrôlez l’accès. Ces
réseaux peuvent ensuite être connectés à vos réseaux
locaux à l’aide de différentes technologies VPN, ce qui
permet d’accéder à vos services back-end au sein du
réseau et/ou localement. Le portail des développeurs et la
passerelle API peuvent être configurés pour être
accessibles depuis Internet ou uniquement au sein du
réseau virtuel.
Audit,
Refuser,
Désactivé
1.0.2
Pour protéger les API Web/HTTP critiques, configurez Gestion des API au sein d’un
Réseau virtuel (VNET) en mode interne et configurez un Azure Application Gateway.
Application Gateway est un service PaaS. Il agit comme un proxy inverse et fournit un
équilibrage de charge L7, un routage, un pare-feu d’applications web et d’autres
services. Plus d’informations
Combiner la gestion des API configurée dans un réseau virtuel interne avec le frontal
Application Gateway permet les scénarios suivants :
Utilisez une même ressource de gestion des API pour exposer toutes les API à
l’ensemble des utilisateurs internes et externes.
Utilisez une même ressource de gestion des API pour exposer un sous-réseau
d’API aux utilisateurs externes.
Fournissez un moyen d’activer et de désactiver l’accès à la Gestion des API à partir
de l’Internet public.
Pour plus d’informations, consultez le benchmark de sécurité cloud Microsoft : Gestion des
identités.
ノ
Agrandir le tableau
(Portail Azure)
(GitHub)
NS-6 : Déployer le pare-feu d’applications web
Autres conseils pour | [
-0.014992564916610718,
-0.01626267097890377,
0.014234487898647785,
0.0023974645882844925,
0.01389418076723814,
0.05191902816295624,
0.05220308527350426,
0.011594146490097046,
-0.05747135356068611,
-0.05797087028622627,
-0.028331875801086426,
-0.025233903899788857,
-0.043933991342782974,
0.... | {
"azure_component": "network",
"chunk_index": 721,
"contains_sku": true,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "506",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
un moyen d’activer et de désactiver l’accès à la Gestion des API à partir
de l’Internet public.
Pour plus d’informations, consultez le benchmark de sécurité cloud Microsoft : Gestion des
identités.
ノ
Agrandir le tableau
(Portail Azure)
(GitHub)
NS-6 : Déployer le pare-feu d’applications web
Autres conseils pour NS-6
Gestion des identités | [
-0.024441087618470192,
-0.0021102263126522303,
0.0023579306434839964,
0.008288240991532803,
0.022340718656778336,
-0.0032094339840114117,
0.033115845173597336,
0.01933051086962223,
-0.05432039126753807,
-0.023911062628030777,
-0.011846261098980904,
-0.06232244148850441,
-0.04505924507975578,... | {
"azure_component": "network",
"chunk_index": 722,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "506",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
Description : Le service prend en charge l’utilisation de l’authentification Azure AD pour
l’accès au plan de données. Plus d’informations
Prise en charge
Activé par défaut
Responsabilité de la configuration
True
Faux
Client
Conseils de configuration : Utilisez Azure Active Directory (Azure AD) comme méthode
d’authentification par défaut pour Gestion des API dans la mesure du possible.
Configurez le portail des développeurs Gestion des API Azure pour authentifier les
comptes de développeurs à l’aide d’Azure AD.
Configurez votre instance Gestion des API Azure pour protéger vos API à l’aide du
protocole OAuth 2.0 et d’Azure AD.
Référence : Protéger une API dans Azure Gestion des API à l’aide de l’autorisation OAuth
2.0 avec Azure Active Directory
Description : méthodes d’authentification locale prises en charge pour l’accès au plan
de données, telles qu’un nom d’utilisateur et un mot de passe locaux. Plus
d’informations
Prise en charge
Activé par défaut
Responsabilité de la configuration
True
Faux
Client
Remarques de fonctionnalité : Évitez l’utilisation de méthodes ou de comptes
d’authentification locaux. Ceux-ci doivent être désactivés dans la mesure du possible.
IM-1 : utiliser le système centralisé d’identité et
d’authentification
Fonctionnalités
Azure AD Authentication requis pour l’accès au plan de données
ノ
Agrandir le tableau
Méthodes d’authentification locales pour l’accès au plan de
données
ノ
Agrandir le tableau | [
-0.0011767195537686348,
-0.01769261434674263,
-0.02873670868575573,
0.011371922679245472,
0.05153125524520874,
0.01799633726477623,
0.033084675669670105,
0.014380701817572117,
0.026640163734555244,
-0.036345794796943665,
-0.0013064894592389464,
-0.05276591703295708,
-0.0391620397567749,
-0... | {
"azure_component": "network",
"chunk_index": 723,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "507",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
Utilisez plutôt Azure AD pour vous authentifier si possible.
Conseils de configuration : Limitez l’utilisation de méthodes d’authentification locales
pour l’accès au plan de données, maintenez l’inventaire des comptes d’utilisateur
Gestion des API et rapprochez l’accès si nécessaire. Dans la Gestion des API, les
développeurs sont les utilisateurs des API que vous exposez via la Gestion des API. Par
défaut, les comptes de développeurs nouvellement créés sont actifs, et sont associés au
groupe Développeurs. Les comptes de développeurs dont l’état est Actif peuvent être
utilisés pour accéder à toutes les API auxquelles ils sont abonnés.
En outre, les abonnements Azure Gestion des API sont un moyen de sécuriser l’accès
aux API et sont fournis avec une paire de clés d’abonnement générées qui prennent en
charge la rotation.
Au lieu d’utiliser d’autres méthodes d’authentification, dans la mesure du possible,
utilisez Azure Active Directory (Azure AD) comme méthode d’authentification par défaut
pour contrôler votre accès au plan de données.
Référence : s’authentifier avec De base
Description : les actions de plan de données prennent en charge l’authentification à
l’aide d’identités managées. Plus d’informations
Prise en charge
Activé par défaut
Responsabilité de la configuration
True
Faux
Client
Conseils de configuration : Utilisez une identité de service managée générée par Azure
Active Directory (Azure AD) pour permettre à votre Gestion des API instance d’accéder
facilement et en toute sécurité à d’autres ressources protégées par Azure AD, telles
qu’Azure Key Vault au lieu d’utiliser des principaux de service. La plateforme assure
entièrement la gestion, la rotation et la protection des informations d’identification
IM-3 : gérer les identités d’application de façon sécurisée
et | [
0.010343754664063454,
0.01059525553137064,
-0.033511918038129807,
-0.006420718971639872,
0.046704474836587906,
0.029501505196094513,
0.04894144833087921,
0.021178916096687317,
-0.0009015976684167981,
-0.04438052698969841,
-0.018298782408237457,
-0.05910053104162216,
-0.05311236158013344,
-... | {
"azure_component": "network",
"chunk_index": 724,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "508",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
AD) pour permettre à votre Gestion des API instance d’accéder
facilement et en toute sécurité à d’autres ressources protégées par Azure AD, telles
qu’Azure Key Vault au lieu d’utiliser des principaux de service. La plateforme assure
entièrement la gestion, la rotation et la protection des informations d’identification
IM-3 : gérer les identités d’application de façon sécurisée
et automatique
Fonctionnalités
Identités managées
ノ
Agrandir le tableau | [
-0.031891658902168274,
0.025774136185646057,
-0.002758902730420232,
0.021035926416516304,
0.042511530220508575,
-0.002079895231872797,
0.054924387484788895,
-0.010447774082422256,
-0.039890822023153305,
-0.030859366059303284,
-0.009791430085897446,
-0.0486641600728035,
-0.04721459373831749,
... | {
"azure_component": "network",
"chunk_index": 725,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "508",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
d’identité managée, ce qui évite les informations d’identification codées en dur dans le
code source ou les fichiers de configuration.
Référence : S’authentifier avec une identité managée
Description : Le plan de données prend en charge l’authentification à l’aide de
principaux de service. Plus d’informations
Prise en charge
Activé par défaut
Responsabilité de la configuration
True
Faux
Client
Conseils de configuration : Il n’existe aucune aide Microsoft actuelle pour cette
configuration de fonctionnalité. Vérifiez et déterminez si votre organization souhaite
configurer cette fonctionnalité de sécurité.
Azure Gestion des API peut être configuré pour tirer parti d’Azure Active Directory
(Azure AD) en tant que fournisseur d’identité pour l’authentification des utilisateurs sur
le portail des développeurs afin de tirer parti des fonctionnalités d’authentification
unique offertes par Azure AD. Une fois ceci configuré, les nouveaux utilisateurs du
portail des développeurs peuvent choisir de suivre le processus d’inscription prêt à
l’emploi en s’authentifiant d’abord par le biais d’Azure AD, puis en terminant le
processus d’inscription sur le portail une fois qu’ils sont authentifiés.
Le processus de connexion ou d’inscription peut également être personnalisé par le
biais de la délégation. La délégation vous permet d’utiliser votre site web existant pour
gérer les connexions/inscriptions des développeurs et l’abonnement aux produits au lieu
de faire appel aux fonctionnalités intégrées du portail des développeurs. Elle permet à
votre site web de conserver les données utilisateur et de valider ces étapes de façon
personnalisée.
Principaux de service
ノ
Agrandir le tableau
IM-5 : utiliser l’authentification unique (SSO) pour l’accès
aux applications
Autres conseils pour IM-5 | [
-0.0025661285035312176,
0.005130763631314039,
-0.051195140928030014,
0.0024945803452283144,
0.06528861075639725,
-0.004581553395837545,
0.04368777200579643,
0.007770082913339138,
0.002292572520673275,
-0.05175047367811203,
-0.025151047855615616,
-0.0516633577644825,
-0.05382804945111275,
0... | {
"azure_component": "network",
"chunk_index": 726,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "509",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
Description : L’accès au plan de données peut être contrôlé à l’aide de stratégies d’accès
conditionnel Azure AD. Plus d’informations
Prise en charge
Activé par défaut
Responsabilité de la configuration
False
Non applicable
Non applicable
Conseils de configuration : cette fonctionnalité n’est pas prise en charge pour sécuriser
ce service.
Description : Le plan de données prend en charge l’utilisation native d’Azure Key Vault
pour le magasin d’informations d’identification et de secrets. Plus d’informations
Prise en charge
Activé par défaut
Responsabilité de la configuration
True
Faux
Client
Conseils de configuration : Configurer l’intégration de Gestion des API à Azure Key
Vault. Vérifiez que les secrets pour Gestion des API (valeurs nommées) sont stockés dans
un coffre de clés Azure pour qu’ils soient accessibles et puissent être mis à jour de
manière sécurisée.
IM-7 : restreindre l’accès aux ressources en fonction des
conditions
Fonctionnalités
Accès conditionnel pour le plan de données
ノ
Agrandir le tableau
IM-8 : restreindre l’exposition des informations
d’identification et des secrets
Fonctionnalités
Prise en charge de l’intégration et du stockage des informations
d’identification et des secrets de service dans Azure Key Vault
ノ
Agrandir le tableau | [
-0.0406222864985466,
0.016475044190883636,
-0.013786626979708672,
0.023747950792312622,
0.08594593405723572,
0.017471978440880775,
0.026353904977440834,
-0.000924890860915184,
0.01122116856276989,
-0.04003172740340233,
-0.030256690457463264,
-0.031247766688466072,
-0.051795803010463715,
-0... | {
"azure_component": "network",
"chunk_index": 727,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "510",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
Référence : Utiliser des valeurs nommées dans les stratégies Azure Gestion des API avec
Key Vault Integration
Azure Policy définitions intégrées - Microsoft.ApiManagement :
Nom
Description
Effet(s)
Version
La version minimale de
Gestion des API doit être
définie le 01/12/2019 ou
une version ultérieure.
Pour empêcher le partage des secrets de
service avec des utilisateurs en lecture
seule, la version d’API minimale doit être
définie sur 01/12/2019 ou une version
ultérieure.
Audit,
Refuser,
Désactivé
1.0.1
Pour plus d’informations, consultez le benchmark de sécurité cloud Microsoft : Accès
privilégié.
Description : Le service a le concept d’un compte d’administration local. Plus
d’informations
Pris en charge
Activé par défaut
Responsabilité de la configuration
True
Faux
Client
Remarques de fonctionnalité : Évitez l’utilisation de méthodes ou de comptes
d’authentification locaux. Ceux-ci doivent être désactivés dans la mesure du possible.
Surveillance de Microsoft Defender pour le cloud
ノ
Agrandir le tableau
(Portail Azure)
(GitHub)
Accès privilégié
PA-1 : Séparer et limiter les utilisateurs hautement
privilégiés/administratifs
Fonctionnalités
Comptes Administration locaux
ノ
Agrandir le tableau | [
-0.04066061973571777,
0.007433702237904072,
-0.002563216257840395,
-0.008518221788108349,
0.034203846007585526,
0.03155142813920975,
0.049522750079631805,
0.03348136693239212,
-0.04786301404237747,
-0.03515494987368584,
0.0017003401881083846,
-0.05762399733066559,
-0.05053437501192093,
0.0... | {
"azure_component": "network",
"chunk_index": 728,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "511",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
Utilisez plutôt Azure AD pour vous authentifier si possible.
Conseils de configuration : S’il n’est pas nécessaire pour les opérations d’administration
de routine, désactivez ou limitez les comptes d’administrateur local uniquement pour
une utilisation d’urgence.
Remarque : Gestion des API permet la création d’un compte d’utilisateur local. Au lieu
de créer ces comptes locaux, activez l’authentification Azure Active Directory (Azure AD)
uniquement et attribuez des autorisations à ces comptes Azure AD.
Référence : Comment gérer les comptes d’utilisateur dans Azure Gestion des API
Description : Azure Role-Based Access Control (Azure RBAC) peut être utilisé pour gérer
l’accès aux actions de plan de données du service. Plus d’informations
Pris en charge
Activé par défaut
Responsabilité de la configuration
True
Faux
Client
Conseils de configuration : Utilisez le contrôle d’accès en fonction du rôle Azure (RBAC
Azure) pour contrôler l’accès à Azure Gestion des API. Gestion des API Azure utilise le
contrôle d’accès en fonction du rôle Azure pour gérer de façon précise l’accès aux
services et aux entités Gestion des API (par exemple les API et les stratégies).
Référence : Comment utiliser Role-Based Access Control dans Azure Gestion des API
Azure Policy définitions intégrées - Microsoft.ApiManagement :
PA-7 : Suivre le principe JEA, Just Enough Administration
(privilège minimum)
Fonctionnalités
RBAC Azure pour le plan de données
ノ
Agrandir le tableau
Surveillance de Microsoft Defender pour le cloud
ノ
Agrandir le tableau | [
-0.0009556571021676064,
0.01770109497010708,
-0.01193912047892809,
-0.005008170381188393,
0.05650429055094719,
0.036766450852155685,
0.03696340695023537,
0.035799477249383926,
0.0049508376978337765,
-0.027350962162017822,
-0.030926445499062538,
-0.05912737920880318,
-0.05119331553578377,
0... | {
"azure_component": "network",
"chunk_index": 729,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "512",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
Nom
Description
Effet(s)
Version
Les abonnements à
Gestion des API ne
doivent pas être étendus
à toutes les API
Les abonnements à Gestion des API doivent
être étendus à un produit ou à une API
individuelle au lieu de toutes les API, ce qui
peut entraîner une exposition excessive des
données.
Audit,
Désactivé,
Refus
1.1.0
Description : Customer Lockbox peut être utilisé pour l’accès au support Microsoft. Plus
d’informations
Pris en charge
Activé par défaut
Responsabilité de la configuration
True
Faux
Partagé
Conseils de configuration : Dans les scénarios de support où Microsoft doit accéder à
vos données, utilisez Customer Lockbox pour passer en revue, puis approuver ou rejeter
chacune des demandes d’accès aux données de Microsoft.
Pour plus d’informations, consultez le benchmark de sécurité cloud Microsoft : Protection
des données.
(Portail Azure)
(GitHub)
PA-8 : Déterminer le processus d’accès pour la prise en
charge du fournisseur de services cloud
Fonctionnalités
Customer Lockbox
ノ
Agrandir le tableau
Protection des données
DP-1 : Découvrir, classer et étiqueter des données
sensibles
Fonctionnalités
Découverte et classification des données sensibles | [
-0.010675447061657906,
-0.01939883455634117,
-0.017195062711834908,
0.019890308380126953,
0.030914928764104843,
0.03867112845182419,
0.008835663087666035,
0.0279266107827425,
-0.04448096826672554,
-0.020708931609988213,
-0.02840553969144821,
-0.06230538338422775,
-0.0840570479631424,
0.013... | {
"azure_component": "network",
"chunk_index": 730,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "513",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
Description : Les outils (tels qu’Azure Purview ou Azure Information Protection) peuvent
être utilisés pour la découverte et la classification des données dans le service. Plus
d’informations
Pris en charge
Activé par défaut
Responsabilité de la configuration
False
Non applicable
Non applicable
Conseils de configuration : cette fonctionnalité n’est pas prise en charge pour sécuriser
ce service.
Description : Le service prend en charge la solution DLP pour surveiller le déplacement
des données sensibles (dans le contenu du client). Plus d’informations
Pris en charge
Activé par défaut
Responsabilité de la configuration
False
Non applicable
Non applicable
Conseils de configuration : cette fonctionnalité n’est pas prise en charge pour sécuriser
ce service.
Description : Le service prend en charge le chiffrement des données en transit pour le
plan de données. Plus d’informations
ノ
Agrandir le tableau
DP-2 : surveiller les anomalies et les menaces ciblant les
données sensibles
Fonctionnalités
Protection contre les fuites/pertes de données
ノ
Agrandir le tableau
DP-3 : chiffrer les données sensibles en transit
Fonctionnalités
Chiffrement des données en transit | [
0.004001793917268515,
-0.024406244978308678,
-0.017322994768619537,
0.03538394719362259,
0.045540593564510345,
0.001066529075615108,
0.020547104999423027,
0.0068446192890405655,
0.0136078717187047,
-0.047954659909009933,
-0.026565544307231903,
-0.01947908103466034,
-0.08161964267492294,
0.... | {
"azure_component": "network",
"chunk_index": 731,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "514",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
Prise en charge
Activé par défaut
Responsabilité de la configuration
True
True
Microsoft
Conseils de configuration : Aucune configuration supplémentaire n’est requise, car elle
est activée sur un déploiement par défaut.
Référence : Gérer les protocoles et les chiffrements dans Azure Gestion des API
Les appels de plan de gestion se font par le biais d'Azure Resource Manager sur TLS. Un
jeton web JSON valide (JWT) est nécessaire. Les appels de plan de données peuvent être
sécurisés via TLS et un des mécanismes d’authentification pris en charge (certificat client
ou JWT, par exemple).
Azure Policy définitions intégrées - Microsoft.ApiManagement :
Nom
Description
Effet(s)
Version
Les API Gestion des
API doivent utiliser
uniquement des
protocoles chiffrés
Pour garantir la sécurité des données en
transit, les API doivent être disponibles
uniquement via des protocoles chiffrés, tels
que HTTPS ou WSS. Évitez d’utiliser des
protocoles non sécurisés, tels que HTTP ou
WS.
Audit,
Désactivé,
Refus
2.0.2
ノ
Agrandir le tableau
Autres conseils pour DP-3
Surveillance de Microsoft Defender pour le cloud
ノ
Agrandir le tableau
(Portail Azure)
(GitHub)
DP-4 : activer le chiffrement des données au repos par
défaut
Fonctionnalités
Chiffrement des données au repos à l’aide de clés de plateforme | [
0.008154341951012611,
-0.04730020463466644,
-0.03974904119968414,
0.02494337037205696,
0.034479621797800064,
-0.011802797205746174,
0.051703982055187225,
0.015457114204764366,
0.019834263250231743,
-0.05111059173941612,
-0.03350045904517174,
-0.06201321259140968,
-0.07626144587993622,
0.00... | {
"azure_component": "network",
"chunk_index": 732,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "515",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
Description : Le chiffrement des données au repos à l’aide de clés de plateforme est pris
en charge. Tout contenu client au repos est chiffré avec ces clés gérées par Microsoft.
Plus d’informations
Prise en charge
Activé par défaut
Responsabilité de la configuration
True
True
Microsoft
Remarques sur les fonctionnalités : les données client d’un Gestion des API instance, y
compris les paramètres d’API, les produits, les abonnements, les utilisateurs, les groupes
et le contenu du portail des développeurs personnalisé, sont stockées dans une base de
données SQL Azure et dans stockage Azure, qui chiffre automatiquement le contenu au
repos.
Conseils de configuration : Aucune configuration supplémentaire n’est requise, car elle
est activée sur un déploiement par défaut.
Description : Le service prend en charge l’intégration d’Azure Key Vault pour toutes les
clés client, secrets ou certificats. Plus d’informations
Prise en charge
Activé par défaut
Responsabilité de la configuration
True
Faux
Client
Conseils de configuration : Configurer l’intégration de Gestion des API à Azure Key
Vault. Vérifiez que les clés utilisées par Gestion des API sont stockées dans un coffre de
clés Azure pour qu’elles soient accessibles et puissent être mises à jour de manière
sécurisée.
Référence : Prérequis pour l’intégration du coffre de clés
ノ
Agrandir le tableau
DP-6 : Utiliser un processus sécurisé de gestion de clés
Fonctionnalités
Gestion des clés dans Azure Key Vault
ノ
Agrandir le tableau
Surveillance de Microsoft Defender pour le cloud | [
-0.0051584099419415,
-0.03644086793065071,
-0.018779033794999123,
0.052362170070409775,
0.07008078694343567,
0.028187161311507225,
0.01739688217639923,
0.043691154569387436,
0.019944937899708748,
-0.048817262053489685,
-0.03421571105718613,
-0.04326397553086281,
-0.07437888532876968,
0.047... | {
"azure_component": "network",
"chunk_index": 733,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "516",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
Azure Policy définitions intégrées - Microsoft.ApiManagement :
Nom
Description
Effet(s)
Version
Les valeurs
nommées des
secrets de
Gestion des API
doivent être
stockées dans
Azure Key Vault
Les valeurs nommées représentent une collection de
paires nom et valeur dans chaque service Gestion des
API. Les valeurs de secret peuvent être stockées en
tant que texte chiffré dans Gestion des API (secrets
personnalisés) ou en référençant les secrets dans
Azure Key Vault. Pour renforcer la sécurité de Gestion
des API et des secrets, référencez les valeurs
nommées des secrets à partir de Azure Key Vault.
Azure Key Vault prend en charge la gestion précise
des accès et les stratégies de rotation des secrets.
Audit,
Désactivé,
Refus
1.0.2
Description : Le service prend en charge l’intégration d’Azure Key Vault pour tous les
certificats clients. Plus d’informations
Prise en charge
Activé par défaut
Responsabilité de la configuration
True
Faux
Client
Conseils de configuration : Configurer l’intégration de Gestion des API à Azure Key
Vault. Vérifiez que les secrets pour Gestion des API (valeurs nommées) sont stockés dans
un coffre de clés Azure pour qu’ils soient accessibles et puissent être mis à jour de
manière sécurisée.
Utilisez Azure Key Vault pour créer et contrôler le cycle de vie des certificats, notamment
la création, l’importation, la rotation, la révocation, le stockage et la purge du certificat.
Assurez-vous que la génération de certificat respecte des normes définies sans utiliser
de propriétés non sécurisées, telles que : taille de clé insuffisante, période de validité
ノ
Agrandir le tableau
(Portail Azure)
(GitHub)
DP-7 : utiliser un processus de gestion des certificats
sécurisé
Fonctionnalités
Gestion des | [
-0.033974893391132355,
-0.0050786579959094524,
-0.020025884732604027,
0.0304540004581213,
0.0359642393887043,
0.029632503166794777,
0.04171936213970184,
0.031327370554208755,
-0.04622570425271988,
-0.015465164557099342,
-0.02252083271741867,
-0.045773155987262726,
-0.038380421698093414,
0.... | {
"azure_component": "network",
"chunk_index": 734,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "517",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
que la génération de certificat respecte des normes définies sans utiliser
de propriétés non sécurisées, telles que : taille de clé insuffisante, période de validité
ノ
Agrandir le tableau
(Portail Azure)
(GitHub)
DP-7 : utiliser un processus de gestion des certificats
sécurisé
Fonctionnalités
Gestion des certificats dans Azure Key Vault
ノ
Agrandir le tableau | [
-0.009410316124558449,
0.030241357162594795,
0.004030029289424419,
0.05550572648644447,
0.07130038738250732,
0.0156379546970129,
0.028262443840503693,
0.017638767138123512,
-0.0152456508949399,
-0.022286277264356613,
-0.014454683288931847,
-0.03911324962973595,
-0.040416132658720016,
0.024... | {
"azure_component": "network",
"chunk_index": 735,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "517",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
trop longue, chiffrement non sécurisé. Configurez la rotation automatique du certificat
dans Azure Key Vault et le service Azure (s’il est pris en charge) en fonction d’une
planification définie ou en cas d’expiration du certificat. Si la rotation automatique n’est
pas prise en charge dans l’application, vérifiez qu’elles sont toujours pivotées à l’aide de
méthodes manuelles dans Azure Key Vault et l’application.
Référence : Sécuriser les services principaux à l’aide de l’authentification par certificat
client dans Azure Gestion des API
Pour plus d’informations, consultez le benchmark de sécurité cloud Microsoft : Gestion des
ressources.
Description : Les configurations de service peuvent être surveillées et appliquées via
Azure Policy. Plus d’informations
Prise en charge
Activé par défaut
Responsabilité de la configuration
True
False
Client
Conseils de configuration : Utilisez des Azure Policy intégrés pour surveiller et appliquer
une configuration sécurisée sur Gestion des API ressources. Utilisez des alias
Azure Policy dans l’espace de noms « Microsoft.ApiManagement » pour créer des
définitions Azure Policy personnalisées si nécessaire.
Référence : Azure Policy définitions de stratégie intégrées pour Azure Gestion des API
Pour plus d’informations, consultez le benchmark de sécurité cloud Microsoft :
Journalisation et détection des menaces.
Gestion des ressources
AM-2 : Utiliser uniquement des services approuvés
Fonctionnalités
Prise en charge d’Azure Policy
ノ
Agrandir le tableau
Journalisation et détection des menaces | [
-0.017987823113799095,
-0.006553931161761284,
-0.024262594059109688,
0.031491391360759735,
0.05131758376955986,
0.032400503754615784,
0.053091756999492645,
-0.0014992955839261413,
-0.0029519887175410986,
-0.03915449231863022,
-0.023388590663671494,
-0.04863477870821953,
-0.04539138078689575,... | {
"azure_component": "network",
"chunk_index": 736,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "518",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
Description : le service dispose d’une solution de Microsoft Defender spécifique à l’offre
pour surveiller et alerter sur les problèmes de sécurité. Plus d’informations
Pris en charge
Activé par défaut
Responsabilité de la configuration
True
False
Client
Conseils de configuration : Defender pour les API, une fonctionnalité de Microsoft
Defender pour le cloud, offre une protection, une détection et une couverture de
réponse complètes pour les API gérées dans Azure Gestion des API.
L’intégration d’API à Defender pour les API est un processus en deux étapes : activation
du plan Defender pour les API pour l’abonnement et intégration d’API non protégées
dans vos instances de Gestion des API.
Affichez un résumé de toutes les recommandations et alertes de sécurité pour les API
intégrées en sélectionnant Microsoft Defender pour le cloud dans le menu de votre
Gestion des API instance.
Référence : Activer les fonctionnalités avancées de sécurité des API à l’aide de Microsoft
Defender pour le cloud
Description : le service produit des journaux de ressources qui peuvent fournir des
métriques et une journalisation améliorées spécifiques au service. Le client peut
configurer ces journaux de ressources et les envoyer à son propre récepteur de
données, comme un compte de stockage ou un espace de travail Log Analytics. Plus
d’informations
LT-1 : activer les fonctionnalités de détection des menaces
Fonctionnalités
Microsoft Defender pour les offres de services/produits
ノ
Agrandir le tableau
LT-4 : Activer la journalisation pour l’examen de sécurité
Fonctionnalités
Journaux des ressources Azure | [
-0.02128221094608307,
0.0019204964628443122,
-0.023487111553549767,
0.0072582378052175045,
0.050256866961717606,
0.032860178500413895,
0.019547872245311737,
-0.0016081843059509993,
-0.006061225198209286,
-0.026003075763583183,
-0.022969592362642288,
-0.04292023554444313,
-0.07432958483695984... | {
"azure_component": "network",
"chunk_index": 737,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "519",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
Pris en charge
Activé par défaut
Responsabilité de la configuration
True
False
Client
Conseils de configuration : Activez les journaux de ressources pour Gestion des API. Les
journaux de ressources fournissent des informations détaillées sur les opérations et les
erreurs qui sont importantes à des fins d’audit et de résolution des problèmes. Les
catégories de journaux de ressources pour Gestion des API incluent :
GatewayLogs
WebSocketConnectionLogs
Référence : Journaux des ressources APIM
Pour plus d’informations, consultez le benchmark de sécurité cloud Microsoft : Sauvegarde
et récupération.
Description : le service peut être sauvegardé par le service Sauvegarde Azure. Plus
d’informations
Pris en charge
Activé par défaut
Responsabilité de la configuration
Faux
Non applicable
Non applicable
Conseils de configuration : cette fonctionnalité n’est pas prise en charge pour sécuriser
ce service.
ノ
Agrandir le tableau
Sauvegarde et récupération
BR-1 : Garantir des sauvegardes automatiques régulières
Fonctionnalités
Sauvegarde Azure
ノ
Agrandir le tableau
Fonctionnalité de sauvegarde native du service | [
-0.030785121023654938,
-0.04183908551931381,
-0.034659504890441895,
-0.01086355373263359,
0.044813577085733414,
-0.0041375234723091125,
0.05877291038632393,
0.01381234172731638,
0.012810741551220417,
-0.02628152072429657,
-0.04504495486617088,
-0.00751905282959342,
-0.06367114931344986,
-0... | {
"azure_component": "network",
"chunk_index": 738,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "520",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
Commentaires
Cette page a-t-elle été utile ?
Indiquer des commentaires sur le produit
Description : le service prend en charge sa propre fonctionnalité de sauvegarde native
(s’il n’utilise pas Sauvegarde Azure). Plus d’informations
Pris en charge
Activé par défaut
Responsabilité de la configuration
True
False
Partagé
Conseils supplémentaires : Tirez parti des fonctionnalités de sauvegarde et de
restauration dans Azure Gestion des API service. Lorsque vous tirez parti des
fonctionnalités de sauvegarde, Azure Gestion des API écrit des sauvegardes sur des
comptes de stockage Azure appartenant au client. Les opérations de sauvegarde et de
restauration sont fournies par Azure Gestion des API pour effectuer une sauvegarde et
une restauration système complètes.
Référence : Comment implémenter la récupération d’urgence à l’aide de la sauvegarde
et de la restauration de service dans Azure Gestion des API
Consultez la vue d’ensemble du benchmark de sécurité cloud Microsoft
En savoir plus sur les bases de référence de la sécurité Azure
ノ
Agrandir le tableau
Étapes suivantes
Yes
No | [
-0.0005658376612700522,
-0.027012625709176064,
-0.011094425804913044,
0.03763611987233162,
0.05009739100933075,
0.03078669123351574,
0.040326908230781555,
0.07225921005010605,
-0.016768092289566994,
-0.03720341995358467,
-0.025099612772464752,
-0.02286512404680252,
-0.039463628083467484,
0... | {
"azure_component": "network",
"chunk_index": 739,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "521",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
Observabilité dans Gestion des API Azure
Article • 03/03/2025
S’APPLIQUE À : tous les niveaux de Gestion des API
L’observabilité est la capacité à comprendre l’état interne d’un système à partir des
données qu’il produit et la capacité à explorer ces données pour répondre à des questions
sur ce qui s’est produit et pourquoi.
Gestion des API Azure aide les organisations à centraliser la gestion de toutes les API. Dans
la mesure où il sert de point d’entrée unique pour le trafic de toutes les API, c’est
l’emplacement idéal pour observer ces dernières.
Gestion des API Azure vous permet de choisir l’utilisation de la passerelle gérée ou de la
passerelle auto-hébergée, qu’elle soit déployée automatiquement ou à l’aide d’une
extension Azure Arc.
Le tableau suivant résume toutes les fonctionnalités d’observabilité prises en charge par
Gestion des API pour faire fonctionner les API et les modèles de déploiement qu’elles
prennent en charge. Les éditeurs d’API et d’autres utilisateurs disposant d’autorisations
d’exploitation ou de gestion de l’instance Gestion des API peuvent utiliser ces
fonctionnalités.
Vue d’ensemble
7 Notes
Pour les consommateurs d’API qui utilisent le portail des développeurs, un rapport
d’API intégré est disponible. Ce rapport fournit uniquement des informations sur leur
propre utilisation des API au cours des 90 jours précédents. Actuellement, le rapport
de l’API intégré n’est pas disponible dans le portail des développeurs pour les niveaux
de service v2.
ノ
Agrandir le tableau | [
-0.005043485667556524,
-0.023820143193006516,
-0.005304574500769377,
-0.016422944143414497,
0.02781408652663231,
-0.0038821129128336906,
0.04447070136666298,
0.05526064336299896,
-0.050065141171216965,
-0.06937907636165619,
-0.010311156511306763,
-0.05439230427145958,
-0.06868799775838852,
... | {
"azure_component": "network",
"chunk_index": 740,
"contains_sku": true,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "522",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
Outil
Utile pour
Retard
des
données
Rétention
échantillonnage
Type de
données
Modèle(s)
de
déploiement
pris en
charge
Inspecteur
d’API
Test et
débogage
Immédiat
100 dernières
traces
Activé par
requête
Traces
des
requêtes
Managée,
auto-
hébergée,
Azure Arc,
espace de
travail
Analytique
intégrée
Création de
rapports et
surveillance
Minutes
Durée de vie
100 %
Rapports
et
journaux
Géré
Azure Monitor
Metrics
Création de
rapports et
surveillance
Minutes
90 jours
(mettre à
niveau pour
prolonger)
100 %
Mesures
Managé,
auto-
hébergé ,
Azure Arc
Journaux
d’activité
Azure Monitor
Création de
rapports,
surveillance
et débogage
Minutes
31 jours/5 Go
(mettre à
niveau pour
prolonger/
étendre)
100% (ajustable)
Journaux
d’activité
Managé ,
auto-
hébergé ,
Azure Arc
Azure
Application
Insights
Création de
rapports,
surveillance
et débogage
Secondes
90 jours/5 Go
(mettre à
niveau pour
prolonger/
étendre)
Custom
Journaux,
métriques
Managée ,
Auto-
hébergée ,
Azure Arc ,
Espace de
travail
Journalisation
via Azure Event
Hubs
Scénarios
personnalisés
Secondes
Géré par
l’utilisateur
Custom
Custom
Managé ,
auto-
hébergé ,
Azure Arc
OpenTelemetry
Surveillance
Minutes
Géré par
l’utilisateur
100 %
Mesures
Auto-
hébergé
1. Facultatif, en fonction de la configuration de | [
0.02473534271121025,
0.0012722158571705222,
-0.017163855955004692,
0.0013073724694550037,
0.04284973442554474,
0.010671917349100113,
0.048436589539051056,
0.029265016317367554,
-0.04893019422888756,
-0.05168286710977554,
0.024754684418439865,
-0.013007373549044132,
-0.0507989227771759,
0.0... | {
"azure_component": "network",
"chunk_index": 741,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "523",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
de
travail
Journalisation
via Azure Event
Hubs
Scénarios
personnalisés
Secondes
Géré par
l’utilisateur
Custom
Custom
Managé ,
auto-
hébergé ,
Azure Arc
OpenTelemetry
Surveillance
Minutes
Géré par
l’utilisateur
100 %
Mesures
Auto-
hébergé
1. Facultatif, en fonction de la configuration de la fonctionnalité dans Gestion des API Azure
2. facultatif, en fonction de la configuration de la passerelle
3. La passerelle auto-hébergée n’envoie actuellement aucun journal de diagnostic à Azure
Monitor. Toutefois, il est possible de configurer et de conserver des journaux localement, à
l’endroit où la passerelle auto-hébergée est déployée. Pour plus d’informations, consultez la
2
1
3
3
1
1
1
1
1
1
1
2 | [
0.03433534502983093,
0.019616449251770973,
-0.0004011902492493391,
-0.029216187074780464,
0.043920136988162994,
-0.005388057790696621,
0.038245465606451035,
0.017514003440737724,
-0.01970142126083374,
-0.04725437983870506,
0.002039835788309574,
-0.05523855984210968,
-0.044509295374155045,
... | {
"azure_component": "network",
"chunk_index": 742,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "523",
"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
configuration des indicateurs de performance et journaux locaux pour une passerelle auto-
hébergée
Bien démarrer avec Azure Monitor pour Gestion des API
Découvrir la journalisation des requêtes avec Application Insights
Découvrir la journalisation des événements avec Event Hubs
Découvrir comment visualiser des données Azure Monitor avec Azure Managed
Grafana
Étapes suivantes
Yes
No | [
0.05254600569605827,
0.017078382894396782,
0.014616630040109158,
0.009339116513729095,
0.06324896961450577,
0.03862207010388374,
0.0224655419588089,
0.05886438488960266,
-0.010008935816586018,
-0.06332515180110931,
0.013107100501656532,
-0.018612094223499298,
-0.07436035573482513,
0.020377... | {
"azure_component": "network",
"chunk_index": 743,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "524",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
Monitorer Gestion des API
20/05/2025
S’APPLIQUE À : Tous les niveaux de Gestion des API
Azure Monitor collecte et agrège les métriques et les journaux d’activité de votre système pour
surveiller la disponibilité, les performances et la résilience, et vous avertir des problèmes
affectant votre système. Vous pouvez utiliser le portail Azure, PowerShell, Azure CLI, l’API REST
ou des bibliothèques de client pour configurer et visualiser les données de monitoring.
Différentes métriques et journaux sont disponibles pour les différents types de ressource. Cet
article décrit les types de données de surveillance que vous pouvez collecter pour ce service et
les moyens d’analyser ces données.
Ce tableau décrit comment collecter des données pour surveiller votre service et ce que vous
pouvez faire avec les données une fois collectées :
Données à
collecter
Descriptif
Comment collecter et
acheminer les données
Où
visualiser
les
données
Données
prises en
charge
Données
métriques
Les métriques sont des
valeurs numériques
décrivant un aspect d’un
système à un moment précis
dans le temps. Les
métriques peuvent être
agrégées à l’aide
d’algorithmes, comparées à
d’autres métriques et
analysées afin de révéler des
tendances au fil du temps.
- Collectées automatiquement
à intervalles réguliers.
: vous pouvez acheminer
certaines métriques de
plateforme vers un espace de
travail Log Analytics pour
interroger d’autres données.
Vérifiez le paramètre
d’exportation DS de chaque
métrique pour voir si vous
pouvez utiliser un paramètre
de diagnostic pour acheminer
les données de métriques.
Metrics
Explorer
Métriques
Gestion des
API Azure
prises en
charge par
Azure
Monitor
Données
du | [
0.0170107651501894,
-0.010408246889710426,
-0.008691375143826008,
-0.0420093759894371,
0.04325128719210625,
0.011804923415184021,
0.01890813745558262,
0.038675807416439056,
-0.0399966798722744,
-0.051764149218797684,
0.02034907229244709,
-0.020246002823114395,
-0.07102321088314056,
0.02487... | {
"azure_component": "network",
"chunk_index": 744,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "525",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
un espace de
travail Log Analytics pour
interroger d’autres données.
Vérifiez le paramètre
d’exportation DS de chaque
métrique pour voir si vous
pouvez utiliser un paramètre
de diagnostic pour acheminer
les données de métriques.
Metrics
Explorer
Métriques
Gestion des
API Azure
prises en
charge par
Azure
Monitor
Données
du journal
des
ressources
Les journaux d’activité sont
des événements système
enregistrés avec un
horodatage. Les journaux
peuvent contenir différents
Créez un paramètre de
diagnostic pour collecter et
acheminer les données du
journal des ressources.
Log
Analytics
Données du
journal des
ressources
Gestion des
API Azure
Collecter des données avec Azure Monitor
ノ
Agrandir le tableau | [
-0.017245786264538765,
0.022631285712122917,
-0.028207648545503616,
-0.0308015625923872,
0.0676673874258995,
0.035059042274951935,
0.04360482841730118,
0.018011048436164856,
-0.021839750930666924,
-0.04314545914530754,
0.01567699946463108,
-0.02671857364475727,
-0.07192239165306091,
0.0225... | {
"azure_component": "network",
"chunk_index": 745,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "525",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
Données à
collecter
Descriptif
Comment collecter et
acheminer les données
Où
visualiser
les
données
Données
prises en
charge
types de données et être du
texte structuré ou de forme
libre. Vous pouvez
acheminer des données de
journaux de ressources vers
des espaces de travail Log
Analytics à des fins
d’interrogation et d’analyse.
prises en
charge par
Azure
Monitor
Données
du journal
d'activité
Le journal d’activité Azure
Monitor fournit des insights
sur les événements de
niveau abonnement. Le
journal d’activité inclut des
informations telles que le
moment auquel une
ressource a été modifiée ou
une machine virtuelle
démarrée.
– Collecté automatiquement.
- Créez un paramètre de
diagnostic pour un espace de
travail Log Analytics sans frais.
Journal
d’activité
Pour obtenir la liste de toutes les données prises en charge par Azure Monitor, consultez :
Métriques prises en charge par Azure Monitor
Journaux de ressources pris en charge par Azure Monitor
Gestion des API Azure intègre les fonctionnalités de monitoring suivantes.
La gestion des API Azure fournit des analyses pour vos API afin de pouvoir analyser leur
utilisation et leurs performances. Utilisez l’analytique pour une supervision générale de vos API
et leur dépannage. Pour obtenir d’autres fonctionnalités de supervision, y compris des
métriques en quasi-temps réel et des journaux de ressources pour les diagnostics et l’audit,
consultez Tutoriel : surveiller les API publiées.
Monitoring intégré de Gestion des API
Obtenir l’analytique des API dans Gestion des API Azure | [
0.007801019586622715,
0.004178742878139019,
-0.02196391671895981,
-0.03708251565694809,
0.05508360639214516,
-0.00617177365347743,
0.014997157268226147,
0.007780919317156076,
-0.022477172315120697,
-0.034154344350099564,
-0.0024985894560813904,
0.003464097622781992,
-0.07867424190044403,
0... | {
"azure_component": "network",
"chunk_index": 746,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "526",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
La gestion des API fournit des analyses à l’aide d’un tableau de bord basé sur Azure
Monitor. Le tableau de bord agrège les données dans un espace de travail Azure Log
Analytics.
Dans les niveaux de service de gestion des API classiques, votre instance de gestion des
API inclut également des analyses intégrées héritées dans le portail Microsoft Azure, et
des données d’analyse sont accessibles à l’aide de l’API REST de gestion des API. Les
données étroitement similaires sont affichées dans le tableau de bord basé sur Azure
Monitor et dans l’analytique intégrée.
Avec l’analyse des API, analysez l’utilisation et les performances des API dans votre instance de
gestion des API sous différentes dimensions, notamment :
Temps
Géographie
API
Opérations d’API
Produits
Abonnements
Utilisateurs
Demandes
7 Notes
Actuellement, cette fonctionnalité n’est pas disponible dans les espaces de travail.
) Important
Le tableau de bord basé sur Azure Monitor est le moyen recommandé d’accéder aux
données d’analyse. L’analytique intégrée (classique) n’est pas disponible dans les
niveaux v2. | [
0.00597069226205349,
0.020495792850852013,
-0.01642625965178013,
-0.028357159346342087,
0.04658343270421028,
0.001517847296781838,
0.02082185633480549,
0.05990457534790039,
-0.03596289083361626,
-0.033394914120435715,
0.006912628188729286,
-0.051358163356781006,
-0.06600447744131088,
0.030... | {
"azure_component": "network",
"chunk_index": 747,
"contains_sku": true,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "527",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
L’analyse des API fournit des données sur les requêtes, notamment les requêtes ayant échoué
et non autorisées. Les valeurs géographiques sont basées sur le mappage d’adresses IP. Il peut
y avoir un délai dans la disponibilité des données d’analyse.
Pour utiliser le tableau de bord basé sur Azure Monitor, vous avez besoin d’un espace de travail
Log Analytics en tant que source de données pour les journaux de passerelle Gestion des API.
Si vous devez en configurer un, les étapes suivantes permettent d’envoyer des journaux de
passerelle à un espace de travail Log Analytics. Pour plus d’informations, consultez Tutoriel :
surveiller les API publiées. Cette procédure est une configuration ponctuelle.
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.
3. Entrez un nom descriptif pour le paramètre de diagnostic.
4. Dans Journaux, sélectionnez Journaux liés à la passerelle ApiManagement.
5. Dans Détails de destination, sélectionnez Envoyer à Log Analytics et sélectionnez un
espace de travail Log Analytics dans le même abonnement ou dans un abonnement
différent. Si vous devez créer un espace de travail, consultez Créer un espace de travail
Log Analytics.
6. Vérifiez que Propre à la ressource est sélectionnée comme table de destination.
7. Cliquez sur Enregistrer.
Une fois qu’un espace de travail Log Analytics est configuré, accédez au tableau de bord basé
sur Azure Monitor pour analyser l’utilisation et les performances de vos API.
1. Dans le portail Azure
, accédez à votre instance APIM.
2. Dans le menu de gauche, sous Supervision, sélectionnez Analytique. Le tableau de bord
d’analyse s’ouvre.
3. Sélectionnez un intervalle de temps pour les données.
Tableau de bord basé sur Azure | [
-0.0007896982715465128,
0.028876544907689095,
-0.033171188086271286,
-0.04060947522521019,
0.04686375707387924,
0.02968795783817768,
0.03541063144803047,
0.05256427824497223,
-0.028117256239056587,
-0.0641869455575943,
-0.00045058835530653596,
-0.06237782910466194,
-0.05397895723581314,
0.... | {
"azure_component": "network",
"chunk_index": 748,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "528",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
au tableau de bord basé
sur Azure Monitor pour analyser l’utilisation et les performances de vos API.
1. Dans le portail Azure
, accédez à votre instance APIM.
2. Dans le menu de gauche, sous Supervision, sélectionnez Analytique. Le tableau de bord
d’analyse s’ouvre.
3. Sélectionnez un intervalle de temps pour les données.
Tableau de bord basé sur Azure Monitor
) Important
Le démarrage de la réception de données dans un nouvel espace de travail Log Analytics
peut prendre jusqu’à deux heures. Un espace de travail existant doit commencer à
recevoir des données dans les 15 minutes environ.
Accéder au tableau de bord | [
0.008198481053113937,
0.035468026995658875,
-0.006908171344548464,
-0.014488589018583298,
0.039408132433891296,
0.011798478662967682,
0.02503109723329544,
0.06528717279434204,
-0.02141924574971199,
-0.03434088081121445,
0.004474768880754709,
-0.02736312337219715,
-0.05822772532701492,
0.02... | {
"azure_component": "network",
"chunk_index": 749,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "528",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
4. Sélectionnez une catégorie de rapport pour les données d’analytique, par exemple
Chronologie ou Géographie.
Dans certains niveaux de service Gestion des API, l’analytique intégrée (également appelée
analytique héritée ou analytique classique) est également disponible dans le portail Microsoft
Azure et les données d’analytique sont accessibles à l’aide de l’API REST de Gestion des API.
Pour accéder à l’analyse intégrée (classique) dans le portail Azure :
1. Dans le portail Azure
, accédez à votre instance APIM.
2. Dans le menu de gauche, sous Supervision, sélectionnez Analytique (classique).
3. Sélectionnez un intervalle de temps pour les données, ou entrez un intervalle
personnalisé.
4. Sélectionnez une catégorie de rapport pour les données d’analytique, par exemple
Chronologie ou Géographie.
5. Si vous le souhaitez, vous pouvez filtrer le rapport selon une ou plusieurs autres
catégories.
Utilisez les opérations Rapports de l’API REST Gestion des API pour récupérer et filtrer les
données d’analytique de votre instance Gestion des API.
Les opérations disponibles retournent des enregistrements de rapport filtrés par API,
Géographie, Opérations d’API, Produit, Demande, Abonnement, Date ou Utilisateur.
Cette section vous montre comment activer les journaux Azure Monitor pour l’audit et la
résolution des problèmes d’utilisation de différentes fonctionnalités de votre instance Gestion
des API. En activant un paramètre de diagnostic, vous pouvez activer la collecte d’une ou
plusieurs des catégories suivantes de journaux de ressources :
Catégorie
Descriptif
Remarques
Passerelle
Gestion des API
Demandes traitées par la passerelle Gestion
des API, notamment les méthodes HTTP, les
protocoles, les corps de requête et de
réponse, les en-têtes, le minutage, | [
-0.006017882842570543,
-0.006604465190321207,
-0.03647861257195473,
-0.017203964293003082,
0.020618710666894913,
0.03493289276957512,
0.02995993010699749,
0.043345820158720016,
-0.04048426076769829,
-0.0689297616481781,
-0.007839489728212357,
-0.054794974625110626,
-0.08694390207529068,
0.... | {
"azure_component": "network",
"chunk_index": 750,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "529",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
de diagnostic, vous pouvez activer la collecte d’une ou
plusieurs des catégories suivantes de journaux de ressources :
Catégorie
Descriptif
Remarques
Passerelle
Gestion des API
Demandes traitées par la passerelle Gestion
des API, notamment les méthodes HTTP, les
protocoles, les corps de requête et de
réponse, les en-têtes, le minutage, les
détails d’erreur et l’implication du cache.
Ajustez les paramètres de toutes les API
ou remplacez-les pour les API
individuelles.
Dans les instances de gestion des API,
configurées avec des espaces de travail,
les journaux de passerelle peuvent être
Analyse intégrée héritée
Journaux d’activité Azure Monitor
ノ
Agrandir le tableau | [
-0.0074213407933712006,
-0.019822577014565468,
-0.011575877666473389,
-0.029175667092204094,
0.05421607568860054,
0.010378464125096798,
0.04104841873049736,
0.02658696472644806,
-0.040880512446165085,
-0.0026778490282595158,
-0.0021321706008166075,
0.008286534808576107,
-0.08640728145837784,... | {
"azure_component": "network",
"chunk_index": 751,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "529",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
Catégorie
Descriptif
Remarques
collectés individuellement pour chaque
espace de travail et agrégés pour un
accès centralisé par l’équipe de la
plateforme.
Connexions
WebSocket
Événements liés aux connexions WebSocket
API, depuis le handshake jusqu'à la
terminaison de la connexion.
Utilisation du
portail des
développeurs
Demandes reçues et traitées par le portail
des développeurs Gestion des API,
notamment les actions d’authentification
utilisateur, les vues des détails de l’API et les
tests d’API dans la console de test
interactive.
Passerelle pour
l'IA générative
Demandes traitées par la passerelle Gestion
des API pour les API REST de modèle de
langage volumineux (LLM), telles que les API
Azure OpenAI, notamment l’utilisation des
jetons, les modèles, et éventuellement les
détails des invites de requête et des
achèvements de réponse.
Activez la journalisation des messages
de requête et/ou des messages de
réponse pour des API LLM spécifiques.
Pour plus d’informations, consultez la référence des données de surveillance de 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.
Activer le paramètre de diagnostic pour les journaux d’activité Azure
Monitor | [
0.0019222813425585628,
-0.021868407726287842,
-0.0209879819303751,
-0.051513031125068665,
0.05288601294159889,
0.008615091443061829,
0.02201954647898674,
0.04410532861948013,
-0.04271266236901283,
-0.04797537252306938,
-0.004969931673258543,
-0.03741895779967308,
-0.0859655886888504,
0.034... | {
"azure_component": "network",
"chunk_index": 752,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "530",
"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. Cliquez sur 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.029347842559218407,
0.02577292174100876,
-0.034893687814474106,
-0.029247140511870384,
0.061853740364313126,
0.059697363525629044,
-0.0018049950012937188,
0.0040834322571754456,
-0.029400264844298363,
-0.061080485582351685,
-0.01896081492304802,
-0.0036159586161375046,
-0.0418076105415821... | {
"azure_component": "network",
"chunk_index": 753,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "531",
"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.
En fonction de la destination des journaux que vous choisissez, l’affichage des données peut
prendre quelques minutes.
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 données du journal Azure Monitor
Afficher les journaux d’activité dans l’espace de travail Log Analytics
ApiManagementGatewayLogs
| where TimeGenerated > ago(1d) | [
-0.009013324975967407,
0.020097792148590088,
-0.02234654501080513,
-0.0525125227868557,
0.05035088211297989,
0.028589166700839996,
0.05161530524492264,
0.02903759479522705,
-0.037281036376953125,
-0.05935925990343094,
-0.03228253126144409,
-0.017889542505145073,
-0.055705077946186066,
0.00... | {
"azure_component": "network",
"chunk_index": 754,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "532",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
Si vous envoyez les journaux à un compte de stockage, vous pouvez accéder aux données dans
le portail Azure et les télécharger à des fins d’analyse.
1. Dans le portail Azure
, accédez à la destination de compte de stockage.
2. Dans le menu de gauche, sélectionnez Navigateur de stockage.
3. Sous Conteneurs d’objetsblob, sélectionnez un nom pour les données de journal, par
exemple insights-logs-developerportalauditlogs pour les journaux d’utilisation du portail
des développeurs.
4. Accédez au conteneur pour les journaux dans votre instance Gestion des API. Les
journaux sont partitionnés à intervalles d’une heure.
5. Pour récupérer les données pour une analyse plus approfondie, sélectionnez Télécharger.
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.
Afficher les journaux d’activité dans le compte de stockage
Modifier les paramètres de journalisation d’API | [
-0.009604315273463726,
0.0006568621611222625,
-0.017918603494763374,
-0.027473177760839462,
0.04374462366104126,
0.059137240052223206,
0.005700150970369577,
0.053234443068504333,
-0.03244408220052719,
-0.0307968407869339,
-0.02554132044315338,
-0.03229871764779091,
-0.05861472338438034,
0.... | {
"azure_component": "network",
"chunk_index": 755,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "533",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
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.
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. Cliquez sur 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. Cliquez sur Enregistrer.
) 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 | [
-0.01892717182636261,
0.012388733215630054,
-0.03094383329153061,
-0.0767589658498764,
0.012461056932806969,
0.06194605305790901,
0.02716863341629505,
0.039063677191734314,
-0.02392038144171238,
-0.032431960105895996,
0.0017214466352015734,
-0.014963679015636444,
-0.057786084711551666,
0.0... | {
"azure_component": "network",
"chunk_index": 756,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "534",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
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. | [
-0.04122384637594223,
-0.02971366047859192,
-0.05535464733839035,
-0.018696926534175873,
0.04685802012681961,
0.017704473808407784,
0.03336746245622635,
0.0037989334668964148,
-0.040893036872148514,
-0.02962573803961277,
0.0020310874097049236,
0.0010922051733359694,
-0.03561590611934662,
0... | {
"azure_component": "network",
"chunk_index": 757,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "534",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
Ces outils Azure Monitor sont disponibles dans le portail Azure pour vous aider à analyser les
données de surveillance :
Certains services Azure ont un tableau de bord de supervision intégré dans le portail
Azure. Ces tableaux de bord sont appelés des insights et vous pouvez les trouver dans la
section Insights d’Azure Monitor dans le portail Azure.
Metrics Explorer vous permet d’afficher et d’analyser les métriques pour les ressources
Azure. Pour plus d’informations, consultez Analyser les métriques avec l’Explorateur de
métriques Azure Monitor.
Log Analytics vous permet d’interroger et d’analyser des données de journal à l’aide du
langage de requête Kusto (KQL). Pour plus d’informations, consultez Bien démarrer avec
les requêtes de journal dans Azure Monitor.
Le portail Azure dispose d’une interface utilisateur pour l’affichage et les recherches de
base du journal d’activité. Pour effectuer une analyse plus approfondie, vous devez router
les données vers les journaux Azure Monitor et exécuter des requêtes plus complexes
dans Log Analytics.
Application Insights analyse la disponibilité, les performances et l’utilisation de vos
applications web, pour que vous puissiez identifier et diagnostiquer les erreurs sans
attendre qu’un utilisateur les signale.
Application Insights inclut des points de connexion à divers outils de développement et
s’intègre à Visual Studio pour prendre en charge vos processus DevOps. Pour plus
d’informations, consultez Supervision des applications pour App Service.
Les outils qui permettent une visualisation plus complexe sont notamment :
Les tableaux de bord, qui vous permettent de combiner différentes sortes de données
dans un même volet du portail Azure.
Les workbooks, des rapports personnalisables que vous pouvez créer dans le portail
Azure. Les workbooks peuvent inclure du texte, des métriques et des requêtes de journal.
Grafana, un outil de plateforme ouvert, parfait pour les tableaux de bord opérationnels.
Vous pouvez utiliser Grafana pour créer des tableaux de bord à partir de | [
0.024163035675883293,
0.010165965184569359,
-0.009306780993938446,
-0.034216854721307755,
0.057776495814323425,
-0.009931655600667,
0.015671037137508392,
0.04438857361674309,
-0.02955530770123005,
-0.06925364583730698,
-0.002153776353225112,
-0.034029074013233185,
-0.06933363527059555,
0.0... | {
"azure_component": "network",
"chunk_index": 758,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "535",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
sortes de données
dans un même volet du portail Azure.
Les workbooks, des rapports personnalisables que vous pouvez créer dans le portail
Azure. Les workbooks peuvent inclure du texte, des métriques et des requêtes de journal.
Grafana, un outil de plateforme ouvert, parfait pour les tableaux de bord opérationnels.
Vous pouvez utiliser Grafana pour créer des tableaux de bord à partir de données de
plusieurs sources autres qu’Azure Monitor.
Power BI, un service d’analyse métier qui fournit des visualisations interactives pour
diverses sources de données. Vous pouvez configurer Power BI pour importer
automatiquement les données de journal à partir d’Azure Monitor afin de tirer parti de
ces visualisations supplémentaires.
Utiliser les outils Azure Monitor pour analyser les
données | [
-0.006632676348090172,
0.01986175775527954,
-0.0406641811132431,
0.0115975895896554,
0.0770779699087143,
0.010560759343206882,
-0.004124065395444632,
0.04721718654036522,
-0.022210268303751945,
-0.05349084362387657,
-0.0027912682853639126,
-0.04142938554286957,
-0.06906979531049728,
0.0372... | {
"azure_component": "network",
"chunk_index": 759,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "535",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
Vous pouvez utiliser Azure Managed Grafana pour visualiser les données de supervision
Gestion des API collectées dans un espace de travail Log Analytics. Utilisez un tableau de bord
Gestion des API
prédéfini pour la visualisation en temps réel des journaux et des métriques
collectés à partir de votre instance Gestion des API.
En savoir plus sur Azure Managed Grafana
En savoir plus sur l’observabilité dans Gestion des API Azure
Sur votre instance du service Gestion des API :
Pour visualiser les journaux et les métriques de ressources pour Gestion des API,
configurez les paramètres de diagnostic afin de collecter les journaux de ressources et les
envoyer à un espace de travail Log Analytics.
Pour visualiser des données détaillées sur les requêtes adressées à la passerelle Gestion
des API, intégrez votre instance Gestion des API à Application Insights.
Sur votre espace de travail Managed Grafana :
Pour créer une instance Managed Grafana et un espace de travail, consultez le démarrage
rapide du portail ou d’Azure CLI.
L’instance Managed Grafana doit se trouver dans le même abonnement que l’instance
Gestion des API.
Quand il est créé, l’espace de travail Grafana se voit automatiquement attribuer une
identité managée Microsoft Entra, qui reçoit le rôle Lecteur de supervision sur
l’abonnement. Cette approche vous permet d’accéder immédiatement à Azure Monitor à
partir du nouvel espace de travail Grafana sans avoir à définir manuellement les
autorisations. Apprenez-en plus sur la configuration des sources de données pour
Managed Grafana.
Commencez par importer le tableau de bord Gestion des API
dans votre espace de travail
Gestion Grafana.
Pour importer le tableau de bord :
Visualiser les données de supervision de Gestion des API à
l’aide d’un tableau de bord Azure Managed Grafana
7 Notes
Pour visualiser les données dans un tableau de bord unique, configurez l’espace de
travail Log Analytics pour les paramètres de diagnostic et l’instance Application
Insights dans le | [
0.039909373968839645,
-0.018209321424365044,
-0.02111644670367241,
-0.008410600945353508,
0.05035936459898949,
0.019411517307162285,
0.02988078072667122,
0.07344730198383331,
-0.04747753590345383,
-0.0695120319724083,
-0.016420722007751465,
-0.0688338577747345,
-0.07939622551202774,
0.0358... | {
"azure_component": "network",
"chunk_index": 760,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "536",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
le tableau de bord Gestion des API
dans votre espace de travail
Gestion Grafana.
Pour importer le tableau de bord :
Visualiser les données de supervision de Gestion des API à
l’aide d’un tableau de bord Azure Managed Grafana
7 Notes
Pour visualiser les données dans un tableau de bord unique, configurez l’espace de
travail Log Analytics pour les paramètres de diagnostic et l’instance Application
Insights dans le même groupe de ressources que votre instance Gestion des API. | [
-0.005739807616919279,
0.013088132254779339,
-0.01826629228889942,
0.003819321049377322,
0.040950678288936615,
0.005195461679250002,
0.022829383611679077,
0.08673570305109024,
-0.03623190522193909,
-0.04252674803137779,
-0.021168028935790062,
-0.08131112158298492,
-0.05243029072880745,
0.0... | {
"azure_component": "network",
"chunk_index": 761,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "536",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
1. Accédez à votre espace de travail Azure Managed Grafana. Dans le portail, dans la page
Vue d’ensemble de votre instance Managed Grafana, sélectionnez le lien Point de
terminaison.
2. Dans l’espace de travail Managed Grafana, accédez à Tableaux de
bord>Parcourir>Importer.
3. Dans la page Importer, sous Importer via grafana.com, entrez 16604, puis sélectionnez
Charger.
4. Sélectionnez une source de données Azure Monitor, passez en revue ou mettez à jour les
autres options, puis sélectionnez Importer.
Pour utiliser le tableau de bord Gestion des API :
1. Dans l’espace de travail Managed Grafana, accédez à Tableaux de bord>Parcourir et
sélectionnez votre tableau de bord Gestion des API.
2. Dans les listes déroulantes situées en haut, effectuez des sélections pour votre instance
Gestion des API. Si vous les avez configurés, sélectionnez une instance Application
Insights et un espace de travail Log Analytics.
Passez en revue les visualisations par défaut sur le tableau de bord, qui ressemblent à la
capture d’écran suivante :
Vous pouvez exporter des données en dehors d’Azure Monitor dans d’autres outils à l’aide de :
Exporter des données Azure Monitor | [
0.005894995294511318,
-0.0207377839833498,
-0.03586368262767792,
0.024145476520061493,
0.048712752759456635,
0.01638093777000904,
0.017960892990231514,
0.09643476456403732,
-0.0344754159450531,
-0.0754440501332283,
-0.024379629641771317,
-0.05339209362864494,
-0.06341467797756195,
0.024060... | {
"azure_component": "network",
"chunk_index": 762,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "537",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
Métriques : utilisez l’API REST pour les métriques pour extraire les données de métriques
de la base de données de métriques Azure Monitor. Pour plus d’informations, consultez
Informations de référence sur l’API REST Azure Monitor.
Journaux : utilisez l’API REST ou les bibliothèques de client associées.
L’exportation de données de l’espace de travail Log Analytics.
Pour bien démarrer avec l’API REST pour Azure Monitor, consultez Procédure pas à pas de l’API
REST d’analyse Azure.
Vous pouvez analyser les données du journal Azure Monitor à l’aide du langage de requête
Kusto (KQL). Pour plus d’informations, consultez Requêtes de journal dans Azure Monitor.
Les alertes Azure Monitor vous permettent d’identifier et de résoudre les problèmes dans votre
système et de vous avertir de manière proactive lorsque des conditions spécifiques sont
observées dans vos données de surveillance avant que vos clients ne les remarquent. Vous
pouvez définir une alerte sur n’importe quelle source de données de métrique ou de journal
dans la plateforme de données Azure Monitor. Il existe différents types d’alertes Azure Monitor
en fonction des services que vous surveillez et des données de monitoring que vous collectez.
Consultez Choix du type approprié de règle d’alerte.
Pour savoir comment configurer une règle d’alerte dans Gestion des API Azure, consultez
Configurer une règle d’alerte.
Pour obtenir des exemples d’alertes courantes pour les ressources Azure, consultez Exemples
de requêtes d’alerte de journal.
Pour certains services, vous pouvez opérer une surveillance à grande échelle en appliquant la
même règle d’alerte de métrique à plusieurs ressources du même type qui existent dans la
même région Azure. Azure Monitor Baseline Alerts (AMBA)
fournit une méthode semi-
automatisée de mise en œuvre des alertes, des tableaux de bord et des recommandations
concernant les métriques à grande | [
0.023947112262248993,
-0.016641907393932343,
-0.0141950948163867,
-0.020833363756537437,
0.04653759300708771,
0.028178097680211067,
0.030795617029070854,
0.06523782014846802,
-0.04828673601150513,
-0.03770410269498825,
0.005084086675196886,
-0.020610611885786057,
-0.08357706665992737,
0.02... | {
"azure_component": "network",
"chunk_index": 763,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "538",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
certains services, vous pouvez opérer une surveillance à grande échelle en appliquant la
même règle d’alerte de métrique à plusieurs ressources du même type qui existent dans la
même région Azure. Azure Monitor Baseline Alerts (AMBA)
fournit une méthode semi-
automatisée de mise en œuvre des alertes, des tableaux de bord et des recommandations
concernant les métriques à grande échelle.
Utiliser des requêtes Kusto pour analyser les
données de journal
Utiliser des alertes Azure Monitor pour vous avertir
des problèmes
Implémentation d’alertes à grande échelle | [
0.029434148222208023,
-0.02773185446858406,
-0.026539571583271027,
-0.01998217962682247,
0.05233648791909218,
-0.001460846047848463,
0.04858914017677307,
0.0330500565469265,
-0.027431000024080276,
-0.05093090981245041,
-0.013690498657524586,
-0.012820669449865818,
-0.09215603768825531,
0.0... | {
"azure_component": "network",
"chunk_index": 764,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "538",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
Pour certains services, si des conditions critiques ou des changements imminents se produisent
pendant des opérations de ressources, une alerte s’affiche dans la page Vue d’ensemble du
service concerné dans le portail. Des informations supplémentaires et les correctifs
recommandés pour l’alerte sont disponibles dans les Recommandations Advisor sous
Surveillance dans le menu de gauche. Pendant les opérations normales, aucune
recommandation Advisor ne s’affiche.
Pour plus d’informations sur Azure Advisor, consultez Vue d’ensemble d’Azure Advisor.
Informations de référence sur les données de monitoring Gestion des API
Tutoriel : Surveiller les API publiées
Supervision de ressources Azure avec Azure Monitor
Obtenir des recommandations personnalisées à
l’aide d’Azure Advisor
Contenu connexe | [
0.042729832231998444,
-0.03198310732841492,
-0.006416650023311377,
-0.031244687736034393,
0.07806075364351273,
-0.00508861243724823,
0.017001546919345856,
0.07487335056066513,
-0.04094196856021881,
-0.070569708943367,
-0.02182403951883316,
0.028965139761567116,
-0.08726177364587784,
0.0234... | {
"azure_component": "network",
"chunk_index": 765,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "539",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
Comment enregistrer des événements sur
Azure Event Hubs dans Gestion des API
Azure
20/05/2025
S’APPLIQUE À : Tous les niveaux de Gestion des API
Cet article décrit comment consigner les événements de Gestion des API à l’aide d’Azure Event
Hubs.
Les concentrateurs d'événements Azure sont un service d'entrée de données hautement
évolutif qui peut traiter des millions d'événements par seconde afin que vous puissiez traiter et
analyser les grandes quantités de données générées par vos périphériques connectés et vos
applications. Les concentrateurs d'événements fonctionnent comme la « porte d'entrée » d’un
pipeline d’événements, et une fois que les données sont collectées dans un concentrateur
d'événements, elles peuvent être transformées et stockées à l'aide de n'importe quel
fournisseur d'analyse en temps réel ou d’adaptateurs de traitement par lot ou de stockage. Les
concentrateurs d'événements dissocient la production d'un flux d'événements de la
consommation de ces événements, de manière à ce que les consommateurs d'événements
puissent accéder aux événements selon leur propre planification.
Une instance du service Gestion des API. Si vous n’en avez pas, consultez Créer une
instance du service Gestion des API.
Un espace de noms et un Event Hub sur Azure Event Hubs. Pour plus d’informations,
consultez l’article Créer un espace de noms Event Hubs et un Event Hub avec le Portail
Azure.
7 Notes
Cette fonctionnalité n’est actuellement pas disponible dans les espaces de travail.
Prérequis
7 Notes
La ressource d’Event Hub peut se trouver dans un autre abonnement, voire dans un
autre locataire, que la ressource Gestion des API | [
-0.031185396015644073,
-0.05904108285903931,
-0.009615480899810791,
-0.03765853866934776,
0.006791101302951574,
0.013281968422234058,
0.020763251930475235,
0.0964609831571579,
-0.0667734295129776,
-0.032791439443826675,
-0.020863458514213562,
-0.06455444544553757,
-0.07883390784263611,
0.0... | {
"azure_component": "network",
"chunk_index": 766,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "540",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
Pour enregistrer des événements dans l’Event Hub, vous devez configurer les informations
d’identification pour l’accès à partir de Gestion des API. Gestion des API prend en charge l’un
des deux mécanismes d’accès suivants :
Une identité managée pour une instance du service Gestion des API (recommandé)
Une chaîne de connexion Event Hubs
1. Activez une identité managée affectée par le système ou par l’utilisateur pour Gestion des
API dans votre instance Gestion des API.
Si vous activez une identité managée affectée par l’utilisateur, prenez note de l’ID
client de l’identité.
2. Attribuez à l’identité le rôle expéditeur de données Azure Event Hubs, limité à l’espace
de noms Event Hubs ou au hub d’événements utilisé pour la journalisation. Pour attribuer
le rôle, utilisez le portail Azure ou d’autres outils Azure.
Pour plus d’informations sur la chaîne de connexion Event Hubs, consultez Obtenir une chaîne
de connexion Event Hubs.
Vous pouvez utiliser une chaîne de connexion pour l’espace de noms Event Hubs ou pour
le hub d’événements spécifique que vous utilisez pour la journalisation à partir de Gestion
des API.
La stratégie d’accès partagé pour la chaîne de connexion doit activer au moins les
autorisations d’envoi.
Configurer l’accès au hub d’événements
7 Notes
Si possible, Microsoft recommande d’utiliser les informations d’identification d’identité
managée pour renforcer la sécurité.
Option 1 : configurer l’identité managée Gestion des API
Option 2 : configurer la chaîne de connexion Event Hubs
Créer un enregistreur d’événements de gestion des
API | [
-0.01720927655696869,
-0.02709903195500374,
-0.035847995430231094,
-0.05189649015665054,
0.02555437944829464,
-0.019955186173319817,
0.03728967159986496,
0.05160582810640335,
-0.052479058504104614,
-0.023399848490953445,
-0.02431531995534897,
-0.04942450299859047,
-0.07290348410606384,
0.0... | {
"azure_component": "network",
"chunk_index": 767,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "541",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
Maintenant que vous disposez d’un hub d’événements, l’étape suivante consiste à configurer
un enregistreur d’événements dans votre service Gestion des API afin qu’il puisse enregistrer
des événements dans le hub d’événements.
Créez et gérez les enregistreurs d’événements gestion des API à l’aide de l’API REST Gestion
des API directement ou à l’aide d’outils, notamment Azure PowerShell, un fichier Bicep ou un
modèle Azure Resource Management.
Vous pouvez configurer un enregistreur d’événements Gestion des API sur un hub
d’événements à l’aide des informations d’identification d’identité managée affectées par le
système ou attribuées par l’utilisateur.
Pour connaître les prérequis, consultez Configurer l’identité managée Gestion des API.
Utilisez l’enregistreur d’événements gestion des API - Créer ou mettre à jour l’API REST
avec le corps de la requête suivant.
JSON
Option 1 : enregistreur d’événements avec informations
d’identification d’identité managée (recommandé)
Enregistreur d’événements avec des informations
d’identification d’identité managées affectées par le système
REST API
{
"properties": {
"loggerType": "azureEventHub",
"description": "Event Hub logger with system-assigned managed identity",
"credentials": {
"endpointAddress":"<EventHubsNamespace>.servicebus.windows.net",
"identityClientId":"SystemAssigned",
"name":"<EventHubName>"
}
}
}
Enregistreur d’événements avec des informations d’identification
d’identité managées affectées par l’utilisateur | [
-0.04853930324316025,
-0.020626358687877655,
-0.022299259901046753,
-0.046152595430612564,
0.025008676573634148,
0.019097451120615005,
0.03121253289282322,
0.06248950958251953,
-0.06215718761086464,
-0.031326934695243835,
-0.03404645994305611,
-0.0544651634991169,
-0.08584555983543396,
0.0... | {
"azure_component": "network",
"chunk_index": 768,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "542",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
Pour connaître les prérequis, consultez Configurer l’identité managée Gestion des API.
Utilisez l’enregistreur d’événements gestion des API - Créer ou mettre à jour l’API REST
avec le corps de la requête suivant.
JSON
Pour connaître les prérequis, consultez Configurer la chaîne de connexion Event Hubs.
L’exemple suivant utilise le cmdlet New-AzApiManagementLogger pour créer un
enregistreur d’événements dans un hub d’événements en configurant une chaîne de
connexion.
PowerShell
REST API
{
"properties": {
"loggerType": "azureEventHub",
"description": "Event Hub logger with user-assigned managed identity",
"credentials": {
"endpointAddress":"<EventHubsNamespace>.servicebus.windows.net",
"identityClientId":"<ClientID>",
"name":"<EventHubName>"
}
}
}
Option 2. Enregistreur d’événements avec les informations
d’identification de chaîne de connexion
7 Notes
Dans la mesure du possible, Microsoft recommande de configurer l’enregistreur
d’événements avec des informations d’identification d’identité managée. Consultez
Configurer le logger des identifiants de l’identité managée, plus haut dans cet article.
PowerShell
# API Management service-specific details
$apimServiceName = "apim-hello-world" | [
-0.029590867459774017,
0.0008992966613732278,
-0.03640279546380043,
-0.032914139330387115,
0.0556020587682724,
-0.0015132467960938811,
0.039995498955249786,
0.046216804534196854,
-0.04684201627969742,
-0.02403874136507511,
-0.03739393875002861,
-0.03229861706495285,
-0.06537728756666183,
0... | {
"azure_component": "network",
"chunk_index": 769,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "543",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
Une fois que votre journal est configuré dans Gestion des API, vous pouvez configurer votre
stratégie log-to-eventhub pour enregistrer les événements de votre choix. Par exemple, utilisez
la stratégie log-to-eventhub de la section stratégie entrante pour journaliser les demandes, ou
dans la section stratégie sortante pour journaliser les réponses.
1. Accédez à votre instance Gestion des API.
2. Sélectionnez les API, puis sélectionnez l’API à ajouter la stratégie. Dans cet exemple, nous
ajoutons une stratégie à l’API Echo dans le produit Illimité.
3. Sélectionnez Toutes les opérations.
4. En haut de l’écran, sélectionnez l’onglet Conception.
5. Sélectionnez l’icône </> (éditeur de code) dans la fenêtre Traitement entrant ou
Traitement sortant. Pour plus d’informations, consultez la section Guide pratique pour
configurer ou modifier des stratégies.
6. Placez votre curseur dans la section des stratégies inbound ou outbound .
7. Dans la fenêtre de droite, sélectionnez Stratégies avancées>Consigner sur Event Hub.
Cela permet d’insérer le modèle d’instruction de stratégie log-to-eventhub .
XML
$resourceGroupName = "myResourceGroup"
# Create logger
$context = New-AzApiManagementContext -ResourceGroupName $resourceGroupName -
ServiceName $apimServiceName
New-AzApiManagementLogger -Context $context -LoggerId "ContosoLogger1" -Name
"ApimEventHub" -ConnectionString
"Endpoint=sb://<EventHubsNamespace>.servicebus.windows.net/;SharedAccessKeyNam
e=<KeyName>;SharedAccessKey=<key>" -Description "Event hub logger with
connection string"
Configurer des stratégies log-to-eventhub
<log-to-eventhub logger-id="logger-id">
@{
return new JObject(
new JProperty("EventTime", DateTime.UtcNow.ToString()), | [
-0.0406634546816349,
-0.00489855045452714,
-0.027312664315104485,
-0.0660431832075119,
0.024007106199860573,
0.01631743088364601,
0.04337696731090546,
0.03232895955443382,
-0.07792989909648895,
-0.044469695538282394,
-0.056091997772455215,
-0.0281983632594347,
-0.057322435081005096,
-0.007... | {
"azure_component": "network",
"chunk_index": 770,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "544",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
-Description "Event hub logger with
connection string"
Configurer des stratégies log-to-eventhub
<log-to-eventhub logger-id="logger-id">
@{
return new JObject(
new JProperty("EventTime", DateTime.UtcNow.ToString()),
new JProperty("ServiceName", context.Deployment.ServiceName),
new JProperty("RequestId", context.RequestId),
new JProperty("RequestIp", context.Request.IpAddress),
new JProperty("OperationName", context.Operation.Name)
).ToString(); | [
-0.055699680000543594,
-0.003681147936731577,
0.006223907228559256,
-0.009559079073369503,
0.03205856680870056,
0.003360108705237508,
0.07162559777498245,
0.01900765486061573,
-0.042848315089941025,
-0.06373284012079239,
-0.042088743299245834,
-0.03085806593298912,
-0.09432501345872879,
0.... | {
"azure_component": "network",
"chunk_index": 771,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "544",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
a. Remplacez logger-id par le nom du fichier JSON que vous avez créé à l’étape
précédente.
b. Vous pouvez utiliser toute expression qui renvoie une chaîne en tant que valeur pour
l’élément log-to-eventhub . Dans cet exemple, une chaîne dans le format JSON
contenant la date et l’heure, le nom du service, l’ID de la requête, son adresse IP et le
nom de l’opération est consignée.
8. Cliquez sur Enregistrer pour enregistrer la mise à jour de la configuration de la stratégie.
Dès qu’elle est enregistrée, la stratégie est active et les événements sont enregistrés dans
l’Event Hub désigné.
Vous pouvez afficher un aperçu du journal dans Event Hubs à l’aide de requêtes Azure Stream
Analytics.
1. Dans le Portail Azure, accédez au Event Hub auquel le journal envoie des événements.
2. Sous Fonctionnalités, sélectionnez l’onglet Traiter les données.
3. Sur la vignette Activer des insights en temps réel à partir d’événements, sélectionnez
Démarrer.
4. Vous devez être en mesure d’afficher un aperçu du journal dans l’onglet Aperçu de
l’entrée. Si les données qui apparaissent ne sont pas à jour, sélectionnez Actualiser pour
afficher les événements les plus récents.
En savoir plus sur Azure Event Hubs
}
</log-to-eventhub>
7 Notes
La taille maximale des messages pris en charge pouvant être envoyée à un Event Hub par
cette stratégie Gestion des API est de 200 kilooctets (ko). Si un message envoyé à un
Event Hub dépasse 200 ko, il est automatiquement tronqué. Le message tronqué est
ensuite transféré vers le hub d’événements. Pour les messages plus grands, envisagez
d’utiliser le Stockage avec la Gestion des API Azure comme solution de contournement
pour éviter la limite de 200 | [
-0.03218833729624748,
-0.025505416095256805,
-0.01778573729097843,
-0.05028558522462845,
0.03771181404590607,
0.004804700613021851,
0.03702341020107269,
0.0541389174759388,
-0.04116038605570793,
-0.060086823999881744,
-0.008371999487280846,
-0.05146004259586334,
-0.08304504305124283,
0.024... | {
"azure_component": "network",
"chunk_index": 772,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "545",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
API est de 200 kilooctets (ko). Si un message envoyé à un
Event Hub dépasse 200 ko, il est automatiquement tronqué. Le message tronqué est
ensuite transféré vers le hub d’événements. Pour les messages plus grands, envisagez
d’utiliser le Stockage avec la Gestion des API Azure comme solution de contournement
pour éviter la limite de 200 Ko. Vous trouverez plus de détails dans cet article
.
Afficher un aperçu du journal dans Event Hubs à
l’aide d’Azure Stream Analytics
Contenu connexe | [
-0.04144732654094696,
-0.07339095324277878,
-0.027435868978500366,
0.00491746049374342,
0.002011776203289628,
0.026688750833272934,
0.01772918924689293,
0.06549916416406631,
-0.04640613868832588,
-0.00629544910043478,
0.006431705318391323,
-0.050977129489183426,
-0.08498361706733704,
0.044... | {
"azure_component": "network",
"chunk_index": 773,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "545",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
Prise en main avec Azure Event Hubs
Réception de messages avec EventProcessorHost
Guide de programmation Event Hubs
En savoir plus sur l’intégration de Gestion des API et Event Hubs
Référence d’entité d’enregistreur
Référence de stratégie log-to-eventhub
En savoir plus sur l’intégration avec Azure Application Insights | [
-0.028857698664069176,
-0.011165537871420383,
-0.00997499842196703,
-0.022299833595752716,
0.040300000458955765,
0.008924572728574276,
0.024184364825487137,
0.06250748783349991,
-0.054521843791007996,
-0.06575528532266617,
-0.00030634322320111096,
-0.03789795562624931,
-0.06333136558532715,
... | {
"azure_component": "network",
"chunk_index": 774,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "546",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
Guide pratique pour intégrer la Gestion des
API Azure avec Azure Application Insights
09/04/2025
S’APPLIQUE À : Tous les niveaux de Gestion des API
Vous pouvez facilement intégrer Azure Application Insights avec Gestion des API Azure. Azure
Application Insights est un service extensible permettant aux développeurs web de créer et de
gérer des applications sur de nombreuses plateformes. Dans ce guide, vous allez :
Parcourir les étapes de l’intégration d’Application Insights dans Gestion des API.
Découvrir les stratégies permettant de réduire l’impact sur les performances de votre
instance de service Gestion des API.
Vous avez besoin d’une instance du service Gestion des API Azure. Commencez par en
créer une.
Pour utiliser Application Insights, créez une instance du service Application Insights. Pour
créer une instance à l’aide du portail Azure, consultez Ressources Application Insights
basées sur l’espace de travail.
7 Notes
Dans un espace de travail Gestion des API, un propriétaire de l’espace de travail peut
intégrer Application Insights indépendamment et activer la journalisation Application
Insights pour les API de l’espace de travail. Les conseils généraux pour intégrer un espace
de travail à Application Insights sont similaires aux instructions d’une instance gestion des
API ; toutefois, la configuration est limitée à l’espace de travail uniquement. Actuellement,
vous devez intégrer Application Insights dans un espace de travail en configurant une
chaîne de connexion (recommandé) ou une clé d’instrumentation.
2 Avertissement
Lorsque vous utilisez notre passerelle auto-hébergée, nous ne garantissons pas que
toutes les données de télémétrie seront envoyées à Azure Application Insights, étant
donné qu’elles dépendent de la mise en mémoire tampon d’Application Insights.
Prérequis | [
-0.014947635121643543,
-0.003966165240854025,
0.013020343147218227,
-0.0333545096218586,
0.03730908781290054,
0.020398801192641258,
0.0630984753370285,
0.03592715784907341,
-0.04834314063191414,
-0.08219610154628754,
-0.02527383528649807,
-0.0647716298699379,
-0.034071117639541626,
0.01577... | {
"azure_component": "network",
"chunk_index": 775,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "547",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
Si vous envisagez de configurer les informations d’identification d’identité managée à
utiliser avec Application Insights, procédez comme suit :
1. Activez une identité managée affectée par le système ou par l’utilisateur pour la
Gestion des API.
Si vous activez une identité managée affectée par l’utilisateur, prenez note de l’ID
client de l’identité.
2. Attribuez à l’identité le rôle Éditeur de métriques de surveillance, étendu à la
ressource Application Insights. Pour attribuer le rôle, utilisez le portail Azure ou
d’autres outils Azure.
Voici les étapes de haut niveau pour ce scénario.
1. D’abord, créez une connexion entre Application Insights et la Gestion des API.
Vous pouvez créer une connexion entre Application Insights et votre Gestion des API à
l’aide du Portail Azure, de l’API REST ou des outils Azure associés. Gestion des API
configure une ressource d’enregistreur d’événements pour la connexion.
7 Notes
La ressource Application Insights peut se trouver dans un autre abonnement voire
dans un autre locataire que la ressource Gestion des API.
Présentation du scénario
) Important
Actuellement, dans le portail, Gestion des API prend uniquement en charge les
connexions à Application Insights à l’aide d’une clé d’instrumentation Application
Insights. Pour renforcer la sécurité, nous vous recommandons d’utiliser une chaîne
de connexion Application Insights avec une identité managée Gestion des API. Pour
configurer la chaîne de connexion avec des informations d’identification d’identité
managée, utilisez l’API REST ou les outils associés, comme indiqué dans une section
ultérieure de cet article. En savoir plus sur le connecteur Application Insights.
7 Notes
Si votre ressource Application Insights se trouve dans un autre locataire, vous devez
créer l’enregistreur d’événements à l’aide de l’API REST ou des outils associés, | [
-0.00913231261074543,
-0.0068204267881810665,
-0.018713368102908134,
-0.027480458840727806,
0.04651360213756561,
0.01131447684019804,
0.058778002858161926,
0.00776103138923645,
-0.039032936096191406,
-0.072183758020401,
-0.02650769241154194,
-0.034656647592782974,
-0.05828341096639633,
0.0... | {
"azure_component": "network",
"chunk_index": 776,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "548",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
2. Ensuite, activez la journalisation Application Insights pour votre ou vos API.
Dans cet article, vous allez activer la journalisation Application Insights pour votre API à
l’aide du Portail Azure. Gestion des API configure une ressource de diagnostic pour l’API.
Suivez ces étapes pour utiliser le Portail Azure pour créer une connexion entre Application
Insights et Gestion des API.
1. Accédez à votre instance de service Gestion des API Azure sur le Portail Azure.
2. Sélectionnez Application Insights dans le menu de gauche.
3. Sélectionnez Ajouter.
4. Sélectionnez l’instance Application Insights que vous avez créée précédemment, et
entrez une brève description.
5. Pour activer la supervision de la disponibilité de votre instance de gestion des API dans
Application Insights, cochez la case Ajouter un moniteur de disponibilité.
comme indiqué dans une section ultérieure de cet article.
Créer une connexion à l’aide du portail Azure
7 Notes
Si possible, Microsoft recommande d’utiliser la chaîne de connexion avec les informations
d’identification d’identité managée pour renforcer la sécurité. Pour configurer ces
informations d’identification, utilisez l’API REST ou les outils associés, comme indiqué
dans une section ultérieure de cet article. | [
-0.014261800795793533,
-0.009418480098247528,
-0.007236485369503498,
-0.04526562616229057,
0.019183970987796783,
0.027737529948353767,
0.04251673072576523,
0.01499337237328291,
-0.03731593117117882,
-0.05340999364852905,
-0.029086489230394363,
-0.053507015109062195,
-0.052676212042570114,
... | {
"azure_component": "network",
"chunk_index": 777,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "549",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
Ce paramètre valide régulièrement si le point de terminaison de la passerelle de
gestion des API répond.
Les résultats s’affichent dans le volet Disponibilité de l’instance Application Insights.
6. Sélectionnez Create (Créer).
7. Vérifiez que le nouvel enregistreur d’événements d’Application Insights figure désormais
dans la liste.
Suivez ces étapes pour utiliser l’API REST, Bicep ou le modèle ARM pour créer un enregistreur
d’événements Application Insights pour votre instance Gestion des API. Vous pouvez
7 Notes
En arrière-plan, une entité Enregistreur d’événements est créée dans votre instance de
gestion des API, qui contient la clé d’instrumentation de l’instance Application Insights.
Conseil
Si vous devez mettre à jour la clé d’instrumentation configurée dans l’enregistreur
d’événements Application Insights, sélectionnez la ligne de l’enregistreur d’événements
dans la liste (et non le nom de l’enregistreur d’événements). Entrez la clé
d’instrumentation, puis sélectionnez Enregistrer.
Créer une connexion à l’aide de l’API REST, de
Bicep ou d’un modèle ARM | [
-0.0034199461806565523,
0.018883446231484413,
0.00942906178534031,
-0.04668937250971794,
0.03302692994475365,
0.04540726915001869,
0.030047129839658737,
0.013706856407225132,
-0.06127962842583656,
-0.027508936822414398,
-0.03317677229642868,
-0.00037022624746896327,
-0.03528693690896034,
0... | {
"azure_component": "network",
"chunk_index": 778,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "550",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
configurer un enregistreur d’événements qui utilise une chaîne de connexion avec des
informations d’identification d’identité managée (recommandé) ou un enregistreur
d’événements qui utilise uniquement une chaîne de connexion.
Consultez les conditions préalables à l’utilisation d’une identité managée Gestion des API.
Votre chaîne de connexion Application Insights s’affiche dans la section Vue d’ensemble de
votre ressource Application Insights.
Utilisez l’enregistreur d’événements gestion des API - Créer ou mettre à jour l’API REST
avec le corps de la requête suivant.
JSON
Utilisez l’enregistreur d’événements gestion des API - Créer ou mettre à jour l’API REST
avec le corps de la requête suivant.
Enregistreur d’événements avec une chaîne de connexion
avec des informations d’identification d’identité managée
(recommandé)
Chaîne de connexion avec identité managée affectée par le système
REST API
{
"properties": {
"loggerType": "applicationInsights",
"description": "Application Insights logger with system-assigned managed
identity",
"credentials": {
"connectionString":"InstrumentationKey=00000000-0000-0000-0000-
000000000000;IngestionEndpoint=https://xxxx.applicationinsights.azure.com/;...
",
"identityClientId":"SystemAssigned"
}
}
}
Chaîne de connexion avec identité managée affectée par l’utilisateur
REST API | [
-0.009615586139261723,
-0.0019163773395121098,
-0.02672606334090233,
-0.052207231521606445,
0.036714520305395126,
0.0011153311934322119,
0.07599994540214539,
0.04246733710169792,
-0.04283083230257034,
-0.05233088508248329,
-0.019629627466201782,
-0.03701982647180557,
-0.0703003853559494,
0... | {
"azure_component": "network",
"chunk_index": 779,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "551",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
JSON
Votre chaîne de connexion Application Insights s’affiche dans la section Vue d’ensemble de
votre ressource Application Insights.
Utilisez l’enregistreur d’événements gestion des API - Créer ou mettre à jour l’API REST
avec le corps de la requête suivant.
Si vous configurez l’enregistreur d’événements pour un espace de travail, utilisez
l’enregistreur d’événements d’espace de travail - Créer ou mettre à jour l’API REST.
JSON
{
"properties": {
"loggerType": "applicationInsights",
"description": "Application Insights logger with user-assigned managed
identity",
"credentials": {
"connectionString":"InstrumentationKey=00000000-0000-0000-0000-
000000000000;IngestionEndpoint=https://xxxx.applicationinsights.azure.com/;...
",
"identityClientId":"<ClientID>"
}
}
}
Enregistreur d’événements avec des informations
d’identification de chaîne de connexion uniquement
REST API
{
"properties": {
"loggerType": "applicationInsights",
"description": "Application Insights logger with connection string",
"credentials": {
"connectionString":"InstrumentationKey=00000000-0000-0000-0000-
000000000000;IngestionEndpoint=https://xxxx.applicationinsights.azure.com/;...
"
}
}
} | [
-0.002949636895209551,
-0.009525035507977009,
-0.002170146908611059,
-0.03088405542075634,
0.024341370910406113,
0.023572910577058792,
0.08103624731302261,
0.033946678042411804,
-0.05569014698266983,
-0.05776240676641464,
-0.030293447896838188,
-0.05547906458377838,
-0.05927874147891998,
0... | {
"azure_component": "network",
"chunk_index": 780,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "552",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
Utilisez la procédure suivante pour activer la journalisation Application Insights pour une API.
Vous pouvez également activer la journalisation Application Insights pour toutes les API.
1. Accédez à votre instance de service Gestion des API Azure sur le Portail Azure.
2. Sélectionnez API>API dans le menu de gauche.
3. Sélectionnez une API, telle que Swagger Petstore. Si elle est configurée, sélectionnez une
version.
4. Accédez à l’onglet Paramètres de la barre supérieure.
5. Descendez jusqu’à la section Journaux de diagnostic.
6. Cochez la case Activer.
Activer la journalisation Application Insights pour
l’API
Conseil
Pour activer la journalisation pour toutes les API, sélectionnez Toutes les API. | [
-0.02035994827747345,
-0.02639726549386978,
-0.0020792540162801743,
-0.06444858759641647,
0.01035863347351551,
0.03813878819346428,
0.05196109041571617,
0.01139580924063921,
-0.03778443485498428,
-0.053053680807352066,
-0.04057304933667183,
-0.052493080496788025,
-0.04011848196387291,
0.01... | {
"azure_component": "network",
"chunk_index": 781,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "553",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
7. Sélectionnez l’enregistreur d'événements joint dans la liste déroulante Destination.
8. Entrez 100 pour Échantillonnage (%) et sélectionnez la case Toujours consigner les
erreurs.
9. Laissez le reste des paramètres tel quel. Pour plus d’informations sur les paramètres,
consultez Informations de référence sur les paramètres des journaux de diagnostic.
10. Sélectionnez Enregistrer.
11. En coulissez, une entité Diagnostic nommée applicationinsights ’ est créée au niveau de
l’API.
Vous pouvez spécifier des enregistreurs d’événements à des différents niveaux :
Enregistreur d’événements pour une seule API
Enregistreur d’événements pour toutes les API
Spécification des deux :
Par défaut, l’enregistreur d’événements d’une seule API (niveau plus granulaire)
remplacera celui de toutes les API.
Si les enregistreurs d’événements configurés aux deux niveaux sont différents et que vous
avez besoin des deux enregistreurs d’événements pour recevoir des données de
télémétrie (multiplexage), contactez Support Microsoft. Notez que le multiplexage n’est
pas pris en charge si vous utilisez le même enregistreur d’événements (destination
Application Insights) au niveau « Toutes les API » et au niveau de l’API unique. Pour que le
multiplexage fonctionne correctement, vous devez configurer différents enregistreurs
2 Avertissement
Le remplacement de la valeur Nombre d’octets de charge utile à journaliser par
défaut, 0, peut réduire considérablement les performances de vos API.
7 Notes
Les demandes aboutissent une fois que Gestion des API a envoyé l’intégralité de la
réponse au client.
Enregistreurs d’événements pour une seule API ou
toutes les API | [
-0.02059151977300644,
0.008214917033910751,
-0.02331044152379036,
-0.03902526572346687,
0.054172880947589874,
0.08064942061901093,
0.0051061837002635,
0.05049732327461243,
-0.06288197636604309,
-0.04031269624829292,
-0.022946424782276154,
-0.004172138404101133,
-0.04194500669836998,
-0.011... | {
"azure_component": "network",
"chunk_index": 782,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "554",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
d’événements au niveau « Toutes les API » et au niveau de l’API individuelle, et demander
de l’aide du support Microsoft pour activer le multiplexage pour votre service.
Application Insights reçoit :
Élément de
télémétrie
Descriptif
Requête
Pour chaque demande entrante :
Demande du serveur frontal
Réponse du serveur frontal
Dépendance
Pour chaque demande transférée à un service principal :
Demande principale
Réponse principale
Exception
Pour chaque demande ayant échoué :
A échoué en raison d’une interruption de la connexion cliente.
A déclenché une section on-error des stratégies d’API.
A un code d’état HTTP de réponse de type 4xx ou 5xx.
Trace
Si vous configurez une stratégie de trace .
Le paramètre severity de la stratégie trace doit être supérieur ou égal au
paramètre verbosity de journalisation d’Application Insights.
Vous pouvez émettre des métriques personnalisées vers Application Insights à partir de votre
instance Gestion des API. Gestion des API émet des métriques personnalisées à l’aide de
stratégies telles que emit-metric et azure-openai-emit-token-metric. La section suivante utilise
la stratégie emit-metric comme exemple.
Données ajoutées à Application Insights
ノ
Agrandir le tableau
7 Notes
Consultez Limites d’Application Insights pour plus d’informations sur la taille maximale et
le nombre d’événements et de métriques par instance d’Application Insights.
Émettre des métriques personnalisées | [
-0.02645735815167427,
-0.019790545105934143,
-0.011012961156666279,
-0.049856074154376984,
0.020475536584854126,
0.027879098430275917,
0.05789947137236595,
0.030606407672166824,
-0.06385147571563721,
-0.049353502690792084,
-0.025363381952047348,
-0.03876391425728798,
-0.03238481655716896,
... | {
"azure_component": "network",
"chunk_index": 783,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "555",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
Pour émettre des métriques personnalisées, effectuez les étapes de configuration suivantes.
1. Activez Métriques personnalisées (préversion) avec des dimensions personnalisées dans
votre instance Application Insights.
a. Accédez à votre instance Application Insights dans le portail.
b. Dans le menu de gauche, sélectionnez Utilisation et estimation des coûts.
c. Sélectionnez Métriques personnalisées (préversion)>Avec des dimensions.
d. Sélectionnez OK.
2. Ajoutez la propriété "metrics": true à l’entité de diagnostic applicationInsights
configurée dans Gestion des API. Actuellement, vous devez ajouter cette propriété à l’aide
de l’API REST Gestion des API Diagnostic – Créer ou mettre à jour. Par exemple :
HTTP
3. Vérifiez que l’enregistreur d’événements Application Insights est configuré dans l’étendue
vers laquelle vous envisagez d’émettre des métriques personnalisées (soit toutes les API,
soit une seule API). Pour plus d’informations, consultez Activer la journalisation
Application Insights pour votre API, plus haut dans cet article.
4. Configurez la stratégie emit-metric dans une étendue où la journalisation Application
Insights est configurée (toutes les API ou une seule API) et est activée pour les métriques
7 Notes
Les métriques personnalisées sont une fonctionnalité de préversion d’Azure Monitor et
soumises à des limitations.
PUT
https://management.azure.com/subscriptions/{SubscriptionId}/resourceGroups/{R
esourceGroupName}/providers/Microsoft.ApiManagement/service/{APIManagementSer
viceName}/diagnostics/applicationinsights
{
[...]
{
"properties": {
"loggerId":
"/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers
/Microsoft.ApiManagement/service/{APIManagementServiceName}/loggers/{Applicat
ionInsightsLoggerName}",
"metrics": true
[...]
}
} | [
-0.007215719670057297,
-0.015144841745495796,
0.039912983775138855,
-0.04395394027233124,
0.04061116278171539,
0.02691754698753357,
0.05374463275074959,
0.019469128921628,
-0.0353102907538414,
-0.0471070259809494,
-0.029600773006677628,
-0.0363597646355629,
-0.04565907269716263,
-0.0148961... | {
"azure_component": "network",
"chunk_index": 784,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "556",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
personnalisées. Pour plus d’informations sur la stratégie, consultez la référence de
stratégie emit-metric.
Azure Monitor impose des limites d’utilisation pour les métriques personnalisées qui peuvent
affecter votre capacité à émettre des métriques à partir de Gestion des API. Par exemple, Azure
Monitor définit actuellement une limite de 10 clés de dimension par métrique et une limite de
50 000 séries chronologiques actives totales par région dans un abonnement (dans une
période de 12 heures).
Ces limites ont les implications suivantes pour la configuration des métriques personnalisées
dans une stratégie de gestion des API telle que emit-metric ou azure-openai-emit-token-
metric :
Vous pouvez configurer un maximum de 10 dimensions personnalisées par stratégie .
Le nombre de séries chronologiques actives générées par la stratégie dans une période
de 12 heures est le produit du nombre de valeurs uniques de chaque dimension
configurée au cours de la période. Par exemple, si trois dimensions personnalisées ont été
configurées dans la stratégie et que chaque dimension a 10 valeurs possibles au cours de
la période, la stratégie contribuera à 1 000 (10 x 10 x 10) séries chronologiques actives.
Si vous configurez la stratégie dans plusieurs instances Gestion des API qui se trouvent
dans la même région d’un abonnement, toutes les instances peuvent contribuer à la
limite des séries chronologiques actives régionales.
Découvrez-en plus sur les limitations et considérations en matière de conception pour les
métriques personnalisées dans Azure Monitor.
Lors de tests de charge internes, cette fonctionnalité de journalisation a provoqué une baisse
du débit de 40 %-50 % lorsque la fréquence des demandes a dépassé 1 000 par seconde. La
Limites pour les métriques personnalisées
Conséquences sur les performances et
échantillonnage des | [
0.008997838012874126,
-0.03318261355161667,
-0.006937851198017597,
-0.05819917842745781,
0.02826734632253647,
-0.003826959291473031,
0.03139447048306465,
0.02181004174053669,
-0.028476864099502563,
-0.04958610236644745,
0.004002810455858707,
-0.04181920737028122,
-0.06711888313293457,
0.01... | {
"azure_component": "network",
"chunk_index": 785,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "557",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
de conception pour les
métriques personnalisées dans Azure Monitor.
Lors de tests de charge internes, cette fonctionnalité de journalisation a provoqué une baisse
du débit de 40 %-50 % lorsque la fréquence des demandes a dépassé 1 000 par seconde. La
Limites pour les métriques personnalisées
Conséquences sur les performances et
échantillonnage des journaux
2 Avertissement
La journalisation de l’ensemble des événements peut avoir de grosses répercussions sur
les performances en fonction du rythme des demandes entrantes. | [
0.012527591548860073,
-0.021254010498523712,
-0.02044730633497238,
-0.017211981117725372,
0.04756821691989899,
0.006258949637413025,
0.03506173565983772,
0.036068450659513474,
-0.029630716890096664,
-0.008617627434432507,
0.04262625053524971,
0.0017621299484744668,
-0.08737319707870483,
-0... | {
"azure_component": "network",
"chunk_index": 786,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "557",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
fonctionnalité Application Insights est conçue pour évaluer les performances des applications à
l’aide d’une analyse statistique. Elle n’est pas :
conçue pour être un système d’audit.
adaptée à la journalisation de chaque demande d’API de volume important.
Vous pouvez manipuler le nombre de demandes journalisées en réglant le paramètre
Échantillonnage. Une valeur de 100 % signifie que toutes les demandes sont consignées,
tandis que le 0 % indique une absence de journalisation.
L’échantillonnage permet de réduire le volume de télémétrie, ce qui permet de prévenir
efficacement une dégradation significative des performances tout en conservant les avantages
de la journalisation.
Pour améliorer les problèmes de performances, ignorez :
les en-têtes de demande et les réponses ;
la journalisation du corps de demande.
Résolution du problème de flux des données de télémétrie de Gestion des API vers Application
Insights :
Vérifiez si une ressource d’étendue de liaison privée Azure Monitor (Azure Monitor Private
Link Scope/AMPLS) liée existe dans le VNet où la ressource Gestion des API est
connectée. Les ressources AMPLS ont une étendue globale entre les abonnements et sont
responsables de la gestion des requêtes et de l’ingestion de données pour toutes les
ressources Azure Monitor. Il est possible que l’AMPLS ait été configuré avec un mode
d’accès Private-Only spécifiquement pour l’ingestion de données. Dans ce cas, incluez la
ressource Application Insights et sa ressource Log Analytics associée dans l’AMPLS. Une
fois cet ajout effectué, les données Gestion des API sont correctement ingérées dans la
ressource Application Insights, ce qui résout le problème de transmission des données | [
0.01541619747877121,
-0.013350498862564564,
-0.005565618630498648,
-0.047231219708919525,
0.04357554391026497,
0.04352503642439842,
0.06510257720947266,
0.035347066819667816,
-0.03665102273225784,
-0.062203776091337204,
0.024110451340675354,
-0.015616343356668949,
-0.06639806181192398,
0.0... | {
"azure_component": "network",
"chunk_index": 787,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "558",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
possible que l’AMPLS ait été configuré avec un mode
d’accès Private-Only spécifiquement pour l’ingestion de données. Dans ce cas, incluez la
ressource Application Insights et sa ressource Log Analytics associée dans l’AMPLS. Une
fois cet ajout effectué, les données Gestion des API sont correctement ingérées dans la
ressource Application Insights, ce qui résout le problème de transmission des données de
télémétrie.
Vidéo
https://learn-video.azurefd.net/vod/player?id=85acedcd-4200-4788-b7c0-
41a11286fcab&locale=fr-fr&embedUrl=%2Fazure%2Fapi-management%2Fapi-
management-howto-app-insights
Dépannage
Contenu connexe | [
0.021196383982896805,
-0.007275962736457586,
-0.006478438153862953,
0.005365899298340082,
0.05473559722304344,
-0.005839142948389053,
0.08138952404260635,
0.034280043095350266,
-0.009938039816915989,
-0.05868595093488693,
0.017421269789338112,
0.00919723603874445,
-0.0665673017501831,
0.03... | {
"azure_component": "network",
"chunk_index": 788,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "558",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
Découvrez plus en détail Azure Application Insights.
Étudiez la possibilité de journalisation avec Azure Event Hubs.
Découvrir comment visualiser des données à partir d’Application Insights avec Azure
Managed Grafana | [
-0.016591913998126984,
-0.020477445796132088,
0.012790576554834843,
-0.014489995315670967,
0.04234800860285759,
0.015208038501441479,
0.04767412692308426,
0.05454838275909424,
-0.03970634937286377,
-0.04942282289266586,
-0.0013142440002411604,
-0.06075632944703102,
-0.0653015524148941,
0.0... | {
"azure_component": "network",
"chunk_index": 789,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "559",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
Ajouter manuellement une API
06/06/2025
S’APPLIQUE À : Tous les niveaux de Gestion des API
Cet article explique comment ajouter manuellement une API à Gestion des API Azure. Lorsque
vous souhaitez créer des réponses fictives à partir de l’API, vous pouvez créer une API vide.
Pour plus d’informations sur la création de réponses d’API fictifs, consultez Réponses d’API
fictifs.
Si vous souhaitez importer une API existante, consultez la section Contenu associé de cet
article.
Dans cet article, vous allez apprendre à créer une API vide. Vous spécifiez httpbin.org
(un
service de test public) en tant qu’API principale.
Suivez le guide de démarrage rapide Créer une instance du service Gestion des API Azure.
1. Dans le portail
Azure, recherchez et sélectionnez Services de gestion des API :
Prérequis
Accéder à votre instance Gestion des API
| [
0.013422437012195587,
-0.020053816959261894,
-0.014116132631897926,
-0.0037337299436330795,
0.011432322673499584,
0.021011266857385635,
0.02585451304912567,
0.05473247542977333,
-0.05562061443924904,
-0.033115554600954056,
-0.023883091285824776,
-0.054580364376306534,
-0.05964274704456329,
... | {
"azure_component": "network",
"chunk_index": 790,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "560",
"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 :
1. Sous API dans le menu de gauche, sélectionnez API.
2. Sélectionnez + Ajouter API.
3. Sélectionnez la vignette HTTP :
4. Entrez l’URL du service web principal (par exemple) https://httpbin.org et d’autres
paramètres pour l’API. Les paramètres sont expliqués dans le tutoriel Importer et publier
votre première API.
5. Sélectionnez Create (Créer).
À ce stade, vous ne disposez d’aucune opération dans Gestion des API qui correspond aux
opérations dans votre API de serveur principal. Si vous appelez une opération exposée via le
serveur principal, mais pas par le biais de gestion des API, vous obtenez une erreur 404.
Création d'une API
7 Notes | [
-0.024883871898055077,
-0.015493420884013176,
-0.010870473459362984,
-0.018038548529148102,
0.006671881303191185,
0.029164737090468407,
0.011975092813372612,
0.03313438966870308,
-0.05735831707715988,
-0.06066397204995155,
-0.06225284934043884,
-0.029698539525270462,
-0.04408418759703636,
... | {
"azure_component": "network",
"chunk_index": 791,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "561",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
Cette section montre comment ajouter une /get opération pour la mapper à l’opération back-
end http://httpbin.org/get .
1. Sélectionnez l’API que vous avez créée à l’étape précédente.
2. Sélectionnez + Ajouter une opération.
3. Dans l’URL, sélectionnez GET et entrez /get dans la zone de texte.
4. Dans le nom d’affichage, entrez FetchData.
5. Sélectionnez Enregistrer.
Testez l’opération dans le portail Azure. (Vous pouvez également le tester dans le portail des
développeurs.)
1. Sélectionnez l’onglet Test.
2. Sélectionnez FetchData.
3. Sélectionnez Envoyer.
La réponse générée par l’opération http://httpbin.org/get s’affiche dans la section réponse
HTTP . Si vous souhaitez transformer vos opérations, consultez Transform and protect your API
(Transformer et protéger votre API).
Cette section montre comment ajouter une opération qui accepte un paramètre. Dans cet
exemple, vous mappez l’opération à http://httpbin.org/status/200 .
1. Sélectionnez l’API que vous avez créée précédemment.
Par défaut, lorsque vous ajoutez une API, même si elle est connectée à un service
principal, gestion des API n’expose aucune opération tant que vous ne les autorisez pas.
Pour autoriser une opération de votre service de serveur principal, créez une opération
APIM Management qui correspond à l’opération de serveur principal.
Ajouter et tester une opération
Ajout d’une opération
Tester l’opération
Ajouter et tester une opération paramétrable
Ajout d’une opération | [
-0.016581417992711067,
-0.05091319605708122,
-0.012678911909461021,
-0.04858161136507988,
0.05073925107717514,
0.021109577268362045,
0.038050342351198196,
0.04819173738360405,
-0.04154686629772186,
-0.05169812589883804,
-0.0478212907910347,
-0.01783437281847,
-0.07365953177213669,
0.002078... | {
"azure_component": "network",
"chunk_index": 792,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "562",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
2. Sous l’onglet Création, sélectionnez + Ajouter une opération.
3. Dans l’URL, sélectionnez GET et entrez /status/{code} dans la zone de texte.
4. Dans le nom d’affichage, entrez GetStatus.
5. Sélectionnez Enregistrer.
Testez l’opération dans le portail Azure. (Vous pouvez également le tester dans le portail des
développeurs.)
1. Sélectionnez l’onglet Test.
2. Sélectionnez GetStatus. Dans le code, entrez 200.
3. Sélectionnez Envoyer.
La réponse générée par l’opération http://httpbin.org/status/200 s’affiche dans la
section réponse HTTP . Si vous souhaitez transformer vos opérations, consultez Transform
and protect your API (Transformer et protéger votre API).
Cette section montre comment ajouter une opération générique. Une opération générique
vous permet de transmettre une valeur arbitraire à une demande d’API. Au lieu de créer des
opérations GET distinctes comme indiqué dans les sections précédentes, vous pouvez créer
une opération GET générique.
1. Sélectionnez l’API que vous avez créée précédemment.
2. Sous l’onglet Création, sélectionnez + Ajouter une opération.
3. Dans l’URL, sélectionnez GET et entrez /* dans la zone de texte.
4. Dans le nom d’affichage, entrez WildcardGet.
5. Sélectionnez Enregistrer.
Tester l’opération
Ajouter et tester une opération générique
U Attention
Soyez prudent quand vous configurez une opération à caractère générique. Cette
configuration peut rendre une API plus vulnérable à certaines menaces de sécurité d’API.
Ajout d’une opération | [
0.0014368718257173896,
-0.033226870000362396,
-0.01003759540617466,
-0.025003600865602493,
0.05024950951337814,
0.030487259849905968,
0.029434774070978165,
0.057696633040905,
-0.024972865357995033,
-0.0673636719584465,
-0.04316958412528038,
0.006832512561231852,
-0.07018221914768219,
0.001... | {
"azure_component": "network",
"chunk_index": 793,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "563",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
Testez l’opération dans le portail Azure. (Vous pouvez également le tester dans le portail des
développeurs.)
1. Sélectionnez l’onglet Test.
2. Sélectionnez WildcardGet. Essayez les opérations GET que vous avez testées dans les
sections précédentes ou essayez une autre opération GET prise en charge.
Par exemple, dans les paramètres de modèle, modifiez la valeur à côté du nom générique
(*) en en-têtes. L’opération retourne les en-têtes HTTP de la requête entrante.
3. Sélectionnez Envoyer.
La réponse générée par l’opération http://httpbin.org/headers s’affiche dans la section
réponse HTTP . Si vous souhaitez transformer vos opérations, consultez Transform and
protect your API (Transformer et protéger votre API).
Vous pouvez composer une API à partir d'API exposées par différents services, notamment :
Une spécification OpenAPI
Une API SOAP
Une API GraphQL
Une application Web hébergée dans Azure App Service
Les fonctions Azure
Azure Logic Apps
Azure Service Fabric
Pour ajouter une API à une API existante :
Tester l’opération
7 Notes
Il peut être important de comprendre comment l’hôte de l’API back-end que vous
intégrez gère les barres obliques de fin sur une URL d’opération. Pour plus d’informations,
consultez ces questions fréquentes sur la gestion des API.
Ajouter d’autres API
7 Notes
Lorsque vous importez une API, les opérations sont ajoutées à votre API actuelle. | [
0.00896463729441166,
-0.025598539039492607,
-0.005261051002889872,
-0.00337735703215003,
0.03450987860560417,
0.023004593327641487,
0.03585667908191681,
0.060711704194545746,
-0.027461949735879898,
-0.05657551437616348,
-0.023490436375141144,
-0.02184274233877659,
-0.08257140219211578,
-0.... | {
"azure_component": "network",
"chunk_index": 794,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "564",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
1. Accédez à votre instance Azure API Management dans le Portail Microsoft Azure :
2. Sélectionnez APIs dans la page Vue d’ensemble, ou sélectionnez APIs>APIs dans le menu
de gauche.
3. Sélectionnez les points de suspension (...) à côté de l’API à laquelle vous souhaitez ajouter
une autre API.
4. Sélectionnez Importer dans le menu déroulant :
| [
-0.0233140978962183,
-0.007377177942544222,
-0.025354987010359764,
-0.014338984154164791,
0.014966608956456184,
0.032439589500427246,
0.006040406879037619,
0.04030201584100723,
-0.050816237926483154,
-0.07478892803192139,
-0.03129779174923897,
0.006532813422381878,
-0.04627811163663864,
0.... | {
"azure_component": "network",
"chunk_index": 795,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "565",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
5. Sélectionnez un service à partir duquel importer une API.
Limitations de l’importation d’API
Importer une spécification OpenAPI
Importer une API SOAP
Importer une API SOAP et la convertir en REST
Importer une API App Service
Importer une API d’application conteneur
Importer une API WebSocket
Importer une API GraphQL
Importer un schéma GraphQL et configurer des résolveurs de champs
Importer une API d’application de fonction
Importer une API d’application logique
Importer un service Service Fabric
Importer une API Azure AI Foundry
Importer une API Azure OpenAI
Importer une API LLM
Importer une API OData
Importer des métadonnées OData de SAP
Importer une API gRPC
Modifier une API
Contenu connexe | [
-0.039861153811216354,
-0.023109612986445427,
-0.039136309176683426,
0.007683177944272757,
0.0355316624045372,
0.060695748776197433,
0.03525005653500557,
0.04670119658112526,
-0.02431441657245159,
-0.06543462723493576,
-0.014730089344084263,
-0.04503382369875908,
-0.07620403170585632,
0.01... | {
"azure_component": "network",
"chunk_index": 796,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "566",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
Importer une spécification OpenAPI
02/06/2025
S’APPLIQUE À : Tous les niveaux de Gestion des API
Cet article comment importer une API back-end ayant une « spécification OpenAPI » dans
Gestion des API Azure en utilisant différents outils. Il explique également comment tester l’API
dans Gestion des API.
Dans cet article, vous apprendrez comment :
Une instance APIM. Si vous n’avez pas encore d’instance Gestion des API Azure, suivez ce
guide de démarrage rapide : Créer une instance Gestion des API Azure.
Azure CLI (Interface de ligne de commande Azure)
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.
Importez une spécification OpenAPI à l’aide du Portail Azure, d’Azure CLI ou de Azure
PowerShell.
"
Tester l’API dans le portail Azure
"
7 Notes
Les limitations d’importation d’API sont documentées dans les restrictions d’importation
d’API et les problèmes connus.
Prérequis | [
-0.04655781015753746,
0.019098274409770966,
-0.011216729879379272,
-0.02257637493312359,
0.05158346891403198,
0.040964432060718536,
0.022236591205000877,
0.05267547816038132,
-0.012777013704180717,
-0.03471973538398743,
-0.014365213923156261,
-0.04277448356151581,
-0.06888215243816376,
0.0... | {
"azure_component": "network",
"chunk_index": 797,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "567",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
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.
Azure PowerShell
Si vous choisissez d’utiliser Azure PowerShell localement :
Installez la dernière version du module Az PowerShell.
Connectez-vous à votre compte Azure à l’aide de la cmdlet Connect-AzAccount.
Si vous choisissez d’utiliser Azure Cloud Shell :
Pour plus d’informations, consultez Vue d’ensemble d’Azure Cloud Shell.
Pour cet exemple, vous importez la spécification OpenAPI
pour l’API Petstore
open source,
mais vous pouvez la remplacer par une spécification OpenAPI de votre choix.
1. Dans le portail Azure
, accédez à votre instance APIM.
2. Dans le menu de gauche, cliquez sur API > + Ajouter une API.
3. Sous Créer à partir d’une définition, sélectionnez OpenAPI.
4. Entrez les paramètres de l’API. Vous pouvez définir les valeurs lors de la création, ou
les configurer ultérieurement en accédant à l’onglet Paramètres. Les paramètres sont
expliqués dans le tutoriel Importer et publier votre première API.
Importer une API back-end
Portail | [
-0.019351083785295486,
0.009803324937820435,
-0.020680448040366173,
-0.010908737778663635,
0.07180871069431305,
0.04524882882833481,
0.027204042300581932,
0.05065632611513138,
-0.005749506410211325,
-0.026972586289048195,
-0.0515141487121582,
-0.007084088400006294,
-0.05978652462363243,
0.... | {
"azure_component": "network",
"chunk_index": 798,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "568",
"source_file": "API_Management.pdf",
"total_pages": 1973
} |
5. Sélectionnez Create (Créer).
Dans le portail, utilisez l’éditeur de spécification OpenAPI pour visualiser, valider ou modifier la
spécification pour l’API que vous avez importée.
Pour utiliser l’éditeur de spécification OpenAPI :
1. Dans le portail Azure, accédez à votre instance APIM.
2. Dans le menu de gauche, sous API, sélectionnez API><votre API>>Toutes les
opérations.
3. Sous l’onglet Conception, dans Front-end, sélectionnez Éditeur de spécification OpenAPI
(l’icône de crayon). Vous pouvez ouvrir la spécification au format JSON ou YAML.
4. Passez en revue ou modifiez la spécification si nécessaire. Enregistrez les changements
apportés.
Vous pouvez configurer la stratégies de validation Gestion des API pour valider les requêtes et
réponses (ou leurs éléments) par rapport au schéma dans une spécification OpenAPI. Par
exemple, utilisez la stratégie validate-content pour valider la taille ou le contenu d’une
requête//du corps d’une réponse.
Les opérations peuvent être appelées directement à partir du portail, ce qui permet d’afficher
et de tester facilement les opérations d’une API.
1. Sélectionnez l’API que vous avez créée à l’étape précédente.
2. Sélectionnez l’onglet Test.
3. Sélectionnez une opération. La page affiche des champs pour les paramètres de requête
et des champs pour les en-têtes.
Visualiser et modifier une spécification OpenAPI
Valider relativement à un schéma de spécification
OpenAPI
Tester la nouvelle API dans le portail
7 Notes | [
0.0008585127652622759,
0.003299749456346035,
-0.0010394828859716654,
-0.028821853920817375,
0.05642767250537872,
0.05027257278561592,
-0.003580822143703699,
0.04125264659523964,
-0.027184270322322845,
-0.060349948704242706,
-0.03450457379221916,
-0.022453220561146736,
-0.07682663947343826,
... | {
"azure_component": "network",
"chunk_index": 799,
"contains_sku": false,
"document_title": "Api_Management",
"file_path": "./azure_docs\\API_Management.pdf",
"is_summary": false,
"service_name": "API Management",
"source": "569",
"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.