ApiWiki interface

Pacote:

@azure/arm-apimanagement

Interface que representa uma 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)	Elimina o Wiki especificado de uma API.
get(string, string, string, ApiWikiGetOptionalParams)	Obtém os detalhes do Wiki para uma API especificada pelo identificador.
getEntityTag(string, string, string, ApiWikiGetEntityTagOptionalParams)	Obtém a versão de estado da entidade (Etag) do Wiki para uma API especificada pelo identificador.
update(string, string, string, string, WikiUpdateContract, ApiWikiUpdateOptionalParams)	Atualizações os detalhes do Wiki para uma API especificada pelo identificador.

Detalhes de 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 é sensível a maiúsculas e minúsculas.

serviceName

string

O nome do serviço Gestão de API.

apiId

string

Identificador de API. Tem de ser exclusivo na instância de serviço de Gestão de API atual.

parameters

WikiContract

Criar parâmetros.

options

ApiWikiCreateOrUpdateOptionalParams

Os parâmetros de opções.

Devoluções

Promise<ApiWikiCreateOrUpdateResponse>

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

Elimina 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 é sensível a maiúsculas e minúsculas.

serviceName

string

O nome do serviço Gestão de API.

apiId

string

Identificador de API. Tem de ser exclusivo na instância de serviço de Gestão de API atual.

ifMatch

string

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

options

ApiWikiDeleteOptionalParams

Os parâmetros de opções.

Devoluções

Promise<void>

get(string, string, string, ApiWikiGetOptionalParams)

Obtém os detalhes do Wiki para uma API especificada pelo 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 é sensível a maiúsculas e minúsculas.

serviceName

string

O nome do serviço Gestão de API.

apiId

string

Identificador de API. Tem de ser exclusivo na instância de serviço de Gestão de API atual.

options

ApiWikiGetOptionalParams

Os parâmetros de opções.

Devoluções

Promise<ApiWikiGetResponse>

getEntityTag(string, string, string, ApiWikiGetEntityTagOptionalParams)

Obtém a versão de estado da entidade (Etag) do Wiki para uma API especificada pelo 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 é sensível a maiúsculas e minúsculas.

serviceName

string

O nome do serviço Gestão de API.

apiId

string

Identificador de API. Tem de ser exclusivo na instância de serviço de Gestão de API atual.

options

ApiWikiGetEntityTagOptionalParams

Os parâmetros de opções.

Devoluções

Promise<ApiWikiGetEntityTagHeaders>

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

Atualizações os detalhes do Wiki para uma API especificada pelo 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 é sensível a maiúsculas e minúsculas.

serviceName

string

O nome do serviço Gestão de API.

apiId

string

Identificador de API. Tem de ser exclusivo na instância de serviço de Gestão de API atual.

ifMatch

string

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

parameters

WikiUpdateContract

Parâmetros da Atualização wiki.

options

ApiWikiUpdateOptionalParams

Os parâmetros de opções.

Devoluções

Promise<ApiWikiUpdateResponse>