ApiWiki interface

Paquet:

@azure/arm-apimanagement

Interface représentant un ApiWiki.

Méthodes

createOrUpdate(string, string, string, WikiContract, ApiWikiCreateOrUpdateOptionalParams)	Crée un wiki pour une API ou met à jour un wiki existant.
delete(string, string, string, string, ApiWikiDeleteOptionalParams)	Supprime le Wiki spécifié d’une API.
get(string, string, string, ApiWikiGetOptionalParams)	Obtient les détails du Wiki pour une API spécifiée par son identificateur.
getEntityTag(string, string, string, ApiWikiGetEntityTagOptionalParams)	Obtient la version d’état d’entité (Etag) du Wiki pour une API spécifiée par son identificateur.
update(string, string, string, string, WikiUpdateContract, ApiWikiUpdateOptionalParams)	Mises à jour les détails du Wiki pour une API spécifiée par son identificateur.

Détails de la méthode

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

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

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

Paramètres

resourceGroupName

string

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

serviceName

string

Nom du service Gestion des API.

apiId

string

Identificateur d'API. Doit être unique dans le instance de service Gestion des API actuel.

parameters

WikiContract

Créez des paramètres.

options

ApiWikiCreateOrUpdateOptionalParams

Paramètres d’options.

Retours

Promise<ApiWikiCreateOrUpdateResponse>

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

Supprime le Wiki spécifié d’une API.

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

apiId

string

Identificateur d'API. Doit être unique dans le instance de service Gestion des API actuel.

ifMatch

string

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

options

ApiWikiDeleteOptionalParams

Paramètres d’options.

Retours

Promise<void>

get(string, string, string, ApiWikiGetOptionalParams)

Obtient les détails du Wiki pour une API spécifiée par son identificateur.

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

Paramètres

resourceGroupName

string

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

serviceName

string

Nom du service Gestion des API.

apiId

string

Identificateur d'API. Doit être unique dans le instance de service Gestion des API actuel.

options

ApiWikiGetOptionalParams

Paramètres d’options.

Retours

Promise<ApiWikiGetResponse>

getEntityTag(string, string, string, ApiWikiGetEntityTagOptionalParams)

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

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

Paramètres

resourceGroupName

string

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

serviceName

string

Nom du service Gestion des API.

apiId

string

Identificateur d'API. Doit être unique dans le instance de service Gestion des API actuel.

options

ApiWikiGetEntityTagOptionalParams

Paramètres d’options.

Retours

Promise<ApiWikiGetEntityTagHeaders>

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

Mises à jour les détails du Wiki pour une API spécifiée par son identificateur.

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

Paramètres

resourceGroupName

string

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

serviceName

string

Nom du service Gestion des API.

apiId

string

Identificateur d'API. Doit être unique dans le instance de service Gestion des API actuel.

ifMatch

string

ETag de l’entité. ETag doit correspondre à l’état d’entité actuel 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

ApiWikiUpdateOptionalParams

Paramètres d’options.

Retours

Promise<ApiWikiUpdateResponse>