Partager via


Microsoft.HybridContainerService provisionedClusterInstances 2023-11-15-preview

Définition de ressource Bicep

Le type de ressource provisionedClusterInstances peut être déployé avec des opérations qui ciblent :

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format de ressource

Pour créer une ressource Microsoft.HybridContainerService/provisionedClusterInstances, ajoutez le bicep suivant à votre modèle.

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

Valeurs de propriété

CloudProviderProfile

Nom Description Valeur
infraNetworkProfile InfraNetworkProfile - Liste des profils de réseau infra pour le cluster approvisionné CloudProviderProfileInfraNetworkProfile

CloudProviderProfileInfraNetworkProfile

Nom Description Valeur
vnetSubnetIds Tableau de références à la ressource Azure correspondant à l’objet Réseau, par exemple /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/logicalNetworks/{logicalNetworkName} string[]

ControlPlaneEndpointProfileControlPlaneEndpoint

Nom Description Valeur
hostIP Adresse IP de l’hôte pour le serveur d’API corde
port Port pour le serveur d’API Int

ControlPlaneProfile

Nom Description Valeur
availabilityZones AvailabilityZones : liste des zones de disponibilité à utiliser pour les nœuds. Racks de centres de données modélisés en tant que zones string[]
controlPlaneEndpoint Point de terminaison du serveur d’API pour le plan de contrôle ControlPlaneEndpointProfileControlPlaneEndpoint
compter Nombre d’agents pour héberger des conteneurs Docker. Les valeurs autorisées doivent être comprises entre 1 et 100 (inclus). La valeur par défaut est 1. Int
linuxProfile Profil des machines virtuelles Linux dans le cluster de service de conteneur. LinuxProfileProperties
nom Nom unique du profil du pool d’agents dans le contexte de l’abonnement et du groupe de ressources. corde
nodeImageVersion Version de l’image de nœud corde
osSKU Spécifie la référence SKU du système d’exploitation utilisée par le pool d’agents. La valeur par défaut est CBLMarinr si OSType est Linux. La valeur par défaut est Windows2019 quand OSType est Windows. 'CBLMarinr'
'Windows2019'
'Windows2022'
osType Type de système d’exploitation de l’image KubernetesVersion particulier (Linux, Windows) 'Linux'
'Windows'
vmSize VmSize : taille des machines virtuelles du pool d’agents. corde

ExtendedLocation

Nom Description Valeur
nom Nom de l’emplacement étendu. corde
type Type d’emplacement étendu. 'CustomLocation'

LinuxProfileProperties

Nom Description Valeur
ssh SSH - Configuration SSH pour les machines virtuelles Linux s’exécutant sur Azure. LinuxProfilePropertiesSsh

LinuxProfilePropertiesSsh

Nom Description Valeur
publicKeys PublicKeys : liste des clés publiques SSH utilisées pour s’authentifier auprès des machines virtuelles Linux. Attendez-vous qu’une seule clé soit spécifiée. LinuxProfilePropertiesSshPublicKeysItem[]

LinuxProfilePropertiesSshPublicKeysItem

Nom Description Valeur
keyData KeyData : clé publique de certificat utilisée pour s’authentifier auprès de machines virtuelles via SSH. Le certificat doit être au format PEM avec ou sans en-têtes. corde

Microsoft.HybridContainerService/provisionedClusterInstances

Nom Description Valeur
extendedLocation Définition d’emplacement étendu ExtendedLocation
nom Nom de la ressource 'default' (obligatoire)
Propriétés Toutes les propriétés du cluster provisionné ProvisionedClusterProperties
portée Utilisez-la lors de la création d’une ressource dans une étendue différente de l’étendue de déploiement. Définissez cette propriété sur le nom symbolique d’une ressource pour appliquer la ressource d’extension .

NamedAgentPoolProfile

