次の方法で共有


Microsoft.HybridContainerService provisionedClusterInstances 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 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/logicalNetworks/{logicalNetworkName} など、ネットワーク オブジェクトに対応する Azure リソースへの参照の配列 string[]

ControlPlaneEndpointProfileControlPlaneEndpoint

名前 形容 価値
hostIP API サーバーのホスト IP アドレス
API サーバーのポート int

ControlPlaneProfile

名前 形容 価値
availabilityZones AvailabilityZones - ノードに使用する可用性ゾーンの一覧。 ゾーンとしてモデル化されたデータセンター ラック string[]
controlPlaneEndpoint コントロール プレーンの API サーバー エンドポイント ControlPlaneEndpointProfileControlPlaneEndpoint
数える Count - Docker コンテナーをホストするエージェントの数。 使用できる値は、1 ~ 100 (両端を含む) の範囲である必要があります。 既定値は 1 です。 int
linuxProfile コンテナー サービス クラスター内の Linux VM のプロファイル。 LinuxProfileProperties
名前 サブスクリプションとリソース グループのコンテキストにおけるエージェント プール プロファイルの一意の名前。
nodeImageVersion ノード イメージのバージョン
osSKU エージェント プールで使用される OS SKU を指定します。 OSType が Linux の場合、既定値は CBLMariner です。 OSType が Windows の場合、既定値は Windows2019 です。 'CBLMariner'
'Windows2019'
'Windows2022'
osType 特定の KubernetesVersion のイメージの OS の種類 (Linux、Windows) 'Linux'
'Windows'
vmSize VmSize - エージェント プール VM のサイズ。

ExtendedLocation

名前 形容 価値
名前 拡張された場所の名前。
種類 拡張された場所の種類。 'CustomLocation'

LinuxProfileProperties

名前 形容 価値
ssh SSH - Azure で実行されている Linux ベースの VM の SSH 構成。 LinuxProfilePropertiesSsh の

LinuxProfilePropertiesSsh

名前 形容 価値
publicKeys PublicKeys - Linux ベースの VM での認証に使用される SSH 公開キーの一覧。 指定するキーは 1 つだけです。 LinuxProfilePropertiesSshPublicKeysItem[]

LinuxProfilePropertiesSshPublicKeysItem

名前 形容 価値
keyData KeyData - SSH 経由で VM で認証するために使用される証明書公開キー。 証明書は、ヘッダーの有無にかかわらず PEM 形式である必要があります。

Microsoft.HybridContainerService/provisionedClusterInstances

名前 形容 価値
extendedLocation 拡張場所の定義 ExtendedLocation の
名前 リソース名 'default' (必須)
プロパティ プロビジョニングされたクラスターのすべてのプロパティ ProvisionedClusterProperties
スコープ デプロイ スコープとは異なるスコープでリソースを作成するときに使用します。 このプロパティをリソースのシンボリック名に設定して、拡張リソースを適用します。

NamedAgentPoolProfile

名前 形容 価値
availabilityZones AvailabilityZones - ノードに使用する可用性ゾーンの一覧。 ゾーンとしてモデル化されたデータセンター ラック string[]
数える Count - Docker コンテナーをホストするエージェントの数。 使用できる値は、1 ~ 100 (両端を含む) の範囲である必要があります。 既定値は 1 です。 int
名前 サブスクリプションとリソース グループのコンテキストにおけるエージェント プール プロファイルの一意の名前。
nodeImageVersion ノード イメージのバージョン
osSKU エージェント プールで使用される OS SKU を指定します。 OSType が Linux の場合、既定値は CBLMariner です。 OSType が Windows の場合、既定値は Windows2019 です。 'CBLMariner'
'Windows2019'
'Windows2022'
osType 特定の KubernetesVersion のイメージの OS の種類 (Linux、Windows) 'Linux'
'Windows'
vmSize VmSize - エージェント プール VM のサイズ。

NetworkProfile

名前 形容 価値
loadBalancerProfile LoadBalancerProfile - クラスター ロード バランサーのプロファイル。 NetworkProfileLoadBalancerProfile
networkPolicy NetworkPolicy - Kubernetes ネットワークの構築に使用されるネットワーク ポリシー。 指定できる値は、'calico'、'flannel' です。 既定値は 'calico' です 'calico'
'flannel'
podCidr PodCidr - kubenet の使用時にポッド IP を割り当てる CIDR 表記 IP 範囲。

NetworkProfileLoadBalancerProfile

名前 形容 価値
数える Count - ロード バランサー VM の数。 既定値は 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 VM のプロファイル。 LinuxProfileProperties
networkProfile NetworkProfile - ネットワーク構成のプロファイル。 NetworkProfile

クイック スタートのサンプル

次のクイック スタート サンプルでは、このリソースの種類をデプロイします。

