Microsoft.RedHatOpenShift/openShiftClusters 2023-11-22 - Bicep, ARM template & Terraform AzAPI reference

Définition de ressource Bicep

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

groupes de ressources - Consultez commandes de déploiement de groupes de ressources

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.RedHatOpenShift/openShiftClusters, ajoutez le bicep suivant à votre modèle.

resource symbolicname 'Microsoft.RedHatOpenShift/openShiftClusters@2023-11-22' = {
  location: 'string'
  name: 'string'
  properties: {
    apiserverProfile: {
      visibility: 'string'
    }
    clusterProfile: {
      domain: 'string'
      fipsValidatedModules: 'string'
      pullSecret: 'string'
      resourceGroupId: 'string'
      version: 'string'
    }
    consoleProfile: {}
    ingressProfiles: [
      {
        name: 'string'
        visibility: 'string'
      }
    ]
    masterProfile: {
      diskEncryptionSetId: 'string'
      encryptionAtHost: 'string'
      subnetId: 'string'
      vmSize: 'string'
    }
    networkProfile: {
      loadBalancerProfile: {
        managedOutboundIps: {
          count: int
        }
      }
      outboundType: 'string'
      podCidr: 'string'
      preconfiguredNSG: 'string'
      serviceCidr: 'string'
    }
    provisioningState: 'string'
    servicePrincipalProfile: {
      clientId: 'string'
      clientSecret: 'string'
    }
    workerProfiles: [
      {
        count: int
        diskEncryptionSetId: 'string'
        diskSizeGB: int
        encryptionAtHost: 'string'
        name: 'string'
        subnetId: 'string'
        vmSize: 'string'
      }
    ]
  }
  tags: {
    {customized property}: 'string'
  }
}

Valeurs de propriété

APIServerProfile

Nom	Description	Valeur
visibilité	Visibilité du serveur d’API.	'Private' 'Public'

ClusterProfile

Nom	Description	Valeur
domaine	Domaine du cluster.	corde
fipsValidatedModules	Si les modules de chiffrement validés FIPS sont utilisés	'Désactivé' 'Activé'
pullSecret	Secret d’extraction pour le cluster.	corde
resourceGroupId	ID du groupe de ressources de cluster.	corde
Version	Version du cluster.	corde

ConsoleProfile

Nom	Description	Valeur

IngressProfile

Nom	Description	Valeur
nom	Nom du profil d’entrée.	corde
visibilité	Visibilité de l’entrée.	'Private' 'Public'

LoadBalancerProfile

Nom	Description	Valeur
managedOutboundIps	Adresses IP sortantes gérées souhaitées pour l’équilibreur de charge public du cluster.	ManagedOutboundIPs

Adresses IP sortantes managées

Nom	Description	Valeur
compter	Le nombre représente le nombre souhaité d’adresses IP sortantes IPv4 créées et gérées par Azure pour l’équilibreur de charge public du cluster. Les valeurs autorisées sont comprises entre 1 et 20. La valeur par défaut est 1.	Int

MasterProfile

Nom	Description	Valeur
diskEncryptionSetId	ID de ressource d’un DiskEncryptionSet associé, le cas échéant.	corde
encryptionAtHost	Indique si les machines virtuelles principales sont chiffrées sur l’hôte.	'Désactivé' 'Activé'
subnetId	ID de ressource Azure du sous-réseau maître.	corde
vmSize	Taille des machines virtuelles principales.	corde

Microsoft.RedHatOpenShift/openShiftClusters

Nom	Description	Valeur
emplacement	Emplacement géographique où réside la ressource	chaîne (obligatoire)
nom	Nom de la ressource	chaîne (obligatoire)
Propriétés	Propriétés du cluster.	OpenShiftClusterProperties
étiquettes	Balises de ressource	Dictionnaire de noms et de valeurs d’étiquettes. Consultez les balises dans les modèles

NetworkProfile

