api_issue_comments

Creates, updates, deletes, gets or lists an api_issue_comments resource.

Overview

Name	api_issue_comments
Type	Resource
Id	azure.api_management.api_issue_comments

Fields

The following fields are returned by SELECT queries:

get

The response body contains the specified issue Comment entity.

Name	Datatype	Description
properties	object	Properties of the Issue Comment.

list_by_service

Paged Result response of issue comments for the API.

Name	Datatype	Description
properties	object	Properties of the Issue Comment.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, serviceName, apiId, issueId, commentId, subscriptionId		Gets the details of the issue Comment for an API specified by its identifier.
list_by_service	select	resourceGroupName, serviceName, apiId, issueId, subscriptionId	$filter, $top, $skip	Lists all comments for the Issue associated with the specified API.
create_or_update	insert	resourceGroupName, serviceName, apiId, issueId, commentId, subscriptionId	If-Match	Creates a new Comment for the Issue in an API or updates an existing one.
delete	delete	resourceGroupName, serviceName, apiId, issueId, commentId, If-Match, subscriptionId		Deletes the specified comment from an Issue.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
If-Match	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.
apiId	string	API 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.
issueId	string	Issue identifier. Must be unique in the current API Management service instance.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
serviceName	string	The name of the API Management service.
subscriptionId	string	The ID of the target subscription.
$filter	string	| Field | Usage | Supported operators | Supported functions |</br>|-------------|-------------|-------------|-------------|</br>| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| userId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>
$skip	integer (int32)	Number of records to skip.
$top	integer (int32)	Number of records to return.
If-Match	string	ETag of the Entity. Not required when creating an entity, but required when updating an entity.

SELECT examples

get

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

SELECT
properties
FROM azure.api_management.api_issue_comments
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND serviceName = '{{ serviceName }}' -- required
AND apiId = '{{ apiId }}' -- required
AND issueId = '{{ issueId }}' -- required
AND commentId = '{{ commentId }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_by_service

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

SELECT
properties
FROM azure.api_management.api_issue_comments
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND serviceName = '{{ serviceName }}' -- required
AND apiId = '{{ apiId }}' -- required
AND issueId = '{{ issueId }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND $filter = '{{ $filter }}'
AND $top = '{{ $top }}'
AND $skip = '{{ $skip }}'
;

INSERT examples

create_or_update

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

INSERT INTO azure.api_management.api_issue_comments (
data__properties,
resourceGroupName,
serviceName,
apiId,
issueId,
commentId,
subscriptionId,
If-Match
)
SELECT 
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ serviceName }}',
'{{ apiId }}',
'{{ issueId }}',
'{{ commentId }}',
'{{ subscriptionId }}',
'{{ If-Match }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: api_issue_comments
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the api_issue_comments resource.
    - name: serviceName
      value: string
      description: Required parameter for the api_issue_comments resource.
    - name: apiId
      value: string
      description: Required parameter for the api_issue_comments resource.
    - name: issueId
      value: string
      description: Required parameter for the api_issue_comments resource.
    - name: commentId
      value: string
      description: Required parameter for the api_issue_comments resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the api_issue_comments resource.
    - name: properties
      value: object
      description: |
        Properties of the Issue Comment.
    - name: If-Match
      value: string
      description: ETag of the Entity. Not required when creating an entity, but required when updating an entity.

DELETE examples

delete

Deletes the specified comment from an Issue.

DELETE FROM azure.api_management.api_issue_comments
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND serviceName = '{{ serviceName }}' --required
AND apiId = '{{ apiId }}' --required
AND issueId = '{{ issueId }}' --required
AND commentId = '{{ commentId }}' --required
AND If-Match = '{{ If-Match }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;