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


Microsoft.HybridContainerService подготовленоClusterInstances 2023-11-15-preview

Определение ресурсов Bicep

Тип ресурса provisionedClusterInstances можно развернуть с помощью операций, целевых:

Список измененных свойств в каждой версии API см. в журнала изменений.

Формат ресурса

Чтобы создать ресурс Microsoft.HybridContainerService/provisionedClusterInstances, добавьте следующий Bicep в шаблон.

resource symbolicname 'Microsoft.HybridContainerService/provisionedClusterInstances@2023-11-15-preview' = {
  scope: resourceSymbolicName or scope
  extendedLocation: {
    name: 'string'
    type: 'string'
  }
  name: 'default'
  properties: {
    agentPoolProfiles: [
      {
        availabilityZones: [
          'string'
        ]
        count: int
        name: 'string'
        nodeImageVersion: 'string'
        osSKU: 'string'
        osType: 'string'
        vmSize: 'string'
      }
    ]
    cloudProviderProfile: {
      infraNetworkProfile: {
        vnetSubnetIds: [
          'string'
        ]
      }
    }
    controlPlane: {
      availabilityZones: [
        'string'
      ]
      controlPlaneEndpoint: {
        hostIP: 'string'
        port: int
      }
      count: int
      linuxProfile: {
        ssh: {
          publicKeys: [
            {
              keyData: 'string'
            }
          ]
        }
      }
      name: 'string'
      nodeImageVersion: 'string'
      osSKU: 'string'
      osType: 'string'
      vmSize: 'string'
    }
    kubernetesVersion: 'string'
    licenseProfile: {
      azureHybridBenefit: 'string'
    }
    linuxProfile: {
      ssh: {
        publicKeys: [
          {
            keyData: 'string'
          }
        ]
      }
    }
    networkProfile: {
      loadBalancerProfile: {
        count: int
      }
      networkPolicy: 'string'
      podCidr: 'string'
    }
  }
}

Значения свойств

CloudProviderProfile

Имя Описание Ценность
infraNetworkProfile InfraNetworkProfile — список профилей инфракрасной сети для подготовленного кластера CloudProviderProfileInfraNetworkProfile

CloudProviderProfileInfraNetworkProfile

Имя Описание Ценность
vnetSubnetIds Массив ссылок на ресурс Azure, соответствующий сетевому объекту, например /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/logicalNetworks/{logicalNetworkName} string[]

ControlPlaneEndpointProfileControlPlaneEndpoint

Имя Описание Ценность
hostIP IP-адрес узла для сервера API струна
порт Порт для сервера API int

ControlPlaneProfile

Имя Описание Ценность
availabilityZones AvailabilityZones — список зон доступности, используемых для узлов. Стойки центра обработки данных, моделируемые как зоны string[]
controlPlaneEndpoint Конечная точка сервера API для уровня управления ControlPlaneEndpointProfileControlPlaneEndpoint
считать Количество агентов для размещения контейнеров Docker. Допустимые значения должны находиться в диапазоне от 1 до 100 (включительно). Значение по умолчанию — 1. int
linuxProfile Профиль виртуальных машин Linux в кластере службы контейнеров. LinuxProfileProperties
имя Уникальное имя профиля пула агентов в контексте подписки и группы ресурсов. струна
nodeImageVersion Версия образа узла струна
osSKU Указывает номер SKU ОС, используемый пулом агентов. Значение по умолчанию — CBLMariner, если OSType — Linux. Значение по умолчанию — Windows2019, если osType — Windows. CBLMariner
"Windows2019"
'Windows2022'
osType Конкретный тип ОС Образа KubernetesVersion (Linux, Windows) Linux
"Windows"
vmSize VmSize — размер виртуальных машин пула агентов. струна

ExtendedLocation

Имя Описание Ценность
имя Имя расширенного расположения. струна
тип Тип расширенного расположения. CustomLocation

LinuxProfileProperties

