Azure API 管理页面控件Azure API Management page controls

Azure API 管理提供以下控件,适用于开发人员门户模板。Azure API Management provides the following controls for use in the developer portal templates.

要使用控件,请将其放在开发人员门户模板中的所需位置。To use a control, place it in the desired location in the developer portal template. 某些控件(例如 app-actions 控件)有参数,如以下示例所示:Some controls, such as the app-actions control, have parameters, as shown in the following example:

<app-actions params="{ appId: '{{app.id}}' }"></app-actions>  

参数的值作为模板的数据模型的一部分传入。The values for the parameters are passed in as part of the data model for the template. 大多数情况下,只需粘贴提供的每个控件的示例,即可正常使用该控件。In most cases, you can simply paste in the provided example for each control for it to work correctly. 有关参数值的详细信息,可参阅每个模板的数据模型部分,其中可能使用了控件。For more information on the parameter values, you can see the data model section for each template in which a control may be used.

如需详细了解如何使用模板,请参阅如何使用模板自定义 API 管理开发人员门户For more information about working with templates, see How to customize the API Management developer portal using templates.

备注

此文档内容与旧开发人员门户有关。This documentation content is about the legacy developer portal. 请参阅以下文章,了解有关新开发人员门户的内容:Refer to the following articles for content about the new developer portal:

可用性Availability

重要

此功能在 API 管理的“高级”、“标准”、“基本”和“开发人员”层中可用。This feature is available in the Premium, Standard, Basic and Developer tiers of API Management.

开发人员门户模板页面控件Developer portal template page controls

app-actionsapp-actions

app-actions 控件提供的用户界面适用于与开发人员门户中用户配置文件页上的应用程序交互。The app-actions control provides a user interface for interacting with applications on the user profile page in the developer portal.

app-actions 控件app-actions control

使用情况Usage

<app-actions params="{ appId: '{{app.id}}' }"></app-actions>  

parametersParameters

参数Parameter 说明Description
appIdappId 应用程序的 ID。The ID of the application.

开发人员门户模板Developer portal templates

app-actions 控件可用于以下开发人员门户模板:The app-actions control may be used in the following developer portal templates:

basic-signinbasic-signin

basic-signin 控件提供了一个控件,用于收集开发人员门户中登录页上的用户登录信息。The basic-signin control provides a control for collecting user sign-in information in the sign-in page in the developer portal.

basic-signin 控件basic-signin control

使用情况Usage

<basic-SignIn></basic-SignIn>  

parametersParameters

无。None.

开发人员门户模板Developer portal templates

basic-signin 控件可用于以下开发人员门户模板:The basic-signin control may be used in the following developer portal templates:

paging-controlpaging-control

paging-control 在开发人员门户页上提供分页功能,该页面会显示项目列表。The paging-control provides paging functionality on developer portal pages that display a list of items.

分页控件paging control

使用情况Usage

<paging-control></paging-control>  

parametersParameters

无。None.

开发人员门户模板Developer portal templates

paging-control 控件可用于以下开发人员门户模板:The paging-control control may be used in the following developer portal templates:

提供程序providers

providers 控件提供了一个控件,用于在开发人员门户的登录页中选择身份验证提供程序。The providers control provides a control for selection of authentication providers in the sign-in page in the developer portal.

提供程序控件providers control

使用情况Usage

<providers></providers>  

parametersParameters

无。None.

开发人员门户模板Developer portal templates

providers 控件可用于以下开发人员门户模板:The providers control may be used in the following developer portal templates:

search-controlsearch-control

search-control 在开发人员门户页上提供搜索功能,该页面会显示项目列表。The search-control provides search functionality on developer portal pages that display a list of items.

搜索控件search control

使用情况Usage

<search-control></search-control>  

parametersParameters

无。None.

开发人员门户模板Developer portal templates

search-control 控件可用于以下开发人员门户模板:The search-control control may be used in the following developer portal templates:

注册sign-up

sign-up 控件提供了一个控件,用于收集开发人员门户中注册页上的用户配置文件信息。The sign-up control provides a control for collecting user profile information in the sign-up page in the developer portal.

sign-up 控件sign-up control

使用情况Usage

<sign-up></sign-up>  

parametersParameters

无。None.

开发人员门户模板Developer portal templates

sign-up 控件可用于以下开发人员门户模板:The sign-up control may be used in the following developer portal templates:

subscribe-buttonsubscribe-button

subscribe-button 提供了一个控件,可供用户订阅产品。The subscribe-button provides a control for subscribing a user to a product.

subscribe-button 控件subscribe-button control

使用情况Usage

<subscribe-button></subscribe-button>  

parametersParameters

无。None.

开发人员门户模板Developer portal templates

subscribe-button 控件可用于以下开发人员门户模板:The subscribe-button control may be used in the following developer portal templates:

subscription-cancelsubscription-cancel

subscription-cancel 控件提供了一个控件,用于在开发人员门户的用户配置文件页中取消产品订阅。The subscription-cancel control provides a control for canceling a subscription to a product in the user profile page in the developer portal.

subscription-cancel 控件subscription-cancel control

使用情况Usage

<subscription-cancel params="{ subscriptionId: '{{subscription.id}}', cancelUrl: '{{subscription.cancelUrl}}' }">  
</subscription-cancel>  
  

parametersParameters

参数Parameter 说明Description
subscriptionIdsubscriptionId 要取消的订阅的 ID。The ID of the subscription to cancel.
cancelUrlcancelUrl 订阅取消 URL。The subscription cancels URL.

开发人员门户模板Developer portal templates

subscription-cancel 控件可用于以下开发人员门户模板:The subscription-cancel control may be used in the following developer portal templates:

后续步骤Next steps

如需详细了解如何使用模板,请参阅如何使用模板自定义 API 管理开发人员门户For more information about working with templates, see How to customize the API Management developer portal using templates.