Nom	Description	Valeur
loadBalancerProfile	Profil de l’équilibreur de charge du cluster.	LoadBalancerProfile
outboundType	OutboundType utilisé pour le trafic de sortie.	'Loadbalancer' 'UserDefinedRouting'
podCidr	CIDR utilisé pour les pods OpenShift/Kubernetes.	corde
préconfiguréNSG	Spécifie si les sous-réseaux sont pré-attachés à un groupe de sécurité réseau	'Désactivé' 'Activé'
serviceCidr	CIDR utilisé pour OpenShift/Kubernetes Services.	corde

OpenShiftClusterProperties

Nom	Description	Valeur
apiserverProfile	Profil du serveur d’API de cluster.	APIServerProfile
clusterProfile	Profil de cluster.	ClusterProfile
consoleProfile	Profil de console.	consoleProfile
ingressProfiles	Profils d’entrée de cluster.	IngressProfile[]
masterProfile	Profil principal du cluster.	masterProfile
networkProfile	Profil réseau du cluster.	NetworkProfile
provisioningState	État d’approvisionnement du cluster.	'AdminUpdating' 'Annulé' 'Création' 'Suppression' 'Échec' 'Réussi' 'Mise à jour'
servicePrincipalProfile	Profil du principal du service de cluster.	ServicePrincipalProfile
workerProfiles	Profils de travail du cluster.	WorkerProfile[]

ServicePrincipalProfile

Nom	Description	Valeur
clientId	ID client utilisé pour le cluster.	corde
clientSecret	Clé secrète client utilisée pour le cluster.	corde

TrackedResourceTags

Nom	Description	Valeur

WorkerProfile

Nom	Description	Valeur
compter	Nombre de machines virtuelles de travail.	Int
diskEncryptionSetId	ID de ressource d’un DiskEncryptionSet associé, le cas échéant.	corde
diskSizeGB	Taille du disque des machines virtuelles worker.	Int
encryptionAtHost	Indique si les machines virtuelles principales sont chiffrées sur l’hôte.	'Désactivé' 'Activé'
nom	Nom du profil de travail.	corde
subnetId	ID de ressource Azure du sous-réseau worker.	corde
vmSize	Taille des machines virtuelles worker.	corde

Définition de ressource de modèle ARM

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

groupes de ressources - Consultez commandes de déploiement de groupes de ressources

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.RedHatOpenShift/openShiftClusters, ajoutez le code JSON suivant à votre modèle.

{
  "type": "Microsoft.RedHatOpenShift/openShiftClusters",
  "apiVersion": "2023-11-22",
  "name": "string",
  "location": "string",
  "properties": {
    "apiserverProfile": {
      "visibility": "string"
    },
    "clusterProfile": {
      "domain": "string",
      "fipsValidatedModules": "string",
      "pullSecret": "string",
      "resourceGroupId": "string",
      "version": "string"
    },
    "consoleProfile": {
    },
    "ingressProfiles": [
      {
        "name": "string",
        "visibility": "string"
      }
    ],
    "masterProfile": {
      "diskEncryptionSetId": "string",
      "encryptionAtHost": "string",
      "subnetId": "string",
      "vmSize": "string"
    },
    "networkProfile": {
      "loadBalancerProfile": {
        "managedOutboundIps": {
          "count": "int"
        }
      },
      "outboundType": "string",
      "podCidr": "string",
      "preconfiguredNSG": "string",
      "serviceCidr": "string"
    },
    "provisioningState": "string",
    "servicePrincipalProfile": {
      "clientId": "string",
      "clientSecret": "string"
    },
    "workerProfiles": [
      {
        "count": "int",
        "diskEncryptionSetId": "string",
        "diskSizeGB": "int",
        "encryptionAtHost": "string",
        "name": "string",
        "subnetId": "string",
        "vmSize": "string"
      }
    ]
  },
  "tags": {
    "{customized property}": "string"
  }
}

Valeurs de propriété

APIServerProfile