Имя Описание Ценность
SSH SSH — конфигурация SSH для виртуальных машин под управлением Linux, работающих в Azure. LinuxProfilePropertiesSsh

LinuxProfilePropertiesSsh

Имя Описание Ценность
publicKeys PublicKeys — список открытых ключей SSH, используемых для проверки подлинности с помощью виртуальных машин под управлением Linux. Ожидается только один ключ. LinuxProfilePropertiesSshPublicKeysItem[]

LinuxProfilePropertiesSshPublicKeysItem

Имя Описание Ценность
keyData KeyData — открытый ключ сертификата, используемый для проверки подлинности с помощью SSH виртуальных машин. Сертификат должен быть в формате PEM с заголовками или без него. струна

Microsoft.HybridContainerService/provisionedClusterInstances

Имя Описание Ценность
extendedLocation Определение расширенного расположения ExtendedLocation
имя Имя ресурса "default" (обязательно)
свойства Все свойства подготовленного кластера ProvisionedClusterProperties
размах Используется при создании ресурса в области, отличной от области развертывания. Задайте для этого свойства символьное имя ресурса, чтобы применить ресурс расширения.

NamedAgentPoolProfile

Имя Описание Ценность
availabilityZones AvailabilityZones — список зон доступности, используемых для узлов. Стойки центра обработки данных, моделируемые как зоны string[]
считать Количество агентов для размещения контейнеров Docker. Допустимые значения должны находиться в диапазоне от 1 до 100 (включительно). Значение по умолчанию — 1. int
имя Уникальное имя профиля пула агентов в контексте подписки и группы ресурсов. струна
nodeImageVersion Версия образа узла струна
osSKU Указывает номер SKU ОС, используемый пулом агентов. Значение по умолчанию — CBLMariner, если OSType — Linux. Значение по умолчанию — Windows2019, если osType — Windows. CBLMariner
"Windows2019"
'Windows2022'
osType Конкретный тип ОС Образа KubernetesVersion (Linux, Windows) Linux
"Windows"
vmSize VmSize — размер виртуальных машин пула агентов. струна

NetworkProfile

Имя Описание Ценность
loadBalancerProfile LoadBalancerProfile — профиль подсистемы балансировки нагрузки кластера. NetworkProfileLoadBalancerProfile
networkPolicy NetworkPolicy — политика сети, используемая для создания сети Kubernetes. Возможные значения: "calico", "flannel". По умолчанию используется "calico" 'calico'
'flannel'
podCidr PodCidr — диапазон IP-адресов нотации CIDR, из которого следует назначать IP-адреса pod при использовании kubenet. струна

NetworkProfileLoadBalancerProfile

Имя Описание Ценность
считать Число — количество виртуальных машин подсистемы балансировки нагрузки. Значение по умолчанию — 0. int

ProvisionedClusterLicenseProfile

Имя Описание Ценность
azureHybridBenefit Указывает, включено ли преимущество гибридного использования Azure "False"
NotApplicable
"True"

ProvisionedClusterProperties

Имя Описание Ценность
agentPoolProfiles Пулы агентов кластера. NamedAgentPoolProfile[]
cloudProviderProfile Базовые свойства поставщика инфраструктуры облака. CloudProviderProfile
controlPlane ControlPlane — конфигурация ControlPlane ControlPlaneProfile
kubernetesVersion KubernetesVersion — версия Kubernetes, указанная при создании управляемого кластера. струна
licenseProfile Профиль лицензии подготовленного кластера. ProvisionedClusterLicenseProfile
linuxProfile LinuxProfile — профиль для виртуальных машин Linux в подготовленном кластере. LinuxProfileProperties
networkProfile NetworkProfile — профиль конфигурации сети. NetworkProfile

Примеры использования

Проверенные модули Azure

Следующие проверенные модули Azure можно использовать для развертывания этого типа ресурсов.

Модуль Описание
гибридной службы контейнеров — подготовленного экземпляра кластера Модуль ресурсов AVM для гибридной службы контейнеров — подготовленный экземпляр кластера

