issue

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

Overview

Name	issue
Type	Resource
Id	azure.api_management.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, issue_id, subscription_id		Gets API Management issue details.
list_by_service	select	resource_group_name, service_name, subscription_id	$filter, $top, $skip	Lists a collection of issues in the specified service instance.

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
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 || apiId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || title | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || authorName | 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.

SELECT examples

get

Gets API Management issue details.

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

list_by_service

Lists a collection of issues in the specified service instance.

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