issues
Creates, updates, deletes, gets or lists an issues resource.
Overview
| Name | issues |
| Type | Resource |
| Id | azure.api_management.issues |
Fields
The following fields are returned by SELECT queries:
- get
- list_by_service
Get the details of the issue.
| Name | Datatype | Description |
|---|---|---|
properties | object | Properties of the Issue. |
Lists a collection of Issue entities.
| Name | Datatype | Description |
|---|---|---|
properties | object | Properties of the Issue. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | resourceGroupName, serviceName, issueId, subscriptionId | Gets API Management issue details | |
list_by_service | select | resourceGroupName, serviceName, subscriptionId | $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 |
|---|---|---|
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>| apiId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| title | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| authorName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| state | filter | eq | |</br> |
$skip | integer (int32) | Number of records to skip. |
$top | integer (int32) | Number of records to return. |
SELECT examples
- get
- list_by_service
Gets API Management issue details
SELECT
properties
FROM azure.api_management.issues
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND serviceName = '{{ serviceName }}' -- required
AND issueId = '{{ issueId }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;
Lists a collection of issues in the specified service instance.
SELECT
properties
FROM azure.api_management.issues
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND serviceName = '{{ serviceName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND $filter = '{{ $filter }}'
AND $top = '{{ $top }}'
AND $skip = '{{ $skip }}'
;