Delen via

ApiContract interface

  • Referentie
Pakket:
@azure/arm-apimanagement

API-gegevens.

Uitbreiding
ProxyResource

Eigenschappen

apiRevision

Beschrijft de revisie van de API. Als er geen waarde is opgegeven, wordt standaardrevisie 1 gemaakt
apiRevisionDescription

Beschrijving van de API-revisie.
apiType

Type of API.
apiVersion

Geeft de versie-id van de API aan als de API is geversied
apiVersionDescription

Beschrijving van de API-versie.
apiVersionSet

Details van versieset
apiVersionSetId

Een resource-id voor de gerelateerde ApiVersionSet.
authenticationSettings

Verzameling van verificatie-instellingen die zijn opgenomen in deze API.
contact

Contactgegevens voor de API.
description

Beschrijving van de API. Kan HTML-opmaaktags bevatten.
displayName

API-naam. Moet 1 tot 300 tekens lang zijn.
isCurrent

Geeft aan of API-revisie de huidige API-revisie is.
isOnline

Geeft aan of API-revisie toegankelijk is via de gateway. OPMERKING: Deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.
license

Licentiegegevens voor de API.
path

Relatieve URL die deze API en alle bijbehorende resourcepaden uniek identificeert binnen het API Management-service-exemplaar. Deze wordt toegevoegd aan de basis-URL van het API-eindpunt die is opgegeven tijdens het maken van het service-exemplaar om een openbare URL voor deze API te vormen.
protocols

Beschrijft op welke protocollen de bewerkingen in deze API kunnen worden aangeroepen.
serviceUrl

Absolute URL van de back-endservice die deze API implementeert. Mag niet langer zijn dan 2000 tekens.
sourceApiId

API-id van de bron-API.
subscriptionKeyParameterNames

Protocollen over welke API beschikbaar wordt gemaakt.
subscriptionRequired

Hiermee geeft u op of een API- of productabonnement vereist is voor toegang tot de API.
termsOfServiceUrl

Een URL naar de servicevoorwaarden voor de API. MOET de indeling van een URL hebben.

Overgenomen eigenschappen

id

Volledig gekwalificeerde resource-id voor de resource. Bijvoorbeeld : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} OPMERKING: deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.
name

De naam van de resourceNOTITIE: deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.
type

Het type resource. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts': deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.

Eigenschapdetails

apiRevision

Beschrijft de revisie van de API. Als er geen waarde is opgegeven, wordt standaardrevisie 1 gemaakt

apiRevision?: string

Waarde van eigenschap

string

apiRevisionDescription

Beschrijving van de API-revisie.

apiRevisionDescription?: string

Waarde van eigenschap

string

apiType

Type of API.

apiType?: string

Waarde van eigenschap

string

apiVersion

Geeft de versie-id van de API aan als de API is geversied

apiVersion?: string

Waarde van eigenschap

string

apiVersionDescription

Beschrijving van de API-versie.

apiVersionDescription?: string

Waarde van eigenschap

string

apiVersionSet

Details van versieset

apiVersionSet?: ApiVersionSetContractDetails

Waarde van eigenschap

ApiVersionSetContractDetails

apiVersionSetId

Een resource-id voor de gerelateerde ApiVersionSet.

apiVersionSetId?: string

Waarde van eigenschap

string

authenticationSettings

Verzameling van verificatie-instellingen die zijn opgenomen in deze API.

authenticationSettings?: AuthenticationSettingsContract

Waarde van eigenschap

AuthenticationSettingsContract

contact

Contactgegevens voor de API.

contact?: ApiContactInformation

Waarde van eigenschap

ApiContactInformation

description

Beschrijving van de API. Kan HTML-opmaaktags bevatten.

description?: string

Waarde van eigenschap

string

displayName

API-naam. Moet 1 tot 300 tekens lang zijn.

displayName?: string

Waarde van eigenschap

string

isCurrent

Geeft aan of API-revisie de huidige API-revisie is.

isCurrent?: boolean

Waarde van eigenschap

boolean

isOnline

Geeft aan of API-revisie toegankelijk is via de gateway. OPMERKING: Deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.

isOnline?: boolean

Waarde van eigenschap

boolean

license

Licentiegegevens voor de API.

license?: ApiLicenseInformation

Waarde van eigenschap

ApiLicenseInformation

path

Relatieve URL die deze API en alle bijbehorende resourcepaden uniek identificeert binnen het API Management-service-exemplaar. Deze wordt toegevoegd aan de basis-URL van het API-eindpunt die is opgegeven tijdens het maken van het service-exemplaar om een openbare URL voor deze API te vormen.

path?: string

Waarde van eigenschap

string

protocols

Beschrijft op welke protocollen de bewerkingen in deze API kunnen worden aangeroepen.

protocols?: string[]

Waarde van eigenschap

string[]

serviceUrl

Absolute URL van de back-endservice die deze API implementeert. Mag niet langer zijn dan 2000 tekens.

serviceUrl?: string

Waarde van eigenschap

string

sourceApiId

API-id van de bron-API.

sourceApiId?: string

Waarde van eigenschap

string

subscriptionKeyParameterNames

Protocollen over welke API beschikbaar wordt gemaakt.

subscriptionKeyParameterNames?: SubscriptionKeyParameterNamesContract

Waarde van eigenschap

SubscriptionKeyParameterNamesContract

subscriptionRequired

Hiermee geeft u op of een API- of productabonnement vereist is voor toegang tot de API.

subscriptionRequired?: boolean

Waarde van eigenschap

boolean

termsOfServiceUrl

Een URL naar de servicevoorwaarden voor de API. MOET de indeling van een URL hebben.

termsOfServiceUrl?: string

Waarde van eigenschap

string

Details van overgenomen eigenschap

id

Volledig gekwalificeerde resource-id voor de resource. Bijvoorbeeld : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} OPMERKING: deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.

id?: string

Waarde van eigenschap

string

overgenomen vanProxyResource.id

name

De naam van de resourceNOTITIE: deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.

name?: string

Waarde van eigenschap

string

overgenomen vanProxyResource.name

type

Het type resource. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts': deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.

type?: string

Waarde van eigenschap

string

overgenomen vanProxyResource.type