ApiWiki interface

Paket:

@azure/arm-apimanagement

Schnittstelle, die ein ApiWiki darstellt.

Methoden

createOrUpdate(string, string, string, WikiContract, ApiWikiCreateOrUpdateOptionalParams)	Erstellt ein neues Wiki für eine API oder aktualisiert eine vorhandene.
delete(string, string, string, string, ApiWikiDeleteOptionalParams)	Löscht das angegebene Wiki aus einer API.
get(string, string, string, ApiWikiGetOptionalParams)	Ruft die Details des Wikis für eine API ab, die durch den Bezeichner angegeben wird.
getEntityTag(string, string, string, ApiWikiGetEntityTagOptionalParams)	Ruft die Entitätsstatusversion (Etag) des Wikis für eine API ab, die durch den Bezeichner angegeben wird.
update(string, string, string, string, WikiUpdateContract, ApiWikiUpdateOptionalParams)	Updates die Details des Wikis für eine API, die durch den Bezeichner angegeben wird.

Details zur Methode

createOrUpdate(string, string, string, WikiContract, ApiWikiCreateOrUpdateOptionalParams)

Erstellt ein neues Wiki für eine API oder aktualisiert eine vorhandene.

function createOrUpdate(resourceGroupName: string, serviceName: string, apiId: string, parameters: WikiContract, options?: ApiWikiCreateOrUpdateOptionalParams): Promise<ApiWikiCreateOrUpdateResponse>

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.

apiId

string

API-Bezeichner. Muss im aktuellen API Management Dienst instance eindeutig sein.

parameters

WikiContract

Erstellen sie Parameter.

options

ApiWikiCreateOrUpdateOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<ApiWikiCreateOrUpdateResponse>

delete(string, string, string, string, ApiWikiDeleteOptionalParams)

Löscht das angegebene Wiki aus einer API.

function delete(resourceGroupName: string, serviceName: string, apiId: string, ifMatch: string, options?: ApiWikiDeleteOptionalParams): 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.

apiId

string

API-Bezeichner. 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 bedingungslose Aktualisierung sein.

options

ApiWikiDeleteOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<void>

get(string, string, string, ApiWikiGetOptionalParams)

Ruft die Details des Wikis für eine API ab, die durch den Bezeichner angegeben wird.

function get(resourceGroupName: string, serviceName: string, apiId: string, options?: ApiWikiGetOptionalParams): Promise<ApiWikiGetResponse>

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.

apiId

string

API-Bezeichner. Muss im aktuellen API Management Dienst instance eindeutig sein.

options

ApiWikiGetOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<ApiWikiGetResponse>

getEntityTag(string, string, string, ApiWikiGetEntityTagOptionalParams)

Ruft die Entitätsstatusversion (Etag) des Wikis für eine API ab, die durch den Bezeichner angegeben wird.

function getEntityTag(resourceGroupName: string, serviceName: string, apiId: string, options?: ApiWikiGetEntityTagOptionalParams): Promise<ApiWikiGetEntityTagHeaders>

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.

apiId

string

API-Bezeichner. Muss im aktuellen API Management Dienst instance eindeutig sein.

options

ApiWikiGetEntityTagOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<ApiWikiGetEntityTagHeaders>

update(string, string, string, string, WikiUpdateContract, ApiWikiUpdateOptionalParams)

Updates die Details des Wikis für eine API, die durch den Bezeichner angegeben wird.

function update(resourceGroupName: string, serviceName: string, apiId: string, ifMatch: string, parameters: WikiUpdateContract, options?: ApiWikiUpdateOptionalParams): Promise<ApiWikiUpdateResponse>

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.

apiId

string

API-Bezeichner. 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 bedingungslose Aktualisierung sein.

parameters

WikiUpdateContract

Wiki Update-Parameter.

options

ApiWikiUpdateOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<ApiWikiUpdateResponse>