workspaces

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

Overview

Name	workspaces
Type	Resource
Id	azure.api_center.workspaces

Fields

vw_workspaces

Name	Datatype	Description
description	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
title	text	field from the properties object
workspaceName	text	field from the properties object

workspaces

Name	Datatype	Description
properties	object	Workspace properties.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	resourceGroupName, serviceName, subscriptionId, workspaceName	Returns details of the workspace.
list	SELECT	resourceGroupName, serviceName, subscriptionId	Returns a collection of workspaces.
create_or_update	INSERT	resourceGroupName, serviceName, subscriptionId, workspaceName	Creates new or updates existing workspace.
delete	DELETE	resourceGroupName, serviceName, subscriptionId, workspaceName	Deletes specified workspace.

SELECT examples

Returns a collection of workspaces.

vw_workspaces

SELECT
description,
resourceGroupName,
serviceName,
subscriptionId,
title,
workspaceName
FROM azure.api_center.vw_workspaces
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND serviceName = '{{ serviceName }}'
AND subscriptionId = '{{ subscriptionId }}';

workspaces

SELECT
properties
FROM azure.api_center.workspaces
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND serviceName = '{{ serviceName }}'
AND subscriptionId = '{{ subscriptionId }}';

INSERT example

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

All Properties

/*+ create */
INSERT INTO azure.api_center.workspaces (
resourceGroupName,
serviceName,
subscriptionId,
workspaceName,
properties
)
SELECT 
'{{ resourceGroupName }}',
'{{ serviceName }}',
'{{ subscriptionId }}',
'{{ workspaceName }}',
'{{ properties }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: title
          value: string
        - name: description
          value: string

DELETE example

Deletes the specified workspaces resource.

/*+ delete */
DELETE FROM azure.api_center.workspaces
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND serviceName = '{{ serviceName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND workspaceName = '{{ workspaceName }}';