1. Packages
  2. Azure Native v2
  3. API Docs
  4. web
  5. getKubeEnvironment
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi

azure-native-v2.web.getKubeEnvironment

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi

Description for Get the properties of a Kubernetes Environment. Azure REST API version: 2022-09-01.

Other available API versions: 2023-01-01, 2023-12-01, 2024-04-01.

Using getKubeEnvironment

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getKubeEnvironment(args: GetKubeEnvironmentArgs, opts?: InvokeOptions): Promise<GetKubeEnvironmentResult>
function getKubeEnvironmentOutput(args: GetKubeEnvironmentOutputArgs, opts?: InvokeOptions): Output<GetKubeEnvironmentResult>
Copy
def get_kube_environment(name: Optional[str] = None,
                         resource_group_name: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetKubeEnvironmentResult
def get_kube_environment_output(name: Optional[pulumi.Input[str]] = None,
                         resource_group_name: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetKubeEnvironmentResult]
Copy
func LookupKubeEnvironment(ctx *Context, args *LookupKubeEnvironmentArgs, opts ...InvokeOption) (*LookupKubeEnvironmentResult, error)
func LookupKubeEnvironmentOutput(ctx *Context, args *LookupKubeEnvironmentOutputArgs, opts ...InvokeOption) LookupKubeEnvironmentResultOutput
Copy

> Note: This function is named LookupKubeEnvironment in the Go SDK.

public static class GetKubeEnvironment 
{
    public static Task<GetKubeEnvironmentResult> InvokeAsync(GetKubeEnvironmentArgs args, InvokeOptions? opts = null)
    public static Output<GetKubeEnvironmentResult> Invoke(GetKubeEnvironmentInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetKubeEnvironmentResult> getKubeEnvironment(GetKubeEnvironmentArgs args, InvokeOptions options)
public static Output<GetKubeEnvironmentResult> getKubeEnvironment(GetKubeEnvironmentArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:web:getKubeEnvironment
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Name
This property is required.
Changes to this property will trigger replacement.
string
Name of the Kubernetes Environment.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of the resource group to which the resource belongs.
Name
This property is required.
Changes to this property will trigger replacement.
string
Name of the Kubernetes Environment.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of the resource group to which the resource belongs.
name
This property is required.
Changes to this property will trigger replacement.
String
Name of the Kubernetes Environment.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
Name of the resource group to which the resource belongs.
name
This property is required.
Changes to this property will trigger replacement.
string
Name of the Kubernetes Environment.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of the resource group to which the resource belongs.
name
This property is required.
Changes to this property will trigger replacement.
str
Name of the Kubernetes Environment.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
Name of the resource group to which the resource belongs.
name
This property is required.
Changes to this property will trigger replacement.
String
Name of the Kubernetes Environment.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
Name of the resource group to which the resource belongs.

getKubeEnvironment Result

The following output properties are available:

DefaultDomain string
Default Domain Name for the cluster
DeploymentErrors string
Any errors that occurred during deployment or deployment validation
Id string
Resource Id.
Location string
Resource Location.
Name string
Resource Name.
ProvisioningState string
Provisioning state of the Kubernetes Environment.
Type string
Resource type.
AksResourceID string
AppLogsConfiguration Pulumi.AzureNative.Web.Outputs.AppLogsConfigurationResponse
Cluster configuration which enables the log daemon to export app logs to a destination. Currently only "log-analytics" is supported
ArcConfiguration Pulumi.AzureNative.Web.Outputs.ArcConfigurationResponse
Cluster configuration which determines the ARC cluster components types. Eg: Choosing between BuildService kind, FrontEnd Service ArtifactsStorageType etc.
ContainerAppsConfiguration Pulumi.AzureNative.Web.Outputs.ContainerAppsConfigurationResponse
Cluster configuration for Container Apps Environments to configure Dapr Instrumentation Key and VNET Configuration
EnvironmentType string
Type of Kubernetes Environment. Only supported for Container App Environments with value as Managed
ExtendedLocation Pulumi.AzureNative.Web.Outputs.ExtendedLocationResponse
Extended Location.
InternalLoadBalancerEnabled bool
Only visible within Vnet/Subnet
Kind string
Kind of resource.
StaticIp string
Static IP of the KubeEnvironment
Tags Dictionary<string, string>
Resource tags.
DefaultDomain string
Default Domain Name for the cluster
DeploymentErrors string
Any errors that occurred during deployment or deployment validation
Id string
Resource Id.
Location string
Resource Location.
Name string
Resource Name.
ProvisioningState string
Provisioning state of the Kubernetes Environment.
Type string
Resource type.
AksResourceID string
AppLogsConfiguration AppLogsConfigurationResponse
Cluster configuration which enables the log daemon to export app logs to a destination. Currently only "log-analytics" is supported
ArcConfiguration ArcConfigurationResponse
Cluster configuration which determines the ARC cluster components types. Eg: Choosing between BuildService kind, FrontEnd Service ArtifactsStorageType etc.
ContainerAppsConfiguration ContainerAppsConfigurationResponse
Cluster configuration for Container Apps Environments to configure Dapr Instrumentation Key and VNET Configuration
EnvironmentType string
Type of Kubernetes Environment. Only supported for Container App Environments with value as Managed
ExtendedLocation ExtendedLocationResponse
Extended Location.
InternalLoadBalancerEnabled bool
Only visible within Vnet/Subnet
Kind string
Kind of resource.
StaticIp string
Static IP of the KubeEnvironment
Tags map[string]string
Resource tags.
defaultDomain String
Default Domain Name for the cluster
deploymentErrors String
Any errors that occurred during deployment or deployment validation
id String
Resource Id.
location String
Resource Location.
name String
Resource Name.
provisioningState String
Provisioning state of the Kubernetes Environment.
type String
Resource type.
aksResourceID String
appLogsConfiguration AppLogsConfigurationResponse
Cluster configuration which enables the log daemon to export app logs to a destination. Currently only "log-analytics" is supported
arcConfiguration ArcConfigurationResponse
Cluster configuration which determines the ARC cluster components types. Eg: Choosing between BuildService kind, FrontEnd Service ArtifactsStorageType etc.
containerAppsConfiguration ContainerAppsConfigurationResponse
Cluster configuration for Container Apps Environments to configure Dapr Instrumentation Key and VNET Configuration
environmentType String
Type of Kubernetes Environment. Only supported for Container App Environments with value as Managed
extendedLocation ExtendedLocationResponse
Extended Location.
internalLoadBalancerEnabled Boolean
Only visible within Vnet/Subnet
kind String
Kind of resource.
staticIp String
Static IP of the KubeEnvironment
tags Map<String,String>
Resource tags.
defaultDomain string
Default Domain Name for the cluster
deploymentErrors string
Any errors that occurred during deployment or deployment validation
id string
Resource Id.
location string
Resource Location.
name string
Resource Name.
provisioningState string
Provisioning state of the Kubernetes Environment.
type string
Resource type.
aksResourceID string
appLogsConfiguration AppLogsConfigurationResponse
Cluster configuration which enables the log daemon to export app logs to a destination. Currently only "log-analytics" is supported
arcConfiguration ArcConfigurationResponse
Cluster configuration which determines the ARC cluster components types. Eg: Choosing between BuildService kind, FrontEnd Service ArtifactsStorageType etc.
containerAppsConfiguration ContainerAppsConfigurationResponse
Cluster configuration for Container Apps Environments to configure Dapr Instrumentation Key and VNET Configuration
environmentType string
Type of Kubernetes Environment. Only supported for Container App Environments with value as Managed
extendedLocation ExtendedLocationResponse
Extended Location.
internalLoadBalancerEnabled boolean
Only visible within Vnet/Subnet
kind string
Kind of resource.
staticIp string
Static IP of the KubeEnvironment
tags {[key: string]: string}
Resource tags.
default_domain str
Default Domain Name for the cluster
deployment_errors str
Any errors that occurred during deployment or deployment validation
id str
Resource Id.
location str
Resource Location.
name str
Resource Name.
provisioning_state str
Provisioning state of the Kubernetes Environment.
type str
Resource type.
aks_resource_id str
app_logs_configuration AppLogsConfigurationResponse
Cluster configuration which enables the log daemon to export app logs to a destination. Currently only "log-analytics" is supported
arc_configuration ArcConfigurationResponse
Cluster configuration which determines the ARC cluster components types. Eg: Choosing between BuildService kind, FrontEnd Service ArtifactsStorageType etc.
container_apps_configuration ContainerAppsConfigurationResponse
Cluster configuration for Container Apps Environments to configure Dapr Instrumentation Key and VNET Configuration
environment_type str
Type of Kubernetes Environment. Only supported for Container App Environments with value as Managed
extended_location ExtendedLocationResponse
Extended Location.
internal_load_balancer_enabled bool
Only visible within Vnet/Subnet
kind str
Kind of resource.
static_ip str
Static IP of the KubeEnvironment
tags Mapping[str, str]
Resource tags.
defaultDomain String
Default Domain Name for the cluster
deploymentErrors String
Any errors that occurred during deployment or deployment validation
id String
Resource Id.
location String
Resource Location.
name String
Resource Name.
provisioningState String
Provisioning state of the Kubernetes Environment.
type String
Resource type.
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.
containerAppsConfiguration Property Map
Cluster configuration for Container Apps Environments to configure Dapr Instrumentation Key and VNET Configuration
environmentType String
Type of Kubernetes Environment. Only supported for Container App Environments with value as Managed
extendedLocation Property Map
Extended Location.
internalLoadBalancerEnabled Boolean
Only visible within Vnet/Subnet
kind String
Kind of resource.
staticIp String
Static IP of the KubeEnvironment
tags Map<String>
Resource tags.

Supporting Types

AppLogsConfigurationResponse

ArcConfigurationResponse

ContainerAppsConfigurationResponse

AppSubnetResourceId string
Resource ID of a subnet for control plane infrastructure components. This subnet must be in the same VNET as the subnet defined in appSubnetResourceId. Must not overlap with the IP range defined in platformReservedCidr, if defined.
ControlPlaneSubnetResourceId string
Resource ID of a subnet for control plane infrastructure components. This subnet must be in the same VNET as the subnet defined in appSubnetResourceId. Must not overlap with the IP range defined in platformReservedCidr, if defined.
DaprAIInstrumentationKey string
Azure Monitor instrumentation key used by Dapr to export Service to Service communication telemetry
DockerBridgeCidr string
CIDR notation IP range assigned to the Docker bridge network. It must not overlap with any Subnet IP ranges or the IP range defined in platformReservedCidr, if defined.
PlatformReservedCidr string
IP range in CIDR notation that can be reserved for environment infrastructure IP addresses. It must not overlap with any other Subnet IP ranges.
PlatformReservedDnsIP string
An IP address from the IP range defined by platformReservedCidr that will be reserved for the internal DNS server
AppSubnetResourceId string
Resource ID of a subnet for control plane infrastructure components. This subnet must be in the same VNET as the subnet defined in appSubnetResourceId. Must not overlap with the IP range defined in platformReservedCidr, if defined.
ControlPlaneSubnetResourceId string
Resource ID of a subnet for control plane infrastructure components. This subnet must be in the same VNET as the subnet defined in appSubnetResourceId. Must not overlap with the IP range defined in platformReservedCidr, if defined.
DaprAIInstrumentationKey string
Azure Monitor instrumentation key used by Dapr to export Service to Service communication telemetry
DockerBridgeCidr string
CIDR notation IP range assigned to the Docker bridge network. It must not overlap with any Subnet IP ranges or the IP range defined in platformReservedCidr, if defined.
PlatformReservedCidr string
IP range in CIDR notation that can be reserved for environment infrastructure IP addresses. It must not overlap with any other Subnet IP ranges.
PlatformReservedDnsIP string
An IP address from the IP range defined by platformReservedCidr that will be reserved for the internal DNS server
appSubnetResourceId String
Resource ID of a subnet for control plane infrastructure components. This subnet must be in the same VNET as the subnet defined in appSubnetResourceId. Must not overlap with the IP range defined in platformReservedCidr, if defined.
controlPlaneSubnetResourceId String
Resource ID of a subnet for control plane infrastructure components. This subnet must be in the same VNET as the subnet defined in appSubnetResourceId. Must not overlap with the IP range defined in platformReservedCidr, if defined.
daprAIInstrumentationKey String
Azure Monitor instrumentation key used by Dapr to export Service to Service communication telemetry
dockerBridgeCidr String
CIDR notation IP range assigned to the Docker bridge network. It must not overlap with any Subnet IP ranges or the IP range defined in platformReservedCidr, if defined.
platformReservedCidr String
IP range in CIDR notation that can be reserved for environment infrastructure IP addresses. It must not overlap with any other Subnet IP ranges.
platformReservedDnsIP String
An IP address from the IP range defined by platformReservedCidr that will be reserved for the internal DNS server
appSubnetResourceId string
Resource ID of a subnet for control plane infrastructure components. This subnet must be in the same VNET as the subnet defined in appSubnetResourceId. Must not overlap with the IP range defined in platformReservedCidr, if defined.
controlPlaneSubnetResourceId string
Resource ID of a subnet for control plane infrastructure components. This subnet must be in the same VNET as the subnet defined in appSubnetResourceId. Must not overlap with the IP range defined in platformReservedCidr, if defined.
daprAIInstrumentationKey string
Azure Monitor instrumentation key used by Dapr to export Service to Service communication telemetry
dockerBridgeCidr string
CIDR notation IP range assigned to the Docker bridge network. It must not overlap with any Subnet IP ranges or the IP range defined in platformReservedCidr, if defined.
platformReservedCidr string
IP range in CIDR notation that can be reserved for environment infrastructure IP addresses. It must not overlap with any other Subnet IP ranges.
platformReservedDnsIP string
An IP address from the IP range defined by platformReservedCidr that will be reserved for the internal DNS server
app_subnet_resource_id str
Resource ID of a subnet for control plane infrastructure components. This subnet must be in the same VNET as the subnet defined in appSubnetResourceId. Must not overlap with the IP range defined in platformReservedCidr, if defined.
control_plane_subnet_resource_id str
Resource ID of a subnet for control plane infrastructure components. This subnet must be in the same VNET as the subnet defined in appSubnetResourceId. Must not overlap with the IP range defined in platformReservedCidr, if defined.
dapr_ai_instrumentation_key str
Azure Monitor instrumentation key used by Dapr to export Service to Service communication telemetry
docker_bridge_cidr str
CIDR notation IP range assigned to the Docker bridge network. It must not overlap with any Subnet IP ranges or the IP range defined in platformReservedCidr, if defined.
platform_reserved_cidr str
IP range in CIDR notation that can be reserved for environment infrastructure IP addresses. It must not overlap with any other Subnet IP ranges.
platform_reserved_dns_ip str
An IP address from the IP range defined by platformReservedCidr that will be reserved for the internal DNS server
appSubnetResourceId String
Resource ID of a subnet for control plane infrastructure components. This subnet must be in the same VNET as the subnet defined in appSubnetResourceId. Must not overlap with the IP range defined in platformReservedCidr, if defined.
controlPlaneSubnetResourceId String
Resource ID of a subnet for control plane infrastructure components. This subnet must be in the same VNET as the subnet defined in appSubnetResourceId. Must not overlap with the IP range defined in platformReservedCidr, if defined.
daprAIInstrumentationKey String
Azure Monitor instrumentation key used by Dapr to export Service to Service communication telemetry
dockerBridgeCidr String
CIDR notation IP range assigned to the Docker bridge network. It must not overlap with any Subnet IP ranges or the IP range defined in platformReservedCidr, if defined.
platformReservedCidr String
IP range in CIDR notation that can be reserved for environment infrastructure IP addresses. It must not overlap with any other Subnet IP ranges.
platformReservedDnsIP String
An IP address from the IP range defined by platformReservedCidr that will be reserved for the internal DNS server

ExtendedLocationResponse

Type This property is required. string
Type of extended location.
Name string
Name of extended location.
Type This property is required. string
Type of extended location.
Name string
Name of extended location.
type This property is required. String
Type of extended location.
name String
Name of extended location.
type This property is required. string
Type of extended location.
name string
Name of extended location.
type This property is required. str
Type of extended location.
name str
Name of extended location.
type This property is required. String
Type of extended location.
name String
Name of extended location.

FrontEndConfigurationResponse

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

LogAnalyticsConfigurationResponse

CustomerId string
CustomerId string
customerId String
customerId string
customerId String

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi