Partilhar via

Referência do modelo de dados do modelo de Gerenciamento de API do Azure

Este tópico descreve as representações de entidade e tipo para itens comuns usados nos modelos de dados para os modelos de portal do desenvolvedor no Gerenciamento de API do Azure.

Para obter mais informações sobre como trabalhar com modelos, consulte Como personalizar o portal do desenvolvedor do Gerenciamento de API usando modelos.

Observação

O conteúdo da documentação a seguir é sobre o portal do desenvolvedor preterido. Pode continuar a utilizá-lo, como de costume, até à descontinuação em outubro de 2023, altura em que será removido de todos os serviços de gestão de APIs. O portal preterido receberá apenas atualizações de segurança críticas. Veja os seguintes artigos para obter mais detalhes:

APLICA-SE A: Desenvolvedor | Básico | Padrão | Premium

Referência

API (Interface de Programação de Aplicações)

A API entidade tem as seguintes propriedades:

Propriedade Tipo Descrição
id string Identificador de recurso. Identifica exclusivamente a API dentro da instância de serviço de Gerenciamento de API atual. O valor é uma URL relativa válida no formato de apis/{id}, onde {id} é um identificador de API. Esta propriedade é somente leitura.
name string Nome da API. Não deve estar vazio. O comprimento máximo é de 100 caracteres.
description string Descrição da API. Não deve estar vazio. Pode incluir tags de formatação HTML. O comprimento máximo é de 1000 caracteres.
serviceUrl string URL absoluta do serviço de back-end que implementa esta API.
path string URL relativa que identifica exclusivamente essa API e todos os seus caminhos de recursos dentro da instância do serviço de Gerenciamento de API. É anexado à URL base do endpoint da API especificada durante a criação da instância de serviço, criando uma URL pública para essa API.
protocols Matriz do número Descreve em quais protocolos as operações nesta API podem ser invocadas. Os valores permitidos são 1 - http e 2 - https, ou ambos.
authenticationSettings Configurações de autenticação do servidor de autorização Coleção de configurações de autenticação incluídas nesta API.
subscriptionKeyParameterNames objeto Propriedade opcional que pode ser usada para especificar nomes personalizados para parâmetros de consulta e/ou cabeçalho que contêm a chave de assinatura. Quando essa propriedade está presente, ela deve conter pelo menos uma das duas propriedades a seguir.

{ "subscriptionKeyParameterNames": { "query": “customQueryParameterName", "header": “customHeaderParameterName" } }

Resumo da API

A API summary entidade tem as seguintes propriedades:

Propriedade Tipo Descrição
id string Identificador de recurso. Identifica exclusivamente a API dentro da instância de serviço de Gerenciamento de API atual. O valor é uma URL relativa válida no formato de apis/{id}, onde {id} é um identificador de API. Esta propriedade é somente leitura.
name string Nome da API. Não deve estar vazio. O comprimento máximo é de 100 caracteres.
description string Descrição da API. Não deve estar vazio. Pode incluir tags de formatação HTML. O comprimento máximo é de 1000 caracteres.

Aplicação

A application entidade tem as seguintes propriedades:

Propriedade Tipo Descrição
Id string O identificador exclusivo do aplicativo.
Title string O título do pedido.
Description string A descrição do pedido.
Url URI O URI do aplicativo.
Version string Informações de versão do aplicativo.
Requirements string Descrição dos requisitos para o pedido.
State número O estado atual do aplicativo.

- 0 - Registado

- 1 - Submetido

- 2 - Publicado

- 3 - Rejeitado

- 4 - Inédito
RegistrationDate Data e Hora A data e a hora em que o pedido foi registado.
CategoryId número A categoria da aplicação (Finanças, entretenimento, etc.)
DeveloperId string O identificador exclusivo do desenvolvedor que enviou o aplicativo.
Attachments Coleção de entidades anexo. Quaisquer anexos para o aplicativo, como capturas de tela ou ícones.
Icon Anexo O ícone da aplicação.

Acessório

A attachment entidade tem as seguintes propriedades:

Propriedade Tipo Descrição
UniqueId string O identificador exclusivo do anexo.
Url string A URL do recurso.
Type string O tipo de anexo.
ContentType string O tipo de media do anexo.

