Informazioni di riferimento sui modelli di dati per i modelli di Gestione API di Azure

  • Articolo

Questo argomento descrive le rappresentazioni di entità e tipi per elementi comuni usati nei modelli di dati per i modelli del portale per sviluppatori in Gestione API di Azure.

Per altre informazioni sull'uso dei modelli, vedere Come personalizzare il portale per sviluppatori di Gestione API usando i modelli.

Nota

Il contenuto della documentazione seguente riguarda il portale per sviluppatori deprecato. È possibile continuare a usarlo come al solito fino al ritiro nell'ottobre 2023, quando verrà rimosso da tutti i servizi di Gestione API. Il portale deprecato riceverà solo gli aggiornamenti della sicurezza critici. Per altre informazioni, vedere gli articoli seguenti:

Disponibilità

Importante

Questa funzionalità è disponibile nei livelli Premium, Standard, Basic e Developer di Gestione API.

Per la disponibilità delle funzionalità nei livelli v2 (anteprima), vedere la panoramica dei livelli v2.

Riferimento

API

L'entità API ha le proprietà seguenti:

Proprietà Type Descrizione
id string Identificatore di risorsa. Identifica in modo univoco l'API all'interno dell'istanza del servizio Gestione API corrente. Il valore è un URL relativo valido nel formato apis/{id} dove {id} è un identificatore API. Questa proprietà è di sola lettura.
name string Nome dell'API. Non deve essere vuoto. La lunghezza massima consentita è di 100 caratteri.
description string Descrizione dell'API. Non deve essere vuoto. Può includere tag di formattazione HTML. La lunghezza massima consentita è di 1000 caratteri.
serviceUrl string URL assoluto del servizio back-end che implementa questa API.
path string URL relativo che identifica in modo univoco questa API e tutti i relativi percorsi delle risorse all'interno dell'istanza del servizio Gestione API. Viene aggiunto all'URL di base dell'endpoint API specificato durante la creazione dell'istanza del servizio in modo da formare un URL pubblico per questa API.
protocols matrice di valori numero Descrive su quali protocolli è possibile richiamare le operazioni in questa API. I valori consentiti sono 1 - http e 2 - https o entrambi.
authenticationSettings Impostazioni di autenticazione del server di autorizzazione Raccolta delle impostazioni di autenticazione incluse in questa API.
subscriptionKeyParameterNames object Proprietà facoltativa che può essere usata per specificare nomi personalizzati per i parametri di query e/o intestazione contenenti la chiave di sottoscrizione. Quando è presente, questa proprietà deve contenere almeno una delle due proprietà seguenti.

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

Riepilogo dell'API

L'entità API summary ha le proprietà seguenti:

Proprietà Type Descrizione
id string Identificatore di risorsa. Identifica in modo univoco l'API all'interno dell'istanza del servizio Gestione API corrente. Il valore è un URL relativo valido nel formato apis/{id} dove {id} è un identificatore API. Questa proprietà è di sola lettura.
name string Nome dell'API. Non deve essere vuoto. La lunghezza massima consentita è di 100 caratteri.
description string Descrizione dell'API. Non deve essere vuoto. Può includere tag di formattazione HTML. La lunghezza massima consentita è di 1000 caratteri.

Applicazione

L'entità application ha le proprietà seguenti:

Proprietà Type Descrizione
Id string Identificatore univoco dell'applicazione.
Title string Titolo dell'applicazione.
Description string Descrizione dell'applicazione.
Url URI URI per l'applicazione.
Version string Informazioni sulla versione per l'applicazione.
Requirements string Descrizione dei requisiti dell'applicazione.
State d'acquisto Stato attuale dell'applicazione.

- 0 - Registrato

- 1 - Inviato

- 2 - Pubblicato

- 3 - Rifiutato

