Kube Environments - Get

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

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

Параметры URI

Name In Required Type Description
name
path True
  • string

Имя среды Kubernetes.

resourceGroupName
path True
  • string

Имя группы ресурсов, к которой принадлежит ресурс.

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

subscriptionId
path True
  • string

Идентификатор вашей подписки Azure. Это строка в формате GUID (например, 000000000-0000-0000-0000-0000-000000000000000).

api-version
query True
  • string

Версия API

Ответы

Name Type Description
200 OK

ОК

Other Status Codes

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

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

azure_auth

Поток OAuth2 Azure Active Directory

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

Scopes

Name Description
user_impersonation олицетворения учетной записи пользователя

Примеры

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

Определения

AppLogsConfiguration
ArcConfiguration
ContainerAppsConfiguration
DefaultErrorResponse

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

Details
Error

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

ExtendedLocation

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

FrontEndConfiguration
FrontEndServiceType
KubeEnvironment

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

KubeEnvironmentProvisioningState

Состояние подготовки среды 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

Идентификатор ресурса подсети для компонентов инфраструктуры уровня управления. Эта подсеть должна находиться в той же виртуальной сети, что и подсеть, определенная в 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-адресов, определенный платформойReservedCidr, который будет зарезервирован для внутреннего DNS-сервера.

DefaultErrorResponse

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

Name Type Description
error

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

Details

Name Type Description
code
  • string

Стандартизованная строка для программной идентификации ошибки.

message
  • string

Подробные сведения об ошибке и сведения об отладке.

target
  • string

Подробные сведения об ошибке и сведения об отладке.

Error

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

Name Type Description
code
  • string

Стандартизованная строка для программной идентификации ошибки.

details

Подробные ошибки.

innererror
  • string

Дополнительные сведения об ошибке отладки.

message
  • string

Подробные сведения об ошибке и сведения об отладке.

target
  • string

Подробные сведения об ошибке и сведения об отладке.

ExtendedLocation

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

Name Type Description
name
  • string

Имя расширенного расположения.

type
  • string

Тип расширенного расположения.

FrontEndConfiguration

Name Type Description
kind

FrontEndServiceType

Name Type Description
LoadBalancer
  • string
NodePort
  • string

KubeEnvironment

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

Name Type Description
extendedLocation

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

id
  • string

Идентификатор ресурса.

kind
  • string

Тип ресурса.

location
  • string

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

name
  • string

Имя ресурса.

properties.aksResourceID
  • string
properties.appLogsConfiguration

Конфигурация кластера, которая позволяет управляющей программе журнала экспортировать журналы приложений в место назначения. Сейчас поддерживается только log-analytics.

properties.arcConfiguration

Конфигурация кластера, определяющая типы компонентов кластера ARC. Например: выбор между типом BuildService, артефактами службы FrontEndsStorageType и т. д.

properties.containerAppsConfiguration

Конфигурация кластера для сред контейнерных приложений для настройки ключа инструментирования Dapr и конфигурации виртуальной сети

properties.defaultDomain
  • string

Доменное имя по умолчанию для кластера

properties.deploymentErrors
  • string

Все ошибки, возникшие во время развертывания или проверки развертывания

properties.environmentType
  • string

Тип среды Kubernetes. Поддерживается только для сред контейнерных приложений со значением "Управляемый"

properties.internalLoadBalancerEnabled
  • boolean

Видимый только в виртуальной сети или подсети

properties.provisioningState

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

properties.staticIp
  • string

Статический IP-адрес KubeEnvironment

tags
  • object

Теги ресурсов.

type
  • string

Тип ресурса.

KubeEnvironmentProvisioningState

Состояние подготовки среды 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