Exemplo de código

Propriedade Tipo Descrição
title string O nome da operação.
snippet string Esta propriedade foi preterida e não deve ser usada.
brush string Qual modelo de coloração de sintaxe de código a ser usado ao exibir o exemplo de código. Os valores permitidos são plain, php, , java, objcxml, python, rubye csharp.
template string O nome deste modelo de exemplo de código.
body string Um espaço reservado para o exemplo de um trecho de código.
method string O método HTTP da operação.
scheme string O protocolo a ser usado para a solicitação de operação.
path string O caminho da operação.
query string Exemplo de cadeia de caracteres de consulta com parâmetros definidos.
host string O URL do gateway de serviço de Gerenciamento de API para a API que contém essa operação.
headers Coleção de entidades de cabeçalho. Cabeçalhos para esta operação.
parameters Coleção de entidades Parameter . Parâmetros que são definidos para esta operação.

Comentário

A API entidade tem as seguintes propriedades:

Propriedade Tipo Descrição
Id número O identificador do comentário.
CommentText string O corpo do comentário. Pode incluir HTML.
DeveloperCompany string O nome da empresa do desenvolvedor.
PostedOn Data e Hora A data e a hora em que o comentário foi publicado.

Questão

A issue entidade tem as seguintes propriedades.

Propriedade Tipo Descrição
Id string O identificador exclusivo do problema.
ApiID string A ID da API para a qual esse problema foi relatado.
Title string Título da questão.
Description string Descrição do problema.
SubscriptionDeveloperName string Nome do desenvolvedor que relatou o problema.
IssueState string O estado atual da questão. Os valores possíveis são Proposto, Aberto, Fechado.
ReportedOn Data e Hora A data e a hora em que o problema foi relatado.
Comments Coleção de comentários entidades. Comentários sobre esta questão.
Attachments Coleção de entidades Anexo. Quaisquer anexos à questão.
Services Coleção de entidades API. As APIs subscritas pelo utilizador que apresentou o problema.

Filtragem

A filtering entidade tem as seguintes propriedades:

Propriedade Tipo Descrição
Pattern string O termo de pesquisa atual; ou null se não houver um termo de pesquisa.
Placeholder string O texto a ser exibido na caixa de pesquisa quando não houver um termo de pesquisa especificado.

Esta seção descreve a parameter representação.

Propriedade Tipo Descrição
name string 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 Booleano Se o cabeçalho é necessário.
readOnly Booleano Se o cabeçalho é somente leitura.

Solicitação HTTP

Esta seção descreve a request representação.

Propriedade Tipo Descrição
description string Descrição do pedido de operação.
headers matriz de entidades de cabeçalho . Cabeçalhos de solicitação.
parameters matriz de parâmetro Coleta de parâmetros de solicitação de operação.
representations matriz de representação Recolha de representações de pedidos de operação.

Resposta HTTP

Esta seção descreve a response representação.

Propriedade Tipo Descrição
statusCode inteiro positivo Código de status de 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ções.

Funcionamento

A operation entidade tem as seguintes propriedades:

Propriedade Tipo Descrição
id string Identificador de recurso. Identifica exclusivamente a operação dentro da instância de serviço de Gerenciamento de API atual. O valor é uma URL relativa válida no formato de apis/{aid}/operations/{id}, onde {aid} é um identificador de API e {id} é um identificador de operação. Esta propriedade é somente leitura.
name string Nome da operação. Não deve estar vazio. O comprimento máximo é de 100 caracteres.
description string Descrição da operação. Não deve estar vazio. Pode incluir tags de formatação HTML. O comprimento máximo é de 1000 caracteres.
scheme string Descreve em quais protocolos as operações nesta API podem ser invocadas. Os valores permitidos são http, https, ou ambos http e https.
uriTemplate string Modelo de URL relativo que identifica o recurso de destino para esta operação. Pode incluir parâmetros. Exemplo: customers/{cid}/orders/{oid}/?date={date}
host string O URL do gateway de gerenciamento da API que hospeda a API.
httpMethod string Método de operação HTTP.
request Solicitação HTTP Uma entidade que contém detalhes da solicitação.
responses matriz de resposta HTTP Matriz de operação entidades de resposta HTTP .

