kube_environments

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

Overview

Name	kube_environments
Type	Resource
Id	azure.web.kube_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.
aksResourceID	string	:vartype aks_resource_id: str
appLogsConfiguration	object	Cluster configuration which enables the log daemon to export app logs to a destination. Currently only "log-analytics" is supported.
arcConfiguration	object	Cluster configuration which determines the ARC cluster components types. Eg: Choosing between BuildService kind, FrontEnd Service ArtifactsStorageType etc.
containerAppsConfiguration	object	Cluster configuration for Container Apps Environments to configure Dapr Instrumentation Key and VNET Configuration.
defaultDomain	string	Default Domain Name for the cluster.
deploymentErrors	string	Any errors that occurred during deployment or deployment validation.
environmentType	string	Type of Kubernetes Environment. Only supported for Container App Environments with value as Managed.
extendedLocation	object	Extended Location.
internalLoadBalancerEnabled	boolean	Only visible within Vnet/Subnet.
kind	string	Kind of resource.
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", "ScheduledForDelete", "UpgradeRequested", and "UpgradeFailed". (Succeeded, Failed, Canceled, Waiting, InitializationInProgress, InfrastructureSetupInProgress, InfrastructureSetupComplete, ScheduledForDelete, UpgradeRequested, UpgradeFailed)
staticIp	string	Static IP of the KubeEnvironment.
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.
aksResourceID	string	:vartype aks_resource_id: str
appLogsConfiguration	object	Cluster configuration which enables the log daemon to export app logs to a destination. Currently only "log-analytics" is supported.
arcConfiguration	object	Cluster configuration which determines the ARC cluster components types. Eg: Choosing between BuildService kind, FrontEnd Service ArtifactsStorageType etc.
containerAppsConfiguration	object	Cluster configuration for Container Apps Environments to configure Dapr Instrumentation Key and VNET Configuration.
defaultDomain	string	Default Domain Name for the cluster.
deploymentErrors	string	Any errors that occurred during deployment or deployment validation.
environmentType	string	Type of Kubernetes Environment. Only supported for Container App Environments with value as Managed.
extendedLocation	object	Extended Location.
internalLoadBalancerEnabled	boolean	Only visible within Vnet/Subnet.
kind	string	Kind of resource.
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", "ScheduledForDelete", "UpgradeRequested", and "UpgradeFailed". (Succeeded, Failed, Canceled, Waiting, InitializationInProgress, InfrastructureSetupInProgress, InfrastructureSetupComplete, ScheduledForDelete, UpgradeRequested, UpgradeFailed)
staticIp	string	Static IP of the KubeEnvironment.
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.
aksResourceID	string	:vartype aks_resource_id: str
appLogsConfiguration	object	Cluster configuration which enables the log daemon to export app logs to a destination. Currently only "log-analytics" is supported.
arcConfiguration	object	Cluster configuration which determines the ARC cluster components types. Eg: Choosing between BuildService kind, FrontEnd Service ArtifactsStorageType etc.
containerAppsConfiguration	object	Cluster configuration for Container Apps Environments to configure Dapr Instrumentation Key and VNET Configuration.
defaultDomain	string	Default Domain Name for the cluster.
deploymentErrors	string	Any errors that occurred during deployment or deployment validation.
environmentType	string	Type of Kubernetes Environment. Only supported for Container App Environments with value as Managed.
extendedLocation	object	Extended Location.
internalLoadBalancerEnabled	boolean	Only visible within Vnet/Subnet.
kind	string	Kind of resource.
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", "ScheduledForDelete", "UpgradeRequested", and "UpgradeFailed". (Succeeded, Failed, Canceled, Waiting, InitializationInProgress, InfrastructureSetupInProgress, InfrastructureSetupComplete, ScheduledForDelete, UpgradeRequested, UpgradeFailed)
staticIp	string	Static IP of the KubeEnvironment.
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, name, subscription_id		Get the properties of a Kubernetes Environment. Description for Get the properties of a Kubernetes Environment.
list_by_resource_group	select	resource_group_name, subscription_id		Get all the Kubernetes Environments in a resource group. Description for Get all the Kubernetes Environments in a resource group.
list_by_subscription	select	subscription_id		Get all Kubernetes Environments for a subscription. Description for Get all Kubernetes Environments for a subscription.
create_or_update	insert	resource_group_name, name, subscription_id, location		Creates or updates a Kubernetes Environment. Description for Creates or updates a Kubernetes Environment.
update	update	resource_group_name, name, subscription_id		Creates or updates a Kubernetes Environment. Description for Creates or updates a Kubernetes Environment.
create_or_update	replace	resource_group_name, name, subscription_id, location		Creates or updates a Kubernetes Environment. Description for Creates or updates a Kubernetes Environment.
delete	delete	resource_group_name, name, subscription_id		Delete a Kubernetes Environment. Description for Delete a Kubernetes 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
name	string	Name of the Kubernetes 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 Kubernetes Environment. Description for Get the properties of a Kubernetes Environment.

