ApiIssueComment interface
Interface que representa uma ApiIssueComment.
Métodos
| create |
Cria um novo Comentário para o Problema numa API ou atualiza um existente. |
| delete(string, string, string, string, string, string, Api |
Elimina o comentário especificado de um Problema. |
| get(string, string, string, string, string, Api |
Obtém os detalhes do problema Comentário para uma API especificada pelo identificador. |
| get |
Obtém a versão do estado da entidade (Etag) do problema Comentário para uma API especificada pelo identificador. |
| list |
Lista todos os comentários para o Problema associado à API especificada. |
Detalhes de Método
createOrUpdate(string, string, string, string, string, IssueCommentContract, ApiIssueCommentCreateOrUpdateOptionalParams)
Cria um novo Comentário para o Problema numa API ou atualiza um existente.
function createOrUpdate(resourceGroupName: string, serviceName: string, apiId: string, issueId: string, commentId: string, parameters: IssueCommentContract, options?: ApiIssueCommentCreateOrUpdateOptionalParams): Promise<ApiIssueCommentCreateOrUpdateResponse>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.
- issueId
-
string
Identificador de problema. Tem de ser exclusivo na instância de serviço de Gestão de API atual.
- commentId
-
string
Identificador de comentários dentro de um Problema. Tem de ser exclusivo no Problema atual.
- parameters
- IssueCommentContract
Criar parâmetros.
Os parâmetros de opções.
Devoluções
delete(string, string, string, string, string, string, ApiIssueCommentDeleteOptionalParams)
Elimina o comentário especificado de um Problema.
function delete(resourceGroupName: string, serviceName: string, apiId: string, issueId: string, commentId: string, ifMatch: string, options?: ApiIssueCommentDeleteOptionalParams): 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.
- issueId
-
string
Identificador de problema. Tem de ser exclusivo na instância de serviço de Gestão de API atual.
- commentId
-
string
Identificador de comentários dentro de um Problema. Tem de ser exclusivo no Problema 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.
Os parâmetros de opções.
Devoluções
Promise<void>
get(string, string, string, string, string, ApiIssueCommentGetOptionalParams)
Obtém os detalhes do problema Comentário para uma API especificada pelo identificador.
function get(resourceGroupName: string, serviceName: string, apiId: string, issueId: string, commentId: string, options?: ApiIssueCommentGetOptionalParams): Promise<ApiIssueCommentGetResponse>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.
- issueId
-
string
Identificador de problema. Tem de ser exclusivo na instância de serviço de Gestão de API atual.
- commentId
-
string
Identificador de comentários dentro de um Problema. Tem de ser exclusivo no Problema atual.
- options
- ApiIssueCommentGetOptionalParams
Os parâmetros de opções.
Devoluções
Promise<ApiIssueCommentGetResponse>
getEntityTag(string, string, string, string, string, ApiIssueCommentGetEntityTagOptionalParams)
Obtém a versão do estado da entidade (Etag) do problema Comentário para uma API especificada pelo identificador.
function getEntityTag(resourceGroupName: string, serviceName: string, apiId: string, issueId: string, commentId: string, options?: ApiIssueCommentGetEntityTagOptionalParams): Promise<ApiIssueCommentGetEntityTagHeaders>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.
- issueId
-
string
Identificador de problema. Tem de ser exclusivo na instância de serviço de Gestão de API atual.
- commentId
-
string
Identificador de comentários dentro de um Problema. Tem de ser exclusivo no Problema atual.
Os parâmetros de opções.
Devoluções
Promise<ApiIssueCommentGetEntityTagHeaders>
listByService(string, string, string, string, ApiIssueCommentListByServiceOptionalParams)
Lista todos os comentários para o Problema associado à API especificada.
function listByService(resourceGroupName: string, serviceName: string, apiId: string, issueId: string, options?: ApiIssueCommentListByServiceOptionalParams): PagedAsyncIterableIterator<IssueCommentContract, IssueCommentContract[], 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.
- apiId
-
string
Identificador de API. Tem de ser exclusivo na instância de serviço de Gestão de API atual.
- issueId
-
string
Identificador de problema. Tem de ser exclusivo na instância de serviço de Gestão de API atual.
Os parâmetros de opções.