A operation menu entidade tem as seguintes propriedades:

Propriedade Tipo Descrição
ApiId string A ID da API atual.
CurrentOperationId string O ID da operação atual.
Action string O tipo de menu.
MenuItems Coleção de entidades do menu de Operação. As operações da API atual.

A operation menu item entidade tem as seguintes propriedades:

Propriedade Tipo Descrição
Id string 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 Descrição
Page número O número da página atual.
PageSize número Os resultados máximos a serem exibidos em uma única página.
TotalItemCount número O número de itens para exibição.
ShowAll Booleano Se todos os resultados devem ser incluídos em uma única página.
PageCount número O número de páginas de resultados.

Parâmetro

Esta seção descreve a parameter representação.

Propriedade Tipo Descrição
name string Nome do parâmetro.
description string Descrição do parâmetro.
value string Valor do parâmetro.
options Matriz de cadeia de caracteres Valores definidos para valores de parâmetros de consulta.
required Booleano Especifica se o parâmetro é necessário ou não.
kind número Se esse parâmetro é um parâmetro path (1) ou um parâmetro querystring (2).
typeName string Parameter type.

Produto

A product entidade tem as seguintes propriedades:

Propriedade Tipo Descrição
Id string Identificador de recurso. Identifica exclusivamente o produto dentro da instância de serviço de Gerenciamento de API atual. O valor é um URL relativo válido no formato de onde {pid} é um identificador de products/{pid} produto. Esta propriedade é somente leitura.
Title string Nome do produto. Não deve estar vazio. O comprimento máximo é de 100 caracteres.
Description string Descrição do produto. Não deve estar vazio. Pode incluir tags de formatação HTML. O comprimento máximo é de 1000 caracteres.
Terms string Termos de utilização do produto. Os programadores que tentem subscrever o produto serão apresentados e obrigados a 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 podem ser descobertos pelos desenvolvedores no portal do desenvolvedor. 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 Booleano Especifica se um usuário pode ter várias assinaturas para este produto ao mesmo tempo.
MultipleSubscriptionsCount número 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 Descrição
Properties dicionário de cadeias de caracteres Propriedades para este provedor de autenticação.
AuthenticationType string O tipo de provedor. (ID do Microsoft Entra, login do Facebook, Conta do Google, Conta da Microsoft, Twitter).
Caption string Nome para exibição do provedor.

Representação

Esta seção descreve um arquivo representation.

Propriedade Tipo Descrição
contentType string Especifica um tipo de conteúdo registrado ou personalizado para essa representação, por exemplo, application/xml.
sample string Um exemplo da representação.

Subscrição

A subscription entidade tem as seguintes propriedades:

Propriedade Tipo Descrição
Id string Identificador de recurso. Identifica exclusivamente a assinatura dentro da instância de serviço de Gerenciamento de API atual. O valor é um URL relativo válido no formato de onde {sid} é um identificador de subscriptions/{sid} assinatura. Esta propriedade é somente leitura.
ProductId string O identificador de recurso do produto ao qual se subscreveu. O valor é um URL relativo válido no formato products/{pid} onde {pid} é um identificador de produto.
ProductTitle string Nome do produto. Não deve estar vazio. O comprimento máximo é de 100 caracteres.
ProductDescription string Descrição do produto. Não deve estar vazio. Pode incluir tags de formatação HTML. O comprimento máximo é de 1000 caracteres.
ProductDetailsUrl string URL relativo aos detalhes do produto.
state string O estado da assinatura. Os estados possíveis são:

- 0 - suspended – a assinatura está bloqueada e o assinante não pode chamar nenhuma API do produto.

- 1 - active – a subscrição está ativa.

