Partilhar via


ApiIssue interface

Interface que representa um ApiIssue.

Métodos

createOrUpdate(string, string, string, string, IssueContract, ApiIssueCreateOrUpdateOptionalParams)

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

delete(string, string, string, string, string, ApiIssueDeleteOptionalParams)

Exclui o Problema especificado de uma API.

get(string, string, string, string, ApiIssueGetOptionalParams)

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

getEntityTag(string, string, string, string, ApiIssueGetEntityTagOptionalParams)

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

listByService(string, string, string, ApiIssueListByServiceOptionalParams)

Lista todos os problemas associados à API especificada.

update(string, string, string, string, string, IssueUpdateContract, ApiIssueUpdateOptionalParams)

Atualiza um problema existente para uma API.

Detalhes de Método

createOrUpdate(string, string, string, string, IssueContract, ApiIssueCreateOrUpdateOptionalParams)

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

function createOrUpdate(resourceGroupName: string, serviceName: string, apiId: string, issueId: string, parameters: IssueContract, options?: ApiIssueCreateOrUpdateOptionalParams): Promise<ApiIssueCreateOrUpdateResponse>

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 de serviço de Gerenciamento de API atual.

issueId

string

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

parameters
IssueContract

Crie parâmetros.

options
ApiIssueCreateOrUpdateOptionalParams

Os parâmetros de opções.

Devoluções

delete(string, string, string, string, string, ApiIssueDeleteOptionalParams)

Exclui o Problema especificado de uma API.

function delete(resourceGroupName: string, serviceName: string, apiId: string, issueId: string, ifMatch: string, options?: ApiIssueDeleteOptionalParams): 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 de serviço de Gerenciamento de API atual.

issueId

string

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

ifMatch

string

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

options
ApiIssueDeleteOptionalParams

Os parâmetros de opções.

Devoluções

Promise<void>

get(string, string, string, string, ApiIssueGetOptionalParams)

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

function get(resourceGroupName: string, serviceName: string, apiId: string, issueId: string, options?: ApiIssueGetOptionalParams): Promise<ApiIssueGetResponse>

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 de serviço de Gerenciamento de API atual.

issueId

string

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

options
ApiIssueGetOptionalParams

Os parâmetros de opções.

Devoluções

getEntityTag(string, string, string, string, ApiIssueGetEntityTagOptionalParams)

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

function getEntityTag(resourceGroupName: string, serviceName: string, apiId: string, issueId: string, options?: ApiIssueGetEntityTagOptionalParams): Promise<ApiIssueGetEntityTagHeaders>

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 de serviço de Gerenciamento de API atual.

issueId

string

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

options
ApiIssueGetEntityTagOptionalParams

Os parâmetros de opções.

Devoluções

listByService(string, string, string, ApiIssueListByServiceOptionalParams)

Lista todos os problemas associados à API especificada.

function listByService(resourceGroupName: string, serviceName: string, apiId: string, options?: ApiIssueListByServiceOptionalParams): PagedAsyncIterableIterator<IssueContract, IssueContract[], PageSettings>

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 de serviço de Gerenciamento de API atual.

options
ApiIssueListByServiceOptionalParams

Os parâmetros de opções.

Devoluções

update(string, string, string, string, string, IssueUpdateContract, ApiIssueUpdateOptionalParams)

Atualiza um problema existente para uma API.

function update(resourceGroupName: string, serviceName: string, apiId: string, issueId: string, ifMatch: string, parameters: IssueUpdateContract, options?: ApiIssueUpdateOptionalParams): Promise<ApiIssueUpdateResponse>

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 de serviço de Gerenciamento de API atual.

issueId

string

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

ifMatch

string

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

parameters
IssueUpdateContract

Atualizar parâmetros.

options
ApiIssueUpdateOptionalParams

Os parâmetros de opções.

Devoluções