Importez votre définition d'API dans Azure API Management.
Avant de commencer
- Vous avez accès à Azure API Management.
- Vous avez installé Microsoft PowerShell. Pour plus d'informations, consultez la documentation Microsoft PowerShell (en anglais).
- Vous avez installé le module Azure PowerShell. Pour plus d'informations, consultez la documentation Microsoft Azure (en anglais).
- Vous avez exporté votre définition d'API.
Procédure
-
Ouvrez votre invite de commande.
-
Pour éviter de configurer le contexte dans chaque commande, vous pouvez l'ajouter en tant que variable en exécutant la commande suivante :
$ApiMgmtContext = New-AzApiManagementContext -ResourceGroupName "{ResourceGroupName}" -ServiceName "{ServiceName}"
| Paramètre |
Description |
{ResourceGroupName} |
Groupe de ressources associé au service. Il peut être trouvé sur le portail Microsoft Azure. |
{ServiceName} |
Nom du service. Il peut être trouvé sur le portail Microsoft Azure. |
-
Entrez la commande suivante afin de charger le fichier :
Import-AzApiManagementApi -Context $ApiMgmtContext -SpecificationFormat "{format}" -SpecificationPath "{yourfile}" -Path "{api-url-suffix}"
-
Ajoutez les paramètres adéquats :
| Paramètre |
Description |
{format} |
Format de la définition d'API à importer. La valeur peut être :
-
Swagger (recommandé)
-
Wadl
-
Wsdl
-
OpenApi
|
{yourfile} |
Chemin et nom du fichier de la définition d'API exportée. |
{api-url-suffix} |
Chemin d'accès à l'API Web à ajouter à la fin de l'URL publique de votre API. |
Résultats
Votre API est exportée et l'invite de commande retourne des informations sur l'API, comme son ID, qui peut-être utilisée pour mettre à jour la définition. Vous pouvez vérifier votre définition d'API sur le portail Azure.
Pour plus d'informations concernant la commande Import-AzApiManagementApi, consultez la documentation Azure (en anglais).
