Microsoft.RedHatOpenShift openShiftClusters 2022-09-04

Bicep リソース定義

openShiftClusters リソースの種類は、次をターゲットとする操作でデプロイできます。

各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。

リソース形式

Microsoft.RedHatOpenShift/openShiftClusters リソースを作成するには、次の Bicep をテンプレートに追加します。

resource symbolicname 'Microsoft.RedHatOpenShift/openShiftClusters@2022-09-04' = {
  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: {
      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'
      }
    ]
  }
}

プロパティ値

openShiftClusters

名前 説明
name リソース名 string (必須)
location リソースが保存されている地理的な場所 string (必須)
tags リソース タグ。 タグの名前と値のディクショナリ。 「テンプレート内のタグ」を参照してください
properties クラスターのプロパティ。 OpenShiftClusterProperties

OpenShiftClusterProperties

名前 説明
apiserverProfile クラスター API サーバー プロファイル。 APIServerProfile
clusterProfile クラスター プロファイル。 ClusterProfile
consoleProfile コンソール プロファイル。 ConsoleProfile
ingressProfiles クラスターのイングレス プロファイル。 IngressProfile[]
masterProfile クラスター マスター プロファイル。 MasterProfile
networkProfile クラスター ネットワーク プロファイル。 NetworkProfile
provisioningState クラスターのプロビジョニング状態。 'AdminUpdating'
'Creating'
'削除中'
'Failed'
'Succeeded'
'更新中'
servicePrincipalProfile クラスター サービス プリンシパル プロファイル。 ServicePrincipalProfile
workerProfiles クラスター ワーカー プロファイル。 WorkerProfile[]

APIServerProfile

名前 説明
ip クラスター API サーバーの IP。 string
url クラスター API サーバーにアクセスするための URL。 string
参照可能範囲 API サーバーの可視性。 'Private'
'Public'

ClusterProfile

名前 説明
domain クラスターのドメイン。 string
fipsValidatedModules FIPS 検証済み暗号化モジュールが使用されている場合 'Disabled'
'Enabled'
pullSecret クラスターのプル シークレット。 string
resourceGroupId クラスター リソース グループの ID。 string
version クラスターのバージョン。 string

ConsoleProfile

名前 説明
url クラスター コンソールにアクセスする URL。 string

IngressProfile

名前 説明
ip イングレスの IP。 string
name イングレス プロファイル名。 string
参照可能範囲 イングレスの可視性。 'Private'
'Public'

MasterProfile

名前 説明
diskEncryptionSetId 関連する DiskEncryptionSet のリソース ID (該当する場合)。 string
encryptionAtHost マスター仮想マシンがホストで暗号化されているかどうか。 'Disabled'
'Enabled'
subnetId マスター サブネットの Azure リソース ID。 string
vmSize マスター VM のサイズ。 string

NetworkProfile

名前 説明
podCidr OpenShift/Kubernetes ポッドに使用される CIDR。 string
serviceCidr OpenShift/Kubernetes Services に使用される CIDR。 string

ServicePrincipalProfile

名前 説明
clientId クラスターに使用されるクライアント ID。 string
clientSecret クラスターに使用されるクライアント シークレット。 string

WorkerProfile

名前 説明
count ワーカー VM の数。 INT
diskEncryptionSetId 関連する DiskEncryptionSet のリソース ID (該当する場合)。 string
diskSizeGB ワーカー VM のディスク サイズ。 INT
encryptionAtHost マスター仮想マシンがホストで暗号化されているかどうか。 'Disabled'
'Enabled'
name worker プロファイル名。 string
subnetId ワーカー サブネットの Azure リソース ID。 string
vmSize ワーカー VM のサイズ。 string

ARM テンプレート リソース定義

openShiftClusters リソースの種類は、次をターゲットとする操作と共にデプロイできます。

各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。

リソース形式

Microsoft.RedHatOpenShift/openShiftClusters リソースを作成するには、次の JSON をテンプレートに追加します。

{
  "type": "Microsoft.RedHatOpenShift/openShiftClusters",
  "apiVersion": "2022-09-04",
  "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": {
      "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"
      }
    ]
  }
}

プロパティ値

openShiftClusters

名前 説明
type リソースの種類 'Microsoft.RedHatOpenShift/openShiftClusters'
apiVersion リソース API のバージョン '2022-09-04'
name リソース名 string (必須)
location リソースが保存されている地理的な場所 string (必須)
tags リソース タグ。 タグ名と値のディクショナリ。 「テンプレートのタグ」を参照してください
properties クラスターのプロパティ。 OpenShiftClusterProperties

OpenShiftClusterProperties

名前 説明
apiserverProfile クラスター API サーバー プロファイル。 APIServerProfile
clusterProfile クラスター プロファイル。 ClusterProfile
consoleProfile コンソール プロファイル。 ConsoleProfile
ingressProfiles クラスターのイングレス プロファイル。 IngressProfile[]
masterProfile クラスター マスター プロファイル。 MasterProfile
networkProfile クラスター ネットワーク プロファイル。 NetworkProfile
provisioningState クラスターのプロビジョニング状態。 'AdminUpdating'
'Creating'
'削除中'
'Failed'
'Succeeded'
'更新中'
servicePrincipalProfile クラスター サービス プリンシパル プロファイル。 ServicePrincipalProfile
workerProfiles クラスター ワーカー プロファイル。 WorkerProfile[]

APIServerProfile

名前 説明
ip クラスター API サーバーの IP。 string
url クラスター API サーバーにアクセスするための URL。 string
参照可能範囲 API サーバーの可視性。 'Private'
'Public'

