Open Shift Clusters - List By Resource Group

リファレンス

サービス:: Red Hat OpenShift

API バージョン:: 2023-09-04

指定したサブスクリプションとリソースグループ内の OpenShift クラスターを一覧表示します。
この操作は、各 OpenShift クラスターのプロパティを返します。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RedHatOpenShift/openShiftClusters?api-version=2023-09-04

URI パラメーター

名前	/	必須	型	説明
resourceGroupName	path	True	string minLength: 1 maxLength: 90	リソースグループの名前。名前では大文字と小文字が区別されません。
subscriptionId	path	True	string minLength: 1	ターゲットサブスクリプションの ID。
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。

応答

名前	型	説明
200 OK	OpenShiftClusterList	わかりました
Other Status Codes	CloudError	操作が失敗した理由を説明するエラー応答。リソースが存在しない場合は、404 (Not Found) が返されます。入力パラメーターのいずれかが間違っている場合は、400 (無効な要求) が返されます。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザーアカウントを偽装する

例

Lists OpenShift clusters in the specified subscription and resource group.

要求のサンプル

HTTP

GET https://management.azure.com/subscriptions/subscriptionId/resourceGroups/resourceGroup/providers/Microsoft.RedHatOpenShift/openShiftClusters?api-version=2023-09-04

応答のサンプル

状態コード:: 200

{
  "value": [
    {
      "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup/providers/Microsoft.RedHatOpenShift/OpenShiftClusters/resourceName",
      "name": "resourceName",
      "type": "Microsoft.RedHatOpenShift/OpenShiftClusters",
      "location": "location",
      "systemData": {
        "createdBy": "string",
        "createdByType": "Application",
        "createdAt": "2020-02-03T01:01:01.1075056Z",
        "lastModifiedBy": "string",
        "lastModifiedByType": "Application",
        "lastModifiedAt": "2020-02-03T01:01:01.1075056Z"
      },
      "tags": {
        "key": "value"
      },
      "properties": {
        "provisioningState": "Succeeded",
        "clusterProfile": {
          "domain": "cluster.location.aroapp.io",
          "version": "4.11.0",
          "resourceGroupId": "/subscriptions/subscriptionId/resourceGroups/clusterResourceGroup"
        },
        "consoleProfile": {
          "url": "https://console-openshift-console.apps.cluster.location.aroapp.io/"
        },
        "servicePrincipalProfile": {
          "clientId": "clientId"
        },
        "networkProfile": {
          "podCidr": "10.128.0.0/14",
          "serviceCidr": "172.30.0.0/16",
          "preconfiguredNSG": "Disabled"
        },
        "masterProfile": {
          "vmSize": "Standard_D8s_v3",
          "subnetId": "/subscriptions/subscriptionId/resourceGroups/vnetResourceGroup/providers/Microsoft.Network/virtualNetworks/vnet/subnets/master"
        },
        "workerProfiles": [
          {
            "name": "worker",
            "vmSize": "Standard_D2s_v3",
            "diskSizeGB": 128,
            "subnetId": "/subscriptions/subscriptionId/resourceGroups/vnetResourceGroup/providers/Microsoft.Network/virtualNetworks/vnet/subnets/worker",
            "count": 3
          }
        ],
        "workerProfilesStatus": [
          {
            "name": "worker1",
            "vmSize": "Standard_D2s_v3",
            "diskSizeGB": 128,
            "subnetId": "/subscriptions/subscriptionId/resourceGroups/vnetResourceGroup/providers/Microsoft.Network/virtualNetworks/vnet/subnets/worker",
            "count": 1
          },
          {
            "name": "worker2",
            "vmSize": "Standard_D2s_v3",
            "diskSizeGB": 128,
            "subnetId": "/subscriptions/subscriptionId/resourceGroups/vnetResourceGroup/providers/Microsoft.Network/virtualNetworks/vnet/subnets/worker",
            "count": 1
          },
          {
            "name": "worker3",
            "vmSize": "Standard_D2s_v3",
            "diskSizeGB": 128,
            "subnetId": "/subscriptions/subscriptionId/resourceGroups/vnetResourceGroup/providers/Microsoft.Network/virtualNetworks/vnet/subnets/worker",
            "count": 1
          }
        ],
        "apiserverProfile": {
          "visibility": "Public",
          "url": "https://api.cluster.location.aroapp.io:6443/",
          "ip": "1.2.3.4"
        },
        "ingressProfiles": [
          {
            "name": "default",
            "visibility": "Public",
            "ip": "1.2.3.4"
          }
        ]
      }
    }
  ]
}