- 4 - Non pubblicato
RegistrationDate Datetime Data e ora della registrazione dell'applicazione.
CategoryId d'acquisto Categoria dell'applicazione (finanza, intrattenimento e così via).
DeveloperId string Identificatore univoco dello sviluppatore che ha inviato l'applicazione.
Attachments Raccolta di entità allegato. Tutti gli allegati per l'applicazione, ad esempio schermate o icone.
Icon Allegato Icona per l'applicazione.

Attachment

L'entità attachment ha le proprietà seguenti:

Proprietà Type Descrizione
UniqueId string Identificatore univoco per l'allegato.
Url string URL della risorsa.
Type string Tipo di allegato.
ContentType string Tipo di supporti dell'allegato.

Esempio di codice

Proprietà Type Descrizione
title string Nome dell'operazione.
snippet string Questa proprietà è deprecata e non deve essere usata.
brush string Modello di colorazione della sintassi del codice da usare quando si visualizza il codice di esempio. I valori consentiti sono plain, php, java, xml, objc, python, ruby e csharp.
template string Nome del modello del codice di esempio.
body string Segnaposto per la porzione del codice di esempio del frammento di codice.
method string Metodo HTTP dell'operazione.
scheme string Protocollo da usare per la richiesta dell'operazione.
path string Percorso dell'operazione.
query string Esempio di stringa di query con parametri definiti.
host string URL del gateway del servizio Gestione API per l'API che contiene questa operazione.
headers Raccolta di entità Header . Intestazioni per l'operazione.
parameters Raccolta di entitàparametro. Parametri definiti per l'operazione.

Commento

L'entità API ha le proprietà seguenti:

Proprietà Type Descrizione
Id d'acquisto ID del commento.
CommentText string Corpo del commento. Può includere HTML.
DeveloperCompany string Nome della società dello sviluppatore.
PostedOn Datetime Data e ora di pubblicazione del commento.

Problema

L'entità issue ha le proprietà seguenti.

Proprietà Type Descrizione
Id string Identificatore univoco per il problema.
ApiID string ID per l'API per cui è stato segnalato questo problema.
Title string Titolo del problema.
Description string Descrizione del problema.
SubscriptionDeveloperName string Nome dello sviluppatore che ha segnalato il problema.
IssueState string Stato attuale del problema. I valori possibili sono Proposto, Aperto e Chiuso.
ReportedOn Datetime Data e ora della segnalazione del problema.
Comments Raccolta di entità commento. Commenti sul problema.
Attachments Raccolta di entità allegato. Qualsiasi allegato al problema.
Services Raccolta di entità API. Le API sottoscritte dall'utente che ha registrato il problema.

Filtro

L'entità filtering ha le proprietà seguenti:

Proprietà Type Descrizione
Pattern string Termine di ricerca corrente; o null se non è presente alcun termine di ricerca.
Placeholder string Testo da visualizzare nella casella di ricerca quando non è specificato alcun termine di ricerca.

Questa sezione descrive la rappresentazione di parameter.

Proprietà Type Descrizione
name string Nome del parametro.
description string Descrizione del parametro.
value string Valore dell'intestazione.
typeName string Tipo di dati del valore dell'intestazione.
options string Opzioni.
required boolean Se l'intestazione è obbligatoria.
readOnly boolean Se l'intestazione è di sola lettura.

Richiesta HTTP

Questa sezione descrive la rappresentazione di request.

Proprietà Type Descrizione
description string Descrizione della richiesta dell'operazione.
headers matrice di entità Intestazione. Intestazioni della richiesta.
parameters matrice di valori Parametro Raccolta di parametri della richiesta dell'operazione.
representations matrice di valori Rappresentazione Raccolta di rappresentazioni della richiesta dell'operazione.

Risposta HTTP

Questa sezione descrive la rappresentazione di response.

Proprietà Type Descrizione
statusCode numero intero positivo Codice di stato della risposta dell'operazione.
description string Descrizione della risposta dell'operazione.
representations matrice di valori Rappresentazione Raccolta di rappresentazioni della risposta dell'operazione.

