Referência do modelo de dados do modelo do Azure Gestão de API
Este tópico descreve a entidade e o tipo de representações para itens comuns utilizados nos modelos de dados para os modelos do portal do programador no Azure Gestão de API.
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.
Referência
- API
- Resumo da API
- Aplicação
- Anexo
- Exemplo de código
- Comentário
- Filtragem
- Cabeçalho
- Pedido de HTTP
- Resposta HTTP
- Problema
- Operação
- Menu Operação
- Item de menu Operação
- Paginação
- Parâmetro
- Produto
- Fornecedor
- Representação
- Subscrição
- Resumo da subscrição
- Informações da conta de utilizador
- Início de sessão do utilizador
- Inscrição de utilizador
API
A API entidade tem as seguintes propriedades:
| Propriedade | Tipo | Description |
|---|---|---|
id |
cadeia (de carateres) | Identificador de recursos. Identifica exclusivamente a API na instância de serviço de Gestão de API atual. O valor é um URL relativo válido no formato de onde {id} é identificador de apis/{id} API. Esta propriedade é só de leitura. |
name |
string | Nome da API. Não pode estar vazio. O comprimento máximo é de 100 carateres. |
description |
string | Descrição da API. Não pode estar vazio. Pode incluir etiquetas de formatação HTML. O comprimento máximo é de 1000 carateres. |
serviceUrl |
string | URL absoluto do serviço de back-end que implementa esta API. |
path |
string | O URL relativo identifica exclusivamente esta API e todos os respetivos caminhos de recursos na instância do serviço Gestão de API. É anexado ao URL base do ponto final da API especificado durante a criação da instância de serviço para formar um URL público para esta API. |
protocols |
matriz de número | Descreve os protocolos que as operações nesta API podem ser invocadas. Os valores permitidos são 1 - http e 2 - https, ou ambos. |
authenticationSettings |
Definições de autenticação do servidor de autorização | Coleção de definições de autenticação incluídas nesta API. |
subscriptionKeyParameterNames |
objeto | Propriedade opcional que pode ser utilizada para especificar nomes personalizados para parâmetros de consulta e/ou cabeçalho que contenham a chave de subscrição. Quando esta propriedade está presente, tem de conter, pelo menos, uma das duas propriedades seguintes.{ "subscriptionKeyParameterNames": { "query": “customQueryParameterName", "header": “customHeaderParameterName" } } |
Resumo da API
A API summary entidade tem as seguintes propriedades:
| Propriedade | Tipo | Description |
|---|---|---|
id |
cadeia (de carateres) | Identificador de recursos. Identifica exclusivamente a API na instância de serviço de Gestão de API atual. O valor é um URL relativo válido no formato de onde {id} é identificador de apis/{id} API. Esta propriedade é só de leitura. |
name |
string | Nome da API. Não pode estar vazio. O comprimento máximo é de 100 carateres. |
description |
string | Descrição da API. Não pode estar vazio. Pode incluir etiquetas de formatação HTML. O comprimento máximo é de 1000 carateres. |
Aplicação
A application entidade tem as seguintes propriedades:
| Propriedade | Tipo | Description |
|---|---|---|
Id |
cadeia (de carateres) | O identificador exclusivo da aplicação. |
Title |
string | O título da aplicação. |
Description |
string | A descrição da aplicação. |
Url |
URI | O URI da aplicação. |
Version |
string | Informações de versão da aplicação. |
Requirements |
string | Uma descrição dos requisitos da aplicação. |
State |
número | O estado atual da aplicação. - 0 - Registado - 1 - Submetido - 2 - Publicado - 3 - Rejeitado - 4 - Não publicado |
RegistrationDate |
DateTime | A data e hora em que a aplicação foi registada. |
CategoryId |
número | A categoria da aplicação (Finanças, entretenimento, etc.) |
DeveloperId |
string | O identificador exclusivo do programador que submeteu a aplicação. |
Attachments |
Coleção de entidades de Anexos . | Quaisquer anexos para a aplicação, como capturas de ecrã ou ícones. |
Icon |
Anexo | O ícone da aplicação. |
Anexo
A attachment entidade tem as seguintes propriedades:
| Propriedade | Tipo | Description |
|---|---|---|
UniqueId |
cadeia (de carateres) | O identificador exclusivo do anexo. |
Url |
string | O URL do recurso. |
Type |
string | O tipo de anexo. |
ContentType |
string | O tipo de suporte de dados do anexo. |
Exemplo de código
| Propriedade | Tipo | Description |
|---|---|---|
title |
cadeia (de carateres) | O nome da operação. |
snippet |
string | Esta propriedade foi preterida e não deve ser utilizada. |
brush |
string | Que modelo de coloração de sintaxe de código a utilizar ao apresentar o exemplo de código. Os valores permitidos são , , , , , , e rubycsharp. objcpythonxmljavaphpplain |
template |
string | O nome deste modelo de exemplo de código. |
body |
string | Um marcador de posição para a parte de exemplo de código do fragmento. |
method |
string | O método HTTP da operação. |
scheme |
string | O protocolo a utilizar para o pedido de operação. |
path |
string | O caminho da operação. |
query |
string | Exemplo de cadeia de consulta com parâmetros definidos. |
host |
string | O URL do gateway de serviço Gestão de API para a API que contém esta operação. |
headers |
Coleção de entidades de Cabeçalho . | Cabeçalhos para esta operação. |
parameters |
Coleção de entidades parâmetros . | Parâmetros definidos para esta operação. |
Comentário
A API entidade tem as seguintes propriedades:
| Propriedade | Tipo | Description |
|---|---|---|
Id |
número | O ID do comentário. |
CommentText |
string | O corpo do comentário. Pode incluir HTML. |
DeveloperCompany |
string | O nome da empresa do programador. |
PostedOn |
DateTime | A data e hora em que o comentário foi publicado. |
Problema
A issue entidade tem as seguintes propriedades.
| Propriedade | Tipo | Description |
|---|---|---|
Id |
cadeia (de carateres) | O identificador exclusivo do problema. |
ApiID |
string | O ID da API para a qual este problema foi comunicado. |
Title |
string | Título do problema. |
Description |
string | Descrição do problema. |
SubscriptionDeveloperName |
string | Nome próprio do programador que reportou o problema. |
IssueState |
string | O estado atual do problema. Os valores possíveis são Proposto, Aberto, Fechado. |
ReportedOn |
DateTime | A data e hora em que o problema foi comunicado. |
Comments |
Coleção de entidades de Comentários . | Comentários sobre este problema. |
Attachments |
Coleção de entidades de Anexos . | Quaisquer anexos para o problema. |
Services |
Coleção de entidades de API . | As APIs subscridas pelo utilizador que apresentou o problema. |
Filtragem
A filtering entidade tem as seguintes propriedades:
| Propriedade | Tipo | Description |
|---|---|---|
Pattern |
cadeia (de carateres) | O termo de pesquisa atual; ou null se não existir nenhum termo de pesquisa. |
Placeholder |
string | O texto a apresentar na caixa de pesquisa quando não existe nenhum termo de pesquisa especificado. |
Cabeçalho
Esta secção descreve a parameter representação.
| Propriedade | Tipo | Description |
|---|---|---|
name |
cadeia (de carateres) | Nome do parâmetro. |
description |
string | Descrição do parâmetro. |
value |
string | Valor do cabeçalho. |
typeName |
string | Tipo de dados do valor do cabeçalho. |
options |
string | Opções. |
required |
boolean | Se o cabeçalho é necessário. |
readOnly |
boolean | Se o cabeçalho é só de leitura. |
Pedido de HTTP
Esta secção descreve a request representação.
| Propriedade | Tipo | Description |
|---|---|---|
description |
cadeia (de carateres) | Descrição do pedido de operação. |
headers |
matriz de Entidades de cabeçalho . | Cabeçalhos de pedido. |
parameters |
matriz de Parâmetro | Coleção de parâmetros de pedido de operação. |
representations |
matriz de Representação | Coleção de representações de pedidos de operação. |
Resposta HTTP
Esta secção descreve a response representação.
| Propriedade | Tipo | Description |
|---|---|---|
statusCode |
número inteiro positivo | Código de estado da resposta da operação. |
description |
string | Descrição da resposta da operação. |
representations |
matriz de Representação | Coleção de representações de resposta de operação. |
Operação
A operation entidade tem as seguintes propriedades:
| Propriedade | Tipo | Description |
|---|---|---|
id |
cadeia (de carateres) | Identificador de recurso. Identifica exclusivamente a operação na instância de serviço do Gestão de API atual. O valor é um URL relativo válido no formato em que {aid} é um identificador de apis/{aid}/operations/{id} API e {id} é um identificador de operação. Esta propriedade é só de leitura. |
name |
string | Nome da operação. Não pode estar vazio. O comprimento máximo é de 100 carateres. |
description |
string | Descrição da operação. Não pode estar vazio. Pode incluir etiquetas de formatação HTML. O comprimento máximo é de 1000 carateres. |
scheme |
string | Descreve em que protocolos as operações nesta API podem ser invocadas. Os valores permitidos são http, httpsou ambos http e https. |
uriTemplate |
string | Modelo de URL relativo que identifica o recurso de destino para esta operação. Podem incluir parâmetros. Exemplo: customers/{cid}/orders/{oid}/?date={date} |
host |
string | O URL do gateway Gestão de API que aloja a API. |
httpMethod |
string | Método HTTP da operação. |
request |
Pedido de HTTP | Uma entidade que contém detalhes do pedido. |
responses |
matriz de Resposta HTTP | Matriz de entidades de resposta HTTP da operação. |
Menu Operação
A operation menu entidade tem as seguintes propriedades:
| Propriedade | Tipo | Description |
|---|---|---|
ApiId |
cadeia (de carateres) | O ID da API atual. |
CurrentOperationId |
string | O ID da operação atual. |
Action |
string | O tipo de menu. |
MenuItems |
Coleção de entidades do item de menu Operação . | As operações da API atual. |
Item de menu Operação
A operation menu item entidade tem as seguintes propriedades:
| Propriedade | Tipo | Description |
|---|---|---|
Id |
cadeia (de carateres) | O ID da operação. |
Title |
string | A descrição da operação. |
HttpMethod |
string | O método Http da operação. |
Paginação
A paging entidade tem as seguintes propriedades:
| Propriedade | Tipo | Description |
|---|---|---|
Page |
número | O número de página atual. |
PageSize |
número | Os resultados máximos a apresentar numa única página. |
TotalItemCount |
número | O número de itens para visualização. |
ShowAll |
boolean | Se pretende colocar todos os resultados numa única página. |
PageCount |
número | O número de páginas de resultados. |
Parâmetro
Esta secção descreve a parameter representação.
| Propriedade | Tipo | Description |
|---|---|---|
name |
cadeia (de carateres) | Nome do parâmetro. |
description |
string | Descrição do parâmetro. |
value |
string | Valor do parâmetro. |
options |
matriz da cadeia | Valores definidos para valores de parâmetros de consulta. |
required |
boolean | Especifica se o parâmetro é necessário ou não. |
kind |
número | Se este parâmetro é um parâmetro de caminho (1) ou um parâmetro de linha de consulta (2). |
typeName |
string | Tipo de parâmetro. |
Produto
A product entidade tem as seguintes propriedades:
| Propriedade | Tipo | Description |
|---|---|---|
Id |
cadeia (de carateres) | Identificador de recursos. Identifica exclusivamente o produto na instância de serviço de Gestão de API atual. O valor é um URL relativo válido no formato de onde {pid} é identificador de products/{pid} produto. Esta propriedade é só de leitura. |
Title |
string | Nome do produto. Não pode estar vazio. O comprimento máximo é de 100 carateres. |
Description |
string | Descrição do produto. Não pode estar vazio. Pode incluir etiquetas de formatação HTML. O comprimento máximo é de 1000 carateres. |
Terms |
string | Termos de utilização do produto. Os programadores que tentarem subscrever o produto serão apresentados e terão de aceitar estes termos antes de poderem concluir o processo de subscrição. |
ProductState |
número | Especifica se o produto é publicado ou não. Os produtos publicados são detetáveis pelos programadores no portal do programador. Os produtos não publicados são visíveis apenas para os administradores. Os valores permitidos para o estado do produto são: - 0 - Not Published- 1 - Published- 2 - Deleted |
AllowMultipleSubscriptions |
boolean | Especifica se um utilizador pode ter várias subscrições para este produto ao mesmo tempo. |
MultipleSubscriptionsCount |
número | O número máximo de subscrições deste produto que um utilizador pode ter ao mesmo tempo. |
Fornecedor
A provider entidade tem as seguintes propriedades:
| Propriedade | Tipo | Description |
|---|---|---|
Properties |
dicionário de cadeias | Propriedades deste fornecedor de autenticação. |
AuthenticationType |
string | O tipo de fornecedor. (Microsoft Entra ID, início de sessão no Facebook, Conta Google, Conta Microsoft, Twitter). |
Caption |
string | Nome a apresentar do fornecedor. |
Representação
Esta secção descreve um representation.
| Propriedade | Tipo | Description |
|---|---|---|
contentType |
cadeia (de carateres) | Especifica um tipo de conteúdo registado ou personalizado para esta representação, por exemplo, application/xml. |
sample |
string | Um exemplo da representação. |
Subscrição
A subscription entidade tem as seguintes propriedades:
| Propriedade | Tipo | Description |
|---|---|---|
Id |
cadeia (de carateres) | Identificador de recurso. Identifica exclusivamente a subscrição na instância de serviço do Gestão de API atual. O valor é um URL relativo válido no formato em que {sid} é um identificador de subscriptions/{sid} subscrição. Esta propriedade é só de leitura. |
ProductId |
string | O identificador do recurso de produto do produto subscrito. O valor é um URL relativo válido no formato em que {pid} é um identificador de products/{pid} produto. |
ProductTitle |
string | Nome do produto. Não pode estar vazio. O comprimento máximo é de 100 carateres. |
ProductDescription |
string | Descrição do produto. Não pode estar vazio. Pode incluir etiquetas de formatação HTML. O comprimento máximo é de 1000 carateres. |
ProductDetailsUrl |
string | URL relativo para os detalhes do produto. |
state |
string | O estado da subscrição. Os estados possíveis são: - 0 - suspended – a subscrição está bloqueada e o subscritor não pode chamar quaisquer APIs do produto.- 1 - active – a subscrição está ativa.- 2 - expired – a subscrição atingiu a data de expiração e foi desativada.- 3 - submitted – o pedido de subscrição foi feito pelo programador, mas ainda não foi aprovado ou rejeitado.- 4 - rejected – o pedido de subscrição foi negado por um administrador.- 5 - cancelled – a subscrição foi cancelada pelo programador ou administrador. |
DisplayName |
string | Nome a apresentar da subscrição. |
CreatedDate |
dateTime | A data em que a subscrição foi criada, no formato ISO 8601: 2014-06-24T16:25:00Z. |
CanBeCancelled |
boolean | Se a subscrição pode ser cancelada pelo utilizador atual. |
IsAwaitingApproval |
boolean | Se a subscrição está a aguardar aprovação. |
StartDate |
dateTime | A data de início da subscrição, no formato ISO 8601: 2014-06-24T16:25:00Z. |
ExpirationDate |
dateTime | A data de expiração da subscrição, no formato ISO 8601: 2014-06-24T16:25:00Z. |
NotificationDate |
dateTime | A data de notificação da subscrição, no formato ISO 8601: 2014-06-24T16:25:00Z. |
primaryKey |
string | A chave de subscrição primária. O comprimento máximo é de 256 carateres. |
secondaryKey |
string | A chave de subscrição secundária. O comprimento máximo é de 256 carateres. |
CanBeRenewed |
boolean | Se a subscrição pode ser renovada pelo utilizador atual. |
HasExpired |
boolean | Se a subscrição expirou. |
IsRejected |
boolean | Se o pedido de subscrição foi negado. |
CancelUrl |
string | O URL relativo para cancelar a subscrição. |
RenewUrl |
string | O URL relativo para renovar a subscrição. |
Resumo da subscrição
A subscription summary entidade tem as seguintes propriedades:
| Propriedade | Tipo | Description |
|---|---|---|
Id |
cadeia (de carateres) | Identificador de recurso. Identifica exclusivamente a subscrição na instância de serviço do Gestão de API atual. O valor é um URL relativo válido no formato em que {sid} é um identificador de subscriptions/{sid} subscrição. Esta propriedade é só de leitura. |
DisplayName |
string | O nome a apresentar da subscrição |
Informações da conta de utilizador
A user account info entidade tem as seguintes propriedades:
| Propriedade | Tipo | Description |
|---|---|---|
FirstName |
cadeia (de carateres) | Nome próprio. Não pode estar vazio. O comprimento máximo é de 100 carateres. |
LastName |
string | Apelido. Não pode estar vazio. O comprimento máximo é de 100 carateres. |
Email |
string | Endereço de e-mail. Não pode estar vazio e tem de ser exclusivo na instância de serviço. O comprimento máximo é de 254 carateres. |
Password |
string | Palavra-passe da conta de utilizador. |
NameIdentifier |
string | Identificador de conta, o mesmo que o e-mail do utilizador. |
ProviderName |
string | Nome do fornecedor de autenticação. |
IsBasicAccount |
boolean | Verdadeiro se esta conta tiver sido registada através de e-mail e palavra-passe; falso se a conta tiver sido registada com um fornecedor. |
Início de sessão do utilizador
A user sign in entidade tem as seguintes propriedades:
| Propriedade | Tipo | Description |
|---|---|---|
Email |
cadeia (de carateres) | Endereço de e-mail. Não pode estar vazio e tem de ser exclusivo na instância de serviço. O comprimento máximo é de 254 carateres. |
Password |
string | Palavra-passe da conta de utilizador. |
ReturnUrl |
string | O URL da página em que o utilizador clicou em iniciar sessão. |
RememberMe |
boolean | Se pretende guardar as informações do utilizador atual. |
RegistrationEnabled |
boolean | Se o registo está ativado. |
DelegationEnabled |
boolean | Se o início de sessão delegado está ativado. |
DelegationUrl |
string | O URL de início de sessão delegado, se ativado. |
SsoSignUpUrl |
string | O URL de início de sessão único para o utilizador, se estiver presente. |
AuxServiceUrl |
string | Se o utilizador atual for um administrador, esta é uma ligação para a instância de serviço no portal do Azure. |
Providers |
Coleção de entidades do Fornecedor | Os fornecedores de autenticação para este utilizador. |
UserRegistrationTerms |
string | Termos com os quais um utilizador tem de concordar antes de iniciar sessão. |
UserRegistrationTermsEnabled |
boolean | Se os termos estão ativados. |
Inscrição de utilizador
A user sign up entidade tem as seguintes propriedades:
| Propriedade | Tipo | Description |
|---|---|---|
PasswordConfirm |
boolean | Valor utilizado pelo controlo deinscrição de inscrição. |
Password |
string | Palavra-passe da conta de utilizador. |
PasswordVerdictLevel |
número | Valor utilizado pelo controlo deinscrição de inscrição. |
UserRegistrationTerms |
string | Termos com os quais um utilizador tem de concordar antes de iniciar sessão. |
UserRegistrationTermsOptions |
número | Valor utilizado pelo controlo deinscrição de inscrição. |
ConsentAccepted |
boolean | Valor utilizado pelo controlo deinscrição de inscrição. |
Email |
string | Endereço de e-mail. Não pode estar vazio e tem de ser exclusivo na instância de serviço. O comprimento máximo é de 254 carateres. |
FirstName |
string | Nome próprio. Não pode estar vazio. O comprimento máximo é de 100 carateres. |
LastName |
string | Apelido. Não pode estar vazio. O comprimento máximo é de 100 carateres. |
UserData |
string | Valor utilizado pelo controlo de inscrição . |
NameIdentifier |
string | Valor utilizado pelo controlo deinscrição de inscrição. |
ProviderName |
string | Nome do fornecedor de autenticação. |
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).