Compartilhar via

Referência do modelo de dados do 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 do portal do desenvolvedor no Gerenciamento de API do Azure.

Para saber mais sobre como trabalhar com modelos, consulte Como personalizar o portal de desenvolvedor de Gerenciamento de API usando modelos.

Observação

O conteúdo da documentação a seguir é sobre o portal do desenvolvedor preterido. Você pode continuar usando-o, como de costume, até a desativação dele em outubro de 2023, quando ele será removido de todos os serviços de Gerenciamento de API. 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 | Standard | Premium

Referência

API (Interface de Programação de Aplicativos)

A entidade API tem as seguintes propriedades:

Propriedade Tipo Descrição
id corda Identificador de recurso. Identifica exclusivamente a API na instância atual do serviço de Gerenciamento de API. O valor é uma URL relativa válida no formato de apis/{id} em que {id} é um identificador de API. Essa propriedade é somente leitura.
name corda Nome da API. Não deve estar vazio. O comprimento máximo é de 100 caracteres.
description corda Descrição da API. Não deve estar vazio. Pode incluir marcas de formatação HTML. O comprimento máximo é de 1000 caracteres.
serviceUrl corda URL absoluta do serviço de back-end que implementa essa API.
path corda URL relativa identificando exclusivamente essa API e todos os seus caminhos de recurso dentro da instância do serviço de Gerenciamento de API. É adicionado à URL base do endpoint da API especificada durante a criação da instância de serviço para criar uma URL pública para essa API.
protocols matriz de 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 estiver presente, ela deverá conter pelo menos uma das duas propriedades a seguir.

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

Resumo da API

A entidade API summary tem as seguintes propriedades:

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

Aplicação

A entidade application tem as seguintes propriedades:

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

- 0 – Registrado

- 1 – Enviado

- 2 – Publicado

- 3 - Rejeitado

- 4 – Não publicado
RegistrationDate Data e Hora A data e a hora que o aplicativo foi registrado.
CategoryId número A categoria do aplicativo (Finanças, entretenimento etc.)
DeveloperId corda O identificador exclusivo do desenvolvedor que enviou o aplicativo.
Attachments Coleção de entidades de anexo . Todos os anexos do aplicativo, como capturas de tela ou ícones.
Icon Anexo O ícone do aplicativo.

Anexo

A entidade attachment tem as seguintes propriedades:

Propriedade Tipo Descrição
UniqueId corda O identificador exclusivo do anexo.
Url corda A URL do recurso.
Type corda O tipo de anexo.
ContentType corda O tipo de mídia do anexo.

Exemplo de código

Propriedade Tipo Descrição
title corda O nome da operação.
snippet corda Essa propriedade foi preterida e não deve ser usada.
brush corda Qual modelo de coloração de sintaxe de código será usado ao exibir o exemplo de código. Os valores permitidos são plain, php, java, xml, objc, python, rubye csharp.
template corda O nome deste modelo de exemplo de código.
body corda Um espaço reservado para o exemplo de código do snippet.
method corda O método HTTP da operação.
scheme corda O protocolo a ser usado para a solicitação de operação.
path corda O caminho da operação.
query corda Exemplo de cadeia de caracteres de consulta com parâmetros definidos.
host corda A 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 do parâmetro . Parâmetros definidos para esta operação.

Comentário

A entidade API tem as seguintes propriedades:

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

Questão

A entidade issue possui as propriedades a seguir.

Propriedade Tipo Descrição
Id corda O identificador exclusivo para o problema.
ApiID corda A ID da API para a qual esse problema foi relatado.
Title corda Título do problema.
Description corda Descrição do problema.
SubscriptionDeveloperName corda Nome do desenvolvedor que relatou o problema.
IssueState corda O estado atual do problema. 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 entidades Comment. Comentários sobre esse problema.
Attachments Coleção de entidades de anexo . Todos os anexos da questão.
Services Coleção de entidades da API. As APIs assinadas pelo usuário que apresentou o problema.

Filtragem

A entidade filtering tem as seguintes propriedades:

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

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

Propriedade Tipo Descrição
name corda Nome do parâmetro.
description corda Descrição do parâmetro.
value corda Valor do cabeçalho.
typeName corda Tipo de dados do valor do cabeçalho.
options corda Opções.
required boolean Se o cabeçalho é necessário.
readOnly boolean Se o cabeçalho é somente leitura.

Solicitação HTTP

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

Propriedade Tipo Descrição
description corda Descrição da solicitação de operação.
headers matriz de Header entidades. Cabeçalhos de solicitação.
parameters matriz do parâmetro Coleção de parâmetros de solicitação de operação.
representations matriz de representação Coleção de representações de pedidos de operação.

