Microsoft.RedHatOpenShift/openShiftClusters 2023-07-01-visualização - Bicep, ARM template & Terraform AzAPI reference

Definição de recursos do bíceps

O tipo de recurso openShiftClusters pode ser implantado com operações que visam:

Grupos de recursos - Consulte comandos de implantação de grupo de recursos

Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.

Formato do recurso

Para criar um recurso Microsoft.RedHatOpenShift/openShiftClusters, adicione o seguinte Bicep ao seu modelo.

resource symbolicname 'Microsoft.RedHatOpenShift/openShiftClusters@2023-07-01-preview' = {
  location: 'string'
  name: 'string'
  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'
      }
    ]
  }
  tags: {
    {customized property}: 'string'
  }
}

Valores de propriedade

APIServerProfile

Designação	Descrição	Valor
IP	O IP do servidor de API do cluster.	string
URL	A URL para acessar o servidor de API do cluster.	string
Visibilidade	Visibilidade do servidor de API.	'Privado' 'Público'

ClusterProfile

Designação	Descrição	Valor
domínio	O domínio do cluster.	string
fipsValidatedModules	Se forem usados módulos de criptografia validados pelo FIPS	'Desativado' 'Habilitado'
pullSecret [en]	O segredo de pull para o cluster.	string
resourceGroupId	A ID do grupo de recursos de cluster.	string
Versão	A versão do cluster.	string

ConsoleProfile

Designação	Descrição	Valor
URL	A URL para acessar o console do cluster.	string

IngressProfile

Designação	Descrição	Valor
IP	O IP da entrada.	string
Designação	O nome do perfil de ingresso.	string
Visibilidade	Visibilidade de ingresso.	'Privado' 'Público'

LoadBalancerProfile

Designação	Descrição	Valor
allocatedOutboundPorts	O número desejado de portas SNAT alocadas por VM. Os valores permitidos estão no intervalo de 0 a 64000 (inclusive). O valor padrão é 1024.	Int
managedOutboundIps	Os IPs de saída gerenciados desejados para o balanceador de carga público do cluster.	ManagedOutboundIPs
outboundIpPrefixes	Os recursos de prefixo IP de saída desejados para o balanceador de carga de cluster.	OutboundIPPrefix[]
outboundIps	Os recursos IP de saída desejados para o balanceador de carga de cluster.	OutboundIP []

ManagedOutboundIPs

Designação	Descrição	Valor
contagem	Count representa o número desejado de IPs de saída IPv4 criados e gerenciados pelo Azure para o balanceador de carga público do cluster. Os valores permitidos estão no intervalo de 1 a 20. O valor padrão é 1.	Int

Perfil Mestra

Designação	Descrição	Valor
diskEncryptionSetId	O ID do recurso de um DiskEncryptionSet associado, se aplicável.	string
criptografiaAtHost	Se as máquinas virtuais mestras são criptografadas no host.	'Desativado' 'Habilitado'
subnetId	A ID de recurso do Azure da sub-rede principal.	string
vmTamanho	O tamanho das VMs mestras.	string

Microsoft.RedHatOpenShift/openShiftClusters

Designação	Descrição	Valor
Localização	A geolocalização onde o recurso vive	string (obrigatório)
Designação	O nome do recurso	string (obrigatório)
propriedades	As propriedades do cluster.	OpenShiftClusterProperties
Etiquetas	Tags de recursos	Dicionário de nomes e valores de tags. Consulte Tags em modelos

Perfil de rede

Designação	Descrição	Valor
loadBalancerProfile	O perfil do balanceador de carga do cluster.	LoadBalancerProfile
outboundType	O OutboundType usado para o tráfego de saída.	'Balanceador de carga' 'UserDefinedRouting'
podCidr	O CIDR usado para OpenShift/Kubernetes Pods.	string
serviçoCidr	O CIDR usado para OpenShift/Kubernetes Services.	string

OpenShiftClusterProperties

Designação	Descrição	Valor
apiserverProfile	O perfil do servidor de API de cluster.	APIServerProfile
clusterProfile	O perfil do cluster.	ClusterProfile
consolePerfil	O perfil do console.	ConsoleProfile
ingressProfiles	Os perfis de entrada do cluster.	IngressProfile[]
Perfil mestre	O perfil do mestre de cluster.	MasterProfile
networkProfile	O perfil de rede do cluster.	NetworkProfile
provisionamentoEstado	O estado de provisionamento do cluster.	'AdminUpdating' 'Criar' 'Eliminação' 'Falhou' 'Conseguiu' 'Atualização'
servicePrincipalProfile	O perfil da entidade de serviço de cluster.	ServicePrincipalProfile
Perfis dos trabalhadores	Os perfis de trabalho do cluster.	WorkerProfile []

IP de saída

