ApiEntityBaseContract interface

Paquet:

@azure/arm-apimanagement

Détails du contrat de base d’API.

Propriétés

apiRevision	Décrit la révision de l’API. Si aucune valeur n’est fournie, la révision 1 par défaut est créée
apiRevisionDescription	Description de la révision de l’API.
apiType	Type d’API.
apiVersion	Indique l’identificateur de version de l’API si l’API est versionnée
apiVersionDescription	Description de la version de l’API.
apiVersionSetId	Identificateur de ressource pour l’ApiVersionSet associé.
authenticationSettings	Collection de paramètres d’authentification inclus dans cette API.
contact	Informations de contact pour l’API.
description	Description de l’API. Peut inclure des balises de mise en forme HTML.
isCurrent	Indique si la révision de l’API est la révision actuelle de l’API.
isOnline	Indique si la révision de l’API est accessible via la passerelle. REMARQUE : cette propriété ne sera pas sérialisée. Elle ne peut être remplie que par le serveur.
license	Informations de licence pour l’API.
subscriptionKeyParameterNames	Protocoles sur lesquels l’API est rendue disponible.
subscriptionRequired	Spécifie si un abonnement API ou Produit est requis pour accéder à l’API.
termsOfServiceUrl	URL vers les conditions d’utilisation de l’API. DOIT être au format d’une URL.

Détails de la propriété

apiRevision

Décrit la révision de l’API. Si aucune valeur n’est fournie, la révision 1 par défaut est créée

apiRevision?: string

Valeur de propriété

string

apiRevisionDescription

Description de la révision de l’API.

apiRevisionDescription?: string

Valeur de propriété

string

apiType

Type d’API.

apiType?: string

Valeur de propriété

string

apiVersion

Indique l’identificateur de version de l’API si l’API est versionnée

apiVersion?: string

Valeur de propriété

string

apiVersionDescription

Description de la version de l’API.

apiVersionDescription?: string

Valeur de propriété

string

apiVersionSetId

Identificateur de ressource pour l’ApiVersionSet associé.

apiVersionSetId?: string

Valeur de propriété

string

authenticationSettings

Collection de paramètres d’authentification inclus dans cette API.

authenticationSettings?: AuthenticationSettingsContract

Valeur de propriété

AuthenticationSettingsContract

contact

Informations de contact pour l’API.

contact?: ApiContactInformation

Valeur de propriété

ApiContactInformation

description

Description de l’API. Peut inclure des balises de mise en forme HTML.

description?: string

Valeur de propriété

string

isCurrent

Indique si la révision de l’API est la révision actuelle de l’API.

isCurrent?: boolean

Valeur de propriété

boolean

isOnline

Indique si la révision de l’API est accessible via la passerelle. REMARQUE : cette propriété ne sera pas sérialisée. Elle ne peut être remplie que par le serveur.

isOnline?: boolean

Valeur de propriété

boolean

license

Informations de licence pour l’API.

license?: ApiLicenseInformation

Valeur de propriété

ApiLicenseInformation

subscriptionKeyParameterNames

Protocoles sur lesquels l’API est rendue disponible.

subscriptionKeyParameterNames?: SubscriptionKeyParameterNamesContract

Valeur de propriété

SubscriptionKeyParameterNamesContract

subscriptionRequired

Spécifie si un abonnement API ou Produit est requis pour accéder à l’API.

subscriptionRequired?: boolean

Valeur de propriété

boolean

termsOfServiceUrl

URL vers les conditions d’utilisation de l’API. DOIT être au format d’une URL.

termsOfServiceUrl?: string

Valeur de propriété

string