Partilhar via

Documentation interface

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

Interface que representa uma Documentação.

Métodos

createOrUpdate(string, string, string, DocumentationContract, DocumentationCreateOrUpdateOptionalParams)

Cria uma nova Documentação ou atualiza uma existente.
delete(string, string, string, string, DocumentationDeleteOptionalParams)

Elimina a Documentação especificada de uma API.
get(string, string, string, DocumentationGetOptionalParams)

Obtém os detalhes da Documentação especificada pelo identificador.
getEntityTag(string, string, string, DocumentationGetEntityTagOptionalParams)

Obtém a versão de estado da entidade (Etag) da Documentação pelo identificador.
listByService(string, string, DocumentationListByServiceOptionalParams)

Lista todas as Documentação da instância de serviço Gestão de API.
update(string, string, string, string, DocumentationUpdateContract, DocumentationUpdateOptionalParams)

Atualizações os detalhes da Documentação de uma API especificada pelo identificador.

Detalhes de Método

createOrUpdate(string, string, string, DocumentationContract, DocumentationCreateOrUpdateOptionalParams)

Cria uma nova Documentação ou atualiza uma existente.

function createOrUpdate(resourceGroupName: string, serviceName: string, documentationId: string, parameters: DocumentationContract, options?: DocumentationCreateOrUpdateOptionalParams): Promise<DocumentationCreateOrUpdateResponse>

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.

documentationId

string

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

parameters
DocumentationContract

Criar parâmetros.

options
DocumentationCreateOrUpdateOptionalParams

Os parâmetros de opções.

Devoluções

Promise<DocumentationCreateOrUpdateResponse>

delete(string, string, string, string, DocumentationDeleteOptionalParams)

Elimina a Documentação especificada de uma API.

function delete(resourceGroupName: string, serviceName: string, documentationId: string, ifMatch: string, options?: DocumentationDeleteOptionalParams): 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.

documentationId

string

Identificador de documentação. 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
DocumentationDeleteOptionalParams

Os parâmetros de opções.

Devoluções

Promise<void>

get(string, string, string, DocumentationGetOptionalParams)

Obtém os detalhes da Documentação especificada pelo identificador.

function get(resourceGroupName: string, serviceName: string, documentationId: string, options?: DocumentationGetOptionalParams): Promise<DocumentationGetResponse>

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.

documentationId

string

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

options
DocumentationGetOptionalParams

Os parâmetros de opções.

Devoluções

Promise<DocumentationGetResponse>

getEntityTag(string, string, string, DocumentationGetEntityTagOptionalParams)

Obtém a versão de estado da entidade (Etag) da Documentação pelo identificador.

function getEntityTag(resourceGroupName: string, serviceName: string, documentationId: string, options?: DocumentationGetEntityTagOptionalParams): Promise<DocumentationGetEntityTagHeaders>

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.

documentationId

string

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

options
DocumentationGetEntityTagOptionalParams

Os parâmetros de opções.

Devoluções

Promise<DocumentationGetEntityTagHeaders>

listByService(string, string, DocumentationListByServiceOptionalParams)

Lista todas as Documentação da instância de serviço Gestão de API.

function listByService(resourceGroupName: string, serviceName: string, options?: DocumentationListByServiceOptionalParams): PagedAsyncIterableIterator<DocumentationContract, DocumentationContract[], PageSettings>

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.

options
DocumentationListByServiceOptionalParams

Os parâmetros de opções.

Devoluções

PagedAsyncIterableIterator<DocumentationContract, DocumentationContract[], PageSettings>

update(string, string, string, string, DocumentationUpdateContract, DocumentationUpdateOptionalParams)

Atualizações os detalhes da Documentação de uma API especificada pelo identificador.

function update(resourceGroupName: string, serviceName: string, documentationId: string, ifMatch: string, parameters: DocumentationUpdateContract, options?: DocumentationUpdateOptionalParams): Promise<DocumentationUpdateResponse>

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.

documentationId

string

Identificador de documentação. 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
DocumentationUpdateContract

Parâmetros de Atualização de Documentação.

options
DocumentationUpdateOptionalParams

Os parâmetros de opções.

Devoluções

Promise<DocumentationUpdateResponse>