environments

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

Overview

Name	environments
Type	Resource
Id	azure.api_center.environments

Fields

The following fields are returned by SELECT queries:

get

Azure operation completed successfully.

Name	Datatype	Description
properties	object	The resource-specific properties for this resource.

list

Azure operation completed successfully.

Name	Datatype	Description
properties	object	The resource-specific properties for this resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, serviceName, workspaceName, environmentName		Returns details of the environment.
list	select	subscriptionId, resourceGroupName, serviceName, workspaceName	$filter	Returns a collection of environments.
create_or_update	insert	subscriptionId, resourceGroupName, serviceName, workspaceName, environmentName		Creates new or updates existing environment.
delete	delete	subscriptionId, resourceGroupName, serviceName, workspaceName, environmentName		Deletes the environment.

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
environmentName	string	The name of the environment.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
serviceName	string	The name of Azure API Center service.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.
workspaceName	string	The name of the workspace.
$filter	string	OData filter parameter.

SELECT examples

get

Returns details of the environment.

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

list

Returns a collection of environments.

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

INSERT examples

create_or_update

Creates new or updates existing environment.

INSERT INTO azure.api_center.environments (
data__properties,
subscriptionId,
resourceGroupName,
serviceName,
workspaceName,
environmentName
)
SELECT 
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ serviceName }}',
'{{ workspaceName }}',
'{{ environmentName }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: environments
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the environments resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the environments resource.
    - name: serviceName
      value: string
      description: Required parameter for the environments resource.
    - name: workspaceName
      value: string
      description: Required parameter for the environments resource.
    - name: environmentName
      value: string
      description: Required parameter for the environments resource.
    - name: properties
      value: object
      description: |
        The resource-specific properties for this resource.

DELETE examples

delete

Deletes the environment.

DELETE FROM azure.api_center.environments
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND serviceName = '{{ serviceName }}' --required
AND workspaceName = '{{ workspaceName }}' --required
AND environmentName = '{{ environmentName }}' --required
;