Kube Environments - Get

Descripción para obtener las propiedades de un entorno de Kubernetes.

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

Parámetros de identificador URI

Name In Required Type Description
name
path True
  • string

Nombre del entorno de Kubernetes.

resourceGroupName
path True
  • string

Nombre del grupo de recursos al que pertenece el recurso.

Regex pattern: ^[-\w\._\(\)]+[^\.]$

subscriptionId
path True
  • string

Su identificador de suscripción de Azure. Se trata de una cadena con formato GUID (por ejemplo, 000000000-0000-0000-0000-000000000000000).

api-version
query True
  • string

Versión de la API

Respuestas

Name Type Description
200 OK

Aceptar

Other Status Codes

App Service respuesta de error.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory

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

Scopes

Name Description
user_impersonation suplantar la cuenta de usuario

Ejemplos

Get kube environments by name

Sample Request

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

Sample Response

{
  "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"
  }
}

Definiciones

AppLogsConfiguration
ArcConfiguration
ContainerAppsConfiguration
DefaultErrorResponse

App Service respuesta de error.

Details
Error

Modelo de error.

ExtendedLocation

Ubicación extendida.

FrontEndConfiguration
FrontEndServiceType
KubeEnvironment

Un clúster de Kubernetes especializado para cargas de trabajo web mediante Azure App Service

KubeEnvironmentProvisioningState

Estado de aprovisionamiento del entorno de Kubernetes.

LogAnalyticsConfiguration
StorageType

AppLogsConfiguration

Name Type Description
destination
  • string
logAnalyticsConfiguration

ArcConfiguration

Name Type Description
artifactStorageAccessMode
  • string
artifactStorageClassName
  • string
artifactStorageMountPath
  • string
artifactStorageNodeName
  • string
artifactsStorageType
frontEndServiceConfiguration
kubeConfig
  • string

ContainerAppsConfiguration

Name Type Description
appSubnetResourceId
  • string

Identificador de recurso de una subred para los componentes de infraestructura del plano de control. Esta subred debe estar en la misma red virtual que la subred definida en appSubnetResourceId. No debe superponerse con el intervalo IP definido en platformReservedCidr, si se define.

controlPlaneSubnetResourceId
  • string

Identificador de recurso de una subred para los componentes de infraestructura del plano de control. Esta subred debe estar en la misma red virtual que la subred definida en appSubnetResourceId. No debe superponerse con el intervalo IP definido en platformReservedCidr, si se define.

daprAIInstrumentationKey
  • string

Clave de instrumentación de Azure Monitor usada por Dapr para exportar la telemetría de comunicación del servicio al servicio

dockerBridgeCidr
  • string

Intervalo IP de notación CIDR asignado a la red del puente de Docker. No debe superponerse con ningún intervalo IP de subred o el intervalo IP definido en platformReservedCidr, si se define.

platformReservedCidr
  • string

Intervalo IP en notación CIDR que se puede reservar para direcciones IP de infraestructura de entorno. No debe superponerse con ningún otro intervalo IP de subred.

platformReservedDnsIP
  • string

Una dirección IP del intervalo IP definido por platformReservedCidr que se reservará para el servidor DNS interno.

DefaultErrorResponse

App Service respuesta de error.

Name Type Description
error

Modelo de error.

Details

Name Type Description
code
  • string

Cadena estandarizada para identificar mediante programación el error.

message
  • string

Descripción detallada del error e información de depuración.

target
  • string

Descripción detallada del error e información de depuración.

Error

Modelo de error.

Name Type Description
code
  • string

Cadena estandarizada para identificar mediante programación el error.

details

Errores detallados.

innererror
  • string

Más información para depurar el error.

message
  • string

Descripción detallada del error e información de depuración.

target
  • string

Descripción detallada del error e información de depuración.

ExtendedLocation

Ubicación extendida.

Name Type Description
name
  • string

Nombre de la ubicación extendida.

type
  • string

Tipo de ubicación extendida.

FrontEndConfiguration

Name Type Description
kind

FrontEndServiceType

Name Type Description
LoadBalancer
  • string
NodePort
  • string

KubeEnvironment

Un clúster de Kubernetes especializado para cargas de trabajo web mediante Azure App Service

Name Type Description
extendedLocation

Ubicación extendida.

id
  • string

Identificador de recurso.

kind
  • string

Tipo de recurso.

location
  • string

Ubicación del recurso.

name
  • string

Nombre del recurso.

properties.aksResourceID
  • string
properties.appLogsConfiguration

Configuración del clúster que permite que el demonio de registro exporte los registros de la aplicación a un destino. Actualmente solo se admite "log-analytics"

properties.arcConfiguration

Configuración del clúster que determina los tipos de componentes del clúster de ARC. Por ejemplo: Elegir entre el tipo BuildService, los artefactos del servicio FrontEndStorageType, etc.

properties.containerAppsConfiguration

Configuración del clúster para entornos de Container Apps para configurar la clave de instrumentación de Dapr y la configuración de red virtual

properties.defaultDomain
  • string

Nombre de dominio predeterminado para el clúster

properties.deploymentErrors
  • string

Errores que se produjeron durante la implementación o validación de la implementación

properties.environmentType
  • string

Tipo de entorno de Kubernetes. Solo se admite para los entornos de aplicación de contenedor con el valor como administrado

properties.internalLoadBalancerEnabled
  • boolean

Solo visible dentro de la red virtual o subred

properties.provisioningState

Estado de aprovisionamiento del entorno de Kubernetes.

properties.staticIp
  • string

Dirección IP estática del entorno de KubeEnvironment

tags
  • object

Etiquetas del recurso.

type
  • string

Tipo de recurso.

KubeEnvironmentProvisioningState

Estado de aprovisionamiento del entorno de Kubernetes.

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