managed_environments

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

Overview

Name	managed_environments
Type	Resource
Id	azure.app_containers.managed_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.
appLogsConfiguration	object	Cluster configuration which enables the log daemon to export app logs to configured destination.
customDomainConfiguration	object	Custom domain configuration for the environment.
daprAIConnectionString	string	Application Insights connection string used by Dapr to export Service to Service communication telemetry.
daprAIInstrumentationKey	string	Azure Monitor instrumentation key used by Dapr to export Service to Service communication telemetry.
daprConfiguration	object	The configuration of Dapr component.
defaultDomain	string	Default Domain Name for the cluster.
deploymentErrors	string	Any errors that occurred during deployment or deployment validation.
eventStreamEndpoint	string	The endpoint of the eventstream of the Environment.
identity	object	The managed service identities assigned to this resource.
infrastructureResourceGroup	string	Name of the platform-managed resource group created for the Managed Environment to host infrastructure resources. If a subnet ID is provided, this resource group will be created in the same subscription as the subnet.
ingressConfiguration	object	Ingress configuration for the Managed Environment.
kedaConfiguration	object	The configuration of Keda component.
kind	string	Kind of the Environment.
location	string	The geo-location where the resource lives. Required.
peerAuthentication	object	Peer authentication settings for the Managed Environment.
peerTrafficConfiguration	object	Peer traffic settings for the Managed Environment.
privateEndpointConnections	array	Private endpoint connections to the resource.
provisioningState	string	Provisioning state of the Environment. Known values are: "Succeeded", "Failed", "Canceled", "Waiting", "InitializationInProgress", "InfrastructureSetupInProgress", "InfrastructureSetupComplete", "ScheduledForDelete", "UpgradeRequested", and "UpgradeFailed". (Succeeded, Failed, Canceled, Waiting, InitializationInProgress, InfrastructureSetupInProgress, InfrastructureSetupComplete, ScheduledForDelete, UpgradeRequested, UpgradeFailed)
publicNetworkAccess	string	Property to allow or block all public traffic. Allowed Values: 'Enabled', 'Disabled'. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
staticIp	string	Static IP of the Environment.
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".
vnetConfiguration	object	Vnet configuration for the environment.
workloadProfiles	array	Workload profiles configured for the Managed Environment.
zoneRedundant	boolean	Whether or not this Managed Environment is zone-redundant.

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.
appLogsConfiguration	object	Cluster configuration which enables the log daemon to export app logs to configured destination.
customDomainConfiguration	object	Custom domain configuration for the environment.
daprAIConnectionString	string	Application Insights connection string used by Dapr to export Service to Service communication telemetry.
daprAIInstrumentationKey	string	Azure Monitor instrumentation key used by Dapr to export Service to Service communication telemetry.
daprConfiguration	object	The configuration of Dapr component.
defaultDomain	string	Default Domain Name for the cluster.
deploymentErrors	string	Any errors that occurred during deployment or deployment validation.
eventStreamEndpoint	string	The endpoint of the eventstream of the Environment.
identity	object	The managed service identities assigned to this resource.
infrastructureResourceGroup	string	Name of the platform-managed resource group created for the Managed Environment to host infrastructure resources. If a subnet ID is provided, this resource group will be created in the same subscription as the subnet.
ingressConfiguration	object	Ingress configuration for the Managed Environment.
kedaConfiguration	object	The configuration of Keda component.
kind	string	Kind of the Environment.
location	string	The geo-location where the resource lives. Required.
peerAuthentication	object	Peer authentication settings for the Managed Environment.
peerTrafficConfiguration	object	Peer traffic settings for the Managed Environment.
privateEndpointConnections	array	Private endpoint connections to the resource.
provisioningState	string	Provisioning state of the Environment. Known values are: "Succeeded", "Failed", "Canceled", "Waiting", "InitializationInProgress", "InfrastructureSetupInProgress", "InfrastructureSetupComplete", "ScheduledForDelete", "UpgradeRequested", and "UpgradeFailed". (Succeeded, Failed, Canceled, Waiting, InitializationInProgress, InfrastructureSetupInProgress, InfrastructureSetupComplete, ScheduledForDelete, UpgradeRequested, UpgradeFailed)
publicNetworkAccess	string	Property to allow or block all public traffic. Allowed Values: 'Enabled', 'Disabled'. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
staticIp	string	Static IP of the Environment.
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".
vnetConfiguration	object	Vnet configuration for the environment.
workloadProfiles	array	Workload profiles configured for the Managed Environment.
zoneRedundant	boolean	Whether or not this Managed Environment is zone-redundant.

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.
appLogsConfiguration	object	Cluster configuration which enables the log daemon to export app logs to configured destination.
customDomainConfiguration	object	Custom domain configuration for the environment.
daprAIConnectionString	string	Application Insights connection string used by Dapr to export Service to Service communication telemetry.
daprAIInstrumentationKey	string	Azure Monitor instrumentation key used by Dapr to export Service to Service communication telemetry.
daprConfiguration	object	The configuration of Dapr component.
defaultDomain	string	Default Domain Name for the cluster.
deploymentErrors	string	Any errors that occurred during deployment or deployment validation.
eventStreamEndpoint	string	The endpoint of the eventstream of the Environment.
identity	object	The managed service identities assigned to this resource.
infrastructureResourceGroup	string	Name of the platform-managed resource group created for the Managed Environment to host infrastructure resources. If a subnet ID is provided, this resource group will be created in the same subscription as the subnet.
ingressConfiguration	object	Ingress configuration for the Managed Environment.
kedaConfiguration	object	The configuration of Keda component.
kind	string	Kind of the Environment.
location	string	The geo-location where the resource lives. Required.
peerAuthentication	object	Peer authentication settings for the Managed Environment.
peerTrafficConfiguration	object	Peer traffic settings for the Managed Environment.
privateEndpointConnections	array	Private endpoint connections to the resource.
provisioningState	string	Provisioning state of the Environment. Known values are: "Succeeded", "Failed", "Canceled", "Waiting", "InitializationInProgress", "InfrastructureSetupInProgress", "InfrastructureSetupComplete", "ScheduledForDelete", "UpgradeRequested", and "UpgradeFailed". (Succeeded, Failed, Canceled, Waiting, InitializationInProgress, InfrastructureSetupInProgress, InfrastructureSetupComplete, ScheduledForDelete, UpgradeRequested, UpgradeFailed)
publicNetworkAccess	string	Property to allow or block all public traffic. Allowed Values: 'Enabled', 'Disabled'. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
staticIp	string	Static IP of the Environment.
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".
vnetConfiguration	object	Vnet configuration for the environment.
workloadProfiles	array	Workload profiles configured for the Managed Environment.
zoneRedundant	boolean	Whether or not this Managed Environment is zone-redundant.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, environment_name, subscription_id		Get the properties of a Managed Environment. Get the properties of a Managed Environment used to host container apps.
list_by_resource_group	select	resource_group_name, subscription_id		Get all the Environments in a resource group. Get all the Managed Environments in a resource group.
list_by_subscription	select	subscription_id		Get all Environments for a subscription. Get all Managed Environments for a subscription.
create_or_update	insert	resource_group_name, environment_name, subscription_id, location		Creates or updates a Managed Environment. Creates or updates a Managed Environment used to host container apps.
update	update	resource_group_name, environment_name, subscription_id, location		Update Managed Environment's properties. Patches a Managed Environment using JSON Merge Patch.
create_or_update	replace	resource_group_name, environment_name, subscription_id, location		Creates or updates a Managed Environment. Creates or updates a Managed Environment used to host container apps.
delete	delete	resource_group_name, environment_name, subscription_id		Delete a Managed Environment. Delete a Managed Environment if it does not have any container apps.
list_workload_profile_states	exec	resource_group_name, environment_name, subscription_id		Get all workload Profile States for a Managed Environment.. Get all workload Profile States for a Managed Environment.
get_auth_token	exec	resource_group_name, environment_name, subscription_id		Get auth token for a managed environment. Checks if resource name 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
environment_name	string	Name of the Environment. 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 a Managed Environment. Get the properties of a Managed Environment used to host container apps.

