Partager via

Gestion directe Gestion des API API REST

  • Article

Azure Gestion des API fournit une API REST de gestion directe pour effectuer des opérations sur des entités sélectionnées, telles que des utilisateurs, des groupes, des produits et des abonnements. L’API de gestion directe peut contourner certaines limites de l’API azure Resource Manager, telles que la limitation des requêtes.

Important

Cette section explique comment accéder à la gestion directe Gestion des API’API REST. Cette API a un mécanisme d’authentification différent d’Azure Resource Manager et utilise une URL de base différente.

Activer l’accès à l’API REST de gestion directe

L’accès à la gestion directe Gestion des API’API REST doit être accordé pour que les appels puissent être effectués avec succès.

  1. Accédez à votre instance Gestion des API Azure dans le portail Azure.

  2. Sélectionnez API de gestion dans la section Déploiement + infrastructure du menu de gauche.

    Sélectionnez API de gestion dans le Portail Azure

  3. Dans Activer Gestion des API’API REST, sélectionnez Oui.

    Important

    Si l’option Activer Gestion des API’API REST n’est pas sélectionnée, les appels effectués à l’API REST pour ce service instance échouent.

    Activer Gestion des API API dans le Portail Azure

Type de support par défaut

Le type de support par défaut pour les demandes et les réponses est application/json. Là où cela est indiqué, certaines opérations prennent en charge d'autres types de contenu. Si aucun autre type de contenu n'est mentionné pour une opération spécifique, le type de support est application/json.

Authentification

Chaque requête adressée à l’API REST Gestion des API doit être accompagnée d’un Authorization en-tête contenant un jeton d’accès partagé valide, comme illustré dans l’exemple suivant.

Authorization: SharedAccessSignature uid=53dd860e1b72ff0467030003&ex=2014-08-04T22:03:00.0000000Z&sn=ItH6scUyCazNKHULKA0Yv6T+Skk4bdVmLqcPPPdWoxl2n1+rVbhKlplFrqjkoUFRr0og4wjeDz4yfThC82OjfQ==

Ce jeton d'accès peut être généré par programmation ou à partir du portail de publication de Gestion des API. Pour obtenir des instructions sur la génération et la récupération du jeton d’accès, consultez Pour créer manuellement un jeton d’accès et Pour créer un jeton d’accès par programmation.

URL de base

L’URL de base de l’API REST de gestion directe Gestion des API est conforme au modèle suivant.

https://{servicename}.management.azure-api.net

Ce modèle contient le paramètre suivant.

  • {serviceName} est le nom du service tel qu’il a été spécifié lors de la création du service, par exemple https://contosoapi.management.azure-api.net.

Toutes les URL retournées par l’API REST Gestion des API sont relatives à cette URL de base, et toutes les requêtes adressées à l’API REST doivent utiliser ce modèle d’URL de base.

Paramètre de requête de version

Toutes les opérations attendent un paramètre de requête api-version avec une valeur au format YYYY-MM-DD, par exemple 2021-08-01.

Notes

Pendant une période de préversion pour une API REST Gestion des API, -preview est ajouté au paramètre de requête de version, par exemple 2021-04-01-preview.

Si ce paramètre de requête n’est pas passé dans la chaîne de requête d’une requête, le serveur retourne un code status de 400 Bad Request. Pour obtenir la liste des versions prises en charge, consultez Gestion des API informations de référence sur l’API REST.

Étapes suivantes