Примеры быстрого запуска Azure

Следующие шаблоны быстрого запуска Azure содержат примеры Bicep для развертывания этого типа ресурса.

Bicep-файл Описание
Создание кластера Kubernetes в Azure Stack HCI Этот шаблон создает кластер Kubernetes в Azure Stack HCI версии 23H2+

Определение ресурса шаблона ARM

Тип ресурса provisionedClusterInstances можно развернуть с помощью операций, целевых:

Список измененных свойств в каждой версии API см. в журнала изменений.

Формат ресурса

Чтобы создать ресурс Microsoft.HybridContainerService/provisionedClusterInstances, добавьте следующий код JSON в шаблон.

{
  "type": "Microsoft.HybridContainerService/provisionedClusterInstances",
  "apiVersion": "2023-11-15-preview",
  "name": "string",
  "extendedLocation": {
    "name": "string",
    "type": "string"
  },
  "properties": {
    "agentPoolProfiles": [
      {
        "availabilityZones": [ "string" ],
        "count": "int",
        "name": "string",
        "nodeImageVersion": "string",
        "osSKU": "string",
        "osType": "string",
        "vmSize": "string"
      }
    ],
    "cloudProviderProfile": {
      "infraNetworkProfile": {
        "vnetSubnetIds": [ "string" ]
      }
    },
    "controlPlane": {
      "availabilityZones": [ "string" ],
      "controlPlaneEndpoint": {
        "hostIP": "string",
        "port": "int"
      },
      "count": "int",
      "linuxProfile": {
        "ssh": {
          "publicKeys": [
            {
              "keyData": "string"
            }
          ]
        }
      },
      "name": "string",
      "nodeImageVersion": "string",
      "osSKU": "string",
      "osType": "string",
      "vmSize": "string"
    },
    "kubernetesVersion": "string",
    "licenseProfile": {
      "azureHybridBenefit": "string"
    },
    "linuxProfile": {
      "ssh": {
        "publicKeys": [
          {
            "keyData": "string"
          }
        ]
      }
    },
    "networkProfile": {
      "loadBalancerProfile": {
        "count": "int"
      },
      "networkPolicy": "string",
      "podCidr": "string"
    }
  }
}

Значения свойств

CloudProviderProfile

Имя Описание Ценность
infraNetworkProfile InfraNetworkProfile — список профилей инфракрасной сети для подготовленного кластера CloudProviderProfileInfraNetworkProfile

CloudProviderProfileInfraNetworkProfile

Имя Описание Ценность
vnetSubnetIds Массив ссылок на ресурс Azure, соответствующий сетевому объекту, например /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/logicalNetworks/{logicalNetworkName} string[]

ControlPlaneEndpointProfileControlPlaneEndpoint

Имя Описание Ценность
hostIP IP-адрес узла для сервера API струна
порт Порт для сервера API int

ControlPlaneProfile

Имя Описание Ценность
availabilityZones AvailabilityZones — список зон доступности, используемых для узлов. Стойки центра обработки данных, моделируемые как зоны string[]
controlPlaneEndpoint Конечная точка сервера API для уровня управления ControlPlaneEndpointProfileControlPlaneEndpoint
считать Количество агентов для размещения контейнеров Docker. Допустимые значения должны находиться в диапазоне от 1 до 100 (включительно). Значение по умолчанию — 1. int
linuxProfile Профиль виртуальных машин Linux в кластере службы контейнеров. LinuxProfileProperties
имя Уникальное имя профиля пула агентов в контексте подписки и группы ресурсов. струна
nodeImageVersion Версия образа узла струна
osSKU Указывает номер SKU ОС, используемый пулом агентов. Значение по умолчанию — CBLMariner, если OSType — Linux. Значение по умолчанию — Windows2019, если osType — Windows. CBLMariner
"Windows2019"
'Windows2022'
osType Конкретный тип ОС Образа KubernetesVersion (Linux, Windows) Linux
"Windows"
vmSize VmSize — размер виртуальных машин пула агентов. струна

