Informazioni di riferimento sui modelli di dati per i modelli di Gestione API di AzureAzure API Management template data model reference

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.This topic describes the entity and type representations for common items used in the data models for the developer portal templates in Azure API Management.

Per altre informazioni sull'uso dei modelli, vedere Come personalizzare il portale per sviluppatori di Gestione API usando i modelli.For more information about working with templates, see How to customize the API Management developer portal using templates.

APIAPI

L'entità API ha le proprietà seguenti.The API entity has the following properties.

ProprietàProperty TipoType DescrizioneDescription
idid stringstring Identificatore di risorsa.Resource identifier. Identifica in modo univoco l'API all'interno dell'istanza del servizio Gestione API corrente.Uniquely identifies the API within the current API Management service instance. Il valore è un URL relativo valido nel formato apis/{id} dove {id} è un identificatore API.The value is a valid relative URL in the format of apis/{id} where {id} is an API identifier. Questa proprietà è di sola lettura.This property is read-only.
namename stringstring Nome dell'API.Name of the API. Non deve essere vuoto.Must not be empty. La lunghezza massima consentita è di 100 caratteri.Maximum length is 100 characters.
descriptiondescription stringstring Descrizione dell'API.Description of the API. Non deve essere vuota.Must not be empty. Può includere tag di formattazione HTML.May include HTML formatting tags. La lunghezza massima consentita è di 1000 caratteri.Maximum length is 1000 characters.
serviceUrlserviceUrl stringstring URL assoluto del servizio back-end che implementa questa API.Absolute URL of the backend service implementing this API.
pathpath stringstring URL relativo che identifica in modo univoco questa API e tutti i relativi percorsi delle risorse all'interno dell'istanza del servizio Gestione API.Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. 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.It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API.
protocolsprotocols matrice di valori numeroarray of number Descrive su quali protocolli è possibile richiamare le operazioni in questa API.Describes on which protocols the operations in this API can be invoked. I valori consentiti sono 1 - http e 2 - https o entrambi.Allowed values are 1 - http and 2 - https, or both.
authenticationSettingsauthenticationSettings Impostazioni di autenticazione del server di autorizzazioneAuthorization server authentication settings Raccolta delle impostazioni di autenticazione incluse in questa API.Collection of authentication settings included in this API.
subscriptionKeyParameterNamessubscriptionKeyParameterNames objectobject Proprietà facoltativa che può essere usata per specificare nomi personalizzati per i parametri di query e/o intestazione contenenti la chiave di sottoscrizione.Optional property that can be used to specify custom names for query and/or header parameters containing the subscription key. Quando è presente, questa proprietà deve contenere almeno una delle due proprietà seguenti.When this property is present it must contain at least one of the two following properties.

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

Riepilogo delle APIAPI summary

L'entità API summary ha le proprietà seguenti.The API summary entity has the following properties.

ProprietàProperty TipoType DescrizioneDescription
idid stringstring Identificatore di risorsa.Resource identifier. Identifica in modo univoco l'API all'interno dell'istanza del servizio Gestione API corrente.Uniquely identifies the API within the current API Management service instance. Il valore è un URL relativo valido nel formato apis/{id} dove {id} è un identificatore API.The value is a valid relative URL in the format of apis/{id} where {id} is an API identifier. Questa proprietà è di sola lettura.This property is read-only.
namename stringstring Nome dell'API.Name of the API. Non deve essere vuoto.Must not be empty. La lunghezza massima consentita è di 100 caratteri.Maximum length is 100 characters.
descriptiondescription stringstring Descrizione dell'API.Description of the API. Non deve essere vuota.Must not be empty. Può includere tag di formattazione HTML.May include HTML formatting tags. La lunghezza massima consentita è di 1000 caratteri.Maximum length is 1000 characters.

ApplicazioneApplication

L'entità application ha le proprietà seguenti.The application entity has the following properties.

