Partager via

Référence du modèle de données du modèle Gestion des API Azure

  • Article

Cette rubrique décrit les représentations de type et d’entité des éléments courants utilisés dans les modèles de données pour les modèles du portail des développeurs dans la Gestion des API Azure.

Pour plus d’informations sur l’utilisation de modèles, consultez la page Guide pratique de personnalisation du portail des développeurs Gestion des API à l’aide de modèles.

Notes

Le contenu de la documentation suivante s’applique au portail des développeurs déconseillé. Vous pouvez continuer à l’utiliser normalement jusqu’à sa suppression en octobre 2023, lorsqu’il sera supprimé de tous les services de gestion des API. Le portail déprécié recevra uniquement les mises à jour de sécurité critiques. Pour plus d’informations, consultez les articles suivants :

Disponibilité

Important

Cette fonctionnalité est disponible dans les niveaux Premium, Standard, De base et Développeur de Gestion des API.

Pour connaître la disponibilité des fonctionnalités dans les niveaux v2 (préversion), consultez vue d’ensemble des niveaux v2.

Informations de référence

API

L’entité API a les propriétés suivantes :

Propriété Type Description
id string Identificateur de ressource. Identifie exclusivement l’API dans l’instance de service Gestion des API actuelle. La valeur est une URL relative valide au format apis/{id}, où {id} est un identificateur d’API. Cette propriété est en lecture seule.
name string Nom de l’API. Ne doit pas être vide. La longueur maximale est de 100 caractères.
description string Description de l’API. Ne doit pas être vide. Peut comporter des balises de mise en forme. La longueur maximale est de 1 000 caractères.
serviceUrl string URL absolue du service principal qui implémente cette API.
path string URL relative identifiant exclusivement cette API et tous les chemins d’accès à ses ressources au sein de l’instance de service Gestion des API. Elle est ajoutée à l’URL de base du point de terminaison d’API spécifiée lors de la création de l’instance de service pour former l’URL publique de cette API.
protocols tableau de nombres Indique sur quels protocoles les opérations dans cette API peuvent être appelées. Les valeurs autorisées sont 1 - http et 2 - https, ou les deux.
authenticationSettings Paramètres d’authentification du serveur d’autorisation Collection de paramètres d’authentification inclus dans cette API.
subscriptionKeyParameterNames object Propriété facultative utilisable pour donner des noms personnalisés aux paramètres de requête et/ou d’en-tête contenant la clé de l’abonnement. Lorsque cette propriété est présente, elle doit contenir au moins une des deux propriétés suivantes.

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

Résumé des API

L’entité API summary a les propriétés suivantes :

Propriété Type Description
id string Identificateur de ressource. Identifie exclusivement l’API dans l’instance de service Gestion des API actuelle. La valeur est une URL relative valide au format apis/{id}, où {id} est un identificateur d’API. Cette propriété est en lecture seule.
name string Nom de l’API. Ne doit pas être vide. La longueur maximale est de 100 caractères.
description string Description de l’API. Ne doit pas être vide. Peut comporter des balises de mise en forme. La longueur maximale est de 1 000 caractères.

Application

L’entité application a les propriétés suivantes :

Propriété Type Description
Id string Identificateur unique de l’application.
Title string Titre de l’application.
Description string Description de l’application.
Url URI URI de l’application.
Version string Informations de version de l’application.
Requirements string Description des conditions requises de l’application.
State nombre État actuel de l’application.

- 0 - Inscrite

- 1 - Soumise

- 2 - Publiée

- 3 - Rejetée

- 4 - Non publiée
RegistrationDate DateTime Date et heure auxquelles l’application a été inscrite.
CategoryId nombre Catégorie de l’application (finance, divertissement, etc.).
DeveloperId string Identificateur unique du développeur qui a soumis l’application.
Attachments Collection d’entités Attachment. Pièces jointes de l’application, telles que des captures d’écran ou des icônes.
Icon Attachment Icône de l’application.

Pièce jointe

L’entité attachment a les propriétés suivantes :

Propriété Type Description
UniqueId string Identificateur unique de la pièce jointe.
Url string URL de la ressource.
Type string Type de pièce jointe.
ContentType string Type de média de la pièce jointe.

Exemple de code

