portal_revisions

Creates, updates, deletes, gets or lists a portal_revisions resource.

Overview

Name	portal_revisions
Type	Resource
Id	azure.api_management.portal_revisions

Fields

The following fields are returned by SELECT queries:

get

Gets the specified portal's revision.

Name	Datatype	Description
properties	object	Properties of the portal revisions.

list_by_service

Lists portal's revisions.

Name	Datatype	Description
properties	object	Properties of the portal revisions.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, serviceName, portalRevisionId, subscriptionId		Gets the developer portal's revision specified by its identifier.
list_by_service	select	resourceGroupName, serviceName, subscriptionId	$filter, $top, $skip	Lists developer portal's revisions.
create_or_update	insert	resourceGroupName, serviceName, portalRevisionId, subscriptionId		Creates a new developer portal's revision by running the portal's publishing. The isCurrent property indicates if the revision is publicly accessible.
update	update	resourceGroupName, serviceName, portalRevisionId, If-Match, subscriptionId		Updates the description of specified portal revision or makes it current.

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
If-Match	string	ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.
portalRevisionId	string	Portal revision 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 | Supported operators | Supported functions | |-------------|------------------------|-----------------------------------| |name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith| |description | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith| |isCurrent | eq, ne | |
$skip	integer (int32)	Number of records to skip.
$top	integer (int32)	Number of records to return.

SELECT examples

get

Gets the developer portal's revision specified by its identifier.

SELECT
properties
FROM azure.api_management.portal_revisions
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND serviceName = '{{ serviceName }}' -- required
AND portalRevisionId = '{{ portalRevisionId }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_by_service

Lists developer portal's revisions.

SELECT
properties
FROM azure.api_management.portal_revisions
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND serviceName = '{{ serviceName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND $filter = '{{ $filter }}'
AND $top = '{{ $top }}'
AND $skip = '{{ $skip }}'
;

INSERT examples

create_or_update

Creates a new developer portal's revision by running the portal's publishing. The isCurrent property indicates if the revision is publicly accessible.

INSERT INTO azure.api_management.portal_revisions (
data__properties,
resourceGroupName,
serviceName,
portalRevisionId,
subscriptionId
)
SELECT 
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ serviceName }}',
'{{ portalRevisionId }}',
'{{ subscriptionId }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: portal_revisions
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the portal_revisions resource.
    - name: serviceName
      value: string
      description: Required parameter for the portal_revisions resource.
    - name: portalRevisionId
      value: string
      description: Required parameter for the portal_revisions resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the portal_revisions resource.
    - name: properties
      value: object
      description: |
        Properties of the portal revisions.

UPDATE examples

update

Updates the description of specified portal revision or makes it current.

UPDATE azure.api_management.portal_revisions
SET 
data__properties = '{{ properties }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}' --required
AND serviceName = '{{ serviceName }}' --required
AND portalRevisionId = '{{ portalRevisionId }}' --required
AND If-Match = '{{ If-Match }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
RETURNING
properties;