Compartir a través de

ApiWiki interface

  • Referencia
Paquete:
@azure/arm-apimanagement

Interfaz que representa una ApiWiki.

Métodos

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

Crea una nueva Wiki para una API o actualiza una existente.
delete(string, string, string, string, ApiWikiDeleteOptionalParams)

Elimina la Wiki especificada de una API.
get(string, string, string, ApiWikiGetOptionalParams)

Obtiene los detalles de la Wiki de una API especificada por su identificador.
getEntityTag(string, string, string, ApiWikiGetEntityTagOptionalParams)

Obtiene la versión de estado de entidad (Etag) del Wiki para una API especificada por su identificador.
update(string, string, string, string, WikiUpdateContract, ApiWikiUpdateOptionalParams)

Actualiza los detalles de la Wiki de una API especificada por su identificador.

Detalles del método

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

Crea una nueva Wiki para una API o actualiza una existente.

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

Parámetros

resourceGroupName

string

Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.

serviceName

string

Nombre del servicio API Management.

apiId

string

Identificador de API. Debe ser único en la instancia actual del servicio API Management.

parameters
WikiContract

Cree parámetros.

options
ApiWikiCreateOrUpdateOptionalParams

Parámetros de opciones.

Devoluciones

Promise<ApiWikiCreateOrUpdateResponse>

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

Elimina la Wiki especificada de una API.

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

Parámetros

resourceGroupName

string

Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.

serviceName

string

Nombre del servicio API Management.

apiId

string

Identificador de API. Debe ser único en la instancia actual del servicio API Management.

ifMatch

string

ETag de la entidad. ETag debe coincidir con el estado de entidad actual de la respuesta del encabezado de la solicitud GET o debe ser * para la actualización incondicional.

options
ApiWikiDeleteOptionalParams

Parámetros de opciones.

Devoluciones

Promise<void>

get(string, string, string, ApiWikiGetOptionalParams)

Obtiene los detalles de la Wiki de una API especificada por su identificador.

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

Parámetros

resourceGroupName

string

Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.

serviceName

string

Nombre del servicio API Management.

apiId

string

Identificador de API. Debe ser único en la instancia actual del servicio API Management.

options
ApiWikiGetOptionalParams

Parámetros de opciones.

Devoluciones

Promise<ApiWikiGetResponse>

getEntityTag(string, string, string, ApiWikiGetEntityTagOptionalParams)

Obtiene la versión de estado de entidad (Etag) del Wiki para una API especificada por su identificador.

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

Parámetros

resourceGroupName

string

Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.

serviceName

string

Nombre del servicio API Management.

apiId

string

Identificador de API. Debe ser único en la instancia actual del servicio API Management.

options
ApiWikiGetEntityTagOptionalParams

Parámetros de opciones.

Devoluciones

Promise<ApiWikiGetEntityTagHeaders>

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

Actualiza los detalles de la Wiki de una API especificada por su identificador.

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

Parámetros

resourceGroupName

string

Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.

serviceName

string

Nombre del servicio API Management.

apiId

string

Identificador de API. Debe ser único en la instancia actual del servicio API Management.

ifMatch

string

ETag de la entidad. ETag debe coincidir con el estado de entidad actual de la respuesta del encabezado de la solicitud GET o debe ser * para la actualización incondicional.

parameters
WikiUpdateContract

Parámetros de actualización wiki.

options
ApiWikiUpdateOptionalParams

Parámetros de opciones.

Devoluciones

Promise<ApiWikiUpdateResponse>