ApiWiki interface

Pacchetto:

@azure/arm-apimanagement

Interfaccia che rappresenta un ApiWiki.

Metodi

createOrUpdate(string, string, string, WikiContract, ApiWikiCreateOrUpdateOptionalParams)	Crea un nuovo wiki per un'API o ne aggiorna uno esistente.
delete(string, string, string, string, ApiWikiDeleteOptionalParams)	Elimina il wiki specificato da un'API.
get(string, string, string, ApiWikiGetOptionalParams)	Ottiene i dettagli del wiki per un'API specificata dal relativo identificatore.
getEntityTag(string, string, string, ApiWikiGetEntityTagOptionalParams)	Ottiene la versione dello stato dell'entità (Etag) del Wiki per un'API specificata dal relativo identificatore.
update(string, string, string, string, WikiUpdateContract, ApiWikiUpdateOptionalParams)	Aggiorna i dettagli del Wiki per un'API specificata dal relativo identificatore.

Dettagli metodo

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

Crea un nuovo wiki per un'API o ne aggiorna uno esistente.

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

Parametri

resourceGroupName

string

Nome del gruppo di risorse. Il nome non fa distinzione tra maiuscole e minuscole.

serviceName

string

Nome del servizio Gestione API.

apiId

string

Identificatore API. Deve essere univoco nell'istanza corrente del servizio Gestione API.

parameters

WikiContract

Creare parametri.

options

ApiWikiCreateOrUpdateOptionalParams

Parametri delle opzioni.

Restituisce

Promise<ApiWikiCreateOrUpdateResponse>

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

Elimina il wiki specificato da un'API.

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

Parametri

resourceGroupName

string

Nome del gruppo di risorse. Il nome non fa distinzione tra maiuscole e minuscole.

serviceName

string

Nome del servizio Gestione API.

apiId

string

Identificatore API. Deve essere univoco nell'istanza corrente del servizio Gestione API.

ifMatch

string

ETag dell'entità. ETag deve corrispondere allo stato corrente dell'entità dalla risposta dell'intestazione della richiesta GET oppure deve essere * per l'aggiornamento incondizionato.

options

ApiWikiDeleteOptionalParams

Parametri delle opzioni.

Restituisce

Promise<void>

get(string, string, string, ApiWikiGetOptionalParams)

Ottiene i dettagli del wiki per un'API specificata dal relativo identificatore.

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

Parametri

resourceGroupName

string

Nome del gruppo di risorse. Il nome non fa distinzione tra maiuscole e minuscole.

serviceName

string

Nome del servizio Gestione API.

apiId

string

Identificatore API. Deve essere univoco nell'istanza corrente del servizio Gestione API.

options

ApiWikiGetOptionalParams

Parametri delle opzioni.

Restituisce

Promise<ApiWikiGetResponse>

getEntityTag(string, string, string, ApiWikiGetEntityTagOptionalParams)

Ottiene la versione dello stato dell'entità (Etag) del Wiki per un'API specificata dal relativo identificatore.

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

Parametri

resourceGroupName

string

Nome del gruppo di risorse. Il nome non fa distinzione tra maiuscole e minuscole.

serviceName

string

Nome del servizio Gestione API.

apiId

string

Identificatore API. Deve essere univoco nell'istanza corrente del servizio Gestione API.

options

ApiWikiGetEntityTagOptionalParams

Parametri delle opzioni.

Restituisce

Promise<ApiWikiGetEntityTagHeaders>

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

Aggiorna i dettagli del Wiki per un'API specificata dal relativo identificatore.

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

Parametri

resourceGroupName

string

Nome del gruppo di risorse. Il nome non fa distinzione tra maiuscole e minuscole.

serviceName

string

Nome del servizio Gestione API.

apiId

string

Identificatore API. Deve essere univoco nell'istanza corrente del servizio Gestione API.

ifMatch

string

ETag dell'entità. ETag deve corrispondere allo stato corrente dell'entità dalla risposta dell'intestazione della richiesta GET oppure deve essere * per l'aggiornamento incondizionato.

parameters

WikiUpdateContract

Parametri di aggiornamento wiki.

options

ApiWikiUpdateOptionalParams

Parametri delle opzioni.

Restituisce

Promise<ApiWikiUpdateResponse>