ProprietàProperty TipoType DescrizioneDescription
IDId stringstring Identificatore univoco dell'applicazione.The unique identifier of the application.
TitoloTitle stringstring Titolo dell'applicazione.The title of the application.
DescrizioneDescription stringstring Descrizione dell'applicazione.The description of the application.
UrlUrl URIURI URI per l'applicazione.The URI for the application.
VersioneVersion stringstring Informazioni sulla versione per l'applicazione.Version information for the application.
RequisitiRequirements stringstring Descrizione dei requisiti dell'applicazione.A description of requirements for the application.
StatoState numbernumber Stato attuale dell'applicazione.The current state of the application.

- 0 - Registrato- 0 - Registered

- 1 - Inviato- 1 - Submitted

- 2 - Pubblicato- 2 - Published

- 3 - Rifiutato- 3 - Rejected

- 4 - Non pubblicato- 4 - Unpublished
RegistrationDateRegistrationDate DateTimeDateTime Data e ora della registrazione dell'applicazione.The date and time the application was registered.
CategoryIdCategoryId numbernumber Categoria dell'applicazione (finanza, intrattenimento e così via).The category of the application (Finance, entertainment, etc.)
DeveloperIdDeveloperId stringstring Identificatore univoco dello sviluppatore che ha inviato l'applicazione.The unique identifier of the developer that submitted the application.
AttachmentsAttachments Raccolta di entità allegato.Collection of Attachment entities. Tutti gli allegati per l'applicazione, ad esempio schermate o icone.Any attachments for the application such as screenshots or icons.
IconaIcon AllegatoAttachment Icona per l'applicazione.The icon the for the application.

AllegatoAttachment

L'entità attachment ha le proprietà seguenti.The attachment entity has the following properties.

ProprietàProperty TipoType DescrizioneDescription
UniqueIdUniqueId stringstring Identificatore univoco per l'allegato.The unique identifier for the attachment.
UrlUrl stringstring URL della risorsa.The URL of the resource.
TipoType stringstring Tipo di allegato.The type of attachment.
ContentTypeContentType stringstring Tipo di supporti dell'allegato.The media type of the attachment.

Codice di esempioCode sample

ProprietàProperty TipoType DescrizioneDescription
titletitle stringstring Nome dell'operazione.The name of the operation.
snippetsnippet stringstring Questa proprietà è deprecata e non deve essere usata.This property is deprecated and should not be used.
brushbrush stringstring Modello di colorazione della sintassi del codice da usare quando si visualizza il codice di esempio.Which code syntax coloring template to be used when displaying the code sample. I valori consentiti sono plain, php, java, xml, objc, python, ruby e csharp.Allowed values are plain, php, java, xml, objc, python, ruby, and csharp.
templatetemplate stringstring Nome del modello del codice di esempio.The name of this code sample template.
bodybody stringstring Segnaposto per la porzione del codice di esempio del frammento di codice.A placeholder for the code sample portion of the snippet.
staticomethod stringstring Metodo HTTP dell'operazione.The HTTP method of the operation.
schemescheme stringstring Protocollo da usare per la richiesta dell'operazione.The protocol to use for the operation request.
pathpath stringstring Percorso dell'operazione.The path of the operation.
queryquery stringstring Esempio di stringa di query con parametri definiti.Query string example with defined parameters.
hosthost stringstring URL del gateway del servizio Gestione API per l'API che contiene questa operazione.The URL of the API Management service gateway for the API that contains this operation.
Headersheaders Raccolta di entità intestazione.Collection of Header entities. Intestazioni per l'operazione.Headers for this operation.
Parametriparameters Raccolta di entitàparametro.Collection of Parameter entities. Parametri definiti per l'operazione.Parameters that are defined for this operation.

CommentoComment

L'entità API ha le proprietà seguenti.The API entity has the following properties.