Operazione

L'entità operation ha le proprietà seguenti:

Proprietà Type Descrizione
id string Identificatore di risorsa. Identifica in modo univoco l'operazione all'interno dell'istanza del servizio Gestione API corrente. Il valore è un URL relativo valido nel formato apis/{aid}/operations/{id} dove {aid} è un identificatore API e {id} è un identificatore di operazione. Questa proprietà è di sola lettura.
name string Nome dell'operazione. Non deve essere vuoto. La lunghezza massima consentita è di 100 caratteri.
description string Descrizione dell'operazione. Non deve essere vuoto. Può includere tag di formattazione HTML. La lunghezza massima consentita è di 1000 caratteri.
scheme string Descrive su quali protocolli è possibile richiamare le operazioni in questa API. I valori consentiti sono http, https o sia http sia https.
uriTemplate string Modello di URL relativo che identifica la risorsa di destinazione per questa operazione. Può includere parametri. Esempio: customers/{cid}/orders/{oid}/?date={date}
host string URL del gateway di Gestione API che ospita l'API.
httpMethod string Metodo HTTP dell'operazione.
request Richiesta HTTP Entità contenente i dettagli della richiesta.
responses matrice di valori Risposta HTTP Matrice di entità Risposta HTTP dell'operazione.

L'entità operation menu ha le proprietà seguenti:

Proprietà Type Descrizione
ApiId string ID dell'API corrente.
CurrentOperationId string ID dell'operazione corrente.
Action string Tipo di menu.
MenuItems Raccolta di entità Voce di menu operazione. Operazioni per l'API corrente.

L'entità operation menu item ha le proprietà seguenti:

Proprietà Type Descrizione
Id string ID dell'operazione.
Title string Descrizione dell'operazione.
HttpMethod string Metodo HTTP dell'operazione.

Paging

L'entità paging ha le proprietà seguenti:

Proprietà Type Descrizione
Page d'acquisto Numero di pagina corrente.
PageSize d'acquisto Numero massimo di risultati da visualizzare in una singola pagina.
TotalItemCount d'acquisto Numero di elementi per la visualizzazione.
ShowAll boolean Se si desidera mostrare tutti risultati in una singola pagina.
PageCount d'acquisto Numero di pagine dei risultati.

Parametro

Questa sezione descrive la rappresentazione di parameter.

Proprietà Type Descrizione
name string Nome del parametro.
description string Descrizione del parametro.
value string Valore del parametro.
options matrice di valori string Valori definiti per i valori del parametro di query.
required boolean Indica se il parametro è obbligatorio o no.
kind d'acquisto Se questo parametro è un parametro di percorso (1) o un parametro di stringa di query (2).
typeName string Tipo di parametro.

Prodotto

L'entità product ha le proprietà seguenti:

Proprietà Type Descrizione
Id string Identificatore di risorsa. Identifica in modo univoco il prodotto all'interno dell'istanza del servizio Gestione API corrente. Il valore è un URL relativo valido nel formato products/{pid} dove {pid} è un identificatore di prodotto. Questa proprietà è di sola lettura.
Title string Nome del prodotto. Non deve essere vuoto. La lunghezza massima consentita è di 100 caratteri.
Description string Descrizione del prodotto. Non deve essere vuoto. Può includere tag di formattazione HTML. La lunghezza massima consentita è di 1000 caratteri.
Terms string Condizioni per l'utilizzo del prodotto. Gli sviluppatori che tentano di sottoscrivere il prodotto vengono presentati e devono accettare queste condizioni prima di poter completare il processo di sottoscrizione.
ProductState d'acquisto Specifica se il prodotto è pubblicato o no. I prodotti pubblicati possono essere individuati dagli sviluppatori nel portale per sviluppatori. I prodotti non pubblicati sono visibili solo agli amministratori.

I valori consentiti per lo stato del prodotto sono:

