Backend interface

Paket:

@azure/arm-apimanagement

Schnittstelle, die ein Back-End darstellt.

Methoden

createOrUpdate(string, string, string, BackendContract, BackendCreateOrUpdateOptionalParams)	Erstellt oder aktualisiert ein Back-End
delete(string, string, string, string, BackendDeleteOptionalParams)	Löscht das angegebene Back-End
get(string, string, string, BackendGetOptionalParams)	Ruft die Details des Back-Ends ab, das durch seinen Bezeichner angegeben wird.
getEntityTag(string, string, string, BackendGetEntityTagOptionalParams)	Ruft die Etag-Version (Entity State) des Back-Ends ab, die durch den Bezeichner angegeben wird.
listByService(string, string, BackendListByServiceOptionalParams)	Listet eine Auflistung von Back-Ends in der angegebenen Dienstinstanz auf
reconnect(string, string, string, BackendReconnectOptionalParams)	Benachrichtigt den API Management Gateways, nach dem angegebenen Timeout eine neue Verbindung mit dem Back-End zu erstellen. Wenn kein Timeout angegeben wurde, wird ein Timeout von 2 Minuten verwendet.
update(string, string, string, string, BackendUpdateParameters, BackendUpdateOptionalParams)	Updates ein vorhandenes Back-End.

Details zur Methode

createOrUpdate(string, string, string, BackendContract, BackendCreateOrUpdateOptionalParams)

Erstellt oder aktualisiert ein Back-End

function createOrUpdate(resourceGroupName: string, serviceName: string, backendId: string, parameters: BackendContract, options?: BackendCreateOrUpdateOptionalParams): Promise<BackendCreateOrUpdateResponse>

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

serviceName

string

Der Name des API Management-Diensts.

backendId

string

Bezeichner der Back-End-Entität. Muss im aktuellen API Management-Dienst instance eindeutig sein.

parameters

BackendContract

Erstellen Sie Parameter.

options

BackendCreateOrUpdateOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<BackendCreateOrUpdateResponse>

delete(string, string, string, string, BackendDeleteOptionalParams)

Löscht das angegebene Back-End

function delete(resourceGroupName: string, serviceName: string, backendId: string, ifMatch: string, options?: BackendDeleteOptionalParams): Promise<void>

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

serviceName

string

Der Name des API Management-Diensts.

backendId

string

Bezeichner der Back-End-Entität. Muss im aktuellen API Management-Dienst instance eindeutig sein.

ifMatch

string

ETag der Entität. ETag sollte mit dem aktuellen Entitätsstatus aus der Headerantwort der GET-Anforderung übereinstimmen, oder es sollte * für die bedingungslose Aktualisierung sein.

options

BackendDeleteOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<void>

get(string, string, string, BackendGetOptionalParams)

Ruft die Details des Back-Ends ab, das durch seinen Bezeichner angegeben wird.

function get(resourceGroupName: string, serviceName: string, backendId: string, options?: BackendGetOptionalParams): Promise<BackendGetResponse>

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

serviceName

string

Der Name des API Management-Diensts.

backendId

string

Bezeichner der Back-End-Entität. Muss im aktuellen API Management-Dienst instance eindeutig sein.

options

BackendGetOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<BackendGetResponse>

getEntityTag(string, string, string, BackendGetEntityTagOptionalParams)

Ruft die Etag-Version (Entity State) des Back-Ends ab, die durch den Bezeichner angegeben wird.

function getEntityTag(resourceGroupName: string, serviceName: string, backendId: string, options?: BackendGetEntityTagOptionalParams): Promise<BackendGetEntityTagHeaders>

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

serviceName

string

Der Name des API Management-Diensts.

backendId

string

Bezeichner der Back-End-Entität. Muss im aktuellen API Management-Dienst instance eindeutig sein.

options

BackendGetEntityTagOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<BackendGetEntityTagHeaders>

listByService(string, string, BackendListByServiceOptionalParams)

Listet eine Auflistung von Back-Ends in der angegebenen Dienstinstanz auf

function listByService(resourceGroupName: string, serviceName: string, options?: BackendListByServiceOptionalParams): PagedAsyncIterableIterator<BackendContract, BackendContract[], PageSettings>

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

serviceName

string

Der Name des API Management-Diensts.

options

BackendListByServiceOptionalParams

Die Optionsparameter.

Gibt zurück

PagedAsyncIterableIterator<BackendContract, BackendContract[], PageSettings>

reconnect(string, string, string, BackendReconnectOptionalParams)

Benachrichtigt den API Management Gateways, nach dem angegebenen Timeout eine neue Verbindung mit dem Back-End zu erstellen. Wenn kein Timeout angegeben wurde, wird ein Timeout von 2 Minuten verwendet.

function reconnect(resourceGroupName: string, serviceName: string, backendId: string, options?: BackendReconnectOptionalParams): Promise<void>

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

serviceName

string

Der Name des API Management-Diensts.

backendId

string

Bezeichner der Back-End-Entität. Muss im aktuellen API Management-Dienst instance eindeutig sein.

options

BackendReconnectOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<void>

update(string, string, string, string, BackendUpdateParameters, BackendUpdateOptionalParams)

Updates ein vorhandenes Back-End.

function update(resourceGroupName: string, serviceName: string, backendId: string, ifMatch: string, parameters: BackendUpdateParameters, options?: BackendUpdateOptionalParams): Promise<BackendUpdateResponse>

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

serviceName

string

Der Name des API Management-Diensts.

backendId

string

Bezeichner der Back-End-Entität. Muss im aktuellen API Management-Dienst instance eindeutig sein.

ifMatch

string

ETag der Entität. ETag sollte mit dem aktuellen Entitätsstatus aus der Headerantwort der GET-Anforderung übereinstimmen, oder es sollte * für die bedingungslose Aktualisierung sein.

parameters

BackendUpdateParameters

Aktualisieren von Parametern.

options

BackendUpdateOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<BackendUpdateResponse>