KubernetesEnvironmentResource Properties
ClassProperties9 members
Represents a Kubernetes environment resource that can host application resources.
Determines whether to include an Aspire dashboard for telemetry visualization in this environment.
public bool DashboardEnabled { get; set; } Gets or sets the default policy that determines how Docker images are pulled during deployment. Possible values are: "Always" - Always attempt to pull the image from the registry. "IfNotPresent" - Pull the image only if it is not already present locally. "Never" - Never pull the image, use only the local image. The default value is "IfNotPresent".
public string DefaultImagePullPolicy { get; set; } Gets or sets the default Kubernetes service type to be used when generating artifacts.
public string DefaultServiceType { get; set; }Remarks
The default value is "ClusterIP". This property determines the type of service (e.g., ClusterIP, NodePort, LoadBalancer) created in Kubernetes for the application.
Specifies the default name of the storage class to be used for persistent volume claims in Kubernetes. This property allows customization of the storage class for specifying storage requirements such as performance, retention policies, and provisioning parameters. If set to null, the default storage class for the cluster will be used.
public string? DefaultStorageClassName { get; set; } Gets or sets the default access policy for reading and writing to the storage.
public string DefaultStorageReadWritePolicy { get; set; } Gets or sets the default storage size for persistent volumes.
public string DefaultStorageSize { get; set; } Specifies the default type of storage used for Kubernetes deployments.
public string DefaultStorageType { get; set; }Remarks
This property determines the storage medium used for the application. Possible values include "emptyDir", "hostPath", "pvc"
Gets or sets the path to an explicit kubeconfig file for Helm and kubectl commands. When set, all Helm and kubectl commands will use
--kubeconfig to target this file instead of the default ~/.kube/config. public string? KubeConfigPath { get; set; }Remarks
This is used by Azure Kubernetes Service (AKS) integration to isolate credentials fetched via
az aks get-credentials from the user's default kubectl context. Gets or sets the parent compute environment resource that owns this Kubernetes environment. When set, resources with
WithComputeEnvironment targeting the parent will also be processed by this Kubernetes environment. public IComputeEnvironmentResource? OwningComputeEnvironment { get; set; }Remarks
This is used by Azure Kubernetes Service (AKS) integration where the user calls
WithComputeEnvironment(aksEnv) but the inner KubernetesEnvironmentResource needs to process the resource.