Nom	Description	Valeur
visibilité	Visibilité du serveur d’API.	'Private' 'Public'

ClusterProfile

Nom	Description	Valeur
domaine	Domaine du cluster.	corde
fipsValidatedModules	Si les modules de chiffrement validés FIPS sont utilisés	'Désactivé' 'Activé'
pullSecret	Secret d’extraction pour le cluster.	corde
resourceGroupId	ID du groupe de ressources de cluster.	corde
Version	Version du cluster.	corde

ConsoleProfile

Nom	Description	Valeur

IngressProfile

Nom	Description	Valeur
nom	Nom du profil d’entrée.	corde
visibilité	Visibilité de l’entrée.	'Private' 'Public'

LoadBalancerProfile

Nom	Description	Valeur
managedOutboundIps	Adresses IP sortantes gérées souhaitées pour l’équilibreur de charge public du cluster.	ManagedOutboundIPs

Adresses IP sortantes managées

Nom	Description	Valeur
compter	Le nombre représente le nombre souhaité d’adresses IP sortantes IPv4 créées et gérées par Azure pour l’équilibreur de charge public du cluster. Les valeurs autorisées sont comprises entre 1 et 20. La valeur par défaut est 1.	Int

MasterProfile

Nom	Description	Valeur
diskEncryptionSetId	ID de ressource d’un DiskEncryptionSet associé, le cas échéant.	corde
encryptionAtHost	Indique si les machines virtuelles principales sont chiffrées sur l’hôte.	'Désactivé' 'Activé'
subnetId	ID de ressource Azure du sous-réseau maître.	corde
vmSize	Taille des machines virtuelles principales.	corde

Microsoft.RedHatOpenShift/openShiftClusters

Nom	Description	Valeur
apiVersion	Version de l’API	'2023-11-22'
emplacement	Emplacement géographique où réside la ressource	chaîne (obligatoire)
nom	Nom de la ressource	chaîne (obligatoire)
Propriétés	Propriétés du cluster.	OpenShiftClusterProperties
étiquettes	Balises de ressource	Dictionnaire de noms et de valeurs d’étiquettes. Consultez les balises dans les modèles
type	Type de ressource	'Microsoft.RedHatOpenShift/openShiftClusters'

NetworkProfile

Nom	Description	Valeur
loadBalancerProfile	Profil de l’équilibreur de charge du cluster.	LoadBalancerProfile
outboundType	OutboundType utilisé pour le trafic de sortie.	'Loadbalancer' 'UserDefinedRouting'
podCidr	CIDR utilisé pour les pods OpenShift/Kubernetes.	corde
préconfiguréNSG	Spécifie si les sous-réseaux sont pré-attachés à un groupe de sécurité réseau	'Désactivé' 'Activé'
serviceCidr	CIDR utilisé pour OpenShift/Kubernetes Services.	corde

OpenShiftClusterProperties

Nom	Description	Valeur
apiserverProfile	Profil du serveur d’API de cluster.	APIServerProfile
clusterProfile	Profil de cluster.	ClusterProfile
consoleProfile	Profil de console.	consoleProfile
ingressProfiles	Profils d’entrée de cluster.	IngressProfile[]
masterProfile	Profil principal du cluster.	masterProfile
networkProfile	Profil réseau du cluster.	NetworkProfile
provisioningState	État d’approvisionnement du cluster.	'AdminUpdating' 'Annulé' 'Création' 'Suppression' 'Échec' 'Réussi' 'Mise à jour'
servicePrincipalProfile	Profil du principal du service de cluster.	ServicePrincipalProfile
workerProfiles	Profils de travail du cluster.	WorkerProfile[]

ServicePrincipalProfile

Nom	Description	Valeur
clientId	ID client utilisé pour le cluster.	corde
clientSecret	Clé secrète client utilisée pour le cluster.	corde

TrackedResourceTags

Nom	Description	Valeur

WorkerProfile