Nom Description Valeur
availabilityZones AvailabilityZones : liste des zones de disponibilité à utiliser pour les nœuds. Racks de centres de données modélisés en tant que zones string[]
compter Nombre d’agents pour héberger des conteneurs Docker. Les valeurs autorisées doivent être comprises entre 1 et 100 (inclus). La valeur par défaut est 1. Int
nom Nom unique du profil du pool d’agents dans le contexte de l’abonnement et du groupe de ressources. corde
nodeImageVersion Version de l’image de nœud corde
osSKU Spécifie la référence SKU du système d’exploitation utilisée par le pool d’agents. La valeur par défaut est CBLMarinr si OSType est Linux. La valeur par défaut est Windows2019 quand OSType est Windows. 'CBLMarinr'
'Windows2019'
'Windows2022'
osType Type de système d’exploitation de l’image KubernetesVersion particulier (Linux, Windows) 'Linux'
'Windows'
vmSize VmSize : taille des machines virtuelles du pool d’agents. corde

NetworkProfile

Nom Description Valeur
loadBalancerProfile LoadBalancerProfile - Profil de l’équilibreur de charge du cluster. NetworkProfileLoadBalancerProfile
networkPolicy NetworkPolicy : stratégie réseau utilisée pour créer un réseau Kubernetes. Les valeurs possibles sont les suivantes : « calico », « flannel ». La valeur par défaut est « calico » 'calico'
'flannel'
podCidr PodCidr : plage d’adresses IP de notation CIDR à partir de laquelle affecter des adresses IP de pod lorsque kubenet est utilisé. corde

NetworkProfileLoadBalancerProfile

Nom Description Valeur
compter Nombre de machines virtuelles de l’équilibreur de charge. La valeur par défaut est 0. Int

ProvisionedClusterLicenseProfile

Nom Description Valeur
azureHybridBenefit Indique si Azure Hybrid Benefit est choisi 'False'
'NotApplicable'
'True'

ProvisionedClusterProperties

Nom Description Valeur
agentPoolProfiles Pools d’agents du cluster. NamedAgentPoolProfile[]
cloudProviderProfile Propriétés du fournisseur d’infrastructure cloud sous-jacentes. CloudProviderProfile
controlPlane ControlPlane - ControlPlane Configuration ControlPlaneProfile
kubernetesVersion KubernetesVersion : version de Kubernetes spécifiée lors de la création du cluster managé. corde
licenseProfile Profil de licence du cluster approvisionné. ProvisionedClusterLicenseProfile
linuxProfile LinuxProfile : profil pour les machines virtuelles Linux dans le cluster approvisionné. LinuxProfileProperties
networkProfile NetworkProfile - Profil de la configuration réseau. NetworkProfile

Exemples de démarrage rapide

Les exemples de démarrage rapide suivants déploient ce type de ressource.

Fichier Bicep Description
Créer un cluster Kubernetes sur Azure Stack HCI Ce modèle crée un cluster Kubernetes sur Azure Stack HCI version 23H2+

Définition de ressource de modèle ARM

Le type de ressource provisionedClusterInstances peut être déployé avec des opérations qui ciblent :

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format de ressource

Pour créer une ressource Microsoft.HybridContainerService/provisionedClusterInstances, ajoutez le code JSON suivant à votre modèle.

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

Valeurs de propriété

CloudProviderProfile

Nom Description Valeur
infraNetworkProfile InfraNetworkProfile - Liste des profils de réseau infra pour le cluster approvisionné CloudProviderProfileInfraNetworkProfile

CloudProviderProfileInfraNetworkProfile

Nom Description Valeur
vnetSubnetIds Tableau de références à la ressource Azure correspondant à l’objet Réseau, par exemple /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/logicalNetworks/{logicalNetworkName} string[]

ControlPlaneEndpointProfileControlPlaneEndpoint

Nom Description Valeur
hostIP Adresse IP de l’hôte pour le serveur d’API corde
port Port pour le serveur d’API Int

ControlPlaneProfile