ProprietàProperty TipoType DescrizioneDescription
IDId numbernumber ID del commento.The id of the comment.
CommentTextCommentText stringstring Corpo del commento.The body of the comment. Può includere HTML.May include HTML.
DeveloperCompanyDeveloperCompany stringstring Nome della società dello sviluppatore.The company name of the developer.
PostedOnPostedOn DateTimeDateTime Data e ora di pubblicazione del commento.The date and time the comment was posted.

ProblemaIssue

L'entità issue ha le proprietà seguenti.The issue entity has the following properties.

ProprietàProperty TipoType DescrizioneDescription
IDId stringstring Identificatore univoco per il problema.The unique identifier for the issue.
ApiIDApiID stringstring ID per l'API per cui è stato segnalato il problema.The id for the API for which this issue was reported.
TitoloTitle stringstring Titolo del problema.Title of the issue.
DescrizioneDescription stringstring Descrizione del problema.Description of the issue.
SubscriptionDeveloperNameSubscriptionDeveloperName stringstring Nome dello sviluppatore che ha segnalato il problema.First name of the developer that reported the issue.
IssueStateIssueState stringstring Stato attuale del problema.The current state of the issue. I valori possibili sono Proposto, Aperto e Chiuso.Possible values are Proposed, Opened, Closed.
ReportedOnReportedOn DateTimeDateTime Data e ora della segnalazione del problema.The date and time the issue was reported.
CommentiComments Raccolta di entità commento.Collection of Comment entities. Commenti sul problema.Comments on this issue.
AttachmentsAttachments Raccolta di entità allegato.Collection of Attachment entities. Qualsiasi allegato al problema.Any attachments to the issue.
ServicesServices Raccolta di entità API.Collection of API entities. Le API sottoscritte dall'utente che ha registrato il problema.The APIs subscribed to by the user that filed the issue.

FiltriFiltering

L'entità filtering ha le proprietà seguenti.The filtering entity has the following properties.

ProprietàProperty TipoType DescrizioneDescription
ModelloPattern stringstring Termine di ricerca corrente; o null se non è presente alcun termine di ricerca.The current search term; or null if there is no search term.
PlaceholderPlaceholder stringstring Il testo da visualizzare nella casella di ricerca quando non è presente alcun termine di ricerca specificato.The text to display in the search box when there is no search term specified.

Questa sezione descrive la rappresentazione di parameter.This section describes the parameter representation.

ProprietàProperty DescrizioneDescription TipoType
namename stringstring Nome del parametro.Parameter name.
descriptiondescription stringstring Descrizione del parametro.Parameter description.
valuevalue stringstring Valore dell'intestazione.Header value.
typeNametypeName stringstring Tipo di dati del valore dell'intestazione.Data type of header value.
optionsoptions stringstring Opzioni.Options.
Obbligatoriarequired booleanboolean Se l'intestazione è obbligatoria.Whether the header is required.
readOnlyreadOnly booleanboolean Se l'intestazione è di sola lettura.Whether the header is read-only.

Richiesta HTTPHTTP Request

Questa sezione descrive la rappresentazione di request.This section describes the request representation.

ProprietàProperty TipoType DescrizioneDescription
descriptiondescription stringstring Descrizione della richiesta dell'operazione.Operation request description.
Headersheaders matrice di entità Intestazione.array of Header entities. Intestazioni della richiesta.Request headers.
Parametriparameters matrice di valori Parametroarray of Parameter Raccolta di parametri della richiesta dell'operazione.Collection of operation request parameters.
representationsrepresentations matrice di valori Rappresentazionearray of Representation Raccolta di rappresentazioni della richiesta dell'operazione.Collection of operation request representations.

Risposta HTTPHTTP Response

Questa sezione descrive la rappresentazione di response.This section describes the response representation.

ProprietàProperty TipoType DescrizioneDescription
statusCodestatusCode intero positivopositive integer Codice di stato della risposta dell'operazione.Operation response status code.
descriptiondescription stringstring Descrizione della risposta dell'operazione.Operation response description.
representationsrepresentations matrice di valori Rappresentazionearray of Representation Raccolta di rappresentazioni della risposta dell'operazione.Collection of operation response representations.

