Kube Environments - Get

Ссылка

Service:: App Service

API Version:: 2023-12-01

Описание для получения свойств среды Kubernetes.

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
name	path	True	string	Имя среды Kubernetes.
resourceGroupName	path	True	string	Имя группы ресурсов, к которой принадлежит ресурс. Regex pattern: `^[-\w\._]+[^\.]$`
subscriptionId	path	True	string	Идентификатор вашей подписки Azure. Это строка в формате GUID (например, 0000000-0000-0000-0000-0000-000000000000).
api-version	query	True	string	Версия API

Ответы

Имя	Тип	Описание
200 OK	KubeEnvironment	ОК
Other Status Codes	DefaultErrorResponse	Служба приложений ответ об ошибке.

Безопасность

azure_auth

Поток OAuth2 в Azure Active Directory

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

Scopes

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

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

Определения

Имя	Описание
AppLogsConfiguration
ArcConfiguration
ContainerAppsConfiguration
DefaultErrorResponse	Служба приложений ответ об ошибке.
Details
Error	Модель ошибок.
ExtendedLocation	Расширенное расположение.
FrontEndConfiguration
FrontEndServiceType
KubeEnvironment	Кластер Kubernetes, специализированный для веб-рабочих нагрузок Служба приложений Azure
KubeEnvironmentProvisioningState	Состояние подготовки среды Kubernetes.
LogAnalyticsConfiguration
StorageType

AppLogsConfiguration

Имя	Тип	Описание
destination	string
logAnalyticsConfiguration	LogAnalyticsConfiguration

ArcConfiguration

Имя	Тип	Описание
artifactStorageAccessMode	string
artifactStorageClassName	string
artifactStorageMountPath	string
artifactStorageNodeName	string
artifactsStorageType	StorageType
frontEndServiceConfiguration	FrontEndConfiguration
kubeConfig	string

ContainerAppsConfiguration

Имя	Тип	Описание
appSubnetResourceId	string	Идентификатор ресурса подсети для компонентов инфраструктуры уровня управления. Эта подсеть должна находиться в той же виртуальной сети, что и подсеть, определенная в appSubnetResourceId. Не должен перекрываться с диапазоном IP-адресов, определенным в platformReservedCidr, если он определен.
controlPlaneSubnetResourceId	string	Идентификатор ресурса подсети для компонентов инфраструктуры уровня управления. Эта подсеть должна находиться в той же виртуальной сети, что и подсеть, определенная в appSubnetResourceId. Не должен перекрываться с диапазоном IP-адресов, определенным в platformReservedCidr, если он определен.
daprAIInstrumentationKey	string	Ключ инструментирования Azure Monitor, используемый Dapr для экспорта телеметрии связи между службами
dockerBridgeCidr	string	Диапазон IP-адресов нотации CIDR, назначенный сети моста Docker. Он не должен перекрываться с диапазонами IP-адресов подсети или диапазоном IP-адресов, определенным в platformReservedCidr, если он определен.
platformReservedCidr	string	Диапазон IP-адресов в нотации CIDR, который можно зарезервировать для IP-адресов инфраструктуры среды. Он не должен перекрываться с другими диапазонами IP-адресов подсети.
platformReservedDnsIP	string	IP-адрес из диапазона IP-адресов, определенного platformReservedCidr, который будет зарезервирован для внутреннего DNS-сервера.

DefaultErrorResponse

Служба приложений ответ об ошибке.

Имя	Тип	Описание
error	Error	Модель ошибок.

Details

Имя	Тип	Описание
code	string	Стандартизированная строка для программной идентификации ошибки.
message	string	Подробное описание ошибки и сведения об отладке.
target	string	Подробное описание ошибки и сведения об отладке.

Error

Модель ошибок.

Имя	Тип	Описание
code	string	Стандартизированная строка для программной идентификации ошибки.
details	Details[]	Подробные сведения об ошибках.
innererror	string	Дополнительные сведения об ошибке отладки.
message	string	Подробное описание ошибки и сведения об отладке.
target	string	Подробное описание ошибки и сведения об отладке.

ExtendedLocation

Расширенное расположение.

Имя	Тип	Описание
name	string	Имя расширенного расположения.
type	string	Тип расширенного расположения.

FrontEndConfiguration

Имя	Тип	Описание
kind	FrontEndServiceType

FrontEndServiceType

Имя	Тип	Описание
LoadBalancer	string
NodePort	string

KubeEnvironment

Кластер Kubernetes, специализированный для веб-рабочих нагрузок Служба приложений Azure

Имя	Тип	Описание
extendedLocation	ExtendedLocation	Расширенное расположение.
id	string	Идентификатор ресурса.
kind	string	Тип ресурса.
location	string	Расположение ресурса.
name	string	Имя ресурса.
properties.aksResourceID	string
properties.appLogsConfiguration	AppLogsConfiguration	Конфигурация кластера, которая позволяет управляющей программе журнала экспортировать журналы приложений в место назначения. В настоящее время поддерживается только log-Analytics.
properties.arcConfiguration	ArcConfiguration	Конфигурация кластера, определяющая типы компонентов кластера ARC. Например: выбор типа buildService, frontEnd Service ArtifactsStorageType и т. д.
properties.containerAppsConfiguration	ContainerAppsConfiguration	Конфигурация кластера для сред контейнеров приложений для настройки ключа инструментирования Dapr и конфигурации виртуальной сети
properties.defaultDomain	string	Доменное имя по умолчанию для кластера
properties.deploymentErrors	string	Все ошибки, возникшие во время развертывания или проверки развертывания
properties.environmentType	string	Тип среды Kubernetes. Поддерживается только для сред контейнеров приложений со значением Managed
properties.internalLoadBalancerEnabled	boolean	Отображается только в виртуальной сети или подсети
properties.provisioningState	KubeEnvironmentProvisioningState	Состояние подготовки среды Kubernetes.
properties.staticIp	string	Статический IP-адрес KubeEnvironment
tags	object	Теги ресурсов.
type	string	Тип ресурса.

KubeEnvironmentProvisioningState

Состояние подготовки среды Kubernetes.

Имя	Тип	Описание
Canceled	string
Failed	string
InfrastructureSetupComplete	string
InfrastructureSetupInProgress	string
InitializationInProgress	string
ScheduledForDelete	string
Succeeded	string
UpgradeFailed	string
UpgradeRequested	string
Waiting	string

LogAnalyticsConfiguration

Имя	Тип	Описание
customerId	string
sharedKey	string

StorageType

Имя	Тип	Описание
LocalNode	string
NetworkFileSystem	string