ExtendedLocation

Имя Описание Ценность
имя Имя расширенного расположения. струна
тип Тип расширенного расположения. CustomLocation

LinuxProfileProperties

Имя Описание Ценность
SSH SSH — конфигурация SSH для виртуальных машин под управлением Linux, работающих в Azure. LinuxProfilePropertiesSsh

LinuxProfilePropertiesSsh

Имя Описание Ценность
publicKeys PublicKeys — список открытых ключей SSH, используемых для проверки подлинности с помощью виртуальных машин под управлением Linux. Ожидается только один ключ. LinuxProfilePropertiesSshPublicKeysItem[]

LinuxProfilePropertiesSshPublicKeysItem

Имя Описание Ценность
keyData KeyData — открытый ключ сертификата, используемый для проверки подлинности с помощью SSH виртуальных машин. Сертификат должен быть в формате PEM с заголовками или без него. струна

Microsoft.HybridContainerService/provisionedClusterInstances

Имя Описание Ценность
apiVersion Версия API '2023-11-15-preview'
extendedLocation Определение расширенного расположения ExtendedLocation
имя Имя ресурса "default" (обязательно)
свойства Все свойства подготовленного кластера ProvisionedClusterProperties
тип Тип ресурса "Microsoft.HybridContainerService/provisionedClusterInstances"

NamedAgentPoolProfile

Имя Описание Ценность
availabilityZones AvailabilityZones — список зон доступности, используемых для узлов. Стойки центра обработки данных, моделируемые как зоны string[]
считать Количество агентов для размещения контейнеров Docker. Допустимые значения должны находиться в диапазоне от 1 до 100 (включительно). Значение по умолчанию — 1. int
имя Уникальное имя профиля пула агентов в контексте подписки и группы ресурсов. струна
nodeImageVersion Версия образа узла струна
osSKU Указывает номер SKU ОС, используемый пулом агентов. Значение по умолчанию — CBLMariner, если OSType — Linux. Значение по умолчанию — Windows2019, если osType — Windows. CBLMariner
"Windows2019"
'Windows2022'
osType Конкретный тип ОС Образа KubernetesVersion (Linux, Windows) Linux
"Windows"
vmSize VmSize — размер виртуальных машин пула агентов. струна

NetworkProfile

Имя Описание Ценность
loadBalancerProfile LoadBalancerProfile — профиль подсистемы балансировки нагрузки кластера. NetworkProfileLoadBalancerProfile
networkPolicy NetworkPolicy — политика сети, используемая для создания сети Kubernetes. Возможные значения: "calico", "flannel". По умолчанию используется "calico" 'calico'
'flannel'
podCidr PodCidr — диапазон IP-адресов нотации CIDR, из которого следует назначать IP-адреса pod при использовании kubenet. струна

NetworkProfileLoadBalancerProfile

Имя Описание Ценность
считать Число — количество виртуальных машин подсистемы балансировки нагрузки. Значение по умолчанию — 0. int

ProvisionedClusterLicenseProfile

Имя Описание Ценность
azureHybridBenefit Указывает, включено ли преимущество гибридного использования Azure "False"
NotApplicable
"True"

ProvisionedClusterProperties

Имя Описание Ценность
agentPoolProfiles Пулы агентов кластера. NamedAgentPoolProfile[]
cloudProviderProfile Базовые свойства поставщика инфраструктуры облака. CloudProviderProfile
controlPlane ControlPlane — конфигурация ControlPlane ControlPlaneProfile
kubernetesVersion KubernetesVersion — версия Kubernetes, указанная при создании управляемого кластера. струна
licenseProfile Профиль лицензии подготовленного кластера. ProvisionedClusterLicenseProfile
linuxProfile LinuxProfile — профиль для виртуальных машин Linux в подготовленном кластере. LinuxProfileProperties
networkProfile NetworkProfile — профиль конфигурации сети. NetworkProfile

Примеры использования

Шаблоны быстрого запуска Azure

