Class AzureCloudEnvironment

Specifies the target Azure environment.

Inheritance

object

AzureCloudEnvironment

Namespace: Neon.Kube.ClusterDef

Assembly: Neon.Kube.dll

Syntax

public class AzureCloudEnvironment

Remarks

Microsoft Azure deploys more than one environment for hosting services. global-cloud identifies their public cloud which is where most users and companies will deploy services. Azure also has a few private environments that are typically used by specialized customers (like governments).

The easiest way to use this is by setting the Name property to one of the possible environments:

global-cloud	Public Azure cloud (the default).
china-cloud	Private Chinese cloud.
german-cloud	Private German cloud.
us-government	Private United States government cloud.

Alternatively, you can set Name to custom and specify a custom endpoint URI and audience. This is useful for deploying a cluster to a new Azure environment unknown to the current NEONKUBE release or other private/internal Azure clouds.

Constructors

AzureCloudEnvironment()

Default constructor.

Declaration

public AzureCloudEnvironment()

Properties

Audience

Specifies the audience.

Declaration

[JsonProperty(PropertyName = "Audience", Required = Required.AllowNull)]
[YamlMember(Alias = "audience", ApplyNamingConventions = false)]
public string Audience { get; set; }

Property Value

Type	Description
string

Endpoint

Environment authentication endpoint URI.

Declaration

[JsonProperty(PropertyName = "Endpoint", Required = Required.AllowNull)]
[YamlMember(Alias = "endpoint", ApplyNamingConventions = false)]
public string Endpoint { get; set; }

Property Value

Type	Description
string

Name

Identifies the Azure environment. This defaults to GlobalCloud.

Declaration

[JsonProperty(PropertyName = "Name", Required = Required.Default, DefaultValueHandling = DefaultValueHandling.IgnoreAndPopulate)]
[YamlMember(Alias = "name", ApplyNamingConventions = false)]
public AzureCloudEnvironments Name { get; set; }

Property Value

Type	Description
AzureCloudEnvironments

Methods

Validate(ClusterDefinition)

Validates the options and also ensures that all null properties are initialized to their default values.

Declaration

public void Validate(ClusterDefinition clusterDefinition)

Parameters

Type	Name	Description
ClusterDefinition	clusterDefinition	The cluster definition.

Exceptions

Type	Condition
ClusterDefinitionException	Thrown if the definition is not valid.