Resposta HTTP

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

Propriedade Tipo Descrição
statusCode número inteiro positivo Código de status de resposta da operação.
description corda 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 entidade operation tem as seguintes propriedades:

Propriedade Tipo Descrição
id corda Identificador de recurso. Identifica exclusivamente a operação na instância atual do serviço de Gerenciamento de API. O valor é uma URL relativa válida no formato de apis/{aid}/operations/{id} em que {aid} é um identificador de API e {id} é um identificador de operação. Essa propriedade é somente leitura.
name corda Nome da operação. Não deve estar vazio. O comprimento máximo é de 100 caracteres.
description corda Descrição da operação. Não deve estar vazio. Pode incluir marcas de formatação HTML. O comprimento máximo é de 1000 caracteres.
scheme corda Descreve em quais protocolos as operações nesta API podem ser invocadas. Os valores permitidos são http, httpsou http e https.
uriTemplate corda 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 corda A URL do ponto de acesso de Gerenciamento de API que hospeda a API.
httpMethod corda Método HTTP de operação.
request Solicitação HTTP Uma entidade que contém detalhes da solicitação.
responses matriz de resposta HTTP Array de entidades de resposta HTTP da operação .

A entidade operation menu tem as seguintes propriedades:

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

A entidade operation menu item tem as seguintes propriedades:

Propriedade Tipo Descrição
Id corda A ID da operação.
Title corda A descrição da operação.
HttpMethod corda O método HTTP de operação.

Paginação

A entidade paging 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 boolean Se deseja exibir todos os resultados em uma única página.
PageCount número O número de páginas de resultados.

Parâmetro

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

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

Produto

A entidade product tem as seguintes propriedades:

Propriedade Tipo Descrição
Id corda Identificador de recurso. Identifica exclusivamente o produto na instância atual do serviço de Gerenciamento de API. O valor é uma URL relativa válida no formato de products/{pid} em que {pid} é um identificador de produto. Essa propriedade é somente leitura.
Title corda Nome do produto. Não deve estar vazio. O comprimento máximo é de 100 caracteres.
Description corda Descrição do produto. Não deve estar vazio. Pode incluir marcas de formatação HTML. O comprimento máximo é de 1000 caracteres.
Terms corda Termos de uso do produto. Os desenvolvedores que tentarem assinar o produto serão apresentados e obrigados a aceitar esses termos antes de concluir o processo de assinatura.
ProductState número Especifica se o produto foi publicado ou não. Os produtos publicados são detectáveis por 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 boolean Especifica se um usuário pode ter várias assinaturas para este produto ao mesmo tempo.
MultipleSubscriptionsCount número O número máximo de assinaturas para este produto que um usuário pode ter ao mesmo tempo.

Provedor

A entidade provider tem as seguintes propriedades:

Propriedade Tipo Descrição
Properties dicionário de cadeia de caracteres Propriedades para este provedor de autenticação.
AuthenticationType corda O tipo de provedor. (ID do Microsoft Entra, logon do Facebook, Conta do Google, Conta da Microsoft, Twitter).
Caption corda Nome de exibição do provedor.

Representação

Esta seção descreve um representation.

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

Subscrição

A entidade subscription tem as seguintes propriedades:

Propriedade Tipo Descrição
Id corda Identificador de recurso. Identifica exclusivamente a assinatura na instância atual do serviço de Gerenciamento de API. O valor é uma URL relativa válida no formato de subscriptions/{sid} em que {sid} é um identificador de assinatura. Essa propriedade é somente leitura.
ProductId corda O identificador de recurso do produto assinado. O valor é uma URL relativa válida no formato de products/{pid} em que {pid} é um identificador de produto.
ProductTitle corda Nome do produto. Não deve estar vazio. O comprimento máximo é de 100 caracteres.
ProductDescription corda Descrição do produto. Não deve estar vazio. Pode incluir marcas de formatação HTML. O comprimento máximo é de 1000 caracteres.
ProductDetailsUrl corda URL relativa aos detalhes do produto.
state corda O estado da assinatura. Os possíveis estados são:

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

- 1 - active – a assinatura está ativa.

- 2 - expired – a assinatura atingiu a data de validade e foi desativada.

- 3 - submitted – a solicitação de assinatura foi feita pelo desenvolvedor, mas ainda não foi aprovada ou rejeitada.

- 4 - rejected – a solicitação de assinatura foi negada por um administrador.

