Dela via

ApiContract interface

  • Referens
Paket:
@azure/arm-apimanagement

API-information.

Extends
ProxyResource

Egenskaper

apiRevision

Beskriver revisionen av API:et. Om inget värde anges skapas standardrevision 1
apiRevisionDescription

Beskrivning av API Revision.
apiType

Typ av API.
apiVersion

Anger versionsidentifieraren för API:et om API:et är versionshanterat
apiVersionDescription

Beskrivning av API-versionen.
apiVersionSet

Information om versionsuppsättning
apiVersionSetId

En resursidentifierare för den relaterade ApiVersionSet.
authenticationSettings

Samling autentiseringsinställningar som ingår i det här API:et.
contact

Kontaktuppgifter för API:et.
description

Beskrivning av API:et. Kan innehålla HTML-formateringstaggar.
displayName

API-namn. Måste vara mellan 1 och 300 tecken långt.
isCurrent

Anger om API-revision är aktuell API-revision.
isOnline

Anger om API-revisionen är tillgänglig via gatewayen. Obs! Den här egenskapen kommer inte att serialiseras. Den kan bara fyllas i av servern.
license

Licensinformation för API:et.
path

Relativ URL som unikt identifierar det här API:et och alla dess resurssökvägar i API Management tjänstinstans. Den läggs till i DEN API-slutpunktsbas-URL som angavs när tjänstinstansen skapades för att skapa en offentlig URL för det här API:et.
protocols

Beskriver vilka protokoll som åtgärderna i det här API:et kan anropas för.
serviceUrl

Absolut URL för serverdelstjänsten som implementerar det här API:et. Får inte vara längre än 2 000 tecken.
sourceApiId

API-identifierare för käll-API:et.
subscriptionKeyParameterNames

Protokoll över vilka API:et görs tillgängligt.
subscriptionRequired

Anger om ett API eller en produktprenumeration krävs för åtkomst till API:et.
termsOfServiceUrl

En URL till användarvillkoren för API:et. MÅSTE vara i formatet för en URL.

Ärvda egenskaper

id

Fullständigt kvalificerat resurs-ID för resursen. Ex – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} OBS: Den här egenskapen kommer inte att serialiseras. Den kan bara fyllas i av servern.
name

Namnet på resursen OBS! Den här egenskapen kommer inte att serialiseras. Den kan bara fyllas i av servern.
type

Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts" OBS: Den här egenskapen kommer inte att serialiseras. Den kan bara fyllas i av servern.

Egenskapsinformation

apiRevision

Beskriver revisionen av API:et. Om inget värde anges skapas standardrevision 1

apiRevision?: string

Egenskapsvärde

string

apiRevisionDescription

Beskrivning av API Revision.

apiRevisionDescription?: string

Egenskapsvärde

string

apiType

Typ av API.

apiType?: string

Egenskapsvärde

string

apiVersion

Anger versionsidentifieraren för API:et om API:et är versionshanterat

apiVersion?: string

Egenskapsvärde

string

apiVersionDescription

Beskrivning av API-versionen.

apiVersionDescription?: string

Egenskapsvärde

string

apiVersionSet

Information om versionsuppsättning

apiVersionSet?: ApiVersionSetContractDetails

Egenskapsvärde

ApiVersionSetContractDetails

apiVersionSetId

En resursidentifierare för den relaterade ApiVersionSet.

apiVersionSetId?: string

Egenskapsvärde

string

authenticationSettings

Samling autentiseringsinställningar som ingår i det här API:et.

authenticationSettings?: AuthenticationSettingsContract

Egenskapsvärde

AuthenticationSettingsContract

contact

Kontaktuppgifter för API:et.

contact?: ApiContactInformation

Egenskapsvärde

ApiContactInformation

description

Beskrivning av API:et. Kan innehålla HTML-formateringstaggar.

description?: string

Egenskapsvärde

string

displayName

API-namn. Måste vara mellan 1 och 300 tecken långt.

displayName?: string

Egenskapsvärde

string

isCurrent

Anger om API-revision är aktuell API-revision.

isCurrent?: boolean

Egenskapsvärde

boolean

isOnline

Anger om API-revisionen är tillgänglig via gatewayen. Obs! Den här egenskapen kommer inte att serialiseras. Den kan bara fyllas i av servern.

isOnline?: boolean

Egenskapsvärde

boolean

license

Licensinformation för API:et.

license?: ApiLicenseInformation

Egenskapsvärde

ApiLicenseInformation

path

Relativ URL som unikt identifierar det här API:et och alla dess resurssökvägar i API Management tjänstinstans. Den läggs till i DEN API-slutpunktsbas-URL som angavs när tjänstinstansen skapades för att skapa en offentlig URL för det här API:et.

path?: string

Egenskapsvärde

string

protocols

Beskriver vilka protokoll som åtgärderna i det här API:et kan anropas för.

protocols?: string[]

Egenskapsvärde

string[]

serviceUrl

Absolut URL för serverdelstjänsten som implementerar det här API:et. Får inte vara längre än 2 000 tecken.

serviceUrl?: string

Egenskapsvärde

string

sourceApiId

API-identifierare för käll-API:et.

sourceApiId?: string

Egenskapsvärde

string

subscriptionKeyParameterNames

Protokoll över vilka API:et görs tillgängligt.

subscriptionKeyParameterNames?: SubscriptionKeyParameterNamesContract

Egenskapsvärde

SubscriptionKeyParameterNamesContract

subscriptionRequired

Anger om ett API eller en produktprenumeration krävs för åtkomst till API:et.

subscriptionRequired?: boolean

Egenskapsvärde

boolean

termsOfServiceUrl

En URL till användarvillkoren för API:et. MÅSTE vara i formatet för en URL.

termsOfServiceUrl?: string

Egenskapsvärde

string

Information om ärvda egenskaper

id

Fullständigt kvalificerat resurs-ID för resursen. Ex – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} OBS: Den här egenskapen kommer inte att serialiseras. Den kan bara fyllas i av servern.

id?: string

Egenskapsvärde

string

Ärvd frånProxyResource.id

name

Namnet på resursen OBS! Den här egenskapen kommer inte att serialiseras. Den kan bara fyllas i av servern.

name?: string

Egenskapsvärde

string

Ärvd frånProxyResource.name

type

Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts" OBS: Den här egenskapen kommer inte att serialiseras. Den kan bara fyllas i av servern.

type?: string

Egenskapsvärde

string

Ärvd frånProxyResource.type