Следующие шаблоны быстрого запуска Azure развернуть этот тип ресурса.

Шаблон Описание
Создание кластера Kubernetes в Azure Stack HCI

развертывание в Azure
Этот шаблон создает кластер Kubernetes в Azure Stack HCI версии 23H2+

Определение ресурса Terraform (поставщик AzAPI)

Тип ресурса provisionedClusterInstances можно развернуть с помощью операций, целевых:

Список измененных свойств в каждой версии API см. в журнала изменений.

Формат ресурса

Чтобы создать ресурс Microsoft.HybridContainerService/provisionedClusterInstances, добавьте следующий объект Terraform в шаблон.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.HybridContainerService/provisionedClusterInstances@2023-11-15-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    extendedLocation = {
      name = "string"
      type = "string"
    }
    properties = {
      agentPoolProfiles = [
        {
          availabilityZones = [
            "string"
          ]
          count = int
          name = "string"
          nodeImageVersion = "string"
          osSKU = "string"
          osType = "string"
          vmSize = "string"
        }
      ]
      cloudProviderProfile = {
        infraNetworkProfile = {
          vnetSubnetIds = [
            "string"
          ]
        }
      }
      controlPlane = {
        availabilityZones = [
          "string"
        ]
        controlPlaneEndpoint = {
          hostIP = "string"
          port = int
        }
        count = int
        linuxProfile = {
          ssh = {
            publicKeys = [
              {
                keyData = "string"
              }
            ]
          }
        }
        name = "string"
        nodeImageVersion = "string"
        osSKU = "string"
        osType = "string"
        vmSize = "string"
      }
      kubernetesVersion = "string"
      licenseProfile = {
        azureHybridBenefit = "string"
      }
      linuxProfile = {
        ssh = {
          publicKeys = [
            {
              keyData = "string"
            }
          ]
        }
      }
      networkProfile = {
        loadBalancerProfile = {
          count = int
        }
        networkPolicy = "string"
        podCidr = "string"
      }
    }
  })
}

Значения свойств

CloudProviderProfile

Имя Описание Ценность
infraNetworkProfile InfraNetworkProfile — список профилей инфракрасной сети для подготовленного кластера CloudProviderProfileInfraNetworkProfile

CloudProviderProfileInfraNetworkProfile

Имя Описание Ценность
vnetSubnetIds Массив ссылок на ресурс Azure, соответствующий сетевому объекту, например /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/logicalNetworks/{logicalNetworkName} string[]

ControlPlaneEndpointProfileControlPlaneEndpoint

Имя Описание Ценность
hostIP IP-адрес узла для сервера API струна
порт Порт для сервера API int

ControlPlaneProfile

Имя Описание Ценность
availabilityZones AvailabilityZones — список зон доступности, используемых для узлов. Стойки центра обработки данных, моделируемые как зоны string[]
controlPlaneEndpoint Конечная точка сервера API для уровня управления ControlPlaneEndpointProfileControlPlaneEndpoint
считать Количество агентов для размещения контейнеров Docker. Допустимые значения должны находиться в диапазоне от 1 до 100 (включительно). Значение по умолчанию — 1. int
linuxProfile Профиль виртуальных машин Linux в кластере службы контейнеров. LinuxProfileProperties
имя Уникальное имя профиля пула агентов в контексте подписки и группы ресурсов. струна
nodeImageVersion Версия образа узла струна
osSKU Указывает номер SKU ОС, используемый пулом агентов. Значение по умолчанию — CBLMariner, если OSType — Linux. Значение по умолчанию — Windows2019, если osType — Windows. CBLMariner
"Windows2019"
'Windows2022'
osType Конкретный тип ОС Образа KubernetesVersion (Linux, Windows) Linux
"Windows"
vmSize VmSize — размер виртуальных машин пула агентов. струна

ExtendedLocation

Имя Описание Ценность
имя Имя расширенного расположения. струна
тип Тип расширенного расположения. CustomLocation

LinuxProfileProperties

