api_issue_attachments

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

Overview

Name	api_issue_attachments
Type	Resource
Id	azure.api_management.api_issue_attachments

Fields

The following fields are returned by SELECT queries:

get

The response body contains the specified issue Attachment entity.

Name	Datatype	Description
properties	object	Properties of the Issue Attachment.

list_by_service

Paged Result response of issue attachments for the API.

Name	Datatype	Description
properties	object	Properties of the Issue Attachment.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, serviceName, apiId, issueId, attachmentId, subscriptionId		Gets the details of the issue Attachment for an API specified by its identifier.
list_by_service	select	resourceGroupName, serviceName, apiId, issueId, subscriptionId	$filter, $top, $skip	Lists all attachments for the Issue associated with the specified API.
create_or_update	insert	resourceGroupName, serviceName, apiId, issueId, attachmentId, subscriptionId	If-Match	Creates a new Attachment for the Issue in an API or updates an existing one.
delete	delete	resourceGroupName, serviceName, apiId, issueId, attachmentId, 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.
attachmentId	string	Attachment 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 Attachment for an API specified by its identifier.

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

list_by_service

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

SELECT
properties
FROM azure.api_management.api_issue_attachments
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 Attachment for the Issue in an API or updates an existing one.

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

Manifest

# Description fields are for documentation purposes
- name: api_issue_attachments
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the api_issue_attachments resource.
    - name: serviceName
      value: string
      description: Required parameter for the api_issue_attachments resource.
    - name: apiId
      value: string
      description: Required parameter for the api_issue_attachments resource.
    - name: issueId
      value: string
      description: Required parameter for the api_issue_attachments resource.
    - name: attachmentId
      value: string
      description: Required parameter for the api_issue_attachments resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the api_issue_attachments resource.
    - name: properties
      value: object
      description: |
        Properties of the Issue Attachment.
    - 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_attachments
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND serviceName = '{{ serviceName }}' --required
AND apiId = '{{ apiId }}' --required
AND issueId = '{{ issueId }}' --required
AND attachmentId = '{{ attachmentId }}' --required
AND If-Match = '{{ If-Match }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;