Nom Description Valeur
availabilityZones AvailabilityZones : liste des zones de disponibilité à utiliser pour les nœuds. Racks de centres de données modélisés en tant que zones string[]
controlPlaneEndpoint Point de terminaison du serveur d’API pour le plan de contrôle ControlPlaneEndpointProfileControlPlaneEndpoint
compter Nombre d’agents pour héberger des conteneurs Docker. Les valeurs autorisées doivent être comprises entre 1 et 100 (inclus). La valeur par défaut est 1. Int
linuxProfile Profil des machines virtuelles Linux dans le cluster de service de conteneur. LinuxProfileProperties
nom Nom unique du profil du pool d’agents dans le contexte de l’abonnement et du groupe de ressources. corde
nodeImageVersion Version de l’image de nœud corde
osSKU Spécifie la référence SKU du système d’exploitation utilisée par le pool d’agents. La valeur par défaut est CBLMarinr si OSType est Linux. La valeur par défaut est Windows2019 quand OSType est Windows. 'CBLMarinr'
'Windows2019'
'Windows2022'
osType Type de système d’exploitation de l’image KubernetesVersion particulier (Linux, Windows) 'Linux'
'Windows'
vmSize VmSize : taille des machines virtuelles du pool d’agents. corde

ExtendedLocation

Nom Description Valeur
nom Nom de l’emplacement étendu. corde
type Type d’emplacement étendu. 'CustomLocation'

LinuxProfileProperties

Nom Description Valeur
ssh SSH - Configuration SSH pour les machines virtuelles Linux s’exécutant sur Azure. LinuxProfilePropertiesSsh

LinuxProfilePropertiesSsh

Nom Description Valeur
publicKeys PublicKeys : liste des clés publiques SSH utilisées pour s’authentifier auprès des machines virtuelles Linux. Attendez-vous qu’une seule clé soit spécifiée. LinuxProfilePropertiesSshPublicKeysItem[]

LinuxProfilePropertiesSshPublicKeysItem

Nom Description Valeur
keyData KeyData : clé publique de certificat utilisée pour s’authentifier auprès de machines virtuelles via SSH. Le certificat doit être au format PEM avec ou sans en-têtes. corde

Microsoft.HybridContainerService/provisionedClusterInstances

Nom Description Valeur
apiVersion Version de l’API '2023-11-15-preview'
extendedLocation Définition d’emplacement étendu ExtendedLocation
nom Nom de la ressource 'default' (obligatoire)
Propriétés Toutes les propriétés du cluster provisionné ProvisionedClusterProperties
type Type de ressource 'Microsoft.HybridContainerService/provisionedClusterInstances'

NamedAgentPoolProfile

Nom Description Valeur
availabilityZones AvailabilityZones : liste des zones de disponibilité à utiliser pour les nœuds. Racks de centres de données modélisés en tant que zones string[]
compter Nombre d’agents pour héberger des conteneurs Docker. Les valeurs autorisées doivent être comprises entre 1 et 100 (inclus). La valeur par défaut est 1. Int
nom Nom unique du profil du pool d’agents dans le contexte de l’abonnement et du groupe de ressources. corde
nodeImageVersion Version de l’image de nœud corde
osSKU Spécifie la référence SKU du système d’exploitation utilisée par le pool d’agents. La valeur par défaut est CBLMarinr si OSType est Linux. La valeur par défaut est Windows2019 quand OSType est Windows. 'CBLMarinr'
'Windows2019'
'Windows2022'
osType Type de système d’exploitation de l’image KubernetesVersion particulier (Linux, Windows) 'Linux'
'Windows'
vmSize VmSize : taille des machines virtuelles du pool d’agents. corde

NetworkProfile

Nom Description Valeur
loadBalancerProfile LoadBalancerProfile - Profil de l’équilibreur de charge du cluster. NetworkProfileLoadBalancerProfile
networkPolicy NetworkPolicy : stratégie réseau utilisée pour créer un réseau Kubernetes. Les valeurs possibles sont les suivantes : « calico », « flannel ». La valeur par défaut est « calico » 'calico'
'flannel'
podCidr PodCidr : plage d’adresses IP de notation CIDR à partir de laquelle affecter des adresses IP de pod lorsque kubenet est utilisé. corde

