ApiIssue interface
Interface que representa uma ApiIssue.
Métodos
| create |
Cria ou atualiza um problema para uma API. |
| delete(string, string, string, string, string, Api |
Exclui o problema especificado de uma API. |
| get(string, string, string, string, Api |
Obtém os detalhes do problema de uma API especificada por seu identificador. |
| get |
Obtém a versão Etag (estado de entidade) do Problema para uma API especificada por seu identificador. |
| list |
Lista todos os problemas associados à API especificada. |
| update(string, string, string, string, string, Issue |
Atualizações um problema existente para uma API. |
Detalhes do método
createOrUpdate(string, string, string, string, IssueContract, ApiIssueCreateOrUpdateOptionalParams)
Cria ou atualiza um problema para uma API.
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 diferencia maiúsculas de minúsculas.
- serviceName
-
string
O nome do serviço Gerenciamento de API.
- apiId
-
string
Identificador da API. Deve ser exclusivo na instância de serviço Gerenciamento de API atual.
- issueId
-
string
Identificador de problema. Deve ser exclusivo na instância de serviço Gerenciamento de API atual.
- parameters
- IssueContract
Criar parâmetros.
Os parâmetros de opções.
Retornos
Promise<ApiIssueCreateOrUpdateResponse>
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 diferencia maiúsculas de minúsculas.
- serviceName
-
string
O nome do serviço Gerenciamento de API.
- apiId
-
string
Identificador da API. Deve ser exclusivo na instância de serviço Gerenciamento de API atual.
- issueId
-
string
Identificador de problema. 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
- ApiIssueDeleteOptionalParams
Os parâmetros de opções.
Retornos
Promise<void>
get(string, string, string, string, ApiIssueGetOptionalParams)
Obtém os detalhes do problema de 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 diferencia maiúsculas de minúsculas.
- serviceName
-
string
O nome do serviço Gerenciamento de API.
- apiId
-
string
Identificador da API. Deve ser exclusivo na instância de serviço Gerenciamento de API atual.
- issueId
-
string
Identificador de problema. Deve ser exclusivo na instância de serviço Gerenciamento de API atual.
- options
- ApiIssueGetOptionalParams
Os parâmetros de opções.
Retornos
Promise<ApiIssueGetResponse>
getEntityTag(string, string, string, string, ApiIssueGetEntityTagOptionalParams)
Obtém a versão Etag (estado de entidade) 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 diferencia maiúsculas de minúsculas.
- serviceName
-
string
O nome do serviço Gerenciamento de API.
- apiId
-
string
Identificador da API. Deve ser exclusivo na instância de serviço Gerenciamento de API atual.
- issueId
-
string
Identificador de problema. Deve ser exclusivo na instância de serviço Gerenciamento de API atual.
Os parâmetros de opções.
Retornos
Promise<ApiIssueGetEntityTagHeaders>
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 diferencia maiúsculas de minúsculas.
- serviceName
-
string
O nome do serviço Gerenciamento de API.
- apiId
-
string
Identificador da API. Deve ser exclusivo na instância de serviço Gerenciamento de API atual.
Os parâmetros de opções.
Retornos
update(string, string, string, string, string, IssueUpdateContract, ApiIssueUpdateOptionalParams)
Atualizações 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 diferencia maiúsculas de minúsculas.
- serviceName
-
string
O nome do serviço Gerenciamento de API.
- apiId
-
string
Identificador da API. Deve ser exclusivo na instância de serviço Gerenciamento de API atual.
- issueId
-
string
Identificador de problema. 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
- IssueUpdateContract
Atualizar parâmetros.
- options
- ApiIssueUpdateOptionalParams
Os parâmetros de opções.
Retornos
Promise<ApiIssueUpdateResponse>