Microsoft.RedHatOpenShift openShiftClusters

Article
09/21/2023

Définition de ressource Bicep

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

Groupes de ressources - Voir commandes de déploiement de groupe de ressources

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

Format des ressources

Pour créer une ressource Microsoft.RedHatOpenShift/openShiftClusters, ajoutez le Bicep suivant à votre modèle.

resource symbolicname 'Microsoft.RedHatOpenShift/openShiftClusters@2023-07-01-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  properties: {
    apiserverProfile: {
      ip: 'string'
      url: 'string'
      visibility: 'string'
    }
    clusterProfile: {
      domain: 'string'
      fipsValidatedModules: 'string'
      pullSecret: 'string'
      resourceGroupId: 'string'
      version: 'string'
    }
    consoleProfile: {
      url: 'string'
    }
    ingressProfiles: [
      {
        ip: 'string'
        name: 'string'
        visibility: 'string'
      }
    ]
    masterProfile: {
      diskEncryptionSetId: 'string'
      encryptionAtHost: 'string'
      subnetId: 'string'
      vmSize: 'string'
    }
    networkProfile: {
      loadBalancerProfile: {
        allocatedOutboundPorts: int
        managedOutboundIps: {
          count: int
        }
        outboundIpPrefixes: [
          {
            id: 'string'
          }
        ]
        outboundIps: [
          {
            id: 'string'
          }
        ]
      }
      outboundType: 'string'
      podCidr: '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és

openShiftClusters

Nom	Description	Valeur
name	Nom de la ressource	string (obligatoire)
location	Emplacement géographique où réside la ressource	string (obligatoire)
tags	Balises de ressource.	Dictionnaire de noms et de valeurs d’étiquettes. Voir Balises dans les modèles
properties	Propriétés du cluster.	OpenShiftClusterProperties

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 master cluster.	MasterProfile
networkProfile	Profil réseau de cluster.	NetworkProfile
provisioningState	État d’approvisionnement du cluster.	'AdminUpdating' 'Création' 'Suppression' 'Failed' 'Succeeded' 'Mise à jour'
servicePrincipalProfile	Profil de principal du service de cluster.	ServicePrincipalProfile
workerProfiles	Profils de travail de cluster.	WorkerProfile[]

APIServerProfile

Nom	Description	Valeur
ip	Adresse IP du serveur d’API de cluster.	string
url	URL permettant d’accéder au serveur d’API de cluster.	string
visibility	Visibilité du serveur d’API.	'Private' 'Public'

ClusterProfile

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

ConsoleProfile

Nom	Description	Valeur
url	URL pour accéder à la console de cluster.	string

IngressProfile

Nom	Description	Valeur
ip	Adresse IP de l’entrée.	string
name	Nom du profil d’entrée.	string
visibility	Visibilité d’entrée.	'Privé' 'Public'

MasterProfile

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

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.	string
serviceCidr	CIDR utilisé pour OpenShift/Kubernetes Services.	string

LoadBalancerProfile

Nom	Description	Valeur
allocationsOutboundPorts	Nombre souhaité de ports SNAT alloués par machine virtuelle. Les valeurs autorisées sont comprises entre 0 et 64 000 (inclus). La valeur par défaut est 1024.	int
managedOutboundIps	Adresses IP sortantes managées souhaitées pour l’équilibreur de charge public du cluster.	ManagedOutboundIPs
outboundIpPrefixes	Ressources de préfixe IP sortant souhaitées pour l’équilibreur de charge du cluster.	OutboundIPPrefix[]
Ips sortants	Ressources IP sortantes souhaitées pour l’équilibreur de charge du cluster.	OutboundIP[]

ManagedOutboundIPs

Nom	Description	Valeur
count	Count 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

OutboundIPPrefix

Nom	Description	Valeur
id	ID de ressource Azure complet d’une ressource préfixe IP.	string

OutboundIP

Nom	Description	Valeur
id	ID de ressource Azure complet de la ressource d’adresse IP.	string

ServicePrincipalProfile

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

WorkerProfile

Nom	Description	Valeur
count	Nombre de machines virtuelles worker.	int
diskEncryptionSetId	ID de ressource d’un DiskEncryptionSet associé, le cas échéant.	string
diskSizeGB	Taille du disque des machines virtuelles worker.	int
encryptionAtHost	Indique si master machines virtuelles sont chiffrées sur l’hôte.	'Désactivé' 'Enabled'
name	Nom du profil de travail.	string
subnetId	ID de ressource Azure du sous-réseau de travail.	string
vmSize	Taille des machines virtuelles worker.	string

Définition de ressources de modèle ARM

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

Groupes de ressources - Voir commandes de déploiement de groupe de ressources

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

Format des ressources

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

{
  "type": "Microsoft.RedHatOpenShift/openShiftClusters",
  "apiVersion": "2023-07-01-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "apiserverProfile": {
      "ip": "string",
      "url": "string",
      "visibility": "string"
    },
    "clusterProfile": {
      "domain": "string",
      "fipsValidatedModules": "string",
      "pullSecret": "string",
      "resourceGroupId": "string",
      "version": "string"
    },
    "consoleProfile": {
      "url": "string"
    },
    "ingressProfiles": [
      {
        "ip": "string",
        "name": "string",
        "visibility": "string"
      }
    ],
    "masterProfile": {
      "diskEncryptionSetId": "string",
      "encryptionAtHost": "string",
      "subnetId": "string",
      "vmSize": "string"
    },
    "networkProfile": {
      "loadBalancerProfile": {
        "allocatedOutboundPorts": "int",
        "managedOutboundIps": {
          "count": "int"
        },
        "outboundIpPrefixes": [
          {
            "id": "string"
          }
        ],
        "outboundIps": [
          {
            "id": "string"
          }
        ]
      },
      "outboundType": "string",
      "podCidr": "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és

openShiftClusters

Nom	Description	Valeur
type	Type de ressource	'Microsoft.RedHatOpenShift/openShiftClusters'
apiVersion	Version de l’API de ressource	'2023-07-01-preview'
name	Nom de la ressource	string (obligatoire)
location	Emplacement géographique où réside la ressource	string (obligatoire)
tags	Balises de ressource.	Dictionnaire de noms et de valeurs d’étiquettes. Voir Balises dans les modèles
properties	Propriétés du cluster.	OpenShiftClusterProperties

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 master cluster.	MasterProfile
networkProfile	Profil réseau de cluster.	NetworkProfile
provisioningState	État d’approvisionnement du cluster.	'AdminUpdating' 'Création' 'Suppression' 'Failed' 'Succeeded' 'Mise à jour'
servicePrincipalProfile	Profil de principal du service de cluster.	ServicePrincipalProfile
workerProfiles	Profils de travail de cluster.	WorkerProfile[]

APIServerProfile

Nom	Description	Valeur
ip	Adresse IP du serveur d’API de cluster.	string
url	URL pour accéder au serveur d’API de cluster.	string
visibility	Visibilité du serveur d’API.	'Privé' 'Public'

ClusterProfile

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

ConsoleProfile

Nom	Description	Valeur
url	URL pour accéder à la console de cluster.	string

IngressProfile

Nom	Description	Valeur
ip	Adresse IP de l’entrée.	string
name	Nom du profil d’entrée.	string
visibility	Visibilité d’entrée.	'Privé' 'Public'

MasterProfile

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

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.	string
serviceCidr	CIDR utilisé pour OpenShift/Kubernetes Services.	string

LoadBalancerProfile

Nom	Description	Valeur
allocationsOutboundPorts	Nombre souhaité de ports SNAT alloués par machine virtuelle. Les valeurs autorisées sont comprises entre 0 et 64 000 (inclus). La valeur par défaut est 1024.	int
managedOutboundIps	Adresses IP sortantes managées souhaitées pour l’équilibreur de charge public du cluster.	ManagedOutboundIPs
outboundIpPrefixes	Ressources de préfixe IP sortant souhaitées pour l’équilibreur de charge du cluster.	OutboundIPPrefix[]
Ips sortants	Ressources IP sortantes souhaitées pour l’équilibreur de charge du cluster.	OutboundIP[]

ManagedOutboundIPs

Nom	Description	Valeur
count	Count 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

OutboundIPPrefix

Nom	Description	Valeur
id	ID de ressource Azure complet d’une ressource préfixe IP.	string

OutboundIP

Nom	Description	Valeur
id	ID de ressource Azure complet de la ressource d’adresse IP.	string

ServicePrincipalProfile

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

WorkerProfile

Nom	Description	Valeur
count	Nombre de machines virtuelles worker.	int
diskEncryptionSetId	ID de ressource d’un DiskEncryptionSet associé, le cas échéant.	string
diskSizeGB	Taille du disque des machines virtuelles worker.	int
encryptionAtHost	Indique si master machines virtuelles sont chiffrées sur l’hôte.	'Désactivé' 'Enabled'
name	Nom du profil de travail.	string
subnetId	ID de ressource Azure du sous-réseau worker.	string
vmSize	Taille des machines virtuelles worker.	string

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 des ressources

Pour créer une ressource Microsoft.RedHatOpenShift/openShiftClusters, ajoutez le Terraform suivant à votre modèle.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.RedHatOpenShift/openShiftClusters@2023-07-01-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      apiserverProfile = {
        ip = "string"
        url = "string"
        visibility = "string"
      }
      clusterProfile = {
        domain = "string"
        fipsValidatedModules = "string"
        pullSecret = "string"
        resourceGroupId = "string"
        version = "string"
      }
      consoleProfile = {
        url = "string"
      }
      ingressProfiles = [
        {
          ip = "string"
          name = "string"
          visibility = "string"
        }
      ]
      masterProfile = {
        diskEncryptionSetId = "string"
        encryptionAtHost = "string"
        subnetId = "string"
        vmSize = "string"
      }
      networkProfile = {
        loadBalancerProfile = {
          allocatedOutboundPorts = int
          managedOutboundIps = {
            count = int
          }
          outboundIpPrefixes = [
            {
              id = "string"
            }
          ]
          outboundIps = [
            {
              id = "string"
            }
          ]
        }
        outboundType = "string"
        podCidr = "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és

openShiftClusters

Nom	Description	Valeur
type	Type de ressource	« Microsoft.RedHatOpenShift/openShiftClusters@2023-07-01-preview »
name	Nom de la ressource	chaîne (obligatoire)
location	Emplacement géographique où réside la ressource	chaîne (obligatoire)
parent_id	Pour effectuer un déploiement sur un groupe de ressources, utilisez l’ID de ce groupe de ressources.	chaîne (obligatoire)
tags	Balises de ressource.	Dictionnaire de noms et de valeurs d’étiquettes.
properties	Propriétés du cluster.	OpenShiftClusterProperties

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 master cluster.	MasterProfile
networkProfile	Profil réseau de cluster.	NetworkProfile
provisioningState	État d’approvisionnement du cluster.	« AdminUpdating » « Création » « Suppression » « Échec » « Réussi » « Mise à jour »
servicePrincipalProfile	Profil de principal du service de cluster.	ServicePrincipalProfile
workerProfiles	Profils de travail de cluster.	WorkerProfile[]

APIServerProfile

Nom	Description	Valeur
ip	Adresse IP du serveur d’API de cluster.	string
url	URL permettant d’accéder au serveur d’API de cluster.	string
visibility	Visibilité du serveur d’API.	« Privé » « Public »

ClusterProfile

Nom	Description	Valeur
domaine	Domaine du cluster.	string
fipsValidatedModules	Si des modules de chiffrement validés par FIPS sont utilisés	« Désactivé » « Activé »
pullSecret	Secret d’extraction pour le cluster.	string
resourceGroupId	ID du groupe de ressources de cluster.	string
version	Version du cluster.	string

ConsoleProfile

Nom	Description	Valeur
url	URL permettant d’accéder à la console du cluster.	string

IngressProfile

Nom	Description	Valeur
ip	Adresse IP de l’entrée.	string
name	Nom du profil d’entrée.	string
visibility	Visibilité d’entrée.	« Privé » « Public »

MasterProfile

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

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.	string
serviceCidr	CIDR utilisé pour OpenShift/Kubernetes Services.	string

LoadBalancerProfile

Nom	Description	Valeur
allocationsOutboundPorts	Nombre souhaité de ports SNAT alloués par machine virtuelle. Les valeurs autorisées sont comprises entre 0 et 64 000 (inclus). La valeur par défaut est 1024.	int
managedOutboundIps	Adresses IP sortantes managées souhaitées pour l’équilibreur de charge public du cluster.	ManagedOutboundIPs
outboundIpPrefixes	Ressources de préfixe IP sortant souhaitées pour l’équilibreur de charge du cluster.	OutboundIPPrefix[]
Ips sortants	Ressources IP sortantes souhaitées pour l’équilibreur de charge du cluster.	OutboundIP[]

ManagedOutboundIPs

Nom	Description	Valeur
count	Count 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

OutboundIPPrefix

Nom	Description	Valeur
id	ID de ressource Azure complet d’une ressource préfixe IP.	string

OutboundIP

Nom	Description	Valeur
id	ID de ressource Azure complet de la ressource d’adresse IP.	string

ServicePrincipalProfile

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

WorkerProfile

Nom	Description	Valeur
count	Nombre de machines virtuelles worker.	int
diskEncryptionSetId	ID de ressource d’un DiskEncryptionSet associé, le cas échéant.	string
diskSizeGB	Taille du disque des machines virtuelles worker.	int
encryptionAtHost	Indique si master machines virtuelles sont chiffrées sur l’hôte.	« Désactivé » « Activé »
name	Nom du profil de travail.	string
subnetId	ID de ressource Azure du sous-réseau worker.	string
vmSize	Taille des machines virtuelles worker.	string

Partager via

Microsoft.RedHatOpenShift openShiftClusters

Définition de ressource Bicep

Format des ressources

Valeurs de propriétés

openShiftClusters

OpenShiftClusterProperties

APIServerProfile

ClusterProfile

ConsoleProfile

IngressProfile

MasterProfile

NetworkProfile

LoadBalancerProfile

ManagedOutboundIPs

OutboundIPPrefix

OutboundIP

ServicePrincipalProfile

WorkerProfile

Définition de ressources de modèle ARM

Format des ressources

Valeurs de propriétés

openShiftClusters

OpenShiftClusterProperties

APIServerProfile

ClusterProfile

ConsoleProfile

IngressProfile

MasterProfile

NetworkProfile

LoadBalancerProfile

ManagedOutboundIPs

OutboundIPPrefix

OutboundIP

ServicePrincipalProfile

WorkerProfile

Définition de ressource Terraform (fournisseur AzAPI)

Format des ressources

Valeurs de propriétés

openShiftClusters

OpenShiftClusterProperties

APIServerProfile

ClusterProfile

ConsoleProfile

IngressProfile

MasterProfile

NetworkProfile

LoadBalancerProfile

ManagedOutboundIPs

OutboundIPPrefix

OutboundIP

ServicePrincipalProfile

WorkerProfile

Commentaires

Ressources supplémentaires