api_issue

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

Overview

Name	api_issue
Type	Resource
Id	azure.api_management.api_issue

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
apiId	string	A resource identifier for the API the issue was created for.
createdDate	string (date-time)	Date and time when the issue was created.
description	string	Text describing the issue. Required.
state	string	Status of the issue. Known values are: "proposed", "open", "removed", "resolved", and "closed". (proposed, open, removed, resolved, closed)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
title	string	The issue title. Required.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
userId	string	A resource identifier for the user created the issue. Required.

list_by_service

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
apiId	string	A resource identifier for the API the issue was created for.
createdDate	string (date-time)	Date and time when the issue was created.
description	string	Text describing the issue. Required.
state	string	Status of the issue. Known values are: "proposed", "open", "removed", "resolved", and "closed". (proposed, open, removed, resolved, closed)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
title	string	The issue title. Required.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
userId	string	A resource identifier for the user created the issue. Required.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, service_name, api_id, issue_id, subscription_id	expandCommentsAttachments	Gets the details of the Issue for an API specified by its identifier.
list_by_service	select	resource_group_name, service_name, api_id, subscription_id	$filter, expandCommentsAttachments, $top, $skip	Lists all issues associated with the specified API.
create_or_update	insert	resource_group_name, service_name, api_id, issue_id, subscription_id		Creates a new Issue for an API or updates an existing one.
update	update	resource_group_name, service_name, api_id, issue_id, subscription_id		Updates an existing issue for an API.
create_or_update	replace	resource_group_name, service_name, api_id, issue_id, subscription_id		Creates a new Issue for an API or updates an existing one.
delete	delete	resource_group_name, service_name, api_id, issue_id, subscription_id		Deletes the specified Issue from an API.
get_entity_tag	exec	resource_group_name, service_name, api_id, issue_id, subscription_id		Gets the entity state (Etag) version of the Issue for an API specified by its identifier.

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
api_id	string	API identifier. Must be unique in the current API Management service instance. Required.
issue_id	string	Issue identifier. Must be unique in the current API Management service instance. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
service_name	string	The name of the API Management service. Required.
subscription_id	string
$filter	string	| Field | Usage | Supported operators | Supported functions ||-------------|-------------|-------------|-------------|| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || userId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || state | filter | eq | |. Default value is None.
$skip	integer	Number of records to skip. Default value is None.
$top	integer	Number of records to return. Default value is None.
expandCommentsAttachments	boolean	Expand the comment attachments. Default value is None.

SELECT examples

get

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

SELECT
id,
name,
apiId,
createdDate,
description,
state,
systemData,
title,
type,
userId
FROM azure.api_management.api_issue
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND service_name = '{{ service_name }}' -- required
AND api_id = '{{ api_id }}' -- required
AND issue_id = '{{ issue_id }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND expandCommentsAttachments = '{{ expandCommentsAttachments }}'
;

list_by_service

Lists all issues associated with the specified API.

SELECT
id,
name,
apiId,
createdDate,
description,
state,
systemData,
title,
type,
userId
FROM azure.api_management.api_issue
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND service_name = '{{ service_name }}' -- required
AND api_id = '{{ api_id }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $filter = '{{ $filter }}'
AND expandCommentsAttachments = '{{ expandCommentsAttachments }}'
AND $top = '{{ $top }}'
AND $skip = '{{ $skip }}'
;

INSERT examples

create_or_update

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

INSERT INTO azure.api_management.api_issue (
properties,
resource_group_name,
service_name,
api_id,
issue_id,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ service_name }}',
'{{ api_id }}',
'{{ issue_id }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: api_issue
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the api_issue resource.
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the api_issue resource.
  - name: api_id
    value: "{{ api_id }}"
    description: Required parameter for the api_issue resource.
  - name: issue_id
    value: "{{ issue_id }}"
    description: Required parameter for the api_issue resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the api_issue resource.
  - name: properties
    description: |
      Properties of the Issue.
    value:
      createdDate: "{{ createdDate }}"
      state: "{{ state }}"
      apiId: "{{ apiId }}"
      title: "{{ title }}"
      description: "{{ description }}"
      userId: "{{ userId }}"

UPDATE examples

update

Updates an existing issue for an API.

UPDATE azure.api_management.api_issue
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND service_name = '{{ service_name }}' --required
AND api_id = '{{ api_id }}' --required
AND issue_id = '{{ issue_id }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

REPLACE examples

create_or_update

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

REPLACE azure.api_management.api_issue
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND service_name = '{{ service_name }}' --required
AND api_id = '{{ api_id }}' --required
AND issue_id = '{{ issue_id }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Deletes the specified Issue from an API.

DELETE FROM azure.api_management.api_issue
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND service_name = '{{ service_name }}' --required
AND api_id = '{{ api_id }}' --required
AND issue_id = '{{ issue_id }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

get_entity_tag

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

EXEC azure.api_management.api_issue.get_entity_tag 
@resource_group_name='{{ resource_group_name }}' --required, 
@service_name='{{ service_name }}' --required, 
@api_id='{{ api_id }}' --required, 
@issue_id='{{ issue_id }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;