Freigeben über

ApiCreateOrUpdateProperties interface

  • Referenz
Paket:
@azure/arm-apimanagement

API-Eigenschaften erstellen oder aktualisieren.

Extends
ApiContractProperties

Eigenschaften

format

Format des Inhalts, in den die API importiert wird.
soapApiType

Typ der zu erstellenden API.

  • http erstellt eine REST-API
  • soap erstellt eine SOAP-Passthrough-API
  • websocket Erstellt websocket-API
  • graphqlerstellt GraphQL-API.
translateRequiredQueryParametersConduct

Strategie der Übersetzung erforderlicher Abfrageparameter in Vorlagenparameter. Standardmäßig hat der Wert "template". Mögliche Werte: "template", "query"
value

Inhaltswert beim Importieren einer API.
wsdlSelector

Kriterien, um den Import von WSDL auf eine Teilmenge des Dokuments zu beschränken.

Geerbte Eigenschaften

apiRevision

Beschreibt die Revision der API. Wenn kein Wert angegeben wird, wird die Standardrevision 1 erstellt.
apiRevisionDescription

Beschreibung der API-Revision.
apiType

Art der API.
apiVersion

Gibt den Versionsbezeichner der API an, wenn die API versioniert ist.
apiVersionDescription

Beschreibung der API-Version.
apiVersionSet

Versionssatzdetails
apiVersionSetId

Ein Ressourcenbezeichner für das zugehörige ApiVersionSet.
authenticationSettings

Sammlung von Authentifizierungseinstellungen, die in dieser API enthalten sind.
contact

Kontaktinformationen für die API.
description

Beschreibung der API. Kann HTML-Formatierungstags umfassen.
displayName

API-Name. Muss 1 bis 300 Zeichen lang sein.
isCurrent

Gibt an, ob die API-Revision die aktuelle API-Revision ist.
isOnline

Gibt an, ob auf die API-Revision über das Gateway zugegriffen werden kann. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden.
license

Lizenzinformationen für die API.
path

Relative URL, die diese API und all ihre Ressourcenpfade in der Instanz des API Management-Diensts eindeutig identifiziert. Sie wird an die Basis-URL des API-Endpunkts angehängt, die während der Dienstinstanzerstellung angegeben wurde, um eine öffentliche URL für diese API zu erstellen.
protocols

Beschreibt, über welche Protokolle die Vorgänge in dieser API aufgerufen werden können.
serviceUrl

Absolute URL des Back-End-Diensts, der diese API implementiert. Darf nicht mehr als 2000 Zeichen lang sein.
sourceApiId

API-Bezeichner der Quell-API.
subscriptionKeyParameterNames

Protokolle, für die die API verfügbar gemacht wird.
subscriptionRequired

Gibt an, ob ein API- oder Produktabonnement für den Zugriff auf die API erforderlich ist.
termsOfServiceUrl

Eine URL zu den Nutzungsbedingungen für die API. MUSS im Format einer URL vorliegen.

Details zur Eigenschaft

format

Format des Inhalts, in den die API importiert wird.

format?: string

Eigenschaftswert

string

soapApiType

Typ der zu erstellenden API.

  • http erstellt eine REST-API
  • soap erstellt eine SOAP-Passthrough-API
  • websocket Erstellt websocket-API
  • graphqlerstellt GraphQL-API.
soapApiType?: string

Eigenschaftswert

string

translateRequiredQueryParametersConduct

Strategie der Übersetzung erforderlicher Abfrageparameter in Vorlagenparameter. Standardmäßig hat der Wert "template". Mögliche Werte: "template", "query"

translateRequiredQueryParametersConduct?: string

Eigenschaftswert

string

value

Inhaltswert beim Importieren einer API.

value?: string

Eigenschaftswert

string

wsdlSelector

Kriterien, um den Import von WSDL auf eine Teilmenge des Dokuments zu beschränken.

wsdlSelector?: ApiCreateOrUpdatePropertiesWsdlSelector

Eigenschaftswert

ApiCreateOrUpdatePropertiesWsdlSelector

Geerbte Eigenschaftsdetails

apiRevision

Beschreibt die Revision der API. Wenn kein Wert angegeben wird, wird die Standardrevision 1 erstellt.

apiRevision?: string

Eigenschaftswert

string

Geerbt vonApiContractProperties.apiRevision

apiRevisionDescription

