你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
Import-AzureRmApiManagementApi
从文件或 URL 导入 API。
警告
截至 2024 年 2 月 29 日，AzureRM PowerShell 模块已正式弃用。 为了确保持续获得支持和更新，建议用户从 AzureRM 迁移到 Az PowerShell 模块。
尽管 AzureRM 模块仍可能正常运行，但它不再维护或受支持，但会根据用户的自由裁量权和风险继续使用任何继续使用模块。 有关过渡到 Az 模块的指导，请参阅我们的迁移资源。
语法
Import-AzureRmApiManagementApi
-Context <PsApiManagementContext>
[-ApiId <String>]
[-ApiRevision <String>]
-SpecificationFormat <PsApiManagementApiFormat>
-SpecificationPath <String>
[-Path <String>]
[-WsdlServiceName <String>]
[-WsdlEndpointName <String>]
[-ApiType <PsApiManagementApiType>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] Import-AzureRmApiManagementApi
-Context <PsApiManagementContext>
[-ApiId <String>]
[-ApiRevision <String>]
-SpecificationFormat <PsApiManagementApiFormat>
-SpecificationUrl <String>
[-Path <String>]
[-WsdlServiceName <String>]
[-WsdlEndpointName <String>]
[-ApiType <PsApiManagementApiType>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] 说明
Import-AzureRmApiManagementApi cmdlet 从 Web 应用程序描述语言（WADL）、Web 服务描述语言（WSDL）或 Swagger 格式的文件或 URL 导入 Azure API 管理 API。
示例
示例 1 从 WADL 文件导入 API
PS C:\>$ApiMgmtContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
PS C:\>Import-AzureRmApiManagementApi -Context $ApiMgmtContext -SpecificationFormat "Wadl" -SpecificationPath "C:\contoso\specifications\echoapi.wadl" -Path "apis"此命令从指定的 WADL 文件导入 API。
示例 2 从 Swagger 文件导入 API
PS C:\>$ApiMgmtContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
PS C:\>Import-AzureRmApiManagementApi -Context $ApiMgmtContext -SpecificationFormat "Swagger" -SpecificationPath "C:\contoso\specifications\echoapi.swagger" -Path "apis"此命令从指定的 Swagger 文件导入 API。
示例 3：从 WADL 链接导入 API
PS C:\>$ApiMgmtContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
PS C:\>Import-AzureRmApiManagementApi -Context $ApiMgmtContext -SpecificationFormat "Wadl" -SpecificationUrl "http://contoso.com/specifications/wadl/echoapi" -Path "apis"此命令从指定的 WADL 链接导入 API。
参数
-ApiId
指定要导入的 API 的 ID。 如果未指定此参数，则会为你生成 ID。
| 类型: | String |
| Position: | Named |
| 默认值: | None |
| 必需: | False |
| 接受管道输入: | True |
| 接受通配符: | False |
-ApiRevision
API 修订的标识符。 此参数是可选的。 如果未指定，则导入操作将在当前活动修订或新 API 上完成。
| 类型: | String |
| Position: | Named |
| 默认值: | None |
| 必需: | False |
| 接受管道输入: | True |
| 接受通配符: | False |
-ApiType
此参数是可选的，默认值为 Http。 仅当导入 WSDL 并创建 SOAP 直通 API 时，Soap 选项才适用。
| 类型: | Nullable<T>[PsApiManagementApiType] |
| 接受的值: | Http, Soap |
| Position: | Named |
| 默认值: | None |
| 必需: | False |
| 接受管道输入: | True |
| 接受通配符: | False |
-Context
指定 PsApiManagementContext 对象。
| 类型: | PsApiManagementContext |
| Position: | Named |
| 默认值: | None |
| 必需: | True |
| 接受管道输入: | True |
| 接受通配符: | False |
-DefaultProfile
用于与 Azure 通信的凭据、帐户、租户和订阅。
| 类型: | IAzureContextContainer |
| 别名: | AzureRmContext, AzureCredential |
| Position: | Named |
| 默认值: | None |
| 必需: | False |
| 接受管道输入: | False |
| 接受通配符: | False |
-Path
将 Web API 路径指定为 API 公共 URL 的最后一部分。 API 使用者使用此 URL 向 Web 服务发送请求。 长度必须为 1 到 400 个字符。 默认值为$Null。
| 类型: | String |
| Position: | Named |
| 默认值: | None |
| 必需: | False |
| 接受管道输入: | True |
| 接受通配符: | False |
-SpecificationFormat
指定规范格式。 psdx_paramvalues Wadl、Wsdl 和 Swagger。
| 类型: | PsApiManagementApiFormat |
| 接受的值: | Wadl, Swagger, Wsdl |
| Position: | Named |
| 默认值: | None |
| 必需: | True |
| 接受管道输入: | True |
| 接受通配符: | False |
-SpecificationPath
指定规范文件路径。
| 类型: | String |
| Position: | Named |
| 默认值: | None |
| 必需: | True |
| 接受管道输入: | True |
| 接受通配符: | False |
-SpecificationUrl
指定规范 URL。
| 类型: | String |
| Position: | Named |
| 默认值: | None |
| 必需: | True |
| 接受管道输入: | True |
| 接受通配符: | False |
-WsdlEndpointName
要导入的 WSDL 终结点（端口）的本地名称。 长度必须为 1 到 400 个字符。 此参数是可选的，仅导入 Wsdl 所必需的。 默认值为$null。
| 类型: | String |
| Position: | Named |
| 默认值: | None |
| 必需: | False |
| 接受管道输入: | True |
| 接受通配符: | False |
-WsdlServiceName
要导入的 WSDL 服务的本地名称。 长度必须为 1 到 400 个字符。 此参数是可选的，仅导入 Wsdl 时是必需的。 默认值为$null。
| 类型: | String |
| Position: | Named |
| 默认值: | None |
| 必需: | False |
| 接受管道输入: | True |
| 接受通配符: | False |
输入
Nullable<T>[[Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementApiType, Microsoft.Azure.Commands.ApiManagement.ServiceManagement, Version=6.1.0.0, Culture=neutral, PublicKeyToken=null]]