connected_environments

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

Overview

Name	connected_environments
Type	Resource
Id	azure.app_containers.connected_environments

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
customDomainConfiguration	object	Custom domain configuration for the environment.
daprAIConnectionString	string	Application Insights connection string used by Dapr to export Service to Service communication telemetry.
defaultDomain	string	Default Domain Name for the cluster.
deploymentErrors	string	Any errors that occurred during deployment or deployment validation.
extendedLocation	object	The complex type of the extended location.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	Provisioning state of the Kubernetes Environment. Known values are: "Succeeded", "Failed", "Canceled", "Waiting", "InitializationInProgress", "InfrastructureSetupInProgress", "InfrastructureSetupComplete", and "ScheduledForDelete". (Succeeded, Failed, Canceled, Waiting, InitializationInProgress, InfrastructureSetupInProgress, InfrastructureSetupComplete, ScheduledForDelete)
staticIp	string	Static IP of the connectedEnvironment.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_resource_group

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
customDomainConfiguration	object	Custom domain configuration for the environment.
daprAIConnectionString	string	Application Insights connection string used by Dapr to export Service to Service communication telemetry.
defaultDomain	string	Default Domain Name for the cluster.
deploymentErrors	string	Any errors that occurred during deployment or deployment validation.
extendedLocation	object	The complex type of the extended location.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	Provisioning state of the Kubernetes Environment. Known values are: "Succeeded", "Failed", "Canceled", "Waiting", "InitializationInProgress", "InfrastructureSetupInProgress", "InfrastructureSetupComplete", and "ScheduledForDelete". (Succeeded, Failed, Canceled, Waiting, InitializationInProgress, InfrastructureSetupInProgress, InfrastructureSetupComplete, ScheduledForDelete)
staticIp	string	Static IP of the connectedEnvironment.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_subscription

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
customDomainConfiguration	object	Custom domain configuration for the environment.
daprAIConnectionString	string	Application Insights connection string used by Dapr to export Service to Service communication telemetry.
defaultDomain	string	Default Domain Name for the cluster.
deploymentErrors	string	Any errors that occurred during deployment or deployment validation.
extendedLocation	object	The complex type of the extended location.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	Provisioning state of the Kubernetes Environment. Known values are: "Succeeded", "Failed", "Canceled", "Waiting", "InitializationInProgress", "InfrastructureSetupInProgress", "InfrastructureSetupComplete", and "ScheduledForDelete". (Succeeded, Failed, Canceled, Waiting, InitializationInProgress, InfrastructureSetupInProgress, InfrastructureSetupComplete, ScheduledForDelete)
staticIp	string	Static IP of the connectedEnvironment.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, connected_environment_name, subscription_id		Get the properties of an connectedEnvironment.
list_by_resource_group	select	resource_group_name, subscription_id		Get all connectedEnvironments in a resource group.
list_by_subscription	select	subscription_id		Get all connectedEnvironments for a subscription. Get all connectedEnvironments for a subscription.
create_or_update	insert	resource_group_name, connected_environment_name, subscription_id, location		Creates or updates an connectedEnvironment.
update	update	resource_group_name, connected_environment_name, subscription_id		Update connected Environment's properties. Patches a Managed Environment. Only patching of tags is supported currently.
create_or_update	replace	resource_group_name, connected_environment_name, subscription_id, location		Creates or updates an connectedEnvironment.
delete	delete	resource_group_name, connected_environment_name, subscription_id		Delete an connectedEnvironment. Delete an connectedEnvironment.
check_name_availability	exec	resource_group_name, connected_environment_name, subscription_id		Checks the resource connectedEnvironmentName availability. 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
connected_environment_name	string	Name of the connectedEnvironment. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Get the properties of an connectedEnvironment.

SELECT
id,
name,
customDomainConfiguration,
daprAIConnectionString,
defaultDomain,
deploymentErrors,
extendedLocation,
location,
provisioningState,
staticIp,
systemData,
tags,
type
FROM azure.app_containers.connected_environments
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND connected_environment_name = '{{ connected_environment_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

Get all connectedEnvironments in a resource group.

SELECT
id,
name,
customDomainConfiguration,
daprAIConnectionString,
defaultDomain,
deploymentErrors,
extendedLocation,
location,
provisioningState,
staticIp,
systemData,
tags,
type
FROM azure.app_containers.connected_environments
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

Get all connectedEnvironments for a subscription. Get all connectedEnvironments for a subscription.

SELECT
id,
name,
customDomainConfiguration,
daprAIConnectionString,
defaultDomain,
deploymentErrors,
extendedLocation,
location,
provisioningState,
staticIp,
systemData,
tags,
type
FROM azure.app_containers.connected_environments
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates or updates an connectedEnvironment.

INSERT INTO azure.app_containers.connected_environments (
tags,
location,
properties,
extendedLocation,
resource_group_name,
connected_environment_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ extendedLocation }}',
'{{ resource_group_name }}',
'{{ connected_environment_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
extendedLocation,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: connected_environments
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the connected_environments resource.
  - name: connected_environment_name
    value: "{{ connected_environment_name }}"
    description: Required parameter for the connected_environments resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the connected_environments resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      ConnectedEnvironment resource specific properties.
    value:
      provisioningState: "{{ provisioningState }}"
      deploymentErrors: "{{ deploymentErrors }}"
      defaultDomain: "{{ defaultDomain }}"
      staticIp: "{{ staticIp }}"
      daprAIConnectionString: "{{ daprAIConnectionString }}"
      customDomainConfiguration:
        customDomainVerificationId: "{{ customDomainVerificationId }}"
        dnsSuffix: "{{ dnsSuffix }}"
        certificateKeyVaultProperties:
          identity: "{{ identity }}"
          keyVaultUrl: "{{ keyVaultUrl }}"
        certificateValue: "{{ certificateValue }}"
        certificatePassword: "{{ certificatePassword }}"
        expirationDate: "{{ expirationDate }}"
        thumbprint: "{{ thumbprint }}"
        subjectName: "{{ subjectName }}"
  - name: extendedLocation
    description: |
      The complex type of the extended location.
    value:
      name: "{{ name }}"
      type: "{{ type }}"

UPDATE examples

update

Update connected Environment's properties. Patches a Managed Environment. Only patching of tags is supported currently.

UPDATE azure.app_containers.connected_environments
SET 
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND connected_environment_name = '{{ connected_environment_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
extendedLocation,
location,
properties,
systemData,
tags,
type;

REPLACE examples

create_or_update

Creates or updates an connectedEnvironment.

REPLACE azure.app_containers.connected_environments
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}',
extendedLocation = '{{ extendedLocation }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND connected_environment_name = '{{ connected_environment_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
extendedLocation,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Delete an connectedEnvironment. Delete an connectedEnvironment.

DELETE FROM azure.app_containers.connected_environments
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND connected_environment_name = '{{ connected_environment_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

check_name_availability

Checks the resource connectedEnvironmentName availability. Checks if resource connectedEnvironmentName is available.

EXEC azure.app_containers.connected_environments.check_name_availability 
@resource_group_name='{{ resource_group_name }}' --required, 
@connected_environment_name='{{ connected_environment_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"name": "{{ name }}", 
"type": "{{ type }}"
}'
;