- 0 - Not Published

- 1 - Published

- 2 - Deleted
AllowMultipleSubscriptions boolean Specifica se un utente può avere più sottoscrizioni al prodotto nello stesso momento.
MultipleSubscriptionsCount d'acquisto Numero massimo di sottoscrizioni per questo prodotto di cui può disporre contemporaneamente un utente.

Provider

L'entità provider ha le proprietà seguenti:

Proprietà Type Descrizione
Properties dizionario di stringhe Proprietà per questo provider di autenticazione.
AuthenticationType string Tipo di provider. (Microsoft Entra ID, account Di Facebook, Account Google, Account Microsoft, Twitter).
Caption string Nome visualizzato del provider.

Rappresentazione

Questa sezione descrive una representation.

Proprietà Type Descrizione
contentType string Specifica un tipo di contenuto registrato o personalizzato per questa rappresentazione, ad esempio application/xml.
sample string Un esempio della rappresentazione.

Subscription

L'entità subscription ha le proprietà seguenti:

Proprietà Type Descrizione
Id string Identificatore di risorsa. Identifica in modo univoco la sottoscrizione all'interno dell'istanza del servizio Gestione API corrente. Il valore è un URL relativo valido nel formato subscriptions/{sid} dove {sid} è un identificatore di sottoscrizione. Questa proprietà è di sola lettura.
ProductId string Identificatore di risorsa per il prodotto relativo al prodotto sottoscritto. Il valore è un URL relativo valido nel formato products/{pid} dove {pid} è un identificatore di prodotto.
ProductTitle string Nome del prodotto. Non deve essere vuoto. La lunghezza massima consentita è di 100 caratteri.
ProductDescription string Descrizione del prodotto. Non deve essere vuoto. Può includere tag di formattazione HTML. La lunghezza massima consentita è di 1000 caratteri.
ProductDetailsUrl string URL relativo per i dettagli del prodotto.
state string Stato della sottoscrizione. Gli stati possibili sono elencati di seguito:

- 0 - suspended: la sottoscrizione è bloccata e il sottoscrittore non può chiamare le API del prodotto.

- 1 - active: la sottoscrizione è attiva.

- 2 - expired: la sottoscrizione ha raggiunto la data di scadenza ed è stata disattivata.

- 3 - submitted: la richiesta di sottoscrizione è stata eseguita dallo sviluppatore, ma non è ancora stata approvata o rifiutata.

- 4 - rejected: la richiesta di sottoscrizione è stata rifiutata da un amministratore.

- 5 - cancelled: la sottoscrizione è stata annullata dallo sviluppatore o dall'amministratore.
DisplayName string Nome visualizzato della sottoscrizione.
CreatedDate dateTime Data di creazione della sottoscrizione, in formato ISO 8601: 2014-06-24T16:25:00Z.
CanBeCancelled boolean Se la sottoscrizione può essere annullata dall'utente corrente.
IsAwaitingApproval boolean Se la sottoscrizione è in attesa di approvazione.
StartDate dateTime Data di inizio per la sottoscrizione, in formato ISO 8601: 2014-06-24T16:25:00Z.
ExpirationDate dateTime Data di scadenza per la sottoscrizione, in formato ISO 8601: 2014-06-24T16:25:00Z.
NotificationDate dateTime Data di notifica per la sottoscrizione, in formato ISO 8601: 2014-06-24T16:25:00Z.
primaryKey string Chiave di sottoscrizione primaria. La lunghezza massima consentita è di 256 caratteri.
secondaryKey string Chiave di sottoscrizione secondaria. La lunghezza massima consentita è di 256 caratteri.
CanBeRenewed boolean Se la sottoscrizione può essere rinnovata dall'utente corrente.
HasExpired boolean Se la sottoscrizione è scaduta.
IsRejected boolean Se la richiesta di sottoscrizione è stata negata.
CancelUrl string URL relativo per annullare la sottoscrizione.
RenewUrl string URL relativo per rinnovare la sottoscrizione.

