connected_environments

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

Overview

Name	connected_environments
Type	Resource
Id	azure.container_apps.connected_environments

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
extendedLocation	object	The complex type of the extended location.
location	string	The geo-location where the resource lives
properties	object	ConnectedEnvironment resource specific properties
tags	object	Resource tags.

list_by_resource_group

Name	Datatype	Description
extendedLocation	object	The complex type of the extended location.
location	string	The geo-location where the resource lives
properties	object	ConnectedEnvironment resource specific properties
tags	object	Resource tags.

list_by_subscription

Name	Datatype	Description
extendedLocation	object	The complex type of the extended location.
location	string	The geo-location where the resource lives
properties	object	ConnectedEnvironment resource specific properties
tags	object	Resource tags.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, connectedEnvironmentName		Get the properties of an connectedEnvironment.
list_by_resource_group	select	subscriptionId, resourceGroupName		Get all connectedEnvironments in a resource group.
list_by_subscription	select	subscriptionId		Get all connectedEnvironments for a subscription.
create_or_update	insert	subscriptionId, resourceGroupName, connectedEnvironmentName		Creates or updates an connectedEnvironment.
update	update	subscriptionId, resourceGroupName, connectedEnvironmentName		Patches a Managed Environment. Only patching of tags is supported currently
delete	delete	subscriptionId, resourceGroupName, connectedEnvironmentName		Delete an connectedEnvironment.
check_name_availability	exec	subscriptionId, resourceGroupName, connectedEnvironmentName		Checks if resource connectedEnvironmentName is available.

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
connectedEnvironmentName	string	Name of the Managed Environment.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.

SELECT examples

get

Get the properties of an connectedEnvironment.

SELECT
extendedLocation,
location,
properties,
tags
FROM azure.container_apps.connected_environments
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND connectedEnvironmentName = '{{ connectedEnvironmentName }}' -- required
;

list_by_resource_group

Get all connectedEnvironments in a resource group.

SELECT
extendedLocation,
location,
properties,
tags
FROM azure.container_apps.connected_environments
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
;

list_by_subscription

Get all connectedEnvironments for a subscription.

SELECT
extendedLocation,
location,
properties,
tags
FROM azure.container_apps.connected_environments
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Creates or updates an connectedEnvironment.

INSERT INTO azure.container_apps.connected_environments (
data__tags,
data__location,
data__extendedLocation,
data__properties,
subscriptionId,
resourceGroupName,
connectedEnvironmentName
)
SELECT 
'{{ tags }}',
'{{ location }}',
'{{ extendedLocation }}',
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ connectedEnvironmentName }}'
RETURNING
extendedLocation,
location,
properties,
tags
;

Manifest

# Description fields are for documentation purposes
- name: connected_environments
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the connected_environments resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the connected_environments resource.
    - name: connectedEnvironmentName
      value: string
      description: Required parameter for the connected_environments resource.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives
    - name: extendedLocation
      value: object
      description: |
        The complex type of the extended location.
    - name: properties
      value: object
      description: |
        ConnectedEnvironment resource specific properties

UPDATE examples

update

Patches a Managed Environment. Only patching of tags is supported currently

UPDATE azure.container_apps.connected_environments
SET 
-- No updatable properties
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND connectedEnvironmentName = '{{ connectedEnvironmentName }}' --required
RETURNING
extendedLocation,
location,
properties,
tags;

DELETE examples

delete

Delete an connectedEnvironment.

DELETE FROM azure.container_apps.connected_environments
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND connectedEnvironmentName = '{{ connectedEnvironmentName }}' --required
;

Lifecycle Methods

check_name_availability

Checks if resource connectedEnvironmentName is available.

EXEC azure.container_apps.connected_environments.check_name_availability 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@connectedEnvironmentName='{{ connectedEnvironmentName }}' --required 
@@json=
'{
"name": "{{ name }}", 
"type": "{{ type }}"
}'
;