Beschreibung der API-Revision.

apiRevisionDescription?: string

Eigenschaftswert

string

Geerbt vonApiContractProperties.apiRevisionDescription

apiType

Art der API.

apiType?: string

Eigenschaftswert

string

Geerbt vonApiContractProperties.apiType

apiVersion

Gibt den Versionsbezeichner der API an, wenn die API versioniert ist.

apiVersion?: string

Eigenschaftswert

string

Geerbt vonApiContractProperties.apiVersion

apiVersionDescription

Beschreibung der API-Version.

apiVersionDescription?: string

Eigenschaftswert

string

Geerbt vonApiContractProperties.apiVersionDescription

apiVersionSet

Versionssatzdetails

apiVersionSet?: ApiVersionSetContractDetails

Eigenschaftswert

ApiVersionSetContractDetails

Geerbt vonApiContractProperties.apiVersionSet

apiVersionSetId

Ein Ressourcenbezeichner für das zugehörige ApiVersionSet.

apiVersionSetId?: string

Eigenschaftswert

string

Geerbt vonApiContractProperties.apiVersionSetId

authenticationSettings

Sammlung von Authentifizierungseinstellungen, die in dieser API enthalten sind.

authenticationSettings?: AuthenticationSettingsContract

Eigenschaftswert

AuthenticationSettingsContract

Geerbt vonApiContractProperties.authenticationSettings

contact

Kontaktinformationen für die API.

contact?: ApiContactInformation

Eigenschaftswert

ApiContactInformation

Geerbt vonApiContractProperties.contact

description

Beschreibung der API. Kann HTML-Formatierungstags umfassen.

description?: string

Eigenschaftswert

string

Geerbt vonApiContractProperties.description

displayName

API-Name. Muss 1 bis 300 Zeichen lang sein.

displayName?: string

Eigenschaftswert

string

Geerbt vonApiContractProperties.displayName

isCurrent

Gibt an, ob die API-Revision die aktuelle API-Revision ist.

isCurrent?: boolean

Eigenschaftswert

boolean

Geerbt vonApiContractProperties.isCurrent

isOnline

Gibt an, ob auf die API-Revision über das Gateway zugegriffen werden kann. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden.

isOnline?: boolean

Eigenschaftswert

boolean

Geerbt vonApiContractProperties.isOnline

license

Lizenzinformationen für die API.

license?: ApiLicenseInformation

Eigenschaftswert

ApiLicenseInformation

Geerbt vonApiContractProperties.license

path

Relative URL, die diese API und all ihre Ressourcenpfade in der Instanz des API Management-Diensts eindeutig identifiziert. Sie wird an die Basis-URL des API-Endpunkts angehängt, die während der Dienstinstanzerstellung angegeben wurde, um eine öffentliche URL für diese API zu erstellen.

path: string

Eigenschaftswert

string

Geerbt vonApiContractProperties.path

protocols

Beschreibt, über welche Protokolle die Vorgänge in dieser API aufgerufen werden können.

protocols?: string[]

Eigenschaftswert

string[]

Geerbt vonApiContractProperties.protocols

serviceUrl

Absolute URL des Back-End-Diensts, der diese API implementiert. Darf nicht mehr als 2000 Zeichen lang sein.

serviceUrl?: string

Eigenschaftswert

string

Geerbt vonApiContractProperties.serviceUrl

sourceApiId

API-Bezeichner der Quell-API.

sourceApiId?: string

Eigenschaftswert

string

Geerbt vonApiContractProperties.sourceApiId

subscriptionKeyParameterNames

Protokolle, für die die API verfügbar gemacht wird.

subscriptionKeyParameterNames?: SubscriptionKeyParameterNamesContract

Eigenschaftswert

SubscriptionKeyParameterNamesContract

Geerbt vonApiContractProperties.subscriptionKeyParameterNames

subscriptionRequired

Gibt an, ob ein API- oder Produktabonnement für den Zugriff auf die API erforderlich ist.

subscriptionRequired?: boolean

Eigenschaftswert

boolean

Geerbt vonApiContractProperties.subscriptionRequired

termsOfServiceUrl

Eine URL zu den Nutzungsbedingungen für die API. MUSS im Format einer URL vorliegen.

termsOfServiceUrl?: string

Eigenschaftswert

string

Geerbt vonApiContractProperties.termsOfServiceUrl