OperazioneOperation

L'entità operation ha le proprietà seguenti.The operation entity has the following properties.

ProprietàProperty TipoType DescrizioneDescription
idid stringstring Identificatore di risorsa.Resource identifier. Identifica in modo univoco l'operazione all'interno dell'istanza del servizio Gestione API corrente.Uniquely identifies the operation within the current API Management service instance. Il valore è un URL relativo valido nel formato apis/{aid}/operations/{id} dove {aid} è un identificatore API e {id} è un identificatore di operazione.The value is a valid relative URL in the format of apis/{aid}/operations/{id} where {aid} is an API identifier and {id} is an operation identifier. Questa proprietà è di sola lettura.This property is read-only.
namename stringstring Nome dell'operazione.Name of the operation. Non deve essere vuoto.Must not be empty. La lunghezza massima consentita è di 100 caratteri.Maximum length is 100 characters.
descriptiondescription stringstring Descrizione dell'operazione.Description of the operation. Non deve essere vuota.Must not be empty. Può includere tag di formattazione HTML.May include HTML formatting tags. La lunghezza massima consentita è di 1000 caratteri.Maximum length is 1000 characters.
schemescheme stringstring Descrive su quali protocolli è possibile richiamare le operazioni in questa API.Describes on which protocols the operations in this API can be invoked. I valori consentiti sono http, https o sia http sia https.Allowed values are http, https, or both http and https.
uriTemplateuriTemplate stringstring Modello di URL relativo che identifica la risorsa di destinazione per questa operazione.Relative URL template identifying the target resource for this operation. Può includere parametri.May include parameters. Esempio: customers/{cid}/orders/{oid}/?date={date}Example: customers/{cid}/orders/{oid}/?date={date}
hosthost stringstring URL del gateway di Gestione API che ospita l'API.The API Management gateway URL that hosts the API.
httpMethodhttpMethod stringstring Metodo HTTP dell'operazione.Operation HTTP method.
richiestarequest Richiesta HTTPHTTP Request Entità contenente i dettagli della richiesta.An entity containing request details.
responsesresponses matrice di valori Risposta HTTParray of HTTP Response Matrice di entità Risposta HTTP dell'operazione.Array of operation HTTP Response entities.

L'entità operation menu ha le proprietà seguenti.The operation menu entity has the following properties.

ProprietàProperty TipoType DescrizioneDescription
ApiIDApiId stringstring ID dell'API corrente.The id of the current API.
CurrentOperationIdCurrentOperationId stringstring ID dell'operazione corrente.The id of the current operation.
AzioneAction stringstring Tipo di menu.The menu type.
MenuItemsMenuItems Raccolta di entità Voce di menu operazione.Collection of Operation menu item entities. Operazioni per l'API corrente.The operations for the current API.

L'entità operation menu item ha le proprietà seguenti.The operation menu item entity has the following properties.

ProprietàProperty TipoType DescrizioneDescription
IDId stringstring ID dell'operazione.The id of the operation.
TitoloTitle stringstring Descrizione dell'operazione.The description of the operation.
HttpMethodHttpMethod stringstring Metodo HTTP dell'operazione.The Http method of the operation.

PagingPaging

L'entità paging ha le proprietà seguenti.The paging entity has the following properties.

ProprietàProperty TipoType DescrizioneDescription
PagePage numbernumber Numero di pagina corrente.The current page number.
PageSizePageSize numbernumber Numero massimo di risultati da visualizzare in una singola pagina.The maximum results to be displayed on a single page.
TotalItemCountTotalItemCount numbernumber Numero di elementi per la visualizzazione.The number of items for display.
ShowAllShowAll booleanboolean Se si desidera mostrare tutti risultati in una singola pagina.Whether to sho all results on a single page.
PageCountPageCount numbernumber Numero di pagine dei risultati.The number of pages of results.

ParametroParameter

Questa sezione descrive la rappresentazione di parameter.This section describes the parameter representation.