Имя Описание Ценность
SSH SSH — конфигурация SSH для виртуальных машин под управлением Linux, работающих в Azure. LinuxProfilePropertiesSsh

LinuxProfilePropertiesSsh

Имя Описание Ценность
publicKeys PublicKeys — список открытых ключей SSH, используемых для проверки подлинности с помощью виртуальных машин под управлением Linux. Ожидается только один ключ. LinuxProfilePropertiesSshPublicKeysItem[]

LinuxProfilePropertiesSshPublicKeysItem

Имя Описание Ценность
keyData KeyData — открытый ключ сертификата, используемый для проверки подлинности с помощью SSH виртуальных машин. Сертификат должен быть в формате PEM с заголовками или без него. струна

Microsoft.HybridContainerService/provisionedClusterInstances

Имя Описание Ценность
extendedLocation Определение расширенного расположения ExtendedLocation
имя Имя ресурса "default" (обязательно)
parent_id Идентификатор ресурса для применения этого ресурса расширения. строка (обязательно)
свойства Все свойства подготовленного кластера ProvisionedClusterProperties
тип Тип ресурса "Microsoft.HybridContainerService/provisionedClusterInstances@2023-11-15-preview"

NamedAgentPoolProfile

Имя Описание Ценность
availabilityZones AvailabilityZones — список зон доступности, используемых для узлов. Стойки центра обработки данных, моделируемые как зоны string[]
считать Количество агентов для размещения контейнеров Docker. Допустимые значения должны находиться в диапазоне от 1 до 100 (включительно). Значение по умолчанию — 1. int
имя Уникальное имя профиля пула агентов в контексте подписки и группы ресурсов. струна
nodeImageVersion Версия образа узла струна
osSKU Указывает номер SKU ОС, используемый пулом агентов. Значение по умолчанию — CBLMariner, если OSType — Linux. Значение по умолчанию — Windows2019, если osType — Windows. CBLMariner
"Windows2019"
'Windows2022'
osType Конкретный тип ОС Образа KubernetesVersion (Linux, Windows) Linux
"Windows"
vmSize VmSize — размер виртуальных машин пула агентов. струна

NetworkProfile

Имя Описание Ценность
loadBalancerProfile LoadBalancerProfile — профиль подсистемы балансировки нагрузки кластера. NetworkProfileLoadBalancerProfile
networkPolicy NetworkPolicy — политика сети, используемая для создания сети Kubernetes. Возможные значения: "calico", "flannel". По умолчанию используется "calico" 'calico'
'flannel'
podCidr PodCidr — диапазон IP-адресов нотации CIDR, из которого следует назначать IP-адреса pod при использовании kubenet. струна

NetworkProfileLoadBalancerProfile

Имя Описание Ценность
считать Число — количество виртуальных машин подсистемы балансировки нагрузки. Значение по умолчанию — 0. int

ProvisionedClusterLicenseProfile

Имя Описание Ценность
azureHybridBenefit Указывает, включено ли преимущество гибридного использования Azure "False"
NotApplicable
"True"

ProvisionedClusterProperties

Имя Описание Ценность
agentPoolProfiles Пулы агентов кластера. NamedAgentPoolProfile[]
cloudProviderProfile Базовые свойства поставщика инфраструктуры облака. CloudProviderProfile
controlPlane ControlPlane — конфигурация ControlPlane ControlPlaneProfile
kubernetesVersion KubernetesVersion — версия Kubernetes, указанная при создании управляемого кластера. струна
licenseProfile Профиль лицензии подготовленного кластера. ProvisionedClusterLicenseProfile
linuxProfile LinuxProfile — профиль для виртуальных машин Linux в подготовленном кластере. LinuxProfileProperties
networkProfile NetworkProfile — профиль конфигурации сети. NetworkProfile

Примеры использования

Проверенные модули Azure

Следующие проверенные модули Azure можно использовать для развертывания этого типа ресурсов.

Модуль Описание
AKS Arc Модуль ресурсов AVM для AKS Arc