workspace_api_revisions
Creates, updates, deletes, gets or lists a workspace_api_revisions resource.
Overview
| Name | workspace_api_revisions |
| Type | Resource |
| Id | azure.api_management.workspace_api_revisions |
Fields
The following fields are returned by SELECT queries:
- list_by_service
The operation returns a list of revision details.
| Name | Datatype | Description |
|---|---|---|
apiId | string | Identifier of the API Revision. |
apiRevision | string | Revision number of API. |
createdDateTime | string (date-time) | The time the API Revision was created. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard. |
description | string | Description of the API Revision. |
isCurrent | boolean | Indicates if API revision is accessible via the gateway. |
isOnline | boolean | Indicates if API revision is the current api revision. |
privateUrl | string | Gateway URL for accessing the non-current API Revision. |
updatedDateTime | string (date-time) | The time the API Revision were updated. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list_by_service | select | resourceGroupName, serviceName, workspaceId, apiId, subscriptionId | $filter, $top, $skip | Lists all revisions of an API. |
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 |
|---|---|---|
apiId | string | API 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. |
workspaceId | string | Workspace identifier. Must be unique in the current API Management service instance. |
$filter | string | | Field | Usage | Supported operators | Supported functions |</br>|-------------|-------------|-------------|-------------|</br>| apiRevision | 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. |
SELECT examples
- list_by_service
Lists all revisions of an API.
SELECT
apiId,
apiRevision,
createdDateTime,
description,
isCurrent,
isOnline,
privateUrl,
updatedDateTime
FROM azure.api_management.workspace_api_revisions
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND serviceName = '{{ serviceName }}' -- required
AND workspaceId = '{{ workspaceId }}' -- required
AND apiId = '{{ apiId }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND $filter = '{{ $filter }}'
AND $top = '{{ $top }}'
AND $skip = '{{ $skip }}'
;