ProprietàProperty DescrizioneDescription TipoType
namename stringstring Nome del parametro.Parameter name.
descriptiondescription stringstring Descrizione del parametro.Parameter description.
valuevalue stringstring Valore del parametro.Parameter value.
optionsoptions matrice di valori stringarray of string Valori definiti per i valori del parametro di query.Values defined for query parameter values.
Obbligatoriarequired booleanboolean Indica se il parametro è obbligatorio o no.Specifies whether parameter is required or not.
kindkind numbernumber Se questo parametro è un parametro di percorso (1) o un parametro di stringa di query (2).Whether this parameter is a path parameter (1), or a querystring parameter (2).
typeNametypeName stringstring Tipo di parametro.Parameter type.

ProdottoProduct

L'entità product ha le proprietà seguenti.The product entity has the following properties.

ProprietàProperty TipoType DescrizioneDescription
IDId stringstring Identificatore di risorsa.Resource identifier. Identifica in modo univoco il prodotto all'interno dell'istanza del servizio Gestione API corrente.Uniquely identifies the product within the current API Management service instance. Il valore è un URL relativo valido nel formato products/{pid} dove {pid} è un identificatore di prodotto.The value is a valid relative URL in the format of products/{pid} where {pid} is a product identifier. Questa proprietà è di sola lettura.This property is read-only.
TitoloTitle stringstring Nome del prodotto.Name of the product. Non deve essere vuoto.Must not be empty. La lunghezza massima consentita è di 100 caratteri.Maximum length is 100 characters.
DescrizioneDescription stringstring Descrizione del prodotto.Description of the product. Non deve essere vuoto.Must not be empty. Può includere tag di formattazione HTML.May include HTML formatting tags. La lunghezza massima consentita è di 1000 caratteri.Maximum length is 1000 characters.
TerminiTerms stringstring Condizioni per l'utilizzo del prodotto.Product terms of use. Gli sviluppatori che tentano di sottoscrivere il prodotto vengono presentati e devono accettare queste condizioni prima di poter completare il processo di sottoscrizione.Developers trying to subscribe to the product will be presented and required to accept these terms before they can complete the subscription process.
ProductStateProductState numbernumber Specifica se il prodotto è pubblicato o no.Specifies whether the product is published or not. I prodotti pubblicati possono essere individuati dagli sviluppatori nel portale per sviluppatori.Published products are discoverable by developers on the developer portal. I prodotti non pubblicati sono visibili solo agli amministratori.Non-published products are visible only to administrators.

I valori consentiti per lo stato del prodotto sono:The allowable values for product state are:

- 0 - Not Published

- 1 - Published

- 2 - Deleted
AllowMultipleSubscriptionsAllowMultipleSubscriptions booleanboolean Specifica se un utente può avere più sottoscrizioni al prodotto nello stesso momento.Specifies whether a user can have multiple subscriptions to this product at the same time.
MultipleSubscriptionsCountMultipleSubscriptionsCount numbernumber Numero di sottoscrizioni a questo prodotto da parte dell'utente corrente.The number of subscriptions to this product by the current user.

ProviderProvider

L'entità provider ha le proprietà seguenti.The provider entity has the following properties.

ProprietàProperty TipoType DescrizioneDescription
ProprietàProperties dizionario di stringhestring dictionary Proprietà per questo provider di autenticazione.Properties for this authentication provider.
AuthenticationTypeAuthenticationType stringstring Tipo di provider.The provider type. (Azure Active Directory, account di accesso di Facebook, account Google, account Microsoft, Twitter).(Azure Active Directory, Facebook login, Google Account, Microsoft Account, Twitter).
SottotitoloCaption stringstring Nome visualizzato del provider.Display name of the provider.

RappresentazioneRepresentation

Questa sezione descrive una representation.This section describes a representation.

