ApiIssueComment interface
Interface representing a ApiIssueComment.
Methods
create |
Creates a new Comment for the Issue in an API or updates an existing one. |
delete(string, string, string, string, string, string, Api |
Deletes the specified comment from an Issue. |
get(string, string, string, string, string, Api |
Gets the details of the issue Comment for an API specified by its identifier. |
get |
Gets the entity state (Etag) version of the issue Comment for an API specified by its identifier. |
list |
Lists all comments for the Issue associated with the specified API. |
Method Details
createOrUpdate(string, string, string, string, string, IssueCommentContract, ApiIssueCommentCreateOrUpdateOptionalParams)
Creates a new Comment for the Issue in an API or updates an existing one.
function createOrUpdate(resourceGroupName: string, serviceName: string, apiId: string, issueId: string, commentId: string, parameters: IssueCommentContract, options?: ApiIssueCommentCreateOrUpdateOptionalParams): Promise<ApiIssueCommentCreateOrUpdateResponse>
Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- 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.
The options parameters.
Returns
delete(string, string, string, string, string, string, ApiIssueCommentDeleteOptionalParams)
Deletes the specified comment from an Issue.
function delete(resourceGroupName: string, serviceName: string, apiId: string, issueId: string, commentId: string, ifMatch: string, options?: ApiIssueCommentDeleteOptionalParams): Promise<void>
Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- 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.
The options parameters.
Returns
Promise<void>
get(string, string, string, string, string, ApiIssueCommentGetOptionalParams)
Gets the details of the issue Comment for an API specified by its identifier.
function get(resourceGroupName: string, serviceName: string, apiId: string, issueId: string, commentId: string, options?: ApiIssueCommentGetOptionalParams): Promise<ApiIssueCommentGetResponse>
Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- 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.
- options
- ApiIssueCommentGetOptionalParams
The options parameters.
Returns
Promise<ApiIssueCommentGetResponse>
getEntityTag(string, string, string, string, string, ApiIssueCommentGetEntityTagOptionalParams)
Gets the entity state (Etag) version of the issue Comment for an API specified by its identifier.
function getEntityTag(resourceGroupName: string, serviceName: string, apiId: string, issueId: string, commentId: string, options?: ApiIssueCommentGetEntityTagOptionalParams): Promise<ApiIssueCommentGetEntityTagHeaders>
Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- 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.
The options parameters.
Returns
Promise<ApiIssueCommentGetEntityTagHeaders>
listByService(string, string, string, string, ApiIssueCommentListByServiceOptionalParams)
Lists all comments for the Issue associated with the specified API.
function listByService(resourceGroupName: string, serviceName: string, apiId: string, issueId: string, options?: ApiIssueCommentListByServiceOptionalParams): PagedAsyncIterableIterator<IssueCommentContract, IssueCommentContract[], PageSettings>
Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- 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.
The options parameters.