定義

名前	説明
APIServerProfile	APIServerProfile は、API サーバープロファイルを表します。
CloudError	CloudError はクラウドエラーを表します。
CloudErrorBody	CloudErrorBody は、クラウドエラーの本文を表します。
ClusterProfile	ClusterProfile はクラスタープロファイルを表します。
ConsoleProfile	ConsoleProfile はコンソールプロファイルを表します。
createdByType	リソースを作成した ID の種類。
EncryptionAtHost	EncryptionAtHost はホスト状態での暗号化を表します
FipsValidatedModules	FipsValidatedModules は、FIPS が使用されているかどうかを判断します。
IngressProfile	IngressProfile はイングレスプロファイルを表します。
MasterProfile	MasterProfile はマスタープロファイルを表します。
NetworkProfile	NetworkProfile は、ネットワークプロファイルを表します。
OpenShiftCluster	OpenShiftCluster は、Azure Red Hat OpenShift クラスターを表します。
OpenShiftClusterList	OpenShiftClusterList は、OpenShift クラスターの一覧を表します。
OutboundType	クラスターのインターネットへのエグレスを提供するために使用される送信ルーティング戦略。
PreconfiguredNSG	事前構成済みNSG は、お客様がサブネットにアタッチされた独自の NSG を使用するかどうかを表します
ProvisioningState	ProvisioningState は、プロビジョニング状態を表します。
ServicePrincipalProfile	ServicePrincipalProfile は、サービスプリンシパルプロファイルを表します。
systemData	リソースの作成と最後の変更に関連するメタデータ。
Visibility	可視性は可視性を表します。
WorkerProfile	WorkerProfile は、worker プロファイルを表します。

APIServerProfile

Object

APIServerProfile は、API サーバープロファイルを表します。

名前	型	説明
ip	string	クラスター API サーバーの IP。
url	string	クラスター API サーバーにアクセスするための URL。
visibility	Visibility	API サーバーの可視性。

CloudError

Object

CloudError はクラウドエラーを表します。

名前	型	説明
error	CloudErrorBody	サービスからのエラー応答。

CloudErrorBody

Object

CloudErrorBody は、クラウドエラーの本文を表します。

名前	型	説明
code	string	エラーの識別子。コードは不変であり、プログラムで使用することを目的としています。
details	CloudErrorBody[]	エラーに関する追加の詳細の一覧。
message	string	ユーザーインターフェイスでの表示に適したエラーを説明するメッセージ。
target	string	特定のエラーのターゲット。たとえば、エラーが発生したプロパティの名前です。

ClusterProfile

Object

ClusterProfile はクラスタープロファイルを表します。

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

ConsoleProfile

Object

ConsoleProfile はコンソールプロファイルを表します。

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

createdByType

列挙

リソースを作成した ID の種類。

値	説明
Application
Key
ManagedIdentity
User

EncryptionAtHost

列挙

EncryptionAtHost はホスト状態での暗号化を表します

値	説明
Disabled
Enabled

FipsValidatedModules

列挙

FipsValidatedModules は、FIPS が使用されているかどうかを判断します。

値	説明
Disabled
Enabled

IngressProfile

Object

IngressProfile はイングレスプロファイルを表します。

名前	型	説明
ip	string	イングレスの IP。
name	string	イングレスプロファイル名。
visibility	Visibility	イングレスの可視性。

MasterProfile

Object

MasterProfile はマスタープロファイルを表します。

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

NetworkProfile

Object

NetworkProfile は、ネットワークプロファイルを表します。

名前	型	説明
outboundType	OutboundType	エグレストラフィックに使用される OutboundType。
podCidr	string	OpenShift/Kubernetes ポッドに使用される CIDR。
preconfiguredNSG	PreconfiguredNSG	サブネットが NSG に事前にアタッチされているかどうかを指定します
serviceCidr	string	OpenShift/Kubernetes Services に使用される CIDR。