environments

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

Overview

Name	environments
Type	Resource
Id	azure.api_center.environments

Fields

vw_environments

Name	Datatype	Description
description	text	field from the properties object
custom_properties	text	field from the properties object
environmentName	text	field from the properties object
kind	text	field from the properties object
onboarding	text	field from the properties object
resourceGroupName	text	field from the properties object
server	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

environments

Name	Datatype	Description
properties	object	Environment properties entity.

Methods

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

SELECT examples

Returns a collection of environments.

vw_environments

SELECT
description,
custom_properties,
environmentName,
kind,
onboarding,
resourceGroupName,
server,
serviceName,
subscriptionId,
title,
workspaceName
FROM azure.api_center.vw_environments
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND serviceName = '{{ serviceName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND workspaceName = '{{ workspaceName }}';

environments

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

INSERT example

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

All Properties

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

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: title
          value: string
        - name: description
          value: string
        - name: kind
          value: []
        - name: server
          value:
            - name: type
              value: []
            - name: managementPortalUri
              value:
                - string
        - name: onboarding
          value:
            - name: instructions
              value: string
            - name: developerPortalUri
              value:
                - string
        - name: customProperties
          value: []

DELETE example

Deletes the specified environments resource.

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