NetworkProfileLoadBalancerProfile

Nom Description Valeur
compter Nombre de machines virtuelles de l’équilibreur de charge. La valeur par défaut est 0. Int

ProvisionedClusterLicenseProfile

Nom Description Valeur
azureHybridBenefit Indique si Azure Hybrid Benefit est choisi 'False'
'NotApplicable'
'True'

ProvisionedClusterProperties

Nom Description Valeur
agentPoolProfiles Pools d’agents du cluster. NamedAgentPoolProfile[]
cloudProviderProfile Propriétés du fournisseur d’infrastructure cloud sous-jacentes. CloudProviderProfile
controlPlane ControlPlane - ControlPlane Configuration ControlPlaneProfile
kubernetesVersion KubernetesVersion : version de Kubernetes spécifiée lors de la création du cluster managé. corde
licenseProfile Profil de licence du cluster approvisionné. ProvisionedClusterLicenseProfile
linuxProfile LinuxProfile : profil pour les machines virtuelles Linux dans le cluster approvisionné. LinuxProfileProperties
networkProfile NetworkProfile - Profil de la configuration réseau. NetworkProfile

Modèles de démarrage rapide

Les modèles de démarrage rapide suivants déploient ce type de ressource.

Modèle Description
Créer un cluster Kubernetes sur Azure Stack HCI

Déployer sur Azure
Ce modèle crée un cluster Kubernetes sur Azure Stack HCI version 23H2+

Définition de ressource Terraform (fournisseur AzAPI)

Le type de ressource provisionedClusterInstances peut être déployé avec des opérations qui ciblent :

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format de ressource

Pour créer une ressource Microsoft.HybridContainerService/provisionedClusterInstances, ajoutez terraform suivante à votre modèle.

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

Valeurs de propriété

CloudProviderProfile

Nom Description Valeur
infraNetworkProfile InfraNetworkProfile - Liste des profils de réseau infra pour le cluster approvisionné CloudProviderProfileInfraNetworkProfile

CloudProviderProfileInfraNetworkProfile

Nom Description Valeur
vnetSubnetIds Tableau de références à la ressource Azure correspondant à l’objet Réseau, par exemple /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/logicalNetworks/{logicalNetworkName} string[]

ControlPlaneEndpointProfileControlPlaneEndpoint

Nom Description Valeur
hostIP Adresse IP de l’hôte pour le serveur d’API corde
port Port pour le serveur d’API Int

ControlPlaneProfile

Nom Description Valeur
availabilityZones AvailabilityZones : liste des zones de disponibilité à utiliser pour les nœuds. Racks de centres de données modélisés en tant que zones string[]
controlPlaneEndpoint Point de terminaison du serveur d’API pour le plan de contrôle ControlPlaneEndpointProfileControlPlaneEndpoint
compter Nombre d’agents pour héberger des conteneurs Docker. Les valeurs autorisées doivent être comprises entre 1 et 100 (inclus). La valeur par défaut est 1. Int
linuxProfile Profil des machines virtuelles Linux dans le cluster de service de conteneur. LinuxProfileProperties
nom Nom unique du profil du pool d’agents dans le contexte de l’abonnement et du groupe de ressources. corde
nodeImageVersion Version de l’image de nœud corde
osSKU Spécifie la référence SKU du système d’exploitation utilisée par le pool d’agents. La valeur par défaut est CBLMarinr si OSType est Linux. La valeur par défaut est Windows2019 quand OSType est Windows. 'CBLMarinr'
'Windows2019'
'Windows2022'
osType Type de système d’exploitation de l’image KubernetesVersion particulier (Linux, Windows) 'Linux'
'Windows'
vmSize VmSize : taille des machines virtuelles du pool d’agents. corde

ExtendedLocation

Nom Description Valeur
nom Nom de l’emplacement étendu. corde
type Type d’emplacement étendu. 'CustomLocation'

LinuxProfileProperties

