Freigeben über

ApiCreateOrUpdateParameter interface

Paket:
@azure/arm-apimanagement

API-Parameter erstellen oder aktualisieren.

Eigenschaften

apiRevision

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

Beschreibung der API-Revision.
apiType

API-Typ.
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 enthalten.
displayName

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

Format des Inhalts, in dem die API importiert wird. Neue Formate können in Zukunft hinzugefügt werden
isCurrent

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

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

Lizenzinformationen für die API.
path

Relative URL identifiziert diese API und alle zugehörigen Ressourcenpfade innerhalb der API-Verwaltungsdienstinstanz eindeutig. Sie wird an die API-Endpunktbasis-URL angefügt, die während der Erstellung der Dienstinstanz angegeben wurde, um eine öffentliche URL für diese API zu bilden.
protocols

Beschreibt, welche Protokolle die Vorgänge in dieser API aufrufen können.
provisioningState

Der Bereitstellungsstatus HINWEIS: Diese Eigenschaft wird nicht serialisiert. Er kann nur vom Server aufgefüllt werden.
serviceUrl

Absolute URL des Back-End-Diensts, der diese API implementiert. Maximal 2000 Zeichen lang.
soapApiType

Typ der zu erstellenden API.

  • http erstellt eine REST-API
  • soap erstellt eine SOAP-Pass-Through-API
  • websocket erstellt websocket-API
  • graphql erstellt die GraphQL-API. Neue Typen können in Zukunft hinzugefügt werden.
sourceApiId

API-ID der Quell-API.
subscriptionKeyParameterNames

Protokolle, über die API verfügbar gemacht wird.
subscriptionRequired

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

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

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

Inhaltswert beim Importieren einer API.
wsdlSelector

Kriterien zum Einschränken des Imports von WSDL in eine Teilmenge des Dokuments.

Details zur Eigenschaft

apiRevision

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

apiRevision?: string

Eigenschaftswert

string

apiRevisionDescription

Beschreibung der API-Revision.

apiRevisionDescription?: string

Eigenschaftswert

string

apiType

API-Typ.

apiType?: string

Eigenschaftswert

string

apiVersion

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

apiVersion?: string

Eigenschaftswert

string

apiVersionDescription

Beschreibung der API-Version.

apiVersionDescription?: string

Eigenschaftswert

string

apiVersionSet

Versionssatzdetails

apiVersionSet?: ApiVersionSetContractDetails

Eigenschaftswert

ApiVersionSetContractDetails

apiVersionSetId

Ein Ressourcenbezeichner für das zugehörige ApiVersionSet.

apiVersionSetId?: string

Eigenschaftswert

string

authenticationSettings

Sammlung von Authentifizierungseinstellungen, die in dieser API enthalten sind.

authenticationSettings?: AuthenticationSettingsContract

Eigenschaftswert

AuthenticationSettingsContract

contact

Kontaktinformationen für die API.

contact?: ApiContactInformation

Eigenschaftswert

ApiContactInformation

description

Beschreibung der API. Kann HTML-Formatierungstags enthalten.

description?: string

Eigenschaftswert

string

displayName

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

displayName?: string

Eigenschaftswert

string

format

Format des Inhalts, in dem die API importiert wird. Neue Formate können in Zukunft hinzugefügt werden

format?: string

Eigenschaftswert

string

isCurrent

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

isCurrent?: boolean

Eigenschaftswert

boolean

isOnline

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

isOnline?: boolean

Eigenschaftswert

boolean

license

Lizenzinformationen für die API.

license?: ApiLicenseInformation

Eigenschaftswert

ApiLicenseInformation

path

Relative URL identifiziert diese API und alle zugehörigen Ressourcenpfade innerhalb der API-Verwaltungsdienstinstanz eindeutig. Sie wird an die API-Endpunktbasis-URL angefügt, die während der Erstellung der Dienstinstanz angegeben wurde, um eine öffentliche URL für diese API zu bilden.

path?: string

Eigenschaftswert

string

protocols

Beschreibt, welche Protokolle die Vorgänge in dieser API aufrufen können.

protocols?: string[]

Eigenschaftswert

string[]

provisioningState

Der Bereitstellungsstatus HINWEIS: Diese Eigenschaft wird nicht serialisiert. Er kann nur vom Server aufgefüllt werden.

provisioningState?: string

Eigenschaftswert

string

serviceUrl

Absolute URL des Back-End-Diensts, der diese API implementiert. Maximal 2000 Zeichen lang.

serviceUrl?: string

Eigenschaftswert

string

soapApiType

Typ der zu erstellenden API.

  • http erstellt eine REST-API
  • soap erstellt eine SOAP-Pass-Through-API
  • websocket erstellt websocket-API
  • graphql erstellt die GraphQL-API. Neue Typen können in Zukunft hinzugefügt werden.
soapApiType?: string

Eigenschaftswert

string

sourceApiId

API-ID der Quell-API.

sourceApiId?: string

Eigenschaftswert

string

subscriptionKeyParameterNames

Protokolle, über die API verfügbar gemacht wird.

subscriptionKeyParameterNames?: SubscriptionKeyParameterNamesContract

Eigenschaftswert

SubscriptionKeyParameterNamesContract

subscriptionRequired

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

subscriptionRequired?: boolean

Eigenschaftswert

boolean

termsOfServiceUrl

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

termsOfServiceUrl?: string

Eigenschaftswert

string

translateRequiredQueryParametersConduct

Strategie der Übersetzung erforderlicher Abfrageparameter in Vorlagen. 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 zum Einschränken des Imports von WSDL in eine Teilmenge des Dokuments.

wsdlSelector?: ApiCreateOrUpdatePropertiesWsdlSelector

Eigenschaftswert

ApiCreateOrUpdatePropertiesWsdlSelector