Partager via


Kube Environments - Get

Description pour Obtenir les propriétés d’un environnement Kubernetes.

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

Paramètres URI

Nom Dans Obligatoire Type Description
name
path True

string

Nom de l’environnement Kubernetes.

resourceGroupName
path True

string

Nom du groupe de ressources auquel appartient la ressource.

Modèle d’expression régulière: ^[-\w\._\(\)]+[^\.]$

subscriptionId
path True

string

Votre ID d’abonnement Azure. Il s’agit d’une chaîne au format GUID (par exemple, 0000000-0000-0000-0000-000000000000000).

api-version
query True

string

Version d'API

Réponses

Nom Type Description
200 OK

KubeEnvironment

Ok

Other Status Codes

DefaultErrorResponse

App Service réponse d’erreur.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom Description
user_impersonation Emprunter l’identité de votre compte d’utilisateur

Exemples

Get kube environments by name

Exemple de requête

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

Exemple de réponse

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

Définitions

Nom Description
AppLogsConfiguration
ArcConfiguration
ContainerAppsConfiguration
DefaultErrorResponse

App Service réponse d’erreur.

Details
Error

Modèle d’erreur.

ExtendedLocation

Emplacement étendu.

FrontEndConfiguration
FrontEndServiceType
KubeEnvironment

Un cluster Kubernetes spécialisé pour les charges de travail web par Azure App Service

KubeEnvironmentProvisioningState

État d’approvisionnement de l’environnement Kubernetes.

LogAnalyticsConfiguration
StorageType

AppLogsConfiguration

Nom Type Description
destination

string

logAnalyticsConfiguration

LogAnalyticsConfiguration

ArcConfiguration

Nom Type Description
artifactStorageAccessMode

string

artifactStorageClassName

string

artifactStorageMountPath

string

artifactStorageNodeName

string

artifactsStorageType

StorageType

frontEndServiceConfiguration

FrontEndConfiguration

kubeConfig

string

ContainerAppsConfiguration

Nom Type Description
appSubnetResourceId

string

ID de ressource d’un sous-réseau pour les composants d’infrastructure du plan de contrôle. Ce sous-réseau doit se trouver dans le même réseau virtuel que le sous-réseau défini dans appSubnetResourceId. Ne doit pas chevaucher la plage d’adresses IP définie dans platformReservedCidr, si elle est définie.

controlPlaneSubnetResourceId

string

ID de ressource d’un sous-réseau pour les composants d’infrastructure du plan de contrôle. Ce sous-réseau doit se trouver dans le même réseau virtuel que le sous-réseau défini dans appSubnetResourceId. Ne doit pas chevaucher la plage d’adresses IP définie dans platformReservedCidr, si elle est définie.

daprAIInstrumentationKey

string

Clé d’instrumentation Azure Monitor utilisée par Dapr pour exporter les données de télémétrie de communication de service à service

dockerBridgeCidr

string

Plage d’adresses IP de notation CIDR attribuée au réseau de pont Docker. Il ne doit pas chevaucher les plages d’adresses IP de sous-réseau ou la plage d’adresses IP définie dans platformReservedCidr, si elle est définie.

platformReservedCidr

string

Plage d’adresses IP en notation CIDR qui peut être réservée aux adresses IP de l’infrastructure d’environnement. Il ne doit pas chevaucher d’autres plages d’adresses IP de sous-réseau.

platformReservedDnsIP

string

Adresse IP de la plage d’adresses IP définie par platformReservedCidr qui sera réservée au serveur DNS interne

DefaultErrorResponse

App Service réponse d’erreur.

Nom Type Description
error

Error

Modèle d’erreur.

Details

Nom Type Description
code

string

Chaîne standardisée pour identifier l’erreur par programmation.

message

string

Description détaillée de l’erreur et informations de débogage.

target

string

Description détaillée de l’erreur et informations de débogage.

Error

Modèle d’erreur.

Nom Type Description
code

string

Chaîne standardisée pour identifier l’erreur par programmation.

details

Details[]

Erreurs détaillées.

innererror

string

Informations supplémentaires pour déboguer l’erreur.

message

string

Description détaillée de l’erreur et informations de débogage.

target

string

Description détaillée de l’erreur et informations de débogage.

ExtendedLocation

Emplacement étendu.

Nom Type Description
name

string

Nom de l’emplacement étendu.

type

string

Type d’emplacement étendu.

FrontEndConfiguration

Nom Type Description
kind

FrontEndServiceType

FrontEndServiceType

Nom Type Description
LoadBalancer

string

NodePort

string

KubeEnvironment

Un cluster Kubernetes spécialisé pour les charges de travail web par Azure App Service

Nom Type Description
extendedLocation

ExtendedLocation

Emplacement étendu.

id

string

ID de ressource.

kind

string

Type de ressource.

location

string

Emplacement de la ressource.

name

string

Nom de la ressource.

properties.aksResourceID

string

properties.appLogsConfiguration

AppLogsConfiguration

Configuration du cluster qui permet au démon de journal d’exporter les journaux d’application vers une destination. Actuellement, seul « log-analytics » est pris en charge

properties.arcConfiguration

ArcConfiguration

Configuration du cluster qui détermine les types de composants de cluster ARC. Par exemple : choix entre le type BuildService, les artefacts de service frontendStorageType, etc.

properties.containerAppsConfiguration

ContainerAppsConfiguration

Configuration de cluster pour les environnements Container Apps afin de configurer la clé d’instrumentation Dapr et la configuration du réseau virtuel

properties.defaultDomain

string

Nom de domaine par défaut pour le cluster

properties.deploymentErrors

string

Toutes les erreurs qui se sont produites pendant le déploiement ou la validation du déploiement

properties.environmentType

string

Type d’environnement Kubernetes. Pris en charge uniquement pour les environnements d’application conteneur avec la valeur gérée

properties.internalLoadBalancerEnabled

boolean

Visible uniquement dans le réseau virtuel/sous-réseau

properties.provisioningState

KubeEnvironmentProvisioningState

État d’approvisionnement de l’environnement Kubernetes.

properties.staticIp

string

Adresse IP statique de KubeEnvironment

tags

object

Balises de ressource.

type

string

Type de ressource.

KubeEnvironmentProvisioningState

État d’approvisionnement de l’environnement Kubernetes.

Nom Type Description
Canceled

string

Failed

string

InfrastructureSetupComplete

string

InfrastructureSetupInProgress

string

InitializationInProgress

string

ScheduledForDelete

string

Succeeded

string

UpgradeFailed

string

UpgradeRequested

string

Waiting

string

LogAnalyticsConfiguration

Nom Type Description
customerId

string

sharedKey

string

StorageType

Nom Type Description
LocalNode

string

NetworkFileSystem

string