Riepilogo delle sottoscrizioni

L'entità subscription summary ha le proprietà seguenti:

Proprietà Type Descrizione
Id string Identificatore di risorsa. Identifica in modo univoco la sottoscrizione all'interno dell'istanza del servizio Gestione API corrente. Il valore è un URL relativo valido nel formato subscriptions/{sid} dove {sid} è un identificatore di sottoscrizione. Questa proprietà è di sola lettura.
DisplayName string Nome visualizzato della sottoscrizione

Informazioni sull'account utente

L'entità user account info ha le proprietà seguenti:

Proprietà Type Descrizione
FirstName string Nome. Non deve essere vuoto. La lunghezza massima consentita è di 100 caratteri.
LastName string Cognome. Non deve essere vuoto. La lunghezza massima consentita è di 100 caratteri.
Email string Indirizzo di posta elettronica. Non deve essere vuoto e deve essere univoco all'interno dell'istanza del servizio. La lunghezza massima consentita è di 254 caratteri.
Password string Password dell'account utente.
NameIdentifier string Identificatore di account, lo stesso usato per la posta elettronica dell'utente.
ProviderName string Nome del provider di autenticazione.
IsBasicAccount boolean True se l'account è stato registrato usando posta elettronica e password; false se l'account è stata registrato usando un provider.

Accesso utente

L'entità user sign in ha le proprietà seguenti:

Proprietà Type Descrizione
Email string Indirizzo di posta elettronica. Non deve essere vuoto e deve essere univoco all'interno dell'istanza del servizio. La lunghezza massima consentita è di 254 caratteri.
Password string Password dell'account utente.
ReturnUrl string URL della pagina in cui l'utente ha fatto clic sull'accesso.
RememberMe boolean Se si desidera salvare le informazioni dell'utente corrente.
RegistrationEnabled boolean Se la registrazione è abilitata.
DelegationEnabled boolean Se l'accesso delegato è abilitato.
DelegationUrl string URL di accesso delegato, se abilitato.
SsoSignUpUrl string URL di accesso Single Sign-On per l'utente, se presente.
AuxServiceUrl string Se l'utente corrente è un amministratore, questo è un collegamento all'istanza del servizio nel portale di Azure.
Providers Raccolta di entità Provider. Provider di autenticazione per l'utente.
UserRegistrationTerms string Condizioni che l'utente deve accettare prima dell'accesso.
UserRegistrationTermsEnabled boolean Se le condizioni sono accettate.

Iscrizione utente

L'entità user sign up ha le proprietà seguenti:

Proprietà Type Descrizione
PasswordConfirm boolean Valore usato per il controllo dell'iscrizione sign-up.
Password string Password dell'account utente.
PasswordVerdictLevel d'acquisto Valore usato per il controllo dell'iscrizione sign-up.
UserRegistrationTerms string Condizioni che l'utente deve accettare prima dell'accesso.
UserRegistrationTermsOptions d'acquisto Valore usato per il controllo dell'iscrizione sign-up.
ConsentAccepted boolean Valore usato per il controllo dell'iscrizione sign-up.
Email string Indirizzo di posta elettronica. Non deve essere vuoto e deve essere univoco all'interno dell'istanza del servizio. La lunghezza massima consentita è di 254 caratteri.
FirstName string Nome. Non deve essere vuoto. La lunghezza massima consentita è di 100 caratteri.
LastName string Cognome. Non deve essere vuoto. La lunghezza massima consentita è di 100 caratteri.
UserData string Valore usato per il controllo dell'iscrizione sign-up.
NameIdentifier string Valore usato per il controllo dell'iscrizione sign-up.
ProviderName string Nome del provider di autenticazione.

Passaggi successivi

Per altre informazioni sull'uso dei modelli, vedere Come personalizzare il portale per sviluppatori di Gestione API usando i modelli.