Kube Environments - Get

Reference

Service:: App Service

API Version:: 2023-12-01

Description for Get the properties of a Kubernetes Environment.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/kubeEnvironments/{name}?api-version=2023-12-01

URI Parameters

Name	In	Required	Type	Description
name	path	True	string	Name of the Kubernetes Environment.
resourceGroupName	path	True	string	Name of the resource group to which the resource belongs. Regex pattern: `^[-\w\._]+[^\.]$`
subscriptionId	path	True	string	Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
api-version	query	True	string	API Version

Responses

Name	Type	Description
200 OK	KubeEnvironment	OK
Other Status Codes	DefaultErrorResponse	App Service error response.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

Get kube environments by name

Sample Request

HTTP

GET https://management.azure.com/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.Web/kubeEnvironments/jlaw-demo1?api-version=2023-12-01

Sample Response

Status code:: 200

{
  "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.Web/kubeEnvironments/jlaw-demo1",
  "name": "jlaw-demo1",
  "type": "Microsoft.Web/kubeEnvironments",
  "location": "North Central US",
  "extendedLocation": {
    "name": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.ExtendedLocation/customLocations/testcustomlocation",
    "type": "customLocation"
  },
  "tags": {},
  "properties": {
    "provisioningState": "Succeeded",
    "deploymentErrors": null,
    "internalLoadBalancerEnabled": false,
    "defaultDomain": "jlaw-demo1.k4apps.io",
    "staticIp": "20.42.33.145",
    "arcConfiguration": null,
    "appLogsConfiguration": null,
    "aksResourceID": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.ContainerService/managedClusters/jlaw-demo1"
  }
}

Definitions

Name	Description
AppLogsConfiguration
ArcConfiguration
ContainerAppsConfiguration
DefaultErrorResponse	App Service error response.
Details
Error	Error model.
ExtendedLocation	Extended Location.
FrontEndConfiguration
FrontEndServiceType
KubeEnvironment	A Kubernetes cluster specialized for web workloads by Azure App Service
KubeEnvironmentProvisioningState	Provisioning state of the Kubernetes Environment.
LogAnalyticsConfiguration
StorageType

AppLogsConfiguration

Name	Type	Description
destination	string
logAnalyticsConfiguration	LogAnalyticsConfiguration

ArcConfiguration

Name	Type	Description
artifactStorageAccessMode	string
artifactStorageClassName	string
artifactStorageMountPath	string
artifactStorageNodeName	string
artifactsStorageType	StorageType
frontEndServiceConfiguration	FrontEndConfiguration
kubeConfig	string

ContainerAppsConfiguration

Name	Type	Description
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

DefaultErrorResponse

App Service error response.

Name	Type	Description
error	Error	Error model.

Details

Name	Type	Description
code	string	Standardized string to programmatically identify the error.
message	string	Detailed error description and debugging information.
target	string	Detailed error description and debugging information.

Error

Error model.

Name	Type	Description
code	string	Standardized string to programmatically identify the error.
details	Details[]	Detailed errors.
innererror	string	More information to debug error.
message	string	Detailed error description and debugging information.
target	string	Detailed error description and debugging information.

ExtendedLocation

Extended Location.

Name	Type	Description
name	string	Name of extended location.
type	string	Type of extended location.

FrontEndConfiguration

Name	Type	Description
kind	FrontEndServiceType

FrontEndServiceType

Name	Type	Description
LoadBalancer	string
NodePort	string

KubeEnvironment

A Kubernetes cluster specialized for web workloads by Azure App Service

Name	Type	Description
extendedLocation	ExtendedLocation	Extended Location.
id	string	Resource Id.
kind	string	Kind of resource.
location	string	Resource Location.
name	string	Resource Name.
properties.aksResourceID	string
properties.appLogsConfiguration	AppLogsConfiguration	Cluster configuration which enables the log daemon to export app logs to a destination. Currently only "log-analytics" is supported
properties.arcConfiguration	ArcConfiguration	Cluster configuration which determines the ARC cluster components types. Eg: Choosing between BuildService kind, FrontEnd Service ArtifactsStorageType etc.
properties.containerAppsConfiguration	ContainerAppsConfiguration	Cluster configuration for Container Apps Environments to configure Dapr Instrumentation Key and VNET Configuration
properties.defaultDomain	string	Default Domain Name for the cluster
properties.deploymentErrors	string	Any errors that occurred during deployment or deployment validation
properties.environmentType	string	Type of Kubernetes Environment. Only supported for Container App Environments with value as Managed
properties.internalLoadBalancerEnabled	boolean	Only visible within Vnet/Subnet
properties.provisioningState	KubeEnvironmentProvisioningState	Provisioning state of the Kubernetes Environment.
properties.staticIp	string	Static IP of the KubeEnvironment
tags	object	Resource tags.
type	string	Resource type.

KubeEnvironmentProvisioningState

Provisioning state of the Kubernetes Environment.

Name	Type	Description
Canceled	string
Failed	string
InfrastructureSetupComplete	string
InfrastructureSetupInProgress	string
InitializationInProgress	string
ScheduledForDelete	string
Succeeded	string
UpgradeFailed	string
UpgradeRequested	string
Waiting	string

LogAnalyticsConfiguration

Name	Type	Description
customerId	string
sharedKey	string

StorageType

Name	Type	Description
LocalNode	string
NetworkFileSystem	string