ApiContract interface

Package:

@azure/arm-apimanagement

Détails de l’API.

Extends

ProxyResource

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.
apiVersionSet	Détails du jeu de versions
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.
displayName	Nom de l’API. Doit être de 1 à 300 caractères.
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.
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. Ne peut pas comporter plus de 2 000 caractères.
sourceApiId	Identificateur d’API de l’API source.
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.

Propriétés héritées

id	ID de ressource complet pour la ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} REMARQUE : cette propriété ne sera pas sérialisée. Elle ne peut être remplie que par le serveur.
name	Nom de la ressource REMARQUE : cette propriété ne sera pas sérialisée. Elle ne peut être remplie que par le serveur.
type	Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts » REMARQUE : cette propriété ne sera pas sérialisée. Elle ne peut être remplie que par le serveur.

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

apiVersionSet

Détails du jeu de versions

apiVersionSet?: ApiVersionSetContractDetails

Valeur de propriété

ApiVersionSetContractDetails

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

displayName

Nom de l’API. Doit être de 1 à 300 caractères.

displayName?: 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

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. Ne peut pas comporter plus de 2 000 caractères.

serviceUrl?: string

Valeur de propriété

string

sourceApiId

Identificateur d’API de l’API source.

sourceApiId?: string

Valeur de propriété

string

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

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

id

ID de ressource complet pour la ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} REMARQUE : cette propriété ne sera pas sérialisée. Elle ne peut être remplie que par le serveur.

id?: string

Valeur de propriété

string

héritée deProxyResource.id

name

Nom de la ressource REMARQUE : cette propriété ne sera pas sérialisée. Elle ne peut être remplie que par le serveur.

name?: string

Valeur de propriété

string

héritée deProxyResource.name

type

Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts » REMARQUE : cette propriété ne sera pas sérialisée. Elle ne peut être remplie que par le serveur.

type?: string

Valeur de propriété

string

héritée deProxyResource.type