Nom	Description	Valeur
compter	Nombre de machines virtuelles de travail.	Int
diskEncryptionSetId	ID de ressource d’un DiskEncryptionSet associé, le cas échéant.	corde
diskSizeGB	Taille du disque des machines virtuelles worker.	Int
encryptionAtHost	Indique si les machines virtuelles principales sont chiffrées sur l’hôte.	'Désactivé' 'Activé'
nom	Nom du profil de travail.	corde
subnetId	ID de ressource Azure du sous-réseau worker.	corde
vmSize	Taille des machines virtuelles worker.	corde

Définition de ressource Terraform (fournisseur AzAPI)

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

groupes de ressources

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.RedHatOpenShift/openShiftClusters, ajoutez la terraform suivante à votre modèle.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.RedHatOpenShift/openShiftClusters@2023-11-22"
  name = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      apiserverProfile = {
        visibility = "string"
      }
      clusterProfile = {
        domain = "string"
        fipsValidatedModules = "string"
        pullSecret = "string"
        resourceGroupId = "string"
        version = "string"
      }
      consoleProfile = {
      }
      ingressProfiles = [
        {
          name = "string"
          visibility = "string"
        }
      ]
      masterProfile = {
        diskEncryptionSetId = "string"
        encryptionAtHost = "string"
        subnetId = "string"
        vmSize = "string"
      }
      networkProfile = {
        loadBalancerProfile = {
          managedOutboundIps = {
            count = int
          }
        }
        outboundType = "string"
        podCidr = "string"
        preconfiguredNSG = "string"
        serviceCidr = "string"
      }
      provisioningState = "string"
      servicePrincipalProfile = {
        clientId = "string"
        clientSecret = "string"
      }
      workerProfiles = [
        {
          count = int
          diskEncryptionSetId = "string"
          diskSizeGB = int
          encryptionAtHost = "string"
          name = "string"
          subnetId = "string"
          vmSize = "string"
        }
      ]
    }
  })
}

Valeurs de propriété

APIServerProfile

Nom	Description	Valeur
visibilité	Visibilité du serveur d’API.	'Private' 'Public'

ClusterProfile

Nom	Description	Valeur
domaine	Domaine du cluster.	corde
fipsValidatedModules	Si les modules de chiffrement validés FIPS sont utilisés	'Désactivé' 'Activé'
pullSecret	Secret d’extraction pour le cluster.	corde
resourceGroupId	ID du groupe de ressources de cluster.	corde
Version	Version du cluster.	corde

ConsoleProfile

Nom	Description	Valeur

IngressProfile

Nom	Description	Valeur
nom	Nom du profil d’entrée.	corde
visibilité	Visibilité de l’entrée.	'Private' 'Public'

LoadBalancerProfile

Nom	Description	Valeur
managedOutboundIps	Adresses IP sortantes gérées souhaitées pour l’équilibreur de charge public du cluster.	ManagedOutboundIPs

Adresses IP sortantes managées

Nom	Description	Valeur
compter	Le nombre représente le nombre souhaité d’adresses IP sortantes IPv4 créées et gérées par Azure pour l’équilibreur de charge public du cluster. Les valeurs autorisées sont comprises entre 1 et 20. La valeur par défaut est 1.	Int

MasterProfile

Nom	Description	Valeur
diskEncryptionSetId	ID de ressource d’un DiskEncryptionSet associé, le cas échéant.	corde
encryptionAtHost	Indique si les machines virtuelles principales sont chiffrées sur l’hôte.	'Désactivé' 'Activé'
subnetId	ID de ressource Azure du sous-réseau maître.	corde
vmSize	Taille des machines virtuelles principales.	corde

Microsoft.RedHatOpenShift/openShiftClusters

