ProductWiki interface

Paquet:

@azure/arm-apimanagement

Interface représentant un ProductWiki.

Méthodes

createOrUpdate(string, string, string, WikiContract, ProductWikiCreateOrUpdateOptionalParams)	Crée un wiki pour un produit ou met à jour un wiki existant.
delete(string, string, string, string, ProductWikiDeleteOptionalParams)	Supprime le Wiki spécifié d’un produit.
get(string, string, string, ProductWikiGetOptionalParams)	Obtient les détails du Wiki pour un produit spécifié par son identificateur.
getEntityTag(string, string, string, ProductWikiGetEntityTagOptionalParams)	Obtient la version d’état d’entité (Etag) du Wiki pour un produit spécifié par son identificateur.
update(string, string, string, string, WikiUpdateContract, ProductWikiUpdateOptionalParams)	Met à jour les détails du Wiki pour un produit spécifié par son identificateur.

Détails de la méthode

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

Crée un wiki pour un produit ou met à jour un wiki existant.

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

Paramètres

resourceGroupName

string

Nom du groupe de ressources. Le nom ne respecte pas la casse.

serviceName

string

Nom du service Gestion des API.

productId

string

Identificateur de produit. Doit être unique dans l’instance actuelle du service Gestion des API.

parameters

WikiContract

Créez des paramètres.

options

ProductWikiCreateOrUpdateOptionalParams

Paramètres d’options.

Retours

Promise<ProductWikiCreateOrUpdateResponse>

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

Supprime le Wiki spécifié d’un produit.

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

Paramètres

resourceGroupName

string

Nom du groupe de ressources. Le nom ne respecte pas la casse.

serviceName

string

Nom du service Gestion des API.

productId

string

Identificateur de produit. Doit être unique dans l’instance actuelle du service Gestion des API.

ifMatch

string

ETag de l’entité. ETag doit correspondre à l’état actuel de l’entité à partir de la réponse d’en-tête de la requête GET ou il doit être * pour la mise à jour inconditionnelle.

options

ProductWikiDeleteOptionalParams

Paramètres d’options.

Retours

Promise<void>

get(string, string, string, ProductWikiGetOptionalParams)

Obtient les détails du Wiki pour un produit spécifié par son identificateur.

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

Paramètres

resourceGroupName

string

Nom du groupe de ressources. Le nom ne respecte pas la casse.

serviceName

string

Nom du service Gestion des API.

productId

string

Identificateur de produit. Doit être unique dans l’instance actuelle du service Gestion des API.

options

ProductWikiGetOptionalParams

Paramètres d’options.

Retours

Promise<ProductWikiGetResponse>

getEntityTag(string, string, string, ProductWikiGetEntityTagOptionalParams)

Obtient la version d’état d’entité (Etag) du Wiki pour un produit spécifié par son identificateur.

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

Paramètres

resourceGroupName

string

Nom du groupe de ressources. Le nom ne respecte pas la casse.

serviceName

string

Nom du service Gestion des API.

productId

string

Identificateur de produit. Doit être unique dans l’instance actuelle du service Gestion des API.

options

ProductWikiGetEntityTagOptionalParams

Paramètres d’options.

Retours

Promise<ProductWikiGetEntityTagHeaders>

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

Met à jour les détails du Wiki pour un produit spécifié par son identificateur.

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

Paramètres

resourceGroupName

string

Nom du groupe de ressources. Le nom ne respecte pas la casse.

serviceName

string

Nom du service Gestion des API.

productId

string

Identificateur de produit. Doit être unique dans l’instance actuelle du service Gestion des API.

ifMatch

string

ETag de l’entité. ETag doit correspondre à l’état actuel de l’entité à partir de la réponse d’en-tête de la requête GET ou il doit être * pour la mise à jour inconditionnelle.

parameters

WikiUpdateContract

Paramètres de mise à jour wiki.

options

ProductWikiUpdateOptionalParams

Paramètres d’options.

Retours

Promise<ProductWikiUpdateResponse>