Nom Description Valeur
ssh SSH - Configuration SSH pour les machines virtuelles Linux s’exécutant sur Azure. LinuxProfilePropertiesSsh

LinuxProfilePropertiesSsh

Nom Description Valeur
publicKeys PublicKeys : liste des clés publiques SSH utilisées pour s’authentifier auprès des machines virtuelles Linux. Attendez-vous qu’une seule clé soit spécifiée. LinuxProfilePropertiesSshPublicKeysItem[]

LinuxProfilePropertiesSshPublicKeysItem

Nom Description Valeur
keyData KeyData : clé publique de certificat utilisée pour s’authentifier auprès de machines virtuelles via SSH. Le certificat doit être au format PEM avec ou sans en-têtes. corde

Microsoft.HybridContainerService/provisionedClusterInstances

Nom Description Valeur
extendedLocation Définition d’emplacement étendu ExtendedLocation
nom Nom de la ressource 'default' (obligatoire)
parent_id ID de la ressource à laquelle appliquer cette ressource d’extension. chaîne (obligatoire)
Propriétés Toutes les propriétés du cluster provisionné ProvisionedClusterProperties
type Type de ressource « Microsoft.HybridContainerService/provisionedClusterInstances@2023-11-15-preview »

NamedAgentPoolProfile

Nom Description Valeur
availabilityZones AvailabilityZones : liste des zones de disponibilité à utiliser pour les nœuds. Racks de centres de données modélisés en tant que zones string[]
compter Nombre d’agents pour héberger des conteneurs Docker. Les valeurs autorisées doivent être comprises entre 1 et 100 (inclus). La valeur par défaut est 1. Int
nom Nom unique du profil du pool d’agents dans le contexte de l’abonnement et du groupe de ressources. corde
nodeImageVersion Version de l’image de nœud corde
osSKU Spécifie la référence SKU du système d’exploitation utilisée par le pool d’agents. La valeur par défaut est CBLMarinr si OSType est Linux. La valeur par défaut est Windows2019 quand OSType est Windows. 'CBLMarinr'
'Windows2019'
'Windows2022'
osType Type de système d’exploitation de l’image KubernetesVersion particulier (Linux, Windows) 'Linux'
'Windows'
vmSize VmSize : taille des machines virtuelles du pool d’agents. corde

NetworkProfile

Nom Description Valeur
loadBalancerProfile LoadBalancerProfile - Profil de l’équilibreur de charge du cluster. NetworkProfileLoadBalancerProfile
networkPolicy NetworkPolicy : stratégie réseau utilisée pour créer un réseau Kubernetes. Les valeurs possibles sont les suivantes : « calico », « flannel ». La valeur par défaut est « calico » 'calico'
'flannel'
podCidr PodCidr : plage d’adresses IP de notation CIDR à partir de laquelle affecter des adresses IP de pod lorsque kubenet est utilisé. corde

NetworkProfileLoadBalancerProfile

Nom Description Valeur
compter Nombre de machines virtuelles de l’équilibreur de charge. La valeur par défaut est 0. Int

ProvisionedClusterLicenseProfile

Nom Description Valeur
azureHybridBenefit Indique si Azure Hybrid Benefit est choisi 'False'
'NotApplicable'
'True'

ProvisionedClusterProperties

Nom Description Valeur
agentPoolProfiles Pools d’agents du cluster. NamedAgentPoolProfile[]
cloudProviderProfile Propriétés du fournisseur d’infrastructure cloud sous-jacentes. CloudProviderProfile
controlPlane ControlPlane - ControlPlane Configuration ControlPlaneProfile
kubernetesVersion KubernetesVersion : version de Kubernetes spécifiée lors de la création du cluster managé. corde
licenseProfile Profil de licence du cluster approvisionné. ProvisionedClusterLicenseProfile
linuxProfile LinuxProfile : profil pour les machines virtuelles Linux dans le cluster approvisionné. LinuxProfileProperties
networkProfile NetworkProfile - Profil de la configuration réseau. NetworkProfile