workspace_api_revision
Creates, updates, deletes, gets or lists a workspace_api_revision resource.
Overview
| Name | workspace_api_revision |
| Type | Resource |
| Id | azure.api_management.workspace_api_revision |
Fields
The following fields are returned by SELECT queries:
- list_by_service
| 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 | resource_group_name, service_name, workspace_id, api_id, subscription_id | $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 |
|---|---|---|
api_id | string | API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. 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 | |
workspace_id | string | Workspace identifier. Must be unique in the current API Management service instance. Required. |
$filter | string | | Field | Usage | Supported operators | Supported functions ||-------------|-------------|-------------|-------------|| apiRevision | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |. 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
- list_by_service
Lists all revisions of an API.
SELECT
apiId,
apiRevision,
createdDateTime,
description,
isCurrent,
isOnline,
privateUrl,
updatedDateTime
FROM azure.api_management.workspace_api_revision
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND service_name = '{{ service_name }}' -- required
AND workspace_id = '{{ workspace_id }}' -- required
AND api_id = '{{ api_id }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $filter = '{{ $filter }}'
AND $top = '{{ $top }}'
AND $skip = '{{ $skip }}'
;