SELECT
id,
name,
appLogsConfiguration,
customDomainConfiguration,
daprAIConnectionString,
daprAIInstrumentationKey,
daprConfiguration,
defaultDomain,
deploymentErrors,
eventStreamEndpoint,
identity,
infrastructureResourceGroup,
ingressConfiguration,
kedaConfiguration,
kind,
location,
peerAuthentication,
peerTrafficConfiguration,
privateEndpointConnections,
provisioningState,
publicNetworkAccess,
staticIp,
systemData,
tags,
type,
vnetConfiguration,
workloadProfiles,
zoneRedundant
FROM azure.app_containers.managed_environments
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND environment_name = '{{ environment_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

Get all the Environments in a resource group. Get all the Managed Environments in a resource group.

SELECT
id,
name,
appLogsConfiguration,
customDomainConfiguration,
daprAIConnectionString,
daprAIInstrumentationKey,
daprConfiguration,
defaultDomain,
deploymentErrors,
eventStreamEndpoint,
identity,
infrastructureResourceGroup,
ingressConfiguration,
kedaConfiguration,
kind,
location,
peerAuthentication,
peerTrafficConfiguration,
privateEndpointConnections,
provisioningState,
publicNetworkAccess,
staticIp,
systemData,
tags,
type,
vnetConfiguration,
workloadProfiles,
zoneRedundant
FROM azure.app_containers.managed_environments
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