Bicep ファイル 形容
Azure Stack HCI で Kubernetes クラスターを作成する このテンプレートは、Azure Stack HCI バージョン 23H2 以降に Kubernetes クラスターを作成します

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 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/logicalNetworks/{logicalNetworkName} など、ネットワーク オブジェクトに対応する Azure リソースへの参照の配列 string[]

ControlPlaneEndpointProfileControlPlaneEndpoint

名前 形容 価値
hostIP API サーバーのホスト IP アドレス
API サーバーのポート int

ControlPlaneProfile

名前 形容 価値
availabilityZones AvailabilityZones - ノードに使用する可用性ゾーンの一覧。 ゾーンとしてモデル化されたデータセンター ラック string[]
controlPlaneEndpoint コントロール プレーンの API サーバー エンドポイント ControlPlaneEndpointProfileControlPlaneEndpoint
数える Count - Docker コンテナーをホストするエージェントの数。 使用できる値は、1 ~ 100 (両端を含む) の範囲である必要があります。 既定値は 1 です。 int
linuxProfile コンテナー サービス クラスター内の Linux VM のプロファイル。 LinuxProfileProperties
名前 サブスクリプションとリソース グループのコンテキストにおけるエージェント プール プロファイルの一意の名前。
nodeImageVersion ノード イメージのバージョン
osSKU エージェント プールで使用される OS SKU を指定します。 OSType が Linux の場合、既定値は CBLMariner です。 OSType が Windows の場合、既定値は Windows2019 です。 'CBLMariner'
'Windows2019'
'Windows2022'
osType 特定の KubernetesVersion のイメージの OS の種類 (Linux、Windows) 'Linux'
'Windows'
vmSize VmSize - エージェント プール VM のサイズ。

ExtendedLocation

名前 形容 価値
名前 拡張された場所の名前。
種類 拡張された場所の種類。 'CustomLocation'

LinuxProfileProperties

名前 形容 価値
ssh SSH - Azure で実行されている Linux ベースの VM の SSH 構成。 LinuxProfilePropertiesSsh の

LinuxProfilePropertiesSsh

名前 形容 価値
publicKeys PublicKeys - Linux ベースの VM での認証に使用される SSH 公開キーの一覧。 指定するキーは 1 つだけです。 LinuxProfilePropertiesSshPublicKeysItem[]

LinuxProfilePropertiesSshPublicKeysItem

名前 形容 価値
keyData KeyData - SSH 経由で VM で認証するために使用される証明書公開キー。 証明書は、ヘッダーの有無にかかわらず PEM 形式である必要があります。

Microsoft.HybridContainerService/provisionedClusterInstances

名前 形容 価値
apiVersion API のバージョン '2023-11-15-preview'
extendedLocation 拡張場所の定義 ExtendedLocation の
名前 リソース名 'default' (必須)
プロパティ プロビジョニングされたクラスターのすべてのプロパティ ProvisionedClusterProperties
種類 リソースの種類 'Microsoft.HybridContainerService/provisionedClusterInstances'

NamedAgentPoolProfile

名前 形容 価値
availabilityZones AvailabilityZones - ノードに使用する可用性ゾーンの一覧。 ゾーンとしてモデル化されたデータセンター ラック string[]
数える Count - Docker コンテナーをホストするエージェントの数。 使用できる値は、1 ~ 100 (両端を含む) の範囲である必要があります。 既定値は 1 です。 int
名前 サブスクリプションとリソース グループのコンテキストにおけるエージェント プール プロファイルの一意の名前。
nodeImageVersion ノード イメージのバージョン
osSKU エージェント プールで使用される OS SKU を指定します。 OSType が Linux の場合、既定値は CBLMariner です。 OSType が Windows の場合、既定値は Windows2019 です。 'CBLMariner'
'Windows2019'
'Windows2022'
osType 特定の KubernetesVersion のイメージの OS の種類 (Linux、Windows) 'Linux'
'Windows'
vmSize VmSize - エージェント プール VM のサイズ。

NetworkProfile

名前 形容 価値
loadBalancerProfile LoadBalancerProfile - クラスター ロード バランサーのプロファイル。 NetworkProfileLoadBalancerProfile
networkPolicy NetworkPolicy - Kubernetes ネットワークの構築に使用されるネットワーク ポリシー。 指定できる値は、'calico'、'flannel' です。 既定値は 'calico' です 'calico'
'flannel'
podCidr PodCidr - kubenet の使用時にポッド IP を割り当てる CIDR 表記 IP 範囲。

NetworkProfileLoadBalancerProfile

名前 形容 価値
数える Count - ロード バランサー VM の数。 既定値は 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 VM のプロファイル。 LinuxProfileProperties
networkProfile NetworkProfile - ネットワーク構成のプロファイル。 NetworkProfile

クイック スタート テンプレート

次のクイック スタート テンプレートでは、このリソースの種類をデプロイします。