ProprietàProperty TipoType DescrizioneDescription
contentTypecontentType stringstring Specifica un tipo di contenuto registrato o personalizzato per questa rappresentazione, ad esempio application/xml.Specifies a registered or custom content type for this representation, e.g. application/xml.
samplesample stringstring Un esempio della rappresentazione.An example of the representation.

SottoscrizioneSubscription

L'entità subscription ha le proprietà seguenti.The subscription entity has the following properties.

ProprietàProperty TipoType DescrizioneDescription
IDId stringstring Identificatore di risorsa.Resource identifier. Identifica in modo univoco la sottoscrizione all'interno dell'istanza del servizio Gestione API corrente.Uniquely identifies the subscription within the current API Management service instance. Il valore è un URL relativo valido nel formato subscriptions/{sid} dove {sid} è un identificatore di sottoscrizione.The value is a valid relative URL in the format of subscriptions/{sid} where {sid} is a subscription identifier. Questa proprietà è di sola lettura.This property is read-only.
ProductIdProductId stringstring Identificatore di risorsa per il prodotto relativo al prodotto sottoscritto.The product resource identifier of the subscribed product. Il valore è un URL relativo valido nel formato products/{pid} dove {pid} è un identificatore di prodotto.The value is a valid relative URL in the format of products/{pid} where {pid} is a product identifier.
ProductTitleProductTitle stringstring Nome del prodotto.Name of the product. Non deve essere vuoto.Must not be empty. La lunghezza massima consentita è di 100 caratteri.Maximum length is 100 characters.
ProductDescriptionProductDescription stringstring Descrizione del prodotto.Description of the product. Non deve essere vuoto.Must not be empty. Può includere tag di formattazione HTML.May include HTML formatting tags. La lunghezza massima consentita è di 1000 caratteri.Maximum length is 1000 characters.
ProductDetailsUrlProductDetailsUrl stringstring URL relativo per i dettagli del prodotto.Relative URL to the product details.
statestate stringstring Stato della sottoscrizione.The state of the subscription. Gli stati possibili sono elencati di seguito:Possible states are:

- 0 - suspended: la sottoscrizione è bloccata e il sottoscrittore non può chiamare le API del prodotto.- 0 - suspended – the subscription is blocked, and the subscriber cannot call any APIs of the product.

- 1 - active: la sottoscrizione è attiva.- 1 - active – the subscription is active.

- 2 - expired: la sottoscrizione ha raggiunto la data di scadenza ed è stata disattivata.- 2 - expired – the subscription reached its expiration date and was deactivated.

- 3 - submitted: la richiesta di sottoscrizione è stata eseguita dallo sviluppatore, ma non è ancora stata approvata o rifiutata.- 3 - submitted – the subscription request has been made by the developer, but has not yet been approved or rejected.

- 4 - rejected: la richiesta di sottoscrizione è stata rifiutata da un amministratore.- 4 - rejected – the subscription request has been denied by an administrator.