SELECT
id,
name,
aksResourceID,
appLogsConfiguration,
arcConfiguration,
containerAppsConfiguration,
defaultDomain,
deploymentErrors,
environmentType,
extendedLocation,
internalLoadBalancerEnabled,
kind,
location,
provisioningState,
staticIp,
systemData,
tags,
type
FROM azure.web.kube_environments
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND name = '{{ name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

Get all the Kubernetes Environments in a resource group. Description for Get all the Kubernetes Environments in a resource group.

SELECT
id,
name,
aksResourceID,
appLogsConfiguration,
arcConfiguration,
containerAppsConfiguration,
defaultDomain,
deploymentErrors,
environmentType,
extendedLocation,
internalLoadBalancerEnabled,
kind,
location,
provisioningState,
staticIp,
systemData,
tags,
type
FROM azure.web.kube_environments
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

Get all Kubernetes Environments for a subscription. Description for Get all Kubernetes Environments for a subscription.

SELECT
id,
name,
aksResourceID,
appLogsConfiguration,
arcConfiguration,
containerAppsConfiguration,
defaultDomain,
deploymentErrors,
environmentType,
extendedLocation,
internalLoadBalancerEnabled,
kind,
location,
provisioningState,
staticIp,
systemData,
tags,
type
FROM azure.web.kube_environments
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates or updates a Kubernetes Environment. Description for Creates or updates a Kubernetes Environment.

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

Manifest

# Description fields are for documentation purposes
- name: kube_environments
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the kube_environments resource.
  - name: name
    value: "{{ name }}"
    description: Required parameter for the kube_environments resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the kube_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: |
      KubeEnvironment resource specific properties.
    value:
      provisioningState: "{{ provisioningState }}"
      deploymentErrors: "{{ deploymentErrors }}"
      internalLoadBalancerEnabled: {{ internalLoadBalancerEnabled }}
      defaultDomain: "{{ defaultDomain }}"
      staticIp: "{{ staticIp }}"
      environmentType: "{{ environmentType }}"
      arcConfiguration:
        artifactsStorageType: "{{ artifactsStorageType }}"
        artifactStorageClassName: "{{ artifactStorageClassName }}"
        artifactStorageMountPath: "{{ artifactStorageMountPath }}"
        artifactStorageNodeName: "{{ artifactStorageNodeName }}"
        artifactStorageAccessMode: "{{ artifactStorageAccessMode }}"
        frontEndServiceConfiguration:
          kind: "{{ kind }}"
        kubeConfig: "{{ kubeConfig }}"
      appLogsConfiguration:
        destination: "{{ destination }}"
        logAnalyticsConfiguration:
          customerId: "{{ customerId }}"
          sharedKey: "{{ sharedKey }}"
      containerAppsConfiguration:
        daprAIInstrumentationKey: "{{ daprAIInstrumentationKey }}"
        platformReservedCidr: "{{ platformReservedCidr }}"
        platformReservedDnsIP: "{{ platformReservedDnsIP }}"
        controlPlaneSubnetResourceId: "{{ controlPlaneSubnetResourceId }}"
        appSubnetResourceId: "{{ appSubnetResourceId }}"
        dockerBridgeCidr: "{{ dockerBridgeCidr }}"
      aksResourceID: "{{ aksResourceID }}"
  - name: extendedLocation
    description: |
      Extended Location.
    value:
      name: "{{ name }}"
      type: "{{ type }}"
  - name: kind
    value: "{{ kind }}"
    description: |
      Kind of resource.

UPDATE examples

update

Creates or updates a Kubernetes Environment. Description for Creates or updates a Kubernetes Environment.

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

REPLACE examples

create_or_update

Creates or updates a Kubernetes Environment. Description for Creates or updates a Kubernetes Environment.

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

DELETE examples

delete

Delete a Kubernetes Environment. Description for Delete a Kubernetes Environment.

DELETE FROM azure.web.kube_environments
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND name = '{{ name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;