Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ApiIssueComment

Package version

Interface representing a ApiIssueComment.

Hierarchy

  • ApiIssueComment

Implemented by

Index

Methods

Methods

createOrUpdate

  • Creates a new Comment for the Issue in an API or updates an existing one.

    Parameters

    • resourceGroupName: string

      The name of the resource group.

    • serviceName: string

      The name of the API Management service.

    • apiId: string

      API identifier. Must be unique in the current API Management service instance.

    • issueId: string

      Issue identifier. Must be unique in the current API Management service instance.

    • commentId: string

      Comment identifier within an Issue. Must be unique in the current Issue.

    • parameters: IssueCommentContract

      Create parameters.

    • Optional options: ApiIssueCommentCreateOrUpdateOptionalParams

      The options parameters.

    Returns Promise<ApiIssueCommentCreateOrUpdateResponse>

delete

  • delete(resourceGroupName: string, serviceName: string, apiId: string, issueId: string, commentId: string, ifMatch: string, options?: ApiIssueCommentDeleteOptionalParams): Promise<void>

  • Deletes the specified comment from an Issue.

    Parameters

    • resourceGroupName: string

      The name of the resource group.

    • serviceName: string

      The name of the API Management service.

    • apiId: string

      API identifier. Must be unique in the current API Management service instance.

    • issueId: string

      Issue identifier. Must be unique in the current API Management service instance.

    • commentId: string

      Comment identifier within an Issue. Must be unique in the current Issue.

    • ifMatch: string

      ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

    • Optional options: ApiIssueCommentDeleteOptionalParams

      The options parameters.

    Returns Promise<void>

get

  • Gets the details of the issue Comment for an API specified by its identifier.

    Parameters

    • resourceGroupName: string

      The name of the resource group.

    • serviceName: string

      The name of the API Management service.

    • apiId: string

      API identifier. Must be unique in the current API Management service instance.

    • issueId: string

      Issue identifier. Must be unique in the current API Management service instance.

    • commentId: string

      Comment identifier within an Issue. Must be unique in the current Issue.

    • Optional options: ApiIssueCommentGetOptionalParams

      The options parameters.

    Returns Promise<ApiIssueCommentGetResponse>

getEntityTag

  • Gets the entity state (Etag) version of the issue Comment for an API specified by its identifier.

    Parameters

    • resourceGroupName: string

      The name of the resource group.

    • serviceName: string

      The name of the API Management service.

    • apiId: string

      API identifier. Must be unique in the current API Management service instance.

    • issueId: string

      Issue identifier. Must be unique in the current API Management service instance.

    • commentId: string

      Comment identifier within an Issue. Must be unique in the current Issue.

    • Optional options: ApiIssueCommentGetEntityTagOptionalParams

      The options parameters.

    Returns Promise<ApiIssueCommentGetEntityTagResponse>

listByService

  • Lists all comments for the Issue associated with the specified API.

    Parameters

    • resourceGroupName: string

      The name of the resource group.

    • serviceName: string

      The name of the API Management service.

    • apiId: string

      API identifier. Must be unique in the current API Management service instance.

    • issueId: string

      Issue identifier. Must be unique in the current API Management service instance.

    • Optional options: ApiIssueCommentListByServiceOptionalParams

      The options parameters.

    Returns PagedAsyncIterableIterator<IssueCommentContract>

Generated using TypeDoc