- 5 - cancelled: la sottoscrizione è stata annullata dallo sviluppatore o dall'amministratore.- 5 - cancelled – the subscription has been cancelled by the developer or administrator.
DisplayNameDisplayName stringstring Nome visualizzato della sottoscrizione.Display name of the subscription.
CreatedDateCreatedDate dateTimedateTime Data di creazione della sottoscrizione, in formato ISO 8601: 2014-06-24T16:25:00Z.The date the subscription was created, in ISO 8601 format: 2014-06-24T16:25:00Z.
CanBeCancelledCanBeCancelled booleanboolean Se la sottoscrizione può essere annullata dall'utente corrente.Whether the subscription can be cancelled by the current user.
IsAwaitingApprovalIsAwaitingApproval booleanboolean Se la sottoscrizione è in attesa di approvazione.Whether the subscription is awaiting approval.
StartDateStartDate dateTimedateTime Data di inizio per la sottoscrizione, in formato ISO 8601: 2014-06-24T16:25:00Z.The start date for the subscription, in ISO 8601 format: 2014-06-24T16:25:00Z.
ExpirationDateExpirationDate dateTimedateTime Data di scadenza per la sottoscrizione, in formato ISO 8601: 2014-06-24T16:25:00Z.The expiration date for the subscription, in ISO 8601 format: 2014-06-24T16:25:00Z.
NotificationDateNotificationDate dateTimedateTime Data di notifica per la sottoscrizione, in formato ISO 8601: 2014-06-24T16:25:00Z.The notification date for the subscription, in ISO 8601 format: 2014-06-24T16:25:00Z.
primaryKeyprimaryKey stringstring Chiave di sottoscrizione primaria.The primary subscription key. La lunghezza massima consentita è di 256 caratteri.Maximum length is 256 characters.
secondaryKeysecondaryKey stringstring Chiave di sottoscrizione secondaria.The secondary subscription key. La lunghezza massima consentita è di 256 caratteri.Maximum length is 256 characters.
CanBeRenewedCanBeRenewed booleanboolean Se la sottoscrizione può essere rinnovata dall'utente corrente.Whether the subscription can be renewed by the current user.
HasExpiredHasExpired booleanboolean Se la sottoscrizione è scaduta.Whether the subscription has expired.
IsRejectedIsRejected booleanboolean Se la richiesta di sottoscrizione è stata negata.Whether the subscription request was denied.
CancelUrlCancelUrl stringstring URL relativo per annullare la sottoscrizione.The relative Url to cancel the subscription.
RenewUrlRenewUrl stringstring URL relativo per rinnovare la sottoscrizione.The relative Url to renew the subscription.

Riepilogo delle sottoscrizioniSubscription summary

L'entità subscription summary ha le proprietà seguenti.The subscription summary entity has the following properties.

ProprietàProperty TipoType DescrizioneDescription
IDId stringstring Identificatore di risorsa.Resource identifier. Identifica in modo univoco la sottoscrizione all'interno dell'istanza del servizio Gestione API corrente.Uniquely identifies the subscription within the current API Management service instance. Il valore è un URL relativo valido nel formato subscriptions/{sid} dove {sid} è un identificatore di sottoscrizione.The value is a valid relative URL in the format of subscriptions/{sid} where {sid} is a subscription identifier. Questa proprietà è di sola lettura.This property is read-only.
DisplayNameDisplayName stringstring Nome visualizzato della sottoscrizioneThe display name of the subscription

Informazioni sull'account utenteUser account info

L'entità user account info ha le proprietà seguenti.The user account info entity has the following properties.

ProprietàProperty TipoType DescrizioneDescription
FirstNameFirstName stringstring Nome.First name. Non deve essere vuoto.Must not be empty. La lunghezza massima consentita è di 100 caratteri.Maximum length is 100 characters.
LastNameLastName stringstring Cognome.Last name. Non deve essere vuoto.Must not be empty. La lunghezza massima consentita è di 100 caratteri.Maximum length is 100 characters.
EmailEmail stringstring Indirizzo di posta elettronica.Email address. Non deve essere vuoto e deve essere univoco all'interno dell'istanza del servizio.Must not be empty and must be unique within the service instance. La lunghezza massima consentita è di 254 caratteri.Maximum length is 254 characters.
PasswordPassword stringstring Password dell'account utente.User account password.
NameIdentifierNameIdentifier stringstring Identificatore di account, lo stesso usato per la posta elettronica dell'utente.Account identifier, the same as the user email.
ProviderNameProviderName stringstring Nome del provider di autenticazione.Authentication provider name.
IsBasicAccountIsBasicAccount booleanboolean True se l'account è stato registrato usando posta elettronica e password; false se l'account è stata registrato usando un provider.True if this account was registered using email and password; false if the account was registered using a provider.

Accesso utenteUser sign in

L'entità user sign in ha le proprietà seguenti.The user sign in entity has the following properties.

