api_release

Creates, updates, deletes, gets or lists an api_release resource.

Overview

Name	api_release
Type	Resource
Id	azure.api_management.api_release

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.
apiId	string	Identifier of the API the release belongs to.
createdDateTime	string (date-time)	The time the API was released. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
notes	string	Release Notes.
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)	The time the API release was updated.

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.
apiId	string	Identifier of the API the release belongs to.
createdDateTime	string (date-time)	The time the API was released. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
notes	string	Release Notes.
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)	The time the API release was updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, service_name, api_id, release_id, subscription_id		Returns the details of an API release.
list_by_service	select	resource_group_name, service_name, api_id, subscription_id	$filter, $top, $skip	Lists all releases of an API. An API release is created when making an API Revision current. Releases are also used to rollback to previous revisions. Results will be paged and can be constrained by the $top and $skip parameters.
create_or_update	insert	resource_group_name, service_name, api_id, release_id, subscription_id		Creates a new Release for the API.
update	update	resource_group_name, service_name, api_id, release_id, subscription_id		Updates the details of the release of the API specified by its identifier.
create_or_update	replace	resource_group_name, service_name, api_id, release_id, subscription_id		Creates a new Release for the API.
delete	delete	resource_group_name, service_name, api_id, release_id, subscription_id		Deletes the specified release in the API.
get_entity_tag	exec	resource_group_name, service_name, api_id, release_id, subscription_id		Returns the etag of an API release.

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 identifier. Must be unique in the current API Management service instance. Required.
release_id	string	Release identifier within an API. 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 | Usage | Supported operators | Supported functions ||-------------|-------------|-------------|-------------|| notes | 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

get

Returns the details of an API release.

SELECT
id,
name,
apiId,
createdDateTime,
notes,
systemData,
type,
updatedDateTime
FROM azure.api_management.api_release
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND service_name = '{{ service_name }}' -- required
AND api_id = '{{ api_id }}' -- required
AND release_id = '{{ release_id }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_service

Lists all releases of an API. An API release is created when making an API Revision current. Releases are also used to rollback to previous revisions. Results will be paged and can be constrained by the $top and $skip parameters.

SELECT
id,
name,
apiId,
createdDateTime,
notes,
systemData,
type,
updatedDateTime
FROM azure.api_management.api_release
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND service_name = '{{ service_name }}' -- required
AND api_id = '{{ api_id }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $filter = '{{ $filter }}'
AND $top = '{{ $top }}'
AND $skip = '{{ $skip }}'
;

INSERT examples

create_or_update

Creates a new Release for the API.

INSERT INTO azure.api_management.api_release (
properties,
resource_group_name,
service_name,
api_id,
release_id,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ service_name }}',
'{{ api_id }}',
'{{ release_id }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: api_release
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the api_release resource.
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the api_release resource.
  - name: api_id
    value: "{{ api_id }}"
    description: Required parameter for the api_release resource.
  - name: release_id
    value: "{{ release_id }}"
    description: Required parameter for the api_release resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the api_release resource.
  - name: properties
    description: |
      ApiRelease entity contract properties.
    value:
      apiId: "{{ apiId }}"
      createdDateTime: "{{ createdDateTime }}"
      updatedDateTime: "{{ updatedDateTime }}"
      notes: "{{ notes }}"

UPDATE examples

update

Updates the details of the release of the API specified by its identifier.

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

REPLACE examples

create_or_update

Creates a new Release for the API.

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

DELETE examples

delete

Deletes the specified release in the API.

DELETE FROM azure.api_management.api_release
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND service_name = '{{ service_name }}' --required
AND api_id = '{{ api_id }}' --required
AND release_id = '{{ release_id }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

get_entity_tag

Returns the etag of an API release.

EXEC azure.api_management.api_release.get_entity_tag 
@resource_group_name='{{ resource_group_name }}' --required, 
@service_name='{{ service_name }}' --required, 
@api_id='{{ api_id }}' --required, 
@release_id='{{ release_id }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;