| title | description | services | documentationcenter | author | manager | editor | ms.service | ms.workload | ms.tgt_pltfrm | ms.topic | ms.date | ms.author |
|---|---|---|---|---|---|---|---|---|---|---|---|---|
Azure API Management page controls | Microsoft Docs |
Learn about the page controls available for use in developer portal templates in Azure API Management. |
api-management |
dlepow |
cfowler |
api-management |
mobile |
na |
article |
11/04/2019 |
danlep |
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. 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.
For more information about working with templates, see How to customize the API Management developer portal using templates.
[!INCLUDE api-management-portal-legacy.md]
[!INCLUDE premium-dev-standard-basic.md]
- app-actions
- basic-signin
- paging-control
- providers
- search-control
- sign-up
- subscribe-button
- subscription-cancel
The app-actions control provides a user interface for interacting with applications on the user profile page in the developer portal.
<app-actions params="{ appId: '{{app.id}}' }"></app-actions> | Parameter | Description |
|---|---|
| appId | The ID of the application. |
The app-actions control may be used in the following developer portal templates:
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> None.
The basic-signin control may be used in the following developer portal templates:
The paging-control provides paging functionality on developer portal pages that display a list of items.
<paging-control></paging-control> None.
The paging-control control may be used in the following developer portal templates:
The providers control provides a control for selection of authentication providers in the sign-in page in the developer portal.
<providers></providers> None.
The providers control may be used in the following developer portal templates:
The search-control provides search functionality on developer portal pages that display a list of items.
<search-control></search-control> None.
The search-control control may be used in the following developer portal templates:
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> None.
The sign-up control may be used in the following developer portal templates:
The subscribe-button provides a control for subscribing a user to a product.
<subscribe-button></subscribe-button> None.
The subscribe-button control may be used in the following developer portal templates:
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 params="{ subscriptionId: '{{subscription.id}}', cancelUrl: '{{subscription.cancelUrl}}' }">
</subscription-cancel>
| Parameter | Description |
|---|---|
| subscriptionId | The ID of the subscription to cancel. |
| cancelUrl | The subscription cancels URL. |
The subscription-cancel control may be used in the following developer portal templates:
For more information about working with templates, see How to customize the API Management developer portal using templates.