Compartilhar via

ApiWiki interface

  • Referência
Pacote:
@azure/arm-apimanagement

Interface que representa um ApiWiki.

Métodos

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

Cria um novo Wiki para uma API ou atualiza um existente.
delete(string, string, string, string, ApiWikiDeleteOptionalParams)

Exclui o Wiki especificado de uma API.
get(string, string, string, ApiWikiGetOptionalParams)

Obtém os detalhes do Wiki para uma API especificada por seu identificador.
getEntityTag(string, string, string, ApiWikiGetEntityTagOptionalParams)

Obtém a versão de estado da entidade (Etag) do Wiki para uma API especificada por seu identificador.
update(string, string, string, string, WikiUpdateContract, ApiWikiUpdateOptionalParams)

Atualiza os detalhes do Wiki para uma API especificada por seu identificador.

Detalhes do método

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

Cria um novo Wiki para uma API ou atualiza um existente.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.

serviceName

string

O nome do serviço de Gerenciamento de API.

apiId

string

Identificador de API. Deve ser exclusivo na instância atual do serviço de Gerenciamento de API.

parameters
WikiContract

Criar parâmetros.

options
ApiWikiCreateOrUpdateOptionalParams

Os parâmetros de opções.

Retornos

Promise<ApiWikiCreateOrUpdateResponse>

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

Exclui o Wiki especificado de uma API.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.

serviceName

string

O nome do serviço de Gerenciamento de API.

apiId

string

Identificador de API. Deve ser exclusivo na instância atual do serviço de Gerenciamento de API.

ifMatch

string

ETag da Entidade. A ETag deve corresponder ao estado da entidade atual da resposta de cabeçalho da solicitação GET ou deve ser * para atualização incondicional.

options
ApiWikiDeleteOptionalParams

Os parâmetros de opções.

Retornos

Promise<void>

get(string, string, string, ApiWikiGetOptionalParams)

Obtém os detalhes do Wiki para uma API especificada por seu identificador.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.

serviceName

string

O nome do serviço de Gerenciamento de API.

apiId

string

Identificador de API. Deve ser exclusivo na instância atual do serviço de Gerenciamento de API.

options
ApiWikiGetOptionalParams

Os parâmetros de opções.

Retornos

Promise<ApiWikiGetResponse>

getEntityTag(string, string, string, ApiWikiGetEntityTagOptionalParams)

Obtém a versão de estado da entidade (Etag) do Wiki para uma API especificada por seu identificador.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.

serviceName

string

O nome do serviço de Gerenciamento de API.

apiId

string

Identificador de API. Deve ser exclusivo na instância atual do serviço de Gerenciamento de API.

options
ApiWikiGetEntityTagOptionalParams

Os parâmetros de opções.

Retornos

Promise<ApiWikiGetEntityTagHeaders>

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

Atualiza os detalhes do Wiki para uma API especificada por seu identificador.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.

serviceName

string

O nome do serviço de Gerenciamento de API.

apiId

string

Identificador de API. Deve ser exclusivo na instância atual do serviço de Gerenciamento de API.

ifMatch

string

ETag da Entidade. A ETag deve corresponder ao estado da entidade atual da resposta de cabeçalho da solicitação GET ou deve ser * para atualização incondicional.

parameters
WikiUpdateContract

Parâmetros do Wiki Update.

options
ApiWikiUpdateOptionalParams

Os parâmetros de opções.

Retornos

Promise<ApiWikiUpdateResponse>