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 den Bezeichner angegeben wird.
getEntityTag(string, string, string, ProductWikiGetEntityTagOptionalParams)	Ruft die Entitätsstatusversion (Etag) des Wikis für ein Produkt ab, das durch den Bezeichner angegeben wird.
update(string, string, string, string, WikiUpdateContract, ProductWikiUpdateOptionalParams)	Updates die Details des Wikis für ein Produkt, das durch seinen Bezeichner angegeben wird.

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. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

serviceName

string

Der Name des API Management-Diensts.

productId

string

Produktbezeichner. Muss im aktuellen API Management-Dienst instance 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. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

serviceName

string

Der Name des API Management-Diensts.

productId

string

Produktbezeichner. 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

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 den Bezeichner angegeben wird.

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

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.

productId

string

Produktbezeichner. Muss im aktuellen API Management-Dienst instance 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 Produkt ab, das durch den Bezeichner angegeben wird.

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

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.

productId

string

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

options

ProductWikiGetEntityTagOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<ProductWikiGetEntityTagHeaders>

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

Updates die Details des Wikis für ein Produkt, das durch seinen Bezeichner angegeben wird.

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

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.

productId

string

Produktbezeichner. 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

WikiUpdateContract

Wiki-Updateparameter.

options

ProductWikiUpdateOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<ProductWikiUpdateResponse>