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

vw_workspace_api_releases

Name	Datatype	Description
apiId	text	field from the properties object
api_id	text	field from the properties object
created_date_time	text	field from the properties object
notes	text	field from the properties object
releaseId	text	field from the properties object
resourceGroupName	text	field from the properties object
serviceName	text	field from the properties object
subscriptionId	text	field from the properties object
updated_date_time	text	field from the properties object
workspaceId	text	field from the properties object

workspace_api_releases

Name	Datatype	Description
properties	object	API Release details

Methods

Name	Accessible by	Required Params	Description
get	SELECT	apiId, releaseId, resourceGroupName, serviceName, subscriptionId, workspaceId	Returns the details of an API release.
list_by_service	SELECT	apiId, resourceGroupName, serviceName, subscriptionId, workspaceId	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	apiId, releaseId, resourceGroupName, serviceName, subscriptionId, workspaceId	Creates a new Release for the API.
delete	DELETE	If-Match, apiId, releaseId, resourceGroupName, serviceName, subscriptionId, workspaceId	Deletes the specified release in the API.
update	UPDATE	If-Match, apiId, releaseId, resourceGroupName, serviceName, subscriptionId, workspaceId	Updates the details of the release of the API specified by its identifier.

SELECT examples

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.

vw_workspace_api_releases

SELECT
apiId,
api_id,
created_date_time,
notes,
releaseId,
resourceGroupName,
serviceName,
subscriptionId,
updated_date_time,
workspaceId
FROM azure.api_management.vw_workspace_api_releases
WHERE apiId = '{{ apiId }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND serviceName = '{{ serviceName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND workspaceId = '{{ workspaceId }}';

workspace_api_releases

SELECT
properties
FROM azure.api_management.workspace_api_releases
WHERE apiId = '{{ apiId }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND serviceName = '{{ serviceName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND workspaceId = '{{ workspaceId }}';

INSERT example

Use the following StackQL query and manifest file to create a new workspace_api_releases resource.

All Properties

/*+ create */
INSERT INTO azure.api_management.workspace_api_releases (
apiId,
releaseId,
resourceGroupName,
serviceName,
subscriptionId,
workspaceId,
properties
)
SELECT 
'{{ apiId }}',
'{{ releaseId }}',
'{{ resourceGroupName }}',
'{{ serviceName }}',
'{{ subscriptionId }}',
'{{ workspaceId }}',
'{{ properties }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: apiId
          value: string
        - name: createdDateTime
          value: string
        - name: updatedDateTime
          value: string
        - name: notes
          value: string

UPDATE example

Updates a workspace_api_releases resource.

/*+ update */
UPDATE azure.api_management.workspace_api_releases
SET 
properties = '{{ properties }}'
WHERE 
If-Match = '{{ If-Match }}'
AND apiId = '{{ apiId }}'
AND releaseId = '{{ releaseId }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND serviceName = '{{ serviceName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND workspaceId = '{{ workspaceId }}';

DELETE example

Deletes the specified workspace_api_releases resource.

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