Get all Environments for a subscription. Get all Managed Environments for a subscription.

SELECT
id,
name,
appLogsConfiguration,
customDomainConfiguration,
daprAIConnectionString,
daprAIInstrumentationKey,
daprConfiguration,
defaultDomain,
deploymentErrors,
eventStreamEndpoint,
identity,
infrastructureResourceGroup,
ingressConfiguration,
kedaConfiguration,
kind,
location,
peerAuthentication,
peerTrafficConfiguration,
privateEndpointConnections,
provisioningState,
publicNetworkAccess,
staticIp,
systemData,
tags,
type,
vnetConfiguration,
workloadProfiles,
zoneRedundant
FROM azure.app_containers.managed_environments
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates or updates a Managed Environment. Creates or updates a Managed Environment used to host container apps.

INSERT INTO azure.app_containers.managed_environments (
tags,
location,
properties,
kind,
identity,
resource_group_name,
environment_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ kind }}',
'{{ identity }}',
'{{ resource_group_name }}',
'{{ environment_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
identity,
kind,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: managed_environments
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the managed_environments resource.
  - name: environment_name
    value: "{{ environment_name }}"
    description: Required parameter for the managed_environments resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the managed_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: |
      Managed environment resource specific properties.
    value:
      provisioningState: "{{ provisioningState }}"
      daprAIInstrumentationKey: "{{ daprAIInstrumentationKey }}"
      daprAIConnectionString: "{{ daprAIConnectionString }}"
      vnetConfiguration:
        internal: {{ internal }}
        infrastructureSubnetId: "{{ infrastructureSubnetId }}"
        dockerBridgeCidr: "{{ dockerBridgeCidr }}"
        platformReservedCidr: "{{ platformReservedCidr }}"
        platformReservedDnsIP: "{{ platformReservedDnsIP }}"
      deploymentErrors: "{{ deploymentErrors }}"
      defaultDomain: "{{ defaultDomain }}"
      staticIp: "{{ staticIp }}"
      appLogsConfiguration:
        destination: "{{ destination }}"
        logAnalyticsConfiguration:
          customerId: "{{ customerId }}"
          sharedKey: "{{ sharedKey }}"
      zoneRedundant: {{ zoneRedundant }}
      customDomainConfiguration:
        customDomainVerificationId: "{{ customDomainVerificationId }}"
        dnsSuffix: "{{ dnsSuffix }}"
        certificateKeyVaultProperties:
          identity: "{{ identity }}"
          keyVaultUrl: "{{ keyVaultUrl }}"
        certificateValue: "{{ certificateValue }}"
        certificatePassword: "{{ certificatePassword }}"
        expirationDate: "{{ expirationDate }}"
        thumbprint: "{{ thumbprint }}"
        subjectName: "{{ subjectName }}"
      eventStreamEndpoint: "{{ eventStreamEndpoint }}"
      workloadProfiles:
        - name: "{{ name }}"
          workloadProfileType: "{{ workloadProfileType }}"
          minimumCount: {{ minimumCount }}
          maximumCount: {{ maximumCount }}
      kedaConfiguration:
        version: "{{ version }}"
      daprConfiguration:
        version: "{{ version }}"
      infrastructureResourceGroup: "{{ infrastructureResourceGroup }}"
      peerAuthentication:
        mtls:
          enabled: {{ enabled }}
      peerTrafficConfiguration:
        encryption:
          enabled: {{ enabled }}
      ingressConfiguration:
        workloadProfileName: "{{ workloadProfileName }}"
        terminationGracePeriodSeconds: {{ terminationGracePeriodSeconds }}
        headerCountLimit: {{ headerCountLimit }}
        requestIdleTimeout: {{ requestIdleTimeout }}
      privateEndpointConnections:
        - id: "{{ id }}"
          name: "{{ name }}"
          type: "{{ type }}"
          systemData:
            createdBy: "{{ createdBy }}"
            createdByType: "{{ createdByType }}"
            createdAt: "{{ createdAt }}"
            lastModifiedBy: "{{ lastModifiedBy }}"
            lastModifiedByType: "{{ lastModifiedByType }}"
            lastModifiedAt: "{{ lastModifiedAt }}"
          properties:
            groupIds:
              - "{{ groupIds }}"
            privateEndpoint:
              id: "{{ id }}"
            privateLinkServiceConnectionState:
              status: "{{ status }}"
              description: "{{ description }}"
              actionsRequired: "{{ actionsRequired }}"
            provisioningState: "{{ provisioningState }}"
      publicNetworkAccess: "{{ publicNetworkAccess }}"
  - name: kind
    value: "{{ kind }}"
    description: |
      Kind of the Environment.
  - name: identity
    description: |
      The managed service identities assigned to this resource.
    value:
      principalId: "{{ principalId }}"
      tenantId: "{{ tenantId }}"
      type: "{{ type }}"
      userAssignedIdentities: "{{ userAssignedIdentities }}"

UPDATE examples

update

Update Managed Environment's properties. Patches a Managed Environment using JSON Merge Patch.

UPDATE azure.app_containers.managed_environments
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}',
kind = '{{ kind }}',
identity = '{{ identity }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND environment_name = '{{ environment_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
identity,
kind,
location,
properties,
systemData,
tags,
type;

REPLACE examples

create_or_update

Creates or updates a Managed Environment. Creates or updates a Managed Environment used to host container apps.

REPLACE azure.app_containers.managed_environments
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}',
kind = '{{ kind }}',
identity = '{{ identity }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND environment_name = '{{ environment_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
identity,
kind,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Delete a Managed Environment. Delete a Managed Environment if it does not have any container apps.

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

Lifecycle Methods

list_workload_profile_states

Get all workload Profile States for a Managed Environment.. Get all workload Profile States for a Managed Environment.

EXEC azure.app_containers.managed_environments.list_workload_profile_states 
@resource_group_name='{{ resource_group_name }}' --required, 
@environment_name='{{ environment_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

get_auth_token

Get auth token for a managed environment. Checks if resource name is available.

EXEC azure.app_containers.managed_environments.get_auth_token 
@resource_group_name='{{ resource_group_name }}' --required, 
@environment_name='{{ environment_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;