Поделиться через


Kube Environments - Create Or Update

Описание для создания или обновления среды Kubernetes.

PUT 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

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

Шаблон регулярного выражения: ^[-\w\._\(\)]+[^\.]$

subscriptionId
path True

string

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

api-version
query True

string

Версия API

Текст запроса

Имя Обязательно Тип Описание
location True

string

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

extendedLocation

ExtendedLocation

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

kind

string

Тип ресурса.

properties.aksResourceID

string

properties.appLogsConfiguration

AppLogsConfiguration

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

properties.arcConfiguration

ArcConfiguration

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

properties.containerAppsConfiguration

ContainerAppsConfiguration

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

properties.environmentType

string

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

properties.internalLoadBalancerEnabled

boolean

Отображается только в виртуальной сети или подсети

properties.staticIp

string

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

tags

object

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

Ответы

Имя Тип Описание
200 OK

KubeEnvironment

ОК

201 Created

KubeEnvironment

Создание

Other Status Codes

DefaultErrorResponse

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

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

azure_auth

Поток OAuth2 в Azure Active Directory

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

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

Примеры

Create kube environments

Образец запроса

PUT https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/examplerg/providers/Microsoft.Web/kubeEnvironments/testkubeenv?api-version=2023-12-01

{
  "location": "East US",
  "properties": {
    "staticIp": "1.2.3.4"
  }
}

Пример ответа

{
  "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/examplerg/providers/Microsoft.Web/kubeEnvironments/testkubeenv",
  "name": "testkubeenv",
  "type": "Microsoft.Web/kubeEnvironments",
  "location": "East US",
  "extendedLocation": {
    "name": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/examplerg/providers/Microsoft.ExtendedLocation/customLocations/testcustomlocation",
    "type": "customLocation"
  },
  "tags": {},
  "properties": {
    "provisioningState": "Succeeded",
    "deploymentErrors": null,
    "internalLoadBalancerEnabled": false,
    "defaultDomain": "testkubeenv.k4apps.io",
    "staticIp": "1.2.3.4",
    "arcConfiguration": null,
    "appLogsConfiguration": null,
    "aksResourceID": "test"
  }
}
{
  "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/examplerg/providers/Microsoft.Web/kubeEnvironments/testkubeenv",
  "name": "testkubeenv",
  "type": "Microsoft.Web/kubeEnvironments",
  "location": "East US",
  "extendedLocation": {
    "name": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/examplerg/providers/Microsoft.ExtendedLocation/customLocations/testcustomlocation",
    "type": "customLocation"
  },
  "tags": {},
  "properties": {
    "provisioningState": "InitializationInProgress",
    "deploymentErrors": null,
    "internalLoadBalancerEnabled": false,
    "defaultDomain": "testkubeenv.k4apps.io",
    "staticIp": "1.2.3.4",
    "arcConfiguration": null,
    "appLogsConfiguration": null,
    "aksResourceID": "test"
  }
}

Определения

Имя Описание
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, интерфейсными артефактами службыStorageType и т. д.

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