Designação	Descrição	Valor
ID	A ID de recurso do Azure totalmente qualificada do recurso de endereço IP.	string

OutboundIPPrefix

Designação	Descrição	Valor
ID	A ID de recurso do Azure totalmente qualificada de um recurso de Prefixo IP.	string

ServicePrincipalProfile

Designação	Descrição	Valor
ID do cliente	A ID do cliente usada para o cluster.	string
clientSecret	O segredo do cliente usado para o cluster.	string

TrackedResourceTags

Designação	Descrição	Valor

Perfil do Trabalhador

Designação	Descrição	Valor
contagem	O número de VMs de trabalho.	Int
diskEncryptionSetId	O ID do recurso de um DiskEncryptionSet associado, se aplicável.	string
diskSizeGB	O tamanho do disco das VMs de trabalho.	Int
criptografiaAtHost	Se as máquinas virtuais mestras são criptografadas no host.	'Desativado' 'Habilitado'
Designação	O nome do perfil de trabalhador.	string
subnetId	A ID de recurso do Azure da sub-rede do trabalhador.	string
vmTamanho	O tamanho das VMs de trabalho.	string

Definição de recurso de modelo ARM

O tipo de recurso openShiftClusters pode ser implantado com operações que visam:

Grupos de recursos - Consulte comandos de implantação de grupo de recursos

Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.

Formato do recurso

Para criar um recurso Microsoft.RedHatOpenShift/openShiftClusters, adicione o seguinte JSON ao seu modelo.

{
  "type": "Microsoft.RedHatOpenShift/openShiftClusters",
  "apiVersion": "2023-07-01-preview",
  "name": "string",
  "location": "string",
  "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"
      }
    ]
  },
  "tags": {
    "{customized property}": "string"
  }
}

Valores de propriedade

APIServerProfile

Designação	Descrição	Valor
IP	O IP do servidor de API do cluster.	string
URL	A URL para acessar o servidor de API do cluster.	string
Visibilidade	Visibilidade do servidor de API.	'Privado' 'Público'

ClusterProfile

Designação	Descrição	Valor
domínio	O domínio do cluster.	string
fipsValidatedModules	Se forem usados módulos de criptografia validados pelo FIPS	'Desativado' 'Habilitado'
pullSecret [en]	O segredo de pull para o cluster.	string
resourceGroupId	A ID do grupo de recursos de cluster.	string
Versão	A versão do cluster.	string

ConsoleProfile

Designação	Descrição	Valor
URL	A URL para acessar o console do cluster.	string

IngressProfile

Designação	Descrição	Valor
IP	O IP da entrada.	string
Designação	O nome do perfil de ingresso.	string
Visibilidade	Visibilidade de ingresso.	'Privado' 'Público'

LoadBalancerProfile

Designação	Descrição	Valor
allocatedOutboundPorts	O número desejado de portas SNAT alocadas por VM. Os valores permitidos estão no intervalo de 0 a 64000 (inclusive). O valor padrão é 1024.	Int
managedOutboundIps	Os IPs de saída gerenciados desejados para o balanceador de carga público do cluster.	ManagedOutboundIPs
outboundIpPrefixes	Os recursos de prefixo IP de saída desejados para o balanceador de carga de cluster.	OutboundIPPrefix[]
outboundIps	Os recursos IP de saída desejados para o balanceador de carga de cluster.	OutboundIP []

ManagedOutboundIPs

Designação	Descrição	Valor
contagem	Count representa o número desejado de IPs de saída IPv4 criados e gerenciados pelo Azure para o balanceador de carga público do cluster. Os valores permitidos estão no intervalo de 1 a 20. O valor padrão é 1.	Int

Perfil Mestra

Designação	Descrição	Valor
diskEncryptionSetId	O ID do recurso de um DiskEncryptionSet associado, se aplicável.	string
criptografiaAtHost	Se as máquinas virtuais mestras são criptografadas no host.	'Desativado' 'Habilitado'
subnetId	A ID de recurso do Azure da sub-rede principal.	string
vmTamanho	O tamanho das VMs mestras.	string

Microsoft.RedHatOpenShift/openShiftClusters

Designação	Descrição	Valor
apiVersion	A versão api	'2023-07-01-pré-visualização'
Localização	A geolocalização onde o recurso vive	string (obrigatório)
Designação	O nome do recurso	string (obrigatório)
propriedades	As propriedades do cluster.	OpenShiftClusterProperties
Etiquetas	Tags de recursos	Dicionário de nomes e valores de tags. Consulte Tags em modelos
tipo	O tipo de recurso	'Microsoft.RedHatOpenShift/openShiftClusters'

Perfil de rede