テンプレート 形容
Azure Stack HCI で Kubernetes クラスターを作成する

Azure にデプロイする
このテンプレートは、Azure Stack HCI バージョン 23H2 以降に Kubernetes クラスターを作成します

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 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/logicalNetworks/{logicalNetworkName} など、ネットワーク オブジェクトに対応する Azure リソースへの参照の配列 string[]

ControlPlaneEndpointProfileControlPlaneEndpoint

名前 形容 価値
hostIP API サーバーのホスト IP アドレス
API サーバーのポート int

ControlPlaneProfile

名前 形容 価値
availabilityZones AvailabilityZones - ノードに使用する可用性ゾーンの一覧。 ゾーンとしてモデル化されたデータセンター ラック string[]
controlPlaneEndpoint コントロール プレーンの API サーバー エンドポイント ControlPlaneEndpointProfileControlPlaneEndpoint
数える Count - Docker コンテナーをホストするエージェントの数。 使用できる値は、1 ~ 100 (両端を含む) の範囲である必要があります。 既定値は 1 です。 int
linuxProfile コンテナー サービス クラスター内の Linux VM のプロファイル。 LinuxProfileProperties
名前 サブスクリプションとリソース グループのコンテキストにおけるエージェント プール プロファイルの一意の名前。
nodeImageVersion ノード イメージのバージョン
osSKU エージェント プールで使用される OS SKU を指定します。 OSType が Linux の場合、既定値は CBLMariner です。 OSType が Windows の場合、既定値は Windows2019 です。 'CBLMariner'
'Windows2019'
'Windows2022'
osType 特定の KubernetesVersion のイメージの OS の種類 (Linux、Windows) 'Linux'
'Windows'
vmSize VmSize - エージェント プール VM のサイズ。

ExtendedLocation

名前 形容 価値
名前 拡張された場所の名前。
種類 拡張された場所の種類。 'CustomLocation'

LinuxProfileProperties

名前 形容 価値
ssh SSH - Azure で実行されている Linux ベースの VM の SSH 構成。 LinuxProfilePropertiesSsh の

LinuxProfilePropertiesSsh

名前 形容 価値
publicKeys PublicKeys - Linux ベースの VM での認証に使用される SSH 公開キーの一覧。 指定するキーは 1 つだけです。 LinuxProfilePropertiesSshPublicKeysItem[]

LinuxProfilePropertiesSshPublicKeysItem

名前 形容 価値
keyData KeyData - SSH 経由で VM で認証するために使用される証明書公開キー。 証明書は、ヘッダーの有無にかかわらず PEM 形式である必要があります。

Microsoft.HybridContainerService/provisionedClusterInstances

名前 形容 価値
extendedLocation 拡張場所の定義 ExtendedLocation の
名前 リソース名 'default' (必須)
parent_id この拡張リソースを適用するリソースの ID。 string (必須)
プロパティ プロビジョニングされたクラスターのすべてのプロパティ ProvisionedClusterProperties
種類 リソースの種類 "Microsoft.HybridContainerService/provisionedClusterInstances@2023-11-15-preview"

NamedAgentPoolProfile

名前 形容 価値
availabilityZones AvailabilityZones - ノードに使用する可用性ゾーンの一覧。 ゾーンとしてモデル化されたデータセンター ラック string[]
数える Count - Docker コンテナーをホストするエージェントの数。 使用できる値は、1 ~ 100 (両端を含む) の範囲である必要があります。 既定値は 1 です。 int
名前 サブスクリプションとリソース グループのコンテキストにおけるエージェント プール プロファイルの一意の名前。
nodeImageVersion ノード イメージのバージョン
osSKU エージェント プールで使用される OS SKU を指定します。 OSType が Linux の場合、既定値は CBLMariner です。 OSType が Windows の場合、既定値は Windows2019 です。 'CBLMariner'
'Windows2019'
'Windows2022'
osType 特定の KubernetesVersion のイメージの OS の種類 (Linux、Windows) 'Linux'
'Windows'
vmSize VmSize - エージェント プール VM のサイズ。

NetworkProfile

名前 形容 価値
loadBalancerProfile LoadBalancerProfile - クラスター ロード バランサーのプロファイル。 NetworkProfileLoadBalancerProfile
networkPolicy NetworkPolicy - Kubernetes ネットワークの構築に使用されるネットワーク ポリシー。 指定できる値は、'calico'、'flannel' です。 既定値は 'calico' です 'calico'
'flannel'
podCidr PodCidr - kubenet の使用時にポッド IP を割り当てる CIDR 表記 IP 範囲。

NetworkProfileLoadBalancerProfile

名前 形容 価値
数える Count - ロード バランサー VM の数。 既定値は 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 VM のプロファイル。 LinuxProfileProperties
networkProfile NetworkProfile - ネットワーク構成のプロファイル。 NetworkProfile