KubernetesEnvironmentResource Class

Reference

Definition

Namespace:: Aspire.Hosting.Kubernetes

Assembly:: Aspire.Hosting.Kubernetes.dll

Package:: Aspire.Hosting.Kubernetes v9.3.0-preview.1.25265.20

Source:: KubernetesEnvironmentResource.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Represents a Kubernetes environment resource that can host application resources.

public sealed class KubernetesEnvironmentResource : Aspire.Hosting.ApplicationModel.Resource, Aspire.Hosting.ApplicationModel.IComputeEnvironmentResource

type KubernetesEnvironmentResource = class
    inherit Resource
    interface IComputeEnvironmentResource
    interface IResource

Public NotInheritable Class KubernetesEnvironmentResource
Inherits Resource
Implements IComputeEnvironmentResource

Inheritance: Object

Resource
KubernetesEnvironmentResource

Implements: IComputeEnvironmentResource IResource

Remarks

Initializes a new instance of the KubernetesEnvironmentResource class.

Constructors

KubernetesEnvironmentResource(String)

Properties

Annotations	Gets the annotations associated with the resource. (Inherited from Resource)
DefaultImagePullPolicy	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".
DefaultServiceType	Gets or sets the default Kubernetes service type to be used when generating artifacts.
DefaultStorageClassName	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.
DefaultStorageReadWritePolicy	Gets or sets the default access policy for reading and writing to the storage.
DefaultStorageSize	Gets or sets the default storage size for persistent volumes.
DefaultStorageType	Specifies the default type of storage used for Kubernetes deployments.
HelmChartDescription	Gets or sets the description of the Helm chart being generated.
HelmChartName	Gets or sets the name of the Helm chart to be generated.
HelmChartVersion	Gets or sets the version of the Helm chart to be generated. This property specifies the version number that will be assigned to the Helm chart, typically following semantic versioning conventions.
Name	Gets the name of the resource. (Inherited from Resource)

Extension Methods

GetDeploymentTargetAnnotation(IResource, IComputeEnvironmentResource)	Gets the deployment target for the specified resource, if any. Throws an exception if there are multiple compute environments and a compute environment is not explicitly specified.
GetReplicaCount(IResource)	Gets the number of replicas for the specified resource. Defaults to `1` if no ReplicaAnnotation is found.
HasAnnotationIncludingAncestorsOfType<T>(IResource)	Gets whether `resource` or its ancestors have an annotation of type `T`
HasAnnotationOfType<T>(IResource)	Gets whether `resource` has an annotation of type `T`
ProcessArgumentValuesAsync(IResource, DistributedApplicationExecutionContext, Action<Object,String,Exception,Boolean>, ILogger, String, CancellationToken)	Processes argument values for the specified resource in the given execution context.
ProcessEnvironmentVariableValuesAsync(IResource, DistributedApplicationExecutionContext, Action<String,Object,String,Exception>, ILogger, String, CancellationToken)	Processes environment variable values for the specified resource within the given execution context.
TryGetAnnotationsIncludingAncestorsOfType<T>(IResource, IEnumerable<T>)	Attempts to retrieve all annotations of the specified type from the given resource including from parents.
TryGetAnnotationsOfType<T>(IResource, IEnumerable<T>)	Attempts to retrieve all annotations of the specified type from the given resource.
TryGetContainerImageName(IResource, String)	Attempts to get the container image name from the given resource.
TryGetContainerMounts(IResource, IEnumerable<ContainerMountAnnotation>)	Attempts to get the container mounts for the specified resource.
TryGetEndpoints(IResource, IEnumerable<EndpointAnnotation>)	Attempts to retrieve the endpoints for the given resource.
TryGetEnvironmentVariables(IResource, IEnumerable<EnvironmentCallbackAnnotation>)	Attempts to get the environment variables from the given resource.
TryGetLastAnnotation<T>(IResource, T)	Attempts to get the last annotation of the specified type from the resource.
TryGetUrls(IResource, IEnumerable<ResourceUrlAnnotation>)	Attempts to retrieve the URLs for the given resource.
IsContainer(IResource)	Determines whether the specified resource is a container resource.
IsExisting(IResource)	Determines if the resource is an existing resource.

Applies to

通过