ProprietàProperty TipoType DescrizioneDescription
EmailEmail stringstring Indirizzo di posta elettronica.Email address. Non deve essere vuoto e deve essere univoco all'interno dell'istanza del servizio.Must not be empty and must be unique within the service instance. La lunghezza massima consentita è di 254 caratteri.Maximum length is 254 characters.
PasswordPassword stringstring Password dell'account utente.User account password.
ReturnUrlReturnUrl stringstring URL della pagina in cui l'utente ha fatto clic sull'accesso.The URL of the page where the user clicked sign in.
RememberMeRememberMe booleanboolean Se si desidera salvare le informazioni dell'utente corrente.Whether to save the current user's information.
RegistrationEnabledRegistrationEnabled booleanboolean Se la registrazione è abilitata.Whether registration is enabled.
DelegationEnabledDelegationEnabled booleanboolean Se l'accesso delegato è abilitato.Whether delegated sign in is enabled.
DelegationUrlDelegationUrl stringstring URL di accesso delegato, se abilitato.The delegated sign in url, if enabled.
SsoSignUpUrlSsoSignUpUrl stringstring URL di accesso Single Sign-On per l'utente, se presente.The single sign on URL for the user, if present.
AuxServiceUrlAuxServiceUrl stringstring Se l'utente corrente è un amministratore, questo è un collegamento all'istanza del servizio nel portale di Azure.If the current user is an administrator, this is a link to the service instance in the Azure portal.
ProvidersProviders Raccolta di entità Provider.Collection of Provider entities Provider di autenticazione per l'utente.The authentication providers for this user.
UserRegistrationTermsUserRegistrationTerms stringstring Condizioni che l'utente deve accettare prima dell'accesso.Terms that a user must agree to before signing in.
UserRegistrationTermsEnabledUserRegistrationTermsEnabled booleanboolean Se le condizioni sono accettate.Whether terms are enabled.

Iscrizione utenteUser sign up

L'entità user sign up ha le proprietà seguenti.The user sign up entity has the following properties.

ProprietàProperty TipoType DescrizioneDescription
PasswordConfirmPasswordConfirm booleanboolean Valore usato per il controllo dell'iscrizione sign-up.Value used by the sign-upsign-up control.
PasswordPassword stringstring Password dell'account utente.User account password.
PasswordVerdictLevelPasswordVerdictLevel numbernumber Valore usato per il controllo dell'iscrizione sign-up.Value used by the sign-upsign-up control.
UserRegistrationTermsUserRegistrationTerms stringstring Condizioni che l'utente deve accettare prima dell'accesso.Terms that a user must agree to before signing in.
UserRegistrationTermsOptionsUserRegistrationTermsOptions numbernumber Valore usato per il controllo dell'iscrizione sign-up.Value used by the sign-upsign-up control.
ConsentAcceptedConsentAccepted booleanboolean Valore usato per il controllo dell'iscrizione sign-up.Value used by the sign-upsign-up control.
EmailEmail stringstring Indirizzo di posta elettronica.Email address. Non deve essere vuoto e deve essere univoco all'interno dell'istanza del servizio.Must not be empty and must be unique within the service instance. La lunghezza massima consentita è di 254 caratteri.Maximum length is 254 characters.
FirstNameFirstName stringstring Nome.First name. Non deve essere vuoto.Must not be empty. La lunghezza massima consentita è di 100 caratteri.Maximum length is 100 characters.
LastNameLastName stringstring Cognome.Last name. Non deve essere vuoto.Must not be empty. La lunghezza massima consentita è di 100 caratteri.Maximum length is 100 characters.
UserDataUserData stringstring Valore usato per il controllo dell'iscrizione sign-up.Value used by the sign-up control.
NameIdentifierNameIdentifier stringstring Valore usato per il controllo dell'iscrizione sign-up.Value used by the sign-upsign-up control.
ProviderNameProviderName stringstring Nome del provider di autenticazione.Authentication provider name.

Passaggi successiviNext steps

Per ulteriori informazioni sull'uso dei modelli, vedere Come personalizzare il portale per sviluppatori di Gestione API usando i modelli.For more information about working with templates, see How to customize the API Management developer portal using templates.