Propriété Type Description
title string Nom de l'opération.
snippet string Cette propriété est déconseillée et ne doit pas être utilisée.
brush string Modèle de coloration de la syntaxe de code à utiliser pour afficher l’exemple de code. Les valeurs autorisées sont plain, php, java, xml, objc, python, ruby et csharp.
template string Nom de ce modèle d’exemple de code.
body string Espace réservé de la portion d’exemple de code de l’extrait de code.
method string Méthode HTTP de l’opération.
scheme string Protocole à utiliser pour la demande d’opération.
path string Chemin de l’opération.
query string Exemple de chaîne de requête avec des paramètres définis.
host string URL de la passerelle du service Gestion des API de l’API qui contient cette opération.
headers Collection d’entités Header. En-têtes de cette opération.
parameters Collection d’entités Parameter. Paramètres définis pour cette opération.

Comment

L’entité API a les propriétés suivantes :

Propriété Type Description
Id nombre ID du commentaire.
CommentText string Corps du commentaire. Peut comporter du code HTML.
DeveloperCompany string Nom de l’entreprise du développeur.
PostedOn DateTime Date et l’heure auxquelles le commentaire a été publié.

Problème

L’entité issue a les propriétés suivantes :

Propriété Type Description
Id string Identificateur unique du problème.
ApiID string ID de l’API pour laquelle ce problème a été signalé.
Title string Titre du problème.
Description string Description du problème.
SubscriptionDeveloperName string Prénom du développeur qui a signalé le problème.
IssueState string État actuel du problème. Les valeurs possibles sont Proposed, Opened et Closed (Proposé, Ouvert et Fermé).
ReportedOn DateTime Date et heure auxquelles le problème a été signalé.
Comments Collection d’entités Comment. Commentaires sur ce problème.
Attachments Collection d’entités Attachment. Pièces jointes à ce problème.
Services Collection d’entités API. API auxquelles l’utilisateur qui a consigné le problème est abonné.

Filtrage

L’entité filtering a les propriétés suivantes :

Propriété Type Description
Pattern string Terme de recherche actuel ; ou null en l’absence de terme de recherche.
Placeholder string Texte à afficher dans la zone de recherche si aucun terme de recherche n’est spécifié.

Cette section décrit la représentation parameter.

Propriété Type Description
name string Nom du paramètre.
description string Description du paramètre.
value string Valeur de l’en-tête.
typeName string Type de données de la valeur d’en-tête.
options string Options.
required boolean Indique si l’en-tête est requis.
readOnly boolean Indique si l’en-tête est en lecture seule.

Demande HTTP

Cette section décrit la représentation request.

Propriété Type Description
description string Description de la demande d’opération.
headers tableau d’entités Header. En-têtes de demande.
parameters tableau de Parameter Collection de paramètres de demande d’opération.
representations tableau de Representation Collection de représentations de demande d’opération.

Réponse HTTP

Cette section décrit la représentation response.

Propriété Type Description
statusCode entier positif Code de statut de la réponse de l’opération.
description string Description de la réponse de l’opération.
representations tableau de Representation Collection de représentations de la réponse de l’opération.

Opération

L’entité operation a les propriétés suivantes :

Propriété Type Description
id string Identificateur de ressource. Identifie exclusivement l’opération dans l’instance de service Gestion des API actuelle. La valeur est une URL relative valide au format apis/{aid}/operations/{id}, où {aid} est un identificateur d’API et {id} un identificateur d’opération. Cette propriété est en lecture seule.
name string Nom de l’opération. Ne doit pas être vide. La longueur maximale est de 100 caractères.
description string Description de l’opération. Ne doit pas être vide. Peut comporter des balises de mise en forme. La longueur maximale est de 1 000 caractères.
scheme string Indique sur quels protocoles les opérations dans cette API peuvent être appelées. Les valeurs autorisées sont http, https, ou à la fois http et https.
uriTemplate string Modèle d’URL relative identifiant la ressource cible de cette opération. Peut comporter des paramètres. Exemple : customers/{cid}/orders/{oid}/?date={date}
host string URL de la passerelle de la Gestion des API qui héberge l’API.
httpMethod string Méthode HTTP de l’opération.
request Demande HTTP Entité qui contient les détails de la demande.
responses tableau de HTTP Response Tableau d’entités HTTP Response de l’opération.

L’entité operation menu a les propriétés suivantes :

Propriété Type Description
ApiId string ID de l’API actuelle.
CurrentOperationId string ID de l’opération actuelle.
Action string Type de menu.
MenuItems Collection d’entités Operation menu item. Opérations de l’API actuelle.

L’entité operation menu item a les propriétés suivantes :

Propriété Type Description
Id string ID de l’opération.
Title string Description de l’opération.
HttpMethod string Méthode HTTP de l’opération.

Pagination

L’entité paging a les propriétés suivantes :