ClusterProfile

名前 説明
domain クラスターのドメイン。 string
fipsValidatedModules FIPS 検証済み暗号化モジュールが使用されている場合 'Disabled'
'Enabled'
pullSecret クラスターのプル シークレット。 string
resourceGroupId クラスター リソース グループの ID。 string
version クラスターのバージョン。 string

ConsoleProfile

名前 説明
url クラスター コンソールにアクセスする URL。 string

IngressProfile

名前 説明
ip イングレスの IP。 string
name イングレス プロファイル名。 string
参照可能範囲 イングレスの可視性。 'Private'
'Public'

MasterProfile

名前 説明
diskEncryptionSetId 関連する DiskEncryptionSet のリソース ID (該当する場合)。 string
encryptionAtHost マスター仮想マシンがホストで暗号化されているかどうか。 'Disabled'
'Enabled'
subnetId マスター サブネットの Azure リソース ID。 string
vmSize マスター VM のサイズ。 string

NetworkProfile

名前 説明
podCidr OpenShift/Kubernetes ポッドに使用される CIDR。 string
serviceCidr OpenShift/Kubernetes Services に使用される CIDR。 string

ServicePrincipalProfile

名前 説明
clientId クラスターに使用されるクライアント ID。 string
clientSecret クラスターに使用されるクライアント シークレット。 string

WorkerProfile

名前 説明
count ワーカー VM の数。 INT
diskEncryptionSetId 関連する DiskEncryptionSet のリソース ID (該当する場合)。 string
diskSizeGB ワーカー VM のディスク サイズ。 INT
encryptionAtHost マスター仮想マシンがホストで暗号化されているかどうか。 'Disabled'
'Enabled'
name worker プロファイル名。 string
subnetId ワーカー サブネットの Azure リソース ID。 string
vmSize ワーカー VM のサイズ。 string

Terraform (AzAPI プロバイダー) リソース定義

openShiftClusters リソースの種類は、次をターゲットとする操作でデプロイできます。

  • リソース グループ

各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。

リソース形式

Microsoft.RedHatOpenShift/openShiftClusters リソースを作成するには、次の Terraform をテンプレートに追加します。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.RedHatOpenShift/openShiftClusters@2022-09-04"
  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 = {
        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"
        }
      ]
    }
  })
}

プロパティ値

openShiftClusters

名前 説明
type リソースの種類 "Microsoft.RedHatOpenShift/openShiftClusters@2022-09-04"
name リソース名 string (必須)
location リソースが保存されている地理的な場所 string (必須)
parent_id リソース グループにデプロイするには、そのリソース グループの ID を使用します。 string (必須)
tags リソース タグ。 タグの名前と値のディクショナリ。
properties クラスターのプロパティ。 OpenShiftClusterProperties

OpenShiftClusterProperties

名前 説明
apiserverProfile クラスター API サーバー プロファイル。 APIServerProfile
clusterProfile クラスター プロファイル。 ClusterProfile
consoleProfile コンソール プロファイル。 ConsoleProfile
ingressProfiles クラスターのイングレス プロファイル。 IngressProfile[]
masterProfile クラスター マスター プロファイル。 MasterProfile
networkProfile クラスター ネットワーク プロファイル。 NetworkProfile
provisioningState クラスターのプロビジョニング状態。 "AdminUpdating"
"作成中"
"削除中"
"Failed"
"Succeeded"
"更新中"
servicePrincipalProfile クラスター サービス プリンシパル プロファイル。 ServicePrincipalProfile
workerProfiles クラスター ワーカー プロファイル。 WorkerProfile[]

APIServerProfile

名前 説明
ip クラスター API サーバーの IP。 string
url クラスター API サーバーにアクセスするための URL。 string
参照可能範囲 API サーバーの可視性。 "Private"
"パブリック"

ClusterProfile

名前 説明
domain クラスターのドメイン。 string
fipsValidatedModules FIPS 検証済み暗号化モジュールが使用されている場合 "無効"
"有効"
pullSecret クラスターのプル シークレット。 string
resourceGroupId クラスター リソース グループの ID。 string
version クラスターのバージョン。 string

ConsoleProfile

名前 説明
url クラスター コンソールにアクセスする URL。 string

IngressProfile

名前 説明
ip イングレスの IP。 string
name イングレス プロファイル名。 string
参照可能範囲 イングレスの可視性。 "Private"
"パブリック"

MasterProfile

名前 説明
diskEncryptionSetId 関連する DiskEncryptionSet のリソース ID (該当する場合)。 string
encryptionAtHost マスター仮想マシンがホストで暗号化されているかどうか。 "無効"
"有効"
subnetId マスター サブネットの Azure リソース ID。 string
vmSize マスター VM のサイズ。 string

NetworkProfile

名前 説明
podCidr OpenShift/Kubernetes ポッドに使用される CIDR。 string
serviceCidr OpenShift/Kubernetes Services に使用される CIDR。 string

ServicePrincipalProfile

名前 説明
clientId クラスターに使用されるクライアント ID。 string
clientSecret クラスターに使用されるクライアント シークレット。 string

WorkerProfile

名前 説明
count ワーカー VM の数。 INT
diskEncryptionSetId 関連する DiskEncryptionSet のリソース ID (該当する場合)。 string
diskSizeGB ワーカー VM のディスク サイズ。 INT
encryptionAtHost マスター仮想マシンがホストで暗号化されているかどうか。 "無効"
"有効"
name worker プロファイル名。 string
subnetId ワーカー サブネットの Azure リソース ID。 string
vmSize ワーカー VM のサイズ。 string