Partager via

ApiCreateOrUpdateProperties interface

  • Référence
Paquet:
@azure/arm-apimanagement

Propriétés de création ou de mise à jour de l’API.

Extends
ApiContractProperties

Propriétés

format

Format du contenu dans lequel l’API est importée.
soapApiType

Type d’API à créer.

  • http crée une API REST
  • soap crée une API directe SOAP
  • websocket crée l’API websocket
  • graphqlcrée GraphQL API.
translateRequiredQueryParametersConduct

Stratégie de traduction des paramètres de requête requis en modèles. Par défaut, a la valeur 'template'. Valeurs possibles : 'template', 'query'
value

Valeur de contenu lors de l’importation d’une API.
wsdlSelector

Critères pour limiter l’importation de WSDL dans un sous-ensemble du document.

Propriétés héritées

apiRevision

Décrit la révision de l’API. Si aucune valeur n’est fournie, la révision par défaut 1 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 des paramètres d’authentification inclus dans cette API.
contact

Coordonnées de l’API.
description

Description de l’API. Peut comporter des balises de mise en forme.
displayName

Nom de l’API. Doit contenir 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. Il ne peut être rempli que par le serveur.
license

Informations de licence pour l’API.
path

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

Indique sur quels protocoles les opérations dans cette API peuvent être appelées.
serviceUrl

URL absolue du service principal qui implémente cette API. Ne peut pas dépasser 2 000 caractères.
sourceApiId

Identificateur d’API de l’API source.
subscriptionKeyParameterNames

Protocoles sur lesquels l’API est mise à disposition.
subscriptionRequired

Spécifie si un abonnement à l’API ou au 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é

format

Format du contenu dans lequel l’API est importée.

format?: string

Valeur de propriété

string

soapApiType

Type d’API à créer.

  • http crée une API REST
  • soap crée une API directe SOAP
  • websocket crée l’API websocket
  • graphqlcrée GraphQL API.
soapApiType?: string

Valeur de propriété

string

translateRequiredQueryParametersConduct

Stratégie de traduction des paramètres de requête requis en modèles. Par défaut, a la valeur 'template'. Valeurs possibles : 'template', 'query'

translateRequiredQueryParametersConduct?: string

Valeur de propriété

string

value

Valeur de contenu lors de l’importation d’une API.

value?: string

Valeur de propriété

string

wsdlSelector

Critères pour limiter l’importation de WSDL dans un sous-ensemble du document.

wsdlSelector?: ApiCreateOrUpdatePropertiesWsdlSelector

Valeur de propriété

ApiCreateOrUpdatePropertiesWsdlSelector

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 par défaut 1 est créée

apiRevision?: string

Valeur de propriété

string

Héritéd’ApiContractProperties.apiRevision

apiRevisionDescription

Description de la révision de l’API.

apiRevisionDescription?: string

Valeur de propriété

string

Héritéd’ApiContractProperties.apiRevisionDescription

apiType

Type d’API.

apiType?: string

Valeur de propriété

string

Héritéd’ApiContractProperties.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éd’ApiContractProperties.apiVersion

apiVersionDescription

Description de la version de l’API.

apiVersionDescription?: string

Valeur de propriété

string

Héritéd’ApiContractProperties.apiVersionDescription

apiVersionSet

Détails du jeu de versions

apiVersionSet?: ApiVersionSetContractDetails

Valeur de propriété

ApiVersionSetContractDetails

Héritéd’ApiContractProperties.apiVersionSet

apiVersionSetId

Identificateur de ressource pour l’ApiVersionSet associé.

apiVersionSetId?: string

Valeur de propriété

string

Héritéd’ApiContractProperties.apiVersionSetId

authenticationSettings

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

authenticationSettings?: AuthenticationSettingsContract

Valeur de propriété

AuthenticationSettingsContract

Héritéd’ApiContractProperties.authenticationSettings

contact

Coordonnées de l’API.

contact?: ApiContactInformation

Valeur de propriété

ApiContactInformation

Héritéd’ApiContractProperties.contact

description

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

description?: string

Valeur de propriété

string

Héritéd’ApiContractProperties.description

displayName

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

displayName?: string

Valeur de propriété

string

Héritéd’ApiContractProperties.displayName

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éd’ApiContractProperties.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. Il ne peut être rempli que par le serveur.

isOnline?: boolean

Valeur de propriété

boolean

Héritéd’ApiContractProperties.isOnline

license

Informations de licence pour l’API.

license?: ApiLicenseInformation

Valeur de propriété

ApiLicenseInformation

Héritéd’ApiContractProperties.license

path

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.

path: string

Valeur de propriété

string

Héritéd’ApiContractProperties.path

protocols

Indique sur quels protocoles les opérations dans cette API peuvent être appelées.

protocols?: string[]

Valeur de propriété

string[]

Héritéd’ApiContractProperties.protocols

serviceUrl

URL absolue du service principal qui implémente cette API. Ne peut pas dépasser 2 000 caractères.

serviceUrl?: string

Valeur de propriété

string

Héritéd’ApiContractProperties.serviceUrl

sourceApiId

Identificateur d’API de l’API source.

sourceApiId?: string

Valeur de propriété

string

Héritéd’ApiContractProperties.sourceApiId

subscriptionKeyParameterNames

Protocoles sur lesquels l’API est mise à disposition.

subscriptionKeyParameterNames?: SubscriptionKeyParameterNamesContract

Valeur de propriété

SubscriptionKeyParameterNamesContract

Héritéd’ApiContractProperties.subscriptionKeyParameterNames

subscriptionRequired

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

subscriptionRequired?: boolean

Valeur de propriété

boolean

Héritéd’ApiContractProperties.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éd’ApiContractProperties.termsOfServiceUrl