Propriété Type Description
Page nombre Numéro de page actuel.
PageSize nombre Maximum de résultats à afficher sur une seule page.
TotalItemCount nombre Nombre d’éléments à afficher.
ShowAll boolean Indique si tous les résultats doivent être affichés sur une seule page.
PageCount nombre Nombre de pages de résultats.

Paramètre

Cette section décrit la représentation parameter.

Propriété Type Description
name string Nom du paramètre.
description string Description du paramètre.
value string Valeur du paramètre.
options tableau de chaînes Valeurs définies pour les valeurs du paramètre de requête.
required boolean Indique si le paramètre est obligatoire ou non.
kind nombre Indique si ce paramètre est un paramètre de chemin d’accès (1) ou un paramètre de chaîne de requête (2).
typeName string Type de paramètre.

Produit

L’entité product a les propriétés suivantes :

Propriété Type Description
Id string Identificateur de ressource. Identifie exclusivement le produit dans l’instance de service Gestion des API actuelle. La valeur est une URL relative valide au format products/{pid}, où {pid} est un identificateur de produit. Cette propriété est en lecture seule.
Title string Nom du produit. Ne doit pas être vide. La longueur maximale est de 100 caractères.
Description string Description du produit. Ne doit pas être vide. Peut comporter des balises de mise en forme. La longueur maximale est de 1 000 caractères.
Terms string Conditions d’utilisation du produit. Les développeurs qui veulent s’abonner au produit devront consulter et accepter ces conditions pour pouvoir terminer le processus d’abonnement.
ProductState nombre Spécifie si le produit est publié ou non. Les produits publiés sont détectables par les développeurs sur le portail des développeurs. Les produits non publiés ne sont visibles que pour les administrateurs.

Les valeurs autorisées pour l’état du produit sont :

- 0 - Not Published

- 1 - Published

- 2 - Deleted
AllowMultipleSubscriptions boolean Spécifie si un utilisateur peut avoir plusieurs abonnements à ce produit en même temps.
MultipleSubscriptionsCount nombre Nombre maximal d’abonnements à ce produit qu’un utilisateur est autorisé à avoir simultanément.

Fournisseur

L’entité provider a les propriétés suivantes :

Propriété Type Description
Properties dictionnaire de chaînes Propriétés de ce fournisseur d’authentification.
AuthenticationType string Type de fournisseur. (ID Microsoft Entra, connexion Facebook, compte Google, compte Microsoft, Twitter).
Caption string Nom complet du fournisseur.

Représentation

Cette section décrit une representation.

Propriété Type Description
contentType string Spécifie un type de contenu inscrit ou personnalisé pour cette représentation, par exemple, application/xml.
sample string Exemple de la représentation.

Abonnement

L’entité subscription a les propriétés suivantes :

Propriété Type Description
Id string Identificateur de ressource. Identifie exclusivement l’abonnement dans l’instance de service Gestion des API actuelle. La valeur est une URL relative valide au format subscriptions/{sid}, où {sid} est un identificateur d’abonnement. Cette propriété est en lecture seule.
ProductId string Identificateur de ressource du produit concerné par l’abonnement. La valeur est une URL relative valide au format products/{pid}, où {pid} est un identificateur de produit.
ProductTitle string Nom du produit. Ne doit pas être vide. La longueur maximale est de 100 caractères.
ProductDescription string Description du produit. Ne doit pas être vide. Peut comporter des balises de mise en forme. La longueur maximale est de 1 000 caractères.
ProductDetailsUrl string URL relative des détails du produit.
state string État de l’abonnement. Les états possibles sont :

- 0 - suspended : l’abonnement est bloqué et l’abonné ne peut appeler aucune API du produit.

- 1 - active : l’abonnement est actif.

- 2 - expired : l’abonnement a atteint sa date d’expiration et a été désactivé.

- 3 - submitted : la demande d’abonnement a été effectuée par le développeur, mais n’a pas encore été approuvée ou rejetée.

- 4 - rejected : la demande d’abonnement a été refusée par un administrateur.

