ApiTagResourceContractProperties interface

Package:

@azure/arm-apimanagement

Propriétés du contrat API pour les ressources de balise.

Extends

ApiEntityBaseContract

Propriétés

id	Identificateur d’API sous la forme /apis/{apiId}.
name	Nom de l’API.
path	URL relative identifiant de manière unique cette API et tous ses chemins de ressources dans l’instance du service Gestion des API. Elle est ajoutée à l’URL de base du point de terminaison d’API spécifiée pendant la création de l’instance de service pour former une URL publique pour cette API.
protocols	Décrit les protocoles sur lesquels les opérations de cette API peuvent être appelées.
serviceUrl	URL absolue du service principal implémentant cette API.

Propriétés héritées

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é

id

Identificateur d’API sous la forme /apis/{apiId}.

id?: string

Valeur de propriété

string

name

Nom de l’API.

name?: string

Valeur de propriété

string

path

URL relative identifiant de manière unique cette API et tous ses chemins de ressources dans l’instance du service Gestion des API. Elle est ajoutée à l’URL de base du point de terminaison d’API spécifiée pendant la création de l’instance de service pour former une URL publique pour cette API.

path?: string

Valeur de propriété

string

protocols

Décrit les protocoles sur lesquels les opérations de cette API peuvent être appelées.

protocols?: string[]

Valeur de propriété

string[]

serviceUrl

URL absolue du service principal implémentant cette API.

serviceUrl?: string

Valeur de propriété

string

Détails de la propriété héritée

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

héritée deApiEntityBaseContract.apiRevision

apiRevisionDescription

Description de la révision de l’API.

apiRevisionDescription?: string

Valeur de propriété

string

héritée deApiEntityBaseContract.apiRevisionDescription

apiType

Type d’API.

apiType?: string

Valeur de propriété

string

héritée deApiEntityBaseContract.apiType

apiVersion

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

apiVersion?: string

Valeur de propriété

string

héritée deApiEntityBaseContract.apiVersion

apiVersionDescription

Description de la version de l’API.

apiVersionDescription?: string

Valeur de propriété

string

héritée deApiEntityBaseContract.apiVersionDescription

apiVersionSetId

Identificateur de ressource pour l’ApiVersionSet associé.

apiVersionSetId?: string

Valeur de propriété

string

héritée deApiEntityBaseContract.apiVersionSetId

authenticationSettings

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

authenticationSettings?: AuthenticationSettingsContract

Valeur de propriété

AuthenticationSettingsContract

héritée deApiEntityBaseContract.authenticationSettings

contact

Informations de contact pour l’API.

contact?: ApiContactInformation

Valeur de propriété

ApiContactInformation

héritée deApiEntityBaseContract.contact

description

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

description?: string

Valeur de propriété

string

héritée deApiEntityBaseContract.description

isCurrent

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

isCurrent?: boolean

Valeur de propriété

boolean

héritée deApiEntityBaseContract.isCurrent

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

héritée deApiEntityBaseContract.isOnline

license

Informations de licence pour l’API.

license?: ApiLicenseInformation

Valeur de propriété

ApiLicenseInformation

héritée deApiEntityBaseContract.license

subscriptionKeyParameterNames

Protocoles sur lesquels l’API est rendue disponible.

subscriptionKeyParameterNames?: SubscriptionKeyParameterNamesContract

Valeur de propriété

SubscriptionKeyParameterNamesContract

héritée deApiEntityBaseContract.subscriptionKeyParameterNames

subscriptionRequired

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

subscriptionRequired?: boolean

Valeur de propriété

boolean

héritée deApiEntityBaseContract.subscriptionRequired

termsOfServiceUrl

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

termsOfServiceUrl?: string

Valeur de propriété

string

héritée deApiEntityBaseContract.termsOfServiceUrl