workspace_api_releases

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

Overview

Name	workspace_api_releases
Type	Resource
Id	azure.api_management.workspace_api_releases

Fields

The following fields are returned by SELECT queries:

get

The operation returns the details of an API Release.

Name	Datatype	Description
properties	object	ApiRelease entity contract properties.

list_by_service

The operation returns a list of API Releases.

Name	Datatype	Description
properties	object	ApiRelease entity contract properties.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, serviceName, workspaceId, apiId, releaseId, subscriptionId		Returns the details of an API release.
list_by_service	select	resourceGroupName, serviceName, workspaceId, apiId, subscriptionId	$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	resourceGroupName, serviceName, workspaceId, apiId, releaseId, subscriptionId	If-Match	Creates a new Release for the API.
update	update	resourceGroupName, serviceName, workspaceId, apiId, releaseId, If-Match, subscriptionId		Updates the details of the release of the API specified by its identifier.
delete	delete	resourceGroupName, serviceName, workspaceId, apiId, releaseId, If-Match, subscriptionId		Deletes the specified release in the 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
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.
apiId	string	API identifier. Must be unique in the current API Management service instance.
releaseId	string	Release identifier within an API. 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>| notes | 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.
If-Match	string	ETag of the Entity. Not required when creating an entity, but required when updating an entity.

SELECT examples

get

Returns the details of an API release.

SELECT
properties
FROM azure.api_management.workspace_api_releases
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND serviceName = '{{ serviceName }}' -- required
AND workspaceId = '{{ workspaceId }}' -- required
AND apiId = '{{ apiId }}' -- required
AND releaseId = '{{ releaseId }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- 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
properties
FROM azure.api_management.workspace_api_releases
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 }}'
;

INSERT examples

create_or_update

Creates a new Release for the API.

INSERT INTO azure.api_management.workspace_api_releases (
data__properties,
resourceGroupName,
serviceName,
workspaceId,
apiId,
releaseId,
subscriptionId,
If-Match
)
SELECT 
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ serviceName }}',
'{{ workspaceId }}',
'{{ apiId }}',
'{{ releaseId }}',
'{{ subscriptionId }}',
'{{ If-Match }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: workspace_api_releases
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the workspace_api_releases resource.
    - name: serviceName
      value: string
      description: Required parameter for the workspace_api_releases resource.
    - name: workspaceId
      value: string
      description: Required parameter for the workspace_api_releases resource.
    - name: apiId
      value: string
      description: Required parameter for the workspace_api_releases resource.
    - name: releaseId
      value: string
      description: Required parameter for the workspace_api_releases resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the workspace_api_releases resource.
    - name: properties
      value: object
      description: |
        ApiRelease entity contract properties.
    - name: If-Match
      value: string
      description: ETag of the Entity. Not required when creating an entity, but required when updating an entity.

UPDATE examples

update

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

UPDATE azure.api_management.workspace_api_releases
SET 
data__properties = '{{ properties }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}' --required
AND serviceName = '{{ serviceName }}' --required
AND workspaceId = '{{ workspaceId }}' --required
AND apiId = '{{ apiId }}' --required
AND releaseId = '{{ releaseId }}' --required
AND If-Match = '{{ If-Match }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
RETURNING
properties;

DELETE examples

delete

Deletes the specified release in the API.

DELETE FROM azure.api_management.workspace_api_releases
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND serviceName = '{{ serviceName }}' --required
AND workspaceId = '{{ workspaceId }}' --required
AND apiId = '{{ apiId }}' --required
AND releaseId = '{{ releaseId }}' --required
AND If-Match = '{{ If-Match }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;