ApiIssueCommentImpl | @azure/arm-apimanagement

Class containing ApiIssueComment operations.

Hierarchy

ApiIssueCommentImpl

Implements

ApiIssueComment

Index

Constructors

constructor

Methods

Constructors

constructor

new ApiIssueCommentImpl(client: ApiManagementClientContext): ApiIssueCommentImpl

- Defined in operations/apiIssueComment.ts:33
Initialize a new instance of the class ApiIssueComment class.

Parameters
- client: ApiManagementClientContext
  
  Reference to the service client
Returns ApiIssueCommentImpl

Methods

createOrUpdate

createOrUpdate(resourceGroupName: string, serviceName: string, apiId: string, issueId: string, commentId: string, parameters: IssueCommentContract, options?: ApiIssueCommentCreateOrUpdateOptionalParams): Promise<ApiIssueCommentCreateOrUpdateResponse>

Implementation of ApiIssueComment.createOrUpdate
- Defined in operations/apiIssueComment.ts:209
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>

Implementation of ApiIssueComment.delete
- Defined in operations/apiIssueComment.ts:243
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

get(resourceGroupName: string, serviceName: string, apiId: string, issueId: string, commentId: string, options?: ApiIssueCommentGetOptionalParams): Promise<ApiIssueCommentGetResponse>

Implementation of ApiIssueComment.get
- Defined in operations/apiIssueComment.ts:185
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

getEntityTag(resourceGroupName: string, serviceName: string, apiId: string, issueId: string, commentId: string, options?: ApiIssueCommentGetEntityTagOptionalParams): Promise<ApiIssueCommentGetEntityTagResponse>

Implementation of ApiIssueComment.getEntityTag
- Defined in operations/apiIssueComment.ts:162
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

listByService(resourceGroupName: string, serviceName: string, apiId: string, issueId: string, options?: ApiIssueCommentListByServiceOptionalParams): PagedAsyncIterableIterator<IssueCommentContract>

Implementation of ApiIssueComment.listByService
- Defined in operations/apiIssueComment.ts:51
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>

Hierarchy

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

client: ApiManagementClientContext

Returns ApiIssueCommentImpl

Methods

createOrUpdate

Parameters

resourceGroupName: string

serviceName: string

apiId: string

issueId: string

commentId: string

parameters: IssueCommentContract

Optional options: ApiIssueCommentCreateOrUpdateOptionalParams

Returns Promise<ApiIssueCommentCreateOrUpdateResponse>

delete

Parameters

resourceGroupName: string

serviceName: string

apiId: string

issueId: string

commentId: string

ifMatch: string

Optional options: ApiIssueCommentDeleteOptionalParams

Returns Promise<void>

get

Parameters

resourceGroupName: string

serviceName: string

apiId: string

issueId: string

commentId: string

Optional options: ApiIssueCommentGetOptionalParams

Returns Promise<ApiIssueCommentGetResponse>

getEntityTag

Parameters

resourceGroupName: string

serviceName: string

apiId: string

issueId: string

commentId: string

Optional options: ApiIssueCommentGetEntityTagOptionalParams

Returns Promise<ApiIssueCommentGetEntityTagResponse>

listByService

Parameters

resourceGroupName: string

serviceName: string

apiId: string

issueId: string

Optional options: ApiIssueCommentListByServiceOptionalParams

Returns PagedAsyncIterableIterator<IssueCommentContract>