portal_revision

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

Overview

Name	portal_revision
Type	Resource
Id	azure.api_management.portal_revision

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.
createdDateTime	string (date-time)	Portal's revision creation date and time.
description	string	Portal revision description.
isCurrent	boolean	Indicates if the portal's revision is public.
provisioningState	string	The provisioning state.
status	string	Status of the portal's revision. Known values are: "pending", "publishing", "completed", and "failed". (pending, publishing, completed, failed)
statusDetails	string	Portal revision publishing status details.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
updatedDateTime	string (date-time)	Last updated date and time.

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.
createdDateTime	string (date-time)	Portal's revision creation date and time.
description	string	Portal revision description.
isCurrent	boolean	Indicates if the portal's revision is public.
provisioningState	string	The provisioning state.
status	string	Status of the portal's revision. Known values are: "pending", "publishing", "completed", and "failed". (pending, publishing, completed, failed)
statusDetails	string	Portal revision publishing status details.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
updatedDateTime	string (date-time)	Last updated date and time.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, service_name, portal_revision_id, subscription_id		Gets the developer portal's revision specified by its identifier.
list_by_service	select	resource_group_name, service_name, subscription_id	$filter, $top, $skip	Lists developer portal's revisions.
create_or_update	insert	resource_group_name, service_name, portal_revision_id, subscription_id		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	resource_group_name, service_name, portal_revision_id, subscription_id		Updates the description of specified portal revision or makes it current.
create_or_update	replace	resource_group_name, service_name, portal_revision_id, subscription_id		Creates a new developer portal's revision by running the portal's publishing. The isCurrent property indicates if the revision is publicly accessible.
get_entity_tag	exec	resource_group_name, service_name, portal_revision_id, subscription_id		Gets the developer portal revision specified by its identifier.

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
portal_revision_id	string	Portal revision 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 | 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 | |. 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 the developer portal's revision specified by its identifier.

SELECT
id,
name,
createdDateTime,
description,
isCurrent,
provisioningState,
status,
statusDetails,
systemData,
type,
updatedDateTime
FROM azure.api_management.portal_revision
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND service_name = '{{ service_name }}' -- required
AND portal_revision_id = '{{ portal_revision_id }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_service

Lists developer portal's revisions.

SELECT
id,
name,
createdDateTime,
description,
isCurrent,
provisioningState,
status,
statusDetails,
systemData,
type,
updatedDateTime
FROM azure.api_management.portal_revision
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 }}'
;

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_revision (
properties,
resource_group_name,
service_name,
portal_revision_id,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ service_name }}',
'{{ portal_revision_id }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: portal_revision
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the portal_revision resource.
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the portal_revision resource.
  - name: portal_revision_id
    value: "{{ portal_revision_id }}"
    description: Required parameter for the portal_revision resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the portal_revision resource.
  - name: properties
    description: |
      Properties of the portal revisions.
    value:
      description: "{{ description }}"
      statusDetails: "{{ statusDetails }}"
      status: "{{ status }}"
      isCurrent: {{ isCurrent }}
      createdDateTime: "{{ createdDateTime }}"
      updatedDateTime: "{{ updatedDateTime }}"
      provisioningState: "{{ provisioningState }}"

UPDATE examples

update

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

UPDATE azure.api_management.portal_revision
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND service_name = '{{ service_name }}' --required
AND portal_revision_id = '{{ portal_revision_id }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

REPLACE 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.

REPLACE azure.api_management.portal_revision
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND service_name = '{{ service_name }}' --required
AND portal_revision_id = '{{ portal_revision_id }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

Lifecycle Methods

get_entity_tag

Gets the developer portal revision specified by its identifier.

EXEC azure.api_management.portal_revision.get_entity_tag 
@resource_group_name='{{ resource_group_name }}' --required, 
@service_name='{{ service_name }}' --required, 
@portal_revision_id='{{ portal_revision_id }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;