Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v1
  3. API Docs
  4. web
  5. KubeEnvironment
These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
pulumi/pulumi-azure-native

azure-native.web.KubeEnvironment

Explore with Pulumi AI

azure-native-v1 logo
These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
pulumi/pulumi-azure-native

    A Kubernetes cluster specialized for web workloads by Azure App Service API Version: 2021-01-01.

    Example Usage

    Create kube environments

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var kubeEnvironment = new AzureNative.Web.KubeEnvironment("kubeEnvironment", new()
    {
        Location = "East US",
        Name = "testkubeenv",
        ResourceGroupName = "examplerg",
        StaticIp = "1.2.3.4",
    });

});

    package main

import (
	web "github.com/pulumi/pulumi-azure-native-sdk/web"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := web.NewKubeEnvironment(ctx, "kubeEnvironment", &web.KubeEnvironmentArgs{
			Location:          pulumi.String("East US"),
			Name:              pulumi.String("testkubeenv"),
			ResourceGroupName: pulumi.String("examplerg"),
			StaticIp:          pulumi.String("1.2.3.4"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.web.KubeEnvironment;
import com.pulumi.azurenative.web.KubeEnvironmentArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var kubeEnvironment = new KubeEnvironment("kubeEnvironment", KubeEnvironmentArgs.builder()        
            .location("East US")
            .name("testkubeenv")
            .resourceGroupName("examplerg")
            .staticIp("1.2.3.4")
            .build());

    }
}

    import pulumi
import pulumi_azure_native as azure_native

kube_environment = azure_native.web.KubeEnvironment("kubeEnvironment",
    location="East US",
    name="testkubeenv",
    resource_group_name="examplerg",
    static_ip="1.2.3.4")

    import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const kubeEnvironment = new azure_native.web.KubeEnvironment("kubeEnvironment", {
    location: "East US",
    name: "testkubeenv",
    resourceGroupName: "examplerg",
    staticIp: "1.2.3.4",
});

    resources:
  kubeEnvironment:
    type: azure-native:web:KubeEnvironment
    properties:
      location: East US
      name: testkubeenv
      resourceGroupName: examplerg
      staticIp: 1.2.3.4

    Create KubeEnvironment Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new KubeEnvironment(name: string, args: KubeEnvironmentArgs, opts?: CustomResourceOptions);
    @overload
def KubeEnvironment(resource_name: str,
                    args: KubeEnvironmentArgs,
                    opts: Optional[ResourceOptions] = None)

@overload
def KubeEnvironment(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    resource_group_name: Optional[str] = None,
                    aks_resource_id: Optional[str] = None,
                    app_logs_configuration: Optional[AppLogsConfigurationArgs] = None,
                    arc_configuration: Optional[ArcConfigurationArgs] = None,
                    extended_location: Optional[ExtendedLocationArgs] = None,
                    internal_load_balancer_enabled: Optional[bool] = None,
                    kind: Optional[str] = None,
                    location: Optional[str] = None,
                    name: Optional[str] = None,
                    static_ip: Optional[str] = None,
                    tags: Optional[Mapping[str, str]] = None)
    func NewKubeEnvironment(ctx *Context, name string, args KubeEnvironmentArgs, opts ...ResourceOption) (*KubeEnvironment, error)
    public KubeEnvironment(string name, KubeEnvironmentArgs args, CustomResourceOptions? opts = null)
    public KubeEnvironment(String name, KubeEnvironmentArgs args)
public KubeEnvironment(String name, KubeEnvironmentArgs args, CustomResourceOptions options)

    type: azure-native:web:KubeEnvironment
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args KubeEnvironmentArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args KubeEnvironmentArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args KubeEnvironmentArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args KubeEnvironmentArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args KubeEnvironmentArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var kubeEnvironmentResource = new AzureNative.Web.KubeEnvironment("kubeEnvironmentResource", new()
{
    ResourceGroupName = "string",
    AksResourceID = "string",
    AppLogsConfiguration = 
    {
        { "destination", "string" },
        { "logAnalyticsConfiguration", 
        {
            { "customerId", "string" },
            { "sharedKey", "string" },
        } },
    },
    ArcConfiguration = 
    {
        { "artifactStorageAccessMode", "string" },
        { "artifactStorageClassName", "string" },
        { "artifactStorageMountPath", "string" },
        { "artifactStorageNodeName", "string" },
        { "artifactsStorageType", "LocalNode" },
        { "frontEndServiceConfiguration", 
        {
            { "kind", "NodePort" },
        } },
        { "kubeConfig", "string" },
    },
    ExtendedLocation = 
    {
        { "name", "string" },
    },
    InternalLoadBalancerEnabled = false,
    Kind = "string",
    Location = "string",
    Name = "string",
    StaticIp = "string",
    Tags = 
    {
        { "string", "string" },
    },
});

    example, err := web.NewKubeEnvironment(ctx, "kubeEnvironmentResource", &web.KubeEnvironmentArgs{
	ResourceGroupName: "string",
	AksResourceID:     "string",
	AppLogsConfiguration: map[string]interface{}{
		"destination": "string",
		"logAnalyticsConfiguration": map[string]interface{}{
			"customerId": "string",
			"sharedKey":  "string",
		},
	},
	ArcConfiguration: map[string]interface{}{
		"artifactStorageAccessMode": "string",
		"artifactStorageClassName":  "string",
		"artifactStorageMountPath":  "string",
		"artifactStorageNodeName":   "string",
		"artifactsStorageType":      "LocalNode",
		"frontEndServiceConfiguration": map[string]interface{}{
			"kind": "NodePort",
		},
		"kubeConfig": "string",
	},
	ExtendedLocation: map[string]interface{}{
		"name": "string",
	},
	InternalLoadBalancerEnabled: false,
	Kind:                        "string",
	Location:                    "string",
	Name:                        "string",
	StaticIp:                    "string",
	Tags: map[string]interface{}{
		"string": "string",
	},
})

    var kubeEnvironmentResource = new KubeEnvironment("kubeEnvironmentResource", KubeEnvironmentArgs.builder()
    .resourceGroupName("string")
    .aksResourceID("string")
    .appLogsConfiguration(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
    .arcConfiguration(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
    .extendedLocation(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
    .internalLoadBalancerEnabled(false)
    .kind("string")
    .location("string")
    .name("string")
    .staticIp("string")
    .tags(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
    .build());

    kube_environment_resource = azure_native.web.KubeEnvironment("kubeEnvironmentResource",
    resource_group_name=string,
    aks_resource_id=string,
    app_logs_configuration={
        destination: string,
        logAnalyticsConfiguration: {
            customerId: string,
            sharedKey: string,
        },
    },
    arc_configuration={
        artifactStorageAccessMode: string,
        artifactStorageClassName: string,
        artifactStorageMountPath: string,
        artifactStorageNodeName: string,
        artifactsStorageType: LocalNode,
        frontEndServiceConfiguration: {
            kind: NodePort,
        },
        kubeConfig: string,
    },
    extended_location={
        name: string,
    },
    internal_load_balancer_enabled=False,
    kind=string,
    location=string,
    name=string,
    static_ip=string,
    tags={
        string: string,
    })

    const kubeEnvironmentResource = new azure_native.web.KubeEnvironment("kubeEnvironmentResource", {
    resourceGroupName: "string",
    aksResourceID: "string",
    appLogsConfiguration: {
        destination: "string",
        logAnalyticsConfiguration: {
            customerId: "string",
            sharedKey: "string",
        },
    },
    arcConfiguration: {
        artifactStorageAccessMode: "string",
        artifactStorageClassName: "string",
        artifactStorageMountPath: "string",
        artifactStorageNodeName: "string",
        artifactsStorageType: "LocalNode",
        frontEndServiceConfiguration: {
            kind: "NodePort",
        },
        kubeConfig: "string",
    },
    extendedLocation: {
        name: "string",
    },
    internalLoadBalancerEnabled: false,
    kind: "string",
    location: "string",
    name: "string",
    staticIp: "string",
    tags: {
        string: "string",
    },
});

    type: azure-native:web:KubeEnvironment
properties:
    aksResourceID: string
    appLogsConfiguration:
        destination: string
        logAnalyticsConfiguration:
            customerId: string
            sharedKey: string
    arcConfiguration:
        artifactStorageAccessMode: string
        artifactStorageClassName: string
        artifactStorageMountPath: string
        artifactStorageNodeName: string
        artifactsStorageType: LocalNode
        frontEndServiceConfiguration:
            kind: NodePort
        kubeConfig: string
    extendedLocation:
        name: string
    internalLoadBalancerEnabled: false
    kind: string
    location: string
    name: string
    resourceGroupName: string
    staticIp: string
    tags:
        string: string

    KubeEnvironment Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The KubeEnvironment resource accepts the following input properties:

    ResourceGroupName string
    Name of the resource group to which the resource belongs.
    AksResourceID string
    AppLogsConfiguration Pulumi.AzureNative.Web.Inputs.AppLogsConfiguration
    Cluster configuration which enables the log daemon to export app logs to a destination. Currently only "log-analytics" is supported
    ArcConfiguration Pulumi.AzureNative.Web.Inputs.ArcConfiguration
    Cluster configuration which determines the ARC cluster components types. Eg: Choosing between BuildService kind, FrontEnd Service ArtifactsStorageType etc.
    ExtendedLocation Pulumi.AzureNative.Web.Inputs.ExtendedLocation
    Extended Location.
    InternalLoadBalancerEnabled bool
    Only visible within Vnet/Subnet
    Kind string
    Kind of resource.
    Location string
    Resource Location.
    Name string
    Name of the Kubernetes Environment.
    StaticIp string
    Static IP of the KubeEnvironment
    Tags Dictionary<string, string>
    Resource tags.
    ResourceGroupName string
    Name of the resource group to which the resource belongs.
    AksResourceID string
    AppLogsConfiguration AppLogsConfigurationArgs
    Cluster configuration which enables the log daemon to export app logs to a destination. Currently only "log-analytics" is supported
    ArcConfiguration ArcConfigurationArgs
    Cluster configuration which determines the ARC cluster components types. Eg: Choosing between BuildService kind, FrontEnd Service ArtifactsStorageType etc.
    ExtendedLocation ExtendedLocationArgs
    Extended Location.
    InternalLoadBalancerEnabled bool
    Only visible within Vnet/Subnet
    Kind string
    Kind of resource.
    Location string
    Resource Location.
    Name string
    Name of the Kubernetes Environment.
    StaticIp string
    Static IP of the KubeEnvironment
    Tags map[string]string
    Resource tags.
    resourceGroupName String
    Name of the resource group to which the resource belongs.
    aksResourceID String
    appLogsConfiguration AppLogsConfiguration
    Cluster configuration which enables the log daemon to export app logs to a destination. Currently only "log-analytics" is supported
    arcConfiguration ArcConfiguration
    Cluster configuration which determines the ARC cluster components types. Eg: Choosing between BuildService kind, FrontEnd Service ArtifactsStorageType etc.
    extendedLocation ExtendedLocation
    Extended Location.
    internalLoadBalancerEnabled Boolean
    Only visible within Vnet/Subnet
    kind String
    Kind of resource.
    location String
    Resource Location.
    name String
    Name of the Kubernetes Environment.
    staticIp String
    Static IP of the KubeEnvironment
    tags Map<String,String>
    Resource tags.
    resourceGroupName string
    Name of the resource group to which the resource belongs.
    aksResourceID string
    appLogsConfiguration AppLogsConfiguration
    Cluster configuration which enables the log daemon to export app logs to a destination. Currently only "log-analytics" is supported
    arcConfiguration ArcConfiguration
    Cluster configuration which determines the ARC cluster components types. Eg: Choosing between BuildService kind, FrontEnd Service ArtifactsStorageType etc.
    extendedLocation ExtendedLocation
    Extended Location.
    internalLoadBalancerEnabled boolean
    Only visible within Vnet/Subnet
    kind string
    Kind of resource.
    location string
    Resource Location.
    name string
    Name of the Kubernetes Environment.
    staticIp string
    Static IP of the KubeEnvironment
    tags {[key: string]: string}
    Resource tags.
    resource_group_name str
    Name of the resource group to which the resource belongs.
    aks_resource_id str
    app_logs_configuration AppLogsConfigurationArgs
    Cluster configuration which enables the log daemon to export app logs to a destination. Currently only "log-analytics" is supported
    arc_configuration ArcConfigurationArgs
    Cluster configuration which determines the ARC cluster components types. Eg: Choosing between BuildService kind, FrontEnd Service ArtifactsStorageType etc.
    extended_location ExtendedLocationArgs
    Extended Location.
    internal_load_balancer_enabled bool
    Only visible within Vnet/Subnet
    kind str
    Kind of resource.
    location str
    Resource Location.
    name str
    Name of the Kubernetes Environment.
    static_ip str
    Static IP of the KubeEnvironment
    tags Mapping[str, str]
    Resource tags.
    resourceGroupName String
    Name of the resource group to which the resource belongs.
    aksResourceID String
    appLogsConfiguration Property Map
    Cluster configuration which enables the log daemon to export app logs to a destination. Currently only "log-analytics" is supported
    arcConfiguration Property Map
    Cluster configuration which determines the ARC cluster components types. Eg: Choosing between BuildService kind, FrontEnd Service ArtifactsStorageType etc.
    extendedLocation Property Map
    Extended Location.
    internalLoadBalancerEnabled Boolean
    Only visible within Vnet/Subnet
    kind String
    Kind of resource.
    location String
    Resource Location.
    name String
    Name of the Kubernetes Environment.
    staticIp String
    Static IP of the KubeEnvironment
    tags Map<String>
    Resource tags.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the KubeEnvironment resource produces the following output properties:

    DefaultDomain string
    Default Domain Name for the cluster
    DeploymentErrors string
    Any errors that occurred during deployment or deployment validation
    Id string
    The provider-assigned unique ID for this managed resource.
    ProvisioningState string
    Provisioning state of the Kubernetes Environment.
    Type string
    Resource type.
    DefaultDomain string
    Default Domain Name for the cluster
    DeploymentErrors string
    Any errors that occurred during deployment or deployment validation
    Id string
    The provider-assigned unique ID for this managed resource.
    ProvisioningState string
    Provisioning state of the Kubernetes Environment.
    Type string
    Resource type.
    defaultDomain String
    Default Domain Name for the cluster
    deploymentErrors String
    Any errors that occurred during deployment or deployment validation
    id String
    The provider-assigned unique ID for this managed resource.
    provisioningState String
    Provisioning state of the Kubernetes Environment.
    type String
    Resource type.
    defaultDomain string
    Default Domain Name for the cluster
    deploymentErrors string
    Any errors that occurred during deployment or deployment validation
    id string
    The provider-assigned unique ID for this managed resource.
    provisioningState string
    Provisioning state of the Kubernetes Environment.
    type string
    Resource type.
    default_domain str
    Default Domain Name for the cluster
    deployment_errors str
    Any errors that occurred during deployment or deployment validation
    id str
    The provider-assigned unique ID for this managed resource.
    provisioning_state str
    Provisioning state of the Kubernetes Environment.
    type str
    Resource type.
    defaultDomain String
    Default Domain Name for the cluster
    deploymentErrors String
    Any errors that occurred during deployment or deployment validation
    id String
    The provider-assigned unique ID for this managed resource.
    provisioningState String
    Provisioning state of the Kubernetes Environment.
    type String
    Resource type.

    Supporting Types

    AppLogsConfiguration, AppLogsConfigurationArgs

    AppLogsConfigurationResponse, AppLogsConfigurationResponseArgs

    ArcConfiguration, ArcConfigurationArgs

    ArcConfigurationResponse, ArcConfigurationResponseArgs

    ExtendedLocation, ExtendedLocationArgs

    Name string
    Name of extended location.
    Name string
    Name of extended location.
    name String
    Name of extended location.
    name string
    Name of extended location.
    name str
    Name of extended location.
    name String
    Name of extended location.

    ExtendedLocationResponse, ExtendedLocationResponseArgs

    Type string
    Type of extended location.
    Name string
    Name of extended location.
    Type string
    Type of extended location.
    Name string
    Name of extended location.
    type String
    Type of extended location.
    name String
    Name of extended location.
    type string
    Type of extended location.
    name string
    Name of extended location.
    type str
    Type of extended location.
    name str
    Name of extended location.
    type String
    Type of extended location.
    name String
    Name of extended location.

    FrontEndConfiguration, FrontEndConfigurationArgs

    FrontEndConfigurationResponse, FrontEndConfigurationResponseArgs

    Kind string
    Kind string
    kind String
    kind string
    kind str
    kind String

    FrontEndServiceType, FrontEndServiceTypeArgs

    NodePort
    NodePort
    LoadBalancer
    LoadBalancer
    FrontEndServiceTypeNodePort
    NodePort
    FrontEndServiceTypeLoadBalancer
    LoadBalancer
    NodePort
    NodePort
    LoadBalancer
    LoadBalancer
    NodePort
    NodePort
    LoadBalancer
    LoadBalancer
    NODE_PORT
    NodePort
    LOAD_BALANCER
    LoadBalancer
    "NodePort"
    NodePort
    "LoadBalancer"
    LoadBalancer

    LogAnalyticsConfiguration, LogAnalyticsConfigurationArgs

    CustomerId string
    SharedKey string
    CustomerId string
    SharedKey string
    customerId String
    sharedKey String
    customerId string
    sharedKey string
    customerId String
    sharedKey String

    LogAnalyticsConfigurationResponse, LogAnalyticsConfigurationResponseArgs

    CustomerId string
    CustomerId string
    customerId String
    customerId string
    customerId String

    StorageType, StorageTypeArgs

    LocalNode
    LocalNode
    NetworkFileSystem
    NetworkFileSystem
    StorageTypeLocalNode
    LocalNode
    StorageTypeNetworkFileSystem
    NetworkFileSystem
    LocalNode
    LocalNode
    NetworkFileSystem
    NetworkFileSystem
    LocalNode
    LocalNode
    NetworkFileSystem
    NetworkFileSystem
    LOCAL_NODE
    LocalNode
    NETWORK_FILE_SYSTEM
    NetworkFileSystem
    "LocalNode"
    LocalNode
    "NetworkFileSystem"
    NetworkFileSystem

    Import

    An existing resource can be imported using its type token, name, and identifier, e.g.

    $ pulumi import azure-native:web:KubeEnvironment testkubeenv /subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/examplerg/providers/Microsoft.Web/kubeEnvironments/testkubeenv

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    azure-native-v1 pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native-v1 logo
    These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
    Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
    pulumi/pulumi-azure-native