- 5 - cancelled : l’abonnement a été annulé par le développeur ou l’administrateur.
DisplayName string Nom complet de l’abonnement.
CreatedDate dateTime Date à laquelle l’abonnement a été créé, au format ISO 8601 : 2014-06-24T16:25:00Z.
CanBeCancelled boolean Si l’abonnement peut être annulé par l’utilisateur actuel.
IsAwaitingApproval boolean Indique si l’abonnement est en attente d’approbation.
StartDate dateTime Date de début de l’abonnement, au format ISO 8601 : 2014-06-24T16:25:00Z.
ExpirationDate dateTime Date d’expiration de l’abonnement, au format ISO 8601 : 2014-06-24T16:25:00Z.
NotificationDate dateTime Date de notification de l’abonnement, au format ISO 8601 : 2014-06-24T16:25:00Z.
primaryKey string Clé primaire de l’abonnement. La longueur maximale est de 256 caractères.
secondaryKey string Clé secondaire de l’abonnement. La longueur maximale est de 256 caractères.
CanBeRenewed boolean Indique si l’abonnement peut être renouvelé par l’utilisateur actuel.
HasExpired boolean Indique si l’abonnement a expiré.
IsRejected boolean Indique si la demande d’abonnement a été refusée.
CancelUrl string URL relative pour annuler l’abonnement.
RenewUrl string URL relative pour renouveler l’abonnement.

Subscription summary

L’entité subscription summary a les propriétés suivantes :

Propriété Type Description
Id string Identificateur de ressource. Identifie exclusivement l’abonnement dans l’instance de service Gestion des API actuelle. La valeur est une URL relative valide au format subscriptions/{sid}, où {sid} est un identificateur d’abonnement. Cette propriété est en lecture seule.
DisplayName string Nom complet de l’abonnement.

User account info

L’entité user account info a les propriétés suivantes :

Propriété Type Description
FirstName string Prénom. Ne doit pas être vide. La longueur maximale est de 100 caractères.
LastName string Nom. Ne doit pas être vide. La longueur maximale est de 100 caractères.
Email string Adresse e-mail. Ne doit pas être vide et doit être unique au sein de l’instance de service. La longueur maximale est de 254 caractères.
Password string Mot de passe du compte d’utilisateur.
NameIdentifier string Identificateur du compte, identique à l’adresse de messagerie de l’utilisateur.
ProviderName string Nom du fournisseur d’authentification.
IsBasicAccount boolean True si ce compte a été inscrit avec une adresse de messagerie et un mot de passe ; False si le compte a été inscrit à l’aide d’un fournisseur.

Connexion de l’utilisateur

L’entité user sign in a les propriétés suivantes :

Propriété Type Description
Email string Adresse e-mail. Ne doit pas être vide et doit être unique au sein de l’instance de service. La longueur maximale est de 254 caractères.
Password string Mot de passe du compte d’utilisateur.
ReturnUrl string URL de la page sur laquelle l’utilisateur a cliqué sur Se connecter.
RememberMe boolean Indique si les informations de l’utilisateur actuel doivent être enregistrées.
RegistrationEnabled boolean Indique si l’inscription est activée.
DelegationEnabled boolean Indique si la connexion déléguée est activée.
DelegationUrl string URL de la connexion déléguée, si elle est activée.
SsoSignUpUrl string URL d’authentification unique de l’utilisateur, le cas échéant.
AuxServiceUrl string Si l’utilisateur actuel est administrateur, lien vers l’instance de service dans le portail Azure.
Providers Collection d’entités Provider. Fournisseurs d’authentification de cet utilisateur.
UserRegistrationTerms string Conditions qu’un utilisateur doit accepter pour pouvoir se connecter.
UserRegistrationTermsEnabled boolean Indique si les conditions sont activées.

User sign up

L’entité user sign up a les propriétés suivantes :

Propriété Type Description
PasswordConfirm boolean Valeur utilisée par le contrôle d’inscription.
Password string Mot de passe du compte d’utilisateur.
PasswordVerdictLevel nombre Valeur utilisée par le contrôle d’inscription.
UserRegistrationTerms string Conditions qu’un utilisateur doit accepter pour pouvoir se connecter.
UserRegistrationTermsOptions nombre Valeur utilisée par le contrôle d’inscription.
ConsentAccepted boolean Valeur utilisée par le contrôle d’inscription.
Email string Adresse e-mail. Ne doit pas être vide et doit être unique au sein de l’instance de service. La longueur maximale est de 254 caractères.
FirstName string Prénom. Ne doit pas être vide. La longueur maximale est de 100 caractères.
LastName string Nom. Ne doit pas être vide. La longueur maximale est de 100 caractères.
UserData string Valeur utilisée par le contrôle d’inscription.
NameIdentifier string Valeur utilisée par le contrôle d’inscription.
ProviderName string Nom du fournisseur d’authentification.

Étapes suivantes

Pour plus d’informations sur l’utilisation de modèles, consultez la page Guide pratique de personnalisation du portail des développeurs Gestion des API à l’aide de modèles.