Nom	Description	Valeur
emplacement	Emplacement géographique où réside la ressource	chaîne (obligatoire)
nom	Nom de la ressource	chaîne (obligatoire)
Propriétés	Propriétés du cluster.	OpenShiftClusterProperties
étiquettes	Balises de ressource	Dictionnaire de noms et de valeurs d’étiquettes.
type	Type de ressource	« Microsoft.RedHatOpenShift/openShiftClusters@2023-11-22 »

NetworkProfile

Nom	Description	Valeur
loadBalancerProfile	Profil de l’équilibreur de charge du cluster.	LoadBalancerProfile
outboundType	OutboundType utilisé pour le trafic de sortie.	'Loadbalancer' 'UserDefinedRouting'
podCidr	CIDR utilisé pour les pods OpenShift/Kubernetes.	corde
préconfiguréNSG	Spécifie si les sous-réseaux sont pré-attachés à un groupe de sécurité réseau	'Désactivé' 'Activé'
serviceCidr	CIDR utilisé pour OpenShift/Kubernetes Services.	corde

OpenShiftClusterProperties

Nom	Description	Valeur
apiserverProfile	Profil du serveur d’API de cluster.	APIServerProfile
clusterProfile	Profil de cluster.	ClusterProfile
consoleProfile	Profil de console.	consoleProfile
ingressProfiles	Profils d’entrée de cluster.	IngressProfile[]
masterProfile	Profil principal du cluster.	masterProfile
networkProfile	Profil réseau du cluster.	NetworkProfile
provisioningState	État d’approvisionnement du cluster.	'AdminUpdating' 'Annulé' 'Création' 'Suppression' 'Échec' 'Réussi' 'Mise à jour'
servicePrincipalProfile	Profil du principal du service de cluster.	ServicePrincipalProfile
workerProfiles	Profils de travail du cluster.	WorkerProfile[]

ServicePrincipalProfile

Nom	Description	Valeur
clientId	ID client utilisé pour le cluster.	corde
clientSecret	Clé secrète client utilisée pour le cluster.	corde

TrackedResourceTags

Nom	Description	Valeur

WorkerProfile

Nom	Description	Valeur
compter	Nombre de machines virtuelles de travail.	Int
diskEncryptionSetId	ID de ressource d’un DiskEncryptionSet associé, le cas échéant.	corde
diskSizeGB	Taille du disque des machines virtuelles worker.	Int
encryptionAtHost	Indique si les machines virtuelles principales sont chiffrées sur l’hôte.	'Désactivé' 'Activé'
nom	Nom du profil de travail.	corde
subnetId	ID de ressource Azure du sous-réseau worker.	corde
vmSize	Taille des machines virtuelles worker.	corde

Partager via

Microsoft.RedHatOpenShift openShiftClusters 2023-11-22

Définition de ressource Bicep

Format de ressource

Valeurs de propriété

APIServerProfile

ClusterProfile

ConsoleProfile

IngressProfile

LoadBalancerProfile

Adresses IP sortantes managées

MasterProfile

Microsoft.RedHatOpenShift/openShiftClusters

NetworkProfile

OpenShiftClusterProperties

ServicePrincipalProfile

TrackedResourceTags

WorkerProfile

Définition de ressource de modèle ARM

Format de ressource

Valeurs de propriété

APIServerProfile

ClusterProfile

ConsoleProfile

IngressProfile

LoadBalancerProfile

Adresses IP sortantes managées

MasterProfile

Microsoft.RedHatOpenShift/openShiftClusters

NetworkProfile

OpenShiftClusterProperties

ServicePrincipalProfile

TrackedResourceTags

WorkerProfile

Définition de ressource Terraform (fournisseur AzAPI)

Format de ressource

Valeurs de propriété

APIServerProfile

ClusterProfile

ConsoleProfile

IngressProfile

LoadBalancerProfile

Adresses IP sortantes managées

MasterProfile

Microsoft.RedHatOpenShift/openShiftClusters

NetworkProfile

OpenShiftClusterProperties

ServicePrincipalProfile

TrackedResourceTags

WorkerProfile

Commentaires

Ressources supplémentaires