Microsoft.RedHatOpenShift openShiftClusters 2020-04-30
Bicep リソース定義
openShiftClusters リソースの種類は、次をターゲットとする操作でデプロイできます。
- リソース グループ - リソース グループのデプロイ コマンドを参照してください
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
リソース形式
Microsoft.RedHatOpenShift/openShiftClusters リソースを作成するには、次の Bicep をテンプレートに追加します。
resource symbolicname 'Microsoft.RedHatOpenShift/openShiftClusters@2020-04-30' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
properties: {
apiserverProfile: {
ip: 'string'
url: 'string'
visibility: 'string'
}
clusterProfile: {
domain: 'string'
pullSecret: 'string'
resourceGroupId: 'string'
version: 'string'
}
consoleProfile: {
url: 'string'
}
ingressProfiles: [
{
ip: 'string'
name: 'string'
visibility: 'string'
}
]
masterProfile: {
subnetId: 'string'
vmSize: 'string'
}
networkProfile: {
podCidr: 'string'
serviceCidr: 'string'
}
provisioningState: 'string'
servicePrincipalProfile: {
clientId: 'string'
clientSecret: 'string'
}
workerProfiles: [
{
count: int
diskSizeGB: int
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 |
pullSecret | クラスターのプル シークレット (変更不可)。 | string |
resourceGroupId | クラスター リソース グループの ID (変更不可)。 | string |
version | クラスターのバージョン (不変)。 | string |
ConsoleProfile
名前 | 説明 | 値 |
---|---|---|
url | クラスター コンソールにアクセスするための URL (変更不可)。 | string |
IngressProfile
名前 | 説明 | 値 |
---|---|---|
ip | イングレスの IP (不変)。 | string |
name | イングレス プロファイル名。 "default" (不変) である必要があります。 | string |
参照可能範囲 | イングレス可視性 (不変)。 | 'Private' 'Public' |
MasterProfile
名前 | 説明 | 値 |
---|---|---|
subnetId | マスター サブネットの Azure リソース ID (不変)。 | string |
vmSize | マスター VM のサイズ (変更不可)。 | 'Standard_D2s_v3' 'Standard_D4s_v3' 'Standard_D8s_v3' |
NetworkProfile
名前 | 説明 | 値 |
---|---|---|
podCidr | OpenShift/Kubernetes ポッドに使用される CIDR (不変)。 | string |
serviceCidr | OpenShift/Kubernetes Services に使用される CIDR (不変)。 | string |
ServicePrincipalProfile
名前 | 説明 | 値 |
---|---|---|
clientId | クラスターに使用されるクライアント ID (不変)。 | string |
clientSecret | クラスターに使用されるクライアント シークレット (不変)。 | string |
WorkerProfile
名前 | 説明 | 値 |
---|---|---|
count | ワーカー VM の数。 3 から 20 (不変) の間である必要があります。 | INT |
diskSizeGB | ワーカー VM のディスク サイズ。 128 以上 (不変) である必要があります。 | INT |
name | worker プロファイル名。 "worker" (不変) である必要があります。 | string |
subnetId | ワーカー サブネットの Azure リソース ID (不変)。 | string |
vmSize | ワーカー VM のサイズ (変更不可)。 | 'Standard_D2s_v3' 'Standard_D4s_v3' 'Standard_D8s_v3' |
ARM テンプレート リソース定義
openShiftClusters リソースの種類は、次をターゲットとする操作と共にデプロイできます。
- リソース グループ - リソース グループのデプロイ コマンドに関するページを参照してください
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
リソース形式
Microsoft.RedHatOpenShift/openShiftClusters リソースを作成するには、次の JSON をテンプレートに追加します。
{
"type": "Microsoft.RedHatOpenShift/openShiftClusters",
"apiVersion": "2020-04-30",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"properties": {
"apiserverProfile": {
"ip": "string",
"url": "string",
"visibility": "string"
},
"clusterProfile": {
"domain": "string",
"pullSecret": "string",
"resourceGroupId": "string",
"version": "string"
},
"consoleProfile": {
"url": "string"
},
"ingressProfiles": [
{
"ip": "string",
"name": "string",
"visibility": "string"
}
],
"masterProfile": {
"subnetId": "string",
"vmSize": "string"
},
"networkProfile": {
"podCidr": "string",
"serviceCidr": "string"
},
"provisioningState": "string",
"servicePrincipalProfile": {
"clientId": "string",
"clientSecret": "string"
},
"workerProfiles": [
{
"count": "int",
"diskSizeGB": "int",
"name": "string",
"subnetId": "string",
"vmSize": "string"
}
]
}
}
プロパティ値
openShiftClusters
名前 | 説明 | 値 |
---|---|---|
type | リソースの種類 | 'Microsoft.RedHatOpenShift/openShiftClusters' |
apiVersion | リソース API のバージョン | '2020-04-30' |
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 |
pullSecret | クラスターのプル シークレット (変更不可)。 | string |
resourceGroupId | クラスター リソース グループの ID (変更不可)。 | string |
version | クラスターのバージョン (不変)。 | string |
ConsoleProfile
名前 | 説明 | 値 |
---|---|---|
url | クラスター コンソールにアクセスするための URL (変更不可)。 | string |
IngressProfile
名前 | 説明 | 値 |
---|---|---|
ip | イングレスの IP (不変)。 | string |
name | イングレス プロファイル名。 "default" (不変) である必要があります。 | string |
参照可能範囲 | イングレス可視性 (不変)。 | 'Private' 'Public' |
MasterProfile
名前 | 説明 | 値 |
---|---|---|
subnetId | マスター サブネットの Azure リソース ID (不変)。 | string |
vmSize | マスター VM のサイズ (変更不可)。 | 'Standard_D2s_v3' 'Standard_D4s_v3' 'Standard_D8s_v3' |
NetworkProfile
名前 | 説明 | 値 |
---|---|---|
podCidr | OpenShift/Kubernetes ポッドに使用される CIDR (不変)。 | string |
serviceCidr | OpenShift/Kubernetes Services に使用される CIDR (不変)。 | string |
ServicePrincipalProfile
名前 | 説明 | 値 |
---|---|---|
clientId | クラスターに使用されるクライアント ID (変更不可)。 | string |
clientSecret | クラスターに使用されるクライアント シークレット (不変)。 | string |
WorkerProfile
名前 | 説明 | 値 |
---|---|---|
count | ワーカー VM の数。 3 ~ 20 (変更不可) の間である必要があります。 | INT |
diskSizeGB | ワーカー VM のディスク サイズ。 128 以上 (不変) である必要があります。 | INT |
name | worker プロファイル名。 "worker" (不変) である必要があります。 | string |
subnetId | ワーカー サブネットの Azure リソース ID (不変)。 | string |
vmSize | ワーカー VM のサイズ (変更不可)。 | 'Standard_D2s_v3' 'Standard_D4s_v3' 'Standard_D8s_v3' |
Terraform (AzAPI プロバイダー) リソース定義
openShiftClusters リソースの種類は、次をターゲットとする操作でデプロイできます。
- リソース グループ
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
リソース形式
Microsoft.RedHatOpenShift/openShiftClusters リソースを作成するには、次の Terraform をテンプレートに追加します。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.RedHatOpenShift/openShiftClusters@2020-04-30"
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"
pullSecret = "string"
resourceGroupId = "string"
version = "string"
}
consoleProfile = {
url = "string"
}
ingressProfiles = [
{
ip = "string"
name = "string"
visibility = "string"
}
]
masterProfile = {
subnetId = "string"
vmSize = "string"
}
networkProfile = {
podCidr = "string"
serviceCidr = "string"
}
provisioningState = "string"
servicePrincipalProfile = {
clientId = "string"
clientSecret = "string"
}
workerProfiles = [
{
count = int
diskSizeGB = int
name = "string"
subnetId = "string"
vmSize = "string"
}
]
}
})
}
プロパティ値
openShiftClusters
名前 | 説明 | 値 |
---|---|---|
type | リソースの種類 | "Microsoft.RedHatOpenShift/openShiftClusters@2020-04-30" |
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" "Public" |
ClusterProfile
名前 | 説明 | 値 |
---|---|---|
domain | クラスターのドメイン (不変)。 | string |
pullSecret | クラスターのプル シークレット (変更不可)。 | string |
resourceGroupId | クラスター リソース グループの ID (変更不可)。 | string |
version | クラスターのバージョン (不変)。 | string |
ConsoleProfile
名前 | 説明 | 値 |
---|---|---|
url | クラスター コンソールにアクセスするための URL (変更不可)。 | string |
IngressProfile
名前 | 説明 | 値 |
---|---|---|
ip | イングレスの IP (不変)。 | string |
name | イングレス プロファイル名。 "default" (不変) である必要があります。 | string |
参照可能範囲 | イングレス可視性 (不変)。 | "Private" "Public" |
MasterProfile
名前 | 説明 | 値 |
---|---|---|
subnetId | マスター サブネットの Azure リソース ID (不変)。 | string |
vmSize | マスター VM のサイズ (変更不可)。 | "Standard_D2s_v3" "Standard_D4s_v3" "Standard_D8s_v3" |
NetworkProfile
名前 | 説明 | 値 |
---|---|---|
podCidr | OpenShift/Kubernetes ポッドに使用される CIDR (不変)。 | string |
serviceCidr | OpenShift/Kubernetes Services に使用される CIDR (不変)。 | string |
ServicePrincipalProfile
名前 | 説明 | 値 |
---|---|---|
clientId | クラスターに使用されるクライアント ID (変更不可)。 | string |
clientSecret | クラスターに使用されるクライアント シークレット (不変)。 | string |
WorkerProfile
名前 | 説明 | 値 |
---|---|---|
count | ワーカー VM の数。 3 から 20 (不変) の間である必要があります。 | INT |
diskSizeGB | ワーカー VM のディスク サイズ。 128 以上 (不変) である必要があります。 | INT |
name | worker プロファイル名。 "worker" (不変) である必要があります。 | string |
subnetId | ワーカー サブネットの Azure リソース ID (不変)。 | string |
vmSize | ワーカー VM のサイズ (変更不可)。 | "Standard_D2s_v3" "Standard_D4s_v3" "Standard_D8s_v3" |