- 5 - cancelled – a assinatura foi cancelada pelo desenvolvedor ou administrador.
DisplayName corda Nome de exibição da assinatura.
CreatedDate dateTime A data em que a assinatura foi criada, no formato ISO 8601: 2014-06-24T16:25:00Z.
CanBeCancelled boolean Se a assinatura pode ser cancelada pelo usuário atual.
IsAwaitingApproval boolean Se a assinatura está aguardando aprovação.
StartDate dateTime A data de início da assinatura, no formato ISO 8601: 2014-06-24T16:25:00Z.
ExpirationDate dateTime A data de validade 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 corda A chave de assinatura primária. O comprimento máximo é de 256 caracteres.
secondaryKey corda A chave de assinatura secundária. O comprimento máximo é de 256 caracteres.
CanBeRenewed boolean Se a assinatura pode ser renovada pelo usuário atual.
HasExpired boolean Se a assinatura expirou.
IsRejected boolean Se a solicitação de assinatura foi negada.
CancelUrl corda A URL relativa para cancelar a assinatura.
RenewUrl corda A URL relativa para renovar a assinatura.

Resumo da assinatura

A entidade subscription summary tem as seguintes propriedades:

Propriedade Tipo Descrição
Id corda Identificador de recurso. Identifica exclusivamente a assinatura na instância atual do serviço de Gerenciamento de API. O valor é uma URL relativa válida no formato de subscriptions/{sid} em que {sid} é um identificador de assinatura. Esta propriedade é apenas para leitura.
DisplayName corda O nome de exibição da assinatura

Informações da conta de usuário

A entidade user account info tem as seguintes propriedades:

Propriedade Tipo Descrição
FirstName corda Nome próprio. Não deve estar vazio. O comprimento máximo é de 100 caracteres.
LastName corda Apelido. Não deve estar vazio. O comprimento máximo é de 100 caracteres.
Email corda Endereço de email. Não pode estar vazio e deve ser único dentro da instância de serviço. O comprimento máximo é de 254 caracteres.
Password corda Senha da conta de usuário.
NameIdentifier corda Identificador de conta, o mesmo que o email do usuário.
ProviderName corda Nome do provedor de autenticação.
IsBasicAccount boolean True se essa conta foi registrada usando email e senha; false se a conta foi registrada usando um provedor.

Login do usuário

A entidade user sign in tem as seguintes propriedades:

Propriedade Tipo Descrição
Email corda Endereço de email. Não deve estar vazio e deve ser único dentro da instância de serviço. O comprimento máximo é de 254 caracteres.
Password corda Senha da conta de usuário.
ReturnUrl corda A URL da página em que o usuário clicou para entrar.
RememberMe boolean Se deseja salvar as informações do usuário atual.
RegistrationEnabled boolean Se o registro está habilitado.
DelegationEnabled boolean Se a entrada delegada está habilitada.
DelegationUrl corda A URL de login delegada, se ativada.
SsoSignUpUrl corda A URL de logon único para o usuário, se presente.
AuxServiceUrl corda Se o usuário atual for um administrador, esse será um link para a instância de serviço no portal do Azure.
Providers Coleção de entidades do provedor Os provedores de autenticação para esse usuário.
UserRegistrationTerms corda Termos aos quais um usuário deve concordar antes de entrar.
UserRegistrationTermsEnabled boolean Se termos estão habilitados.

Inscrição do usuário

A entidade user sign up tem as seguintes propriedades:

Propriedade Tipo Descrição
PasswordConfirm boolean Valor usado pelo controle de inscrição .
Password corda Senha da conta de usuário.
PasswordVerdictLevel número Valor usado pelo controle de inscrição .
UserRegistrationTerms corda Termos aos quais um usuário deve concordar antes de entrar.
UserRegistrationTermsOptions número Valor usado pelo controle de inscrição .
ConsentAccepted boolean Valor usado pelo controle de inscrição .
Email corda Endereço de email. Não deve estar vazio e deve ser único dentro da instância de serviço. O comprimento máximo é de 254 caracteres.
FirstName corda Nome próprio. Não deve estar vazio. O comprimento máximo é de 100 caracteres.
LastName corda Apelido. Não deve estar vazio. O comprimento máximo é de 100 caracteres.
UserData corda Valor usado pelo controle de inscrição .
NameIdentifier corda Valor usado pelo controle de inscrição .
ProviderName corda Nome do provedor de autenticação.

Próximas etapas

Para saber mais sobre como trabalhar com modelos, consulte Como personalizar o portal de desenvolvedor de Gerenciamento de API usando modelos.

  • Last updated on