通过

你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Export-AzApiManagementApi

  • 参考
模块:
Az.ApiManagement

将 API 导出到文件。

语法

Export-AzApiManagementApi
      -Context <PsApiManagementContext>
      -ApiId <String>
      [-ApiRevision <String>]
      -SpecificationFormat <PsApiManagementApiFormat>
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Export-AzApiManagementApi
      -Context <PsApiManagementContext>
      -ApiId <String>
      [-ApiRevision <String>]
      -SpecificationFormat <PsApiManagementApiFormat>
      -SaveAs <String>
      [-Force]
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

说明

Export-AzApiManagementApi cmdlet 将 Azure API 管理 API 导出到支持格式之一的文件。

示例

示例 1：以 Web 应用程序描述语言（WADL）格式导出 API

$ApiMgmtContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Export-AzApiManagementApi -Context $ApiMgmtContext -ApiId "0123456789" -SpecificationFormat "Wadl" -SaveAs "C:\contoso\specifications\0123456789.wadl"

此命令将 API 导出到 WADL 文件。

示例 2：将 OpenApi 3.0 规范格式中的 API 导出为 Json 文档

$ApiMgmtContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Export-AzApiManagementApi -Context $ApiMgmtContext -ApiId swagger-petstore -SpecificationFormat OpenApiJson -SaveAs D:\github\petstore.json

此命令将 Open Api 格式的 API 定义导出为 Json 文档

参数

-ApiId

指定要导出的 API 的 ID。

类型:String
Position:Named
默认值:None
必需:True
接受管道输入:True
接受通配符:False

-ApiRevision

API 修订的标识符。 此参数是可选的。 如果未指定，则导出将针对当前活动 API 修订完成。

类型:String
Position:Named
默认值:None
必需:False
接受管道输入:True
接受通配符:False

-Confirm

提示你在运行 cmdlet 之前进行确认。

类型:SwitchParameter
别名:cf
Position:Named
默认值:False
必需:False
接受管道输入:False
接受通配符:False

-Context

指定 PsApiManagementContext 对象。

类型:PsApiManagementContext
Position:Named
默认值:None
必需:True
接受管道输入:True
接受通配符:False

-DefaultProfile

用于与 Azure 通信的凭据、帐户、租户和订阅。

类型:IAzureContextContainer
别名:AzContext, AzureRmContext, AzureCredential
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-Force

指示此操作覆盖同名文件（如果已存在）。

类型:SwitchParameter
Position:Named
默认值:None
必需:False
接受管道输入:True
接受通配符:False

-PassThru

指示如果成功导出 API 或$False，此操作将返回$True。

类型:SwitchParameter
Position:Named
默认值:None
必需:False
接受管道输入:True
接受通配符:False

-SaveAs

指定要将导出的 API 保存到的文件路径。

类型:String
Position:Named
默认值:None
必需:True
接受管道输入:True
接受通配符:False

-SpecificationFormat

指定 API 格式。 psdx_paramvalues Wadl、Wsdl、Swagger、OpenApi 和 OpenApiJson

类型:PsApiManagementApiFormat
接受的值:Wadl, Swagger, Wsdl, OpenApi, OpenApiJson
Position:Named
默认值:None
必需:True
接受管道输入:True
接受通配符:False

-WhatIf

显示运行该 cmdlet 时会发生什么情况。 cmdlet 未运行。

类型:SwitchParameter
别名:wi
Position:Named
默认值:False
必需:False
接受管道输入:False
接受通配符:False

输入

PsApiManagementContext

String

PsApiManagementApiFormat

SwitchParameter

输出

String