- 2 - expired – a subscrição atingiu a sua 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 para exibição da assinatura.
CreatedDate dateTime A data em que a subscrição foi criada, no formato ISO 8601: 2014-06-24T16:25:00Z.
CanBeCancelled Booleano Se a assinatura pode ser cancelada pelo usuário atual.
IsAwaitingApproval Booleano 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 data e hora A data de expiração da assinatura, no formato ISO 8601: 2014-06-24T16:25:00Z.
NotificationDate dateTime A data de notificação da assinatura, no formato ISO 8601: 2014-06-24T16:25:00Z.
primaryKey string A chave de subscrição principal. O comprimento máximo é de 256 caracteres.
secondaryKey string A chave de subscrição secundária. O comprimento máximo é de 256 caracteres.
CanBeRenewed Booleano Se a assinatura pode ser renovada pelo usuário atual.
HasExpired Booleano Se a subscrição expirou.
IsRejected Booleano Se o pedido de subscrição foi negado.
CancelUrl string O URL relativo para cancelar a assinatura.
RenewUrl string O URL relativo para renovar a assinatura.

Resumo da subscrição

A subscription summary entidade tem as seguintes propriedades:

Propriedade Tipo Descrição
Id string Identificador de recurso. Identifica exclusivamente a assinatura dentro da instância de serviço de Gerenciamento de API atual. O valor é um URL relativo válido no formato subscriptions/{sid}, onde {sid} é um identificador de assinatura. Esta propriedade é somente leitura.
DisplayName string Nome de exibição da assinatura

Informações da conta de utilizador

A user account info entidade tem as seguintes propriedades:

Propriedade Tipo Descrição
FirstName string Nome próprio. Não deve estar vazio. O comprimento máximo é de 100 caracteres.
LastName string Apelido. Não deve estar vazio. O comprimento máximo é de 100 caracteres.
Email string Endereço de e-mail. Não deve estar vazio e deve ser exclusivo dentro da instância de serviço. O comprimento máximo é de 254 caracteres.
Password string Palavra-passe da conta de utilizador.
NameIdentifier string Identificador de conta, o mesmo que o e-mail do usuário.
ProviderName string Nome do provedor de autenticação.
IsBasicAccount Booleano True se esta conta foi registrada usando e-mail e senha; false se a conta foi registrada usando um provedor.

Início de sessão do utilizador

A user sign in entidade tem as seguintes propriedades:

Propriedade Tipo Descrição
Email string Endereço de e-mail. Não deve estar vazio e deve ser exclusivo dentro da instância de serviço. O comprimento máximo é de 254 caracteres.
Password string Palavra-passe da conta de utilizador.
ReturnUrl string O URL da página em que o utilizador clicou para iniciar sessão.
RememberMe Booleano Se deseja salvar as informações do usuário atual.
RegistrationEnabled Booleano Se o registro está habilitado.
DelegationEnabled Booleano Se o início de sessão delegado está ativado.
DelegationUrl string A URL de entrada delegada, se ativada.
SsoSignUpUrl string A URL de logon único para o usuário, se presente.
AuxServiceUrl string Se o usuário atual for um administrador, esse é um link para a instância de serviço no portal do Azure.
Providers Coleção de entidades Provedor Os provedores de autenticação para este usuário.
UserRegistrationTerms string Termos com os quais um utilizador tem de concordar antes de iniciar sessão.
UserRegistrationTermsEnabled Booleano Estão os termos ativados?

Registo de utilizadores

A user sign up entidade tem as seguintes propriedades:

Propriedade Tipo Descrição
PasswordConfirm Booleano Valor usado pelo controlo de registo de inscrição.
Password string Palavra-passe da conta de utilizador.
PasswordVerdictLevel número Valor usado pelo controle de inscrição.
UserRegistrationTerms string Termos com os quais um utilizador tem de concordar antes de iniciar sessão.
UserRegistrationTermsOptions número Valor usado pelo controlo de inscrição de sign-up.
ConsentAccepted Booleano Valor usado pelo controlo de inscrição.
Email string Endereço de e-mail. Não deve estar vazio e deve ser exclusivo dentro da instância de serviço. O comprimento máximo é de 254 caracteres.
FirstName string Nome próprio. Não deve estar vazio. O comprimento máximo é de 100 caracteres.
LastName string Apelido. Não deve estar vazio. O comprimento máximo é de 100 caracteres.
UserData string Valor usado pelo controle de inscrição .
NameIdentifier string Valor usado pelo controle de inscrição.
ProviderName string Nome do provedor de autenticação.

Próximos passos

Para obter mais informações sobre como trabalhar com modelos, consulte Como personalizar o portal do desenvolvedor do Gerenciamento de API usando modelos.

  • Last updated on