由于 Az PowerShell 模块现在已具有 AzureRM PowerShell 模块的所有功能及更多功能,因此我们将于 2024 年 2 月 29 日停用 AzureRM PowerShell 模块。

若要避免服务中断,请 更新脚本 ,在 2024 年 2 月 29 日结束之前将使用 AzureRM PowerShell 模块的脚本更新为使用 Az PowerShell 模块。 若要自动更新脚本,请按照 快速入门指南 操作。

[-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。

Type: String Position:Named Default value:None Accept pipeline input:True Accept wildcard characters:False

-ApiRevision

API 修订的标识符。 此参数是可选的。 如果未指定,则导入将完成当前活动修订版或新 API。

Type: String Position:Named Default value:None Accept pipeline input:True Accept wildcard characters:False

-ApiType

此参数是可选的,默认值为 Http。 Soap 选项仅在导入 WSDL 时适用,并且将创建 SOAP 直通 API。

Type: Nullable<T> [ PsApiManagementApiType ] Accepted values:Http, Soap Position:Named Default value:None Accept pipeline input:True Accept wildcard characters:False

-Context

指定 PsApiManagementContext 对象。

Type: PsApiManagementContext Position:Named Default value:None Accept pipeline input:True Accept wildcard characters:False

-DefaultProfile

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

Type: IAzureContextContainer Aliases:AzureRmContext, AzureCredential Position:Named Default value:None Accept pipeline input:False Accept wildcard characters:False

-Path

将 Web API 路径指定为 API 公共 URL 的最后一部分。 API 使用者使用此 URL 向 Web 服务发送请求。 长度必须为 1 到 400 个字符。 默认值为$Null。

Type: String Position:Named Default value:None Accept pipeline input:True Accept wildcard characters:False

-SpecificationFormat

指定规范格式。 psdx_paramvalues Wadl、Wsdl 和 Swagger。

Type: PsApiManagementApiFormat Accepted values:Wadl, Swagger, Wsdl Position:Named Default value:None Accept pipeline input:True Accept wildcard characters:False

-SpecificationPath

指定规范文件路径。

Type: String Position:Named Default value:None Accept pipeline input:True Accept wildcard characters:False

-SpecificationUrl

指定规范 URL。

Type: String Position:Named Default value:None Accept pipeline input:True Accept wildcard characters:False

-WsdlEndpointName

要导入的 WSDL 终结点的本地名称 (端口) 。 长度必须为 1 到 400 个字符。 此参数是可选的,仅用于导入 Wsdl。 默认值为$null。

Type: String Position:Named Default value:None Accept pipeline input:True Accept wildcard characters:False

-WsdlServiceName

要导入的 WSDL 服务的本地名称。 长度必须为 1 到 400 个字符。 此参数是可选的,仅导入 Wsdl 时是必需的。 默认值为$null。

Type: String Position:Named Default value:None Accept pipeline input:True Accept wildcard characters:False

PsApiManagementContext

String

PsApiManagementApiFormat

Nullable<T> [ [ Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementApiType, Microsoft.Azure.Commands.ApiManagement.ServiceManagement, Version=6.1.0.0, Culture=neutral, PublicKeyToken=null ] ]

PsApiManagementApi

  • Export-AzureRmApiManagementApi
  • Get-AzureRmApiManagementApi
  • New-AzureRmApiManagementApi
  • Remove-AzureRmApiManagementApi
  • Set-AzureRmApiManagementApi
  •