Controlos de página do Azure Gestão de API
O Azure Gestão de API fornece os seguintes controlos para utilização nos modelos do portal do programador.
Para utilizar um controlo, coloque-o na localização pretendida no modelo do portal do programador. Alguns controlos, como o controlo de ações de aplicação , têm parâmetros, conforme mostrado no exemplo seguinte:
<app-actions params="{ appId: '{{app.id}}' }"></app-actions>
Os valores dos parâmetros são transmitidos como parte do modelo de dados do modelo. Na maioria dos casos, pode simplesmente colar no exemplo fornecido para que cada controlo funcione corretamente. Para obter mais informações sobre os valores dos parâmetros, pode ver a secção modelo de dados para cada modelo em que um controlo pode ser utilizado.
Para obter mais informações sobre como trabalhar com modelos, veja How to customize the Gestão de API developer portal using templates (Como personalizar o portal do programador Gestão de API com modelos).
Nota
O seguinte conteúdo da documentação é sobre o portal de programador preterido. Pode continuar a utilizá-lo, como habitualmente, até à descontinuação em outubro de 2023, altura em que será removido de todos os serviços de Gestão de API. O portal preterido só receberá atualizações de segurança críticas. Veja mais detalhes nos artigos seguintes:
Disponibilidade
Importante
Esta funcionalidade está disponível nos escalões Premium, Standard, Básico e Programador da Gestão de API.
Para obter a disponibilidade de funcionalidades nas camadas v2 (pré-visualização), veja a descrição geral das camadas v2.
Controlos de página do modelo do portal do programador
- ações da aplicação
- início de sessão básico
- paginação-controlo
- fornecedores
- search-control
- inscrição
- botão subscrever
- subscrição-cancelar
ações da aplicação
O app-actions controlo fornece uma interface de utilizador para interagir com aplicações na página de perfil de utilizador no portal do programador.
Utilização
<app-actions params="{ appId: '{{app.id}}' }"></app-actions>
Parâmetros
| Parâmetro | Description |
|---|---|
| appId | O ID da aplicação. |
Modelos do portal do programador
O app-actions controlo pode ser utilizado nos seguintes modelos do portal de programador:
início de sessão básico
O basic-signin controlo fornece um controlo para recolher informações de início de sessão do utilizador na página de início de sessão no portal do programador.
Utilização
<basic-SignIn></basic-SignIn>
Parâmetros
Nenhum.
Modelos do portal do programador
O basic-signin controlo pode ser utilizado nos seguintes modelos do portal de programador:
paginação-controlo
O paging-control fornece funcionalidades de paginação em páginas do portal do programador que apresentam uma lista de itens.
Utilização
<paging-control></paging-control>
Parâmetros
Nenhum.
Modelos do portal do programador
O paging-control controlo pode ser utilizado nos seguintes modelos do portal de programador:
fornecedores
O providers controlo fornece um controlo para a seleção de fornecedores de autenticação na página de início de sessão no portal do programador.
o
Utilização
<providers></providers>
Parâmetros
Nenhum.
Modelos do portal do programador
O providers controlo pode ser utilizado nos seguintes modelos do portal de programador:
search-control
O search-control fornece funcionalidades de pesquisa em páginas do portal do programador que apresentam uma lista de itens.
Utilização
<search-control></search-control>
Parâmetros
Nenhum.
Modelos do portal do programador
O search-control controlo pode ser utilizado nos seguintes modelos do portal de programador:
inscrição
O sign-up controlo fornece um controlo para recolher informações do perfil de utilizador na página de inscrição no portal do programador.
controlo
Utilização
<sign-up></sign-up>
Parâmetros
Nenhum.
Modelos do portal do programador
O sign-up controlo pode ser utilizado nos seguintes modelos do portal de programador:
botão subscrever
O subscribe-button fornece um controlo para subscrever um utilizador a um produto.
controlo de
Utilização
<subscribe-button></subscribe-button>
Parâmetros
Nenhum.
Modelos do portal do programador
O subscribe-button controlo pode ser utilizado nos seguintes modelos do portal de programador:
subscrição-cancelar
O subscription-cancel controlo fornece um controlo para cancelar uma subscrição de um produto na página de perfil de utilizador no portal do programador.
Utilização
<subscription-cancel params="{ subscriptionId: '{{subscription.id}}', cancelUrl: '{{subscription.cancelUrl}}' }">
</subscription-cancel>
Parâmetros
| Parâmetro | Description |
|---|---|
| subscriptionId | O ID da subscrição a cancelar. |
| cancelUrl | A subscrição cancela o URL. |
Modelos do portal do programador
O subscription-cancel controlo pode ser utilizado nos seguintes modelos do portal do programador:
Passos seguintes
Para obter mais informações sobre como trabalhar com modelos, veja How to customize the Gestão de API developer portal using templates (Como personalizar o portal do programador Gestão de API com modelos).