Designação	Descrição	Valor
loadBalancerProfile	O perfil do balanceador de carga do cluster.	LoadBalancerProfile
outboundType	O OutboundType usado para o tráfego de saída.	'Balanceador de carga' 'UserDefinedRouting'
podCidr	O CIDR usado para OpenShift/Kubernetes Pods.	string
serviçoCidr	O CIDR usado para OpenShift/Kubernetes Services.	string

OpenShiftClusterProperties

Designação	Descrição	Valor
apiserverProfile	O perfil do servidor de API de cluster.	APIServerProfile
clusterProfile	O perfil do cluster.	ClusterProfile
consolePerfil	O perfil do console.	ConsoleProfile
ingressProfiles	Os perfis de entrada do cluster.	IngressProfile[]
Perfil mestre	O perfil do mestre de cluster.	MasterProfile
networkProfile	O perfil de rede do cluster.	NetworkProfile
provisionamentoEstado	O estado de provisionamento do cluster.	'AdminUpdating' 'Criar' 'Eliminação' 'Falhou' 'Conseguiu' 'Atualização'
servicePrincipalProfile	O perfil da entidade de serviço de cluster.	ServicePrincipalProfile
Perfis dos trabalhadores	Os perfis de trabalho do cluster.	WorkerProfile []

IP de saída

Designação	Descrição	Valor
ID	A ID de recurso do Azure totalmente qualificada do recurso de endereço IP.	string

OutboundIPPrefix

Designação	Descrição	Valor
ID	A ID de recurso do Azure totalmente qualificada de um recurso de Prefixo IP.	string

ServicePrincipalProfile

Designação	Descrição	Valor
ID do cliente	A ID do cliente usada para o cluster.	string
clientSecret	O segredo do cliente usado para o cluster.	string

TrackedResourceTags

Designação	Descrição	Valor

Perfil do Trabalhador

Designação	Descrição	Valor
contagem	O número de VMs de trabalho.	Int
diskEncryptionSetId	O ID do recurso de um DiskEncryptionSet associado, se aplicável.	string
diskSizeGB	O tamanho do disco das VMs de trabalho.	Int
criptografiaAtHost	Se as máquinas virtuais mestras são criptografadas no host.	'Desativado' 'Habilitado'
Designação	O nome do perfil de trabalhador.	string
subnetId	A ID de recurso do Azure da sub-rede do trabalhador.	string
vmTamanho	O tamanho das VMs de trabalho.	string

Definição de recursos Terraform (provedor AzAPI)

O tipo de recurso openShiftClusters pode ser implantado com operações que visam:

Grupos de recursos

Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.

Formato do recurso

Para criar um recurso Microsoft.RedHatOpenShift/openShiftClusters, adicione o seguinte Terraform ao seu modelo.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.RedHatOpenShift/openShiftClusters@2023-07-01-preview"
  name = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  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"
        }
      ]
    }
  })
}

Valores de propriedade

APIServerProfile

Designação	Descrição	Valor
IP	O IP do servidor de API do cluster.	string
URL	A URL para acessar o servidor de API do cluster.	string
Visibilidade	Visibilidade do servidor de API.	'Privado' 'Público'

ClusterProfile

Designação	Descrição	Valor
domínio	O domínio do cluster.	string
fipsValidatedModules	Se forem usados módulos de criptografia validados pelo FIPS	'Desativado' 'Habilitado'
pullSecret [en]	O segredo de pull para o cluster.	string
resourceGroupId	A ID do grupo de recursos de cluster.	string
Versão	A versão do cluster.	string

ConsoleProfile

Designação	Descrição	Valor
URL	A URL para acessar o console do cluster.	string

IngressProfile

Designação	Descrição	Valor
IP	O IP da entrada.	string
Designação	O nome do perfil de ingresso.	string
Visibilidade	Visibilidade de ingresso.	'Privado' 'Público'

LoadBalancerProfile

Designação	Descrição	Valor
allocatedOutboundPorts	O número desejado de portas SNAT alocadas por VM. Os valores permitidos estão no intervalo de 0 a 64000 (inclusive). O valor padrão é 1024.	Int
managedOutboundIps	Os IPs de saída gerenciados desejados para o balanceador de carga público do cluster.	ManagedOutboundIPs
outboundIpPrefixes	Os recursos de prefixo IP de saída desejados para o balanceador de carga de cluster.	OutboundIPPrefix[]
outboundIps	Os recursos IP de saída desejados para o balanceador de carga de cluster.	OutboundIP []

ManagedOutboundIPs

Designação	Descrição	Valor
contagem	Count representa o número desejado de IPs de saída IPv4 criados e gerenciados pelo Azure para o balanceador de carga público do cluster. Os valores permitidos estão no intervalo de 1 a 20. O valor padrão é 1.	Int

Perfil Mestra

