ProductWiki interface

Pacote:

@azure/arm-apimanagement

Interface que representa um ProductWiki.

Métodos

createOrUpdate(string, string, string, WikiContract, ProductWikiCreateOrUpdateOptionalParams)	Cria um novo Wiki para um Produto ou atualiza um existente.
delete(string, string, string, string, ProductWikiDeleteOptionalParams)	Exclui o Wiki especificado de um Produto.
get(string, string, string, ProductWikiGetOptionalParams)	Obtém os detalhes do Wiki para um Produto especificado por seu identificador.
getEntityTag(string, string, string, ProductWikiGetEntityTagOptionalParams)	Obtém a versão Etag (estado de entidade) do Wiki para um Produto especificado por seu identificador.
update(string, string, string, string, WikiUpdateContract, ProductWikiUpdateOptionalParams)	Atualizações os detalhes do Wiki para um Produto especificado por seu identificador.

Detalhes do método

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

Cria um novo Wiki para um Produto ou atualiza um existente.

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

Parâmetros

resourceGroupName

string

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

serviceName

string

O nome do serviço Gerenciamento de API.

productId

string

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

parameters

WikiContract

Criar parâmetros.

options

ProductWikiCreateOrUpdateOptionalParams

Os parâmetros de opções.

Retornos

Promise<ProductWikiCreateOrUpdateResponse>

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

Exclui o Wiki especificado de um Produto.

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

Parâmetros

resourceGroupName

string

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

serviceName

string

O nome do serviço Gerenciamento de API.

productId

string

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

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

ProductWikiDeleteOptionalParams

Os parâmetros de opções.

Retornos

Promise<void>

get(string, string, string, ProductWikiGetOptionalParams)

Obtém os detalhes do Wiki para um Produto especificado por seu identificador.

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

Parâmetros

resourceGroupName

string

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

serviceName

string

O nome do serviço Gerenciamento de API.

productId

string

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

options

ProductWikiGetOptionalParams

Os parâmetros de opções.

Retornos

Promise<ProductWikiGetResponse>

getEntityTag(string, string, string, ProductWikiGetEntityTagOptionalParams)

Obtém a versão Etag (estado de entidade) do Wiki para um Produto especificado por seu identificador.

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

Parâmetros

resourceGroupName

string

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

serviceName

string

O nome do serviço Gerenciamento de API.

productId

string

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

options

ProductWikiGetEntityTagOptionalParams

Os parâmetros de opções.

Retornos

Promise<ProductWikiGetEntityTagHeaders>

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

Atualizações os detalhes do Wiki para um Produto especificado por seu identificador.

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

Parâmetros

resourceGroupName

string

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

serviceName

string

O nome do serviço Gerenciamento de API.

productId

string

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

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

ProductWikiUpdateOptionalParams

Os parâmetros de opções.

Retornos

Promise<ProductWikiUpdateResponse>