ProductWiki interface

Paket:

@azure/arm-apimanagement

Schnittstelle, die ein ProductWiki darstellt.

Methoden

createOrUpdate(string, string, string, WikiContract, ProductWikiCreateOrUpdateOptionalParams)	Erstellt ein neues Wiki für ein Produkt oder aktualisiert ein vorhandenes.
delete(string, string, string, string, ProductWikiDeleteOptionalParams)	Löscht das angegebene Wiki aus einem Produkt.
get(string, string, string, ProductWikiGetOptionalParams)	Ruft die Details des Wikis für ein Produkt ab, das durch seinen Bezeichner angegeben ist.
getEntityTag(string, string, string, ProductWikiGetEntityTagOptionalParams)	Ruft die Entitätsstatusversion (Etag) des Wikis für ein durch seinen Bezeichner angegebenes Produkt ab.
update(string, string, string, string, WikiUpdateContract, ProductWikiUpdateOptionalParams)	Aktualisiert die Details des Wikis für ein durch seinen Bezeichner angegebenes Produkt.

Details zur Methode

createOrUpdate(string, string, string, WikiContract, ProductWikiCreateOrUpdateOptionalParams)

Erstellt ein neues Wiki für ein Produkt oder aktualisiert ein vorhandenes.

function createOrUpdate(resourceGroupName: string, serviceName: string, productId: string, parameters: WikiContract, options?: ProductWikiCreateOrUpdateOptionalParams): Promise<ProductWikiCreateOrUpdateResponse>

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.

serviceName

string

Der Name des API-Verwaltungsdiensts.

productId

string

Produkt-ID. Muss in der aktuellen API-Verwaltungsdienstinstanz eindeutig sein.

parameters

WikiContract

Erstellen Sie Parameter.

options

ProductWikiCreateOrUpdateOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<ProductWikiCreateOrUpdateResponse>

delete(string, string, string, string, ProductWikiDeleteOptionalParams)

Löscht das angegebene Wiki aus einem Produkt.

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

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.

serviceName

string

Der Name des API-Verwaltungsdiensts.

productId

string

Produkt-ID. Muss in der aktuellen API-Verwaltungsdienstinstanz 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

ProductWikiDeleteOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<void>

get(string, string, string, ProductWikiGetOptionalParams)

Ruft die Details des Wikis für ein Produkt ab, das durch seinen Bezeichner angegeben ist.

function get(resourceGroupName: string, serviceName: string, productId: string, options?: ProductWikiGetOptionalParams): Promise<ProductWikiGetResponse>

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.

serviceName

string

Der Name des API-Verwaltungsdiensts.

productId

string

Produkt-ID. Muss in der aktuellen API-Verwaltungsdienstinstanz eindeutig sein.

options

ProductWikiGetOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<ProductWikiGetResponse>

getEntityTag(string, string, string, ProductWikiGetEntityTagOptionalParams)

Ruft die Entitätsstatusversion (Etag) des Wikis für ein durch seinen Bezeichner angegebenes Produkt ab.

function getEntityTag(resourceGroupName: string, serviceName: string, productId: string, options?: ProductWikiGetEntityTagOptionalParams): Promise<ProductWikiGetEntityTagHeaders>

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.

serviceName

string

Der Name des API-Verwaltungsdiensts.

productId

string

Produkt-ID. Muss in der aktuellen API-Verwaltungsdienstinstanz eindeutig sein.

options

ProductWikiGetEntityTagOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<ProductWikiGetEntityTagHeaders>

update(string, string, string, string, WikiUpdateContract, ProductWikiUpdateOptionalParams)

Aktualisiert die Details des Wikis für ein durch seinen Bezeichner angegebenes Produkt.

function update(resourceGroupName: string, serviceName: string, productId: string, ifMatch: string, parameters: WikiUpdateContract, options?: ProductWikiUpdateOptionalParams): Promise<ProductWikiUpdateResponse>

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.

serviceName

string

Der Name des API-Verwaltungsdiensts.

productId

string

Produkt-ID. Muss in der aktuellen API-Verwaltungsdienstinstanz 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

ProductWikiUpdateOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<ProductWikiUpdateResponse>