Designação	Descrição	Valor
diskEncryptionSetId	O ID do recurso de um DiskEncryptionSet associado, se aplicável.	string
criptografiaAtHost	Se as máquinas virtuais mestras são criptografadas no host.	'Desativado' 'Habilitado'
subnetId	A ID de recurso do Azure da sub-rede principal.	string
vmTamanho	O tamanho das VMs mestras.	string

Microsoft.RedHatOpenShift/openShiftClusters

Designação	Descrição	Valor
Localização	A geolocalização onde o recurso vive	string (obrigatório)
Designação	O nome do recurso	string (obrigatório)
propriedades	As propriedades do cluster.	OpenShiftClusterProperties
Etiquetas	Tags de recursos	Dicionário de nomes e valores de tags.
tipo	O tipo de recurso	"Microsoft.RedHatOpenShift/openShiftClusters@2023-07-01-preview"

Perfil de rede

Designação	Descrição	Valor
loadBalancerProfile	O perfil do balanceador de carga do cluster.	LoadBalancerProfile
outboundType	O OutboundType usado para o tráfego de saída.	'Balanceador de carga' 'UserDefinedRouting'
podCidr	O CIDR usado para OpenShift/Kubernetes Pods.	string
serviçoCidr	O CIDR usado para OpenShift/Kubernetes Services.	string

OpenShiftClusterProperties

Designação	Descrição	Valor
apiserverProfile	O perfil do servidor de API de cluster.	APIServerProfile
clusterProfile	O perfil do cluster.	ClusterProfile
consolePerfil	O perfil do console.	ConsoleProfile
ingressProfiles	Os perfis de entrada do cluster.	IngressProfile[]
Perfil mestre	O perfil do mestre de cluster.	MasterProfile
networkProfile	O perfil de rede do cluster.	NetworkProfile
provisionamentoEstado	O estado de provisionamento do cluster.	'AdminUpdating' 'Criar' 'Eliminação' 'Falhou' 'Conseguiu' 'Atualização'
servicePrincipalProfile	O perfil da entidade de serviço de cluster.	ServicePrincipalProfile
Perfis dos trabalhadores	Os perfis de trabalho do cluster.	WorkerProfile []

IP de saída

Designação	Descrição	Valor
ID	A ID de recurso do Azure totalmente qualificada do recurso de endereço IP.	string

OutboundIPPrefix

Designação	Descrição	Valor
ID	A ID de recurso do Azure totalmente qualificada de um recurso de Prefixo IP.	string

ServicePrincipalProfile

Designação	Descrição	Valor
ID do cliente	A ID do cliente usada para o cluster.	string
clientSecret	O segredo do cliente usado para o cluster.	string

TrackedResourceTags

Designação	Descrição	Valor

Perfil do Trabalhador

Designação	Descrição	Valor
contagem	O número de VMs de trabalho.	Int
diskEncryptionSetId	O ID do recurso de um DiskEncryptionSet associado, se aplicável.	string
diskSizeGB	O tamanho do disco das VMs de trabalho.	Int
criptografiaAtHost	Se as máquinas virtuais mestras são criptografadas no host.	'Desativado' 'Habilitado'
Designação	O nome do perfil de trabalhador.	string
subnetId	A ID de recurso do Azure da sub-rede do trabalhador.	string
vmTamanho	O tamanho das VMs de trabalho.	string

Partilhar via

Microsoft.RedHatOpenShift openShiftClusters 2023-07-01-visualização

Definição de recursos do bíceps

Formato do recurso

Valores de propriedade

APIServerProfile

ClusterProfile

ConsoleProfile

IngressProfile

LoadBalancerProfile

ManagedOutboundIPs

Perfil Mestra

Microsoft.RedHatOpenShift/openShiftClusters

Perfil de rede

OpenShiftClusterProperties

IP de saída

OutboundIPPrefix

ServicePrincipalProfile

TrackedResourceTags

Perfil do Trabalhador

Definição de recurso de modelo ARM

Formato do recurso

Valores de propriedade

APIServerProfile

ClusterProfile

ConsoleProfile

IngressProfile

LoadBalancerProfile

ManagedOutboundIPs

Perfil Mestra

Microsoft.RedHatOpenShift/openShiftClusters

Perfil de rede

OpenShiftClusterProperties

IP de saída

OutboundIPPrefix

ServicePrincipalProfile

TrackedResourceTags

Perfil do Trabalhador

Definição de recursos Terraform (provedor AzAPI)

Formato do recurso

Valores de propriedade

APIServerProfile

ClusterProfile

ConsoleProfile

IngressProfile

LoadBalancerProfile

ManagedOutboundIPs

Perfil Mestra

Microsoft.RedHatOpenShift/openShiftClusters

Perfil de rede

OpenShiftClusterProperties

IP de saída

OutboundIPPrefix

ServicePrincipalProfile

TrackedResourceTags

Perfil do Trabalhador

Comentários

Recursos adicionais