Export-AzApiManagementApi
Exporte une API dans un fichier.
Syntaxe
ExportToPipeline (Par défaut)
Export-AzApiManagementApi
-Context <PsApiManagementContext>
-ApiId <String>
-SpecificationFormat <PsApiManagementApiFormat>
[-ApiRevision <String>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ExportToFile
Export-AzApiManagementApi
-Context <PsApiManagementContext>
-ApiId <String>
-SpecificationFormat <PsApiManagementApiFormat>
-SaveAs <String>
[-ApiRevision <String>]
[-Force]
[-PassThru]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
L’applet de commande Export-AzApiManagementApi exporte une API Gestion des API Azure vers un fichier dans l’un des formats pris en charge.
Exemples
$ApiMgmtContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Export-AzApiManagementApi -Context $ApiMgmtContext -ApiId "0123456789" -SpecificationFormat "Wadl" -SaveAs "C:\contoso\specifications\0123456789.wadl"
Cette commande exporte une API vers un fichier WADL.
$ApiMgmtContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Export-AzApiManagementApi -Context $ApiMgmtContext -ApiId swagger-petstore -SpecificationFormat OpenApiJson -SaveAs D:\github\petstore.json
Cette commande exporte des définitions d’API au format Open Api en tant que document Json
Paramètres
-ApiId
Spécifie l’ID de l’API à exporter.
Propriétés du paramètre
Type: String
Valeur par défaut: None Prend en charge les caractères génériques: False DontShow: False
Jeux de paramètres
(All)
Position: Named Obligatoire: True Valeur du pipeline: False Valeur du pipeline par nom de propriété: True Valeur des arguments restants: False
-ApiRevision
Identificateur de révision de l’API. Ce paramètre est facultatif. S’il n’est pas spécifié, l’exportation est effectuée pour la révision de l’API actuellement active.
Propriétés du paramètre
Type: String
Valeur par défaut: None Prend en charge les caractères génériques: False DontShow: False
Jeux de paramètres
(All)
Position: Named Obligatoire: False Valeur du pipeline: False Valeur du pipeline par nom de propriété: True Valeur des arguments restants: False
-Confirm
Vous invite à confirmer avant d’exécuter l’applet de commande.
Propriétés du paramètre
Type: SwitchParameter
Valeur par défaut: False Prend en charge les caractères génériques: False DontShow: False Alias: cf
Jeux de paramètres
(All)
Position: Named Obligatoire: False Valeur du pipeline: False Valeur du pipeline par nom de propriété: False Valeur des arguments restants: False
-Context
Spécifie un objet PsApiManagementContext .
Propriétés du paramètre
Type: PsApiManagementContext
Valeur par défaut: None Prend en charge les caractères génériques: False DontShow: False
Jeux de paramètres
(All)
Position: Named Obligatoire: True Valeur du pipeline: False Valeur du pipeline par nom de propriété: True Valeur des arguments restants: False
-DefaultProfile
Informations d’identification, compte, locataire et abonnement utilisés pour la communication avec Azure.
Propriétés du paramètre
Type: IAzureContextContainer
Valeur par défaut: None Prend en charge les caractères génériques: False DontShow: False Alias: AzContext, AzureRmContext, AzureCredential
Jeux de paramètres
(All)
Position: Named Obligatoire: False Valeur du pipeline: False Valeur du pipeline par nom de propriété: False Valeur des arguments restants: False
-Force
Indique que cette opération remplace le fichier du même nom s’il existe déjà.
Propriétés du paramètre
Type: SwitchParameter
Valeur par défaut: None Prend en charge les caractères génériques: False DontShow: False
Jeux de paramètres
ExportToFile
Position: Named Obligatoire: False Valeur du pipeline: False Valeur du pipeline par nom de propriété: True Valeur des arguments restants: False
-PassThru
Indique que cette opération retourne $True si l’API est exportée correctement ou $False sinon.
Propriétés du paramètre
Type: SwitchParameter
Valeur par défaut: None Prend en charge les caractères génériques: False DontShow: False
Jeux de paramètres
ExportToFile
Position: Named Obligatoire: False Valeur du pipeline: False Valeur du pipeline par nom de propriété: True Valeur des arguments restants: False
-SaveAs
Spécifie le chemin d’accès au fichier dans lequel enregistrer l’API exportée.
Propriétés du paramètre
Type: String
Valeur par défaut: None Prend en charge les caractères génériques: False DontShow: False
Jeux de paramètres
ExportToFile
Position: Named Obligatoire: True Valeur du pipeline: False Valeur du pipeline par nom de propriété: True Valeur des arguments restants: False
Spécifie le format d’API.
psdx_paramvalues Wadl, Wsdl, Swagger, OpenApi et OpenApiJson
Type: PsApiManagementApiFormat
Valeur par défaut: None Valeurs acceptées: Wadl, Swagger, Wsdl, OpenApi, OpenApiJson Prend en charge les caractères génériques: False DontShow: False
(All)
Position: Named Obligatoire: True Valeur du pipeline: False Valeur du pipeline par nom de propriété: True Valeur des arguments restants: False
-WhatIf
Affiche ce qui se passerait si l’applet de commande s’exécute.
L’applet de commande ne s’exécute pas.
Propriétés du paramètre
Type: SwitchParameter
Valeur par défaut: False Prend en charge les caractères génériques: False DontShow: False Alias: Wi
Jeux de paramètres
(All)
Position: Named Obligatoire: False Valeur du pipeline: False Valeur du pipeline par nom de propriété: False Valeur des arguments restants: False
CommonParameters
Cette applet de commande prend en charge les paramètres courants : -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction et -WarningVariable. Pour plus d’informations, consultez about_CommonParameters .
Sorties